diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca48c27cb..ef054b621 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to commercetools nodejs +# Contributing to commercetools Composable Commerce nodejs Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved. diff --git a/README.md b/README.md index 121e5307c..812cd7e44 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ - Node.js commercetools ecosystem. + Node.js commercetools Composable Commerce ecosystem.
diff --git a/book.json b/book.json index 12b6088e4..cffe6c64a 100644 --- a/book.json +++ b/book.json @@ -1,7 +1,7 @@ { "gitbook": ">=3.2.1", "root": "docs", - "title": "commercetools node.js", + "title": "commercetools composable commerce node.js", "plugins": [ "edit-link", "prism", diff --git a/docs/README.md b/docs/README.md index b10c51538..f42aba746 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@ - Node.js commercetools ecosystem. + Node.js commercetools Composable Commerce ecosystem.
diff --git a/docs/cli/README.md b/docs/cli/README.md index 299c9c582..1c673f716 100644 --- a/docs/cli/README.md +++ b/docs/cli/README.md @@ -2,7 +2,7 @@ This section contains all information about the command line tools built by the commercetools nodeJS team. -Our CLI tools perform various functions from importing and exporting to syncing data between various projects in the commercetools platform. +Our CLI tools perform various functions from importing and exporting to syncing data between various projects in commercetools Composable Commerce. ### modules diff --git a/docs/cli/category-exporter.md b/docs/cli/category-exporter.md index 13b39a438..6e606a294 100644 --- a/docs/cli/category-exporter.md +++ b/docs/cli/category-exporter.md @@ -1,13 +1,13 @@ # Category Exporter -A package which exports [commercetools categories](https://docs.commercetools.com/http-api-projects-categories.html) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/). +A package which exports [Composable Commerce categories](https://docs.commercetools.com/http-api-projects-categories.html) in `JSON` format from the [commercetools Composable Commerce](https://docs.commercetools.com/). ## Configuration The constructor accepts two arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `manage_products`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows) - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional) - An optional logger object having four functions (`info`, `warn`, `error` and `debug`) @@ -20,7 +20,7 @@ The constructor accepts two arguments: ``` Usage: category-exporter [options] -Export categories from the commercetools platform +Export categories from the commercetools Composable Commerce Options: --help Show help text. [boolean] diff --git a/docs/cli/csv-parser-discount-code.md b/docs/cli/csv-parser-discount-code.md index 62eef2b3b..5a825b8fb 100644 --- a/docs/cli/csv-parser-discount-code.md +++ b/docs/cli/csv-parser-discount-code.md @@ -1,6 +1,6 @@ # CSV Parser Discount Code -Convert [commercetools discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) CSV data to JSON. See example below for CSV format, sample response and usage. +Convert [commercetools Composable Commerce discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) CSV data to JSON. See example below for CSV format, sample response and usage. ## Usage @@ -10,7 +10,7 @@ Convert [commercetools discount codes](https://docs.commercetools.com/http-api-p ``` Usage: csvparserdiscountcode [options] -Convert commercetools discount codes CSV data to JSON. +Convert commercetools Composable Commerce discount codes CSV data to JSON. Options: --help, -h Show help text. [boolean] diff --git a/docs/cli/csv-parser-orders.md b/docs/cli/csv-parser-orders.md index f66979c1f..8543ac397 100644 --- a/docs/cli/csv-parser-orders.md +++ b/docs/cli/csv-parser-orders.md @@ -5,7 +5,7 @@ [![David Dependencies Status][david-icon]][david] [![David devDependencies Status][david-dev-icon]][david-dev] -Convert [commercetools order](https://docs.commercetools.com/http-api-projects-orders.html) CSV data to JSON. See examples below for supported CSV format and sample responses. +Convert [commercetools Composable Commerce order](https://docs.commercetools.com/http-api-projects-orders.html) CSV data to JSON. See examples below for supported CSV format and sample responses. ## Usage @@ -15,7 +15,7 @@ Convert [commercetools order](https://docs.commercetools.com/http-api-projects-o ``` Usage: csvparserorder [options] -Convert commercetools order CSV data to JSON. +Convert commercetools Composable Commerce order CSV data to JSON. Options: --help, -h Show help text. [boolean] diff --git a/docs/cli/csv-parser-price.md b/docs/cli/csv-parser-price.md index 0c407136b..4670b1828 100644 --- a/docs/cli/csv-parser-price.md +++ b/docs/cli/csv-parser-price.md @@ -5,7 +5,7 @@ [![David Dependencies Status][david-icon]][david] [![David devDependencies Status][david-dev-icon]][david-dev] -Convert [commercetools price](https://docs.commercetools.com/http-api-projects-products.html#price) CSV data to JSON. See example below for CSV format and sample response +Convert [commercetools Composable Commerce price](https://docs.commercetools.com/http-api-projects-products.html#price) CSV data to JSON. See example below for CSV format and sample response ## Usage @@ -15,7 +15,7 @@ Convert [commercetools price](https://docs.commercetools.com/http-api-projects-p ``` Usage: csvparserprice [options] -Convert commercetools price CSV data to JSON. +Convert commercetools Composable Commerce price CSV data to JSON. Options: --help, -h Show help text. [boolean] diff --git a/docs/cli/csv-parser-state.md b/docs/cli/csv-parser-state.md index 3a7de23d1..23355c7a2 100644 --- a/docs/cli/csv-parser-state.md +++ b/docs/cli/csv-parser-state.md @@ -1,6 +1,6 @@ # CSV Parser State -Convert [commercetools states](https://docs.commercetools.com/http-api-projects-states.html#state) CSV data to JSON. See example below for CSV format, sample response and usage. +Convert [commercetools Composable Commerce states](https://docs.commercetools.com/http-api-projects-states.html#state) CSV data to JSON. See example below for CSV format, sample response and usage. ## Usage @@ -78,7 +78,7 @@ outputStream The constructor takes in 2 optional parameters - A configuration object containing any/all of the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (only required if states have a `transitions` field containing one or more states that need to be resolved. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (only required if states have a `transitions` field containing one or more states that need to be resolved. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `csvConfig` (Object): A configuration object for describing the CSV file: - `delimiter` (String): Used delimiter in the CSV (Default: `','`) - `multiValueDelimiter` (String): Used delimiter in multiValue fields in the CSV (Default: `';'`) diff --git a/docs/cli/custom-objects-exporter.md b/docs/cli/custom-objects-exporter.md index 15ab5f164..75a387dd4 100644 --- a/docs/cli/custom-objects-exporter.md +++ b/docs/cli/custom-objects-exporter.md @@ -1,13 +1,13 @@ # Custom Objects Exporter -A package which exports [commercetools custom objects](https://docs.commercetools.com/http-api-projects-custom-objects.html) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/). +A package which exports [Composable Commerce custom objects](https://docs.commercetools.com/http-api-projects-custom-objects.html) in `JSON` format from [commercetools Composable Commerce](https://docs.commercetools.com/). ## Configuration The constructor accepts two arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `view_orders`, `view_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows) - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional) - An optional logger object having four functions (`info`, `warn`, `error` and `debug`) @@ -20,7 +20,7 @@ The constructor accepts two arguments: ``` Usage: custom-objects-exporter [options] -Export custom objects from the commercetools platform +Export custom objects from commercetools Composable Commerce Options: --help Show help text. [boolean] diff --git a/docs/cli/custom-objects-importer.md b/docs/cli/custom-objects-importer.md index 9d95f44d4..530b30711 100644 --- a/docs/cli/custom-objects-importer.md +++ b/docs/cli/custom-objects-importer.md @@ -1,6 +1,6 @@ # Custom Objects Importer -This package helps with importing [commercetools custom objects](https://docs.commercetools.com/http-api-projects-custom-objects.html) in JSON format to the [commercetools platform](https://docs.commercetools.com/). +This package helps with importing [Composable Commerce custom objects](https://docs.commercetools.com/http-api-projects-custom-objects.html) in JSON format to [commercetools Composable Commerce](https://docs.commercetools.com/). The package is built to be used in conjunction with [sphere-node-cli](https://github.com/sphereio/sphere-node-cli) ## Configuration @@ -8,7 +8,7 @@ The package is built to be used in conjunction with [sphere-node-cli](https://gi The constructor accepts five arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `accessToken` (String): Access token to be used to authenticate requests to API. Requires scope of [`view_products`, `view_orders`, `view_customers`, `manage_products`, `manage_orders`, `manage_customers`]. - `batchSize` (Number): Amount of custom objects to process concurrently (Optional. Default: 50) - `continueOnProblems` (Boolean): Flag whether to continue processing if an error occurs (Optional. Default: false) diff --git a/docs/cli/customer-groups-exporter.md b/docs/cli/customer-groups-exporter.md index 65d4c195a..d897f76d1 100644 --- a/docs/cli/customer-groups-exporter.md +++ b/docs/cli/customer-groups-exporter.md @@ -1,13 +1,13 @@ # Customer Groups Exporter -A package which exports [commercetools customer groups](https://docs.commercetools.com/http-api-projects-customerGroups.html) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/). +A package which exports [Composable Commerce customer groups](https://docs.commercetools.com/http-api-projects-customerGroups.html) in `JSON` format from [commercetools Composable Commerce](https://docs.commercetools.com/). ## Configuration The constructor accepts two arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows) - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional) - An optional logger object having four functions (`info`, `warn`, `error` and `debug`) @@ -20,7 +20,7 @@ The constructor accepts two arguments: ``` Usage: customer-groups-exporter [options] -Export customer groups from the commercetools platform +Export customer groups from commercetools Composable Commerce Options: --help Show help text. [boolean] diff --git a/docs/cli/discount-code-exporter.md b/docs/cli/discount-code-exporter.md index 0c04962c3..b5fb1ca22 100644 --- a/docs/cli/discount-code-exporter.md +++ b/docs/cli/discount-code-exporter.md @@ -1,13 +1,13 @@ # Discount Code Exporter -A package that helps with exporting [commercetools discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) in `JSON` or `CSV` format from the [commercetools platform](https://docs.commercetools.com/). +A package that helps with exporting [Composable Commerce discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) in `JSON` or `CSV` format from [commercetools Composable Commerce](https://docs.commercetools.com/). ## Configuration The constructor accepts two arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `batchSize` (Number): Amount of codes not more than 500 to process concurrently (Optional. Default: 500) - `language` (String): Language used for localised fields if no template is given (Optional. Default: `'en'`) - `accessToken` (String): Access token to be used to authenticate requests to API. Requires scope of [`view_orders`] @@ -28,7 +28,7 @@ The constructor accepts two arguments: ``` Usage: bin/discount-code-exporter.js [options] -Export discount codes from the commercetools platform. +Export discount codes from commercetools Composable Commerce. Options: --help, -h Show help text. [boolean] diff --git a/docs/cli/discount-code-generator.md b/docs/cli/discount-code-generator.md index 0732632dc..fd50b1d38 100644 --- a/docs/cli/discount-code-generator.md +++ b/docs/cli/discount-code-generator.md @@ -1,6 +1,6 @@ # Discount Code Generator -Generate unique discount codes to be imported to the [commercetools platform](https://docs.commercetools.com/). See usage below +Generate unique discount codes to be imported to [commercetools Composable Commerce](https://docs.commercetools.com/). See usage below ## Usage diff --git a/docs/cli/discount-code-importer.md b/docs/cli/discount-code-importer.md index 3a611aed8..d22b253a2 100644 --- a/docs/cli/discount-code-importer.md +++ b/docs/cli/discount-code-importer.md @@ -1,6 +1,6 @@ # Discount Code Importer -A package that helps with importing [commercetools discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) in JSON format to the [commercetools platform](https://docs.commercetools.com/). +A package that helps with importing [Composable Commerce discount codes](https://docs.commercetools.com/http-api-projects-discountCodes.html) in JSON format to [commercetools Composable Commerce](https://docs.commercetools.com/). This package is built to be used in conjunction with [sphere-node-cli](https://github.com/sphereio/sphere-node-cli) ## Configuration @@ -8,7 +8,7 @@ This package is built to be used in conjunction with [sphere-node-cli](https://g The constructor accepts two arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `accessToken` (String): Access token to be used to authenticate requests to API. Requires scope of [`manage_orders`] - `batchSize` (Number): Amount of codes not more than 500 to process concurrently (Optional. Default: 50) - `continueOnProblems` (Boolean): Flag whether to continue processing if an error occurs (Optional. Default: false) diff --git a/docs/cli/inventories-exporter.md b/docs/cli/inventories-exporter.md index dff16e507..81bbe1b6d 100644 --- a/docs/cli/inventories-exporter.md +++ b/docs/cli/inventories-exporter.md @@ -1,12 +1,12 @@ # Inventories Exporter -This package helps in exporting [inventories](https://docs.commercetools.com/http-api-projects-inventory.html) from the commercetools platform in `csv` and `json` format +This package helps in exporting [inventories](https://docs.commercetools.com/http-api-projects-inventory.html) from commercetools Composable Commerce in `csv` and `json` format ## Configuration The constructor accepts four arguments: -- `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) +- `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - An optional logger object having four methods (`info`, `warn`, `error` and `verbose`) - `exportConfig` (Object): Internal Export configurations - `delimiter` (Object): CSV delimiter @@ -25,7 +25,7 @@ npm install @commercetools/inventories-exporter --global ``` Usage: inventoriesexporter [options] -Export inventories from the commercetools platform. +Export inventories from commercetools Composable Commerce. Options: --help, -h Show help text. [boolean] diff --git a/docs/cli/personal-data-erasure.md b/docs/cli/personal-data-erasure.md index 55d739f4d..8b475b8b9 100644 --- a/docs/cli/personal-data-erasure.md +++ b/docs/cli/personal-data-erasure.md @@ -1,6 +1,6 @@ # Personal Data Erasure -A package which deletes or exports [commercetools personal data](#list-of-personal-data) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/). +A package which deletes or exports [personal data](#list-of-personal-data) in `JSON` format from [commercetools Composable Commerce](https://docs.commercetools.com/). ## List of personal data @@ -16,7 +16,7 @@ A package which deletes or exports [commercetools personal data](#list-of-person The constructor accepts two arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`view_products`, `manage_products`, `view_orders`, `manage_orders`, `view_payments`, `manage_payments`, `view_shopping_lists`, `manage_shopping_lists`, `view_customers`, `manage_customers`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows) - An optional logger object having four functions (`info`, `warn`, `error` and `debug`) diff --git a/docs/cli/price-exporter.md b/docs/cli/price-exporter.md index 1f1b413da..cc24bbe00 100644 --- a/docs/cli/price-exporter.md +++ b/docs/cli/price-exporter.md @@ -1,13 +1,13 @@ # Price Exporter -A package that helps with exporting [commercetools price](https://docs.commercetools.com/http-api-projects-products.html#price) in `JSON` or `CSV` format from the [commercetools platform](https://docs.commercetools.com/). +A package that helps with exporting [Composable Commerce price](https://docs.commercetools.com/http-api-projects-products.html#price) in `JSON` or `CSV` format from [commercetools Composable Commerce](https://docs.commercetools.com/). ## Configuration The constructor accepts two arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `accessToken` (String): Access token to be used to authenticate requests to API. Requires scope of [`view_orders`] - `delimiter` (String): CSV delimiter (Optional. Default: `','`) - `exportFormat` (String): Export format ['csv', 'json'] (Optional. Default: 'json') @@ -24,7 +24,7 @@ The constructor accepts two arguments: ``` Usage: price-exporter [options] -Export prices from the commercetools platform. +Export prices from commercetools Composable Commerce. Options: --help, -h Show help text. [boolean] @@ -104,7 +104,7 @@ You can export the custom field by passing in a header file like below customType,customField.foo,customField.localized.de,customField.localized.en ``` -The CSV exported is compatible with the [csv-parser-price](https://commercetools.github.io/nodejs/cli/csv-parser-price.html) module, and can be used to import exported prices to the CTP platform. +The CSV exported is compatible with the [csv-parser-price](https://commercetools.github.io/nodejs/cli/csv-parser-price.html) module, and can be used to import exported prices to the CTP API. ### JS diff --git a/docs/cli/product-exporter.md b/docs/cli/product-exporter.md index 0e3276904..c33c0e45e 100644 --- a/docs/cli/product-exporter.md +++ b/docs/cli/product-exporter.md @@ -1,13 +1,13 @@ # Product Exporter -A package that helps with exporting [commercetools products](https://docs.commercetools.com/http-api-projects-productProjections.html#productprojection) from the [commercetools platform](http://dev.commercetools.com/). +A package that helps with exporting [Composable Commerce products](https://docs.commercetools.com/http-api-projects-productProjections.html#productprojection) from [commercetools Composable Commerce](http://dev.commercetools.com/). The products can be exported in JSON format, or as chunks that can be piped to a parser for more export formats. ## Configuration The constructor accepts four arguments: -- `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) +- `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `exportConfig` (Object): Internal Export configurations - `batch` (Number): Amount of products to fetch for each API call - `expand` (Array): An array of strings signifying reference fields to expand in the returned product @@ -26,7 +26,7 @@ The constructor accepts four arguments: ``` Usage: product-exporter [options] -Export products from the commercetools platform +Export products from commercetools Composable Commerce Options: --help, -h Show help text. [boolean] diff --git a/docs/cli/product-json-to-csv.md b/docs/cli/product-json-to-csv.md index 4e80bea64..57964ffb8 100644 --- a/docs/cli/product-json-to-csv.md +++ b/docs/cli/product-json-to-csv.md @@ -1,6 +1,6 @@ # Product JSON to CSV Parser -A package that parses [commercetools products](https://docs.commercetools.com/http-api-projects-products.html#product) JSON data to CSV. +A package that parses [commercetools Composable Commerce products](https://docs.commercetools.com/http-api-projects-products.html#product) JSON data to CSV. The products to be parsed can either be read from a `.json` file or directly [piped in](http://www.gnu.org/software/bash/manual/bash.html#Pipelines) from the [product exporter](https://commercetools.github.io/nodejs/cli/product-exporter.html). ## Usage @@ -11,7 +11,7 @@ The products to be parsed can either be read from a `.json` file or directly [pi ``` Usage: product-json-to-csv [options] -Convert commercetools products from JSON to CSV +Convert commercetools Composable Commerce products from JSON to CSV Options: --help, -h Show help [boolean] @@ -59,7 +59,7 @@ The products to be parsed from JSON to CSV can be passed to this module in one o #### Pass products through a pipe -Piping products in JSON to be parsed. This ideally works with the commercetools product exporter. In this scenario, the products are parsed directly after export. More information on pipe streams can be found [here](http://www.gnu.org/software/bash/manual/bash.html#Pipelines) +Piping products in JSON to be parsed. This ideally works with the commercetools Composable Commerce product exporter. In this scenario, the products are parsed directly after export. More information on pipe streams can be found [here](http://www.gnu.org/software/bash/manual/bash.html#Pipelines) ##### Example @@ -120,7 +120,7 @@ For more direct usage, it is possible to use this module directly The constructor accepts four arguments: -- `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) +- `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `parserConfig` (Object): Internal Parse configurations - `categoryBy` (String): Specify which identifier should be used to reference the categories (Options: `name`, `key`, `externalId` and `namedPath`. Default: `name`) - `categoryOrderHintBy` (String): Specify which identifier should be used to reference the categoryOrderHints (Options: `name`, `key`, `externalId` and `namedPath`. Default: `name`) diff --git a/docs/cli/product-json-to-xlsx.md b/docs/cli/product-json-to-xlsx.md index 99dc62aa9..4662c915f 100644 --- a/docs/cli/product-json-to-xlsx.md +++ b/docs/cli/product-json-to-xlsx.md @@ -1,6 +1,6 @@ # Product JSON to XLSX Parser -A package that parses [commercetools products](https://docs.commercetools.com/http-api-projects-products.html#product) JSON data to XLSX. +A package that parses [commercetools Composable Commerce products](https://docs.commercetools.com/http-api-projects-products.html#product) JSON data to XLSX. The products to be parsed can either be read from a `.json` file or directly [piped in](http://www.gnu.org/software/bash/manual/bash.html#Pipelines) from the [product exporter](https://commercetools.github.io/nodejs/cli/product-exporter.html). ## Usage @@ -11,7 +11,7 @@ The products to be parsed can either be read from a `.json` file or directly [pi ``` Usage: product-json-to-xlsx [options] -Convert commercetools products from JSON to XLSX +Convert commercetools Composable Commerce products from JSON to XLSX Options: --help, -h Show help [boolean] @@ -57,7 +57,7 @@ The products to be parsed from JSON to XLSX can be passed to this module in one #### Pass products through a pipe -Piping products in JSON to be parsed. This ideally works with the commercetools product exporter. In this scenario, the products are parsed directly after export. More information on pipe streams can be found [here](http://www.gnu.org/software/bash/manual/bash.html#Pipelines) +Piping products in JSON to be parsed. This ideally works with the commercetools Composable Commerce product exporter. In this scenario, the products are parsed directly after export. More information on pipe streams can be found [here](http://www.gnu.org/software/bash/manual/bash.html#Pipelines) ##### Example @@ -108,7 +108,7 @@ For more direct usage, it is possible to use this module directly The constructor accepts four arguments: -- `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) +- `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `parserConfig` (Object): Internal Parse configurations - `categoryBy` (String): Specify which identifier should be used to reference the categories (Options: `name`, `key`, `externalId` and `namedPath`. Default: `name`) - `categoryOrderHintBy` (String): Specify which identifier should be used to reference the categoryOrderHints (Options: `name`, `key`, `externalId` and `namedPath`. Default: `name`) diff --git a/docs/cli/resource-deleter.md b/docs/cli/resource-deleter.md index 8a3dcbb02..6cef3e405 100644 --- a/docs/cli/resource-deleter.md +++ b/docs/cli/resource-deleter.md @@ -1,6 +1,6 @@ # Resource Deleter -A package which deletes resources from the [commercetools platform](https://docs.commercetools.com/). +A package which deletes resources from [commercetools Composable Commerce](https://docs.commercetools.com/). Examples of the resources are : @@ -29,7 +29,7 @@ Examples of the resources are : The constructor accepts two arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)). + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)). - `accessToken` (String): [Access token] to be used to authenticate requests to API. Requires scope of [`manage_products`, `manage_customers`, `manage_types`]. More info on how to get the access token [here](https://docs.commercetools.com/http-api-authorization.html#authorization-flows). - `resource` (String): [resource] that need to be deleted. - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api.html#predicates) (Optional). @@ -43,7 +43,7 @@ The constructor accepts two arguments: ``` Usage: resource-deleter [options] -Delete resource from the commercetools platform. +Delete resource from commercetools Composable Commerce. Options: --help Show help text. [boolean] diff --git a/docs/cli/state-importer.md b/docs/cli/state-importer.md index 1aea6bc30..aaa4134f0 100644 --- a/docs/cli/state-importer.md +++ b/docs/cli/state-importer.md @@ -1,6 +1,6 @@ # State Importer -A package that helps with importing [commercetools states](https://docs.commercetools.com/http-api-projects-states.html) in JSON format to the [commercetools platform](https://docs.commercetools.com/). +A package that helps with importing [Composable Commerce states](https://docs.commercetools.com/http-api-projects-states.html) in JSON format to [commercetools Composable Commerce](https://docs.commercetools.com/). This package is built to be used in conjunction with [sphere-node-cli](https://github.com/sphereio/sphere-node-cli) ## Configuration @@ -8,7 +8,7 @@ This package is built to be used in conjunction with [sphere-node-cli](https://g The constructor accepts three arguments: - A required object containing the following values: - - `apiConfig` (Object): `AuthMiddleware` options for authentication on the commercetools platform. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) + - `apiConfig` (Object): `AuthMiddleware` options for authentication on commercetools Composable Commerce. (Required. See [here](https://commercetools.github.io/nodejs/sdk/api/sdkMiddlewareAuth.html#named-arguments-options)) - `continueOnProblems` (Boolean): Flag whether to continue processing if an error occurs (Optional. Default: false) - `accessToken` (String): Access token to be used to authenticate requests to API. Requires scope of [`manage_project`] to create and/or update states or [`manage_orders`] to update states - An optional logger object having four functions (`info`, `warn`, `error` and `verbose`) diff --git a/docs/sdk/README.md b/docs/sdk/README.md index c1ab19fa0..c8c048c2f 100644 --- a/docs/sdk/README.md +++ b/docs/sdk/README.md @@ -15,9 +15,9 @@ The SDK is now split into multiple little packages, think about it as a _microse The core of the SDK lies within its [middlewares](/sdk/Middlewares.md) implementation. Middlewares do specific things and can be replaced by other middlewares depending on the use case, allowing many possible combinations. -The [SDK _client_](/sdk/api/README.md#sdk-client) itself is in fact really simple and somehow even agnostic of the specific commercetools platform API that can be used as a generic HTTP client. +The [SDK _client_](/sdk/api/README.md#sdk-client) itself is in fact really simple and somehow even agnostic of the specific commercetools Composable Commerce API that can be used as a generic HTTP client. -If we take a step back and look at the general requirement, at the end we simply want to **execute a request**. It just happens to be that we want to make specific requests to the commercetools platform API but it might be as well any other API. That's where the [middlewares](/sdk/Middlewares.md) come in, which provide the _side effects_ of the given request. +If we take a step back and look at the general requirement, at the end we simply want to **execute a request**. It just happens to be that we want to make specific requests to commercetools Composable Commerce API but it might be as well any other API. That's where the [middlewares](/sdk/Middlewares.md) come in, which provide the _side effects_ of the given request. ## Usage example diff --git a/docs/sdk/api/apiRequestBuilder.md b/docs/sdk/api/apiRequestBuilder.md index 896281b8b..63d31fcfb 100644 --- a/docs/sdk/api/apiRequestBuilder.md +++ b/docs/sdk/api/apiRequestBuilder.md @@ -21,7 +21,7 @@ npm install --save @commercetools/api-request-builder ## `createRequestBuilder(options)` -Creates a _request builder_ that allows to declaratively build a HTTP API request URI for the commercetools platform. +Creates a _request builder_ that allows to declaratively build a HTTP API request URI for commercetools Composable Commerce. #### Arguments @@ -70,7 +70,7 @@ const uri = requestBuilder.productProjections.build() // uri = "/project-key/product-projections" ``` -Default services match the commercetools API using a camel-case convention. +Default services match the commercetools Composable Commerce API using a camel-case convention. | Endpoints | Service | Features | | ---------------------------- | ------------------------------- | ---------------------------------------------------------------- | diff --git a/docs/sdk/api/getCredentials.md b/docs/sdk/api/getCredentials.md index 212cc06de..5bf61e1dd 100644 --- a/docs/sdk/api/getCredentials.md +++ b/docs/sdk/api/getCredentials.md @@ -1,6 +1,6 @@ # `get-credentials` -Retrieve commercetools project credentials from environment variables or file system. +Retrieve Project credentials from environment variables or file system. ## Install diff --git a/docs/sdk/api/sdkAuth.md b/docs/sdk/api/sdkAuth.md index e5bf92954..e9ac32744 100644 --- a/docs/sdk/api/sdkAuth.md +++ b/docs/sdk/api/sdkAuth.md @@ -1,6 +1,6 @@ # `sdk-auth` -Auth module for different [authorization flows](https://docs.commercetools.com/http-api-authorization.html#authorization-flows) of commercetools platform API +Auth module for different [authorization flows](https://docs.commercetools.com/http-api-authorization.html#authorization-flows) of commercetools Composable Commerce API ## Install @@ -21,7 +21,7 @@ npm install --save @commercetools/sdk-auth ## Initialization -Creates an auth client to handle authorization against the commercetools platform API. +Creates an auth client to handle authorization against commercetools Composable Commerce API. #### Named arguments (options) @@ -67,7 +67,7 @@ const token = await authClient.clientCredentialsFlow({ ### Client Credentials Flow -Fetches access token using [Client Credentials Flow](https://docs.commercetools.com/http-api-authorization.html#client-credentials-flow) from the commercetools platform API. +Fetches access token using [Client Credentials Flow](https://docs.commercetools.com/http-api-authorization.html#client-credentials-flow) from commercetools Composable Commerce API. #### Argument @@ -88,7 +88,7 @@ await authClient.clientCredentialsFlow() ### Customer Password Flow -Fetches access token using [Password Flow](https://docs.commercetools.com/http-api-authorization.html#password-flow) from the commercetools platform API. +Fetches access token using [Password Flow](https://docs.commercetools.com/http-api-authorization.html#password-flow) from commercetools Composable Commerce API. #### Argument @@ -151,7 +151,7 @@ await authClient.clientPasswordFlow({ ### Refresh Token Flow -Fetches a new access token using [Refresh Token Flow](https://docs.commercetools.com/http-api-authorization.html#refresh-token-flow) from the commercetools platform API. +Fetches a new access token using [Refresh Token Flow](https://docs.commercetools.com/http-api-authorization.html#refresh-token-flow) from commercetools Composable Commerce API. #### Argument @@ -173,7 +173,7 @@ await authClient.refreshTokenFlow('refreshToken') ### Anonymous Session Flow -Fetches access token using [Anonymous Session Flow](https://docs.commercetools.com/http-api-authorization.html#tokens-for-anonymous-sessions) from the commercetools platform API. +Fetches access token using [Anonymous Session Flow](https://docs.commercetools.com/http-api-authorization.html#tokens-for-anonymous-sessions) from commercetools Composable Commerce API. #### Argument @@ -229,7 +229,7 @@ await authClient.customFlow({ ### Token Introspection -Fetches info about `access_token` using [Token Introspection](https://docs.commercetools.com/http-api-authorization.html#oauth2-token-introspection) from the commercetools platform API. +Fetches info about `access_token` using [Token Introspection](https://docs.commercetools.com/http-api-authorization.html#oauth2-token-introspection) from commercetools Composable Commerce API. #### Argument diff --git a/docs/sdk/api/sdkMiddlewareAuth.md b/docs/sdk/api/sdkMiddlewareAuth.md index cd89bbf43..07d84f953 100644 --- a/docs/sdk/api/sdkMiddlewareAuth.md +++ b/docs/sdk/api/sdkMiddlewareAuth.md @@ -21,7 +21,7 @@ npm install --save @commercetools/sdk-middleware-auth ## `createAuthMiddlewareForClientCredentialsFlow(options)` -Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for the [Client Credentials Flow](https://docs.commercetools.com/http-api-authorization.html#client-credentials-flow) of the commercetools platform API. +Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for the [Client Credentials Flow](https://docs.commercetools.com/http-api-authorization.html#client-credentials-flow) of commercetools Composable Commerce API. #### Named arguments (options) @@ -61,7 +61,7 @@ const client = createClient({ ## `createAuthMiddlewareForPasswordFlow(options)` -Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for the [Password Flow](https://docs.commercetools.com/http-api-authorization.html#password-flow) of the commercetools platform API. +Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for the [Password Flow](https://docs.commercetools.com/http-api-authorization.html#password-flow) of commercetools Composable Commerce API. #### Named arguments (options) @@ -108,7 +108,7 @@ const client = createClient({ ## `createAuthMiddlewareForAnonymousSessionFlow(options)` -Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for the [Anonymous Session Flow](https://docs.commercetools.com/http-api-authorization.html#tokens-for-anonymous-sessions) of the commercetools platform API. +Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for the [Anonymous Session Flow](https://docs.commercetools.com/http-api-authorization.html#tokens-for-anonymous-sessions) of commercetools Composable Commerce API. #### Named arguments (options) @@ -149,7 +149,7 @@ const client = createClient({ ## `createAuthMiddlewareForRefreshTokenFlow(options)` -Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for the [Refresh Token Flow](https://docs.commercetools.com/http-api-authorization.html#refresh-token-flow) of the commercetools platform API. +Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for the [Refresh Token Flow](https://docs.commercetools.com/http-api-authorization.html#refresh-token-flow) of commercetools Composable Commerce API. #### Named arguments (options) diff --git a/docs/sdk/api/sdkMiddlewareHttp.md b/docs/sdk/api/sdkMiddlewareHttp.md index 3e323b61e..a715c0a85 100644 --- a/docs/sdk/api/sdkMiddlewareHttp.md +++ b/docs/sdk/api/sdkMiddlewareHttp.md @@ -21,7 +21,7 @@ npm install --save @commercetools/sdk-middleware-http ## `createHttpMiddleware(options)` -Creates a [middleware](/sdk/Glossary.md#middleware) to handle HTTP requests for the commercetools platform API. +Creates a [middleware](/sdk/Glossary.md#middleware) to handle HTTP requests for commercetools Composable Commerce API. The HTTP middleware can run in either a browser or Node.js environment. For Node.js environments it is important to either have a `fetch` implementation either globally available via e.g. [isomorphic-fetch](https://github.com/matthew-andrews/isomorphic-fetch) or to pass it in as an argument (see below) via e.g. [node-fetch](https://github.com/bitinn/node-fetch). In browsers without a native `fetch` implementation any well known `fetch` polyfill should be compatible with the middleware such as [whatwg-fetch](https://github.com/whatwg/fetch) or [unfetch](https://github.com/developit/unfetch). @@ -42,7 +42,7 @@ The HTTP middleware can run in either a browser or Node.js environment. For Node 13. `fetch` _(Function)_: A `fetch` implementation which can be e.g. `node-fetch` or `unfetch` but also the native browser `fetch` function 14. `timeout` _(Number)_: Request/response timeout in ms. Must be globally available or passed in `AbortController` 15. `abortController` or `getAbortController` depending on what you chose to handle the timeout (_abortController_): This property accepts the `AbortController` instance. Could be [abort-controller](https://www.npmjs.com/package/abort-controller) or a globally available one. -16. `retryConfig` _(Object)_: Field required in the object listed below +16. `retryConfig` _(Object)_: Field required in the object listed below #### Retrying requests @@ -73,12 +73,7 @@ const client = createClient({ retryDelay: 300, //milliseconds maxDelay: 5000, //milliseconds retryOnAbort: false, - retryCodes: [ - 504, - 'ETIMEDOUT', - 'ECONNREFUSED', - 503 - ] + retryCodes: [504, 'ETIMEDOUT', 'ECONNREFUSED', 503], }, // Optional if not globally available diff --git a/docs/sdk/api/syncActions.md b/docs/sdk/api/syncActions.md index 1c5295cde..59ed25f26 100644 --- a/docs/sdk/api/syncActions.md +++ b/docs/sdk/api/syncActions.md @@ -714,7 +714,7 @@ client.execute(statesRequests) Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API update actions for [_types_](https://docs.commercetools.com/http-api-projects-types.html). -**Please note** that there is no `remove action` for `enum` values. So this package will comply with the [platform](https://docs.commercetools.com/http-api-projects-types.html#add-enumvalue-to-fielddefinition) and only generate `changeOrder` and `add` actions for any `enum`. +**Please note** that there is no `remove action` for `enum` values. So this package will comply with the [API](https://docs.commercetools.com/http-api-projects-types.html#add-enumvalue-to-fielddefinition) and only generate `changeOrder` and `add` actions for any `enum`. #### Arguments diff --git a/docs/sdk/api/typescriptSdk.md b/docs/sdk/api/typescriptSdk.md index 508814b9e..b9171a97b 100644 --- a/docs/sdk/api/typescriptSdk.md +++ b/docs/sdk/api/typescriptSdk.md @@ -5,7 +5,7 @@ Follow this [link](https://docs.commercetools.com/sdk/javascript-sdk) for an up