commerce-sdk-isomorphic 5.7.0 → 5.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -385,6 +385,12 @@ type GrantType = "authorization_code" | "refresh_token" | "client_credentials" |
385
385
  * @property signatureCount: The signature counter for replay attack prevention
386
386
  * - **Max Length:** 8
387
387
  *
388
+ * @property createdTime: The date and time when this credential was registered
389
+ *
390
+ * @property lastUsed: The date and time when this credential was last used for authentication
391
+ *
392
+ * @property uses: The number of times this credential has been used for authentication
393
+ *
388
394
  */
389
395
  type PasskeyCredential = {
390
396
  id?: number;
@@ -394,6 +400,9 @@ type PasskeyCredential = {
394
400
  publicKey?: string;
395
401
  userHandle?: string;
396
402
  signatureCount?: string;
403
+ createdTime?: string;
404
+ lastUsed?: string;
405
+ uses?: number;
397
406
  } & {
398
407
  [key: string]: any;
399
408
  };
@@ -652,7 +661,8 @@ type getPasswordLessAccessTokenBodyType = {
652
661
  pwdless_login_token: string;
653
662
  client_id?: string;
654
663
  code_verifier?: string;
655
- login_id?: string;
664
+ channel_id: string;
665
+ login_id: string;
656
666
  };
657
667
  type getPasswordResetTokenQueryParameters = {};
658
668
  type getPasswordResetTokenPathParameters = {
@@ -781,7 +791,7 @@ type resetPasswordBodyType = {
781
791
  new_password?: string;
782
792
  channel_id: string;
783
793
  hint?: string;
784
- user_id?: string;
794
+ user_id: string;
785
795
  };
786
796
  type revokeTokenQueryParameters = {};
787
797
  type revokeTokenPathParameters = {
@@ -847,7 +857,21 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
847
857
 
848
858
  **Important:** Before using this API, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides and the more detailed [SLAS guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html) for instructions on setting up a SLAS client, obtaining credentials, as well as flow and use case information.
849
859
 
850
- For load shedding and rate limiting information, see [Load Shedding and Rate Limiting.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/throttle-rates.html)*<br />
860
+ For load shedding and rate limiting information, see [Load Shedding and Rate Limiting.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/throttle-rates.html)
861
+
862
+ ## Response Details
863
+
864
+ ### Timeouts
865
+
866
+ Shopper API requests must respond within 10 seconds, including any hook execution. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see [Timeouts and Limits.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/timeouts-limits.html)
867
+
868
+ ### Error Handling
869
+
870
+ Error responses follow the [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail format. To trace errors, include a `correlation-id` header in your request — the response returns it as `x-correlation-id`. For details, see [HTTP Status Codes and Errors.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/error-response-codes.html)
871
+
872
+ ## Related APIs
873
+
874
+ - [SLAS Admin API](https://developer.salesforce.com/docs/commerce/commerce-api/references/auth-admin?meta=Summary) — Manage SLAS tenants, clients, and identity providers.*<br />
851
875
  *
852
876
  * Simple example:
853
877
  *
@@ -1055,15 +1079,18 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
1055
1079
  "grant_type",
1056
1080
  "hint",
1057
1081
  "pwdless_login_token",
1082
+ "channel_id",
1083
+ "login_id",
1058
1084
  "client_id",
1059
- "code_verifier",
1060
- "login_id"
1085
+ "code_verifier"
1061
1086
  ];
1062
1087
  readonly getPasswordLessAccessTokenRequired: readonly [
1063
1088
  "organizationId",
1064
1089
  "grant_type",
1065
1090
  "hint",
1066
- "pwdless_login_token"
1091
+ "pwdless_login_token",
1092
+ "channel_id",
1093
+ "login_id"
1067
1094
  ];
1068
1095
  readonly getPasswordResetToken: readonly [
1069
1096
  "organizationId",
@@ -1226,16 +1253,17 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
1226
1253
  "client_id",
1227
1254
  "pwd_action_token",
1228
1255
  "channel_id",
1256
+ "user_id",
1229
1257
  "code_verifier",
1230
1258
  "new_password",
1231
- "hint",
1232
- "user_id"
1259
+ "hint"
1233
1260
  ];
1234
1261
  readonly resetPasswordRequired: readonly [
1235
1262
  "organizationId",
1236
1263
  "client_id",
1237
1264
  "pwd_action_token",
1238
- "channel_id"
1265
+ "channel_id",
1266
+ "user_id"
1239
1267
  ];
1240
1268
  readonly revokeToken: readonly [
1241
1269
  "organizationId",
@@ -1387,7 +1415,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
1387
1415
 
1388
1416
  * @param options.parameters.response_type - Must be `code`. Indicates that the caller wants an authorization code.
1389
1417
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
1390
- * @param options.parameters.scope -
1418
+ * @param options.parameters.scope - The OAuth scopes to include in the token.
1391
1419
  * @param options.parameters.state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
1392
1420
  * @param options.parameters.usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
1393
1421
  * @param options.parameters.hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
@@ -1444,7 +1472,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
1444
1472
 
1445
1473
  * @param options.parameters.response_type - Must be `code`. Indicates that the caller wants an authorization code.
1446
1474
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
1447
- * @param options.parameters.scope -
1475
+ * @param options.parameters.scope - The OAuth scopes to include in the token.
1448
1476
  * @param options.parameters.state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
1449
1477
  * @param options.parameters.usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
1450
1478
  * @param options.parameters.hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
@@ -2281,7 +2309,8 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
2281
2309
  * @param options.body.pwdless_login_token - Passwordless login token that was created from the user ID.
2282
2310
  * @param options.body.client_id - The public client ID.
2283
2311
  * @param options.body.code_verifier - PKCE code verifier. Created by the client. The `code_challenge` is created by SHA256 hashing the `code_verifier` and Base64 encoding the resulting hash. The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
2284
- * @param options.body.login_id - The ID used by the shopper for password token request. When provided, login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
2312
+ * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
2313
+ * @param options.body.login_id - The ID used by the shopper for password token request. The login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
2285
2314
  *
2286
2315
  * @returns A promise of type TokenResponse.
2287
2316
  */
@@ -2378,7 +2407,8 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
2378
2407
  * @param options.body.pwdless_login_token - Passwordless login token that was created from the user ID.
2379
2408
  * @param options.body.client_id - The public client ID.
2380
2409
  * @param options.body.code_verifier - PKCE code verifier. Created by the client. The `code_challenge` is created by SHA256 hashing the `code_verifier` and Base64 encoding the resulting hash. The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
2381
- * @param options.body.login_id - The ID used by the shopper for password token request. When provided, login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
2410
+ * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
2411
+ * @param options.body.login_id - The ID used by the shopper for password token request. The login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
2382
2412
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
2383
2413
  *
2384
2414
  * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
@@ -3067,7 +3097,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
3067
3097
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
3068
3098
  * @param options.parameters.refresh_token - Refresh token that was given during the access token request.
3069
3099
  * @param options.parameters.channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with B2C Commerce.
3070
- * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID.
3100
+ * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID. Starting in B2C Commerce 26.8, it also invalidates all access tokens issued prior to invoking logout for that shopper.
3071
3101
  This only works within the same session type. Sessions created through different authentication methods (/authorize vs. Trusted System On Behalf) are treated as separate sessions. To invalidate tokens with different SLAS User IDs, you must make explicit logout calls with each token.
3072
3102
  A shopper authenticated via both /authorize and TSOB has two separate sessions. You will need two logout calls (one per token) to fully log them out.
3073
3103
 
@@ -3103,7 +3133,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
3103
3133
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
3104
3134
  * @param options.parameters.refresh_token - Refresh token that was given during the access token request.
3105
3135
  * @param options.parameters.channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with B2C Commerce.
3106
- * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID.
3136
+ * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID. Starting in B2C Commerce 26.8, it also invalidates all access tokens issued prior to invoking logout for that shopper.
3107
3137
  This only works within the same session type. Sessions created through different authentication methods (/authorize vs. Trusted System On Behalf) are treated as separate sessions. To invalidate tokens with different SLAS User IDs, you must make explicit logout calls with each token.
3108
3138
  A shopper authenticated via both /authorize and TSOB has two separate sessions. You will need two logout calls (one per token) to fully log them out.
3109
3139
 
@@ -3206,7 +3236,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
3206
3236
  * @param options.body.new_password - The new password to set for the shopper associated with the password action token.
3207
3237
  * @param options.body.channel_id - The channel that the request is for. For a B2C Commerce request, this is angalous to the site ID.
3208
3238
  * @param options.body.hint - Adding a `hint` query parameter with a value of `cross_device` will remove the need to have the code_verifier for password reset request. If the `hint` query parameter is used it must also have been used in the password action request.
3209
- * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC. Required only when hint is provided.
3239
+ * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC.
3210
3240
  *
3211
3241
  * @returns A promise of type void.
3212
3242
  */
@@ -3233,7 +3263,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
3233
3263
  * @param options.body.new_password - The new password to set for the shopper associated with the password action token.
3234
3264
  * @param options.body.channel_id - The channel that the request is for. For a B2C Commerce request, this is angalous to the site ID.
3235
3265
  * @param options.body.hint - Adding a `hint` query parameter with a value of `cross_device` will remove the need to have the code_verifier for password reset request. If the `hint` query parameter is used it must also have been used in the password action request.
3236
- * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC. Required only when hint is provided.
3266
+ * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC.
3237
3267
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
3238
3268
  *
3239
3269
  * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
@@ -3865,6 +3895,12 @@ declare namespace ShopperLoginApiTypes {
3865
3895
  * @property signatureCount: The signature counter for replay attack prevention
3866
3896
  * - **Max Length:** 8
3867
3897
  *
3898
+ * @property createdTime: The date and time when this credential was registered
3899
+ *
3900
+ * @property lastUsed: The date and time when this credential was last used for authentication
3901
+ *
3902
+ * @property uses: The number of times this credential has been used for authentication
3903
+ *
3868
3904
  */
3869
3905
  type PasskeyCredential = {
3870
3906
  id?: number;
@@ -3874,6 +3910,9 @@ declare namespace ShopperLoginApiTypes {
3874
3910
  publicKey?: string;
3875
3911
  userHandle?: string;
3876
3912
  signatureCount?: string;
3913
+ createdTime?: string;
3914
+ lastUsed?: string;
3915
+ uses?: number;
3877
3916
  } & {
3878
3917
  [key: string]: any;
3879
3918
  };
@@ -4144,7 +4183,8 @@ declare namespace ShopperLoginApiTypes {
4144
4183
  pwdless_login_token: string;
4145
4184
  client_id?: string;
4146
4185
  code_verifier?: string;
4147
- login_id?: string;
4186
+ channel_id: string;
4187
+ login_id: string;
4148
4188
  };
4149
4189
  type getPasswordResetTokenQueryParameters = {};
4150
4190
  type getPasswordResetTokenPathParameters = {
@@ -4273,7 +4313,7 @@ declare namespace ShopperLoginApiTypes {
4273
4313
  new_password?: string;
4274
4314
  channel_id: string;
4275
4315
  hint?: string;
4276
- user_id?: string;
4316
+ user_id: string;
4277
4317
  };
4278
4318
  type revokeTokenQueryParameters = {};
4279
4319
  type revokeTokenPathParameters = {
@@ -4342,7 +4382,21 @@ declare namespace ShopperLoginApiTypes {
4342
4382
 
4343
4383
  **Important:** Before using this API, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides and the more detailed [SLAS guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html) for instructions on setting up a SLAS client, obtaining credentials, as well as flow and use case information.
4344
4384
 
4345
- For load shedding and rate limiting information, see [Load Shedding and Rate Limiting.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/throttle-rates.html)*<br />
4385
+ For load shedding and rate limiting information, see [Load Shedding and Rate Limiting.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/throttle-rates.html)
4386
+
4387
+ ## Response Details
4388
+
4389
+ ### Timeouts
4390
+
4391
+ Shopper API requests must respond within 10 seconds, including any hook execution. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see [Timeouts and Limits.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/timeouts-limits.html)
4392
+
4393
+ ### Error Handling
4394
+
4395
+ Error responses follow the [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail format. To trace errors, include a `correlation-id` header in your request — the response returns it as `x-correlation-id`. For details, see [HTTP Status Codes and Errors.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/error-response-codes.html)
4396
+
4397
+ ## Related APIs
4398
+
4399
+ - [SLAS Admin API](https://developer.salesforce.com/docs/commerce/commerce-api/references/auth-admin?meta=Summary) — Manage SLAS tenants, clients, and identity providers.*<br />
4346
4400
  *
4347
4401
  * Simple example:
4348
4402
  *
@@ -4550,15 +4604,18 @@ declare namespace ShopperLoginApiTypes {
4550
4604
  "grant_type",
4551
4605
  "hint",
4552
4606
  "pwdless_login_token",
4607
+ "channel_id",
4608
+ "login_id",
4553
4609
  "client_id",
4554
- "code_verifier",
4555
- "login_id"
4610
+ "code_verifier"
4556
4611
  ];
4557
4612
  readonly getPasswordLessAccessTokenRequired: readonly [
4558
4613
  "organizationId",
4559
4614
  "grant_type",
4560
4615
  "hint",
4561
- "pwdless_login_token"
4616
+ "pwdless_login_token",
4617
+ "channel_id",
4618
+ "login_id"
4562
4619
  ];
4563
4620
  readonly getPasswordResetToken: readonly [
4564
4621
  "organizationId",
@@ -4721,16 +4778,17 @@ declare namespace ShopperLoginApiTypes {
4721
4778
  "client_id",
4722
4779
  "pwd_action_token",
4723
4780
  "channel_id",
4781
+ "user_id",
4724
4782
  "code_verifier",
4725
4783
  "new_password",
4726
- "hint",
4727
- "user_id"
4784
+ "hint"
4728
4785
  ];
4729
4786
  readonly resetPasswordRequired: readonly [
4730
4787
  "organizationId",
4731
4788
  "client_id",
4732
4789
  "pwd_action_token",
4733
- "channel_id"
4790
+ "channel_id",
4791
+ "user_id"
4734
4792
  ];
4735
4793
  readonly revokeToken: readonly [
4736
4794
  "organizationId",
@@ -4882,7 +4940,7 @@ declare namespace ShopperLoginApiTypes {
4882
4940
 
4883
4941
  * @param options.parameters.response_type - Must be `code`. Indicates that the caller wants an authorization code.
4884
4942
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
4885
- * @param options.parameters.scope -
4943
+ * @param options.parameters.scope - The OAuth scopes to include in the token.
4886
4944
  * @param options.parameters.state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
4887
4945
  * @param options.parameters.usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
4888
4946
  * @param options.parameters.hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
@@ -4939,7 +4997,7 @@ declare namespace ShopperLoginApiTypes {
4939
4997
 
4940
4998
  * @param options.parameters.response_type - Must be `code`. Indicates that the caller wants an authorization code.
4941
4999
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
4942
- * @param options.parameters.scope -
5000
+ * @param options.parameters.scope - The OAuth scopes to include in the token.
4943
5001
  * @param options.parameters.state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
4944
5002
  * @param options.parameters.usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
4945
5003
  * @param options.parameters.hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
@@ -5776,7 +5834,8 @@ declare namespace ShopperLoginApiTypes {
5776
5834
  * @param options.body.pwdless_login_token - Passwordless login token that was created from the user ID.
5777
5835
  * @param options.body.client_id - The public client ID.
5778
5836
  * @param options.body.code_verifier - PKCE code verifier. Created by the client. The `code_challenge` is created by SHA256 hashing the `code_verifier` and Base64 encoding the resulting hash. The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
5779
- * @param options.body.login_id - The ID used by the shopper for password token request. When provided, login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
5837
+ * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
5838
+ * @param options.body.login_id - The ID used by the shopper for password token request. The login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
5780
5839
  *
5781
5840
  * @returns A promise of type TokenResponse.
5782
5841
  */
@@ -5873,7 +5932,8 @@ declare namespace ShopperLoginApiTypes {
5873
5932
  * @param options.body.pwdless_login_token - Passwordless login token that was created from the user ID.
5874
5933
  * @param options.body.client_id - The public client ID.
5875
5934
  * @param options.body.code_verifier - PKCE code verifier. Created by the client. The `code_challenge` is created by SHA256 hashing the `code_verifier` and Base64 encoding the resulting hash. The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
5876
- * @param options.body.login_id - The ID used by the shopper for password token request. When provided, login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
5935
+ * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
5936
+ * @param options.body.login_id - The ID used by the shopper for password token request. The login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
5877
5937
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
5878
5938
  *
5879
5939
  * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
@@ -6562,7 +6622,7 @@ declare namespace ShopperLoginApiTypes {
6562
6622
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
6563
6623
  * @param options.parameters.refresh_token - Refresh token that was given during the access token request.
6564
6624
  * @param options.parameters.channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with B2C Commerce.
6565
- * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID.
6625
+ * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID. Starting in B2C Commerce 26.8, it also invalidates all access tokens issued prior to invoking logout for that shopper.
6566
6626
  This only works within the same session type. Sessions created through different authentication methods (/authorize vs. Trusted System On Behalf) are treated as separate sessions. To invalidate tokens with different SLAS User IDs, you must make explicit logout calls with each token.
6567
6627
  A shopper authenticated via both /authorize and TSOB has two separate sessions. You will need two logout calls (one per token) to fully log them out.
6568
6628
 
@@ -6598,7 +6658,7 @@ declare namespace ShopperLoginApiTypes {
6598
6658
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
6599
6659
  * @param options.parameters.refresh_token - Refresh token that was given during the access token request.
6600
6660
  * @param options.parameters.channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with B2C Commerce.
6601
- * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID.
6661
+ * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID. Starting in B2C Commerce 26.8, it also invalidates all access tokens issued prior to invoking logout for that shopper.
6602
6662
  This only works within the same session type. Sessions created through different authentication methods (/authorize vs. Trusted System On Behalf) are treated as separate sessions. To invalidate tokens with different SLAS User IDs, you must make explicit logout calls with each token.
6603
6663
  A shopper authenticated via both /authorize and TSOB has two separate sessions. You will need two logout calls (one per token) to fully log them out.
6604
6664
 
@@ -6701,7 +6761,7 @@ declare namespace ShopperLoginApiTypes {
6701
6761
  * @param options.body.new_password - The new password to set for the shopper associated with the password action token.
6702
6762
  * @param options.body.channel_id - The channel that the request is for. For a B2C Commerce request, this is angalous to the site ID.
6703
6763
  * @param options.body.hint - Adding a `hint` query parameter with a value of `cross_device` will remove the need to have the code_verifier for password reset request. If the `hint` query parameter is used it must also have been used in the password action request.
6704
- * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC. Required only when hint is provided.
6764
+ * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC.
6705
6765
  *
6706
6766
  * @returns A promise of type void.
6707
6767
  */
@@ -6728,7 +6788,7 @@ declare namespace ShopperLoginApiTypes {
6728
6788
  * @param options.body.new_password - The new password to set for the shopper associated with the password action token.
6729
6789
  * @param options.body.channel_id - The channel that the request is for. For a B2C Commerce request, this is angalous to the site ID.
6730
6790
  * @param options.body.hint - Adding a `hint` query parameter with a value of `cross_device` will remove the need to have the code_verifier for password reset request. If the `hint` query parameter is used it must also have been used in the password action request.
6731
- * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC. Required only when hint is provided.
6791
+ * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC.
6732
6792
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
6733
6793
  *
6734
6794
  * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
@@ -7246,6 +7306,12 @@ declare namespace ShopperLoginModelTypes {
7246
7306
  * @property signatureCount: The signature counter for replay attack prevention
7247
7307
  * - **Max Length:** 8
7248
7308
  *
7309
+ * @property createdTime: The date and time when this credential was registered
7310
+ *
7311
+ * @property lastUsed: The date and time when this credential was last used for authentication
7312
+ *
7313
+ * @property uses: The number of times this credential has been used for authentication
7314
+ *
7249
7315
  */
7250
7316
  type PasskeyCredential = {
7251
7317
  id?: number;
@@ -7255,6 +7321,9 @@ declare namespace ShopperLoginModelTypes {
7255
7321
  publicKey?: string;
7256
7322
  userHandle?: string;
7257
7323
  signatureCount?: string;
7324
+ createdTime?: string;
7325
+ lastUsed?: string;
7326
+ uses?: number;
7258
7327
  } & {
7259
7328
  [key: string]: any;
7260
7329
  };
@@ -50995,6 +51064,18 @@ type PageResult = {
50995
51064
  } & {
50996
51065
  [key: string]: any;
50997
51066
  };
51067
+ /**
51068
+ * @type PreviewContextApplyRequest:
51069
+ *
51070
+ * @property token: The signed preview context token minted by the Business Manager share endpoint.
51071
+ * - **Max Length:** 8192
51072
+ *
51073
+ */
51074
+ type PreviewContextApplyRequest = {
51075
+ token: string;
51076
+ } & {
51077
+ [key: string]: any;
51078
+ };
50998
51079
  /**
50999
51080
  * @type QualifierResolveRequest: Request body for resolving customer group qualifications, campaign promotion eligibility, and data bindings. All fields are optional. An empty body is valid and returns an empty response.
51000
51081
  *
@@ -51054,6 +51135,12 @@ type GetMultipleContentPersonalizedEnum = "none";
51054
51135
  type GetPagePersonalizedEnum = "none";
51055
51136
  type GetPagesPersonalizedEnum = "none";
51056
51137
  type SearchContentPersonalizedEnum = "none";
51138
+ type applyPreviewContextQueryParameters = {
51139
+ siteId: string;
51140
+ };
51141
+ type applyPreviewContextPathParameters = {
51142
+ organizationId: string;
51143
+ };
51057
51144
  type getComponentQueryParameters = {
51058
51145
  parameters?: string;
51059
51146
  siteId: string;
@@ -51149,11 +51236,11 @@ type searchContentPathParameters = {
51149
51236
  /**
51150
51237
  * All path parameters that are used by at least one ShopperExperience method.
51151
51238
  */
51152
- type ShopperExperiencePathParameters = Partial<getComponentPathParameters & getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & resolveQualifiersPathParameters & searchContentPathParameters & {}>;
51239
+ type ShopperExperiencePathParameters = Partial<applyPreviewContextPathParameters & getComponentPathParameters & getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & resolveQualifiersPathParameters & searchContentPathParameters & {}>;
51153
51240
  /**
51154
51241
  * All query parameters that are used by at least one ShopperExperience method.
51155
51242
  */
51156
- type ShopperExperienceQueryParameters = Partial<getComponentQueryParameters & getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & resolveQualifiersQueryParameters & searchContentQueryParameters & {}>;
51243
+ type ShopperExperienceQueryParameters = Partial<applyPreviewContextQueryParameters & getComponentQueryParameters & getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & resolveQualifiersQueryParameters & searchContentQueryParameters & {}>;
51157
51244
  /**
51158
51245
  * All parameters that are used by ShopperExperience.
51159
51246
  */
@@ -51290,6 +51377,7 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51290
51377
  };
51291
51378
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/v1";
51292
51379
  static readonly apiPaths: {
51380
+ applyPreviewContext: string;
51293
51381
  getComponent: string;
51294
51382
  getContent: string;
51295
51383
  getContentFolder: string;
@@ -51302,6 +51390,14 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51302
51390
  };
51303
51391
  constructor(config: ClientConfigInit<ConfigParameters>);
51304
51392
  static readonly paramKeys: {
51393
+ readonly applyPreviewContext: readonly [
51394
+ "organizationId",
51395
+ "siteId"
51396
+ ];
51397
+ readonly applyPreviewContextRequired: readonly [
51398
+ "organizationId",
51399
+ "siteId"
51400
+ ];
51305
51401
  readonly getComponent: readonly [
51306
51402
  "organizationId",
51307
51403
  "componentId",
@@ -51420,6 +51516,63 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51420
51516
  "siteId"
51421
51517
  ];
51422
51518
  };
51519
+ /**
51520
+ * Applies a shareable storefront preview context to the shopper session resolved from the caller's `ShopperToken`. The server verifies the signed `token`, decodes the enclosed shopper context claims (customer group, effective date, source code, custom qualifiers), and writes them to the shopper session so that subsequent storefront requests reflect the preview facets.
51521
+
51522
+ **Important**:
51523
+ - The `token` is expected to be minted by the Business Manager share endpoint. Signature and expiry are enforced server-side.
51524
+ - The target shopper session is identified by the caller's `ShopperToken`; callers cannot apply to another shopper's session.
51525
+
51526
+ *
51527
+ * If you would like to get a raw Response object use the other applyPreviewContext function.
51528
+ *
51529
+ * @param options - An object containing the options for this method.
51530
+ * @param options.parameters - An object containing the parameters for this method.
51531
+ * @param options.parameters.organizationId - An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).
51532
+ * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51533
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51534
+ * @param options.body - The data to send as the request body.
51535
+ *
51536
+ * @returns A promise of type void.
51537
+ */
51538
+ applyPreviewContext(options: RequireParametersUnlessAllAreOptional<{
51539
+ parameters?: CompositeParameters<{
51540
+ organizationId: string;
51541
+ siteId: string;
51542
+ } & QueryParameters, ConfigParameters>;
51543
+ headers?: {
51544
+ [key: string]: string;
51545
+ };
51546
+ body: PreviewContextApplyRequest & CustomRequestBody;
51547
+ }>): Promise<void>;
51548
+ /**
51549
+ * Applies a shareable storefront preview context to the shopper session resolved from the caller's `ShopperToken`. The server verifies the signed `token`, decodes the enclosed shopper context claims (customer group, effective date, source code, custom qualifiers), and writes them to the shopper session so that subsequent storefront requests reflect the preview facets.
51550
+
51551
+ **Important**:
51552
+ - The `token` is expected to be minted by the Business Manager share endpoint. Signature and expiry are enforced server-side.
51553
+ - The target shopper session is identified by the caller's `ShopperToken`; callers cannot apply to another shopper's session.
51554
+
51555
+ *
51556
+ * @param options - An object containing the options for this method.
51557
+ * @param options.parameters - An object containing the parameters for this method.
51558
+ * @param options.parameters.organizationId - An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).
51559
+ * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51560
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51561
+ * @param options.body - The data to send as the request body.
51562
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
51563
+ *
51564
+ * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
51565
+ */
51566
+ applyPreviewContext<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
51567
+ parameters?: CompositeParameters<{
51568
+ organizationId: string;
51569
+ siteId: string;
51570
+ } & QueryParameters, ConfigParameters>;
51571
+ headers?: {
51572
+ [key: string]: string;
51573
+ };
51574
+ body: PreviewContextApplyRequest & CustomRequestBody;
51575
+ }>, rawResponse?: T): Promise<T extends true ? Response : void>;
51423
51576
  /**
51424
51577
  * Get a Page Designer component by its unique identifier. The results apply the visibility rules for the component, such as personalization or scheduled visibility.
51425
51578
 
@@ -51435,7 +51588,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51435
51588
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51436
51589
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
51437
51590
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51438
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51591
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51592
+
51593
+ When set to `none`, the server skips applying personalization to the response.
51594
+
51595
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51439
51596
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51440
51597
  *
51441
51598
  * @returns A promise of type Component.
@@ -51466,7 +51623,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51466
51623
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51467
51624
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
51468
51625
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51469
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51626
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51627
+
51628
+ When set to `none`, the server skips applying personalization to the response.
51629
+
51630
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51470
51631
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51471
51632
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
51472
51633
  *
@@ -51501,7 +51662,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51501
51662
  * @param options.parameters.id - Identifier for the requested content asset.
51502
51663
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51503
51664
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51504
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51665
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51666
+
51667
+ When set to `none`, the server skips applying personalization to the response.
51668
+
51669
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51505
51670
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51506
51671
  *
51507
51672
  * @returns A promise of type Content.
@@ -51532,7 +51697,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51532
51697
  * @param options.parameters.id - Identifier for the requested content asset.
51533
51698
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51534
51699
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51535
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51700
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51701
+
51702
+ When set to `none`, the server skips applying personalization to the response.
51703
+
51704
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51536
51705
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51537
51706
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
51538
51707
  *
@@ -51565,7 +51734,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51565
51734
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51566
51735
  * @param options.parameters.levels - Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
51567
51736
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51568
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51737
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51738
+
51739
+ When set to `none`, the server skips applying personalization to the response.
51740
+
51741
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51569
51742
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51570
51743
  *
51571
51744
  * @returns A promise of type ContentFolder.
@@ -51596,7 +51769,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51596
51769
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51597
51770
  * @param options.parameters.levels - Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
51598
51771
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51599
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51772
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51773
+
51774
+ When set to `none`, the server skips applying personalization to the response.
51775
+
51776
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51600
51777
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51601
51778
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
51602
51779
  *
@@ -51630,7 +51807,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51630
51807
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51631
51808
  * @param options.parameters.levels - Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
51632
51809
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51633
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51810
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51811
+
51812
+ When set to `none`, the server skips applying personalization to the response.
51813
+
51814
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51634
51815
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51635
51816
  *
51636
51817
  * @returns A promise of type ContentFolderResult.
@@ -51661,7 +51842,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51661
51842
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51662
51843
  * @param options.parameters.levels - Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
51663
51844
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51664
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51845
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51846
+
51847
+ When set to `none`, the server skips applying personalization to the response.
51848
+
51849
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51665
51850
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51666
51851
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
51667
51852
  *
@@ -51696,7 +51881,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51696
51881
  * @param options.parameters.ids - Comma-separated list of content asset identifiers to retrieve.
51697
51882
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51698
51883
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51699
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51884
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51885
+
51886
+ When set to `none`, the server skips applying personalization to the response.
51887
+
51888
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51700
51889
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51701
51890
  *
51702
51891
  * @returns A promise of type ContentResult.
@@ -51727,7 +51916,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51727
51916
  * @param options.parameters.ids - Comma-separated list of content asset identifiers to retrieve.
51728
51917
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
51729
51918
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51730
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51919
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51920
+
51921
+ When set to `none`, the server skips applying personalization to the response.
51922
+
51923
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51731
51924
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51732
51925
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
51733
51926
  *
@@ -51763,7 +51956,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51763
51956
  * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
51764
51957
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
51765
51958
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51766
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51959
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51960
+
51961
+ When set to `none`, the server skips applying personalization to the response.
51962
+
51963
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51767
51964
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51768
51965
  *
51769
51966
  * @returns A promise of type Page.
@@ -51798,7 +51995,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51798
51995
  * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
51799
51996
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
51800
51997
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51801
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
51998
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
51999
+
52000
+ When set to `none`, the server skips applying personalization to the response.
52001
+
52002
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51802
52003
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51803
52004
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
51804
52005
  *
@@ -51840,7 +52041,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51840
52041
  * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
51841
52042
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
51842
52043
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51843
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
52044
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
52045
+
52046
+ When set to `none`, the server skips applying personalization to the response.
52047
+
52048
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51844
52049
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51845
52050
  *
51846
52051
  * @returns A promise of type PageResult.
@@ -51881,7 +52086,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51881
52086
  * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
51882
52087
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
51883
52088
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
51884
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
52089
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
52090
+
52091
+ When set to `none`, the server skips applying personalization to the response.
52092
+
52093
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
51885
52094
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
51886
52095
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
51887
52096
  *
@@ -51999,7 +52208,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
51999
52208
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
52000
52209
  * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
52001
52210
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
52002
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
52211
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
52212
+
52213
+ When set to `none`, the server skips applying personalization to the response.
52214
+
52215
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
52003
52216
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
52004
52217
  *
52005
52218
  * @returns A promise of type ContentSearchResult.
@@ -52047,7 +52260,11 @@ declare class ShopperExperience<ConfigParameters extends ShopperExperienceParame
52047
52260
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
52048
52261
  * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
52049
52262
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
52050
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
52263
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
52264
+
52265
+ When set to `none`, the server skips applying personalization to the response.
52266
+
52267
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
52051
52268
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
52052
52269
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
52053
52270
  *
@@ -52575,6 +52792,18 @@ declare namespace ShopperExperienceApiTypes {
52575
52792
  } & {
52576
52793
  [key: string]: any;
52577
52794
  };
52795
+ /**
52796
+ * @type PreviewContextApplyRequest:
52797
+ *
52798
+ * @property token: The signed preview context token minted by the Business Manager share endpoint.
52799
+ * - **Max Length:** 8192
52800
+ *
52801
+ */
52802
+ type PreviewContextApplyRequest = {
52803
+ token: string;
52804
+ } & {
52805
+ [key: string]: any;
52806
+ };
52578
52807
  /**
52579
52808
  * @type QualifierResolveRequest: Request body for resolving customer group qualifications, campaign promotion eligibility, and data bindings. All fields are optional. An empty body is valid and returns an empty response.
52580
52809
  *
@@ -52640,14 +52869,29 @@ declare namespace ShopperExperienceApiTypes {
52640
52869
  } & {
52641
52870
  [key: string]: any;
52642
52871
  };
52872
+ type GetComponentSfdcDwDntEnum = "0" | "1";
52643
52873
  type GetComponentPersonalizedEnum = "none";
52874
+ type GetContentSfdcDwDntEnum = "0" | "1";
52644
52875
  type GetContentPersonalizedEnum = "none";
52876
+ type GetContentFolderSfdcDwDntEnum = "0" | "1";
52645
52877
  type GetContentFolderPersonalizedEnum = "none";
52878
+ type GetContentFoldersSfdcDwDntEnum = "0" | "1";
52646
52879
  type GetContentFoldersPersonalizedEnum = "none";
52880
+ type GetMultipleContentSfdcDwDntEnum = "0" | "1";
52647
52881
  type GetMultipleContentPersonalizedEnum = "none";
52882
+ type GetPageSfdcDwDntEnum = "0" | "1";
52648
52883
  type GetPagePersonalizedEnum = "none";
52884
+ type GetPagesSfdcDwDntEnum = "0" | "1";
52649
52885
  type GetPagesPersonalizedEnum = "none";
52886
+ type ResolveQualifiersSfdcDwDntEnum = "0" | "1";
52887
+ type SearchContentSfdcDwDntEnum = "0" | "1";
52650
52888
  type SearchContentPersonalizedEnum = "none";
52889
+ type applyPreviewContextQueryParameters = {
52890
+ siteId: string;
52891
+ };
52892
+ type applyPreviewContextPathParameters = {
52893
+ organizationId: string;
52894
+ };
52651
52895
  type getComponentQueryParameters = {
52652
52896
  parameters?: string;
52653
52897
  siteId: string;
@@ -52743,11 +52987,11 @@ declare namespace ShopperExperienceApiTypes {
52743
52987
  /**
52744
52988
  * All path parameters that are used by at least one ShopperExperience method.
52745
52989
  */
52746
- type ShopperExperiencePathParameters = Partial<getComponentPathParameters & getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & resolveQualifiersPathParameters & searchContentPathParameters & {}>;
52990
+ type ShopperExperiencePathParameters = Partial<applyPreviewContextPathParameters & getComponentPathParameters & getContentPathParameters & getContentFolderPathParameters & getContentFoldersPathParameters & getMultipleContentPathParameters & getPagePathParameters & getPagesPathParameters & resolveQualifiersPathParameters & searchContentPathParameters & {}>;
52747
52991
  /**
52748
52992
  * All query parameters that are used by at least one ShopperExperience method.
52749
52993
  */
52750
- type ShopperExperienceQueryParameters = Partial<getComponentQueryParameters & getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & resolveQualifiersQueryParameters & searchContentQueryParameters & {}>;
52994
+ type ShopperExperienceQueryParameters = Partial<applyPreviewContextQueryParameters & getComponentQueryParameters & getContentQueryParameters & getContentFolderQueryParameters & getContentFoldersQueryParameters & getMultipleContentQueryParameters & getPageQueryParameters & getPagesQueryParameters & resolveQualifiersQueryParameters & searchContentQueryParameters & {}>;
52751
52995
  /**
52752
52996
  * All parameters that are used by ShopperExperience.
52753
52997
  */
@@ -52884,6 +53128,7 @@ declare namespace ShopperExperienceApiTypes {
52884
53128
  };
52885
53129
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/experience/shopper-experience/v1";
52886
53130
  static readonly apiPaths: {
53131
+ applyPreviewContext: string;
52887
53132
  getComponent: string;
52888
53133
  getContent: string;
52889
53134
  getContentFolder: string;
@@ -52896,6 +53141,14 @@ declare namespace ShopperExperienceApiTypes {
52896
53141
  };
52897
53142
  constructor(config: ClientConfigInit<ConfigParameters>);
52898
53143
  static readonly paramKeys: {
53144
+ readonly applyPreviewContext: readonly [
53145
+ "organizationId",
53146
+ "siteId"
53147
+ ];
53148
+ readonly applyPreviewContextRequired: readonly [
53149
+ "organizationId",
53150
+ "siteId"
53151
+ ];
52899
53152
  readonly getComponent: readonly [
52900
53153
  "organizationId",
52901
53154
  "componentId",
@@ -53014,6 +53267,63 @@ declare namespace ShopperExperienceApiTypes {
53014
53267
  "siteId"
53015
53268
  ];
53016
53269
  };
53270
+ /**
53271
+ * Applies a shareable storefront preview context to the shopper session resolved from the caller's `ShopperToken`. The server verifies the signed `token`, decodes the enclosed shopper context claims (customer group, effective date, source code, custom qualifiers), and writes them to the shopper session so that subsequent storefront requests reflect the preview facets.
53272
+
53273
+ **Important**:
53274
+ - The `token` is expected to be minted by the Business Manager share endpoint. Signature and expiry are enforced server-side.
53275
+ - The target shopper session is identified by the caller's `ShopperToken`; callers cannot apply to another shopper's session.
53276
+
53277
+ *
53278
+ * If you would like to get a raw Response object use the other applyPreviewContext function.
53279
+ *
53280
+ * @param options - An object containing the options for this method.
53281
+ * @param options.parameters - An object containing the parameters for this method.
53282
+ * @param options.parameters.organizationId - An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).
53283
+ * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53284
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53285
+ * @param options.body - The data to send as the request body.
53286
+ *
53287
+ * @returns A promise of type void.
53288
+ */
53289
+ applyPreviewContext(options: RequireParametersUnlessAllAreOptional<{
53290
+ parameters?: CompositeParameters<{
53291
+ organizationId: string;
53292
+ siteId: string;
53293
+ } & QueryParameters, ConfigParameters>;
53294
+ headers?: {
53295
+ [key: string]: string;
53296
+ };
53297
+ body: PreviewContextApplyRequest & CustomRequestBody;
53298
+ }>): Promise<void>;
53299
+ /**
53300
+ * Applies a shareable storefront preview context to the shopper session resolved from the caller's `ShopperToken`. The server verifies the signed `token`, decodes the enclosed shopper context claims (customer group, effective date, source code, custom qualifiers), and writes them to the shopper session so that subsequent storefront requests reflect the preview facets.
53301
+
53302
+ **Important**:
53303
+ - The `token` is expected to be minted by the Business Manager share endpoint. Signature and expiry are enforced server-side.
53304
+ - The target shopper session is identified by the caller's `ShopperToken`; callers cannot apply to another shopper's session.
53305
+
53306
+ *
53307
+ * @param options - An object containing the options for this method.
53308
+ * @param options.parameters - An object containing the parameters for this method.
53309
+ * @param options.parameters.organizationId - An identifier for the Salesforce Commerce Cloud organization the request is being made by. It consists of a prefix 'f_ecom_' followed by a 4-character [realm identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#realm-id) and a 3-character [instance type identifier](https://developer.salesforce.com/docs/commerce/commerce-api/guide/base-url.html#instance-id).
53310
+ * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53311
+ * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53312
+ * @param options.body - The data to send as the request body.
53313
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
53314
+ *
53315
+ * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
53316
+ */
53317
+ applyPreviewContext<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
53318
+ parameters?: CompositeParameters<{
53319
+ organizationId: string;
53320
+ siteId: string;
53321
+ } & QueryParameters, ConfigParameters>;
53322
+ headers?: {
53323
+ [key: string]: string;
53324
+ };
53325
+ body: PreviewContextApplyRequest & CustomRequestBody;
53326
+ }>, rawResponse?: T): Promise<T extends true ? Response : void>;
53017
53327
  /**
53018
53328
  * Get a Page Designer component by its unique identifier. The results apply the visibility rules for the component, such as personalization or scheduled visibility.
53019
53329
 
@@ -53029,7 +53339,11 @@ declare namespace ShopperExperienceApiTypes {
53029
53339
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53030
53340
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
53031
53341
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53032
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53342
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53343
+
53344
+ When set to `none`, the server skips applying personalization to the response.
53345
+
53346
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53033
53347
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53034
53348
  *
53035
53349
  * @returns A promise of type Component.
@@ -53060,7 +53374,11 @@ declare namespace ShopperExperienceApiTypes {
53060
53374
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53061
53375
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
53062
53376
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53063
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53377
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53378
+
53379
+ When set to `none`, the server skips applying personalization to the response.
53380
+
53381
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53064
53382
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53065
53383
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
53066
53384
  *
@@ -53095,7 +53413,11 @@ declare namespace ShopperExperienceApiTypes {
53095
53413
  * @param options.parameters.id - Identifier for the requested content asset.
53096
53414
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53097
53415
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53098
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53416
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53417
+
53418
+ When set to `none`, the server skips applying personalization to the response.
53419
+
53420
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53099
53421
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53100
53422
  *
53101
53423
  * @returns A promise of type Content.
@@ -53126,7 +53448,11 @@ declare namespace ShopperExperienceApiTypes {
53126
53448
  * @param options.parameters.id - Identifier for the requested content asset.
53127
53449
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53128
53450
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53129
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53451
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53452
+
53453
+ When set to `none`, the server skips applying personalization to the response.
53454
+
53455
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53130
53456
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53131
53457
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
53132
53458
  *
@@ -53159,7 +53485,11 @@ declare namespace ShopperExperienceApiTypes {
53159
53485
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53160
53486
  * @param options.parameters.levels - Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
53161
53487
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53162
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53488
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53489
+
53490
+ When set to `none`, the server skips applying personalization to the response.
53491
+
53492
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53163
53493
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53164
53494
  *
53165
53495
  * @returns A promise of type ContentFolder.
@@ -53190,7 +53520,11 @@ declare namespace ShopperExperienceApiTypes {
53190
53520
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53191
53521
  * @param options.parameters.levels - Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
53192
53522
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53193
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53523
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53524
+
53525
+ When set to `none`, the server skips applying personalization to the response.
53526
+
53527
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53194
53528
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53195
53529
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
53196
53530
  *
@@ -53224,7 +53558,11 @@ declare namespace ShopperExperienceApiTypes {
53224
53558
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53225
53559
  * @param options.parameters.levels - Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
53226
53560
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53227
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53561
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53562
+
53563
+ When set to `none`, the server skips applying personalization to the response.
53564
+
53565
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53228
53566
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53229
53567
  *
53230
53568
  * @returns A promise of type ContentFolderResult.
@@ -53255,7 +53593,11 @@ declare namespace ShopperExperienceApiTypes {
53255
53593
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53256
53594
  * @param options.parameters.levels - Specifies how many levels of nested subfolders you want the server to return. The default value is 1. Valid values are 0, 1, or 2.
53257
53595
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53258
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53596
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53597
+
53598
+ When set to `none`, the server skips applying personalization to the response.
53599
+
53600
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53259
53601
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53260
53602
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
53261
53603
  *
@@ -53290,7 +53632,11 @@ declare namespace ShopperExperienceApiTypes {
53290
53632
  * @param options.parameters.ids - Comma-separated list of content asset identifiers to retrieve.
53291
53633
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53292
53634
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53293
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53635
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53636
+
53637
+ When set to `none`, the server skips applying personalization to the response.
53638
+
53639
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53294
53640
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53295
53641
  *
53296
53642
  * @returns A promise of type ContentResult.
@@ -53321,7 +53667,11 @@ declare namespace ShopperExperienceApiTypes {
53321
53667
  * @param options.parameters.ids - Comma-separated list of content asset identifiers to retrieve.
53322
53668
  * @param options.parameters.siteId - The identifier of the site that a request is being made in the context of. Attributes might have site specific values, and some objects may only be assigned to specific sites.
53323
53669
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53324
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53670
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53671
+
53672
+ When set to `none`, the server skips applying personalization to the response.
53673
+
53674
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53325
53675
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53326
53676
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
53327
53677
  *
@@ -53357,7 +53707,11 @@ declare namespace ShopperExperienceApiTypes {
53357
53707
  * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
53358
53708
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
53359
53709
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53360
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53710
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53711
+
53712
+ When set to `none`, the server skips applying personalization to the response.
53713
+
53714
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53361
53715
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53362
53716
  *
53363
53717
  * @returns A promise of type Page.
@@ -53392,7 +53746,11 @@ declare namespace ShopperExperienceApiTypes {
53392
53746
  * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
53393
53747
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
53394
53748
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53395
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53749
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53750
+
53751
+ When set to `none`, the server skips applying personalization to the response.
53752
+
53753
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53396
53754
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53397
53755
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
53398
53756
  *
@@ -53434,7 +53792,11 @@ declare namespace ShopperExperienceApiTypes {
53434
53792
  * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
53435
53793
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
53436
53794
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53437
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53795
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53796
+
53797
+ When set to `none`, the server skips applying personalization to the response.
53798
+
53799
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53438
53800
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53439
53801
  *
53440
53802
  * @returns A promise of type PageResult.
@@ -53475,7 +53837,11 @@ declare namespace ShopperExperienceApiTypes {
53475
53837
  * @param options.parameters.aspectAttributes - A JSON representation of aspect attributes. Each aspect attribute is a key/value pair. Aspect attributes serve as a runtime parameter contract between caller (for example, this API or the DWScript API) and callee (the page). This parameter must not contain more than 256 characters after URL decoding.
53476
53838
  * @param options.parameters.parameters - A free-form definition of parameters that influences the page rendering according to its implementation. This parameter must not contain more than 256 characters after URL decoding.
53477
53839
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53478
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53840
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53841
+
53842
+ When set to `none`, the server skips applying personalization to the response.
53843
+
53844
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53479
53845
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53480
53846
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
53481
53847
  *
@@ -53593,7 +53959,11 @@ declare namespace ShopperExperienceApiTypes {
53593
53959
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53594
53960
  * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
53595
53961
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
53596
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
53962
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
53963
+
53964
+ When set to `none`, the server skips applying personalization to the response.
53965
+
53966
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53597
53967
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53598
53968
  *
53599
53969
  * @returns A promise of type ContentSearchResult.
@@ -53641,7 +54011,11 @@ declare namespace ShopperExperienceApiTypes {
53641
54011
  * @param options.parameters.locale - A descriptor for a geographical region by both a language and country code. By combining these two, regional differences in a language can be addressed, such as with the request header parameter `Accept-Language` following [RFC 2616](https://tools.ietf.org/html/rfc2616) & [RFC 1766](https://tools.ietf.org/html/rfc1766). This can also just refer to a language code, also RFC 2616/1766 compliant, as a default if there is no specific match for a country. Finally, can also be used to define default behavior if there is no locale specified.
53642
54012
  * @param options.parameters.limit - Number of records to retrieve per request. Must be between 1 (minimum) and 200 (maximum). Defaults to 50.
53643
54013
  * @param options.parameters.offset - Used to retrieve the results based on a particular resource offset.
53644
- * @param options.parameters.personalized - Controls whether personalization is applied to the response. When set to `none`, the server skips applying personalization to the response.
54014
+ * @param options.parameters.personalized - Controls whether personalization is applied to the response. Set to `none` to opt out of personalized response handling so the response is safe to cache at the CDN layer.
54015
+
54016
+ When set to `none`, the server skips applying personalization to the response.
54017
+
54018
+ Setting `personalized=none` is necessary but not sufficient for CDN caching: a response is only cached when the endpoint is also cacheable in the [server-side web-tier cache](https://developer.salesforce.com/docs/commerce/commerce-api/guide/server-side-web-tier-caching.html), subject to its TTLs and invalidation. A call that is uncacheable in the web tier is not cached at the CDN either. See [CDN caching](https://developer.salesforce.com/docs/commerce/commerce-api/guide/cdn-caching.html).
53645
54019
  * @param options.headers - An object literal of key value pairs of the headers to be sent with this request.
53646
54020
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
53647
54021
  *
@@ -54055,6 +54429,18 @@ declare namespace ShopperExperienceModelTypes {
54055
54429
  } & {
54056
54430
  [key: string]: any;
54057
54431
  };
54432
+ /**
54433
+ * @type PreviewContextApplyRequest:
54434
+ *
54435
+ * @property token: The signed preview context token minted by the Business Manager share endpoint.
54436
+ * - **Max Length:** 8192
54437
+ *
54438
+ */
54439
+ type PreviewContextApplyRequest = {
54440
+ token: string;
54441
+ } & {
54442
+ [key: string]: any;
54443
+ };
54058
54444
  /**
54059
54445
  * @type QualifierResolveRequest: Request body for resolving customer group qualifications, campaign promotion eligibility, and data bindings. All fields are optional. An empty body is valid and returns an empty response.
54060
54446
  *
@@ -54125,29 +54511,40 @@ declare namespace ShopperExperienceTypes {
54125
54511
  // API types
54126
54512
  type ShopperExperiencePathParameters = ShopperExperienceApiTypes.ShopperExperiencePathParameters;
54127
54513
  type ShopperExperienceQueryParameters = ShopperExperienceApiTypes.ShopperExperienceQueryParameters;
54514
+ type applyPreviewContextQueryParameters = ShopperExperienceApiTypes.applyPreviewContextQueryParameters;
54515
+ type applyPreviewContextPathParameters = ShopperExperienceApiTypes.applyPreviewContextPathParameters;
54516
+ type GetComponentSfdcDwDntEnum = ShopperExperienceApiTypes.GetComponentSfdcDwDntEnum;
54128
54517
  type GetComponentPersonalizedEnum = ShopperExperienceApiTypes.GetComponentPersonalizedEnum;
54129
54518
  type getComponentQueryParameters = ShopperExperienceApiTypes.getComponentQueryParameters;
54130
54519
  type getComponentPathParameters = ShopperExperienceApiTypes.getComponentPathParameters;
54520
+ type GetContentSfdcDwDntEnum = ShopperExperienceApiTypes.GetContentSfdcDwDntEnum;
54131
54521
  type GetContentPersonalizedEnum = ShopperExperienceApiTypes.GetContentPersonalizedEnum;
54132
54522
  type getContentQueryParameters = ShopperExperienceApiTypes.getContentQueryParameters;
54133
54523
  type getContentPathParameters = ShopperExperienceApiTypes.getContentPathParameters;
54524
+ type GetContentFolderSfdcDwDntEnum = ShopperExperienceApiTypes.GetContentFolderSfdcDwDntEnum;
54134
54525
  type GetContentFolderPersonalizedEnum = ShopperExperienceApiTypes.GetContentFolderPersonalizedEnum;
54135
54526
  type getContentFolderQueryParameters = ShopperExperienceApiTypes.getContentFolderQueryParameters;
54136
54527
  type getContentFolderPathParameters = ShopperExperienceApiTypes.getContentFolderPathParameters;
54528
+ type GetContentFoldersSfdcDwDntEnum = ShopperExperienceApiTypes.GetContentFoldersSfdcDwDntEnum;
54137
54529
  type GetContentFoldersPersonalizedEnum = ShopperExperienceApiTypes.GetContentFoldersPersonalizedEnum;
54138
54530
  type getContentFoldersQueryParameters = ShopperExperienceApiTypes.getContentFoldersQueryParameters;
54139
54531
  type getContentFoldersPathParameters = ShopperExperienceApiTypes.getContentFoldersPathParameters;
54532
+ type GetMultipleContentSfdcDwDntEnum = ShopperExperienceApiTypes.GetMultipleContentSfdcDwDntEnum;
54140
54533
  type GetMultipleContentPersonalizedEnum = ShopperExperienceApiTypes.GetMultipleContentPersonalizedEnum;
54141
54534
  type getMultipleContentQueryParameters = ShopperExperienceApiTypes.getMultipleContentQueryParameters;
54142
54535
  type getMultipleContentPathParameters = ShopperExperienceApiTypes.getMultipleContentPathParameters;
54536
+ type GetPageSfdcDwDntEnum = ShopperExperienceApiTypes.GetPageSfdcDwDntEnum;
54143
54537
  type GetPagePersonalizedEnum = ShopperExperienceApiTypes.GetPagePersonalizedEnum;
54144
54538
  type getPageQueryParameters = ShopperExperienceApiTypes.getPageQueryParameters;
54145
54539
  type getPagePathParameters = ShopperExperienceApiTypes.getPagePathParameters;
54540
+ type GetPagesSfdcDwDntEnum = ShopperExperienceApiTypes.GetPagesSfdcDwDntEnum;
54146
54541
  type GetPagesPersonalizedEnum = ShopperExperienceApiTypes.GetPagesPersonalizedEnum;
54147
54542
  type getPagesQueryParameters = ShopperExperienceApiTypes.getPagesQueryParameters;
54148
54543
  type getPagesPathParameters = ShopperExperienceApiTypes.getPagesPathParameters;
54544
+ type ResolveQualifiersSfdcDwDntEnum = ShopperExperienceApiTypes.ResolveQualifiersSfdcDwDntEnum;
54149
54545
  type resolveQualifiersQueryParameters = ShopperExperienceApiTypes.resolveQualifiersQueryParameters;
54150
54546
  type resolveQualifiersPathParameters = ShopperExperienceApiTypes.resolveQualifiersPathParameters;
54547
+ type SearchContentSfdcDwDntEnum = ShopperExperienceApiTypes.SearchContentSfdcDwDntEnum;
54151
54548
  type SearchContentPersonalizedEnum = ShopperExperienceApiTypes.SearchContentPersonalizedEnum;
54152
54549
  type searchContentQueryParameters = ShopperExperienceApiTypes.searchContentQueryParameters;
54153
54550
  type searchContentPathParameters = ShopperExperienceApiTypes.searchContentPathParameters;
@@ -54167,6 +54564,7 @@ declare namespace ShopperExperienceTypes {
54167
54564
  type Page = ShopperExperienceModelTypes.Page;
54168
54565
  type PageResult = ShopperExperienceModelTypes.PageResult;
54169
54566
  type PaginatedResultBase = ShopperExperienceModelTypes.PaginatedResultBase;
54567
+ type PreviewContextApplyRequest = ShopperExperienceModelTypes.PreviewContextApplyRequest;
54170
54568
  type QualifierResolveRequest = ShopperExperienceModelTypes.QualifierResolveRequest;
54171
54569
  type QualifierResolveResponse = ShopperExperienceModelTypes.QualifierResolveResponse;
54172
54570
  type Region = ShopperExperienceModelTypes.Region;
@@ -77235,6 +77633,12 @@ declare namespace helpers {
77235
77633
  * @property signatureCount: The signature counter for replay attack prevention
77236
77634
  * - **Max Length:** 8
77237
77635
  *
77636
+ * @property createdTime: The date and time when this credential was registered
77637
+ *
77638
+ * @property lastUsed: The date and time when this credential was last used for authentication
77639
+ *
77640
+ * @property uses: The number of times this credential has been used for authentication
77641
+ *
77238
77642
  */
77239
77643
  type PasskeyCredential = {
77240
77644
  id?: number;
@@ -77244,6 +77648,9 @@ declare namespace helpers {
77244
77648
  publicKey?: string;
77245
77649
  userHandle?: string;
77246
77650
  signatureCount?: string;
77651
+ createdTime?: string;
77652
+ lastUsed?: string;
77653
+ uses?: number;
77247
77654
  } & {
77248
77655
  [key: string]: any;
77249
77656
  };
@@ -77514,7 +77921,8 @@ declare namespace helpers {
77514
77921
  pwdless_login_token: string;
77515
77922
  client_id?: string;
77516
77923
  code_verifier?: string;
77517
- login_id?: string;
77924
+ channel_id: string;
77925
+ login_id: string;
77518
77926
  };
77519
77927
  type getPasswordResetTokenQueryParameters = {};
77520
77928
  type getPasswordResetTokenPathParameters = {
@@ -77643,7 +78051,7 @@ declare namespace helpers {
77643
78051
  new_password?: string;
77644
78052
  channel_id: string;
77645
78053
  hint?: string;
77646
- user_id?: string;
78054
+ user_id: string;
77647
78055
  };
77648
78056
  type revokeTokenQueryParameters = {};
77649
78057
  type revokeTokenPathParameters = {
@@ -77712,7 +78120,21 @@ declare namespace helpers {
77712
78120
 
77713
78121
  **Important:** Before using this API, see [Authorization for Shopper APIs](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) in the Get Started guides and the more detailed [SLAS guides](https://developer.salesforce.com/docs/commerce/commerce-api/guide/slas.html) for instructions on setting up a SLAS client, obtaining credentials, as well as flow and use case information.
77714
78122
 
77715
- For load shedding and rate limiting information, see [Load Shedding and Rate Limiting.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/throttle-rates.html)*<br />
78123
+ For load shedding and rate limiting information, see [Load Shedding and Rate Limiting.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/throttle-rates.html)
78124
+
78125
+ ## Response Details
78126
+
78127
+ ### Timeouts
78128
+
78129
+ Shopper API requests must respond within 10 seconds, including any hook execution. If a response exceeds this threshold, an HTTP 504 status code is returned. For details, see [Timeouts and Limits.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/timeouts-limits.html)
78130
+
78131
+ ### Error Handling
78132
+
78133
+ Error responses follow the [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807) problem detail format. To trace errors, include a `correlation-id` header in your request — the response returns it as `x-correlation-id`. For details, see [HTTP Status Codes and Errors.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/error-response-codes.html)
78134
+
78135
+ ## Related APIs
78136
+
78137
+ - [SLAS Admin API](https://developer.salesforce.com/docs/commerce/commerce-api/references/auth-admin?meta=Summary) — Manage SLAS tenants, clients, and identity providers.*<br />
77716
78138
  *
77717
78139
  * Simple example:
77718
78140
  *
@@ -77920,15 +78342,18 @@ declare namespace helpers {
77920
78342
  "grant_type",
77921
78343
  "hint",
77922
78344
  "pwdless_login_token",
78345
+ "channel_id",
78346
+ "login_id",
77923
78347
  "client_id",
77924
- "code_verifier",
77925
- "login_id"
78348
+ "code_verifier"
77926
78349
  ];
77927
78350
  readonly getPasswordLessAccessTokenRequired: readonly [
77928
78351
  "organizationId",
77929
78352
  "grant_type",
77930
78353
  "hint",
77931
- "pwdless_login_token"
78354
+ "pwdless_login_token",
78355
+ "channel_id",
78356
+ "login_id"
77932
78357
  ];
77933
78358
  readonly getPasswordResetToken: readonly [
77934
78359
  "organizationId",
@@ -78091,16 +78516,17 @@ declare namespace helpers {
78091
78516
  "client_id",
78092
78517
  "pwd_action_token",
78093
78518
  "channel_id",
78519
+ "user_id",
78094
78520
  "code_verifier",
78095
78521
  "new_password",
78096
- "hint",
78097
- "user_id"
78522
+ "hint"
78098
78523
  ];
78099
78524
  readonly resetPasswordRequired: readonly [
78100
78525
  "organizationId",
78101
78526
  "client_id",
78102
78527
  "pwd_action_token",
78103
- "channel_id"
78528
+ "channel_id",
78529
+ "user_id"
78104
78530
  ];
78105
78531
  readonly revokeToken: readonly [
78106
78532
  "organizationId",
@@ -78252,7 +78678,7 @@ declare namespace helpers {
78252
78678
 
78253
78679
  * @param options.parameters.response_type - Must be `code`. Indicates that the caller wants an authorization code.
78254
78680
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
78255
- * @param options.parameters.scope -
78681
+ * @param options.parameters.scope - The OAuth scopes to include in the token.
78256
78682
  * @param options.parameters.state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
78257
78683
  * @param options.parameters.usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
78258
78684
  * @param options.parameters.hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
@@ -78309,7 +78735,7 @@ declare namespace helpers {
78309
78735
 
78310
78736
  * @param options.parameters.response_type - Must be `code`. Indicates that the caller wants an authorization code.
78311
78737
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
78312
- * @param options.parameters.scope -
78738
+ * @param options.parameters.scope - The OAuth scopes to include in the token.
78313
78739
  * @param options.parameters.state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
78314
78740
  * @param options.parameters.usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
78315
78741
  * @param options.parameters.hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
@@ -79146,7 +79572,8 @@ declare namespace helpers {
79146
79572
  * @param options.body.pwdless_login_token - Passwordless login token that was created from the user ID.
79147
79573
  * @param options.body.client_id - The public client ID.
79148
79574
  * @param options.body.code_verifier - PKCE code verifier. Created by the client. The `code_challenge` is created by SHA256 hashing the `code_verifier` and Base64 encoding the resulting hash. The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
79149
- * @param options.body.login_id - The ID used by the shopper for password token request. When provided, login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
79575
+ * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
79576
+ * @param options.body.login_id - The ID used by the shopper for password token request. The login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
79150
79577
  *
79151
79578
  * @returns A promise of type TokenResponse.
79152
79579
  */
@@ -79243,7 +79670,8 @@ declare namespace helpers {
79243
79670
  * @param options.body.pwdless_login_token - Passwordless login token that was created from the user ID.
79244
79671
  * @param options.body.client_id - The public client ID.
79245
79672
  * @param options.body.code_verifier - PKCE code verifier. Created by the client. The `code_challenge` is created by SHA256 hashing the `code_verifier` and Base64 encoding the resulting hash. The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
79246
- * @param options.body.login_id - The ID used by the shopper for password token request. When provided, login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
79673
+ * @param options.body.channel_id - The channel (B2C Commerce site) that the user is associated with.
79674
+ * @param options.body.login_id - The ID used by the shopper for password token request. The login_id must exactly match the ID used during passwordless login. ex. If passwordless login used `samantha.sampleson@example.com`, but the passwordless login token request provides `sam.sampleson@example.com`, the request fails due to mismatch.
79247
79675
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
79248
79676
  *
79249
79677
  * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
@@ -79932,7 +80360,7 @@ declare namespace helpers {
79932
80360
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
79933
80361
  * @param options.parameters.refresh_token - Refresh token that was given during the access token request.
79934
80362
  * @param options.parameters.channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with B2C Commerce.
79935
- * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID.
80363
+ * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID. Starting in B2C Commerce 26.8, it also invalidates all access tokens issued prior to invoking logout for that shopper.
79936
80364
  This only works within the same session type. Sessions created through different authentication methods (/authorize vs. Trusted System On Behalf) are treated as separate sessions. To invalidate tokens with different SLAS User IDs, you must make explicit logout calls with each token.
79937
80365
  A shopper authenticated via both /authorize and TSOB has two separate sessions. You will need two logout calls (one per token) to fully log them out.
79938
80366
 
@@ -79968,7 +80396,7 @@ declare namespace helpers {
79968
80396
  * @param options.parameters.client_id - The SLAS public client ID or SLAS private client ID for use with trusted-agent requests. When using a private client ID a PKCE code challenge is not required.
79969
80397
  * @param options.parameters.refresh_token - Refresh token that was given during the access token request.
79970
80398
  * @param options.parameters.channel_id - The `channel_id` parameter must be provided if the shopper authenticated using the `login` endpoint with B2C Commerce.
79971
- * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID.
80399
+ * @param options.parameters.hint - `hint=all-sessions` logs out all sessions and invalidates all refresh tokens for a shopper with the same SLAS user ID. Starting in B2C Commerce 26.8, it also invalidates all access tokens issued prior to invoking logout for that shopper.
79972
80400
  This only works within the same session type. Sessions created through different authentication methods (/authorize vs. Trusted System On Behalf) are treated as separate sessions. To invalidate tokens with different SLAS User IDs, you must make explicit logout calls with each token.
79973
80401
  A shopper authenticated via both /authorize and TSOB has two separate sessions. You will need two logout calls (one per token) to fully log them out.
79974
80402
 
@@ -80071,7 +80499,7 @@ declare namespace helpers {
80071
80499
  * @param options.body.new_password - The new password to set for the shopper associated with the password action token.
80072
80500
  * @param options.body.channel_id - The channel that the request is for. For a B2C Commerce request, this is angalous to the site ID.
80073
80501
  * @param options.body.hint - Adding a `hint` query parameter with a value of `cross_device` will remove the need to have the code_verifier for password reset request. If the `hint` query parameter is used it must also have been used in the password action request.
80074
- * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC. Required only when hint is provided.
80502
+ * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC.
80075
80503
  *
80076
80504
  * @returns A promise of type void.
80077
80505
  */
@@ -80098,7 +80526,7 @@ declare namespace helpers {
80098
80526
  * @param options.body.new_password - The new password to set for the shopper associated with the password action token.
80099
80527
  * @param options.body.channel_id - The channel that the request is for. For a B2C Commerce request, this is angalous to the site ID.
80100
80528
  * @param options.body.hint - Adding a `hint` query parameter with a value of `cross_device` will remove the need to have the code_verifier for password reset request. If the `hint` query parameter is used it must also have been used in the password action request.
80101
- * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC. Required only when hint is provided.
80529
+ * @param options.body.user_id - User ID for logging in. This is the id that is used to log into SFCC.
80102
80530
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
80103
80531
  *
80104
80532
  * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
@@ -80592,6 +81020,8 @@ declare namespace helpers {
80592
81020
  * @param options.parameters.callbackURI? - URI to send the passwordless login token to. Must be listed in your SLAS configuration. Required when mode is callback
80593
81021
  * @param options.parameters.pwdlessLoginToken - Passwordless login token
80594
81022
  * @param options.parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
81023
+ * @param options.parameters.loginId - The ID used by the shopper for the password token request. Must exactly match the ID used during passwordless login.
81024
+ * @param options.parameters.channelId - The channel that the request is for. Analogous to the site ID.
80595
81025
  * @returns Promise of Response or Object
80596
81026
  */
80597
81027
  function getPasswordLessAccessToken(options: {
@@ -80607,6 +81037,8 @@ declare namespace helpers {
80607
81037
  parameters: {
80608
81038
  pwdlessLoginToken: string;
80609
81039
  dnt?: string;
81040
+ loginId: string;
81041
+ channelId: string;
80610
81042
  };
80611
81043
  enableHttpOnlySessionCookies?: boolean;
80612
81044
  }): Promise<TokenResponse>;