commerce-sdk-isomorphic 3.3.0 → 3.4.0

package/lib/index.esm.d.ts

@@ -25342,12 +25342,14 @@ type ShopperSearchQueryParameters = {
     sort?: string;
     currency?: string;
     locale?: string;
-    expand?: Array<string>;
+    expand?: Array<string> | string;
     allImages?: boolean;
     perPricebook?: boolean;
     allVariationProperties?: boolean;
+    includedCustomVariationProperties?: string;
     offset?: any;
     limit?: number;
+    includedCustomProductProperties?: string;
 };
 /**
  * All parameters that are used by ShopperSearch.
@@ -25407,6 +25409,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
             "allImages",
             "perPricebook",
             "allVariationProperties",
+            "includedCustomVariationProperties",
             "offset",
             "limit"
         ];
@@ -25420,7 +25423,9 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
             "q",
             "limit",
             "currency",
-            "locale"
+            "locale",
+            "expand",
+            "includedCustomProductProperties"
         ];
         readonly getSearchSuggestionsRequired: readonly [
             "organizationId",
@@ -25458,6 +25463,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
      * @param allImages - When the `images` expand parameter is used with this flag, the response includes the `imageGroups property`, which contains an image model. If this flag is true, the full image model is returned. If false, only matching images are included. If no flag is passed, the `imageGroups` property is omitted from the response.
      * @param perPricebook - When this flag is set to `true` and is used with the `prices` expand parameter, the response includes per PriceBook prices and tiered prices (if available).
      * @param allVariationProperties - The flag that determines which variation properties are included in the result. When set to `true` with the `variations` expand parameter, all variation properties (`variationAttributes`, `variationGroups`, `variants`) are returned. When set to false, only the default property `variationAttributes` is returned.
+     * @param includedCustomVariationProperties - A comma-separated list of custom property ids to be returned for variant products. The `variants` expand parameter and `allVariationProperties` query parameter are required for these properties to be returned.
      * @param offset -
      * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
      * @param headers - An object literal of key value pairs of the headers to be
@@ -25480,6 +25486,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
             allImages?: boolean;
             perPricebook?: boolean;
             allVariationProperties?: boolean;
+            includedCustomVariationProperties?: string;
             offset?: any;
             limit?: number;
         } & {
@@ -25517,6 +25524,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
      * @param allImages - When the `images` expand parameter is used with this flag, the response includes the `imageGroups property`, which contains an image model. If this flag is true, the full image model is returned. If false, only matching images are included. If no flag is passed, the `imageGroups` property is omitted from the response.
      * @param perPricebook - When this flag is set to `true` and is used with the `prices` expand parameter, the response includes per PriceBook prices and tiered prices (if available).
      * @param allVariationProperties - The flag that determines which variation properties are included in the result. When set to `true` with the `variations` expand parameter, all variation properties (`variationAttributes`, `variationGroups`, `variants`) are returned. When set to false, only the default property `variationAttributes` is returned.
+     * @param includedCustomVariationProperties - A comma-separated list of custom property ids to be returned for variant products. The `variants` expand parameter and `allVariationProperties` query parameter are required for these properties to be returned.
      * @param offset -
      * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
      * @param headers - An object literal of key value pairs of the headers to be
@@ -25539,6 +25547,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
             allImages?: boolean;
             perPricebook?: boolean;
             allVariationProperties?: boolean;
+            includedCustomVariationProperties?: string;
             offset?: any;
             limit?: number;
         } & {
@@ -25561,6 +25570,8 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
      * @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
      * @param currency - The currency code specified for price. This parameter is effective only for product suggestions.
      * @param locale -
+     * @param expand - A comma-separated list that allows values `images`, `prices`, `custom_product_properties`. By default, the expand parameter includes `prices`.
+     * @param includedCustomProductProperties - A comma-separated list of custom property ids to be returned for product suggestions. The `custom_product_properties` expand parameter is required for these properties to be returned.
      * @param headers - An object literal of key value pairs of the headers to be
      * sent with this request.
      *
@@ -25575,6 +25586,8 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
             limit?: number;
             currency?: string;
             locale?: string;
+            expand?: string;
+            includedCustomProductProperties?: string;
         } & {
             [key in `c_${string}`]: any;
         }, ConfigParameters>;
@@ -25593,6 +25606,8 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
      * @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
      * @param currency - The currency code specified for price. This parameter is effective only for product suggestions.
      * @param locale -
+     * @param expand - A comma-separated list that allows values `images`, `prices`, `custom_product_properties`. By default, the expand parameter includes `prices`.
+     * @param includedCustomProductProperties - A comma-separated list of custom property ids to be returned for product suggestions. The `custom_product_properties` expand parameter is required for these properties to be returned.
      * @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.
@@ -25607,6 +25622,8 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
             limit?: number;
             currency?: string;
             locale?: string;
+            expand?: string;
+            includedCustomProductProperties?: string;
         } & {
             [key in `c_${string}`]: any;
         }, ConfigParameters>;
@@ -26239,12 +26256,14 @@ declare namespace ShopperSearchTypes {
         sort?: string;
         currency?: string;
         locale?: string;
-        expand?: Array<string>;
+        expand?: Array<string> | string;
         allImages?: boolean;
         perPricebook?: boolean;
         allVariationProperties?: boolean;
+        includedCustomVariationProperties?: string;
         offset?: any;
         limit?: number;
+        includedCustomProductProperties?: string;
     };
     /**
      * All parameters that are used by ShopperSearch.
@@ -26304,6 +26323,7 @@ declare namespace ShopperSearchTypes {
                 "allImages",
                 "perPricebook",
                 "allVariationProperties",
+                "includedCustomVariationProperties",
                 "offset",
                 "limit"
             ];
@@ -26317,7 +26337,9 @@ declare namespace ShopperSearchTypes {
                 "q",
                 "limit",
                 "currency",
-                "locale"
+                "locale",
+                "expand",
+                "includedCustomProductProperties"
             ];
             readonly getSearchSuggestionsRequired: readonly [
                 "organizationId",
@@ -26355,6 +26377,7 @@ declare namespace ShopperSearchTypes {
          * @param allImages - When the `images` expand parameter is used with this flag, the response includes the `imageGroups property`, which contains an image model. If this flag is true, the full image model is returned. If false, only matching images are included. If no flag is passed, the `imageGroups` property is omitted from the response.
          * @param perPricebook - When this flag is set to `true` and is used with the `prices` expand parameter, the response includes per PriceBook prices and tiered prices (if available).
          * @param allVariationProperties - The flag that determines which variation properties are included in the result. When set to `true` with the `variations` expand parameter, all variation properties (`variationAttributes`, `variationGroups`, `variants`) are returned. When set to false, only the default property `variationAttributes` is returned.
+         * @param includedCustomVariationProperties - A comma-separated list of custom property ids to be returned for variant products. The `variants` expand parameter and `allVariationProperties` query parameter are required for these properties to be returned.
          * @param offset -
          * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
          * @param headers - An object literal of key value pairs of the headers to be
@@ -26377,6 +26400,7 @@ declare namespace ShopperSearchTypes {
                 allImages?: boolean;
                 perPricebook?: boolean;
                 allVariationProperties?: boolean;
+                includedCustomVariationProperties?: string;
                 offset?: any;
                 limit?: number;
             } & {
@@ -26414,6 +26438,7 @@ declare namespace ShopperSearchTypes {
          * @param allImages - When the `images` expand parameter is used with this flag, the response includes the `imageGroups property`, which contains an image model. If this flag is true, the full image model is returned. If false, only matching images are included. If no flag is passed, the `imageGroups` property is omitted from the response.
          * @param perPricebook - When this flag is set to `true` and is used with the `prices` expand parameter, the response includes per PriceBook prices and tiered prices (if available).
          * @param allVariationProperties - The flag that determines which variation properties are included in the result. When set to `true` with the `variations` expand parameter, all variation properties (`variationAttributes`, `variationGroups`, `variants`) are returned. When set to false, only the default property `variationAttributes` is returned.
+         * @param includedCustomVariationProperties - A comma-separated list of custom property ids to be returned for variant products. The `variants` expand parameter and `allVariationProperties` query parameter are required for these properties to be returned.
          * @param offset -
          * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
          * @param headers - An object literal of key value pairs of the headers to be
@@ -26436,6 +26461,7 @@ declare namespace ShopperSearchTypes {
                 allImages?: boolean;
                 perPricebook?: boolean;
                 allVariationProperties?: boolean;
+                includedCustomVariationProperties?: string;
                 offset?: any;
                 limit?: number;
             } & {
@@ -26458,6 +26484,8 @@ declare namespace ShopperSearchTypes {
          * @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
          * @param currency - The currency code specified for price. This parameter is effective only for product suggestions.
          * @param locale -
+         * @param expand - A comma-separated list that allows values `images`, `prices`, `custom_product_properties`. By default, the expand parameter includes `prices`.
+         * @param includedCustomProductProperties - A comma-separated list of custom property ids to be returned for product suggestions. The `custom_product_properties` expand parameter is required for these properties to be returned.
          * @param headers - An object literal of key value pairs of the headers to be
          * sent with this request.
          *
@@ -26472,6 +26500,8 @@ declare namespace ShopperSearchTypes {
                 limit?: number;
                 currency?: string;
                 locale?: string;
+                expand?: string;
+                includedCustomProductProperties?: string;
             } & {
                 [key in `c_${string}`]: any;
             }, ConfigParameters>;
@@ -26490,6 +26520,8 @@ declare namespace ShopperSearchTypes {
          * @param limit - The maximum number of suggestions made per request. If no value is defined, by default five suggestions per suggestion type are evaluated. This affects all types of suggestions (category, product, brand, and custom suggestions).
          * @param currency - The currency code specified for price. This parameter is effective only for product suggestions.
          * @param locale -
+         * @param expand - A comma-separated list that allows values `images`, `prices`, `custom_product_properties`. By default, the expand parameter includes `prices`.
+         * @param includedCustomProductProperties - A comma-separated list of custom property ids to be returned for product suggestions. The `custom_product_properties` expand parameter is required for these properties to be returned.
          * @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.
@@ -26504,6 +26536,8 @@ declare namespace ShopperSearchTypes {
                 limit?: number;
                 currency?: string;
                 locale?: string;
+                expand?: string;
+                includedCustomProductProperties?: string;
             } & {
                 [key in `c_${string}`]: any;
             }, ConfigParameters>;