From dec6e9bd6a2c27558a391634af732665d371e3ac Mon Sep 17 00:00:00 2001 From: Stephen Armstrong <77231096+industrian@users.noreply.github.com> Date: Wed, 16 Oct 2024 08:33:41 +0100 Subject: [PATCH] Update broken links to commercetools docs (#1918) * Test add change * Update links in docs * Minor changes --- docs/cli/category-exporter.md | 8 ++++---- docs/cli/csv-parser-discount-code.md | 2 +- docs/cli/csv-parser-orders.md | 2 +- docs/cli/csv-parser-price.md | 2 +- docs/cli/csv-parser-state.md | 2 +- docs/cli/custom-objects-exporter.md | 8 ++++---- docs/cli/custom-objects-importer.md | 2 +- docs/cli/customer-groups-exporter.md | 8 ++++---- docs/cli/discount-code-exporter.md | 6 +++--- docs/cli/discount-code-importer.md | 2 +- docs/cli/inventories-exporter.md | 4 ++-- docs/cli/personal-data-erasure.md | 2 +- docs/cli/price-exporter.md | 6 +++--- docs/cli/product-exporter.md | 8 ++++---- docs/cli/product-json-to-csv.md | 2 +- docs/cli/product-json-to-xlsx.md | 2 +- docs/cli/resource-deleter.md | 6 +++--- docs/cli/state-importer.md | 2 +- docs/sdk/api/apiRequestBuilder.md | 6 +++--- docs/sdk/api/sdkAuth.md | 14 +++++++------- docs/sdk/api/sdkMiddlewareAuth.md | 14 +++++++------- docs/sdk/api/syncActions.md | 10 +++++----- docs/sdk/api/typescriptSdk.md | 2 +- packages/category-exporter/readme.md | 2 +- packages/csv-parser-discount-code/readme.md | 2 +- packages/csv-parser-orders/readme.md | 2 +- packages/csv-parser-price/readme.md | 2 +- packages/csv-parser-state/readme.md | 2 +- packages/custom-objects-exporter/readme.md | 2 +- packages/custom-objects-importer/readme.md | 2 +- packages/customer-groups-exporter/readme.md | 2 +- packages/discount-code-importer/readme.md | 2 +- packages/price-exporter/readme.md | 2 +- packages/product-exporter/readme.md | 2 +- packages/product-json-to-csv/readme.md | 2 +- packages/product-json-to-xlsx/readme.md | 2 +- packages/resource-deleter/readme.md | 2 +- packages/state-importer/readme.md | 2 +- 38 files changed, 75 insertions(+), 75 deletions(-) diff --git a/docs/cli/category-exporter.md b/docs/cli/category-exporter.md index 13b39a438..f1836fedd 100644 --- a/docs/cli/category-exporter.md +++ b/docs/cli/category-exporter.md @@ -1,6 +1,6 @@ # 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 [commercetools categories](https://docs.commercetools.com/api/projects/categories) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/). ## Configuration @@ -8,8 +8,8 @@ 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)) - - `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) + - `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/api/authorization) + - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional) - An optional logger object having four functions (`info`, `warn`, `error` and `debug`) ## Usage @@ -47,7 +47,7 @@ Options: - If the file specified already exists, it will be overwritten. - The default location for status report logging is the standard output. - If no output path is specified, the exported categories will be logged to the standard output as a result, status reports will be logged to a `category-exporter.log` file in the current directory. -- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) +- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query) ### JS diff --git a/docs/cli/csv-parser-discount-code.md b/docs/cli/csv-parser-discount-code.md index 62eef2b3b..8dac5c9b0 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 discount codes](https://docs.commercetools.com/api/projects/discountCodes) CSV data to JSON. See example below for CSV format, sample response and usage. ## Usage diff --git a/docs/cli/csv-parser-orders.md b/docs/cli/csv-parser-orders.md index f66979c1f..91aa44884 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 order](https://docs.commercetools.com/api/projects/orders) CSV data to JSON. See examples below for supported CSV format and sample responses. ## Usage diff --git a/docs/cli/csv-parser-price.md b/docs/cli/csv-parser-price.md index 0c407136b..bc87b39b2 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 price](https://docs.commercetools.com/api/types#price) CSV data to JSON. See example below for CSV format and sample response ## Usage diff --git a/docs/cli/csv-parser-state.md b/docs/cli/csv-parser-state.md index 3a7de23d1..46978b9e2 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 states](https://docs.commercetools.com/api/projects/states#state) CSV data to JSON. See example below for CSV format, sample response and usage. ## Usage diff --git a/docs/cli/custom-objects-exporter.md b/docs/cli/custom-objects-exporter.md index 15ab5f164..37e91f377 100644 --- a/docs/cli/custom-objects-exporter.md +++ b/docs/cli/custom-objects-exporter.md @@ -1,6 +1,6 @@ # 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 [commercetools custom objects](https://docs.commercetools.com/api/projects/custom-objects) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/). ## Configuration @@ -8,8 +8,8 @@ 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)) - - `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) + - `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/api/authorization) + - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional) - An optional logger object having four functions (`info`, `warn`, `error` and `debug`) ## Usage @@ -46,7 +46,7 @@ Options: - If the file specified already exists, it will be overwritten. - The default location for status report logging is the standard output. - If no output path is specified, the exported objects will be logged to the standard output as a result, status reports will be logged to a `custom-objects-export.log` file in the current directory. -- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) +- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query) ### JS diff --git a/docs/cli/custom-objects-importer.md b/docs/cli/custom-objects-importer.md index 9d95f44d4..4fa4f4cf5 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 [commercetools custom objects](https://docs.commercetools.com/api/projects/custom-objects) in JSON format to the [commercetools platform](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 diff --git a/docs/cli/customer-groups-exporter.md b/docs/cli/customer-groups-exporter.md index 65d4c195a..cad12f6bd 100644 --- a/docs/cli/customer-groups-exporter.md +++ b/docs/cli/customer-groups-exporter.md @@ -1,6 +1,6 @@ # 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 [commercetools customer groups](https://docs.commercetools.com/api/projects/customerGroups) in `JSON` format from the [commercetools platform](https://docs.commercetools.com/). ## Configuration @@ -8,8 +8,8 @@ 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)) - - `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) + - `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/api/authorization) + - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional) - An optional logger object having four functions (`info`, `warn`, `error` and `debug`) ## Usage @@ -46,7 +46,7 @@ Options: - If the file specified already exists, it will be overwritten. - The default location for status report logging is the standard output. - If no output path is specified, the exported groups will be logged to the standard output as a result, status reports will be logged to a `customer-groups-export.log` file in the current directory. -- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) +- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query) ### JS diff --git a/docs/cli/discount-code-exporter.md b/docs/cli/discount-code-exporter.md index 0c04962c3..8e3d938db 100644 --- a/docs/cli/discount-code-exporter.md +++ b/docs/cli/discount-code-exporter.md @@ -1,6 +1,6 @@ # 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 [commercetools discount codes](https://docs.commercetools.com/api/projects/discountCodes) in `JSON` or `CSV` format from the [commercetools platform](https://docs.commercetools.com/). ## Configuration @@ -14,7 +14,7 @@ The constructor accepts two arguments: - `delimiter` (String): CSV delimiter (Optional. Default: `','`) - `multiValueDelimiter` (String): CSV delimiter used in multivalue fields (Optional. Default: `';'`) - `exportFormat` (String): Export format ['csv', 'json'] (Optional. Default: 'json') - - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional) + - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional) - `fields` (Array): An array of column names the exported CSV file should contain. This fields array should contain the required columns of the CSV file (Optional. If omitted, a default set of column fields is used. Currently, these fields are: `name`, `description`, `code`, `cartDiscounts`,`cartPredicate`,`groups`,`isActive`,`validFrom`,`validUntil`,`references`,`maxApplications`,`maxApplicationsPerCustomer`. The localised fields (`name` and `description` default to the language specified in the `language` value above. This is synonymous with the `--template` flag in the CLI) @@ -66,7 +66,7 @@ Options: - If no output path is specified, the exported codes will be logged to the standard output as a result, status reports will be logged to a `discount-code-export.log` file in the current directory. - The `--delimiter` flag specifies the delimiter used in the output file if CSV. Defaults to `','` if omitted. - The `--multiValueDelimiter` flag specifies the delimiter for multiValue cells in the output file if CSV. Defaults to `';'` if omitted. -- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) +- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query) ### JS diff --git a/docs/cli/discount-code-importer.md b/docs/cli/discount-code-importer.md index 3a611aed8..cf2b46f02 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 [commercetools discount codes](https://docs.commercetools.com/api/projects/discountCodes) in JSON format to the [commercetools platform](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 diff --git a/docs/cli/inventories-exporter.md b/docs/cli/inventories-exporter.md index dff16e507..865056b47 100644 --- a/docs/cli/inventories-exporter.md +++ b/docs/cli/inventories-exporter.md @@ -1,6 +1,6 @@ # 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/api/projects/inventory) from the commercetools platform in `csv` and `json` format ## Configuration @@ -43,7 +43,7 @@ Options: Can be used with the query flag --query, -q Filter query for stocks: - https://docs.commercetools.com/http-api-projects-inventory.html#query-inventory + https://docs.commercetools.com/api/projects/inventory#query-inventory can be used with channelKey flag --template, -t Path to a CSV template file with headers which should be diff --git a/docs/cli/personal-data-erasure.md b/docs/cli/personal-data-erasure.md index 492c428c2..96918e455 100644 --- a/docs/cli/personal-data-erasure.md +++ b/docs/cli/personal-data-erasure.md @@ -17,7 +17,7 @@ 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)) - - `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) + - `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/api/authorization) - An optional logger object having four functions (`info`, `warn`, `error` and `debug`) ## Usage diff --git a/docs/cli/price-exporter.md b/docs/cli/price-exporter.md index 1f1b413da..0c94681e5 100644 --- a/docs/cli/price-exporter.md +++ b/docs/cli/price-exporter.md @@ -1,6 +1,6 @@ # 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 [commercetools price](https://docs.commercetools.com/api/types#price) in `JSON` or `CSV` format from the [commercetools platform](https://docs.commercetools.com/). ## Configuration @@ -11,7 +11,7 @@ The constructor accepts two arguments: - `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') - - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional) + - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional) - `staged` (Boolean): Specify if prices should be fetched from all products (true) or only published products (false) (Optional. Default: false) - `csvHeaders` (Array): Array containing headers for the returned CSV price data. If omitted, all headers will be turned. (Optional) - An optional logger object having four functions (`info`, `warn`, `error` and `verbose`) @@ -59,7 +59,7 @@ Options: - The default location for status report logging is the standard output. - If no output path is specified, the exported prices will be logged to the standard output. - The `--delimiter` flag specifies the delimiter used in the input and output file if CSV. Defaults to `','` if omitted. -- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate is on the products containing the prices (`product-proections` endpoint) and not on the prices themselves. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) +- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate is on the products containing the prices (`product-proections` endpoint) and not on the prices themselves. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query) - The `--staged` flag specifies the projection of the products from which the prices should be fetched. - If passed `true`, prices from published and unpublished products are retrieved - If passed `false` (or omitted), only prices from published products are retrieved diff --git a/docs/cli/product-exporter.md b/docs/cli/product-exporter.md index 6d30fed74..24e3dbcec 100644 --- a/docs/cli/product-exporter.md +++ b/docs/cli/product-exporter.md @@ -1,6 +1,6 @@ # 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 [commercetools products](https://docs.commercetools.com/api/projects/productProjections) from the [commercetools platform](https://docs.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 @@ -12,7 +12,7 @@ The constructor accepts four arguments: - `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 - `json` (Boolean): Specify if products returned should be in JSON file format. If set to false, the products will be output in chunks (Default: true) - - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) (Optional) + - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional) - `staged` (Boolean): Specify if prices should be fetched from all products (true) or only published products (false) (Optional. Default: false) - `total` (Number): The total number of products to fetch - An optional logger object having four methods (`info`, `warn`, `error` and `debug`) @@ -63,8 +63,8 @@ Options: - If the file specified already exists, it will be overwritten. - The default location for status report logging is the standard output. - If no output path is specified, the exported products will be logged to the standard output. -- The `--predicate` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api-query-predicates) -- The `--expand` flag specifies the Reference or References to expand in the returned products. The required references for expansion should be passed in as normal strings separated by a space. More information about reference expansion can be found [here](https://docs.commercetools.com/http-api.html#reference-expansion) +- The `--predicate` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query) +- The `--expand` flag specifies the Reference or References to expand in the returned products. The required references for expansion should be passed in as normal strings separated by a space. More information about reference expansion can be found [here](https://docs.commercetools.com/api/general-concepts#reference-expansion) - The `--exportType` flag specifies if products returned should be in JSON file format or chunks. The chunk output is particularly useful if a different output format is desired (such as CSV), in which case, the chunks can be piped to a parser to get the desired format. - The `--staged` flag specifies the projection of the products to be fetched. - If passed `true`, published and unpublished products are retrieved diff --git a/docs/cli/product-json-to-csv.md b/docs/cli/product-json-to-csv.md index 4e80bea64..9619e1715 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 products](https://docs.commercetools.com/api/projects/products#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 diff --git a/docs/cli/product-json-to-xlsx.md b/docs/cli/product-json-to-xlsx.md index 99dc62aa9..ed84d4eb2 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 products](https://docs.commercetools.com/api/projects/products#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 diff --git a/docs/cli/resource-deleter.md b/docs/cli/resource-deleter.md index 028ee97a4..a5515c283 100644 --- a/docs/cli/resource-deleter.md +++ b/docs/cli/resource-deleter.md @@ -30,9 +30,9 @@ 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)). - - `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). + - `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/api/authorization). - `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). + - `predicate` (String): Query string specifying (where) predicate. More info on predicates [here](https://docs.commercetools.com/api/predicates/query) (Optional). - An optional logger object having four functions (`info`, `warn`, `error` and `debug`). ## Usage @@ -83,7 +83,7 @@ Then you can delete resource using the cli: - The `--output` flag specifies where to output the deleted resource. Several notes on this flag: - The default location for status report logging is the standard output. - If no output path is specified, the deleted resource output will be logged to the standard output as a result, status reports will be logged to a `resource-deleter.log` file in the current directory. -- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/http-api.html#predicates). +- The `where` flag specifies an optional (where) query predicate to be included in the request. This predicate should be wrapped in single quotes ('single quoted predicate'). More info on predicates [here](https://docs.commercetools.com/api/predicates/query). ### JS diff --git a/docs/cli/state-importer.md b/docs/cli/state-importer.md index 1aea6bc30..8e48459af 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 [commercetools states](https://docs.commercetools.com/api/projects/states) in JSON format to the [commercetools platform](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 diff --git a/docs/sdk/api/apiRequestBuilder.md b/docs/sdk/api/apiRequestBuilder.md index 896281b8b..63ce640ab 100644 --- a/docs/sdk/api/apiRequestBuilder.md +++ b/docs/sdk/api/apiRequestBuilder.md @@ -118,7 +118,7 @@ Note that `markMatchingVariants` is set by default to `false` which turns off th #### Staged -It is possible to add the `staged` boolean option to the uri. This decides wether to query the `current` or `staged` projections, for example in [Product Projections](https://docs.commercetools.com/http-api-projects-productProjections.html#product-projections). (Defaults to **false**) +It is possible to add the `staged` boolean option to the uri. This decides wether to query the `current` or `staged` projections, for example in [Product Projections](https://docs.commercetools.com/api/projects/productProjections). (Defaults to **false**) ```js const service = createRequestBuilder(options) @@ -154,7 +154,7 @@ const uri = requestBuilder.carts.byCustomerId('customerId').build() #### dataErasure -You can also append the `dataErasure` option to the uri when making a delete request if you want to make sure all related data is deleted. For example, regarding the GDPR, this means that all personal data related to the particular object, including invisible data, is erased. [More info here](https://docs.commercetools.com/release-notes#releases-2018-05-24-data-erasure) +You can also append the `dataErasure` option to the uri when making a delete request if you want to make sure all related data is deleted. For example, regarding the GDPR, this means that all personal data related to the particular object, including invisible data, is erased. [More info here](https://docs.commercetools.com/api/releases/2018-05-24-data-erasure) This can be done by using the `.withFullDataErasure()` method. @@ -169,7 +169,7 @@ const deleteUri = service.payments #### withTotal -You can also append the `withTotal` option to the uri when making a query. [More info here](https://docs.commercetools.com/http-api#pagedqueryresult). +You can also append the `withTotal` option to the uri when making a query. [More info here](https://docs.commercetools.com/api/general-concepts#pagedqueryresult). This can be done by using the `.withTotal(false)` method. diff --git a/docs/sdk/api/sdkAuth.md b/docs/sdk/api/sdkAuth.md index e5bf92954..286ad0916 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/api/authorization) of commercetools platform API ## Install @@ -31,7 +31,7 @@ Creates an auth client to handle authorization against the commercetools platfor 4. `token` _(String)_: A `token` which will be sent in `Authorization` header. If not provided, we calculate it from credentials. 5. `disableRefreshToken` _(boolean)_: whether the API should generate a refresh token 6. `credentials` _(Object)_: the client credentials for authentication (`clientId`, `clientSecret`) -7. `scopes` _(Array)_: a list of [scopes](https://docs.commercetools.com/http-api-authorization.html#scopes) (default `manage_project:{projectKey}`) to assign to the OAuth token +7. `scopes` _(Array)_: a list of [scopes](https://docs.commercetools.com/api/scopes) (default `manage_project:{projectKey}`) to assign to the OAuth token 8. `fetch` _(Function)_: A `fetch` implementation which can be e.g. `node-fetch` or `unfetch` but also the native browser `fetch` function. Only needs be be passed if not globally available (e.g. through `isomorphic-fetch`) #### Usage example @@ -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/api/authorization#client-credentials-flow) from the commercetools platform 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/api/authorization#password-flow) from the commercetools platform 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/api/authorization#refresh-token-flow) from the commercetools platform 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/api/authorization#tokens-for-anonymous-sessions) from the commercetools platform 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/api/authorization#introspection) from the commercetools platform API. #### Argument diff --git a/docs/sdk/api/sdkMiddlewareAuth.md b/docs/sdk/api/sdkMiddlewareAuth.md index cd89bbf43..796ea7462 100644 --- a/docs/sdk/api/sdkMiddlewareAuth.md +++ b/docs/sdk/api/sdkMiddlewareAuth.md @@ -21,14 +21,14 @@ 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/api/authorization#client-credentials-flow) of the commercetools platform API. #### Named arguments (options) 1. `host` _(String)_: the host of the OAuth API service 2. `projectKey` _(String)_: the key of the project to assign the default scope to 3. `credentials` _(Object)_: the client credentials for authentication (`clientId`, `clientSecret`) -4. `scopes` _(Array)_: a list of [scopes](https://docs.commercetools.com/http-api-authorization.html#scopes) (default `manage_project:{projectKey}`) to assign to the OAuth token +4. `scopes` _(Array)_: a list of [scopes](https://docs.commercetools.com/api/scopes) (default `manage_project:{projectKey}`) to assign to the OAuth token 5. `fetch` _(Function)_: A `fetch` implementation which can be e.g. `node-fetch` or `unfetch` but also the native browser `fetch` function. Only needs be be passed if not globally available (e.g. through `isomorphic-fetch`) 6. `timeout` _(Number)_: An optional number value (in milliseconds) which specifies when a request should timeout if authentication request fails to complete. 7. `getAbortController` _(Function)_: An optional abortController class instance that should signal the http-client to abandon the current request instance. @@ -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/api/authorization#password-flow) of the commercetools platform API. #### Named arguments (options) @@ -71,7 +71,7 @@ Creates a [middleware](/sdk/Glossary.md#middleware) to handle authentication for - The `user` field is an object containing `username` and `password`. [Sample below](#usage-example-1) -4. `scopes` _(Array)_: a list of [scopes](https://docs.commercetools.com/http-api-authorization.html#scopes) to assign to the OAuth token. _No default scope is sent_ +4. `scopes` _(Array)_: a list of [scopes](https://docs.commercetools.com/api/scopes) to assign to the OAuth token. _No default scope is sent_ 5. `fetch` _(Function)_: A `fetch` implementation which can be e.g. `node-fetch` or `unfetch` but also the native browser `fetch` function. Only needs be be passed if not globally available (e.g. through `isomorphic-fetch`) 6. `timeout` _(Number)_: An optional number value (in milliseconds) which specifies when a request should timeout if authentication request fails to complete. 7. `getAbortController` _(Function)_: An optional abortController class instance that should signal the http-client to abandon the current request instance. @@ -108,14 +108,14 @@ 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/api/authorization#tokens-for-anonymous-sessions) of the commercetools platform API. #### Named arguments (options) 1. `host` _(String)_: the host of the OAuth API service 2. `projectKey` _(String)_: the key of the project to assign the default scope to 3. `credentials` _(Object)_: the client credentials for authentication (`clientId`, `clientSecret`, `anonymousId`) -4. `scopes` _(Array)_: a list of [scopes](https://docs.commercetools.com/http-api-authorization.html#scopes) (default `manage_project:{projectKey}`) to assign to the OAuth token +4. `scopes` _(Array)_: a list of [scopes](https://docs.commercetools.com/api/scopes) (default `manage_project:{projectKey}`) to assign to the OAuth token 5. `fetch` _(Function)_: A `fetch` implementation which can be e.g. `node-fetch` or `unfetch` but also the native browser `fetch` function. Only needs be be passed if not globally available (e.g. through `isomorphic-fetch`) 6. `timeout` _(Number)_: An optional number value (in milliseconds) which specifies when a request should timeout if authentication request fails to complete. 7. `getAbortController` _(Function)_: An optional abortController class instance that should signal the http-client to abandon the current request instance. @@ -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/api/authorization#refresh-token-flow) of the commercetools platform API. #### Named arguments (options) diff --git a/docs/sdk/api/syncActions.md b/docs/sdk/api/syncActions.md index 1c5295cde..a9457ab5e 100644 --- a/docs/sdk/api/syncActions.md +++ b/docs/sdk/api/syncActions.md @@ -442,7 +442,7 @@ client.execute(zonesRequests) > From package [@commercetools/sync-actions](/sdk/api/README.md#sync-actions). -Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API update actions for [_productTypes_](https://docs.commercetools.com/http-api-projects-productTypes.html). +Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API update actions for [_productTypes_](https://docs.commercetools.com/api/projects/productTypes). #### Arguments @@ -492,7 +492,7 @@ client.execute(productTypesRequest) Unlike other resources (e.g `createSyncProducts`), `createSyncProductTypes` requires that you apply hints to calculate update actions for nested values such as `attributes` and `enumValues`. -Since a [change in the API](https://docs.commercetools.com/release-notes.html#releases-2018-03-09-product-type-rename-name-and-enum-key), the [previous implementation was not capable for calculating appropiate update-actions](https://github.com/commercetools/nodejs/pull/760#issue-213684712) when an enum-value has changed its `key`, or when an attribute has changed its `name`. +Since a [change in the API](https://docs.commercetools.com/api/releases/2018-03-09-product-type-rename_name_and_enum_key), the [previous implementation was not capable for calculating appropriate update-actions](https://github.com/commercetools/nodejs/pull/760#issue-213684712) when an enum-value has changed its `key`, or when an attribute has changed its `name`. The `key` of an enum value was used as its identifier to calculate correct update-actions. When the intention of a change was `changeEnumKey`, it is discernable for `sync-actions` to appropriately calculate that for you. Same goes for attribute values. @@ -544,7 +544,7 @@ const updateActions = productTypeSync.buildActions(next, previous, { // isLocalized is a valuable hint to `sync-actions`, since in the API, // we have different update actions on an enum value depending on whether the label is localized or not. // read more about `changePlainEnumValueLabel` and `changeLocalizedEnumValueLabel` - // https://docs.commercetools.com/http-api-projects-productTypes.html#change-the-label-of-an-enumvalue + // https://docs.commercetools.com/api/projects/productTypes#change-the-label-of-an-enumvalue isLocalized: false, }, }, @@ -712,9 +712,9 @@ client.execute(statesRequests) > From package [@commercetools/sync-actions](/sdk/api/README.md#sync-actions). -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). +Creates a [sync action](/sdk/Glossary.md#syncaction) that allows to build API update actions for [_types_](https://docs.commercetools.com/api/projects/types). -**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 [platform](https://docs.commercetools.com/api/projects/types#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..1dbcaf529 100644 --- a/docs/sdk/api/typescriptSdk.md +++ b/docs/sdk/api/typescriptSdk.md @@ -1,6 +1,6 @@ # TypeScript SDK Client v2 -Follow this [link](https://docs.commercetools.com/sdk/javascript-sdk) for an up to date and more accurate JavaScript/TypeScript SDK documentation. +Follow this [link](https://docs.commercetools.com/sdk/typescript-sdk) for an up to date and more accurate JavaScript/TypeScript SDK documentation.