@commercelayer/cli-plugin-provisioning
v2.0.3
Published
Commerce Layer CLI Provisioning plugin
Downloads
90
Readme
@commercelayer/cli-plugin-provisioning
Commerce Layer CLI Provisioning plugin
Usage
commercelayer COMMAND
commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
Commands
commercelayer provisioning:create RESOURCE
commercelayer provisioning:delete RESOURCE [ID]
commercelayer provisioning:exec RESOURCE [ID] [ACTION]
commercelayer provisioning:fetch RESOURCE PATH [ID]
commercelayer provisioning:get RESOURCE [ID]
commercelayer provisioning:list RESOURCE
commercelayer provisioning:resources
commercelayer provisioning:retrieve RESOURCE [ID]
commercelayer provisioning:update RESOURCE [ID]
commercelayer provisioning:create RESOURCE
Create a new resource.
USAGE
$ commercelayer provisioning:create RESOURCE [-i <value>...] [-f <value>...] [-u -j] [-l curl|node [--doc | -R]]
[--curl ] [--node ] [-H ] [-Y ] [-O <value>...] [-D <value> | -a <value>... | -r <value>... | -m <value>... | ]
ARGUMENTS
RESOURCE the resource type
FLAGS
-D, --data=<value> the data file to use as request body
-H, --headers show response headers
-O, --object=<value>... define a resource object attribute
-R, --raw print out the raw API response
-Y, --headers-only show only response headers
-a, --attribute=<value>... define a resource attribute
-f, --fields=<value>... comma separeted list of fields in the format [resourceType/]field1,field2,field3
-i, --include=<value>... comma separated resources to include
-j, --json convert output in standard JSON format
-m, --metadata=<value>... define a metadata attribute or a set of metadata attributes
-r, --relationship=<value>... define a relationship with another resource
-u, --unformatted print unformatted JSON output
DOCUMENTATION FLAGS
-l, --lang=<option> show the CLI command in the specified language syntax
<options: curl|node>
--curl show the equivalent cURL command of the CLI command
--doc show the CLI command in a specific language
--node show the equivalent Node SDK source code of the CLI command
DESCRIPTION
create a new resource
ALIASES
$ commercelayer prov:create
$ commercelayer pc
$ commercelayer pcreate
EXAMPLES
$ commercelayer provisioning:create organizations -a name=MyOrg
$ clayer prov:create subscriptions -r plan=plans/<planId>
$ cl prov:create organization -a name=MyOrg -m meta_key="meta value"
$ cl pc roles -D /path/to/data/file/data.json
See code: src/commands/provisioning/create.ts
commercelayer provisioning:delete RESOURCE [ID]
Delete an existing resource.
USAGE
$ commercelayer provisioning:delete RESOURCE [ID] [-i <value>...] [-f <value>...] [-u -j] [-l curl|node [--doc | -R]]
[--curl ] [--node ] [-H ] [-Y ]
ARGUMENTS
RESOURCE the resource type
ID id of the resource to delete
FLAGS
-H, --headers show response headers
-R, --raw print out the raw API response
-Y, --headers-only show only response headers
-f, --fields=<value>... comma separeted list of fields in the format [resourceType/]field1,field2,field3
-i, --include=<value>... comma separated resources to include
-j, --json convert output in standard JSON format
-u, --unformatted print unformatted JSON output
DOCUMENTATION FLAGS
-l, --lang=<option> show the CLI command in the specified language syntax
<options: curl|node>
--curl show the equivalent cURL command of the CLI command
--doc show the CLI command in a specific language
--node show the equivalent Node SDK source code of the CLI command
DESCRIPTION
delete an existing resource
ALIASES
$ commercelayer prov:delete
$ commercelayer pd
$ commercelayer pdelete
$ commercelayer pdel
EXAMPLES
$ commercelayer provisioning:delete api_credentials/<id>
$ cl prov:delete api_credentials <id>
See code: src/commands/provisioning/delete.ts
commercelayer provisioning:exec RESOURCE [ID] [ACTION]
Execute an action on a resource.
USAGE
$ commercelayer provisioning:exec RESOURCE [ID] [ACTION] [-a <value>...]
ARGUMENTS
RESOURCE the resource type
ID id of the resource on which to execute the action
ACTION action to execute on resource
FLAGS
-a, --attribute=<value>... define a resource attribute
DESCRIPTION
execute an action on a resource
ALIASES
$ commercelayer prov:exec
$ commercelayer pe
$ commercelayer pexec
EXAMPLES
$ commercelayer provisioning:exec organizations <organizationId> transfer_ownership
$ cl prov:exec memberships <membershipId> resend
See code: src/commands/provisioning/exec.ts
commercelayer provisioning:fetch RESOURCE PATH [ID]
Retrieve a resource or list a set of resources.
USAGE
$ commercelayer provisioning:fetch RESOURCE... PATH... [ID...] [-i <value>...] [-f <value>...] [-u -j] [-l curl|node
[--doc | -R]] [--curl ] [--node ] [-H ] [-Y ] [-e <value>... | ] [-w <value>...] [-p <value>] [-n <value>] [-s
<value>...]
ARGUMENTS
RESOURCE... the resource type
PATH... path (or URL) of the resource(s) to fetch
ID... resource id
FLAGS
-H, --headers show response headers
-R, --raw print out the raw API response
-Y, --headers-only show only response headers
-e, --extract=<value>... extract subfields from object attributes
-f, --fields=<value>... comma separeted list of fields in the format [resourceType/]field1,field2,field3
-i, --include=<value>... comma separated resources to include
-j, --json convert output in standard JSON format
-n, --pageSize=<value> number of elements per page
-p, --page=<value> page number
-s, --sort=<value>... define results ordering
-u, --unformatted print unformatted JSON output
-w, --where=<value>... comma separated list of query filters
DOCUMENTATION FLAGS
-l, --lang=<option> show the CLI command in the specified language syntax
<options: curl|node>
--curl show the equivalent cURL command of the CLI command
--doc show the CLI command in a specific language
--node show the equivalent Node SDK source code of the CLI command
DESCRIPTION
retrieve a resource or list a set of resources
ALIASES
$ commercelayer prov:fetch
$ commercelayer pf
EXAMPLES
$ commercelayer provisioning:fetch roles
$ commercelayer prov:fetch roles
$ clayer prov:fetch roles/<roleId>
$ cl prov:fetch roles/<roleId>/<roleRelationship>
$ cl pf roles/{roleId}/permissions aBcdEkYWx
See code: src/commands/provisioning/fetch.ts
commercelayer provisioning:get RESOURCE [ID]
Retrieve a resource or list a set of resources.
USAGE
$ commercelayer provisioning:get RESOURCE... [ID...] [-i <value>...] [-f <value>...] [-u -j] [-l curl|node [--doc |
-R]] [--curl ] [--node ] [-H ] [-Y ] [-e <value>... | ] [-w <value>...] [-p <value>] [-n <value>] [-s <value>...]
ARGUMENTS
RESOURCE... the resource type
ID... id of the resource to retrieve
FLAGS
-H, --headers show response headers
-R, --raw print out the raw API response
-Y, --headers-only show only response headers
-e, --extract=<value>... extract subfields from object attributes
-f, --fields=<value>... comma separeted list of fields in the format [resourceType/]field1,field2,field3
-i, --include=<value>... comma separated resources to include
-j, --json convert output in standard JSON format
-n, --pageSize=<value> number of elements per page
-p, --page=<value> page number
-s, --sort=<value>... define results ordering
-u, --unformatted print unformatted JSON output
-w, --where=<value>... comma separated list of query filters
DOCUMENTATION FLAGS
-l, --lang=<option> show the CLI command in the specified language syntax
<options: curl|node>
--curl show the equivalent cURL command of the CLI command
--doc show the CLI command in a specific language
--node show the equivalent Node SDK source code of the CLI command
DESCRIPTION
retrieve a resource or list a set of resources
ALIASES
$ commercelayer prov:get
$ commercelayer pg
$ commercelayer pget
EXAMPLES
$ commercelayer provisioning:get roles
$ commercelayer prov:get roles
$ clayer prov:get roles/<roleId>
$ cl prov:get roles <roleId>
See code: src/commands/provisioning/get.ts
commercelayer provisioning:list RESOURCE
Fetch a collection of resources.
USAGE
$ commercelayer provisioning:list RESOURCE [-i <value>...] [-f <value>...] [-u -j] [-l curl|node [--doc | -R]]
[--curl ] [--node ] [-H ] [-Y ] [-w <value>...] [-p <value>] [-n <value>] [-s <value>...] [-e <value>... | ]
ARGUMENTS
RESOURCE the resource type
FLAGS
-H, --headers show response headers
-R, --raw print out the raw API response
-Y, --headers-only show only response headers
-e, --extract=<value>... extract subfields from object attributes
-f, --fields=<value>... comma separeted list of fields in the format [resourceType/]field1,field2,field3
-i, --include=<value>... comma separated resources to include
-j, --json convert output in standard JSON format
-n, --pageSize=<value> number of elements per page
-p, --page=<value> page number
-s, --sort=<value>... define results ordering
-u, --unformatted print unformatted JSON output
-w, --where=<value>... comma separated list of query filters
DOCUMENTATION FLAGS
-l, --lang=<option> show the CLI command in the specified language syntax
<options: curl|node>
--curl show the equivalent cURL command of the CLI command
--doc show the CLI command in a specific language
--node show the equivalent Node SDK source code of the CLI command
DESCRIPTION
fetch a collection of resources
ALIASES
$ commercelayer pl
$ commercelayer prov:list
$ commercelayer plist
$ commercelayer pls
EXAMPLES
$ commercelayer provisioning:list roles -f id,name -i organization -s updated_at
$ cl prov:list roles -i organization -f name -f organizations/name -w organization_name_eq="ORG NAME"
$ cl prov:list roles -p 5 -n 10 -s -created_at --raw
See code: src/commands/provisioning/list.ts
commercelayer provisioning:resources
List all the available Provisioning API resources.
USAGE
$ commercelayer provisioning:resources [-h]
FLAGS
-h, --help Show CLI help.
DESCRIPTION
list all the available Provisioning API resources
ALIASES
$ commercelayer prov:resources
$ commercelayer pres
EXAMPLES
$ commercelayer provisioning:resources
$ cl prov:resources
See code: src/commands/provisioning/resources.ts
commercelayer provisioning:retrieve RESOURCE [ID]
Fetch a single resource.
USAGE
$ commercelayer provisioning:retrieve RESOURCE [ID] [-i <value>...] [-f <value>...] [-u -j] [-l curl|node [--doc | -R]]
[--curl ] [--node ] [-H ] [-Y ] [-e <value>... | ]
ARGUMENTS
RESOURCE the resource type
ID id of the resource to retrieve
FLAGS
-H, --headers show response headers
-R, --raw print out the raw API response
-Y, --headers-only show only response headers
-e, --extract=<value>... extract subfields from object attributes
-f, --fields=<value>... comma separeted list of fields in the format [resourceType/]field1,field2,field3
-i, --include=<value>... comma separated resources to include
-j, --json convert output in standard JSON format
-u, --unformatted print unformatted JSON output
DOCUMENTATION FLAGS
-l, --lang=<option> show the CLI command in the specified language syntax
<options: curl|node>
--curl show the equivalent cURL command of the CLI command
--doc show the CLI command in a specific language
--node show the equivalent Node SDK source code of the CLI command
DESCRIPTION
fetch a single resource
ALIASES
$ commercelayer prov:retrieve
$ commercelayer pr
$ commercelayer pretrieve
EXAMPLES
$ commercelayer provisioning:retrieve roles/<roleId>
$ commercelayer prov:retrieve roles <roleId>
$ cl prov:retrieve roles <roleId>
$ clayer pr roles/<roleId>
See code: src/commands/provisioning/retrieve.ts
commercelayer provisioning:update RESOURCE [ID]
Update an existing resource.
USAGE
$ commercelayer provisioning:update RESOURCE [ID] [-i <value>...] [-f <value>...] [-u -j] [-l curl|node [--doc | -R]]
[--curl ] [--node ] [-H ] [-Y ] [-O <value>...] [-D <value> | -a <value>... | -r <value>... | [-m <value>... | -M
<value>...] | | ]
ARGUMENTS
RESOURCE the resource type
ID id of the resource to update
FLAGS
-D, --data=<value> the data file to use as request body
-H, --headers show response headers
-M, --metadata-replace=<value>... define a metadata attribute and replace every item already present in the remote
resource
-O, --object=<value>... define a resource object attribute
-R, --raw print out the raw API response
-Y, --headers-only show only response headers
-a, --attribute=<value>... define a resource attribute
-f, --fields=<value>... comma separeted list of fields in the format [resourceType/]field1,field2,field3
-i, --include=<value>... comma separated resources to include
-j, --json convert output in standard JSON format
-m, --metadata=<value>... define a metadata attribute and merge it with the metadata already present in the
remote resource
-r, --relationship=<value>... define a relationship with another resource
-u, --unformatted print unformatted JSON output
DOCUMENTATION FLAGS
-l, --lang=<option> show the CLI command in the specified language syntax
<options: curl|node>
--curl show the equivalent cURL command of the CLI command
--doc show the CLI command in a specific language
--node show the equivalent Node SDK source code of the CLI command
DESCRIPTION
update an existing resource
ALIASES
$ commercelayer prov:update
$ commercelayer pu
$ commercelayer pupdate
$ commercelayer pupd
EXAMPLES
$ commercelayer provisioning:update roles/<roleId> -a reference=referenceId
$ commercelayer prov:update roles <roleId> -a reference_origin="Ref Origin"
$ cl prov:update roles/<roleId> -m meta_key="meta value"
$ cl pu roles <roleId> -M meta_key="metadata overwrite
$ clayer prov:update roles <roleId> -D /path/to/data/file/data.json
See code: src/commands/provisioning/update.ts