Release v3.1.0 (@W-15945047@) (#404)

* Update to latest raml-toolkit * Update APIs * Update CHANGELOG.md * Generate docs * Increment version * Update .gitattributes * Revert "Update .gitattributes" This reverts commit 2af825b. * Revert "Update APIs" This reverts commit e140c37. * Reapply "Update APIs" This reverts commit e3b17bb. * Fix the version of future potentially breaking change * Fix CI tests * Now publishing with Node 16 Since we're supporting Node 16, 18, and 20. * Update docs with the new commerce-sdk version * CI: create unique cache for each Node version tested * CI caching: hash the correct file
SalesforceCommerceCloud · Jun 20, 2024 · cf5c041 · cf5c041
1 parent 01ae667
commit cf5c041
Show file tree

Hide file tree

Showing 1,633 changed files with 43,624 additions and 18,296 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: '14.x'
+          node-version: '16.x'
           registry-url: 'https://registry.npmjs.org'
       - run: npm install snyk --legacy-peer-deps
       - run: npm run snyk:auth ${{ secrets.SNYK_TOKEN }}

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -16,7 +16,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: ${{ matrix.node_version }}
+          node-version: ${{ matrix.node }}
           cache: npm
       - name: Cache node modules
         id: cache-nodemodules
@@ -25,7 +25,7 @@ jobs:
           cache-name: cache-node-modules
         with:
           path: "**/node_modules"
-          key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ hashFiles('**/yarn.lock') }}
+          key: ${{ runner.os }}-node${{ matrix.node }}-build-${{ env.cache-name }}-${{ hashFiles('**/package-lock.json') }}
       - run: npm install snyk --legacy-peer-deps
       - run: npm run snyk:auth ${{ secrets.SNYK_TOKEN }}
       - run: npm install --legacy-peer-deps

diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+16
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,15 @@ only use JavaScript, or if you use TypeScript but only import the client classes
 then your usage **will not change**. You will likely only need to make changes if
 you import the type definitions directly.
 
