Skip to content

Commit d05459d

Browse files
Release v4.0.0 (#407)
* update APIs * update changelog/readme * update CHANGELOG * add shopper context RAML description changes * update docs through docs script * bump to major version
1 parent 422610a commit d05459d

File tree

236 files changed

+6252
-2615
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

236 files changed

+6252
-2615
lines changed

CHANGELOG.md

Lines changed: 38 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,48 @@
22

33
## v4.0.0
44

5-
### :warning: Planned Shopper Context Changes :warning:
5+
### :warning: Planned API Changes :warning:
66

7-
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.
7+
#### Shopper Context
8+
9+
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.
10+
11+
#### Shopper Login (SLAS)
12+
13+
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).
14+
15+
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.
16+
17+
In practice, we recommend that customers using the SLAS helper functions upgrade to `v4.0.0` of the `commerce-sdk`.
818

919
### Enchancements
1020

11-
- 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 [#406](https://github.com/SalesforceCommerceCloud/commerce-sdk/pull/406)
12-
- See the [announcement on the developer docs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html#guest-tokens) for more information
21+
- Update SLAS helper function `loginGuestUserPrivate` to require `channel_id` and `loginGuestUser` to pass in `channel_id` to SLAS through `clientConfig.parameters.siteId` [#406](https://github.com/SalesforceCommerceCloud/commerce-sdk/pull/406)
22+
23+
### API Changes
24+
25+
*CDN Zones API*
26+
27+
* Endpoints added
28+
| **Endpoint Name** | **Description** |
29+
| ------------- |-----------------------------------|
30+
| getOwaspWafPackage | Get a OWASP ModSecurity Core Rule Set. |
31+
| patchOwaspWafPackage | Patch a OWASP ModSecurity Core Rule Set. |
32+
| getWafManagedRulesInRuleset | Retrieves all rules in the specified WAFv2 managed ruleset. |
33+
| updateWafManagedRuleInRuleset | Updates a WAF managed rule in the specified WAFv2 managed ruleset. |
34+
| migrateZoneToWafV2 | Migrates a zone to WAFv2. Only applicable for existing zones using WAFv1. |
35+
| upsertOriginHeaderModification | Upsert origin header modification. |
36+
| getOriginHeaderModification | Get origin header modification associated with a zone. |
37+
| deleteOriginHeaderModification | Delete the origin header modification associated with a zone. |
38+
39+
* **BREAKING**: Removed deprecated endpoints
40+
* getFirewallRules
41+
* createFirewallRule
42+
* getFirewallRule
43+
* updateFirewallRule
44+
* deleteFirewallRule
45+
46+
NOTE: As of February 6th, 2024, firewall rules are deprecated and customers can use [eCDN custom rules](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones-custom-rules.html) moving forward.
1347

1448
## v3.1.0
1549

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,19 @@ The Salesforce Commerce SDK allows easy interaction with the Salesforce B2C Comm
44

55
Visit the [Commerce Cloud Developer Center](https://developer.salesforce.com/developer-centers/commerce-cloud) to learn more about Salesforce Commerce. The developer center has API documentation, getting started guides, community forums, and more.
66
7-
## :warning: Planned Shopper Context Changes :warning:
7+
## :warning: Planned API Changes :warning:
88

9-
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.
9+
### Shopper Context
10+
11+
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.
12+
13+
### Shopper Login (SLAS)
14+
15+
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).
16+
17+
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.
18+
19+
In practice, we recommend that customers using the SLAS helper functions upgrade to `v4.0.0` of the `commerce-sdk`.
1020

1121
## Prerequisites
1222

apis/cdn/cdn-api-process-apis/.metadata.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
2-
"id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis/1.0.30",
2+
"id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/cdn-api-process-apis/1.0.32",
33
"name": "CDN Zones",
44
"description": "Extend your eCDN beyond Business Manager configuration.",
55
"groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8",
66
"assetId": "cdn-api-process-apis",
7-
"version": "1.0.30",
7+
"version": "1.0.32",
88
"categories": {
99
"API layer": [
1010
"Process"

apis/cdn/cdn-api-process-apis/cdn-zones-description.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ The API client must also have at least one of the following OAuth scopes: `sfcc.
1717

1818
For detailed setup instructions, see the [Authorization for Admin APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-admin-apis.html) guide.
1919

20+
You must include the relevant scope(s) in the client ID used to generate the token. For details, see the [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html)
21+
2022
## Use Cases
2123

2224
For detailed usage information, refer to the [CDN Zones Guides.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-zones.html)

0 commit comments

Comments
 (0)