Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(rebranding): removing platform references #1782

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<a href="https://commercetools.com/">
<img alt="commercetools logo" src="http://cdn.rawgit.com/commercetools/press-kit/master/PNG/72DPI/CT%20logo%20chrom%20black%20horizontal%20RGB%2072dpi.png">
</a>
<b>Node.js commercetools ecosystem.</b>
<b>Node.js commercetools Composable Commerce ecosystem.</b>
</p>

<p align="center">
Expand Down
2 changes: 1 addition & 1 deletion book.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"gitbook": ">=3.2.1",
"root": "docs",
"title": "commercetools node.js",
"title": "commercetools composable commerce node.js",
"plugins": [
"edit-link",
"prism",
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<a href="https://commercetools.com/">
<img alt="commercetools logo" src="http://cdn.rawgit.com/commercetools/press-kit/master/PNG/72DPI/CT%20logo%20chrom%20black%20horizontal%20RGB%2072dpi.png">
</a>
<b>Node.js commercetools ecosystem.</b>
<b>Node.js commercetools Composable Commerce ecosystem.</b>
</p>

<p align="center">
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/cli/category-exporter.md
Original file line number Diff line number Diff line change
@@ -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`)
Expand All @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/csv-parser-discount-code.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/csv-parser-orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/csv-parser-price.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/csv-parser-state.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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: `';'`)
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/custom-objects-exporter.md
Original file line number Diff line number Diff line change
@@ -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`)
Expand All @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/custom-objects-importer.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# 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

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)
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/customer-groups-exporter.md
Original file line number Diff line number Diff line change
@@ -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`)
Expand All @@ -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]
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/discount-code-exporter.md
Original file line number Diff line number Diff line change
@@ -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`]
Expand All @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/discount-code-generator.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/cli/discount-code-importer.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# 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

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)
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/inventories-exporter.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions docs/cli/personal-data-erasure.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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`)

Expand Down
Loading