+## v3.1.0
+
+### API Changes
+*Shopper Baskets*
+
+  | **Endpoint Name** | **Description**                   |
+  | ------------- |-----------------------------------|
+  | updateItemsInBasket | Updates multiple items in a basket. |
+
 ## v3.0.0
 
 #### API Changes

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Visit the [Commerce Cloud Developer Center](https://developer.salesforce.com/dev
 ## :warning: Planned future release will contain breaking changes :warning:
 Due to an issue with the generation of the type definitions, an upcoming release
 of the SDK will change type definitions to include namespaces. As this is a
-breaking change, a new major version will be released (v3.0.0). Only the names of
+breaking change, a new major version will be released (v4.0.0). Only the names of
 the types will change, not their contents or any of the exported code. If you
 only use JavaScript, or if you use TypeScript but only import the client classes,
 then your usage **will not change**. You will likely only need to make changes if

diff --git a/apis/checkout/orders/.metadata.json b/apis/checkout/orders/.metadata.json
@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/orders/1.4.2",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/orders/1.4.4",
   "name": "Orders",
   "description": "Manage order and order payment status.",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "orders",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "categories": {
     "API layer": [
       "Process"

diff --git a/apis/checkout/orders/data-types.raml b/apis/checkout/orders/data-types.raml
@@ -3,7 +3,7 @@
 usage: This library provides all order relevant data types
 
 uses:
-  CommerceCloudStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.27/commerce-cloud-standards.raml 
+  CommerceCloudStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/commerce-cloud-standards.raml 
 
 types:
   OrderUpdateRequest:
@@ -1331,7 +1331,6 @@ types:
       quantity?:
         description: |-
           The ordered quantity of the products represented by this item.
-        maximum: 999
         minimum: 0
         type: number
         format: double
@@ -2148,7 +2147,6 @@ types:
           green umbrella
       quantity:
         description: The ordered quantity of the products represented by this item.
-        maximum: 999
         minimum: 0
         type: number
         format: double

diff --git a/apis/checkout/orders/exchange.json b/apis/checkout/orders/exchange.json
@@ -6,12 +6,12 @@
       "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8"
     },
     {
-      "version": "1.0.27",
+      "version": "2.0.1",
       "assetId": "commerce-cloud-standards",
       "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8"
     }
   ],
-  "version": "1.4.2",
+  "version": "1.4.4",
   "originalFormatVersion": "1.0",
   "apiVersion": "v1",
   "descriptorVersion": "0.1.0",

diff --git a/...-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.27/SecuritySchemes/bearer-token.raml b/...-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.27/SecuritySchemes/bearer-token.raml
diff --git a/...odules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.27/exchange.json b/...odules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.27/exchange.json
diff --git a/...7/Documentation/ErrorResponseMapping.raml → ...1/Documentation/ErrorResponseMapping.raml b/...7/Documentation/ErrorResponseMapping.raml → ...1/Documentation/ErrorResponseMapping.raml
diff --git a/...andards/1.0.27/Documentation/baseUri.raml → ...tandards/2.0.1/Documentation/baseUri.raml b/...andards/1.0.27/Documentation/baseUri.raml → ...tandards/2.0.1/Documentation/baseUri.raml
diff --git a/...standards/1.0.27/Examples/BoolFilter.json → ...-standards/2.0.1/Examples/BoolFilter.json b/...standards/1.0.27/Examples/BoolFilter.json → ...-standards/2.0.1/Examples/BoolFilter.json
diff --git a/...-standards/1.0.27/Examples/BoolQuery.json → ...d-standards/2.0.1/Examples/BoolQuery.json b/...-standards/1.0.27/Examples/BoolQuery.json → ...d-standards/2.0.1/Examples/BoolQuery.json
diff --git a/...-standards/1.0.27/Examples/BoolQuery.raml → ...d-standards/2.0.1/Examples/BoolQuery.raml b/...-standards/1.0.27/Examples/BoolQuery.raml → ...d-standards/2.0.1/Examples/BoolQuery.raml
diff --git a/...oud-standards/1.0.27/Examples/Filter.json → ...loud-standards/2.0.1/Examples/Filter.json b/...oud-standards/1.0.27/Examples/Filter.json → ...loud-standards/2.0.1/Examples/Filter.json
diff --git a/...ndards/1.0.27/Examples/FilteredQuery.json → ...andards/2.0.1/Examples/FilteredQuery.json b/...ndards/1.0.27/Examples/FilteredQuery.json → ...andards/2.0.1/Examples/FilteredQuery.json
diff --git a/...tandards/1.0.27/Examples/NestedQuery.json → ...standards/2.0.1/Examples/NestedQuery.json b/...tandards/1.0.27/Examples/NestedQuery.json → ...standards/2.0.1/Examples/NestedQuery.json
diff --git a/...7/Examples/PaginatedSearchResultBase.json → ...1/Examples/PaginatedSearchResultBase.json b/...7/Examples/PaginatedSearchResultBase.json → ...1/Examples/PaginatedSearchResultBase.json
diff --git a/...loud-standards/1.0.27/Examples/Query.json → ...cloud-standards/2.0.1/Examples/Query.json b/...loud-standards/1.0.27/Examples/Query.json → ...cloud-standards/2.0.1/Examples/Query.json
diff --git a/...tandards/1.0.27/Examples/QueryFilter.json → ...standards/2.0.1/Examples/QueryFilter.json b/...tandards/1.0.27/Examples/QueryFilter.json → ...standards/2.0.1/Examples/QueryFilter.json
diff --git a/...andards/1.0.27/Examples/Range2Filter.json → ...tandards/2.0.1/Examples/Range2Filter.json b/...andards/1.0.27/Examples/Range2Filter.json → ...tandards/2.0.1/Examples/Range2Filter.json
diff --git a/...tandards/1.0.27/Examples/RangeFilter.json → ...standards/2.0.1/Examples/RangeFilter.json b/...tandards/1.0.27/Examples/RangeFilter.json → ...standards/2.0.1/Examples/RangeFilter.json
diff --git a/...ds/1.0.27/Examples/SearchRequestBase.json → ...rds/2.0.1/Examples/SearchRequestBase.json b/...ds/1.0.27/Examples/SearchRequestBase.json → ...rds/2.0.1/Examples/SearchRequestBase.json
diff --git a/...0.27/Examples/SimpleSearchResultBase.json → ....0.1/Examples/SimpleSearchResultBase.json b/...0.27/Examples/SimpleSearchResultBase.json → ....0.1/Examples/SimpleSearchResultBase.json
diff --git a/...standards/1.0.27/Examples/TermFilter.json → ...-standards/2.0.1/Examples/TermFilter.json b/...standards/1.0.27/Examples/TermFilter.json → ...-standards/2.0.1/Examples/TermFilter.json
diff --git a/...-standards/1.0.27/Examples/TermQuery.json → ...d-standards/2.0.1/Examples/TermQuery.json b/...-standards/1.0.27/Examples/TermQuery.json → ...d-standards/2.0.1/Examples/TermQuery.json
diff --git a/...-standards/1.0.27/Examples/TextQuery.json → ...d-standards/2.0.1/Examples/TextQuery.json b/...-standards/1.0.27/Examples/TextQuery.json → ...d-standards/2.0.1/Examples/TextQuery.json
diff --git a/...ds/1.0.27/SecuritySchemes/am-oauth-2.raml → ...rds/2.0.1/SecuritySchemes/am-oauth-2.raml b/...ds/1.0.27/SecuritySchemes/am-oauth-2.raml → ...rds/2.0.1/SecuritySchemes/am-oauth-2.raml
diff --git a/...7/SecuritySchemes/shopper-token-taob.raml → ...1/SecuritySchemes/shopper-token-taob.raml b/...7/SecuritySchemes/shopper-token-taob.raml → ...1/SecuritySchemes/shopper-token-taob.raml
diff --git a/...7/SecuritySchemes/shopper-token-tsob.raml → ...1/SecuritySchemes/shopper-token-tsob.raml b/...7/SecuritySchemes/shopper-token-tsob.raml → ...1/SecuritySchemes/shopper-token-tsob.raml
diff --git a/...1.0.27/SecuritySchemes/shopper-token.raml → .../2.0.1/SecuritySchemes/shopper-token.raml b/...1.0.27/SecuritySchemes/shopper-token.raml → .../2.0.1/SecuritySchemes/shopper-token.raml
@@ -5,7 +5,7 @@ description: |
   A shopper token allows you to access the Shopper API endpoints of both OCAPI and the B2C Commerce API. These endpoints can be used to build headless storefronts and other applications.
   The `ShopperToken` security scheme is a parent of other security schemes, such as `ShopperTokenTsob`. A Shopper API endpoint can require a specific child scheme (`ShopperTokenTsob`, for example) that cannot be accessed with a regular shopper token.
 
-type: x-custom
+type: OAuth 2.0
 displayName: ShopperToken
 
 uses:
@@ -43,4 +43,8 @@ describedBy:
           example:
             type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden"
             title: Forbidden
-            detail: Your token is valid, but you have no permissions to access the resource.
+            detail: Your access token is valid, but you don’t have the required permissions to access the resource.
+settings:
+  authorizationUri: https://{short-code}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/authorize
+  accessTokenUri: https://{short-code}.api.commercecloud.salesforce.com/shopper/auth/v1/organizations/{organizationId}/oauth2/token
+  authorizationGrants: [authorization_code,client_credentials]
diff --git a/...standards/1.0.27/Types/ISO-standards.raml → ...-standards/2.0.1/Types/ISO-standards.raml b/...standards/1.0.27/Types/ISO-standards.raml → ...-standards/2.0.1/Types/ISO-standards.raml
diff --git a/...s/1.0.27/Types/additional-properties.raml → ...ds/2.0.1/Types/additional-properties.raml b/...s/1.0.27/Types/additional-properties.raml → ...ds/2.0.1/Types/additional-properties.raml
diff --git a/....27/Types/attribute-definition-types.raml → ...0.1/Types/attribute-definition-types.raml b/....27/Types/attribute-definition-types.raml → ...0.1/Types/attribute-definition-types.raml
diff --git a/...tandards/1.0.27/Types/error-response.raml → ...standards/2.0.1/Types/error-response.raml b/...tandards/1.0.27/Types/error-response.raml → ...standards/2.0.1/Types/error-response.raml
diff --git a/...ndards/1.0.27/Types/pagination-types.raml → ...andards/2.0.1/Types/pagination-types.raml b/...ndards/1.0.27/Types/pagination-types.raml → ...andards/2.0.1/Types/pagination-types.raml
diff --git a/...-standards/1.0.27/Types/search-types.raml → ...d-standards/2.0.1/Types/search-types.raml b/...-standards/1.0.27/Types/search-types.raml → ...d-standards/2.0.1/Types/search-types.raml
diff --git a/...dards/2.0.0/commerce-cloud-standards.raml → ...dards/2.0.1/commerce-cloud-standards.raml b/...dards/2.0.0/commerce-cloud-standards.raml → ...dards/2.0.1/commerce-cloud-standards.raml
diff --git a/...mmerce-cloud-standards/2.0.0/example.raml → ...mmerce-cloud-standards/2.0.1/example.raml b/...mmerce-cloud-standards/2.0.0/example.raml → ...mmerce-cloud-standards/2.0.1/example.raml
diff --git a/...merce-cloud-standards/2.0.0/exchange.json → ...merce-cloud-standards/2.0.1/exchange.json b/...merce-cloud-standards/2.0.0/exchange.json → ...merce-cloud-standards/2.0.1/exchange.json
@@ -5,6 +5,6 @@
   "tags": [],
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "commerce-cloud-standards",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8"
 }
