commerce-sdk-isomorphic 2.1.0 → 3.1.0

package/lib/index.esm.d.ts

@@ -8551,7 +8551,7 @@ type ShopperContextsParameters = ShopperContextsPathParameters & BaseUriParamete
  * ```
  *
  * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 0.0.28<br />
+ * API Version: 0.0.29<br />
  * Last Updated: <br />
  * </span>
  *
@@ -8606,6 +8606,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
     };
     /**
      * Gets the shopper's context based on the shopperJWT.
+     
+     With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
      *
      * If you would like to get a raw Response object use the other getShopperContext function.
      *
@@ -8613,7 +8615,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
      * @param parameters - An object containing the parameters for this method.
      * @param organizationId -
      * @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
-     * @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
+     * @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
      * @param headers - An object literal of key value pairs of the headers to be
      * sent with this request.
      *
@@ -8634,12 +8636,14 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
     }>): Promise<ShopperContext>;
     /**
      * Gets the shopper's context based on the shopperJWT.
+     
+     With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
      *
      * @param options - An object containing the options for this method.
      * @param parameters - An object containing the parameters for this method.
      * @param organizationId -
      * @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
-     * @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
+     * @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
      * @param headers - An object literal of key value pairs of the headers to be
      * sent with this request.
      * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -8660,6 +8664,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
     }>, rawResponse?: T): Promise<T extends true ? Response : ShopperContext>;
     /**
      * Creates the shopper's context based on shopperJWT.
+     
+     With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
      *
      * If you would like to get a raw Response object use the other createShopperContext function.
      *
@@ -8698,6 +8704,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
     }>): Promise<void | void>;
     /**
      * Creates the shopper's context based on shopperJWT.
+     
+     With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
      *
      * @param options - An object containing the options for this method.
      * @param parameters - An object containing the parameters for this method.
@@ -8734,6 +8742,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
     }>, rawResponse?: T): Promise<T extends true ? Response : void | void>;
     /**
      * Gets the shopper's context based on the shopperJWT.
+     
+     With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
      *
      * If you would like to get a raw Response object use the other deleteShopperContext function.
      *
@@ -8762,6 +8772,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
     }>): Promise<void>;
     /**
      * Gets the shopper's context based on the shopperJWT.
+     
+     With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
      *
      * @param options - An object containing the options for this method.
      * @param parameters - An object containing the parameters for this method.
@@ -8788,6 +8800,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
     }>, rawResponse?: T): Promise<T extends true ? Response : void>;
     /**
      * Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
+     
+     With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
      *
      * If you would like to get a raw Response object use the other updateShopperContext function.
      *
@@ -8826,6 +8840,8 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
     }>): Promise<ShopperContext>;
     /**
      * Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
+     
+     With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
      *
      * @param options - An object containing the options for this method.
      * @param parameters - An object containing the parameters for this method.
@@ -9278,7 +9294,7 @@ declare namespace ShopperContextsTypes {
      * ```
      *
      * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 0.0.28<br />
+     * API Version: 0.0.29<br />
      * Last Updated: <br />
      * </span>
      *
