From 38ab8f029cfefaa94a6d1fddfa1c3f055bf85268 Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Thu, 11 Apr 2024 16:27:33 +0200 Subject: [PATCH 1/8] feat: add commercelayer spec --- src/cl.ts | 3 + src/commercelayer.ts | 16535 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 16538 insertions(+) create mode 100644 src/cl.ts create mode 100644 src/commercelayer.ts diff --git a/src/cl.ts b/src/cl.ts new file mode 100644 index 000000000000..5848780eaebc --- /dev/null +++ b/src/cl.ts @@ -0,0 +1,3 @@ + +import completionSpec from './commercelayer' +export default completionSpec diff --git a/src/commercelayer.ts b/src/commercelayer.ts new file mode 100644 index 000000000000..94a08cb19f58 --- /dev/null +++ b/src/commercelayer.ts @@ -0,0 +1,16535 @@ +/** Autogenerated by @commercelayer/cli cli:fig command **/ + + +const completionSpec: Fig.Spec = { + "name": "@commercelayer/cli", + "subcommands": [ + { + "name": [ + "applications", + "app:list", + "applications:list", + "app:available", + "applications:available", + "apps" + ], + "description": "Show a list of all (logged in) available cli applications", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "Organization slug" + }, + { + "name": [ + "-d", + "--domain" + ], + "description": "Api domain", + "hidden": true + }, + { + "name": [ + "-k", + "--kind" + ], + "description": "Application kind", + "args": { + "suggestions": [ + "integration", + "sales_channel", + "user" + ] + } + }, + { + "name": [ + "-m", + "--mode" + ], + "description": "Execution mode", + "args": { + "suggestions": [ + "test", + "live" + ] + } + }, + { + "name": "--live", + "description": "Live execution mode" + }, + { + "name": "--id", + "description": "Application id" + }, + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias associated to the application" + }, + { + "name": "--appkey", + "description": "Cli application key", + "hidden": true + }, + { + "name": [ + "-A", + "--api" + ], + "description": "Specific api application" + }, + { + "name": [ + "-X", + "--extra" + ], + "description": "Show applications extra info", + "hidden": true + }, + { + "name": [ + "-S", + "--sort" + ], + "description": "Sort applications by organization and application name" + } + ] + }, + { + "name": [ + "applications:add", + "app:add" + ], + "description": "Add a new commerce layer application to cli config (application must be of kind 'integration' or 'sales_channel')", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "Organization slug" + }, + { + "name": [ + "-d", + "--domain" + ], + "description": "Api domain", + "hidden": true + }, + { + "name": [ + "-i", + "--clientId" + ], + "description": "Application client_id", + "isRequired": true + }, + { + "name": [ + "-s", + "--clientSecret" + ], + "description": "Application client_secret" + }, + { + "name": [ + "-S", + "--scope" + ], + "description": "Access token scope (market, stock location)" + }, + { + "name": [ + "-e", + "--email" + ], + "description": "Customer email" + }, + { + "name": [ + "-p", + "--password" + ], + "description": "Customer secret password" + }, + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias you want to associate to the application", + "isRequired": true + }, + { + "name": "--debug", + "description": "Show more verbose error messages", + "hidden": true + } + ] + }, + { + "name": [ + "applications:current", + "app:current" + ], + "description": "Show the current application", + "options": [ + { + "name": "--info", + "hidden": true + }, + { + "name": [ + "-j", + "--json" + ], + "description": "Show info in json format" + } + ] + }, + { + "name": [ + "applications:info", + "app:info" + ], + "description": "Show application details", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "Organization slug" + }, + { + "name": [ + "-d", + "--domain" + ], + "description": "Api domain", + "hidden": true + }, + { + "name": [ + "-k", + "--kind" + ], + "description": "Application kind", + "args": { + "suggestions": [ + "integration", + "sales_channel", + "user" + ] + } + }, + { + "name": [ + "-m", + "--mode" + ], + "description": "Execution mode", + "args": { + "suggestions": [ + "test", + "live" + ] + } + }, + { + "name": "--live", + "description": "Live execution mode" + }, + { + "name": "--id", + "description": "Application id" + }, + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias associated to the application" + }, + { + "name": "--appkey", + "description": "Cli application key", + "hidden": true + }, + { + "name": [ + "-A", + "--api" + ], + "description": "Specific api application" + }, + { + "name": [ + "-j", + "--json" + ], + "description": "Show info in json format" + } + ] + }, + { + "name": [ + "applications:login", + "app:login", + "login" + ], + "description": "Execute login to a commerce layer application (application must be of kind 'integration' or 'sales_channel')", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "Organization slug" + }, + { + "name": [ + "-d", + "--domain" + ], + "description": "Api domain", + "hidden": true + }, + { + "name": [ + "-i", + "--clientId" + ], + "description": "Application client_id", + "isRequired": true + }, + { + "name": [ + "-s", + "--clientSecret" + ], + "description": "Application client_secret" + }, + { + "name": [ + "-S", + "--scope" + ], + "description": "Access token scope (market, stock location)" + }, + { + "name": [ + "-e", + "--email" + ], + "description": "Customer email" + }, + { + "name": [ + "-p", + "--password" + ], + "description": "Customer secret password" + }, + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias you want to associate to the application", + "isRequired": true + }, + { + "name": "--debug", + "description": "Show more verbose error messages", + "hidden": true + } + ] + }, + { + "name": [ + "applications:logout", + "app:logout", + "app:remove", + "applications:remove", + "logout" + ], + "description": "Remove an application from cli local configuration", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "Organization slug" + }, + { + "name": [ + "-d", + "--domain" + ], + "description": "Api domain", + "hidden": true + }, + { + "name": [ + "-k", + "--kind" + ], + "description": "Application kind", + "args": { + "suggestions": [ + "integration", + "sales_channel", + "user" + ] + } + }, + { + "name": [ + "-m", + "--mode" + ], + "description": "Execution mode", + "args": { + "suggestions": [ + "test", + "live" + ] + } + }, + { + "name": "--live", + "description": "Live execution mode" + }, + { + "name": "--id", + "description": "Application id" + }, + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias associated to the application" + }, + { + "name": "--appkey", + "description": "Cli application key", + "hidden": true + }, + { + "name": [ + "-A", + "--api" + ], + "description": "Specific api application" + }, + { + "name": [ + "-r", + "--revoke" + ], + "description": "Revoke current access token" + }, + { + "name": [ + "-F", + "--force" + ], + "description": "Force application removal without user confirmation", + "hidden": true + } + ] + }, + { + "name": [ + "applications:provisioning", + "prov:list", + "app:provisioning", + "prov:apps", + "prov:applications" + ], + "description": "Show all provisioning applications", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "Organization slug" + }, + { + "name": [ + "-d", + "--domain" + ], + "description": "Api domain", + "hidden": true + }, + { + "name": [ + "-k", + "--kind" + ], + "description": "Application kind", + "args": { + "suggestions": [ + "integration", + "sales_channel", + "user" + ] + } + }, + { + "name": [ + "-m", + "--mode" + ], + "description": "Execution mode", + "args": { + "suggestions": [ + "test", + "live" + ] + } + }, + { + "name": "--live", + "description": "Live execution mode" + }, + { + "name": "--id", + "description": "Application id" + }, + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias associated to the application" + }, + { + "name": "--appkey", + "description": "Cli application key", + "hidden": true + }, + { + "name": [ + "-A", + "--api" + ], + "description": "Specific api application" + }, + { + "name": [ + "-X", + "--extra" + ], + "description": "Show applications extra info", + "hidden": true + }, + { + "name": [ + "-S", + "--sort" + ], + "description": "Sort applications by organization and application name" + } + ] + }, + { + "name": [ + "applications:scope", + "app:scope" + ], + "description": "Switch scope of current application", + "options": [ + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias you want to associate to the application" + } + ], + "args": [ + { + "name": "scope", + "description": "The application scope" + } + ] + }, + { + "name": [ + "applications:switch", + "app:switch" + ], + "description": "Switch applications", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "Organization slug" + }, + { + "name": [ + "-d", + "--domain" + ], + "description": "Api domain", + "hidden": true + }, + { + "name": [ + "-k", + "--kind" + ], + "description": "Application kind", + "args": { + "suggestions": [ + "integration", + "sales_channel", + "user" + ] + } + }, + { + "name": [ + "-m", + "--mode" + ], + "description": "Execution mode", + "args": { + "suggestions": [ + "test", + "live" + ] + } + }, + { + "name": "--live", + "description": "Live execution mode" + }, + { + "name": "--id", + "description": "Application id" + }, + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias associated to the application" + }, + { + "name": "--appkey", + "description": "Cli application key", + "hidden": true + }, + { + "name": [ + "-A", + "--api" + ], + "description": "Specific api application" + } + ] + }, + { + "name": [ + "app:token", + "app:token" + ], + "description": "Get a new access token from commerce layer api", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "Organization slug" + }, + { + "name": [ + "-d", + "--domain" + ], + "description": "Api domain", + "hidden": true + }, + { + "name": [ + "-k", + "--kind" + ], + "description": "Application kind", + "args": { + "suggestions": [ + "integration", + "sales_channel", + "user" + ] + } + }, + { + "name": [ + "-m", + "--mode" + ], + "description": "Execution mode", + "args": { + "suggestions": [ + "test", + "live" + ] + } + }, + { + "name": "--live", + "description": "Live execution mode" + }, + { + "name": "--id", + "description": "Application id" + }, + { + "name": [ + "-a", + "--alias" + ], + "description": "The alias associated to the application" + }, + { + "name": "--appkey", + "description": "Cli application key", + "hidden": true + }, + { + "name": [ + "-A", + "--api" + ], + "description": "Specific api application" + }, + { + "name": [ + "-s", + "--save" + ], + "description": "Save access token" + }, + { + "name": [ + "-i", + "--info" + ], + "description": "Show access token info" + }, + { + "name": [ + "-S", + "--shared" + ], + "description": "Organization shared secret", + "hidden": true + }, + { + "name": [ + "-M", + "--minutes" + ], + "description": "Minutes to token expiration [2, 240]", + "hidden": true + } + ], + "hidden": false + }, + { + "name": [ + "cli:update", + "upgrade", + "latest" + ], + "description": "Update commerce layer cli", + "options": [ + { + "name": [ + "-v", + "--version" + ], + "description": "Update cli to a specific version or tag" + } + ] + }, + { + "name": [ + "cli:version", + "version" + ], + "description": "Show installed version of commerce layer cli", + "options": [ + { + "name": [ + "-p", + "--plugins" + ], + "description": "Show version of installed plugins" + } + ] + }, + { + "name": [ + "plugins:available" + ], + "description": "Show all available commerce layer cli plugins", + "options": [ + { + "name": [ + "-H", + "--hidden" + ], + "description": "Show also enabled but hidden plugins", + "hidden": true + } + ] + }, + { + "name": [ + "plugins:latest" + ], + "description": "Show latest version of available plugins", + "options": [ + { + "name": [ + "-b", + "--beta" + ], + "description": "Retrieve latest version from beta channel" + } + ], + "args": [ + { + "name": "plugin", + "description": "The name of the plugin", + "isOptional": true + } + ] + }, + { + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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", + "tags", + "tax_categories" + ] + } + }, + { + "name": [ + "-g", + "--group" + ], + "description": "The group id associated to the import in case of multi-chunk imports" + }, + { + "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": "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of resource being imported", + "isRequired": true, + "args": { + "description": "addresses|bundles|coupons|customer_addresses|...", + "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": [ + "-p", + "--parent" + ], + "description": "The id of the parent resource to be associated with imported data" + }, + { + "name": [ + "-i", + "--inputs" + ], + "description": "The path of the file containing the data to import", + "isRequired": true + }, + { + "name": [ + "-C", + "--csv" + ], + "description": "Accept input file in csv format" + }, + { + "name": [ + "-D", + "--delimiter" + ], + "description": "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", + "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": [ + "imports:delete", + "imp:delete" + ], + "description": "Delete an existing import", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "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": [ + { + "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": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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", + "tags", + "tax_categories" + ] + } + }, + { + "name": [ + "-g", + "--group" + ], + "description": "The group id associated to the import in case of multi-chunk imports" + }, + { + "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" + } + ] + }, + { + "name": [ + "imports:types", + "imp:types" + ], + "description": "Show online documentation for supported resources", + "options": [ + { + "name": [ + "-O", + "--open" + ], + "description": "Open online documentation page" + } + ] + }, + { + "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" + ], + "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" + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": [ + "-i", + "--clientId" + ], + "description": "Application client_id", + "isRequired": true + }, + { + "name": [ + "-s", + "--clientSecret" + ], + "description": "Application client_secret" + }, + { + "name": [ + "-S", + "--scope" + ], + "description": "Access token scope (market, stock location)" + }, + { + "name": [ + "-e", + "--email" + ], + "description": "Customer email" + }, + { + "name": [ + "-p", + "--password" + ], + "description": "Customer secret password" + }, + { + "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" + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": [ + "-i", + "--clientId" + ], + "description": "Application client_id", + "isRequired": true + }, + { + "name": [ + "-s", + "--clientSecret" + ], + "description": "Application client_secret" + }, + { + "name": [ + "-S", + "--scope" + ], + "description": "Access token scope" + }, + { + "name": [ + "-P", + "--provisioning" + ], + "description": "Execute login to provisioning api" + } + ], + "args": [ + { + "name": "token", + "description": "Access token to revoke" + } + ] + }, + { + "name": [ + "orders" + ], + "description": "Execute an action on an order", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:approve" + ], + "description": "Send this attribute if you want to approve a placed order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:approve_and_capture" + ], + "description": "Send this attribute if you want to approve and capture a placed order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:archive" + ], + "description": "Send this attribute if you want to archive the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:authorization_amount_cents" + ], + "description": "The authorization amount, in cents.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:authorize" + ], + "description": "Send this attribute if you want to authorize the order's payment source.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:billing_address_clone_id" + ], + "description": "The id of the address that you want to clone to create the order's billing address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "isRequired": true + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:billing_address_same_as_shipping" + ], + "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:cancel" + ], + "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:capture" + ], + "description": "Send this attribute if you want to capture an authorized order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:commit_invoice" + ], + "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:create_subscriptions" + ], + "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:customer_payment_source_id" + ], + "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "isRequired": true + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:nullify_payment_source" + ], + "description": "Send this attribute if you want to nullify the payment source for this order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:place" + ], + "description": "Send this attribute if you want to place the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:refresh" + ], + "description": "Send this attribute if you want to manually refresh the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:refund" + ], + "description": "Send this attribute if you want to refund a captured order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:refund_invoice" + ], + "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:save_billing_address_to_customer_address_book" + ], + "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:save_payment_source_to_customer_wallet" + ], + "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:save_shipping_address_to_customer_address_book" + ], + "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:shipping_address_clone_id" + ], + "description": "The id of the address that you want to clone to create the order's shipping address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "isRequired": true + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:shipping_address_same_as_billing" + ], + "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:start_editing" + ], + "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:stop_editing" + ], + "description": "Send this attribute to stop the editing for the order and return back to placed status.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:unarchive" + ], + "description": "Send this attribute if you want to unarchive the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:update_taxes" + ], + "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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:validate" + ], + "description": "Send this attribute if you want to trigger the external validation for the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "webhooks" + ], + "description": "List all the registered webhooks or the details of a single webhook", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "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" + }, + { + "name": [ + "-H", + "--hide-empty" + ], + "description": "Hide empty attributes" + }, + { + "name": [ + "-e", + "--events" + ], + "description": "Show the last event callbacks associated to the webhook" + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the webhook to get a single webhook", + "isOptional": true + } + ] + }, + { + "name": [ + "webhooks:create", + "wh:create" + ], + "description": "Create a new webhook", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--topic" + ], + "description": "The identifier of the event that will trigger the webhook", + "isRequired": true + }, + { + "name": [ + "-u", + "--url" + ], + "description": "The callback url used to post data", + "isRequired": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "A comma separated list of related resources to be included" + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The webhook short name" + } + ] + }, + { + "name": [ + "webhooks:destroy", + "webhooks:delete", + "wh:delete", + "wh:destroy" + ], + "description": "Destroy an existing webhook", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-H", + "--hide-empty" + ], + "description": "Hide empty attributes" + }, + { + "name": [ + "-e", + "--events" + ], + "description": "Show the last event callbacks associated to the webhook" + } + ], + "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": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-p", + "--payload" + ], + "description": "Show the event payload sent to the callback endpoint" + }, + { + "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": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-A", + "--all" + ], + "description": "Show all events instead of first 25 only " + }, + { + "name": [ + "-l", + "--limit" + ], + "description": "Limit number of events in output" + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the webhook" + } + ] + }, + { + "name": [ + "webhooks:list", + "wh:list" + ], + "description": "List all the registered webhooks", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "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" + } + ] + }, + { + "name": [ + "webhooks:listen", + "wh:listen" + ], + "description": "Listen a webhook for outgoing callbacks", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--time" + ], + "description": "Waiting time for the first event" + } + ], + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--topic" + ], + "description": "The identifier of the event that will trigger the webhook" + }, + { + "name": [ + "-u", + "--url" + ], + "description": "The callback url used to post data" + }, + { + "name": [ + "-i", + "--include" + ], + "description": "A comma separated list of related resources to be included" + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The webhook short name" + } + ], + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": [ + "-a", + "--accessToken" + ], + "isRequired": true, + "hidden": false + }, + { + "name": "--open", + "description": "Open microstore url in default browser" + }, + { + "name": [ + "-S", + "--skuListId" + ], + "description": "The sku list id", + "isRequired": true + }, + { + "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" + } + ] + }, + { + "name": [ + "checkout" + ], + "description": "Create checkout urls", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": [ + "-a", + "--accessToken" + ], + "description": "Custom access token to use instead of the one used for login", + "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": [ + "-O", + "--order" + ], + "description": "An order id" + }, + { + "name": [ + "-S", + "--sku" + ], + "description": "An sku code" + }, + { + "name": [ + "-B", + "--bundle" + ], + "description": "A bundle code" + }, + { + "name": [ + "-m", + "--market" + ], + "description": "A market number" + }, + { + "name": [ + "-c", + "--coupon" + ], + "description": "A promo code" + }, + { + "name": [ + "-e", + "--email" + ], + "description": "A customer email" + } + ] + }, + { + "name": [ + "checkout:order" + ], + "description": "Create checkout urls starting from an existing order", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": [ + "-a", + "--accessToken" + ], + "description": "Custom access token to use instead of the one used for login", + "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 + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the order" + } + ] + }, + { + "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": [ + "-u", + "--url" + ], + "description": "Seeder data url" + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The name of the business model file to use" + }, + { + "name": "--debug", + "description": "Show command debug information", + "hidden": true + }, + { + "name": [ + "-r", + "--relationships" + ], + "description": "Check resource relationships" + } + ] + }, + { + "name": [ + "seeder:clean" + ], + "description": "Clean previously imported 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": [ + "-u", + "--url" + ], + "description": "Seeder data url" + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The name of the business model file to use" + }, + { + "name": "--debug", + "description": "Show debug information", + "hidden": true + }, + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "-u", + "--url" + ], + "description": "Seeder data url" + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The name of the business model file to use" + }, + { + "name": "--debug", + "description": "Show debug information", + "hidden": true + }, + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-k", + "--keep" + ], + "description": "Keep existing resources without updating them" + }, + { + "name": [ + "-D", + "--delay" + ], + "description": "Add a delay in milliseconds between calls to different resources", + "hidden": true + } + ] + }, + { + "name": [ + "adyen_payment" + ], + "description": "Execute an action on a resource of type adyen_payments", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "authorization" + ], + "description": "Execute an action on a resource of type authorizations", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "authorization:capture" + ], + "description": "Send this attribute if you want to create a capture for this authorization.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "authorization:capture_amount_cents" + ], + "description": "The associated capture amount, in cents.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "authorization:void" + ], + "description": "Send this attribute if you want to create a void for this authorization.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "axerve_payment" + ], + "description": "Execute an action on a resource of type axerve_payments", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "axerve_payment:update" + ], + "description": "Send this attribute if you want to update the payment with fresh order data.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "bundle" + ], + "description": "Execute an action on a resource of type bundles", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "bundle:compute_compare_at_amount" + ], + "description": "Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle skus for the market.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "bundle:compute_price_amount" + ], + "description": "Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle skus for the market.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "buy_x_pay_y_promotion" + ], + "description": "Execute an action on a resource of type buy_x_pay_y_promotions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "buy_x_pay_y_promotion:disable" + ], + "description": "Send this attribute if you want to mark the promotion as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "buy_x_pay_y_promotion:enable" + ], + "description": "Send this attribute if you want to mark the promotion as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "capture" + ], + "description": "Execute an action on a resource of type captures", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "capture:refund" + ], + "description": "Send this attribute if you want to create a refund for this capture.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "capture:refund_amount_cents" + ], + "description": "The associated refund amount, in cents.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "checkout_com_payment" + ], + "description": "Execute an action on a resource of type checkout_com_payments", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "checkout_com_payment:details" + ], + "description": "Send this attribute if you want to send additional details the payment request (i.e. upon 3ds check).", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "checkout_com_payment:refresh" + ], + "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "customer_password_reset" + ], + "description": "Execute an action on a resource of type customer_password_resets", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "customer_password_reset:reset_password_token" + ], + "description": "Send the 'reset_password_token' that you got on create when updating the customer password.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "external_promotion" + ], + "description": "Execute an action on a resource of type external_promotions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "external_promotion:disable" + ], + "description": "Send this attribute if you want to mark the promotion as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "external_promotion:enable" + ], + "description": "Send this attribute if you want to mark the promotion as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "fixed_amount_promotion" + ], + "description": "Execute an action on a resource of type fixed_amount_promotions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "fixed_amount_promotion:disable" + ], + "description": "Send this attribute if you want to mark the promotion as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "fixed_amount_promotion:enable" + ], + "description": "Send this attribute if you want to mark the promotion as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "fixed_price_promotion" + ], + "description": "Execute an action on a resource of type fixed_price_promotions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "fixed_price_promotion:disable" + ], + "description": "Send this attribute if you want to mark the promotion as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "fixed_price_promotion:enable" + ], + "description": "Send this attribute if you want to mark the promotion as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "free_gift_promotion" + ], + "description": "Execute an action on a resource of type free_gift_promotions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "free_gift_promotion:disable" + ], + "description": "Send this attribute if you want to mark the promotion as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "free_gift_promotion:enable" + ], + "description": "Send this attribute if you want to mark the promotion as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "free_shipping_promotion" + ], + "description": "Execute an action on a resource of type free_shipping_promotions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "free_shipping_promotion:disable" + ], + "description": "Send this attribute if you want to mark the promotion as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "free_shipping_promotion:enable" + ], + "description": "Send this attribute if you want to mark the promotion as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "gift_card" + ], + "description": "Execute an action on a resource of type gift_cards", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "gift_card:activate" + ], + "description": "Send this attribute if you want to activate a gift card.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "gift_card:balance_change_cents" + ], + "description": "The balance change, in cents. send a negative value to reduces the card balance by the specified amount. send a positive value to recharge the gift card (if rechargeable).", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "gift_card:deactivate" + ], + "description": "Send this attribute if you want to deactivate a gift card.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "gift_card:purchase" + ], + "description": "Send this attribute if you want to confirm a draft gift card. the gift card becomes 'inactive', waiting to be activated.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "in_stock_subscription" + ], + "description": "Execute an action on a resource of type in_stock_subscriptions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "in_stock_subscription:activate" + ], + "description": "Send this attribute if you want to activate an inactive subscription.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "in_stock_subscription:deactivate" + ], + "description": "Send this attribute if you want to dactivate an active subscription.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "klarna_payment" + ], + "description": "Execute an action on a resource of type klarna_payments", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "klarna_payment:update" + ], + "description": "Send this attribute if you want to update the payment session with fresh order data.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "line_item" + ], + "description": "Execute an action on a resource of type line_items", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "line_item:external_price" + ], + "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. any successive price computation will be done externally, until the attribute is reset to '0'.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "line_item:reserve_stock" + ], + "description": "Send this attribute if you want to reserve the stock for the line item's skus quantity. stock reservations expiration depends on the inventory model's cutoff. when used on update the existing active stock reservations are renewed.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "market" + ], + "description": "Execute an action on a resource of type markets", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "market:disable" + ], + "description": "Send this attribute if you want to mark the market as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "market:enable" + ], + "description": "Send this attribute if you want to mark the market as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order" + ], + "description": "Execute an action on a resource of type orders", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order_subscription" + ], + "description": "Execute an action on a resource of type order_subscriptions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order_subscription:activate" + ], + "description": "Send this attribute if you want to mark this subscription as active.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order_subscription:cancel" + ], + "description": "Send this attribute if you want to mark this subscription as cancelled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order_subscription:deactivate" + ], + "description": "Send this attribute if you want to mark this subscription as inactive.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:approve" + ], + "description": "Send this attribute if you want to approve a placed order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:approve_and_capture" + ], + "description": "Send this attribute if you want to approve and capture a placed order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:archive" + ], + "description": "Send this attribute if you want to archive the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:authorization_amount_cents" + ], + "description": "The authorization amount, in cents.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:authorize" + ], + "description": "Send this attribute if you want to authorize the order's payment source.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:billing_address_clone_id" + ], + "description": "The id of the address that you want to clone to create the order's billing address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "isRequired": true + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the resource" + } + ] + }, + { + "name": [ + "order:billing_address_same_as_shipping" + ], + "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:cancel" + ], + "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:capture" + ], + "description": "Send this attribute if you want to capture an authorized order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:commit_invoice" + ], + "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:create_subscriptions" + ], + "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:customer_payment_source_id" + ], + "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "isRequired": true + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the resource" + } + ] + }, + { + "name": [ + "order:nullify_payment_source" + ], + "description": "Send this attribute if you want to nullify the payment source for this order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:place" + ], + "description": "Send this attribute if you want to place the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:refresh" + ], + "description": "Send this attribute if you want to manually refresh the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:refund" + ], + "description": "Send this attribute if you want to refund a captured order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:refund_invoice" + ], + "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "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 customer's address book as a customer address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:save_payment_source_to_customer_wallet" + ], + "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "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 customer's address book as a customer address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:shipping_address_clone_id" + ], + "description": "The id of the address that you want to clone to create the order's shipping address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "isRequired": true + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the resource" + } + ] + }, + { + "name": [ + "order:shipping_address_same_as_billing" + ], + "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:start_editing" + ], + "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:stop_editing" + ], + "description": "Send this attribute to stop the editing for the order and return back to placed status.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:unarchive" + ], + "description": "Send this attribute if you want to unarchive the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:update_taxes" + ], + "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "order:validate" + ], + "description": "Send this attribute if you want to trigger the external validation for the order.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "payment_method" + ], + "description": "Execute an action on a resource of type payment_methods", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "payment_method:disable" + ], + "description": "Send this attribute if you want to mark the payment method as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "payment_method:enable" + ], + "description": "Send this attribute if you want to mark the payment method as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "percentage_discount_promotion" + ], + "description": "Execute an action on a resource of type percentage_discount_promotions", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "percentage_discount_promotion:disable" + ], + "description": "Send this attribute if you want to mark the promotion as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "percentage_discount_promotion:enable" + ], + "description": "Send this attribute if you want to mark the promotion as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return" + ], + "description": "Execute an action on a resource of type returns", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return_line_item" + ], + "description": "Execute an action on a resource of type return_line_items", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return_line_item:restock" + ], + "description": "Send this attribute if you want to restock the line item.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:approve" + ], + "description": "Send this attribute if you want to mark this return as approved.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:archive" + ], + "description": "Send this attribute if you want to archive the return.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:cancel" + ], + "description": "Send this attribute if you want to mark this return as cancelled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:receive" + ], + "description": "Send this attribute if you want to mark this return as received.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:reject" + ], + "description": "Send this attribute if you want to mark this return as rejected.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:request" + ], + "description": "Send this attribute if you want to activate this return.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:restock" + ], + "description": "Send this attribute if you want to restock all of the return line items.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:ship" + ], + "description": "Send this attribute if you want to mark this return as shipped.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "return:unarchive" + ], + "description": "Send this attribute if you want to unarchive the return.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "satispay_payment" + ], + "description": "Execute an action on a resource of type satispay_payments", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "satispay_payment:refresh" + ], + "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment" + ], + "description": "Execute an action on a resource of type shipments", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:decrement_stock" + ], + "description": "Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:get_rates" + ], + "description": "Send this attribute if you want get the shipping rates from the associated carrier accounts.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:on_hold" + ], + "description": "Send this attribute if you want to put this shipment on hold.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:packing" + ], + "description": "Send this attribute if you want to start packing this shipment.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:picking" + ], + "description": "Send this attribute if you want to start picking this shipment.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:purchase" + ], + "description": "Send this attribute if you want to purchase this shipment with the selected rate.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:ready_to_ship" + ], + "description": "Send this attribute if you want to mark this shipment as ready to ship.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:release_stock" + ], + "description": "Send this attribute if you want to automatically release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:reserve_stock" + ], + "description": "Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:ship" + ], + "description": "Send this attribute if you want to mark this shipment as shipped.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipment:upcoming" + ], + "description": "Send this attribute if you want to mark this shipment as upcoming.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipping_method" + ], + "description": "Execute an action on a resource of type shipping_methods", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipping_method:disable" + ], + "description": "Send this attribute if you want to mark the shipping method as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "shipping_method:enable" + ], + "description": "Send this attribute if you want to mark the shipping method as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_line_item" + ], + "description": "Execute an action on a resource of type stock_line_items", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_line_item:decrement_stock" + ], + "description": "Send this attribute if you want to automatically decrement and release the stock this stock line item. can be done only when fulfillment is in progress.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_line_item:release_stock" + ], + "description": "Send this attribute if you want to automatically release the stock for this stock line item. can be done only when fulfillment is in progress.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_line_item:reserve_stock" + ], + "description": "Send this attribute if you want to automatically reserve the stock for this stock line item. can be done only when fulfillment is in progress.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_reservation" + ], + "description": "Execute an action on a resource of type stock_reservations", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_reservation:pending" + ], + "description": "Send this attribute if you want to mark this stock reservation as pending.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_transfer" + ], + "description": "Execute an action on a resource of type stock_transfers", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_transfer:cancel" + ], + "description": "Send this attribute if you want to cancel this stock transfer.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_transfer:complete" + ], + "description": "Send this attribute if you want to complete this stock transfer.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_transfer:in_transit" + ], + "description": "Send this attribute if you want to mark this stock transfer as in transit.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_transfer:on_hold" + ], + "description": "Send this attribute if you want to put this stock transfer on hold.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_transfer:picking" + ], + "description": "Send this attribute if you want to start picking this stock transfer.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stock_transfer:upcoming" + ], + "description": "Send this attribute if you want to mark this stock transfer as upcoming.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stripe_payment" + ], + "description": "Execute an action on a resource of type stripe_payments", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stripe_payment:refresh" + ], + "description": "Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "stripe_payment:update" + ], + "description": "Send this attribute if you want to update the created payment intent with fresh order data.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "webhook" + ], + "description": "Execute an action on a resource of type webhooks", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "webhook:disable" + ], + "description": "Send this attribute if you want to mark the webhook as disabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "webhook:enable" + ], + "description": "Send this attribute if you want to mark the webhook as enabled.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "webhook:reset_circuit" + ], + "description": "Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": [ + "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" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file" + }, + { + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories" + }, + { + "name": [ + "-N", + "--notify" + ], + "description": "Force system notification when export has finished", + "hidden": true + }, + { + "name": [ + "-i", + "--clientId" + ], + "description": "Organization client_id", + "hidden": true + }, + { + "name": [ + "-s", + "--clientSecret" + ], + "description": "Organization client_secret", + "hidden": true + }, + { + "name": [ + "-C", + "--csv" + ], + "description": "Export fields in csv format" + }, + { + "name": [ + "-D", + "--delimiter" + ], + "description": "The delimiter character to use in the csv output file (one of ',', ';', '|', tab)", + "args": { + "suggestions": [ + ",", + ";", + "|", + "TAB" + ] + } + }, + { + "name": [ + "-H", + "--header" + ], + "description": "Rename column headers defining a comma-separated list of values field:\"renamed title\"" + }, + { + "name": [ + "-b", + "--blind" + ], + "description": "Execute in blind mode without prompt and progress bar" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-T", + "--timeout" + ], + "description": "Set request timeout in milliseconds [1000 - 15000]", + "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" + }, + { + "name": [ + "-r", + "--resource" + ], + "description": "The resource type" + }, + { + "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": [ + "resources:count", + "count", + "res:count", + "rs:count" + ], + "description": "Count the number of existent resources", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + } + ] + }, + { + "name": [ + "resources:create", + "create", + "rc", + "res:create", + "post" + ], + "description": "Create a new resource", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-a", + "--attribute" + ], + "description": "Define a resource attribute" + }, + { + "name": [ + "-O", + "--object" + ], + "description": "Define a resource object attribute" + }, + { + "name": [ + "-r", + "--relationship" + ], + "description": "Define a relationship with another resource" + }, + { + "name": [ + "-m", + "--metadata" + ], + "description": "Define a metadata attribute or a set of metadata attributes" + }, + { + "name": [ + "-D", + "--data" + ], + "description": "The data file to use as request body" + }, + { + "name": [ + "-t", + "--tags" + ], + "description": "List of tags associated with the resource" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + } + ] + }, + { + "name": [ + "resources:delete", + "delete", + "rd", + "res:delete" + ], + "description": "Delete an existing resource", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to delete", + "isOptional": true + } + ] + }, + { + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file" + }, + { + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-p", + "--page" + ], + "description": "Page number" + }, + { + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true + } + ], + "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": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-p", + "--page" + ], + "description": "Page number" + }, + { + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file" + }, + { + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to retrieve", + "isOptional": true + } + ] + }, + { + "name": [ + "resources:list", + "list", + "rl", + "res:list" + ], + "description": "Fetch a collection of resources", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-p", + "--page" + ], + "description": "Page number" + }, + { + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file" + }, + { + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + } + ] + }, + { + "name": [ + "relationship", + "relationship", + "resources:rel", + "res:rel", + "res:relationship", + "relationship" + ], + "description": "Fetch a resource relationship", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-p", + "--page" + ], + "description": "Page number" + }, + { + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file" + }, + { + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file" + }, + { + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "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" + }, + { + "name": [ + "resources:update", + "update", + "ru", + "res:update", + "patch" + ], + "description": "Update an existing resource", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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" + }, + { + "name": "--load-args", + "description": "Load previously saved command arguments" + }, + { + "name": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-a", + "--attribute" + ], + "description": "Define a resource attribute" + }, + { + "name": [ + "-O", + "--object" + ], + "description": "Define a resource object attribute" + }, + { + "name": [ + "-r", + "--relationship" + ], + "description": "Define a relationship with another resource" + }, + { + "name": [ + "-m", + "--metadata" + ], + "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource" + }, + { + "name": [ + "-M", + "--metadata-replace" + ], + "description": "Define a metadata attribute and replace every item already present in the remote resource" + }, + { + "name": [ + "-D", + "--data" + ], + "description": "The data file to use as request body" + }, + { + "name": [ + "-t", + "--tags" + ], + "description": "List of tags associated with the resource" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to update", + "isOptional": true + } + ] + }, + { + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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": "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of resource to clean up", + "isRequired": true, + "args": { + "description": "bundles|gift_cards|prices|promotions|...", + "suggestions": [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items" + ] + } + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "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" + } + ] + }, + { + "name": [ + "cleanups:types", + "clp:types" + ], + "description": "Show online documentation for supported resources", + "options": [ + { + "name": [ + "-O", + "--open" + ], + "description": "Open online documentation page" + } + ] + }, + { + "name": [ + "exports" + ], + "description": "List all the created exports or show details of a single export", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-A", + "--all" + ], + "description": "Show all exports instead of first 25 only" + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of resource exported", + "args": { + "suggestions": [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds" + ] + } + }, + { + "name": [ + "-s", + "--status" + ], + "description": "The export job status", + "args": { + "suggestions": [ + "in_progress", + "pending", + "completed", + "interrupted" + ] + } + }, + { + "name": [ + "-l", + "--limit" + ], + "description": "Limit number of exports in output" + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the export to be retrieved", + "isOptional": true + } + ] + }, + { + "name": [ + "exports:all", + "exp:all", + "export" + ], + "description": "Export all the records", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of resource being exported", + "isRequired": true, + "args": { + "description": "addresses|bundles|coupons|customer_subscriptions|...", + "suggestions": [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds" + ] + } + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-D", + "--dry-data" + ], + "description": "Skip redundant attributes" + }, + { + "name": [ + "-F", + "--format" + ], + "description": "Export file format", + "args": { + "suggestions": [ + "csv", + "json" + ], + "default": "json" + } + }, + { + "name": [ + "-C", + "--csv" + ], + "description": "Export data in csv format" + }, + { + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file" + }, + { + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories" + }, + { + "name": [ + "-N", + "--notify" + ], + "description": "Force system notification when export has finished", + "hidden": true + }, + { + "name": [ + "-b", + "--blind" + ], + "description": "Execute in blind mode without showing the progress monitor" + }, + { + "name": [ + "-P", + "--prettify" + ], + "description": "Prettify json output format" + }, + { + "name": [ + "-O", + "--open" + ], + "description": "Open automatically the file after a successful export" + }, + { + "name": [ + "-q", + "--quiet" + ], + "description": "Execute command without showing warning messages" + }, + { + "name": [ + "-k", + "--keep" + ], + "description": "Keep original export files in temp dir" + } + ], + "hidden": false + }, + { + "name": [ + "exports:create", + "exp:create" + ], + "description": "Create a new export", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of resource being exported", + "isRequired": true, + "args": { + "description": "addresses|bundles|coupons|customer_subscriptions|...", + "suggestions": [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds" + ] + } + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-D", + "--dry-data" + ], + "description": "Skip redundant attributes" + }, + { + "name": [ + "-F", + "--format" + ], + "description": "Export file format", + "args": { + "suggestions": [ + "csv", + "json" + ], + "default": "json" + } + }, + { + "name": [ + "-C", + "--csv" + ], + "description": "Export data in csv format" + }, + { + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file" + }, + { + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories" + }, + { + "name": [ + "-N", + "--notify" + ], + "description": "Force system notification when export has finished", + "hidden": true + }, + { + "name": [ + "-b", + "--blind" + ], + "description": "Execute in blind mode without showing the progress monitor" + }, + { + "name": [ + "-P", + "--prettify" + ], + "description": "Prettify json output format" + }, + { + "name": [ + "-O", + "--open" + ], + "description": "Open automatically the file after a successful export" + } + ] + }, + { + "name": [ + "exports:details", + "exp:details" + ], + "description": "Show the details of an existing export", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the export" + } + ] + }, + { + "name": [ + "exports:group", + "exp:group" + ], + "description": "List all the exports related to an export group", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + } + ], + "args": [ + { + "name": "group_id", + "description": "Unique id of the group export" + } + ] + }, + { + "name": [ + "exports:list", + "exp:list" + ], + "description": "List all the created exports", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-A", + "--all" + ], + "description": "Show all exports instead of first 25 only" + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of resource exported", + "args": { + "suggestions": [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds" + ] + } + }, + { + "name": [ + "-s", + "--status" + ], + "description": "The export job status", + "args": { + "suggestions": [ + "in_progress", + "pending", + "completed", + "interrupted" + ] + } + }, + { + "name": [ + "-l", + "--limit" + ], + "description": "Limit number of exports in output" + } + ] + }, + { + "name": [ + "exports:types", + "exp:types" + ], + "description": "Show online documentation for supported resources", + "options": [ + { + "name": [ + "-O", + "--open" + ], + "description": "Open online documentation page" + } + ] + }, + { + "name": [ + "tags" + ], + "description": "List all the created tags or show details of a single tag", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-A", + "--all" + ], + "description": "Show all tags instead of first 25 only" + }, + { + "name": [ + "-l", + "--limit" + ], + "description": "Limit number of tags in output" + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the tag to be retrieved", + "isOptional": true + } + ] + }, + { + "name": [ + "tags:add", + "tag" + ], + "description": "Add one or more tags to a set of resources", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The tag name", + "isRequired": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of the resource to tag", + "isRequired": true + }, + { + "name": [ + "-i", + "--id" + ], + "description": "The ids of the resources to tag", + "isRequired": true + }, + { + "name": [ + "-C", + "--create" + ], + "description": "Create tags if don't exist" + }, + { + "name": [ + "-v", + "--verbose" + ], + "description": "Show details of the tag process" + } + ] + }, + { + "name": [ + "tags:count" + ], + "description": "Count resources tagged with a specific tag", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of the tagged resources" + }, + { + "name": [ + "-z", + "--zero" + ], + "description": "Show also resources without tags" + } + ], + "args": [ + { + "name": "id_name", + "description": "Unique id or name of the tag" + } + ] + }, + { + "name": [ + "tags:create" + ], + "description": "Create one or more new tags", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The tag name", + "isRequired": true + } + ] + }, + { + "name": [ + "tags:delete" + ], + "description": "Delete one or more existing tags", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The tag name", + "isRequired": true + } + ] + }, + { + "name": [ + "tags:details" + ], + "description": "Show the details of an existing tag", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + } + ], + "args": [ + { + "name": "id_name", + "description": "Unique id or name of the tag" + } + ] + }, + { + "name": [ + "tags:list" + ], + "description": "List all the created tags", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-A", + "--all" + ], + "description": "Show all tags instead of first 25 only" + }, + { + "name": [ + "-l", + "--limit" + ], + "description": "Limit number of tags in output" + } + ] + }, + { + "name": [ + "tags:remove", + "tag" + ], + "description": "Remove one or more tags to a set of resources", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The tag name", + "isRequired": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of the resource to tag", + "isRequired": true + }, + { + "name": [ + "-i", + "--id" + ], + "description": "The ids of th eresources to tag", + "isRequired": true + }, + { + "name": [ + "-v", + "--verbose" + ], + "description": "Show details of the tag process" + } + ] + }, + { + "name": [ + "tags:types" + ], + "description": "Show online documentation for supported resources", + "options": [ + { + "name": [ + "-O", + "--open" + ], + "description": "Open online documentation page" + } + ] + }, + { + "name": [ + "tags:update" + ], + "description": "Update an existing tag", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The new tag name", + "isRequired": true + } + ], + "args": [ + { + "name": "id_name", + "description": "Unique id or name of the tag" + } + ] + }, + { + "name": [ + "tags:which" + ], + "description": "Show all the resources with this tag", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of the tagged resources", + "isRequired": true + }, + { + "name": [ + "-A", + "--all" + ], + "description": "Show all resources instead of first 25 only" + }, + { + "name": [ + "-l", + "--limit" + ], + "description": "Limit number of resources in output" + } + ], + "args": [ + { + "name": "id_name", + "description": "Unique id or name of the tag" + } + ] + }, + { + "name": [ + "provisioning:create", + "prov:create", + "pc", + "pcreate" + ], + "description": "Create a new resource", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-a", + "--attribute" + ], + "description": "Define a resource attribute" + }, + { + "name": [ + "-O", + "--object" + ], + "description": "Define a resource object attribute" + }, + { + "name": [ + "-r", + "--relationship" + ], + "description": "Define a relationship with another resource" + }, + { + "name": [ + "-m", + "--metadata" + ], + "description": "Define a metadata attribute or a set of metadata attributes" + }, + { + "name": [ + "-D", + "--data" + ], + "description": "The data file to use as request body" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + } + ] + }, + { + "name": [ + "provisioning:delete", + "prov:delete", + "pd", + "pdelete", + "pdel" + ], + "description": "Delete an existing resource", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to delete", + "isOptional": true + } + ] + }, + { + "name": [ + "provisioning:exec", + "prov:exec", + "pe", + "pexec" + ], + "description": "Execute an action on a resource", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-a", + "--attribute" + ], + "description": "Define a resource attribute" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource on which to execute the action", + "isOptional": true + }, + { + "name": "action", + "description": "Action to execute on resource", + "isOptional": true + } + ] + }, + { + "name": [ + "provisioning:fetch", + "prov:fetch", + "pf" + ], + "description": "Retrieve a resource or list a set of resources", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-p", + "--page" + ], + "description": "Page number" + }, + { + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "path", + "description": "Path (or url) of the resource(s) to fetch" + }, + { + "name": "id", + "description": "Resource id", + "isOptional": true + } + ] + }, + { + "name": [ + "provisioning:get", + "prov:get", + "pg", + "pget" + ], + "description": "Retrieve a resource or list a set of resources", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-p", + "--page" + ], + "description": "Page number" + }, + { + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to retrieve", + "isOptional": true + } + ] + }, + { + "name": [ + "provisioning:list", + "pl", + "prov:list", + "plist", + "pls" + ], + "description": "Fetch a collection of resources", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-p", + "--page" + ], + "description": "Page number" + }, + { + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + } + ] + }, + { + "name": [ + "provisioning:rel", + "provisioning:rel", + "prov:rel", + "prov:relationship" + ], + "description": "Fetch a resource relationship", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters" + }, + { + "name": [ + "-p", + "--page" + ], + "description": "Page number" + }, + { + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page" + }, + { + "name": [ + "-s", + "--sort" + ], + "description": "Defines results ordering" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to retrieve" + }, + { + "name": "relationship", + "description": "Name of the relationship field" + } + ], + "hidden": false + }, + { + "name": [ + "provisioning:resources", + "prov:resources", + "pres" + ], + "description": "List all the available provisioning api resources", + "options": [ + { + "name": [ + "-h", + "--help" + ], + "description": "Show cli help." + } + ] + }, + { + "name": [ + "provisioning:retrieve", + "prov:retrieve", + "pr", + "pretrieve" + ], + "description": "Fetch a single resource", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to retrieve", + "isOptional": true + } + ] + }, + { + "name": [ + "provisioning:update", + "prov:update", + "pu", + "pupdate", + "pupd" + ], + "description": "Update an existing resource", + "options": [ + { + "name": [ + "-d", + "--domain" + ], + "hidden": true + }, + { + "name": "--accessToken", + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include" + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + }, + { + "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": [ + "-H", + "--headers" + ], + "description": "Show response headers" + }, + { + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" + }, + { + "name": [ + "-a", + "--attribute" + ], + "description": "Define a resource attribute" + }, + { + "name": [ + "-O", + "--object" + ], + "description": "Define a resource object attribute" + }, + { + "name": [ + "-r", + "--relationship" + ], + "description": "Define a relationship with another resource" + }, + { + "name": [ + "-m", + "--metadata" + ], + "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource" + }, + { + "name": [ + "-M", + "--metadata-replace" + ], + "description": "Define a metadata attribute and replace every item already present in the remote resource" + }, + { + "name": [ + "-D", + "--data" + ], + "description": "The data file to use as request body" + } + ], + "args": [ + { + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to update", + "isOptional": true + } + ] + }, + { + "name": [ + "autocomplete" + ], + "description": "Display autocomplete installation instructions.", + "options": [ + { + "name": [ + "-r", + "--refresh-cache" + ], + "description": "Refresh cache (ignores displaying instructions)" + } + ], + "args": [ + { + "name": "shell", + "description": "Shell type", + "suggestions": [ + "zsh", + "bash", + "powershell" + ], + "isOptional": true + } + ] + }, + { + "name": [ + "help" + ], + "description": "Display help for <%= config.bin %>.", + "options": [ + { + "name": [ + "-n", + "--nested-commands" + ], + "description": "Include all nested commands in the output." + } + ], + "args": [ + { + "name": "commands", + "description": "Command to show help for.", + "isOptional": true + } + ] + }, + { + "name": [ + "plugins" + ], + "description": "List installed plugins.", + "options": [ + { + "name": "--json", + "description": "Format output as json." + }, + { + "name": "--core", + "description": "Show core plugins." + } + ] + }, + { + "name": [ + "plugins:inspect" + ], + "description": "Displays installation properties of a plugin.", + "options": [ + { + "name": "--json", + "description": "Format output as json." + }, + { + "name": [ + "-h", + "--help" + ], + "description": "Show cli help." + }, + { + "name": [ + "-v", + "--verbose" + ] + } + ], + "args": [ + { + "name": "plugin", + "description": "Plugin to inspect.", + "default": "." + } + ] + }, + { + "name": [ + "plugins:install", + "plugins:add" + ], + "description": "Installs a plugin into the cli.\ncan be installed from npm or a git url.\n\ninstallation of a user-installed plugin will override a core plugin.\n\ne.g. if you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. this is useful if a user needs to update core plugin functionality in the cli without the need to patch and update the whole cli.\n", + "options": [ + { + "name": "--json", + "description": "Format output as json." + }, + { + "name": [ + "-f", + "--force" + ], + "description": "Run yarn install with force flag." + }, + { + "name": [ + "-h", + "--help" + ], + "description": "Show cli help." + }, + { + "name": "--jit", + "hidden": true + }, + { + "name": [ + "-s", + "--silent" + ], + "description": "Silences yarn output." + }, + { + "name": [ + "-v", + "--verbose" + ], + "description": "Show verbose yarn output." + } + ], + "args": [ + { + "name": "plugin", + "description": "Plugin to install." + } + ] + }, + { + "name": [ + "plugins:link" + ], + "description": "Links a plugin into the cli for development.\ninstallation of a linked plugin will override a user-installed or core plugin.\n\ne.g. if you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. this is useful for development work.\n", + "options": [ + { + "name": [ + "-h", + "--help" + ], + "description": "Show cli help." + }, + { + "name": "--install", + "description": "Install dependencies after linking the plugin.", + "exclusiveOn": [ + "--no-install" + ] + }, + { + "name": "--no-install" + }, + { + "name": [ + "-v", + "--verbose" + ] + } + ], + "args": [ + { + "name": "path", + "description": "Path to plugin", + "default": "." + } + ] + }, + { + "name": [ + "plugins:reset" + ], + "options": [ + { + "name": "--hard" + }, + { + "name": "--reinstall" + } + ] + }, + { + "name": [ + "plugins:uninstall", + "plugins:unlink", + "plugins:remove" + ], + "description": "Removes a plugin from the cli.", + "options": [ + { + "name": [ + "-h", + "--help" + ], + "description": "Show cli help." + }, + { + "name": [ + "-v", + "--verbose" + ] + } + ], + "args": [ + { + "name": "plugin", + "description": "Plugin to uninstall" + } + ] + }, + { + "name": [ + "plugins:update" + ], + "description": "Update installed plugins.", + "options": [ + { + "name": [ + "-h", + "--help" + ], + "description": "Show cli help." + }, + { + "name": [ + "-v", + "--verbose" + ] + } + ] + } + ] +} + + +export default completionSpec From a2bd48b9786d29380a10984e20e7967feab6bed5 Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Thu, 11 Apr 2024 16:30:50 +0200 Subject: [PATCH 2/8] fix: fix empty args object --- src/commercelayer.ts | 5670 ++++++++++++++++++++++++------------------ 1 file changed, 3318 insertions(+), 2352 deletions(-) diff --git a/src/commercelayer.ts b/src/commercelayer.ts index 94a08cb19f58..5a6a065789a8 100644 --- a/src/commercelayer.ts +++ b/src/commercelayer.ts @@ -20,7 +20,8 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "Organization slug" + "description": "Organization slug", + "args": {} }, { "name": [ @@ -28,6 +29,7 @@ const completionSpec: Fig.Spec = { "--domain" ], "description": "Api domain", + "args": {}, "hidden": true }, { @@ -63,18 +65,21 @@ const completionSpec: Fig.Spec = { }, { "name": "--id", - "description": "Application id" + "description": "Application id", + "args": {} }, { "name": [ "-a", "--alias" ], - "description": "The alias associated to the application" + "description": "The alias associated to the application", + "args": {} }, { "name": "--appkey", "description": "Cli application key", + "args": {}, "hidden": true }, { @@ -82,7 +87,8 @@ const completionSpec: Fig.Spec = { "-A", "--api" ], - "description": "Specific api application" + "description": "Specific api application", + "args": {} }, { "name": [ @@ -113,7 +119,8 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "Organization slug" + "description": "Organization slug", + "args": {} }, { "name": [ @@ -121,6 +128,7 @@ const completionSpec: Fig.Spec = { "--domain" ], "description": "Api domain", + "args": {}, "hidden": true }, { @@ -129,6 +137,7 @@ const completionSpec: Fig.Spec = { "--clientId" ], "description": "Application client_id", + "args": {}, "isRequired": true }, { @@ -136,28 +145,32 @@ const completionSpec: Fig.Spec = { "-s", "--clientSecret" ], - "description": "Application client_secret" + "description": "Application client_secret", + "args": {} }, { "name": [ "-S", "--scope" ], - "description": "Access token scope (market, stock location)" + "description": "Access token scope (market, stock location)", + "args": {} }, { "name": [ "-e", "--email" ], - "description": "Customer email" + "description": "Customer email", + "args": {} }, { "name": [ "-p", "--password" ], - "description": "Customer secret password" + "description": "Customer secret password", + "args": {} }, { "name": [ @@ -165,6 +178,7 @@ const completionSpec: Fig.Spec = { "--alias" ], "description": "The alias you want to associate to the application", + "args": {}, "isRequired": true }, { @@ -206,7 +220,8 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "Organization slug" + "description": "Organization slug", + "args": {} }, { "name": [ @@ -214,6 +229,7 @@ const completionSpec: Fig.Spec = { "--domain" ], "description": "Api domain", + "args": {}, "hidden": true }, { @@ -249,18 +265,21 @@ const completionSpec: Fig.Spec = { }, { "name": "--id", - "description": "Application id" + "description": "Application id", + "args": {} }, { "name": [ "-a", "--alias" ], - "description": "The alias associated to the application" + "description": "The alias associated to the application", + "args": {} }, { "name": "--appkey", "description": "Cli application key", + "args": {}, "hidden": true }, { @@ -268,7 +287,8 @@ const completionSpec: Fig.Spec = { "-A", "--api" ], - "description": "Specific api application" + "description": "Specific api application", + "args": {} }, { "name": [ @@ -292,7 +312,8 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "Organization slug" + "description": "Organization slug", + "args": {} }, { "name": [ @@ -300,6 +321,7 @@ const completionSpec: Fig.Spec = { "--domain" ], "description": "Api domain", + "args": {}, "hidden": true }, { @@ -308,6 +330,7 @@ const completionSpec: Fig.Spec = { "--clientId" ], "description": "Application client_id", + "args": {}, "isRequired": true }, { @@ -315,28 +338,32 @@ const completionSpec: Fig.Spec = { "-s", "--clientSecret" ], - "description": "Application client_secret" + "description": "Application client_secret", + "args": {} }, { "name": [ "-S", "--scope" ], - "description": "Access token scope (market, stock location)" + "description": "Access token scope (market, stock location)", + "args": {} }, { "name": [ "-e", "--email" ], - "description": "Customer email" + "description": "Customer email", + "args": {} }, { "name": [ "-p", "--password" ], - "description": "Customer secret password" + "description": "Customer secret password", + "args": {} }, { "name": [ @@ -344,6 +371,7 @@ const completionSpec: Fig.Spec = { "--alias" ], "description": "The alias you want to associate to the application", + "args": {}, "isRequired": true }, { @@ -368,7 +396,8 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "Organization slug" + "description": "Organization slug", + "args": {} }, { "name": [ @@ -376,6 +405,7 @@ const completionSpec: Fig.Spec = { "--domain" ], "description": "Api domain", + "args": {}, "hidden": true }, { @@ -411,18 +441,21 @@ const completionSpec: Fig.Spec = { }, { "name": "--id", - "description": "Application id" + "description": "Application id", + "args": {} }, { "name": [ "-a", "--alias" ], - "description": "The alias associated to the application" + "description": "The alias associated to the application", + "args": {} }, { "name": "--appkey", "description": "Cli application key", + "args": {}, "hidden": true }, { @@ -430,7 +463,8 @@ const completionSpec: Fig.Spec = { "-A", "--api" ], - "description": "Specific api application" + "description": "Specific api application", + "args": {} }, { "name": [ @@ -464,7 +498,8 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "Organization slug" + "description": "Organization slug", + "args": {} }, { "name": [ @@ -472,6 +507,7 @@ const completionSpec: Fig.Spec = { "--domain" ], "description": "Api domain", + "args": {}, "hidden": true }, { @@ -507,18 +543,21 @@ const completionSpec: Fig.Spec = { }, { "name": "--id", - "description": "Application id" + "description": "Application id", + "args": {} }, { "name": [ "-a", "--alias" ], - "description": "The alias associated to the application" + "description": "The alias associated to the application", + "args": {} }, { "name": "--appkey", "description": "Cli application key", + "args": {}, "hidden": true }, { @@ -526,7 +565,8 @@ const completionSpec: Fig.Spec = { "-A", "--api" ], - "description": "Specific api application" + "description": "Specific api application", + "args": {} }, { "name": [ @@ -557,7 +597,8 @@ const completionSpec: Fig.Spec = { "-a", "--alias" ], - "description": "The alias you want to associate to the application" + "description": "The alias you want to associate to the application", + "args": {} } ], "args": [ @@ -579,7 +620,8 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "Organization slug" + "description": "Organization slug", + "args": {} }, { "name": [ @@ -587,6 +629,7 @@ const completionSpec: Fig.Spec = { "--domain" ], "description": "Api domain", + "args": {}, "hidden": true }, { @@ -622,18 +665,21 @@ const completionSpec: Fig.Spec = { }, { "name": "--id", - "description": "Application id" + "description": "Application id", + "args": {} }, { "name": [ "-a", "--alias" ], - "description": "The alias associated to the application" + "description": "The alias associated to the application", + "args": {} }, { "name": "--appkey", "description": "Cli application key", + "args": {}, "hidden": true }, { @@ -641,7 +687,8 @@ const completionSpec: Fig.Spec = { "-A", "--api" ], - "description": "Specific api application" + "description": "Specific api application", + "args": {} } ] }, @@ -657,7 +704,8 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "Organization slug" + "description": "Organization slug", + "args": {} }, { "name": [ @@ -665,6 +713,7 @@ const completionSpec: Fig.Spec = { "--domain" ], "description": "Api domain", + "args": {}, "hidden": true }, { @@ -700,18 +749,21 @@ const completionSpec: Fig.Spec = { }, { "name": "--id", - "description": "Application id" + "description": "Application id", + "args": {} }, { "name": [ "-a", "--alias" ], - "description": "The alias associated to the application" + "description": "The alias associated to the application", + "args": {} }, { "name": "--appkey", "description": "Cli application key", + "args": {}, "hidden": true }, { @@ -719,7 +771,8 @@ const completionSpec: Fig.Spec = { "-A", "--api" ], - "description": "Specific api application" + "description": "Specific api application", + "args": {} }, { "name": [ @@ -741,6 +794,7 @@ const completionSpec: Fig.Spec = { "--shared" ], "description": "Organization shared secret", + "args": {}, "hidden": true }, { @@ -749,6 +803,7 @@ const completionSpec: Fig.Spec = { "--minutes" ], "description": "Minutes to token expiration [2, 240]", + "args": {}, "hidden": true } ], @@ -767,7 +822,8 @@ const completionSpec: Fig.Spec = { "-v", "--version" ], - "description": "Update cli to a specific version or tag" + "description": "Update cli to a specific version or tag", + "args": {} } ] }, @@ -837,6 +893,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -845,10 +902,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -896,7 +955,8 @@ const completionSpec: Fig.Spec = { "-g", "--group" ], - "description": "The group id associated to the import in case of multi-chunk imports" + "description": "The group id associated to the import in case of multi-chunk imports", + "args": {} }, { "name": [ @@ -932,7 +992,8 @@ const completionSpec: Fig.Spec = { "-l", "--limit" ], - "description": "Limit number of imports in output" + "description": "Limit number of imports in output", + "args": {} } ], "args": [ @@ -957,6 +1018,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -965,10 +1027,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -978,7 +1042,6 @@ const completionSpec: Fig.Spec = { "--type" ], "description": "The type of resource being imported", - "isRequired": true, "args": { "description": "addresses|bundles|coupons|customer_addresses|...", "suggestions": [ @@ -1004,14 +1067,16 @@ const completionSpec: Fig.Spec = { "tags", "tax_categories" ] - } + }, + "isRequired": true }, { "name": [ "-p", "--parent" ], - "description": "The id of the parent resource to be associated with imported data" + "description": "The id of the parent resource to be associated with imported data", + "args": {} }, { "name": [ @@ -1019,6 +1084,7 @@ const completionSpec: Fig.Spec = { "--inputs" ], "description": "The path of the file containing the data to import", + "args": {}, "isRequired": true }, { @@ -1072,6 +1138,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1080,10 +1147,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true } @@ -1108,6 +1177,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1116,10 +1186,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1142,7 +1214,8 @@ const completionSpec: Fig.Spec = { "-S", "--save-inputs" ], - "description": "Save import inputs to local file" + "description": "Save import inputs to local file", + "args": {} } ], "args": [ @@ -1165,6 +1238,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1173,10 +1247,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true } @@ -1201,6 +1277,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1209,10 +1286,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1260,7 +1339,8 @@ const completionSpec: Fig.Spec = { "-g", "--group" ], - "description": "The group id associated to the import in case of multi-chunk imports" + "description": "The group id associated to the import in case of multi-chunk imports", + "args": {} }, { "name": [ @@ -1296,7 +1376,8 @@ const completionSpec: Fig.Spec = { "-l", "--limit" ], - "description": "Limit number of imports in output" + "description": "Limit number of imports in output", + "args": {} } ] }, @@ -1340,6 +1421,7 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { @@ -1377,13 +1459,15 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "The slug of your organization" + "description": "The slug of your organization", + "args": {} }, { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { @@ -1392,6 +1476,7 @@ const completionSpec: Fig.Spec = { "--clientId" ], "description": "Application client_id", + "args": {}, "isRequired": true }, { @@ -1399,28 +1484,32 @@ const completionSpec: Fig.Spec = { "-s", "--clientSecret" ], - "description": "Application client_secret" + "description": "Application client_secret", + "args": {} }, { "name": [ "-S", "--scope" ], - "description": "Access token scope (market, stock location)" + "description": "Access token scope (market, stock location)", + "args": {} }, { "name": [ "-e", "--email" ], - "description": "Customer email" + "description": "Customer email", + "args": {} }, { "name": [ "-p", "--password" ], - "description": "Customer secret password" + "description": "Customer secret password", + "args": {} }, { "name": "--info", @@ -1446,13 +1535,15 @@ const completionSpec: Fig.Spec = { "-o", "--organization" ], - "description": "The slug of your organization" + "description": "The slug of your organization", + "args": {} }, { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { @@ -1461,6 +1552,7 @@ const completionSpec: Fig.Spec = { "--clientId" ], "description": "Application client_id", + "args": {}, "isRequired": true }, { @@ -1468,14 +1560,16 @@ const completionSpec: Fig.Spec = { "-s", "--clientSecret" ], - "description": "Application client_secret" + "description": "Application client_secret", + "args": {} }, { "name": [ "-S", "--scope" ], - "description": "Access token scope" + "description": "Access token scope", + "args": {} }, { "name": [ @@ -1494,9 +1588,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "orders" + "adyen_payment" ], - "description": "Execute an action on an order", + "description": "Execute an action on a resource of type adyen_payments", "options": [ { "name": [ @@ -1504,6 +1598,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1512,10 +1607,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1524,7 +1621,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -1544,15 +1641,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:approve" + "adyen_payment:details" ], - "description": "Send this attribute if you want to approve a placed order.", + "description": "Send this attribute if you want to send additional details the payment request.", "options": [ { "name": [ @@ -1560,6 +1657,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1568,10 +1666,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1580,7 +1680,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -1600,15 +1700,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:approve_and_capture" + "authorization" ], - "description": "Send this attribute if you want to approve and capture a placed order.", + "description": "Execute an action on a resource of type authorizations", "options": [ { "name": [ @@ -1616,6 +1716,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1624,10 +1725,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1636,7 +1739,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -1656,15 +1759,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:archive" + "authorization:capture" ], - "description": "Send this attribute if you want to archive the order.", + "description": "Send this attribute if you want to create a capture for this authorization.", "options": [ { "name": [ @@ -1672,6 +1775,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1680,10 +1784,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1692,7 +1798,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -1712,15 +1818,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:authorization_amount_cents" + "authorization:capture_amount_cents" ], - "description": "The authorization amount, in cents.", + "description": "The associated capture amount, in cents.", "options": [ { "name": [ @@ -1728,6 +1834,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1736,10 +1843,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1748,7 +1857,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -1768,15 +1877,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:authorize" + "authorization:void" ], - "description": "Send this attribute if you want to authorize the order's payment source.", + "description": "Send this attribute if you want to create a void for this authorization.", "options": [ { "name": [ @@ -1784,6 +1893,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1792,10 +1902,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1804,7 +1916,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -1824,15 +1936,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:billing_address_clone_id" + "axerve_payment" ], - "description": "The id of the address that you want to clone to create the order's billing address.", + "description": "Execute an action on a resource of type axerve_payments", "options": [ { "name": [ @@ -1840,6 +1952,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1848,10 +1961,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1860,7 +1975,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -1875,28 +1990,20 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:billing_address_same_as_shipping" + "axerve_payment:update" ], - "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", + "description": "Send this attribute if you want to update the payment with fresh order data.", "options": [ { "name": [ @@ -1904,6 +2011,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1912,10 +2020,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1924,7 +2034,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -1944,15 +2054,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:cancel" + "bundle" ], - "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", + "description": "Execute an action on a resource of type bundles", "options": [ { "name": [ @@ -1960,6 +2070,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -1968,10 +2079,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -1980,7 +2093,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2000,15 +2113,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:capture" + "bundle:compute_compare_at_amount" ], - "description": "Send this attribute if you want to capture an authorized order.", + "description": "Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle skus for the market.", "options": [ { "name": [ @@ -2016,6 +2129,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2024,10 +2138,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2036,7 +2152,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2056,15 +2172,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:commit_invoice" + "bundle:compute_price_amount" ], - "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "description": "Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle skus for the market.", "options": [ { "name": [ @@ -2072,6 +2188,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2080,10 +2197,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2092,7 +2211,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2112,15 +2231,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:create_subscriptions" + "buy_x_pay_y_promotion" ], - "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", + "description": "Execute an action on a resource of type buy_x_pay_y_promotions", "options": [ { "name": [ @@ -2128,6 +2247,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2136,10 +2256,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2148,7 +2270,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2168,15 +2290,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:customer_payment_source_id" + "buy_x_pay_y_promotion:disable" ], - "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -2184,6 +2306,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2192,10 +2315,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2204,7 +2329,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2219,28 +2344,20 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:nullify_payment_source" + "buy_x_pay_y_promotion:enable" ], - "description": "Send this attribute if you want to nullify the payment source for this order.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -2248,6 +2365,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2256,10 +2374,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2268,7 +2388,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2288,15 +2408,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:place" + "capture" ], - "description": "Send this attribute if you want to place the order.", + "description": "Execute an action on a resource of type captures", "options": [ { "name": [ @@ -2304,6 +2424,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2312,10 +2433,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2324,7 +2447,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2344,15 +2467,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:refresh" + "capture:refund" ], - "description": "Send this attribute if you want to manually refresh the order.", + "description": "Send this attribute if you want to create a refund for this capture.", "options": [ { "name": [ @@ -2360,6 +2483,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2368,10 +2492,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2380,7 +2506,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2400,15 +2526,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:refund" + "capture:refund_amount_cents" ], - "description": "Send this attribute if you want to refund a captured order.", + "description": "The associated refund amount, in cents.", "options": [ { "name": [ @@ -2416,6 +2542,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2424,10 +2551,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2436,7 +2565,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2456,15 +2585,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:refund_invoice" + "checkout_com_payment" ], - "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "description": "Execute an action on a resource of type checkout_com_payments", "options": [ { "name": [ @@ -2472,6 +2601,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2480,10 +2610,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2492,7 +2624,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2512,15 +2644,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:save_billing_address_to_customer_address_book" + "checkout_com_payment:details" ], - "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", + "description": "Send this attribute if you want to send additional details the payment request (i.e. upon 3ds check).", "options": [ { "name": [ @@ -2528,6 +2660,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2536,10 +2669,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2548,7 +2683,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2568,15 +2703,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:save_payment_source_to_customer_wallet" + "checkout_com_payment:refresh" ], - "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", + "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", "options": [ { "name": [ @@ -2584,6 +2719,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2592,10 +2728,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2604,7 +2742,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2624,15 +2762,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:save_shipping_address_to_customer_address_book" + "customer_password_reset" ], - "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", + "description": "Execute an action on a resource of type customer_password_resets", "options": [ { "name": [ @@ -2640,6 +2778,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2648,10 +2787,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2660,7 +2801,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2680,15 +2821,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:shipping_address_clone_id" + "customer_password_reset:reset_password_token" ], - "description": "The id of the address that you want to clone to create the order's shipping address.", + "description": "Send the 'reset_password_token' that you got on create when updating the customer password.", "options": [ { "name": [ @@ -2696,6 +2837,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2704,10 +2846,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2716,7 +2860,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2731,28 +2875,20 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:shipping_address_same_as_billing" + "external_promotion" ], - "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", + "description": "Execute an action on a resource of type external_promotions", "options": [ { "name": [ @@ -2760,6 +2896,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2768,10 +2905,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2780,7 +2919,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2800,15 +2939,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:start_editing" + "external_promotion:disable" ], - "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -2816,6 +2955,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2824,10 +2964,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2836,7 +2978,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2856,15 +2998,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:stop_editing" + "external_promotion:enable" ], - "description": "Send this attribute to stop the editing for the order and return back to placed status.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -2872,6 +3014,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2880,10 +3023,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2892,7 +3037,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2912,15 +3057,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:unarchive" + "fixed_amount_promotion" ], - "description": "Send this attribute if you want to unarchive the order.", + "description": "Execute an action on a resource of type fixed_amount_promotions", "options": [ { "name": [ @@ -2928,6 +3073,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2936,10 +3082,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -2948,7 +3096,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -2968,15 +3116,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:update_taxes" + "fixed_amount_promotion:disable" ], - "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -2984,6 +3132,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -2992,10 +3141,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -3004,7 +3155,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -3024,15 +3175,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:validate" + "fixed_amount_promotion:enable" ], - "description": "Send this attribute if you want to trigger the external validation for the order.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -3040,6 +3191,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3048,10 +3200,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -3060,7 +3214,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -3080,15 +3234,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "webhooks" + "fixed_price_promotion" ], - "description": "List all the registered webhooks or the details of a single webhook", + "description": "Execute an action on a resource of type fixed_price_promotions", "options": [ { "name": [ @@ -3096,6 +3250,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3104,62 +3259,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-c", - "--circuit" - ], - "description": "Show only webhooks with circuit in the declared state", - "args": { - "suggestions": [ - "open", - "closed" - ] - } - }, - { - "name": [ - "-t", - "--topic" + "-p", + "--print" ], - "description": "The event that triggered the webhook" + "description": "Print out the modified resource" }, { "name": [ - "-H", - "--hide-empty" + "-j", + "--json" ], - "description": "Hide empty attributes" + "description": "Print result in json format" }, { "name": [ - "-e", - "--events" + "-u", + "--unformatted" ], - "description": "Show the last event callbacks associated to the webhook" + "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" + "fixed_price_promotion:disable" ], - "description": "Create a new webhook", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -3167,6 +3309,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3175,53 +3318,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-t", - "--topic" + "-p", + "--print" ], - "description": "The identifier of the event that will trigger the webhook", - "isRequired": true + "description": "Print out the modified resource" }, { "name": [ - "-u", - "--url" + "-j", + "--json" ], - "description": "The callback url used to post data", - "isRequired": true + "description": "Print result in json format" }, { "name": [ - "-i", - "--include" + "-u", + "--unformatted" ], - "description": "A comma separated list of related resources to be included" - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": [ - "-n", - "--name" - ], - "description": "The webhook short name" + "name": "id", + "description": "The unique id of the resource" } ] }, { "name": [ - "webhooks:destroy", - "webhooks:delete", - "wh:delete", - "wh:destroy" + "fixed_price_promotion:enable" ], - "description": "Destroy an existing webhook", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -3229,6 +3368,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3237,27 +3377,49 @@ const completionSpec: Fig.Spec = { "-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": "Unique id of the webhook" + "description": "The unique id of the resource" } ] }, { "name": [ - "webhooks:details", - "wh:details" + "free_gift_promotion" ], - "description": "Show the details of an existing webhook", + "description": "Execute an action on a resource of type free_gift_promotions", "options": [ { "name": [ @@ -3265,6 +3427,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3273,41 +3436,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-H", - "--hide-empty" + "-p", + "--print" ], - "description": "Hide empty attributes" + "description": "Print out the modified resource" }, { "name": [ - "-e", - "--events" + "-j", + "--json" ], - "description": "Show the last event callbacks associated to the webhook" + "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" + "free_gift_promotion:disable" ], - "description": "Show the details of a firedf webhook event", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -3315,6 +3486,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3323,41 +3495,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ "-p", - "--payload" + "--print" ], - "description": "Show the event payload sent to the callback endpoint" + "description": "Print out the modified resource" }, { "name": [ - "-f", - "--format" + "-j", + "--json" ], - "description": "Format the payload output" + "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" + "free_gift_promotion:enable" ], - "description": "List all the events associated to the webhook", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -3365,6 +3545,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3373,41 +3554,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-A", - "--all" + "-p", + "--print" ], - "description": "Show all events instead of first 25 only " + "description": "Print out the modified resource" }, { "name": [ - "-l", - "--limit" + "-j", + "--json" + ], + "description": "Print result in json format" + }, + { + "name": [ + "-u", + "--unformatted" ], - "description": "Limit number of events in output" + "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" + "free_shipping_promotion" ], - "description": "List all the registered webhooks", + "description": "Execute an action on a resource of type free_shipping_promotions", "options": [ { "name": [ @@ -3415,6 +3604,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3423,41 +3613,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-c", - "--circuit" + "-p", + "--print" ], - "description": "Show only webhooks with circuit in the declared state", - "args": { - "suggestions": [ - "open", - "closed" - ] - } + "description": "Print out the modified resource" }, { "name": [ - "-t", - "--topic" + "-j", + "--json" + ], + "description": "Print result in json format" + }, + { + "name": [ + "-u", + "--unformatted" ], - "description": "The event that triggered the webhook" + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the resource" } ] }, { "name": [ - "webhooks:listen", - "wh:listen" + "free_shipping_promotion:disable" ], - "description": "Listen a webhook for outgoing callbacks", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -3465,6 +3663,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3473,34 +3672,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-t", - "--time" + "-p", + "--print" + ], + "description": "Print out the modified resource" + }, + { + "name": [ + "-j", + "--json" + ], + "description": "Print result in json format" + }, + { + "name": [ + "-u", + "--unformatted" ], - "description": "Waiting time for the first event" + "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" + "free_shipping_promotion:enable" ], - "description": "Show the payload associated to an event callback", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -3508,6 +3722,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3516,34 +3731,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-f", - "--format" + "-p", + "--print" ], - "description": "Format the payload output" - } - ], - "args": [ + "description": "Print out the modified resource" + }, { - "name": "id", - "description": "Unique id of the webhook" - } - ] - }, - { + "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:reset", - "wh:reset" + "gift_card" ], - "description": "Reset the circuit breaker associated to the webhook", + "description": "Execute an action on a resource of type gift_cards", "options": [ { "name": [ @@ -3551,6 +3781,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3559,34 +3790,49 @@ const completionSpec: Fig.Spec = { "-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": "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" + "gift_card:activate" ], - "description": "Update an existing webhook", + "description": "Send this attribute if you want to activate a gift card.", "options": [ { "name": [ @@ -3594,6 +3840,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3602,54 +3849,49 @@ const completionSpec: Fig.Spec = { "-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" - }, - { - "name": [ - "-u", - "--url" + "-p", + "--print" ], - "description": "The callback url used to post data" + "description": "Print out the modified resource" }, { "name": [ - "-i", - "--include" + "-j", + "--json" ], - "description": "A comma separated list of related resources to be included" + "description": "Print result in json format" }, { "name": [ - "-n", - "--name" + "-u", + "--unformatted" ], - "description": "The webhook short name" + "description": "Print json output without indentation" } ], "args": [ { "name": "id", - "description": "Unique id of the webhook" + "description": "The unique id of the resource" } ] }, { "name": [ - "microstore" + "gift_card:balance_change_cents" ], - "description": "Create microstore urls", + "description": "The balance change, in cents. send a negative value to reduces the card balance by the specified amount. send a positive value to recharge the gift card (if rechargeable).", "options": [ { "name": [ @@ -3657,6 +3899,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3665,56 +3908,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { - "name": [ - "-a", - "--accessToken" - ], + "name": "--accessToken", + "args": {}, "isRequired": true, - "hidden": false - }, - { - "name": "--open", - "description": "Open microstore url in default browser" + "hidden": true }, { "name": [ - "-S", - "--skuListId" + "-p", + "--print" ], - "description": "The sku list id", - "isRequired": true + "description": "Print out the modified resource" }, { "name": [ - "-A", - "--all" + "-j", + "--json" ], - "description": "Activate the buy all button " + "description": "Print result in json format" }, { "name": [ - "-C", - "--cart" + "-u", + "--unformatted" ], - "description": "Activate the cart application" - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": [ - "-I", - "--inline" - ], - "description": "Disable redirect to cart application" + "name": "id", + "description": "The unique id of the resource" } ] }, { "name": [ - "checkout" + "gift_card:deactivate" ], - "description": "Create checkout urls", + "description": "Send this attribute if you want to deactivate a gift card.", "options": [ { "name": [ @@ -3722,6 +3958,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3730,75 +3967,108 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "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": [ + "-p", + "--print" + ], + "description": "Print out the modified resource" }, { - "name": "--staging", - "description": "Connect to checkout application in staging environment", - "hidden": true + "name": [ + "-j", + "--json" + ], + "description": "Print result in json format" }, { "name": [ - "-O", - "--order" + "-u", + "--unformatted" ], - "description": "An order id" - }, + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the resource" + } + ] + }, + { + "name": [ + "gift_card:purchase" + ], + "description": "Send this attribute if you want to confirm a draft gift card. the gift card becomes 'inactive', waiting to be activated.", + "options": [ { "name": [ - "-S", - "--sku" + "-o", + "--organization" ], - "description": "An sku code" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-B", - "--bundle" + "-d", + "--domain" ], - "description": "A bundle code" + "args": {}, + "hidden": true + }, + { + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-m", - "--market" + "-p", + "--print" ], - "description": "A market number" + "description": "Print out the modified resource" }, { "name": [ - "-c", - "--coupon" + "-j", + "--json" ], - "description": "A promo code" + "description": "Print result in json format" }, { "name": [ - "-e", - "--email" + "-u", + "--unformatted" ], - "description": "A customer email" + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the resource" } ] }, { "name": [ - "checkout:order" + "in_stock_subscription" ], - "description": "Create checkout urls starting from an existing order", + "description": "Execute an action on a resource of type in_stock_subscriptions", "options": [ { "name": [ @@ -3806,6 +4076,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3814,129 +4085,57 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, + "hidden": true + }, + { + "name": "--accessToken", + "args": {}, + "isRequired": true, "hidden": true }, { "name": [ - "-a", - "--accessToken" + "-p", + "--print" ], - "description": "Custom access token to use instead of the one used for login", - "isRequired": true, - "hidden": false + "description": "Print out the modified resource" }, { - "name": "--open", - "description": "Open checkout url in default browser" + "name": [ + "-j", + "--json" + ], + "description": "Print result in json format" }, { - "name": "--staging", - "description": "Connect to checkout application in staging environment", - "hidden": true + "name": [ + "-u", + "--unformatted" + ], + "description": "Print json output without indentation" } ], "args": [ { "name": "id", - "description": "Unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "seeder:check" + "in_stock_subscription:activate" ], - "description": "Execute a check on seeder data", + "description": "Send this attribute if you want to activate an inactive subscription.", "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" - }, - { - "name": [ - "-n", - "--name" - ], - "description": "The name of the business model file to use" - }, - { - "name": "--debug", - "description": "Show command debug information", - "hidden": true - }, - { - "name": [ - "-r", - "--relationships" - ], - "description": "Check resource relationships" - } - ] - }, - { - "name": [ - "seeder:clean" - ], - "description": "Clean previously imported 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": [ - "-u", - "--url" - ], - "description": "Seeder data url" - }, - { - "name": [ - "-n", - "--name" - ], - "description": "The name of the business model file to use" - }, - { - "name": "--debug", - "description": "Show debug information", - "hidden": true - }, { "name": [ "-o", "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -3945,99 +4144,49 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "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": [ - "-u", - "--url" - ], - "description": "Seeder data url" - }, - { - "name": [ - "-n", - "--name" - ], - "description": "The name of the business model file to use" - }, - { - "name": "--debug", - "description": "Show debug information", - "hidden": true }, { "name": [ - "-o", - "--organization" + "-p", + "--print" ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true + "description": "Print out the modified resource" }, { "name": [ - "-d", - "--domain" + "-j", + "--json" ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true + "description": "Print result in json format" }, { "name": [ - "-k", - "--keep" + "-u", + "--unformatted" ], - "description": "Keep existing resources without updating them" - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": [ - "-D", - "--delay" - ], - "description": "Add a delay in milliseconds between calls to different resources", - "hidden": true + "name": "id", + "description": "The unique id of the resource" } ] }, { "name": [ - "adyen_payment" + "in_stock_subscription:deactivate" ], - "description": "Execute an action on a resource of type adyen_payments", + "description": "Send this attribute if you want to dactivate an active subscription.", "options": [ { "name": [ @@ -4045,6 +4194,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4053,10 +4203,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4091,9 +4243,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "adyen_payment:details" + "klarna_payment" ], - "description": "Send this attribute if you want to send additional details the payment request.", + "description": "Execute an action on a resource of type klarna_payments", "options": [ { "name": [ @@ -4101,6 +4253,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4109,10 +4262,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4147,9 +4302,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "authorization" + "klarna_payment:update" ], - "description": "Execute an action on a resource of type authorizations", + "description": "Send this attribute if you want to update the payment session with fresh order data.", "options": [ { "name": [ @@ -4157,6 +4312,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4165,10 +4321,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4203,9 +4361,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "authorization:capture" + "line_item" ], - "description": "Send this attribute if you want to create a capture for this authorization.", + "description": "Execute an action on a resource of type line_items", "options": [ { "name": [ @@ -4213,6 +4371,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4221,10 +4380,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4259,9 +4420,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "authorization:capture_amount_cents" + "line_item:external_price" ], - "description": "The associated capture amount, in cents.", + "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. any successive price computation will be done externally, until the attribute is reset to '0'.", "options": [ { "name": [ @@ -4269,6 +4430,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4277,10 +4439,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4315,9 +4479,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "authorization:void" + "line_item:reserve_stock" ], - "description": "Send this attribute if you want to create a void for this authorization.", + "description": "Send this attribute if you want to reserve the stock for the line item's skus quantity. stock reservations expiration depends on the inventory model's cutoff. when used on update the existing active stock reservations are renewed.", "options": [ { "name": [ @@ -4325,6 +4489,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4333,10 +4498,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4371,9 +4538,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "axerve_payment" + "market" ], - "description": "Execute an action on a resource of type axerve_payments", + "description": "Execute an action on a resource of type markets", "options": [ { "name": [ @@ -4381,6 +4548,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4389,10 +4557,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4427,9 +4597,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "axerve_payment:update" + "market:disable" ], - "description": "Send this attribute if you want to update the payment with fresh order data.", + "description": "Send this attribute if you want to mark the market as disabled.", "options": [ { "name": [ @@ -4437,6 +4607,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4445,10 +4616,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4483,9 +4656,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "bundle" + "market:enable" ], - "description": "Execute an action on a resource of type bundles", + "description": "Send this attribute if you want to mark the market as enabled.", "options": [ { "name": [ @@ -4493,6 +4666,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4501,10 +4675,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4539,9 +4715,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "bundle:compute_compare_at_amount" + "order" ], - "description": "Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle skus for the market.", + "description": "Execute an action on a resource of type orders", "options": [ { "name": [ @@ -4549,6 +4725,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4557,10 +4734,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4595,9 +4774,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "bundle:compute_price_amount" + "order_subscription" ], - "description": "Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle skus for the market.", + "description": "Execute an action on a resource of type order_subscriptions", "options": [ { "name": [ @@ -4605,6 +4784,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4613,10 +4793,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4651,9 +4833,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "buy_x_pay_y_promotion" + "order_subscription:activate" ], - "description": "Execute an action on a resource of type buy_x_pay_y_promotions", + "description": "Send this attribute if you want to mark this subscription as active.", "options": [ { "name": [ @@ -4661,6 +4843,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4669,10 +4852,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4707,9 +4892,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "buy_x_pay_y_promotion:disable" + "order_subscription:cancel" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Send this attribute if you want to mark this subscription as cancelled.", "options": [ { "name": [ @@ -4717,6 +4902,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4725,10 +4911,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4763,9 +4951,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "buy_x_pay_y_promotion:enable" + "order_subscription:deactivate" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute if you want to mark this subscription as inactive.", "options": [ { "name": [ @@ -4773,6 +4961,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4781,10 +4970,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4819,9 +5010,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "capture" + "order:approve" ], - "description": "Execute an action on a resource of type captures", + "description": "Send this attribute if you want to approve a placed order.", "options": [ { "name": [ @@ -4829,6 +5020,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4837,10 +5029,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4875,9 +5069,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "capture:refund" + "order:approve_and_capture" ], - "description": "Send this attribute if you want to create a refund for this capture.", + "description": "Send this attribute if you want to approve and capture a placed order.", "options": [ { "name": [ @@ -4885,6 +5079,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4893,10 +5088,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4931,9 +5128,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "capture:refund_amount_cents" + "order:archive" ], - "description": "The associated refund amount, in cents.", + "description": "Send this attribute if you want to archive the order.", "options": [ { "name": [ @@ -4941,6 +5138,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -4949,10 +5147,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -4987,9 +5187,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "checkout_com_payment" + "order:authorization_amount_cents" ], - "description": "Execute an action on a resource of type checkout_com_payments", + "description": "The authorization amount, in cents.", "options": [ { "name": [ @@ -4997,6 +5197,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5005,10 +5206,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5043,9 +5246,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "checkout_com_payment:details" + "order:authorize" ], - "description": "Send this attribute if you want to send additional details the payment request (i.e. upon 3ds check).", + "description": "Send this attribute if you want to authorize the order's payment source.", "options": [ { "name": [ @@ -5053,6 +5256,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5061,10 +5265,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5099,9 +5305,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "checkout_com_payment:refresh" + "order:billing_address_clone_id" ], - "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", + "description": "The id of the address that you want to clone to create the order's billing address.", "options": [ { "name": [ @@ -5109,6 +5315,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5117,10 +5324,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5144,6 +5353,15 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ @@ -5155,9 +5373,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "customer_password_reset" + "order:billing_address_same_as_shipping" ], - "description": "Execute an action on a resource of type customer_password_resets", + "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", "options": [ { "name": [ @@ -5165,6 +5383,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5173,10 +5392,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5211,9 +5432,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "customer_password_reset:reset_password_token" + "order:cancel" ], - "description": "Send the 'reset_password_token' that you got on create when updating the customer password.", + "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", "options": [ { "name": [ @@ -5221,6 +5442,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5229,10 +5451,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5267,9 +5491,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "external_promotion" + "order:capture" ], - "description": "Execute an action on a resource of type external_promotions", + "description": "Send this attribute if you want to capture an authorized order.", "options": [ { "name": [ @@ -5277,6 +5501,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5285,10 +5510,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5323,9 +5550,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "external_promotion:disable" + "order:commit_invoice" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", "options": [ { "name": [ @@ -5333,6 +5560,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5341,10 +5569,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5379,9 +5609,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "external_promotion:enable" + "order:create_subscriptions" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", "options": [ { "name": [ @@ -5389,6 +5619,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5397,10 +5628,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5435,9 +5668,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "fixed_amount_promotion" + "order:customer_payment_source_id" ], - "description": "Execute an action on a resource of type fixed_amount_promotions", + "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", "options": [ { "name": [ @@ -5445,6 +5678,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5453,10 +5687,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5480,6 +5716,15 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ @@ -5491,9 +5736,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "fixed_amount_promotion:disable" + "order:nullify_payment_source" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Send this attribute if you want to nullify the payment source for this order.", "options": [ { "name": [ @@ -5501,6 +5746,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5509,10 +5755,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5547,9 +5795,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "fixed_amount_promotion:enable" + "order:place" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute if you want to place the order.", "options": [ { "name": [ @@ -5557,6 +5805,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5565,10 +5814,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5603,9 +5854,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "fixed_price_promotion" + "order:refresh" ], - "description": "Execute an action on a resource of type fixed_price_promotions", + "description": "Send this attribute if you want to manually refresh the order.", "options": [ { "name": [ @@ -5613,6 +5864,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5621,10 +5873,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5659,9 +5913,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "fixed_price_promotion:disable" + "order:refund" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Send this attribute if you want to refund a captured order.", "options": [ { "name": [ @@ -5669,6 +5923,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5677,10 +5932,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5715,9 +5972,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "fixed_price_promotion:enable" + "order:refund_invoice" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", "options": [ { "name": [ @@ -5725,6 +5982,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5733,10 +5991,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5771,9 +6031,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_gift_promotion" + "order:save_billing_address_to_customer_address_book" ], - "description": "Execute an action on a resource of type free_gift_promotions", + "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", "options": [ { "name": [ @@ -5781,6 +6041,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5789,10 +6050,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5827,9 +6090,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_gift_promotion:disable" + "order:save_payment_source_to_customer_wallet" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", "options": [ { "name": [ @@ -5837,6 +6100,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5845,10 +6109,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5883,9 +6149,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_gift_promotion:enable" + "order:save_shipping_address_to_customer_address_book" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", "options": [ { "name": [ @@ -5893,6 +6159,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5901,10 +6168,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5939,9 +6208,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_shipping_promotion" + "order:shipping_address_clone_id" ], - "description": "Execute an action on a resource of type free_shipping_promotions", + "description": "The id of the address that you want to clone to create the order's shipping address.", "options": [ { "name": [ @@ -5949,6 +6218,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -5957,10 +6227,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -5984,6 +6256,15 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ @@ -5995,9 +6276,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_shipping_promotion:disable" + "order:shipping_address_same_as_billing" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", "options": [ { "name": [ @@ -6005,6 +6286,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6013,10 +6295,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6051,9 +6335,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_shipping_promotion:enable" + "order:start_editing" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", "options": [ { "name": [ @@ -6061,6 +6345,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6069,10 +6354,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6107,9 +6394,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card" + "order:stop_editing" ], - "description": "Execute an action on a resource of type gift_cards", + "description": "Send this attribute to stop the editing for the order and return back to placed status.", "options": [ { "name": [ @@ -6117,6 +6404,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6125,10 +6413,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6163,9 +6453,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card:activate" + "order:unarchive" ], - "description": "Send this attribute if you want to activate a gift card.", + "description": "Send this attribute if you want to unarchive the order.", "options": [ { "name": [ @@ -6173,6 +6463,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6181,10 +6472,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6219,9 +6512,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card:balance_change_cents" + "order:update_taxes" ], - "description": "The balance change, in cents. send a negative value to reduces the card balance by the specified amount. send a positive value to recharge the gift card (if rechargeable).", + "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", "options": [ { "name": [ @@ -6229,6 +6522,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6237,10 +6531,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6275,9 +6571,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card:deactivate" + "order:validate" ], - "description": "Send this attribute if you want to deactivate a gift card.", + "description": "Send this attribute if you want to trigger the external validation for the order.", "options": [ { "name": [ @@ -6285,6 +6581,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6293,10 +6590,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6331,9 +6630,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card:purchase" + "payment_method" ], - "description": "Send this attribute if you want to confirm a draft gift card. the gift card becomes 'inactive', waiting to be activated.", + "description": "Execute an action on a resource of type payment_methods", "options": [ { "name": [ @@ -6341,6 +6640,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6349,10 +6649,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6387,9 +6689,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "in_stock_subscription" + "payment_method:disable" ], - "description": "Execute an action on a resource of type in_stock_subscriptions", + "description": "Send this attribute if you want to mark the payment method as disabled.", "options": [ { "name": [ @@ -6397,6 +6699,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6405,10 +6708,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6443,9 +6748,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "in_stock_subscription:activate" + "payment_method:enable" ], - "description": "Send this attribute if you want to activate an inactive subscription.", + "description": "Send this attribute if you want to mark the payment method as enabled.", "options": [ { "name": [ @@ -6453,6 +6758,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6461,10 +6767,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6499,9 +6807,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "in_stock_subscription:deactivate" + "percentage_discount_promotion" ], - "description": "Send this attribute if you want to dactivate an active subscription.", + "description": "Execute an action on a resource of type percentage_discount_promotions", "options": [ { "name": [ @@ -6509,6 +6817,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6517,10 +6826,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6555,9 +6866,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "klarna_payment" + "percentage_discount_promotion:disable" ], - "description": "Execute an action on a resource of type klarna_payments", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -6565,6 +6876,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6573,10 +6885,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6611,9 +6925,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "klarna_payment:update" + "percentage_discount_promotion:enable" ], - "description": "Send this attribute if you want to update the payment session with fresh order data.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -6621,6 +6935,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6629,10 +6944,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6667,9 +6984,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "line_item" + "return" ], - "description": "Execute an action on a resource of type line_items", + "description": "Execute an action on a resource of type returns", "options": [ { "name": [ @@ -6677,6 +6994,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6685,10 +7003,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6723,9 +7043,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "line_item:external_price" + "return_line_item" ], - "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. any successive price computation will be done externally, until the attribute is reset to '0'.", + "description": "Execute an action on a resource of type return_line_items", "options": [ { "name": [ @@ -6733,6 +7053,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6741,10 +7062,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6779,9 +7102,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "line_item:reserve_stock" + "return_line_item:restock" ], - "description": "Send this attribute if you want to reserve the stock for the line item's skus quantity. stock reservations expiration depends on the inventory model's cutoff. when used on update the existing active stock reservations are renewed.", + "description": "Send this attribute if you want to restock the line item.", "options": [ { "name": [ @@ -6789,6 +7112,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6797,10 +7121,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6835,9 +7161,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "market" + "return:approve" ], - "description": "Execute an action on a resource of type markets", + "description": "Send this attribute if you want to mark this return as approved.", "options": [ { "name": [ @@ -6845,6 +7171,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6853,10 +7180,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6891,9 +7220,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "market:disable" + "return:archive" ], - "description": "Send this attribute if you want to mark the market as disabled.", + "description": "Send this attribute if you want to archive the return.", "options": [ { "name": [ @@ -6901,6 +7230,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6909,10 +7239,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -6947,9 +7279,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "market:enable" + "return:cancel" ], - "description": "Send this attribute if you want to mark the market as enabled.", + "description": "Send this attribute if you want to mark this return as cancelled.", "options": [ { "name": [ @@ -6957,6 +7289,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -6965,10 +7298,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7003,9 +7338,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order" + "return:receive" ], - "description": "Execute an action on a resource of type orders", + "description": "Send this attribute if you want to mark this return as received.", "options": [ { "name": [ @@ -7013,6 +7348,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7021,10 +7357,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7059,9 +7397,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order_subscription" + "return:reject" ], - "description": "Execute an action on a resource of type order_subscriptions", + "description": "Send this attribute if you want to mark this return as rejected.", "options": [ { "name": [ @@ -7069,6 +7407,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7077,10 +7416,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7115,9 +7456,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order_subscription:activate" + "return:request" ], - "description": "Send this attribute if you want to mark this subscription as active.", + "description": "Send this attribute if you want to activate this return.", "options": [ { "name": [ @@ -7125,6 +7466,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7133,10 +7475,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7171,9 +7515,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order_subscription:cancel" + "return:restock" ], - "description": "Send this attribute if you want to mark this subscription as cancelled.", + "description": "Send this attribute if you want to restock all of the return line items.", "options": [ { "name": [ @@ -7181,6 +7525,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7189,10 +7534,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7227,9 +7574,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order_subscription:deactivate" + "return:ship" ], - "description": "Send this attribute if you want to mark this subscription as inactive.", + "description": "Send this attribute if you want to mark this return as shipped.", "options": [ { "name": [ @@ -7237,6 +7584,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7245,10 +7593,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7283,9 +7633,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:approve" + "return:unarchive" ], - "description": "Send this attribute if you want to approve a placed order.", + "description": "Send this attribute if you want to unarchive the return.", "options": [ { "name": [ @@ -7293,6 +7643,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7301,10 +7652,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7339,9 +7692,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:approve_and_capture" + "satispay_payment" ], - "description": "Send this attribute if you want to approve and capture a placed order.", + "description": "Execute an action on a resource of type satispay_payments", "options": [ { "name": [ @@ -7349,6 +7702,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7357,10 +7711,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7395,9 +7751,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:archive" + "satispay_payment:refresh" ], - "description": "Send this attribute if you want to archive the order.", + "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", "options": [ { "name": [ @@ -7405,6 +7761,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7413,10 +7770,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7451,9 +7810,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:authorization_amount_cents" + "shipment" ], - "description": "The authorization amount, in cents.", + "description": "Execute an action on a resource of type shipments", "options": [ { "name": [ @@ -7461,6 +7820,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7469,10 +7829,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7507,9 +7869,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:authorize" + "shipment:decrement_stock" ], - "description": "Send this attribute if you want to authorize the order's payment source.", + "description": "Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -7517,6 +7879,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7525,10 +7888,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7563,9 +7928,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:billing_address_clone_id" + "shipment:get_rates" ], - "description": "The id of the address that you want to clone to create the order's billing address.", + "description": "Send this attribute if you want get the shipping rates from the associated carrier accounts.", "options": [ { "name": [ @@ -7573,6 +7938,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7581,10 +7947,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7608,14 +7976,6 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "isRequired": true } ], "args": [ @@ -7627,9 +7987,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:billing_address_same_as_shipping" + "shipment:on_hold" ], - "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", + "description": "Send this attribute if you want to put this shipment on hold.", "options": [ { "name": [ @@ -7637,6 +7997,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7645,10 +8006,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7683,9 +8046,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:cancel" + "shipment:packing" ], - "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", + "description": "Send this attribute if you want to start packing this shipment.", "options": [ { "name": [ @@ -7693,6 +8056,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7701,10 +8065,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7739,9 +8105,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:capture" + "shipment:picking" ], - "description": "Send this attribute if you want to capture an authorized order.", + "description": "Send this attribute if you want to start picking this shipment.", "options": [ { "name": [ @@ -7749,6 +8115,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7757,10 +8124,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7795,9 +8164,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:commit_invoice" + "shipment:purchase" ], - "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "description": "Send this attribute if you want to purchase this shipment with the selected rate.", "options": [ { "name": [ @@ -7805,6 +8174,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7813,10 +8183,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7851,9 +8223,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:create_subscriptions" + "shipment:ready_to_ship" ], - "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", + "description": "Send this attribute if you want to mark this shipment as ready to ship.", "options": [ { "name": [ @@ -7861,6 +8233,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7869,10 +8242,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7907,9 +8282,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:customer_payment_source_id" + "shipment:release_stock" ], - "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", + "description": "Send this attribute if you want to automatically release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -7917,6 +8292,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7925,10 +8301,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -7952,14 +8330,6 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "isRequired": true } ], "args": [ @@ -7971,9 +8341,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:nullify_payment_source" + "shipment:reserve_stock" ], - "description": "Send this attribute if you want to nullify the payment source for this order.", + "description": "Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -7981,6 +8351,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -7989,10 +8360,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8027,9 +8400,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:place" + "shipment:ship" ], - "description": "Send this attribute if you want to place the order.", + "description": "Send this attribute if you want to mark this shipment as shipped.", "options": [ { "name": [ @@ -8037,6 +8410,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8045,10 +8419,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8083,9 +8459,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:refresh" + "shipment:upcoming" ], - "description": "Send this attribute if you want to manually refresh the order.", + "description": "Send this attribute if you want to mark this shipment as upcoming.", "options": [ { "name": [ @@ -8093,6 +8469,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8101,10 +8478,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8139,9 +8518,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:refund" + "shipping_method" ], - "description": "Send this attribute if you want to refund a captured order.", + "description": "Execute an action on a resource of type shipping_methods", "options": [ { "name": [ @@ -8149,6 +8528,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8157,10 +8537,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8195,9 +8577,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:refund_invoice" + "shipping_method:disable" ], - "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "description": "Send this attribute if you want to mark the shipping method as disabled.", "options": [ { "name": [ @@ -8205,6 +8587,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8213,10 +8596,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8251,9 +8636,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:save_billing_address_to_customer_address_book" + "shipping_method:enable" ], - "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", + "description": "Send this attribute if you want to mark the shipping method as enabled.", "options": [ { "name": [ @@ -8261,6 +8646,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8269,10 +8655,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8307,9 +8695,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:save_payment_source_to_customer_wallet" + "stock_line_item" ], - "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", + "description": "Execute an action on a resource of type stock_line_items", "options": [ { "name": [ @@ -8317,6 +8705,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8325,10 +8714,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8363,9 +8754,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:save_shipping_address_to_customer_address_book" + "stock_line_item:decrement_stock" ], - "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", + "description": "Send this attribute if you want to automatically decrement and release the stock this stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -8373,6 +8764,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8381,10 +8773,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8419,9 +8813,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:shipping_address_clone_id" + "stock_line_item:release_stock" ], - "description": "The id of the address that you want to clone to create the order's shipping address.", + "description": "Send this attribute if you want to automatically release the stock for this stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -8429,6 +8823,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8437,10 +8832,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8464,14 +8861,6 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "isRequired": true } ], "args": [ @@ -8483,9 +8872,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:shipping_address_same_as_billing" + "stock_line_item:reserve_stock" ], - "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", + "description": "Send this attribute if you want to automatically reserve the stock for this stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -8493,6 +8882,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8501,10 +8891,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8539,9 +8931,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:start_editing" + "stock_reservation" ], - "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", + "description": "Execute an action on a resource of type stock_reservations", "options": [ { "name": [ @@ -8549,6 +8941,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8557,10 +8950,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8595,9 +8990,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:stop_editing" + "stock_reservation:pending" ], - "description": "Send this attribute to stop the editing for the order and return back to placed status.", + "description": "Send this attribute if you want to mark this stock reservation as pending.", "options": [ { "name": [ @@ -8605,6 +9000,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8613,10 +9009,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8651,9 +9049,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:unarchive" + "stock_transfer" ], - "description": "Send this attribute if you want to unarchive the order.", + "description": "Execute an action on a resource of type stock_transfers", "options": [ { "name": [ @@ -8661,6 +9059,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8669,10 +9068,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8707,9 +9108,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:update_taxes" + "stock_transfer:cancel" ], - "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", + "description": "Send this attribute if you want to cancel this stock transfer.", "options": [ { "name": [ @@ -8717,6 +9118,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8725,10 +9127,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8763,9 +9167,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:validate" + "stock_transfer:complete" ], - "description": "Send this attribute if you want to trigger the external validation for the order.", + "description": "Send this attribute if you want to complete this stock transfer.", "options": [ { "name": [ @@ -8773,6 +9177,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8781,10 +9186,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8819,9 +9226,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "payment_method" + "stock_transfer:in_transit" ], - "description": "Execute an action on a resource of type payment_methods", + "description": "Send this attribute if you want to mark this stock transfer as in transit.", "options": [ { "name": [ @@ -8829,6 +9236,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8837,10 +9245,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8875,9 +9285,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "payment_method:disable" + "stock_transfer:on_hold" ], - "description": "Send this attribute if you want to mark the payment method as disabled.", + "description": "Send this attribute if you want to put this stock transfer on hold.", "options": [ { "name": [ @@ -8885,6 +9295,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8893,10 +9304,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8931,9 +9344,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "payment_method:enable" + "stock_transfer:picking" ], - "description": "Send this attribute if you want to mark the payment method as enabled.", + "description": "Send this attribute if you want to start picking this stock transfer.", "options": [ { "name": [ @@ -8941,6 +9354,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -8949,10 +9363,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -8987,9 +9403,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "percentage_discount_promotion" + "stock_transfer:upcoming" ], - "description": "Execute an action on a resource of type percentage_discount_promotions", + "description": "Send this attribute if you want to mark this stock transfer as upcoming.", "options": [ { "name": [ @@ -8997,6 +9413,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9005,10 +9422,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9043,9 +9462,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "percentage_discount_promotion:disable" + "stripe_payment" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Execute an action on a resource of type stripe_payments", "options": [ { "name": [ @@ -9053,6 +9472,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9061,10 +9481,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9099,9 +9521,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "percentage_discount_promotion:enable" + "stripe_payment:refresh" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.", "options": [ { "name": [ @@ -9109,6 +9531,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9117,10 +9540,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9155,9 +9580,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return" + "stripe_payment:update" ], - "description": "Execute an action on a resource of type returns", + "description": "Send this attribute if you want to update the created payment intent with fresh order data.", "options": [ { "name": [ @@ -9165,6 +9590,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9173,10 +9599,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9211,9 +9639,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return_line_item" + "webhook" ], - "description": "Execute an action on a resource of type return_line_items", + "description": "Execute an action on a resource of type webhooks", "options": [ { "name": [ @@ -9221,6 +9649,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9229,10 +9658,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9267,9 +9698,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return_line_item:restock" + "webhook:disable" ], - "description": "Send this attribute if you want to restock the line item.", + "description": "Send this attribute if you want to mark the webhook as disabled.", "options": [ { "name": [ @@ -9277,6 +9708,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9285,10 +9717,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9323,9 +9757,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:approve" + "webhook:enable" ], - "description": "Send this attribute if you want to mark this return as approved.", + "description": "Send this attribute if you want to mark the webhook as enabled.", "options": [ { "name": [ @@ -9333,6 +9767,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9341,10 +9776,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9379,9 +9816,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:archive" + "webhook:reset_circuit" ], - "description": "Send this attribute if you want to archive the return.", + "description": "Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.", "options": [ { "name": [ @@ -9389,6 +9826,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9397,10 +9835,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9435,9 +9875,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:cancel" + "orders" ], - "description": "Send this attribute if you want to mark this return as cancelled.", + "description": "Execute an action on an order", "options": [ { "name": [ @@ -9445,6 +9885,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9453,10 +9894,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9465,7 +9908,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9485,15 +9928,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "return:receive" + "orders:approve" ], - "description": "Send this attribute if you want to mark this return as received.", + "description": "Send this attribute if you want to approve a placed order.", "options": [ { "name": [ @@ -9501,6 +9944,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9509,10 +9953,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9521,7 +9967,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9541,15 +9987,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "return:reject" + "orders:approve_and_capture" ], - "description": "Send this attribute if you want to mark this return as rejected.", + "description": "Send this attribute if you want to approve and capture a placed order.", "options": [ { "name": [ @@ -9557,6 +10003,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9565,10 +10012,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9577,7 +10026,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9597,15 +10046,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "return:request" + "orders:archive" ], - "description": "Send this attribute if you want to activate this return.", + "description": "Send this attribute if you want to archive the order.", "options": [ { "name": [ @@ -9613,6 +10062,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9621,10 +10071,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9633,7 +10085,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9653,15 +10105,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "return:restock" + "orders:authorization_amount_cents" ], - "description": "Send this attribute if you want to restock all of the return line items.", + "description": "The authorization amount, in cents.", "options": [ { "name": [ @@ -9669,6 +10121,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9677,10 +10130,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9689,7 +10144,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9709,15 +10164,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "return:ship" + "orders:authorize" ], - "description": "Send this attribute if you want to mark this return as shipped.", + "description": "Send this attribute if you want to authorize the order's payment source.", "options": [ { "name": [ @@ -9725,6 +10180,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9733,10 +10189,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9745,7 +10203,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9765,15 +10223,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "return:unarchive" + "orders:billing_address_clone_id" ], - "description": "Send this attribute if you want to unarchive the return.", + "description": "The id of the address that you want to clone to create the order's billing address.", "options": [ { "name": [ @@ -9781,6 +10239,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9789,10 +10248,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9801,7 +10262,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9816,20 +10277,29 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "satispay_payment" + "orders:billing_address_same_as_shipping" ], - "description": "Execute an action on a resource of type satispay_payments", + "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", "options": [ { "name": [ @@ -9837,6 +10307,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9845,10 +10316,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9857,7 +10330,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9877,15 +10350,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "satispay_payment:refresh" + "orders:cancel" ], - "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", + "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", "options": [ { "name": [ @@ -9893,6 +10366,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9901,10 +10375,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9913,7 +10389,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9933,15 +10409,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment" + "orders:capture" ], - "description": "Execute an action on a resource of type shipments", + "description": "Send this attribute if you want to capture an authorized order.", "options": [ { "name": [ @@ -9949,6 +10425,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -9957,10 +10434,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -9969,7 +10448,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -9989,15 +10468,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:decrement_stock" + "orders:commit_invoice" ], - "description": "Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", "options": [ { "name": [ @@ -10005,6 +10484,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10013,10 +10493,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10025,7 +10507,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10045,15 +10527,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:get_rates" + "orders:create_subscriptions" ], - "description": "Send this attribute if you want get the shipping rates from the associated carrier accounts.", + "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", "options": [ { "name": [ @@ -10061,6 +10543,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10069,10 +10552,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10081,7 +10566,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10101,15 +10586,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:on_hold" + "orders:customer_payment_source_id" ], - "description": "Send this attribute if you want to put this shipment on hold.", + "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", "options": [ { "name": [ @@ -10117,6 +10602,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10125,10 +10611,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10137,7 +10625,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10152,20 +10640,29 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:packing" + "orders:nullify_payment_source" ], - "description": "Send this attribute if you want to start packing this shipment.", + "description": "Send this attribute if you want to nullify the payment source for this order.", "options": [ { "name": [ @@ -10173,6 +10670,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10181,10 +10679,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10193,7 +10693,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10213,15 +10713,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:picking" + "orders:place" ], - "description": "Send this attribute if you want to start picking this shipment.", + "description": "Send this attribute if you want to place the order.", "options": [ { "name": [ @@ -10229,6 +10729,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10237,10 +10738,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10249,7 +10752,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10269,15 +10772,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:purchase" + "orders:refresh" ], - "description": "Send this attribute if you want to purchase this shipment with the selected rate.", + "description": "Send this attribute if you want to manually refresh the order.", "options": [ { "name": [ @@ -10285,6 +10788,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10293,10 +10797,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10305,7 +10811,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10325,15 +10831,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:ready_to_ship" + "orders:refund" ], - "description": "Send this attribute if you want to mark this shipment as ready to ship.", + "description": "Send this attribute if you want to refund a captured order.", "options": [ { "name": [ @@ -10341,6 +10847,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10349,10 +10856,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10361,7 +10870,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10381,15 +10890,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:release_stock" + "orders:refund_invoice" ], - "description": "Send this attribute if you want to automatically release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", "options": [ { "name": [ @@ -10397,6 +10906,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10405,10 +10915,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10417,7 +10929,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10437,15 +10949,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:reserve_stock" + "orders:save_billing_address_to_customer_address_book" ], - "description": "Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", "options": [ { "name": [ @@ -10453,6 +10965,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10461,10 +10974,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10473,7 +10988,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10493,15 +11008,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:ship" + "orders:save_payment_source_to_customer_wallet" ], - "description": "Send this attribute if you want to mark this shipment as shipped.", + "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", "options": [ { "name": [ @@ -10509,6 +11024,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10517,10 +11033,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10529,7 +11047,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10549,15 +11067,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipment:upcoming" + "orders:save_shipping_address_to_customer_address_book" ], - "description": "Send this attribute if you want to mark this shipment as upcoming.", + "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", "options": [ { "name": [ @@ -10565,6 +11083,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10573,10 +11092,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10585,7 +11106,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10605,15 +11126,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipping_method" + "orders:shipping_address_clone_id" ], - "description": "Execute an action on a resource of type shipping_methods", + "description": "The id of the address that you want to clone to create the order's shipping address.", "options": [ { "name": [ @@ -10621,6 +11142,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10629,10 +11151,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10641,7 +11165,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10656,20 +11180,29 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipping_method:disable" + "orders:shipping_address_same_as_billing" ], - "description": "Send this attribute if you want to mark the shipping method as disabled.", + "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", "options": [ { "name": [ @@ -10677,6 +11210,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10685,10 +11219,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10697,7 +11233,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10717,15 +11253,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "shipping_method:enable" + "orders:start_editing" ], - "description": "Send this attribute if you want to mark the shipping method as enabled.", + "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", "options": [ { "name": [ @@ -10733,6 +11269,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10741,10 +11278,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10753,7 +11292,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10773,15 +11312,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "stock_line_item" + "orders:stop_editing" ], - "description": "Execute an action on a resource of type stock_line_items", + "description": "Send this attribute to stop the editing for the order and return back to placed status.", "options": [ { "name": [ @@ -10789,6 +11328,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10797,10 +11337,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10809,7 +11351,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10829,15 +11371,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "stock_line_item:decrement_stock" + "orders:unarchive" ], - "description": "Send this attribute if you want to automatically decrement and release the stock this stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want to unarchive the order.", "options": [ { "name": [ @@ -10845,6 +11387,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10853,10 +11396,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10865,7 +11410,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10885,15 +11430,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "stock_line_item:release_stock" + "orders:update_taxes" ], - "description": "Send this attribute if you want to automatically release the stock for this stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", "options": [ { "name": [ @@ -10901,6 +11446,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10909,10 +11455,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10921,7 +11469,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10941,15 +11489,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "stock_line_item:reserve_stock" + "orders:validate" ], - "description": "Send this attribute if you want to automatically reserve the stock for this stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want to trigger the external validation for the order.", "options": [ { "name": [ @@ -10957,6 +11505,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -10965,10 +11514,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -10977,7 +11528,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified resource" + "description": "Print out the modified order" }, { "name": [ @@ -10997,15 +11548,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "The unique id of the order" } ] }, { "name": [ - "stock_reservation" + "webhooks" ], - "description": "Execute an action on a resource of type stock_reservations", + "description": "List all the registered webhooks or the details of a single webhook", "options": [ { "name": [ @@ -11013,6 +11564,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11021,47 +11573,65 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-p", - "--print" + "-c", + "--circuit" ], - "description": "Print out the modified resource" + "description": "Show only webhooks with circuit in the declared state", + "args": { + "suggestions": [ + "open", + "closed" + ] + } }, { "name": [ - "-j", - "--json" + "-t", + "--topic" ], - "description": "Print result in json format" + "description": "The event that triggered the webhook", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-H", + "--hide-empty" ], - "description": "Print json output without indentation" + "description": "Hide empty attributes" + }, + { + "name": [ + "-e", + "--events" + ], + "description": "Show the last event callbacks associated to the webhook" } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the webhook to get a single webhook", + "isOptional": true } ] }, { "name": [ - "stock_reservation:pending" + "webhooks:create", + "wh:create" ], - "description": "Send this attribute if you want to mark this stock reservation as pending.", + "description": "Create a new webhook", "options": [ { "name": [ @@ -11069,6 +11639,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11077,47 +11648,59 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-p", - "--print" + "-t", + "--topic" ], - "description": "Print out the modified resource" + "description": "The identifier of the event that will trigger the webhook", + "args": {}, + "isRequired": true }, { "name": [ - "-j", - "--json" + "-u", + "--url" ], - "description": "Print result in json format" + "description": "The callback url used to post data", + "args": {}, + "isRequired": true }, { "name": [ - "-u", - "--unformatted" + "-i", + "--include" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "A comma separated list of related resources to be included", + "args": {} + }, { - "name": "id", - "description": "The unique id of the resource" + "name": [ + "-n", + "--name" + ], + "description": "The webhook short name", + "args": {} } ] }, { "name": [ - "stock_transfer" + "webhooks:destroy", + "webhooks:delete", + "wh:delete", + "wh:destroy" ], - "description": "Execute an action on a resource of type stock_transfers", + "description": "Destroy an existing webhook", "options": [ { "name": [ @@ -11125,6 +11708,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11133,47 +11717,29 @@ const completionSpec: Fig.Spec = { "-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" + "description": "Unique id of the webhook" } ] }, { "name": [ - "stock_transfer:cancel" + "webhooks:details", + "wh:details" ], - "description": "Send this attribute if you want to cancel this stock transfer.", + "description": "Show the details of an existing webhook", "options": [ { "name": [ @@ -11181,6 +11747,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11189,47 +11756,43 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" - }, - { - "name": [ - "-j", - "--json" + "-H", + "--hide-empty" ], - "description": "Print result in json format" + "description": "Hide empty attributes" }, { "name": [ - "-u", - "--unformatted" + "-e", + "--events" ], - "description": "Print json output without indentation" + "description": "Show the last event callbacks associated to the webhook" } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "stock_transfer:complete" + "webhooks:event", + "wh:event" ], - "description": "Send this attribute if you want to complete this stock transfer.", + "description": "Show the details of a firedf webhook event", "options": [ { "name": [ @@ -11237,6 +11800,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11245,47 +11809,43 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ "-p", - "--print" - ], - "description": "Print out the modified resource" - }, - { - "name": [ - "-j", - "--json" + "--payload" ], - "description": "Print result in json format" + "description": "Show the event payload sent to the callback endpoint" }, { "name": [ - "-u", - "--unformatted" + "-f", + "--format" ], - "description": "Print json output without indentation" + "description": "Format the payload output" } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "stock_transfer:in_transit" + "webhooks:events", + "wh:events" ], - "description": "Send this attribute if you want to mark this stock transfer as in transit.", + "description": "List all the events associated to the webhook", "options": [ { "name": [ @@ -11293,6 +11853,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11301,47 +11862,44 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" - }, - { - "name": [ - "-j", - "--json" + "-A", + "--all" ], - "description": "Print result in json format" + "description": "Show all events instead of first 25 only " }, { "name": [ - "-u", - "--unformatted" + "-l", + "--limit" ], - "description": "Print json output without indentation" + "description": "Limit number of events in output", + "args": {} } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "stock_transfer:on_hold" + "webhooks:list", + "wh:list" ], - "description": "Send this attribute if you want to put this stock transfer on hold.", + "description": "List all the registered webhooks", "options": [ { "name": [ @@ -11349,6 +11907,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11357,47 +11916,44 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-p", - "--print" + "-c", + "--circuit" ], - "description": "Print out the modified resource" - }, - { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + "description": "Show only webhooks with circuit in the declared state", + "args": { + "suggestions": [ + "open", + "closed" + ] + } }, { "name": [ - "-u", - "--unformatted" + "-t", + "--topic" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" + "description": "The event that triggered the webhook", + "args": {} } ] }, { "name": [ - "stock_transfer:picking" + "webhooks:listen", + "wh:listen" ], - "description": "Send this attribute if you want to start picking this stock transfer.", + "description": "Listen a webhook for outgoing callbacks", "options": [ { "name": [ @@ -11405,6 +11961,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11413,47 +11970,39 @@ const completionSpec: Fig.Spec = { "-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" + "-t", + "--time" ], - "description": "Print json output without indentation" + "description": "Waiting time for the first event", + "args": { + "default": "120" + } } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "stock_transfer:upcoming" + "webhooks:payload", + "wh:payload" ], - "description": "Send this attribute if you want to mark this stock transfer as upcoming.", + "description": "Show the payload associated to an event callback", "options": [ { "name": [ @@ -11461,6 +12010,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11469,47 +12019,36 @@ const completionSpec: Fig.Spec = { "-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" + "-f", + "--format" ], - "description": "Print json output without indentation" + "description": "Format the payload output" } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "stripe_payment" + "webhooks:reset", + "wh:reset" ], - "description": "Execute an action on a resource of type stripe_payments", + "description": "Reset the circuit breaker associated to the webhook", "options": [ { "name": [ @@ -11517,6 +12056,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11525,47 +12065,36 @@ const completionSpec: Fig.Spec = { "-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" + "description": "Unique id of the webhook" } ] }, { "name": [ - "stripe_payment:refresh" + "webhooks:topics", + "wh:topics" ], - "description": "Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.", + "description": "Show online documentation for supported events" + }, + { + "name": [ + "webhooks:update", + "wh:update" + ], + "description": "Update an existing webhook", "options": [ { "name": [ @@ -11573,6 +12102,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11581,47 +12111,60 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-p", - "--print" + "-t", + "--topic" ], - "description": "Print out the modified resource" + "description": "The identifier of the event that will trigger the webhook", + "args": {} }, { "name": [ - "-j", - "--json" + "-u", + "--url" ], - "description": "Print result in json format" + "description": "The callback url used to post data", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-i", + "--include" ], - "description": "Print json output without indentation" + "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": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "stripe_payment:update" + "microstore" ], - "description": "Send this attribute if you want to update the created payment intent with fresh order data.", + "description": "Create microstore urls", "options": [ { "name": [ @@ -11629,6 +12172,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11637,47 +12181,59 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { - "name": "--accessToken", + "name": [ + "-a", + "--accessToken" + ], + "args": {}, "isRequired": true, - "hidden": true + "hidden": false + }, + { + "name": "--open", + "description": "Open microstore url in default browser" }, { "name": [ - "-p", - "--print" + "-S", + "--skuListId" ], - "description": "Print out the modified resource" + "description": "The sku list id", + "args": {}, + "isRequired": true }, { "name": [ - "-j", - "--json" + "-A", + "--all" ], - "description": "Print result in json format" + "description": "Activate the buy all button " }, { "name": [ - "-u", - "--unformatted" + "-C", + "--cart" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "Activate the cart application" + }, { - "name": "id", - "description": "The unique id of the resource" + "name": [ + "-I", + "--inline" + ], + "description": "Disable redirect to cart application" } ] }, { "name": [ - "webhook" + "checkout" ], - "description": "Execute an action on a resource of type webhooks", + "description": "Create checkout urls", "options": [ { "name": [ @@ -11685,6 +12241,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11693,47 +12250,83 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { - "name": "--accessToken", + "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": [ - "-p", - "--print" + "-O", + "--order" ], - "description": "Print out the modified resource" + "description": "An order id", + "args": {} }, { "name": [ - "-j", - "--json" + "-S", + "--sku" ], - "description": "Print result in json format" + "description": "An sku code", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-B", + "--bundle" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "A bundle code", + "args": {} + }, { - "name": "id", - "description": "The unique id of the resource" + "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": [ - "webhook:disable" + "checkout:order" ], - "description": "Send this attribute if you want to mark the webhook as disabled.", + "description": "Create checkout urls starting from an existing order", "options": [ { "name": [ @@ -11741,6 +12334,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11749,54 +12343,140 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "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 + "hidden": false }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + "name": "--open", + "description": "Open checkout url in default browser" }, + { + "name": "--staging", + "description": "Connect to checkout application in staging environment", + "hidden": true + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the order" + } + ] + }, + { + "name": [ + "seeder:check" + ], + "description": "Execute a check on seeder data", + "options": [ { "name": [ - "-j", - "--json" + "-b", + "--businessModel" ], - "description": "Print result in json format" + "description": "The kind of business model you want to import", + "args": { + "suggestions": [ + "single_sku", + "multi_market", + "custom" + ], + "default": "single_sku" + } }, { "name": [ "-u", - "--unformatted" + "--url" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "Seeder data url", + "args": { + "default": "https://data.commercelayer.app/seeder" + } + }, { - "name": "id", - "description": "The unique id of the resource" + "name": [ + "-n", + "--name" + ], + "description": "The name of the business model file to use", + "args": {} + }, + { + "name": "--debug", + "description": "Show command debug information", + "hidden": true + }, + { + "name": [ + "-r", + "--relationships" + ], + "description": "Check resource relationships" } ] }, { "name": [ - "webhook:enable" + "seeder:clean" ], - "description": "Send this attribute if you want to mark the webhook as enabled.", + "description": "Clean previously imported 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": [ + "-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", + "args": {}, "isRequired": true, "hidden": true }, @@ -11805,54 +12485,69 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true - }, + } + ] + }, + { + "name": [ + "seeder:seed", + "seed" + ], + "description": "Execute commerce layer seeder", + "options": [ { "name": [ - "-p", - "--print" + "-b", + "--businessModel" ], - "description": "Print out the modified resource" + "description": "The kind of business model you want to import", + "args": { + "suggestions": [ + "single_sku", + "multi_market", + "custom" + ], + "default": "single_sku" + } }, { "name": [ - "-j", - "--json" + "-u", + "--url" ], - "description": "Print result in json format" + "description": "Seeder data url", + "args": { + "default": "https://data.commercelayer.app/seeder" + } }, { "name": [ - "-u", - "--unformatted" + "-n", + "--name" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "The name of the business model file to use", + "args": {} + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "webhook:reset_circuit" - ], - "description": "Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.", - "options": [ + "name": "--debug", + "description": "Show debug information", + "hidden": true + }, { "name": [ "-o", "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11861,39 +12556,30 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" - }, - { - "name": [ - "-j", - "--json" + "-k", + "--keep" ], - "description": "Print result in json format" + "description": "Keep existing resources without updating them" }, { "name": [ - "-u", - "--unformatted" + "-D", + "--delay" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" + "description": "Add a delay in milliseconds between calls to different resources", + "args": {}, + "hidden": true } ] }, @@ -11927,6 +12613,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -11935,10 +12622,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -11947,14 +12636,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -12007,39 +12698,45 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ "-s", "--sort" ], - "description": "Defines results ordering" + "description": "Defines results ordering", + "args": {} }, { "name": [ "-x", "--save" ], - "description": "Save command output to file" + "description": "Save command output to file", + "args": {} }, { "name": [ "-X", "--save-path" ], - "description": "Save command output to file and create missing path directories" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ @@ -12055,6 +12752,7 @@ const completionSpec: Fig.Spec = { "--clientId" ], "description": "Organization client_id", + "args": {}, "hidden": true }, { @@ -12063,6 +12761,7 @@ const completionSpec: Fig.Spec = { "--clientSecret" ], "description": "Organization client_secret", + "args": {}, "hidden": true }, { @@ -12092,7 +12791,8 @@ const completionSpec: Fig.Spec = { "-H", "--header" ], - "description": "Rename column headers defining a comma-separated list of values field:\"renamed title\"" + "description": "Rename column headers defining a comma-separated list of values field:\"renamed title\"", + "args": {} }, { "name": [ @@ -12106,7 +12806,8 @@ const completionSpec: Fig.Spec = { "-e", "--extract" ], - "description": "Extract subfields from object attributes" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ @@ -12114,6 +12815,7 @@ const completionSpec: Fig.Spec = { "--timeout" ], "description": "Set request timeout in milliseconds [1000 - 15000]", + "args": {}, "hidden": true } ], @@ -12136,14 +12838,16 @@ const completionSpec: Fig.Spec = { "-a", "--alias" ], - "description": "The alias associated to saved command arguments" + "description": "The alias associated to saved command arguments", + "args": {} }, { "name": [ "-r", "--resource" ], - "description": "The resource type" + "description": "The resource type", + "args": {} }, { "name": [ @@ -12192,6 +12896,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -12200,10 +12905,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -12212,7 +12919,8 @@ const completionSpec: Fig.Spec = { "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} } ], "args": [ @@ -12238,6 +12946,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -12246,10 +12955,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -12258,14 +12969,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -12318,11 +13031,13 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ @@ -12343,42 +13058,48 @@ const completionSpec: Fig.Spec = { "-a", "--attribute" ], - "description": "Define a resource attribute" + "description": "Define a resource attribute", + "args": {} }, { "name": [ "-O", "--object" ], - "description": "Define a resource object attribute" + "description": "Define a resource object attribute", + "args": {} }, { "name": [ "-r", "--relationship" ], - "description": "Define a relationship with another resource" + "description": "Define a relationship with another resource", + "args": {} }, { "name": [ "-m", "--metadata" ], - "description": "Define a metadata attribute or a set of metadata attributes" + "description": "Define a metadata attribute or a set of metadata attributes", + "args": {} }, { "name": [ "-D", "--data" ], - "description": "The data file to use as request body" + "description": "The data file to use as request body", + "args": {} }, { "name": [ "-t", "--tags" ], - "description": "List of tags associated with the resource" + "description": "List of tags associated with the resource", + "args": {} } ], "args": [ @@ -12403,6 +13124,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -12411,10 +13133,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -12423,14 +13147,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -12483,11 +13209,13 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ @@ -12564,6 +13292,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -12572,10 +13301,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -12584,14 +13315,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -12644,11 +13377,13 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ @@ -12669,49 +13404,56 @@ const completionSpec: Fig.Spec = { "-x", "--save" ], - "description": "Save command output to file" + "description": "Save command output to file", + "args": {} }, { "name": [ "-X", "--save-path" ], - "description": "Save command output to file and create missing path directories" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ "-e", "--extract" ], - "description": "Extract subfields from object attributes" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ "-p", "--page" ], - "description": "Page number" + "description": "Page number", + "args": {} }, { "name": [ "-n", "--pageSize" ], - "description": "Number of elements per page" + "description": "Number of elements per page", + "args": {} }, { "name": [ "-s", "--sort" ], - "description": "Defines results ordering" + "description": "Defines results ordering", + "args": {} }, { "name": [ @@ -12756,6 +13498,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -12764,10 +13507,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -12776,14 +13521,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -12836,11 +13583,13 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ @@ -12861,49 +13610,56 @@ const completionSpec: Fig.Spec = { "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ "-p", "--page" ], - "description": "Page number" + "description": "Page number", + "args": {} }, { "name": [ "-n", "--pageSize" ], - "description": "Number of elements per page" + "description": "Number of elements per page", + "args": {} }, { "name": [ "-s", "--sort" ], - "description": "Defines results ordering" + "description": "Defines results ordering", + "args": {} }, { "name": [ "-x", "--save" ], - "description": "Save command output to file" + "description": "Save command output to file", + "args": {} }, { "name": [ "-X", "--save-path" ], - "description": "Save command output to file and create missing path directories" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ "-e", "--extract" ], - "description": "Extract subfields from object attributes" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ @@ -12941,6 +13697,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -12949,10 +13706,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -12961,14 +13720,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -13021,11 +13782,13 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ @@ -13046,49 +13809,56 @@ const completionSpec: Fig.Spec = { "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ "-p", "--page" ], - "description": "Page number" + "description": "Page number", + "args": {} }, { "name": [ "-n", "--pageSize" ], - "description": "Number of elements per page" + "description": "Number of elements per page", + "args": {} }, { "name": [ "-s", "--sort" ], - "description": "Defines results ordering" + "description": "Defines results ordering", + "args": {} }, { "name": [ "-x", "--save" ], - "description": "Save command output to file" + "description": "Save command output to file", + "args": {} }, { "name": [ "-X", "--save-path" ], - "description": "Save command output to file and create missing path directories" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ "-e", "--extract" ], - "description": "Extract subfields from object attributes" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ @@ -13123,6 +13893,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13131,10 +13902,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -13143,14 +13916,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -13203,11 +13978,13 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ @@ -13228,49 +14005,56 @@ const completionSpec: Fig.Spec = { "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ "-p", "--page" ], - "description": "Page number" + "description": "Page number", + "args": {} }, { "name": [ "-n", "--pageSize" ], - "description": "Number of elements per page" + "description": "Number of elements per page", + "args": {} }, { "name": [ "-s", "--sort" ], - "description": "Defines results ordering" + "description": "Defines results ordering", + "args": {} }, { "name": [ "-x", "--save" ], - "description": "Save command output to file" + "description": "Save command output to file", + "args": {} }, { "name": [ "-X", "--save-path" ], - "description": "Save command output to file and create missing path directories" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ "-e", "--extract" ], - "description": "Extract subfields from object attributes" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ @@ -13312,6 +14096,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13320,10 +14105,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -13332,14 +14119,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -13392,11 +14181,13 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ @@ -13417,21 +14208,24 @@ const completionSpec: Fig.Spec = { "-x", "--save" ], - "description": "Save command output to file" + "description": "Save command output to file", + "args": {} }, { "name": [ "-X", "--save-path" ], - "description": "Save command output to file and create missing path directories" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ "-e", "--extract" ], - "description": "Extract subfields from object attributes" + "description": "Extract subfields from object attributes", + "args": {} } ], "args": [ @@ -13471,6 +14265,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13479,10 +14274,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -13491,14 +14288,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -13551,11 +14350,13 @@ const completionSpec: Fig.Spec = { }, { "name": "--save-args", - "description": "Save command data to file for future use" + "description": "Save command data to file for future use", + "args": {} }, { "name": "--load-args", - "description": "Load previously saved command arguments" + "description": "Load previously saved command arguments", + "args": {} }, { "name": [ @@ -13576,49 +14377,56 @@ const completionSpec: Fig.Spec = { "-a", "--attribute" ], - "description": "Define a resource attribute" + "description": "Define a resource attribute", + "args": {} }, { "name": [ "-O", "--object" ], - "description": "Define a resource object attribute" + "description": "Define a resource object attribute", + "args": {} }, { "name": [ "-r", "--relationship" ], - "description": "Define a relationship with another resource" + "description": "Define a relationship with another resource", + "args": {} }, { "name": [ "-m", "--metadata" ], - "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource" + "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource", + "args": {} }, { "name": [ "-M", "--metadata-replace" ], - "description": "Define a metadata attribute and replace every item already present in the remote resource" + "description": "Define a metadata attribute and replace every item already present in the remote resource", + "args": {} }, { "name": [ "-D", "--data" ], - "description": "The data file to use as request body" + "description": "The data file to use as request body", + "args": {} }, { "name": [ "-t", "--tags" ], - "description": "List of tags associated with the resource" + "description": "List of tags associated with the resource", + "args": {} } ], "args": [ @@ -13635,9 +14443,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "cleanups" + "exports" ], - "description": "List all the created cleanups or show details of a single cleanup", + "description": "List all the created exports or show details of a single export", "options": [ { "name": [ @@ -13645,6 +14453,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13653,10 +14462,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -13665,24 +14476,41 @@ const completionSpec: Fig.Spec = { "-A", "--all" ], - "description": "Show all cleanups instead of first 25 only" + "description": "Show all exports instead of first 25 only" }, { "name": [ "-t", "--type" ], - "description": "The type of resource cleaned", + "description": "The type of resource exported", "args": { "suggestions": [ + "addresses", "bundles", + "coupons", + "customer_subscriptions", + "customers", "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", "prices", - "promotions", + "shipments", + "shipping_categories", + "shipping_methods", "sku_lists", + "sku_list_items", "sku_options", "skus", - "stock_items" + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds" ] } }, @@ -13691,7 +14519,7 @@ const completionSpec: Fig.Spec = { "-s", "--status" ], - "description": "The cleanup job status", + "description": "The export job status", "args": { "suggestions": [ "in_progress", @@ -13706,24 +14534,25 @@ const completionSpec: Fig.Spec = { "-l", "--limit" ], - "description": "Limit number of cleanups in output" + "description": "Limit number of exports in output", + "args": {} } ], "args": [ { "name": "id", - "description": "Unique id of the cleanup to be retrieved", + "description": "Unique id of the export to be retrieved", "isOptional": true } ] }, { "name": [ - "cleanups:create", - "clp:create", - "cleanup" + "exports:all", + "exp:all", + "export" ], - "description": "Create a new cleanup", + "description": "Export all the records", "options": [ { "name": [ @@ -13731,6 +14560,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13739,10 +14569,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -13751,35 +14583,105 @@ const completionSpec: Fig.Spec = { "-t", "--type" ], - "description": "The type of resource to clean up", - "isRequired": true, + "description": "The type of resource being exported", "args": { - "description": "bundles|gift_cards|prices|promotions|...", + "description": "addresses|bundles|coupons|customer_subscriptions|...", "suggestions": [ + "addresses", "bundles", + "coupons", + "customer_subscriptions", + "customers", "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", "prices", - "promotions", + "shipments", + "shipping_categories", + "shipping_methods", "sku_lists", + "sku_list_items", "sku_options", "skus", - "stock_items" + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds" ] - } + }, + "isRequired": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} + }, + { + "name": [ + "-D", + "--dry-data" + ], + "description": "Skip redundant attributes" + }, + { + "name": [ + "-F", + "--format" + ], + "description": "Export file format", + "args": { + "suggestions": [ + "csv", + "json" + ], + "default": "json" + } + }, + { + "name": [ + "-C", + "--csv" + ], + "description": "Export data in csv format" + }, + { + "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": [ "-N", "--notify" ], - "description": "Force system notification when cleanup has finished", + "description": "Force system notification when export has finished", "hidden": true }, { @@ -13789,21 +14691,43 @@ const completionSpec: Fig.Spec = { ], "description": "Execute in blind mode without showing the progress monitor" }, + { + "name": [ + "-P", + "--prettify" + ], + "description": "Prettify json output format" + }, + { + "name": [ + "-O", + "--open" + ], + "description": "Open automatically the file after a successful export" + }, { "name": [ "-q", "--quiet" ], "description": "Execute command without showing warning messages" + }, + { + "name": [ + "-k", + "--keep" + ], + "description": "Keep original export files in temp dir" } - ] + ], + "hidden": false }, { "name": [ - "cleanups:details", - "clp:details" + "exports:create", + "exp:create" ], - "description": "Show the details of an existing cleanup", + "description": "Create a new export", "options": [ { "name": [ @@ -13811,6 +14735,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13819,34 +14744,189 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-l", - "--logs" + "-t", + "--type" ], - "description": "Show error logs related to the cleanup process" + "description": "The type of resource being exported", + "args": { + "description": "addresses|bundles|coupons|customer_subscriptions|...", + "suggestions": [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds" + ] + }, + "isRequired": true + }, + { + "name": [ + "-i", + "--include" + ], + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters", + "args": {} + }, + { + "name": [ + "-D", + "--dry-data" + ], + "description": "Skip redundant attributes" + }, + { + "name": [ + "-F", + "--format" + ], + "description": "Export file format", + "args": { + "suggestions": [ + "csv", + "json" + ], + "default": "json" + } + }, + { + "name": [ + "-C", + "--csv" + ], + "description": "Export data in csv format" + }, + { + "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": [ + "-N", + "--notify" + ], + "description": "Force system notification when export has finished", + "hidden": true + }, + { + "name": [ + "-b", + "--blind" + ], + "description": "Execute in blind mode without showing the progress monitor" + }, + { + "name": [ + "-P", + "--prettify" + ], + "description": "Prettify json output format" + }, + { + "name": [ + "-O", + "--open" + ], + "description": "Open automatically the file after a successful export" + } + ] + }, + { + "name": [ + "exports:details", + "exp:details" + ], + "description": "Show the details of an existing export", + "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 cleanup" + "description": "Unique id of the export" } ] }, { "name": [ - "cleanups:group", - "clp:group" + "exports:group", + "exp:group" ], - "description": "List all the cleanups related to a cleanup group", + "description": "List all the exports related to an export group", "options": [ { "name": [ @@ -13854,6 +14934,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13862,10 +14943,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true } @@ -13873,16 +14956,16 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "group_id", - "description": "Unique id of the group cleanup" + "description": "Unique id of the group export" } ] }, { "name": [ - "cleanups:list", - "clp:list" + "exports:list", + "exp:list" ], - "description": "List all the created cleanups", + "description": "List all the created exports", "options": [ { "name": [ @@ -13890,6 +14973,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13898,10 +14982,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -13910,24 +14996,41 @@ const completionSpec: Fig.Spec = { "-A", "--all" ], - "description": "Show all cleanups instead of first 25 only" + "description": "Show all exports instead of first 25 only" }, { "name": [ "-t", "--type" ], - "description": "The type of resource cleaned", + "description": "The type of resource exported", "args": { "suggestions": [ + "addresses", "bundles", + "coupons", + "customer_subscriptions", + "customers", "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", "prices", - "promotions", - "sku_lists", - "sku_options", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", "skus", - "stock_items" + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds" ] } }, @@ -13936,7 +15039,7 @@ const completionSpec: Fig.Spec = { "-s", "--status" ], - "description": "The cleanup job status", + "description": "The export job status", "args": { "suggestions": [ "in_progress", @@ -13951,14 +15054,15 @@ const completionSpec: Fig.Spec = { "-l", "--limit" ], - "description": "Limit number of cleanups in output" + "description": "Limit number of exports in output", + "args": {} } ] }, { "name": [ - "cleanups:types", - "clp:types" + "exports:types", + "exp:types" ], "description": "Show online documentation for supported resources", "options": [ @@ -13973,9 +15077,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "exports" + "cleanups" ], - "description": "List all the created exports or show details of a single export", + "description": "List all the created cleanups or show details of a single cleanup", "options": [ { "name": [ @@ -13983,6 +15087,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -13991,10 +15096,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -14003,41 +15110,24 @@ const completionSpec: Fig.Spec = { "-A", "--all" ], - "description": "Show all exports instead of first 25 only" + "description": "Show all cleanups instead of first 25 only" }, { "name": [ "-t", "--type" ], - "description": "The type of resource exported", + "description": "The type of resource cleaned", "args": { "suggestions": [ - "addresses", "bundles", - "coupons", - "customer_subscriptions", - "customers", "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", "prices", - "shipments", - "shipping_categories", - "shipping_methods", + "promotions", "sku_lists", - "sku_list_items", "sku_options", "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds" + "stock_items" ] } }, @@ -14046,7 +15136,7 @@ const completionSpec: Fig.Spec = { "-s", "--status" ], - "description": "The export job status", + "description": "The cleanup job status", "args": { "suggestions": [ "in_progress", @@ -14061,24 +15151,25 @@ const completionSpec: Fig.Spec = { "-l", "--limit" ], - "description": "Limit number of exports in output" + "description": "Limit number of cleanups in output", + "args": {} } ], "args": [ { "name": "id", - "description": "Unique id of the export to be retrieved", + "description": "Unique id of the cleanup to be retrieved", "isOptional": true } ] }, { "name": [ - "exports:all", - "exp:all", - "export" + "cleanups:create", + "clp:create", + "cleanup" ], - "description": "Export all the records", + "description": "Create a new cleanup", "options": [ { "name": [ @@ -14086,6 +15177,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -14094,10 +15186,12 @@ const completionSpec: Fig.Spec = { "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -14106,147 +15200,145 @@ const completionSpec: Fig.Spec = { "-t", "--type" ], - "description": "The type of resource being exported", - "isRequired": true, + "description": "The type of resource to clean up", "args": { - "description": "addresses|bundles|coupons|customer_subscriptions|...", + "description": "bundles|gift_cards|prices|promotions|...", "suggestions": [ - "addresses", "bundles", - "coupons", - "customer_subscriptions", - "customers", "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", "prices", - "shipments", - "shipping_categories", - "shipping_methods", + "promotions", "sku_lists", - "sku_list_items", "sku_options", "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds" + "stock_items" ] - } - }, - { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include" + }, + "isRequired": true }, { "name": [ "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ - "-D", - "--dry-data" + "-N", + "--notify" ], - "description": "Skip redundant attributes" + "description": "Force system notification when cleanup has finished", + "hidden": true }, { "name": [ - "-F", - "--format" + "-b", + "--blind" ], - "description": "Export file format", - "args": { - "suggestions": [ - "csv", - "json" - ], - "default": "json" - } + "description": "Execute in blind mode without showing the progress monitor" }, { "name": [ - "-C", - "--csv" + "-q", + "--quiet" ], - "description": "Export data in csv format" - }, + "description": "Execute command without showing warning messages" + } + ] + }, + { + "name": [ + "cleanups:details", + "clp:details" + ], + "description": "Show the details of an existing cleanup", + "options": [ { "name": [ - "-x", - "--save" + "-o", + "--organization" ], - "description": "Save command output to file" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-X", - "--save-path" + "-d", + "--domain" ], - "description": "Save command output to file and create missing path directories" + "args": {}, + "hidden": true }, { - "name": [ - "-N", - "--notify" - ], - "description": "Force system notification when export has finished", + "name": "--accessToken", + "args": {}, + "isRequired": true, "hidden": true }, { "name": [ - "-b", - "--blind" + "-l", + "--logs" ], - "description": "Execute in blind mode without showing the progress monitor" - }, + "description": "Show error logs related to the cleanup process" + } + ], + "args": [ { - "name": [ - "-P", - "--prettify" - ], - "description": "Prettify json output format" - }, + "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", - "--open" + "-o", + "--organization" ], - "description": "Open automatically the file after a successful export" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-q", - "--quiet" + "-d", + "--domain" ], - "description": "Execute command without showing warning messages" + "args": {}, + "hidden": true }, { - "name": [ - "-k", - "--keep" - ], - "description": "Keep original export files in temp dir" + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true } ], - "hidden": false + "args": [ + { + "name": "group_id", + "description": "Unique id of the group cleanup" + } + ] }, { "name": [ - "exports:create", - "exp:create" + "cleanups:list", + "clp:list" ], - "description": "Create a new export", + "description": "List all the created cleanups", "options": [ { "name": [ @@ -14254,6 +15346,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", + "args": {}, "isRequired": true, "hidden": true }, @@ -14262,287 +15355,47 @@ const completionSpec: Fig.Spec = { "-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 being exported", - "isRequired": true, + "description": "The type of resource cleaned", "args": { - "description": "addresses|bundles|coupons|customer_subscriptions|...", "suggestions": [ - "addresses", "bundles", - "coupons", - "customer_subscriptions", - "customers", "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", "prices", - "shipments", - "shipping_categories", - "shipping_methods", + "promotions", "sku_lists", - "sku_list_items", "sku_options", "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds" + "stock_items" ] } }, { "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include" - }, - { - "name": [ - "-w", - "--where" + "-s", + "--status" ], - "description": "Comma separated list of query filters" - }, - { - "name": [ - "-D", - "--dry-data" - ], - "description": "Skip redundant attributes" - }, - { - "name": [ - "-F", - "--format" - ], - "description": "Export file format", - "args": { - "suggestions": [ - "csv", - "json" - ], - "default": "json" - } - }, - { - "name": [ - "-C", - "--csv" - ], - "description": "Export data in csv format" - }, - { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file" - }, - { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories" - }, - { - "name": [ - "-N", - "--notify" - ], - "description": "Force system notification when export has finished", - "hidden": true - }, - { - "name": [ - "-b", - "--blind" - ], - "description": "Execute in blind mode without showing the progress monitor" - }, - { - "name": [ - "-P", - "--prettify" - ], - "description": "Prettify json output format" - }, - { - "name": [ - "-O", - "--open" - ], - "description": "Open automatically the file after a successful export" - } - ] - }, - { - "name": [ - "exports:details", - "exp:details" - ], - "description": "Show the details of an existing export", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true - }, - { - "name": [ - "-d", - "--domain" - ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true - } - ], - "args": [ - { - "name": "id", - "description": "Unique id of the export" - } - ] - }, - { - "name": [ - "exports:group", - "exp:group" - ], - "description": "List all the exports related to an export group", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true - }, - { - "name": [ - "-d", - "--domain" - ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true - } - ], - "args": [ - { - "name": "group_id", - "description": "Unique id of the group export" - } - ] - }, - { - "name": [ - "exports:list", - "exp:list" - ], - "description": "List all the created exports", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true - }, - { - "name": [ - "-d", - "--domain" - ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true - }, - { - "name": [ - "-A", - "--all" - ], - "description": "Show all exports instead of first 25 only" - }, - { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource exported", - "args": { - "suggestions": [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds" - ] - } - }, - { - "name": [ - "-s", - "--status" - ], - "description": "The export job status", + "description": "The cleanup job status", "args": { "suggestions": [ "in_progress", @@ -14557,14 +15410,15 @@ const completionSpec: Fig.Spec = { "-l", "--limit" ], - "description": "Limit number of exports in output" + "description": "Limit number of cleanups in output", + "args": {} } ] }, { "name": [ - "exports:types", - "exp:types" + "cleanups:types", + "clp:types" ], "description": "Show online documentation for supported resources", "options": [ @@ -14579,517 +15433,338 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "tags" - ], - "description": "List all the created tags or show details of a single tag", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true - }, - { - "name": [ - "-d", - "--domain" - ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true - }, - { - "name": [ - "-A", - "--all" - ], - "description": "Show all tags instead of first 25 only" - }, - { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of tags in output" - } - ], - "args": [ - { - "name": "id", - "description": "Unique id of the tag to be retrieved", - "isOptional": true - } - ] - }, - { - "name": [ - "tags:add", - "tag" + "provisioning:create", + "prov:create", + "pc", + "pcreate" ], - "description": "Add one or more tags to a set of resources", + "description": "Create a new resource", "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true - }, { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, - { - "name": [ - "-n", - "--name" - ], - "description": "The tag name", - "isRequired": true - }, - { - "name": [ - "-t", - "--type" - ], - "description": "The type of the resource to tag", - "isRequired": true - }, { "name": [ "-i", - "--id" + "--include" ], - "description": "The ids of the resources to tag", - "isRequired": true + "description": "Comma separated resources to include", + "args": {} }, { "name": [ - "-C", - "--create" + "-f", + "--fields" ], - "description": "Create tags if don't exist" + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ - "-v", - "--verbose" - ], - "description": "Show details of the tag process" - } - ] - }, - { - "name": [ - "tags:count" - ], - "description": "Count resources tagged with a specific tag", - "options": [ - { - "name": [ - "-o", - "--organization" + "-j", + "--json" ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true + "description": "Convert output in standard json format" }, { "name": [ - "-d", - "--domain" + "-u", + "--unformatted" ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true + "description": "Print unformatted json output" }, { "name": [ - "-t", - "--type" + "-R", + "--raw" ], - "description": "The type of the tagged resources" + "description": "Print out the raw api response", + "hidden": false }, { - "name": [ - "-z", - "--zero" - ], - "description": "Show also resources without tags" - } - ], - "args": [ - { - "name": "id_name", - "description": "Unique id or name of the tag" - } - ] - }, - { - "name": [ - "tags:create" - ], - "description": "Create one or more new tags", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-d", - "--domain" + "-l", + "--lang" ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } }, { - "name": [ - "-n", - "--name" - ], - "description": "The tag name", - "isRequired": true - } - ] - }, - { - "name": [ - "tags:delete" - ], - "description": "Delete one or more existing tags", - "options": [ + "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": [ - "-o", - "--organization" + "-H", + "--headers" ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true + "description": "Show response headers" }, { "name": [ - "-d", - "--domain" + "-Y", + "--headers-only" ], - "hidden": true + "description": "Show only response headers" }, { - "name": "--accessToken", - "isRequired": true, - "hidden": true + "name": [ + "-a", + "--attribute" + ], + "description": "Define a resource attribute", + "args": {} }, { "name": [ - "-n", - "--name" + "-O", + "--object" ], - "description": "The tag name", - "isRequired": true - } - ] - }, - { - "name": [ - "tags:details" - ], - "description": "Show the details of an existing tag", - "options": [ + "description": "Define a resource object attribute", + "args": {} + }, { "name": [ - "-o", - "--organization" + "-r", + "--relationship" ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true + "description": "Define a relationship with another resource", + "args": {} }, { "name": [ - "-d", - "--domain" + "-m", + "--metadata" ], - "hidden": true + "description": "Define a metadata attribute or a set of metadata attributes", + "args": {} }, { - "name": "--accessToken", - "isRequired": true, - "hidden": true + "name": [ + "-D", + "--data" + ], + "description": "The data file to use as request body", + "args": {} } ], "args": [ { - "name": "id_name", - "description": "Unique id or name of the tag" + "name": "resource", + "description": "The resource type" } ] }, { "name": [ - "tags:list" + "provisioning:delete", + "prov:delete", + "pd", + "pdelete", + "pdel" ], - "description": "List all the created tags", + "description": "Delete an existing resource", "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true - }, { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-A", - "--all" + "-i", + "--include" ], - "description": "Show all tags instead of first 25 only" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ - "-l", - "--limit" - ], - "description": "Limit number of tags in output" - } - ] - }, - { - "name": [ - "tags:remove", - "tag" - ], - "description": "Remove one or more tags to a set of resources", - "options": [ - { - "name": [ - "-o", - "--organization" + "-f", + "--fields" ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ - "-d", - "--domain" + "-j", + "--json" ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true + "description": "Convert output in standard json format" }, { "name": [ - "-n", - "--name" + "-u", + "--unformatted" ], - "description": "The tag name", - "isRequired": true + "description": "Print unformatted json output" }, { "name": [ - "-t", - "--type" + "-R", + "--raw" ], - "description": "The type of the resource to tag", - "isRequired": true + "description": "Print out the raw api response", + "hidden": false }, { - "name": [ - "-i", - "--id" - ], - "description": "The ids of th eresources to tag", - "isRequired": true + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-v", - "--verbose" + "-l", + "--lang" ], - "description": "Show details of the tag process" - } - ] - }, - { - "name": [ - "tags:types" - ], - "description": "Show online documentation for supported resources", - "options": [ + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } + }, { - "name": [ - "-O", - "--open" - ], - "description": "Open online documentation page" - } - ] - }, - { - "name": [ - "tags:update" - ], - "description": "Update an existing tag", - "options": [ + "name": "--curl", + "description": "Show the equivalent curl command of the cli command", + "hidden": false + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true + "name": "--node", + "description": "Show the equivalent node sdk source code of the cli command", + "hidden": false }, { "name": [ - "-d", - "--domain" + "-H", + "--headers" ], - "hidden": true - }, - { - "name": "--accessToken", - "isRequired": true, - "hidden": true + "description": "Show response headers" }, { "name": [ - "-n", - "--name" + "-Y", + "--headers-only" ], - "description": "The new tag name", - "isRequired": true + "description": "Show only response headers" } ], "args": [ { - "name": "id_name", - "description": "Unique id or name of the tag" + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to delete", + "isOptional": true } ] }, { "name": [ - "tags:which" + "provisioning:exec", + "prov:exec", + "pe", + "pexec" ], - "description": "Show all the resources with this tag", + "description": "Execute an action on a resource", "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "isRequired": true, - "hidden": true - }, { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, { "name": [ - "-t", - "--type" - ], - "description": "The type of the tagged resources", - "isRequired": true - }, - { - "name": [ - "-A", - "--all" - ], - "description": "Show all resources instead of first 25 only" - }, - { - "name": [ - "-l", - "--limit" + "-a", + "--attribute" ], - "description": "Limit number of resources in output" + "description": "Define a resource attribute", + "args": {} } ], "args": [ { - "name": "id_name", - "description": "Unique id or name of the tag" + "name": "resource", + "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource on which to execute the action", + "isOptional": true + }, + { + "name": "action", + "description": "Action to execute on resource", + "isOptional": true } ] }, { "name": [ - "provisioning:create", - "prov:create", - "pc", - "pcreate" + "provisioning:fetch", + "prov:fetch", + "pf" ], - "description": "Create a new resource", + "description": "Retrieve a resource or list a set of resources", "options": [ { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -15098,14 +15773,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -15172,66 +15849,89 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-a", - "--attribute" + "-e", + "--extract" ], - "description": "Define a resource attribute" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ - "-O", - "--object" + "-w", + "--where" ], - "description": "Define a resource object attribute" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ - "-r", - "--relationship" + "-p", + "--page" ], - "description": "Define a relationship with another resource" + "description": "Page number", + "args": {} }, { "name": [ - "-m", - "--metadata" + "-n", + "--pageSize" ], - "description": "Define a metadata attribute or a set of metadata attributes" + "description": "Number of elements per page", + "args": {} }, { "name": [ - "-D", - "--data" + "-s", + "--sort" + ], + "description": "Defines results ordering", + "args": {} + }, + { + "name": [ + "-I", + "--force-include" ], - "description": "The data file to use as request body" + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true } ], "args": [ { "name": "resource", "description": "The resource type" + }, + { + "name": "path", + "description": "Path (or url) of the resource(s) to fetch" + }, + { + "name": "id", + "description": "Resource id", + "isOptional": true } ] }, { "name": [ - "provisioning:delete", - "prov:delete", - "pd", - "pdelete", - "pdel" + "provisioning:get", + "prov:get", + "pg", + "pget" ], - "description": "Delete an existing resource", + "description": "Retrieve a resource or list a set of resources", "options": [ { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -15240,14 +15940,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -15311,47 +16013,54 @@ const completionSpec: Fig.Spec = { "--headers-only" ], "description": "Show only response headers" - } - ], - "args": [ + }, { - "name": "resource", - "description": "The resource type" + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes", + "args": {} }, { - "name": "id", - "description": "Id of the resource to delete", - "isOptional": true - } - ] - }, - { - "name": [ - "provisioning:exec", - "prov:exec", - "pe", - "pexec" - ], - "description": "Execute an action on a resource", - "options": [ + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters", + "args": {} + }, { "name": [ - "-d", - "--domain" + "-p", + "--page" ], - "hidden": true + "description": "Page number", + "args": {} }, { - "name": "--accessToken", - "isRequired": true, - "hidden": true + "name": [ + "-n", + "--pageSize" + ], + "description": "Number of elements per page", + "args": {} }, { "name": [ - "-a", - "--attribute" + "-s", + "--sort" + ], + "description": "Defines results ordering", + "args": {} + }, + { + "name": [ + "-I", + "--force-include" ], - "description": "Define a resource attribute" + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true } ], "args": [ @@ -15361,33 +16070,32 @@ const completionSpec: Fig.Spec = { }, { "name": "id", - "description": "Id of the resource on which to execute the action", - "isOptional": true - }, - { - "name": "action", - "description": "Action to execute on resource", + "description": "Id of the resource to retrieve", "isOptional": true } ] }, { "name": [ - "provisioning:fetch", - "prov:fetch", - "pf" + "provisioning:list", + "pl", + "prov:list", + "plist", + "pls" ], - "description": "Retrieve a resource or list a set of resources", + "description": "Fetch a collection of resources", "options": [ { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -15396,14 +16104,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -15468,40 +16178,45 @@ const completionSpec: Fig.Spec = { ], "description": "Show only response headers" }, - { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes" - }, { "name": [ "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ "-p", "--page" ], - "description": "Page number" + "description": "Page number", + "args": {} }, { "name": [ "-n", "--pageSize" ], - "description": "Number of elements per page" + "description": "Number of elements per page", + "args": {} }, { "name": [ "-s", "--sort" ], - "description": "Defines results ordering" + "description": "Defines results ordering", + "args": {} + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ @@ -15516,36 +16231,29 @@ const completionSpec: Fig.Spec = { { "name": "resource", "description": "The resource type" - }, - { - "name": "path", - "description": "Path (or url) of the resource(s) to fetch" - }, - { - "name": "id", - "description": "Resource id", - "isOptional": true } ] }, { "name": [ - "provisioning:get", - "prov:get", - "pg", - "pget" + "provisioning:rel", + "provisioning:rel", + "prov:rel", + "prov:relationship" ], - "description": "Retrieve a resource or list a set of resources", + "description": "Fetch a resource relationship", "options": [ { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -15554,14 +16262,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -15626,40 +16336,45 @@ const completionSpec: Fig.Spec = { ], "description": "Show only response headers" }, - { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes" - }, { "name": [ "-w", "--where" ], - "description": "Comma separated list of query filters" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ "-p", "--page" ], - "description": "Page number" + "description": "Page number", + "args": {} }, { "name": [ "-n", "--pageSize" ], - "description": "Number of elements per page" + "description": "Number of elements per page", + "args": {} }, { "name": [ "-s", "--sort" ], - "description": "Defines results ordering" + "description": "Defines results ordering", + "args": {} + }, + { + "name": [ + "-e", + "--extract" + ], + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ @@ -15677,30 +16392,52 @@ const completionSpec: Fig.Spec = { }, { "name": "id", - "description": "Id of the resource to retrieve", - "isOptional": true + "description": "Id of the resource to retrieve" + }, + { + "name": "relationship", + "description": "Name of the relationship field" + } + ], + "hidden": false + }, + { + "name": [ + "provisioning:resources", + "prov:resources", + "pres" + ], + "description": "List all the available provisioning api resources", + "options": [ + { + "name": [ + "-h", + "--help" + ], + "description": "Show cli help." } ] }, { "name": [ - "provisioning:list", - "pl", - "prov:list", - "plist", - "pls" + "provisioning:retrieve", + "prov:retrieve", + "pr", + "pretrieve" ], - "description": "Fetch a collection of resources", + "description": "Fetch a single resource", "options": [ { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -15709,14 +16446,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -15781,75 +16520,48 @@ const completionSpec: Fig.Spec = { ], "description": "Show only response headers" }, - { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters" - }, - { - "name": [ - "-p", - "--page" - ], - "description": "Page number" - }, - { - "name": [ - "-n", - "--pageSize" - ], - "description": "Number of elements per page" - }, - { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering" - }, { "name": [ "-e", "--extract" ], - "description": "Extract subfields from object attributes" - }, - { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true + "description": "Extract subfields from object attributes", + "args": {} } ], "args": [ { "name": "resource", "description": "The resource type" + }, + { + "name": "id", + "description": "Id of the resource to retrieve", + "isOptional": true } ] }, { "name": [ - "provisioning:rel", - "provisioning:rel", - "prov:rel", - "prov:relationship" + "provisioning:update", + "prov:update", + "pu", + "pupdate", + "pupd" ], - "description": "Fetch a resource relationship", + "description": "Update an existing resource", "options": [ { "name": [ "-d", "--domain" ], + "args": {}, "hidden": true }, { "name": "--accessToken", + "args": {}, "isRequired": true, "hidden": true }, @@ -15858,14 +16570,16 @@ const completionSpec: Fig.Spec = { "-i", "--include" ], - "description": "Comma separated resources to include" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ "-f", "--fields" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ @@ -15932,46 +16646,51 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-w", - "--where" + "-a", + "--attribute" ], - "description": "Comma separated list of query filters" + "description": "Define a resource attribute", + "args": {} }, { "name": [ - "-p", - "--page" + "-O", + "--object" ], - "description": "Page number" + "description": "Define a resource object attribute", + "args": {} }, { "name": [ - "-n", - "--pageSize" + "-r", + "--relationship" ], - "description": "Number of elements per page" + "description": "Define a relationship with another resource", + "args": {} }, { "name": [ - "-s", - "--sort" + "-m", + "--metadata" ], - "description": "Defines results ordering" + "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource", + "args": {} }, { "name": [ - "-e", - "--extract" + "-M", + "--metadata-replace" ], - "description": "Extract subfields from object attributes" + "description": "Define a metadata attribute and replace every item already present in the remote resource", + "args": {} }, { "name": [ - "-I", - "--force-include" + "-D", + "--data" ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true + "description": "The data file to use as request body", + "args": {} } ], "args": [ @@ -15981,301 +16700,548 @@ const completionSpec: Fig.Spec = { }, { "name": "id", - "description": "Id of the resource to retrieve" - }, - { - "name": "relationship", - "description": "Name of the relationship field" + "description": "Id of the resource to update", + "isOptional": true } - ], - "hidden": false + ] }, { "name": [ - "provisioning:resources", - "prov:resources", - "pres" + "tags" ], - "description": "List all the available provisioning api resources", + "description": "List all the created tags or show details of a single tag", "options": [ { "name": [ - "-h", - "--help" + "-o", + "--organization" ], - "description": "Show cli help." + "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 tags instead of first 25 only" + }, + { + "name": [ + "-l", + "--limit" + ], + "description": "Limit number of tags in output", + "args": {} + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the tag to be retrieved", + "isOptional": true } ] }, { "name": [ - "provisioning:retrieve", - "prov:retrieve", - "pr", - "pretrieve" + "tags:add", + "tag" ], - "description": "Fetch a single resource", + "description": "Add one or more tags to a set of resources", "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": [ + "-n", + "--name" + ], + "description": "The tag name", + "args": {}, + "isRequired": true + }, + { + "name": [ + "-t", + "--type" + ], + "description": "The type of the resource to tag", + "args": {}, + "isRequired": true + }, { "name": [ "-i", - "--include" + "--id" ], - "description": "Comma separated resources to include" + "description": "The ids of the resources to tag", + "args": {}, + "isRequired": true }, { "name": [ - "-f", - "--fields" + "-C", + "--create" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." + "description": "Create tags if don't exist", + "args": {} }, { "name": [ - "-j", - "--json" + "-v", + "--verbose" ], - "description": "Convert output in standard json format" + "description": "Show details of the tag process" + } + ] + }, + { + "name": [ + "tags:count" + ], + "description": "Count resources tagged with a specific tag", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-u", - "--unformatted" + "-d", + "--domain" ], - "description": "Print unformatted json output" + "args": {}, + "hidden": true + }, + { + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-R", - "--raw" + "-t", + "--type" ], - "description": "Print out the raw api response", - "hidden": false + "description": "The type of the tagged resources", + "args": {} }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + "name": [ + "-z", + "--zero" + ], + "description": "Show also resources without tags" + } + ], + "args": [ + { + "name": "id_name", + "description": "Unique id or name of the tag" + } + ] + }, + { + "name": [ + "tags:create" + ], + "description": "Create one or more new tags", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-l", - "--lang" + "-d", + "--domain" ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + "args": {}, + "hidden": true }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The tag name", + "args": {}, + "isRequired": true + } + ] + }, + { + "name": [ + "tags:delete" + ], + "description": "Delete one or more existing tags", + "options": [ + { + "name": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true + }, + { + "name": [ + "-d", + "--domain" + ], + "args": {}, + "hidden": true }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-H", - "--headers" + "-n", + "--name" ], - "description": "Show response headers" - }, + "description": "The tag name", + "args": {}, + "isRequired": true + } + ] + }, + { + "name": [ + "tags:details" + ], + "description": "Show the details of an existing tag", + "options": [ { "name": [ - "-Y", - "--headers-only" + "-o", + "--organization" ], - "description": "Show only response headers" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-e", - "--extract" + "-d", + "--domain" ], - "description": "Extract subfields from object attributes" + "args": {}, + "hidden": true + }, + { + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true } ], "args": [ { - "name": "resource", - "description": "The resource type" - }, - { - "name": "id", - "description": "Id of the resource to retrieve", - "isOptional": true + "name": "id_name", + "description": "Unique id or name of the tag" } ] }, { "name": [ - "provisioning:update", - "prov:update", - "pu", - "pupdate", - "pupd" + "tags:list" ], - "description": "Update an existing resource", + "description": "List all the created tags", "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" + "-A", + "--all" ], - "description": "Comma separated resources to include" + "description": "Show all tags instead of first 25 only" }, { "name": [ - "-f", - "--fields" + "-l", + "--limit" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2..." - }, + "description": "Limit number of tags in output", + "args": {} + } + ] + }, + { + "name": [ + "tags:remove", + "tag" + ], + "description": "Remove one or more tags to a set of resources", + "options": [ { "name": [ - "-j", - "--json" + "-o", + "--organization" ], - "description": "Convert output in standard json format" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-u", - "--unformatted" + "-d", + "--domain" ], - "description": "Print unformatted json output" + "args": {}, + "hidden": true + }, + { + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-R", - "--raw" + "-n", + "--name" ], - "description": "Print out the raw api response", - "hidden": false + "description": "The tag name", + "args": {}, + "isRequired": true }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + "name": [ + "-t", + "--type" + ], + "description": "The type of the resource to tag", + "args": {}, + "isRequired": true }, { "name": [ - "-l", - "--lang" + "-i", + "--id" ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + "description": "The ids of th eresources to tag", + "args": {}, + "isRequired": true }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false - }, + "name": [ + "-v", + "--verbose" + ], + "description": "Show details of the tag process" + } + ] + }, + { + "name": [ + "tags:types" + ], + "description": "Show online documentation for supported resources", + "options": [ { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false - }, + "name": [ + "-O", + "--open" + ], + "description": "Open online documentation page" + } + ] + }, + { + "name": [ + "tags:update" + ], + "description": "Update an existing tag", + "options": [ { "name": [ - "-H", - "--headers" + "-o", + "--organization" ], - "description": "Show response headers" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-Y", - "--headers-only" + "-d", + "--domain" ], - "description": "Show only response headers" + "args": {}, + "hidden": true + }, + { + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-a", - "--attribute" + "-n", + "--name" ], - "description": "Define a resource attribute" - }, + "description": "The new tag name", + "args": {}, + "isRequired": true + } + ], + "args": [ + { + "name": "id_name", + "description": "Unique id or name of the tag" + } + ] + }, + { + "name": [ + "tags:which" + ], + "description": "Show all the resources with this tag", + "options": [ { "name": [ - "-O", - "--object" + "-o", + "--organization" ], - "description": "Define a resource object attribute" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-r", - "--relationship" + "-d", + "--domain" ], - "description": "Define a relationship with another resource" + "args": {}, + "hidden": true + }, + { + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-m", - "--metadata" + "-t", + "--type" ], - "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource" + "description": "The type of the tagged resources", + "args": {}, + "isRequired": true }, { "name": [ - "-M", - "--metadata-replace" + "-A", + "--all" ], - "description": "Define a metadata attribute and replace every item already present in the remote resource" + "description": "Show all resources instead of first 25 only" }, { "name": [ - "-D", - "--data" + "-l", + "--limit" ], - "description": "The data file to use as request body" + "description": "Limit number of resources in output", + "args": {} } ], "args": [ { - "name": "resource", - "description": "The resource type" - }, - { - "name": "id", - "description": "Id of the resource to update", - "isOptional": true + "name": "id_name", + "description": "Unique id or name of the tag" } ] }, From dd9308e2981b15c58e77bcd9c0615c619e6f3c3e Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Fri, 12 Apr 2024 11:36:49 +0200 Subject: [PATCH 3/8] feat: add resources command suggestions --- src/commercelayer.ts | 6654 +++++++++++++++++++++++------------------- 1 file changed, 3646 insertions(+), 3008 deletions(-) diff --git a/src/commercelayer.ts b/src/commercelayer.ts index 5a6a065789a8..9d84e26357eb 100644 --- a/src/commercelayer.ts +++ b/src/commercelayer.ts @@ -1,4 +1,7 @@ -/** Autogenerated by @commercelayer/cli cli:fig command **/ + +/** + * Autogenerated by @commercelayer/cli cli:fig command + **/ const completionSpec: Fig.Spec = { @@ -88,7 +91,12 @@ const completionSpec: Fig.Spec = { "--api" ], "description": "Specific api application", - "args": {} + "args": { + "suggestions": [ + "core", + "provisioning" + ] + } }, { "name": [ @@ -288,7 +296,12 @@ const completionSpec: Fig.Spec = { "--api" ], "description": "Specific api application", - "args": {} + "args": { + "suggestions": [ + "core", + "provisioning" + ] + } }, { "name": [ @@ -464,7 +477,12 @@ const completionSpec: Fig.Spec = { "--api" ], "description": "Specific api application", - "args": {} + "args": { + "suggestions": [ + "core", + "provisioning" + ] + } }, { "name": [ @@ -566,7 +584,12 @@ const completionSpec: Fig.Spec = { "--api" ], "description": "Specific api application", - "args": {} + "args": { + "suggestions": [ + "core", + "provisioning" + ] + } }, { "name": [ @@ -688,7 +711,12 @@ const completionSpec: Fig.Spec = { "--api" ], "description": "Specific api application", - "args": {} + "args": { + "suggestions": [ + "core", + "provisioning" + ] + } } ] }, @@ -772,7 +800,12 @@ const completionSpec: Fig.Spec = { "--api" ], "description": "Specific api application", - "args": {} + "args": { + "suggestions": [ + "core", + "provisioning" + ] + } }, { "name": [ @@ -883,9 +916,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "imports" + "microstore" ], - "description": "List all the created imports or show details of a single import", + "description": "Create microstore urls", "options": [ { "name": [ @@ -906,111 +939,106 @@ const completionSpec: Fig.Spec = { "hidden": true }, { - "name": "--accessToken", + "name": [ + "-a", + "--accessToken" + ], "args": {}, "isRequired": true, - "hidden": true + "hidden": false + }, + { + "name": "--open", + "description": "Open microstore url in default browser" + }, + { + "name": [ + "-S", + "--skuListId" + ], + "description": "The sku list id", + "args": {}, + "isRequired": true }, { "name": [ "-A", "--all" ], - "description": "Show all imports instead of first 25 only" + "description": "Activate the buy all button " }, { "name": [ - "-t", - "--type" + "-C", + "--cart" ], - "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" - ] - } + "description": "Activate the cart application" }, { "name": [ - "-g", - "--group" + "-I", + "--inline" ], - "description": "The group id associated to the import in case of multi-chunk imports", - "args": {} - }, + "description": "Disable redirect to cart application" + } + ] + }, + { + "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": [ - "-s", - "--status" + "-d", + "--domain" ], - "description": "The import job status", - "args": { - "suggestions": [ - "in_progress", - "pending", - "completed", - "interrupted" - ] - } + "args": {}, + "hidden": true }, { "name": [ - "-e", - "--errors" + "-p", + "--print" ], - "description": "Show only imports with errors" + "description": "Print users answers", + "hidden": true }, { "name": [ - "-w", - "--warnings" + "-i", + "--info" ], - "description": "Show only import with warnings" + "description": "Print generated token info" }, { "name": [ - "-l", - "--limit" + "-c", + "--check" ], - "description": "Limit number of imports in output", - "args": {} - } - ], - "args": [ - { - "name": "id", - "description": "Unique id of the import to be retrieved", - "isOptional": true + "description": "Check generated access token" } ] }, { "name": [ - "imports:create", - "imp:create", - "import" + "token:get" ], - "description": "Create a new import", + "description": "Get a new access token", "options": [ { "name": [ @@ -1018,9 +1046,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "args": {} }, { "name": [ @@ -1030,107 +1056,65 @@ const completionSpec: Fig.Spec = { "args": {}, "hidden": true }, - { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - }, { "name": [ - "-t", - "--type" + "-i", + "--clientId" ], - "description": "The type of resource being imported", - "args": { - "description": "addresses|bundles|coupons|customer_addresses|...", - "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" - ] - }, + "description": "Application client_id", + "args": {}, "isRequired": true }, { "name": [ - "-p", - "--parent" + "-s", + "--clientSecret" ], - "description": "The id of the parent resource to be associated with imported data", + "description": "Application client_secret", "args": {} }, { "name": [ - "-i", - "--inputs" + "-S", + "--scope" ], - "description": "The path of the file containing the data to import", - "args": {}, - "isRequired": true + "description": "Access token scope (market, stock location)", + "args": {} }, { "name": [ - "-C", - "--csv" + "-e", + "--email" ], - "description": "Accept input file in csv format" + "description": "Customer email", + "args": {} }, { "name": [ - "-D", - "--delimiter" + "-p", + "--password" ], - "description": "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", - "args": { - "suggestions": [ - ",", - ";", - "|", - "TAB" - ] - } + "description": "Customer secret password", + "args": {} }, { - "name": [ - "-b", - "--blind" - ], - "description": "Execute in blind mode without showing the progress monitor" + "name": "--info", + "description": "Show access token info" }, { "name": [ - "-q", - "--quiet" - ], - "description": "Execute command without showing warning messages" + "-P", + "--provisioning" + ], + "description": "Execute login to provisioning api" } ] }, { "name": [ - "imports:delete", - "imp:delete" + "token:revoke" ], - "description": "Delete an existing import", + "description": "Revoke a commerce layer access token", "options": [ { "name": [ @@ -1138,9 +1122,7 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "args": {} }, { "name": [ @@ -1151,25 +1133,50 @@ const completionSpec: Fig.Spec = { "hidden": true }, { - "name": "--accessToken", + "name": [ + "-i", + "--clientId" + ], + "description": "Application client_id", "args": {}, - "isRequired": true, - "hidden": true + "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": "id", - "description": "Unique id of the import" + "name": "token", + "description": "Access token to revoke" } ] }, { "name": [ - "imports:details", - "imp:details" + "webhooks" ], - "description": "Show the details of an existing import", + "description": "List all the registered webhooks or the details of a single webhook", "options": [ { "name": [ @@ -1197,40 +1204,54 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-i", - "--inputs" + "-c", + "--circuit" ], - "description": "Show input items associated with the import" + "description": "Show only webhooks with circuit in the declared state", + "args": { + "suggestions": [ + "open", + "closed" + ] + } }, { "name": [ - "-l", - "--logs" + "-t", + "--topic" ], - "description": "Show warning and error logs related to the import process" + "description": "The event that triggered the webhook", + "args": {} }, { "name": [ - "-S", - "--save-inputs" + "-H", + "--hide-empty" ], - "description": "Save import inputs to local file", - "args": {} + "description": "Hide empty attributes" + }, + { + "name": [ + "-e", + "--events" + ], + "description": "Show the last event callbacks associated to the webhook" } ], "args": [ { "name": "id", - "description": "Unique id of the import" + "description": "Unique id of the webhook to get a single webhook", + "isOptional": true } ] }, { "name": [ - "imports:group", - "imp:group" + "webhooks:create", + "wh:create" ], - "description": "List all the imports related to an import group", + "description": "Create a new webhook", "options": [ { "name": [ @@ -1255,21 +1276,51 @@ const completionSpec: Fig.Spec = { "args": {}, "isRequired": true, "hidden": true - } - ], - "args": [ + }, { - "name": "group_id", - "description": "Unique id of the group import" + "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": [ + "-i", + "--include" + ], + "description": "A comma separated list of related resources to be included", + "args": {} + }, + { + "name": [ + "-n", + "--name" + ], + "description": "The webhook short name", + "args": {} } ] }, { "name": [ - "imports:list", - "imp:list" + "webhooks:destroy", + "webhooks:delete", + "wh:delete", + "wh:destroy" ], - "description": "List all the created imports", + "description": "Destroy an existing webhook", "options": [ { "name": [ @@ -1294,128 +1345,85 @@ const completionSpec: Fig.Spec = { "args": {}, "isRequired": true, "hidden": true - }, + } + ], + "args": [ { - "name": [ - "-A", - "--all" - ], - "description": "Show all imports instead of first 25 only" - }, + "name": "id", + "description": "Unique id of the webhook" + } + ] + }, + { + "name": [ + "webhooks:details", + "wh:details" + ], + "description": "Show the details of an existing webhook", + "options": [ { "name": [ - "-t", - "--type" + "-o", + "--organization" ], - "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" - ] - } + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-g", - "--group" + "-d", + "--domain" ], - "description": "The group id associated to the import in case of multi-chunk imports", - "args": {} + "args": {}, + "hidden": true }, { - "name": [ - "-s", - "--status" - ], - "description": "The import job status", - "args": { - "suggestions": [ - "in_progress", - "pending", - "completed", - "interrupted" - ] - } + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-e", - "--errors" + "-H", + "--hide-empty" ], - "description": "Show only imports with errors" + "description": "Hide empty attributes" }, { "name": [ - "-w", - "--warnings" + "-e", + "--events" ], - "description": "Show only import with warnings" - }, + "description": "Show the last event callbacks associated to the webhook" + } + ], + "args": [ { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of imports in output", - "args": {} + "name": "id", + "description": "Unique id of the webhook" } ] }, { "name": [ - "imports:types", - "imp:types" + "webhooks:event", + "wh:event" ], - "description": "Show online documentation for supported resources", + "description": "Show the details of a firedf webhook event", "options": [ { "name": [ - "-O", - "--open" + "-o", + "--organization" ], - "description": "Open online documentation page" - } - ] - }, - { - "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": [ + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true + }, { "name": [ "-d", @@ -1425,34 +1433,39 @@ const completionSpec: Fig.Spec = { "hidden": true }, { - "name": [ - "-p", - "--print" - ], - "description": "Print users answers", + "name": "--accessToken", + "args": {}, + "isRequired": true, "hidden": true }, { "name": [ - "-i", - "--info" + "-p", + "--payload" ], - "description": "Print generated token info" + "description": "Show the event payload sent to the callback endpoint" }, { "name": [ - "-c", - "--check" + "-f", + "--format" ], - "description": "Check generated access token" + "description": "Format the payload output" + } + ], + "args": [ + { + "name": "id", + "description": "Unique id of the webhook" } ] }, { "name": [ - "token:get" + "webhooks:events", + "wh:events" ], - "description": "Get a new access token", + "description": "List all the events associated to the webhook", "options": [ { "name": [ @@ -1460,7 +1473,9 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", - "args": {} + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ @@ -1471,64 +1486,40 @@ const completionSpec: Fig.Spec = { "hidden": true }, { - "name": [ - "-i", - "--clientId" - ], - "description": "Application client_id", + "name": "--accessToken", "args": {}, - "isRequired": true - }, - { - "name": [ - "-s", - "--clientSecret" - ], - "description": "Application client_secret", - "args": {} - }, - { - "name": [ - "-S", - "--scope" - ], - "description": "Access token scope (market, stock location)", - "args": {} + "isRequired": true, + "hidden": true }, { "name": [ - "-e", - "--email" + "-A", + "--all" ], - "description": "Customer email", - "args": {} + "description": "Show all events instead of first 25 only " }, { "name": [ - "-p", - "--password" + "-l", + "--limit" ], - "description": "Customer secret password", + "description": "Limit number of events in output", "args": {} - }, - { - "name": "--info", - "description": "Show access token info" - }, + } + ], + "args": [ { - "name": [ - "-P", - "--provisioning" - ], - "description": "Execute login to provisioning api" + "name": "id", + "description": "Unique id of the webhook" } ] }, { "name": [ - "token:revoke" + "webhooks:list", + "wh:list" ], - "description": "Revoke a commerce layer access token", + "description": "List all the registered webhooks", "options": [ { "name": [ @@ -1536,7 +1527,9 @@ const completionSpec: Fig.Spec = { "--organization" ], "description": "The slug of your organization", - "args": {} + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ @@ -1547,50 +1540,40 @@ const completionSpec: Fig.Spec = { "hidden": true }, { - "name": [ - "-i", - "--clientId" - ], - "description": "Application client_id", + "name": "--accessToken", "args": {}, - "isRequired": true + "isRequired": true, + "hidden": true }, { "name": [ - "-s", - "--clientSecret" + "-c", + "--circuit" ], - "description": "Application client_secret", - "args": {} + "description": "Show only webhooks with circuit in the declared state", + "args": { + "suggestions": [ + "open", + "closed" + ] + } }, { "name": [ - "-S", - "--scope" + "-t", + "--topic" ], - "description": "Access token scope", + "description": "The event that triggered the webhook", "args": {} - }, - { - "name": [ - "-P", - "--provisioning" - ], - "description": "Execute login to provisioning api" - } - ], - "args": [ - { - "name": "token", - "description": "Access token to revoke" } ] }, { "name": [ - "adyen_payment" + "webhooks:listen", + "wh:listen" ], - "description": "Execute an action on a resource of type adyen_payments", + "description": "Listen a webhook for outgoing callbacks", "options": [ { "name": [ @@ -1618,38 +1601,28 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" - }, - { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" - }, - { - "name": [ - "-u", - "--unformatted" + "-t", + "--time" ], - "description": "Print json output without indentation" + "description": "Waiting time for the first event", + "args": { + "default": "120" + } } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "adyen_payment:details" + "webhooks:payload", + "wh:payload" ], - "description": "Send this attribute if you want to send additional details the payment request.", + "description": "Show the payload associated to an event callback", "options": [ { "name": [ @@ -1677,38 +1650,25 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" - }, - { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" - }, - { - "name": [ - "-u", - "--unformatted" + "-f", + "--format" ], - "description": "Print json output without indentation" + "description": "Format the payload output" } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "authorization" + "webhooks:reset", + "wh:reset" ], - "description": "Execute an action on a resource of type authorizations", + "description": "Reset the circuit breaker associated to the webhook", "options": [ { "name": [ @@ -1733,41 +1693,28 @@ const completionSpec: Fig.Spec = { "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" + "description": "Unique id of the webhook" } ] }, { "name": [ - "authorization:capture" + "webhooks:topics", + "wh:topics" ], - "description": "Send this attribute if you want to create a capture for this authorization.", + "description": "Show online documentation for supported events" + }, + { + "name": [ + "webhooks:update", + "wh:update" + ], + "description": "Update an existing webhook", "options": [ { "name": [ @@ -1795,38 +1742,49 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-t", + "--topic" ], - "description": "Print out the modified resource" + "description": "The identifier of the event that will trigger the webhook", + "args": {} }, { "name": [ - "-j", - "--json" + "-u", + "--url" ], - "description": "Print result in json format" + "description": "The callback url used to post data", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-i", + "--include" ], - "description": "Print json output without indentation" + "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": "The unique id of the resource" + "description": "Unique id of the webhook" } ] }, { "name": [ - "authorization:capture_amount_cents" + "checkout" ], - "description": "The associated capture amount, in cents.", + "description": "Create checkout urls", "options": [ { "name": [ @@ -1847,104 +1805,79 @@ 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 + "hidden": false }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + "name": "--open", + "description": "Open checkout url in default browser" }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + "name": "--staging", + "description": "Connect to checkout application in staging environment", + "hidden": true }, { "name": [ - "-u", - "--unformatted" + "-O", + "--order" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "authorization:void" - ], - "description": "Send this attribute if you want to create a void for this authorization.", - "options": [ + "description": "An order id", + "args": {} + }, { "name": [ - "-o", - "--organization" + "-S", + "--sku" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "An sku code", + "args": {} }, { "name": [ - "-d", - "--domain" + "-B", + "--bundle" ], - "args": {}, - "hidden": true - }, - { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "description": "A bundle code", + "args": {} }, { "name": [ - "-p", - "--print" + "-m", + "--market" ], - "description": "Print out the modified resource" + "description": "A market number", + "args": {} }, { "name": [ - "-j", - "--json" + "-c", + "--coupon" ], - "description": "Print result in json format" + "description": "A promo code", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-e", + "--email" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" + "description": "A customer email", + "args": {} } ] }, { "name": [ - "axerve_payment" + "checkout:order" ], - "description": "Execute an action on a resource of type axerve_payments", + "description": "Create checkout urls starting from an existing order", "options": [ { "name": [ @@ -1964,105 +1897,56 @@ const completionSpec: Fig.Spec = { "args": {}, "hidden": true }, - { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - }, { "name": [ - "-p", - "--print" + "-a", + "--accessToken" ], - "description": "Print out the modified resource" + "description": "Custom access token to use instead of the one used for login", + "args": {}, + "isRequired": true, + "hidden": false }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + "name": "--open", + "description": "Open checkout url in default browser" }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" + "name": "--staging", + "description": "Connect to checkout application in staging environment", + "hidden": true } ], "args": [ { "name": "id", - "description": "The unique id of the resource" + "description": "Unique id of the order" } ] }, { "name": [ - "axerve_payment:update" + "resources" ], - "description": "Send this attribute if you want to update the payment with fresh order data.", + "description": "List all the available commerce layer api resources", "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" + "-h", + "--help" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" + "description": "Show cli help." } ] }, { "name": [ - "bundle" + "resources:all", + "all", + "ra", + "res:all" ], - "description": "Execute an action on a resource of type bundles", + "description": "Fetch all resources", "options": [ { "name": [ @@ -2090,215 +1974,262 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ "-j", "--json" ], - "description": "Print result in json format" + "description": "Convert output in standard json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "bundle:compute_compare_at_amount" - ], - "description": "Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle skus for the market.", - "options": [ + "description": "Print unformatted json output" + }, { "name": [ - "-o", - "--organization" + "-R", + "--raw" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Print out the raw api response", + "hidden": false + }, + { + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-d", - "--domain" + "-l", + "--lang" ], - "args": {}, - "hidden": true + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "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": [ - "-p", - "--print" + "-w", + "--where" ], - "description": "Print out the modified resource" + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ - "-j", - "--json" + "-s", + "--sort" ], - "description": "Print result in json format" + "description": "Defines results ordering", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-x", + "--save" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "Save command output to file", + "args": {} + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "bundle:compute_price_amount" - ], - "description": "Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle skus for the market.", - "options": [ + "name": [ + "-X", + "--save-path" + ], + "description": "Save command output to file and create missing path directories", + "args": {} + }, { "name": [ - "-o", - "--organization" + "-N", + "--notify" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, + "description": "Force system notification when export has finished", "hidden": true }, { "name": [ - "-d", - "--domain" + "-i", + "--clientId" ], + "description": "Organization client_id", "args": {}, "hidden": true }, { - "name": "--accessToken", + "name": [ + "-s", + "--clientSecret" + ], + "description": "Organization client_secret", "args": {}, - "isRequired": true, "hidden": true }, { "name": [ - "-p", - "--print" + "-C", + "--csv" ], - "description": "Print out the modified resource" + "description": "Export fields in csv format" }, { "name": [ - "-j", - "--json" + "-D", + "--delimiter" ], - "description": "Print result in json format" + "description": "The delimiter character to use in the csv output file (one of ',', ';', '|', tab)", + "args": { + "suggestions": [ + ",", + ";", + "|", + "TAB" + ] + } }, { "name": [ - "-u", - "--unformatted" + "-H", + "--header" ], - "description": "Print json output without indentation" + "description": "Rename column headers defining a comma-separated list of values field:\"renamed title\"", + "args": {} + }, + { + "name": [ + "-b", + "--blind" + ], + "description": "Execute in blind mode without prompt and progress bar" + }, + { + "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": "id", - "description": "The unique id of the resource" + "name": "resource", + "description": "The resource type" } ] }, { "name": [ - "buy_x_pay_y_promotion" + "resources:args", + "res:args" ], - "description": "Execute an action on a resource of type buy_x_pay_y_promotions", + "description": "Show all the saved command arguments", "options": [ { "name": [ - "-o", - "--organization" + "-a", + "--alias" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "The alias associated to saved command arguments", + "args": {} }, { "name": [ - "-d", - "--domain" + "-r", + "--resource" ], - "args": {}, - "hidden": true - }, - { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "description": "The resource type", + "args": {} }, { "name": [ - "-p", - "--print" + "-o", + "--operation" ], - "description": "Print out the modified resource" + "description": "The resource operation", + "args": { + "suggestions": [ + "list", + "retrieve", + "create", + "update" + ] + } }, { "name": [ - "-j", - "--json" + "-D", + "--delete" ], - "description": "Print result in json format" + "description": "Delete saved arguments associated to the alias" }, { "name": [ - "-u", - "--unformatted" + "-P", + "--pretty" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" + "description": "Show saved arguments in table format", + "hidden": true } ] }, { "name": [ - "buy_x_pay_y_promotion:disable" + "resources:count", + "count", + "res:count", + "rs:count" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Count the number of existent resources", "options": [ { "name": [ @@ -2326,38 +2257,29 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" - }, - { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" - }, - { - "name": [ - "-u", - "--unformatted" + "-w", + "--where" ], - "description": "Print json output without indentation" + "description": "Comma separated list of query filters", + "args": {} } ], "args": [ { - "name": "id", - "description": "The unique id of the resource" + "name": "resource", + "description": "The resource type" } ] }, { "name": [ - "buy_x_pay_y_promotion:enable" + "resources:create", + "create", + "rc", + "res:create", + "post" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Create a new resource", "options": [ { "name": [ @@ -2385,156 +2307,260 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ "-j", "--json" ], - "description": "Print result in json format" + "description": "Convert output in standard json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "capture" - ], - "description": "Execute an action on a resource of type captures", - "options": [ + "description": "Print unformatted json output" + }, { "name": [ - "-o", - "--organization" + "-R", + "--raw" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Print out the raw api response", + "hidden": false + }, + { + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-d", - "--domain" + "-l", + "--lang" ], - "args": {}, - "hidden": true + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "name": "--curl", + "description": "Show the equivalent curl command of the cli command", + "hidden": false }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + "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": [ - "-j", - "--json" + "-H", + "--headers" ], - "description": "Print result in json format" + "description": "Show response headers" }, { "name": [ - "-u", - "--unformatted" + "-Y", + "--headers-only" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "capture:refund" - ], - "description": "Send this attribute if you want to create a refund for this capture.", - "options": [ + "description": "Show only response headers" + }, { "name": [ - "-o", - "--organization" + "-a", + "--attribute" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Define a resource attribute", + "args": {} }, { "name": [ - "-d", - "--domain" + "-O", + "--object" ], - "args": {}, - "hidden": true + "description": "Define a resource object attribute", + "args": {} }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "name": [ + "-r", + "--relationship" + ], + "description": "Define a relationship with another resource", + "args": {} }, { "name": [ - "-p", - "--print" + "-m", + "--metadata" ], - "description": "Print out the modified resource" + "description": "Define a metadata attribute or a set of metadata attributes", + "args": {} }, { "name": [ - "-j", - "--json" + "-D", + "--data" ], - "description": "Print result in json format" + "description": "The data file to use as request body", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-t", + "--tags" ], - "description": "Print json output without indentation" + "description": "List of tags associated with the resource", + "args": {} } ], "args": [ { - "name": "id", - "description": "The unique id of the resource" + "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" + ] } ] }, { "name": [ - "capture:refund_amount_cents" + "resources:delete", + "delete", + "rd", + "res:delete" ], - "description": "The associated refund amount, in cents.", + "description": "Delete an existing resource", "options": [ { "name": [ @@ -2562,97 +2588,250 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ "-j", "--json" ], - "description": "Print result in json format" + "description": "Convert output in standard json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "checkout_com_payment" - ], - "description": "Execute an action on a resource of type checkout_com_payments", - "options": [ + "description": "Print unformatted json output" + }, { "name": [ - "-o", - "--organization" + "-R", + "--raw" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Print out the raw api response", + "hidden": false + }, + { + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-d", - "--domain" + "-l", + "--lang" ], - "args": {}, - "hidden": true + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "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": [ - "-p", - "--print" + "-H", + "--headers" ], - "description": "Print out the modified resource" + "description": "Show response headers" }, { "name": [ - "-j", - "--json" + "-Y", + "--headers-only" ], - "description": "Print result in json format" + "description": "Show only response headers" + } + ], + "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", + "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" + ] }, + { + "name": "id", + "description": "Id of the resource to delete", + "isOptional": true + } + ] + }, + { + "name": [ + "resources:doc", + "res:doc", + "doc" + ], + "description": "Open the default browser and show the online documentation for the resource", + "options": [ { "name": [ - "-u", - "--unformatted" + "-p", + "--page" ], - "description": "Print json output without indentation" + "description": "The doc page you want to access", + "args": { + "suggestions": [ + "object", + "create", + "retrieve", + "list", + "update", + "delete" + ] + } } ], "args": [ { - "name": "id", - "description": "The unique id of the resource" + "name": "resource", + "description": "The resource for which you want to access the online documentation" } ] }, { "name": [ - "checkout_com_payment:details" + "resources:fetch", + "fetch", + "res:fetch", + "rf" ], - "description": "Send this attribute if you want to send additional details the payment request (i.e. upon 3ds check).", + "description": "Retrieve a resource or list a set of resources", "options": [ { "name": [ @@ -2680,156 +2859,185 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ "-j", "--json" ], - "description": "Print result in json format" + "description": "Convert output in standard json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "checkout_com_payment:refresh" - ], - "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", - "options": [ + "description": "Print unformatted json output" + }, { "name": [ - "-o", - "--organization" + "-R", + "--raw" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Print out the raw api response", + "hidden": false + }, + { + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-d", - "--domain" + "-l", + "--lang" ], - "args": {}, - "hidden": true + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "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": [ - "-p", - "--print" + "-H", + "--headers" ], - "description": "Print out the modified resource" + "description": "Show response headers" }, { "name": [ - "-j", - "--json" + "-Y", + "--headers-only" ], - "description": "Print result in json format" + "description": "Show only response headers" }, { "name": [ - "-u", - "--unformatted" + "-x", + "--save" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "customer_password_reset" - ], - "description": "Execute an action on a resource of type customer_password_resets", - "options": [ + "description": "Save command output to file", + "args": {} + }, { "name": [ - "-o", - "--organization" + "-X", + "--save-path" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ - "-d", - "--domain" + "-e", + "--extract" ], - "args": {}, - "hidden": true + "description": "Extract subfields from object attributes", + "args": {} }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "name": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters", + "args": {} }, { "name": [ "-p", - "--print" + "--page" ], - "description": "Print out the modified resource" + "description": "Page number", + "args": {} }, { "name": [ - "-j", - "--json" + "-n", + "--pageSize" ], - "description": "Print result in json format" + "description": "Number of elements per page", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-s", + "--sort" ], - "description": "Print json output without indentation" + "description": "Defines results ordering", + "args": {} + }, + { + "name": [ + "-I", + "--force-include" + ], + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true } ], "args": [ + { + "name": "path", + "description": "Path (or url) of the resource(s) to fetch" + }, { "name": "id", - "description": "The unique id of the resource" + "description": "Resource id", + "isOptional": true } ] }, { "name": [ - "customer_password_reset:reset_password_token" + "resources:filters", + "res:filters" ], - "description": "Send the 'reset_password_token' that you got on create when updating the customer password.", + "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": [ @@ -2857,156 +3065,178 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ "-j", "--json" ], - "description": "Print result in json format" + "description": "Convert output in standard json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "external_promotion" - ], - "description": "Execute an action on a resource of type external_promotions", - "options": [ + "description": "Print unformatted json output" + }, { "name": [ - "-o", - "--organization" + "-R", + "--raw" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Print out the raw api response", + "hidden": false + }, + { + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-d", - "--domain" + "-l", + "--lang" ], - "args": {}, - "hidden": true + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "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": [ - "-p", - "--print" + "-H", + "--headers" ], - "description": "Print out the modified resource" + "description": "Show response headers" }, { "name": [ - "-j", - "--json" + "-Y", + "--headers-only" ], - "description": "Print result in json format" + "description": "Show only response headers" }, { "name": [ - "-u", - "--unformatted" + "-w", + "--where" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "Comma separated list of query filters", + "args": {} + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "external_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + "name": [ + "-p", + "--page" + ], + "description": "Page number", + "args": {} + }, { "name": [ - "-o", - "--organization" + "-n", + "--pageSize" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Number of elements per page", + "args": {} }, { "name": [ - "-d", - "--domain" + "-s", + "--sort" ], - "args": {}, - "hidden": true + "description": "Defines results ordering", + "args": {} }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file", + "args": {} }, { "name": [ - "-p", - "--print" + "-X", + "--save-path" ], - "description": "Print out the modified resource" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ - "-j", - "--json" + "-e", + "--extract" ], - "description": "Print result in json format" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-I", + "--force-include" ], - "description": "Print json output without indentation" + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true } ], "args": [ + { + "name": "resource", + "description": "The resource type" + }, { "name": "id", - "description": "The unique id of the resource" + "description": "Id of the resource to retrieve", + "isOptional": true } ] }, { "name": [ - "external_promotion:enable" + "resources:list", + "list", + "rl", + "res:list" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Fetch a collection of resources", "options": [ { "name": [ @@ -3034,156 +3264,299 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ "-j", "--json" ], - "description": "Print result in json format" + "description": "Convert output in standard json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "fixed_amount_promotion" - ], - "description": "Execute an action on a resource of type fixed_amount_promotions", - "options": [ + "description": "Print unformatted json output" + }, { "name": [ - "-o", - "--organization" + "-R", + "--raw" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Print out the raw api response", + "hidden": false + }, + { + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-d", - "--domain" + "-l", + "--lang" ], - "args": {}, - "hidden": true + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "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": [ - "-p", - "--print" + "-H", + "--headers" ], - "description": "Print out the modified resource" + "description": "Show response headers" }, { "name": [ - "-j", - "--json" + "-Y", + "--headers-only" ], - "description": "Print result in json format" + "description": "Show only response headers" }, { "name": [ - "-u", - "--unformatted" + "-w", + "--where" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "Comma separated list of query filters", + "args": {} + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "fixed_amount_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + "name": [ + "-p", + "--page" + ], + "description": "Page number", + "args": {} + }, { "name": [ - "-o", - "--organization" + "-n", + "--pageSize" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Number of elements per page", + "args": {} }, { "name": [ - "-d", - "--domain" + "-s", + "--sort" ], - "args": {}, - "hidden": true + "description": "Defines results ordering", + "args": {} }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file", + "args": {} }, { "name": [ - "-p", - "--print" + "-X", + "--save-path" ], - "description": "Print out the modified resource" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ - "-j", - "--json" + "-e", + "--extract" ], - "description": "Print result in json format" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-I", + "--force-include" ], - "description": "Print json output without indentation" + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true } ], "args": [ { - "name": "id", - "description": "The unique id of the resource" + "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": [ - "fixed_amount_promotion:enable" + "relationship", + "relationship", + "resources:rel", + "res:rel", + "res:relationship", + "relationship" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Fetch a resource relationship", "options": [ { "name": [ @@ -3211,156 +3584,182 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ "-j", "--json" ], - "description": "Print result in json format" + "description": "Convert output in standard json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "fixed_price_promotion" - ], - "description": "Execute an action on a resource of type fixed_price_promotions", - "options": [ + "description": "Print unformatted json output" + }, { "name": [ - "-o", - "--organization" + "-R", + "--raw" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Print out the raw api response", + "hidden": false + }, + { + "name": "--doc", + "description": "Show the cli command in a specific language" }, { "name": [ - "-d", - "--domain" + "-l", + "--lang" ], - "args": {}, - "hidden": true + "description": "Show the cli command in the specified language syntax", + "args": { + "suggestions": [ + "curl", + "node" + ] + } }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "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": [ - "-p", - "--print" + "-H", + "--headers" ], - "description": "Print out the modified resource" + "description": "Show response headers" }, { "name": [ - "-j", - "--json" + "-Y", + "--headers-only" ], - "description": "Print result in json format" + "description": "Show only response headers" }, { "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + "-w", + "--where" + ], + "description": "Comma separated list of query filters", + "args": {} + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "fixed_price_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + "name": [ + "-p", + "--page" + ], + "description": "Page number", + "args": {} + }, { "name": [ - "-o", - "--organization" + "-n", + "--pageSize" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "description": "Number of elements per page", + "args": {} }, { "name": [ - "-d", - "--domain" + "-s", + "--sort" ], - "args": {}, - "hidden": true + "description": "Defines results ordering", + "args": {} }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "name": [ + "-x", + "--save" + ], + "description": "Save command output to file", + "args": {} }, { "name": [ - "-p", - "--print" + "-X", + "--save-path" ], - "description": "Print out the modified resource" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ - "-j", - "--json" + "-e", + "--extract" ], - "description": "Print result in json format" + "description": "Extract subfields from object attributes", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-I", + "--force-include" ], - "description": "Print json output without indentation" + "description": "Force resources inclusion beyound the 3rd level", + "hidden": true } ], "args": [ + { + "name": "resource", + "description": "The resource type" + }, { "name": "id", - "description": "The unique id of the resource" + "description": "Id of the resource to retrieve" + }, + { + "name": "relationship", + "description": "Name of the relationship field" } - ] + ], + "hidden": false }, { "name": [ - "fixed_price_promotion:enable" + "resources:retrieve", + "retrieve", + "rr", + "res:retrieve" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Fetch a single resource", "options": [ { "name": [ @@ -3388,97 +3787,274 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} + }, + { + "name": [ + "-f", + "--fields" + ], + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ "-j", "--json" ], - "description": "Print result in json format" + "description": "Convert output in standard json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print json output without indentation" - } - ], - "args": [ + "description": "Print unformatted json output" + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "free_gift_promotion" - ], - "description": "Execute an action on a resource of type free_gift_promotions", - "options": [ + "name": [ + "-R", + "--raw" + ], + "description": "Print out the raw api response", + "hidden": false + }, + { + "name": "--doc", + "description": "Show the cli command in a specific language" + }, { "name": [ - "-o", - "--organization" + "-l", + "--lang" ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + "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": [ - "-d", - "--domain" + "-H", + "--headers" ], - "args": {}, - "hidden": true + "description": "Show response headers" }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + "name": [ + "-Y", + "--headers-only" + ], + "description": "Show only response headers" }, { "name": [ - "-p", - "--print" + "-x", + "--save" ], - "description": "Print out the modified resource" + "description": "Save command output to file", + "args": {} }, { "name": [ - "-j", - "--json" + "-X", + "--save-path" ], - "description": "Print result in json format" + "description": "Save command output to file and create missing path directories", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-e", + "--extract" ], - "description": "Print json output without indentation" + "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", + "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": "The unique id of the resource" + "description": "Id of the resource to retrieve", + "isOptional": true } ] }, { "name": [ - "free_gift_promotion:disable" + "resources:schema", + "schema", + "res:schema", + "rs" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Show the current commercelayer openapi schema version used by the plugin" + }, + { + "name": [ + "resources:update", + "update", + "ru", + "res:update", + "patch" + ], + "description": "Update an existing resource", "options": [ { "name": [ @@ -3506,38 +4082,269 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-p", - "--print" + "-i", + "--include" ], - "description": "Print out the modified resource" + "description": "Comma separated resources to include", + "args": {} }, { "name": [ - "-j", - "--json" + "-f", + "--fields" ], - "description": "Print result in json format" + "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-j", + "--json" ], - "description": "Print json output without indentation" + "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": [ + "-a", + "--attribute" + ], + "description": "Define a resource attribute", + "args": {} + }, + { + "name": [ + "-O", + "--object" + ], + "description": "Define a resource object attribute", + "args": {} + }, + { + "name": [ + "-r", + "--relationship" + ], + "description": "Define a relationship with another resource", + "args": {} + }, + { + "name": [ + "-m", + "--metadata" + ], + "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource", + "args": {} + }, + { + "name": [ + "-M", + "--metadata-replace" + ], + "description": "Define a metadata attribute and replace every item already present in the remote resource", + "args": {} + }, + { + "name": [ + "-D", + "--data" + ], + "description": "The data file to use as request body", + "args": {} + }, + { + "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", + "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": "id", - "description": "The unique id of the resource" + "description": "Id of the resource to update", + "isOptional": true } ] }, { "name": [ - "free_gift_promotion:enable" + "adyen_payment" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Execute an action on a resource of type adyen_payments", "options": [ { "name": [ @@ -3594,9 +4401,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_shipping_promotion" + "adyen_payment:details" ], - "description": "Execute an action on a resource of type free_shipping_promotions", + "description": "Send this attribute if you want to send additional details the payment request.", "options": [ { "name": [ @@ -3653,9 +4460,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_shipping_promotion:disable" + "authorization" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Execute an action on a resource of type authorizations", "options": [ { "name": [ @@ -3712,9 +4519,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "free_shipping_promotion:enable" + "authorization:capture" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute if you want to create a capture for this authorization.", "options": [ { "name": [ @@ -3771,9 +4578,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card" + "authorization:capture_amount_cents" ], - "description": "Execute an action on a resource of type gift_cards", + "description": "The associated capture amount, in cents.", "options": [ { "name": [ @@ -3830,9 +4637,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card:activate" + "authorization:void" ], - "description": "Send this attribute if you want to activate a gift card.", + "description": "Send this attribute if you want to create a void for this authorization.", "options": [ { "name": [ @@ -3889,9 +4696,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card:balance_change_cents" + "axerve_payment" ], - "description": "The balance change, in cents. send a negative value to reduces the card balance by the specified amount. send a positive value to recharge the gift card (if rechargeable).", + "description": "Execute an action on a resource of type axerve_payments", "options": [ { "name": [ @@ -3948,9 +4755,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card:deactivate" + "axerve_payment:update" ], - "description": "Send this attribute if you want to deactivate a gift card.", + "description": "Send this attribute if you want to update the payment with fresh order data.", "options": [ { "name": [ @@ -4007,9 +4814,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "gift_card:purchase" + "bundle" ], - "description": "Send this attribute if you want to confirm a draft gift card. the gift card becomes 'inactive', waiting to be activated.", + "description": "Execute an action on a resource of type bundles", "options": [ { "name": [ @@ -4066,9 +4873,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "in_stock_subscription" + "bundle:compute_compare_at_amount" ], - "description": "Execute an action on a resource of type in_stock_subscriptions", + "description": "Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle skus for the market.", "options": [ { "name": [ @@ -4125,9 +4932,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "in_stock_subscription:activate" + "bundle:compute_price_amount" ], - "description": "Send this attribute if you want to activate an inactive subscription.", + "description": "Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle skus for the market.", "options": [ { "name": [ @@ -4184,9 +4991,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "in_stock_subscription:deactivate" + "buy_x_pay_y_promotion" ], - "description": "Send this attribute if you want to dactivate an active subscription.", + "description": "Execute an action on a resource of type buy_x_pay_y_promotions", "options": [ { "name": [ @@ -4243,9 +5050,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "klarna_payment" + "buy_x_pay_y_promotion:disable" ], - "description": "Execute an action on a resource of type klarna_payments", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -4302,9 +5109,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "klarna_payment:update" + "buy_x_pay_y_promotion:enable" ], - "description": "Send this attribute if you want to update the payment session with fresh order data.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -4361,9 +5168,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "line_item" + "capture" ], - "description": "Execute an action on a resource of type line_items", + "description": "Execute an action on a resource of type captures", "options": [ { "name": [ @@ -4420,9 +5227,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "line_item:external_price" + "capture:refund" ], - "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. any successive price computation will be done externally, until the attribute is reset to '0'.", + "description": "Send this attribute if you want to create a refund for this capture.", "options": [ { "name": [ @@ -4479,9 +5286,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "line_item:reserve_stock" + "capture:refund_amount_cents" ], - "description": "Send this attribute if you want to reserve the stock for the line item's skus quantity. stock reservations expiration depends on the inventory model's cutoff. when used on update the existing active stock reservations are renewed.", + "description": "The associated refund amount, in cents.", "options": [ { "name": [ @@ -4538,9 +5345,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "market" + "checkout_com_payment" ], - "description": "Execute an action on a resource of type markets", + "description": "Execute an action on a resource of type checkout_com_payments", "options": [ { "name": [ @@ -4597,9 +5404,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "market:disable" + "checkout_com_payment:details" ], - "description": "Send this attribute if you want to mark the market as disabled.", + "description": "Send this attribute if you want to send additional details the payment request (i.e. upon 3ds check).", "options": [ { "name": [ @@ -4656,9 +5463,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "market:enable" + "checkout_com_payment:refresh" ], - "description": "Send this attribute if you want to mark the market as enabled.", + "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", "options": [ { "name": [ @@ -4715,9 +5522,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order" + "customer_password_reset" ], - "description": "Execute an action on a resource of type orders", + "description": "Execute an action on a resource of type customer_password_resets", "options": [ { "name": [ @@ -4774,9 +5581,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order_subscription" + "customer_password_reset:reset_password_token" ], - "description": "Execute an action on a resource of type order_subscriptions", + "description": "Send the 'reset_password_token' that you got on create when updating the customer password.", "options": [ { "name": [ @@ -4833,9 +5640,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order_subscription:activate" + "external_promotion" ], - "description": "Send this attribute if you want to mark this subscription as active.", + "description": "Execute an action on a resource of type external_promotions", "options": [ { "name": [ @@ -4892,9 +5699,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order_subscription:cancel" + "external_promotion:disable" ], - "description": "Send this attribute if you want to mark this subscription as cancelled.", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -4951,9 +5758,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order_subscription:deactivate" + "external_promotion:enable" ], - "description": "Send this attribute if you want to mark this subscription as inactive.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -5010,9 +5817,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:approve" + "fixed_amount_promotion" ], - "description": "Send this attribute if you want to approve a placed order.", + "description": "Execute an action on a resource of type fixed_amount_promotions", "options": [ { "name": [ @@ -5069,9 +5876,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:approve_and_capture" + "fixed_amount_promotion:disable" ], - "description": "Send this attribute if you want to approve and capture a placed order.", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -5128,9 +5935,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:archive" + "fixed_amount_promotion:enable" ], - "description": "Send this attribute if you want to archive the order.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -5187,9 +5994,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:authorization_amount_cents" + "fixed_price_promotion" ], - "description": "The authorization amount, in cents.", + "description": "Execute an action on a resource of type fixed_price_promotions", "options": [ { "name": [ @@ -5246,9 +6053,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:authorize" + "fixed_price_promotion:disable" ], - "description": "Send this attribute if you want to authorize the order's payment source.", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -5305,9 +6112,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:billing_address_clone_id" + "fixed_price_promotion:enable" ], - "description": "The id of the address that you want to clone to create the order's billing address.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -5353,15 +6160,6 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true } ], "args": [ @@ -5373,9 +6171,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:billing_address_same_as_shipping" + "free_gift_promotion" ], - "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", + "description": "Execute an action on a resource of type free_gift_promotions", "options": [ { "name": [ @@ -5432,9 +6230,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:cancel" + "free_gift_promotion:disable" ], - "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -5491,9 +6289,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:capture" + "free_gift_promotion:enable" ], - "description": "Send this attribute if you want to capture an authorized order.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -5550,9 +6348,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:commit_invoice" + "free_shipping_promotion" ], - "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "description": "Execute an action on a resource of type free_shipping_promotions", "options": [ { "name": [ @@ -5609,9 +6407,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:create_subscriptions" + "free_shipping_promotion:disable" ], - "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -5668,9 +6466,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:customer_payment_source_id" + "free_shipping_promotion:enable" ], - "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -5716,15 +6514,6 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true } ], "args": [ @@ -5736,9 +6525,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:nullify_payment_source" + "gift_card" ], - "description": "Send this attribute if you want to nullify the payment source for this order.", + "description": "Execute an action on a resource of type gift_cards", "options": [ { "name": [ @@ -5795,9 +6584,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:place" + "gift_card:activate" ], - "description": "Send this attribute if you want to place the order.", + "description": "Send this attribute if you want to activate a gift card.", "options": [ { "name": [ @@ -5854,9 +6643,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:refresh" + "gift_card:balance_change_cents" ], - "description": "Send this attribute if you want to manually refresh the order.", + "description": "The balance change, in cents. send a negative value to reduces the card balance by the specified amount. send a positive value to recharge the gift card (if rechargeable).", "options": [ { "name": [ @@ -5913,9 +6702,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:refund" + "gift_card:deactivate" ], - "description": "Send this attribute if you want to refund a captured order.", + "description": "Send this attribute if you want to deactivate a gift card.", "options": [ { "name": [ @@ -5972,9 +6761,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:refund_invoice" + "gift_card:purchase" ], - "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "description": "Send this attribute if you want to confirm a draft gift card. the gift card becomes 'inactive', waiting to be activated.", "options": [ { "name": [ @@ -6031,9 +6820,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:save_billing_address_to_customer_address_book" + "in_stock_subscription" ], - "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", + "description": "Execute an action on a resource of type in_stock_subscriptions", "options": [ { "name": [ @@ -6090,9 +6879,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:save_payment_source_to_customer_wallet" + "in_stock_subscription:activate" ], - "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", + "description": "Send this attribute if you want to activate an inactive subscription.", "options": [ { "name": [ @@ -6149,9 +6938,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:save_shipping_address_to_customer_address_book" + "in_stock_subscription:deactivate" ], - "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", + "description": "Send this attribute if you want to dactivate an active subscription.", "options": [ { "name": [ @@ -6208,9 +6997,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:shipping_address_clone_id" + "klarna_payment" ], - "description": "The id of the address that you want to clone to create the order's shipping address.", + "description": "Execute an action on a resource of type klarna_payments", "options": [ { "name": [ @@ -6256,15 +7045,6 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true } ], "args": [ @@ -6276,9 +7056,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:shipping_address_same_as_billing" + "klarna_payment:update" ], - "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", + "description": "Send this attribute if you want to update the payment session with fresh order data.", "options": [ { "name": [ @@ -6335,9 +7115,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:start_editing" + "line_item" ], - "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", + "description": "Execute an action on a resource of type line_items", "options": [ { "name": [ @@ -6394,9 +7174,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:stop_editing" + "line_item:external_price" ], - "description": "Send this attribute to stop the editing for the order and return back to placed status.", + "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. any successive price computation will be done externally, until the attribute is reset to '0'.", "options": [ { "name": [ @@ -6453,9 +7233,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:unarchive" + "line_item:reserve_stock" ], - "description": "Send this attribute if you want to unarchive the order.", + "description": "Send this attribute if you want to reserve the stock for the line item's skus quantity. stock reservations expiration depends on the inventory model's cutoff. when used on update the existing active stock reservations are renewed.", "options": [ { "name": [ @@ -6512,9 +7292,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:update_taxes" + "market" ], - "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", + "description": "Execute an action on a resource of type markets", "options": [ { "name": [ @@ -6571,9 +7351,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "order:validate" + "market:disable" ], - "description": "Send this attribute if you want to trigger the external validation for the order.", + "description": "Send this attribute if you want to mark the market as disabled.", "options": [ { "name": [ @@ -6630,9 +7410,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "payment_method" + "market:enable" ], - "description": "Execute an action on a resource of type payment_methods", + "description": "Send this attribute if you want to mark the market as enabled.", "options": [ { "name": [ @@ -6689,9 +7469,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "payment_method:disable" + "order" ], - "description": "Send this attribute if you want to mark the payment method as disabled.", + "description": "Execute an action on a resource of type orders", "options": [ { "name": [ @@ -6748,9 +7528,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "payment_method:enable" + "order_subscription" ], - "description": "Send this attribute if you want to mark the payment method as enabled.", + "description": "Execute an action on a resource of type order_subscriptions", "options": [ { "name": [ @@ -6807,9 +7587,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "percentage_discount_promotion" + "order_subscription:activate" ], - "description": "Execute an action on a resource of type percentage_discount_promotions", + "description": "Send this attribute if you want to mark this subscription as active.", "options": [ { "name": [ @@ -6866,9 +7646,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "percentage_discount_promotion:disable" + "order_subscription:cancel" ], - "description": "Send this attribute if you want to mark the promotion as disabled.", + "description": "Send this attribute if you want to mark this subscription as cancelled.", "options": [ { "name": [ @@ -6925,9 +7705,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "percentage_discount_promotion:enable" + "order_subscription:deactivate" ], - "description": "Send this attribute if you want to mark the promotion as enabled.", + "description": "Send this attribute if you want to mark this subscription as inactive.", "options": [ { "name": [ @@ -6984,9 +7764,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return" + "order:approve" ], - "description": "Execute an action on a resource of type returns", + "description": "Send this attribute if you want to approve a placed order.", "options": [ { "name": [ @@ -7043,9 +7823,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return_line_item" + "order:approve_and_capture" ], - "description": "Execute an action on a resource of type return_line_items", + "description": "Send this attribute if you want to approve and capture a placed order.", "options": [ { "name": [ @@ -7102,9 +7882,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return_line_item:restock" + "order:archive" ], - "description": "Send this attribute if you want to restock the line item.", + "description": "Send this attribute if you want to archive the order.", "options": [ { "name": [ @@ -7161,9 +7941,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:approve" + "order:authorization_amount_cents" ], - "description": "Send this attribute if you want to mark this return as approved.", + "description": "The authorization amount, in cents.", "options": [ { "name": [ @@ -7220,9 +8000,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:archive" + "order:authorize" ], - "description": "Send this attribute if you want to archive the return.", + "description": "Send this attribute if you want to authorize the order's payment source.", "options": [ { "name": [ @@ -7279,9 +8059,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:cancel" + "order:billing_address_clone_id" ], - "description": "Send this attribute if you want to mark this return as cancelled.", + "description": "The id of the address that you want to clone to create the order's billing address.", "options": [ { "name": [ @@ -7327,6 +8107,15 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ @@ -7338,9 +8127,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:receive" + "order:billing_address_same_as_shipping" ], - "description": "Send this attribute if you want to mark this return as received.", + "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", "options": [ { "name": [ @@ -7397,9 +8186,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:reject" + "order:cancel" ], - "description": "Send this attribute if you want to mark this return as rejected.", + "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", "options": [ { "name": [ @@ -7456,9 +8245,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:request" + "order:capture" ], - "description": "Send this attribute if you want to activate this return.", + "description": "Send this attribute if you want to capture an authorized order.", "options": [ { "name": [ @@ -7515,9 +8304,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:restock" + "order:commit_invoice" ], - "description": "Send this attribute if you want to restock all of the return line items.", + "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", "options": [ { "name": [ @@ -7574,9 +8363,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:ship" + "order:create_subscriptions" ], - "description": "Send this attribute if you want to mark this return as shipped.", + "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", "options": [ { "name": [ @@ -7633,9 +8422,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "return:unarchive" + "order:customer_payment_source_id" ], - "description": "Send this attribute if you want to unarchive the return.", + "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", "options": [ { "name": [ @@ -7681,6 +8470,15 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ @@ -7692,9 +8490,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "satispay_payment" + "order:nullify_payment_source" ], - "description": "Execute an action on a resource of type satispay_payments", + "description": "Send this attribute if you want to nullify the payment source for this order.", "options": [ { "name": [ @@ -7751,9 +8549,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "satispay_payment:refresh" + "order:place" ], - "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", + "description": "Send this attribute if you want to place the order.", "options": [ { "name": [ @@ -7810,9 +8608,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment" + "order:refresh" ], - "description": "Execute an action on a resource of type shipments", + "description": "Send this attribute if you want to manually refresh the order.", "options": [ { "name": [ @@ -7869,9 +8667,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:decrement_stock" + "order:refund" ], - "description": "Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want to refund a captured order.", "options": [ { "name": [ @@ -7928,9 +8726,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:get_rates" + "order:refund_invoice" ], - "description": "Send this attribute if you want get the shipping rates from the associated carrier accounts.", + "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", "options": [ { "name": [ @@ -7987,9 +8785,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:on_hold" + "order:save_billing_address_to_customer_address_book" ], - "description": "Send this attribute if you want to put this shipment on hold.", + "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", "options": [ { "name": [ @@ -8046,9 +8844,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:packing" + "order:save_payment_source_to_customer_wallet" ], - "description": "Send this attribute if you want to start packing this shipment.", + "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", "options": [ { "name": [ @@ -8105,9 +8903,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:picking" + "order:save_shipping_address_to_customer_address_book" ], - "description": "Send this attribute if you want to start picking this shipment.", + "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", "options": [ { "name": [ @@ -8164,9 +8962,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:purchase" + "order:shipping_address_clone_id" ], - "description": "Send this attribute if you want to purchase this shipment with the selected rate.", + "description": "The id of the address that you want to clone to create the order's shipping address.", "options": [ { "name": [ @@ -8212,6 +9010,15 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" + }, + { + "name": [ + "-v", + "--value" + ], + "description": "The trigger attribute value", + "args": {}, + "isRequired": true } ], "args": [ @@ -8223,9 +9030,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:ready_to_ship" + "order:shipping_address_same_as_billing" ], - "description": "Send this attribute if you want to mark this shipment as ready to ship.", + "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", "options": [ { "name": [ @@ -8282,9 +9089,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:release_stock" + "order:start_editing" ], - "description": "Send this attribute if you want to automatically release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", "options": [ { "name": [ @@ -8341,9 +9148,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:reserve_stock" + "order:stop_editing" ], - "description": "Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute to stop the editing for the order and return back to placed status.", "options": [ { "name": [ @@ -8400,9 +9207,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:ship" + "order:unarchive" ], - "description": "Send this attribute if you want to mark this shipment as shipped.", + "description": "Send this attribute if you want to unarchive the order.", "options": [ { "name": [ @@ -8459,9 +9266,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipment:upcoming" + "order:update_taxes" ], - "description": "Send this attribute if you want to mark this shipment as upcoming.", + "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", "options": [ { "name": [ @@ -8518,9 +9325,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipping_method" + "order:validate" ], - "description": "Execute an action on a resource of type shipping_methods", + "description": "Send this attribute if you want to trigger the external validation for the order.", "options": [ { "name": [ @@ -8577,9 +9384,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipping_method:disable" + "payment_method" ], - "description": "Send this attribute if you want to mark the shipping method as disabled.", + "description": "Execute an action on a resource of type payment_methods", "options": [ { "name": [ @@ -8636,9 +9443,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "shipping_method:enable" + "payment_method:disable" ], - "description": "Send this attribute if you want to mark the shipping method as enabled.", + "description": "Send this attribute if you want to mark the payment method as disabled.", "options": [ { "name": [ @@ -8695,9 +9502,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_line_item" + "payment_method:enable" ], - "description": "Execute an action on a resource of type stock_line_items", + "description": "Send this attribute if you want to mark the payment method as enabled.", "options": [ { "name": [ @@ -8754,9 +9561,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_line_item:decrement_stock" + "percentage_discount_promotion" ], - "description": "Send this attribute if you want to automatically decrement and release the stock this stock line item. can be done only when fulfillment is in progress.", + "description": "Execute an action on a resource of type percentage_discount_promotions", "options": [ { "name": [ @@ -8813,9 +9620,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_line_item:release_stock" + "percentage_discount_promotion:disable" ], - "description": "Send this attribute if you want to automatically release the stock for this stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want to mark the promotion as disabled.", "options": [ { "name": [ @@ -8872,9 +9679,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_line_item:reserve_stock" + "percentage_discount_promotion:enable" ], - "description": "Send this attribute if you want to automatically reserve the stock for this stock line item. can be done only when fulfillment is in progress.", + "description": "Send this attribute if you want to mark the promotion as enabled.", "options": [ { "name": [ @@ -8931,9 +9738,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_reservation" + "return" ], - "description": "Execute an action on a resource of type stock_reservations", + "description": "Execute an action on a resource of type returns", "options": [ { "name": [ @@ -8990,9 +9797,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_reservation:pending" + "return_line_item" ], - "description": "Send this attribute if you want to mark this stock reservation as pending.", + "description": "Execute an action on a resource of type return_line_items", "options": [ { "name": [ @@ -9049,9 +9856,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_transfer" + "return_line_item:restock" ], - "description": "Execute an action on a resource of type stock_transfers", + "description": "Send this attribute if you want to restock the line item.", "options": [ { "name": [ @@ -9108,9 +9915,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_transfer:cancel" + "return:approve" ], - "description": "Send this attribute if you want to cancel this stock transfer.", + "description": "Send this attribute if you want to mark this return as approved.", "options": [ { "name": [ @@ -9167,9 +9974,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_transfer:complete" + "return:archive" ], - "description": "Send this attribute if you want to complete this stock transfer.", + "description": "Send this attribute if you want to archive the return.", "options": [ { "name": [ @@ -9226,9 +10033,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_transfer:in_transit" + "return:cancel" ], - "description": "Send this attribute if you want to mark this stock transfer as in transit.", + "description": "Send this attribute if you want to mark this return as cancelled.", "options": [ { "name": [ @@ -9285,9 +10092,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_transfer:on_hold" + "return:receive" ], - "description": "Send this attribute if you want to put this stock transfer on hold.", + "description": "Send this attribute if you want to mark this return as received.", "options": [ { "name": [ @@ -9344,9 +10151,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_transfer:picking" + "return:reject" ], - "description": "Send this attribute if you want to start picking this stock transfer.", + "description": "Send this attribute if you want to mark this return as rejected.", "options": [ { "name": [ @@ -9403,9 +10210,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stock_transfer:upcoming" + "return:request" ], - "description": "Send this attribute if you want to mark this stock transfer as upcoming.", + "description": "Send this attribute if you want to activate this return.", "options": [ { "name": [ @@ -9462,9 +10269,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stripe_payment" + "return:restock" ], - "description": "Execute an action on a resource of type stripe_payments", + "description": "Send this attribute if you want to restock all of the return line items.", "options": [ { "name": [ @@ -9521,9 +10328,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stripe_payment:refresh" + "return:ship" ], - "description": "Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.", + "description": "Send this attribute if you want to mark this return as shipped.", "options": [ { "name": [ @@ -9580,9 +10387,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "stripe_payment:update" + "return:unarchive" ], - "description": "Send this attribute if you want to update the created payment intent with fresh order data.", + "description": "Send this attribute if you want to unarchive the return.", "options": [ { "name": [ @@ -9639,9 +10446,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "webhook" + "satispay_payment" ], - "description": "Execute an action on a resource of type webhooks", + "description": "Execute an action on a resource of type satispay_payments", "options": [ { "name": [ @@ -9698,9 +10505,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "webhook:disable" + "satispay_payment:refresh" ], - "description": "Send this attribute if you want to mark the webhook as disabled.", + "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", "options": [ { "name": [ @@ -9757,9 +10564,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "webhook:enable" + "shipment" ], - "description": "Send this attribute if you want to mark the webhook as enabled.", + "description": "Execute an action on a resource of type shipments", "options": [ { "name": [ @@ -9816,9 +10623,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "webhook:reset_circuit" + "shipment:decrement_stock" ], - "description": "Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.", + "description": "Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -9875,9 +10682,9 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "orders" + "shipment:get_rates" ], - "description": "Execute an action on an order", + "description": "Send this attribute if you want get the shipping rates from the associated carrier accounts.", "options": [ { "name": [ @@ -9908,7 +10715,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -9928,15 +10735,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:approve" + "shipment:on_hold" ], - "description": "Send this attribute if you want to approve a placed order.", + "description": "Send this attribute if you want to put this shipment on hold.", "options": [ { "name": [ @@ -9967,7 +10774,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -9987,15 +10794,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:approve_and_capture" + "shipment:packing" ], - "description": "Send this attribute if you want to approve and capture a placed order.", + "description": "Send this attribute if you want to start packing this shipment.", "options": [ { "name": [ @@ -10026,7 +10833,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10046,15 +10853,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:archive" + "shipment:picking" ], - "description": "Send this attribute if you want to archive the order.", + "description": "Send this attribute if you want to start picking this shipment.", "options": [ { "name": [ @@ -10085,7 +10892,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10105,15 +10912,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:authorization_amount_cents" + "shipment:purchase" ], - "description": "The authorization amount, in cents.", + "description": "Send this attribute if you want to purchase this shipment with the selected rate.", "options": [ { "name": [ @@ -10144,7 +10951,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10164,15 +10971,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:authorize" + "shipment:ready_to_ship" ], - "description": "Send this attribute if you want to authorize the order's payment source.", + "description": "Send this attribute if you want to mark this shipment as ready to ship.", "options": [ { "name": [ @@ -10203,7 +11010,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10223,15 +11030,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:billing_address_clone_id" + "shipment:release_stock" ], - "description": "The id of the address that you want to clone to create the order's billing address.", + "description": "Send this attribute if you want to automatically release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -10262,7 +11069,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10277,29 +11084,20 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:billing_address_same_as_shipping" + "shipment:reserve_stock" ], - "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", + "description": "Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -10330,7 +11128,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10350,15 +11148,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:cancel" + "shipment:ship" ], - "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", + "description": "Send this attribute if you want to mark this shipment as shipped.", "options": [ { "name": [ @@ -10389,7 +11187,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10409,15 +11207,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:capture" + "shipment:upcoming" ], - "description": "Send this attribute if you want to capture an authorized order.", + "description": "Send this attribute if you want to mark this shipment as upcoming.", "options": [ { "name": [ @@ -10448,7 +11246,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10468,15 +11266,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:commit_invoice" + "shipping_method" ], - "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "description": "Execute an action on a resource of type shipping_methods", "options": [ { "name": [ @@ -10507,7 +11305,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10527,15 +11325,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:create_subscriptions" + "shipping_method:disable" ], - "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", + "description": "Send this attribute if you want to mark the shipping method as disabled.", "options": [ { "name": [ @@ -10566,7 +11364,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10586,15 +11384,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:customer_payment_source_id" + "shipping_method:enable" ], - "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", + "description": "Send this attribute if you want to mark the shipping method as enabled.", "options": [ { "name": [ @@ -10625,7 +11423,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10640,29 +11438,20 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:nullify_payment_source" + "stock_line_item" ], - "description": "Send this attribute if you want to nullify the payment source for this order.", + "description": "Execute an action on a resource of type stock_line_items", "options": [ { "name": [ @@ -10693,7 +11482,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10713,15 +11502,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:place" + "stock_line_item:decrement_stock" ], - "description": "Send this attribute if you want to place the order.", + "description": "Send this attribute if you want to automatically decrement and release the stock this stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -10752,7 +11541,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10772,15 +11561,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:refresh" + "stock_line_item:release_stock" ], - "description": "Send this attribute if you want to manually refresh the order.", + "description": "Send this attribute if you want to automatically release the stock for this stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -10811,7 +11600,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10831,15 +11620,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:refund" + "stock_line_item:reserve_stock" ], - "description": "Send this attribute if you want to refund a captured order.", + "description": "Send this attribute if you want to automatically reserve the stock for this stock line item. can be done only when fulfillment is in progress.", "options": [ { "name": [ @@ -10870,7 +11659,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10890,15 +11679,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:refund_invoice" + "stock_reservation" ], - "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "description": "Execute an action on a resource of type stock_reservations", "options": [ { "name": [ @@ -10929,7 +11718,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -10949,15 +11738,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:save_billing_address_to_customer_address_book" + "stock_reservation:pending" ], - "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", + "description": "Send this attribute if you want to mark this stock reservation as pending.", "options": [ { "name": [ @@ -10988,7 +11777,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11008,15 +11797,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:save_payment_source_to_customer_wallet" + "stock_transfer" ], - "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", + "description": "Execute an action on a resource of type stock_transfers", "options": [ { "name": [ @@ -11047,7 +11836,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11067,15 +11856,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:save_shipping_address_to_customer_address_book" + "stock_transfer:cancel" ], - "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", + "description": "Send this attribute if you want to cancel this stock transfer.", "options": [ { "name": [ @@ -11106,7 +11895,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11126,15 +11915,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:shipping_address_clone_id" + "stock_transfer:complete" ], - "description": "The id of the address that you want to clone to create the order's shipping address.", + "description": "Send this attribute if you want to complete this stock transfer.", "options": [ { "name": [ @@ -11165,7 +11954,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11180,29 +11969,20 @@ const completionSpec: Fig.Spec = { "--unformatted" ], "description": "Print json output without indentation" - }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true } ], "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:shipping_address_same_as_billing" + "stock_transfer:in_transit" ], - "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", + "description": "Send this attribute if you want to mark this stock transfer as in transit.", "options": [ { "name": [ @@ -11233,7 +12013,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11253,15 +12033,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:start_editing" + "stock_transfer:on_hold" ], - "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", + "description": "Send this attribute if you want to put this stock transfer on hold.", "options": [ { "name": [ @@ -11292,7 +12072,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11312,15 +12092,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:stop_editing" + "stock_transfer:picking" ], - "description": "Send this attribute to stop the editing for the order and return back to placed status.", + "description": "Send this attribute if you want to start picking this stock transfer.", "options": [ { "name": [ @@ -11351,7 +12131,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11371,15 +12151,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:unarchive" + "stock_transfer:upcoming" ], - "description": "Send this attribute if you want to unarchive the order.", + "description": "Send this attribute if you want to mark this stock transfer as upcoming.", "options": [ { "name": [ @@ -11410,7 +12190,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11430,15 +12210,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:update_taxes" + "stripe_payment" ], - "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", + "description": "Execute an action on a resource of type stripe_payments", "options": [ { "name": [ @@ -11469,7 +12249,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11489,15 +12269,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "orders:validate" + "stripe_payment:refresh" ], - "description": "Send this attribute if you want to trigger the external validation for the order.", + "description": "Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.", "options": [ { "name": [ @@ -11528,7 +12308,7 @@ const completionSpec: Fig.Spec = { "-p", "--print" ], - "description": "Print out the modified order" + "description": "Print out the modified resource" }, { "name": [ @@ -11548,15 +12328,15 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "id", - "description": "The unique id of the order" + "description": "The unique id of the resource" } ] }, { "name": [ - "webhooks" + "stripe_payment:update" ], - "description": "List all the registered webhooks or the details of a single webhook", + "description": "Send this attribute if you want to update the created payment intent with fresh order data.", "options": [ { "name": [ @@ -11584,54 +12364,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-c", - "--circuit" - ], - "description": "Show only webhooks with circuit in the declared state", - "args": { - "suggestions": [ - "open", - "closed" - ] - } - }, - { - "name": [ - "-t", - "--topic" + "-p", + "--print" ], - "description": "The event that triggered the webhook", - "args": {} + "description": "Print out the modified resource" }, { "name": [ - "-H", - "--hide-empty" + "-j", + "--json" ], - "description": "Hide empty attributes" + "description": "Print result in json format" }, { "name": [ - "-e", - "--events" + "-u", + "--unformatted" ], - "description": "Show the last event callbacks associated to the webhook" + "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" + "webhook" ], - "description": "Create a new webhook", + "description": "Execute an action on a resource of type webhooks", "options": [ { "name": [ @@ -11659,48 +12423,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-t", - "--topic" + "-p", + "--print" ], - "description": "The identifier of the event that will trigger the webhook", - "args": {}, - "isRequired": true + "description": "Print out the modified resource" }, { "name": [ - "-u", - "--url" + "-j", + "--json" ], - "description": "The callback url used to post data", - "args": {}, - "isRequired": true + "description": "Print result in json format" }, { "name": [ - "-i", - "--include" + "-u", + "--unformatted" ], - "description": "A comma separated list of related resources to be included", - "args": {} - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": [ - "-n", - "--name" - ], - "description": "The webhook short name", - "args": {} + "name": "id", + "description": "The unique id of the resource" } ] }, { "name": [ - "webhooks:destroy", - "webhooks:delete", - "wh:delete", - "wh:destroy" + "webhook:disable" ], - "description": "Destroy an existing webhook", + "description": "Send this attribute if you want to mark the webhook as disabled.", "options": [ { "name": [ @@ -11725,21 +12479,41 @@ const completionSpec: Fig.Spec = { "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": "Unique id of the webhook" + "description": "The unique id of the resource" } ] }, { "name": [ - "webhooks:details", - "wh:details" + "webhook:enable" ], - "description": "Show the details of an existing webhook", + "description": "Send this attribute if you want to mark the webhook as enabled.", "options": [ { "name": [ @@ -11767,32 +12541,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-H", - "--hide-empty" + "-p", + "--print" ], - "description": "Hide empty attributes" + "description": "Print out the modified resource" }, { "name": [ - "-e", - "--events" + "-j", + "--json" ], - "description": "Show the last event callbacks associated to the webhook" + "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" + "webhook:reset_circuit" ], - "description": "Show the details of a firedf webhook event", + "description": "Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.", "options": [ { "name": [ @@ -11821,31 +12601,37 @@ const completionSpec: Fig.Spec = { { "name": [ "-p", - "--payload" + "--print" ], - "description": "Show the event payload sent to the callback endpoint" + "description": "Print out the modified resource" }, { "name": [ - "-f", - "--format" + "-j", + "--json" ], - "description": "Format the payload output" - } - ], - "args": [ + "description": "Print result in json format" + }, { - "name": "id", - "description": "Unique id of the webhook" + "name": [ + "-u", + "--unformatted" + ], + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the resource" } ] }, { "name": [ - "webhooks:events", - "wh:events" + "orders" ], - "description": "List all the events associated to the webhook", + "description": "Execute an action on an order", "options": [ { "name": [ @@ -11873,33 +12659,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-A", - "--all" + "-p", + "--print" ], - "description": "Show all events instead of first 25 only " + "description": "Print out the modified order" }, { "name": [ - "-l", - "--limit" + "-j", + "--json" ], - "description": "Limit number of events in output", - "args": {} + "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 order" } ] }, { "name": [ - "webhooks:list", - "wh:list" + "orders:approve" ], - "description": "List all the registered webhooks", + "description": "Send this attribute if you want to approve a placed order.", "options": [ { "name": [ @@ -11927,33 +12718,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-c", - "--circuit" + "-p", + "--print" ], - "description": "Show only webhooks with circuit in the declared state", - "args": { - "suggestions": [ - "open", - "closed" - ] - } + "description": "Print out the modified order" }, { "name": [ - "-t", - "--topic" + "-j", + "--json" ], - "description": "The event that triggered the webhook", - "args": {} + "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": [ - "webhooks:listen", - "wh:listen" + "orders:approve_and_capture" ], - "description": "Listen a webhook for outgoing callbacks", + "description": "Send this attribute if you want to approve and capture a placed order.", "options": [ { "name": [ @@ -11981,28 +12777,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-t", - "--time" + "-p", + "--print" ], - "description": "Waiting time for the first event", - "args": { - "default": "120" - } + "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": "Unique id of the webhook" + "description": "The unique id of the order" } ] }, { "name": [ - "webhooks:payload", - "wh:payload" + "orders:archive" ], - "description": "Show the payload associated to an event callback", + "description": "Send this attribute if you want to archive the order.", "options": [ { "name": [ @@ -12030,25 +12836,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-f", - "--format" + "-p", + "--print" ], - "description": "Format the payload output" + "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": "Unique id of the webhook" + "description": "The unique id of the order" } ] }, { "name": [ - "webhooks:reset", - "wh:reset" + "orders:authorization_amount_cents" ], - "description": "Reset the circuit breaker associated to the webhook", + "description": "The authorization amount, in cents.", "options": [ { "name": [ @@ -12073,28 +12892,41 @@ const completionSpec: Fig.Spec = { "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": "Unique id of the webhook" + "description": "The unique id of the order" } ] }, { "name": [ - "webhooks:topics", - "wh:topics" - ], - "description": "Show online documentation for supported events" - }, - { - "name": [ - "webhooks:update", - "wh:update" + "orders:authorize" ], - "description": "Update an existing webhook", + "description": "Send this attribute if you want to authorize the order's payment source.", "options": [ { "name": [ @@ -12122,49 +12954,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-t", - "--topic" - ], - "description": "The identifier of the event that will trigger the webhook", - "args": {} - }, - { - "name": [ - "-u", - "--url" + "-p", + "--print" ], - "description": "The callback url used to post data", - "args": {} + "description": "Print out the modified order" }, { "name": [ - "-i", - "--include" + "-j", + "--json" ], - "description": "A comma separated list of related resources to be included", - "args": {} + "description": "Print result in json format" }, { "name": [ - "-n", - "--name" + "-u", + "--unformatted" ], - "description": "The webhook short name", - "args": {} + "description": "Print json output without indentation" } ], "args": [ { "name": "id", - "description": "Unique id of the webhook" + "description": "The unique id of the order" } ] }, { "name": [ - "microstore" + "orders:billing_address_clone_id" ], - "description": "Create microstore urls", + "description": "The id of the address that you want to clone to create the order's billing address.", "options": [ { "name": [ @@ -12185,55 +13006,54 @@ const completionSpec: Fig.Spec = { "hidden": true }, { - "name": [ - "-a", - "--accessToken" - ], + "name": "--accessToken", "args": {}, "isRequired": true, - "hidden": false - }, - { - "name": "--open", - "description": "Open microstore url in default browser" + "hidden": true }, { "name": [ - "-S", - "--skuListId" + "-p", + "--print" ], - "description": "The sku list id", - "args": {}, - "isRequired": true + "description": "Print out the modified order" }, { "name": [ - "-A", - "--all" + "-j", + "--json" ], - "description": "Activate the buy all button " + "description": "Print result in json format" }, { "name": [ - "-C", - "--cart" + "-u", + "--unformatted" ], - "description": "Activate the cart application" + "description": "Print json output without indentation" }, { "name": [ - "-I", - "--inline" + "-v", + "--value" ], - "description": "Disable redirect to cart application" + "description": "The trigger attribute value", + "args": {}, + "isRequired": true + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "checkout" + "orders:billing_address_same_as_shipping" ], - "description": "Create checkout urls", + "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", "options": [ { "name": [ @@ -12254,79 +13074,45 @@ 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 - }, - { - "name": "--open", - "description": "Open checkout url in default browser" - }, - { - "name": "--staging", - "description": "Connect to checkout application in staging environment", "hidden": true }, { "name": [ - "-O", - "--order" - ], - "description": "An order id", - "args": {} - }, - { - "name": [ - "-S", - "--sku" - ], - "description": "An sku code", - "args": {} - }, - { - "name": [ - "-B", - "--bundle" + "-p", + "--print" ], - "description": "A bundle code", - "args": {} + "description": "Print out the modified order" }, { "name": [ - "-m", - "--market" + "-j", + "--json" ], - "description": "A market number", - "args": {} + "description": "Print result in json format" }, { "name": [ - "-c", - "--coupon" + "-u", + "--unformatted" ], - "description": "A promo code", - "args": {} - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": [ - "-e", - "--email" - ], - "description": "A customer email", - "args": {} + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "checkout:order" + "orders:cancel" ], - "description": "Create checkout urls starting from an existing order", + "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", "options": [ { "name": [ @@ -12347,129 +13133,46 @@ 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 - }, - { - "name": "--open", - "description": "Open checkout url in default browser" - }, - { - "name": "--staging", - "description": "Connect to checkout application in staging environment", "hidden": true - } - ], - "args": [ - { - "name": "id", - "description": "Unique id of the order" - } - ] - }, - { - "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": [ - "-u", - "--url" + "-p", + "--print" ], - "description": "Seeder data url", - "args": { - "default": "https://data.commercelayer.app/seeder" - } + "description": "Print out the modified order" }, { "name": [ - "-n", - "--name" + "-j", + "--json" ], - "description": "The name of the business model file to use", - "args": {} - }, - { - "name": "--debug", - "description": "Show command debug information", - "hidden": true + "description": "Print result in json format" }, { "name": [ - "-r", - "--relationships" + "-u", + "--unformatted" ], - "description": "Check resource relationships" + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "seeder:clean" + "orders:capture" ], - "description": "Clean previously imported seeder data", + "description": "Send this attribute if you want to capture an authorized order.", "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", @@ -12493,54 +13196,42 @@ const completionSpec: Fig.Spec = { "args": {}, "isRequired": true, "hidden": true - } - ] - }, - { - "name": [ - "seeder:seed", - "seed" - ], - "description": "Execute commerce layer seeder", - "options": [ + }, { "name": [ - "-b", - "--businessModel" + "-p", + "--print" ], - "description": "The kind of business model you want to import", - "args": { - "suggestions": [ - "single_sku", - "multi_market", - "custom" - ], - "default": "single_sku" - } + "description": "Print out the modified order" }, { "name": [ - "-u", - "--url" + "-j", + "--json" ], - "description": "Seeder data url", - "args": { - "default": "https://data.commercelayer.app/seeder" - } + "description": "Print result in json format" }, { "name": [ - "-n", - "--name" + "-u", + "--unformatted" ], - "description": "The name of the business model file to use", - "args": {} - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": "--debug", - "description": "Show debug information", - "hidden": true - }, + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:commit_invoice" + ], + "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "options": [ { "name": [ "-o", @@ -12567,45 +13258,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-k", - "--keep" + "-p", + "--print" ], - "description": "Keep existing resources without updating them" + "description": "Print out the modified order" }, { "name": [ - "-D", - "--delay" - ], - "description": "Add a delay in milliseconds between calls to different resources", - "args": {}, - "hidden": true - } - ] - }, - { - "name": [ - "resources" - ], - "description": "List all the available commerce layer api resources", - "options": [ + "-j", + "--json" + ], + "description": "Print result in json format" + }, { "name": [ - "-h", - "--help" + "-u", + "--unformatted" ], - "description": "Show cli help." + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "resources:all", - "all", - "ra", - "res:all" + "orders:create_subscriptions" ], - "description": "Fetch all resources", + "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", "options": [ { "name": [ @@ -12633,262 +13317,224 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} - }, - { - "name": [ - "-f", - "--fields" + "-p", + "--print" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + "description": "Print out the modified order" }, { "name": [ "-j", "--json" ], - "description": "Convert output in standard json format" + "description": "Print result in json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print unformatted json output" - }, + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:customer_payment_source_id" + ], + "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", + "options": [ { "name": [ - "-R", - "--raw" + "-o", + "--organization" ], - "description": "Print out the raw api response", - "hidden": false - }, - { - "name": "--doc", - "description": "Show the cli command in a specific language" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-l", - "--lang" + "-d", + "--domain" ], - "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": {} + "args": {}, + "hidden": true }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-w", - "--where" + "-p", + "--print" ], - "description": "Comma separated list of query filters", - "args": {} + "description": "Print out the modified order" }, { "name": [ - "-s", - "--sort" + "-j", + "--json" ], - "description": "Defines results ordering", - "args": {} + "description": "Print result in json format" }, { "name": [ - "-x", - "--save" + "-u", + "--unformatted" ], - "description": "Save command output to file", - "args": {} + "description": "Print json output without indentation" }, { "name": [ - "-X", - "--save-path" + "-v", + "--value" ], - "description": "Save command output to file and create missing path directories", - "args": {} - }, + "description": "The trigger attribute value", + "args": {}, + "isRequired": true + } + ], + "args": [ { - "name": [ - "-N", - "--notify" - ], - "description": "Force system notification when export has finished", - "hidden": true - }, + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:nullify_payment_source" + ], + "description": "Send this attribute if you want to nullify the payment source for this order.", + "options": [ { "name": [ - "-i", - "--clientId" + "-o", + "--organization" ], - "description": "Organization client_id", + "description": "The slug of your organization", "args": {}, + "isRequired": true, "hidden": true }, { "name": [ - "-s", - "--clientSecret" + "-d", + "--domain" ], - "description": "Organization client_secret", "args": {}, "hidden": true }, { - "name": [ - "-C", - "--csv" - ], - "description": "Export fields in csv format" - }, - { - "name": [ - "-D", - "--delimiter" - ], - "description": "The delimiter character to use in the csv output file (one of ',', ';', '|', tab)", - "args": { - "suggestions": [ - ",", - ";", - "|", - "TAB" - ] - } - }, - { - "name": [ - "-H", - "--header" - ], - "description": "Rename column headers defining a comma-separated list of values field:\"renamed title\"", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-b", - "--blind" + "-p", + "--print" ], - "description": "Execute in blind mode without prompt and progress bar" + "description": "Print out the modified order" }, { "name": [ - "-e", - "--extract" + "-j", + "--json" ], - "description": "Extract subfields from object attributes", - "args": {} + "description": "Print result in json format" }, { "name": [ - "-T", - "--timeout" + "-u", + "--unformatted" ], - "description": "Set request timeout in milliseconds [1000 - 15000]", - "args": {}, - "hidden": true + "description": "Print json output without indentation" } ], "args": [ { - "name": "resource", - "description": "The resource type" + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "resources:args", - "res:args" + "orders:place" ], - "description": "Show all the saved command arguments", + "description": "Send this attribute if you want to place the order.", "options": [ { "name": [ - "-a", - "--alias" + "-o", + "--organization" ], - "description": "The alias associated to saved command arguments", - "args": {} + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-r", - "--resource" + "-d", + "--domain" ], - "description": "The resource type", - "args": {} + "args": {}, + "hidden": true + }, + { + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-o", - "--operation" + "-p", + "--print" ], - "description": "The resource operation", - "args": { - "suggestions": [ - "list", - "retrieve", - "create", - "update" - ] - } + "description": "Print out the modified order" }, { "name": [ - "-D", - "--delete" + "-j", + "--json" ], - "description": "Delete saved arguments associated to the alias" + "description": "Print result in json format" }, { "name": [ - "-P", - "--pretty" + "-u", + "--unformatted" ], - "description": "Show saved arguments in table format", - "hidden": true + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "resources:count", - "count", - "res:count", - "rs:count" + "orders:refresh" ], - "description": "Count the number of existent resources", + "description": "Send this attribute if you want to manually refresh the order.", "options": [ { "name": [ @@ -12916,29 +13562,38 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-w", - "--where" + "-p", + "--print" ], - "description": "Comma separated list of query filters", - "args": {} + "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": "resource", - "description": "The resource type" + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "resources:create", - "create", - "rc", - "res:create", - "post" + "orders:refund" ], - "description": "Create a new resource", + "description": "Send this attribute if you want to refund a captured order.", "options": [ { "name": [ @@ -12966,157 +13621,97 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} - }, - { - "name": [ - "-f", - "--fields" + "-p", + "--print" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + "description": "Print out the modified order" }, { "name": [ "-j", "--json" ], - "description": "Convert output in standard json format" + "description": "Print result in 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" - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" - }, + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:refund_invoice" + ], + "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", + "options": [ { "name": [ - "-a", - "--attribute" + "-o", + "--organization" ], - "description": "Define a resource attribute", - "args": {} + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-O", - "--object" + "-d", + "--domain" ], - "description": "Define a resource object attribute", - "args": {} + "args": {}, + "hidden": true }, { - "name": [ - "-r", - "--relationship" - ], - "description": "Define a relationship with another resource", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-m", - "--metadata" + "-p", + "--print" ], - "description": "Define a metadata attribute or a set of metadata attributes", - "args": {} + "description": "Print out the modified order" }, { "name": [ - "-D", - "--data" + "-j", + "--json" ], - "description": "The data file to use as request body", - "args": {} + "description": "Print result in json format" }, { "name": [ - "-t", - "--tags" + "-u", + "--unformatted" ], - "description": "List of tags associated with the resource", - "args": {} + "description": "Print json output without indentation" } ], "args": [ { - "name": "resource", - "description": "The resource type" + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "resources:delete", - "delete", - "rd", - "res:delete" + "orders:save_billing_address_to_customer_address_book" ], - "description": "Delete an existing resource", + "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", "options": [ { "name": [ @@ -13144,147 +13739,156 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} - }, - { - "name": [ - "-f", - "--fields" + "-p", + "--print" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + "description": "Print out the modified order" }, { "name": [ "-j", "--json" ], - "description": "Convert output in standard json format" + "description": "Print result in json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print unformatted json output" - }, + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:save_payment_source_to_customer_wallet" + ], + "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", + "options": [ { "name": [ - "-R", - "--raw" + "-o", + "--organization" ], - "description": "Print out the raw api response", - "hidden": false - }, - { - "name": "--doc", - "description": "Show the cli command in a specific language" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-l", - "--lang" + "-d", + "--domain" ], - "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 + "args": {}, + "hidden": true }, { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + "name": [ + "-p", + "--print" + ], + "description": "Print out the modified order" }, { "name": [ - "-H", - "--headers" + "-j", + "--json" ], - "description": "Show response headers" + "description": "Print result in json format" }, { "name": [ - "-Y", - "--headers-only" + "-u", + "--unformatted" ], - "description": "Show only response headers" + "description": "Print json output without indentation" } ], "args": [ - { - "name": "resource", - "description": "The resource type" - }, { "name": "id", - "description": "Id of the resource to delete", - "isOptional": true + "description": "The unique id of the order" } ] }, { "name": [ - "resources:doc", - "res:doc", - "doc" + "orders:save_shipping_address_to_customer_address_book" ], - "description": "Open the default browser and show the online documentation for the resource", + "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", "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", - "--page" + "--print" ], - "description": "The doc page you want to access", - "args": { - "suggestions": [ - "object", - "create", - "retrieve", - "list", - "update", - "delete" - ] - } + "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": "resource", - "description": "The resource for which you want to access the online documentation" + "name": "id", + "description": "The unique id of the order" } ] }, { "name": [ - "resources:fetch", - "fetch", - "res:fetch", - "rf" + "orders:shipping_address_clone_id" ], - "description": "Retrieve a resource or list a set of resources", + "description": "The id of the address that you want to clone to create the order's shipping address.", "options": [ { "name": [ @@ -13312,185 +13916,165 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} - }, - { - "name": [ - "-f", - "--fields" + "-p", + "--print" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + "description": "Print out the modified order" }, { "name": [ "-j", "--json" ], - "description": "Convert output in standard json format" + "description": "Print result in json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print unformatted json output" + "description": "Print json output without indentation" }, { "name": [ - "-R", - "--raw" + "-v", + "--value" ], - "description": "Print out the raw api response", - "hidden": false - }, + "description": "The trigger attribute value", + "args": {}, + "isRequired": true + } + ], + "args": [ { - "name": "--doc", - "description": "Show the cli command in a specific language" - }, + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:shipping_address_same_as_billing" + ], + "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", + "options": [ { "name": [ - "-l", - "--lang" + "-o", + "--organization" ], - "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 + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + "name": [ + "-d", + "--domain" + ], + "args": {}, + "hidden": true }, { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + "name": [ + "-p", + "--print" + ], + "description": "Print out the modified order" }, { "name": [ - "-H", - "--headers" + "-j", + "--json" ], - "description": "Show response headers" + "description": "Print result in json format" }, { "name": [ - "-Y", - "--headers-only" + "-u", + "--unformatted" ], - "description": "Show only response headers" - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} - }, + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:start_editing" + ], + "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", + "options": [ { "name": [ - "-X", - "--save-path" + "-o", + "--organization" ], - "description": "Save command output to file and create missing path directories", - "args": {} + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-e", - "--extract" + "-d", + "--domain" ], - "description": "Extract subfields from object attributes", - "args": {} + "args": {}, + "hidden": true }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ "-p", - "--page" - ], - "description": "Page number", - "args": {} - }, - { - "name": [ - "-n", - "--pageSize" + "--print" ], - "description": "Number of elements per page", - "args": {} + "description": "Print out the modified order" }, { "name": [ - "-s", - "--sort" + "-j", + "--json" ], - "description": "Defines results ordering", - "args": {} + "description": "Print result in json format" }, { "name": [ - "-I", - "--force-include" + "-u", + "--unformatted" ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true + "description": "Print json output without indentation" } ], "args": [ - { - "name": "path", - "description": "Path (or url) of the resource(s) to fetch" - }, { "name": "id", - "description": "Resource id", - "isOptional": true + "description": "The unique id of the order" } ] }, { "name": [ - "resources:filters", - "res:filters" - ], - "description": "Show a list of all available filter predicates" - }, - { - "name": [ - "resources:get", - "get", - "res:get", - "rg" + "orders:stop_editing" ], - "description": "Retrieve a resource or list a set of resources", + "description": "Send this attribute to stop the editing for the order and return back to placed status.", "options": [ { "name": [ @@ -13518,178 +14102,156 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} - }, - { - "name": [ - "-f", - "--fields" + "-p", + "--print" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + "description": "Print out the modified order" }, { "name": [ "-j", "--json" ], - "description": "Convert output in standard json format" + "description": "Print result in json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print unformatted json output" - }, + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:unarchive" + ], + "description": "Send this attribute if you want to unarchive the order.", + "options": [ { "name": [ - "-R", - "--raw" + "-o", + "--organization" ], - "description": "Print out the raw api response", - "hidden": false - }, - { - "name": "--doc", - "description": "Show the cli command in a specific language" + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-l", - "--lang" + "-d", + "--domain" ], - "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": {} + "args": {}, + "hidden": true }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-H", - "--headers" + "-p", + "--print" ], - "description": "Show response headers" + "description": "Print out the modified order" }, { "name": [ - "-Y", - "--headers-only" + "-j", + "--json" ], - "description": "Show only response headers" + "description": "Print result in json format" }, { "name": [ - "-w", - "--where" + "-u", + "--unformatted" ], - "description": "Comma separated list of query filters", - "args": {} - }, + "description": "Print json output without indentation" + } + ], + "args": [ + { + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "orders:update_taxes" + ], + "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", + "options": [ { "name": [ - "-p", - "--page" + "-o", + "--organization" ], - "description": "Page number", - "args": {} + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-n", - "--pageSize" + "-d", + "--domain" ], - "description": "Number of elements per page", - "args": {} + "args": {}, + "hidden": true }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-x", - "--save" + "-p", + "--print" ], - "description": "Save command output to file", - "args": {} + "description": "Print out the modified order" }, { "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} - }, - { - "name": [ - "-e", - "--extract" + "-j", + "--json" ], - "description": "Extract subfields from object attributes", - "args": {} + "description": "Print result in json format" }, { "name": [ - "-I", - "--force-include" + "-u", + "--unformatted" ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true + "description": "Print json output without indentation" } ], "args": [ - { - "name": "resource", - "description": "The resource type" - }, { "name": "id", - "description": "Id of the resource to retrieve", - "isOptional": true + "description": "The unique id of the order" } ] }, { "name": [ - "resources:list", - "list", - "rl", - "res:list" + "orders:validate" ], - "description": "Fetch a collection of resources", + "description": "Send this attribute if you want to trigger the external validation for the order.", "options": [ { "name": [ @@ -13717,175 +14279,163 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} - }, - { - "name": [ - "-f", - "--fields" + "-p", + "--print" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + "description": "Print out the modified order" }, { "name": [ "-j", "--json" ], - "description": "Convert output in standard json format" + "description": "Print result in json format" }, { "name": [ "-u", "--unformatted" ], - "description": "Print unformatted json output" - }, - { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false - }, + "description": "Print json output without indentation" + } + ], + "args": [ { - "name": "--doc", - "description": "Show the cli command in a specific language" - }, + "name": "id", + "description": "The unique id of the order" + } + ] + }, + { + "name": [ + "imports" + ], + "description": "List all the created imports or show details of a single import", + "options": [ { "name": [ - "-l", - "--lang" + "-o", + "--organization" ], - "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": {} + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-H", - "--headers" + "-d", + "--domain" ], - "description": "Show response headers" + "args": {}, + "hidden": true }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-w", - "--where" + "-A", + "--all" ], - "description": "Comma separated list of query filters", - "args": {} + "description": "Show all imports instead of first 25 only" }, { "name": [ - "-p", - "--page" + "-t", + "--type" ], - "description": "Page number", - "args": {} + "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": [ - "-n", - "--pageSize" + "-g", + "--group" ], - "description": "Number of elements per page", + "description": "The group id associated to the import in case of multi-chunk imports", "args": {} }, { "name": [ "-s", - "--sort" + "--status" ], - "description": "Defines results ordering", - "args": {} + "description": "The import job status", + "args": { + "suggestions": [ + "in_progress", + "pending", + "completed", + "interrupted" + ] + } }, { "name": [ - "-x", - "--save" + "-e", + "--errors" ], - "description": "Save command output to file", - "args": {} + "description": "Show only imports with errors" }, { "name": [ - "-X", - "--save-path" + "-w", + "--warnings" ], - "description": "Save command output to file and create missing path directories", - "args": {} + "description": "Show only import with warnings" }, { "name": [ - "-e", - "--extract" + "-l", + "--limit" ], - "description": "Extract subfields from object attributes", + "description": "Limit number of imports in output", "args": {} - }, - { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true } ], "args": [ { - "name": "resource", - "description": "The resource type" + "name": "id", + "description": "Unique id of the import to be retrieved", + "isOptional": true } ] }, { "name": [ - "relationship", - "relationship", - "resources:rel", - "res:rel", - "res:relationship", - "relationship" + "imports:create", + "imp:create", + "import" ], - "description": "Fetch a resource relationship", + "description": "Create a new import", "options": [ { "name": [ @@ -13913,182 +14463,238 @@ const completionSpec: Fig.Spec = { }, { "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...", - "args": {} - }, - { - "name": [ - "-j", - "--json" + "-t", + "--type" ], - "description": "Convert output in standard json format" - }, + "description": "The type of resource being imported", + "args": { + "description": "addresses|bundles|coupons|customer_addresses|...", + "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": [ - "-u", - "--unformatted" + "-p", + "--parent" ], - "description": "Print unformatted json output" + "description": "The id of the parent resource to be associated with imported data", + "args": {} }, { "name": [ - "-R", - "--raw" + "-i", + "--inputs" ], - "description": "Print out the raw api response", - "hidden": false + "description": "The path of the file containing the data to import", + "args": {}, + "isRequired": true }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + "name": [ + "-C", + "--csv" + ], + "description": "Accept input file in csv format" }, { "name": [ - "-l", - "--lang" + "-D", + "--delimiter" ], - "description": "Show the cli command in the specified language syntax", + "description": "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", "args": { "suggestions": [ - "curl", - "node" + ",", + ";", + "|", + "TAB" ] } }, - { - "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" + "-b", + "--blind" ], - "description": "Show response headers" + "description": "Execute in blind mode without showing the progress monitor" }, { "name": [ - "-Y", - "--headers-only" + "-q", + "--quiet" ], - "description": "Show only response headers" - }, + "description": "Execute command without showing warning messages" + } + ] + }, + { + "name": [ + "imports:delete", + "imp:delete" + ], + "description": "Delete an existing import", + "options": [ { "name": [ - "-w", - "--where" + "-o", + "--organization" ], - "description": "Comma separated list of query filters", - "args": {} + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-p", - "--page" + "-d", + "--domain" ], - "description": "Page number", - "args": {} + "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": [ - "-n", - "--pageSize" + "-o", + "--organization" ], - "description": "Number of elements per page", - "args": {} + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-s", - "--sort" + "-d", + "--domain" ], - "description": "Defines results ordering", - "args": {} + "args": {}, + "hidden": true }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-X", - "--save-path" + "-i", + "--inputs" ], - "description": "Save command output to file and create missing path directories", - "args": {} + "description": "Show input items associated with the import" }, { "name": [ - "-e", - "--extract" + "-l", + "--logs" ], - "description": "Extract subfields from object attributes", - "args": {} + "description": "Show warning and error logs related to the import process" }, { "name": [ - "-I", - "--force-include" + "-S", + "--save-inputs" ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true + "description": "Save import inputs to local file", + "args": {} } ], "args": [ { - "name": "resource", - "description": "The resource type" + "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": [ + "-o", + "--organization" + ], + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { - "name": "id", - "description": "Id of the resource to retrieve" + "name": [ + "-d", + "--domain" + ], + "args": {}, + "hidden": true }, { - "name": "relationship", - "description": "Name of the relationship field" + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true } ], - "hidden": false + "args": [ + { + "name": "group_id", + "description": "Unique id of the group import" + } + ] }, { "name": [ - "resources:retrieve", - "retrieve", - "rr", - "res:retrieve" + "imports:list", + "imp:list" ], - "description": "Fetch a single resource", + "description": "List all the created imports", "options": [ { "name": [ @@ -14116,149 +14722,203 @@ const completionSpec: Fig.Spec = { }, { "name": [ - "-i", - "--include" + "-A", + "--all" ], - "description": "Comma separated resources to include", - "args": {} + "description": "Show all imports instead of first 25 only" }, { "name": [ - "-f", - "--fields" + "-t", + "--type" ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + "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": [ - "-j", - "--json" + "-g", + "--group" ], - "description": "Convert output in standard json format" + "description": "The group id associated to the import in case of multi-chunk imports", + "args": {} }, { "name": [ - "-u", - "--unformatted" + "-s", + "--status" ], - "description": "Print unformatted json output" + "description": "The import job status", + "args": { + "suggestions": [ + "in_progress", + "pending", + "completed", + "interrupted" + ] + } }, { "name": [ - "-R", - "--raw" + "-e", + "--errors" ], - "description": "Print out the raw api response", - "hidden": false + "description": "Show only imports with errors" }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + "name": [ + "-w", + "--warnings" + ], + "description": "Show only import with warnings" }, { "name": [ "-l", - "--lang" + "--limit" ], - "description": "Show the cli command in the specified language syntax", + "description": "Limit number of imports in output", + "args": {} + } + ] + }, + { + "name": [ + "imports:types", + "imp:types" + ], + "description": "Show online documentation for supported resources", + "options": [ + { + "name": [ + "-O", + "--open" + ], + "description": "Open online documentation page" + } + ] + }, + { + "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": [ - "curl", - "node" - ] + "single_sku", + "multi_market", + "custom" + ], + "default": "single_sku" } }, { - "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": [ + "-u", + "--url" + ], + "description": "Seeder data url", + "args": { + "default": "https://data.commercelayer.app/seeder" + } }, { - "name": "--load-args", - "description": "Load previously saved command arguments", + "name": [ + "-n", + "--name" + ], + "description": "The name of the business model file to use", "args": {} }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + "name": "--debug", + "description": "Show command debug information", + "hidden": true }, { "name": [ - "-Y", - "--headers-only" + "-r", + "--relationships" ], - "description": "Show only response headers" - }, + "description": "Check resource relationships" + } + ] + }, + { + "name": [ + "seeder:clean" + ], + "description": "Clean previously imported seeder data", + "options": [ { "name": [ - "-x", - "--save" + "-b", + "--businessModel" ], - "description": "Save command output to file", - "args": {} + "description": "The kind of business model you want to import", + "args": { + "suggestions": [ + "single_sku", + "multi_market", + "custom" + ], + "default": "single_sku" + } }, { "name": [ - "-X", - "--save-path" + "-u", + "--url" ], - "description": "Save command output to file and create missing path directories", - "args": {} + "description": "Seeder data url", + "args": { + "default": "https://data.commercelayer.app/seeder" + } }, { "name": [ - "-e", - "--extract" + "-n", + "--name" ], - "description": "Extract subfields from object attributes", + "description": "The name of the business model file to use", "args": {} - } - ], - "args": [ - { - "name": "resource", - "description": "The resource type" }, { - "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" - }, - { - "name": [ - "resources:update", - "update", - "ru", - "res:update", - "patch" - ], - "description": "Update an existing resource", - "options": [ + "name": "--debug", + "description": "Show debug information", + "hidden": true + }, { "name": [ "-o", @@ -14282,162 +14942,93 @@ const completionSpec: Fig.Spec = { "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...", - "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": [ + "seeder:seed", + "seed" + ], + "description": "Execute commerce layer seeder", + "options": [ { "name": [ - "-l", - "--lang" + "-b", + "--businessModel" ], - "description": "Show the cli command in the specified language syntax", + "description": "The kind of business model you want to import", "args": { "suggestions": [ - "curl", - "node" - ] + "single_sku", + "multi_market", + "custom" + ], + "default": "single_sku" } }, - { - "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" + "-u", + "--url" ], - "description": "Show only response headers" + "description": "Seeder data url", + "args": { + "default": "https://data.commercelayer.app/seeder" + } }, { "name": [ - "-a", - "--attribute" + "-n", + "--name" ], - "description": "Define a resource attribute", + "description": "The name of the business model file to use", "args": {} }, { - "name": [ - "-O", - "--object" - ], - "description": "Define a resource object attribute", - "args": {} + "name": "--debug", + "description": "Show debug information", + "hidden": true }, { "name": [ - "-r", - "--relationship" + "-o", + "--organization" ], - "description": "Define a relationship with another resource", - "args": {} + "description": "The slug of your organization", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-m", - "--metadata" + "-d", + "--domain" ], - "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource", - "args": {} + "args": {}, + "hidden": true }, { - "name": [ - "-M", - "--metadata-replace" - ], - "description": "Define a metadata attribute and replace every item already present in the remote resource", - "args": {} + "name": "--accessToken", + "args": {}, + "isRequired": true, + "hidden": true }, { "name": [ - "-D", - "--data" + "-k", + "--keep" ], - "description": "The data file to use as request body", - "args": {} + "description": "Keep existing resources without updating them" }, { "name": [ - "-t", - "--tags" + "-D", + "--delay" ], - "description": "List of tags associated with the resource", - "args": {} - } - ], - "args": [ - { - "name": "resource", - "description": "The resource type" - }, - { - "name": "id", - "description": "Id of the resource to update", - "isOptional": true + "description": "Add a delay in milliseconds between calls to different resources", + "args": {}, + "hidden": true } ] }, @@ -15577,7 +16168,16 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "resource", - "description": "The resource type" + "description": "The resource type", + "suggestions": [ + "api_credential", + "application_membership", + "membership", + "organization", + "permission", + "role", + "subscription" + ] } ] }, @@ -15688,7 +16288,12 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "resource", - "description": "The resource type" + "description": "The resource type", + "suggestions": [ + "api_credential", + "application_membership", + "membership" + ] }, { "name": "id", @@ -16230,7 +16835,18 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "resource", - "description": "The resource type" + "description": "The resource type", + "suggestions": [ + "api_credentials", + "application_memberships", + "memberships", + "organizations", + "permissions", + "plans", + "roles", + "subscriptions", + "versions" + ] } ] }, @@ -16532,7 +17148,20 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "resource", - "description": "The resource type" + "description": "The resource type", + "suggestions": [ + "api_credential", + "application_membership", + "billing_profile", + "membership", + "organization", + "permission", + "plan", + "role", + "subscription", + "user", + "version" + ] }, { "name": "id", @@ -16696,7 +17325,16 @@ const completionSpec: Fig.Spec = { "args": [ { "name": "resource", - "description": "The resource type" + "description": "The resource type", + "suggestions": [ + "api_credential", + "application_membership", + "membership", + "organization", + "permission", + "role", + "user" + ] }, { "name": "id", From 2258fc7fb2af0584973a50a8d7425a5d50fe8476 Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Mon, 15 Apr 2024 12:09:40 +0200 Subject: [PATCH 4/8] fix: fix linter issues --- src/cl.ts | 5 +- src/commercelayer.ts | 25211 ++++++++++++++++++----------------------- 2 files changed, 11068 insertions(+), 14148 deletions(-) diff --git a/src/cl.ts b/src/cl.ts index 5848780eaebc..dfa4a222c49c 100644 --- a/src/cl.ts +++ b/src/cl.ts @@ -1,3 +1,2 @@ - -import completionSpec from './commercelayer' -export default completionSpec +import completionSpec from "./commercelayer"; +export default completionSpec; diff --git a/src/commercelayer.ts b/src/commercelayer.ts index 9d84e26357eb..219dc0808226 100644 --- a/src/commercelayer.ts +++ b/src/commercelayer.ts @@ -1,4266 +1,3686 @@ - /** * Autogenerated by @commercelayer/cli cli:fig command **/ - const completionSpec: Fig.Spec = { - "name": "@commercelayer/cli", - "subcommands": [ - { - "name": [ - "applications", - "app:list", - "applications:list", - "app:available", - "applications:available", - "apps" - ], - "description": "Show a list of all (logged in) available cli applications", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "Organization slug", - "args": {} + name: "@commercelayer/cli", + subcommands: [ + { + name: ["applications", "app:list", "applications:list", "app:available", "applications:available", "apps"], + description: "Show a list of all (logged in) available cli applications", + options: [ + { + name: ["-o", "--organization"], + description: "Organization slug", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "description": "Api domain", - "args": {}, - "hidden": true + name: ["-d", "--domain"], + description: "Api domain", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-k", - "--kind" - ], - "description": "Application kind", - "args": { - "suggestions": [ - "integration", - "sales_channel", - "user" - ] - } - }, - { - "name": [ - "-m", - "--mode" - ], - "description": "Execution mode", - "args": { - "suggestions": [ - "test", - "live" - ] - } + name: ["-k", "--kind"], + description: "Application kind", + args: { + description: "", + suggestions: ["integration", "sales_channel", "user"], + }, }, { - "name": "--live", - "description": "Live execution mode" + name: ["-m", "--mode"], + description: "Execution mode", + args: { + description: "", + suggestions: ["test", "live"], + }, }, { - "name": "--id", - "description": "Application id", - "args": {} + name: "--live", + description: "Live execution mode", }, { - "name": [ - "-a", - "--alias" - ], - "description": "The alias associated to the application", - "args": {} + name: "--id", + description: "Application id", + args: { + description: "", + }, }, { - "name": "--appkey", - "description": "Cli application key", - "args": {}, - "hidden": true + name: ["-a", "--alias"], + description: "The alias associated to the application", + args: { + description: "", + }, }, { - "name": [ - "-A", - "--api" - ], - "description": "Specific api application", - "args": { - "suggestions": [ - "core", - "provisioning" - ] - } - }, - { - "name": [ - "-X", - "--extra" - ], - "description": "Show applications extra info", - "hidden": true + name: "--appkey", + description: "Cli application key", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-S", - "--sort" - ], - "description": "Sort applications by organization and application name" - } - ] + name: ["-A", "--api"], + description: "Specific api application", + args: { + description: "", + suggestions: ["core", "provisioning"], + }, + }, + { + name: ["-X", "--extra"], + description: "Show applications extra info", + hidden: true, + }, + { + name: ["-S", "--sort"], + description: "Sort applications by organization and application name", + }, + ], }, { - "name": [ - "applications:add", - "app:add" - ], - "description": "Add a new commerce layer application to cli config (application must be of kind 'integration' or 'sales_channel')", - "options": [ + name: ["applications:add", "app:add"], + description: "", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "Organization slug", - "args": {} + name: ["-o", "--organization"], + description: "Organization slug", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "description": "Api domain", - "args": {}, - "hidden": true + name: ["-d", "--domain"], + description: "Api domain", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-i", - "--clientId" - ], - "description": "Application client_id", - "args": {}, - "isRequired": true + name: ["-i", "--clientId"], + description: "Application client_id", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-s", - "--clientSecret" - ], - "description": "Application client_secret", - "args": {} + name: ["-s", "--clientSecret"], + description: "Application client_secret", + args: { + description: "", + }, }, { - "name": [ - "-S", - "--scope" - ], - "description": "Access token scope (market, stock location)", - "args": {} + name: ["-S", "--scope"], + description: "Access token scope (market, stock location)", + args: { + description: "", + }, }, { - "name": [ - "-e", - "--email" - ], - "description": "Customer email", - "args": {} + name: ["-e", "--email"], + description: "Customer email", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--password" - ], - "description": "Customer secret password", - "args": {} + name: ["-p", "--password"], + description: "Customer secret password", + args: { + description: "", + }, }, { - "name": [ - "-a", - "--alias" - ], - "description": "The alias you want to associate to the application", - "args": {}, - "isRequired": true + name: ["-a", "--alias"], + description: "The alias you want to associate to the application", + args: { + description: "", + }, + isRequired: true, }, { - "name": "--debug", - "description": "Show more verbose error messages", - "hidden": true - } - ] + name: "--debug", + description: "Show more verbose error messages", + hidden: true, + }, + ], }, { - "name": [ - "applications:current", - "app:current" - ], - "description": "Show the current application", - "options": [ + name: ["applications:current", "app:current"], + description: "Show the current application", + options: [ { - "name": "--info", - "hidden": true + name: "--info", + hidden: true, }, { - "name": [ - "-j", - "--json" - ], - "description": "Show info in json format" - } - ] + name: ["-j", "--json"], + description: "Show info in json format", + }, + ], }, { - "name": [ - "applications:info", - "app:info" - ], - "description": "Show application details", - "options": [ + name: ["applications:info", "app:info"], + description: "Show application details", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "Organization slug", - "args": {} + name: ["-o", "--organization"], + description: "Organization slug", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "description": "Api domain", - "args": {}, - "hidden": true + name: ["-d", "--domain"], + description: "Api domain", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-k", - "--kind" - ], - "description": "Application kind", - "args": { - "suggestions": [ - "integration", - "sales_channel", - "user" - ] - } - }, - { - "name": [ - "-m", - "--mode" - ], - "description": "Execution mode", - "args": { - "suggestions": [ - "test", - "live" - ] - } + name: ["-k", "--kind"], + description: "Application kind", + args: { + description: "", + suggestions: ["integration", "sales_channel", "user"], + }, }, { - "name": "--live", - "description": "Live execution mode" + name: ["-m", "--mode"], + description: "Execution mode", + args: { + description: "", + suggestions: ["test", "live"], + }, }, { - "name": "--id", - "description": "Application id", - "args": {} + name: "--live", + description: "Live execution mode", }, { - "name": [ - "-a", - "--alias" - ], - "description": "The alias associated to the application", - "args": {} + name: "--id", + description: "Application id", + args: { + description: "", + }, }, { - "name": "--appkey", - "description": "Cli application key", - "args": {}, - "hidden": true + name: ["-a", "--alias"], + description: "The alias associated to the application", + args: { + description: "", + }, }, { - "name": [ - "-A", - "--api" - ], - "description": "Specific api application", - "args": { - "suggestions": [ - "core", - "provisioning" - ] - } - }, - { - "name": [ - "-j", - "--json" - ], - "description": "Show info in json format" - } - ] + name: "--appkey", + description: "Cli application key", + args: { + description: "", + }, + hidden: true, + }, + { + name: ["-A", "--api"], + description: "Specific api application", + args: { + description: "", + suggestions: ["core", "provisioning"], + }, + }, + { + name: ["-j", "--json"], + description: "Show info in json format", + }, + ], }, { - "name": [ - "applications:login", - "app:login", - "login" - ], - "description": "Execute login to a commerce layer application (application must be of kind 'integration' or 'sales_channel')", - "options": [ + name: ["applications:login", "app:login", "login"], + description: "", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "Organization slug", - "args": {} + name: ["-o", "--organization"], + description: "Organization slug", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "description": "Api domain", - "args": {}, - "hidden": true + name: ["-d", "--domain"], + description: "Api domain", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-i", - "--clientId" - ], - "description": "Application client_id", - "args": {}, - "isRequired": true + name: ["-i", "--clientId"], + description: "Application client_id", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-s", - "--clientSecret" - ], - "description": "Application client_secret", - "args": {} + name: ["-s", "--clientSecret"], + description: "Application client_secret", + args: { + description: "", + }, }, { - "name": [ - "-S", - "--scope" - ], - "description": "Access token scope (market, stock location)", - "args": {} + name: ["-S", "--scope"], + description: "Access token scope (market, stock location)", + args: { + description: "", + }, }, { - "name": [ - "-e", - "--email" - ], - "description": "Customer email", - "args": {} + name: ["-e", "--email"], + description: "Customer email", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--password" - ], - "description": "Customer secret password", - "args": {} + name: ["-p", "--password"], + description: "Customer secret password", + args: { + description: "", + }, }, { - "name": [ - "-a", - "--alias" - ], - "description": "The alias you want to associate to the application", - "args": {}, - "isRequired": true + name: ["-a", "--alias"], + description: "The alias you want to associate to the application", + args: { + description: "", + }, + isRequired: true, }, { - "name": "--debug", - "description": "Show more verbose error messages", - "hidden": true - } - ] + name: "--debug", + description: "Show more verbose error messages", + hidden: true, + }, + ], }, { - "name": [ - "applications:logout", - "app:logout", - "app:remove", - "applications:remove", - "logout" - ], - "description": "Remove an application from cli local configuration", - "options": [ + name: ["applications:logout", "app:logout", "app:remove", "applications:remove", "logout"], + description: "Remove an application from cli local configuration", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "Organization slug", - "args": {} + name: ["-o", "--organization"], + description: "Organization slug", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "description": "Api domain", - "args": {}, - "hidden": true + name: ["-d", "--domain"], + description: "Api domain", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-k", - "--kind" - ], - "description": "Application kind", - "args": { - "suggestions": [ - "integration", - "sales_channel", - "user" - ] - } - }, - { - "name": [ - "-m", - "--mode" - ], - "description": "Execution mode", - "args": { - "suggestions": [ - "test", - "live" - ] - } + name: ["-k", "--kind"], + description: "Application kind", + args: { + description: "", + suggestions: ["integration", "sales_channel", "user"], + }, }, { - "name": "--live", - "description": "Live execution mode" + name: ["-m", "--mode"], + description: "Execution mode", + args: { + description: "", + suggestions: ["test", "live"], + }, }, { - "name": "--id", - "description": "Application id", - "args": {} + name: "--live", + description: "Live execution mode", }, { - "name": [ - "-a", - "--alias" - ], - "description": "The alias associated to the application", - "args": {} + name: "--id", + description: "Application id", + args: { + description: "", + }, }, { - "name": "--appkey", - "description": "Cli application key", - "args": {}, - "hidden": true + name: ["-a", "--alias"], + description: "The alias associated to the application", + args: { + description: "", + }, }, { - "name": [ - "-A", - "--api" - ], - "description": "Specific api application", - "args": { - "suggestions": [ - "core", - "provisioning" - ] - } - }, - { - "name": [ - "-r", - "--revoke" - ], - "description": "Revoke current access token" + name: "--appkey", + description: "Cli application key", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-F", - "--force" - ], - "description": "Force application removal without user confirmation", - "hidden": true - } - ] + name: ["-A", "--api"], + description: "Specific api application", + args: { + description: "", + suggestions: ["core", "provisioning"], + }, + }, + { + name: ["-r", "--revoke"], + description: "Revoke current access token", + }, + { + name: ["-F", "--force"], + description: "Force application removal without user confirmation", + hidden: true, + }, + ], }, { - "name": [ - "applications:provisioning", - "prov:list", - "app:provisioning", - "prov:apps", - "prov:applications" - ], - "description": "Show all provisioning applications", - "options": [ + name: ["applications:provisioning", "app:prov", "app:provisioning", "prov:apps", "prov:applications"], + description: "Show all provisioning applications", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "Organization slug", - "args": {} + name: ["-o", "--organization"], + description: "Organization slug", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "description": "Api domain", - "args": {}, - "hidden": true + name: ["-d", "--domain"], + description: "Api domain", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-k", - "--kind" - ], - "description": "Application kind", - "args": { - "suggestions": [ - "integration", - "sales_channel", - "user" - ] - } - }, - { - "name": [ - "-m", - "--mode" - ], - "description": "Execution mode", - "args": { - "suggestions": [ - "test", - "live" - ] - } + name: ["-k", "--kind"], + description: "Application kind", + args: { + description: "", + suggestions: ["integration", "sales_channel", "user"], + }, }, { - "name": "--live", - "description": "Live execution mode" + name: ["-m", "--mode"], + description: "Execution mode", + args: { + description: "", + suggestions: ["test", "live"], + }, }, { - "name": "--id", - "description": "Application id", - "args": {} + name: "--live", + description: "Live execution mode", }, { - "name": [ - "-a", - "--alias" - ], - "description": "The alias associated to the application", - "args": {} + name: "--id", + description: "Application id", + args: { + description: "", + }, }, { - "name": "--appkey", - "description": "Cli application key", - "args": {}, - "hidden": true + name: ["-a", "--alias"], + description: "The alias associated to the application", + args: { + description: "", + }, }, { - "name": [ - "-A", - "--api" - ], - "description": "Specific api application", - "args": { - "suggestions": [ - "core", - "provisioning" - ] - } - }, - { - "name": [ - "-X", - "--extra" - ], - "description": "Show applications extra info", - "hidden": true + name: "--appkey", + description: "Cli application key", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-S", - "--sort" - ], - "description": "Sort applications by organization and application name" - } - ] + name: ["-A", "--api"], + description: "Specific api application", + args: { + description: "", + suggestions: ["core", "provisioning"], + }, + }, + { + name: ["-X", "--extra"], + description: "Show applications extra info", + hidden: true, + }, + { + name: ["-S", "--sort"], + description: "Sort applications by organization and application name", + }, + ], }, { - "name": [ - "applications:scope", - "app:scope" - ], - "description": "Switch scope of current application", - "options": [ + name: ["applications:scope", "app:scope"], + description: "Switch scope of current application", + options: [ { - "name": [ - "-a", - "--alias" - ], - "description": "The alias you want to associate to the application", - "args": {} - } + name: ["-a", "--alias"], + description: "The alias you want to associate to the application", + args: { + description: "", + }, + }, ], - "args": [ - { - "name": "scope", - "description": "The application scope" - } - ] + args: { + name: "scope", + description: "The application scope", + }, }, { - "name": [ - "applications:switch", - "app:switch" - ], - "description": "Switch applications", - "options": [ + name: ["applications:switch", "app:switch"], + description: "Switch applications", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "Organization slug", - "args": {} + name: ["-o", "--organization"], + description: "Organization slug", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "description": "Api domain", - "args": {}, - "hidden": true + name: ["-d", "--domain"], + description: "Api domain", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-k", - "--kind" - ], - "description": "Application kind", - "args": { - "suggestions": [ - "integration", - "sales_channel", - "user" - ] - } - }, - { - "name": [ - "-m", - "--mode" - ], - "description": "Execution mode", - "args": { - "suggestions": [ - "test", - "live" - ] - } + name: ["-k", "--kind"], + description: "Application kind", + args: { + description: "", + suggestions: ["integration", "sales_channel", "user"], + }, }, { - "name": "--live", - "description": "Live execution mode" + name: ["-m", "--mode"], + description: "Execution mode", + args: { + description: "", + suggestions: ["test", "live"], + }, }, { - "name": "--id", - "description": "Application id", - "args": {} + name: "--live", + description: "Live execution mode", }, { - "name": [ - "-a", - "--alias" - ], - "description": "The alias associated to the application", - "args": {} + name: "--id", + description: "Application id", + args: { + description: "", + }, }, { - "name": "--appkey", - "description": "Cli application key", - "args": {}, - "hidden": true + name: ["-a", "--alias"], + description: "The alias associated to the application", + args: { + description: "", + }, }, { - "name": [ - "-A", - "--api" - ], - "description": "Specific api application", - "args": { - "suggestions": [ - "core", - "provisioning" - ] - } - } - ] - }, - { - "name": [ - "app:token", - "app:token" - ], - "description": "Get a new access token from commerce layer api", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "Organization slug", - "args": {} + name: "--appkey", + description: "Cli application key", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "description": "Api domain", - "args": {}, - "hidden": true + name: ["-A", "--api"], + description: "Specific api application", + args: { + description: "", + suggestions: ["core", "provisioning"], + }, + }, + ], + }, + { + name: "app:token", + description: "Get a new access token from commerce layer api", + options: [ + { + name: ["-o", "--organization"], + description: "Organization slug", + args: { + description: "", + }, }, { - "name": [ - "-k", - "--kind" - ], - "description": "Application kind", - "args": { - "suggestions": [ - "integration", - "sales_channel", - "user" - ] - } - }, - { - "name": [ - "-m", - "--mode" - ], - "description": "Execution mode", - "args": { - "suggestions": [ - "test", - "live" - ] - } + name: ["-d", "--domain"], + description: "Api domain", + args: { + description: "", + }, + hidden: true, }, { - "name": "--live", - "description": "Live execution mode" + name: ["-k", "--kind"], + description: "Application kind", + args: { + description: "", + suggestions: ["integration", "sales_channel", "user"], + }, }, { - "name": "--id", - "description": "Application id", - "args": {} + name: ["-m", "--mode"], + description: "Execution mode", + args: { + description: "", + suggestions: ["test", "live"], + }, }, { - "name": [ - "-a", - "--alias" - ], - "description": "The alias associated to the application", - "args": {} + name: "--live", + description: "Live execution mode", }, { - "name": "--appkey", - "description": "Cli application key", - "args": {}, - "hidden": true + name: "--id", + description: "Application id", + args: { + description: "", + }, }, { - "name": [ - "-A", - "--api" - ], - "description": "Specific api application", - "args": { - "suggestions": [ - "core", - "provisioning" - ] - } - }, - { - "name": [ - "-s", - "--save" - ], - "description": "Save access token" + name: ["-a", "--alias"], + description: "The alias associated to the application", + args: { + description: "", + }, }, { - "name": [ - "-i", - "--info" - ], - "description": "Show access token info" + name: "--appkey", + description: "Cli application key", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-S", - "--shared" - ], - "description": "Organization shared secret", - "args": {}, - "hidden": true + name: ["-A", "--api"], + description: "Specific api application", + args: { + description: "", + suggestions: ["core", "provisioning"], + }, }, { - "name": [ - "-M", - "--minutes" - ], - "description": "Minutes to token expiration [2, 240]", - "args": {}, - "hidden": true - } + name: ["-s", "--save"], + description: "Save access token", + }, + { + name: ["-i", "--info"], + description: "Show access token info", + }, + { + name: ["-S", "--shared"], + description: "Organization shared secret", + args: { + description: "", + }, + hidden: true, + }, + { + name: ["-M", "--minutes"], + description: "Minutes to token expiration [2, 240]", + args: { + description: "", + }, + hidden: true, + }, ], - "hidden": false + hidden: false, }, { - "name": [ - "cli:update", - "upgrade", - "latest" - ], - "description": "Update commerce layer cli", - "options": [ + name: ["cli:update", "upgrade", "latest"], + description: "Update commerce layer cli", + options: [ { - "name": [ - "-v", - "--version" - ], - "description": "Update cli to a specific version or tag", - "args": {} - } - ] + name: ["-v", "--version"], + description: "Update cli to a specific version or tag", + args: { + description: "", + }, + }, + ], }, { - "name": [ - "cli:version", - "version" - ], - "description": "Show installed version of commerce layer cli", - "options": [ + name: ["cli:version", "version"], + description: "Show installed version of commerce layer cli", + options: [ { - "name": [ - "-p", - "--plugins" - ], - "description": "Show version of installed plugins" - } - ] + name: ["-p", "--plugins"], + description: "Show version of installed plugins", + }, + ], }, { - "name": [ - "plugins:available" - ], - "description": "Show all available commerce layer cli plugins", - "options": [ + name: "plugins:available", + description: "Show all available commerce layer cli plugins", + options: [ { - "name": [ - "-H", - "--hidden" - ], - "description": "Show also enabled but hidden plugins", - "hidden": true - } - ] + name: ["-H", "--hidden"], + description: "Show also enabled but hidden plugins", + hidden: true, + }, + ], }, { - "name": [ - "plugins:latest" - ], - "description": "Show latest version of available plugins", - "options": [ + name: "plugins:latest", + description: "Show latest version of available plugins", + options: [ { - "name": [ - "-b", - "--beta" - ], - "description": "Retrieve latest version from beta channel" - } + name: ["-b", "--beta"], + description: "Retrieve latest version from beta channel", + }, ], - "args": [ - { - "name": "plugin", - "description": "The name of the plugin", - "isOptional": true - } - ] + args: { + name: "plugin", + description: "The name of the plugin", + isOptional: true, + }, }, { - "name": [ - "microstore" - ], - "description": "Create microstore urls", - "options": [ + name: "checkout", + description: "Create checkout urls", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-a", - "--accessToken" - ], - "args": {}, - "isRequired": true, - "hidden": false + name: ["-a", "--accessToken"], + description: "Custom access token to use instead of the one used for login", + args: { + description: "", + }, + isRequired: true, + hidden: false, }, { - "name": "--open", - "description": "Open microstore url in default browser" + name: "--open", + description: "Open checkout url in default browser", }, { - "name": [ - "-S", - "--skuListId" - ], - "description": "The sku list id", - "args": {}, - "isRequired": true + name: "--staging", + description: "Connect to checkout application in staging environment", + hidden: true, }, { - "name": [ - "-A", - "--all" - ], - "description": "Activate the buy all button " + name: ["-O", "--order"], + description: "An order id", + args: { + description: "", + }, }, { - "name": [ - "-C", - "--cart" - ], - "description": "Activate the cart application" + name: ["-S", "--sku"], + description: "An sku code", + args: { + description: "", + }, }, { - "name": [ - "-I", - "--inline" - ], - "description": "Disable redirect to cart application" - } - ] - }, - { - "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: ["-B", "--bundle"], + description: "A bundle code", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print users answers", - "hidden": true + name: ["-m", "--market"], + description: "A market number", + args: { + description: "", + }, }, { - "name": [ - "-i", - "--info" - ], - "description": "Print generated token info" + name: ["-c", "--coupon"], + description: "A promo code", + args: { + description: "", + }, }, { - "name": [ - "-c", - "--check" - ], - "description": "Check generated access token" - } - ] + name: ["-e", "--email"], + description: "A customer email", + args: { + description: "", + }, + }, + ], }, { - "name": [ - "token:get" - ], - "description": "Get a new access token", - "options": [ + name: "checkout:order", + description: "Create checkout urls starting from an existing order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-i", - "--clientId" - ], - "description": "Application client_id", - "args": {}, - "isRequired": true + name: ["-a", "--accessToken"], + description: "Custom access token to use instead of the one used for login", + args: { + description: "", + }, + isRequired: true, + hidden: false, }, { - "name": [ - "-s", - "--clientSecret" - ], - "description": "Application client_secret", - "args": {} + name: "--open", + description: "Open checkout url in default browser", }, { - "name": [ - "-S", - "--scope" - ], - "description": "Access token scope (market, stock location)", - "args": {} + name: "--staging", + description: "Connect to checkout application in staging environment", + 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", + options: [ { - "name": [ - "-e", - "--email" - ], - "description": "Customer email", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--password" - ], - "description": "Customer secret password", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--info", - "description": "Show access token info" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-P", - "--provisioning" - ], - "description": "Execute login to provisioning api" - } - ] - }, - { - "name": [ - "token:revoke" - ], - "description": "Revoke a commerce layer access token", - "options": [ + name: ["-A", "--all"], + description: "Show all imports instead of first 25 only", + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {} + name: ["-t", "--type"], + description: "The type of resource imported", + args: { + description: "", + 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": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-g", "--group"], + description: "The group id associated to the import in case of multi-chunk imports", + args: { + description: "", + }, }, { - "name": [ - "-i", - "--clientId" - ], - "description": "Application client_id", - "args": {}, - "isRequired": true + name: ["-s", "--status"], + description: "The import job status", + args: { + description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, }, { - "name": [ - "-s", - "--clientSecret" - ], - "description": "Application client_secret", - "args": {} + name: ["-e", "--errors"], + description: "Show only imports with errors", }, { - "name": [ - "-S", - "--scope" - ], - "description": "Access token scope", - "args": {} + name: ["-w", "--warnings"], + description: "Show only import with warnings", }, { - "name": [ - "-P", - "--provisioning" - ], - "description": "Execute login to provisioning api" - } + name: ["-l", "--limit"], + description: "Limit number of imports in output", + args: { + description: "", + }, + }, ], - "args": [ - { - "name": "token", - "description": "Access token to revoke" - } - ] + args: { + name: "id", + description: "Unique id of the import to be retrieved", + isOptional: true, + }, }, { - "name": [ - "webhooks" - ], - "description": "List all the registered webhooks or the details of a single webhook", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true - }, + name: ["imports:create", "imp:create", "import"], + description: "Create a new import", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + 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: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-H", - "--hide-empty" - ], - "description": "Hide empty attributes" + 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": [ - "-e", - "--events" - ], - "description": "Show the last event callbacks associated to the webhook" - } - ], - "args": [ - { - "name": "id", - "description": "Unique id of the webhook to get a single webhook", - "isOptional": true - } - ] - }, - { - "name": [ - "webhooks:create", - "wh:create" - ], - "description": "Create a new webhook", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-p", "--parent"], + description: "The id of the parent resource to be associated with imported data", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-i", "--inputs"], + description: "The path of the file containing the data to import", + args: { + description: "", + }, + isRequired: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-C", "--csv"], + description: "Accept input file in csv format", }, { - "name": [ - "-t", - "--topic" - ], - "description": "The identifier of the event that will trigger the webhook", - "args": {}, - "isRequired": true + name: ["-D", "--delimiter"], + description: "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", + args: { + description: "", + suggestions: [",", ";", "|", "TAB"], + }, }, { - "name": [ - "-u", - "--url" - ], - "description": "The callback url used to post data", - "args": {}, - "isRequired": true + name: ["-b", "--blind"], + description: "Execute in blind mode without showing the progress monitor", }, { - "name": [ - "-i", - "--include" - ], - "description": "A comma separated list of related resources to be included", - "args": {} + name: ["-q", "--quiet"], + description: "Execute command without showing warning messages", }, - { - "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: ["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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - } + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, ], - "args": [ - { - "name": "id", - "description": "Unique id of the webhook" - } - ] + args: { + name: "id", + description: "Unique id of the import", + }, }, { - "name": [ - "webhooks:details", - "wh:details" - ], - "description": "Show the details of an existing webhook", - "options": [ + name: ["imports:details", "imp:details"], + description: "Show the details of an existing import", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-H", - "--hide-empty" - ], - "description": "Hide empty attributes" + name: ["-i", "--inputs"], + description: "Show input items associated with the import", }, { - "name": [ - "-e", - "--events" - ], - "description": "Show the last event callbacks associated to the webhook" - } - ], - "args": [ + name: ["-l", "--logs"], + description: "Show warning and error logs related to the import process", + }, { - "name": "id", - "description": "Unique id of the webhook" - } - ] + name: ["-S", "--save-inputs"], + description: "Save import inputs to local file", + args: { + description: "", + }, + }, + ], + args: { + name: "id", + description: "Unique id of the import", + }, }, { - "name": [ - "webhooks:event", - "wh:event" - ], - "description": "Show the details of a firedf webhook event", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true - }, + name: ["imports:group", "imp:group"], + description: "List all the imports related to an import group", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-p", - "--payload" - ], - "description": "Show the event payload sent to the callback endpoint" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, - { - "name": [ - "-f", - "--format" - ], - "description": "Format the payload output" - } ], - "args": [ - { - "name": "id", - "description": "Unique id of the webhook" - } - ] + args: { + name: "group_id", + description: "Unique id of the group import", + }, }, { - "name": [ - "webhooks:events", - "wh:events" - ], - "description": "List all the events associated to the webhook", - "options": [ + 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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-A", - "--all" - ], - "description": "Show all events instead of first 25 only " + name: ["-A", "--all"], + description: "Show all imports instead of first 25 only", }, { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of events in output", - "args": {} - } - ], - "args": [ + name: ["-t", "--type"], + description: "The type of resource imported", + args: { + description: "", + 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": "id", - "description": "Unique id of the webhook" - } - ] - }, - { - "name": [ - "webhooks:list", - "wh:list" - ], - "description": "List all the registered webhooks", - "options": [ + name: ["-g", "--group"], + description: "The group id associated to the import in case of multi-chunk imports", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-s", "--status"], + description: "The import job status", + args: { + description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-e", "--errors"], + description: "Show only imports with errors", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-w", "--warnings"], + description: "Show only import with warnings", }, { - "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: ["-l", "--limit"], + description: "Limit number of imports in output", + args: { + description: "", + }, + }, + ], }, { - "name": [ - "webhooks:listen", - "wh:listen" - ], - "description": "Listen a webhook for outgoing callbacks", - "options": [ + name: ["imports:types", "imp:types"], + description: "Show online documentation for supported resources", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-O", "--open"], + description: "Open online documentation page", }, + ], + }, + { + name: "microstore", + description: "Create microstore urls", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-t", - "--time" - ], - "description": "Waiting time for the first event", - "args": { - "default": "120" - } - } - ], - "args": [ + name: ["-a", "--accessToken"], + args: { + description: "", + }, + isRequired: true, + hidden: false, + }, { - "name": "id", - "description": "Unique id of the webhook" - } - ] - }, - { - "name": [ - "webhooks:payload", - "wh:payload" - ], - "description": "Show the payload associated to an event callback", - "options": [ + name: "--open", + description: "Open microstore url in default browser", + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-S", "--skuListId"], + description: "The sku list id", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-A", "--all"], + description: "Activate the buy all button", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-C", "--cart"], + description: "Activate the cart application", }, { - "name": [ - "-f", - "--format" - ], - "description": "Format the payload output" - } + name: ["-I", "--inline"], + description: "Disable redirect to cart application", + }, ], - "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: "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: { + description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-u", "--url"], + description: "Seeder data url", + args: { + description: "", + default: "https://data.commercelayer.app/seeder", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - } - ], - "args": [ + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: { + description: "", + }, + }, { - "name": "id", - "description": "Unique id of the webhook" - } - ] - }, - { - "name": [ - "webhooks:topics", - "wh:topics" + name: "--debug", + description: "Show command debug information", + hidden: true, + }, + { + name: ["-r", "--relationships"], + description: "Check resource relationships", + }, ], - "description": "Show online documentation for supported events" }, { - "name": [ - "webhooks:update", - "wh:update" - ], - "description": "Update an existing webhook", - "options": [ + name: "seeder:clean", + description: "Clean previously imported 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: { + description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-u", "--url"], + description: "Seeder data url", + args: { + description: "", + default: "https://data.commercelayer.app/seeder", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: { + description: "", + }, }, { - "name": [ - "-t", - "--topic" - ], - "description": "The identifier of the event that will trigger the webhook", - "args": {} + name: "--debug", + description: "Show debug information", + hidden: true, }, { - "name": [ - "-u", - "--url" - ], - "description": "The callback url used to post data", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "A comma separated list of related resources to be included", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The webhook short name", - "args": {} - } + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, ], - "args": [ - { - "name": "id", - "description": "Unique id of the webhook" - } - ] }, { - "name": [ - "checkout" - ], - "description": "Create checkout urls", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true - }, + name: ["seeder:seed", "seed"], + description: "Execute commerce layer seeder", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", + args: { + description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", + }, }, { - "name": [ - "-a", - "--accessToken" - ], - "description": "Custom access token to use instead of the one used for login", - "args": {}, - "isRequired": true, - "hidden": false + name: ["-u", "--url"], + description: "Seeder data url", + args: { + description: "", + default: "https://data.commercelayer.app/seeder", + }, }, { - "name": "--open", - "description": "Open checkout url in default browser" + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: { + description: "", + }, }, { - "name": "--staging", - "description": "Connect to checkout application in staging environment", - "hidden": true + name: "--debug", + description: "Show debug information", + hidden: true, }, { - "name": [ - "-O", - "--order" - ], - "description": "An order id", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-S", - "--sku" - ], - "description": "An sku code", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-B", - "--bundle" - ], - "description": "A bundle code", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-m", - "--market" - ], - "description": "A market number", - "args": {} + name: ["-k", "--keep"], + description: "Keep existing resources without updating them", }, { - "name": [ - "-c", - "--coupon" - ], - "description": "A promo code", - "args": {} + name: ["-D", "--delay"], + description: "Add a delay in milliseconds between calls to different resources", + args: { + description: "", + }, + hidden: true, }, - { - "name": [ - "-e", - "--email" - ], - "description": "A customer email", - "args": {} - } - ] + ], }, { - "name": [ - "checkout:order" - ], - "description": "Create checkout urls starting from an existing order", - "options": [ + 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": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-p", "--print"], + description: "Print users answers", + hidden: true, }, { - "name": [ - "-a", - "--accessToken" - ], - "description": "Custom access token to use instead of the one used for login", - "args": {}, - "isRequired": true, - "hidden": false + name: ["-i", "--info"], + description: "Print generated token info", }, { - "name": "--open", - "description": "Open checkout url in default browser" + name: ["-c", "--check"], + description: "Check generated access token", }, - { - "name": "--staging", - "description": "Connect to checkout application in staging environment", - "hidden": true - } ], - "args": [ - { - "name": "id", - "description": "Unique id of the order" - } - ] }, { - "name": [ - "resources" - ], - "description": "List all the available commerce layer api resources", - "options": [ + name: "token:get", + description: "Get a new access token", + options: [ { - "name": [ - "-h", - "--help" - ], - "description": "Show cli help." - } - ] - }, - { - "name": [ - "resources:all", - "all", - "ra", - "res:all" - ], - "description": "Fetch all resources", - "options": [ + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-i", "--clientId"], + description: "Application client_id", + args: { + description: "", + }, + isRequired: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-s", "--clientSecret"], + description: "Application client_secret", + args: { + description: "", + }, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-S", "--scope"], + description: "Access token scope (market, stock location)", + args: { + description: "", + }, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-e", "--email"], + description: "Customer email", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-p", "--password"], + description: "Customer secret password", + args: { + description: "", + }, }, { - "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: "token:revoke", + description: "Revoke a commerce layer access token", + options: [ { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-i", "--clientId"], + description: "Application client_id", + args: { + description: "", + }, + 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", + args: { + description: "", + }, }, { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + name: ["-S", "--scope"], + description: "Access token scope", + args: { + description: "", + }, }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + name: ["-P", "--provisioning"], + description: "Execute login to provisioning api", }, + ], + args: { + name: "token", + description: "Access token to revoke", + }, + }, + { + name: "orders", + description: "Execute an action on an order", + options: [ { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-N", - "--notify" - ], - "description": "Force system notification when export has finished", - "hidden": true + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-i", - "--clientId" - ], - "description": "Organization client_id", - "args": {}, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:approve", + description: "Send this attribute if you want to approve a placed order", + options: [ { - "name": [ - "-s", - "--clientSecret" - ], - "description": "Organization client_secret", - "args": {}, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-C", - "--csv" - ], - "description": "Export fields in csv format" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-D", - "--delimiter" - ], - "description": "The delimiter character to use in the csv output file (one of ',', ';', '|', tab)", - "args": { - "suggestions": [ - ",", - ";", - "|", - "TAB" - ] - } - }, - { - "name": [ - "-H", - "--header" - ], - "description": "Rename column headers defining a comma-separated list of values field:\"renamed title\"", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-b", - "--blind" - ], - "description": "Execute in blind mode without prompt and progress bar" + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-T", - "--timeout" - ], - "description": "Set request timeout in milliseconds [1000 - 15000]", - "args": {}, - "hidden": true - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "resource", - "description": "The resource type" - } - ] + args: { + name: "id", + description: "The unique id of the order", + }, }, { - "name": [ - "resources:args", - "res:args" - ], - "description": "Show all the saved command arguments", - "options": [ + name: "orders:approve_and_capture", + description: "Send this attribute if you want to approve and capture a placed order", + options: [ { - "name": [ - "-a", - "--alias" - ], - "description": "The alias associated to saved command arguments", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-r", - "--resource" - ], - "description": "The resource type", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "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: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-P", - "--pretty" - ], - "description": "Show saved arguments in table format", - "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": [ - "resources:count", - "count", - "res:count", - "rs:count" - ], - "description": "Count the number of existent resources", - "options": [ + name: "orders:archive", + description: "Send this attribute if you want to archive the order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} - } - ], - "args": [ + name: ["-j", "--json"], + description: "Print result in json format", + }, { - "name": "resource", - "description": "The resource type" - } - ] + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, }, { - "name": [ - "resources:create", - "create", - "rc", - "res:create", - "post" - ], - "description": "Create a new resource", - "options": [ + name: "orders:authorization_amount_cents", + description: "The authorization amount, in cents", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:authorize", + description: "Send this attribute if you want to authorize the order's payment source", + options: [ { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:billing_address_clone_id", + description: "The id of the address that you want to clone to create the order's billing addre", + options: [ { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-a", - "--attribute" - ], - "description": "Define a resource attribute", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-O", - "--object" - ], - "description": "Define a resource object attribute", - "args": {} + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, { - "name": [ - "-r", - "--relationship" - ], - "description": "Define a relationship with another resource", - "args": {} + name: ["-v", "--value"], + description: "The trigger attribute value", + args: { + description: "", + }, + isRequired: true, }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:billing_address_same_as_shipping", + description: "Send this attribute if you want the billing address to be cloned from the order'", + options: [ { - "name": [ - "-m", - "--metadata" - ], - "description": "Define a metadata attribute or a set of metadata attributes", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-D", - "--data" - ], - "description": "The data file to use as request body", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-t", - "--tags" - ], - "description": "List of tags associated with the resource", - "args": {} - } - ], - "args": [ + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, { - "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" - ] - } - ] + 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": [ - "resources:delete", - "delete", - "rd", - "res:delete" - ], - "description": "Delete an existing resource", - "options": [ + name: "orders:cancel", + description: "Send this attribute if you want to cancel a placed order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:capture", + description: "Send this attribute if you want to capture an authorized order", + options: [ { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:commit_invoice", + description: "Send this attribute if you want commit the sales tax invoice to the associated t", + options: [ { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" - } + 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": [ + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:create_subscriptions", + description: "Send this attribute upon/after placing the order if you want to create order sub", + options: [ { - "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" - ] + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "id", - "description": "Id of the resource to delete", - "isOptional": true - } - ] - }, - { - "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"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:customer_payment_source_id", + description: "The id of the customer payment source (i", + options: [ { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-v", "--value"], + description: "The trigger attribute value", + args: { + description: "", + }, + isRequired: true, }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:nullify_payment_source", + description: "Send this attribute if you want to nullify the payment source for this order", + options: [ { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:pending", + description: "Send this attribute if you want to move a draft or placing order to pending", + options: [ { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-p", - "--page" - ], - "description": "Page number", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-n", - "--pageSize" - ], - "description": "Number of elements per page", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true - } - ], - "args": [ - { - "name": "path", - "description": "Path (or url) of the resource(s) to fetch" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "name": "id", - "description": "Resource id", - "isOptional": true - } - ] - }, - { - "name": [ - "resources:filters", - "res:filters" ], - "description": "Show a list of all available filter predicates" + args: { + name: "id", + description: "The unique id of the order", + }, }, { - "name": [ - "resources:get", - "get", - "res:get", - "rg" - ], - "description": "Retrieve a resource or list a set of resources", - "options": [ + name: "orders:place", + description: "Send this attribute if you want to place the order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:refresh", + description: "Send this attribute if you want to manually refresh the order", + options: [ { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:refund", + description: "Send this attribute if you want to refund a captured order", + options: [ { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-p", - "--page" - ], - "description": "Page number", - "args": {} + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:refund_invoice", + description: "Send this attribute if you want refund the sales tax invoice to the associated t", + options: [ { - "name": [ - "-n", - "--pageSize" - ], - "description": "Number of elements per page", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true - } - ], - "args": [ - { - "name": "resource", - "description": "The resource type" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "name": "id", - "description": "Id of the resource to retrieve", - "isOptional": true - } - ] + ], + args: { + name: "id", + description: "The unique id of the order", + }, }, { - "name": [ - "resources:list", - "list", - "rl", - "res:list" - ], - "description": "Fetch a collection of resources", - "options": [ + name: "orders:reset_circuit", + description: "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders: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", + options: [ { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:save_payment_source_to_customer_wallet", + description: "Send this attribute if you want the order's payment source to be saved in the cu", + options: [ { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-p", - "--page" - ], - "description": "Page number", - "args": {} + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders: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": [ - "-n", - "--pageSize" - ], - "description": "Number of elements per page", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true - } - ], - "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", - "relationship", - "resources:rel", - "res:rel", - "res:relationship", - "relationship" - ], - "description": "Fetch a resource relationship", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:shipping_address_clone_id", + description: "The id of the address that you want to clone to create the order's shipping addr", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-v", "--value"], + description: "The trigger attribute value", + args: { + description: "", + }, + isRequired: true, }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:shipping_address_same_as_billing", + description: "Send this attribute if you want the shipping address to be cloned from the order", + options: [ { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + 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: { + description: "", + }, + hidden: true, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} - }, - { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:start_editing", + description: "Send this attribute if you want to edit the order after it is placed", + options: [ { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-p", - "--page" - ], - "description": "Page number", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-n", - "--pageSize" - ], - "description": "Number of elements per page", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:stop_editing", + description: "Send this attribute to stop the editing for the order and return back to placed", + options: [ { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true - } - ], - "args": [ + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, { - "name": "resource", - "description": "The resource type" + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": "id", - "description": "Id of the resource to retrieve" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "relationship", - "description": "Name of the relationship field" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "hidden": false + args: { + name: "id", + description: "The unique id of the order", + }, }, { - "name": [ - "resources:retrieve", - "retrieve", - "rr", - "res:retrieve" - ], - "description": "Fetch a single resource", - "options": [ + name: "orders:unarchive", + description: "Send this attribute if you want to unarchive the order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:update_taxes", + description: "Send this attribute if you want to force tax calculation for this order (a tax c", + options: [ { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:validate", + description: "Send this attribute if you want to trigger the external validation for the order", + options: [ { - "name": "--save-args", - "description": "Save command data to file for future use", - "args": {} + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-p", "--print"], + description: "Print out the modified order", }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "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", - "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 - } - ] + args: { + name: "id", + description: "The unique id of the order", + }, }, { - "name": [ - "resources:schema", - "schema", - "res:schema", - "rs" + name: "resources", + description: "List all the available commerce layer api resources", + options: [ + { + name: ["-h", "--help"], + description: "Show cli help", + }, ], - "description": "Show the current commercelayer openapi schema version used by the plugin" }, { - "name": [ - "resources:update", - "update", - "ru", - "res:update", - "patch" - ], - "description": "Update an existing resource", - "options": [ + name: ["resources:all", "all", "ra", "res:all"], + description: "Fetch all resources", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + 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: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + 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: "--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: "--save-args", + description: "Save command data to file for future use", + args: { + description: "", + }, }, { - "name": "--load-args", - "description": "Load previously saved command arguments", - "args": {} + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, }, { - "name": [ - "-a", - "--attribute" - ], - "description": "Define a resource attribute", - "args": {} + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, }, { - "name": [ - "-O", - "--object" - ], - "description": "Define a resource object attribute", - "args": {} + name: ["-X", "--save-path"], + description: "Save command output to file and create missing path directories", + args: { + description: "", + }, }, { - "name": [ - "-r", - "--relationship" - ], - "description": "Define a relationship with another resource", - "args": {} + name: ["-N", "--notify"], + description: "Force system notification when export has finished", + hidden: true, }, { - "name": [ - "-m", - "--metadata" - ], - "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource", - "args": {} + name: "--clientId", + description: "Organization client_id", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-M", - "--metadata-replace" - ], - "description": "Define a metadata attribute and replace every item already present in the remote resource", - "args": {} + name: "--clientSecret", + description: "Organization client_secret", + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-D", - "--data" - ], - "description": "The data file to use as request body", - "args": {} + name: ["-C", "--csv"], + description: "Export fields in csv format", }, { - "name": [ - "-t", - "--tags" - ], - "description": "List of tags associated with the resource", - "args": {} - } + name: ["-D", "--delimiter"], + description: "", + args: { + description: "", + suggestions: [",", ";", "|", "TAB"], + }, + }, + { + name: ["-H", "--header"], + description: "", + args: { + description: "", + }, + }, + { + name: ["-b", "--blind"], + description: "Execute in blind mode without prompt and progress bar", + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, + }, + { + name: ["-T", "--timeout"], + description: "Set request timeout in milliseconds [1000 - 15000]", + args: { + description: "", + }, + hidden: true, + }, ], - "args": [ + args: { + name: "resource", + description: "The resource type", + }, + }, + { + name: ["resources:args", "res:args"], + description: "Show all the saved command arguments", + 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", + name: ["-a", "--alias"], + description: "The alias associated to saved command arguments", + args: { + description: "", + }, + }, + { + name: ["-r", "--resource"], + description: "The resource type", + args: { + description: "", + }, + }, + { + name: ["-o", "--operation"], + description: "The resource operation", + args: { + description: "", + 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: ["resources:count", "count", "res:count", "rs:count"], + description: "Count the number of existent resources", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, + }, + ], + args: { + name: "resource", + description: "The resource type", + }, + }, + { + name: ["resources:create", "create", "rc", "res:create", "post"], + description: "Create a new resource", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, + }, + { + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, + }, + { + 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: { + description: "", + 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: { + description: "", + }, + }, + { + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, + }, + { + name: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-a", "--attribute"], + description: "Define a resource attribute", + args: { + description: "", + }, + }, + { + name: ["-O", "--object"], + description: "Define a resource object attribute", + args: { + description: "", + }, + }, + { + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", + args: { + description: "", + }, + }, + { + name: ["-m", "--metadata"], + description: "Define a metadata attribute or a set of metadata attributes", + args: { + description: "", + }, + }, + { + name: ["-D", "--data"], + description: "The data file to use as request body", + args: { + description: "", + }, + }, + { + name: ["-t", "--tags"], + description: "List of tags associated with the resource", + args: { + description: "", + }, + }, + ], + 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", + "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", + ], + }, + }, + { + name: ["resources:delete", "delete", "rd", "res:delete"], + description: "Delete an existing resource", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, + }, + { + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, + }, + { + 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: { + description: "", + 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: { + description: "", + }, + }, + { + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, + }, + { + name: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + ], + 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", + "customer", + "customer_address", + "customer_group", "customer_password_reset", "customer_payment_source", "customer_subscription", "delivery_lead_time", + "export", "external_gateway", "external_payment", "external_promotion", @@ -4272,6 +3692,7 @@ const completionSpec: Fig.Spec = { "gift_card", "gift_card_recipient", "google_geocoder", + "import", "in_stock_subscription", "inventory_model", "inventory_return_location", @@ -4330,13810 +3751,11310 @@ const completionSpec: Fig.Spec = { "tax_rule", "taxjar_account", "webhook", - "wire_transfer" - ] + "wire_transfer", + ], }, { - "name": "id", - "description": "Id of the resource to update", - "isOptional": true - } - ] + name: "id", + description: "Id of the resource to delete", + isOptional: true, + }, + ], }, { - "name": [ - "adyen_payment" - ], - "description": "Execute an action on a resource of type adyen_payments", - "options": [ + name: ["resources:doc", "res:doc", "doc"], + description: "Open the default browser and show the online documentation for the resource", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-p", "--page"], + description: "The doc page you want to access", + args: { + description: "", + 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": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, + }, { - "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: ["-j", "--json"], + description: "Convert output in standard json format", + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--doc", + description: "Show the cli command in a specific language", }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "authorization" - ], - "description": "Execute an action on a resource of type authorizations", - "options": [ + name: "--save-args", + description: "Save command data to file for future use", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-X", "--save-path"], + description: "Save command output to file and create missing path directories", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "authorization:capture" - ], - "description": "Send this attribute if you want to create a capture for this authorization.", - "options": [ + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-p", "--page"], + description: "Page number", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: { + description: "", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, }, + ], + args: [ { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: "path", + description: "Path (or url) of the resource(s) to fetch", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: "id", + description: "Resource id", + isOptional: true, + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] }, { - "name": [ - "authorization:capture_amount_cents" - ], - "description": "The associated capture amount, in cents.", - "options": [ + 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" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "authorization:void" - ], - "description": "Send this attribute if you want to create a void for this authorization.", - "options": [ + name: ["-j", "--json"], + description: "Convert output in standard json format", + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--doc", + description: "Show the cli command in a specific language", }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "axerve_payment" - ], - "description": "Execute an action on a resource of type axerve_payments", - "options": [ + name: "--save-args", + description: "Save command data to file for future use", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-p", "--page"], + description: "Page number", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: { + description: "", + }, + }, + { + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, + }, + { + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, + }, + { + name: ["-X", "--save-path"], + description: "Save command output to file and create missing path directories", + args: { + description: "", + }, + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, + }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, + }, ], - "args": [ + args: [ + { + name: "resource", + description: "The resource type", + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, + }, + ], }, { - "name": [ - "axerve_payment:update" - ], - "description": "Send this attribute if you want to update the payment with fresh order data.", - "options": [ + name: ["resources:list", "list", "rl", "res:list"], + description: "Fetch a collection of resources", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-j", "--json"], + description: "Convert output in standard json format", + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "bundle" - ], - "description": "Execute an action on a resource of type bundles", - "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": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: "--save-args", + description: "Save command data to file for future use", + args: { + description: "", + }, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "bundle:compute_compare_at_amount" - ], - "description": "Send this attribute if you want to compute the compare_at_amount_cents as the sum of the prices of the bundle skus for the market.", - "options": [ + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--page"], + description: "Page number", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "bundle:compute_price_amount" - ], - "description": "Send this attribute if you want to compute the price_amount_cents as the sum of the prices of the bundle skus for the market.", - "options": [ + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, + }, { - "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", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, + }, + ], + 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", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "buy_x_pay_y_promotion" - ], - "description": "Execute an action on a resource of type buy_x_pay_y_promotions", - "options": [ + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: "--doc", + description: "Show the cli command in a specific language", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "buy_x_pay_y_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "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", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-p", "--page"], + description: "Page number", + args: { + description: "", + }, + }, + { + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: { + description: "", + }, + }, + { + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, + }, + { + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, + }, + { + name: ["-X", "--save-path"], + description: "Save command output to file and create missing path directories", + args: { + description: "", + }, + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, + }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, + }, ], - "args": [ + args: [ { - "name": "id", - "description": "The unique id of the resource" - } - ] + name: "resource", + description: "The resource type", + }, + { + name: "id", + description: "Id of the resource to retrieve", + }, + { + name: "relationship", + description: "Name of the relationship field", + }, + ], + hidden: false, }, { - "name": [ - "buy_x_pay_y_promotion:enable" - ], - "description": "Send this attribute if you want to mark the promotion as enabled.", - "options": [ + 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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-j", "--json"], + description: "Convert output in standard json format", + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "capture" - ], - "description": "Execute an action on a resource of type captures", - "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": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: "--save-args", + description: "Save command data to file for future use", + args: { + description: "", + }, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "capture:refund" - ], - "description": "Send this attribute if you want to create a refund for this capture.", - "options": [ + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-X", "--save-path"], + description: "Save command output to file and create missing path directories", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, }, + ], + args: [ { - "name": [ - "-u", - "--unformatted" + 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", ], - "description": "Print json output without indentation" - } - ], - "args": [ + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, + }, + ], }, { - "name": [ - "capture:refund_amount_cents" - ], - "description": "The associated refund amount, in cents.", - "options": [ + name: ["resources:schema", "schema", "res:schema", "rs"], + description: "Show the current commercelayer openapi schema version used by the plugin", + }, + { + name: ["resources:update", "update", "ru", "res:update", "patch"], + description: "Update an existing resource", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-j", "--json"], + description: "Convert output in standard json format", + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] - }, - { - "name": [ - "checkout_com_payment" - ], - "description": "Execute an action on a resource of type checkout_com_payments", - "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": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: "--save-args", + description: "Save command data to file for future use", + args: { + description: "", + }, + }, + { + name: "--load-args", + description: "Load previously saved command arguments", + args: { + description: "", + }, + }, + { + name: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-a", "--attribute"], + description: "Define a resource attribute", + args: { + description: "", + }, + }, + { + name: ["-O", "--object"], + description: "Define a resource object attribute", + args: { + description: "", + }, + }, + { + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", + args: { + description: "", + }, + }, + { + name: ["-m", "--metadata"], + description: "", + args: { + description: "", + }, + }, + { + name: ["-M", "--metadata-replace"], + description: "", + args: { + description: "", + }, + }, + { + name: ["-D", "--data"], + description: "The data file to use as request body", + args: { + description: "", + }, + }, + { + name: ["-t", "--tags"], + description: "List of tags associated with the resource", + args: { + description: "", + }, + }, ], - "args": [ + args: [ { - "name": "id", - "description": "The unique id of the resource" - } - ] + 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: "id", + description: "Id of the resource to update", + isOptional: true, + }, + ], }, { - "name": [ - "checkout_com_payment:details" - ], - "description": "Send this attribute if you want to send additional details the payment request (i.e. upon 3ds check).", - "options": [ + name: "webhooks", + description: "List all the registered webhooks or the details of a single webhook", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-c", "--circuit"], + description: "Show only webhooks with circuit in the declared state", + args: { + description: "", + suggestions: ["open", "closed"], + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-t", "--topic"], + description: "The event that triggered the webhook", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] + name: ["-e", "--events"], + description: "Show the last event callbacks associated to the webhook", + }, + ], + args: { + name: "id", + description: "Unique id of the webhook to get a single webhook", + isOptional: true, + }, }, { - "name": [ - "checkout_com_payment:refresh" - ], - "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", - "options": [ + name: ["webhooks:create", "wh:create"], + description: "Create a new webhook", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-t", "--topic"], + description: "The identifier of the event that will trigger the webhook", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-u", "--url"], + description: "The callback url used to post data", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-i", "--include"], + description: "A comma separated list of related resources to be included", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-n", "--name"], + description: "The webhook short name", + args: { + description: "", + }, + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] }, { - "name": [ - "customer_password_reset" - ], - "description": "Execute an action on a resource of type customer_password_resets", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true - }, - { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true - }, + name: ["webhooks:destroy", "webhooks:delete", "wh:delete", "wh:destroy"], + description: "Destroy an existing webhook", + options: [ { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, - { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - "name": [ - "customer_password_reset:reset_password_token" - ], - "description": "Send the 'reset_password_token' that you got on create when updating the customer password.", - "options": [ + name: ["webhooks:details", "wh:details"], + description: "Show the details of an existing webhook", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "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": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - "name": [ - "external_promotion" - ], - "description": "Execute an action on a resource of type external_promotions", - "options": [ + name: ["webhooks:event", "wh:event"], + description: "Show the details of a firedf webhook event", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--payload"], + description: "Show the event payload sent to the callback endpoint", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-f", "--format"], + description: "Format the payload output", }, - { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - "name": [ - "external_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + name: ["webhooks:events", "wh:events"], + description: "List all the events associated to the webhook", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-A", "--all"], + description: "Show all events instead of first 25 only", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-l", "--limit"], + description: "Limit number of events in output", + args: { + description: "", + }, }, - { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - "name": [ - "external_promotion:enable" - ], - "description": "Send this attribute if you want to mark the promotion as enabled.", - "options": [ + name: ["webhooks:list", "wh:list"], + description: "List all the registered webhooks", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-c", "--circuit"], + description: "Show only webhooks with circuit in the declared state", + args: { + description: "", + suggestions: ["open", "closed"], + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-t", "--topic"], + description: "The event that triggered the webhook", + args: { + description: "", + }, }, - { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] }, { - "name": [ - "fixed_amount_promotion" - ], - "description": "Execute an action on a resource of type fixed_amount_promotions", - "options": [ + 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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-t", "--time"], + description: "Waiting time for the first event", + args: { + description: "", + default: "120", + }, }, - { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - "name": [ - "fixed_amount_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + 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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + 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": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - "name": [ - "fixed_amount_promotion:enable" - ], - "description": "Send this attribute if you want to mark the promotion as enabled.", - "options": [ + 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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-t", "--topic"], + description: "The identifier of the event that will trigger the webhook", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-u", "--url"], + description: "The callback url used to post data", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-i", "--include"], + description: "A comma separated list of related resources to be included", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-n", "--name"], + description: "The webhook short name", + args: { + description: "", + }, + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - "name": [ - "fixed_price_promotion" - ], - "description": "Execute an action on a resource of type fixed_price_promotions", - "options": [ + 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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "fixed_price_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + 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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "fixed_price_promotion:enable" - ], - "description": "Send this attribute if you want to mark the promotion as enabled.", - "options": [ + name: "authorization", + description: "Execute an action on a resource of type authorizations", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "free_gift_promotion" - ], - "description": "Execute an action on a resource of type free_gift_promotions", - "options": [ + name: "authorization:capture", + description: "Send this attribute if you want to create a capture for this authorization", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "free_gift_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + name: "authorization:capture_amount_cents", + description: "The associated capture amount, in cents", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "free_gift_promotion:enable" - ], - "description": "Send this attribute if you want to mark the promotion as enabled.", - "options": [ + name: "authorization:void", + description: "Send this attribute if you want to create a void for this authorization", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "free_shipping_promotion" - ], - "description": "Execute an action on a resource of type free_shipping_promotions", - "options": [ + name: "axerve_payment", + description: "Execute an action on a resource of type axerve_payments", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "free_shipping_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + name: "axerve_payment:update", + description: "Send this attribute if you want to update the payment with fresh order data", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "free_shipping_promotion:enable" - ], - "description": "Send this attribute if you want to mark the promotion as enabled.", - "options": [ + name: "bundle", + description: "Execute an action on a resource of type bundles", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "gift_card" - ], - "description": "Execute an action on a resource of type gift_cards", - "options": [ + 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" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "gift_card:activate" - ], - "description": "Send this attribute if you want to activate a gift card.", - "options": [ + 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" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "gift_card:balance_change_cents" - ], - "description": "The balance change, in cents. send a negative value to reduces the card balance by the specified amount. send a positive value to recharge the gift card (if rechargeable).", - "options": [ + name: "buy_x_pay_y_promotion", + description: "Execute an action on a resource of type buy_x_pay_y_promotions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "gift_card:deactivate" - ], - "description": "Send this attribute if you want to deactivate a gift card.", - "options": [ + name: "buy_x_pay_y_promotion:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "gift_card:purchase" - ], - "description": "Send this attribute if you want to confirm a draft gift card. the gift card becomes 'inactive', waiting to be activated.", - "options": [ + name: "buy_x_pay_y_promotion:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "in_stock_subscription" - ], - "description": "Execute an action on a resource of type in_stock_subscriptions", - "options": [ + name: "capture", + description: "Execute an action on a resource of type captures", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "in_stock_subscription:activate" - ], - "description": "Send this attribute if you want to activate an inactive subscription.", - "options": [ + name: "capture:refund", + description: "Send this attribute if you want to create a refund for this capture", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "in_stock_subscription:deactivate" - ], - "description": "Send this attribute if you want to dactivate an active subscription.", - "options": [ + name: "capture:refund_amount_cents", + description: "The associated refund amount, in cents", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "klarna_payment" - ], - "description": "Execute an action on a resource of type klarna_payments", - "options": [ + name: "checkout_com_payment", + description: "Execute an action on a resource of type checkout_com_payments", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "klarna_payment:update" - ], - "description": "Send this attribute if you want to update the payment session with fresh order data.", - "options": [ + name: "checkout_com_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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "line_item" - ], - "description": "Execute an action on a resource of type line_items", - "options": [ + name: "checkout_com_payment:refresh", + description: "Send this attribute if you want to refresh all the pending transactions, can be", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "line_item:external_price" - ], - "description": "When creating or updating a new line item, set this attribute to '1' if you want to inject the unit_amount_cents price from an external source. any successive price computation will be done externally, until the attribute is reset to '0'.", - "options": [ + name: "customer_password_reset", + description: "Execute an action on a resource of type customer_password_resets", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "line_item:reserve_stock" - ], - "description": "Send this attribute if you want to reserve the stock for the line item's skus quantity. stock reservations expiration depends on the inventory model's cutoff. when used on update the existing active stock reservations are renewed.", - "options": [ + name: "customer_password_reset:reset_password_token", + description: "Send the 'reset_password_token' that you got on create when updating the custome", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "market" - ], - "description": "Execute an action on a resource of type markets", - "options": [ + name: "external_gateway", + description: "Execute an action on a resource of type external_gateways", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "market:disable" - ], - "description": "Send this attribute if you want to mark the market as disabled.", - "options": [ + name: "external_gateway:reset_circuit", + description: "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "market:enable" - ], - "description": "Send this attribute if you want to mark the market as enabled.", - "options": [ + name: "external_promotion", + description: "Execute an action on a resource of type external_promotions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order" - ], - "description": "Execute an action on a resource of type orders", - "options": [ + name: "external_promotion:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order_subscription" - ], - "description": "Execute an action on a resource of type order_subscriptions", - "options": [ + name: "external_promotion:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order_subscription:activate" - ], - "description": "Send this attribute if you want to mark this subscription as active.", - "options": [ + name: "external_promotion:reset_circuit", + description: "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order_subscription:cancel" - ], - "description": "Send this attribute if you want to mark this subscription as cancelled.", - "options": [ + name: "external_tax_calculator", + description: "Execute an action on a resource of type external_tax_calculators", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order_subscription:deactivate" - ], - "description": "Send this attribute if you want to mark this subscription as inactive.", - "options": [ + name: "external_tax_calculator:reset_circuit", + description: "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:approve" - ], - "description": "Send this attribute if you want to approve a placed order.", - "options": [ + name: "fixed_amount_promotion", + description: "Execute an action on a resource of type fixed_amount_promotions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:approve_and_capture" - ], - "description": "Send this attribute if you want to approve and capture a placed order.", - "options": [ + name: "fixed_amount_promotion:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:archive" - ], - "description": "Send this attribute if you want to archive the order.", - "options": [ + name: "fixed_amount_promotion:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:authorization_amount_cents" - ], - "description": "The authorization amount, in cents.", - "options": [ + name: "fixed_price_promotion", + description: "Execute an action on a resource of type fixed_price_promotions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:authorize" - ], - "description": "Send this attribute if you want to authorize the order's payment source.", - "options": [ + name: "fixed_price_promotion:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:billing_address_clone_id" - ], - "description": "The id of the address that you want to clone to create the order's billing address.", - "options": [ - { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true - }, + name: "fixed_price_promotion:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:billing_address_same_as_shipping" - ], - "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", - "options": [ + name: "free_gift_promotion", + description: "Execute an action on a resource of type free_gift_promotions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:cancel" - ], - "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", - "options": [ + name: "free_gift_promotion:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:capture" - ], - "description": "Send this attribute if you want to capture an authorized order.", - "options": [ + name: "free_gift_promotion:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:commit_invoice" - ], - "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", - "options": [ + name: "free_shipping_promotion", + description: "Execute an action on a resource of type free_shipping_promotions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:create_subscriptions" - ], - "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", - "options": [ + name: "free_shipping_promotion:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:customer_payment_source_id" - ], - "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", - "options": [ + name: "free_shipping_promotion:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:nullify_payment_source" - ], - "description": "Send this attribute if you want to nullify the payment source for this order.", - "options": [ + name: "gift_card", + description: "Execute an action on a resource of type gift_cards", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:place" - ], - "description": "Send this attribute if you want to place the order.", - "options": [ + name: "gift_card:activate", + description: "Send this attribute if you want to activate a gift card", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:refresh" - ], - "description": "Send this attribute if you want to manually refresh the order.", - "options": [ + name: "gift_card:balance_change_cents", + description: "The balance change, in cents", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:refund" - ], - "description": "Send this attribute if you want to refund a captured order.", - "options": [ + name: "gift_card:deactivate", + description: "Send this attribute if you want to deactivate a gift card", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:refund_invoice" - ], - "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", - "options": [ + name: "gift_card:purchase", + description: "Send this attribute if you want to confirm a draft gift card", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "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 customer's address book as a customer address.", - "options": [ + name: "in_stock_subscription", + description: "Execute an action on a resource of type in_stock_subscriptions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:save_payment_source_to_customer_wallet" - ], - "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", - "options": [ + name: "in_stock_subscription:activate", + description: "Send this attribute if you want to activate an inactive subscription", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "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 customer's address book as a customer address.", - "options": [ + name: "in_stock_subscription:deactivate", + description: "Send this attribute if you want to dactivate an active subscription", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:shipping_address_clone_id" - ], - "description": "The id of the address that you want to clone to create the order's shipping address.", - "options": [ + name: "klarna_payment", + description: "Execute an action on a resource of type klarna_payments", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:shipping_address_same_as_billing" - ], - "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", - "options": [ + name: "klarna_payment:update", + description: "Send this attribute if you want to update the payment session with fresh order d", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:start_editing" - ], - "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", - "options": [ + name: "line_item", + description: "Execute an action on a resource of type line_items", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:stop_editing" - ], - "description": "Send this attribute to stop the editing for the order and return back to placed status.", - "options": [ + 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" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:unarchive" - ], - "description": "Send this attribute if you want to unarchive the order.", - "options": [ + 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" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:update_taxes" - ], - "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", - "options": [ + name: "line_item:reset_circuit", + description: "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "order:validate" - ], - "description": "Send this attribute if you want to trigger the external validation for the order.", - "options": [ + name: "market", + description: "Execute an action on a resource of type markets", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "payment_method" - ], - "description": "Execute an action on a resource of type payment_methods", - "options": [ + name: "market:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "payment_method:disable" - ], - "description": "Send this attribute if you want to mark the payment method as disabled.", - "options": [ + name: "market:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "payment_method:enable" - ], - "description": "Send this attribute if you want to mark the payment method as enabled.", - "options": [ + name: "order", + description: "Execute an action on a resource of type orders", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "percentage_discount_promotion" - ], - "description": "Execute an action on a resource of type percentage_discount_promotions", - "options": [ + name: "order_subscription", + description: "Execute an action on a resource of type order_subscriptions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "percentage_discount_promotion:disable" - ], - "description": "Send this attribute if you want to mark the promotion as disabled.", - "options": [ + name: "order_subscription:activate", + description: "Send this attribute if you want to mark this subscription as active", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "percentage_discount_promotion:enable" - ], - "description": "Send this attribute if you want to mark the promotion as enabled.", - "options": [ + name: "order_subscription:cancel", + description: "Send this attribute if you want to mark this subscription as cancelled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return" - ], - "description": "Execute an action on a resource of type returns", - "options": [ + name: "order_subscription:deactivate", + description: "Send this attribute if you want to mark this subscription as inactive", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return_line_item" - ], - "description": "Execute an action on a resource of type return_line_items", - "options": [ + name: "order:approve", + description: "Send this attribute if you want to approve a placed order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return_line_item:restock" - ], - "description": "Send this attribute if you want to restock the line item.", - "options": [ + name: "order:approve_and_capture", + description: "Send this attribute if you want to approve and capture a placed order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:approve" - ], - "description": "Send this attribute if you want to mark this return as approved.", - "options": [ + name: "order:archive", + description: "Send this attribute if you want to archive the order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:archive" - ], - "description": "Send this attribute if you want to archive the return.", - "options": [ + name: "order:authorization_amount_cents", + description: "The authorization amount, in cents", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:cancel" - ], - "description": "Send this attribute if you want to mark this return as cancelled.", - "options": [ + name: "order:authorize", + description: "Send this attribute if you want to authorize the order's payment source", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:receive" - ], - "description": "Send this attribute if you want to mark this return as received.", - "options": [ + name: "order:billing_address_clone_id", + description: "The id of the address that you want to clone to create the order's billing addre", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] + name: ["-v", "--value"], + description: "The trigger attribute value", + args: { + description: "", + }, + isRequired: true, + }, + ], + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:reject" - ], - "description": "Send this attribute if you want to mark this return as rejected.", - "options": [ + name: "order:billing_address_same_as_shipping", + description: "Send this attribute if you want the billing address to be cloned from the order'", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:request" - ], - "description": "Send this attribute if you want to activate this return.", - "options": [ + name: "order:cancel", + description: "Send this attribute if you want to cancel a placed order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:restock" - ], - "description": "Send this attribute if you want to restock all of the return line items.", - "options": [ + name: "order:capture", + description: "Send this attribute if you want to capture an authorized order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:ship" - ], - "description": "Send this attribute if you want to mark this return as shipped.", - "options": [ + name: "order:commit_invoice", + description: "Send this attribute if you want commit the sales tax invoice to the associated t", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "return:unarchive" - ], - "description": "Send this attribute if you want to unarchive the return.", - "options": [ + name: "order:create_subscriptions", + description: "Send this attribute upon/after placing the order if you want to create order sub", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "satispay_payment" - ], - "description": "Execute an action on a resource of type satispay_payments", - "options": [ + name: "order:customer_payment_source_id", + description: "The id of the customer payment source (i", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] + name: ["-v", "--value"], + description: "The trigger attribute value", + args: { + description: "", + }, + isRequired: true, + }, + ], + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "satispay_payment:refresh" - ], - "description": "Send this attribute if you want to refresh all the pending transactions, can be used as webhooks fallback logic.", - "options": [ + name: "order:nullify_payment_source", + description: "Send this attribute if you want to nullify the payment source for this order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment" - ], - "description": "Execute an action on a resource of type shipments", - "options": [ + name: "order:pending", + description: "Send this attribute if you want to move a draft or placing order to pending", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:decrement_stock" - ], - "description": "Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", - "options": [ + name: "order:place", + description: "Send this attribute if you want to place the order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:get_rates" - ], - "description": "Send this attribute if you want get the shipping rates from the associated carrier accounts.", - "options": [ + name: "order:refresh", + description: "Send this attribute if you want to manually refresh the order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:on_hold" - ], - "description": "Send this attribute if you want to put this shipment on hold.", - "options": [ + name: "order:refund", + description: "Send this attribute if you want to refund a captured order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:packing" - ], - "description": "Send this attribute if you want to start packing this shipment.", - "options": [ + name: "order:refund_invoice", + description: "Send this attribute if you want refund the sales tax invoice to the associated t", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:picking" - ], - "description": "Send this attribute if you want to start picking this shipment.", - "options": [ + name: "order:reset_circuit", + description: "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:purchase" - ], - "description": "Send this attribute if you want to purchase this shipment with the selected rate.", - "options": [ + 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", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:ready_to_ship" - ], - "description": "Send this attribute if you want to mark this shipment as ready to ship.", - "options": [ + name: "order:save_payment_source_to_customer_wallet", + description: "Send this attribute if you want the order's payment source to be saved in the cu", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:release_stock" - ], - "description": "Send this attribute if you want to automatically release the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", - "options": [ + 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" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:reserve_stock" - ], - "description": "Send this attribute if you want to automatically reserve the stock for each of the associated stock line item. can be done only when fulfillment is in progress.", - "options": [ + name: "order:shipping_address_clone_id", + description: "The id of the address that you want to clone to create the order's shipping addr", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } - ], - "args": [ + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, { - "name": "id", - "description": "The unique id of the resource" - } - ] + name: ["-v", "--value"], + description: "The trigger attribute value", + args: { + description: "", + }, + isRequired: true, + }, + ], + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:ship" - ], - "description": "Send this attribute if you want to mark this shipment as shipped.", - "options": [ + 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" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipment:upcoming" - ], - "description": "Send this attribute if you want to mark this shipment as upcoming.", - "options": [ + name: "order:start_editing", + description: "Send this attribute if you want to edit the order after it is placed", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipping_method" - ], - "description": "Execute an action on a resource of type shipping_methods", - "options": [ + name: "order:stop_editing", + description: "Send this attribute to stop the editing for the order and return back to placed", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipping_method:disable" - ], - "description": "Send this attribute if you want to mark the shipping method as disabled.", - "options": [ + name: "order:unarchive", + description: "Send this attribute if you want to unarchive the order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "shipping_method:enable" - ], - "description": "Send this attribute if you want to mark the shipping method as enabled.", - "options": [ + name: "order:update_taxes", + description: "Send this attribute if you want to force tax calculation for this order (a tax c", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_line_item" - ], - "description": "Execute an action on a resource of type stock_line_items", - "options": [ + name: "order:validate", + description: "Send this attribute if you want to trigger the external validation for the order", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_line_item:decrement_stock" - ], - "description": "Send this attribute if you want to automatically decrement and release the stock this stock line item. can be done only when fulfillment is in progress.", - "options": [ + name: "payment_method", + description: "Execute an action on a resource of type payment_methods", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_line_item:release_stock" - ], - "description": "Send this attribute if you want to automatically release the stock for this stock line item. can be done only when fulfillment is in progress.", - "options": [ + name: "payment_method:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_line_item:reserve_stock" - ], - "description": "Send this attribute if you want to automatically reserve the stock for this stock line item. can be done only when fulfillment is in progress.", - "options": [ + name: "payment_method:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_reservation" - ], - "description": "Execute an action on a resource of type stock_reservations", - "options": [ + name: "percentage_discount_promotion", + description: "Execute an action on a resource of type percentage_discount_promotions", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_reservation:pending" - ], - "description": "Send this attribute if you want to mark this stock reservation as pending.", - "options": [ + name: "percentage_discount_promotion:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_transfer" - ], - "description": "Execute an action on a resource of type stock_transfers", - "options": [ + name: "percentage_discount_promotion:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_transfer:cancel" - ], - "description": "Send this attribute if you want to cancel this stock transfer.", - "options": [ + name: "return", + description: "Execute an action on a resource of type returns", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_transfer:complete" - ], - "description": "Send this attribute if you want to complete this stock transfer.", - "options": [ + name: "return_line_item", + description: "Execute an action on a resource of type return_line_items", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_transfer:in_transit" - ], - "description": "Send this attribute if you want to mark this stock transfer as in transit.", - "options": [ + name: "return_line_item:restock", + description: "Send this attribute if you want to restock the line item", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_transfer:on_hold" - ], - "description": "Send this attribute if you want to put this stock transfer on hold.", - "options": [ + name: "return:approve", + description: "Send this attribute if you want to mark this return as approved", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_transfer:picking" - ], - "description": "Send this attribute if you want to start picking this stock transfer.", - "options": [ + name: "return:archive", + description: "Send this attribute if you want to archive the return", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stock_transfer:upcoming" - ], - "description": "Send this attribute if you want to mark this stock transfer as upcoming.", - "options": [ + name: "return:cancel", + description: "Send this attribute if you want to mark this return as cancelled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stripe_payment" - ], - "description": "Execute an action on a resource of type stripe_payments", - "options": [ + name: "return:receive", + description: "Send this attribute if you want to mark this return as received", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stripe_payment:refresh" - ], - "description": "Send this attribute if you want to refresh the payment status, can be used as webhooks fallback logic.", - "options": [ + name: "return:reject", + description: "Send this attribute if you want to mark this return as rejected", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "stripe_payment:update" - ], - "description": "Send this attribute if you want to update the created payment intent with fresh order data.", - "options": [ + name: "return:request", + description: "Send this attribute if you want to activate this return", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "webhook" - ], - "description": "Execute an action on a resource of type webhooks", - "options": [ + name: "return:restock", + description: "Send this attribute if you want to restock all of the return line items", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "webhook:disable" - ], - "description": "Send this attribute if you want to mark the webhook as disabled.", - "options": [ + name: "return:ship", + description: "Send this attribute if you want to mark this return as shipped", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "webhook:enable" - ], - "description": "Send this attribute if you want to mark the webhook as enabled.", - "options": [ + name: "return:unarchive", + description: "Send this attribute if you want to unarchive the return", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "webhook:reset_circuit" - ], - "description": "Send this attribute if you want to reset the circuit breaker associated to this webhook to 'closed' state and zero failures count.", - "options": [ + name: "satispay_payment", + description: "Execute an action on a resource of type satispay_payments", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified resource" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the resource" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders" - ], - "description": "Execute an action on an order", - "options": [ + name: "satispay_payment:refresh", + description: "Send this attribute if you want to refresh all the pending transactions, can be", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:approve" - ], - "description": "Send this attribute if you want to approve a placed order.", - "options": [ + name: "shipment", + description: "Execute an action on a resource of type shipments", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:approve_and_capture" - ], - "description": "Send this attribute if you want to approve and capture a placed order.", - "options": [ + name: "shipment:decrement_stock", + description: "Send this attribute if you want to automatically decrement and release the stock", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:archive" - ], - "description": "Send this attribute if you want to archive the order.", - "options": [ + name: "shipment:get_rates", + description: "Send this attribute if you want get the shipping rates from the associated carri", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:authorization_amount_cents" - ], - "description": "The authorization amount, in cents.", - "options": [ + name: "shipment:on_hold", + description: "Send this attribute if you want to put this shipment on hold", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:authorize" - ], - "description": "Send this attribute if you want to authorize the order's payment source.", - "options": [ + name: "shipment:packing", + description: "Send this attribute if you want to start packing this shipment", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:billing_address_clone_id" - ], - "description": "The id of the address that you want to clone to create the order's billing address.", - "options": [ + name: "shipment:picking", + description: "Send this attribute if you want to start picking this shipment", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:billing_address_same_as_shipping" - ], - "description": "Send this attribute if you want the billing address to be cloned from the order's shipping address.", - "options": [ + name: "shipment:purchase", + description: "Send this attribute if you want to purchase this shipment with the selected rate", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:cancel" - ], - "description": "Send this attribute if you want to cancel a placed order. the order's authorization will be automatically voided.", - "options": [ + name: "shipment:ready_to_ship", + description: "Send this attribute if you want to mark this shipment as ready to ship", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:capture" - ], - "description": "Send this attribute if you want to capture an authorized order.", - "options": [ + name: "shipment:release_stock", + description: "Send this attribute if you want to automatically destroy the stock reservations", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:commit_invoice" - ], - "description": "Send this attribute if you want commit the sales tax invoice to the associated tax calculator (currently supported by avalara).", - "options": [ + name: "shipment:reserve_stock", + description: "Send this attribute if you want to automatically reserve the stock for each of t", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:create_subscriptions" - ], - "description": "Send this attribute upon/after placing the order if you want to create order subscriptions from the line items that have a frequency.", - "options": [ + name: "shipment:ship", + description: "Send this attribute if you want to mark this shipment as shipped", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:customer_payment_source_id" - ], - "description": "The id of the customer payment source (i.e. credit card) that you want to use as the order's payment source.", - "options": [ + name: "shipment:upcoming", + description: "Send this attribute if you want to mark this shipment as upcoming", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:nullify_payment_source" - ], - "description": "Send this attribute if you want to nullify the payment source for this order.", - "options": [ + name: "shipping_method", + description: "Execute an action on a resource of type shipping_methods", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:place" - ], - "description": "Send this attribute if you want to place the order.", - "options": [ + name: "shipping_method:disable", + description: "Send this attribute if you want to mark this resource as disabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + 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: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + ], + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:refresh" - ], - "description": "Send this attribute if you want to manually refresh the order.", - "options": [ + name: "shipping_method:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:refund" - ], - "description": "Send this attribute if you want to refund a captured order.", - "options": [ + name: "shipping_method:reset_circuit", + description: "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:refund_invoice" - ], - "description": "Send this attribute if you want refund the sales tax invoice to the associated tax calculator (currently supported by avalara).", - "options": [ + name: "stock_item", + description: "Execute an action on a resource of type stock_items", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:save_billing_address_to_customer_address_book" - ], - "description": "Send this attribute if you want the order's billing address to be saved in the customer's address book as a customer address.", - "options": [ + name: "stock_item:validate", + description: "Send this attribute if you want to validate the stock item quantity against the", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:save_payment_source_to_customer_wallet" - ], - "description": "Send this attribute if you want the order's payment source to be saved in the customer's wallet as a customer payment source.", - "options": [ + name: "stock_line_item", + description: "Execute an action on a resource of type stock_line_items", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:save_shipping_address_to_customer_address_book" - ], - "description": "Send this attribute if you want the order's shipping address to be saved in the customer's address book as a customer address.", - "options": [ + name: "stock_line_item:decrement_stock", + description: "Send this attribute if you want to automatically decrement and release the stock", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:shipping_address_clone_id" - ], - "description": "The id of the address that you want to clone to create the order's shipping address.", - "options": [ + name: "stock_line_item:release_stock", + description: "Send this attribute if you want to automatically destroy the stock reservation f", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "name": [ - "-v", - "--value" - ], - "description": "The trigger attribute value", - "args": {}, - "isRequired": true - } ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:shipping_address_same_as_billing" - ], - "description": "Send this attribute if you want the shipping address to be cloned from the order's billing address.", - "options": [ + name: "stock_line_item:reserve_stock", + description: "Send this attribute if you want to automatically reserve the stock for this stoc", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:start_editing" - ], - "description": "Send this attribute if you want to edit the order after it is placed. remember you cannot exceed the original total amount.", - "options": [ + name: "stock_reservation", + description: "Execute an action on a resource of type stock_reservations", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:stop_editing" - ], - "description": "Send this attribute to stop the editing for the order and return back to placed status.", - "options": [ + name: "stock_reservation:pending", + description: "Send this attribute if you want to mark this stock reservation as pending", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:unarchive" - ], - "description": "Send this attribute if you want to unarchive the order.", - "options": [ + name: "stock_transfer", + description: "Execute an action on a resource of type stock_transfers", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:update_taxes" - ], - "description": "Send this attribute if you want to force tax calculation for this order (a tax calculator must be associated to the order's market).", - "options": [ + name: "stock_transfer:cancel", + description: "Send this attribute if you want to cancel this stock transfer", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "orders:validate" - ], - "description": "Send this attribute if you want to trigger the external validation for the order.", - "options": [ + name: "stock_transfer:complete", + description: "Send this attribute if you want to complete this stock transfer", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-p", - "--print" - ], - "description": "Print out the modified order" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-j", - "--json" - ], - "description": "Print result in json format" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print json output without indentation" - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "The unique id of the order" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "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: "stock_transfer:in_transit", + description: "Send this attribute if you want to mark this stock transfer as in transit", + options: [ { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-A", - "--all" - ], - "description": "Show all imports instead of first 25 only" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "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: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-g", - "--group" - ], - "description": "The group id associated to the import in case of multi-chunk imports", - "args": {} + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "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: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-w", - "--warnings" - ], - "description": "Show only import with warnings" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "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 - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "imports:create", - "imp:create", - "import" - ], - "description": "Create a new import", - "options": [ + name: "stock_transfer:on_hold", + description: "Send this attribute if you want to put this stock transfer on hold", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource being imported", - "args": { - "description": "addresses|bundles|coupons|customer_addresses|...", - "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: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-p", - "--parent" - ], - "description": "The id of the parent resource to be associated with imported data", - "args": {} + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-i", - "--inputs" - ], - "description": "The path of the file containing the data to import", - "args": {}, - "isRequired": true + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the resource", + }, + }, + { + name: "stock_transfer:picking", + description: "Send this attribute if you want to start picking this stock transfer", + options: [ { - "name": [ - "-C", - "--csv" - ], - "description": "Accept input file in csv format" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-D", - "--delimiter" - ], - "description": "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", - "args": { - "suggestions": [ - ",", - ";", - "|", - "TAB" - ] - } - }, - { - "name": [ - "-b", - "--blind" - ], - "description": "Execute in blind mode without showing the progress monitor" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-q", - "--quiet" - ], - "description": "Execute command without showing warning messages" - } - ] - }, - { - "name": [ - "imports:delete", - "imp:delete" - ], - "description": "Delete an existing import", - "options": [ + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "Unique id of the import" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "imports:details", - "imp:details" - ], - "description": "Show the details of an existing import", - "options": [ + name: "stock_transfer:upcoming", + description: "Send this attribute if you want to mark this stock transfer as upcoming", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--inputs" - ], - "description": "Show input items associated with the import" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-l", - "--logs" - ], - "description": "Show warning and error logs related to the import process" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-S", - "--save-inputs" - ], - "description": "Save import inputs to local file", - "args": {} - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "Unique id of the import" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "imports:group", - "imp:group" - ], - "description": "List all the imports related to an import group", - "options": [ + name: "stripe_payment", + description: "Execute an action on a resource of type stripe_payments", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + 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: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the resource", + }, + }, + { + name: "stripe_payment:refresh", + description: "Send this attribute if you want to refresh the payment status, can be used as we", + options: [ { - "name": [ - "-A", - "--all" - ], - "description": "Show all imports instead of first 25 only" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "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: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-g", - "--group" - ], - "description": "The group id associated to the import in case of multi-chunk imports", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "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: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-w", - "--warnings" - ], - "description": "Show only import with warnings" + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of imports in output", - "args": {} - } - ] - }, - { - "name": [ - "imports:types", - "imp:types" + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "description": "Show online documentation for supported resources", - "options": [ - { - "name": [ - "-O", - "--open" - ], - "description": "Open online documentation page" - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "seeder:check" - ], - "description": "Execute a check on seeder data", - "options": [ + name: "stripe_payment:update", + description: "Send this attribute if you want to update the created payment intent with fresh", + 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", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-u", - "--url" - ], - "description": "Seeder data url", - "args": { - "default": "https://data.commercelayer.app/seeder" - } + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The name of the business model file to use", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--debug", - "description": "Show command debug information", - "hidden": true + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-r", - "--relationships" - ], - "description": "Check resource relationships" - } - ] + 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": [ - "seeder:clean" - ], - "description": "Clean previously imported seeder data", - "options": [ + name: "webhook", + description: "Execute an action on a resource of type webhooks", + 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", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-u", - "--url" - ], - "description": "Seeder data url", - "args": { - "default": "https://data.commercelayer.app/seeder" - } + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The name of the business model file to use", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--debug", - "description": "Show debug information", - "hidden": true + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, - { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - } - ] + ], + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "seeder:seed", - "seed" - ], - "description": "Execute commerce layer seeder", - "options": [ + name: "webhook:disable", + description: "Send this attribute if you want to mark this resource as disabled", + 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", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-u", - "--url" - ], - "description": "Seeder data url", - "args": { - "default": "https://data.commercelayer.app/seeder" - } + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The name of the business model file to use", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--debug", - "description": "Show debug information", - "hidden": true + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the resource", + }, + }, + { + name: "webhook:enable", + description: "Send this attribute if you want to mark this resource as enabled", + options: [ { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-k", - "--keep" - ], - "description": "Keep existing resources without updating them" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-D", - "--delay" - ], - "description": "Add a delay in milliseconds between calls to different resources", - "args": {}, - "hidden": true - } - ] + name: "--accessToken", + args: { + description: "", + }, + 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": [ - "exports" - ], - "description": "List all the created exports or show details of a single export", - "options": [ + name: "webhook:reset_circuit", + description: "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-A", - "--all" - ], - "description": "Show all exports instead of first 25 only" + name: ["-p", "--print"], + description: "Print out the modified resource", }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource exported", - "args": { - "suggestions": [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds" - ] - } + name: ["-j", "--json"], + description: "Print result in json format", }, { - "name": [ - "-s", - "--status" - ], - "description": "The export job status", - "args": { - "suggestions": [ - "in_progress", - "pending", - "completed", - "interrupted" - ] - } - }, - { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of exports in output", - "args": {} - } + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, ], - "args": [ - { - "name": "id", - "description": "Unique id of the export to be retrieved", - "isOptional": true - } - ] + args: { + name: "id", + description: "The unique id of the resource", + }, }, { - "name": [ - "exports:all", - "exp:all", - "export" - ], - "description": "Export all the records", - "options": [ + name: ["provisioning:create", "prov:create", "pc", "pcreate"], + description: "Create a new resource", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource being exported", - "args": { - "description": "addresses|bundles|coupons|customer_subscriptions|...", - "suggestions": [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds" - ] + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", }, - "isRequired": true }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-D", - "--dry-data" - ], - "description": "Skip redundant attributes" + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": [ - "-F", - "--format" - ], - "description": "Export file format", - "args": { - "suggestions": [ - "csv", - "json" - ], - "default": "json" - } + name: "--doc", + description: "Show the cli command in a specific language", }, { - "name": [ - "-C", - "--csv" - ], - "description": "Export data in csv format" + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": [ - "-N", - "--notify" - ], - "description": "Force system notification when export has finished", - "hidden": true + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-b", - "--blind" - ], - "description": "Execute in blind mode without showing the progress monitor" + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": [ - "-P", - "--prettify" - ], - "description": "Prettify json output format" + name: ["-a", "--attribute"], + description: "Define a resource attribute", + args: { + description: "", + }, }, { - "name": [ - "-O", - "--open" - ], - "description": "Open automatically the file after a successful export" + name: ["-O", "--object"], + description: "Define a resource object attribute", + args: { + description: "", + }, }, { - "name": [ - "-q", - "--quiet" - ], - "description": "Execute command without showing warning messages" + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", + args: { + description: "", + }, }, { - "name": [ - "-k", - "--keep" - ], - "description": "Keep original export files in temp dir" - } - ], - "hidden": false - }, - { - "name": [ - "exports:create", - "exp:create" - ], - "description": "Create a new export", - "options": [ + name: ["-m", "--metadata"], + description: "Define a metadata attribute or a set of metadata attributes", + args: { + 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", + args: { + description: "", + }, + }, + ], + args: { + name: "resource", + description: "The resource type", + suggestions: [ + "api_credential", + "application_membership", + "membership", + "organization", + "permission", + "role", + "subscription", + ], + }, + }, + { + name: ["provisioning:delete", "prov:delete", "pd", "pdelete", "pdel"], + description: "Delete an existing resource", + options: [ + { + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource being exported", - "args": { - "description": "addresses|bundles|coupons|customer_subscriptions|...", - "suggestions": [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds" - ] + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", }, - "isRequired": true }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-D", - "--dry-data" - ], - "description": "Skip redundant attributes" + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": [ - "-F", - "--format" - ], - "description": "Export file format", - "args": { - "suggestions": [ - "csv", - "json" - ], - "default": "json" - } + name: "--doc", + description: "Show the cli command in a specific language", }, { - "name": [ - "-C", - "--csv" - ], - "description": "Export data in csv format" + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-x", - "--save" - ], - "description": "Save command output to file", - "args": {} + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-X", - "--save-path" - ], - "description": "Save command output to file and create missing path directories", - "args": {} + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": [ - "-N", - "--notify" - ], - "description": "Force system notification when export has finished", - "hidden": true + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-b", - "--blind" - ], - "description": "Execute in blind mode without showing the progress monitor" + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, + ], + args: [ { - "name": [ - "-P", - "--prettify" - ], - "description": "Prettify json output format" + name: "resource", + description: "The resource type", + suggestions: ["api_credential", "application_membership", "membership"], }, { - "name": [ - "-O", - "--open" - ], - "description": "Open automatically the file after a successful export" - } - ] + name: "id", + description: "Id of the resource to delete", + isOptional: true, + }, + ], }, { - "name": [ - "exports:details", - "exp:details" + name: ["provisioning:exec", "prov:exec", "pe", "pexec"], + description: "Execute an action on a resource", + options: [ + { + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-a", "--attribute"], + description: "Define a resource attribute", + args: { + description: "", + }, + }, ], - "description": "Show the details of an existing export", - "options": [ + args: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: "resource", + description: "The resource type", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: "id", + description: "Id of the resource on which to execute the action", + isOptional: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - } + name: "action", + description: "Action to execute on resource", + isOptional: true, + }, ], - "args": [ + }, + { + name: ["provisioning:fetch", "prov:fetch", "pf"], + description: "Retrieve a resource or list a set of resources", + options: [ + { + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, + }, + { + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, + }, { - "name": "id", - "description": "Unique id of the export" - } - ] - }, - { - "name": [ - "exports:group", - "exp:group" - ], - "description": "List all the exports related to an export group", - "options": [ + name: ["-j", "--json"], + description: "Convert output in standard json format", + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - } - ], - "args": [ + name: "--doc", + description: "Show the cli command in a specific language", + }, { - "name": "group_id", - "description": "Unique id of the group export" - } - ] - }, - { - "name": [ - "exports:list", - "exp:list" - ], - "description": "List all the created exports", - "options": [ + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, + }, { - "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" - ], - "args": {}, - "hidden": true + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-A", - "--all" - ], - "description": "Show all exports instead of first 25 only" + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource exported", - "args": { - "suggestions": [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds" - ] - } + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, }, { - "name": [ - "-s", - "--status" - ], - "description": "The export job status", - "args": { - "suggestions": [ - "in_progress", - "pending", - "completed", - "interrupted" - ] - } - }, - { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of exports in output", - "args": {} - } - ] - }, - { - "name": [ - "exports:types", - "exp:types" - ], - "description": "Show online documentation for supported resources", - "options": [ + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, + }, { - "name": [ - "-O", - "--open" - ], - "description": "Open online documentation page" - } - ] - }, - { - "name": [ - "cleanups" - ], - "description": "List all the created cleanups or show details of a single cleanup", - "options": [ + name: ["-p", "--page"], + description: "Page number", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, }, + ], + args: [ { - "name": [ - "-A", - "--all" - ], - "description": "Show all cleanups instead of first 25 only" + name: "resource", + description: "The resource type", }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource cleaned", - "args": { - "suggestions": [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items" - ] - } + name: "path", + description: "Path (or url) of the resource(s) to fetch", }, { - "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: "id", + description: "Resource id", + isOptional: true, + }, ], - "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: ["provisioning:get", "prov:get", "pg", "pget"], + 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"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource to clean up", - "args": { - "description": "bundles|gift_cards|prices|promotions|...", - "suggestions": [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items" - ] + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", }, - "isRequired": true }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": [ - "-N", - "--notify" - ], - "description": "Force system notification when cleanup has finished", - "hidden": true + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-b", - "--blind" - ], - "description": "Execute in blind mode without showing the progress monitor" + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "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: "--doc", + description: "Show the cli command in a specific language", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "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: "--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: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - } - ], - "args": [ + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, + }, { - "name": "group_id", - "description": "Unique id of the group cleanup" - } - ] - }, - { - "name": [ - "cleanups:list", - "clp:list" - ], - "description": "List all the created cleanups", - "options": [ + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, + }, { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-p", "--page"], + description: "Page number", + args: { + description: "", + }, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: { + description: "", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, }, { - "name": [ - "-A", - "--all" - ], - "description": "Show all cleanups instead of first 25 only" + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, }, + ], + args: [ { - "name": [ - "-t", - "--type" - ], - "description": "The type of resource cleaned", - "args": { - "suggestions": [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items" - ] - } + name: "resource", + description: "The resource type", }, { - "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" + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, + }, ], - "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", - "options": [ + name: ["provisioning:list", "pl", "prov:list", "plist", "pls"], + description: "Fetch a collection of resources", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + 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: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + 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: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": [ - "-a", - "--attribute" - ], - "description": "Define a resource attribute", - "args": {} + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": [ - "-O", - "--object" - ], - "description": "Define a resource object attribute", - "args": {} + name: ["-p", "--page"], + description: "Page number", + args: { + description: "", + }, }, { - "name": [ - "-r", - "--relationship" - ], - "description": "Define a relationship with another resource", - "args": {} + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: { + description: "", + }, }, { - "name": [ - "-m", - "--metadata" - ], - "description": "Define a metadata attribute or a set of metadata attributes", - "args": {} + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, }, { - "name": [ - "-D", - "--data" - ], - "description": "The data file to use as request body", - "args": {} - } - ], - "args": [ + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, + }, { - "name": "resource", - "description": "The resource type", - "suggestions": [ - "api_credential", - "application_membership", - "membership", - "organization", - "permission", - "role", - "subscription" - ] - } - ] + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, + }, + ], + args: { + name: "resource", + description: "The resource type", + suggestions: [ + "api_credentials", + "application_memberships", + "memberships", + "organizations", + "permissions", + "plans", + "roles", + "subscriptions", + "versions", + ], + }, }, { - "name": [ - "provisioning:delete", - "prov:delete", - "pd", - "pdelete", - "pdel" - ], - "description": "Delete an existing resource", - "options": [ + name: ["provisioning:rel", "prov:rel", "prov:relationship"], + description: "Fetch a resource relationship", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + 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: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + 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: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" - } - ], - "args": [ + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, { - "name": "resource", - "description": "The resource type", - "suggestions": [ - "api_credential", - "application_membership", - "membership" - ] + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": "id", - "description": "Id of the resource to delete", - "isOptional": true - } - ] - }, - { - "name": [ - "provisioning:exec", - "prov:exec", - "pe", - "pexec" - ], - "description": "Execute an action on a resource", - "options": [ + name: ["-p", "--page"], + description: "Page number", + args: { + description: "", + }, + }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-n", "--pageSize"], + description: "Number of elements per page", + args: { + description: "", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, }, { - "name": [ - "-a", - "--attribute" - ], - "description": "Define a resource attribute", - "args": {} - } + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, + }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, + }, ], - "args": [ + args: [ { - "name": "resource", - "description": "The resource type" + name: "resource", + description: "The resource type", }, { - "name": "id", - "description": "Id of the resource on which to execute the action", - "isOptional": true + name: "id", + description: "Id of the resource to retrieve", }, { - "name": "action", - "description": "Action to execute on resource", - "isOptional": true - } - ] + name: "relationship", + description: "Name of the relationship field", + }, + ], + hidden: false, }, { - "name": [ - "provisioning:fetch", - "prov:fetch", - "pf" - ], - "description": "Retrieve a resource or list a set of resources", - "options": [ - { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true - }, + name: ["provisioning:resources", "prov:resources", "pres"], + description: "List all the available provisioning api resources", + options: [ { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-h", "--help"], + description: "Show cli help", }, + ], + }, + { + name: ["provisioning:retrieve", "prov:retrieve", "pr", "pretrieve"], + description: "Fetch a single resource", + options: [ { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: "--doc", + description: "Show the cli command in a specific language", }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": [ - "-p", - "--page" - ], - "description": "Page number", - "args": {} + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, }, + ], + args: [ { - "name": [ - "-n", - "--pageSize" + name: "resource", + description: "The resource type", + suggestions: [ + "api_credential", + "application_membership", + "billing_profile", + "membership", + "organization", + "permission", + "plan", + "role", + "subscription", + "user", + "version", ], - "description": "Number of elements per page", - "args": {} }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, }, - { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true - } ], - "args": [ + }, + { + name: ["provisioning:update", "prov:update", "pu", "pupdate", "pupd"], + description: "Update an existing resource", + options: [ { - "name": "resource", - "description": "The resource type" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "path", - "description": "Path (or url) of the resource(s) to fetch" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "id", - "description": "Resource id", - "isOptional": true - } - ] - }, - { - "name": [ - "provisioning:get", - "prov:get", - "pg", - "pget" - ], - "description": "Retrieve a resource or list a set of resources", - "options": [ - { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-f", "--fields"], + description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: "--doc", + description: "Show the cli command in a specific language", }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", + args: { + description: "", + suggestions: ["curl", "node"], + }, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: "--node", + description: "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-H", "--headers"], + description: "Show response headers", }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: ["-a", "--attribute"], + description: "Define a resource attribute", + args: { + description: "", + }, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-O", "--object"], + description: "Define a resource object attribute", + args: { + description: "", + }, }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", + args: { + description: "", + }, }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-m", "--metadata"], + description: "", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--page" - ], - "description": "Page number", - "args": {} + name: ["-M", "--metadata-replace"], + description: "", + args: { + description: "", + }, }, { - "name": [ - "-n", - "--pageSize" - ], - "description": "Number of elements per page", - "args": {} + name: ["-D", "--data"], + description: "The data file to use as request body", + args: { + description: "", + }, }, + ], + args: [ { - "name": [ - "-s", - "--sort" + name: "resource", + description: "The resource type", + suggestions: [ + "api_credential", + "application_membership", + "membership", + "organization", + "permission", + "role", + "user", ], - "description": "Defines results ordering", - "args": {} }, { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true - } + name: "id", + description: "Id of the resource to update", + isOptional: true, + }, ], - "args": [ + }, + { + name: "exports", + description: "List all the created exports or show details of a single export", + options: [ { - "name": "resource", - "description": "The resource type" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "id", - "description": "Id of the resource to retrieve", - "isOptional": true - } - ] - }, - { - "name": [ - "provisioning:list", - "pl", - "prov:list", - "plist", - "pls" - ], - "description": "Fetch a collection of resources", - "options": [ + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-A", "--all"], + description: "Show all exports instead of first 25 only", }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-t", "--type"], + description: "The type of resource exported", + args: { + description: "", + suggestions: [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds", + ], + }, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-s", "--status"], + description: "The export job status", + args: { + description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-l", "--limit"], + description: "Limit number of exports in output", + args: { + description: "", + }, }, + ], + args: { + name: "id", + description: "Unique id of the export to be retrieved", + isOptional: true, + }, + }, + { + name: ["exports:all", "exp:all", "export"], + description: "Export all the records", + options: [ { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-t", "--type"], + description: "The type of resource being exported", + args: { + description: "Addresses|bundles|coupons|customer_subscriptions|etc", + suggestions: [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds", + ], + }, + isRequired: true, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: ["-D", "--dry-data"], + description: "Skip redundant attributes", }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-F", "--format"], + description: "Export file format", + args: { + description: "", + suggestions: ["csv", "json"], + default: "json", + }, }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-C", "--csv"], + description: "Export data in csv format", }, { - "name": [ - "-p", - "--page" - ], - "description": "Page number", - "args": {} + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, }, { - "name": [ - "-n", - "--pageSize" - ], - "description": "Number of elements per page", - "args": {} + name: ["-X", "--save-path"], + description: "Save command output to file and create missing path directories", + args: { + description: "", + }, }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + name: ["-N", "--notify"], + description: "Force system notification when export has finished", + hidden: true, }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-b", "--blind"], + description: "Execute in blind mode without showing the progress monitor", }, { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true - } - ], - "args": [ - { - "name": "resource", - "description": "The resource type", - "suggestions": [ - "api_credentials", - "application_memberships", - "memberships", - "organizations", - "permissions", - "plans", - "roles", - "subscriptions", - "versions" - ] - } - ] - }, - { - "name": [ - "provisioning:rel", - "provisioning:rel", - "prov:rel", - "prov:relationship" - ], - "description": "Fetch a resource relationship", - "options": [ - { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-P", "--prettify"], + description: "Prettify json output format", }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-O", "--open"], + description: "Open automatically the file after a successful export", }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-q", "--quiet"], + description: "Execute command without showing warning messages", }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-k", "--keep"], + description: "Keep original export files in temp dir", }, + ], + hidden: false, + }, + { + name: ["exports:create", "exp:create"], + description: "Create a new export", + options: [ { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: ["-t", "--type"], + description: "The type of resource being exported", + args: { + description: "Addresses|bundles|coupons|customer_subscriptions|etc", + suggestions: [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds", + ], + }, + isRequired: true, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-D", "--dry-data"], + description: "Skip redundant attributes", }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: ["-F", "--format"], + description: "Export file format", + args: { + description: "", + suggestions: ["csv", "json"], + default: "json", + }, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-C", "--csv"], + description: "Export data in csv format", }, { - "name": [ - "-w", - "--where" - ], - "description": "Comma separated list of query filters", - "args": {} + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, }, { - "name": [ - "-p", - "--page" - ], - "description": "Page number", - "args": {} + name: ["-X", "--save-path"], + description: "Save command output to file and create missing path directories", + args: { + description: "", + }, }, { - "name": [ - "-n", - "--pageSize" - ], - "description": "Number of elements per page", - "args": {} + name: ["-N", "--notify"], + description: "Force system notification when export has finished", + hidden: true, }, { - "name": [ - "-s", - "--sort" - ], - "description": "Defines results ordering", - "args": {} + name: ["-b", "--blind"], + description: "Execute in blind mode without showing the progress monitor", }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} + name: ["-P", "--prettify"], + description: "Prettify json output format", }, { - "name": [ - "-I", - "--force-include" - ], - "description": "Force resources inclusion beyound the 3rd level", - "hidden": true - } + name: ["-O", "--open"], + description: "Open automatically the file after a successful export", + }, ], - "args": [ + }, + { + name: ["exports:details", "exp:details"], + description: "Show the details of an existing export", + options: [ { - "name": "resource", - "description": "The resource type" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "id", - "description": "Id of the resource to retrieve" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "relationship", - "description": "Name of the relationship field" - } + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, ], - "hidden": false + args: { + name: "id", + description: "Unique id of the export", + }, }, { - "name": [ - "provisioning:resources", - "prov:resources", - "pres" - ], - "description": "List all the available provisioning api resources", - "options": [ + name: ["exports:group", "exp:group"], + description: "List all the exports related to an export group", + options: [ { - "name": [ - "-h", - "--help" - ], - "description": "Show cli help." - } - ] + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + ], + args: { + name: "group_id", + description: "Unique id of the group export", + }, }, { - "name": [ - "provisioning:retrieve", - "prov:retrieve", - "pr", - "pretrieve" - ], - "description": "Fetch a single resource", - "options": [ + name: ["exports:list", "exp:list"], + description: "List all the created exports", + options: [ { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-A", "--all"], + description: "Show all exports instead of first 25 only", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + name: ["-t", "--type"], + description: "The type of resource exported", + args: { + description: "", + suggestions: [ + "addresses", + "bundles", + "coupons", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tax_categories", + "transactions", + "authorizations", + "captures", + "voids", + "refunds", + ], + }, }, { - "name": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-s", "--status"], + description: "The export job status", + args: { + description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-l", "--limit"], + description: "Limit number of exports in output", + args: { + description: "", + }, + }, + ], + }, + { + name: ["exports:types", "exp:types"], + description: "Show online documentation for supported resources", + options: [ + { + name: ["-O", "--open"], + description: "Open online documentation page", }, + ], + }, + { + name: "cleanups", + description: "List all the created cleanups or show details of a single cleanup", + options: [ { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + 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: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + 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: { + description: "", + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], + }, }, { - "name": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-s", "--status"], + description: "The cleanup job status", + args: { + description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-l", "--limit"], + description: "Limit number of cleanups in output", + args: { + description: "", + }, }, + ], + 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": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-e", - "--extract" - ], - "description": "Extract subfields from object attributes", - "args": {} - } - ], - "args": [ - { - "name": "resource", - "description": "The resource type", - "suggestions": [ - "api_credential", - "application_membership", - "billing_profile", - "membership", - "organization", - "permission", - "plan", - "role", - "subscription", - "user", - "version" - ] + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "id", - "description": "Id of the resource to retrieve", - "isOptional": true - } - ] - }, - { - "name": [ - "provisioning:update", - "prov:update", - "pu", - "pupdate", - "pupd" - ], - "description": "Update an existing resource", - "options": [ - { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "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": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - "name": [ - "-i", - "--include" - ], - "description": "Comma separated resources to include", - "args": {} + name: ["-N", "--notify"], + description: "Force system notification when cleanup has finished", + hidden: true, }, { - "name": [ - "-f", - "--fields" - ], - "description": "Comma separeted list of fields in the format [resourcetype/]field1,field2...", - "args": {} + name: ["-b", "--blind"], + description: "Execute in blind mode without showing the progress monitor", }, { - "name": [ - "-j", - "--json" - ], - "description": "Convert output in standard json format" + 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": [ - "-u", - "--unformatted" - ], - "description": "Print unformatted json output" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-R", - "--raw" - ], - "description": "Print out the raw api response", - "hidden": false + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--doc", - "description": "Show the cli command in a specific language" + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-l", - "--lang" - ], - "description": "Show the cli command in the specified language syntax", - "args": { - "suggestions": [ - "curl", - "node" - ] - } + 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": "--curl", - "description": "Show the equivalent curl command of the cli command", - "hidden": false + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": "--node", - "description": "Show the equivalent node sdk source code of the cli command", - "hidden": false + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-H", - "--headers" - ], - "description": "Show response headers" + name: "--accessToken", + args: { + description: "", + }, + 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": [ - "-Y", - "--headers-only" - ], - "description": "Show only response headers" + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-a", - "--attribute" - ], - "description": "Define a resource attribute", - "args": {} + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": [ - "-O", - "--object" - ], - "description": "Define a resource object attribute", - "args": {} + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-r", - "--relationship" - ], - "description": "Define a relationship with another resource", - "args": {} + name: ["-A", "--all"], + description: "Show all cleanups instead of first 25 only", }, { - "name": [ - "-m", - "--metadata" - ], - "description": "Define a metadata attribute and merge it with the metadata already present in the remote resource", - "args": {} + name: ["-t", "--type"], + description: "The type of resource cleaned", + args: { + description: "", + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], + }, }, { - "name": [ - "-M", - "--metadata-replace" - ], - "description": "Define a metadata attribute and replace every item already present in the remote resource", - "args": {} + name: ["-s", "--status"], + description: "The cleanup job status", + args: { + description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, }, { - "name": [ - "-D", - "--data" - ], - "description": "The data file to use as request body", - "args": {} - } + name: ["-l", "--limit"], + description: "Limit number of cleanups in output", + args: { + description: "", + }, + }, ], - "args": [ + }, + { + name: ["cleanups:types", "clp:types"], + description: "Show online documentation for supported resources", + options: [ { - "name": "resource", - "description": "The resource type", - "suggestions": [ - "api_credential", - "application_membership", - "membership", - "organization", - "permission", - "role", - "user" - ] + name: ["-O", "--open"], + description: "Open online documentation page", }, - { - "name": "id", - "description": "Id of the resource to update", - "isOptional": true - } - ] + ], }, { - "name": [ - "tags" - ], - "description": "List all the created tags or show details of a single tag", - "options": [ + name: "tags", + description: "List all the created tags or show details of a single tag", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-A", - "--all" - ], - "description": "Show all tags instead of first 25 only" + name: ["-A", "--all"], + description: "Show all tags instead of first 25 only", }, { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of tags in output", - "args": {} - } + name: ["-l", "--limit"], + description: "Limit number of tags in output", + args: { + description: "", + }, + }, ], - "args": [ - { - "name": "id", - "description": "Unique id of the tag to be retrieved", - "isOptional": true - } - ] + args: { + name: "id", + description: "Unique id of the tag to be retrieved", + isOptional: true, + }, }, { - "name": [ - "tags:add", - "tag" - ], - "description": "Add one or more tags to a set of resources", - "options": [ + name: ["tags:add", "tag"], + description: "Add one or more tags to a set of resources", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The tag name", - "args": {}, - "isRequired": true + name: ["-n", "--name"], + description: "The tag name", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of the resource to tag", - "args": {}, - "isRequired": true + name: ["-t", "--type"], + description: "The type of the resource to tag", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-i", - "--id" - ], - "description": "The ids of the resources to tag", - "args": {}, - "isRequired": true + name: ["-i", "--id"], + description: "The ids of the resources to tag", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-C", - "--create" - ], - "description": "Create tags if don't exist", - "args": {} + name: ["-C", "--create"], + description: "Create tags if don't exist", + args: { + description: "", + }, }, { - "name": [ - "-v", - "--verbose" - ], - "description": "Show details of the tag process" - } - ] + name: ["-v", "--verbose"], + description: "Show details of the tag process", + }, + ], }, { - "name": [ - "tags:count" - ], - "description": "Count resources tagged with a specific tag", - "options": [ + name: "tags:count", + description: "Count resources tagged with a specific tag", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of the tagged resources", - "args": {} + name: ["-t", "--type"], + description: "The type of the tagged resources", + args: { + description: "", + }, }, { - "name": [ - "-z", - "--zero" - ], - "description": "Show also resources without tags" - } + name: ["-z", "--zero"], + description: "Show also resources without tags", + }, ], - "args": [ - { - "name": "id_name", - "description": "Unique id or name of the tag" - } - ] + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, }, { - "name": [ - "tags:create" - ], - "description": "Create one or more new tags", - "options": [ + name: "tags:create", + description: "Create one or more new tags", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The tag name", - "args": {}, - "isRequired": true - } - ] + name: ["-n", "--name"], + description: "The tag name", + args: { + description: "", + }, + isRequired: true, + }, + ], }, { - "name": [ - "tags:delete" - ], - "description": "Delete one or more existing tags", - "options": [ + name: "tags:delete", + description: "Delete one or more existing tags", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The tag name", - "args": {}, - "isRequired": true - } - ] + name: ["-n", "--name"], + description: "The tag name", + args: { + description: "", + }, + isRequired: true, + }, + ], }, { - "name": [ - "tags:details" - ], - "description": "Show the details of an existing tag", - "options": [ + name: "tags:details", + description: "Show the details of an existing tag", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true - } + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, ], - "args": [ - { - "name": "id_name", - "description": "Unique id or name of the tag" - } - ] + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, }, { - "name": [ - "tags:list" - ], - "description": "List all the created tags", - "options": [ + name: "tags:list", + description: "List all the created tags", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-A", - "--all" - ], - "description": "Show all tags instead of first 25 only" + name: ["-A", "--all"], + description: "Show all tags instead of first 25 only", }, { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of tags in output", - "args": {} - } - ] + name: ["-l", "--limit"], + description: "Limit number of tags in output", + args: { + description: "", + }, + }, + ], }, { - "name": [ - "tags:remove", - "tag" - ], - "description": "Remove one or more tags to a set of resources", - "options": [ + name: "tags:remove", + description: "Remove one or more tags to a set of resources", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The tag name", - "args": {}, - "isRequired": true + name: ["-n", "--name"], + description: "The tag name", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of the resource to tag", - "args": {}, - "isRequired": true + name: ["-t", "--type"], + description: "The type of the resource to tag", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-i", - "--id" - ], - "description": "The ids of th eresources to tag", - "args": {}, - "isRequired": true + name: ["-i", "--id"], + description: "The ids of th eresources to tag", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-v", - "--verbose" - ], - "description": "Show details of the tag process" - } - ] + name: ["-v", "--verbose"], + description: "Show details of the tag process", + }, + ], }, { - "name": [ - "tags:types" - ], - "description": "Show online documentation for supported resources", - "options": [ + name: "tags:types", + description: "Show online documentation for supported resources", + options: [ { - "name": [ - "-O", - "--open" - ], - "description": "Open online documentation page" - } - ] + name: ["-O", "--open"], + description: "Open online documentation page", + }, + ], }, { - "name": [ - "tags:update" - ], - "description": "Update an existing tag", - "options": [ + name: "tags:update", + description: "Update an existing tag", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-n", - "--name" - ], - "description": "The new tag name", - "args": {}, - "isRequired": true - } + name: ["-n", "--name"], + description: "The new tag name", + args: { + description: "", + }, + isRequired: true, + }, ], - "args": [ - { - "name": "id_name", - "description": "Unique id or name of the tag" - } - ] + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, }, { - "name": [ - "tags:which" - ], - "description": "Show all the resources with this tag", - "options": [ + name: "tags:which", + description: "Show all the resources with this tag", + options: [ { - "name": [ - "-o", - "--organization" - ], - "description": "The slug of your organization", - "args": {}, - "isRequired": true, - "hidden": true + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-d", - "--domain" - ], - "args": {}, - "hidden": true + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - "name": "--accessToken", - "args": {}, - "isRequired": true, - "hidden": true + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - "name": [ - "-t", - "--type" - ], - "description": "The type of the tagged resources", - "args": {}, - "isRequired": true + name: ["-t", "--type"], + description: "The type of the tagged resources", + args: { + description: "", + }, + isRequired: true, }, { - "name": [ - "-A", - "--all" - ], - "description": "Show all resources instead of first 25 only" + name: ["-A", "--all"], + description: "Show all resources instead of first 25 only", }, { - "name": [ - "-l", - "--limit" - ], - "description": "Limit number of resources in output", - "args": {} - } + name: ["-l", "--limit"], + description: "Limit number of resources in output", + args: { + description: "", + }, + }, ], - "args": [ - { - "name": "id_name", - "description": "Unique id or name of the tag" - } - ] + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, }, { - "name": [ - "autocomplete" - ], - "description": "Display autocomplete installation instructions.", - "options": [ + name: "help", + description: "Display help for <%= config.bin %>", + options: [ { - "name": [ - "-r", - "--refresh-cache" - ], - "description": "Refresh cache (ignores displaying instructions)" - } + name: ["-n", "--nested-commands"], + description: "Include all nested commands in the output", + }, ], - "args": [ - { - "name": "shell", - "description": "Shell type", - "suggestions": [ - "zsh", - "bash", - "powershell" - ], - "isOptional": true - } - ] + args: { + name: "command", + description: "Command to show help for", + isOptional: true, + }, }, { - "name": [ - "help" - ], - "description": "Display help for <%= config.bin %>.", - "options": [ + name: "autocomplete", + description: "Display autocomplete installation instructions", + options: [ { - "name": [ - "-n", - "--nested-commands" - ], - "description": "Include all nested commands in the output." - } + name: ["-r", "--refresh-cache"], + description: "Refresh cache (ignores displaying instructions)", + }, ], - "args": [ - { - "name": "commands", - "description": "Command to show help for.", - "isOptional": true - } - ] + args: { + name: "shell", + description: "Shell type", + suggestions: ["zsh", "bash", "powershell"], + isOptional: true, + }, }, { - "name": [ - "plugins" - ], - "description": "List installed plugins.", - "options": [ + name: "plugins", + description: "List installed plugins", + options: [ { - "name": "--json", - "description": "Format output as json." + name: "--json", + description: "Format output as json", }, { - "name": "--core", - "description": "Show core plugins." - } - ] + name: "--core", + description: "Show core plugins", + }, + ], }, { - "name": [ - "plugins:inspect" - ], - "description": "Displays installation properties of a plugin.", - "options": [ + name: "plugins:inspect", + description: "Displays installation properties of a plugin", + options: [ { - "name": "--json", - "description": "Format output as json." + name: "--json", + description: "Format output as json", }, { - "name": [ - "-h", - "--help" - ], - "description": "Show cli help." + name: ["-h", "--help"], + description: "Show cli help", }, { - "name": [ - "-v", - "--verbose" - ] - } + name: ["-v", "--verbose"], + }, ], - "args": [ - { - "name": "plugin", - "description": "Plugin to inspect.", - "default": "." - } - ] + args: { + name: "plugin", + description: "Plugin to inspect", + default: ".", + }, }, { - "name": [ - "plugins:install", - "plugins:add" - ], - "description": "Installs a plugin into the cli.\ncan be installed from npm or a git url.\n\ninstallation of a user-installed plugin will override a core plugin.\n\ne.g. if you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. this is useful if a user needs to update core plugin functionality in the cli without the need to patch and update the whole cli.\n", - "options": [ + name: ["plugins:install", "plugins:add"], + description: "Uses bundled npm executable to install plugins into <%= config", + options: [ { - "name": "--json", - "description": "Format output as json." + name: "--json", + description: "Format output as json", }, { - "name": [ - "-f", - "--force" - ], - "description": "Run yarn install with force flag." + name: ["-f", "--force"], + description: "Force npm to fetch remote resources even if a local copy exists on disk", }, { - "name": [ - "-h", - "--help" - ], - "description": "Show cli help." + name: ["-h", "--help"], + description: "Show cli help", }, { - "name": "--jit", - "hidden": true + name: "--jit", + hidden: true, }, { - "name": [ - "-s", - "--silent" - ], - "description": "Silences yarn output." + name: ["-s", "--silent"], + description: "Silences npm output", }, { - "name": [ - "-v", - "--verbose" - ], - "description": "Show verbose yarn output." - } + name: ["-v", "--verbose"], + description: "Show verbose npm output", + }, ], - "args": [ - { - "name": "plugin", - "description": "Plugin to install." - } - ] + args: { + name: "plugin", + description: "Plugin to install", + }, }, { - "name": [ - "plugins:link" - ], - "description": "Links a plugin into the cli for development.\ninstallation of a linked plugin will override a user-installed or core plugin.\n\ne.g. if you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. this is useful for development work.\n", - "options": [ + name: "plugins:link", + description: "Links a plugin into the cli for development", + options: [ { - "name": [ - "-h", - "--help" - ], - "description": "Show cli help." + name: ["-h", "--help"], + description: "Show cli help", }, { - "name": "--install", - "description": "Install dependencies after linking the plugin.", - "exclusiveOn": [ - "--no-install" - ] + name: "--install", + description: "Install dependencies after linking the plugin", + exclusiveOn: ["--no-install"], }, { - "name": "--no-install" + name: "--no-install", }, { - "name": [ - "-v", - "--verbose" - ] - } + name: ["-v", "--verbose"], + }, ], - "args": [ - { - "name": "path", - "description": "Path to plugin", - "default": "." - } - ] + args: { + name: "path", + description: "Path to plugin", + default: ".", + }, }, { - "name": [ - "plugins:reset" - ], - "options": [ + name: "plugins:reset", + options: [ { - "name": "--hard" + name: "--hard", }, { - "name": "--reinstall" - } - ] + name: "--reinstall", + }, + ], }, { - "name": [ - "plugins:uninstall", - "plugins:unlink", - "plugins:remove" - ], - "description": "Removes a plugin from the cli.", - "options": [ + name: ["plugins:uninstall", "plugins:unlink", "plugins:remove"], + description: "Removes a plugin from the cli", + options: [ { - "name": [ - "-h", - "--help" - ], - "description": "Show cli help." + name: ["-h", "--help"], + description: "Show cli help", }, { - "name": [ - "-v", - "--verbose" - ] - } + name: ["-v", "--verbose"], + }, ], - "args": [ - { - "name": "plugin", - "description": "Plugin to uninstall" - } - ] + args: { + name: "plugin", + description: "Plugin to uninstall", + }, }, { - "name": [ - "plugins:update" - ], - "description": "Update installed plugins.", - "options": [ + name: "plugins:update", + description: "Update installed plugins", + options: [ { - "name": [ - "-h", - "--help" - ], - "description": "Show cli help." - }, - { - "name": [ - "-v", - "--verbose" - ] - } - ] - } - ] -} - + name: ["-h", "--help"], + description: "Show cli help", + }, + { + name: ["-v", "--verbose"], + }, + ], + }, + ], +}; -export default completionSpec +export default completionSpec; From 014ee4ff3063f7631e4bf8dd162855bdba95d2fe Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Wed, 17 Apr 2024 09:57:20 +0200 Subject: [PATCH 5/8] fix: fix prettier check issues --- src/commercelayer.ts | 7297 ++++++++++++++++++++++-------------------- 1 file changed, 3769 insertions(+), 3528 deletions(-) diff --git a/src/commercelayer.ts b/src/commercelayer.ts index 219dc0808226..7621cf3fb68e 100644 --- a/src/commercelayer.ts +++ b/src/commercelayer.ts @@ -6,7 +6,14 @@ const completionSpec: Fig.Spec = { name: "@commercelayer/cli", subcommands: [ { - name: ["applications", "app:list", "applications:list", "app:available", "applications:available", "apps"], + name: [ + "applications", + "app:list", + "applications:list", + "app:available", + "applications:available", + "apps", + ], description: "Show a list of all (logged in) available cli applications", options: [ { @@ -315,7 +322,13 @@ const completionSpec: Fig.Spec = { ], }, { - name: ["applications:logout", "app:logout", "app:remove", "applications:remove", "logout"], + name: [ + "applications:logout", + "app:logout", + "app:remove", + "applications:remove", + "logout", + ], description: "Remove an application from cli local configuration", options: [ { @@ -395,7 +408,13 @@ const completionSpec: Fig.Spec = { ], }, { - name: ["applications:provisioning", "app:prov", "app:provisioning", "prov:apps", "prov:applications"], + name: [ + "applications:provisioning", + "app:prov", + "app:provisioning", + "prov:apps", + "prov:applications", + ], description: "Show all provisioning applications", options: [ { @@ -729,7 +748,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-a", "--accessToken"], - description: "Custom access token to use instead of the one used for login", + description: + "Custom access token to use instead of the one used for login", args: { description: "", }, @@ -811,7 +831,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-a", "--accessToken"], - description: "Custom access token to use instead of the one used for login", + description: + "Custom access token to use instead of the one used for login", args: { description: "", }, @@ -835,7 +856,8 @@ const completionSpec: Fig.Spec = { }, { name: "imports", - description: "List all the created imports or show details of a single import", + description: + "List all the created imports or show details of a single import", options: [ { name: ["-o", "--organization"], @@ -897,7 +919,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-g", "--group"], - description: "The group id associated to the import in case of multi-chunk imports", + description: + "The group id associated to the import in case of multi-chunk imports", args: { description: "", }, @@ -993,7 +1016,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-p", "--parent"], - description: "The id of the parent resource to be associated with imported data", + description: + "The id of the parent resource to be associated with imported data", args: { description: "", }, @@ -1012,7 +1036,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-D", "--delimiter"], - description: "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", + description: + "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", args: { description: "", suggestions: [",", ";", "|", "TAB"], @@ -1020,7 +1045,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-b", "--blind"], - description: "Execute in blind mode without showing the progress monitor", + description: + "Execute in blind mode without showing the progress monitor", }, { name: ["-q", "--quiet"], @@ -1096,7 +1122,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-l", "--logs"], - description: "Show warning and error logs related to the import process", + description: + "Show warning and error logs related to the import process", }, { name: ["-S", "--save-inputs"], @@ -1209,7 +1236,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-g", "--group"], - description: "The group id associated to the import in case of multi-chunk imports", + description: + "The group id associated to the import in case of multi-chunk imports", args: { description: "", }, @@ -1304,211 +1332,242 @@ const completionSpec: Fig.Spec = { ], }, { - name: "seeder:check", - description: "Execute a check on seeder data", + name: "resources", + description: "List all the available commerce layer api resources", options: [ { - name: ["-b", "--businessModel"], - description: "The kind of business model you want to import", + name: ["-h", "--help"], + description: "Show cli help", + }, + ], + }, + { + name: ["resources:all", "all", "ra", "res:all"], + description: "Fetch all resources", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", }, + isRequired: true, + hidden: true, }, { - name: ["-u", "--url"], - description: "Seeder data url", + name: ["-d", "--domain"], args: { description: "", - default: "https://data.commercelayer.app/seeder", }, + hidden: true, }, { - name: ["-n", "--name"], - description: "The name of the business model file to use", + name: "--accessToken", args: { description: "", }, - }, - { - name: "--debug", - description: "Show command debug information", + isRequired: true, hidden: true, }, { - name: ["-r", "--relationships"], - description: "Check resource relationships", - }, - ], - }, - { - name: "seeder:clean", - description: "Clean previously imported seeder data", - options: [ - { - name: ["-b", "--businessModel"], - description: "The kind of business model you want to import", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", }, }, { - name: ["-u", "--url"], - description: "Seeder data url", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", - default: "https://data.commercelayer.app/seeder", }, }, { - name: ["-n", "--name"], - description: "The name of the business model file to use", + 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: { description: "", + suggestions: ["curl", "node"], }, }, { - name: "--debug", - description: "Show debug information", - hidden: true, + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - name: ["-o", "--organization"], - description: "The slug of your organization", + 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: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: "--load-args", + description: "Load previously saved command arguments", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, - 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", + name: ["-s", "--sort"], + description: "Defines results ordering", args: { description: "", - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", }, }, { - name: ["-u", "--url"], - description: "Seeder data url", + name: ["-x", "--save"], + description: "Save command output to file", args: { description: "", - default: "https://data.commercelayer.app/seeder", }, }, { - name: ["-n", "--name"], - description: "The name of the business model file to use", + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", args: { description: "", }, }, { - name: "--debug", - description: "Show debug information", + name: ["-N", "--notify"], + description: "Force system notification when export has finished", hidden: true, }, { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: "--clientId", + description: "Organization client_id", args: { description: "", }, - isRequired: true, hidden: true, }, { - name: ["-d", "--domain"], + name: "--clientSecret", + description: "Organization client_secret", args: { description: "", }, hidden: true, }, { - name: "--accessToken", + name: ["-C", "--csv"], + description: "Export fields in csv format", + }, + { + name: ["-D", "--delimiter"], + description: "", args: { description: "", + suggestions: [",", ";", "|", "TAB"], }, - isRequired: true, - hidden: true, }, { - name: ["-k", "--keep"], - description: "Keep existing resources without updating them", + name: ["-H", "--header"], + description: "", + args: { + description: "", + }, }, { - name: ["-D", "--delay"], - description: "Add a delay in milliseconds between calls to different resources", + name: ["-b", "--blind"], + description: "Execute in blind mode without prompt and progress bar", + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", + args: { + description: "", + }, + }, + { + name: ["-T", "--timeout"], + description: "Set request timeout in milliseconds [1000 - 15000]", args: { description: "", }, 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: "resource", + description: "The resource type", }, }, { - name: "token:generate", - description: "Start a wizard to generate a custom access token", + name: ["resources:args", "res:args"], + description: "Show all the saved command arguments", options: [ { - name: ["-d", "--domain"], + name: ["-a", "--alias"], + description: "The alias associated to saved command arguments", args: { description: "", }, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print users answers", - hidden: true, + name: ["-r", "--resource"], + description: "The resource type", + args: { + description: "", + }, }, { - name: ["-i", "--info"], - description: "Print generated token info", + name: ["-o", "--operation"], + description: "The resource operation", + args: { + description: "", + suggestions: ["list", "retrieve", "create", "update"], + }, }, { - name: ["-c", "--check"], - description: "Check generated access token", + name: ["-D", "--delete"], + description: "Delete saved arguments associated to the alias", + }, + { + name: ["-P", "--pretty"], + description: "Show saved arguments in table format", + hidden: true, }, ], }, { - name: "token:get", - description: "Get a new access token", + name: ["resources:count", "count", "res:count", "rs:count"], + description: "Count the number of existent resources", options: [ { name: ["-o", "--organization"], @@ -1516,6 +1575,8 @@ const completionSpec: Fig.Spec = { args: { description: "", }, + isRequired: true, + hidden: true, }, { name: ["-d", "--domain"], @@ -1525,196 +1586,282 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--clientId"], - description: "Application client_id", + name: "--accessToken", args: { description: "", }, isRequired: true, + hidden: true, }, { - name: ["-s", "--clientSecret"], - description: "Application client_secret", + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, }, + ], + args: { + name: "resource", + description: "The resource type", + }, + }, + { + name: ["resources:create", "create", "rc", "res:create", "post"], + description: "Create a new resource", + options: [ { - name: ["-S", "--scope"], - description: "Access token scope (market, stock location)", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-e", "--email"], - description: "Customer email", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-p", "--password"], - description: "Customer secret password", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: "--info", - description: "Show access token info", + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - 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", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, }, { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: ["-i", "--clientId"], - description: "Application client_id", - args: { - description: "", - }, - isRequired: true, + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: ["-s", "--clientSecret"], - description: "Application client_secret", - args: { - description: "", - }, + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-S", "--scope"], - description: "Access token scope", + 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: { description: "", + suggestions: ["curl", "node"], }, }, { - name: ["-P", "--provisioning"], - description: "Execute login to provisioning api", + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, - ], - args: { - name: "token", - description: "Access token to revoke", - }, - }, - { - name: "orders", - description: "Execute an action on an order", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - name: ["-d", "--domain"], + name: "--save-args", + description: "Save command data to file for future use", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: "--load-args", + description: "Load previously saved command arguments", args: { description: "", }, - isRequired: true, - hidden: true, - }, - { - name: ["-p", "--print"], - description: "Print out the modified order", }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:approve", - description: "Send this attribute if you want to approve a placed order", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-a", "--attribute"], + description: "Define a resource attribute", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-O", "--object"], + description: "Define a resource object attribute", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-m", "--metadata"], + description: + "Define a metadata attribute or a set of metadata attributes", + args: { + description: "", + }, }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-D", "--data"], + description: "The data file to use as request body", + args: { + description: "", + }, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-t", "--tags"], + description: "List of tags associated with the resource", + args: { + description: "", + }, }, ], args: { - name: "id", - description: "The unique id of the order", + 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", + ], }, }, { - name: "orders:approve_and_capture", - description: "Send this attribute if you want to approve and capture a placed order", + name: ["resources:delete", "delete", "rd", "res:delete"], + description: "Delete an existing resource", options: [ { name: ["-o", "--organization"], @@ -1741,118 +1888,224 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", - }, - { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", - }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:archive", - description: "Send this attribute if you want to archive the order", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: "--doc", + description: "Show the cli command in a specific language", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:authorization_amount_cents", - description: "The authorization amount, in cents", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", args: { description: "", + suggestions: ["curl", "node"], }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + 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: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: "--load-args", + description: "Load previously saved command arguments", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, + ], + args: [ { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + 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", + ], + }, + { + name: "id", + description: "Id of the resource to delete", + isOptional: true, + }, + ], + }, + { + 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: { + description: "", + suggestions: [ + "object", + "create", + "retrieve", + "list", + "update", + "delete", + ], + }, }, ], args: { - name: "id", - description: "The unique id of the order", + name: "resource", + description: + "The resource for which you want to access the online documentation", }, }, { - name: "orders:authorize", - description: "Send this attribute if you want to authorize the order's payment source", + name: ["resources:fetch", "fetch", "res:fetch", "rf"], + description: "Retrieve a resource or list a set of resources", options: [ { name: ["-o", "--organization"], @@ -1879,218 +2132,153 @@ const completionSpec: Fig.Spec = { 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:billing_address_clone_id", - description: "The id of the address that you want to clone to create the order's billing addre", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: "--doc", + description: "Show the cli command in a specific language", }, { - name: ["-v", "--value"], - description: "The trigger attribute value", + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", args: { description: "", + suggestions: ["curl", "node"], }, - isRequired: true, }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:billing_address_same_as_shipping", - description: "Send this attribute if you want the billing address to be cloned from the order'", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - 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: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: "--load-args", + description: "Load previously saved command arguments", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", - }, - { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:cancel", - description: "Send this attribute if you want to cancel a placed order", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-x", "--save"], + description: "Save command output to file", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, - 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", + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:capture", - description: "Send this attribute if you want to capture an authorized order", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-p", "--page"], + description: "Page number", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-s", "--sort"], + description: "Defines results ordering", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, }, + ], + args: [ { - name: ["-j", "--json"], - description: "Print result in json format", + name: "path", + description: "Path (or url) of the resource(s) to fetch", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: "id", + description: "Resource id", + isOptional: true, }, ], - args: { - name: "id", - description: "The unique id of the order", - }, }, { - name: "orders:commit_invoice", - description: "Send this attribute if you want commit the sales tax invoice to the associated t", + 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"], @@ -2117,172 +2305,149 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, + }, + { + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { name: ["-j", "--json"], - description: "Print result in json format", + description: "Convert output in standard json format", }, { name: ["-u", "--unformatted"], - description: "Print json output without indentation", + description: "Print unformatted json output", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:create_subscriptions", - description: "Send this attribute upon/after placing the order if you want to create order sub", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + 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: { description: "", + suggestions: ["curl", "node"], }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + 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: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: "--load-args", + description: "Load previously saved command arguments", args: { description: "", }, - isRequired: true, - hidden: true, - }, - { - name: ["-p", "--print"], - description: "Print out the modified order", }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:customer_payment_source_id", - description: "The id of the customer payment source (i", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-p", "--page"], + description: "Page number", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: { description: "", }, - 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", - }, - { - name: ["-v", "--value"], - description: "The trigger attribute value", + name: ["-s", "--sort"], + description: "Defines results ordering", args: { description: "", }, - isRequired: true, }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:nullify_payment_source", - description: "Send this attribute if you want to nullify the payment source for this order", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-x", "--save"], + description: "Save command output to file", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, }, + ], + args: [ { - name: ["-j", "--json"], - description: "Print result in json format", + name: "resource", + description: "The resource type", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, }, ], - args: { - name: "id", - description: "The unique id of the order", - }, }, { - name: "orders:pending", - description: "Send this attribute if you want to move a draft or placing order to pending", + name: ["resources:list", "list", "rl", "res:list"], + description: "Fetch a collection of resources", options: [ { name: ["-o", "--organization"], @@ -2309,256 +2474,266 @@ const completionSpec: Fig.Spec = { 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:place", - description: "Send this attribute if you want to place the order", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, - isRequired: true, - hidden: true, - }, - { - name: ["-p", "--print"], - description: "Print out the modified order", }, { name: ["-j", "--json"], - description: "Print result in json format", + description: "Convert output in standard json format", }, { name: ["-u", "--unformatted"], - description: "Print json output without indentation", + description: "Print unformatted json output", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:refresh", - description: "Send this attribute if you want to manually refresh the order", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, + name: "--doc", + description: "Show the cli command in a specific language", }, { - name: "--accessToken", + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", args: { description: "", + suggestions: ["curl", "node"], }, - 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", + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:refund", - description: "Send this attribute if you want to refund a captured order", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - name: ["-d", "--domain"], + name: "--save-args", + description: "Save command data to file for future use", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: "--load-args", + description: "Load previously saved command arguments", args: { description: "", }, - isRequired: true, - hidden: true, - }, - { - name: ["-p", "--print"], - description: "Print out the modified order", }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:refund_invoice", - description: "Send this attribute if you want refund the sales tax invoice to the associated t", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-p", "--page"], + description: "Page number", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: { description: "", }, - 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", + name: ["-s", "--sort"], + description: "Defines results ordering", + args: { + description: "", + }, }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:reset_circuit", - description: "Send this attribute if you want to reset the circuit breaker associated to this", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-x", "--save"], + description: "Save command output to file", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, - 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", + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, }, ], args: { - name: "id", - description: "The unique id of the order", + 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: "orders: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: ["relationship", "resources:rel", "res:rel", "res:relationship"], + description: "Fetch a resource relationship", options: [ { name: ["-o", "--organization"], @@ -2585,172 +2760,153 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-i", "--include"], + description: "Comma separated resources to include", + args: { + description: "", + }, + }, + { + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { name: ["-j", "--json"], - description: "Print result in json format", + description: "Convert output in standard json format", }, { name: ["-u", "--unformatted"], - description: "Print json output without indentation", + description: "Print unformatted json output", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:save_payment_source_to_customer_wallet", - description: "Send this attribute if you want the order's payment source to be saved in the cu", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + 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: { description: "", + suggestions: ["curl", "node"], }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + 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: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: "--load-args", + description: "Load previously saved command arguments", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders: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"], - description: "The slug of your organization", + name: ["-p", "--page"], + description: "Page number", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-s", "--sort"], + description: "Defines results ordering", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-x", "--save"], + description: "Save command output to file", + args: { + description: "", + }, }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", + args: { + description: "", + }, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", - }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:shipping_address_clone_id", - description: "The id of the address that you want to clone to create the order's shipping addr", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", hidden: true, }, + ], + args: [ { - name: ["-p", "--print"], - description: "Print out the modified order", - }, - { - name: ["-j", "--json"], - description: "Print result in json format", + name: "resource", + description: "The resource type", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: "id", + description: "Id of the resource to retrieve", }, { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: { - description: "", - }, - isRequired: true, + name: "relationship", + description: "Name of the relationship field", }, ], - args: { - name: "id", - description: "The unique id of the order", - }, + hidden: false, }, { - name: "orders:shipping_address_same_as_billing", - description: "Send this attribute if you want the shipping address to be cloned from the order", + name: ["resources:retrieve", "retrieve", "rr", "res:retrieve"], + description: "Fetch a single resource", options: [ { name: ["-o", "--organization"], @@ -2777,266 +2933,247 @@ const completionSpec: Fig.Spec = { 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:start_editing", - description: "Send this attribute if you want to edit the order after it is placed", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, - isRequired: true, - hidden: true, - }, - { - name: ["-p", "--print"], - description: "Print out the modified order", }, { name: ["-j", "--json"], - description: "Print result in json format", + description: "Convert output in standard json format", }, { name: ["-u", "--unformatted"], - description: "Print json output without indentation", + description: "Print unformatted json output", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:stop_editing", - description: "Send this attribute to stop the editing for the order and return back to placed", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, + name: "--doc", + description: "Show the cli command in a specific language", }, { - name: "--accessToken", + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", args: { description: "", + suggestions: ["curl", "node"], }, - 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", + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:unarchive", - description: "Send this attribute if you want to unarchive the order", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - name: ["-d", "--domain"], + name: "--save-args", + description: "Save command data to file for future use", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: "--load-args", + description: "Load previously saved command arguments", args: { description: "", }, - isRequired: true, - hidden: true, - }, - { - name: ["-p", "--print"], - description: "Print out the modified order", }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, - ], - args: { - name: "id", - description: "The unique id of the order", - }, - }, - { - name: "orders:update_taxes", - description: "Send this attribute if you want to force tax calculation for this order (a tax c", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-x", "--save"], + description: "Save command output to file", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, - 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:validate", - description: "Send this attribute if you want to trigger the external validation for the order", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, + args: [ { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-p", "--print"], - description: "Print out the modified order", - }, - { - name: ["-j", "--json"], - description: "Print result in json format", + 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: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, }, ], - args: { - name: "id", - description: "The unique id of the order", - }, }, { - name: "resources", - description: "List all the available commerce layer api resources", - options: [ - { - name: ["-h", "--help"], - description: "Show cli help", - }, - ], + name: ["resources:schema", "schema", "res:schema", "rs"], + description: + "Show the current commercelayer openapi schema version used by the plugin", }, { - name: ["resources:all", "all", "ra", "res:all"], - description: "Fetch all resources", + name: ["resources:update", "update", "ru", "res:update", "patch"], + description: "Update an existing resource", options: [ { name: ["-o", "--organization"], @@ -3071,7 +3208,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, @@ -3108,7 +3246,8 @@ const completionSpec: Fig.Spec = { }, { name: "--node", - description: "Show the equivalent node sdk source code of the cli command", + description: + "Show the equivalent node sdk source code of the cli command", hidden: false, }, { @@ -3126,179 +3265,214 @@ const completionSpec: Fig.Spec = { }, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", - args: { - description: "", - }, - }, - { - name: ["-s", "--sort"], - description: "Defines results ordering", - args: { - description: "", - }, + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-x", "--save"], - description: "Save command output to file", - args: { - description: "", - }, + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - name: ["-X", "--save-path"], - description: "Save command output to file and create missing path directories", + name: ["-a", "--attribute"], + description: "Define a resource attribute", args: { description: "", }, }, { - name: ["-N", "--notify"], - description: "Force system notification when export has finished", - hidden: true, - }, - { - name: "--clientId", - description: "Organization client_id", + name: ["-O", "--object"], + description: "Define a resource object attribute", args: { description: "", }, - hidden: true, }, { - name: "--clientSecret", - description: "Organization client_secret", + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", args: { description: "", }, - hidden: true, - }, - { - name: ["-C", "--csv"], - description: "Export fields in csv format", }, { - name: ["-D", "--delimiter"], + name: ["-m", "--metadata"], description: "", args: { description: "", - suggestions: [",", ";", "|", "TAB"], }, }, { - name: ["-H", "--header"], + name: ["-M", "--metadata-replace"], description: "", args: { description: "", }, }, { - name: ["-b", "--blind"], - description: "Execute in blind mode without prompt and progress bar", - }, - { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: ["-D", "--data"], + description: "The data file to use as request body", args: { description: "", }, }, { - name: ["-T", "--timeout"], - description: "Set request timeout in milliseconds [1000 - 15000]", + name: ["-t", "--tags"], + description: "List of tags associated with the resource", args: { description: "", }, - 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: { - description: "", - }, - }, + args: [ { - name: ["-r", "--resource"], + name: "resource", description: "The resource type", - args: { - description: "", - }, - }, - { - name: ["-o", "--operation"], - description: "The resource operation", - args: { - description: "", - suggestions: ["list", "retrieve", "create", "update"], - }, - }, - { - name: ["-D", "--delete"], - description: "Delete saved arguments associated to the alias", + 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: ["-P", "--pretty"], - description: "Show saved arguments in table format", - hidden: true, + name: "id", + description: "Id of the resource to update", + isOptional: true, }, ], }, { - name: ["resources:count", "count", "res:count", "rs:count"], - description: "Count the number of existent resources", + 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: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-d", "--domain"], args: { description: "", }, - isRequired: true, hidden: true, }, { - name: ["-d", "--domain"], - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print users answers", hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: ["-i", "--info"], + description: "Print generated token info", }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", - args: { - description: "", - }, + name: ["-c", "--check"], + description: "Check generated access token", }, ], - args: { - name: "resource", - description: "The resource type", - }, }, { - name: ["resources:create", "create", "rc", "res:create", "post"], - description: "Create a new resource", + name: "token:get", + description: "Get a new access token", options: [ { name: ["-o", "--organization"], @@ -3306,8 +3480,6 @@ const completionSpec: Fig.Spec = { args: { description: "", }, - isRequired: true, - hidden: true, }, { name: ["-d", "--domain"], @@ -3317,239 +3489,173 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: "--accessToken", + name: ["-i", "--clientId"], + description: "Application client_id", args: { description: "", }, isRequired: true, - hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", - args: { - description: "", - }, - }, - { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-s", "--clientSecret"], + description: "Application client_secret", args: { description: "", }, }, { - 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", + name: ["-S", "--scope"], + description: "Access token scope (market, stock location)", args: { description: "", - 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", + name: ["-e", "--email"], + description: "Customer email", args: { description: "", }, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: ["-p", "--password"], + description: "Customer secret password", args: { description: "", }, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: "--info", + description: "Show access token info", }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-P", "--provisioning"], + description: "Execute login to provisioning api", }, + ], + }, + { + name: "token:revoke", + description: "Revoke a commerce layer access token", + options: [ { - name: ["-a", "--attribute"], - description: "Define a resource attribute", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, }, { - name: ["-O", "--object"], - description: "Define a resource object attribute", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-r", "--relationship"], - description: "Define a relationship with another resource", + name: ["-i", "--clientId"], + description: "Application client_id", args: { description: "", }, + isRequired: true, }, { - name: ["-m", "--metadata"], - description: "Define a metadata attribute or a set of metadata attributes", + name: ["-s", "--clientSecret"], + description: "Application client_secret", args: { description: "", }, }, { - name: ["-D", "--data"], - description: "The data file to use as request body", + name: ["-S", "--scope"], + description: "Access token scope", args: { description: "", }, }, { - name: ["-t", "--tags"], - description: "List of tags associated with the resource", - args: { - description: "", - }, + name: ["-P", "--provisioning"], + description: "Execute login to provisioning api", }, ], 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", - "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", - ], + name: "token", + description: "Access token to revoke", }, }, { - name: ["resources:delete", "delete", "rd", "res:delete"], - description: "Delete an existing resource", + 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: { + description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", + }, + }, + { + name: ["-u", "--url"], + description: "Seeder data url", + args: { + description: "", + default: "https://data.commercelayer.app/seeder", + }, + }, + { + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: { + description: "", + }, + }, + { + name: "--debug", + description: "Show command debug information", + hidden: true, + }, + { + name: ["-r", "--relationships"], + description: "Check resource relationships", + }, + ], + }, + { + name: "seeder:clean", + description: "Clean previously imported seeder data", + options: [ + { + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", + args: { + description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", + }, + }, + { + name: ["-u", "--url"], + description: "Seeder data url", + args: { + description: "", + default: "https://data.commercelayer.app/seeder", + }, + }, + { + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: { + description: "", + }, + }, + { + name: "--debug", + description: "Show debug information", + hidden: true, + }, { name: ["-o", "--organization"], description: "The slug of your organization", @@ -3574,214 +3680,143 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, + ], + }, + { + name: ["seeder:seed", "seed"], + description: "Execute commerce layer seeder", + options: [ { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", args: { description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", }, }, { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-u", "--url"], + description: "Seeder data url", args: { description: "", + default: "https://data.commercelayer.app/seeder", }, }, { - name: ["-j", "--json"], - description: "Convert output in standard json format", + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: { + description: "", + }, }, { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: "--debug", + description: "Show debug information", + hidden: true, }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: "--doc", - description: "Show the cli command in a specific language", + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: "--accessToken", args: { description: "", - suggestions: ["curl", "node"], }, + isRequired: true, + hidden: true, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-k", "--keep"], + description: "Keep existing resources without updating them", }, { - name: "--node", - description: "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-D", "--delay"], + description: + "Add a delay in milliseconds between calls to different resources", + args: { + description: "", + }, + hidden: true, }, + ], + }, + { + name: "webhooks", + description: + "List all the registered webhooks or the details of a single webhook", + options: [ { - name: "--save-args", - description: "Save command data to file for future use", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-c", "--circuit"], + description: "Show only webhooks with circuit in the declared state", + args: { + description: "", + suggestions: ["open", "closed"], + }, }, - ], - 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", - "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", - ], + name: ["-t", "--topic"], + description: "The event that triggered the webhook", + args: { + description: "", + }, }, { - name: "id", - description: "Id of the resource to delete", - isOptional: true, + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", }, - ], - }, - { - 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: { - description: "", - suggestions: ["object", "create", "retrieve", "list", "update", "delete"], - }, + name: ["-e", "--events"], + description: + "Show the last event callbacks associated to the webhook", }, ], args: { - name: "resource", - description: "The resource for which you want to access the online documentation", + name: "id", + description: "Unique id of the webhook to get a single webhook", + isOptional: true, }, }, { - name: ["resources:fetch", "fetch", "res:fetch", "rf"], - description: "Retrieve a resource or list a set of resources", + name: ["webhooks:create", "wh:create"], + description: "Create a new webhook", options: [ { name: ["-o", "--organization"], @@ -3807,151 +3842,252 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, + { + name: ["-t", "--topic"], + description: + "The identifier of the event that will trigger the webhook", + args: { + description: "", + }, + isRequired: true, + }, + { + name: ["-u", "--url"], + description: "The callback url used to post data", + args: { + description: "", + }, + isRequired: true, + }, { name: ["-i", "--include"], - description: "Comma separated resources to include", + description: + "A comma separated list of related resources to be included", args: { description: "", }, }, { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-n", "--name"], + description: "The webhook short name", args: { description: "", }, }, + ], + }, + { + name: ["webhooks:destroy", "webhooks:delete", "wh:delete", "wh:destroy"], + description: "Destroy an existing webhook", + options: [ { - name: ["-j", "--json"], - description: "Convert output in standard json format", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: "--accessToken", + args: { + description: "", + }, + 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: "--doc", - description: "Show the cli command in a specific language", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-d", "--domain"], args: { description: "", - suggestions: ["curl", "node"], }, + hidden: true, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: "--node", - description: "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", + }, + { + name: ["-e", "--events"], + description: + "Show the last event callbacks associated to the webhook", + }, + ], + 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: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: "--save-args", - description: "Save command data to file for future use", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-p", "--payload"], + description: "Show the event payload sent to the callback endpoint", }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + 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: ["-x", "--save"], - description: "Save command output to file", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-X", "--save-path"], - description: "Save command output to file and create missing path directories", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-A", "--all"], + description: "Show all events instead of first 25 only", + }, + { + name: ["-l", "--limit"], + description: "Limit number of events in output", args: { description: "", }, }, + ], + args: { + name: "id", + description: "Unique id of the webhook", + }, + }, + { + name: ["webhooks:list", "wh:list"], + description: "List all the registered webhooks", + options: [ { - name: ["-p", "--page"], - description: "Page number", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: "--accessToken", args: { description: "", }, - }, - { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + isRequired: true, hidden: true, }, - ], - args: [ { - name: "path", - description: "Path (or url) of the resource(s) to fetch", + name: ["-c", "--circuit"], + description: "Show only webhooks with circuit in the declared state", + args: { + description: "", + suggestions: ["open", "closed"], + }, }, { - name: "id", - description: "Resource id", - isOptional: true, + name: ["-t", "--topic"], + description: "The event that triggered the webhook", + args: { + description: "", + }, }, ], }, { - 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", + name: ["webhooks:listen", "wh:listen"], + description: "Listen a webhook for outgoing callbacks", options: [ { name: ["-o", "--organization"], @@ -3978,146 +4114,162 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: ["-t", "--time"], + description: "Waiting time for the first event", args: { description: "", + 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: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + 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: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-d", "--domain"], args: { description: "", - suggestions: ["curl", "node"], }, + hidden: true, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: "--node", - description: "Show the equivalent node sdk source code 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:reset", "wh:reset"], + description: "Reset the circuit breaker associated to the webhook", + options: [ { - name: "--save-args", - description: "Save command data to file for future use", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", - }, - { - name: ["-Y", "--headers-only"], - description: "Show only response headers", - }, - { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: "--accessToken", args: { description: "", }, + 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: ["-p", "--page"], - description: "Page number", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-x", "--save"], - description: "Save command output to file", + name: ["-t", "--topic"], + description: + "The identifier of the event that will trigger the webhook", args: { description: "", }, }, { - name: ["-X", "--save-path"], - description: "Save command output to file and create missing path directories", + name: ["-u", "--url"], + description: "The callback url used to post data", args: { description: "", }, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: ["-i", "--include"], + description: + "A comma separated list of related resources to be included", args: { description: "", }, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", - hidden: true, - }, - ], - args: [ - { - name: "resource", - description: "The resource type", - }, - { - name: "id", - description: "Id of the resource to retrieve", - isOptional: true, + name: ["-n", "--name"], + description: "The webhook short name", + args: { + description: "", + }, }, ], + args: { + name: "id", + description: "Unique id of the webhook", + }, }, { - name: ["resources:list", "list", "rl", "res:list"], - description: "Fetch a collection of resources", + name: "orders", + description: "Execute an action on an order", options: [ { name: ["-o", "--organization"], @@ -4144,263 +4296,119 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", - args: { - description: "", - }, - }, - { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { name: ["-j", "--json"], - description: "Convert output in standard json format", + description: "Print result in 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", + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:approve", + description: "Send this attribute if you want to approve a placed order", + options: [ { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", - suggestions: ["curl", "node"], }, + isRequired: true, + hidden: true, }, { - 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", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", - }, - { - name: ["-Y", "--headers-only"], - description: "Show only response headers", - }, - { - name: ["-w", "--where"], - description: "Comma separated list of query filters", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-p", "--page"], - description: "Page number", - args: { - description: "", - }, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", - args: { - description: "", - }, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:approve_and_capture", + description: + "Send this attribute if you want to approve and capture a placed order", + options: [ { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-x", "--save"], - description: "Save command output to file", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-X", "--save-path"], - description: "Save command output to file and create missing path directories", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", - hidden: true, - }, - ], - 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: ["-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: ["relationship", "resources:rel", "res:rel", "res:relationship"], - description: "Fetch a resource relationship", + name: "orders:archive", + description: "Send this attribute if you want to archive the order", options: [ { name: ["-o", "--organization"], @@ -4427,150 +4435,315 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", + 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:authorization_amount_cents", + description: "The authorization amount, in cents", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, + }, + { + name: ["-p", "--print"], + description: "Print out the modified order", }, { name: ["-j", "--json"], - description: "Convert output in standard json format", + description: "Print result in json format", }, { name: ["-u", "--unformatted"], - description: "Print unformatted json output", + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:authorize", + description: + "Send this attribute if you want to authorize the order's payment source", + options: [ { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: "--doc", - description: "Show the cli command in a specific language", + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: "--accessToken", args: { description: "", - suggestions: ["curl", "node"], }, + isRequired: true, + hidden: true, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: "--node", - description: "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: "--save-args", - description: "Save command data to file for future use", + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:billing_address_clone_id", + description: + "The id of the address that you want to clone to create the order's billing addre", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + { + name: ["-v", "--value"], + description: "The trigger attribute value", args: { description: "", }, + isRequired: true, }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:billing_address_same_as_shipping", + description: + "Send this attribute if you want the billing address to be cloned from the order'", + options: [ { - name: ["-p", "--page"], - description: "Page number", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-x", "--save"], - description: "Save command output to file", + 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:cancel", + description: "Send this attribute if you want to cancel a placed order", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-X", "--save-path"], - description: "Save command output to file and create missing path directories", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", - 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: [ + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:capture", + description: + "Send this attribute if you want to capture an authorized order", + options: [ { - name: "resource", - description: "The resource type", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, + { + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: "id", - description: "Id of the resource to retrieve", + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: "relationship", - description: "Name of the relationship field", + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], - hidden: false, + args: { + name: "id", + description: "The unique id of the order", + }, }, { - name: ["resources:retrieve", "retrieve", "rr", "res:retrieve"], - description: "Fetch a single resource", + name: "orders:commit_invoice", + description: + "Send this attribute if you want commit the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], @@ -4597,243 +4770,128 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", - args: { - description: "", - }, - }, - { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { name: ["-j", "--json"], - description: "Convert output in standard json format", + description: "Print result in 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", + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:create_subscriptions", + description: + "Send this attribute upon/after placing the order if you want to create order sub", + options: [ { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", - suggestions: ["curl", "node"], }, + isRequired: true, + hidden: true, }, { - 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", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-x", "--save"], - description: "Save command output to file", + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:customer_payment_source_id", + description: "The id of the customer payment source (i", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-X", "--save-path"], - description: "Save command output to file and create missing path directories", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: "--accessToken", args: { description: "", }, + 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: ["-p", "--print"], + description: "Print out the modified order", }, { - name: "id", - description: "Id of the resource to retrieve", - isOptional: true, + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + { + name: ["-v", "--value"], + description: "The trigger attribute value", + args: { + description: "", + }, + isRequired: true, }, ], + args: { + name: "id", + description: "The unique id of the order", + }, }, { - name: ["resources:schema", "schema", "res:schema", "rs"], - description: "Show the current commercelayer openapi schema version used by the plugin", - }, - { - name: ["resources:update", "update", "ru", "res:update", "patch"], - description: "Update an existing resource", + name: "orders:nullify_payment_source", + description: + "Send this attribute if you want to nullify the payment source for this order", options: [ { name: ["-o", "--organization"], @@ -4860,243 +4918,120 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", - args: { - description: "", - }, - }, - { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { name: ["-j", "--json"], - description: "Convert output in standard json format", + description: "Print result in 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", + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:pending", + description: + "Send this attribute if you want to move a draft or placing order to pending", + options: [ { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", - suggestions: ["curl", "node"], }, + isRequired: true, + hidden: true, }, { - 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", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", - }, - { - name: ["-Y", "--headers-only"], - description: "Show only response headers", - }, - { - name: ["-a", "--attribute"], - description: "Define a resource attribute", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-O", "--object"], - description: "Define a resource object attribute", - args: { - description: "", - }, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-r", "--relationship"], - description: "Define a relationship with another resource", - args: { - description: "", - }, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:place", + description: "Send this attribute if you want to place the order", + options: [ { - name: ["-m", "--metadata"], - description: "", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-M", "--metadata-replace"], - description: "", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-D", "--data"], - description: "The data file to use as request body", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-t", "--tags"], - description: "List of tags associated with the resource", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, - ], - args: [ { - 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: ["-j", "--json"], + description: "Print result in json format", }, { - name: "id", - description: "Id of the resource to update", - isOptional: true, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], + args: { + name: "id", + description: "The unique id of the order", + }, }, { - name: "webhooks", - description: "List all the registered webhooks or the details of a single webhook", + name: "orders:refresh", + description: + "Send this attribute if you want to manually refresh the order", options: [ { name: ["-o", "--organization"], @@ -5123,38 +5058,73 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-c", "--circuit"], - description: "Show only webhooks with circuit in the declared state", + 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:refund", + description: "Send this attribute if you want to refund a captured order", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", - suggestions: ["open", "closed"], }, + isRequired: true, + hidden: true, }, { - name: ["-t", "--topic"], - description: "The event that triggered the webhook", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-H", "--hide-empty"], - description: "Hide empty attributes", + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-e", "--events"], - description: "Show the last event callbacks associated to the webhook", + 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: "Unique id of the webhook to get a single webhook", - isOptional: true, + description: "The unique id of the order", }, }, { - name: ["webhooks:create", "wh:create"], - description: "Create a new webhook", + name: "orders:refund_invoice", + description: + "Send this attribute if you want refund the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], @@ -5181,40 +5151,74 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-t", "--topic"], - description: "The identifier of the event that will trigger the webhook", - args: { - description: "", - }, - isRequired: true, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-u", "--url"], - description: "The callback url used to post data", + 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:reset_circuit", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, isRequired: true, + hidden: true, }, { - name: ["-i", "--include"], - description: "A comma separated list of related resources to be included", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-n", "--name"], - description: "The webhook short name", + name: "--accessToken", args: { description: "", }, + 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: ["webhooks:destroy", "webhooks:delete", "wh:delete", "wh:destroy"], - description: "Destroy an existing webhook", + name: "orders: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", options: [ { name: ["-o", "--organization"], @@ -5240,15 +5244,28 @@ const completionSpec: Fig.Spec = { 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: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:details", "wh:details"], - description: "Show the details of an existing webhook", + name: "orders:save_payment_source_to_customer_wallet", + description: + "Send this attribute if you want the order's payment source to be saved in the cu", options: [ { name: ["-o", "--organization"], @@ -5275,22 +5292,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-H", "--hide-empty"], - description: "Hide empty attributes", + name: ["-p", "--print"], + description: "Print out the modified order", }, { - 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 order", }, }, { - name: ["webhooks:event", "wh:event"], - description: "Show the details of a firedf webhook event", + name: "orders: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"], @@ -5317,22 +5339,27 @@ 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 order", }, { - 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 order", }, }, { - name: ["webhooks:events", "wh:events"], - description: "List all the events associated to the webhook", + name: "orders:shipping_address_clone_id", + description: + "The id of the address that you want to clone to create the order's shipping addr", options: [ { name: ["-o", "--organization"], @@ -5359,25 +5386,35 @@ 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 order", }, { - name: ["-l", "--limit"], - description: "Limit number of events in output", + name: ["-j", "--json"], + description: "Print result in json format", + }, + { + name: ["-u", "--unformatted"], + description: "Print json output without indentation", + }, + { + name: ["-v", "--value"], + description: "The trigger attribute value", args: { description: "", }, + isRequired: true, }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:list", "wh:list"], - description: "List all the registered webhooks", + name: "orders: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"], @@ -5404,25 +5441,74 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-c", "--circuit"], - description: "Show only webhooks with circuit in the declared state", + 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:start_editing", + description: + "Send this attribute if you want to edit the order after it is placed", + options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", - suggestions: ["open", "closed"], }, + isRequired: true, + hidden: true, }, { - name: ["-t", "--topic"], - description: "The event that triggered the webhook", + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, + }, + { + name: "--accessToken", args: { description: "", }, + 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: ["webhooks:listen", "wh:listen"], - description: "Listen a webhook for outgoing callbacks", + name: "orders:stop_editing", + description: + "Send this attribute to stop the editing for the order and return back to placed", options: [ { name: ["-o", "--organization"], @@ -5449,22 +5535,26 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-t", "--time"], - description: "Waiting time for the first event", - args: { - description: "", - default: "120", - }, + 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: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:payload", "wh:payload"], - description: "Show the payload associated to an event callback", + name: "orders:unarchive", + description: "Send this attribute if you want to unarchive the order", options: [ { name: ["-o", "--organization"], @@ -5491,18 +5581,27 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-f", "--format"], - description: "Format the payload output", + 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: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:reset", "wh:reset"], - description: "Reset the circuit breaker associated to the webhook", + name: "orders:update_taxes", + description: + "Send this attribute if you want to force tax calculation for this order (a tax c", options: [ { name: ["-o", "--organization"], @@ -5528,19 +5627,28 @@ const completionSpec: Fig.Spec = { 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: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:topics", "wh:topics"], - description: "Show online documentation for supported events", - }, - { - name: ["webhooks:update", "wh:update"], - description: "Update an existing webhook", + name: "orders:validate", + description: + "Send this attribute if you want to trigger the external validation for the order", options: [ { name: ["-o", "--organization"], @@ -5567,37 +5675,21 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-t", "--topic"], - description: "The identifier of the event that will trigger the webhook", - args: { - description: "", - }, - }, - { - name: ["-u", "--url"], - description: "The callback url used to post data", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-i", "--include"], - description: "A comma separated list of related resources to be included", - args: { - description: "", - }, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-n", "--name"], - description: "The webhook short name", - args: { - description: "", - }, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the order", }, }, { @@ -5648,7 +5740,8 @@ const completionSpec: Fig.Spec = { }, { name: "adyen_payment:details", - description: "Send this attribute if you want to send additional details the payment request", + description: + "Send this attribute if you want to send additional details the payment request", options: [ { name: ["-o", "--organization"], @@ -5740,7 +5833,8 @@ const completionSpec: Fig.Spec = { }, { name: "authorization:capture", - description: "Send this attribute if you want to create a capture for this authorization", + description: + "Send this attribute if you want to create a capture for this authorization", options: [ { name: ["-o", "--organization"], @@ -5832,7 +5926,8 @@ const completionSpec: Fig.Spec = { }, { name: "authorization:void", - description: "Send this attribute if you want to create a void for this authorization", + description: + "Send this attribute if you want to create a void for this authorization", options: [ { name: ["-o", "--organization"], @@ -5924,7 +6019,8 @@ const completionSpec: Fig.Spec = { }, { name: "axerve_payment:update", - description: "Send this attribute if you want to update the payment with fresh order data", + description: + "Send this attribute if you want to update the payment with fresh order data", options: [ { name: ["-o", "--organization"], @@ -6016,7 +6112,8 @@ const completionSpec: Fig.Spec = { }, { name: "bundle:compute_compare_at_amount", - description: "Send this attribute if you want to compute the compare_at_amount_cents as the su", + description: + "Send this attribute if you want to compute the compare_at_amount_cents as the su", options: [ { name: ["-o", "--organization"], @@ -6062,7 +6159,8 @@ const completionSpec: Fig.Spec = { }, { name: "bundle:compute_price_amount", - description: "Send this attribute if you want to compute the price_amount_cents as the sum of", + description: + "Send this attribute if you want to compute the price_amount_cents as the sum of", options: [ { name: ["-o", "--organization"], @@ -6108,7 +6206,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", + description: + "Execute an action on a resource of type buy_x_pay_y_promotions", options: [ { name: ["-o", "--organization"], @@ -6154,7 +6253,8 @@ const completionSpec: Fig.Spec = { }, { name: "buy_x_pay_y_promotion:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -6200,7 +6300,8 @@ const completionSpec: Fig.Spec = { }, { name: "buy_x_pay_y_promotion:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -6292,7 +6393,8 @@ const completionSpec: Fig.Spec = { }, { name: "capture:refund", - description: "Send this attribute if you want to create a refund for this capture", + description: + "Send this attribute if you want to create a refund for this capture", options: [ { name: ["-o", "--organization"], @@ -6384,7 +6486,8 @@ const completionSpec: Fig.Spec = { }, { name: "checkout_com_payment", - description: "Execute an action on a resource of type checkout_com_payments", + description: + "Execute an action on a resource of type checkout_com_payments", options: [ { name: ["-o", "--organization"], @@ -6430,7 +6533,8 @@ const completionSpec: Fig.Spec = { }, { name: "checkout_com_payment:details", - description: "Send this attribute if you want to send additional details the payment request (", + description: + "Send this attribute if you want to send additional details the payment request (", options: [ { name: ["-o", "--organization"], @@ -6476,7 +6580,8 @@ const completionSpec: Fig.Spec = { }, { name: "checkout_com_payment:refresh", - description: "Send this attribute if you want to refresh all the pending transactions, can be", + description: + "Send this attribute if you want to refresh all the pending transactions, can be", options: [ { name: ["-o", "--organization"], @@ -6522,7 +6627,8 @@ const completionSpec: Fig.Spec = { }, { name: "customer_password_reset", - description: "Execute an action on a resource of type customer_password_resets", + description: + "Execute an action on a resource of type customer_password_resets", options: [ { name: ["-o", "--organization"], @@ -6568,7 +6674,8 @@ const completionSpec: Fig.Spec = { }, { name: "customer_password_reset:reset_password_token", - description: "Send the 'reset_password_token' that you got on create when updating the custome", + description: + "Send the 'reset_password_token' that you got on create when updating the custome", options: [ { name: ["-o", "--organization"], @@ -6660,7 +6767,8 @@ const completionSpec: Fig.Spec = { }, { name: "external_gateway:reset_circuit", - description: "Send this attribute if you want to reset the circuit breaker associated to this", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -6706,7 +6814,8 @@ const completionSpec: Fig.Spec = { }, { name: "external_promotion", - description: "Execute an action on a resource of type external_promotions", + description: + "Execute an action on a resource of type external_promotions", options: [ { name: ["-o", "--organization"], @@ -6752,7 +6861,8 @@ const completionSpec: Fig.Spec = { }, { name: "external_promotion:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -6798,7 +6908,8 @@ const completionSpec: Fig.Spec = { }, { name: "external_promotion:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -6844,7 +6955,8 @@ const completionSpec: Fig.Spec = { }, { name: "external_promotion:reset_circuit", - description: "Send this attribute if you want to reset the circuit breaker associated to this", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -6890,7 +7002,8 @@ const completionSpec: Fig.Spec = { }, { name: "external_tax_calculator", - description: "Execute an action on a resource of type external_tax_calculators", + description: + "Execute an action on a resource of type external_tax_calculators", options: [ { name: ["-o", "--organization"], @@ -6936,7 +7049,8 @@ const completionSpec: Fig.Spec = { }, { name: "external_tax_calculator:reset_circuit", - description: "Send this attribute if you want to reset the circuit breaker associated to this", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -6982,7 +7096,8 @@ const completionSpec: Fig.Spec = { }, { name: "fixed_amount_promotion", - description: "Execute an action on a resource of type fixed_amount_promotions", + description: + "Execute an action on a resource of type fixed_amount_promotions", options: [ { name: ["-o", "--organization"], @@ -7028,7 +7143,8 @@ const completionSpec: Fig.Spec = { }, { name: "fixed_amount_promotion:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -7074,7 +7190,8 @@ const completionSpec: Fig.Spec = { }, { name: "fixed_amount_promotion:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -7120,7 +7237,8 @@ const completionSpec: Fig.Spec = { }, { name: "fixed_price_promotion", - description: "Execute an action on a resource of type fixed_price_promotions", + description: + "Execute an action on a resource of type fixed_price_promotions", options: [ { name: ["-o", "--organization"], @@ -7166,7 +7284,8 @@ const completionSpec: Fig.Spec = { }, { name: "fixed_price_promotion:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -7212,7 +7331,8 @@ const completionSpec: Fig.Spec = { }, { name: "fixed_price_promotion:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -7258,7 +7378,8 @@ const completionSpec: Fig.Spec = { }, { name: "free_gift_promotion", - description: "Execute an action on a resource of type free_gift_promotions", + description: + "Execute an action on a resource of type free_gift_promotions", options: [ { name: ["-o", "--organization"], @@ -7304,7 +7425,8 @@ const completionSpec: Fig.Spec = { }, { name: "free_gift_promotion:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -7350,7 +7472,8 @@ const completionSpec: Fig.Spec = { }, { name: "free_gift_promotion:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -7396,7 +7519,8 @@ const completionSpec: Fig.Spec = { }, { name: "free_shipping_promotion", - description: "Execute an action on a resource of type free_shipping_promotions", + description: + "Execute an action on a resource of type free_shipping_promotions", options: [ { name: ["-o", "--organization"], @@ -7442,7 +7566,8 @@ const completionSpec: Fig.Spec = { }, { name: "free_shipping_promotion:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -7488,7 +7613,8 @@ const completionSpec: Fig.Spec = { }, { name: "free_shipping_promotion:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -7718,7 +7844,8 @@ const completionSpec: Fig.Spec = { }, { name: "gift_card:purchase", - description: "Send this attribute if you want to confirm a draft gift card", + description: + "Send this attribute if you want to confirm a draft gift card", options: [ { name: ["-o", "--organization"], @@ -7764,7 +7891,8 @@ const completionSpec: Fig.Spec = { }, { name: "in_stock_subscription", - description: "Execute an action on a resource of type in_stock_subscriptions", + description: + "Execute an action on a resource of type in_stock_subscriptions", options: [ { name: ["-o", "--organization"], @@ -7810,7 +7938,8 @@ const completionSpec: Fig.Spec = { }, { name: "in_stock_subscription:activate", - description: "Send this attribute if you want to activate an inactive subscription", + description: + "Send this attribute if you want to activate an inactive subscription", options: [ { name: ["-o", "--organization"], @@ -7856,7 +7985,8 @@ const completionSpec: Fig.Spec = { }, { name: "in_stock_subscription:deactivate", - description: "Send this attribute if you want to dactivate an active subscription", + description: + "Send this attribute if you want to dactivate an active subscription", options: [ { name: ["-o", "--organization"], @@ -7948,7 +8078,8 @@ const completionSpec: Fig.Spec = { }, { name: "klarna_payment:update", - description: "Send this attribute if you want to update the payment session with fresh order d", + description: + "Send this attribute if you want to update the payment session with fresh order d", options: [ { name: ["-o", "--organization"], @@ -8040,7 +8171,8 @@ const completionSpec: Fig.Spec = { }, { name: "line_item:external_price", - description: "When creating or updating a new line item, set this attribute to '1' if you want", + description: + "When creating or updating a new line item, set this attribute to '1' if you want", options: [ { name: ["-o", "--organization"], @@ -8086,7 +8218,8 @@ const completionSpec: Fig.Spec = { }, { name: "line_item:reserve_stock", - description: "Send this attribute if you want to reserve the stock for the line item's skus qu", + description: + "Send this attribute if you want to reserve the stock for the line item's skus qu", options: [ { name: ["-o", "--organization"], @@ -8132,7 +8265,8 @@ const completionSpec: Fig.Spec = { }, { name: "line_item:reset_circuit", - description: "Send this attribute if you want to reset the circuit breaker associated to this", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -8224,7 +8358,8 @@ const completionSpec: Fig.Spec = { }, { name: "market:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -8270,7 +8405,8 @@ const completionSpec: Fig.Spec = { }, { name: "market:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -8362,7 +8498,8 @@ const completionSpec: Fig.Spec = { }, { name: "order_subscription", - description: "Execute an action on a resource of type order_subscriptions", + description: + "Execute an action on a resource of type order_subscriptions", options: [ { name: ["-o", "--organization"], @@ -8408,7 +8545,8 @@ const completionSpec: Fig.Spec = { }, { name: "order_subscription:activate", - description: "Send this attribute if you want to mark this subscription as active", + description: + "Send this attribute if you want to mark this subscription as active", options: [ { name: ["-o", "--organization"], @@ -8454,7 +8592,8 @@ const completionSpec: Fig.Spec = { }, { name: "order_subscription:cancel", - description: "Send this attribute if you want to mark this subscription as cancelled", + description: + "Send this attribute if you want to mark this subscription as cancelled", options: [ { name: ["-o", "--organization"], @@ -8500,7 +8639,8 @@ const completionSpec: Fig.Spec = { }, { name: "order_subscription:deactivate", - description: "Send this attribute if you want to mark this subscription as inactive", + description: + "Send this attribute if you want to mark this subscription as inactive", options: [ { name: ["-o", "--organization"], @@ -8592,7 +8732,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:approve_and_capture", - description: "Send this attribute if you want to approve and capture a placed order", + description: + "Send this attribute if you want to approve and capture a placed order", options: [ { name: ["-o", "--organization"], @@ -8730,7 +8871,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:authorize", - description: "Send this attribute if you want to authorize the order's payment source", + description: + "Send this attribute if you want to authorize the order's payment source", options: [ { name: ["-o", "--organization"], @@ -8776,7 +8918,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:billing_address_clone_id", - description: "The id of the address that you want to clone to create the order's billing addre", + description: + "The id of the address that you want to clone to create the order's billing addre", options: [ { name: ["-o", "--organization"], @@ -8830,7 +8973,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:billing_address_same_as_shipping", - description: "Send this attribute if you want the billing address to be cloned from the order'", + description: + "Send this attribute if you want the billing address to be cloned from the order'", options: [ { name: ["-o", "--organization"], @@ -8922,7 +9066,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:capture", - description: "Send this attribute if you want to capture an authorized order", + description: + "Send this attribute if you want to capture an authorized order", options: [ { name: ["-o", "--organization"], @@ -8968,7 +9113,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", + description: + "Send this attribute if you want commit the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], @@ -9014,7 +9160,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:create_subscriptions", - description: "Send this attribute upon/after placing the order if you want to create order sub", + description: + "Send this attribute upon/after placing the order if you want to create order sub", options: [ { name: ["-o", "--organization"], @@ -9114,7 +9261,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:nullify_payment_source", - description: "Send this attribute if you want to nullify the payment source for this order", + description: + "Send this attribute if you want to nullify the payment source for this order", options: [ { name: ["-o", "--organization"], @@ -9160,7 +9308,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:pending", - description: "Send this attribute if you want to move a draft or placing order to pending", + description: + "Send this attribute if you want to move a draft or placing order to pending", options: [ { name: ["-o", "--organization"], @@ -9252,7 +9401,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:refresh", - description: "Send this attribute if you want to manually refresh the order", + description: + "Send this attribute if you want to manually refresh the order", options: [ { name: ["-o", "--organization"], @@ -9344,7 +9494,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:refund_invoice", - description: "Send this attribute if you want refund the sales tax invoice to the associated t", + description: + "Send this attribute if you want refund the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], @@ -9390,7 +9541,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:reset_circuit", - description: "Send this attribute if you want to reset the circuit breaker associated to this", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -9436,7 +9588,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", + description: + "Send this attribute if you want the order's billing address to be saved in the c", options: [ { name: ["-o", "--organization"], @@ -9482,7 +9635,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:save_payment_source_to_customer_wallet", - description: "Send this attribute if you want the order's payment source to be saved in the cu", + description: + "Send this attribute if you want the order's payment source to be saved in the cu", options: [ { name: ["-o", "--organization"], @@ -9528,7 +9682,8 @@ const completionSpec: Fig.Spec = { }, { 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", + description: + "Send this attribute if you want the order's shipping address to be saved in the", options: [ { name: ["-o", "--organization"], @@ -9574,7 +9729,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", + description: + "The id of the address that you want to clone to create the order's shipping addr", options: [ { name: ["-o", "--organization"], @@ -9628,7 +9784,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:shipping_address_same_as_billing", - description: "Send this attribute if you want the shipping address to be cloned from the order", + description: + "Send this attribute if you want the shipping address to be cloned from the order", options: [ { name: ["-o", "--organization"], @@ -9674,7 +9831,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:start_editing", - description: "Send this attribute if you want to edit the order after it is placed", + description: + "Send this attribute if you want to edit the order after it is placed", options: [ { name: ["-o", "--organization"], @@ -9720,7 +9878,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:stop_editing", - description: "Send this attribute to stop the editing for the order and return back to placed", + description: + "Send this attribute to stop the editing for the order and return back to placed", options: [ { name: ["-o", "--organization"], @@ -9812,7 +9971,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:update_taxes", - description: "Send this attribute if you want to force tax calculation for this order (a tax c", + description: + "Send this attribute if you want to force tax calculation for this order (a tax c", options: [ { name: ["-o", "--organization"], @@ -9858,7 +10018,8 @@ const completionSpec: Fig.Spec = { }, { name: "order:validate", - description: "Send this attribute if you want to trigger the external validation for the order", + description: + "Send this attribute if you want to trigger the external validation for the order", options: [ { name: ["-o", "--organization"], @@ -9950,7 +10111,8 @@ const completionSpec: Fig.Spec = { }, { name: "payment_method:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -9996,7 +10158,8 @@ const completionSpec: Fig.Spec = { }, { name: "payment_method:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -10042,7 +10205,8 @@ const completionSpec: Fig.Spec = { }, { name: "percentage_discount_promotion", - description: "Execute an action on a resource of type percentage_discount_promotions", + description: + "Execute an action on a resource of type percentage_discount_promotions", options: [ { name: ["-o", "--organization"], @@ -10088,7 +10252,8 @@ const completionSpec: Fig.Spec = { }, { name: "percentage_discount_promotion:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -10134,7 +10299,8 @@ const completionSpec: Fig.Spec = { }, { name: "percentage_discount_promotion:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -10318,7 +10484,8 @@ const completionSpec: Fig.Spec = { }, { name: "return:approve", - description: "Send this attribute if you want to mark this return as approved", + description: + "Send this attribute if you want to mark this return as approved", options: [ { name: ["-o", "--organization"], @@ -10410,7 +10577,8 @@ const completionSpec: Fig.Spec = { }, { name: "return:cancel", - description: "Send this attribute if you want to mark this return as cancelled", + description: + "Send this attribute if you want to mark this return as cancelled", options: [ { name: ["-o", "--organization"], @@ -10456,7 +10624,8 @@ const completionSpec: Fig.Spec = { }, { name: "return:receive", - description: "Send this attribute if you want to mark this return as received", + description: + "Send this attribute if you want to mark this return as received", options: [ { name: ["-o", "--organization"], @@ -10502,7 +10671,8 @@ const completionSpec: Fig.Spec = { }, { name: "return:reject", - description: "Send this attribute if you want to mark this return as rejected", + description: + "Send this attribute if you want to mark this return as rejected", options: [ { name: ["-o", "--organization"], @@ -10594,7 +10764,8 @@ const completionSpec: Fig.Spec = { }, { name: "return:restock", - description: "Send this attribute if you want to restock all of the return line items", + description: + "Send this attribute if you want to restock all of the return line items", options: [ { name: ["-o", "--organization"], @@ -10640,7 +10811,8 @@ const completionSpec: Fig.Spec = { }, { name: "return:ship", - description: "Send this attribute if you want to mark this return as shipped", + description: + "Send this attribute if you want to mark this return as shipped", options: [ { name: ["-o", "--organization"], @@ -10778,7 +10950,8 @@ const completionSpec: Fig.Spec = { }, { name: "satispay_payment:refresh", - description: "Send this attribute if you want to refresh all the pending transactions, can be", + description: + "Send this attribute if you want to refresh all the pending transactions, can be", options: [ { name: ["-o", "--organization"], @@ -10870,7 +11043,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:decrement_stock", - description: "Send this attribute if you want to automatically decrement and release the stock", + description: + "Send this attribute if you want to automatically decrement and release the stock", options: [ { name: ["-o", "--organization"], @@ -10916,7 +11090,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:get_rates", - description: "Send this attribute if you want get the shipping rates from the associated carri", + description: + "Send this attribute if you want get the shipping rates from the associated carri", options: [ { name: ["-o", "--organization"], @@ -10962,7 +11137,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:on_hold", - description: "Send this attribute if you want to put this shipment on hold", + description: + "Send this attribute if you want to put this shipment on hold", options: [ { name: ["-o", "--organization"], @@ -11008,7 +11184,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:packing", - description: "Send this attribute if you want to start packing this shipment", + description: + "Send this attribute if you want to start packing this shipment", options: [ { name: ["-o", "--organization"], @@ -11054,7 +11231,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:picking", - description: "Send this attribute if you want to start picking this shipment", + description: + "Send this attribute if you want to start picking this shipment", options: [ { name: ["-o", "--organization"], @@ -11100,7 +11278,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:purchase", - description: "Send this attribute if you want to purchase this shipment with the selected rate", + description: + "Send this attribute if you want to purchase this shipment with the selected rate", options: [ { name: ["-o", "--organization"], @@ -11146,7 +11325,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:ready_to_ship", - description: "Send this attribute if you want to mark this shipment as ready to ship", + description: + "Send this attribute if you want to mark this shipment as ready to ship", options: [ { name: ["-o", "--organization"], @@ -11192,7 +11372,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:release_stock", - description: "Send this attribute if you want to automatically destroy the stock reservations", + description: + "Send this attribute if you want to automatically destroy the stock reservations", options: [ { name: ["-o", "--organization"], @@ -11238,7 +11419,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:reserve_stock", - description: "Send this attribute if you want to automatically reserve the stock for each of t", + description: + "Send this attribute if you want to automatically reserve the stock for each of t", options: [ { name: ["-o", "--organization"], @@ -11284,7 +11466,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:ship", - description: "Send this attribute if you want to mark this shipment as shipped", + description: + "Send this attribute if you want to mark this shipment as shipped", options: [ { name: ["-o", "--organization"], @@ -11330,7 +11513,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipment:upcoming", - description: "Send this attribute if you want to mark this shipment as upcoming", + description: + "Send this attribute if you want to mark this shipment as upcoming", options: [ { name: ["-o", "--organization"], @@ -11422,7 +11606,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipping_method:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -11468,7 +11653,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipping_method:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -11514,7 +11700,8 @@ const completionSpec: Fig.Spec = { }, { name: "shipping_method:reset_circuit", - description: "Send this attribute if you want to reset the circuit breaker associated to this", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -11606,7 +11793,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_item:validate", - description: "Send this attribute if you want to validate the stock item quantity against the", + description: + "Send this attribute if you want to validate the stock item quantity against the", options: [ { name: ["-o", "--organization"], @@ -11698,7 +11886,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_line_item:decrement_stock", - description: "Send this attribute if you want to automatically decrement and release the stock", + description: + "Send this attribute if you want to automatically decrement and release the stock", options: [ { name: ["-o", "--organization"], @@ -11744,7 +11933,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_line_item:release_stock", - description: "Send this attribute if you want to automatically destroy the stock reservation f", + description: + "Send this attribute if you want to automatically destroy the stock reservation f", options: [ { name: ["-o", "--organization"], @@ -11790,7 +11980,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_line_item:reserve_stock", - description: "Send this attribute if you want to automatically reserve the stock for this stoc", + description: + "Send this attribute if you want to automatically reserve the stock for this stoc", options: [ { name: ["-o", "--organization"], @@ -11882,7 +12073,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_reservation:pending", - description: "Send this attribute if you want to mark this stock reservation as pending", + description: + "Send this attribute if you want to mark this stock reservation as pending", options: [ { name: ["-o", "--organization"], @@ -11974,7 +12166,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_transfer:cancel", - description: "Send this attribute if you want to cancel this stock transfer", + description: + "Send this attribute if you want to cancel this stock transfer", options: [ { name: ["-o", "--organization"], @@ -12020,7 +12213,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_transfer:complete", - description: "Send this attribute if you want to complete this stock transfer", + description: + "Send this attribute if you want to complete this stock transfer", options: [ { name: ["-o", "--organization"], @@ -12066,7 +12260,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_transfer:in_transit", - description: "Send this attribute if you want to mark this stock transfer as in transit", + description: + "Send this attribute if you want to mark this stock transfer as in transit", options: [ { name: ["-o", "--organization"], @@ -12112,7 +12307,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_transfer:on_hold", - description: "Send this attribute if you want to put this stock transfer on hold", + description: + "Send this attribute if you want to put this stock transfer on hold", options: [ { name: ["-o", "--organization"], @@ -12158,7 +12354,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_transfer:picking", - description: "Send this attribute if you want to start picking this stock transfer", + description: + "Send this attribute if you want to start picking this stock transfer", options: [ { name: ["-o", "--organization"], @@ -12204,7 +12401,8 @@ const completionSpec: Fig.Spec = { }, { name: "stock_transfer:upcoming", - description: "Send this attribute if you want to mark this stock transfer as upcoming", + description: + "Send this attribute if you want to mark this stock transfer as upcoming", options: [ { name: ["-o", "--organization"], @@ -12296,7 +12494,8 @@ const completionSpec: Fig.Spec = { }, { name: "stripe_payment:refresh", - description: "Send this attribute if you want to refresh the payment status, can be used as we", + description: + "Send this attribute if you want to refresh the payment status, can be used as we", options: [ { name: ["-o", "--organization"], @@ -12342,7 +12541,8 @@ const completionSpec: Fig.Spec = { }, { name: "stripe_payment:update", - description: "Send this attribute if you want to update the created payment intent with fresh", + description: + "Send this attribute if you want to update the created payment intent with fresh", options: [ { name: ["-o", "--organization"], @@ -12434,7 +12634,8 @@ const completionSpec: Fig.Spec = { }, { name: "webhook:disable", - description: "Send this attribute if you want to mark this resource as disabled", + description: + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], @@ -12480,7 +12681,8 @@ const completionSpec: Fig.Spec = { }, { name: "webhook:enable", - description: "Send this attribute if you want to mark this resource as enabled", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], @@ -12526,7 +12728,8 @@ const completionSpec: Fig.Spec = { }, { name: "webhook:reset_circuit", - description: "Send this attribute if you want to reset the circuit breaker associated to this", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], @@ -12571,9 +12774,19 @@ const completionSpec: Fig.Spec = { }, }, { - name: ["provisioning:create", "prov:create", "pc", "pcreate"], - description: "Create a new resource", + name: "exports", + description: + "List all the created exports or show details of a single export", options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, { name: ["-d", "--domain"], args: { @@ -12590,116 +12803,220 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: ["-A", "--all"], + description: "Show all exports instead of first 25 only", + }, + { + name: ["-t", "--type"], + description: "The type of resource exported", + args: { + description: "", + suggestions: [ + "addresses", + "authorizations", + "bundles", + "captures", + "coupons", + "customer_addresses", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "refunds", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tags", + "tax_categories", + "transactions", + "voids", + ], + }, + }, + { + name: ["-s", "--status"], + description: "The export job status", args: { description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], }, }, { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-l", "--limit"], + description: "Limit number of exports in output", args: { description: "", }, }, + ], + args: { + name: "id", + description: "Unique id of the export to be retrieved", + isOptional: true, + }, + }, + { + name: ["exports:all", "exp:all", "export"], + description: "Export all the records", + options: [ { - name: ["-j", "--json"], - description: "Convert output in standard json format", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: "--doc", - description: "Show the cli command in a specific language", + name: ["-t", "--type"], + description: "The type of resource being exported", + args: { + description: "Addresses|authorizations|bundles|captures|etc", + suggestions: [ + "addresses", + "authorizations", + "bundles", + "captures", + "coupons", + "customer_addresses", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "refunds", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tags", + "tax_categories", + "transactions", + "voids", + ], + }, + isRequired: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", - suggestions: ["curl", "node"], }, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: { + description: "", + }, }, { - name: "--node", - description: "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-D", "--dry-data"], + description: "Skip redundant attributes", }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-F", "--format"], + description: "Export file format", + args: { + description: "", + suggestions: ["csv", "json"], + default: "json", + }, }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-C", "--csv"], + description: "Export data in csv format", }, { - name: ["-a", "--attribute"], - description: "Define a resource attribute", + name: ["-x", "--save"], + description: "Save command output to file", args: { description: "", }, }, { - name: ["-O", "--object"], - description: "Define a resource object attribute", + name: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", args: { description: "", }, }, { - name: ["-r", "--relationship"], - description: "Define a relationship with another resource", - args: { - description: "", - }, + name: ["-N", "--notify"], + description: "Force system notification when export has finished", + hidden: true, + }, + { + name: ["-b", "--blind"], + description: + "Execute in blind mode without showing the progress monitor", + }, + { + name: ["-P", "--prettify"], + description: "Prettify json output format", }, { - name: ["-m", "--metadata"], - description: "Define a metadata attribute or a set of metadata attributes", - args: { - description: "", - }, + name: ["-O", "--open"], + description: "Open automatically the file after a successful export", }, { - name: ["-D", "--data"], - description: "The data file to use as request body", - args: { - description: "", - }, + name: ["-q", "--quiet"], + description: "Execute command without showing warning messages", + }, + { + name: ["-k", "--keep"], + description: "Keep original export files in temp dir", }, ], - args: { - name: "resource", - description: "The resource type", - suggestions: [ - "api_credential", - "application_membership", - "membership", - "organization", - "permission", - "role", - "subscription", - ], - }, + hidden: false, }, { - name: ["provisioning:delete", "prov:delete", "pd", "pdelete", "pdel"], - description: "Delete an existing resource", + name: ["exports:create", "exp:create"], + description: "Create a new export", options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, { name: ["-d", "--domain"], args: { @@ -12715,6 +13032,43 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, + { + name: ["-t", "--type"], + description: "The type of resource being exported", + args: { + description: "Addresses|authorizations|bundles|captures|etc", + suggestions: [ + "addresses", + "authorizations", + "bundles", + "captures", + "coupons", + "customer_addresses", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "refunds", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tags", + "tax_categories", + "transactions", + "voids", + ], + }, + isRequired: true, + }, { name: ["-i", "--include"], description: "Comma separated resources to include", @@ -12723,126 +13077,105 @@ const completionSpec: Fig.Spec = { }, }, { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, }, { - name: ["-j", "--json"], - description: "Convert output in standard json format", - }, - { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: ["-D", "--dry-data"], + description: "Skip redundant attributes", }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: ["-F", "--format"], + description: "Export file format", + args: { + description: "", + suggestions: ["csv", "json"], + default: "json", + }, }, { - name: "--doc", - description: "Show the cli command in a specific language", + name: ["-C", "--csv"], + description: "Export data in csv format", }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-x", "--save"], + description: "Save command output to file", args: { description: "", - 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: ["-X", "--save-path"], + description: + "Save command output to file and create missing path directories", + args: { + description: "", + }, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-N", "--notify"], + description: "Force system notification when export has finished", + hidden: true, }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-b", "--blind"], + description: + "Execute in blind mode without showing the progress monitor", }, - ], - args: [ { - name: "resource", - description: "The resource type", - suggestions: ["api_credential", "application_membership", "membership"], + name: ["-P", "--prettify"], + description: "Prettify json output format", }, { - name: "id", - description: "Id of the resource to delete", - isOptional: true, + name: ["-O", "--open"], + description: "Open automatically the file after a successful export", }, ], }, { - name: ["provisioning:exec", "prov:exec", "pe", "pexec"], - description: "Execute an action on a resource", + name: ["exports:details", "exp:details"], + description: "Show the details of an existing export", options: [ { - name: ["-d", "--domain"], + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, hidden: true, }, { - name: "--accessToken", + name: ["-d", "--domain"], args: { description: "", }, - isRequired: true, hidden: true, }, { - name: ["-a", "--attribute"], - description: "Define a resource attribute", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, ], - args: [ - { - name: "resource", - description: "The resource type", - }, - { - name: "id", - description: "Id of the resource on which to execute the action", - isOptional: true, - }, - { - name: "action", - description: "Action to execute on resource", - isOptional: true, - }, - ], + args: { + name: "id", + description: "Unique id of the export", + }, }, { - name: ["provisioning:fetch", "prov:fetch", "pf"], - description: "Retrieve a resource or list a set of resources", + name: ["exports:group", "exp:group"], + description: "List all the exports related to an export group", options: [ { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, @@ -12850,123 +13183,134 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, + ], + args: { + name: "group_id", + description: "Unique id of the group export", + }, + }, + { + name: ["exports:list", "exp:list"], + description: "List all the created exports", + options: [ { - 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", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", - suggestions: ["curl", "node"], }, + isRequired: true, + hidden: true, }, { - 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: ["-H", "--headers"], - description: "Show response headers", - }, - { - name: ["-Y", "--headers-only"], - description: "Show only response headers", - }, - { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-p", "--page"], - description: "Page number", + name: ["-A", "--all"], + description: "Show all exports instead of first 25 only", + }, + { + name: ["-t", "--type"], + description: "The type of resource exported", args: { description: "", + suggestions: [ + "addresses", + "authorizations", + "bundles", + "captures", + "coupons", + "customer_addresses", + "customer_subscriptions", + "customers", + "gift_cards", + "line_items", + "orders", + "payment_methods", + "price_tiers", + "prices", + "refunds", + "shipments", + "shipping_categories", + "shipping_methods", + "sku_lists", + "sku_list_items", + "sku_options", + "skus", + "stock_items", + "tags", + "tax_categories", + "transactions", + "voids", + ], }, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-s", "--status"], + description: "The export job status", args: { description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], }, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: ["-l", "--limit"], + description: "Limit number of exports in output", args: { description: "", }, }, - { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", - hidden: true, - }, ], - args: [ - { - name: "resource", - description: "The resource type", - }, - { - name: "path", - description: "Path (or url) of the resource(s) to fetch", - }, + }, + { + name: ["exports:types", "exp:types"], + description: "Show online documentation for supported resources", + options: [ { - name: "id", - description: "Resource id", - isOptional: true, + name: ["-O", "--open"], + description: "Open online documentation page", }, ], }, { - name: ["provisioning:get", "prov:get", "pg", "pget"], - description: "Retrieve a resource or list a set of resources", + name: "tags", + description: "List all the created tags or show details of a single tag", options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, { name: ["-d", "--domain"], args: { @@ -12983,252 +13327,256 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: ["-A", "--all"], + description: "Show all tags instead of first 25 only", + }, + { + name: ["-l", "--limit"], + description: "Limit number of tags in output", args: { description: "", }, }, + ], + args: { + name: "id", + description: "Unique id of the tag to be retrieved", + isOptional: true, + }, + }, + { + name: ["tags:add", "tag"], + description: "Add one or more tags to a set of resources", + options: [ { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + 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: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-d", "--domain"], args: { description: "", - suggestions: ["curl", "node"], }, + hidden: true, }, { - 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: ["-H", "--headers"], - description: "Show response headers", - }, - { - name: ["-Y", "--headers-only"], - description: "Show only response headers", - }, - { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-n", "--name"], + description: "The tag name", args: { description: "", }, + isRequired: true, }, { - name: ["-p", "--page"], - description: "Page number", + name: ["-t", "--type"], + description: "The type of the resource to tag", args: { description: "", }, + isRequired: true, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-i", "--id"], + description: "The ids of the resources to tag", args: { description: "", }, + isRequired: true, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: ["-C", "--create"], + description: "Create tags if don't exist", args: { description: "", }, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", - hidden: true, - }, - ], - args: [ - { - name: "resource", - description: "The resource type", - }, - { - name: "id", - description: "Id of the resource to retrieve", - isOptional: true, + name: ["-v", "--verbose"], + description: "Show details of the tag process", }, ], }, { - name: ["provisioning:list", "pl", "prov:list", "plist", "pls"], - description: "Fetch a collection of resources", + name: "tags:count", + description: "Count resources tagged with a specific tag", options: [ { - name: ["-d", "--domain"], + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, hidden: true, }, { - name: "--accessToken", + name: ["-d", "--domain"], args: { description: "", }, - isRequired: true, hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-t", "--type"], + description: "The type of the tagged resources", args: { description: "", }, }, { - 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: ["-z", "--zero"], + description: "Show also resources without tags", }, + ], + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, + }, + { + name: "tags:create", + description: "Create one or more new tags", + options: [ { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", - suggestions: ["curl", "node"], }, + isRequired: true, + hidden: true, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - name: "--node", - description: "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-n", "--name"], + description: "The tag name", + args: { + description: "", + }, + isRequired: true, }, + ], + }, + { + name: "tags:delete", + description: "Delete one or more existing tags", + options: [ { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-p", "--page"], - description: "Page number", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: ["-n", "--name"], + description: "The tag name", args: { description: "", }, + isRequired: true, }, + ], + }, + { + name: "tags:details", + description: "Show the details of an existing tag", + options: [ { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, hidden: true, }, ], args: { - name: "resource", - description: "The resource type", - suggestions: [ - "api_credentials", - "application_memberships", - "memberships", - "organizations", - "permissions", - "plans", - "roles", - "subscriptions", - "versions", - ], + name: "id_name", + description: "Unique id or name of the tag", }, }, { - name: ["provisioning:rel", "prov:rel", "prov:relationship"], - description: "Fetch a resource relationship", + name: "tags:list", + description: "List all the created tags", options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: { + description: "", + }, + isRequired: true, + hidden: true, + }, { name: ["-d", "--domain"], args: { @@ -13245,132 +13593,184 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", + name: ["-A", "--all"], + description: "Show all tags instead of first 25 only", + }, + { + name: ["-l", "--limit"], + description: "Limit number of tags in output", args: { description: "", }, }, + ], + }, + { + name: "tags:remove", + description: "Remove one or more tags to a set of resources", + options: [ { - name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + 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: ["-d", "--domain"], + args: { + description: "", + }, + hidden: true, }, { - name: "--doc", - description: "Show the cli command in a specific language", + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: ["-l", "--lang"], - description: "Show the cli command in the specified language syntax", + name: ["-n", "--name"], + description: "The tag name", args: { description: "", - suggestions: ["curl", "node"], }, + isRequired: true, }, { - name: "--curl", - description: "Show the equivalent curl command of the cli command", - hidden: false, + name: ["-t", "--type"], + description: "The type of the resource to tag", + args: { + description: "", + }, + isRequired: true, }, { - name: "--node", - description: "Show the equivalent node sdk source code of the cli command", - hidden: false, + name: ["-i", "--id"], + description: "The ids of th eresources to tag", + args: { + description: "", + }, + isRequired: true, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-v", "--verbose"], + description: "Show details of the tag process", }, + ], + }, + { + name: "tags:types", + description: "Show online documentation for supported resources", + options: [ { - name: ["-Y", "--headers-only"], - description: "Show only response headers", + name: ["-O", "--open"], + description: "Open online documentation page", }, + ], + }, + { + name: "tags:update", + description: "Update an existing tag", + options: [ { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-p", "--page"], - description: "Page number", + name: ["-d", "--domain"], args: { description: "", }, + hidden: true, }, { - name: ["-n", "--pageSize"], - description: "Number of elements per page", + name: "--accessToken", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: ["-n", "--name"], + description: "The new tag name", args: { description: "", }, + isRequired: true, }, + ], + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, + }, + { + name: "tags:which", + description: "Show all the resources with this tag", + options: [ { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: ["-o", "--organization"], + description: "The slug of your organization", args: { description: "", }, + isRequired: true, + hidden: true, }, { - name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + name: ["-d", "--domain"], + args: { + description: "", + }, hidden: true, }, - ], - args: [ { - name: "resource", - description: "The resource type", + name: "--accessToken", + args: { + description: "", + }, + isRequired: true, + hidden: true, }, { - name: "id", - description: "Id of the resource to retrieve", + name: ["-t", "--type"], + description: "The type of the tagged resources", + args: { + description: "", + }, + isRequired: true, }, { - name: "relationship", - description: "Name of the relationship field", + name: ["-A", "--all"], + description: "Show all resources instead of first 25 only", }, - ], - hidden: false, - }, - { - name: ["provisioning:resources", "prov:resources", "pres"], - description: "List all the available provisioning api resources", - options: [ { - name: ["-h", "--help"], - description: "Show cli help", + name: ["-l", "--limit"], + description: "Limit number of resources in output", + args: { + description: "", + }, }, ], + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, }, { - name: ["provisioning:retrieve", "prov:retrieve", "pr", "pretrieve"], - description: "Fetch a single resource", + name: ["provisioning:create", "prov:create", "pc", "pcreate"], + description: "Create a new resource", options: [ { name: ["-d", "--domain"], @@ -13396,7 +13796,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, @@ -13433,7 +13834,8 @@ const completionSpec: Fig.Spec = { }, { name: "--node", - description: "Show the equivalent node sdk source code of the cli command", + description: + "Show the equivalent node sdk source code of the cli command", hidden: false, }, { @@ -13445,41 +13847,59 @@ const completionSpec: Fig.Spec = { description: "Show only response headers", }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", + name: ["-a", "--attribute"], + description: "Define a resource attribute", args: { description: "", }, }, - ], - args: [ { - name: "resource", - description: "The resource type", - suggestions: [ - "api_credential", - "application_membership", - "billing_profile", - "membership", - "organization", - "permission", - "plan", - "role", - "subscription", - "user", - "version", - ], + name: ["-O", "--object"], + description: "Define a resource object attribute", + args: { + description: "", + }, }, { - name: "id", - description: "Id of the resource to retrieve", - isOptional: true, + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", + args: { + description: "", + }, + }, + { + name: ["-m", "--metadata"], + description: + "Define a metadata attribute or a set of metadata attributes", + args: { + description: "", + }, + }, + { + name: ["-D", "--data"], + description: "The data file to use as request body", + args: { + description: "", + }, }, ], + args: { + name: "resource", + description: "The resource type", + suggestions: [ + "api_credential", + "application_membership", + "membership", + "organization", + "permission", + "role", + "subscription", + ], + }, }, { - name: ["provisioning:update", "prov:update", "pu", "pupdate", "pupd"], - description: "Update an existing resource", + name: ["provisioning:delete", "prov:delete", "pd", "pdelete", "pdel"], + description: "Delete an existing resource", options: [ { name: ["-d", "--domain"], @@ -13505,7 +13925,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-f", "--fields"], - description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, @@ -13542,7 +13963,8 @@ const completionSpec: Fig.Spec = { }, { name: "--node", - description: "Show the equivalent node sdk source code of the cli command", + description: + "Show the equivalent node sdk source code of the cli command", hidden: false, }, { @@ -13553,48 +13975,6 @@ const completionSpec: Fig.Spec = { name: ["-Y", "--headers-only"], description: "Show only response headers", }, - { - name: ["-a", "--attribute"], - description: "Define a resource attribute", - args: { - description: "", - }, - }, - { - name: ["-O", "--object"], - description: "Define a resource object attribute", - args: { - description: "", - }, - }, - { - name: ["-r", "--relationship"], - description: "Define a relationship with another resource", - args: { - description: "", - }, - }, - { - name: ["-m", "--metadata"], - description: "", - args: { - description: "", - }, - }, - { - name: ["-M", "--metadata-replace"], - description: "", - args: { - description: "", - }, - }, - { - name: ["-D", "--data"], - description: "The data file to use as request body", - args: { - description: "", - }, - }, ], args: [ { @@ -13604,32 +13984,19 @@ const completionSpec: Fig.Spec = { "api_credential", "application_membership", "membership", - "organization", - "permission", - "role", - "user", ], }, { name: "id", - description: "Id of the resource to update", + description: "Id of the resource to delete", isOptional: true, }, ], }, { - name: "exports", - description: "List all the created exports or show details of a single export", + name: ["provisioning:exec", "prov:exec", "pe", "pexec"], + description: "Execute an action on a resource", options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, { name: ["-d", "--domain"], args: { @@ -13646,131 +14013,111 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-A", "--all"], - description: "Show all exports instead of first 25 only", - }, - { - name: ["-t", "--type"], - description: "The type of resource exported", + name: ["-a", "--attribute"], + description: "Define a resource attribute", args: { description: "", - suggestions: [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds", - ], }, }, + ], + args: [ { - name: ["-s", "--status"], - description: "The export job status", - args: { - description: "", - suggestions: ["in_progress", "pending", "completed", "interrupted"], - }, + name: "resource", + description: "The resource type", }, { - name: ["-l", "--limit"], - description: "Limit number of exports in output", - args: { - description: "", - }, + name: "id", + description: "Id of the resource on which to execute the action", + isOptional: true, + }, + { + name: "action", + description: "Action to execute on resource", + isOptional: true, }, ], - args: { - name: "id", - description: "Unique id of the export to be retrieved", - isOptional: true, - }, }, { - name: ["exports:all", "exp:all", "export"], - description: "Export all the records", + name: ["provisioning:fetch", "prov:fetch", "pf"], + description: "Retrieve a resource or list a set of resources", options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-d", "--domain"], args: { description: "", }, - isRequired: true, hidden: true, }, { - name: ["-d", "--domain"], + name: "--accessToken", args: { description: "", }, + isRequired: true, hidden: true, }, { - name: "--accessToken", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-t", "--type"], - description: "The type of resource being exported", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { - description: "Addresses|bundles|coupons|customer_subscriptions|etc", - suggestions: [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds", - ], + description: "", + }, + }, + { + 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: { + description: "", + suggestions: ["curl", "node"], }, - isRequired: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", + 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: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, @@ -13783,77 +14130,52 @@ const completionSpec: Fig.Spec = { }, }, { - name: ["-D", "--dry-data"], - description: "Skip redundant attributes", - }, - { - name: ["-F", "--format"], - description: "Export file format", + name: ["-p", "--page"], + description: "Page number", args: { description: "", - suggestions: ["csv", "json"], - default: "json", }, }, { - name: ["-C", "--csv"], - description: "Export data in csv format", - }, - { - name: ["-x", "--save"], - description: "Save command output to file", + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: { description: "", }, }, { - name: ["-X", "--save-path"], - description: "Save command output to file and create missing path directories", + name: ["-s", "--sort"], + description: "Defines results ordering", args: { description: "", }, }, { - name: ["-N", "--notify"], - description: "Force system notification when export has finished", + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", hidden: true, }, + ], + args: [ { - name: ["-b", "--blind"], - description: "Execute in blind mode without showing the progress monitor", - }, - { - name: ["-P", "--prettify"], - description: "Prettify json output format", - }, - { - name: ["-O", "--open"], - description: "Open automatically the file after a successful export", + name: "resource", + description: "The resource type", }, { - name: ["-q", "--quiet"], - description: "Execute command without showing warning messages", + name: "path", + description: "Path (or url) of the resource(s) to fetch", }, { - name: ["-k", "--keep"], - description: "Keep original export files in temp dir", + name: "id", + description: "Resource id", + isOptional: true, }, ], - hidden: false, }, { - name: ["exports:create", "exp:create"], - description: "Create a new export", + name: ["provisioning:get", "prov:get", "pg", "pget"], + description: "Retrieve a resource or list a set of resources", options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, { name: ["-d", "--domain"], args: { @@ -13869,41 +14191,6 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, - { - name: ["-t", "--type"], - description: "The type of resource being exported", - args: { - description: "Addresses|bundles|coupons|customer_subscriptions|etc", - suggestions: [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds", - ], - }, - isRequired: true, - }, { name: ["-i", "--include"], description: "Comma separated resources to include", @@ -13912,143 +14199,114 @@ const completionSpec: Fig.Spec = { }, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, }, { - name: ["-D", "--dry-data"], - description: "Skip redundant attributes", + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: ["-F", "--format"], - description: "Export file format", - args: { - description: "", - suggestions: ["csv", "json"], - default: "json", - }, + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: ["-C", "--csv"], - description: "Export data in csv format", + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, { - name: ["-x", "--save"], - description: "Save command output to file", - args: { - description: "", - }, + name: "--doc", + description: "Show the cli command in a specific language", }, { - name: ["-X", "--save-path"], - description: "Save command output to file and create missing path directories", + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", args: { description: "", + suggestions: ["curl", "node"], }, }, { - name: ["-N", "--notify"], - description: "Force system notification when export has finished", - hidden: true, + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - name: ["-b", "--blind"], - description: "Execute in blind mode without showing the progress monitor", + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, }, { - name: ["-P", "--prettify"], - description: "Prettify json output format", + name: ["-H", "--headers"], + description: "Show response headers", }, { - name: ["-O", "--open"], - description: "Open automatically the file after a successful export", + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, - ], - }, - { - name: ["exports:details", "exp:details"], - description: "Show the details of an existing export", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-p", "--page"], + description: "Page number", args: { description: "", }, - isRequired: true, - hidden: true, }, - ], - args: { - name: "id", - description: "Unique id of the export", - }, - }, - { - name: ["exports:group", "exp:group"], - description: "List all the exports related to an export group", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-s", "--sort"], + description: "Defines results ordering", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", hidden: true, }, ], - args: { - name: "group_id", - description: "Unique id of the group export", - }, - }, - { - name: ["exports:list", "exp:list"], - description: "List all the created exports", - options: [ + args: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: "resource", + description: "The resource type", }, + { + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, + }, + ], + }, + { + name: ["provisioning:list", "pl", "prov:list", "plist", "pls"], + description: "Fetch a collection of resources", + options: [ { name: ["-d", "--domain"], args: { @@ -14065,154 +14323,125 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-A", "--all"], - description: "Show all exports instead of first 25 only", - }, - { - name: ["-t", "--type"], - description: "The type of resource exported", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", - suggestions: [ - "addresses", - "bundles", - "coupons", - "customer_subscriptions", - "customers", - "gift_cards", - "line_items", - "orders", - "payment_methods", - "price_tiers", - "prices", - "shipments", - "shipping_categories", - "shipping_methods", - "sku_lists", - "sku_list_items", - "sku_options", - "skus", - "stock_items", - "tax_categories", - "transactions", - "authorizations", - "captures", - "voids", - "refunds", - ], }, }, { - name: ["-s", "--status"], - description: "The export job status", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", - suggestions: ["in_progress", "pending", "completed", "interrupted"], }, }, { - name: ["-l", "--limit"], - description: "Limit number of exports in output", - args: { - description: "", - }, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, - ], - }, - { - name: ["exports:types", "exp:types"], - description: "Show online documentation for supported resources", - options: [ { - name: ["-O", "--open"], - description: "Open online documentation page", + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, - ], - }, - { - 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", + 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: { description: "", + suggestions: ["curl", "node"], }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + 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: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-p", "--page"], + description: "Page number", args: { description: "", }, - 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", + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: { description: "", - suggestions: [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items", - ], }, }, { - name: ["-s", "--status"], - description: "The cleanup job status", + name: ["-s", "--sort"], + description: "Defines results ordering", args: { description: "", - suggestions: ["in_progress", "pending", "completed", "interrupted"], }, }, { - name: ["-l", "--limit"], - description: "Limit number of cleanups in output", + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, }, + { + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, + }, ], args: { - name: "id", - description: "Unique id of the cleanup to be retrieved", - isOptional: true, + name: "resource", + description: "The resource type", + suggestions: [ + "api_credentials", + "application_memberships", + "memberships", + "organizations", + "permissions", + "plans", + "roles", + "subscriptions", + "versions", + ], }, }, { - name: ["cleanups:create", "clp:create", "cleanup"], - description: "Create a new cleanup", + name: ["provisioning:rel", "prov:rel", "prov:relationship"], + description: "Fetch a resource relationship", options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, { name: ["-d", "--domain"], args: { @@ -14229,252 +14458,246 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-t", "--type"], - description: "The type of resource to clean up", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { - description: "Bundles|gift_cards|prices|promotions|etc", - suggestions: [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items", - ], + description: "", }, - isRequired: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, }, { - name: ["-N", "--notify"], - description: "Force system notification when cleanup has finished", - hidden: true, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: ["-b", "--blind"], - description: "Execute in blind mode without showing the progress monitor", + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: ["-q", "--quiet"], - description: "Execute command without showing warning messages", + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, - ], - }, - { - name: ["cleanups:details", "clp:details"], - description: "Show the details of an existing cleanup", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: "--doc", + description: "Show the cli command in a specific language", }, { - name: ["-d", "--domain"], + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", args: { description: "", + suggestions: ["curl", "node"], }, - hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: "--curl", + description: "Show the equivalent curl command of the cli command", + hidden: false, }, { - name: ["-l", "--logs"], - description: "Show error logs related to the cleanup process", + name: "--node", + description: + "Show the equivalent node sdk source code of the cli command", + hidden: false, }, - ], - 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: { - description: "", - }, - isRequired: true, - hidden: true, + name: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", }, { - name: ["-d", "--domain"], + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-p", "--page"], + description: "Page number", args: { description: "", }, - 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", + name: ["-n", "--pageSize"], + description: "Number of elements per page", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-s", "--sort"], + description: "Defines results ordering", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-A", "--all"], - description: "Show all cleanups instead of first 25 only", + name: ["-I", "--force-include"], + description: "Force resources inclusion beyound the 3rd level", + hidden: true, }, + ], + args: [ { - name: ["-t", "--type"], - description: "The type of resource cleaned", - args: { - description: "", - suggestions: [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items", - ], - }, + name: "resource", + description: "The resource type", }, { - name: ["-s", "--status"], - description: "The cleanup job status", - args: { - description: "", - suggestions: ["in_progress", "pending", "completed", "interrupted"], - }, + name: "id", + description: "Id of the resource to retrieve", }, { - name: ["-l", "--limit"], - description: "Limit number of cleanups in output", - args: { - description: "", - }, + name: "relationship", + description: "Name of the relationship field", }, ], + hidden: false, }, { - name: ["cleanups:types", "clp:types"], - description: "Show online documentation for supported resources", + name: ["provisioning:resources", "prov:resources", "pres"], + description: "List all the available provisioning api resources", options: [ { - name: ["-O", "--open"], - description: "Open online documentation page", + name: ["-h", "--help"], + description: "Show cli help", }, ], }, { - name: "tags", - description: "List all the created tags or show details of a single tag", + name: ["provisioning:retrieve", "prov:retrieve", "pr", "pretrieve"], + description: "Fetch a single resource", options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-d", "--domain"], args: { description: "", }, - isRequired: true, hidden: true, }, { - name: ["-d", "--domain"], + name: "--accessToken", args: { description: "", }, + isRequired: true, hidden: true, }, { - name: "--accessToken", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-A", "--all"], - description: "Show all tags instead of first 25 only", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + args: { + description: "", + }, }, { - name: ["-l", "--limit"], - description: "Limit number of tags in output", + 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: { description: "", + suggestions: ["curl", "node"], }, }, - ], - args: { - name: "id", - description: "Unique id of the tag to be retrieved", - isOptional: true, - }, - }, - { - name: ["tags:add", "tag"], - description: "Add one or more tags to a set of resources", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + 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: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-e", "--extract"], + description: "Extract subfields from object attributes", args: { description: "", }, - isRequired: true, - hidden: true, }, + ], + args: [ + { + name: "resource", + description: "The resource type", + suggestions: [ + "api_credential", + "application_membership", + "billing_profile", + "membership", + "organization", + "permission", + "plan", + "role", + "subscription", + "user", + "version", + ], + }, + { + name: "id", + description: "Id of the resource to retrieve", + isOptional: true, + }, + ], + }, + { + name: ["provisioning:update", "prov:update", "pu", "pupdate", "pupd"], + description: "Update an existing resource", + options: [ { name: ["-d", "--domain"], args: { @@ -14491,128 +14714,132 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-n", "--name"], - description: "The tag name", + name: ["-i", "--include"], + description: "Comma separated resources to include", args: { description: "", }, - isRequired: true, }, { - name: ["-t", "--type"], - description: "The type of the resource to tag", + name: ["-f", "--fields"], + description: + "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", args: { description: "", }, - isRequired: true, }, { - name: ["-i", "--id"], - description: "The ids of the resources to tag", - args: { - description: "", - }, - isRequired: true, + name: ["-j", "--json"], + description: "Convert output in standard json format", }, { - name: ["-C", "--create"], - description: "Create tags if don't exist", - args: { - description: "", - }, + name: ["-u", "--unformatted"], + description: "Print unformatted json output", }, { - name: ["-v", "--verbose"], - description: "Show details of the tag process", + name: ["-R", "--raw"], + description: "Print out the raw api response", + hidden: false, }, - ], - }, - { - name: "tags:count", - description: "Count resources tagged with a specific tag", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: "--doc", + description: "Show the cli command in a specific language", }, { - name: ["-d", "--domain"], + name: ["-l", "--lang"], + description: "Show the cli command in the specified language syntax", args: { description: "", + suggestions: ["curl", "node"], }, - hidden: true, }, { - name: "--accessToken", + 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: ["-H", "--headers"], + description: "Show response headers", + }, + { + name: ["-Y", "--headers-only"], + description: "Show only response headers", + }, + { + name: ["-a", "--attribute"], + description: "Define a resource attribute", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-t", "--type"], - description: "The type of the tagged resources", + name: ["-O", "--object"], + description: "Define a resource object attribute", args: { description: "", }, }, { - name: ["-z", "--zero"], - description: "Show also resources without tags", - }, - ], - args: { - name: "id_name", - description: "Unique id or name of the tag", - }, - }, - { - name: "tags:create", - description: "Create one or more new tags", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-m", "--metadata"], + description: "", args: { description: "", }, - hidden: true, }, { - name: "--accessToken", + name: ["-M", "--metadata-replace"], + description: "", args: { description: "", }, - isRequired: true, - hidden: true, }, { - name: ["-n", "--name"], - description: "The tag name", + name: ["-D", "--data"], + description: "The data file to use as request body", args: { description: "", }, - isRequired: true, + }, + ], + args: [ + { + name: "resource", + description: "The resource type", + suggestions: [ + "api_credential", + "application_membership", + "membership", + "organization", + "permission", + "role", + "user", + ], + }, + { + name: "id", + description: "Id of the resource to update", + isOptional: true, }, ], }, { - name: "tags:delete", - description: "Delete one or more existing tags", + name: "cleanups", + description: + "List all the created cleanups or show details of a single cleanup", options: [ { name: ["-o", "--organization"], @@ -14639,52 +14866,51 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-n", "--name"], - description: "The tag name", - args: { - description: "", - }, - isRequired: true, + name: ["-A", "--all"], + description: "Show all cleanups instead of first 25 only", }, - ], - }, - { - name: "tags:details", - description: "Show the details of an existing tag", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-t", "--type"], + description: "The type of resource cleaned", args: { description: "", + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-s", "--status"], + description: "The cleanup job status", args: { description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], }, - hidden: true, }, { - name: "--accessToken", + name: ["-l", "--limit"], + description: "Limit number of cleanups in output", args: { description: "", }, - isRequired: true, - hidden: true, }, ], args: { - name: "id_name", - description: "Unique id or name of the tag", + name: "id", + description: "Unique id of the cleanup to be retrieved", + isOptional: true, }, }, { - name: "tags:list", - description: "List all the created tags", + name: ["cleanups:create", "clp:create", "cleanup"], + description: "Create a new cleanup", options: [ { name: ["-o", "--organization"], @@ -14711,21 +14937,49 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-A", "--all"], - description: "Show all tags instead of first 25 only", + 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: ["-l", "--limit"], - description: "Limit number of tags in output", + name: ["-w", "--where"], + description: "Comma separated list of query filters", args: { description: "", }, }, + { + 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: "tags:remove", - description: "Remove one or more tags to a set of resources", + name: ["cleanups:details", "clp:details"], + description: "Show the details of an existing cleanup", options: [ { name: ["-o", "--organization"], @@ -14752,48 +15006,18 @@ const completionSpec: Fig.Spec = { hidden: true, }, { - name: ["-n", "--name"], - description: "The tag name", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-t", "--type"], - description: "The type of the resource to tag", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-i", "--id"], - description: "The ids of th eresources to tag", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-v", "--verbose"], - description: "Show details of the tag process", - }, - ], - }, - { - name: "tags:types", - description: "Show online documentation for supported resources", - options: [ - { - name: ["-O", "--open"], - description: "Open online documentation page", + name: ["-l", "--logs"], + description: "Show error logs related to the cleanup process", }, ], + args: { + name: "id", + description: "Unique id of the cleanup", + }, }, { - name: "tags:update", - description: "Update an existing tag", + name: ["cleanups:group", "clp:group"], + description: "List all the cleanups related to a cleanup group", options: [ { name: ["-o", "--organization"], @@ -14819,23 +15043,15 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, - { - name: ["-n", "--name"], - description: "The new tag name", - args: { - description: "", - }, - isRequired: true, - }, ], args: { - name: "id_name", - description: "Unique id or name of the tag", + name: "group_id", + description: "Unique id of the group cleanup", }, }, { - name: "tags:which", - description: "Show all the resources with this tag", + name: ["cleanups:list", "clp:list"], + description: "List all the created cleanups", options: [ { name: ["-o", "--organization"], @@ -14861,30 +15077,53 @@ const completionSpec: Fig.Spec = { isRequired: true, hidden: true, }, + { + name: ["-A", "--all"], + description: "Show all cleanups instead of first 25 only", + }, { name: ["-t", "--type"], - description: "The type of the tagged resources", + description: "The type of resource cleaned", args: { description: "", + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], }, - isRequired: true, }, { - name: ["-A", "--all"], - description: "Show all resources instead of first 25 only", + name: ["-s", "--status"], + description: "The cleanup job status", + args: { + description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], + }, }, { name: ["-l", "--limit"], - description: "Limit number of resources in output", + description: "Limit number of cleanups in output", args: { description: "", }, }, ], - args: { - name: "id_name", - description: "Unique id or name of the tag", - }, + }, + { + name: ["cleanups:types", "clp:types"], + description: "Show online documentation for supported resources", + options: [ + { + name: ["-O", "--open"], + description: "Open online documentation page", + }, + ], }, { name: "help", @@ -14955,7 +15194,8 @@ const completionSpec: Fig.Spec = { }, { name: ["plugins:install", "plugins:add"], - description: "Uses bundled npm executable to install plugins into <%= config", + description: + "Uses bundled npm executable to install plugins into <%= config", options: [ { name: "--json", @@ -14963,7 +15203,8 @@ const completionSpec: Fig.Spec = { }, { name: ["-f", "--force"], - description: "Force npm to fetch remote resources even if a local copy exists on disk", + description: + "Force npm to fetch remote resources even if a local copy exists on disk", }, { name: ["-h", "--help"], From 93a242b1395a3fae3693857e3bb4fac5707e6706 Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Thu, 18 Apr 2024 11:53:19 +0200 Subject: [PATCH 6/8] fix: fix empty descriptions --- src/commercelayer.ts | 6848 +++++++++++++++--------------------------- 1 file changed, 2406 insertions(+), 4442 deletions(-) diff --git a/src/commercelayer.ts b/src/commercelayer.ts index 7621cf3fb68e..5839e3a3bc6d 100644 --- a/src/commercelayer.ts +++ b/src/commercelayer.ts @@ -19,23 +19,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "Organization slug", - args: { - description: "", - }, + args: {}, }, { name: ["-d", "--domain"], description: "Api domain", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-k", "--kind"], description: "Application kind", args: { - description: "", suggestions: ["integration", "sales_channel", "user"], }, }, @@ -43,7 +38,6 @@ const completionSpec: Fig.Spec = { name: ["-m", "--mode"], description: "Execution mode", args: { - description: "", suggestions: ["test", "live"], }, }, @@ -54,30 +48,23 @@ const completionSpec: Fig.Spec = { { name: "--id", description: "Application id", - args: { - description: "", - }, + args: {}, }, { name: ["-a", "--alias"], description: "The alias associated to the application", - args: { - description: "", - }, + args: {}, }, { name: "--appkey", description: "Cli application key", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-A", "--api"], description: "Specific api application", args: { - description: "", suggestions: ["core", "provisioning"], }, }, @@ -99,60 +86,44 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "Organization slug", - args: { - description: "", - }, + args: {}, }, { name: ["-d", "--domain"], description: "Api domain", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-i", "--clientId"], description: "Application client_id", - args: { - description: "", - }, + args: {}, isRequired: true, }, { name: ["-s", "--clientSecret"], description: "Application client_secret", - args: { - description: "", - }, + args: {}, }, { name: ["-S", "--scope"], description: "Access token scope (market, stock location)", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--email"], description: "Customer email", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--password"], description: "Customer secret password", - args: { - description: "", - }, + args: {}, }, { name: ["-a", "--alias"], description: "The alias you want to associate to the application", - args: { - description: "", - }, + args: {}, isRequired: true, }, { @@ -183,23 +154,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "Organization slug", - args: { - description: "", - }, + args: {}, }, { name: ["-d", "--domain"], description: "Api domain", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-k", "--kind"], description: "Application kind", args: { - description: "", suggestions: ["integration", "sales_channel", "user"], }, }, @@ -207,7 +173,6 @@ const completionSpec: Fig.Spec = { name: ["-m", "--mode"], description: "Execution mode", args: { - description: "", suggestions: ["test", "live"], }, }, @@ -218,30 +183,23 @@ const completionSpec: Fig.Spec = { { name: "--id", description: "Application id", - args: { - description: "", - }, + args: {}, }, { name: ["-a", "--alias"], description: "The alias associated to the application", - args: { - description: "", - }, + args: {}, }, { name: "--appkey", description: "Cli application key", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-A", "--api"], description: "Specific api application", args: { - description: "", suggestions: ["core", "provisioning"], }, }, @@ -258,60 +216,44 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "Organization slug", - args: { - description: "", - }, + args: {}, }, { name: ["-d", "--domain"], description: "Api domain", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-i", "--clientId"], description: "Application client_id", - args: { - description: "", - }, + args: {}, isRequired: true, }, { name: ["-s", "--clientSecret"], description: "Application client_secret", - args: { - description: "", - }, + args: {}, }, { name: ["-S", "--scope"], description: "Access token scope (market, stock location)", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--email"], description: "Customer email", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--password"], description: "Customer secret password", - args: { - description: "", - }, + args: {}, }, { name: ["-a", "--alias"], description: "The alias you want to associate to the application", - args: { - description: "", - }, + args: {}, isRequired: true, }, { @@ -334,23 +276,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "Organization slug", - args: { - description: "", - }, + args: {}, }, { name: ["-d", "--domain"], description: "Api domain", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-k", "--kind"], description: "Application kind", args: { - description: "", suggestions: ["integration", "sales_channel", "user"], }, }, @@ -358,7 +295,6 @@ const completionSpec: Fig.Spec = { name: ["-m", "--mode"], description: "Execution mode", args: { - description: "", suggestions: ["test", "live"], }, }, @@ -369,30 +305,23 @@ const completionSpec: Fig.Spec = { { name: "--id", description: "Application id", - args: { - description: "", - }, + args: {}, }, { name: ["-a", "--alias"], description: "The alias associated to the application", - args: { - description: "", - }, + args: {}, }, { name: "--appkey", description: "Cli application key", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-A", "--api"], description: "Specific api application", args: { - description: "", suggestions: ["core", "provisioning"], }, }, @@ -420,23 +349,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "Organization slug", - args: { - description: "", - }, + args: {}, }, { name: ["-d", "--domain"], description: "Api domain", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-k", "--kind"], description: "Application kind", args: { - description: "", suggestions: ["integration", "sales_channel", "user"], }, }, @@ -444,7 +368,6 @@ const completionSpec: Fig.Spec = { name: ["-m", "--mode"], description: "Execution mode", args: { - description: "", suggestions: ["test", "live"], }, }, @@ -455,30 +378,23 @@ const completionSpec: Fig.Spec = { { name: "--id", description: "Application id", - args: { - description: "", - }, + args: {}, }, { name: ["-a", "--alias"], description: "The alias associated to the application", - args: { - description: "", - }, + args: {}, }, { name: "--appkey", description: "Cli application key", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-A", "--api"], description: "Specific api application", args: { - description: "", suggestions: ["core", "provisioning"], }, }, @@ -500,9 +416,7 @@ const completionSpec: Fig.Spec = { { name: ["-a", "--alias"], description: "The alias you want to associate to the application", - args: { - description: "", - }, + args: {}, }, ], args: { @@ -517,23 +431,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "Organization slug", - args: { - description: "", - }, + args: {}, }, { name: ["-d", "--domain"], description: "Api domain", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-k", "--kind"], description: "Application kind", args: { - description: "", suggestions: ["integration", "sales_channel", "user"], }, }, @@ -541,7 +450,6 @@ const completionSpec: Fig.Spec = { name: ["-m", "--mode"], description: "Execution mode", args: { - description: "", suggestions: ["test", "live"], }, }, @@ -552,30 +460,23 @@ const completionSpec: Fig.Spec = { { name: "--id", description: "Application id", - args: { - description: "", - }, + args: {}, }, { name: ["-a", "--alias"], description: "The alias associated to the application", - args: { - description: "", - }, + args: {}, }, { name: "--appkey", description: "Cli application key", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-A", "--api"], description: "Specific api application", args: { - description: "", suggestions: ["core", "provisioning"], }, }, @@ -588,23 +489,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "Organization slug", - args: { - description: "", - }, + args: {}, }, { name: ["-d", "--domain"], description: "Api domain", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-k", "--kind"], description: "Application kind", args: { - description: "", suggestions: ["integration", "sales_channel", "user"], }, }, @@ -612,7 +508,6 @@ const completionSpec: Fig.Spec = { name: ["-m", "--mode"], description: "Execution mode", args: { - description: "", suggestions: ["test", "live"], }, }, @@ -623,30 +518,23 @@ const completionSpec: Fig.Spec = { { name: "--id", description: "Application id", - args: { - description: "", - }, + args: {}, }, { name: ["-a", "--alias"], description: "The alias associated to the application", - args: { - description: "", - }, + args: {}, }, { name: "--appkey", description: "Cli application key", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-A", "--api"], description: "Specific api application", args: { - description: "", suggestions: ["core", "provisioning"], }, }, @@ -661,17 +549,13 @@ const completionSpec: Fig.Spec = { { name: ["-S", "--shared"], description: "Organization shared secret", - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-M", "--minutes"], description: "Minutes to token expiration [2, 240]", - args: { - description: "", - }, + args: {}, hidden: true, }, ], @@ -684,9 +568,7 @@ const completionSpec: Fig.Spec = { { name: ["-v", "--version"], description: "Update cli to a specific version or tag", - args: { - description: "", - }, + args: {}, }, ], }, @@ -733,26 +615,20 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-a", "--accessToken"], description: "Custom access token to use instead of the one used for login", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: false, }, @@ -768,44 +644,32 @@ const completionSpec: Fig.Spec = { { name: ["-O", "--order"], description: "An order id", - args: { - description: "", - }, + args: {}, }, { name: ["-S", "--sku"], description: "An sku code", - args: { - description: "", - }, + args: {}, }, { name: ["-B", "--bundle"], description: "A bundle code", - args: { - description: "", - }, + args: {}, }, { name: ["-m", "--market"], description: "A market number", - args: { - description: "", - }, + args: {}, }, { name: ["-c", "--coupon"], description: "A promo code", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--email"], description: "A customer email", - args: { - description: "", - }, + args: {}, }, ], }, @@ -816,26 +680,20 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-a", "--accessToken"], description: "Custom access token to use instead of the one used for login", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: false, }, @@ -862,24 +720,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -891,7 +743,6 @@ const completionSpec: Fig.Spec = { name: ["-t", "--type"], description: "The type of resource imported", args: { - description: "", suggestions: [ "addresses", "bundles", @@ -921,15 +772,12 @@ const completionSpec: Fig.Spec = { name: ["-g", "--group"], description: "The group id associated to the import in case of multi-chunk imports", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--status"], description: "The import job status", args: { - description: "", suggestions: ["in_progress", "pending", "completed", "interrupted"], }, }, @@ -944,9 +792,7 @@ const completionSpec: Fig.Spec = { { name: ["-l", "--limit"], description: "Limit number of imports in output", - args: { - description: "", - }, + args: {}, }, ], args: { @@ -962,24 +808,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -1018,16 +858,12 @@ const completionSpec: Fig.Spec = { name: ["-p", "--parent"], description: "The id of the parent resource to be associated with imported data", - args: { - description: "", - }, + args: {}, }, { name: ["-i", "--inputs"], description: "The path of the file containing the data to import", - args: { - description: "", - }, + args: {}, isRequired: true, }, { @@ -1039,7 +875,6 @@ const completionSpec: Fig.Spec = { description: "The delimiter character used in the csv input file (one of ',', ';', '|', tab)", args: { - description: "", suggestions: [",", ";", "|", "TAB"], }, }, @@ -1061,24 +896,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -1095,24 +924,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -1128,9 +951,7 @@ const completionSpec: Fig.Spec = { { name: ["-S", "--save-inputs"], description: "Save import inputs to local file", - args: { - description: "", - }, + args: {}, }, ], args: { @@ -1145,24 +966,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -1179,24 +994,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -1208,7 +1017,6 @@ const completionSpec: Fig.Spec = { name: ["-t", "--type"], description: "The type of resource imported", args: { - description: "", suggestions: [ "addresses", "bundles", @@ -1238,15 +1046,12 @@ const completionSpec: Fig.Spec = { name: ["-g", "--group"], description: "The group id associated to the import in case of multi-chunk imports", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--status"], description: "The import job status", args: { - description: "", suggestions: ["in_progress", "pending", "completed", "interrupted"], }, }, @@ -1261,9 +1066,7 @@ const completionSpec: Fig.Spec = { { name: ["-l", "--limit"], description: "Limit number of imports in output", - args: { - description: "", - }, + args: {}, }, ], }, @@ -1284,24 +1087,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: ["-a", "--accessToken"], - args: { - description: "", - }, + args: {}, isRequired: true, hidden: false, }, @@ -1312,9 +1109,7 @@ const completionSpec: Fig.Spec = { { name: ["-S", "--skuListId"], description: "The sku list id", - args: { - description: "", - }, + args: {}, isRequired: true, }, { @@ -1332,322 +1127,313 @@ const completionSpec: Fig.Spec = { ], }, { - 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", + name: "seeder:check", + description: "Execute a check on seeder data", options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", args: { - description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-u", "--url"], + description: "Seeder data url", args: { - description: "", + default: "https://data.commercelayer.app/seeder", }, - hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: {}, + }, + { + name: "--debug", + description: "Show command debug information", hidden: true, }, { - name: ["-i", "--include"], - description: "Comma separated resources to include", - args: { - description: "", - }, + name: ["-r", "--relationships"], + description: "Check resource relationships", }, + ], + }, + { + name: "seeder:clean", + description: "Clean previously imported seeder data", + options: [ { - name: ["-f", "--fields"], - description: - "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", args: { - description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", }, }, { - name: ["-j", "--json"], - description: "Convert output in standard json format", + name: ["-u", "--url"], + description: "Seeder data url", + args: { + default: "https://data.commercelayer.app/seeder", + }, }, { - name: ["-u", "--unformatted"], - description: "Print unformatted json output", + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: {}, }, { - name: ["-R", "--raw"], - description: "Print out the raw api response", - hidden: false, + name: "--debug", + description: "Show debug information", + hidden: true, }, { - 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: { - description: "", - 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: ["-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", - args: { - description: "", - }, + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: "--load-args", - description: "Load previously saved command arguments", - args: { - description: "", - }, + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, }, + ], + }, + { + name: ["seeder:seed", "seed"], + description: "Execute commerce layer seeder", + options: [ { - name: ["-w", "--where"], - description: "Comma separated list of query filters", + name: ["-b", "--businessModel"], + description: "The kind of business model you want to import", args: { - description: "", + suggestions: ["single_sku", "multi_market", "custom"], + default: "single_sku", }, }, { - name: ["-s", "--sort"], - description: "Defines results ordering", + name: ["-u", "--url"], + description: "Seeder data url", args: { - description: "", + default: "https://data.commercelayer.app/seeder", }, }, { - name: ["-x", "--save"], - description: "Save command output to file", - args: { - description: "", - }, + name: ["-n", "--name"], + description: "The name of the business model file to use", + args: {}, }, { - name: ["-X", "--save-path"], - description: - "Save command output to file and create missing path directories", - args: { - description: "", - }, + name: "--debug", + description: "Show debug information", + hidden: true, }, { - name: ["-N", "--notify"], - description: "Force system notification when export has finished", + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, hidden: true, }, { - name: "--clientId", - description: "Organization client_id", - args: { - description: "", - }, + name: ["-d", "--domain"], + args: {}, hidden: true, }, { - name: "--clientSecret", - description: "Organization client_secret", - args: { - description: "", - }, + name: "--accessToken", + args: {}, + isRequired: true, hidden: true, }, { - name: ["-C", "--csv"], - description: "Export fields in csv format", + name: ["-k", "--keep"], + description: "Keep existing resources without updating them", }, { - name: ["-D", "--delimiter"], - description: "", - args: { - description: "", - suggestions: [",", ";", "|", "TAB"], - }, + name: ["-D", "--delay"], + description: + "Add a delay in milliseconds between calls to different resources", + 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: ["-H", "--header"], - description: "", - args: { - description: "", - }, + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: ["-b", "--blind"], - description: "Execute in blind mode without prompt and progress bar", + name: ["-p", "--print"], + description: "Print users answers", + hidden: true, }, { - name: ["-e", "--extract"], - description: "Extract subfields from object attributes", - args: { - description: "", - }, + name: ["-i", "--info"], + description: "Print generated token info", }, { - name: ["-T", "--timeout"], - description: "Set request timeout in milliseconds [1000 - 15000]", - args: { - description: "", - }, - hidden: true, + name: ["-c", "--check"], + description: "Check generated access token", }, ], - args: { - name: "resource", - description: "The resource type", - }, }, { - name: ["resources:args", "res:args"], - description: "Show all the saved command arguments", + name: "token:get", + description: "Get a new access token", options: [ { - name: ["-a", "--alias"], - description: "The alias associated to saved command arguments", - args: { - description: "", - }, + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, }, { - name: ["-r", "--resource"], - description: "The resource type", - args: { - description: "", - }, + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: ["-o", "--operation"], - description: "The resource operation", - args: { - description: "", - suggestions: ["list", "retrieve", "create", "update"], - }, + name: ["-i", "--clientId"], + description: "Application client_id", + args: {}, + isRequired: true, }, { - name: ["-D", "--delete"], - description: "Delete saved arguments associated to the alias", + name: ["-s", "--clientSecret"], + description: "Application client_secret", + args: {}, }, { - name: ["-P", "--pretty"], - description: "Show saved arguments in table format", - hidden: true, + 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: ["resources:count", "count", "res:count", "rs:count"], - description: "Count the number of existent resources", + name: "token:revoke", + description: "Revoke a commerce layer access token", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, + args: {}, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, + name: ["-i", "--clientId"], + description: "Application client_id", + args: {}, isRequired: true, - hidden: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", - args: { - description: "", - }, + 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: "resource", - description: "The resource type", + name: "token", + description: "Access token to revoke", }, }, { - name: ["resources:create", "create", "rc", "res:create", "post"], - description: "Create a new resource", + 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"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -1670,7 +1456,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -1688,67 +1473,269 @@ const completionSpec: Fig.Spec = { { name: "--save-args", description: "Save command data to file for future use", - args: { - description: "", - }, + args: {}, }, { name: "--load-args", description: "Load previously saved command arguments", - args: { - description: "", - }, + args: {}, }, { - name: ["-H", "--headers"], - description: "Show response headers", + name: ["-w", "--where"], + description: "Comma separated list of query filters", + args: {}, }, { - name: ["-Y", "--headers-only"], - description: "Show only response headers", - }, + name: ["-s", "--sort"], + description: "Defines results ordering", + args: {}, + }, { - name: ["-a", "--attribute"], - description: "Define a resource attribute", + 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: ["-N", "--notify"], + description: "Force system notification when export has finished", + hidden: true, + }, + { + name: "--clientId", + description: "Organization client_id", + args: {}, + hidden: true, + }, + { + name: "--clientSecret", + description: "Organization client_secret", + args: {}, + hidden: true, + }, + { + name: ["-C", "--csv"], + description: "Export fields in csv format", + }, + { + name: ["-D", "--delimiter"], + description: "", args: { - description: "", + suggestions: [",", ";", "|", "TAB"], }, }, { - name: ["-O", "--object"], - description: "Define a resource object attribute", + name: ["-H", "--header"], + description: "", + args: {}, + }, + { + name: ["-b", "--blind"], + description: "Execute in blind mode without prompt and progress bar", + }, + { + 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: {}, + }, + { + name: ["-r", "--resource"], + description: "The resource type", + args: {}, + }, + { + name: ["-o", "--operation"], + description: "The resource operation", args: { - description: "", + suggestions: ["list", "retrieve", "create", "update"], }, }, { - name: ["-r", "--relationship"], - description: "Define a relationship with another resource", + name: ["-D", "--delete"], + description: "Delete saved arguments associated to the alias", + }, + { + name: ["-P", "--pretty"], + description: "Show saved arguments in table format", + hidden: true, + }, + ], + }, + { + name: ["resources:count", "count", "res:count", "rs:count"], + description: "Count the number of existent resources", + 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: ["-w", "--where"], + description: "Comma separated list of query filters", + args: {}, + }, + ], + args: { + name: "resource", + description: "The resource type", + }, + }, + { + name: ["resources:create", "create", "rc", "res:create", "post"], + description: "Create a new 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: { - description: "", + 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: ["-a", "--attribute"], + description: "Define a resource attribute", + args: {}, + }, + { + name: ["-O", "--object"], + description: "Define a resource object attribute", + args: {}, + }, + { + name: ["-r", "--relationship"], + description: "Define a relationship with another resource", + args: {}, + }, { name: ["-m", "--metadata"], description: "Define a metadata attribute or a set of metadata attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-D", "--data"], description: "The data file to use as request body", - args: { - description: "", - }, + args: {}, }, { name: ["-t", "--tags"], description: "List of tags associated with the resource", - args: { - description: "", - }, + args: {}, }, ], args: { @@ -1866,41 +1853,31 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -1923,7 +1900,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -1941,16 +1917,12 @@ const completionSpec: Fig.Spec = { { name: "--save-args", description: "Save command data to file for future use", - args: { - description: "", - }, + args: {}, }, { name: "--load-args", description: "Load previously saved command arguments", - args: { - description: "", - }, + args: {}, }, { name: ["-H", "--headers"], @@ -2085,7 +2057,6 @@ const completionSpec: Fig.Spec = { name: ["-p", "--page"], description: "The doc page you want to access", args: { - description: "", suggestions: [ "object", "create", @@ -2110,41 +2081,31 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -2167,7 +2128,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -2185,16 +2145,12 @@ const completionSpec: Fig.Spec = { { name: "--save-args", description: "Save command data to file for future use", - args: { - description: "", - }, + args: {}, }, { name: "--load-args", description: "Load previously saved command arguments", - args: { - description: "", - }, + args: {}, }, { name: ["-H", "--headers"], @@ -2207,52 +2163,38 @@ const completionSpec: Fig.Spec = { { name: ["-x", "--save"], description: "Save command output to file", - args: { - description: "", - }, + args: {}, }, { name: ["-X", "--save-path"], description: "Save command output to file and create missing path directories", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--page"], description: "Page number", - args: { - description: "", - }, + args: {}, }, { name: ["-n", "--pageSize"], description: "Number of elements per page", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--sort"], description: "Defines results ordering", - args: { - description: "", - }, + args: {}, }, { name: ["-I", "--force-include"], @@ -2283,41 +2225,31 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -2340,7 +2272,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -2358,16 +2289,12 @@ const completionSpec: Fig.Spec = { { name: "--save-args", description: "Save command data to file for future use", - args: { - description: "", - }, + args: {}, }, { name: "--load-args", description: "Load previously saved command arguments", - args: { - description: "", - }, + args: {}, }, { name: ["-H", "--headers"], @@ -2380,52 +2307,38 @@ const completionSpec: Fig.Spec = { { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--page"], description: "Page number", - args: { - description: "", - }, + args: {}, }, { name: ["-n", "--pageSize"], description: "Number of elements per page", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--sort"], description: "Defines results ordering", - args: { - description: "", - }, + args: {}, }, { name: ["-x", "--save"], description: "Save command output to file", - args: { - description: "", - }, + args: {}, }, { name: ["-X", "--save-path"], description: "Save command output to file and create missing path directories", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-I", "--force-include"], @@ -2452,41 +2365,31 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -2509,7 +2412,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -2527,16 +2429,12 @@ const completionSpec: Fig.Spec = { { name: "--save-args", description: "Save command data to file for future use", - args: { - description: "", - }, + args: {}, }, { name: "--load-args", description: "Load previously saved command arguments", - args: { - description: "", - }, + args: {}, }, { name: ["-H", "--headers"], @@ -2549,52 +2447,38 @@ const completionSpec: Fig.Spec = { { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--page"], description: "Page number", - args: { - description: "", - }, + args: {}, }, { name: ["-n", "--pageSize"], description: "Number of elements per page", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--sort"], description: "Defines results ordering", - args: { - description: "", - }, + args: {}, }, { name: ["-x", "--save"], description: "Save command output to file", - args: { - description: "", - }, + args: {}, }, { name: ["-X", "--save-path"], description: "Save command output to file and create missing path directories", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-I", "--force-include"], @@ -2738,41 +2622,31 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -2795,7 +2669,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -2813,16 +2686,12 @@ const completionSpec: Fig.Spec = { { name: "--save-args", description: "Save command data to file for future use", - args: { - description: "", - }, + args: {}, }, { name: "--load-args", description: "Load previously saved command arguments", - args: { - description: "", - }, + args: {}, }, { name: ["-H", "--headers"], @@ -2835,52 +2704,38 @@ const completionSpec: Fig.Spec = { { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--page"], description: "Page number", - args: { - description: "", - }, + args: {}, }, { name: ["-n", "--pageSize"], description: "Number of elements per page", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--sort"], description: "Defines results ordering", - args: { - description: "", - }, + args: {}, }, { name: ["-x", "--save"], description: "Save command output to file", - args: { - description: "", - }, + args: {}, }, { name: ["-X", "--save-path"], description: "Save command output to file and create missing path directories", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-I", "--force-include"], @@ -2911,41 +2766,31 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -2968,7 +2813,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -2986,16 +2830,12 @@ const completionSpec: Fig.Spec = { { name: "--save-args", description: "Save command data to file for future use", - args: { - description: "", - }, + args: {}, }, { name: "--load-args", description: "Load previously saved command arguments", - args: { - description: "", - }, + args: {}, }, { name: ["-H", "--headers"], @@ -3008,24 +2848,18 @@ const completionSpec: Fig.Spec = { { name: ["-x", "--save"], description: "Save command output to file", - args: { - description: "", - }, + args: {}, }, { name: ["-X", "--save-path"], description: "Save command output to file and create missing path directories", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, ], args: [ @@ -3178,41 +3012,31 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -3235,7 +3059,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -3253,16 +3076,12 @@ const completionSpec: Fig.Spec = { { name: "--save-args", description: "Save command data to file for future use", - args: { - description: "", - }, + args: {}, }, { name: "--load-args", description: "Load previously saved command arguments", - args: { - description: "", - }, + args: {}, }, { name: ["-H", "--headers"], @@ -3275,51 +3094,37 @@ const completionSpec: Fig.Spec = { { name: ["-a", "--attribute"], description: "Define a resource attribute", - args: { - description: "", - }, + args: {}, }, { name: ["-O", "--object"], description: "Define a resource object attribute", - args: { - description: "", - }, + args: {}, }, { name: ["-r", "--relationship"], description: "Define a relationship with another resource", - args: { - description: "", - }, + args: {}, }, { name: ["-m", "--metadata"], description: "", - args: { - description: "", - }, + args: {}, }, { name: ["-M", "--metadata-replace"], description: "", - args: { - description: "", - }, + args: {}, }, { name: ["-D", "--data"], description: "The data file to use as request body", - args: { - description: "", - }, + args: {}, }, { name: ["-t", "--tags"], description: "List of tags associated with the resource", - args: { - description: "", - }, + args: {}, }, ], args: [ @@ -3437,861 +3242,686 @@ const completionSpec: Fig.Spec = { ], }, { - 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", + name: "orders", + description: "Execute an action on an order", options: [ + { + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, + }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { - name: ["-p", "--print"], - description: "Print users answers", + name: "--accessToken", + args: {}, + isRequired: true, hidden: true, }, { - name: ["-i", "--info"], - description: "Print generated token info", + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-c", "--check"], - description: "Check generated access token", + 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: "token:get", - description: "Get a new access token", + name: "orders:approve", + description: "Send this attribute if you want to approve a placed order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, + isRequired: true, + hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { - name: ["-i", "--clientId"], - description: "Application client_id", - args: { - description: "", - }, + name: "--accessToken", + args: {}, isRequired: true, + hidden: true, }, { - name: ["-s", "--clientSecret"], - description: "Application client_secret", - args: { - description: "", - }, - }, - { - name: ["-S", "--scope"], - description: "Access token scope (market, stock location)", - args: { - description: "", - }, - }, - { - name: ["-e", "--email"], - description: "Customer email", - args: { - description: "", - }, - }, - { - name: ["-p", "--password"], - description: "Customer secret password", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: "--info", - description: "Show access token info", + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-P", "--provisioning"], - description: "Execute login to provisioning api", + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], + args: { + name: "id", + description: "The unique id of the order", + }, }, { - name: "token:revoke", - description: "Revoke a commerce layer access token", + name: "orders:approve_and_capture", + description: + "Send this attribute if you want to approve and capture a placed order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, + isRequired: true, + hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { - name: ["-i", "--clientId"], - description: "Application client_id", - args: { - description: "", - }, + name: "--accessToken", + args: {}, isRequired: true, + hidden: true, }, { - name: ["-s", "--clientSecret"], - description: "Application client_secret", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-S", "--scope"], - description: "Access token scope", - args: { - description: "", - }, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-P", "--provisioning"], - description: "Execute login to provisioning api", + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { - name: "token", - description: "Access token to revoke", + name: "id", + description: "The unique id of the order", }, }, { - 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: { - description: "", - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", - }, - }, - { - name: ["-u", "--url"], - description: "Seeder data url", - args: { - description: "", - default: "https://data.commercelayer.app/seeder", - }, - }, - { - name: ["-n", "--name"], - description: "The name of the business model file to use", - args: { - description: "", - }, - }, - { - name: "--debug", - description: "Show command debug information", - hidden: true, - }, - { - name: ["-r", "--relationships"], - description: "Check resource relationships", - }, - ], - }, - { - name: "seeder:clean", - description: "Clean previously imported seeder data", + name: "orders:archive", + description: "Send this attribute if you want to archive the order", options: [ - { - name: ["-b", "--businessModel"], - description: "The kind of business model you want to import", - args: { - description: "", - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", - }, - }, - { - name: ["-u", "--url"], - description: "Seeder data url", - args: { - description: "", - default: "https://data.commercelayer.app/seeder", - }, - }, - { - name: ["-n", "--name"], - description: "The name of the business model file to use", - args: { - description: "", - }, - }, - { - name: "--debug", - description: "Show debug information", - hidden: true, - }, { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, 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: { - description: "", - suggestions: ["single_sku", "multi_market", "custom"], - default: "single_sku", - }, - }, { - name: ["-u", "--url"], - description: "Seeder data url", - args: { - description: "", - default: "https://data.commercelayer.app/seeder", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-n", "--name"], - description: "The name of the business model file to use", - args: { - description: "", - }, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: "--debug", - description: "Show debug information", - hidden: true, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, + ], + args: { + name: "id", + description: "The unique id of the order", + }, + }, + { + name: "orders:authorization_amount_cents", + description: "The authorization amount, in cents", + options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-k", "--keep"], - description: "Keep existing resources without updating them", + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-D", "--delay"], - description: - "Add a delay in milliseconds between calls to different resources", - args: { - description: "", - }, - hidden: true, + 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: "webhooks", + name: "orders:authorize", description: - "List all the registered webhooks or the details of a single webhook", + "Send this attribute if you want to authorize the order's payment source", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-c", "--circuit"], - description: "Show only webhooks with circuit in the declared state", - args: { - description: "", - suggestions: ["open", "closed"], - }, - }, - { - name: ["-t", "--topic"], - description: "The event that triggered the webhook", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - 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 order", }, }, { - name: ["webhooks:create", "wh:create"], - description: "Create a new webhook", + name: "orders:billing_address_clone_id", + description: + "The id of the address that you want to clone to create the order's billing addre", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-t", "--topic"], - description: - "The identifier of the event that will trigger the webhook", - args: { - description: "", - }, - isRequired: true, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-u", "--url"], - description: "The callback url used to post data", - args: { - description: "", - }, - isRequired: true, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-i", "--include"], - description: - "A comma separated list of related resources to be included", - args: { - description: "", - }, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, { - name: ["-n", "--name"], - description: "The webhook short name", - args: { - description: "", - }, + name: ["-v", "--value"], + description: "The trigger attribute value", + args: {}, + isRequired: true, }, ], + args: { + name: "id", + description: "The unique id of the order", + }, }, { - name: ["webhooks:destroy", "webhooks:delete", "wh:delete", "wh:destroy"], - description: "Destroy an existing webhook", + name: "orders:billing_address_same_as_shipping", + description: + "Send this attribute if you want the billing address to be cloned from the order'", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + 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: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:details", "wh:details"], - description: "Show the details of an existing webhook", + name: "orders:cancel", + description: "Send this attribute if you want to cancel a placed order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-H", "--hide-empty"], - description: "Hide empty attributes", + name: ["-p", "--print"], + description: "Print out the modified order", }, { - 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 order", }, }, { - name: ["webhooks:event", "wh:event"], - description: "Show the details of a firedf webhook event", + name: "orders:capture", + description: + "Send this attribute if you want to capture an authorized order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-p", "--payload"], - description: "Show the event payload sent to the callback endpoint", + name: ["-p", "--print"], + description: "Print out the modified order", }, { - 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 order", }, }, { - name: ["webhooks:events", "wh:events"], - description: "List all the events associated to the webhook", + name: "orders:commit_invoice", + description: + "Send this attribute if you want commit the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-A", "--all"], - description: "Show all events instead of first 25 only", + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-l", "--limit"], - description: "Limit number of events in output", - args: { - description: "", - }, + 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 order", }, }, { - name: ["webhooks:list", "wh:list"], - description: "List all the registered webhooks", + name: "orders:create_subscriptions", + description: + "Send this attribute upon/after placing the order if you want to create order sub", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-c", "--circuit"], - description: "Show only webhooks with circuit in the declared state", - args: { - description: "", - suggestions: ["open", "closed"], - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-t", "--topic"], - description: "The event that triggered the webhook", - args: { - description: "", - }, + 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: ["webhooks:listen", "wh:listen"], - description: "Listen a webhook for outgoing callbacks", + name: "orders:customer_payment_source_id", + description: "The id of the customer payment source (i", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-t", "--time"], - description: "Waiting time for the first event", - args: { - description: "", - default: "120", - }, + 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", + }, + { + name: ["-v", "--value"], + description: "The trigger attribute value", + args: {}, + isRequired: true, }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:payload", "wh:payload"], - description: "Show the payload associated to an event callback", + name: "orders:nullify_payment_source", + description: + "Send this attribute if you want to nullify the payment source for this order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-f", "--format"], - description: "Format the payload output", + 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: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:reset", "wh:reset"], - description: "Reset the circuit breaker associated to the webhook", + name: "orders:pending", + description: + "Send this attribute if you want to move a draft or placing order to pending", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + 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: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: ["webhooks:topics", "wh:topics"], - description: "Show online documentation for supported events", - }, - { - name: ["webhooks:update", "wh:update"], - description: "Update an existing webhook", + name: "orders:place", + description: "Send this attribute if you want to place the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-t", "--topic"], - description: - "The identifier of the event that will trigger the webhook", - args: { - description: "", - }, - }, - { - name: ["-u", "--url"], - description: "The callback url used to post data", - args: { - description: "", - }, + name: ["-p", "--print"], + description: "Print out the modified order", }, { - name: ["-i", "--include"], - description: - "A comma separated list of related resources to be included", - args: { - description: "", - }, + name: ["-j", "--json"], + description: "Print result in json format", }, { - name: ["-n", "--name"], - description: "The webhook short name", - args: { - description: "", - }, + name: ["-u", "--unformatted"], + description: "Print json output without indentation", }, ], args: { name: "id", - description: "Unique id of the webhook", + description: "The unique id of the order", }, }, { - name: "orders", - description: "Execute an action on an order", + name: "orders:refresh", + description: + "Send this attribute if you want to manually refresh the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4314,30 +3944,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:approve", - description: "Send this attribute if you want to approve a placed order", + name: "orders:refund", + description: "Send this attribute if you want to refund a captured order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4360,31 +3984,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:approve_and_capture", + name: "orders:refund_invoice", description: - "Send this attribute if you want to approve and capture a placed order", + "Send this attribute if you want refund the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4407,30 +4025,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:archive", - description: "Send this attribute if you want to archive the order", + name: "orders:reset_circuit", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4453,30 +4066,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:authorization_amount_cents", - description: "The authorization amount, in cents", + name: "orders: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", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4499,31 +4107,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:authorize", + name: "orders:save_payment_source_to_customer_wallet", description: - "Send this attribute if you want to authorize the order's payment source", + "Send this attribute if you want the order's payment source to be saved in the cu", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4546,31 +4148,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:billing_address_clone_id", + name: "orders:save_shipping_address_to_customer_address_book", description: - "The id of the address that you want to clone to create the order's billing addre", + "Send this attribute if you want the order's shipping address to be saved in the", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4586,14 +4182,6 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, - { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: { - description: "", - }, - isRequired: true, - }, ], args: { name: "id", @@ -4601,31 +4189,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:billing_address_same_as_shipping", + name: "orders:shipping_address_clone_id", description: - "Send this attribute if you want the billing address to be cloned from the order'", + "The id of the address that you want to clone to create the order's shipping addr", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4641,6 +4223,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", @@ -4648,30 +4236,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:cancel", - description: "Send this attribute if you want to cancel a placed order", + name: "orders: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"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4694,31 +4277,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:capture", + name: "orders:start_editing", description: - "Send this attribute if you want to capture an authorized order", + "Send this attribute if you want to edit the order after it is placed", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4741,31 +4318,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:commit_invoice", + name: "orders:stop_editing", description: - "Send this attribute if you want commit the sales tax invoice to the associated t", + "Send this attribute to stop the editing for the order and return back to placed", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4788,31 +4359,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:create_subscriptions", - description: - "Send this attribute upon/after placing the order if you want to create order sub", + name: "orders:unarchive", + description: "Send this attribute if you want to unarchive the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4835,30 +4399,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:customer_payment_source_id", - description: "The id of the customer payment source (i", + name: "orders:update_taxes", + description: + "Send this attribute if you want to force tax calculation for this order (a tax c", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4874,14 +4433,6 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, - { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: { - description: "", - }, - isRequired: true, - }, ], args: { name: "id", @@ -4889,31 +4440,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:nullify_payment_source", + name: "orders:validate", description: - "Send this attribute if you want to nullify the payment source for this order", + "Send this attribute if you want to trigger the external validation for the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -4936,513 +4481,452 @@ const completionSpec: Fig.Spec = { }, }, { - name: "orders:pending", + name: "webhooks", description: - "Send this attribute if you want to move a draft or placing order to pending", + "List all the registered webhooks or the details of a single webhook", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-c", "--circuit"], + description: "Show only webhooks with circuit in the declared state", + args: { + suggestions: ["open", "closed"], + }, }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-t", "--topic"], + description: "The event that triggered the webhook", + args: {}, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", + }, + { + name: ["-e", "--events"], + description: + "Show the last event callbacks associated to the webhook", }, ], args: { name: "id", - description: "The unique id of the order", + description: "Unique id of the webhook to get a single webhook", + isOptional: true, }, }, { - name: "orders:place", - description: "Send this attribute if you want to place the order", + name: ["webhooks:create", "wh:create"], + description: "Create a new webhook", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-t", "--topic"], + description: + "The identifier of the event that will trigger the webhook", + args: {}, + isRequired: true, }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-u", "--url"], + description: "The callback url used to post data", + args: {}, + isRequired: true, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + 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: "The unique id of the order", - }, }, { - name: "orders:refresh", - description: - "Send this attribute if you want to manually refresh the order", + name: ["webhooks:destroy", "webhooks:delete", "wh:delete", "wh:destroy"], + description: "Destroy an existing webhook", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + 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", + description: "Unique id of the webhook", }, }, { - name: "orders:refund", - description: "Send this attribute if you want to refund a captured order", + name: ["webhooks:details", "wh:details"], + description: "Show the details of an existing webhook", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", - }, - { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-H", "--hide-empty"], + description: "Hide empty attributes", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-e", "--events"], + description: + "Show the last event callbacks associated to the webhook", }, ], args: { name: "id", - description: "The unique id of the order", + description: "Unique id of the webhook", }, }, { - name: "orders:refund_invoice", - description: - "Send this attribute if you want refund the sales tax invoice to the associated t", + name: ["webhooks:event", "wh:event"], + description: "Show the details of a firedf webhook event", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", - }, - { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-p", "--payload"], + description: "Show the event payload sent to the callback endpoint", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-f", "--format"], + description: "Format the payload output", }, ], args: { name: "id", - description: "The unique id of the order", + description: "Unique id of the webhook", }, }, { - name: "orders:reset_circuit", - description: - "Send this attribute if you want to reset the circuit breaker associated to this", + name: ["webhooks:events", "wh:events"], + description: "List all the events associated to the webhook", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", - }, - { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-A", "--all"], + description: "Show all events instead of first 25 only", }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-l", "--limit"], + description: "Limit number of events in output", + args: {}, }, ], args: { name: "id", - description: "The unique id of the order", + description: "Unique id of the webhook", }, }, { - name: "orders: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: ["webhooks:list", "wh:list"], + description: "List all the registered webhooks", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-c", "--circuit"], + description: "Show only webhooks with circuit in the declared state", args: { - description: "", + 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: ["-p", "--print"], - description: "Print out the modified order", + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-t", "--time"], + description: "Waiting time for the first event", + args: { + default: "120", + }, }, ], args: { name: "id", - description: "The unique id of the order", + description: "Unique id of the webhook", }, }, { - name: "orders:save_payment_source_to_customer_wallet", - description: - "Send this attribute if you want the order's payment source to be saved in the cu", + 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: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + 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", + name: ["-f", "--format"], + description: "Format the payload output", }, ], args: { name: "id", - description: "The unique id of the order", + description: "Unique id of the webhook", }, }, { - name: "orders:save_shipping_address_to_customer_address_book", - description: - "Send this attribute if you want the order's shipping address to be saved in the", + 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: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + 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", + description: "Unique id of the webhook", }, }, { - name: "orders:shipping_address_clone_id", - description: - "The id of the address that you want to clone to create the order's shipping addr", + 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: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-p", "--print"], - description: "Print out the modified order", + name: ["-t", "--topic"], + description: + "The identifier of the event that will trigger the webhook", + args: {}, }, { - name: ["-j", "--json"], - description: "Print result in json format", + name: ["-u", "--url"], + description: "The callback url used to post data", + args: {}, }, { - name: ["-u", "--unformatted"], - description: "Print json output without indentation", + name: ["-i", "--include"], + description: + "A comma separated list of related resources to be included", + args: {}, }, { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: { - description: "", - }, - isRequired: true, + name: ["-n", "--name"], + description: "The webhook short name", + args: {}, }, ], args: { name: "id", - description: "The unique id of the order", + description: "Unique id of the webhook", }, }, { - name: "orders:shipping_address_same_as_billing", - description: - "Send this attribute if you want the shipping address to be cloned from the order", + 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: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-p", "--print"], - description: "Print out the modified order", + description: "Print out the modified resource", }, { name: ["-j", "--json"], @@ -5455,41 +4939,35 @@ const completionSpec: Fig.Spec = { ], args: { name: "id", - description: "The unique id of the order", + description: "The unique id of the resource", }, }, { - name: "orders:start_editing", + name: "adyen_payment:details", description: - "Send this attribute if you want to edit the order after it is placed", + "Send this attribute if you want to send additional details the payment request", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-p", "--print"], - description: "Print out the modified order", + description: "Print out the modified resource", }, { name: ["-j", "--json"], @@ -5502,41 +4980,34 @@ const completionSpec: Fig.Spec = { ], args: { name: "id", - description: "The unique id of the order", + description: "The unique id of the resource", }, }, { - name: "orders:stop_editing", - description: - "Send this attribute to stop the editing for the order and return back to placed", + name: "authorization", + description: "Execute an action on a resource of type authorizations", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-p", "--print"], - description: "Print out the modified order", + description: "Print out the modified resource", }, { name: ["-j", "--json"], @@ -5549,40 +5020,35 @@ const completionSpec: Fig.Spec = { ], args: { name: "id", - description: "The unique id of the order", + description: "The unique id of the resource", }, }, { - name: "orders:unarchive", - description: "Send this attribute if you want to unarchive the order", + name: "authorization:capture", + description: + "Send this attribute if you want to create a capture for this authorization", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-p", "--print"], - description: "Print out the modified order", + description: "Print out the modified resource", }, { name: ["-j", "--json"], @@ -5595,41 +5061,34 @@ const completionSpec: Fig.Spec = { ], args: { name: "id", - description: "The unique id of the order", + description: "The unique id of the resource", }, }, { - name: "orders:update_taxes", - description: - "Send this attribute if you want to force tax calculation for this order (a tax c", + name: "authorization:capture_amount_cents", + description: "The associated capture amount, in cents", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-p", "--print"], - description: "Print out the modified order", + description: "Print out the modified resource", }, { name: ["-j", "--json"], @@ -5642,41 +5101,35 @@ const completionSpec: Fig.Spec = { ], args: { name: "id", - description: "The unique id of the order", + description: "The unique id of the resource", }, }, { - name: "orders:validate", + name: "authorization:void", description: - "Send this attribute if you want to trigger the external validation for the order", + "Send this attribute if you want to create a void for this authorization", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-p", "--print"], - description: "Print out the modified order", + description: "Print out the modified resource", }, { name: ["-j", "--json"], @@ -5689,34 +5142,28 @@ const completionSpec: Fig.Spec = { ], args: { name: "id", - description: "The unique id of the order", + description: "The unique id of the resource", }, }, { - name: "adyen_payment", - description: "Execute an action on a resource of type adyen_payments", + name: "axerve_payment", + description: "Execute an action on a resource of type axerve_payments", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -5739,31 +5186,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "adyen_payment:details", + name: "axerve_payment:update", description: - "Send this attribute if you want to send additional details the payment request", + "Send this attribute if you want to update the payment with fresh order data", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -5786,30 +5227,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "authorization", - description: "Execute an action on a resource of type authorizations", + name: "bundle", + description: "Execute an action on a resource of type bundles", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -5832,31 +5267,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "authorization:capture", + name: "bundle:compute_compare_at_amount", description: - "Send this attribute if you want to create a capture for this authorization", + "Send this attribute if you want to compute the compare_at_amount_cents as the su", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -5879,30 +5308,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "authorization:capture_amount_cents", - description: "The associated capture amount, in cents", + 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"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -5925,31 +5349,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "authorization:void", + name: "buy_x_pay_y_promotion", description: - "Send this attribute if you want to create a void for this authorization", + "Execute an action on a resource of type buy_x_pay_y_promotions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -5972,30 +5390,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "axerve_payment", - description: "Execute an action on a resource of type axerve_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"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6018,31 +5431,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "axerve_payment:update", + name: "buy_x_pay_y_promotion:enable", description: - "Send this attribute if you want to update the payment with fresh order data", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6065,30 +5472,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "bundle", - description: "Execute an action on a resource of type bundles", + name: "capture", + description: "Execute an action on a resource of type captures", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6111,31 +5512,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "bundle:compute_compare_at_amount", + name: "capture:refund", description: - "Send this attribute if you want to compute the compare_at_amount_cents as the su", + "Send this attribute if you want to create a refund for this capture", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6158,31 +5553,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "bundle:compute_price_amount", - description: - "Send this attribute if you want to compute the price_amount_cents as the sum of", + name: "capture:refund_amount_cents", + description: "The associated refund amount, in cents", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6205,31 +5593,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "buy_x_pay_y_promotion", + name: "checkout_com_payment", description: - "Execute an action on a resource of type buy_x_pay_y_promotions", + "Execute an action on a resource of type checkout_com_payments", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6252,31 +5634,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "buy_x_pay_y_promotion:disable", + name: "checkout_com_payment:details", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to send additional details the payment request (", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6299,31 +5675,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "buy_x_pay_y_promotion:enable", + name: "checkout_com_payment:refresh", description: - "Send this attribute if you want to mark this resource as enabled", + "Send this attribute if you want to refresh all the pending transactions, can be", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6346,30 +5716,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "capture", - description: "Execute an action on a resource of type captures", + name: "customer_password_reset", + description: + "Execute an action on a resource of type customer_password_resets", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6392,31 +5757,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "capture:refund", + name: "customer_password_reset:reset_password_token", description: - "Send this attribute if you want to create a refund for this capture", + "Send the 'reset_password_token' that you got on create when updating the custome", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6439,30 +5798,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "capture:refund_amount_cents", - description: "The associated refund amount, in cents", + name: "external_gateway", + description: "Execute an action on a resource of type external_gateways", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6485,31 +5838,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "checkout_com_payment", + name: "external_gateway:reset_circuit", description: - "Execute an action on a resource of type checkout_com_payments", + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6532,31 +5879,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "checkout_com_payment:details", + name: "external_promotion", description: - "Send this attribute if you want to send additional details the payment request (", + "Execute an action on a resource of type external_promotions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6579,31 +5920,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "checkout_com_payment:refresh", + name: "external_promotion:disable", description: - "Send this attribute if you want to refresh all the pending transactions, can be", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6626,31 +5961,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "customer_password_reset", + name: "external_promotion:enable", description: - "Execute an action on a resource of type customer_password_resets", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6673,31 +6002,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "customer_password_reset:reset_password_token", + name: "external_promotion:reset_circuit", description: - "Send the 'reset_password_token' that you got on create when updating the custome", + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6720,30 +6043,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_gateway", - description: "Execute an action on a resource of type external_gateways", + name: "external_tax_calculator", + description: + "Execute an action on a resource of type external_tax_calculators", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6766,31 +6084,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_gateway:reset_circuit", + name: "external_tax_calculator:reset_circuit", description: "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6813,31 +6125,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_promotion", + name: "fixed_amount_promotion", description: - "Execute an action on a resource of type external_promotions", + "Execute an action on a resource of type fixed_amount_promotions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6860,31 +6166,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_promotion:disable", + name: "fixed_amount_promotion:disable", description: "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6907,31 +6207,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_promotion:enable", + name: "fixed_amount_promotion:enable", description: "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -6954,31 +6248,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_promotion:reset_circuit", + name: "fixed_price_promotion", description: - "Send this attribute if you want to reset the circuit breaker associated to this", + "Execute an action on a resource of type fixed_price_promotions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7001,31 +6289,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_tax_calculator", + name: "fixed_price_promotion:disable", description: - "Execute an action on a resource of type external_tax_calculators", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7048,31 +6330,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "external_tax_calculator:reset_circuit", + name: "fixed_price_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"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7095,31 +6371,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_amount_promotion", + name: "free_gift_promotion", description: - "Execute an action on a resource of type fixed_amount_promotions", + "Execute an action on a resource of type free_gift_promotions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7142,31 +6412,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_amount_promotion:disable", + name: "free_gift_promotion:disable", description: "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7189,31 +6453,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_amount_promotion:enable", + name: "free_gift_promotion:enable", description: "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7236,31 +6494,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_price_promotion", + name: "free_shipping_promotion", description: - "Execute an action on a resource of type fixed_price_promotions", + "Execute an action on a resource of type free_shipping_promotions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7283,31 +6535,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_price_promotion:disable", + name: "free_shipping_promotion:disable", description: "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7330,31 +6576,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "fixed_price_promotion:enable", + name: "free_shipping_promotion:enable", description: "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7377,31 +6617,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_gift_promotion", - description: - "Execute an action on a resource of type free_gift_promotions", + name: "gift_card", + description: "Execute an action on a resource of type gift_cards", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7424,31 +6657,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_gift_promotion:disable", - description: - "Send this attribute if you want to mark this resource as disabled", + name: "gift_card:activate", + description: "Send this attribute if you want to activate a gift card", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7471,31 +6697,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_gift_promotion:enable", - description: - "Send this attribute if you want to mark this resource as enabled", + name: "gift_card:balance_change_cents", + description: "The balance change, in cents", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7518,31 +6737,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_shipping_promotion", - description: - "Execute an action on a resource of type free_shipping_promotions", + name: "gift_card:deactivate", + description: "Send this attribute if you want to deactivate a gift card", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7565,31 +6777,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_shipping_promotion:disable", + name: "gift_card:purchase", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to confirm a draft gift card", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7612,31 +6818,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "free_shipping_promotion:enable", + name: "in_stock_subscription", description: - "Send this attribute if you want to mark this resource as enabled", + "Execute an action on a resource of type in_stock_subscriptions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7659,30 +6859,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card", - description: "Execute an action on a resource of type gift_cards", + name: "in_stock_subscription:activate", + description: + "Send this attribute if you want to activate an inactive subscription", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7705,30 +6900,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card:activate", - description: "Send this attribute if you want to activate a gift card", + name: "in_stock_subscription:deactivate", + description: + "Send this attribute if you want to dactivate an active subscription", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7751,30 +6941,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card:balance_change_cents", - description: "The balance change, in cents", + name: "klarna_payment", + description: "Execute an action on a resource of type klarna_payments", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7797,30 +6981,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card:deactivate", - description: "Send this attribute if you want to deactivate a gift card", + name: "klarna_payment:update", + description: + "Send this attribute if you want to update the payment session with fresh order d", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7843,31 +7022,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "gift_card:purchase", - description: - "Send this attribute if you want to confirm a draft gift card", + name: "line_item", + description: "Execute an action on a resource of type line_items", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7890,31 +7062,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "in_stock_subscription", + name: "line_item:external_price", description: - "Execute an action on a resource of type in_stock_subscriptions", + "When creating or updating a new line item, set this attribute to '1' if you want", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7937,31 +7103,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "in_stock_subscription:activate", + name: "line_item:reserve_stock", description: - "Send this attribute if you want to activate an inactive subscription", + "Send this attribute if you want to reserve the stock for the line item's skus qu", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -7984,31 +7144,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "in_stock_subscription:deactivate", + name: "line_item:reset_circuit", description: - "Send this attribute if you want to dactivate an active subscription", + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8031,30 +7185,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "klarna_payment", - description: "Execute an action on a resource of type klarna_payments", + name: "market", + description: "Execute an action on a resource of type markets", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8077,31 +7225,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "klarna_payment:update", + name: "market:disable", description: - "Send this attribute if you want to update the payment session with fresh order d", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8124,30 +7266,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "line_item", - description: "Execute an action on a resource of type line_items", + name: "market:enable", + description: + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8170,31 +7307,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "line_item:external_price", - description: - "When creating or updating a new line item, set this attribute to '1' if you want", + name: "order", + description: "Execute an action on a resource of type orders", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8217,31 +7347,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "line_item:reserve_stock", + name: "order_subscription", description: - "Send this attribute if you want to reserve the stock for the line item's skus qu", + "Execute an action on a resource of type order_subscriptions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8264,31 +7388,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "line_item:reset_circuit", + name: "order_subscription:activate", 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 active", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8311,30 +7429,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "market", - description: "Execute an action on a resource of type markets", + name: "order_subscription:cancel", + description: + "Send this attribute if you want to mark this subscription as cancelled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8357,31 +7470,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "market:disable", + name: "order_subscription:deactivate", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to mark this subscription as inactive", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8404,31 +7511,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "market:enable", - description: - "Send this attribute if you want to mark this resource as enabled", + name: "order:approve", + description: "Send this attribute if you want to approve a placed order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8451,30 +7551,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order", - description: "Execute an action on a resource of type orders", + name: "order:approve_and_capture", + description: + "Send this attribute if you want to approve and capture a placed order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8497,31 +7592,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order_subscription", - description: - "Execute an action on a resource of type order_subscriptions", + name: "order:archive", + description: "Send this attribute if you want to archive the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8544,31 +7632,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order_subscription:activate", - description: - "Send this attribute if you want to mark this subscription as active", + name: "order:authorization_amount_cents", + description: "The authorization amount, in cents", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8591,31 +7672,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order_subscription:cancel", + name: "order:authorize", description: - "Send this attribute if you want to mark this subscription as cancelled", + "Send this attribute if you want to authorize the order's payment source", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8638,31 +7713,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order_subscription:deactivate", + name: "order:billing_address_clone_id", description: - "Send this attribute if you want to mark this subscription as inactive", + "The id of the address that you want to clone to create the order's billing addre", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8678,6 +7747,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", @@ -8685,30 +7760,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:approve", - description: "Send this attribute if you want to approve a placed order", + name: "order:billing_address_same_as_shipping", + description: + "Send this attribute if you want the billing address to be cloned from the order'", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8731,31 +7801,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:approve_and_capture", - description: - "Send this attribute if you want to approve and capture a placed order", + name: "order:cancel", + description: "Send this attribute if you want to cancel a placed order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8778,30 +7841,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:archive", - description: "Send this attribute if you want to archive the order", + name: "order:capture", + description: + "Send this attribute if you want to capture an authorized order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8824,30 +7882,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:authorization_amount_cents", - description: "The authorization amount, in cents", + name: "order:commit_invoice", + description: + "Send this attribute if you want commit the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8870,31 +7923,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:authorize", + name: "order:create_subscriptions", description: - "Send this attribute if you want to authorize the order's payment source", + "Send this attribute upon/after placing the order if you want to create order sub", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8917,31 +7964,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:billing_address_clone_id", - description: - "The id of the address that you want to clone to create the order's billing addre", + name: "order:customer_payment_source_id", + description: "The id of the customer payment source (i", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -8960,9 +8000,7 @@ const completionSpec: Fig.Spec = { { name: ["-v", "--value"], description: "The trigger attribute value", - args: { - description: "", - }, + args: {}, isRequired: true, }, ], @@ -8972,31 +8010,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:billing_address_same_as_shipping", + name: "order:nullify_payment_source", description: - "Send this attribute if you want the billing address to be cloned from the order'", + "Send this attribute if you want to nullify the payment source for this order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9019,30 +8051,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:cancel", - description: "Send this attribute if you want to cancel a placed order", + name: "order:pending", + description: + "Send this attribute if you want to move a draft or placing order to pending", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9065,31 +8092,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:capture", - description: - "Send this attribute if you want to capture an authorized order", + name: "order:place", + description: "Send this attribute if you want to place the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9112,31 +8132,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:commit_invoice", + name: "order:refresh", description: - "Send this attribute if you want commit the sales tax invoice to the associated t", + "Send this attribute if you want to manually refresh the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9159,31 +8173,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:create_subscriptions", - description: - "Send this attribute upon/after placing the order if you want to create order sub", + name: "order:refund", + description: "Send this attribute if you want to refund a captured order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9206,30 +8213,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:customer_payment_source_id", - description: "The id of the customer payment source (i", + name: "order:refund_invoice", + description: + "Send this attribute if you want refund the sales tax invoice to the associated t", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9245,14 +8247,6 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, - { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: { - description: "", - }, - isRequired: true, - }, ], args: { name: "id", @@ -9260,31 +8254,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:nullify_payment_source", + name: "order:reset_circuit", description: - "Send this attribute if you want to nullify the payment source for this order", + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9307,31 +8295,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:pending", + name: "order:save_billing_address_to_customer_address_book", 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 billing address to be saved in the c", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9354,30 +8336,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:place", - description: "Send this attribute if you want to place the order", + name: "order:save_payment_source_to_customer_wallet", + description: + "Send this attribute if you want the order's payment source to be saved in the cu", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9400,31 +8377,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:refresh", + name: "order:save_shipping_address_to_customer_address_book", description: - "Send this attribute if you want to manually refresh the order", + "Send this attribute if you want the order's shipping address to be saved in the", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9447,30 +8418,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:refund", - description: "Send this attribute if you want to refund a captured order", + name: "order:shipping_address_clone_id", + description: + "The id of the address that you want to clone to create the order's shipping addr", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9486,6 +8452,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", @@ -9493,31 +8465,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:refund_invoice", + name: "order:shipping_address_same_as_billing", description: - "Send this attribute if you want refund the sales tax invoice to the associated t", + "Send this attribute if you want the shipping address to be cloned from the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9540,31 +8506,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:reset_circuit", + name: "order:start_editing", description: - "Send this attribute if you want to reset the circuit breaker associated to this", + "Send this attribute if you want to edit the order after it is placed", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9587,31 +8547,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:save_billing_address_to_customer_address_book", + name: "order:stop_editing", description: - "Send this attribute if you want the order's billing address to be saved in the c", + "Send this attribute to stop the editing for the order and return back to placed", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9634,31 +8588,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:save_payment_source_to_customer_wallet", - description: - "Send this attribute if you want the order's payment source to be saved in the cu", + name: "order:unarchive", + description: "Send this attribute if you want to unarchive the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9681,31 +8628,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:save_shipping_address_to_customer_address_book", + name: "order:update_taxes", description: - "Send this attribute if you want the order's shipping address to be saved in the", + "Send this attribute if you want to force tax calculation for this order (a tax c", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9728,31 +8669,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:shipping_address_clone_id", + name: "order:validate", description: - "The id of the address that you want to clone to create the order's shipping addr", + "Send this attribute if you want to trigger the external validation for the order", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9768,14 +8703,6 @@ const completionSpec: Fig.Spec = { name: ["-u", "--unformatted"], description: "Print json output without indentation", }, - { - name: ["-v", "--value"], - description: "The trigger attribute value", - args: { - description: "", - }, - isRequired: true, - }, ], args: { name: "id", @@ -9783,31 +8710,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:shipping_address_same_as_billing", - description: - "Send this attribute if you want the shipping address to be cloned from the order", + name: "payment_method", + description: "Execute an action on a resource of type payment_methods", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9830,31 +8750,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:start_editing", + name: "payment_method:disable", 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 disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9877,31 +8791,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:stop_editing", + name: "payment_method:enable", description: - "Send this attribute to stop the editing for the order and return back to placed", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9924,30 +8832,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:unarchive", - description: "Send this attribute if you want to unarchive the order", + name: "percentage_discount_promotion", + description: + "Execute an action on a resource of type percentage_discount_promotions", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -9970,31 +8873,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:update_taxes", + name: "percentage_discount_promotion:disable", 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 disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10017,31 +8914,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "order:validate", + name: "percentage_discount_promotion:enable", description: - "Send this attribute if you want to trigger the external validation for the order", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10064,30 +8955,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "payment_method", - description: "Execute an action on a resource of type payment_methods", + name: "return", + description: "Execute an action on a resource of type returns", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10110,31 +8995,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "payment_method:disable", - description: - "Send this attribute if you want to mark this resource as disabled", + name: "return_line_item", + description: "Execute an action on a resource of type return_line_items", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10157,31 +9035,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "payment_method:enable", - description: - "Send this attribute if you want to mark this resource as enabled", + name: "return_line_item:restock", + description: "Send this attribute if you want to restock the line item", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10204,31 +9075,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "percentage_discount_promotion", + name: "return:approve", description: - "Execute an action on a resource of type percentage_discount_promotions", + "Send this attribute if you want to mark this return as approved", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10251,31 +9116,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "percentage_discount_promotion:disable", - description: - "Send this attribute if you want to mark this resource as disabled", + name: "return:archive", + description: "Send this attribute if you want to archive the return", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10298,31 +9156,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "percentage_discount_promotion:enable", + name: "return:cancel", description: - "Send this attribute if you want to mark this resource as enabled", + "Send this attribute if you want to mark this return as cancelled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10345,30 +9197,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return", - description: "Execute an action on a resource of type returns", + name: "return:receive", + description: + "Send this attribute if you want to mark this return as received", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10391,30 +9238,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return_line_item", - description: "Execute an action on a resource of type return_line_items", + name: "return:reject", + description: + "Send this attribute if you want to mark this return as rejected", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10437,30 +9279,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return_line_item:restock", - description: "Send this attribute if you want to restock the line item", + name: "return:request", + description: "Send this attribute if you want to activate this return", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10483,31 +9319,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:approve", + name: "return:restock", description: - "Send this attribute if you want to mark this return as approved", + "Send this attribute if you want to restock all of the return line items", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10530,30 +9360,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:archive", - description: "Send this attribute if you want to archive the return", + name: "return:ship", + description: + "Send this attribute if you want to mark this return as shipped", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10576,31 +9401,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:cancel", - description: - "Send this attribute if you want to mark this return as cancelled", + name: "return:unarchive", + description: "Send this attribute if you want to unarchive the return", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10623,31 +9441,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:receive", - description: - "Send this attribute if you want to mark this return as received", + name: "satispay_payment", + description: "Execute an action on a resource of type satispay_payments", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10670,31 +9481,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:reject", + name: "satispay_payment:refresh", description: - "Send this attribute if you want to mark this return as rejected", + "Send this attribute if you want to refresh all the pending transactions, can be", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10717,30 +9522,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:request", - description: "Send this attribute if you want to activate this return", + name: "shipment", + description: "Execute an action on a resource of type shipments", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10763,31 +9562,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:restock", + name: "shipment:decrement_stock", description: - "Send this attribute if you want to restock all of the return line items", + "Send this attribute if you want to automatically decrement and release the stock", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10810,31 +9603,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:ship", + name: "shipment:get_rates", description: - "Send this attribute if you want to mark this return as shipped", + "Send this attribute if you want get the shipping rates from the associated carri", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10857,30 +9644,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "return:unarchive", - description: "Send this attribute if you want to unarchive the return", + name: "shipment:on_hold", + description: + "Send this attribute if you want to put this shipment on hold", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10903,30 +9685,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "satispay_payment", - description: "Execute an action on a resource of type satispay_payments", + name: "shipment:packing", + description: + "Send this attribute if you want to start packing this shipment", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10949,31 +9726,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "satispay_payment:refresh", + name: "shipment:picking", description: - "Send this attribute if you want to refresh all the pending transactions, can be", + "Send this attribute if you want to start picking this shipment", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -10996,30 +9767,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment", - description: "Execute an action on a resource of type shipments", + name: "shipment:purchase", + description: + "Send this attribute if you want to purchase this shipment with the selected rate", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11042,31 +9808,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:decrement_stock", + name: "shipment:ready_to_ship", 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 ready to ship", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11089,31 +9849,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:get_rates", + name: "shipment:release_stock", description: - "Send this attribute if you want get the shipping rates from the associated carri", + "Send this attribute if you want to automatically destroy the stock reservations", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11136,31 +9890,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:on_hold", + name: "shipment:reserve_stock", description: - "Send this attribute if you want to put this shipment on hold", + "Send this attribute if you want to automatically reserve the stock for each of t", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11183,31 +9931,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:packing", + name: "shipment:ship", description: - "Send this attribute if you want to start packing this shipment", + "Send this attribute if you want to mark this shipment as shipped", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11230,31 +9972,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:picking", + name: "shipment:upcoming", description: - "Send this attribute if you want to start picking this shipment", + "Send this attribute if you want to mark this shipment as upcoming", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11277,31 +10013,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:purchase", - description: - "Send this attribute if you want to purchase this shipment with the selected rate", + name: "shipping_method", + description: "Execute an action on a resource of type shipping_methods", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11324,31 +10053,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:ready_to_ship", + name: "shipping_method:disable", description: - "Send this attribute if you want to mark this shipment as ready to ship", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11371,31 +10094,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:release_stock", + name: "shipping_method:enable", description: - "Send this attribute if you want to automatically destroy the stock reservations", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11418,31 +10135,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:reserve_stock", + name: "shipping_method:reset_circuit", description: - "Send this attribute if you want to automatically reserve the stock for each of t", + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11465,31 +10176,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:ship", - description: - "Send this attribute if you want to mark this shipment as shipped", + name: "stock_item", + description: "Execute an action on a resource of type stock_items", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11512,31 +10216,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipment:upcoming", + name: "stock_item:validate", description: - "Send this attribute if you want to mark this shipment as upcoming", + "Send this attribute if you want to validate the stock item quantity against the", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11559,30 +10257,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipping_method", - description: "Execute an action on a resource of type shipping_methods", + name: "stock_line_item", + description: "Execute an action on a resource of type stock_line_items", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11605,31 +10297,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipping_method:disable", + name: "stock_line_item:decrement_stock", description: - "Send this attribute if you want to mark this resource as disabled", + "Send this attribute if you want to automatically decrement and release the stock", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11652,31 +10338,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipping_method:enable", + name: "stock_line_item:release_stock", description: - "Send this attribute if you want to mark this resource as enabled", + "Send this attribute if you want to automatically destroy the stock reservation f", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11699,31 +10379,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "shipping_method:reset_circuit", + name: "stock_line_item:reserve_stock", description: - "Send this attribute if you want to reset the circuit breaker associated to this", + "Send this attribute if you want to automatically reserve the stock for this stoc", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11746,30 +10420,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_item", - description: "Execute an action on a resource of type stock_items", + name: "stock_reservation", + description: "Execute an action on a resource of type stock_reservations", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11792,31 +10460,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_item:validate", + name: "stock_reservation:pending", description: - "Send this attribute if you want to validate the stock item quantity against the", + "Send this attribute if you want to mark this stock reservation as pending", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11839,30 +10501,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_line_item", - description: "Execute an action on a resource of type stock_line_items", + name: "stock_transfer", + description: "Execute an action on a resource of type stock_transfers", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11885,31 +10541,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_line_item:decrement_stock", + name: "stock_transfer:cancel", description: - "Send this attribute if you want to automatically decrement and release the stock", + "Send this attribute if you want to cancel this stock transfer", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11932,31 +10582,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_line_item:release_stock", + name: "stock_transfer:complete", description: - "Send this attribute if you want to automatically destroy the stock reservation f", + "Send this attribute if you want to complete this stock transfer", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -11979,31 +10623,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_line_item:reserve_stock", + name: "stock_transfer:in_transit", description: - "Send this attribute if you want to automatically reserve the stock for this stoc", + "Send this attribute if you want to mark this stock transfer as in transit", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12026,30 +10664,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_reservation", - description: "Execute an action on a resource of type stock_reservations", + name: "stock_transfer:on_hold", + description: + "Send this attribute if you want to put this stock transfer on hold", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12072,31 +10705,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_reservation:pending", + name: "stock_transfer:picking", description: - "Send this attribute if you want to mark this stock reservation as pending", + "Send this attribute if you want to start picking this stock transfer", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12119,30 +10746,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_transfer", - description: "Execute an action on a resource of type stock_transfers", + name: "stock_transfer:upcoming", + description: + "Send this attribute if you want to mark this stock transfer as upcoming", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12165,31 +10787,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_transfer:cancel", - description: - "Send this attribute if you want to cancel this stock transfer", + name: "stripe_payment", + description: "Execute an action on a resource of type stripe_payments", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12212,31 +10827,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_transfer:complete", + name: "stripe_payment:refresh", description: - "Send this attribute if you want to complete this stock transfer", + "Send this attribute if you want to refresh the payment status, can be used as we", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12259,31 +10868,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_transfer:in_transit", + name: "stripe_payment:update", description: - "Send this attribute if you want to mark this stock transfer as in transit", + "Send this attribute if you want to update the created payment intent with fresh", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12306,31 +10909,24 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_transfer:on_hold", - description: - "Send this attribute if you want to put this stock transfer on hold", + name: "webhook", + description: "Execute an action on a resource of type webhooks", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12353,31 +10949,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_transfer:picking", + name: "webhook:disable", description: - "Send this attribute if you want to start picking this stock transfer", + "Send this attribute if you want to mark this resource as disabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12400,31 +10990,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stock_transfer:upcoming", + name: "webhook:enable", description: - "Send this attribute if you want to mark this stock transfer as upcoming", + "Send this attribute if you want to mark this resource as enabled", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12447,30 +11031,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stripe_payment", - description: "Execute an action on a resource of type stripe_payments", + name: "webhook:reset_circuit", + description: + "Send this attribute if you want to reset the circuit breaker associated to this", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12493,312 +11072,25 @@ const completionSpec: Fig.Spec = { }, }, { - name: "stripe_payment:refresh", + name: "exports", description: - "Send this attribute if you want to refresh the payment status, can be used as we", + "List all the created exports or show details of a single export", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, - 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: "stripe_payment:update", - description: - "Send this attribute if you want to update the created payment intent with fresh", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - 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: "webhook", - description: "Execute an action on a resource of type webhooks", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - 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: "webhook:disable", - description: - "Send this attribute if you want to mark this resource as disabled", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - 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: "webhook:enable", - description: - "Send this attribute if you want to mark this resource as enabled", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - 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: "webhook:reset_circuit", - description: - "Send this attribute if you want to reset the circuit breaker associated to this", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - 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: "exports", - description: - "List all the created exports or show details of a single export", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12810,7 +11102,6 @@ const completionSpec: Fig.Spec = { name: ["-t", "--type"], description: "The type of resource exported", args: { - description: "", suggestions: [ "addresses", "authorizations", @@ -12846,16 +11137,13 @@ const completionSpec: Fig.Spec = { name: ["-s", "--status"], description: "The export job status", args: { - description: "", suggestions: ["in_progress", "pending", "completed", "interrupted"], }, }, { name: ["-l", "--limit"], description: "Limit number of exports in output", - args: { - description: "", - }, + args: {}, }, ], args: { @@ -12871,24 +11159,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -12932,16 +11214,12 @@ const completionSpec: Fig.Spec = { { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-D", "--dry-data"], @@ -12951,7 +11229,6 @@ const completionSpec: Fig.Spec = { name: ["-F", "--format"], description: "Export file format", args: { - description: "", suggestions: ["csv", "json"], default: "json", }, @@ -12963,17 +11240,13 @@ const completionSpec: Fig.Spec = { { name: ["-x", "--save"], description: "Save command output to file", - args: { - description: "", - }, + args: {}, }, { name: ["-X", "--save-path"], description: "Save command output to file and create missing path directories", - args: { - description: "", - }, + args: {}, }, { name: ["-N", "--notify"], @@ -13011,24 +11284,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -13072,16 +11339,12 @@ const completionSpec: Fig.Spec = { { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-D", "--dry-data"], @@ -13091,7 +11354,6 @@ const completionSpec: Fig.Spec = { name: ["-F", "--format"], description: "Export file format", args: { - description: "", suggestions: ["csv", "json"], default: "json", }, @@ -13103,17 +11365,13 @@ const completionSpec: Fig.Spec = { { name: ["-x", "--save"], description: "Save command output to file", - args: { - description: "", - }, + args: {}, }, { name: ["-X", "--save-path"], description: "Save command output to file and create missing path directories", - args: { - description: "", - }, + args: {}, }, { name: ["-N", "--notify"], @@ -13142,24 +11400,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -13176,24 +11428,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -13210,24 +11456,18 @@ const completionSpec: Fig.Spec = { { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, @@ -13239,7 +11479,6 @@ const completionSpec: Fig.Spec = { name: ["-t", "--type"], description: "The type of resource exported", args: { - description: "", suggestions: [ "addresses", "authorizations", @@ -13275,498 +11514,274 @@ const completionSpec: Fig.Spec = { name: ["-s", "--status"], description: "The export job status", args: { - description: "", - suggestions: ["in_progress", "pending", "completed", "interrupted"], - }, - }, - { - name: ["-l", "--limit"], - description: "Limit number of exports in output", - args: { - description: "", - }, - }, - ], - }, - { - name: ["exports:types", "exp:types"], - description: "Show online documentation for supported resources", - options: [ - { - name: ["-O", "--open"], - description: "Open online documentation page", - }, - ], - }, - { - name: "tags", - description: "List all the created tags or show details of a single tag", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-A", "--all"], - description: "Show all tags instead of first 25 only", - }, - { - name: ["-l", "--limit"], - description: "Limit number of tags in output", - args: { - description: "", - }, - }, - ], - args: { - name: "id", - description: "Unique id of the tag to be retrieved", - isOptional: true, - }, - }, - { - name: ["tags:add", "tag"], - description: "Add one or more tags to a set of resources", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-n", "--name"], - description: "The tag name", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-t", "--type"], - description: "The type of the resource to tag", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-i", "--id"], - description: "The ids of the resources to tag", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-C", "--create"], - description: "Create tags if don't exist", - args: { - description: "", - }, - }, - { - name: ["-v", "--verbose"], - description: "Show details of the tag process", - }, - ], - }, - { - name: "tags:count", - description: "Count resources tagged with a specific tag", - options: [ - { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-t", "--type"], - description: "The type of the tagged resources", - args: { - description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], }, }, { - name: ["-z", "--zero"], - description: "Show also resources without tags", + name: ["-l", "--limit"], + description: "Limit number of exports in output", + args: {}, }, ], - args: { - name: "id_name", - description: "Unique id or name of the tag", - }, }, { - name: "tags:create", - description: "Create one or more new tags", + name: ["exports:types", "exp:types"], + description: "Show online documentation for supported resources", options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-d", "--domain"], - args: { - description: "", - }, - hidden: true, - }, - { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, - }, - { - name: ["-n", "--name"], - description: "The tag name", - args: { - description: "", - }, - isRequired: true, + name: ["-O", "--open"], + description: "Open online documentation page", }, ], }, { - name: "tags:delete", - description: "Delete one or more existing tags", + 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: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-n", "--name"], - description: "The tag name", - args: { - description: "", - }, - isRequired: true, + name: ["-A", "--all"], + description: "Show all cleanups instead of first 25 only", }, - ], - }, - { - name: "tags:details", - description: "Show the details of an existing tag", - options: [ { - name: ["-o", "--organization"], - description: "The slug of your organization", + name: ["-t", "--type"], + description: "The type of resource cleaned", args: { - description: "", + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], }, - isRequired: true, - hidden: true, }, { - name: ["-d", "--domain"], + name: ["-s", "--status"], + description: "The cleanup job status", args: { - description: "", + suggestions: ["in_progress", "pending", "completed", "interrupted"], }, - hidden: true, }, { - name: "--accessToken", - args: { - description: "", - }, - isRequired: true, - hidden: true, + name: ["-l", "--limit"], + description: "Limit number of cleanups in output", + args: {}, }, ], args: { - name: "id_name", - description: "Unique id or name of the tag", + name: "id", + description: "Unique id of the cleanup to be retrieved", + isOptional: true, }, }, { - name: "tags:list", - description: "List all the created tags", + name: ["cleanups:create", "clp:create", "cleanup"], + description: "Create a new cleanup", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-t", "--type"], + description: "The type of resource to clean up", args: { - description: "", + 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: ["-A", "--all"], - description: "Show all tags instead of first 25 only", + name: ["-b", "--blind"], + description: + "Execute in blind mode without showing the progress monitor", }, { - name: ["-l", "--limit"], - description: "Limit number of tags in output", - args: { - description: "", - }, + name: ["-q", "--quiet"], + description: "Execute command without showing warning messages", }, ], }, { - name: "tags:remove", - description: "Remove one or more tags to a set of resources", + name: ["cleanups:details", "clp:details"], + description: "Show the details of an existing cleanup", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-n", "--name"], - description: "The tag name", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-t", "--type"], - description: "The type of the resource to tag", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-i", "--id"], - description: "The ids of th eresources to tag", - args: { - description: "", - }, - isRequired: true, - }, - { - name: ["-v", "--verbose"], - description: "Show details of the tag process", - }, - ], - }, - { - name: "tags:types", - description: "Show online documentation for supported resources", - options: [ - { - name: ["-O", "--open"], - description: "Open online documentation page", + name: ["-l", "--logs"], + description: "Show error logs related to the cleanup process", }, ], + args: { + name: "id", + description: "Unique id of the cleanup", + }, }, { - name: "tags:update", - description: "Update an existing tag", + 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: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, - { - name: ["-n", "--name"], - description: "The new tag name", - args: { - description: "", - }, - isRequired: true, - }, ], args: { - name: "id_name", - description: "Unique id or name of the tag", + name: "group_id", + description: "Unique id of the group cleanup", }, }, { - name: "tags:which", - description: "Show all the resources with this tag", + name: ["cleanups:list", "clp:list"], + description: "List all the created cleanups", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, + { + name: ["-A", "--all"], + description: "Show all cleanups instead of first 25 only", + }, { name: ["-t", "--type"], - description: "The type of the tagged resources", + description: "The type of resource cleaned", args: { - description: "", + suggestions: [ + "bundles", + "gift_cards", + "prices", + "promotions", + "sku_lists", + "sku_options", + "skus", + "stock_items", + ], }, - isRequired: true, }, { - name: ["-A", "--all"], - description: "Show all resources instead of first 25 only", + 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: ["-l", "--limit"], - description: "Limit number of resources in output", - args: { - description: "", - }, + name: ["-O", "--open"], + description: "Open online documentation page", }, ], - args: { - name: "id_name", - description: "Unique id or name of the tag", - }, }, { name: ["provisioning:create", "prov:create", "pc", "pcreate"], @@ -13774,33 +11789,25 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -13823,7 +11830,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -13849,38 +11855,28 @@ const completionSpec: Fig.Spec = { { name: ["-a", "--attribute"], description: "Define a resource attribute", - args: { - description: "", - }, + args: {}, }, { name: ["-O", "--object"], description: "Define a resource object attribute", - args: { - description: "", - }, + args: {}, }, { name: ["-r", "--relationship"], description: "Define a relationship with another resource", - args: { - description: "", - }, + args: {}, }, { name: ["-m", "--metadata"], description: "Define a metadata attribute or a set of metadata attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-D", "--data"], description: "The data file to use as request body", - args: { - description: "", - }, + args: {}, }, ], args: { @@ -13903,33 +11899,25 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -13952,7 +11940,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -13999,25 +11986,19 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-a", "--attribute"], description: "Define a resource attribute", - args: { - description: "", - }, + args: {}, }, ], args: [ @@ -14043,33 +12024,25 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -14092,7 +12065,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -14118,37 +12090,27 @@ const completionSpec: Fig.Spec = { { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--page"], description: "Page number", - args: { - description: "", - }, + args: {}, }, { name: ["-n", "--pageSize"], description: "Number of elements per page", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--sort"], description: "Defines results ordering", - args: { - description: "", - }, + args: {}, }, { name: ["-I", "--force-include"], @@ -14178,33 +12140,25 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -14227,7 +12181,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -14253,37 +12206,27 @@ const completionSpec: Fig.Spec = { { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--page"], description: "Page number", - args: { - description: "", - }, + args: {}, }, { name: ["-n", "--pageSize"], description: "Number of elements per page", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--sort"], description: "Defines results ordering", - args: { - description: "", - }, + args: {}, }, { name: ["-I", "--force-include"], @@ -14309,33 +12252,25 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -14358,7 +12293,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -14384,37 +12318,27 @@ const completionSpec: Fig.Spec = { { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--page"], description: "Page number", - args: { - description: "", - }, + args: {}, }, { name: ["-n", "--pageSize"], description: "Number of elements per page", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--sort"], description: "Defines results ordering", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-I", "--force-include"], @@ -14444,33 +12368,25 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -14493,7 +12409,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -14519,37 +12434,27 @@ const completionSpec: Fig.Spec = { { name: ["-w", "--where"], description: "Comma separated list of query filters", - args: { - description: "", - }, + args: {}, }, { name: ["-p", "--page"], description: "Page number", - args: { - description: "", - }, + args: {}, }, { name: ["-n", "--pageSize"], description: "Number of elements per page", - args: { - description: "", - }, + args: {}, }, { name: ["-s", "--sort"], description: "Defines results ordering", - args: { - description: "", - }, + args: {}, }, { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, { name: ["-I", "--force-include"], @@ -14589,33 +12494,25 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -14638,7 +12535,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -14664,9 +12560,7 @@ const completionSpec: Fig.Spec = { { name: ["-e", "--extract"], description: "Extract subfields from object attributes", - args: { - description: "", - }, + args: {}, }, ], args: [ @@ -14700,33 +12594,25 @@ const completionSpec: Fig.Spec = { options: [ { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-i", "--include"], description: "Comma separated resources to include", - args: { - description: "", - }, + args: {}, }, { name: ["-f", "--fields"], description: "Comma separeted list of fields in the format [resourcetype/]field1,field2,field3", - args: { - description: "", - }, + args: {}, }, { name: ["-j", "--json"], @@ -14749,7 +12635,6 @@ const completionSpec: Fig.Spec = { name: ["-l", "--lang"], description: "Show the cli command in the specified language syntax", args: { - description: "", suggestions: ["curl", "node"], }, }, @@ -14775,44 +12660,32 @@ const completionSpec: Fig.Spec = { { name: ["-a", "--attribute"], description: "Define a resource attribute", - args: { - description: "", - }, + args: {}, }, { name: ["-O", "--object"], description: "Define a resource object attribute", - args: { - description: "", - }, + args: {}, }, { name: ["-r", "--relationship"], description: "Define a relationship with another resource", - args: { - description: "", - }, + args: {}, }, { name: ["-m", "--metadata"], description: "", - args: { - description: "", - }, + args: {}, }, { name: ["-M", "--metadata-replace"], description: "", - args: { - description: "", - }, + args: {}, }, { name: ["-D", "--data"], description: "The data file to use as request body", - args: { - description: "", - }, + args: {}, }, ], args: [ @@ -14837,293 +12710,400 @@ const completionSpec: Fig.Spec = { ], }, { - name: "cleanups", - description: - "List all the created cleanups or show details of a single cleanup", + name: "tags", + description: "List all the created tags or show details of a single tag", + 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 tags instead of first 25 only", + }, + { + name: ["-l", "--limit"], + description: "Limit number of tags in output", + args: {}, + }, + ], + args: { + name: "id", + description: "Unique id of the tag to be retrieved", + isOptional: true, + }, + }, + { + name: ["tags:add", "tag"], + description: "Add one or more tags to a set of resources", + 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: ["-n", "--name"], + description: "The tag name", + args: {}, + isRequired: true, + }, + { + name: ["-t", "--type"], + description: "The type of the resource to tag", + args: {}, + isRequired: true, + }, + { + name: ["-i", "--id"], + description: "The ids of the resources to tag", + args: {}, + isRequired: true, + }, + { + name: ["-C", "--create"], + description: "Create tags if don't exist", + args: {}, + }, + { + name: ["-v", "--verbose"], + description: "Show details of the tag process", + }, + ], + }, + { + name: "tags:count", + description: "Count resources tagged with a specific tag", + 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 the tagged resources", + args: {}, + }, + { + name: ["-z", "--zero"], + description: "Show also resources without tags", + }, + ], + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, + }, + { + name: "tags:create", + description: "Create one or more new tags", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-A", "--all"], - description: "Show all cleanups instead of first 25 only", + name: ["-n", "--name"], + description: "The tag name", + args: {}, + isRequired: true, }, + ], + }, + { + name: "tags:delete", + description: "Delete one or more existing tags", + options: [ { - name: ["-t", "--type"], - description: "The type of resource cleaned", - args: { - description: "", - suggestions: [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items", - ], - }, + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, + isRequired: true, + hidden: true, }, { - name: ["-s", "--status"], - description: "The cleanup job status", - args: { - description: "", - suggestions: ["in_progress", "pending", "completed", "interrupted"], - }, + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: ["-l", "--limit"], - description: "Limit number of cleanups in output", - args: { - description: "", - }, + name: "--accessToken", + args: {}, + isRequired: true, + hidden: true, + }, + { + name: ["-n", "--name"], + description: "The tag name", + args: {}, + isRequired: true, }, ], - 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", + name: "tags:details", + description: "Show the details of an existing tag", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, + ], + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, + }, + { + name: "tags:list", + description: "List all the created tags", + options: [ { - 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", - ], - }, + name: ["-o", "--organization"], + description: "The slug of your organization", + args: {}, isRequired: true, + hidden: true, }, { - name: ["-w", "--where"], - description: "Comma separated list of query filters", - args: { - description: "", - }, + name: ["-d", "--domain"], + args: {}, + hidden: true, }, { - name: ["-N", "--notify"], - description: "Force system notification when cleanup has finished", + name: "--accessToken", + args: {}, + isRequired: true, hidden: true, }, { - name: ["-b", "--blind"], - description: - "Execute in blind mode without showing the progress monitor", + name: ["-A", "--all"], + description: "Show all tags instead of first 25 only", }, { - name: ["-q", "--quiet"], - description: "Execute command without showing warning messages", + name: ["-l", "--limit"], + description: "Limit number of tags in output", + args: {}, }, ], }, { - name: ["cleanups:details", "clp:details"], - description: "Show the details of an existing cleanup", + name: "tags:remove", + description: "Remove one or more tags to a set of resources", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { - name: ["-l", "--logs"], - description: "Show error logs related to the cleanup process", + name: ["-n", "--name"], + description: "The tag name", + args: {}, + isRequired: true, + }, + { + name: ["-t", "--type"], + description: "The type of the resource to tag", + args: {}, + isRequired: true, + }, + { + name: ["-i", "--id"], + description: "The ids of th eresources to tag", + args: {}, + isRequired: true, + }, + { + name: ["-v", "--verbose"], + description: "Show details of the tag 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", + name: "tags:types", + description: "Show online documentation for supported resources", + options: [ + { + name: ["-O", "--open"], + description: "Open online documentation page", + }, + ], + }, + { + name: "tags:update", + description: "Update an existing tag", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, + { + name: ["-n", "--name"], + description: "The new tag name", + args: {}, + isRequired: true, + }, ], args: { - name: "group_id", - description: "Unique id of the group cleanup", + name: "id_name", + description: "Unique id or name of the tag", }, }, { - name: ["cleanups:list", "clp:list"], - description: "List all the created cleanups", + name: "tags:which", + description: "Show all the resources with this tag", options: [ { name: ["-o", "--organization"], description: "The slug of your organization", - args: { - description: "", - }, + args: {}, isRequired: true, hidden: true, }, { name: ["-d", "--domain"], - args: { - description: "", - }, + args: {}, hidden: true, }, { name: "--accessToken", - args: { - description: "", - }, + 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: { - description: "", - suggestions: [ - "bundles", - "gift_cards", - "prices", - "promotions", - "sku_lists", - "sku_options", - "skus", - "stock_items", - ], - }, + description: "The type of the tagged resources", + args: {}, + isRequired: true, }, { - name: ["-s", "--status"], - description: "The cleanup job status", - args: { - description: "", - suggestions: ["in_progress", "pending", "completed", "interrupted"], - }, + name: ["-A", "--all"], + description: "Show all resources instead of first 25 only", }, { name: ["-l", "--limit"], - description: "Limit number of cleanups in output", - args: { - description: "", - }, + description: "Limit number of resources in output", + args: {}, }, ], + args: { + name: "id_name", + description: "Unique id or name of the tag", + }, }, { - name: ["cleanups:types", "clp:types"], - description: "Show online documentation for supported resources", + name: "autocomplete", + description: "Display autocomplete installation instructions", options: [ { - name: ["-O", "--open"], - description: "Open online documentation page", + name: ["-r", "--refresh-cache"], + description: "Refresh cache (ignores displaying instructions)", }, ], + args: { + name: "shell", + description: "Shell type", + suggestions: ["zsh", "bash", "powershell"], + isOptional: true, + }, }, { name: "help", @@ -15140,22 +13120,6 @@ const completionSpec: Fig.Spec = { isOptional: true, }, }, - { - name: "autocomplete", - description: "Display autocomplete installation instructions", - options: [ - { - name: ["-r", "--refresh-cache"], - description: "Refresh cache (ignores displaying instructions)", - }, - ], - args: { - name: "shell", - description: "Shell type", - suggestions: ["zsh", "bash", "powershell"], - isOptional: true, - }, - }, { name: "plugins", description: "List installed plugins", From 55445d42745aa50640c7ea9d5675612b600aa72f Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Mon, 29 Apr 2024 10:19:23 +0200 Subject: [PATCH 7/8] fix: fix force-include flag decription --- src/commercelayer.ts | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/commercelayer.ts b/src/commercelayer.ts index 5839e3a3bc6d..ba6d6a0ae24e 100644 --- a/src/commercelayer.ts +++ b/src/commercelayer.ts @@ -2198,7 +2198,7 @@ const completionSpec: Fig.Spec = { }, { name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, ], @@ -2342,7 +2342,7 @@ const completionSpec: Fig.Spec = { }, { name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, ], @@ -2482,7 +2482,7 @@ const completionSpec: Fig.Spec = { }, { name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, ], @@ -2739,7 +2739,7 @@ const completionSpec: Fig.Spec = { }, { name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, ], @@ -12114,7 +12114,7 @@ const completionSpec: Fig.Spec = { }, { name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, ], @@ -12230,7 +12230,7 @@ const completionSpec: Fig.Spec = { }, { name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, ], @@ -12342,7 +12342,7 @@ const completionSpec: Fig.Spec = { }, { name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, ], @@ -12458,7 +12458,7 @@ const completionSpec: Fig.Spec = { }, { name: ["-I", "--force-include"], - description: "Force resources inclusion beyound the 3rd level", + description: "Force resources inclusion beyond the 3rd level", hidden: true, }, ], From 1d6aed6dbe1e5f8e2ac6cea28fa2bae0a4fa42f4 Mon Sep 17 00:00:00 2001 From: Pierluigi Viti Date: Fri, 16 Aug 2024 15:10:19 +0200 Subject: [PATCH 8/8] feat: update commands --- src/commercelayer.ts | 5287 ++++++++++++++++++++++++++---------------- 1 file changed, 3247 insertions(+), 2040 deletions(-) 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",