diff --git a/apis/checkout/orders/orders-description.md b/apis/checkout/orders/orders-description.md
@@ -6,6 +6,8 @@ Use the Orders API to update order status and order payment status, edit shippin
 
 The client requesting the order information must have access to the Orders resource. The API requests pass a system-to-system bearer token in the header of the request. The `POST /orders` endpoint uses the [ShopperTokenTsob](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-login?meta=security%3AShopperTokenTsob) security scheme.
 
+You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see the  [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
+
 ## Update Order Statuses
 
 An order uses several status properties to define its workflow state. Some of them are used to trigger internal processes, such as inventory allocation. Others have no default function, but are available for use with customizations.

diff --git a/apis/checkout/orders/orders.raml b/apis/checkout/orders/orders.raml
@@ -15,7 +15,7 @@ baseUriParameters:
 uses:
   StatusCodes: status-codes.raml
   DataTypes: data-types.raml
-  CommerceCloudStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.27/commerce-cloud-standards.raml
+  CommerceCloudStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/commerce-cloud-standards.raml
   ApiStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/api-standards.raml
 
 types:
@@ -25,7 +25,7 @@ types:
     type: CommerceCloudStandards.Organization
     get:
       description: |-
-        Returns the details of orders that match the query filters. By default, calling this API with no filter returns the 100 most recently created orders. To return up to 200 orders, use the limit parameter. To return a page of results past the first page, use a resource offset.
+        Returns the details of orders that match the query filters. By default, calling this API with no filter returns the 100 most recently created orders. To return up to 200 orders, use the limit parameter. To return a page of results past the first page, use a resource offset. *Note* : The sum of the offset and limit parameters cannot be greater than 10000.
       displayName: getOrders
       queryParameters:
         sortBy?:
@@ -92,7 +92,6 @@ types:
               maxLimit: 200
               defaultSize: 100
       securedBy:
-        - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders", "sfcc.orders.rw" ] }
         - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders", "sfcc.orders.rw" ] }
     post:
       description: !include create-order-description.md
@@ -135,7 +134,6 @@ types:
           - CommerceCloudStandards.SiteSpecific
         displayName: getOrder
         securedBy:
-          - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders", "sfcc.orders.rw" ] }
           - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders", "sfcc.orders.rw" ] }
       patch:
         description: |-
@@ -152,7 +150,6 @@ types:
             examples:
                 DataTypes.OrderUpdateRequest: !include examples/order-request.raml
         securedBy:
-          - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
           - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
           - CommerceCloudStandards.ShopperTokenTsob: { scopes: [ "sfcc.orders.rw" ] }
       /confirmation-status:
@@ -172,7 +169,6 @@ types:
               examples:
                 DataTypes.OrderConfirmationStatusUpdateRequest: !include examples/order-confirmation-status-request.raml
           securedBy:
-            - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
             - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
       /export-status:
         type: CommerceCloudStandards.Organization
@@ -191,7 +187,6 @@ types:
               examples:
                 DataTypes.OrderExportStatusUpdateRequest: !include examples/order-export-status-request.raml
           securedBy:
-            - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
             - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
       /external-status:
         type: CommerceCloudStandards.Organization
@@ -210,7 +205,6 @@ types:
               examples:
                 DataTypes.OrderExternalStatusUpdateRequest: !include examples/order-external-status-request.raml
           securedBy:
-            - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
             - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
       /payment-status:
         type: CommerceCloudStandards.Organization
@@ -229,7 +223,6 @@ types:
               examples:
                 DataTypes.OrderPaymentStatusUpdateRequest: !include examples/order-payment-status-request.raml
           securedBy:
-            - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
             - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
       /shipping-status:
         type: CommerceCloudStandards.Organization
@@ -248,7 +241,6 @@ types:
               examples:
                 DataTypes.OrderShippingStatusUpdateRequest: !include examples/order-shipping-status-request.raml
           securedBy:
-            - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
             - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
       /status:
         type: CommerceCloudStandards.Organization
@@ -286,7 +278,6 @@ types:
               examples:
                 DataTypes.OrderStatusUpdateRequest: !include examples/order-status-request.raml
           securedBy:
-            - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
             - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
       '/payment-instruments/{paymentInstrumentId}':
         type: CommerceCloudStandards.Organization
@@ -313,7 +304,6 @@ types:
               examples:
                 DataTypes.PaymentInstrumentUpdateRequest: !include examples/order-payment-instrument-request.raml
           securedBy:
-            - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
             - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
         /transaction:
           type: CommerceCloudStandards.Organization
@@ -333,7 +323,6 @@ types:
                 examples:
                   DataTypes.PaymentTransactionUpdateRequest: !include examples/order-payment-transaction-request.raml
             securedBy:
-              - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
               - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
       '/shipments/{shipmentId}':
         type: CommerceCloudStandards.Organization
@@ -362,5 +351,4 @@ types:
                 examples:
                   DataTypes.ShippingAddressUpdateRequest: !include examples/order-shipping-address-request.raml
             securedBy:
-              - CommerceCloudStandards.BearerToken: { scopes: [ "sfcc.orders.rw" ] }
               - CommerceCloudStandards.AmOAuth2: { scopes: [ "sfcc.orders.rw" ] }
diff --git a/apis/checkout/shopper-baskets/.metadata.json b/apis/checkout/shopper-baskets/.metadata.json
@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets/2.0.3",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets/2.0.9",
   "name": "Shopper Baskets",
   "description": "Build a checkout experience.",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "shopper-baskets",
-  "version": "2.0.3",
+  "version": "2.0.9",
   "categories": {
     "API layer": [
       "Process"

diff --git a/apis/checkout/shopper-baskets/examples/basket/items-patch-request.raml b/apis/checkout/shopper-baskets/examples/basket/items-patch-request.raml
@@ -0,0 +1,14 @@
+#%RAML 1.0 NamedExample
+value:
+  [{
+    "itemId": "051e908cca031ebf8ee80cbb0a",
+    "productId": "green-bag",
+    "quantity": 1
+  },{
+    "itemId": "078a492cca031ebf8ee80739ab",
+    "optionItems" : [{
+      "optionId":"Option1",
+      "optionValueId":"ValueA"
+    }],
+    "quantity": 1
+  }]