@commercelayer/provisioning-sdk 1.0.0-beta.1 → 1.0.0-beta.3

package/README.md

@@ -1,18 +1,14 @@
 # Commerce Layer Provisioning SDK
 
-[![Version](https://img.shields.io/npm/v/@commercelayer/sdk.svg)](https://npmjs.org/package/@commercelayer/sdk)
-[![Downloads/week](https://img.shields.io/npm/dw/@commercelayer/sdk.svg)](https://npmjs.org/package/@commercelayer/sdk)
-[![License](https://img.shields.io/npm/l/@commercelayer/sdk.svg)](https://github.com/commercelayer/commercelayer-sdk/blob/master/package.json)
+[![Version](https://img.shields.io/npm/v/@commercelayer/provisioning-sdk.svg)](https://npmjs.org/package/@commercelayer/provisioning-sdk)
+[![Downloads/week](https://img.shields.io/npm/dw/@commercelayer/provisioning-sdk.svg)](https://npmjs.org/package/@commercelayer/provisioning-sdk)
+[![License](https://img.shields.io/npm/l/@commercelayer/provisioning-sdk.svg)](https://github.com/commercelayer/commercelayer-sdk/blob/master/package.json)
 [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
 [![Release](https://github.com/commercelayer/commercelayer-sdk/actions/workflows/semantic-release.yml/badge.svg)](https://github.com/commercelayer/commercelayer-sdk/actions/workflows/semantic-release.yml)
 [![CodeQL](https://github.com/commercelayer/commercelayer-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/commercelayer/commercelayer-cli/actions/workflows/codeql-analysis.yml)
 [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript%205-%230074c1.svg)](https://www.typescriptlang.org/)
 
-A JavaScript Library wrapper that makes it quick and easy to interact with the [Commerce Layer API](https://docs.commercelayer.io/developers).
-
-## What is Commerce Layer?
-
-[Commerce Layer](https://commercelayer.io) is a multi-market commerce API and order management system that lets you add global shopping capabilities to any website, mobile app, chatbot, wearable, voice, or IoT device, with ease. Compose your stack with the best-of-breed tools you already mastered and love. Make any experience shoppable, anywhere, through a blazing-fast, enterprise-grade, and secure API.
+A JavaScript Library wrapper that makes it quick and easy to interact with the [Commerce Layer Provisioning API](https://docs.commercelayer.io/provisioning).
 
 ## Table of contents
 
@@ -31,221 +27,214 @@ A JavaScript Library wrapper that makes it quick and easy to interact with the [
 
 ## Getting started
 
-To get started with Commerce Layer JS SDK you need to install it, get the credentials that will allow you to perform your API calls, and import the SDK into your application's code. The sections below explain how to achieve this.
-
-> If you want, you can also read [this tutorial](https://commercelayer.io/blog/getting-started-with-commerce-layer-javascript-sdk) from Commerce Layer's blog.
+To get started with Commerce Layer Provisioning SDK you need to install it, get the credentials that will allow you to perform your API calls, and import the SDK into your application's code. The sections below explain how to achieve this.
 
 ### Installation
 
-Commerce Layer JS SDK is available as an [npm](https://www.npmjs.com/package/@commercelayer/sdk) and [yarn](https://yarnpkg.com/package/@commercelayer/sdk) package that you can install with the command below:
+Commerce Layer Provisioning SDK is available as an [npm](https://www.npmjs.com/package/@commercelayer/provisioning-sdk) and [yarn](https://yarnpkg.com/package/@commercelayer/provisioning-sdk) package that you can install with the command below:
 
 ```shell
-npm install @commercelayer/sdk
+npm install @commercelayer/provisioning-sdk
 
 // or
 
-yarn add @commercelayer/sdk
+yarn add @commercelayer/provisioning-sdk
 ```
 
 ### Authentication
 
-All requests to Commerce Layer API must be authenticated with an [OAuth2](https://oauth.net/2) bearer token. Hence, before starting to use this SDK you need to get a valid access token. Kindly check [our documentation](https://docs.commercelayer.io/developers/authentication) for more information about the available authorization flows.
+All requests to Commerce Layer API must be authenticated with an [OAuth2](https://oauth.net/2) bearer token. Hence, before starting to use this SDK you need to get a valid access token. Kindly check [our documentation](https://docs.commercelayer.io/provisioning/authentication) for more information about the available authorization flows.
 
-> Feel free to use [Commerce Layer JS Auth](https://github.com/commercelayer/commercelayer-js-auth), a JavaScript library that helps you wrap our authentication API.
+> Feel free to use [Commerce Layer Provisioning Auth](https://github.com/commercelayer/commercelayer-js-auth), a JavaScript library that helps you wrap our authentication API.
 
 ### Import
 
 You can use the ES6 default import with the SDK like so:
 
 ```javascript
-import CommerceLayer from '@commercelayer/sdk'
+import CommerceLayerProvisioning from '@commercelayer/provisioning-sdk'
 
-const cl = CommerceLayer({
-  organization: 'your-organization-slug',
+const clp = CommerceLayerProvisioning({
   accessToken: 'your-access-token'
 })
 ```
 
 ## SDK usage
 
-The JavaScript SDK is a wrapper around Commerce Layer API which means you would still be making API requests but with a different syntax. For now, we don't have comprehensive SDK documentation for every single resource our API supports (about 400+ endpoints), hence you will need to rely on our comprehensive [API Reference](https://docs.commercelayer.io/core/v/api-reference) as you go about using this SDK. So for example, if you want to create an order, take a look at the [Order object](https://docs.commercelayer.io/core/v/api-reference/orders/object) or the [Create an order](https://docs.commercelayer.io/core/v/api-reference/orders/create) documentation to see the required attributes and/or relationships. The same goes for every other supported resource.
+The JavaScript SDK is a wrapper around Commerce Layer Provisioning API which means you would still be making API requests but with a different syntax. For now, we don't have comprehensive SDK documentation for every single resource our API supports, hence you will need to rely on our comprehensive [Provisioning API Reference](https://docs.commercelayer.io/provisioning/v/api-reference-p) as you go about using this SDK. So for example, if you want to create a role, take a look at the [Role object](https://docs.commercelayer.io/provisioning/v/api-reference-p/role/object) or the [Create a role](https://docs.commercelayer.io/provisioning/v/api-reference-p/roles/create) documentation to see the required attributes and/or relationships. The same goes for every other supported resource.
 
-To show you how things work, we will use the [SKUs](https://docs.commercelayer.io/core/v/api-reference/skus) and [Shipping Categories](https://docs.commercelayer.io/core/v/api-reference/shipping_categories) resource in the following examples. The code snippets below show how to use the SDK when performing the standard CRUD operations provided by our REST API. Kindly check our [API reference](https://docs.commercelayer.io/core/v/api-reference) for the complete list of available **resources** and their **attributes**.
+The code snippets below show how to use the SDK when performing the standard CRUD operations provided by our REST API. Kindly check our [Provisioning API reference](https://docs.commercelayer.io/provisioning/v/api-reference-p) for the complete list of available **resources** and their **attributes**.
 
 ### Create
 
 <details>
-<summary>How to create an SKU</summary>
+<summary>How to create a Role</summary>
 <br />
 
 ```javascript
-  // Select the shipping category (it's a required relationship for the SKU resource)
-  const shippingCategories = await cl.shipping_categories.list({ filters: { name_eq: 'Merchandising' } })
+  // Select the organization (it's a required relationship for the SKU resource)
+  const organizations = await clp.organizations.list({ filters: { name_eq: 'Test Org' } })
 
   const attributes = {
-    code: 'TSHIRTMM000000FFFFFFXL',
-    name: 'Black Men T-shirt with White Logo (XL)',
-    description: "A very beautiful and cozy mens t-shirt",
-    weight: "500",
-    unit_of_weight: "gr"
-    shipping_category: cl.shipping_categories.relationship(shippingCategories[0].id), // assigns the relationship
+    name: 'Test Role',
+    organization: clp.organizations.relationship(organizations.first().id), // assigns the relationship
   }
 
-  const newSku = await cl.skus.create(attributes)
+  const newRole = await clp.roles.create(attributes)
 ```
 
-ℹ️ Check our API reference for more information on how to [create an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/create).
+ℹ️ Check our API reference for more information on how to [create a Role](https://docs.commercelayer.io/provisioning/v/api-reference-p/roles/create).
 </details>
 
 ### Retrieve / List
 
 <details>
-<summary>How to fetch a single SKU</summary>
+<summary>How to fetch a single organization</summary>
 <br />
 
 ```javascript
-  // Fetch the SKU by ID
-  const sku = await cl.skus.retrieve('BxAkSVqKEn')
+  // Fetch the organization by ID
+  const org = await clp.organizations.retrieve('BxAkSVqKEn')
 
-  // Fetch all SKUs and filter by code
-  const sku = await cl.skus.list({ filters: { code_eq: 'TSHIRTMM000000FFFFFFXLXX' } })
+  // Fetch all organizations and filter by name
+  const orgs = await clp.organizations.list({ filters: { name_start: 'TestOrg_' } })
 
-  // Fetch the first SKU of the list
-  const sku = (await cl.skus.list()).first()
+  // Fetch the first organization of the list
+  const org = (await clp.organizations.list()).first()
 
-  // Fetch the last SKU of the list
-  const sku = (await cl.skus.list()).last()
+  // Fetch the last organization of the list
+  const org = (await clp.organizations.list()).last()
 ```
 
-ℹ️ Check our API reference for more information on how to [retrieve an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/retrieve).
+ℹ️ Check our API reference for more information on how to [retrieve an organization](https://docs.commercelayer.io/provisioning/v/api-reference-p/organizations/retrieve).
 </details>
 
 <details>
-<summary>How to fetch a collection of SKUs</summary>
+<summary>How to fetch a collection of organizations</summary>
 <br />
 
 ```javascript
-  // Fetch all the SKUs
-  const skus = await cl.skus.list()
+  // Fetch all the organizations
+  const orgs = await clp.organizations.list()
 ```
 
 When fetching a collection of resources you can leverage the `meta` attribute to get its `meta` information like so:
 
 ```javascript
-  const skus = await cl.skus.list()
-  const meta = skus.meta
+  const orgs = await clp.organizations.list()
+  const meta = orgs.meta
 ```
 
-ℹ️ Check our API reference for more information on how to [list all SKUs](https://docs.commercelayer.io/developers/v/api-reference/skus/list).
+ℹ️ Check our API reference for more information on how to [list all SKUs](https://docs.commercelayer.io/provisioning/v/api-reference-p/organizations/list).
 </details>
 
 <details>
-<summary>How to fetch a collection of SKUs and sort the results</summary>
+<summary>How to fetch a collection of organizations and sort the results</summary>
 <br />
 
 ```javascript
   // Sort the results by creation date in ascending order (default)
-  const skus = await cl.skus.list({ sort: { created_at: 'asc' } })
+  const orgs = await clp.organizations.list({ sort: { created_at: 'asc' } })
 
   // Sort the results by creation date in descending order
-  const skus = await cl.skus.list({ sort: { created_at: 'desc' } })
+  const orgs = await clp.organizations.list({ sort: { created_at: 'desc' } })
   ```
 
-ℹ️ Check our API reference for more information on how to [sort results](https://docs.commercelayer.io/developers/sorting-results).
+ℹ️ Check our API reference for more information on how to [sort results](https://docs.commercelayer.io/provisioning/sorting-results).
 </details>
 
 <details>
-<summary>How to fetch a collection of SKUs and include associations</summary>
+<summary>How to fetch a collection of Memberships and include associations</summary>
 <br />
 
 ```javascript
-  // Include an association (prices)
-  const skus = await cl.skus.list({ include: [ 'prices' ] })
+  // Include an association (organization)
+  const mships = await clp.memberships.list({ include: [ 'organization' ] })
 
-  // Include an association (stock items)
-  const skus = await cl.skus.list({ include: [ 'stock_items' ] })
+  // Include an association (stock role)
+  const mships = await clp.memberships.list({ include: [ 'role' ] })
   ```
 
-ℹ️ Check our API reference for more information on how to [include associations](https://docs.commercelayer.io/developers/including-associations).
+ℹ️ Check our API reference for more information on how to [include associations](https://docs.commercelayer.io/provisioning/including-associations).
 </details>
 
 <details>
-<summary>How to fetch a collection of SKUs and return specific fields (sparse fieldsets)</summary>
+<summary>How to fetch a collection of Permissions and return specific fields (sparse fieldsets)</summary>
 <br />
 
 ```javascript
   // Request the API to return only specific fields
-  const skus = await cl.skus.list({ fields: { skus: [ 'name', 'metadata' ] } })
+  const perms = await clp.permissions.list({ fields: { permissions: [ 'can_create', 'can_update' ] } })
 
   // Request the API to return only specific fields of the included resource
-  const skus = await cl.skus.list({ include: [ 'prices' ], fields: { prices: [ 'currency_code', 'formatted_amount' ] } })
+  const mships = await clp.memberships.list({ include: [ 'organization' ], fields: { organizations: [ 'name' ] } })
   ```
 
-ℹ️ Check our API reference for more information on how to [use sparse fieldsets](https://docs.commercelayer.io/developers/sparse-fieldsets).
+ℹ️ Check our API reference for more information on how to [use sparse fieldsets](https://docs.commercelayer.io/provisioning/sparse-fieldsets).
 </details>
 
 <details>
-<summary>How to fetch a collection of SKUs and filter data</summary>
+<summary>How to fetch a collection of organizations and filter data</summary>
 <br />
 
 ```javascript
-  // Filter all the SKUs fetching only the ones whose code starts with the string "TSHIRT"
-  const skus = await cl.skus.list({ filters: { code_start: 'TSHIRT' } })
+  // Filter all the organizations fetching only the ones whose name starts with the string "ORG"
+  const orgs = await clp.organizations .list({ filters: { name_start: 'ORG' } })
 
-  // Filter all the SKUs fetching only the ones whose code ends with the string "XLXX"
-  const skus = await cl.skus.list({ filters: { code_end: 'XLXX' } })
+  // Filter all the organizations fetching only the ones whose name ends with the string "Brand"
+  const orgs = await clp.organizations.list({ filters: { name_end: 'Brand' } })
 
-  // Filter all the SKUs fetching only the ones whose name contains the string "White Logo"
-  const skus = await cl.skus.list({ filters: { name_cont: 'White Logo' } })
+  // Filter all the organizations fetching only the ones whose name contains the string "Test"
+  const orgs = await clp.organizations.list({ filters: { name_cont: 'Test' } })
 
-  // Filter all the SKUs fetching only the ones created between two specific dates
+  // Filter all the organizations fetching only the ones created between two specific dates
   // (filters combined according to the AND logic)
-  const skus = await cl.skus.list({ filters: { created_at_gt: '2018-01-01', created_at_lt: '2018-01-31'} })
+  const orgs = await clp.organizations.list({ filters: { created_at_gt: '2018-01-01', created_at_lt: '2018-01-31'} })
 
-  // Filters all the SKUs fetching only the ones created or updated after a specific date
+  // Filters all the organizations fetching only the ones created or updated after a specific date
   // (attributes combined according to the OR logic)
-  const skus = await cl.skus.list({ filters: { updated_at_or_created_at_gt: '2019-10-10' } })
+  const orgs = await clp.organizations.list({ filters: { updated_at_or_created_at_gt: '2019-10-10' } })
 
-  // Filters all the SKUs fetching only the ones whose name contains the string "Black"
-  // and whose shipping category name starts with the string "MERCH"
-  const skus = await cl.skus.list({ filters: { name_cont: 'Black', shipping_category_name_start: 'MERCH'} })
+  // Filters all the Roles fetching only the ones whose name contains the string "Admin"
+  // and whose organization name starts with the string "ORG"
+  const roles = await clp.roles.list({ filters: { name_cont: 'Admin', organization_name_start: 'ORG'} })
   ```
 
-ℹ️ Check our API reference for more information on how to [filter data](https://docs.commercelayer.io/developers/filtering-data).
+ℹ️ Check our API reference for more information on how to [filter data](https://docs.commercelayer.io/provisioning/filtering-data).
 </details>
 
 <details>
-<summary>How to paginate a collection of SKUs</summary>
+<summary>How to paginate a collection of organizations</summary>
 <br />
 
 When you fetch a collection of resources, you get paginated results. You can request specific pages or items in a page like so:
 
 ```javascript
-  // Fetch the SKUs, setting the page number to 3 and the page size to 5
-  const skus = await cl.skus.list({ pageNumber: 3, pageSize: 5 })
+  // Fetch the organizations, setting the page number to 3 and the page size to 5
+  const skorgsus = await clp.organizations.list({ pageNumber: 3, pageSize: 5 })
 
-  // Get the total number of SKUs in the collection
-  const skuCount = skus.meta.recordCount
+  // Get the total number of organizations in the collection
+  const orgCount = orgs.meta.recordCount
 
   // Get the total number of pages
-  const pageCount = skus.meta.pageCount
+  const pageCount = orgs.meta.pageCount
 ```
 
 > PS: the default page number is **1**, the default page size is **10**, and the maximum page size allowed is **25**.
 
-ℹ️ Check our API reference for more information on how [pagination](https://docs.commercelayer.io/developers/pagination) works.
+ℹ️ Check our API reference for more information on how [pagination](https://docs.commercelayer.io/provisioning/pagination) works.
 </details>
 
 <details>
-<summary>How to iterate through a collection of SKUs</summary>
+<summary>How to iterate through a collection of Organizations</summary>
 <br />
 
 To execute a function for every item of a collection, use the `map()` method like so:
 
 ```javascript
-  // Fetch the whole list of SKUs (1st page) and print their names and codes to console
-  const skus = await cl.skus.list()
-  skus.map(p => console.log('Product: ' + p.name + ' - Code: ' + p.code))
+  // Fetch the whole list of organizations (1st page) and print their ids and names to console
+  const orgs = await clp.organizations.list()
+  orgs.map(o => console.log('ID: ' + o.id + ' - Name: ' + o.name))
 ```
 
 </details>
@@ -265,19 +254,19 @@ Many resources have relationships with other resources and instead of including
 
 ```javascript
 // Fetch 1-to-1 related resource: billing address of an order
-const billingAddress = cl.orders.billing_address('xYZkjABcde')
+const org = clp.memberships.organization('xYZkjABcde')
 
 // Fetch 1-to-N related resources: orders associated to a customer
-const orders = cl.customers.orders('XyzKjAbCDe', { fields: ['status', 'number'] })
+const perms = clp.roles.permissions('XyzKjAbCDe', { fields: ['can_create', 'can_update'] })
 ```
 
 In general:
 
-- An API endpoint like `/api/customers` or `/api/customers/<customerId>` translates to `cl.customers` or `cl.customers('<customerId>')` with the SDK.
-- 1-to-1 relationship API endpoints like `/api/orders/<orderId>/shipping_address` translates to `cl.orders('<orderId>', { include: ['shipping_address'] }}` with the SDK.
-- 1-to-N relationship API endpoints like  `/api/customers/<customerId>?include=orders` or `/api/customers/<customerId>/orders` translates to `cl.customers.retrieve('customerId', { include: ['orders'] })` or `cl.customers.orders('<customerId>')` with the SDK.
+- An API endpoint like `/api/organizations` or `/api/organization/<organizationId>` translates to `clp.organizations` or `clp.organizations('<organizationId>')` with the SDK.
+- 1-to-1 relationship API endpoints like `/api/roles/<roleId>/organization` translates to `clp.roles('<roleId>', { include: ['organization'] }}` with the SDK.
+- 1-to-N relationship API endpoints like  `/api/roles/<roleId>?include=versions` or `/api/roles/<roleId>/permissions` translates to `clp.roles.retrieve('<roleId>', { include: ['versions'] })` or `clp.roles.permissions('<roleId>')` with the SDK.
 
-ℹ️ Check our API reference for more information on how to [fetch relationships](https://docs.commercelayer.io/core/fetching-relationships).
+ℹ️ Check our API reference for more information on how to [fetch relationships](https://docs.commercelayer.io/provisioning/fetching-relationships).
 </details>
 
 <details>
@@ -290,8 +279,8 @@ function passing a filter to get as result the total number of
 resources.
 
 ```javascript
-// Get the total number of placed orders
-const placedOrders = cl.orders.count({ filters: { status_eq: 'placed' } })
+// Get the total number of sales_channel credentials
+const credentials = clp.api_credentials.count({ filters: { kind_eq: 'sales_channel' } })
 
 ```
 
@@ -300,59 +289,59 @@ const placedOrders = cl.orders.count({ filters: { status_eq: 'placed' } })
 ### Update
 
 <details>
-<summary>How to update an existing SKU</summary>
+<summary>How to update an existing organization</summary>
 <br />
 
 ```javascript
-  const sku = {
+  const org = {
     id: 'xYZkjABcde',
-    description: 'Updated description...',
-    imageUrl: 'https://img.yourdomain.com/skus/new-image.png'
+    reference: '<new-reference>',
+    reference_origin: '<new-reference-origin>'
   }
 
-  cl.skus.update(sku) // updates the SKU on the server
+  clp.organizations.update(org) // updates the SKU on the server
 ```
 
-ℹ️ Check our API reference for more information on how to [update an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/update).
+ℹ️ Check our API reference for more information on how to [update an organization](https://docs.commercelayer.io/provisioning/v/api-reference-p/organizations/update).
 </details>
 
 ### Delete
 
 <details>
-<summary>How to delete an existing SKU</summary>
+<summary>How to delete an existing membership</summary>
 <br />
 
 ```javascript
-  cl.skus.delete('xYZkjABcde') // persisted deletion
+  clp.memberships.delete('xYZkjABcde') // persisted deletion
 ```
 
-ℹ️ Check our API reference for more information on how to [delete an SKU](https://docs.commercelayer.io/developers/v/api-reference/skus/delete).
+ℹ️ Check our API reference for more information on how to [delete a membership](https://docs.commercelayer.io/provisioning/v/api-reference-p/memberships/delete).
 </details>
 
 ## Overriding credentials
 
-If needed, Commerce Layer JS SDK lets you change the client configuration and set it at a request level. To do that, just use the `config()` method or pass the `options` parameter and authenticate the API call with the desired credentials:
+If needed, Commerce Layer Provisioning SDK lets you change the client configuration and set it at a request level. To do that, just use the `config()` method or pass the `options` parameter and authenticate the API call with the desired credentials:
 
 ```javascript
   // Permanently change configuration at client level
-  cl.config({ organization: 'you-organization-slug', accessToken: 'your-access-token' })
-  const skus = await cl.skus.list()
+  clp.config({ accessToken: 'your-access-token' })
+  const roles = await clp.roles.list()
 
   or
 
   // Use configuration at request level
-  cl.skus.list({}, { organization: 'you-organization-slug', accessToken: 'your-access-token' })
+  clp.roles.list({}, { accessToken: 'your-access-token' })
 ```
 
 ## Handling validation errors
 
-Commerce Layer API returns specific errors (with extra information) on each attribute of a single resource. You can inspect them to properly handle validation errors (if any). To do that, use the `errors` attribute of the catched error:
+Commerce Layer Provisioning API returns specific errors (with extra information) on each attribute of a single resource. You can inspect them to properly handle validation errors (if any). To do that, use the `errors` attribute of the catched error:
 
 ```javascript
   // Log error messages to console:
-  const attributes = { code: 'TSHIRTMM000000FFFFFFXL', name: '' }
+  const attributes = { name: '' }
 
-  const newSku = await cl.skus.create(attributes).catch(error => console.log(error.errors))
+  const newRole = await clp.roles.create(attributes).catch(error => console.log(error.errors))
 
   // Logged errors
   /*
@@ -365,19 +354,11 @@ Commerce Layer API returns specific errors (with extra information) on each attr
       status: '422',
       meta: { error: 'blank' }
     },
-    {
-      title: 'has already been taken',
-      detail: 'code - has already been taken',
-      code: 'VALIDATION_ERROR',
-      source: { pointer: '/data/attributes/code' },
-      status: '422',
-      meta: { error: 'taken', value: 'TSHIRTMM000000FFFFFFXL' }
-    },
     {
       title: "can't be blank",
-      detail: "shipping_category - can't be blank",
+      detail: "organization - can't be blank",
       code: 'VALIDATION_ERROR',
-      source: { pointer: '/data/relationships/shipping_category' },
+      source: { pointer: '/data/relationships/organization' },
       status: '422',
       meta: { error: 'blank' }
     }
@@ -386,16 +367,16 @@ Commerce Layer API returns specific errors (with extra information) on each attr
 
 ```
 
-ℹ️ Check our API reference for more information about the [errors](https://docs.commercelayer.io/developers/handling-errors) returned by the API.
+ℹ️ Check our API reference for more information about the [errors](https://docs.commercelayer.io/provisioning/handling-errors) returned by the API.
 
 ## Contributors guide
 
-1. Fork [this repository](https://github.com/commercelayer/commercelayer-sdk) (learn how to do this [here](https://help.github.com/articles/fork-a-repo)).
+1. Fork [this repository](https://github.com/commercelayer/provisioning-sdk) (learn how to do this [here](https://help.github.com/articles/fork-a-repo)).
 
 2. Clone the forked repository like so:
 
     ```shell
-    git clone https://github.com/<your username>/commercelayer-sdk.git && cd commercelayer-sdk
+    git clone https://github.com/<your username>/provisioning-sdk.git && cd provisioning-sdk
     ```
 
 3. Make your changes and create a pull request ([learn how to do this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)).
@@ -406,7 +387,7 @@ Commerce Layer API returns specific errors (with extra information) on each attr
 
 1. Join [Commerce Layer's Slack community](https://slack.commercelayer.app).
 
-2. Create an [issue](https://github.com/commercelayer/commercelayer-cli/issues) in this repository.
+2. Create an [issue](https://github.com/commercelayer/provisioning-sdk/issues) in this repository.
 
 3. Ping us [on Twitter](https://twitter.com/commercelayer).
 

package/lib/cjs/client.d.ts

@@ -16,13 +16,15 @@ type RequestConfig = {
     proxy?: ProxyConfig;
     headers?: RequestHeaders;
 };
+type RequestConfigExtra = {
+    adapter?: Adapter;
+    userAgent?: string;
+};
 type ApiConfig = {
     domain?: string;
     accessToken: string;
 };
-type ApiClientInitConfig = ApiConfig & RequestConfig & {
-    adapter?: Adapter;
-};
+type ApiClientInitConfig = ApiConfig & RequestConfig & RequestConfigExtra;
 type ApiClientConfig = Partial<ApiClientInitConfig>;
 declare class ApiClient {
     #private;
@@ -31,6 +33,7 @@ declare class ApiClient {
     interceptors: InterceptorManager;
     private constructor();
     config(config: ApiClientConfig): ApiClient;
+    userAgent(userAgent: string): ApiClient;
     adapter(adapter: Adapter): ApiClient;
     request(method: Method, path: string, body?: any, options?: ApiClientConfig): Promise<any>;
     private customHeaders;

package/lib/cjs/client.js

@@ -18,6 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const axios_1 = __importDefault(require("axios"));
 const error_1 = require("./error");
 const config_1 = __importDefault(require("./config"));
+// import { packageInfo } from './util'
 const debug_1 = __importDefault(require("./debug"));
 const debug = (0, debug_1.default)('client');
 const baseURL = (domain) => {
@@ -40,10 +41,15 @@ class ApiClient {
             timeout: options.timeout || config_1.default.client.timeout,
             proxy: options.proxy,
             httpAgent: options.httpAgent,
-            httpsAgent: options.httpsAgent,
+            httpsAgent: options.httpsAgent
         };
         // Set custom headers
         const customHeaders = this.customHeaders(options.headers);
+        // Set User-Agent
+        // const userAgentData = packageInfo(['version', 'dependencies.axios'], { nestedName: true })
+        let userAgent = options.userAgent || `SDK-provisioning axios/${axios_1.default.VERSION}`;
+        if (!userAgent.includes('axios/'))
+            userAgent += ` axios/${axios_1.default.VERSION}`;
         const axiosOptions = {
             baseURL: this.baseUrl,
             timeout: config_1.default.client.timeout,
@@ -51,7 +57,8 @@ class ApiClient {
                 ...customHeaders,
                 'Accept': 'application/vnd.api+json',
                 'Content-Type': 'application/vnd.api+json',
-                'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f")
+                'Authorization': 'Bearer ' + __classPrivateFieldGet(this, _ApiClient_accessToken, "f"),
+                'User-Agent': userAgent
             },
             ...axiosConfig
         };
@@ -73,6 +80,10 @@ class ApiClient {
             def.httpAgent = config.httpAgent;
         if (config.httpsAgent)
             def.httpsAgent = config.httpsAgent;
+        if (config.adapter)
+            this.adapter(config.adapter);
+        if (config.userAgent)
+            this.userAgent(config.userAgent);
         // API Client config
         if (config.accessToken) {
             __classPrivateFieldSet(this, _ApiClient_accessToken, config.accessToken, "f");
@@ -80,8 +91,18 @@ class ApiClient {
         }
         if (config.headers)
             def.headers.common = this.customHeaders(config.headers);
-        if (config.adapter)
-            this.adapter(config.adapter);
+        return this;
+    }
+    userAgent(userAgent) {
+        if (userAgent) {
+            let ua = userAgent;
+            if (!ua.includes('axios/')) {
+                // const axiosVer = packageInfo(['dependencies.axios'], { nestedName: true })
+                if (axios_1.default.VERSION)
+                    ua += ` axios/${axios_1.default.VERSION}`;
+            }
+            __classPrivateFieldGet(this, _ApiClient_client, "f").defaults.headers['User-Agent'] = ua;
+        }
         return this;
     }
     adapter(adapter) {
@@ -91,10 +112,14 @@ class ApiClient {
     }
     async request(method, path, body, options) {
         debug('request %s %s, %O, %O', method, path, body || {}, options || {});
+        // Ignored params alerts (in debug mode)
+        if (options === null || options === void 0 ? void 0 : options.adapter)
+            debug('Adapter ignored in request config');
+        if (options === null || options === void 0 ? void 0 : options.userAgent)
+            debug('User-Agent header ignored in request config');
         const data = body ? { data: body } : undefined;
         const url = path;
         // Runtime request parameters
-        // const baseUrl = options?.organization ? baseURL(options.organization, options.domain) : undefined
         const accessToken = (options === null || options === void 0 ? void 0 : options.accessToken) || __classPrivateFieldGet(this, _ApiClient_accessToken, "f");
         const headers = this.customHeaders(options === null || options === void 0 ? void 0 : options.headers);
         if (accessToken)
@@ -111,7 +136,7 @@ class ApiClient {
         const customHeaders = {};
         if (headers) {
             for (const [name, value] of Object.entries(headers))
-                if (!['accept', 'content-type', 'authorization'].includes(name.toLowerCase()))
+                if (!['accept', 'content-type', 'authorization', 'user-agent'].includes(name.toLowerCase()))
                     customHeaders[name] = value;
         }
         return customHeaders;

package/lib/cjs/commercelayer.js

@@ -68,22 +68,19 @@ class CommerceLayerProvisioningClient {
         // ##__CL_RESOURCES_INIT_STOP__##
     }
     // get environment(): ApiMode { return this.#environment }
-    localConfig(config /* & { organization?: string } */) {
+    localConfig(config) {
     }
     config(config) {
         debug('config %o', config);
         // CommerceLayer config
         this.localConfig(config);
         // ResourceAdapter config
-        // To rebuild baseUrl in client in case only the domain is defined
-        // if (!config.organization) config.organization = this.currentOrganization
         __classPrivateFieldGet(this, _CommerceLayerProvisioningClient_adapter, "f").config(config);
         return this;
     }
     resources() {
         return static_1.CommerceLayerProvisioningStatic.resources();
     }
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types, @typescript-eslint/no-explicit-any
     isApiError(error) {
         return static_1.CommerceLayerProvisioningStatic.isApiError(error);
     }