@@ -9333,6 +9349,8 @@ declare namespace ShopperContextsTypes {
         };
         /**
          * Gets the shopper's context based on the shopperJWT.
+         
+         With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
          *
          * If you would like to get a raw Response object use the other getShopperContext function.
          *
@@ -9340,7 +9358,7 @@ declare namespace ShopperContextsTypes {
          * @param parameters - An object containing the parameters for this method.
          * @param organizationId -
          * @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
-         * @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
+         * @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
          * @param headers - An object literal of key value pairs of the headers to be
          * sent with this request.
          *
@@ -9361,12 +9379,14 @@ declare namespace ShopperContextsTypes {
         }>): Promise<ShopperContext>;
         /**
          * Gets the shopper's context based on the shopperJWT.
+         
+         With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
          *
          * @param options - An object containing the options for this method.
          * @param parameters - An object containing the parameters for this method.
          * @param organizationId -
          * @param usid - The Shopper's unique identifier. It is a required parameter and is part of the response from the Guest or Registered User Shopper Login (SLAS) API call.
-         * @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting July 31 2024, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
+         * @param siteId - The identifier of the site to which the request is being sent. With B2C Commerce release 24.5, all new implementations of Shopper Context require the `siteId` query parameter to be passed. Existing customers with Shopper Context implementations should start including `siteId` going forward. Starting January 2025, `siteId` will be required for all customers, and a bad request response code will be returned for requests without a `siteId`.
          * @param headers - An object literal of key value pairs of the headers to be
          * sent with this request.
          * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -9387,6 +9407,8 @@ declare namespace ShopperContextsTypes {
         }>, rawResponse?: T): Promise<T extends true ? Response : ShopperContext>;
         /**
          * Creates the shopper's context based on shopperJWT.
+         
+         With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
          *
          * If you would like to get a raw Response object use the other createShopperContext function.
          *
@@ -9425,6 +9447,8 @@ declare namespace ShopperContextsTypes {
         }>): Promise<void | void>;
         /**
          * Creates the shopper's context based on shopperJWT.
+         
+         With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
          *
          * @param options - An object containing the options for this method.
          * @param parameters - An object containing the parameters for this method.
@@ -9461,6 +9485,8 @@ declare namespace ShopperContextsTypes {
         }>, rawResponse?: T): Promise<T extends true ? Response : void | void>;
         /**
          * Gets the shopper's context based on the shopperJWT.
+         
+         With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
          *
          * If you would like to get a raw Response object use the other deleteShopperContext function.
          *
@@ -9489,6 +9515,8 @@ declare namespace ShopperContextsTypes {
         }>): Promise<void>;
         /**
          * Gets the shopper's context based on the shopperJWT.
+         
+         With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
          *
          * @param options - An object containing the options for this method.
          * @param parameters - An object containing the parameters for this method.
@@ -9515,6 +9543,8 @@ declare namespace ShopperContextsTypes {
         }>, rawResponse?: T): Promise<T extends true ? Response : void>;
         /**
          * Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
+         
+         With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
          *
          * If you would like to get a raw Response object use the other updateShopperContext function.
          *
@@ -9553,6 +9583,8 @@ declare namespace ShopperContextsTypes {
         }>): Promise<ShopperContext>;
         /**
          * Updates the shopper's context based on the Shopper JWT. If the shopper context exists, it's updated with the patch body. If a `custom qualifier/assignment qualifer` or an `effectiveDateTime` or a `sourceCode` or a `customerGroupIds` is already present in the existing shopper context, its value is replaced by the corresponding value from the patch body. If a `custom qualifers'` or a `assignment qualifiers'` value is set to `null`, it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to an empty string (\"\"), it's deleted from existing shopper context. If `effectiveDateTime` or `sourceCode` value is set to `null`, it's ignored. If an `effectiveDateTime` or `sourceCode` or `custom/assignment qualifiiers'` value is new, it's added to the existing Shopper context. If `customerGroupIds` is set to empty array `[]` the existing value in shopper context is deleted.
+         
+         With B2C Commerce release 24.5, all endpoints in the Shopper context API will require the `siteId` parameter for new customers. This field is marked as optional for backward compatibility and will be changed to mandatory tentatively by January 2025.
          *
          * @param options - An object containing the options for this method.
          * @param parameters - An object containing the parameters for this method.
@@ -18229,8 +18261,6 @@ type GiftCertificate = {
 };
 type GiftCertificateRequest = {
     giftCertificateCode: string;
-} & {
-    [key: string]: any;
 };
 type RangeFilter$4 = {
     [key: string]: any;
@@ -18374,7 +18404,7 @@ type ShopperGiftCertificatesParameters = ShopperGiftCertificatesPathParameters &
  * ```
  *
  * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 1.0.16<br />
+ * API Version: 1.0.17<br />
  * Last Updated: <br />
  * </span>
  *
@@ -18560,8 +18590,6 @@ declare namespace ShopperGiftCertificatesTypes {
     };
     type GiftCertificateRequest = {
         giftCertificateCode: string;
-    } & {
-        [key: string]: any;
     };
     type ErrorResponse = {
         type: string;
@@ -18860,7 +18888,7 @@ declare namespace ShopperGiftCertificatesTypes {
      * ```
      *
      * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 1.0.16<br />
+     * API Version: 1.0.17<br />
      * Last Updated: <br />
      * </span>
      *
@@ -26810,8 +26838,6 @@ type PromotionResult = {
     limit: number;
     data: Array<Promotion>;
     total: number;
-} & {
-    [key: string]: any;
 };
 type RangeFilter$8 = {
     [key: string]: any;
@@ -26961,7 +26987,7 @@ type ShopperPromotionsParameters = ShopperPromotionsPathParameters & BaseUriPara
  * ```
  *
  * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 1.0.26<br />
+ * API Version: 1.0.27<br />
  * Last Updated: <br />
  * </span>
  *
@@ -27240,8 +27266,6 @@ declare namespace ShopperPromotionsTypes {
         limit: number;
         data: Array<Promotion>;
         total: number;
-    } & {
-        [key: string]: any;
     };
     type Error = {
         type: string;
@@ -27546,7 +27570,7 @@ declare namespace ShopperPromotionsTypes {
      * ```
      *
      * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 1.0.26<br />
+     * API Version: 1.0.27<br />
      * Last Updated: <br />
      * </span>
      *
@@ -32950,6 +32974,7 @@ declare namespace helpers {
      * @param credentials.clientSecret - secret associated with client ID
      * @param parameters - parameters to pass in the API calls.
      * @param parameters.usid? - Unique Shopper Identifier to enable personalization.
+     * @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
      * @returns TokenResponse
      */
     function loginGuestUserPrivate(slasClient: ShopperLogin<{
@@ -32959,6 +32984,7 @@ declare namespace helpers {
         siteId: string;
     }>, parameters: {
         usid?: string;
+        dnt?: boolean;
     }, credentials: {
         clientSecret: string;
     }): Promise<TokenResponse>;
@@ -32968,6 +32994,7 @@ declare namespace helpers {
      * @param parameters - parameters to pass in the API calls.
      * @param parameters.redirectURI - Per OAuth standard, a valid app route. Must be listed in your SLAS configuration. On server, this will not be actually called. On browser, this will be called, but ignored.
      * @param parameters.usid? - Unique Shopper Identifier to enable personalization.
+     * @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
      * @returns TokenResponse
      */
     function loginGuestUser(slasClient: ShopperLogin<{
@@ -32978,6 +33005,7 @@ declare namespace helpers {
     }>, parameters: {
         redirectURI: string;
         usid?: string;
+        dnt?: boolean;
     }): Promise<TokenResponse>;
     /**
      * A single function to execute the ShopperLogin Public Client Registered User B2C Login with proof key for code exchange flow as described in the [API documentation](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-login:Summary).
@@ -32990,6 +33018,7 @@ declare namespace helpers {
      * @param parameters - parameters to pass in the API calls.
      * @param parameters.redirectURI - Per OAuth standard, a valid app route. Must be listed in your SLAS configuration. On server, this will not be actually called. On browser, this will be called, but ignored.
      * @param parameters.usid? - Unique Shopper Identifier to enable personalization.
+     * @param parameters.dnt? - Optional parameter to enable Do Not Track (DNT) for the user.
      * @returns TokenResponse
      */
     function loginRegisteredUserB2C(slasClient: ShopperLogin<{
@@ -33004,6 +33033,7 @@ declare namespace helpers {
     }, parameters: {
         redirectURI: string;
         usid?: string;
+        dnt?: boolean;
     }): Promise<TokenResponse>;
     /**
      * Exchange a refresh token for a new access token.
@@ -33022,6 +33052,7 @@ declare namespace helpers {
         siteId: string;
     }>, parameters: {
         refreshToken: string;
+        dnt?: boolean;
     }, credentials?: {
         clientSecret?: string;
     }): Promise<TokenResponse>;