Skip to content

Commit

Permalink
fix: fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pviti committed May 17, 2024
1 parent f4d315c commit 0babde5
Showing 1 changed file with 78 additions and 62 deletions.
140 changes: 78 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,31 @@ List all the created exports or show details of a single export.
```sh-session
USAGE
$ commercelayer exports [ID] [-A | -l <value>] [-t
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_cate
gories|transactions|authorizations|captures|voids|refunds] [-s in_progress|pending|completed|interrupted]
addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipments|shipp
ing_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categ
ories|transactions|voids] [-s in_progress|pending|completed|interrupted]

ARGUMENTS
ID unique id of the export to be retrieved

FLAGS
-A, --all show all exports instead of first 25 only
-l, --limit=<value> limit number of exports in output
-s, --status=<option> the export job status
<options: in_progress|pending|completed|interrupted>
-t, --type=<option> the type of resource exported
<options: addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orde
rs|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>
-A, --all
show all exports instead of first 25 only

-l, --limit=<value>
limit number of exports in output

-s, --status=<option>
the export job status
<options: in_progress|pending|completed|interrupted>

-t, --type=<option>
the type of resource exported
<options: addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_sub
scriptions|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipm
ents|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags
|tax_categories|transactions|voids>

DESCRIPTION
list all the created exports or show details of a single export
Expand All @@ -70,28 +78,28 @@ Export all the records.
```sh-session
USAGE
$ commercelayer exports:all -t
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_cate
gories|transactions|authorizations|captures|voids|refunds [-i <value>] [-w <value>] [-D] [-F csv|json | -C | ] [-x
<value> | -X <value>] [-b] [-P | ] [-O] [-q] [-k]
addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipments|shipp
ing_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categ
ories|transactions|voids [-i <value>] [-w <value>] [-D] [-F csv|json | -C | ] [-x <value> | -X <value>] [-b] [-P | ]
[-O] [-q] [-k]

FLAGS
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format=<option> [default: json] export file format
<options: csv|json>
-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path=<value> save command output to file and create missing path
directories
-b, --blind execute in blind mode without showing the progress
monitor
-i, --include=<value>... comma separated resources to include
-k, --keep keep original export files in temp dir
-q, --quiet execute command without showing warning messages
-t, --type=addresses|bundles|coupons|customer_subscriptions|... (required) the type of resource being exported
-w, --where=<value>... comma separated list of query filters
-x, --save=<value> save command output to file
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format=<option> [default: json] export file format
<options: csv|json>
-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path=<value> save command output to file and create missing path
directories
-b, --blind execute in blind mode without showing the progress monitor
-i, --include=<value>... comma separated resources to include
-k, --keep keep original export files in temp dir
-q, --quiet execute command without showing warning messages
-t, --type=addresses|authorizations|bundles|captures|... (required) the type of resource being exported
-w, --where=<value>... comma separated list of query filters
-x, --save=<value> save command output to file

DESCRIPTION
export all the records
Expand All @@ -117,26 +125,26 @@ Create a new export.
```sh-session
USAGE
$ commercelayer exports:create -t
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_cate
gories|transactions|authorizations|captures|voids|refunds [-i <value>] [-w <value>] [-D] [-F csv|json | -C | ] [-x
<value> | -X <value>] [-b] [-P | ] [-O]
addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipments|shipp
ing_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categ
ories|transactions|voids [-i <value>] [-w <value>] [-D] [-F csv|json | -C | ] [-x <value> | -X <value>] [-b] [-P | ]
[-O]

FLAGS
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format=<option> [default: json] export file format
<options: csv|json>
-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path=<value> save command output to file and create missing path
directories
-b, --blind execute in blind mode without showing the progress
monitor
-i, --include=<value>... comma separated resources to include
-t, --type=addresses|bundles|coupons|customer_subscriptions|... (required) the type of resource being exported
-w, --where=<value>... comma separated list of query filters
-x, --save=<value> save command output to file
-C, --csv export data in CSV format
-D, --dry-data skip redundant attributes
-F, --format=<option> [default: json] export file format
<options: csv|json>
-O, --open open automatically the file after a successful export
-P, --prettify prettify json output format
-X, --save-path=<value> save command output to file and create missing path
directories
-b, --blind execute in blind mode without showing the progress monitor
-i, --include=<value>... comma separated resources to include
-t, --type=addresses|authorizations|bundles|captures|... (required) the type of resource being exported
-w, --where=<value>... comma separated list of query filters
-x, --save=<value> save command output to file

DESCRIPTION
create a new export
Expand Down Expand Up @@ -209,20 +217,28 @@ List all the created exports.
```sh-session
USAGE
$ commercelayer exports:list [-A | -l <value>] [-t
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_cate
gories|transactions|authorizations|captures|voids|refunds] [-s in_progress|pending|completed|interrupted]
addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_subscriptions
|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipments|shipp
ing_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags|tax_categ
ories|transactions|voids] [-s in_progress|pending|completed|interrupted]

FLAGS
-A, --all show all exports instead of first 25 only
-l, --limit=<value> limit number of exports in output
-s, --status=<option> the export job status
<options: in_progress|pending|completed|interrupted>
-t, --type=<option> the type of resource exported
<options: addresses|bundles|coupons|customer_subscriptions|customers|gift_cards|line_items|orde
rs|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>
-A, --all
show all exports instead of first 25 only

-l, --limit=<value>
limit number of exports in output

-s, --status=<option>
the export job status
<options: in_progress|pending|completed|interrupted>

-t, --type=<option>
the type of resource exported
<options: addresses|authorizations|bundles|captures|coupons|customer_addresses|customer_payment_sources|customer_sub
scriptions|customers|gift_cards|line_items|line_item_options|orders|payment_methods|price_tiers|prices|refunds|shipm
ents|shipping_categories|shipping_methods|sku_lists|sku_list_items|sku_options|skus|stock_items|stock_transfers|tags
|tax_categories|transactions|voids>

DESCRIPTION
list all the created exports
Expand Down

0 comments on commit 0babde5

Please sign in to comment.