commerce-sdk-isomorphic 1.10.2 → 1.10.4

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## v1.10.4
+
+#### Bug fixes
+
+- Mark `expand` query parameter for `getProduct` endpoint as optional instead of required
+
+## v1.10.3
+
+#### Bug fixes
+
+- Fix `expand` query parameter for `shopper-products`
+- Remove `retrieveCredQualityUserInfo` endpoint from `shopper-login` as this functionality was removed from SLAS
+
 ## v1.10.2
 
 #### Documentation

package/lib/index.cjs.d.ts

@@ -16690,20 +16690,6 @@ type PasswordlessLoginRequest = {
 } & {
     [key: string]: any;
 };
-type CredQualityUserResponse = {
-    tenantId: string;
-    username: string;
-    email: string;
-    credQualityMeasure: number;
-    pwdStrengthMeasure: number;
-    pwdQualityMeasure: number;
-    credChangeCount: number;
-    loginCount: number;
-    lastLoginDatetime: any;
-    lastCredCheckDatetime: any;
-} & {
-    [key: string]: any;
-};
 type PasswordLessLoginTokenRequest = {
     grant_type: string;
     hint: string;
@@ -16751,6 +16737,7 @@ type TokenResponse = {
     id_token: string;
     refresh_token: string;
     expires_in: number;
+    refresh_token_expires_in: any;
     token_type: string;
     usid: string;
     customer_id: string;
@@ -16903,7 +16890,6 @@ type ShopperLoginPathParameters = {
  * All query parameters that are used by at least one ShopperLogin method.
  */
 type ShopperLoginQueryParameters = {
-    username?: string;
     client_id?: string;
     refresh_token?: string;
     channel_id?: string;
@@ -16944,7 +16930,7 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
  * ```
  *
  * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 1.39.16<br />
+ * API Version: 1.39.17<br />
  * Last Updated: <br />
  * </span>
  
@@ -16958,52 +16944,6 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
     };
     static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
     constructor(config: ClientConfigInit<ConfigParameters>);
-    /**
-     * Get credential quality statistics for a user.
-     *
-     * If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
-     *
-     * @param options - An object containing the options for this method.
-     * @param parameters - An object containing the parameters for this method.
-     * @param organizationId -
-     * @param username - User's login ID or email address.
-     * @param headers - An object literal of key value pairs of the headers to be
-     * sent with this request.
-     *
-     * @returns A promise of type CredQualityUserResponse.
-     *
-     */
-    retrieveCredQualityUserInfo(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            username: string;
-        }, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>): Promise<CredQualityUserResponse>;
-    /**
-     * Get credential quality statistics for a user.
-     *
-     * @param options - An object containing the options for this method.
-     * @param parameters - An object containing the parameters for this method.
-     * @param organizationId -
-     * @param username - User's login ID or email address.
-     * @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.
-     * @returns A promise of type Response if rawResponse is true, a promise of type CredQualityUserResponse otherwise.
-     *
-     */
-    retrieveCredQualityUserInfo<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-        parameters?: CompositeParameters<{
-            organizationId: string;
-            username: string;
-        }, ConfigParameters>;
-        headers?: {
-            [key: string]: string;
-        };
-    }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
     /**
      * Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
      
@@ -18132,20 +18072,6 @@ declare namespace ShopperLoginTypes {
     } & {
         [key: string]: any;
     };
-    type CredQualityUserResponse = {
-        tenantId: string;
-        username: string;
-        email: string;
-        credQualityMeasure: number;
-        pwdStrengthMeasure: number;
-        pwdQualityMeasure: number;
-        credChangeCount: number;
-        loginCount: number;
-        lastLoginDatetime: any;
-        lastCredCheckDatetime: any;
-    } & {
-        [key: string]: any;
-    };
     type PasswordLessLoginTokenRequest = {
         grant_type: string;
         hint: string;
@@ -18200,6 +18126,7 @@ declare namespace ShopperLoginTypes {
         id_token: string;
         refresh_token: string;
         expires_in: number;
+        refresh_token_expires_in: any;
         token_type: string;
         usid: string;
         customer_id: string;
@@ -18507,7 +18434,6 @@ declare namespace ShopperLoginTypes {
      * All query parameters that are used by at least one ShopperLogin method.
      */
     type ShopperLoginQueryParameters = {
-        username?: string;
         client_id?: string;
         refresh_token?: string;
         channel_id?: string;
@@ -18548,7 +18474,7 @@ declare namespace ShopperLoginTypes {
      * ```
      *
      * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 1.39.16<br />
+     * API Version: 1.39.17<br />
      * Last Updated: <br />
      * </span>
      
@@ -18562,52 +18488,6 @@ declare namespace ShopperLoginTypes {
         };
         static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
         constructor(config: ClientConfigInit<ConfigParameters>);
-        /**
-         * Get credential quality statistics for a user.
-         *
-         * If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
-         *
-         * @param options - An object containing the options for this method.
-         * @param parameters - An object containing the parameters for this method.
-         * @param organizationId -
-         * @param username - User's login ID or email address.
-         * @param headers - An object literal of key value pairs of the headers to be
-         * sent with this request.
-         *
-         * @returns A promise of type CredQualityUserResponse.
-         *
-         */
-        retrieveCredQualityUserInfo(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                username: string;
-            }, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<CredQualityUserResponse>;
-        /**
-         * Get credential quality statistics for a user.
-         *
-         * @param options - An object containing the options for this method.
-         * @param parameters - An object containing the parameters for this method.
-         * @param organizationId -
-         * @param username - User's login ID or email address.
-         * @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.
-         * @returns A promise of type Response if rawResponse is true, a promise of type CredQualityUserResponse otherwise.
-         *
-         */
-        retrieveCredQualityUserInfo<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                username: string;
-            }, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
         /**
          * Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).
          
@@ -22328,10 +22208,11 @@ type ShopperProductsPathParameters = {
  * All query parameters that are used by at least one ShopperProducts method.
  */
 type ShopperProductsQueryParameters = {
+    select?: string;
     ids?: string;
     inventoryIds?: string;
     currency?: string;
-    expand?: string;
+    expand?: Array<string>;
     locale?: string;
     allImages?: boolean;
     perPricebook?: boolean;
@@ -22343,10 +22224,10 @@ type ShopperProductsQueryParameters = {
  */
 type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
 /**
- * [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
+ * [](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=:Summary)
  * ==================================
  *
- * *Display product details across your storefront.*<br />
+ * **<br />
  *
  * Simple example:
  *
@@ -22365,7 +22246,7 @@ type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParamete
  * ```
  *
  * <span style="font-size:.7em; display:block; text-align: right">
- * API Version: 0.0.24<br />
+ * API Version: <br />
  * Last Updated: <br />
  * </span>
  
@@ -22387,6 +22268,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
      * @param options - An object containing the options for this method.
      * @param parameters - An object containing the parameters for this method.
      * @param organizationId -
+     * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations.The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
      * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
      * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
      * @param currency - The currency mnemonic specified for price.
@@ -22404,10 +22286,11 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
     getProducts(options?: RequireParametersUnlessAllAreOptional<{
         parameters?: CompositeParameters<{
             organizationId: string;
+            select?: string;
             ids: string;
             inventoryIds?: string;
             currency?: string;
-            expand?: string;
+            expand?: Array<string>;
             locale?: string;
             allImages?: boolean;
             perPricebook?: boolean;
@@ -22423,6 +22306,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
      * @param options - An object containing the options for this method.
      * @param parameters - An object containing the parameters for this method.
      * @param organizationId -
+     * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations.The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
      * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
      * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
      * @param currency - The currency mnemonic specified for price.
@@ -22440,10 +22324,11 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
     getProducts<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
         parameters?: CompositeParameters<{
             organizationId: string;
+            select?: string;
             ids: string;
             inventoryIds?: string;
             currency?: string;
-            expand?: string;
+            expand?: Array<string>;
             locale?: string;
             allImages?: boolean;
             perPricebook?: boolean;
@@ -22462,6 +22347,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
      * @param parameters - An object containing the parameters for this method.
      * @param organizationId -
      * @param id - The ID of the requested product.
+     * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations. The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
      * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
      * @param currency - The currency mnemonic specified for price.
      * @param expand - The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations). All expand parameters are used for the request when no expand parameter is provided. The value "none" may be used to turn off all expand options.
@@ -22479,9 +22365,10 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
         parameters?: CompositeParameters<{
             organizationId: string;
             id: string;
+            select?: string;
             inventoryIds?: string;
             currency?: string;
-            expand?: string;
+            expand?: Array<string>;
             locale?: string;
             allImages?: boolean;
             perPricebook?: boolean;
@@ -22498,6 +22385,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
      * @param parameters - An object containing the parameters for this method.
      * @param organizationId -
      * @param id - The ID of the requested product.
+     * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations. The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
      * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
      * @param currency - The currency mnemonic specified for price.
      * @param expand - The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations). All expand parameters are used for the request when no expand parameter is provided. The value "none" may be used to turn off all expand options.
@@ -22515,9 +22403,10 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
         parameters?: CompositeParameters<{
             organizationId: string;
             id: string;
+            select?: string;
             inventoryIds?: string;
             currency?: string;
-            expand?: string;
+            expand?: Array<string>;
             locale?: string;
             allImages?: boolean;
             perPricebook?: boolean;
@@ -23251,10 +23140,11 @@ declare namespace ShopperProductsTypes {
      * All query parameters that are used by at least one ShopperProducts method.
      */
     type ShopperProductsQueryParameters = {
+        select?: string;
         ids?: string;
         inventoryIds?: string;
         currency?: string;
-        expand?: string;
+        expand?: Array<string>;
         locale?: string;
         allImages?: boolean;
         perPricebook?: boolean;
@@ -23266,10 +23156,10 @@ declare namespace ShopperProductsTypes {
      */
     type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
     /**
-     * [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
+     * [](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=:Summary)
      * ==================================
      *
-     * *Display product details across your storefront.*<br />
+     * **<br />
      *
      * Simple example:
      *
@@ -23288,7 +23178,7 @@ declare namespace ShopperProductsTypes {
      * ```
      *
      * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 0.0.24<br />
+     * API Version: <br />
      * Last Updated: <br />
      * </span>
      
@@ -23310,6 +23200,7 @@ declare namespace ShopperProductsTypes {
          * @param options - An object containing the options for this method.
          * @param parameters - An object containing the parameters for this method.
          * @param organizationId -
+         * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations.The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
          * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
          * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
          * @param currency - The currency mnemonic specified for price.
@@ -23327,10 +23218,11 @@ declare namespace ShopperProductsTypes {
         getProducts(options?: RequireParametersUnlessAllAreOptional<{
             parameters?: CompositeParameters<{
                 organizationId: string;
+                select?: string;
                 ids: string;
                 inventoryIds?: string;
                 currency?: string;
-                expand?: string;
+                expand?: Array<string>;
                 locale?: string;
                 allImages?: boolean;
                 perPricebook?: boolean;
@@ -23346,6 +23238,7 @@ declare namespace ShopperProductsTypes {
          * @param options - An object containing the options for this method.
          * @param parameters - An object containing the parameters for this method.
          * @param organizationId -
+         * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations.The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
          * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
          * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
          * @param currency - The currency mnemonic specified for price.
@@ -23363,10 +23256,11 @@ declare namespace ShopperProductsTypes {
         getProducts<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
             parameters?: CompositeParameters<{
                 organizationId: string;
+                select?: string;
                 ids: string;
                 inventoryIds?: string;
                 currency?: string;
-                expand?: string;
+                expand?: Array<string>;
                 locale?: string;
                 allImages?: boolean;
                 perPricebook?: boolean;
@@ -23385,6 +23279,7 @@ declare namespace ShopperProductsTypes {
          * @param parameters - An object containing the parameters for this method.
          * @param organizationId -
          * @param id - The ID of the requested product.
+         * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations. The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
          * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
          * @param currency - The currency mnemonic specified for price.
          * @param expand - The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations). All expand parameters are used for the request when no expand parameter is provided. The value "none" may be used to turn off all expand options.
@@ -23402,9 +23297,10 @@ declare namespace ShopperProductsTypes {
             parameters?: CompositeParameters<{
                 organizationId: string;
                 id: string;
+                select?: string;
                 inventoryIds?: string;
                 currency?: string;
-                expand?: string;
+                expand?: Array<string>;
                 locale?: string;
                 allImages?: boolean;
                 perPricebook?: boolean;
@@ -23421,6 +23317,7 @@ declare namespace ShopperProductsTypes {
          * @param parameters - An object containing the parameters for this method.
          * @param organizationId -
          * @param id - The ID of the requested product.
+         * @param select - The property selector declaring which fields are included into the response payload. You can specify a single field name, a comma-separated list of names, or work with wildcards.You can also sepcify Array Operations. The select will be available, tentatively from october 2023.The exact date will be announced via changelog.
          * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
          * @param currency - The currency mnemonic specified for price.
          * @param expand - The expand parameter. A comma separated list with the allowed values (availability, bundled_products, links, promotions, options, images, prices, variations, set_products, recommendations). All expand parameters are used for the request when no expand parameter is provided. The value "none" may be used to turn off all expand options.
@@ -23438,9 +23335,10 @@ declare namespace ShopperProductsTypes {
             parameters?: CompositeParameters<{
                 organizationId: string;
                 id: string;
+                select?: string;
                 inventoryIds?: string;
                 currency?: string;
-                expand?: string;
+                expand?: Array<string>;
                 locale?: string;
                 allImages?: boolean;
                 perPricebook?: boolean;
@@ -25592,9 +25490,10 @@ declare class TemplateURL extends URL {
      */
     replaceOrigin(newOriginString: string): void;
     /**
-     * Add append an object literal of query parameters to the URL object. Arrays
-     * are allowed and are appended using the "repeat" convention where the \{ a:
-     * ["1", "2"] \} becomes "?a=1&a=2"
+     * Add append an object literal of query parameters to the URL object. SCAPI expects
+     * Arrays to be comma separated where \{ a: ["1", "2"] \} becomes ?a=1,2.
+     * The 'refine' query parameter is an exception, where SCAPI expects the the "repeat"
+     * convention where \{ refine: ["1", "2"] \} becomes "?refine=1&refine=2"
      */
     addQueryParams(queryParams?: QueryParameters): void;
     /**
@@ -25754,20 +25653,6 @@ declare namespace helpers {
     } & {
         [key: string]: any;
     };
-    type CredQualityUserResponse = {
-        tenantId: string;
-        username: string;
-        email: string;
-        credQualityMeasure: number;
-        pwdStrengthMeasure: number;
-        pwdQualityMeasure: number;
-        credChangeCount: number;
-        loginCount: number;
-        lastLoginDatetime: any;
-        lastCredCheckDatetime: any;
-    } & {
-        [key: string]: any;
-    };
     type PasswordLessLoginTokenRequest = {
         grant_type: string;
         hint: string;
@@ -25822,6 +25707,7 @@ declare namespace helpers {
         id_token: string;
         refresh_token: string;
         expires_in: number;
+        refresh_token_expires_in: any;
         token_type: string;
         usid: string;
         customer_id: string;
@@ -26129,7 +26015,6 @@ declare namespace helpers {
      * All query parameters that are used by at least one ShopperLogin method.
      */
     type ShopperLoginQueryParameters = {
-        username?: string;
         client_id?: string;
         refresh_token?: string;
         channel_id?: string;
@@ -26170,7 +26055,7 @@ declare namespace helpers {
      * ```
      *
      * <span style="font-size:.7em; display:block; text-align: right">
-     * API Version: 1.39.16<br />
+     * API Version: 1.39.17<br />
      * Last Updated: <br />
      * </span>
      
@@ -26184,52 +26069,6 @@ declare namespace helpers {
         };
         static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
         constructor(config: ClientConfigInit<ConfigParameters>);
-        /**
-         * Get credential quality statistics for a user.
-         *
-         * If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
-         *
-         * @param options - An object containing the options for this method.
-         * @param parameters - An object containing the parameters for this method.
-         * @param organizationId -
-         * @param username - User's login ID or email address.
-         * @param headers - An object literal of key value pairs of the headers to be
-         * sent with this request.
-         *
-         * @returns A promise of type CredQualityUserResponse.
-         *
-         */
-        retrieveCredQualityUserInfo(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                username: string;
-            }, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>): Promise<CredQualityUserResponse>;
-        /**
-         * Get credential quality statistics for a user.
-         *
-         * @param options - An object containing the options for this method.
-         * @param parameters - An object containing the parameters for this method.
-         * @param organizationId -
-         * @param username - User's login ID or email address.
-         * @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.
-         * @returns A promise of type Response if rawResponse is true, a promise of type CredQualityUserResponse otherwise.
-         *
-         */
-        retrieveCredQualityUserInfo<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
-            parameters?: CompositeParameters<{
-                organizationId: string;
-                username: string;
-            }, ConfigParameters>;
-            headers?: {
-                [key: string]: string;
-            };
-        }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
         /**
          * Logs in a shopper with credentials that are managed by a B2C Commerce instance (ECOM). It follows the authorization code grant flow as defined by the OAuth 2.1 standard. It also uses a proof key for code exchange (PKCE).