Release v3.0.0 (#166)

* add API changes for release * update readme and changelog * update changelog * update release notes * add shopper context description changes * bump version * update generated docs
SalesforceCommerceCloud · Jul 18, 2024 · c5f4bb1 · c5f4bb1
1 parent 1e893c7
commit c5f4bb1
Show file tree

Hide file tree

Showing 21 changed files with 324 additions and 305 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,14 +2,26 @@
 
 ## v3.0.0
 
-### :warning: Planned Shopper Context Changes :warning: 
+### :warning: Planned API Changes :warning: 
 
-Starting July 31st 2024, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
+#### Shopper Context
+
+Starting July 31st 2024, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025. You can read more about the planned change [here](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary) in the notes section.
+
+#### Shopper Login (SLAS)
+
+SLAS will soon require new tenants to pass `channel_id` as an argument for retrieving guest access tokens. You can read more about the planned change [here](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html#guest-tokens).
+
+Please be aware that existing tenants are on a temporary allow list and will see no immediate disruption to service.  We do ask that all users seek to adhere to the `channel_id` requirement before the end of August to enhance your security posture before the holiday peak season.
+
+In practice, we recommend:
+
+- For customers using the SLAS helpers with a public client, it is recommended to upgrade to at least `v1.8.0` of the `commerce-sdk-isomorphic`.
+- For customers using the SLAS helpers with a private client, it is recommended to upgrade to `v3.0.0` of the `commerce-sdk-isomorphic`.
 
 ### Enchancements
 
-- Update SLAS helper function `loginGuestUserPrivate` to require `channel_id` as SLAS requires `channel_id` when requesting a guest access token with a `grant_type` of `client_credentials` starting July 31st 2024 [#165](https://github.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/pull/165)
-  - See the [announcement on the developer docs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html#guest-tokens) for more information
+- Update SLAS helper function `loginGuestUserPrivate` to require `channel_id` through `clientConfig.parameters.siteId` [#165](https://github.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/pull/165)
 
 ## v2.1.0
 

diff --git a/README.md b/README.md
@@ -4,9 +4,22 @@ This SDK provides a Browser & Node.js JavaScript client for calling [B2C Commerc
 
 _For a Node.js only SDK that can also access Admin APIs checkout [Commerce SDK](https://github.com/SalesforceCommerceCloud/commerce-sdk)._
 
-## :warning: Planned Shopper Context Changes :warning:
+## :warning: Planned API Changes :warning:
 
-Starting July 31st 2024, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
+### Shopper Context
+
+Starting July 31st 2024, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025. You can read more about the planned change [here](https://developer.salesforce.com/docs/commerce/commerce-api/references/shopper-context?meta=Summary) in the notes section.
+
+### Shopper Login (SLAS)
+
+SLAS will soon require new tenants to pass `channel_id` as an argument for retrieving guest access tokens. You can read more about the planned change [here](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html#guest-tokens).
+
+Please be aware that existing tenants are on a temporary allow list and will see no immediate disruption to service.  We do ask that all users seek to adhere to the `channel_id` requirement before the end of August to enhance your security posture before the holiday peak season.
+
+In practice, we recommend:
+
+- For customers using the SLAS helpers with a public client, it is recommended to upgrade to at least `v1.8.0` of the `commerce-sdk-isomorphic`.
+- For customers using the SLAS helpers with a private client, it is recommended to upgrade to `v3.0.0` of the `commerce-sdk-isomorphic`.
 
 ## Getting Started
 

diff --git a/apis/shopper-context/.metadata.json b/apis/shopper-context/.metadata.json
@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-context/0.0.28",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-context/0.0.29",
   "name": "Shopper Context",
   "description": "The Shopper Context API enables developers to build highly contextualized shopping experiences for shoppers.",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "shopper-context",
-  "version": "0.0.28",
+  "version": "0.0.29",
   "categories": {
     "API layer": [
       "System"

diff --git a/apis/shopper-context/exchange.json b/apis/shopper-context/exchange.json
@@ -11,7 +11,7 @@
       "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8"
     }
   ],
-  "version": "0.0.28",
+  "version": "0.0.29",
   "originalFormatVersion": "1.0",
   "apiVersion": "v1",
   "descriptorVersion": "0.1.0",

diff --git a/apis/shopper-context/shopper-context.raml b/apis/shopper-context/shopper-context.raml
@@ -102,11 +102,14 @@ types:
   type: CommerceCloudStandards.Organization
   /shopper-context/{usid}:
     get:
-      description: Gets the shopper's context based on the shopperJWT.
+      description: |- 
+        Gets the shopper's context based on the shopperJWT.
+        
+        With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
       displayName: getShopperContext
       queryParameters:
         siteId: 
-          description: The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
+          description: The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
           example:
             SiteGenesis
           type: string
@@ -147,7 +150,10 @@ types:
       securedBy:
         - CommerceCloudStandards.ShopperToken: { scopes: [sfcc.shopper-context, sfcc.shopper-context.rw] }    
     put:
-      description: Creates the shopper's context based on shopperJWT.
+      description: |-
+        Creates the shopper's context based on shopperJWT.
+        
+        With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
       displayName: createShopperContext
       queryParameters:
         siteId: 
@@ -200,7 +206,10 @@ types:
       securedBy:
         - CommerceCloudStandards.ShopperToken: { scopes: [sfcc.shopper-context.rw] }  
     delete:
-      description: Gets the shopper's context based on the shopperJWT.
+      description: |-
+        Gets the shopper's context based on the shopperJWT. 
+        
+        With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
       displayName: deleteShopperContext
       queryParameters:
         siteId: 
@@ -240,7 +249,10 @@ types:
       securedBy:
         - CommerceCloudStandards.ShopperToken: { scopes: [sfcc.shopper-context.rw] }    
     patch:
-      description: Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (""), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
+      description:  |-
+        Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (""), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted. 
+        
+        With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
       displayName: updateShopperContext
       queryParameters:
         siteId: 

diff --git a/apis/shopper-gift-certificates/.metadata.json b/apis/shopper-gift-certificates/.metadata.json
@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-gift-certificates/1.0.16",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-gift-certificates/1.0.17",
   "name": "Shopper Gift Certificates",
   "description": "Obtain details about a gift certificate.",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "shopper-gift-certificates",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "categories": {
     "API layer": [
       "System"

diff --git a/apis/shopper-gift-certificates/exchange.json b/apis/shopper-gift-certificates/exchange.json
@@ -11,7 +11,7 @@
       "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8"
     }
   ],
-  "version": "1.0.16",
+  "version": "1.0.17",
   "originalFormatVersion": "1.0",
   "apiVersion": "v1",
   "descriptorVersion": "0.1.0",

diff --git a/apis/shopper-gift-certificates/shopper-gift-certificates.raml b/apis/shopper-gift-certificates/shopper-gift-certificates.raml
@@ -18,7 +18,10 @@ uses:
   CommerceCloudStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/commerce-cloud-standards.raml
 types:
   GiftCertificate:
-    description: Document representing a gift certificate.
+    description: |-
+      Document representing a gift certificate.
+    type:
+      CommerceCloudStandards.OpenObject
     examples:
       gift-certificate: !include Examples/gift-certificate-example.raml
     properties:
@@ -63,7 +66,10 @@ types:
           - partially_redeemed
           - redeemed
   GiftCertificateRequest:
-    description: Document representing a gift certificate request data.
+    description: |-
+      Document representing a gift certificate request data.
+    type:
+      CommerceCloudStandards.ClosedObject
     properties:
       giftCertificateCode:
         description: The gift certificate code.

diff --git a/apis/shopper-promotions/.metadata.json b/apis/shopper-promotions/.metadata.json
@@ -1,10 +1,10 @@
 {
-  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-promotions/1.0.26",
+  "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-promotions/1.0.27",
   "name": "Shopper Promotions",
   "description": "View details for active promotions.",
   "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
   "assetId": "shopper-promotions",
-  "version": "1.0.26",
+  "version": "1.0.27",
   "categories": {
     "API layer": [
       "System"

diff --git a/apis/shopper-promotions/exchange.json b/apis/shopper-promotions/exchange.json
@@ -11,7 +11,7 @@
       "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8"
     }
   ],
-  "version": "1.0.26",
+  "version": "1.0.27",
   "originalFormatVersion": "1.0",
   "apiVersion": "v1",
   "descriptorVersion": "0.1.0",

diff --git a/apis/shopper-promotions/shopper-promotions.raml b/apis/shopper-promotions/shopper-promotions.raml
@@ -17,7 +17,10 @@ uses:
 
 types:
   Promotion:
-    description: Document representing a promotion.
+    description: |-
+      Document representing a promotion.
+    type:
+      CommerceCloudStandards.OpenObject
     properties:
       calloutMsg:
         description: The localized call-out message of the promotion.
@@ -64,7 +67,10 @@ types:
         required: false
         example: 2015-07-04T21:00:00Z
   PromotionResult:
-    description: Result document containing an array of promotions.
+    description: |-
+      Result document containing an array of promotions.
+    type:
+      CommerceCloudStandards.ClosedObject
     examples:
       promotion: !include Examples/promotions_result.raml
     properties:

diff --git a/docs/assets/js/search.json b/docs/assets/js/search.json