@commercelayer/cli-plugin-resources
Advanced tools
Comparing version 5.3.2 to 5.3.3
@@ -1,1 +0,1 @@ | ||
{"version":"5.3.2","commands":{"resources:all":{"id":"resources:all","description":"fetch all resources","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["all","ra","res:all"],"examples":["$ commercelayer resources:all customers -f id,email -i customer_group -s updated_at","$ cl res:all -i customer_group -f customer_groups/name -w customer_group_name_eq=\"GROUP NAME\"","$ cl all -s -created_at --json"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"notify":{"name":"notify","type":"boolean","char":"N","description":"force system notification when export has finished","hidden":true,"allowNo":false},"clientId":{"name":"clientId","type":"option","char":"i","description":"organization client_id","hidden":true,"required":false,"multiple":false},"clientSecret":{"name":"clientSecret","type":"option","char":"s","description":"organization client_secret","hidden":true,"required":false,"multiple":false},"csv":{"name":"csv","type":"boolean","char":"C","description":"export fields in csv format","allowNo":false,"dependsOn":["fields"],"exclusive":["raw","json"]},"header":{"name":"header","type":"option","char":"H","description":"rename column headers defining a comma-separated list of values field:\"renamed title\"","multiple":true,"dependsOn":["csv"]},"blind":{"name":"blind","type":"boolean","char":"b","description":"execute in blind mode without prompt and progress bar","allowNo":false},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]},"timeout":{"name":"timeout","type":"option","char":"T","description":"set request timeout in milliseconds [1000 - 10000]","hidden":true,"multiple":false}},"args":[{"name":"resource","description":"the resource type","required":true}],"_globalFlags":{}},"resources:args":{"id":"resources:args","description":"show all the saved command arguments","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["res:args"],"flags":{"alias":{"name":"alias","type":"option","char":"a","description":"the alias associated to saved command arguments","multiple":false,"dependsOn":["operation","resource"]},"resource":{"name":"resource","type":"option","char":"r","description":"the resource type","multiple":false},"operation":{"name":"operation","type":"option","char":"o","description":"the resource operation","multiple":false,"options":["list","retrieve","create","update"]},"delete":{"name":"delete","type":"boolean","char":"D","description":"delete saved arguments associated to the alias","allowNo":false,"dependsOn":["alias"]},"pretty":{"name":"pretty","type":"boolean","char":"P","description":"show saved arguments in table format","hidden":true,"allowNo":false,"exclusive":["alias"]}},"args":[],"_globalFlags":{}},"resources:create":{"id":"resources:create","description":"create a new resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["create","rc","res:create","post"],"examples":["$ commercelayer resources:create customers -a email=user@test.com","$ clayer res:create customers -a email=\"user@test-com\" -r customer_group=customer_groups/<customerGroupId>","$ cl create customers -a email=user@test.com -m meta_key=\"meta value\"","$ cl rc customers -D /path/to/data/file/data.json"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"attribute":{"name":"attribute","type":"option","char":"a","description":"define a resource attribute","multiple":true},"object":{"name":"object","type":"option","char":"O","description":"define a resource object attribute","multiple":true},"relationship":{"name":"relationship","type":"option","char":"r","description":"define a relationship with another resource","multiple":true},"metadata":{"name":"metadata","type":"option","char":"m","description":"define a metadata attribute or a set of metadata attributes","multiple":true},"data":{"name":"data","type":"option","char":"D","description":"the data file to use as request body","multiple":false,"exclusive":["attribute","relationship","metadata","doc","load-args","save-args"]}},"args":[{"name":"resource","description":"the resource type","required":true}],"_globalFlags":{}},"resources:delete":{"id":"resources:delete","description":"delete an existing resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["delete","rd","res:delete"],"examples":["$ commercelayer resources:delete customers/<customerId>","$ cl delete customers <customerId>"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to retrieve","required":false}],"_globalFlags":{}},"resources:doc":{"id":"resources:doc","description":"open the default browser and show the online documentation for the resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["res:doc","doc"],"examples":["$ commercelayer resources:doc customers","$ cl res:doc customers","$ cl doc customers -p create"],"flags":{"page":{"name":"page","type":"option","char":"p","description":"the doc page you want to access","required":false,"multiple":false,"options":["object","create","retrieve","list","update","delete"]}},"args":[{"name":"resource","description":"the resource for which you want to access the online documentation","required":true}],"_globalFlags":{}},"resources:fetch":{"id":"resources:fetch","description":"retrieve a resource or list a set of resources","strict":false,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["fetch","res:fetch","rf"],"examples":["$ commercelayer resources:fetch customers","$ commercelayer res:fetch customers","$ clayer res:fetch customers/<customerId>","$ cl fetch customers/<customerId>/<customerRelationship>","$ cl fetch customers/{customerId}/orders aBcdEkYWx"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"page":{"name":"page","type":"option","char":"p","description":"page number","multiple":false},"pageSize":{"name":"pageSize","type":"option","char":"n","description":"number of elements per page","multiple":false},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true}},"args":[{"name":"path","description":"path (or URL) of the resource(s) to fetch","required":true},{"name":"id","description":"resource id","required":false}],"_globalFlags":{}},"resources:filters":{"id":"resources:filters","description":"show a list of all available filter predicates","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["res:filters"],"examples":["$ commercelayer resources:filters","$ cl res:filters"],"flags":{},"args":[],"_globalFlags":{}},"resources:get":{"id":"resources:get","description":"retrieve a resource or list a set of resources","strict":false,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["get","res:get","rg"],"examples":["$ commercelayer resources:get customers","$ commercelayer res:get customers","$ clayer res:get customers/<customerId>","$ cl get customers <customerId>"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"page":{"name":"page","type":"option","char":"p","description":"page number","multiple":false},"pageSize":{"name":"pageSize","type":"option","char":"n","description":"number of elements per page","multiple":false},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to retrieve","required":false}],"_globalFlags":{}},"resources":{"id":"resources","description":"list all the available Commerce Layer API resources","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":[],"examples":["$ cl-resources resources","$ cl-res resources","$ commercelayer resources","$ cl resources"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[],"_globalFlags":{}},"resources:list":{"id":"resources:list","description":"fetch a collection of resources","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["list","rl","res:list"],"examples":["$ commercelayer resources:list customers -f id,email -i customer_group -s updated_at","$ cl res:list -i customer_group -f customer_groups/name -w customer_group_name_eq=\"GROUP NAME\"","$ cl list -p 5 -n 10 -s -created_at --raw"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"page":{"name":"page","type":"option","char":"p","description":"page number","multiple":false},"pageSize":{"name":"pageSize","type":"option","char":"n","description":"number of elements per page","multiple":false},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]}},"args":[{"name":"resource","description":"the resource type","required":true}],"_globalFlags":{}},"resources:noc":{"id":"resources:noc","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[],"_globalFlags":{}},"resources:relationship":{"id":"resources:relationship","description":"fetch a resource relationship","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","hidden":true,"aliases":["relationship","resources:rel","res:rel","res:relationship","relationship"],"examples":["$ commercelayer resources:relationship customers <customerId> customer_group","$ clayer res:relationship customers <customerId> orders","$ cl res:rel customers <customerId> orders -w status_eq=pending","$ cl relationship customers <customerId> <customerRelationship>"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"page":{"name":"page","type":"option","char":"p","description":"page number","multiple":false},"pageSize":{"name":"pageSize","type":"option","char":"n","description":"number of elements per page","multiple":false},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to retrieve","required":true},{"name":"relationship","description":"name of the relationship field","required":true}],"_globalFlags":{}},"resources:retrieve":{"id":"resources:retrieve","description":"fetch a single resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["retrieve","rr","res:retrieve"],"examples":["$ commercelayer resources:retrieve customers/<customerId>","$ commercelayer retrieve customers <customerId>","$ cl res:retrieve customers <customerId>","$ clayer rr customers/<customerId>"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to retrieve","required":false}],"_globalFlags":{}},"resources:update":{"id":"resources:update","description":"update an existing resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["update","ru","res:update","patch"],"examples":["$ commercelayer resources:update customers/<customerId> -a reference=referenceId","$ commercelayer res:update customers <customerId> -a reference_origin=\"Ref Origin\"","$ cl update customers/<customerId> -m meta_key=\"meta value\"","$ cl ru customers <customerId> -M meta_key=\"metadata overwrite","$ clayer update customers <customerId> -D /path/to/data/file/data.json"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"attribute":{"name":"attribute","type":"option","char":"a","description":"define a resource attribute","multiple":true},"object":{"name":"object","type":"option","char":"O","description":"define a resource object attribute","multiple":true},"relationship":{"name":"relationship","type":"option","char":"r","description":"define a relationship with another resource","multiple":true},"metadata":{"name":"metadata","type":"option","char":"m","description":"define a metadata attribute and merge it with the metadata already present in the remote resource","multiple":true,"exclusive":["metadata-replace"]},"metadata-replace":{"name":"metadata-replace","type":"option","char":"M","description":"define a metadata attribute and replace every item already presente in the remote resource","multiple":true,"exclusive":["metadata"]},"data":{"name":"data","type":"option","char":"D","description":"the data file to use as request body","multiple":false,"exclusive":["attribute","relationship","metadata","metadata-replace","doc","load-args","save-args"]}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to update","required":false}],"_globalFlags":{}}}} | ||
{"version":"5.3.3","commands":{"resources:all":{"id":"resources:all","description":"fetch all resources","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["all","ra","res:all"],"examples":["$ commercelayer resources:all customers -f id,email -i customer_group -s updated_at","$ cl res:all -i customer_group -f customer_groups/name -w customer_group_name_eq=\"GROUP NAME\"","$ cl all -s -created_at --json"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"notify":{"name":"notify","type":"boolean","char":"N","description":"force system notification when export has finished","hidden":true,"allowNo":false},"clientId":{"name":"clientId","type":"option","char":"i","description":"organization client_id","hidden":true,"required":false,"multiple":false},"clientSecret":{"name":"clientSecret","type":"option","char":"s","description":"organization client_secret","hidden":true,"required":false,"multiple":false},"csv":{"name":"csv","type":"boolean","char":"C","description":"export fields in csv format","allowNo":false,"dependsOn":["fields"],"exclusive":["raw","json"]},"header":{"name":"header","type":"option","char":"H","description":"rename column headers defining a comma-separated list of values field:\"renamed title\"","multiple":true,"dependsOn":["csv"]},"blind":{"name":"blind","type":"boolean","char":"b","description":"execute in blind mode without prompt and progress bar","allowNo":false},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]},"timeout":{"name":"timeout","type":"option","char":"T","description":"set request timeout in milliseconds [1000 - 10000]","hidden":true,"multiple":false}},"args":[{"name":"resource","description":"the resource type","required":true}],"_globalFlags":{}},"resources:args":{"id":"resources:args","description":"show all the saved command arguments","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["res:args"],"flags":{"alias":{"name":"alias","type":"option","char":"a","description":"the alias associated to saved command arguments","multiple":false,"dependsOn":["operation","resource"]},"resource":{"name":"resource","type":"option","char":"r","description":"the resource type","multiple":false},"operation":{"name":"operation","type":"option","char":"o","description":"the resource operation","multiple":false,"options":["list","retrieve","create","update"]},"delete":{"name":"delete","type":"boolean","char":"D","description":"delete saved arguments associated to the alias","allowNo":false,"dependsOn":["alias"]},"pretty":{"name":"pretty","type":"boolean","char":"P","description":"show saved arguments in table format","hidden":true,"allowNo":false,"exclusive":["alias"]}},"args":[],"_globalFlags":{}},"resources:create":{"id":"resources:create","description":"create a new resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["create","rc","res:create","post"],"examples":["$ commercelayer resources:create customers -a email=user@test.com","$ clayer res:create customers -a email=\"user@test-com\" -r customer_group=customer_groups/<customerGroupId>","$ cl create customers -a email=user@test.com -m meta_key=\"meta value\"","$ cl rc customers -D /path/to/data/file/data.json"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"attribute":{"name":"attribute","type":"option","char":"a","description":"define a resource attribute","multiple":true},"object":{"name":"object","type":"option","char":"O","description":"define a resource object attribute","multiple":true},"relationship":{"name":"relationship","type":"option","char":"r","description":"define a relationship with another resource","multiple":true},"metadata":{"name":"metadata","type":"option","char":"m","description":"define a metadata attribute or a set of metadata attributes","multiple":true},"data":{"name":"data","type":"option","char":"D","description":"the data file to use as request body","multiple":false,"exclusive":["attribute","relationship","metadata","doc","load-args","save-args"]}},"args":[{"name":"resource","description":"the resource type","required":true}],"_globalFlags":{}},"resources:delete":{"id":"resources:delete","description":"delete an existing resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["delete","rd","res:delete"],"examples":["$ commercelayer resources:delete customers/<customerId>","$ cl delete customers <customerId>"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to retrieve","required":false}],"_globalFlags":{}},"resources:doc":{"id":"resources:doc","description":"open the default browser and show the online documentation for the resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["res:doc","doc"],"examples":["$ commercelayer resources:doc customers","$ cl res:doc customers","$ cl doc customers -p create"],"flags":{"page":{"name":"page","type":"option","char":"p","description":"the doc page you want to access","required":false,"multiple":false,"options":["object","create","retrieve","list","update","delete"]}},"args":[{"name":"resource","description":"the resource for which you want to access the online documentation","required":true}],"_globalFlags":{}},"resources:fetch":{"id":"resources:fetch","description":"retrieve a resource or list a set of resources","strict":false,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["fetch","res:fetch","rf"],"examples":["$ commercelayer resources:fetch customers","$ commercelayer res:fetch customers","$ clayer res:fetch customers/<customerId>","$ cl fetch customers/<customerId>/<customerRelationship>","$ cl fetch customers/{customerId}/orders aBcdEkYWx"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"page":{"name":"page","type":"option","char":"p","description":"page number","multiple":false},"pageSize":{"name":"pageSize","type":"option","char":"n","description":"number of elements per page","multiple":false},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true}},"args":[{"name":"path","description":"path (or URL) of the resource(s) to fetch","required":true},{"name":"id","description":"resource id","required":false}],"_globalFlags":{}},"resources:filters":{"id":"resources:filters","description":"show a list of all available filter predicates","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["res:filters"],"examples":["$ commercelayer resources:filters","$ cl res:filters"],"flags":{},"args":[],"_globalFlags":{}},"resources:get":{"id":"resources:get","description":"retrieve a resource or list a set of resources","strict":false,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["get","res:get","rg"],"examples":["$ commercelayer resources:get customers","$ commercelayer res:get customers","$ clayer res:get customers/<customerId>","$ cl get customers <customerId>"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"page":{"name":"page","type":"option","char":"p","description":"page number","multiple":false},"pageSize":{"name":"pageSize","type":"option","char":"n","description":"number of elements per page","multiple":false},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to retrieve","required":false}],"_globalFlags":{}},"resources":{"id":"resources","description":"list all the available Commerce Layer API resources","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":[],"examples":["$ cl-resources resources","$ cl-res resources","$ commercelayer resources","$ cl resources"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[],"_globalFlags":{}},"resources:list":{"id":"resources:list","description":"fetch a collection of resources","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["list","rl","res:list"],"examples":["$ commercelayer resources:list customers -f id,email -i customer_group -s updated_at","$ cl res:list -i customer_group -f customer_groups/name -w customer_group_name_eq=\"GROUP NAME\"","$ cl list -p 5 -n 10 -s -created_at --raw"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"page":{"name":"page","type":"option","char":"p","description":"page number","multiple":false},"pageSize":{"name":"pageSize","type":"option","char":"n","description":"number of elements per page","multiple":false},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]}},"args":[{"name":"resource","description":"the resource type","required":true}],"_globalFlags":{}},"resources:noc":{"id":"resources:noc","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","hidden":true,"aliases":[],"flags":{},"args":[],"_globalFlags":{}},"resources:relationship":{"id":"resources:relationship","description":"fetch a resource relationship","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","hidden":true,"aliases":["relationship","resources:rel","res:rel","res:relationship","relationship"],"examples":["$ commercelayer resources:relationship customers <customerId> customer_group","$ clayer res:relationship customers <customerId> orders","$ cl res:rel customers <customerId> orders -w status_eq=pending","$ cl relationship customers <customerId> <customerRelationship>"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"where":{"name":"where","type":"option","char":"w","description":"comma separated list of query filters","multiple":true},"page":{"name":"page","type":"option","char":"p","description":"page number","multiple":false},"pageSize":{"name":"pageSize","type":"option","char":"n","description":"number of elements per page","multiple":false},"sort":{"name":"sort","type":"option","char":"s","description":"defines results ordering","multiple":true},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to retrieve","required":true},{"name":"relationship","description":"name of the relationship field","required":true}],"_globalFlags":{}},"resources:retrieve":{"id":"resources:retrieve","description":"fetch a single resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["retrieve","rr","res:retrieve"],"examples":["$ commercelayer resources:retrieve customers/<customerId>","$ commercelayer retrieve customers <customerId>","$ cl res:retrieve customers <customerId>","$ clayer rr customers/<customerId>"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"save":{"name":"save","type":"option","char":"x","description":"save command output to file","multiple":false,"exclusive":["save-path"]},"save-path":{"name":"save-path","type":"option","char":"X","description":"save command output to file and create missing path directories","multiple":false,"exclusive":["save"]},"extract":{"name":"extract","type":"option","char":"e","description":"extract subfields from object attributes","multiple":true,"exclusive":["raw"]}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to retrieve","required":false}],"_globalFlags":{}},"resources:update":{"id":"resources:update","description":"update an existing resource","strict":true,"pluginName":"@commercelayer/cli-plugin-resources","pluginAlias":"@commercelayer/cli-plugin-resources","pluginType":"core","aliases":["update","ru","res:update","patch"],"examples":["$ commercelayer resources:update customers/<customerId> -a reference=referenceId","$ commercelayer res:update customers <customerId> -a reference_origin=\"Ref Origin\"","$ cl update customers/<customerId> -m meta_key=\"meta value\"","$ cl ru customers <customerId> -M meta_key=\"metadata overwrite","$ clayer update customers <customerId> -D /path/to/data/file/data.json"],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"the slug of your organization","required":true,"multiple":false},"domain":{"name":"domain","type":"option","char":"d","hidden":true,"required":false,"multiple":false,"dependsOn":["organization"]},"accessToken":{"name":"accessToken","type":"option","hidden":true,"required":true,"multiple":false},"include":{"name":"include","type":"option","char":"i","description":"comma separated resources to include","multiple":true},"fields":{"name":"fields","type":"option","char":"f","description":"comma separeted list of fields in the format [resource]=field1,field2...","multiple":true},"json":{"name":"json","type":"boolean","char":"j","description":"convert output in standard JSON format","allowNo":false},"unformatted":{"name":"unformatted","type":"boolean","char":"u","description":"print unformatted JSON output","allowNo":false,"dependsOn":["json"]},"raw":{"name":"raw","type":"boolean","char":"R","description":"print out the raw API response","hidden":false,"allowNo":false},"doc":{"name":"doc","type":"boolean","char":"D","description":"shows the CLI command in a specific language","allowNo":false},"lang":{"name":"lang","type":"option","char":"l","description":"show the CLI command in the specified language syntax","multiple":false,"options":["curl","node"],"dependsOn":["doc"],"exclusive":["curl","node"]},"curl":{"name":"curl","type":"boolean","description":"show the equivalent cURL command of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","node"]},"node":{"name":"node","type":"boolean","description":"show the equivalent Node SDK source code of the CLI command","hidden":false,"allowNo":false,"dependsOn":["doc"],"exclusive":["lang","curl"]},"save-args":{"name":"save-args","type":"option","description":"save command data to file for future use","multiple":false},"load-args":{"name":"load-args","type":"option","description":"load previously saved command arguments","multiple":false},"attribute":{"name":"attribute","type":"option","char":"a","description":"define a resource attribute","multiple":true},"object":{"name":"object","type":"option","char":"O","description":"define a resource object attribute","multiple":true},"relationship":{"name":"relationship","type":"option","char":"r","description":"define a relationship with another resource","multiple":true},"metadata":{"name":"metadata","type":"option","char":"m","description":"define a metadata attribute and merge it with the metadata already present in the remote resource","multiple":true,"exclusive":["metadata-replace"]},"metadata-replace":{"name":"metadata-replace","type":"option","char":"M","description":"define a metadata attribute and replace every item already presente in the remote resource","multiple":true,"exclusive":["metadata"]},"data":{"name":"data","type":"option","char":"D","description":"the data file to use as request body","multiple":false,"exclusive":["attribute","relationship","metadata","metadata-replace","doc","load-args","save-args"]}},"args":[{"name":"resource","description":"the resource type","required":true},{"name":"id","description":"id of the resource to update","required":false}],"_globalFlags":{}}}} |
{ | ||
"name": "@commercelayer/cli-plugin-resources", | ||
"description": "Commerce Layer CLI Resources plugin", | ||
"version": "5.3.2", | ||
"version": "5.3.3", | ||
"author": "Pierluigi Viti <pierluigi@commercelayer.io>", | ||
@@ -21,8 +21,7 @@ "bugs": "https://github.com/commercelayer/commercelayer-cli-plugin-resources/issues", | ||
"eslint-config-oclif-typescript": "^1.0.2", | ||
"globby": "^10.0.2", | ||
"inflector-js": "^1.0.1", | ||
"mocha": "^9.2.1", | ||
"nyc": "^15.1.0", | ||
"ts-node": "^10.6.0", | ||
"typescript": "^4.5.5" | ||
"ts-node": "^10.7.0", | ||
"typescript": "^4.6.2" | ||
}, | ||
@@ -84,3 +83,3 @@ "engines": { | ||
"@oclif/core": "^1.3.0", | ||
"axios": "^0.26.0", | ||
"axios": "^0.26.1", | ||
"inquirer": "^8.2.0", | ||
@@ -87,0 +86,0 @@ "json-2-csv": "^3.17.0", |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
18
229998
Updatedaxios@^0.26.1