diff --git a/src/commercelayer.ts b/src/commercelayer.ts index ba6d6a0ae24e..14d61f8d9589 100644 --- a/src/commercelayer.ts +++ b/src/commercelayer.ts @@ -609,74 +609,118 @@ const completionSpec: Fig.Spec = { }, }, { - name: "checkout", - description: "Create checkout urls", + name: "seeder:check", + description: "Execute a check on seeder data", options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", + args: { + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", + }, }, { - name: ["-d", "--domain"], - args: {}, - hidden: true, + name: ["-u", "--url"], + description: "Seeder data url", + args: { + default: "https://data.commercelayer.app/seeder", + }, }, { - name: ["-a", "--accessToken"], - description: - "Custom access token to use instead of the one used for login", + name: ["-n", "--name"], + description: "The name of the business model file to use", args: {}, - isRequired: true, - hidden: false, }, { - name: "--open", - description: "Open checkout url in default browser", + name: "--debug", + description: "Show command debug information", + hidden: true, }, { - name: "--staging", - description: "Connect to checkout application in staging environment", - hidden: true, + name: ["-r", "--relationships"], + description: "Check resource relationships", }, + ], + }, + { + name: "seeder:clean", + description: "Clean previously imported seeder data", + options: [ { - name: ["-O", "--order"], - description: "An order id", - args: {}, + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", + args: { + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", + }, }, { - name: ["-S", "--sku"], - description: "An sku code", - args: {}, + name: ["-u", "--url"], + description: "Seeder data url", + args: { + default: "https://data.commercelayer.app/seeder", + }, }, { - name: ["-B", "--bundle"], - description: "A bundle code", + name: ["-n", "--name"], + description: "The name of the business model file to use", args: {}, }, { - name: ["-m", "--market"], - description: "A market number", + name: "--debug", + description: "Show debug information", + hidden: true, + }, + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-c", "--coupon"], - description: "A promo code", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: ["-e", "--email"], - description: "A customer email", + name: "--accessToken", args: {}, + isRequired: true, + hidden: true, }, ], }, { - name: "checkout:order", - description: "Create checkout urls starting from an existing order", + name: ["seeder:seed", "seed"], + description: "Execute commerce layer seeder", options: [ + { + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", + args: { + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", + }, + }, + { + name: ["-u", "--url"], + description: "Seeder data url", + args: { + default: "https://data.commercelayer.app/seeder", + }, + }, + { + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: {}, + }, + { + name: "--debug", + description: "Show debug information", + hidden: true, + }, { name: ["-o", "--organization"], description: "The slug of your organization", @@ -690,32 +734,37 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-a", "--accessToken"], - description: - "Custom access token to use instead of the one used for login", + name: "--accessToken", args: {}, isRequired: true, - hidden: false, + hidden: true, }, { - name: "--open", - description: "Open checkout url in default browser", + name: ["-k", "--keep"], + description: "Keep existing resources without updating them", }, { - name: "--staging", - description: "Connect to checkout application in staging environment", + name: ["-D", "--delay"], + description: + "Add a delay in milliseconds between calls to different resources", + args: {}, hidden: true, }, ], - args: { - name: "id", - description: "Unique id of the order", - }, }, { - name: "imports", - description: - "List all the created imports or show details of a single import", + name: "resources", + description: "List all the available commerce layer api resources", + options: [ + { + name: ["-h", "--help"], + description: "Show cli help", + }, + ], + }, + { + name: ["resources:all", "all", "ra", "res:all"], + description: "Fetch all resources", options: [ { name: ["-o", "--organization"], @@ -736,232 +785,176 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-A", "--all"], - description: "Show all imports instead of first 25 only", - }, - { - name: ["-t", "--type"], - description: "The type of resource imported", - args: { - suggestions: [ - "addresses", - "bundles", - "coupons", - "customer_addresses", - "customer_payment_sources", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "line_item_options", - "orders", - "price_tiers", - "prices", - "shipping_categories", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tags", - "tax_categories", - ], - }, + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: {}, }, { - name: ["-g", "--group"], + name: ["-f", "--fields"], description: - "The group id associated to the import in case of multi-chunk imports", + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: {}, }, { - name: ["-s", "--status"], - description: "The import job status", + name: ["-j", "--json"], + description: "Convert output in standard json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print unformatted json output", + }, + { + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, + }, + { + name: "--doc", + description: "Show the cli command in a specific language", + }, + { + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", args: { - suggestions: ["in_progress", "pending", "completed", "interrupted"], + suggestions: ["curl", "node"], }, }, { - name: ["-e", "--errors"], - description: "Show only imports with errors", + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - name: ["-w", "--warnings"], - description: "Show only import with warnings", + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - name: ["-l", "--limit"], - description: "Limit number of imports in output", + name: "--save-args", + description: "Save command data to file for future use", args: {}, }, - ], - args: { - name: "id", - description: "Unique id of the import to be retrieved", - isOptional: true, - }, - }, - { - name: ["imports:create", "imp:create", "import"], - description: "Create a new import", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: "--load-args", + description: "Load previously saved command arguments", args: {}, - isRequired: true, + }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, { - name: ["-d", "--domain"], + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: {}, - hidden: true, }, { - name: "--accessToken", + name: ["-s", "--sort"], + description: "Defines results ordering", args: {}, - isRequired: true, - hidden: true, }, { - name: ["-t", "--type"], - description: "The type of resource being imported", - args: { - description: "Addresses|bundles|coupons|customer_addresses|etc", - suggestions: [ - "addresses", - "bundles", - "coupons", - "customer_addresses", - "customer_payment_sources", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "line_item_options", - "orders", - "price_tiers", - "prices", - "shipping_categories", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tags", - "tax_categories", - ], - }, - isRequired: true, + name: ["-x", "--save"], + description: "Save command output to file", + args: {}, }, { - name: ["-p", "--parent"], + name: ["-X", "--save-path"], description: - "The id of the parent resource to be associated with imported data", + "Save command output to file and create missing path directories", args: {}, }, { - name: ["-i", "--inputs"], - description: "The path of the file containing the data to import", + name: ["-N", "--notify"], + description: "Force system notification when export has finished", + hidden: true, + }, + { + name: "--clientId", + description: "Organization client_id", args: {}, - isRequired: true, + hidden: true, + }, + { + name: "--clientSecret", + description: "Organization client_secret", + args: {}, + hidden: true, }, { name: ["-C", "--csv"], - description: "Accept input file in csv format", + description: "Export fields in csv format", }, { name: ["-D", "--delimiter"], - description: - "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", + description: "", args: { suggestions: [",", ";", "|", "TAB"], }, }, { - name: ["-b", "--blind"], - description: - "Execute in blind mode without showing the progress monitor", - }, - { - name: ["-q", "--quiet"], - description: "Execute command without showing warning messages", + name: ["-H", "--header"], + description: "", + args: {}, }, - ], - }, - { - name: ["imports:delete", "imp:delete"], - description: "Delete an existing import", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, + name: ["-b", "--blind"], + description: "Execute in blind mode without prompt and progress bar", }, { - name: ["-d", "--domain"], + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: {}, - hidden: true, }, { - name: "--accessToken", + name: ["-T", "--timeout"], + description: "Set request timeout in milliseconds [1000 - 15000]", args: {}, - isRequired: true, hidden: true, }, ], args: { - name: "id", - description: "Unique id of the import", + name: "resource", + description: "The resource type", }, }, { - name: ["imports:details", "imp:details"], - description: "Show the details of an existing import", + name: ["resources:args", "res:args"], + description: "Show all the saved command arguments", options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], + name: ["-a", "--alias"], + description: "The alias associated to saved command arguments", args: {}, - hidden: true, }, { - name: "--accessToken", + name: ["-r", "--resource"], + description: "The resource type", args: {}, - isRequired: true, - hidden: true, }, { - name: ["-i", "--inputs"], - description: "Show input items associated with the import", + name: ["-o", "--operation"], + description: "The resource operation", + args: { + suggestions: ["list", "retrieve", "create", "update"], + }, }, { - name: ["-l", "--logs"], - description: - "Show warning and error logs related to the import process", + name: ["-D", "--delete"], + description: "Delete saved arguments associated to the alias", }, { - name: ["-S", "--save-inputs"], - description: "Save import inputs to local file", - args: {}, + name: ["-P", "--pretty"], + description: "Show saved arguments in table format", + hidden: true, }, ], - args: { - name: "id", - description: "Unique id of the import", - }, }, { - name: ["imports:group", "imp:group"], - description: "List all the imports related to an import group", + name: ["resources:count", "count", "res:count", "rs:count"], + description: "Count the number of existent resources", options: [ { name: ["-o", "--organization"], @@ -981,15 +974,20 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, + { + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: {}, + }, ], args: { - name: "group_id", - description: "Unique id of the group import", + name: "resource", + description: "The resource type", }, }, { - name: ["imports:list", "imp:list"], - description: "List all the created imports", + name: ["resources:create", "create", "rc", "res:create", "post"], + description: "Create a new resource", options: [ { name: ["-o", "--organization"], @@ -1010,186 +1008,221 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-A", "--all"], - description: "Show all imports instead of first 25 only", - }, - { - name: ["-t", "--type"], - description: "The type of resource imported", - args: { - suggestions: [ - "addresses", - "bundles", - "coupons", - "customer_addresses", - "customer_payment_sources", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "line_item_options", - "orders", - "price_tiers", - "prices", - "shipping_categories", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tags", - "tax_categories", - ], - }, + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: {}, }, { - name: ["-g", "--group"], + name: ["-f", "--fields"], description: - "The group id associated to the import in case of multi-chunk imports", + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: {}, }, { - name: ["-s", "--status"], - description: "The import job status", - args: { - suggestions: ["in_progress", "pending", "completed", "interrupted"], - }, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: ["-e", "--errors"], - description: "Show only imports with errors", + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: ["-w", "--warnings"], - description: "Show only import with warnings", + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-l", "--limit"], - description: "Limit number of imports in output", - args: {}, + name: "--doc", + description: "Show the cli command in a specific language", }, - ], - }, - { - name: ["imports:types", "imp:types"], - description: "Show online documentation for supported resources", - options: [ { - name: ["-O", "--open"], - description: "Open online documentation page", + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + suggestions: ["curl", "node"], + }, }, - ], - }, - { - name: "microstore", - description: "Create microstore urls", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - name: ["-d", "--domain"], + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, + }, + { + name: "--save-args", + description: "Save command data to file for future use", args: {}, - hidden: true, }, { - name: ["-a", "--accessToken"], + name: "--load-args", + description: "Load previously saved command arguments", args: {}, - isRequired: true, - hidden: false, }, { - name: "--open", - description: "Open microstore url in default browser", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-S", "--skuListId"], - description: "The sku list id", - args: {}, - isRequired: true, - }, - { - name: ["-A", "--all"], - description: "Activate the buy all button", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - name: ["-C", "--cart"], - description: "Activate the cart application", + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", + hidden: true, }, { - name: ["-I", "--inline"], - description: "Disable redirect to cart application", + name: ["-a", "--attribute"], + description: "Define a resource attribute", + args: {}, }, - ], - }, - { - name: "seeder:check", - description: "Execute a check on seeder data", - options: [ { - name: ["-b", "--businessModel"], - description: "The kind of business model you want to import", - args: { - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", - }, + name: ["-O", "--object"], + description: "Define a resource object attribute", + args: {}, }, { - name: ["-u", "--url"], - description: "Seeder data url", - args: { - default: "https://data.commercelayer.app/seeder", - }, + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", + args: {}, }, { - name: ["-n", "--name"], - description: "The name of the business model file to use", + name: ["-m", "--metadata"], + description: + "Define a metadata attribute or a set of metadata attributes", args: {}, }, { - name: "--debug", - description: "Show command debug information", - hidden: true, + name: ["-D", "--data"], + description: "The data file to use as request body", + args: {}, }, { - name: ["-r", "--relationships"], - description: "Check resource relationships", + name: ["-t", "--tags"], + description: "List of tags associated with the resource", + args: {}, }, ], + args: { + name: "resource", + description: "The resource type", + suggestions: [ + "address", + "adjustment", + "adyen_gateway", + "adyen_payment", + "attachment", + "avalara_account", + "axerve_gateway", + "axerve_payment", + "billing_info_validation_rule", + "bing_geocoder", + "braintree_gateway", + "braintree_payment", + "bundle", + "buy_x_pay_y_promotion", + "carrier_account", + "checkout_com_gateway", + "checkout_com_payment", + "cleanup", + "coupon", + "coupon_codes_promotion_rule", + "coupon_recipient", + "credit_card", + "custom_promotion_rule", + "customer", + "customer_address", + "customer_group", + "customer_password_reset", + "customer_payment_source", + "customer_subscription", + "delivery_lead_time", + "export", + "external_gateway", + "external_payment", + "external_promotion", + "external_tax_calculator", + "fixed_amount_promotion", + "fixed_price_promotion", + "free_gift_promotion", + "free_shipping_promotion", + "gift_card", + "gift_card_recipient", + "google_geocoder", + "import", + "in_stock_subscription", + "inventory_model", + "inventory_return_location", + "inventory_stock_location", + "klarna_gateway", + "klarna_payment", + "line_item", + "line_item_option", + "link", + "manual_gateway", + "manual_tax_calculator", + "market", + "merchant", + "order", + "order_amount_promotion_rule", + "order_copy", + "order_subscription", + "order_subscription_item", + "package", + "parcel", + "parcel_line_item", + "payment_method", + "payment_option", + "paypal_gateway", + "paypal_payment", + "percentage_discount_promotion", + "price", + "price_frequency_tier", + "price_list", + "price_list_scheduler", + "price_volume_tier", + "recurring_order_copy", + "return", + "return_line_item", + "satispay_gateway", + "satispay_payment", + "shipment", + "shipping_category", + "shipping_method", + "shipping_weight_tier", + "shipping_zone", + "sku", + "sku_list", + "sku_list_item", + "sku_list_promotion_rule", + "sku_option", + "spreedly_gateway", + "stock_item", + "stock_line_item", + "stock_location", + "stock_reservation", + "stock_transfer", + "stripe_gateway", + "stripe_payment", + "subscription_model", + "tag", + "tax_category", + "tax_rule", + "taxjar_account", + "webhook", + "wire_transfer", + ], + }, }, { - name: "seeder:clean", - description: "Clean previously imported seeder data", + name: ["resources:delete", "delete", "rd", "res:delete"], + description: "Delete an existing resource", options: [ - { - name: ["-b", "--businessModel"], - description: "The kind of business model you want to import", - args: { - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", - }, - }, - { - name: ["-u", "--url"], - description: "Seeder data url", - args: { - default: "https://data.commercelayer.app/seeder", - }, - }, - { - name: ["-n", "--name"], - description: "The name of the business model file to use", - args: {}, - }, - { - name: "--debug", - description: "Show debug information", - hidden: true, - }, { name: ["-o", "--organization"], description: "The slug of your organization", @@ -1208,108 +1241,230 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, - ], - }, - { - name: ["seeder:seed", "seed"], - description: "Execute commerce layer seeder", - options: [ { - name: ["-b", "--businessModel"], - description: "The kind of business model you want to import", - args: { - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", - }, + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: {}, }, { - name: ["-u", "--url"], - description: "Seeder data url", - args: { - default: "https://data.commercelayer.app/seeder", - }, + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: {}, }, { - name: ["-n", "--name"], - description: "The name of the business model file to use", - args: {}, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: "--debug", - description: "Show debug information", - hidden: true, + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-d", "--domain"], - args: {}, - hidden: true, + name: "--doc", + description: "Show the cli command in a specific language", }, { - name: "--accessToken", - args: {}, - isRequired: true, - hidden: true, + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + suggestions: ["curl", "node"], + }, }, { - name: ["-k", "--keep"], - description: "Keep existing resources without updating them", + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - name: ["-D", "--delay"], + name: "--node", description: - "Add a delay in milliseconds between calls to different resources", + "Show the equivalent node sdk source code of the cli command", + hidden: false, + }, + { + name: "--save-args", + description: "Save command data to file for future use", args: {}, - hidden: true, }, - ], - }, - { - name: ["token:decode", "token:info"], - description: "Decode a commerce layer access token", - args: { - name: "token", - description: "The access token to be decoded", - }, - }, - { - name: "token:generate", - description: "Start a wizard to generate a custom access token", - options: [ { - name: ["-d", "--domain"], + name: "--load-args", + description: "Load previously saved command arguments", args: {}, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print users answers", + name: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, + ], + args: [ { - name: ["-i", "--info"], - description: "Print generated token info", + name: "resource", + description: "The resource type", + suggestions: [ + "address", + "adjustment", + "adyen_gateway", + "adyen_payment", + "attachment", + "avalara_account", + "axerve_gateway", + "axerve_payment", + "billing_info_validation_rule", + "bing_geocoder", + "braintree_gateway", + "braintree_payment", + "bundle", + "buy_x_pay_y_promotion", + "carrier_account", + "checkout_com_gateway", + "checkout_com_payment", + "cleanup", + "coupon", + "coupon_codes_promotion_rule", + "coupon_recipient", + "credit_card", + "custom_promotion_rule", + "customer", + "customer_address", + "customer_group", + "customer_password_reset", + "customer_payment_source", + "customer_subscription", + "delivery_lead_time", + "export", + "external_gateway", + "external_payment", + "external_promotion", + "external_tax_calculator", + "fixed_amount_promotion", + "fixed_price_promotion", + "free_gift_promotion", + "free_shipping_promotion", + "gift_card", + "gift_card_recipient", + "google_geocoder", + "import", + "in_stock_subscription", + "inventory_model", + "inventory_return_location", + "inventory_stock_location", + "klarna_gateway", + "klarna_payment", + "line_item", + "line_item_option", + "link", + "manual_gateway", + "manual_tax_calculator", + "market", + "merchant", + "order", + "order_amount_promotion_rule", + "order_copy", + "order_subscription", + "order_subscription_item", + "package", + "parcel", + "parcel_line_item", + "payment_method", + "payment_option", + "paypal_gateway", + "paypal_payment", + "percentage_discount_promotion", + "price", + "price_frequency_tier", + "price_list", + "price_list_scheduler", + "price_volume_tier", + "recurring_order_copy", + "return", + "return_line_item", + "satispay_gateway", + "satispay_payment", + "shipment", + "shipping_category", + "shipping_method", + "shipping_weight_tier", + "shipping_zone", + "sku", + "sku_list", + "sku_list_item", + "sku_list_promotion_rule", + "sku_option", + "spreedly_gateway", + "stock_item", + "stock_line_item", + "stock_location", + "stock_reservation", + "stock_transfer", + "stripe_gateway", + "stripe_payment", + "subscription_model", + "tag", + "tax_category", + "tax_rule", + "taxjar_account", + "webhook", + "wire_transfer", + ], }, { - name: ["-c", "--check"], - description: "Check generated access token", + name: "id", + description: "Id of the resource to delete", + isOptional: true, }, ], }, { - name: "token:get", - description: "Get a new access token", + name: ["resources:doc", "res:doc", "doc"], + description: + "Open the default browser and show the online documentation for the resource", + options: [ + { + name: ["-p", "--page"], + description: "The doc page you want to access", + args: { + suggestions: [ + "object", + "create", + "retrieve", + "list", + "update", + "delete", + ], + }, + }, + ], + args: { + name: "resource", + description: + "The resource for which you want to access the online documentation", + }, + }, + { + name: ["resources:fetch", "fetch", "res:fetch", "rf"], + description: "Retrieve a resource or list a set of resources", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { name: ["-d", "--domain"], @@ -1317,94 +1472,136 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--clientId"], - description: "Application client_id", + name: "--accessToken", args: {}, isRequired: true, + hidden: true, }, { - name: ["-s", "--clientSecret"], - description: "Application client_secret", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: {}, }, { - name: ["-S", "--scope"], - description: "Access token scope (market, stock location)", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: {}, }, { - name: ["-e", "--email"], - description: "Customer email", - args: {}, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: ["-p", "--password"], - description: "Customer secret password", - args: {}, + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: "--info", - description: "Show access token info", + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-P", "--provisioning"], - description: "Execute login to provisioning api", + name: "--doc", + description: "Show the cli command in a specific language", }, - ], - }, - { - name: "token:revoke", - description: "Revoke a commerce layer access token", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + suggestions: ["curl", "node"], + }, }, { - name: ["-d", "--domain"], - args: {}, - hidden: true, + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - name: ["-i", "--clientId"], - description: "Application client_id", - args: {}, - isRequired: true, + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - name: ["-s", "--clientSecret"], - description: "Application client_secret", + name: "--save-args", + description: "Save command data to file for future use", args: {}, }, { - name: ["-S", "--scope"], - description: "Access token scope", + name: "--load-args", + description: "Load previously saved command arguments", args: {}, }, { - name: ["-P", "--provisioning"], - description: "Execute login to provisioning api", + name: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", + hidden: true, + }, + { + name: ["-x", "--save"], + description: "Save command output to file", + args: {}, + }, + { + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", + args: {}, + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: {}, + }, + { + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: {}, + }, + { + name: ["-p", "--page"], + description: "Page number", + args: {}, + }, + { + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: {}, + }, + { + name: ["-s", "--sort"], + description: "Defines results ordering", + args: {}, }, ], - args: { - name: "token", - description: "Access token to revoke", - }, - }, - { - name: "resources", - description: "List all the available commerce layer api resources", - options: [ + args: [ { - name: ["-h", "--help"], - description: "Show cli help", + name: "path", + description: "Path (or url) of the resource(s) to fetch", + }, + { + name: "id", + description: "Resource id", + isOptional: true, }, ], }, { - name: ["resources:all", "all", "ra", "res:all"], - description: "Fetch all resources", + name: ["resources:filters", "res:filters"], + description: "Show a list of all available filter predicates", + }, + { + name: ["resources:get", "get", "res:get", "rg"], + description: "Retrieve a resource or list a set of resources", options: [ { name: ["-o", "--organization"], @@ -1481,115 +1678,70 @@ const completionSpec: Fig.Spec = { args: {}, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", - args: {}, - }, - { - name: ["-s", "--sort"], - description: "Defines results ordering", - args: {}, - }, - { - name: ["-x", "--save"], - description: "Save command output to file", - args: {}, + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-X", "--save-path"], - description: - "Save command output to file and create missing path directories", - args: {}, + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - name: ["-N", "--notify"], - description: "Force system notification when export has finished", + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, { - name: "--clientId", - description: "Organization client_id", + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: {}, - hidden: true, }, { - name: "--clientSecret", - description: "Organization client_secret", + name: ["-p", "--page"], + description: "Page number", args: {}, - hidden: true, }, { - name: ["-C", "--csv"], - description: "Export fields in csv format", + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: {}, }, { - name: ["-D", "--delimiter"], - description: "", - args: { - suggestions: [",", ";", "|", "TAB"], - }, + name: ["-s", "--sort"], + description: "Defines results ordering", + args: {}, }, { - name: ["-H", "--header"], - description: "", + name: ["-x", "--save"], + description: "Save command output to file", args: {}, }, { - name: ["-b", "--blind"], - description: "Execute in blind mode without prompt and progress bar", + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", + args: {}, }, { name: ["-e", "--extract"], description: "Extract subfields from object attributes", args: {}, }, - { - name: ["-T", "--timeout"], - description: "Set request timeout in milliseconds [1000 - 15000]", - args: {}, - hidden: true, - }, ], - args: { - name: "resource", - description: "The resource type", - }, - }, - { - name: ["resources:args", "res:args"], - description: "Show all the saved command arguments", - options: [ - { - name: ["-a", "--alias"], - description: "The alias associated to saved command arguments", - args: {}, - }, + args: [ { - name: ["-r", "--resource"], + name: "resource", description: "The resource type", - args: {}, - }, - { - name: ["-o", "--operation"], - description: "The resource operation", - args: { - suggestions: ["list", "retrieve", "create", "update"], - }, - }, - { - name: ["-D", "--delete"], - description: "Delete saved arguments associated to the alias", }, { - name: ["-P", "--pretty"], - description: "Show saved arguments in table format", - hidden: true, + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, }, ], }, { - name: ["resources:count", "count", "res:count", "rs:count"], - description: "Count the number of existent resources", + name: ["resources:last", "last", "res:last"], + description: "Show the last id of a resource type", options: [ { name: ["-o", "--organization"], @@ -1609,11 +1761,6 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, - { - name: ["-w", "--where"], - description: "Comma separated list of query filters", - args: {}, - }, ], args: { name: "resource", @@ -1621,8 +1768,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: ["resources:create", "create", "rc", "res:create", "post"], - description: "Create a new resource", + name: ["resources:list", "list", "rl", "res:list"], + description: "Fetch a collection of resources", options: [ { name: ["-o", "--organization"], @@ -1707,34 +1854,44 @@ const completionSpec: Fig.Spec = { description: "Show only response headers", }, { - name: ["-a", "--attribute"], - description: "Define a resource attribute", + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", + hidden: true, + }, + { + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: {}, }, { - name: ["-O", "--object"], - description: "Define a resource object attribute", + name: ["-p", "--page"], + description: "Page number", args: {}, }, { - name: ["-r", "--relationship"], - description: "Define a relationship with another resource", + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: {}, }, { - name: ["-m", "--metadata"], - description: - "Define a metadata attribute or a set of metadata attributes", + name: ["-s", "--sort"], + description: "Defines results ordering", args: {}, }, { - name: ["-D", "--data"], - description: "The data file to use as request body", + name: ["-x", "--save"], + description: "Save command output to file", args: {}, }, { - name: ["-t", "--tags"], - description: "List of tags associated with the resource", + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", + args: {}, + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: {}, }, ], @@ -1742,113 +1899,136 @@ const completionSpec: Fig.Spec = { name: "resource", description: "The resource type", suggestions: [ - "address", - "adjustment", - "adyen_gateway", - "adyen_payment", - "attachment", - "avalara_account", - "axerve_gateway", - "axerve_payment", - "billing_info_validation_rule", - "bing_geocoder", - "braintree_gateway", - "braintree_payment", - "bundle", - "buy_x_pay_y_promotion", - "checkout_com_gateway", - "checkout_com_payment", - "cleanup", - "coupon", - "coupon_codes_promotion_rule", - "coupon_recipient", - "credit_card", - "custom_promotion_rule", - "customer", - "customer_address", - "customer_group", - "customer_password_reset", - "customer_payment_source", - "customer_subscription", - "delivery_lead_time", - "export", - "external_gateway", - "external_payment", - "external_promotion", - "external_tax_calculator", - "fixed_amount_promotion", - "fixed_price_promotion", - "free_gift_promotion", - "free_shipping_promotion", - "gift_card", - "gift_card_recipient", - "google_geocoder", - "import", - "in_stock_subscription", - "inventory_model", - "inventory_return_location", - "inventory_stock_location", - "klarna_gateway", - "klarna_payment", - "line_item", - "line_item_option", - "manual_gateway", - "manual_tax_calculator", - "market", - "merchant", - "order", - "order_amount_promotion_rule", - "order_copy", - "order_subscription", - "order_subscription_item", - "package", - "parcel", - "parcel_line_item", - "payment_method", - "payment_option", - "paypal_gateway", - "paypal_payment", - "percentage_discount_promotion", - "price", - "price_frequency_tier", - "price_list", - "price_volume_tier", - "recurring_order_copy", - "return", - "return_line_item", - "satispay_gateway", - "satispay_payment", - "shipment", - "shipping_category", - "shipping_method", - "shipping_weight_tier", - "shipping_zone", - "sku", - "sku_list", - "sku_list_item", - "sku_list_promotion_rule", - "sku_option", - "spreedly_gateway", - "stock_item", - "stock_line_item", - "stock_location", - "stock_reservation", - "stock_transfer", - "stripe_gateway", - "stripe_payment", - "subscription_model", - "tag", - "tax_category", - "tax_rule", - "taxjar_account", - "webhook", - "wire_transfer", + "addresses", + "adjustments", + "adyen_gateways", + "adyen_payments", + "attachments", + "authorizations", + "avalara_accounts", + "axerve_gateways", + "axerve_payments", + "billing_info_validation_rules", + "bing_geocoders", + "braintree_gateways", + "braintree_payments", + "bundles", + "buy_x_pay_y_promotions", + "captures", + "carrier_accounts", + "checkout_com_gateways", + "checkout_com_payments", + "cleanups", + "coupons", + "coupon_codes_promotion_rules", + "coupon_recipients", + "credit_cards", + "custom_promotion_rules", + "customers", + "customer_addresses", + "customer_groups", + "customer_password_resets", + "customer_payment_sources", + "customer_subscriptions", + "delivery_lead_times", + "events", + "event_callbacks", + "exports", + "external_gateways", + "external_payments", + "external_promotions", + "external_tax_calculators", + "fixed_amount_promotions", + "fixed_price_promotions", + "free_gift_promotions", + "free_shipping_promotions", + "geocoders", + "gift_cards", + "gift_card_recipients", + "google_geocoders", + "imports", + "in_stock_subscriptions", + "inventory_models", + "inventory_return_locations", + "inventory_stock_locations", + "klarna_gateways", + "klarna_payments", + "line_items", + "line_item_options", + "links", + "manual_gateways", + "manual_tax_calculators", + "markets", + "merchants", + "orders", + "order_amount_promotion_rules", + "order_copies", + "order_factories", + "order_subscriptions", + "order_subscription_items", + "order_validation_rules", + "packages", + "parcels", + "parcel_line_items", + "payment_gateways", + "payment_methods", + "payment_options", + "paypal_gateways", + "paypal_payments", + "percentage_discount_promotions", + "prices", + "price_frequency_tiers", + "price_lists", + "price_list_schedulers", + "price_tiers", + "price_volume_tiers", + "promotions", + "promotion_rules", + "recurring_order_copies", + "refunds", + "reserved_stocks", + "resource_errors", + "returns", + "return_line_items", + "satispay_gateways", + "satispay_payments", + "shipments", + "shipment_line_items", + "shipping_categories", + "shipping_methods", + "shipping_method_tiers", + "shipping_weight_tiers", + "shipping_zones", + "skus", + "sku_lists", + "sku_list_items", + "sku_list_promotion_rules", + "sku_options", + "spreedly_gateways", + "stock_items", + "stock_line_items", + "stock_locations", + "stock_reservations", + "stock_transfers", + "stripe_gateways", + "stripe_payments", + "subscription_models", + "tags", + "tax_calculators", + "tax_categories", + "tax_rules", + "taxjar_accounts", + "transactions", + "versions", + "voids", + "webhooks", + "wire_transfers", ], }, }, { - name: ["resources:delete", "delete", "rd", "res:delete"], - description: "Delete an existing resource", + name: ["relationship", "resources:rel", "res:rel", "res:relationship"], + description: "Fetch a resource relationship", options: [ { name: ["-o", "--organization"], @@ -1932,34 +2112,203 @@ const completionSpec: Fig.Spec = { name: ["-Y", "--headers-only"], description: "Show only response headers", }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", + hidden: true, + }, + { + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: {}, + }, + { + name: ["-p", "--page"], + description: "Page number", + args: {}, + }, + { + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: {}, + }, + { + name: ["-s", "--sort"], + description: "Defines results ordering", + args: {}, + }, + { + name: ["-x", "--save"], + description: "Save command output to file", + args: {}, + }, + { + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", + args: {}, + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: {}, + }, ], args: [ { name: "resource", description: "The resource type", - suggestions: [ - "address", - "adjustment", - "adyen_gateway", - "adyen_payment", - "attachment", - "avalara_account", - "axerve_gateway", - "axerve_payment", - "billing_info_validation_rule", - "bing_geocoder", - "braintree_gateway", - "braintree_payment", - "bundle", - "buy_x_pay_y_promotion", - "checkout_com_gateway", - "checkout_com_payment", - "cleanup", - "coupon", - "coupon_codes_promotion_rule", - "coupon_recipient", - "credit_card", - "custom_promotion_rule", + }, + { + name: "id", + description: "Id of the resource to retrieve", + }, + { + name: "relationship", + description: "Name of the relationship field", + }, + ], + hidden: false, + }, + { + name: ["resources:retrieve", "retrieve", "rr", "res:retrieve"], + description: "Fetch a single resource", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: {}, + }, + { + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: {}, + }, + { + name: ["-j", "--json"], + description: "Convert output in standard json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print unformatted json output", + }, + { + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, + }, + { + name: "--doc", + description: "Show the cli command in a specific language", + }, + { + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + suggestions: ["curl", "node"], + }, + }, + { + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, + }, + { + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, + }, + { + name: "--save-args", + description: "Save command data to file for future use", + args: {}, + }, + { + name: "--load-args", + description: "Load previously saved command arguments", + args: {}, + }, + { + name: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", + hidden: true, + }, + { + name: ["-x", "--save"], + description: "Save command output to file", + args: {}, + }, + { + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", + args: {}, + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: {}, + }, + ], + args: [ + { + name: "resource", + description: "The resource type", + suggestions: [ + "address", + "adjustment", + "adyen_gateway", + "adyen_payment", + "application", + "attachment", + "authorization", + "avalara_account", + "axerve_gateway", + "axerve_payment", + "billing_info_validation_rule", + "bing_geocoder", + "braintree_gateway", + "braintree_payment", + "bundle", + "buy_x_pay_y_promotion", + "capture", + "carrier_account", + "checkout_com_gateway", + "checkout_com_payment", + "cleanup", + "coupon", + "coupon_codes_promotion_rule", + "coupon_recipient", + "credit_card", + "custom_promotion_rule", "customer", "customer_address", "customer_group", @@ -1967,6 +2316,8 @@ const completionSpec: Fig.Spec = { "customer_payment_source", "customer_subscription", "delivery_lead_time", + "event", + "event_callback", "export", "external_gateway", "external_payment", @@ -1976,6 +2327,7 @@ const completionSpec: Fig.Spec = { "fixed_price_promotion", "free_gift_promotion", "free_shipping_promotion", + "geocoder", "gift_card", "gift_card_recipient", "google_geocoder", @@ -1988,6 +2340,7 @@ const completionSpec: Fig.Spec = { "klarna_payment", "line_item", "line_item_option", + "link", "manual_gateway", "manual_tax_calculator", "market", @@ -1995,11 +2348,15 @@ const completionSpec: Fig.Spec = { "order", "order_amount_promotion_rule", "order_copy", + "order_factory", "order_subscription", "order_subscription_item", + "order_validation_rule", + "organization", "package", "parcel", "parcel_line_item", + "payment_gateway", "payment_method", "payment_option", "paypal_gateway", @@ -2008,15 +2365,24 @@ const completionSpec: Fig.Spec = { "price", "price_frequency_tier", "price_list", + "price_list_scheduler", + "price_tier", "price_volume_tier", + "promotion", + "promotion_rule", "recurring_order_copy", + "refund", + "reserved_stock", + "resource_error", "return", "return_line_item", "satispay_gateway", "satispay_payment", "shipment", + "shipment_line_item", "shipping_category", "shipping_method", + "shipping_method_tier", "shipping_weight_tier", "shipping_zone", "sku", @@ -2034,49 +2400,32 @@ const completionSpec: Fig.Spec = { "stripe_payment", "subscription_model", "tag", + "tax_calculator", "tax_category", "tax_rule", "taxjar_account", + "transaction", + "version", + "void", "webhook", "wire_transfer", ], }, { name: "id", - description: "Id of the resource to delete", + description: "Id of the resource to retrieve", isOptional: true, }, ], }, { - name: ["resources:doc", "res:doc", "doc"], + name: ["resources:schema", "schema", "res:schema", "rs"], description: - "Open the default browser and show the online documentation for the resource", - options: [ - { - name: ["-p", "--page"], - description: "The doc page you want to access", - args: { - suggestions: [ - "object", - "create", - "retrieve", - "list", - "update", - "delete", - ], - }, - }, - ], - args: { - name: "resource", - description: - "The resource for which you want to access the online documentation", - }, + "Show the current commercelayer openapi schema version used by the plugin", }, { - name: ["resources:fetch", "fetch", "res:fetch", "rf"], - description: "Retrieve a resource or list a set of resources", + name: ["resources:update", "update", "ru", "res:update", "patch"], + description: "Update an existing resource", options: [ { name: ["-o", "--organization"], @@ -2161,67 +2510,168 @@ const completionSpec: Fig.Spec = { description: "Show only response headers", }, { - name: ["-x", "--save"], - description: "Save command output to file", - args: {}, + name: ["-I", "--force-include"], + description: "Force resources inclusion beyond the 3rd level", + hidden: true, }, { - name: ["-X", "--save-path"], - description: - "Save command output to file and create missing path directories", + name: ["-a", "--attribute"], + description: "Define a resource attribute", args: {}, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: ["-O", "--object"], + description: "Define a resource object attribute", args: {}, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", args: {}, }, { - name: ["-p", "--page"], - description: "Page number", + name: ["-m", "--metadata"], + description: "", args: {}, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-M", "--metadata-replace"], + description: "", args: {}, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: ["-D", "--data"], + description: "The data file to use as request body", args: {}, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyond the 3rd level", - hidden: true, + name: ["-t", "--tags"], + description: "List of tags associated with the resource", + args: {}, }, ], args: [ { - name: "path", - description: "Path (or url) of the resource(s) to fetch", - }, - { - name: "id", - description: "Resource id", - isOptional: true, - }, - ], - }, - { - name: ["resources:filters", "res:filters"], - description: "Show a list of all available filter predicates", - }, - { - name: ["resources:get", "get", "res:get", "rg"], - description: "Retrieve a resource or list a set of resources", - options: [ + name: "resource", + description: "The resource type", + suggestions: [ + "address", + "adjustment", + "adyen_gateway", + "adyen_payment", + "attachment", + "authorization", + "avalara_account", + "axerve_gateway", + "axerve_payment", + "billing_info_validation_rule", + "bing_geocoder", + "braintree_gateway", + "braintree_payment", + "bundle", + "buy_x_pay_y_promotion", + "capture", + "carrier_account", + "checkout_com_gateway", + "checkout_com_payment", + "coupon", + "coupon_codes_promotion_rule", + "coupon_recipient", + "credit_card", + "custom_promotion_rule", + "customer", + "customer_address", + "customer_group", + "customer_password_reset", + "customer_payment_source", + "customer_subscription", + "delivery_lead_time", + "event", + "external_gateway", + "external_payment", + "external_promotion", + "external_tax_calculator", + "fixed_amount_promotion", + "fixed_price_promotion", + "free_gift_promotion", + "free_shipping_promotion", + "gift_card", + "gift_card_recipient", + "google_geocoder", + "in_stock_subscription", + "inventory_model", + "inventory_return_location", + "inventory_stock_location", + "klarna_gateway", + "klarna_payment", + "line_item", + "line_item_option", + "link", + "manual_gateway", + "manual_tax_calculator", + "market", + "merchant", + "order", + "order_amount_promotion_rule", + "order_copy", + "order_subscription", + "order_subscription_item", + "package", + "parcel", + "parcel_line_item", + "payment_method", + "payment_option", + "paypal_gateway", + "paypal_payment", + "percentage_discount_promotion", + "price", + "price_frequency_tier", + "price_list", + "price_list_scheduler", + "price_volume_tier", + "recurring_order_copy", + "return", + "return_line_item", + "satispay_gateway", + "satispay_payment", + "shipment", + "shipping_category", + "shipping_method", + "shipping_weight_tier", + "shipping_zone", + "sku", + "sku_list", + "sku_list_item", + "sku_list_promotion_rule", + "sku_option", + "spreedly_gateway", + "stock_item", + "stock_line_item", + "stock_location", + "stock_reservation", + "stock_transfer", + "stripe_gateway", + "stripe_payment", + "subscription_model", + "tag", + "tax_category", + "tax_rule", + "taxjar_account", + "webhook", + "wire_transfer", + ], + }, + { + name: "id", + description: "Id of the resource to update", + isOptional: true, + }, + ], + }, + { + name: "links", + description: "List all the links or the details of a single link", + options: [ { name: ["-o", "--organization"], description: "The slug of your organization", @@ -2235,132 +2685,145 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: "--accessToken", + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", args: {}, isRequired: true, hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", - args: {}, + name: ["-A", "--all"], + description: "Show all links instead of first 25 only", }, { - name: ["-f", "--fields"], - description: - "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-l", "--limit"], + description: "Limit number of links in output", args: {}, }, { - name: ["-j", "--json"], - description: "Convert output in standard json format", + name: ["-n", "--name"], + description: "The name of the link", + args: {}, }, { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: ["-S", "--link_scope"], + description: "The scope of the link", + args: {}, }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: ["-s", "--starts"], + description: "Look at the description of flag 'expires' for details", + args: {}, }, { - name: "--doc", - description: "Show the cli command in a specific language", + name: ["-e", "--expires"], + description: + "Use the standard iso format with operators [gt, gteq, eq, lt, lteq]", + args: {}, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", - args: { - suggestions: ["curl", "node"], - }, + name: "--sort", + description: "A comma separated list of fields to sort by", + args: {}, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-L", "--locale"], + description: "Show dates in locale time zone and format", }, { - name: "--node", - description: - "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", }, + ], + args: { + name: "id", + description: "Unique id of the link to get a single link", + isOptional: true, + }, + }, + { + name: ["links:create", "link"], + description: "Create a new resource link", + options: [ { - name: "--save-args", - description: "Save command data to file for future use", + name: ["-o", "--organization"], + description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", - }, - { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-t", "--item_type"], + description: "The type of the resource for which the link is created", args: {}, }, { - name: ["-p", "--page"], - description: "Page number", + name: ["-i", "--item_id"], + description: "The id of the resource for which the link is created", args: {}, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-I", "--client_id"], + description: + "The client_id of the application of kind sales_channel to be used with the link", args: {}, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: "--scope", + description: "The application scope", args: {}, + hidden: true, }, { - name: ["-x", "--save"], - description: "Save command output to file", + name: ["-S", "--link_scope"], + description: "The scope of the link", args: {}, }, { - name: ["-X", "--save-path"], - description: - "Save command output to file and create missing path directories", + name: ["-n", "--name"], + description: "The name associated to the the link", args: {}, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: ["-s", "--starts"], + description: "Use the standard iso format: https://developer", args: {}, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyond the 3rd level", - hidden: true, + name: ["-e", "--expires"], + description: "Use the standard iso format: https://developer", + args: {}, }, - ], - args: [ { - name: "resource", - description: "The resource type", + name: ["-D", "--link_domain"], + description: "The domain of the link", + args: { + default: "c11r.link", + }, }, { - name: "id", - description: "Id of the resource to retrieve", - isOptional: true, + name: "--open", + description: "Open link in default browser", }, ], }, { - name: ["resources:list", "list", "rl", "res:list"], - description: "Fetch a collection of resources", + name: "links:delete", + description: "Delete an existent resource link", options: [ { name: ["-o", "--organization"], @@ -2375,249 +2838,185 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: "--accessToken", + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", args: {}, isRequired: true, hidden: true, }, + ], + args: { + name: "id", + description: "The id of the link", + }, + }, + { + name: ["links:details", "links:show", "links:get"], + description: "Show link details", + options: [ { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: ["-o", "--organization"], + description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-f", "--fields"], - description: - "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: ["-j", "--json"], - description: "Convert output in standard json format", + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: ["-L", "--locale"], + description: "Show dates in locale time zone and format", }, + ], + args: { + name: "id", + description: "The id of the link", + }, + }, + { + name: "links:disable", + description: "Disable an existing enabled link", + options: [ { - name: "--doc", - description: "Show the cli command in a specific language", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", - args: { - suggestions: ["curl", "node"], - }, + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", + args: {}, + isRequired: true, + hidden: true, }, + ], + args: { + name: "id", + description: "The id of the link", + }, + }, + { + name: "links:enable", + description: "Enable an existend disabled link", + options: [ { - name: "--node", - description: - "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, }, { - name: "--save-args", - description: "Save command data to file for future use", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", args: {}, + isRequired: true, + hidden: true, }, + ], + args: { + name: "id", + description: "The id of the link", + }, + }, + { + name: "links:list", + description: "List all the created links", + options: [ { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-p", "--page"], - description: "Page number", + name: ["-A", "--all"], + description: "Show all links instead of first 25 only", + }, + { + name: ["-l", "--limit"], + description: "Limit number of links in output", args: {}, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-n", "--name"], + description: "The name of the link", args: {}, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: ["-S", "--link_scope"], + description: "The scope of the link", args: {}, }, { - name: ["-x", "--save"], - description: "Save command output to file", + name: ["-s", "--starts"], + description: "Look at the description of flag 'expires' for details", args: {}, }, { - name: ["-X", "--save-path"], + name: ["-e", "--expires"], description: - "Save command output to file and create missing path directories", + "Use the standard iso format with operators [gt, gteq, eq, lt, lteq]", args: {}, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: "--sort", + description: "A comma separated list of fields to sort by", args: {}, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyond the 3rd level", - hidden: true, + name: ["-L", "--locale"], + description: "Show dates in locale time zone and format", }, ], - args: { - name: "resource", - description: "The resource type", - suggestions: [ - "addresses", - "adjustments", - "adyen_gateways", - "adyen_payments", - "attachments", - "authorizations", - "avalara_accounts", - "axerve_gateways", - "axerve_payments", - "billing_info_validation_rules", - "bing_geocoders", - "braintree_gateways", - "braintree_payments", - "bundles", - "buy_x_pay_y_promotions", - "captures", - "carrier_accounts", - "checkout_com_gateways", - "checkout_com_payments", - "cleanups", - "coupons", - "coupon_codes_promotion_rules", - "coupon_recipients", - "credit_cards", - "custom_promotion_rules", - "customers", - "customer_addresses", - "customer_groups", - "customer_password_resets", - "customer_payment_sources", - "customer_subscriptions", - "delivery_lead_times", - "events", - "event_callbacks", - "exports", - "external_gateways", - "external_payments", - "external_promotions", - "external_tax_calculators", - "fixed_amount_promotions", - "fixed_price_promotions", - "free_gift_promotions", - "free_shipping_promotions", - "geocoders", - "gift_cards", - "gift_card_recipients", - "google_geocoders", - "imports", - "in_stock_subscriptions", - "inventory_models", - "inventory_return_locations", - "inventory_stock_locations", - "klarna_gateways", - "klarna_payments", - "line_items", - "line_item_options", - "manual_gateways", - "manual_tax_calculators", - "markets", - "merchants", - "orders", - "order_amount_promotion_rules", - "order_copies", - "order_factories", - "order_subscriptions", - "order_subscription_items", - "order_validation_rules", - "packages", - "parcels", - "parcel_line_items", - "payment_gateways", - "payment_methods", - "payment_options", - "paypal_gateways", - "paypal_payments", - "percentage_discount_promotions", - "prices", - "price_frequency_tiers", - "price_lists", - "price_tiers", - "price_volume_tiers", - "promotions", - "promotion_rules", - "recurring_order_copies", - "refunds", - "reserved_stocks", - "resource_errors", - "returns", - "return_line_items", - "satispay_gateways", - "satispay_payments", - "shipments", - "shipment_line_items", - "shipping_categories", - "shipping_methods", - "shipping_method_tiers", - "shipping_weight_tiers", - "shipping_zones", - "skus", - "sku_lists", - "sku_list_items", - "sku_list_promotion_rules", - "sku_options", - "spreedly_gateways", - "stock_items", - "stock_line_items", - "stock_locations", - "stock_reservations", - "stock_transfers", - "stripe_gateways", - "stripe_payments", - "subscription_models", - "tags", - "tax_calculators", - "tax_categories", - "tax_rules", - "taxjar_accounts", - "transactions", - "versions", - "voids", - "webhooks", - "wire_transfers", - ], - }, }, { - name: ["relationship", "resources:rel", "res:rel", "res:relationship"], - description: "Fetch a resource relationship", + name: "links:open", + description: "Open an existent resource link", options: [ { name: ["-o", "--organization"], @@ -2632,136 +3031,166 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: "--accessToken", + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", args: {}, isRequired: true, hidden: true, }, + ], + args: { + name: "id", + description: "The id of the link", + }, + }, + { + name: "links:resources", + description: "Show linkable resources", + options: [ { - name: ["-i", "--include"], - description: "Comma separated resources to include", - args: {}, - }, - { - name: ["-f", "--fields"], - description: - "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: {}, - }, - { - name: ["-j", "--json"], - description: "Convert output in standard json format", + name: ["-O", "--open"], + description: "Open online documentation page", }, + ], + }, + { + name: "links:update", + description: "Create a new resource link", + options: [ { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: "--doc", - description: "Show the cli command in a specific language", + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", - args: { - suggestions: ["curl", "node"], - }, + name: ["-t", "--item_type"], + description: "The type of the resource for which the link is created", + args: {}, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-i", "--item_id"], + description: "The id of the resource for which the link is created", + args: {}, }, { - name: "--node", + name: ["-I", "--client_id"], description: - "Show the equivalent node sdk source code of the cli command", - hidden: false, - }, - { - name: "--save-args", - description: "Save command data to file for future use", + "The client_id of the application of kind sales_channel to be used with the link", args: {}, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: "--scope", + description: "The application scope", args: {}, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-S", "--link_scope"], + description: "The scope of the link", + args: {}, }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-n", "--name"], + description: "The name associated to the the link", + args: {}, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-s", "--starts"], + description: "Use the standard iso format: https://developer", args: {}, }, { - name: ["-p", "--page"], - description: "Page number", + name: ["-e", "--expires"], + description: "Use the standard iso format: https://developer", args: {}, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", - args: {}, + name: ["-D", "--link_domain"], + description: "The domain of the link", + args: { + default: "c11r.link", + }, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", - args: {}, + name: "--open", + description: "Open link in default browser", }, + ], + args: { + name: "id", + description: "The id of the link", + }, + }, + { + name: "webhooks", + description: + "List all the registered webhooks or the details of a single webhook", + options: [ { - name: ["-x", "--save"], - description: "Save command output to file", + name: ["-o", "--organization"], + description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-X", "--save-path"], - description: - "Save command output to file and create missing path directories", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: "--accessToken", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyond the 3rd level", - hidden: true, + name: ["-c", "--circuit"], + description: "Show only webhooks with circuit in the declared state", + args: { + suggestions: ["open", "closed"], + }, }, - ], - args: [ { - name: "resource", - description: "The resource type", + name: ["-t", "--topic"], + description: "The event that triggered the webhook", + args: {}, }, { - name: "id", - description: "Id of the resource to retrieve", + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", }, { - name: "relationship", - description: "Name of the relationship field", + name: ["-e", "--events"], + description: + "Show the last event callbacks associated to the webhook", }, ], - hidden: false, + args: { + name: "id", + description: "Unique id of the webhook to get a single webhook", + isOptional: true, + }, }, { - name: ["resources:retrieve", "retrieve", "rr", "res:retrieve"], - description: "Fetch a single resource", + name: ["webhooks:create", "wh:create"], + description: "Create a new webhook", options: [ { name: ["-o", "--organization"], @@ -2782,232 +3211,127 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", - args: {}, - }, - { - name: ["-f", "--fields"], + name: ["-t", "--topic"], description: - "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + "The identifier of the event that will trigger the webhook", args: {}, + isRequired: true, }, { - name: ["-j", "--json"], - description: "Convert output in standard json format", + name: ["-u", "--url"], + description: "The callback url used to post data", + args: {}, + isRequired: true, }, { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: ["-i", "--include"], + description: + "A comma separated list of related resources to be included", + args: {}, }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: ["-n", "--name"], + description: "The webhook short name", + args: {}, }, + ], + }, + { + name: ["webhooks:destroy", "webhooks:delete", "wh:delete", "wh:destroy"], + description: "Destroy an existing webhook", + options: [ { - name: "--doc", - description: "Show the cli command in a specific language", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", - args: { - suggestions: ["curl", "node"], - }, + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:details", "wh:details"], + description: "Show the details of an existing webhook", + options: [ { - name: "--node", - description: - "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, }, { - name: "--save-args", - description: "Save command data to file for future use", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: "--accessToken", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-e", "--events"], + description: + "Show the last event callbacks associated to the webhook", }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:disable", "wh:disable"], + description: "Disable an enabled webhook", + options: [ { - name: ["-x", "--save"], - description: "Save command output to file", + name: ["-o", "--organization"], + description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-X", "--save-path"], - description: - "Save command output to file and create missing path directories", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: "--accessToken", args: {}, + isRequired: true, + hidden: true, }, ], - args: [ - { - name: "resource", - description: "The resource type", - suggestions: [ - "address", - "adjustment", - "adyen_gateway", - "adyen_payment", - "application", - "attachment", - "authorization", - "avalara_account", - "axerve_gateway", - "axerve_payment", - "billing_info_validation_rule", - "bing_geocoder", - "braintree_gateway", - "braintree_payment", - "bundle", - "buy_x_pay_y_promotion", - "capture", - "carrier_account", - "checkout_com_gateway", - "checkout_com_payment", - "cleanup", - "coupon", - "coupon_codes_promotion_rule", - "coupon_recipient", - "credit_card", - "custom_promotion_rule", - "customer", - "customer_address", - "customer_group", - "customer_password_reset", - "customer_payment_source", - "customer_subscription", - "delivery_lead_time", - "event", - "event_callback", - "export", - "external_gateway", - "external_payment", - "external_promotion", - "external_tax_calculator", - "fixed_amount_promotion", - "fixed_price_promotion", - "free_gift_promotion", - "free_shipping_promotion", - "geocoder", - "gift_card", - "gift_card_recipient", - "google_geocoder", - "import", - "in_stock_subscription", - "inventory_model", - "inventory_return_location", - "inventory_stock_location", - "klarna_gateway", - "klarna_payment", - "line_item", - "line_item_option", - "manual_gateway", - "manual_tax_calculator", - "market", - "merchant", - "order", - "order_amount_promotion_rule", - "order_copy", - "order_factory", - "order_subscription", - "order_subscription_item", - "order_validation_rule", - "organization", - "package", - "parcel", - "parcel_line_item", - "payment_gateway", - "payment_method", - "payment_option", - "paypal_gateway", - "paypal_payment", - "percentage_discount_promotion", - "price", - "price_frequency_tier", - "price_list", - "price_tier", - "price_volume_tier", - "promotion", - "promotion_rule", - "recurring_order_copy", - "refund", - "reserved_stock", - "resource_error", - "return", - "return_line_item", - "satispay_gateway", - "satispay_payment", - "shipment", - "shipment_line_item", - "shipping_category", - "shipping_method", - "shipping_method_tier", - "shipping_weight_tier", - "shipping_zone", - "sku", - "sku_list", - "sku_list_item", - "sku_list_promotion_rule", - "sku_option", - "spreedly_gateway", - "stock_item", - "stock_line_item", - "stock_location", - "stock_reservation", - "stock_transfer", - "stripe_gateway", - "stripe_payment", - "subscription_model", - "tag", - "tax_calculator", - "tax_category", - "tax_rule", - "taxjar_account", - "transaction", - "version", - "void", - "webhook", - "wire_transfer", - ], - }, - { - name: "id", - description: "Id of the resource to retrieve", - isOptional: true, - }, - ], - }, - { - name: ["resources:schema", "schema", "res:schema", "rs"], - description: - "Show the current commercelayer openapi schema version used by the plugin", + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - name: ["resources:update", "update", "ru", "res:update", "patch"], - description: "Update an existing resource", + name: ["webhooks:enable", "wh:enable"], + description: "Enable a disabled webhook", options: [ { name: ["-o", "--organization"], @@ -3027,217 +3351,812 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:event", "wh:event"], + description: "Show the details of a firedf webhook event", + options: [ { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: ["-o", "--organization"], + description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-f", "--fields"], - description: - "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: ["-j", "--json"], - description: "Convert output in standard json format", - }, - { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", - }, - { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, - }, - { - name: "--doc", - description: "Show the cli command in a specific language", + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", - args: { - suggestions: ["curl", "node"], - }, + name: ["-p", "--payload"], + description: "Show the event payload sent to the callback endpoint", }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-f", "--format"], + description: "Format the payload output", }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:events", "wh:events"], + description: "List all the events associated to the webhook", + options: [ { - name: "--node", - description: - "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, }, { - name: "--save-args", - description: "Save command data to file for future use", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: "--accessToken", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-A", "--all"], + description: "Show all events instead of first 25 only", }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-l", "--limit"], + description: "Limit number of events in output", + args: {}, }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:list", "wh:list"], + description: "List all the registered webhooks", + options: [ { - name: ["-a", "--attribute"], - description: "Define a resource attribute", + name: ["-o", "--organization"], + description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-O", "--object"], - description: "Define a resource object attribute", + name: ["-d", "--domain"], args: {}, + hidden: true, }, { - name: ["-r", "--relationship"], - description: "Define a relationship with another resource", + name: "--accessToken", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-m", "--metadata"], - description: "", + name: ["-c", "--circuit"], + description: "Show only webhooks with circuit in the declared state", + args: { + suggestions: ["open", "closed"], + }, + }, + { + name: ["-t", "--topic"], + description: "The event that triggered the webhook", + args: {}, + }, + ], + }, + { + name: ["webhooks:listen", "wh:listen"], + description: "Listen a webhook for outgoing callbacks", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-t", "--time"], + description: "Waiting time for the first event", + args: { + default: "120", + }, + }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:payload", "wh:payload"], + description: "Show the payload associated to an event callback", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-f", "--format"], + description: "Format the payload output", + }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:reset", "wh:reset"], + description: "Reset the circuit breaker associated to the webhook", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:topics", "wh:topics"], + description: "Show online documentation for supported events", + }, + { + name: ["webhooks:update", "wh:update"], + description: "Update an existing webhook", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-t", "--topic"], + description: + "The identifier of the event that will trigger the webhook", + args: {}, + }, + { + name: ["-u", "--url"], + description: "The callback url used to post data", + args: {}, + }, + { + name: ["-i", "--include"], + description: + "A comma separated list of related resources to be included", + args: {}, + }, + { + name: ["-n", "--name"], + description: "The webhook short name", + args: {}, + }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: "microstore", + description: "Create microstore urls", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", + args: {}, + isRequired: true, + hidden: false, + }, + { + name: "--open", + description: "Open microstore url in default browser", + }, + { + name: "--staging", + description: + "Connect to microstore application in staging environment", + hidden: true, + }, + { + name: ["-S", "--skuListId"], + description: "The sku list id", + args: {}, + }, + { + name: ["-K", "--skuId"], + description: "The sku id", + args: {}, + }, + { + name: ["-A", "--all"], + description: "Activate the buy all button", + }, + { + name: ["-C", "--cart"], + description: "Activate the cart application", + }, + { + name: ["-I", "--inline"], + description: "Disable redirect to cart application", + exclusiveOn: ["--no-inline"], + }, + { + name: "--no-inline", + }, + { + name: ["-l", "--lang"], + description: "The language used for microstore", + args: { + suggestions: ["en", "it"], + default: "en", + }, + }, + ], + }, + { + name: "checkout", + description: "Create checkout urls", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", + args: {}, + isRequired: true, + hidden: false, + }, + { + name: "--open", + description: "Open checkout url in default browser", + }, + { + name: "--staging", + description: "Connect to checkout application in staging environment", + hidden: true, + }, + { + name: ["-l", "--link"], + description: "Generate short link", + }, + { + name: ["-O", "--order"], + description: "An order id", + args: {}, + }, + { + name: ["-S", "--sku"], + description: "An sku code", + args: {}, + }, + { + name: ["-B", "--bundle"], + description: "A bundle code", + args: {}, + }, + { + name: ["-m", "--market"], + description: "A market number", + args: {}, + }, + { + name: ["-c", "--coupon"], + description: "A promo code", + args: {}, + }, + { + name: ["-e", "--email"], + description: "A customer email", + args: {}, + }, + ], + }, + { + name: "checkout:order", + description: "Create checkout urls starting from an existing order", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: ["-a", "--accessToken"], + description: + "Custom access token to use instead of the one used for login", + args: {}, + isRequired: true, + hidden: false, + }, + { + name: "--open", + description: "Open checkout url in default browser", + }, + { + name: "--staging", + description: "Connect to checkout application in staging environment", + hidden: true, + }, + { + name: ["-l", "--link"], + description: "Generate short link", + }, + ], + args: { + name: "id", + description: "Unique id of the order", + }, + }, + { + name: "imports", + description: + "List all the created imports or show details of a single import", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-A", "--all"], + description: "Show all imports instead of first 25 only", + }, + { + name: ["-t", "--type"], + description: "The type of resource imported", + args: { + suggestions: [ + "addresses", + "bundles", + "coupons", + "customer_addresses", + "customer_payment_sources", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "line_item_options", + "orders", + "price_tiers", + "prices", + "shipping_categories", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "stock_transfers", + "tags", + "tax_categories", + ], + }, + }, + { + name: ["-g", "--group"], + description: + "The group id associated to the import in case of multi-chunk imports", + args: {}, + }, + { + name: ["-s", "--status"], + description: "The import job status", + args: { + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, + }, + { + name: ["-e", "--errors"], + description: "Show only imports with errors", + }, + { + name: ["-w", "--warnings"], + description: "Show only import with warnings", + }, + { + name: ["-l", "--limit"], + description: "Limit number of imports in output", + args: {}, + }, + ], + args: { + name: "id", + description: "Unique id of the import to be retrieved", + isOptional: true, + }, + }, + { + name: ["imports:create", "imp:create", "import"], + description: "Create a new import", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-t", "--type"], + description: "The type of resource being imported", + args: { + description: "Addresses|bundles|coupons|customer_addresses|etc", + suggestions: [ + "addresses", + "bundles", + "coupons", + "customer_addresses", + "customer_payment_sources", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "line_item_options", + "orders", + "price_tiers", + "prices", + "shipping_categories", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "stock_transfers", + "tags", + "tax_categories", + ], + }, + isRequired: true, + }, + { + name: ["-p", "--parent"], + description: + "The id of the parent resource to be associated with imported data", + args: {}, + }, + { + name: ["-i", "--inputs"], + description: "The path of the file containing the data to import", + args: {}, + isRequired: true, + }, + { + name: ["-C", "--csv"], + description: "Accept input file in csv format", + }, + { + name: ["-b", "--blind"], + description: + "Execute in blind mode without showing the progress monitor", + }, + { + name: ["-q", "--quiet"], + description: "Execute command without showing warning messages", + }, + ], + }, + { + name: ["imports:delete", "imp:delete"], + description: "Delete an existing import", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", args: {}, + isRequired: true, + hidden: true, }, + ], + args: { + name: "id", + description: "Unique id of the import", + }, + }, + { + name: ["imports:details", "imp:details"], + description: "Show the details of an existing import", + options: [ { - name: ["-M", "--metadata-replace"], - description: "", + name: ["-o", "--organization"], + description: "The slug of your organization", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-D", "--data"], - description: "The data file to use as request body", + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", args: {}, + isRequired: true, + hidden: true, }, { - name: ["-t", "--tags"], - description: "List of tags associated with the resource", + name: ["-i", "--inputs"], + description: "Show input items associated with the import", + }, + { + name: ["-l", "--logs"], + description: + "Show warning and error logs related to the import process", + }, + { + name: ["-S", "--save-inputs"], + description: "Save import inputs to local file", args: {}, }, ], - args: [ + args: { + name: "id", + description: "Unique id of the import", + }, + }, + { + name: ["imports:group", "imp:group"], + description: "List all the imports related to an import group", + options: [ { - name: "resource", - description: "The resource type", - suggestions: [ - "address", - "adjustment", - "adyen_gateway", - "adyen_payment", - "attachment", - "authorization", - "avalara_account", - "axerve_gateway", - "axerve_payment", - "billing_info_validation_rule", - "bing_geocoder", - "braintree_gateway", - "braintree_payment", - "bundle", - "buy_x_pay_y_promotion", - "capture", - "checkout_com_gateway", - "checkout_com_payment", - "coupon", - "coupon_codes_promotion_rule", - "coupon_recipient", - "credit_card", - "custom_promotion_rule", - "customer", - "customer_address", - "customer_group", - "customer_password_reset", - "customer_payment_source", - "customer_subscription", - "delivery_lead_time", - "external_gateway", - "external_payment", - "external_promotion", - "external_tax_calculator", - "fixed_amount_promotion", - "fixed_price_promotion", - "free_gift_promotion", - "free_shipping_promotion", - "gift_card", - "gift_card_recipient", - "google_geocoder", - "in_stock_subscription", - "inventory_model", - "inventory_return_location", - "inventory_stock_location", - "klarna_gateway", - "klarna_payment", - "line_item", - "line_item_option", - "manual_gateway", - "manual_tax_calculator", - "market", - "merchant", - "order", - "order_amount_promotion_rule", - "order_copy", - "order_subscription", - "order_subscription_item", - "package", - "parcel", - "parcel_line_item", - "payment_method", - "payment_option", - "paypal_gateway", - "paypal_payment", - "percentage_discount_promotion", - "price", - "price_frequency_tier", - "price_list", - "price_volume_tier", - "recurring_order_copy", - "return", - "return_line_item", - "satispay_gateway", - "satispay_payment", - "shipment", - "shipping_category", - "shipping_method", - "shipping_weight_tier", - "shipping_zone", - "sku", - "sku_list", - "sku_list_item", - "sku_list_promotion_rule", - "sku_option", - "spreedly_gateway", - "stock_item", - "stock_line_item", - "stock_location", - "stock_reservation", - "stock_transfer", - "stripe_gateway", - "stripe_payment", - "subscription_model", - "tag", - "tax_category", - "tax_rule", - "taxjar_account", - "webhook", - "wire_transfer", - ], + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + ], + args: { + name: "group_id", + description: "Unique id of the group import", + }, + }, + { + name: ["imports:list", "imp:list"], + description: "List all the created imports", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-A", "--all"], + description: "Show all imports instead of first 25 only", + }, + { + name: ["-t", "--type"], + description: "The type of resource imported", + args: { + suggestions: [ + "addresses", + "bundles", + "coupons", + "customer_addresses", + "customer_payment_sources", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "line_item_options", + "orders", + "price_tiers", + "prices", + "shipping_categories", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "stock_transfers", + "tags", + "tax_categories", + ], + }, + }, + { + name: ["-g", "--group"], + description: + "The group id associated to the import in case of multi-chunk imports", + args: {}, + }, + { + name: ["-s", "--status"], + description: "The import job status", + args: { + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, + }, + { + name: ["-e", "--errors"], + description: "Show only imports with errors", + }, + { + name: ["-w", "--warnings"], + description: "Show only import with warnings", + }, + { + name: ["-l", "--limit"], + description: "Limit number of imports in output", + args: {}, }, + ], + }, + { + name: ["imports:types", "imp:types"], + description: "Show online documentation for supported resources", + options: [ { - name: "id", - description: "Id of the resource to update", - isOptional: true, + name: ["-O", "--open"], + description: "Open online documentation page", }, ], }, @@ -3780,6 +4699,47 @@ const completionSpec: Fig.Spec = { description: "The unique id of the order", }, }, + { + name: "orders:fulfill", + description: + "Send this attribute if you want to mark as fulfilled a shipped/delivered order", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-p", "--print"], + description: "Print out the modified order", + }, + { + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, { name: "orders:nullify_payment_source", description: @@ -4477,13 +5437,215 @@ const completionSpec: Fig.Spec = { ], args: { name: "id", - description: "The unique id of the order", + description: "The unique id of the order", + }, + }, + { + name: ["token:decode", "token:info"], + description: "Decode a commerce layer access token", + args: { + name: "token", + description: "The access token to be decoded", + }, + }, + { + name: "token:generate", + description: "Start a wizard to generate a custom access token", + options: [ + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: ["-p", "--print"], + description: "Print users answers", + hidden: true, + }, + { + name: ["-i", "--info"], + description: "Print generated token info", + }, + { + name: ["-c", "--check"], + description: "Check generated access token", + }, + ], + }, + { + name: "token:get", + description: "Get a new access token", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: ["-i", "--clientId"], + description: "Application client_id", + args: {}, + isRequired: true, + }, + { + name: ["-s", "--clientSecret"], + description: "Application client_secret", + args: {}, + }, + { + name: ["-S", "--scope"], + description: "Access token scope (market, stock location)", + args: {}, + }, + { + name: ["-e", "--email"], + description: "Customer email", + args: {}, + }, + { + name: ["-p", "--password"], + description: "Customer secret password", + args: {}, + }, + { + name: "--info", + description: "Show access token info", + }, + { + name: ["-P", "--provisioning"], + description: "Execute login to provisioning api", + }, + ], + }, + { + name: "token:revoke", + description: "Revoke a commerce layer access token", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: ["-i", "--clientId"], + description: "Application client_id", + args: {}, + isRequired: true, + }, + { + name: ["-s", "--clientSecret"], + description: "Application client_secret", + args: {}, + }, + { + name: ["-S", "--scope"], + description: "Access token scope", + args: {}, + }, + { + name: ["-P", "--provisioning"], + description: "Execute login to provisioning api", + }, + ], + args: { + name: "token", + description: "Access token to revoke", + }, + }, + { + name: "adyen_payment", + description: "Execute an action on a resource of type adyen_payments", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-p", "--print"], + description: "Print out the modified resource", + }, + { + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + ], + args: { + name: "id", + description: "The unique id of the resource", + }, + }, + { + name: "adyen_payment:details", + description: + "Send this attribute if you want to send additional details the payment request", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-p", "--print"], + description: "Print out the modified resource", + }, + { + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + ], + args: { + name: "id", + description: "The unique id of the resource", }, }, { - name: "webhooks", - description: - "List all the registered webhooks or the details of a single webhook", + name: "authorization", + description: "Execute an action on a resource of type authorizations", options: [ { name: ["-o", "--organization"], @@ -4504,36 +5666,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-c", "--circuit"], - description: "Show only webhooks with circuit in the declared state", - args: { - suggestions: ["open", "closed"], - }, - }, - { - name: ["-t", "--topic"], - description: "The event that triggered the webhook", - args: {}, + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - name: ["-H", "--hide-empty"], - description: "Hide empty attributes", + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-e", "--events"], - description: - "Show the last event callbacks associated to the webhook", + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook to get a single webhook", - isOptional: true, + description: "The unique id of the resource", }, }, { - name: ["webhooks:create", "wh:create"], - description: "Create a new webhook", + name: "authorization:capture", + description: + "Send this attribute if you want to create a capture for this authorization", options: [ { name: ["-o", "--organization"], @@ -4554,34 +5707,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-t", "--topic"], - description: - "The identifier of the event that will trigger the webhook", - args: {}, - isRequired: true, - }, - { - name: ["-u", "--url"], - description: "The callback url used to post data", - args: {}, - isRequired: true, + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - name: ["-i", "--include"], - description: - "A comma separated list of related resources to be included", - args: {}, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-n", "--name"], - description: "The webhook short name", - args: {}, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - name: ["webhooks:destroy", "webhooks:delete", "wh:delete", "wh:destroy"], - description: "Destroy an existing webhook", + name: "authorization:capture_amount_cents", + description: + "Send this attribute as a value in cents if you want to overwrite the amount to b", options: [ { name: ["-o", "--organization"], @@ -4601,15 +5747,28 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, + { + name: ["-p", "--print"], + description: "Print out the modified resource", + }, + { + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the resource", }, }, { - name: ["webhooks:details", "wh:details"], - description: "Show the details of an existing webhook", + name: "authorization:forward", + description: + "Send this attribute if you want to forwrad a stuck transaction to succeeded and", options: [ { name: ["-o", "--organization"], @@ -4630,23 +5789,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-H", "--hide-empty"], - description: "Hide empty attributes", + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - name: ["-e", "--events"], - description: - "Show the last event callbacks associated to the webhook", + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the resource", }, }, { - name: ["webhooks:event", "wh:event"], - description: "Show the details of a firedf webhook event", + name: "authorization:void", + description: + "Send this attribute if you want to create a void for this authorization", options: [ { name: ["-o", "--organization"], @@ -4667,22 +5830,26 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-p", "--payload"], - description: "Show the event payload sent to the callback endpoint", + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - name: ["-f", "--format"], - description: "Format the payload output", + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the resource", }, }, { - name: ["webhooks:events", "wh:events"], - description: "List all the events associated to the webhook", + name: "axerve_payment", + description: "Execute an action on a resource of type axerve_payments", options: [ { name: ["-o", "--organization"], @@ -4703,23 +5870,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-A", "--all"], - description: "Show all events instead of first 25 only", + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - name: ["-l", "--limit"], - description: "Limit number of events in output", - args: {}, + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the resource", }, }, { - name: ["webhooks:list", "wh:list"], - description: "List all the registered webhooks", + name: "axerve_payment:update", + description: + "Send this attribute if you want to update the payment with fresh order data", options: [ { name: ["-o", "--organization"], @@ -4740,22 +5911,26 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-c", "--circuit"], - description: "Show only webhooks with circuit in the declared state", - args: { - suggestions: ["open", "closed"], - }, + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - name: ["-t", "--topic"], - description: "The event that triggered the webhook", - args: {}, + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - name: ["webhooks:listen", "wh:listen"], - description: "Listen a webhook for outgoing callbacks", + name: "bundle", + description: "Execute an action on a resource of type bundles", options: [ { name: ["-o", "--organization"], @@ -4776,21 +5951,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-t", "--time"], - description: "Waiting time for the first event", - args: { - default: "120", - }, + name: ["-p", "--print"], + description: "Print out the modified resource", + }, + { + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the resource", }, }, { - name: ["webhooks:payload", "wh:payload"], - description: "Show the payload associated to an event callback", + name: "bundle:compute_compare_at_amount", + description: + "Send this attribute if you want to compute the compare_at_amount_cents as the su", options: [ { name: ["-o", "--organization"], @@ -4811,18 +5992,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-f", "--format"], - description: "Format the payload output", + name: ["-p", "--print"], + description: "Print out the modified resource", + }, + { + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the resource", }, }, { - name: ["webhooks:reset", "wh:reset"], - description: "Reset the circuit breaker associated to the webhook", + name: "bundle:compute_price_amount", + description: + "Send this attribute if you want to compute the price_amount_cents as the sum of", options: [ { name: ["-o", "--organization"], @@ -4842,19 +6032,28 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, + { + name: ["-p", "--print"], + description: "Print out the modified resource", + }, + { + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the resource", }, }, { - name: ["webhooks:topics", "wh:topics"], - description: "Show online documentation for supported events", - }, - { - name: ["webhooks:update", "wh:update"], - description: "Update an existing webhook", + name: "buy_x_pay_y_promotion", + description: + "Execute an action on a resource of type buy_x_pay_y_promotions", options: [ { name: ["-o", "--organization"], @@ -4875,36 +6074,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-t", "--topic"], - description: - "The identifier of the event that will trigger the webhook", - args: {}, - }, - { - name: ["-u", "--url"], - description: "The callback url used to post data", - args: {}, + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - name: ["-i", "--include"], - description: - "A comma separated list of related resources to be included", - args: {}, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-n", "--name"], - description: "The webhook short name", - args: {}, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the resource", }, }, { - name: "adyen_payment", - description: "Execute an action on a resource of type adyen_payments", + name: "buy_x_pay_y_promotion:disable", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -4943,9 +6133,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "adyen_payment:details", + name: "buy_x_pay_y_promotion:enable", description: - "Send this attribute if you want to send additional details the payment request", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -4984,8 +6174,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "authorization", - description: "Execute an action on a resource of type authorizations", + name: "capture", + description: "Execute an action on a resource of type captures", options: [ { name: ["-o", "--organization"], @@ -5024,9 +6214,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "authorization:capture", + name: "capture:forward", description: - "Send this attribute if you want to create a capture for this authorization", + "Send this attribute if you want to forwrad a stuck transaction to succeeded and", options: [ { name: ["-o", "--organization"], @@ -5065,8 +6255,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "authorization:capture_amount_cents", - description: "The associated capture amount, in cents", + name: "capture:refund", + description: + "Send this attribute if you want to create a refund for this capture", options: [ { name: ["-o", "--organization"], @@ -5105,9 +6296,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "authorization:void", + name: "capture:refund_amount_cents", description: - "Send this attribute if you want to create a void for this authorization", + "Send this attribute as a value in cents if you want to overwrite the amount to b", options: [ { name: ["-o", "--organization"], @@ -5146,8 +6337,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "axerve_payment", - description: "Execute an action on a resource of type axerve_payments", + name: "checkout_com_payment", + description: + "Execute an action on a resource of type checkout_com_payments", options: [ { name: ["-o", "--organization"], @@ -5186,9 +6378,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "axerve_payment:update", + name: "checkout_com_payment:details", description: - "Send this attribute if you want to update the payment with fresh order data", + "Send this attribute if you want to send additional details the payment request (", options: [ { name: ["-o", "--organization"], @@ -5227,8 +6419,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "bundle", - description: "Execute an action on a resource of type bundles", + name: "checkout_com_payment:refresh", + description: + "Send this attribute if you want to refresh all the pending transactions, can be", options: [ { name: ["-o", "--organization"], @@ -5267,9 +6460,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "bundle:compute_compare_at_amount", + name: "customer_password_reset", description: - "Send this attribute if you want to compute the compare_at_amount_cents as the su", + "Execute an action on a resource of type customer_password_resets", options: [ { name: ["-o", "--organization"], @@ -5308,9 +6501,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "bundle:compute_price_amount", + name: "customer_password_reset:reset_password_token", description: - "Send this attribute if you want to compute the price_amount_cents as the sum of", + "Send the 'reset_password_token' that you got on create when updating the custome", options: [ { name: ["-o", "--organization"], @@ -5349,9 +6542,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "buy_x_pay_y_promotion", - description: - "Execute an action on a resource of type buy_x_pay_y_promotions", + name: "external_gateway", + description: "Execute an action on a resource of type external_gateways", options: [ { name: ["-o", "--organization"], @@ -5390,9 +6582,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "buy_x_pay_y_promotion:disable", + name: "external_gateway:reset_circuit", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -5431,9 +6623,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "buy_x_pay_y_promotion:enable", + name: "external_promotion", description: - "Send this attribute if you want to mark this resource as enabled", + "Execute an action on a resource of type external_promotions", options: [ { name: ["-o", "--organization"], @@ -5472,8 +6664,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "capture", - description: "Execute an action on a resource of type captures", + name: "external_promotion:disable", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -5512,9 +6705,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "capture:refund", + name: "external_promotion:enable", description: - "Send this attribute if you want to create a refund for this capture", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -5553,8 +6746,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "capture:refund_amount_cents", - description: "The associated refund amount, in cents", + name: "external_promotion:reset_circuit", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -5593,9 +6787,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "checkout_com_payment", + name: "external_tax_calculator", description: - "Execute an action on a resource of type checkout_com_payments", + "Execute an action on a resource of type external_tax_calculators", options: [ { name: ["-o", "--organization"], @@ -5634,9 +6828,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "checkout_com_payment:details", + name: "external_tax_calculator:reset_circuit", description: - "Send this attribute if you want to send additional details the payment request (", + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -5675,9 +6869,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "checkout_com_payment:refresh", + name: "fixed_amount_promotion", description: - "Send this attribute if you want to refresh all the pending transactions, can be", + "Execute an action on a resource of type fixed_amount_promotions", options: [ { name: ["-o", "--organization"], @@ -5716,9 +6910,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "customer_password_reset", + name: "fixed_amount_promotion:disable", description: - "Execute an action on a resource of type customer_password_resets", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -5757,9 +6951,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "customer_password_reset:reset_password_token", + name: "fixed_amount_promotion:enable", description: - "Send the 'reset_password_token' that you got on create when updating the custome", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -5798,8 +6992,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_gateway", - description: "Execute an action on a resource of type external_gateways", + name: "fixed_price_promotion", + description: + "Execute an action on a resource of type fixed_price_promotions", options: [ { name: ["-o", "--organization"], @@ -5838,9 +7033,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_gateway:reset_circuit", + name: "fixed_price_promotion:disable", description: - "Send this attribute if you want to reset the circuit breaker associated to this", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -5879,9 +7074,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_promotion", + name: "fixed_price_promotion:enable", description: - "Execute an action on a resource of type external_promotions", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -5920,9 +7115,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_promotion:disable", + name: "free_gift_promotion", description: - "Send this attribute if you want to mark this resource as disabled", + "Execute an action on a resource of type free_gift_promotions", options: [ { name: ["-o", "--organization"], @@ -5961,9 +7156,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_promotion:enable", + name: "free_gift_promotion:disable", description: - "Send this attribute if you want to mark this resource as enabled", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -6002,9 +7197,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_promotion:reset_circuit", + name: "free_gift_promotion:enable", description: - "Send this attribute if you want to reset the circuit breaker associated to this", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -6043,9 +7238,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_tax_calculator", + name: "free_shipping_promotion", description: - "Execute an action on a resource of type external_tax_calculators", + "Execute an action on a resource of type free_shipping_promotions", options: [ { name: ["-o", "--organization"], @@ -6084,9 +7279,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_tax_calculator:reset_circuit", + name: "free_shipping_promotion:disable", description: - "Send this attribute if you want to reset the circuit breaker associated to this", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -6125,9 +7320,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_amount_promotion", + name: "free_shipping_promotion:enable", description: - "Execute an action on a resource of type fixed_amount_promotions", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -6166,9 +7361,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_amount_promotion:disable", - description: - "Send this attribute if you want to mark this resource as disabled", + name: "gift_card", + description: "Execute an action on a resource of type gift_cards", options: [ { name: ["-o", "--organization"], @@ -6207,9 +7401,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_amount_promotion:enable", - description: - "Send this attribute if you want to mark this resource as enabled", + name: "gift_card:activate", + description: "Send this attribute if you want to activate a gift card", options: [ { name: ["-o", "--organization"], @@ -6248,9 +7441,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_price_promotion", - description: - "Execute an action on a resource of type fixed_price_promotions", + name: "gift_card:balance_change_cents", + description: "The balance change, in cents", options: [ { name: ["-o", "--organization"], @@ -6289,9 +7481,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_price_promotion:disable", - description: - "Send this attribute if you want to mark this resource as disabled", + name: "gift_card:deactivate", + description: "Send this attribute if you want to deactivate a gift card", options: [ { name: ["-o", "--organization"], @@ -6330,9 +7521,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_price_promotion:enable", + name: "gift_card:purchase", description: - "Send this attribute if you want to mark this resource as enabled", + "Send this attribute if you want to confirm a draft gift card", options: [ { name: ["-o", "--organization"], @@ -6371,9 +7562,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_gift_promotion", + name: "in_stock_subscription", description: - "Execute an action on a resource of type free_gift_promotions", + "Execute an action on a resource of type in_stock_subscriptions", options: [ { name: ["-o", "--organization"], @@ -6412,9 +7603,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_gift_promotion:disable", + name: "in_stock_subscription:activate", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to activate an inactive subscription", options: [ { name: ["-o", "--organization"], @@ -6453,9 +7644,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_gift_promotion:enable", + name: "in_stock_subscription:deactivate", description: - "Send this attribute if you want to mark this resource as enabled", + "Send this attribute if you want to dactivate an active subscription", options: [ { name: ["-o", "--organization"], @@ -6494,9 +7685,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_shipping_promotion", - description: - "Execute an action on a resource of type free_shipping_promotions", + name: "klarna_payment", + description: "Execute an action on a resource of type klarna_payments", options: [ { name: ["-o", "--organization"], @@ -6535,9 +7725,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_shipping_promotion:disable", + name: "klarna_payment:update", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to update the payment session with fresh order d", options: [ { name: ["-o", "--organization"], @@ -6576,9 +7766,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_shipping_promotion:enable", - description: - "Send this attribute if you want to mark this resource as enabled", + name: "line_item", + description: "Execute an action on a resource of type line_items", options: [ { name: ["-o", "--organization"], @@ -6617,8 +7806,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card", - description: "Execute an action on a resource of type gift_cards", + name: "line_item:external_price", + description: + "When creating or updating a new line item, set this attribute to '1' if you want", options: [ { name: ["-o", "--organization"], @@ -6657,8 +7847,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card:activate", - description: "Send this attribute if you want to activate a gift card", + name: "line_item:reserve_stock", + description: + "Send this attribute if you want to reserve the stock for the line item's skus qu", options: [ { name: ["-o", "--organization"], @@ -6697,8 +7888,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card:balance_change_cents", - description: "The balance change, in cents", + name: "line_item:reset_circuit", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -6737,8 +7929,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card:deactivate", - description: "Send this attribute if you want to deactivate a gift card", + name: "link:disable", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -6777,9 +7970,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card:purchase", + name: "link:enable", description: - "Send this attribute if you want to confirm a draft gift card", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -6818,9 +8011,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "in_stock_subscription", - description: - "Execute an action on a resource of type in_stock_subscriptions", + name: "market", + description: "Execute an action on a resource of type markets", options: [ { name: ["-o", "--organization"], @@ -6859,9 +8051,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "in_stock_subscription:activate", + name: "market:disable", description: - "Send this attribute if you want to activate an inactive subscription", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -6900,9 +8092,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "in_stock_subscription:deactivate", + name: "market:enable", description: - "Send this attribute if you want to dactivate an active subscription", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -6941,8 +8133,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "klarna_payment", - description: "Execute an action on a resource of type klarna_payments", + name: "order", + description: "Execute an action on a resource of type orders", options: [ { name: ["-o", "--organization"], @@ -6981,9 +8173,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "klarna_payment:update", + name: "order_subscription", description: - "Send this attribute if you want to update the payment session with fresh order d", + "Execute an action on a resource of type order_subscriptions", options: [ { name: ["-o", "--organization"], @@ -7022,8 +8214,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "line_item", - description: "Execute an action on a resource of type line_items", + name: "order_subscription:activate", + description: + "Send this attribute if you want to mark this subscription as active", options: [ { name: ["-o", "--organization"], @@ -7062,9 +8255,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "line_item:external_price", + name: "order_subscription:cancel", description: - "When creating or updating a new line item, set this attribute to '1' if you want", + "Send this attribute if you want to mark this subscription as cancelled", options: [ { name: ["-o", "--organization"], @@ -7103,9 +8296,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "line_item:reserve_stock", + name: "order_subscription:convert", description: - "Send this attribute if you want to reserve the stock for the line item's skus qu", + "Send this attribute if you want to convert a manual subscription to an automatic", options: [ { name: ["-o", "--organization"], @@ -7144,9 +8337,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "line_item:reset_circuit", + name: "order_subscription:deactivate", description: - "Send this attribute if you want to reset the circuit breaker associated to this", + "Send this attribute if you want to mark this subscription as inactive", options: [ { name: ["-o", "--organization"], @@ -7185,8 +8378,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "market", - description: "Execute an action on a resource of type markets", + name: "order:approve", + description: "Send this attribute if you want to approve a placed order", options: [ { name: ["-o", "--organization"], @@ -7225,9 +8418,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "market:disable", + name: "order:approve_and_capture", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to approve and capture a placed order", options: [ { name: ["-o", "--organization"], @@ -7266,9 +8459,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "market:enable", - description: - "Send this attribute if you want to mark this resource as enabled", + name: "order:archive", + description: "Send this attribute if you want to archive the order", options: [ { name: ["-o", "--organization"], @@ -7307,8 +8499,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order", - description: "Execute an action on a resource of type orders", + name: "order:authorization_amount_cents", + description: + "Send this attribute as a value in cents if you want to overwrite the amount to b", options: [ { name: ["-o", "--organization"], @@ -7347,9 +8540,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order_subscription", + name: "order:authorize", description: - "Execute an action on a resource of type order_subscriptions", + "Send this attribute if you want to authorize the order's payment source", options: [ { name: ["-o", "--organization"], @@ -7388,9 +8581,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order_subscription:activate", + name: "order:billing_address_clone_id", description: - "Send this attribute if you want to mark this subscription as active", + "The id of the address that you want to clone to create the order's billing addre", options: [ { name: ["-o", "--organization"], @@ -7422,6 +8615,12 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, + { + name: ["-v", "--value"], + description: "The trigger attribute value", + args: {}, + isRequired: true, + }, ], args: { name: "id", @@ -7429,9 +8628,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order_subscription:cancel", + name: "order:billing_address_same_as_shipping", description: - "Send this attribute if you want to mark this subscription as cancelled", + "Send this attribute if you want the billing address to be cloned from the order'", options: [ { name: ["-o", "--organization"], @@ -7470,9 +8669,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order_subscription:deactivate", - description: - "Send this attribute if you want to mark this subscription as inactive", + name: "order:cancel", + description: "Send this attribute if you want to cancel a placed order", options: [ { name: ["-o", "--organization"], @@ -7511,8 +8709,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:approve", - description: "Send this attribute if you want to approve a placed order", + name: "order:capture", + description: + "Send this attribute if you want to capture an authorized order", options: [ { name: ["-o", "--organization"], @@ -7551,9 +8750,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:approve_and_capture", + name: "order:commit_invoice", description: - "Send this attribute if you want to approve and capture a placed order", + "Send this attribute if you want commit the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], @@ -7592,8 +8791,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:archive", - description: "Send this attribute if you want to archive the order", + name: "order:create_subscriptions", + description: + "Send this attribute upon/after placing the order if you want to create order sub", options: [ { name: ["-o", "--organization"], @@ -7632,8 +8832,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:authorization_amount_cents", - description: "The authorization amount, in cents", + name: "order:customer_payment_source_id", + description: "The id of the customer payment source (i", options: [ { name: ["-o", "--organization"], @@ -7665,6 +8865,12 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, + { + name: ["-v", "--value"], + description: "The trigger attribute value", + args: {}, + isRequired: true, + }, ], args: { name: "id", @@ -7672,9 +8878,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:authorize", + name: "order:fulfill", description: - "Send this attribute if you want to authorize the order's payment source", + "Send this attribute if you want to mark as fulfilled a shipped/delivered order", options: [ { name: ["-o", "--organization"], @@ -7713,9 +8919,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:billing_address_clone_id", + name: "order:nullify_payment_source", description: - "The id of the address that you want to clone to create the order's billing addre", + "Send this attribute if you want to nullify the payment source for this order", options: [ { name: ["-o", "--organization"], @@ -7747,12 +8953,6 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, - { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: {}, - isRequired: true, - }, ], args: { name: "id", @@ -7760,9 +8960,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:billing_address_same_as_shipping", + name: "order:pending", description: - "Send this attribute if you want the billing address to be cloned from the order'", + "Send this attribute if you want to move a draft or placing order to pending", options: [ { name: ["-o", "--organization"], @@ -7801,8 +9001,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:cancel", - description: "Send this attribute if you want to cancel a placed order", + name: "order:place", + description: "Send this attribute if you want to place the order", options: [ { name: ["-o", "--organization"], @@ -7841,9 +9041,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:capture", + name: "order:refresh", description: - "Send this attribute if you want to capture an authorized order", + "Send this attribute if you want to manually refresh the order", options: [ { name: ["-o", "--organization"], @@ -7882,9 +9082,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:commit_invoice", - description: - "Send this attribute if you want commit the sales tax invoice to the associated t", + name: "order:refund", + description: "Send this attribute if you want to refund a captured order", options: [ { name: ["-o", "--organization"], @@ -7923,9 +9122,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:create_subscriptions", + name: "order:refund_invoice", description: - "Send this attribute upon/after placing the order if you want to create order sub", + "Send this attribute if you want refund the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], @@ -7964,8 +9163,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:customer_payment_source_id", - description: "The id of the customer payment source (i", + name: "order:reset_circuit", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -7997,12 +9197,6 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, - { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: {}, - isRequired: true, - }, ], args: { name: "id", @@ -8010,9 +9204,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:nullify_payment_source", + name: "order:save_billing_address_to_customer_address_book", description: - "Send this attribute if you want to nullify the payment source for this order", + "Send this attribute if you want the order's billing address to be saved in the c", options: [ { name: ["-o", "--organization"], @@ -8051,9 +9245,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:pending", + name: "order:save_payment_source_to_customer_wallet", description: - "Send this attribute if you want to move a draft or placing order to pending", + "Send this attribute if you want the order's payment source to be saved in the cu", options: [ { name: ["-o", "--organization"], @@ -8092,8 +9286,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:place", - description: "Send this attribute if you want to place the order", + name: "order:save_shipping_address_to_customer_address_book", + description: + "Send this attribute if you want the order's shipping address to be saved in the", options: [ { name: ["-o", "--organization"], @@ -8132,9 +9327,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:refresh", + name: "order:shipping_address_clone_id", description: - "Send this attribute if you want to manually refresh the order", + "The id of the address that you want to clone to create the order's shipping addr", options: [ { name: ["-o", "--organization"], @@ -8166,6 +9361,12 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, + { + name: ["-v", "--value"], + description: "The trigger attribute value", + args: {}, + isRequired: true, + }, ], args: { name: "id", @@ -8173,8 +9374,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:refund", - description: "Send this attribute if you want to refund a captured order", + name: "order:shipping_address_same_as_billing", + description: + "Send this attribute if you want the shipping address to be cloned from the order", options: [ { name: ["-o", "--organization"], @@ -8213,9 +9415,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:refund_invoice", + name: "order:start_editing", description: - "Send this attribute if you want refund the sales tax invoice to the associated t", + "Send this attribute if you want to edit the order after it is placed", options: [ { name: ["-o", "--organization"], @@ -8254,9 +9456,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:reset_circuit", + name: "order:stop_editing", description: - "Send this attribute if you want to reset the circuit breaker associated to this", + "Send this attribute to stop the editing for the order and return back to placed", options: [ { name: ["-o", "--organization"], @@ -8295,9 +9497,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:save_billing_address_to_customer_address_book", - description: - "Send this attribute if you want the order's billing address to be saved in the c", + name: "order:unarchive", + description: "Send this attribute if you want to unarchive the order", options: [ { name: ["-o", "--organization"], @@ -8336,9 +9537,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:save_payment_source_to_customer_wallet", + name: "order:update_taxes", description: - "Send this attribute if you want the order's payment source to be saved in the cu", + "Send this attribute if you want to force tax calculation for this order (a tax c", options: [ { name: ["-o", "--organization"], @@ -8377,9 +9578,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:save_shipping_address_to_customer_address_book", + name: "order:validate", description: - "Send this attribute if you want the order's shipping address to be saved in the", + "Send this attribute if you want to trigger the external validation for the order", options: [ { name: ["-o", "--organization"], @@ -8418,9 +9619,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:shipping_address_clone_id", - description: - "The id of the address that you want to clone to create the order's shipping addr", + name: "payment_method", + description: "Execute an action on a resource of type payment_methods", options: [ { name: ["-o", "--organization"], @@ -8452,12 +9652,6 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, - { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: {}, - isRequired: true, - }, ], args: { name: "id", @@ -8465,9 +9659,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:shipping_address_same_as_billing", + name: "payment_method:disable", description: - "Send this attribute if you want the shipping address to be cloned from the order", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -8506,9 +9700,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:start_editing", + name: "payment_method:enable", description: - "Send this attribute if you want to edit the order after it is placed", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -8547,9 +9741,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:stop_editing", + name: "percentage_discount_promotion", description: - "Send this attribute to stop the editing for the order and return back to placed", + "Execute an action on a resource of type percentage_discount_promotions", options: [ { name: ["-o", "--organization"], @@ -8588,8 +9782,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:unarchive", - description: "Send this attribute if you want to unarchive the order", + name: "percentage_discount_promotion:disable", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -8628,9 +9823,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:update_taxes", + name: "percentage_discount_promotion:enable", description: - "Send this attribute if you want to force tax calculation for this order (a tax c", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -8669,9 +9864,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:validate", + name: "price_list_scheduler", description: - "Send this attribute if you want to trigger the external validation for the order", + "Execute an action on a resource of type price_list_schedulers", options: [ { name: ["-o", "--organization"], @@ -8710,8 +9905,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "payment_method", - description: "Execute an action on a resource of type payment_methods", + name: "price_list_scheduler:disable", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -8750,9 +9946,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "payment_method:disable", + name: "price_list_scheduler:enable", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -8791,9 +9987,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "payment_method:enable", - description: - "Send this attribute if you want to mark this resource as enabled", + name: "return", + description: "Execute an action on a resource of type returns", options: [ { name: ["-o", "--organization"], @@ -8832,9 +10027,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "percentage_discount_promotion", - description: - "Execute an action on a resource of type percentage_discount_promotions", + name: "return_line_item", + description: "Execute an action on a resource of type return_line_items", options: [ { name: ["-o", "--organization"], @@ -8873,9 +10067,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "percentage_discount_promotion:disable", - description: - "Send this attribute if you want to mark this resource as disabled", + name: "return_line_item:restock", + description: "Send this attribute if you want to restock the line item", options: [ { name: ["-o", "--organization"], @@ -8914,9 +10107,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "percentage_discount_promotion:enable", + name: "return:approve", description: - "Send this attribute if you want to mark this resource as enabled", + "Send this attribute if you want to mark this return as approved", options: [ { name: ["-o", "--organization"], @@ -8955,8 +10148,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return", - description: "Execute an action on a resource of type returns", + name: "return:archive", + description: "Send this attribute if you want to archive the return", options: [ { name: ["-o", "--organization"], @@ -8995,8 +10188,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return_line_item", - description: "Execute an action on a resource of type return_line_items", + name: "return:cancel", + description: + "Send this attribute if you want to mark this return as cancelled", options: [ { name: ["-o", "--organization"], @@ -9035,8 +10229,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return_line_item:restock", - description: "Send this attribute if you want to restock the line item", + name: "return:receive", + description: + "Send this attribute if you want to mark this return as received", options: [ { name: ["-o", "--organization"], @@ -9075,9 +10270,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:approve", + name: "return:refund", description: - "Send this attribute if you want to mark this return as approved", + "Send this attribute if you want to create a refund for this return", options: [ { name: ["-o", "--organization"], @@ -9116,8 +10311,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:archive", - description: "Send this attribute if you want to archive the return", + name: "return:refund_amount_cents", + description: + "Send this attribute as a value in cents to specify the amount to be refunded", options: [ { name: ["-o", "--organization"], @@ -9156,9 +10352,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:cancel", + name: "return:reject", description: - "Send this attribute if you want to mark this return as cancelled", + "Send this attribute if you want to mark this return as rejected", options: [ { name: ["-o", "--organization"], @@ -9197,9 +10393,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:receive", - description: - "Send this attribute if you want to mark this return as received", + name: "return:request", + description: "Send this attribute if you want to activate this return", options: [ { name: ["-o", "--organization"], @@ -9238,9 +10433,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:reject", + name: "return:restock", description: - "Send this attribute if you want to mark this return as rejected", + "Send this attribute if you want to restock all of the return line items", options: [ { name: ["-o", "--organization"], @@ -9279,8 +10474,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:request", - description: "Send this attribute if you want to activate this return", + name: "return:ship", + description: + "Send this attribute if you want to mark this return as shipped", options: [ { name: ["-o", "--organization"], @@ -9319,9 +10515,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:restock", - description: - "Send this attribute if you want to restock all of the return line items", + name: "return:unarchive", + description: "Send this attribute if you want to unarchive the return", options: [ { name: ["-o", "--organization"], @@ -9360,9 +10555,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:ship", - description: - "Send this attribute if you want to mark this return as shipped", + name: "satispay_payment", + description: "Execute an action on a resource of type satispay_payments", options: [ { name: ["-o", "--organization"], @@ -9401,8 +10595,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:unarchive", - description: "Send this attribute if you want to unarchive the return", + name: "satispay_payment:refresh", + description: + "Send this attribute if you want to refresh all the pending transactions, can be", options: [ { name: ["-o", "--organization"], @@ -9441,8 +10636,8 @@ const completionSpec: Fig.Spec = { }, }, { - name: "satispay_payment", - description: "Execute an action on a resource of type satispay_payments", + name: "shipment", + description: "Execute an action on a resource of type shipments", options: [ { name: ["-o", "--organization"], @@ -9481,9 +10676,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "satispay_payment:refresh", + name: "shipment:cancel", description: - "Send this attribute if you want to refresh all the pending transactions, can be", + "Send this attribute if you want to mark this shipment as cancelled (unless alrea", options: [ { name: ["-o", "--organization"], @@ -9522,8 +10717,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment", - description: "Execute an action on a resource of type shipments", + name: "shipment:decrement_stock", + description: + "Send this attribute if you want to automatically decrement and release the stock", options: [ { name: ["-o", "--organization"], @@ -9562,9 +10758,9 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:decrement_stock", + name: "shipment:deliver", description: - "Send this attribute if you want to automatically decrement and release the stock", + "Send this attribute if you want to mark this shipment as delivered", options: [ { name: ["-o", "--organization"], @@ -11071,6 +12267,255 @@ const completionSpec: Fig.Spec = { description: "The unique id of the resource", }, }, + { + name: "cleanups", + description: + "List all the created cleanups or show details of a single cleanup", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-A", "--all"], + description: "Show all cleanups instead of first 25 only", + }, + { + name: ["-t", "--type"], + description: "The type of resource cleaned", + args: { + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], + }, + }, + { + name: ["-s", "--status"], + description: "The cleanup job status", + args: { + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, + }, + { + name: ["-l", "--limit"], + description: "Limit number of cleanups in output", + args: {}, + }, + ], + args: { + name: "id", + description: "Unique id of the cleanup to be retrieved", + isOptional: true, + }, + }, + { + name: ["cleanups:create", "clp:create", "cleanup"], + description: "Create a new cleanup", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-t", "--type"], + description: "The type of resource to clean up", + args: { + description: "Bundles|gift_cards|prices|promotions|etc", + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], + }, + isRequired: true, + }, + { + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: {}, + }, + { + name: ["-N", "--notify"], + description: "Force system notification when cleanup has finished", + hidden: true, + }, + { + name: ["-b", "--blind"], + description: + "Execute in blind mode without showing the progress monitor", + }, + { + name: ["-q", "--quiet"], + description: "Execute command without showing warning messages", + }, + ], + }, + { + name: ["cleanups:details", "clp:details"], + description: "Show the details of an existing cleanup", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-l", "--logs"], + description: "Show error logs related to the cleanup process", + }, + ], + args: { + name: "id", + description: "Unique id of the cleanup", + }, + }, + { + name: ["cleanups:group", "clp:group"], + description: "List all the cleanups related to a cleanup group", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + ], + args: { + name: "group_id", + description: "Unique id of the group cleanup", + }, + }, + { + name: ["cleanups:list", "clp:list"], + description: "List all the created cleanups", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: {}, + hidden: true, + }, + { + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-A", "--all"], + description: "Show all cleanups instead of first 25 only", + }, + { + name: ["-t", "--type"], + description: "The type of resource cleaned", + args: { + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], + }, + }, + { + name: ["-s", "--status"], + description: "The cleanup job status", + args: { + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, + }, + { + name: ["-l", "--limit"], + description: "Limit number of cleanups in output", + args: {}, + }, + ], + }, + { + name: ["cleanups:types", "clp:types"], + description: "Show online documentation for supported resources", + options: [ + { + name: ["-O", "--open"], + description: "Open online documentation page", + }, + ], + }, { name: "exports", description: @@ -11109,10 +12554,12 @@ const completionSpec: Fig.Spec = { "captures", "coupons", "customer_addresses", + "customer_payment_sources", "customer_subscriptions", "customers", "gift_cards", "line_items", + "line_item_options", "orders", "payment_methods", "price_tiers", @@ -11126,6 +12573,7 @@ const completionSpec: Fig.Spec = { "sku_options", "skus", "stock_items", + "stock_transfers", "tags", "tax_categories", "transactions", @@ -11186,10 +12634,12 @@ const completionSpec: Fig.Spec = { "captures", "coupons", "customer_addresses", + "customer_payment_sources", "customer_subscriptions", "customers", "gift_cards", "line_items", + "line_item_options", "orders", "payment_methods", "price_tiers", @@ -11203,6 +12653,7 @@ const completionSpec: Fig.Spec = { "sku_options", "skus", "stock_items", + "stock_transfers", "tags", "tax_categories", "transactions", @@ -11311,10 +12762,12 @@ const completionSpec: Fig.Spec = { "captures", "coupons", "customer_addresses", + "customer_payment_sources", "customer_subscriptions", "customers", "gift_cards", "line_items", + "line_item_options", "orders", "payment_methods", "price_tiers", @@ -11328,6 +12781,7 @@ const completionSpec: Fig.Spec = { "sku_options", "skus", "stock_items", + "stock_transfers", "tags", "tax_categories", "transactions", @@ -11486,10 +12940,12 @@ const completionSpec: Fig.Spec = { "captures", "coupons", "customer_addresses", + "customer_payment_sources", "customer_subscriptions", "customers", "gift_cards", "line_items", + "line_item_options", "orders", "payment_methods", "price_tiers", @@ -11503,6 +12959,7 @@ const completionSpec: Fig.Spec = { "sku_options", "skus", "stock_items", + "stock_transfers", "tags", "tax_categories", "transactions", @@ -11534,255 +12991,6 @@ const completionSpec: Fig.Spec = { }, ], }, - { - name: "cleanups", - description: - "List all the created cleanups or show details of a single cleanup", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: {}, - hidden: true, - }, - { - name: "--accessToken", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-A", "--all"], - description: "Show all cleanups instead of first 25 only", - }, - { - name: ["-t", "--type"], - description: "The type of resource cleaned", - args: { - suggestions: [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items", - ], - }, - }, - { - name: ["-s", "--status"], - description: "The cleanup job status", - args: { - suggestions: ["in_progress", "pending", "completed", "interrupted"], - }, - }, - { - name: ["-l", "--limit"], - description: "Limit number of cleanups in output", - args: {}, - }, - ], - args: { - name: "id", - description: "Unique id of the cleanup to be retrieved", - isOptional: true, - }, - }, - { - name: ["cleanups:create", "clp:create", "cleanup"], - description: "Create a new cleanup", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: {}, - hidden: true, - }, - { - name: "--accessToken", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-t", "--type"], - description: "The type of resource to clean up", - args: { - description: "Bundles|gift_cards|prices|promotions|etc", - suggestions: [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items", - ], - }, - isRequired: true, - }, - { - name: ["-w", "--where"], - description: "Comma separated list of query filters", - args: {}, - }, - { - name: ["-N", "--notify"], - description: "Force system notification when cleanup has finished", - hidden: true, - }, - { - name: ["-b", "--blind"], - description: - "Execute in blind mode without showing the progress monitor", - }, - { - name: ["-q", "--quiet"], - description: "Execute command without showing warning messages", - }, - ], - }, - { - name: ["cleanups:details", "clp:details"], - description: "Show the details of an existing cleanup", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: {}, - hidden: true, - }, - { - name: "--accessToken", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-l", "--logs"], - description: "Show error logs related to the cleanup process", - }, - ], - args: { - name: "id", - description: "Unique id of the cleanup", - }, - }, - { - name: ["cleanups:group", "clp:group"], - description: "List all the cleanups related to a cleanup group", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: {}, - hidden: true, - }, - { - name: "--accessToken", - args: {}, - isRequired: true, - hidden: true, - }, - ], - args: { - name: "group_id", - description: "Unique id of the group cleanup", - }, - }, - { - name: ["cleanups:list", "clp:list"], - description: "List all the created cleanups", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: {}, - hidden: true, - }, - { - name: "--accessToken", - args: {}, - isRequired: true, - hidden: true, - }, - { - name: ["-A", "--all"], - description: "Show all cleanups instead of first 25 only", - }, - { - name: ["-t", "--type"], - description: "The type of resource cleaned", - args: { - suggestions: [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items", - ], - }, - }, - { - name: ["-s", "--status"], - description: "The cleanup job status", - args: { - suggestions: ["in_progress", "pending", "completed", "interrupted"], - }, - }, - { - name: ["-l", "--limit"], - description: "Limit number of cleanups in output", - args: {}, - }, - ], - }, - { - name: ["cleanups:types", "clp:types"], - description: "Show online documentation for supported resources", - options: [ - { - name: ["-O", "--open"], - description: "Open online documentation page", - }, - ], - }, { name: ["provisioning:create", "prov:create", "pc", "pcreate"], description: "Create a new resource", @@ -13158,8 +14366,7 @@ const completionSpec: Fig.Spec = { }, { name: ["plugins:install", "plugins:add"], - description: - "Uses bundled npm executable to install plugins into <%= config", + description: "Uses npm to install plugins", options: [ { name: "--json",