commerce-sdk-isomorphic 1.10.1 → 1.10.3

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.
@@ -213,6 +213,7 @@ type PaymentCardSpec = {
213
213
  name?: string;
214
214
  numberLengths?: Array<string>;
215
215
  numberPrefixes?: Array<string>;
216
+ securityCodeLength?: number;
216
217
  } & {
217
218
  [key: string]: any;
218
219
  };
@@ -687,7 +688,7 @@ type ShopperBasketsParameters = ShopperBasketsPathParameters & BaseUriParameters
687
688
  * ```
688
689
  *
689
690
  * <span style="font-size:.7em; display:block; text-align: right">
690
- * API Version: 0.8.5<br />
691
+ * API Version: 0.8.9<br />
691
692
  * Last Updated: <br />
692
693
  * </span>
693
694
 
@@ -800,6 +801,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
800
801
  - `false` (default): Return a BasketTransferException (HTTP status 409). The basket owner doesn't change.
801
802
  - `true`: Force the transfer by deleting the current shopper's active basket and making the current shopper the owner of the previous shopper's basket. Returns the transferred basket (HTTP status 200).
802
803
  * @param siteId -
804
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
805
+ Below are some valid examples:
806
+ - en-US
807
+ - de-AT
808
+ - de
809
+ - default
803
810
  * @param headers - An object literal of key value pairs of the headers to be
804
811
  * sent with this request.
805
812
  *
@@ -811,6 +818,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
811
818
  organizationId: string;
812
819
  overrideExisting?: boolean;
813
820
  siteId: string;
821
+ locale?: string;
814
822
  }, ConfigParameters>;
815
823
  headers?: {
816
824
  [key: string]: string;
@@ -833,6 +841,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
833
841
  - `false` (default): Return a BasketTransferException (HTTP status 409). The basket owner doesn't change.
834
842
  - `true`: Force the transfer by deleting the current shopper's active basket and making the current shopper the owner of the previous shopper's basket. Returns the transferred basket (HTTP status 200).
835
843
  * @param siteId -
844
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
845
+ Below are some valid examples:
846
+ - en-US
847
+ - de-AT
848
+ - de
849
+ - default
836
850
  * @param headers - An object literal of key value pairs of the headers to be
837
851
  * sent with this request.
838
852
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -844,6 +858,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
844
858
  organizationId: string;
845
859
  overrideExisting?: boolean;
846
860
  siteId: string;
861
+ locale?: string;
847
862
  }, ConfigParameters>;
848
863
  headers?: {
849
864
  [key: string]: string;
@@ -904,6 +919,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
904
919
  - saved_quantity: Use the product's quantity in the current shopper's active basket. Ignore the quantity from the previous shopper's basket.
905
920
  - separate_item: Add a separate product item to the current shopper's basket for the quantity in the previous shopper's basket.
906
921
  * @param siteId -
922
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
923
+ Below are some valid examples:
924
+ - en-US
925
+ - de-AT
926
+ - de
927
+ - default
907
928
  * @param headers - An object literal of key value pairs of the headers to be
908
929
  * sent with this request.
909
930
  *
@@ -916,6 +937,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
916
937
  createDestinationBasket?: boolean;
917
938
  productItemMergeMode?: string;
918
939
  siteId: string;
940
+ locale?: string;
919
941
  }, ConfigParameters>;
920
942
  headers?: {
921
943
  [key: string]: string;
@@ -974,6 +996,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
974
996
  - saved_quantity: Use the product's quantity in the current shopper's active basket. Ignore the quantity from the previous shopper's basket.
975
997
  - separate_item: Add a separate product item to the current shopper's basket for the quantity in the previous shopper's basket.
976
998
  * @param siteId -
999
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
1000
+ Below are some valid examples:
1001
+ - en-US
1002
+ - de-AT
1003
+ - de
1004
+ - default
977
1005
  * @param headers - An object literal of key value pairs of the headers to be
978
1006
  * sent with this request.
979
1007
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -986,6 +1014,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
986
1014
  createDestinationBasket?: boolean;
987
1015
  productItemMergeMode?: string;
988
1016
  siteId: string;
1017
+ locale?: string;
989
1018
  }, ConfigParameters>;
990
1019
  headers?: {
991
1020
  [key: string]: string;
@@ -1398,6 +1427,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1398
1427
  * @param basketId - The ID of the basket to be modified.
1399
1428
  * @param couponItemId - The ID of the coupon item to be removed.
1400
1429
  * @param siteId -
1430
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
1431
+ Below are some valid examples:
1432
+ - en-US
1433
+ - de-AT
1434
+ - de
1435
+ - default
1401
1436
  * @param headers - An object literal of key value pairs of the headers to be
1402
1437
  * sent with this request.
1403
1438
  *
@@ -1410,6 +1445,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1410
1445
  basketId: string;
1411
1446
  couponItemId: string;
1412
1447
  siteId: string;
1448
+ locale?: string;
1413
1449
  }, ConfigParameters>;
1414
1450
  headers?: {
1415
1451
  [key: string]: string;
@@ -1424,6 +1460,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1424
1460
  * @param basketId - The ID of the basket to be modified.
1425
1461
  * @param couponItemId - The ID of the coupon item to be removed.
1426
1462
  * @param siteId -
1463
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
1464
+ Below are some valid examples:
1465
+ - en-US
1466
+ - de-AT
1467
+ - de
1468
+ - default
1427
1469
  * @param headers - An object literal of key value pairs of the headers to be
1428
1470
  * sent with this request.
1429
1471
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -1436,6 +1478,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1436
1478
  basketId: string;
1437
1479
  couponItemId: string;
1438
1480
  siteId: string;
1481
+ locale?: string;
1439
1482
  }, ConfigParameters>;
1440
1483
  headers?: {
1441
1484
  [key: string]: string;
@@ -1588,6 +1631,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1588
1631
  * @param basketId - The ID of the basket to be modified.
1589
1632
  * @param giftCertificateItemId - the ID of the gift certificate item to be updated.
1590
1633
  * @param siteId -
1634
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
1635
+ Below are some valid examples:
1636
+ - en-US
1637
+ - de-AT
1638
+ - de
1639
+ - default
1591
1640
  * @param headers - An object literal of key value pairs of the headers to be
1592
1641
  * sent with this request.
1593
1642
  *
@@ -1600,6 +1649,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1600
1649
  basketId: string;
1601
1650
  giftCertificateItemId: string;
1602
1651
  siteId: string;
1652
+ locale?: string;
1603
1653
  }, ConfigParameters>;
1604
1654
  headers?: {
1605
1655
  [key: string]: string;
@@ -1614,6 +1664,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1614
1664
  * @param basketId - The ID of the basket to be modified.
1615
1665
  * @param giftCertificateItemId - the ID of the gift certificate item to be updated.
1616
1666
  * @param siteId -
1667
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
1668
+ Below are some valid examples:
1669
+ - en-US
1670
+ - de-AT
1671
+ - de
1672
+ - default
1617
1673
  * @param headers - An object literal of key value pairs of the headers to be
1618
1674
  * sent with this request.
1619
1675
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -1626,6 +1682,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1626
1682
  basketId: string;
1627
1683
  giftCertificateItemId: string;
1628
1684
  siteId: string;
1685
+ locale?: string;
1629
1686
  }, ConfigParameters>;
1630
1687
  headers?: {
1631
1688
  [key: string]: string;
@@ -1832,6 +1889,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1832
1889
  * @param basketId - The ID of the basket to be modified.
1833
1890
  * @param itemId - The ID of the item to be updated.
1834
1891
  * @param siteId -
1892
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
1893
+ Below are some valid examples:
1894
+ - en-US
1895
+ - de-AT
1896
+ - de
1897
+ - default
1835
1898
  * @param headers - An object literal of key value pairs of the headers to be
1836
1899
  * sent with this request.
1837
1900
  *
@@ -1844,6 +1907,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1844
1907
  basketId: string;
1845
1908
  itemId: string;
1846
1909
  siteId: string;
1910
+ locale?: string;
1847
1911
  }, ConfigParameters>;
1848
1912
  headers?: {
1849
1913
  [key: string]: string;
@@ -1858,6 +1922,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1858
1922
  * @param basketId - The ID of the basket to be modified.
1859
1923
  * @param itemId - The ID of the item to be updated.
1860
1924
  * @param siteId -
1925
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
1926
+ Below are some valid examples:
1927
+ - en-US
1928
+ - de-AT
1929
+ - de
1930
+ - default
1861
1931
  * @param headers - An object literal of key value pairs of the headers to be
1862
1932
  * sent with this request.
1863
1933
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -1870,6 +1940,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
1870
1940
  basketId: string;
1871
1941
  itemId: string;
1872
1942
  siteId: string;
1943
+ locale?: string;
1873
1944
  }, ConfigParameters>;
1874
1945
  headers?: {
1875
1946
  [key: string]: string;
@@ -2142,6 +2213,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2142
2213
  * @param basketId - The ID of the basket to be modified.
2143
2214
  * @param paymentInstrumentId -
2144
2215
  * @param siteId -
2216
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
2217
+ Below are some valid examples:
2218
+ - en-US
2219
+ - de-AT
2220
+ - de
2221
+ - default
2145
2222
  * @param headers - An object literal of key value pairs of the headers to be
2146
2223
  * sent with this request.
2147
2224
  *
@@ -2154,6 +2231,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2154
2231
  basketId: string;
2155
2232
  paymentInstrumentId: string;
2156
2233
  siteId: string;
2234
+ locale?: string;
2157
2235
  }, ConfigParameters>;
2158
2236
  headers?: {
2159
2237
  [key: string]: string;
@@ -2168,6 +2246,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2168
2246
  * @param basketId - The ID of the basket to be modified.
2169
2247
  * @param paymentInstrumentId -
2170
2248
  * @param siteId -
2249
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
2250
+ Below are some valid examples:
2251
+ - en-US
2252
+ - de-AT
2253
+ - de
2254
+ - default
2171
2255
  * @param headers - An object literal of key value pairs of the headers to be
2172
2256
  * sent with this request.
2173
2257
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -2180,6 +2264,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2180
2264
  basketId: string;
2181
2265
  paymentInstrumentId: string;
2182
2266
  siteId: string;
2267
+ locale?: string;
2183
2268
  }, ConfigParameters>;
2184
2269
  headers?: {
2185
2270
  [key: string]: string;
@@ -2408,6 +2493,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2408
2493
  * @param basketId - The ID of the basket to be modified.
2409
2494
  * @param priceAdjustmentId -
2410
2495
  * @param siteId -
2496
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
2497
+ Below are some valid examples:
2498
+ - en-US
2499
+ - de-AT
2500
+ - de
2501
+ - default
2411
2502
  * @param headers - An object literal of key value pairs of the headers to be
2412
2503
  * sent with this request.
2413
2504
  *
@@ -2420,6 +2511,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2420
2511
  basketId: string;
2421
2512
  priceAdjustmentId: string;
2422
2513
  siteId: string;
2514
+ locale?: string;
2423
2515
  }, ConfigParameters>;
2424
2516
  headers?: {
2425
2517
  [key: string]: string;
@@ -2434,6 +2526,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2434
2526
  * @param basketId - The ID of the basket to be modified.
2435
2527
  * @param priceAdjustmentId -
2436
2528
  * @param siteId -
2529
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
2530
+ Below are some valid examples:
2531
+ - en-US
2532
+ - de-AT
2533
+ - de
2534
+ - default
2437
2535
  * @param headers - An object literal of key value pairs of the headers to be
2438
2536
  * sent with this request.
2439
2537
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -2446,6 +2544,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2446
2544
  basketId: string;
2447
2545
  priceAdjustmentId: string;
2448
2546
  siteId: string;
2547
+ locale?: string;
2449
2548
  }, ConfigParameters>;
2450
2549
  headers?: {
2451
2550
  [key: string]: string;
@@ -2726,6 +2825,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2726
2825
  * @param basketId - The ID of the basket to be modified.
2727
2826
  * @param shipmentId - The ID of the shipment to be modified.
2728
2827
  * @param siteId -
2828
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
2829
+ Below are some valid examples:
2830
+ - en-US
2831
+ - de-AT
2832
+ - de
2833
+ - default
2729
2834
  * @param headers - An object literal of key value pairs of the headers to be
2730
2835
  * sent with this request.
2731
2836
  *
@@ -2738,6 +2843,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2738
2843
  basketId: string;
2739
2844
  shipmentId: string;
2740
2845
  siteId: string;
2846
+ locale?: string;
2741
2847
  }, ConfigParameters>;
2742
2848
  headers?: {
2743
2849
  [key: string]: string;
@@ -2754,6 +2860,12 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2754
2860
  * @param basketId - The ID of the basket to be modified.
2755
2861
  * @param shipmentId - The ID of the shipment to be modified.
2756
2862
  * @param siteId -
2863
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
2864
+ Below are some valid examples:
2865
+ - en-US
2866
+ - de-AT
2867
+ - de
2868
+ - default
2757
2869
  * @param headers - An object literal of key value pairs of the headers to be
2758
2870
  * sent with this request.
2759
2871
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -2766,6 +2878,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
2766
2878
  basketId: string;
2767
2879
  shipmentId: string;
2768
2880
  siteId: string;
2881
+ locale?: string;
2769
2882
  }, ConfigParameters>;
2770
2883
  headers?: {
2771
2884
  [key: string]: string;
@@ -3604,6 +3717,7 @@ declare namespace ShopperBasketsTypes {
3604
3717
  name?: string;
3605
3718
  numberLengths?: Array<string>;
3606
3719
  numberPrefixes?: Array<string>;
3720
+ securityCodeLength?: number;
3607
3721
  } & {
3608
3722
  [key: string]: any;
3609
3723
  };
@@ -4113,7 +4227,7 @@ declare namespace ShopperBasketsTypes {
4113
4227
  * ```
4114
4228
  *
4115
4229
  * <span style="font-size:.7em; display:block; text-align: right">
4116
- * API Version: 0.8.5<br />
4230
+ * API Version: 0.8.9<br />
4117
4231
  * Last Updated: <br />
4118
4232
  * </span>
4119
4233
 
@@ -4226,6 +4340,12 @@ declare namespace ShopperBasketsTypes {
4226
4340
  - `false` (default): Return a BasketTransferException (HTTP status 409). The basket owner doesn't change.
4227
4341
  - `true`: Force the transfer by deleting the current shopper's active basket and making the current shopper the owner of the previous shopper's basket. Returns the transferred basket (HTTP status 200).
4228
4342
  * @param siteId -
4343
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
4344
+ Below are some valid examples:
4345
+ - en-US
4346
+ - de-AT
4347
+ - de
4348
+ - default
4229
4349
  * @param headers - An object literal of key value pairs of the headers to be
4230
4350
  * sent with this request.
4231
4351
  *
@@ -4237,6 +4357,7 @@ declare namespace ShopperBasketsTypes {
4237
4357
  organizationId: string;
4238
4358
  overrideExisting?: boolean;
4239
4359
  siteId: string;
4360
+ locale?: string;
4240
4361
  }, ConfigParameters>;
4241
4362
  headers?: {
4242
4363
  [key: string]: string;
@@ -4259,6 +4380,12 @@ declare namespace ShopperBasketsTypes {
4259
4380
  - `false` (default): Return a BasketTransferException (HTTP status 409). The basket owner doesn't change.
4260
4381
  - `true`: Force the transfer by deleting the current shopper's active basket and making the current shopper the owner of the previous shopper's basket. Returns the transferred basket (HTTP status 200).
4261
4382
  * @param siteId -
4383
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
4384
+ Below are some valid examples:
4385
+ - en-US
4386
+ - de-AT
4387
+ - de
4388
+ - default
4262
4389
  * @param headers - An object literal of key value pairs of the headers to be
4263
4390
  * sent with this request.
4264
4391
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -4270,6 +4397,7 @@ declare namespace ShopperBasketsTypes {
4270
4397
  organizationId: string;
4271
4398
  overrideExisting?: boolean;
4272
4399
  siteId: string;
4400
+ locale?: string;
4273
4401
  }, ConfigParameters>;
4274
4402
  headers?: {
4275
4403
  [key: string]: string;
@@ -4330,6 +4458,12 @@ declare namespace ShopperBasketsTypes {
4330
4458
  - saved_quantity: Use the product's quantity in the current shopper's active basket. Ignore the quantity from the previous shopper's basket.
4331
4459
  - separate_item: Add a separate product item to the current shopper's basket for the quantity in the previous shopper's basket.
4332
4460
  * @param siteId -
4461
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
4462
+ Below are some valid examples:
4463
+ - en-US
4464
+ - de-AT
4465
+ - de
4466
+ - default
4333
4467
  * @param headers - An object literal of key value pairs of the headers to be
4334
4468
  * sent with this request.
4335
4469
  *
@@ -4342,6 +4476,7 @@ declare namespace ShopperBasketsTypes {
4342
4476
  createDestinationBasket?: boolean;
4343
4477
  productItemMergeMode?: string;
4344
4478
  siteId: string;
4479
+ locale?: string;
4345
4480
  }, ConfigParameters>;
4346
4481
  headers?: {
4347
4482
  [key: string]: string;
@@ -4400,6 +4535,12 @@ declare namespace ShopperBasketsTypes {
4400
4535
  - saved_quantity: Use the product's quantity in the current shopper's active basket. Ignore the quantity from the previous shopper's basket.
4401
4536
  - separate_item: Add a separate product item to the current shopper's basket for the quantity in the previous shopper's basket.
4402
4537
  * @param siteId -
4538
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
4539
+ Below are some valid examples:
4540
+ - en-US
4541
+ - de-AT
4542
+ - de
4543
+ - default
4403
4544
  * @param headers - An object literal of key value pairs of the headers to be
4404
4545
  * sent with this request.
4405
4546
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -4412,6 +4553,7 @@ declare namespace ShopperBasketsTypes {
4412
4553
  createDestinationBasket?: boolean;
4413
4554
  productItemMergeMode?: string;
4414
4555
  siteId: string;
4556
+ locale?: string;
4415
4557
  }, ConfigParameters>;
4416
4558
  headers?: {
4417
4559
  [key: string]: string;
@@ -4824,6 +4966,12 @@ declare namespace ShopperBasketsTypes {
4824
4966
  * @param basketId - The ID of the basket to be modified.
4825
4967
  * @param couponItemId - The ID of the coupon item to be removed.
4826
4968
  * @param siteId -
4969
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
4970
+ Below are some valid examples:
4971
+ - en-US
4972
+ - de-AT
4973
+ - de
4974
+ - default
4827
4975
  * @param headers - An object literal of key value pairs of the headers to be
4828
4976
  * sent with this request.
4829
4977
  *
@@ -4836,6 +4984,7 @@ declare namespace ShopperBasketsTypes {
4836
4984
  basketId: string;
4837
4985
  couponItemId: string;
4838
4986
  siteId: string;
4987
+ locale?: string;
4839
4988
  }, ConfigParameters>;
4840
4989
  headers?: {
4841
4990
  [key: string]: string;
@@ -4850,6 +4999,12 @@ declare namespace ShopperBasketsTypes {
4850
4999
  * @param basketId - The ID of the basket to be modified.
4851
5000
  * @param couponItemId - The ID of the coupon item to be removed.
4852
5001
  * @param siteId -
5002
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
5003
+ Below are some valid examples:
5004
+ - en-US
5005
+ - de-AT
5006
+ - de
5007
+ - default
4853
5008
  * @param headers - An object literal of key value pairs of the headers to be
4854
5009
  * sent with this request.
4855
5010
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -4862,6 +5017,7 @@ declare namespace ShopperBasketsTypes {
4862
5017
  basketId: string;
4863
5018
  couponItemId: string;
4864
5019
  siteId: string;
5020
+ locale?: string;
4865
5021
  }, ConfigParameters>;
4866
5022
  headers?: {
4867
5023
  [key: string]: string;
@@ -5014,6 +5170,12 @@ declare namespace ShopperBasketsTypes {
5014
5170
  * @param basketId - The ID of the basket to be modified.
5015
5171
  * @param giftCertificateItemId - the ID of the gift certificate item to be updated.
5016
5172
  * @param siteId -
5173
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
5174
+ Below are some valid examples:
5175
+ - en-US
5176
+ - de-AT
5177
+ - de
5178
+ - default
5017
5179
  * @param headers - An object literal of key value pairs of the headers to be
5018
5180
  * sent with this request.
5019
5181
  *
@@ -5026,6 +5188,7 @@ declare namespace ShopperBasketsTypes {
5026
5188
  basketId: string;
5027
5189
  giftCertificateItemId: string;
5028
5190
  siteId: string;
5191
+ locale?: string;
5029
5192
  }, ConfigParameters>;
5030
5193
  headers?: {
5031
5194
  [key: string]: string;
@@ -5040,6 +5203,12 @@ declare namespace ShopperBasketsTypes {
5040
5203
  * @param basketId - The ID of the basket to be modified.
5041
5204
  * @param giftCertificateItemId - the ID of the gift certificate item to be updated.
5042
5205
  * @param siteId -
5206
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
5207
+ Below are some valid examples:
5208
+ - en-US
5209
+ - de-AT
5210
+ - de
5211
+ - default
5043
5212
  * @param headers - An object literal of key value pairs of the headers to be
5044
5213
  * sent with this request.
5045
5214
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -5052,6 +5221,7 @@ declare namespace ShopperBasketsTypes {
5052
5221
  basketId: string;
5053
5222
  giftCertificateItemId: string;
5054
5223
  siteId: string;
5224
+ locale?: string;
5055
5225
  }, ConfigParameters>;
5056
5226
  headers?: {
5057
5227
  [key: string]: string;
@@ -5258,6 +5428,12 @@ declare namespace ShopperBasketsTypes {
5258
5428
  * @param basketId - The ID of the basket to be modified.
5259
5429
  * @param itemId - The ID of the item to be updated.
5260
5430
  * @param siteId -
5431
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
5432
+ Below are some valid examples:
5433
+ - en-US
5434
+ - de-AT
5435
+ - de
5436
+ - default
5261
5437
  * @param headers - An object literal of key value pairs of the headers to be
5262
5438
  * sent with this request.
5263
5439
  *
@@ -5270,6 +5446,7 @@ declare namespace ShopperBasketsTypes {
5270
5446
  basketId: string;
5271
5447
  itemId: string;
5272
5448
  siteId: string;
5449
+ locale?: string;
5273
5450
  }, ConfigParameters>;
5274
5451
  headers?: {
5275
5452
  [key: string]: string;
@@ -5284,6 +5461,12 @@ declare namespace ShopperBasketsTypes {
5284
5461
  * @param basketId - The ID of the basket to be modified.
5285
5462
  * @param itemId - The ID of the item to be updated.
5286
5463
  * @param siteId -
5464
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
5465
+ Below are some valid examples:
5466
+ - en-US
5467
+ - de-AT
5468
+ - de
5469
+ - default
5287
5470
  * @param headers - An object literal of key value pairs of the headers to be
5288
5471
  * sent with this request.
5289
5472
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -5296,6 +5479,7 @@ declare namespace ShopperBasketsTypes {
5296
5479
  basketId: string;
5297
5480
  itemId: string;
5298
5481
  siteId: string;
5482
+ locale?: string;
5299
5483
  }, ConfigParameters>;
5300
5484
  headers?: {
5301
5485
  [key: string]: string;
@@ -5568,6 +5752,12 @@ declare namespace ShopperBasketsTypes {
5568
5752
  * @param basketId - The ID of the basket to be modified.
5569
5753
  * @param paymentInstrumentId -
5570
5754
  * @param siteId -
5755
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
5756
+ Below are some valid examples:
5757
+ - en-US
5758
+ - de-AT
5759
+ - de
5760
+ - default
5571
5761
  * @param headers - An object literal of key value pairs of the headers to be
5572
5762
  * sent with this request.
5573
5763
  *
@@ -5580,6 +5770,7 @@ declare namespace ShopperBasketsTypes {
5580
5770
  basketId: string;
5581
5771
  paymentInstrumentId: string;
5582
5772
  siteId: string;
5773
+ locale?: string;
5583
5774
  }, ConfigParameters>;
5584
5775
  headers?: {
5585
5776
  [key: string]: string;
@@ -5594,6 +5785,12 @@ declare namespace ShopperBasketsTypes {
5594
5785
  * @param basketId - The ID of the basket to be modified.
5595
5786
  * @param paymentInstrumentId -
5596
5787
  * @param siteId -
5788
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
5789
+ Below are some valid examples:
5790
+ - en-US
5791
+ - de-AT
5792
+ - de
5793
+ - default
5597
5794
  * @param headers - An object literal of key value pairs of the headers to be
5598
5795
  * sent with this request.
5599
5796
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -5606,6 +5803,7 @@ declare namespace ShopperBasketsTypes {
5606
5803
  basketId: string;
5607
5804
  paymentInstrumentId: string;
5608
5805
  siteId: string;
5806
+ locale?: string;
5609
5807
  }, ConfigParameters>;
5610
5808
  headers?: {
5611
5809
  [key: string]: string;
@@ -5834,6 +6032,12 @@ declare namespace ShopperBasketsTypes {
5834
6032
  * @param basketId - The ID of the basket to be modified.
5835
6033
  * @param priceAdjustmentId -
5836
6034
  * @param siteId -
6035
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
6036
+ Below are some valid examples:
6037
+ - en-US
6038
+ - de-AT
6039
+ - de
6040
+ - default
5837
6041
  * @param headers - An object literal of key value pairs of the headers to be
5838
6042
  * sent with this request.
5839
6043
  *
@@ -5846,6 +6050,7 @@ declare namespace ShopperBasketsTypes {
5846
6050
  basketId: string;
5847
6051
  priceAdjustmentId: string;
5848
6052
  siteId: string;
6053
+ locale?: string;
5849
6054
  }, ConfigParameters>;
5850
6055
  headers?: {
5851
6056
  [key: string]: string;
@@ -5860,6 +6065,12 @@ declare namespace ShopperBasketsTypes {
5860
6065
  * @param basketId - The ID of the basket to be modified.
5861
6066
  * @param priceAdjustmentId -
5862
6067
  * @param siteId -
6068
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
6069
+ Below are some valid examples:
6070
+ - en-US
6071
+ - de-AT
6072
+ - de
6073
+ - default
5863
6074
  * @param headers - An object literal of key value pairs of the headers to be
5864
6075
  * sent with this request.
5865
6076
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -5872,6 +6083,7 @@ declare namespace ShopperBasketsTypes {
5872
6083
  basketId: string;
5873
6084
  priceAdjustmentId: string;
5874
6085
  siteId: string;
6086
+ locale?: string;
5875
6087
  }, ConfigParameters>;
5876
6088
  headers?: {
5877
6089
  [key: string]: string;
@@ -6152,6 +6364,12 @@ declare namespace ShopperBasketsTypes {
6152
6364
  * @param basketId - The ID of the basket to be modified.
6153
6365
  * @param shipmentId - The ID of the shipment to be modified.
6154
6366
  * @param siteId -
6367
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
6368
+ Below are some valid examples:
6369
+ - en-US
6370
+ - de-AT
6371
+ - de
6372
+ - default
6155
6373
  * @param headers - An object literal of key value pairs of the headers to be
6156
6374
  * sent with this request.
6157
6375
  *
@@ -6164,6 +6382,7 @@ declare namespace ShopperBasketsTypes {
6164
6382
  basketId: string;
6165
6383
  shipmentId: string;
6166
6384
  siteId: string;
6385
+ locale?: string;
6167
6386
  }, ConfigParameters>;
6168
6387
  headers?: {
6169
6388
  [key: string]: string;
@@ -6180,6 +6399,12 @@ declare namespace ShopperBasketsTypes {
6180
6399
  * @param basketId - The ID of the basket to be modified.
6181
6400
  * @param shipmentId - The ID of the shipment to be modified.
6182
6401
  * @param siteId -
6402
+ * @param locale - A descriptor to provide locale context for a geographical region by both a language and/or country code. The locale pattern in the query param follows the ISO 639-1 for the language code (e.g. en, de, fr) and ISO 3166-1 for the country code (e.g. US, DE, AT). The param can be a combination of language code and country code or can just refer to the language code.
6403
+ Below are some valid examples:
6404
+ - en-US
6405
+ - de-AT
6406
+ - de
6407
+ - default
6183
6408
  * @param headers - An object literal of key value pairs of the headers to be
6184
6409
  * sent with this request.
6185
6410
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -6192,6 +6417,7 @@ declare namespace ShopperBasketsTypes {
6192
6417
  basketId: string;
6193
6418
  shipmentId: string;
6194
6419
  siteId: string;
6420
+ locale?: string;
6195
6421
  }, ConfigParameters>;
6196
6422
  headers?: {
6197
6423
  [key: string]: string;
@@ -6842,7 +7068,7 @@ type ShopperContextsParameters = ShopperContextsPathParameters & BaseUriParamete
6842
7068
  * ```
6843
7069
  *
6844
7070
  * <span style="font-size:.7em; display:block; text-align: right">
6845
- * API Version: 0.0.19<br />
7071
+ * API Version: 0.0.20<br />
6846
7072
  * Last Updated: <br />
6847
7073
  * </span>
6848
7074
 
@@ -6864,7 +7090,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
6864
7090
  * @param options - An object containing the options for this method.
6865
7091
  * @param parameters - An object containing the parameters for this method.
6866
7092
  * @param organizationId -
6867
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7093
+ * @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.
6868
7094
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
6869
7095
  * @param headers - An object literal of key value pairs of the headers to be
6870
7096
  * sent with this request.
@@ -6888,7 +7114,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
6888
7114
  * @param options - An object containing the options for this method.
6889
7115
  * @param parameters - An object containing the parameters for this method.
6890
7116
  * @param organizationId -
6891
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7117
+ * @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.
6892
7118
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
6893
7119
  * @param headers - An object literal of key value pairs of the headers to be
6894
7120
  * sent with this request.
@@ -6914,7 +7140,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
6914
7140
  * @param options - An object containing the options for this method.
6915
7141
  * @param parameters - An object containing the parameters for this method.
6916
7142
  * @param organizationId -
6917
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7143
+ * @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.
6918
7144
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
6919
7145
  * @param headers - An object literal of key value pairs of the headers to be
6920
7146
  * sent with this request.
@@ -6940,7 +7166,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
6940
7166
  * @param options - An object containing the options for this method.
6941
7167
  * @param parameters - An object containing the parameters for this method.
6942
7168
  * @param organizationId -
6943
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7169
+ * @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.
6944
7170
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
6945
7171
  * @param headers - An object literal of key value pairs of the headers to be
6946
7172
  * sent with this request.
@@ -6968,7 +7194,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
6968
7194
  * @param options - An object containing the options for this method.
6969
7195
  * @param parameters - An object containing the parameters for this method.
6970
7196
  * @param organizationId -
6971
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7197
+ * @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.
6972
7198
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
6973
7199
  * @param headers - An object literal of key value pairs of the headers to be
6974
7200
  * sent with this request.
@@ -6992,7 +7218,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
6992
7218
  * @param options - An object containing the options for this method.
6993
7219
  * @param parameters - An object containing the parameters for this method.
6994
7220
  * @param organizationId -
6995
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7221
+ * @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.
6996
7222
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
6997
7223
  * @param headers - An object literal of key value pairs of the headers to be
6998
7224
  * sent with this request.
@@ -7018,7 +7244,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
7018
7244
  * @param options - An object containing the options for this method.
7019
7245
  * @param parameters - An object containing the parameters for this method.
7020
7246
  * @param organizationId -
7021
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7247
+ * @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.
7022
7248
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7023
7249
  * @param headers - An object literal of key value pairs of the headers to be
7024
7250
  * sent with this request.
@@ -7044,7 +7270,7 @@ declare class ShopperContexts<ConfigParameters extends ShopperContextsParameters
7044
7270
  * @param options - An object containing the options for this method.
7045
7271
  * @param parameters - An object containing the parameters for this method.
7046
7272
  * @param organizationId -
7047
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7273
+ * @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.
7048
7274
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7049
7275
  * @param headers - An object literal of key value pairs of the headers to be
7050
7276
  * sent with this request.
@@ -7466,7 +7692,7 @@ declare namespace ShopperContextsTypes {
7466
7692
  * ```
7467
7693
  *
7468
7694
  * <span style="font-size:.7em; display:block; text-align: right">
7469
- * API Version: 0.0.19<br />
7695
+ * API Version: 0.0.20<br />
7470
7696
  * Last Updated: <br />
7471
7697
  * </span>
7472
7698
 
@@ -7488,7 +7714,7 @@ declare namespace ShopperContextsTypes {
7488
7714
  * @param options - An object containing the options for this method.
7489
7715
  * @param parameters - An object containing the parameters for this method.
7490
7716
  * @param organizationId -
7491
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7717
+ * @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.
7492
7718
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7493
7719
  * @param headers - An object literal of key value pairs of the headers to be
7494
7720
  * sent with this request.
@@ -7512,7 +7738,7 @@ declare namespace ShopperContextsTypes {
7512
7738
  * @param options - An object containing the options for this method.
7513
7739
  * @param parameters - An object containing the parameters for this method.
7514
7740
  * @param organizationId -
7515
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7741
+ * @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.
7516
7742
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7517
7743
  * @param headers - An object literal of key value pairs of the headers to be
7518
7744
  * sent with this request.
@@ -7538,7 +7764,7 @@ declare namespace ShopperContextsTypes {
7538
7764
  * @param options - An object containing the options for this method.
7539
7765
  * @param parameters - An object containing the parameters for this method.
7540
7766
  * @param organizationId -
7541
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7767
+ * @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.
7542
7768
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7543
7769
  * @param headers - An object literal of key value pairs of the headers to be
7544
7770
  * sent with this request.
@@ -7564,7 +7790,7 @@ declare namespace ShopperContextsTypes {
7564
7790
  * @param options - An object containing the options for this method.
7565
7791
  * @param parameters - An object containing the parameters for this method.
7566
7792
  * @param organizationId -
7567
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7793
+ * @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.
7568
7794
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7569
7795
  * @param headers - An object literal of key value pairs of the headers to be
7570
7796
  * sent with this request.
@@ -7592,7 +7818,7 @@ declare namespace ShopperContextsTypes {
7592
7818
  * @param options - An object containing the options for this method.
7593
7819
  * @param parameters - An object containing the parameters for this method.
7594
7820
  * @param organizationId -
7595
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7821
+ * @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.
7596
7822
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7597
7823
  * @param headers - An object literal of key value pairs of the headers to be
7598
7824
  * sent with this request.
@@ -7616,7 +7842,7 @@ declare namespace ShopperContextsTypes {
7616
7842
  * @param options - An object containing the options for this method.
7617
7843
  * @param parameters - An object containing the parameters for this method.
7618
7844
  * @param organizationId -
7619
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7845
+ * @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.
7620
7846
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7621
7847
  * @param headers - An object literal of key value pairs of the headers to be
7622
7848
  * sent with this request.
@@ -7642,7 +7868,7 @@ declare namespace ShopperContextsTypes {
7642
7868
  * @param options - An object containing the options for this method.
7643
7869
  * @param parameters - An object containing the parameters for this method.
7644
7870
  * @param organizationId -
7645
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7871
+ * @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.
7646
7872
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7647
7873
  * @param headers - An object literal of key value pairs of the headers to be
7648
7874
  * sent with this request.
@@ -7668,7 +7894,7 @@ declare namespace ShopperContextsTypes {
7668
7894
  * @param options - An object containing the options for this method.
7669
7895
  * @param parameters - An object containing the parameters for this method.
7670
7896
  * @param organizationId -
7671
- * @param usid - The Shopper's unique identifier, if known. This is an optional field, a new shopper ID will be generated if this field is empty.
7897
+ * @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.
7672
7898
  * @param siteId - The identifer of the site that a request is being made in the context of. It is strongly recommended to pass in the siteId in the call.
7673
7899
  * @param headers - An object literal of key value pairs of the headers to be
7674
7900
  * sent with this request.
@@ -16439,12 +16665,12 @@ type LoginRequest = {
16439
16665
  scope?: string;
16440
16666
  usid?: string;
16441
16667
  channel_id: string;
16442
- code_challenge: string;
16668
+ code_challenge?: string;
16443
16669
  } & {
16444
16670
  [key: string]: any;
16445
16671
  };
16446
16672
  type TrustedAgentTokenRequest = {
16447
- agent_id: string;
16673
+ agent_id?: string;
16448
16674
  client_id: string;
16449
16675
  channel_id: string;
16450
16676
  code_verifier: string;
@@ -16464,20 +16690,6 @@ type PasswordlessLoginRequest = {
16464
16690
  } & {
16465
16691
  [key: string]: any;
16466
16692
  };
16467
- type CredQualityUserResponse = {
16468
- tenantId: string;
16469
- username: string;
16470
- email: string;
16471
- credQualityMeasure: number;
16472
- pwdStrengthMeasure: number;
16473
- pwdQualityMeasure: number;
16474
- credChangeCount: number;
16475
- loginCount: number;
16476
- lastLoginDatetime: any;
16477
- lastCredCheckDatetime: any;
16478
- } & {
16479
- [key: string]: any;
16480
- };
16481
16693
  type PasswordLessLoginTokenRequest = {
16482
16694
  grant_type: string;
16483
16695
  hint: string;
@@ -16525,6 +16737,7 @@ type TokenResponse = {
16525
16737
  id_token: string;
16526
16738
  refresh_token: string;
16527
16739
  expires_in: number;
16740
+ refresh_token_expires_in: any;
16528
16741
  token_type: string;
16529
16742
  usid: string;
16530
16743
  customer_id: string;
@@ -16559,6 +16772,7 @@ type SessionBridgeTokenRequest = {
16559
16772
  dwsid: string;
16560
16773
  grant_type: string;
16561
16774
  login_id: string;
16775
+ dwsgst?: string;
16562
16776
  usid?: string;
16563
16777
  } & {
16564
16778
  [key: string]: any;
@@ -16676,7 +16890,6 @@ type ShopperLoginPathParameters = {
16676
16890
  * All query parameters that are used by at least one ShopperLogin method.
16677
16891
  */
16678
16892
  type ShopperLoginQueryParameters = {
16679
- username?: string;
16680
16893
  client_id?: string;
16681
16894
  refresh_token?: string;
16682
16895
  channel_id?: string;
@@ -16717,7 +16930,7 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
16717
16930
  * ```
16718
16931
  *
16719
16932
  * <span style="font-size:.7em; display:block; text-align: right">
16720
- * API Version: 1.39.14<br />
16933
+ * API Version: 1.39.17<br />
16721
16934
  * Last Updated: <br />
16722
16935
  * </span>
16723
16936
 
@@ -16731,52 +16944,6 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
16731
16944
  };
16732
16945
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
16733
16946
  constructor(config: ClientConfigInit<ConfigParameters>);
16734
- /**
16735
- * Get credential quality statistics for a user.
16736
- *
16737
- * If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
16738
- *
16739
- * @param options - An object containing the options for this method.
16740
- * @param parameters - An object containing the parameters for this method.
16741
- * @param organizationId -
16742
- * @param username - User's login ID or email address.
16743
- * @param headers - An object literal of key value pairs of the headers to be
16744
- * sent with this request.
16745
- *
16746
- * @returns A promise of type CredQualityUserResponse.
16747
- *
16748
- */
16749
- retrieveCredQualityUserInfo(options?: RequireParametersUnlessAllAreOptional<{
16750
- parameters?: CompositeParameters<{
16751
- organizationId: string;
16752
- username: string;
16753
- }, ConfigParameters>;
16754
- headers?: {
16755
- [key: string]: string;
16756
- };
16757
- }>): Promise<CredQualityUserResponse>;
16758
- /**
16759
- * Get credential quality statistics for a user.
16760
- *
16761
- * @param options - An object containing the options for this method.
16762
- * @param parameters - An object containing the parameters for this method.
16763
- * @param organizationId -
16764
- * @param username - User's login ID or email address.
16765
- * @param headers - An object literal of key value pairs of the headers to be
16766
- * sent with this request.
16767
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
16768
- * @returns A promise of type Response if rawResponse is true, a promise of type CredQualityUserResponse otherwise.
16769
- *
16770
- */
16771
- retrieveCredQualityUserInfo<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
16772
- parameters?: CompositeParameters<{
16773
- organizationId: string;
16774
- username: string;
16775
- }, ConfigParameters>;
16776
- headers?: {
16777
- [key: string]: string;
16778
- };
16779
- }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
16780
16947
  /**
16781
16948
  * 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).
16782
16949
 
@@ -16788,7 +16955,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
16788
16955
 
16789
16956
  Required parameters: `code_challenge`, `channel_id`, `client_id`, and `redirect_uri`.
16790
16957
 
16791
- Optional parameters: `usid``.
16958
+ Optional parameters: `usid`.
16792
16959
 
16793
16960
  The SLAS `/login` endpoint redirects back to the redirect URI and returns an authorization code.
16794
16961
 
@@ -16827,7 +16994,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
16827
16994
 
16828
16995
  Required parameters: `code_challenge`, `channel_id`, `client_id`, and `redirect_uri`.
16829
16996
 
16830
- Optional parameters: `usid``.
16997
+ Optional parameters: `usid`.
16831
16998
 
16832
16999
  The SLAS `/login` endpoint redirects back to the redirect URI and returns an authorization code.
16833
17000
 
@@ -16975,7 +17142,12 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
16975
17142
  * @param options - An object containing the options for this method.
16976
17143
  * @param parameters - An object containing the parameters for this method.
16977
17144
  * @param organizationId -
16978
- * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
17145
+ * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
17146
+ - `http://localhost:3000/callback`
17147
+ - `https://example.com/callback`
17148
+ - `com.example.app:redirect_uri_path`
17149
+ - ` *.subdomain.topleveldomain.com`
17150
+
16979
17151
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
16980
17152
  * @param client_id - The client ID obtained during application registration.
16981
17153
  * @param scope -
@@ -17023,7 +17195,12 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17023
17195
  * @param options - An object containing the options for this method.
17024
17196
  * @param parameters - An object containing the parameters for this method.
17025
17197
  * @param organizationId -
17026
- * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
17198
+ * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
17199
+ - `http://localhost:3000/callback`
17200
+ - `https://example.com/callback`
17201
+ - `com.example.app:redirect_uri_path`
17202
+ - ` *.subdomain.topleveldomain.com`
17203
+
17027
17204
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
17028
17205
  * @param client_id - The client ID obtained during application registration.
17029
17206
  * @param scope -
@@ -17070,7 +17247,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17070
17247
 
17071
17248
  For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
17072
17249
 
17073
- For a public client using PKCE, an application will pass a PKCE `code_verifier`` that matches the `code_challenge`` that was used to `authorize` the customer along with the authorization code.
17250
+ For a public client using PKCE, an application will pass a PKCE `code_verifier` that matches the `code_challenge` that was used to `authorize` the customer along with the authorization code.
17074
17251
 
17075
17252
  When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.
17076
17253
 
@@ -17106,7 +17283,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17106
17283
 
17107
17284
  For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
17108
17285
 
17109
- For a public client using PKCE, an application will pass a PKCE `code_verifier`` that matches the `code_challenge`` that was used to `authorize` the customer along with the authorization code.
17286
+ For a public client using PKCE, an application will pass a PKCE `code_verifier` that matches the `code_challenge` that was used to `authorize` the customer along with the authorization code.
17110
17287
 
17111
17288
  When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.
17112
17289
 
@@ -17260,7 +17437,12 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17260
17437
  The `code_challenge` is not needed if a using SLAS private `client_id`.
17261
17438
  * @param login_id - The ID of the shopper for trusted agent access.
17262
17439
  * @param idp_origin - The IDP that the shopper is associated with.
17263
- * @param redirect_uri - The redirect for Account Manager to redirect to.
17440
+ * @param redirect_uri - The redirect for Account Manager to redirect to. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
17441
+ - `http://localhost:3000/callback`
17442
+ - `https://example.com/callback`
17443
+ - `com.example.app:redirect_uri_path`
17444
+ - ` *.subdomain.topleveldomain.com`
17445
+
17264
17446
  * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
17265
17447
  * @param headers - An object literal of key value pairs of the headers to be
17266
17448
  * sent with this request.
@@ -17300,7 +17482,12 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17300
17482
  The `code_challenge` is not needed if a using SLAS private `client_id`.
17301
17483
  * @param login_id - The ID of the shopper for trusted agent access.
17302
17484
  * @param idp_origin - The IDP that the shopper is associated with.
17303
- * @param redirect_uri - The redirect for Account Manager to redirect to.
17485
+ * @param redirect_uri - The redirect for Account Manager to redirect to. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
17486
+ - `http://localhost:3000/callback`
17487
+ - `https://example.com/callback`
17488
+ - `com.example.app:redirect_uri_path`
17489
+ - ` *.subdomain.topleveldomain.com`
17490
+
17304
17491
  * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
17305
17492
  * @param headers - An object literal of key value pairs of the headers to be
17306
17493
  * sent with this request.
@@ -17655,6 +17842,9 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17655
17842
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
17656
17843
  /**
17657
17844
  * Returns a JSON listing of the OpenID/OAuth endpoints, supported scopes and claims, public keys used to sign the tokens, and other details.
17845
+
17846
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
17847
+
17658
17848
  *
17659
17849
  * If you would like to get a raw Response object use the other getWellknownOpenidConfiguration function.
17660
17850
  *
@@ -17677,6 +17867,9 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17677
17867
  }>): Promise<Object>;
17678
17868
  /**
17679
17869
  * Returns a JSON listing of the OpenID/OAuth endpoints, supported scopes and claims, public keys used to sign the tokens, and other details.
17870
+
17871
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
17872
+
17680
17873
  *
17681
17874
  * @param options - An object containing the options for this method.
17682
17875
  * @param parameters - An object containing the parameters for this method.
@@ -17697,6 +17890,9 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17697
17890
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
17698
17891
  /**
17699
17892
  * Returns a JSON Web Key Set (JWKS) containing the current, past, and future public keys. The key set enables clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
17893
+
17894
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
17895
+
17700
17896
  *
17701
17897
  * If you would like to get a raw Response object use the other getJwksUri function.
17702
17898
  *
@@ -17719,6 +17915,9 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
17719
17915
  }>): Promise<Object>;
17720
17916
  /**
17721
17917
  * Returns a JSON Web Key Set (JWKS) containing the current, past, and future public keys. The key set enables clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
17918
+
17919
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
17920
+
17722
17921
  *
17723
17922
  * @param options - An object containing the options for this method.
17724
17923
  * @param parameters - An object containing the parameters for this method.
@@ -17837,12 +18036,12 @@ declare namespace ShopperLoginTypes {
17837
18036
  scope?: string;
17838
18037
  usid?: string;
17839
18038
  channel_id: string;
17840
- code_challenge: string;
18039
+ code_challenge?: string;
17841
18040
  } & {
17842
18041
  [key: string]: any;
17843
18042
  };
17844
18043
  type TrustedAgentTokenRequest = {
17845
- agent_id: string;
18044
+ agent_id?: string;
17846
18045
  client_id: string;
17847
18046
  channel_id: string;
17848
18047
  code_verifier: string;
@@ -17873,20 +18072,6 @@ declare namespace ShopperLoginTypes {
17873
18072
  } & {
17874
18073
  [key: string]: any;
17875
18074
  };
17876
- type CredQualityUserResponse = {
17877
- tenantId: string;
17878
- username: string;
17879
- email: string;
17880
- credQualityMeasure: number;
17881
- pwdStrengthMeasure: number;
17882
- pwdQualityMeasure: number;
17883
- credChangeCount: number;
17884
- loginCount: number;
17885
- lastLoginDatetime: any;
17886
- lastCredCheckDatetime: any;
17887
- } & {
17888
- [key: string]: any;
17889
- };
17890
18075
  type PasswordLessLoginTokenRequest = {
17891
18076
  grant_type: string;
17892
18077
  hint: string;
@@ -17941,6 +18126,7 @@ declare namespace ShopperLoginTypes {
17941
18126
  id_token: string;
17942
18127
  refresh_token: string;
17943
18128
  expires_in: number;
18129
+ refresh_token_expires_in: any;
17944
18130
  token_type: string;
17945
18131
  usid: string;
17946
18132
  customer_id: string;
@@ -17975,6 +18161,7 @@ declare namespace ShopperLoginTypes {
17975
18161
  dwsid: string;
17976
18162
  grant_type: string;
17977
18163
  login_id: string;
18164
+ dwsgst?: string;
17978
18165
  usid?: string;
17979
18166
  } & {
17980
18167
  [key: string]: any;
@@ -18247,7 +18434,6 @@ declare namespace ShopperLoginTypes {
18247
18434
  * All query parameters that are used by at least one ShopperLogin method.
18248
18435
  */
18249
18436
  type ShopperLoginQueryParameters = {
18250
- username?: string;
18251
18437
  client_id?: string;
18252
18438
  refresh_token?: string;
18253
18439
  channel_id?: string;
@@ -18288,7 +18474,7 @@ declare namespace ShopperLoginTypes {
18288
18474
  * ```
18289
18475
  *
18290
18476
  * <span style="font-size:.7em; display:block; text-align: right">
18291
- * API Version: 1.39.14<br />
18477
+ * API Version: 1.39.17<br />
18292
18478
  * Last Updated: <br />
18293
18479
  * </span>
18294
18480
 
@@ -18302,52 +18488,6 @@ declare namespace ShopperLoginTypes {
18302
18488
  };
18303
18489
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
18304
18490
  constructor(config: ClientConfigInit<ConfigParameters>);
18305
- /**
18306
- * Get credential quality statistics for a user.
18307
- *
18308
- * If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
18309
- *
18310
- * @param options - An object containing the options for this method.
18311
- * @param parameters - An object containing the parameters for this method.
18312
- * @param organizationId -
18313
- * @param username - User's login ID or email address.
18314
- * @param headers - An object literal of key value pairs of the headers to be
18315
- * sent with this request.
18316
- *
18317
- * @returns A promise of type CredQualityUserResponse.
18318
- *
18319
- */
18320
- retrieveCredQualityUserInfo(options?: RequireParametersUnlessAllAreOptional<{
18321
- parameters?: CompositeParameters<{
18322
- organizationId: string;
18323
- username: string;
18324
- }, ConfigParameters>;
18325
- headers?: {
18326
- [key: string]: string;
18327
- };
18328
- }>): Promise<CredQualityUserResponse>;
18329
- /**
18330
- * Get credential quality statistics for a user.
18331
- *
18332
- * @param options - An object containing the options for this method.
18333
- * @param parameters - An object containing the parameters for this method.
18334
- * @param organizationId -
18335
- * @param username - User's login ID or email address.
18336
- * @param headers - An object literal of key value pairs of the headers to be
18337
- * sent with this request.
18338
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
18339
- * @returns A promise of type Response if rawResponse is true, a promise of type CredQualityUserResponse otherwise.
18340
- *
18341
- */
18342
- retrieveCredQualityUserInfo<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
18343
- parameters?: CompositeParameters<{
18344
- organizationId: string;
18345
- username: string;
18346
- }, ConfigParameters>;
18347
- headers?: {
18348
- [key: string]: string;
18349
- };
18350
- }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
18351
18491
  /**
18352
18492
  * 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).
18353
18493
 
@@ -18359,7 +18499,7 @@ declare namespace ShopperLoginTypes {
18359
18499
 
18360
18500
  Required parameters: `code_challenge`, `channel_id`, `client_id`, and `redirect_uri`.
18361
18501
 
18362
- Optional parameters: `usid``.
18502
+ Optional parameters: `usid`.
18363
18503
 
18364
18504
  The SLAS `/login` endpoint redirects back to the redirect URI and returns an authorization code.
18365
18505
 
@@ -18398,7 +18538,7 @@ declare namespace ShopperLoginTypes {
18398
18538
 
18399
18539
  Required parameters: `code_challenge`, `channel_id`, `client_id`, and `redirect_uri`.
18400
18540
 
18401
- Optional parameters: `usid``.
18541
+ Optional parameters: `usid`.
18402
18542
 
18403
18543
  The SLAS `/login` endpoint redirects back to the redirect URI and returns an authorization code.
18404
18544
 
@@ -18546,7 +18686,12 @@ declare namespace ShopperLoginTypes {
18546
18686
  * @param options - An object containing the options for this method.
18547
18687
  * @param parameters - An object containing the parameters for this method.
18548
18688
  * @param organizationId -
18549
- * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
18689
+ * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
18690
+ - `http://localhost:3000/callback`
18691
+ - `https://example.com/callback`
18692
+ - `com.example.app:redirect_uri_path`
18693
+ - ` *.subdomain.topleveldomain.com`
18694
+
18550
18695
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
18551
18696
  * @param client_id - The client ID obtained during application registration.
18552
18697
  * @param scope -
@@ -18594,7 +18739,12 @@ declare namespace ShopperLoginTypes {
18594
18739
  * @param options - An object containing the options for this method.
18595
18740
  * @param parameters - An object containing the parameters for this method.
18596
18741
  * @param organizationId -
18597
- * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
18742
+ * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
18743
+ - `http://localhost:3000/callback`
18744
+ - `https://example.com/callback`
18745
+ - `com.example.app:redirect_uri_path`
18746
+ - ` *.subdomain.topleveldomain.com`
18747
+
18598
18748
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
18599
18749
  * @param client_id - The client ID obtained during application registration.
18600
18750
  * @param scope -
@@ -18641,7 +18791,7 @@ declare namespace ShopperLoginTypes {
18641
18791
 
18642
18792
  For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
18643
18793
 
18644
- For a public client using PKCE, an application will pass a PKCE `code_verifier`` that matches the `code_challenge`` that was used to `authorize` the customer along with the authorization code.
18794
+ For a public client using PKCE, an application will pass a PKCE `code_verifier` that matches the `code_challenge` that was used to `authorize` the customer along with the authorization code.
18645
18795
 
18646
18796
  When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.
18647
18797
 
@@ -18677,7 +18827,7 @@ declare namespace ShopperLoginTypes {
18677
18827
 
18678
18828
  For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
18679
18829
 
18680
- For a public client using PKCE, an application will pass a PKCE `code_verifier`` that matches the `code_challenge`` that was used to `authorize` the customer along with the authorization code.
18830
+ For a public client using PKCE, an application will pass a PKCE `code_verifier` that matches the `code_challenge` that was used to `authorize` the customer along with the authorization code.
18681
18831
 
18682
18832
  When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.
18683
18833
 
@@ -18831,7 +18981,12 @@ declare namespace ShopperLoginTypes {
18831
18981
  The `code_challenge` is not needed if a using SLAS private `client_id`.
18832
18982
  * @param login_id - The ID of the shopper for trusted agent access.
18833
18983
  * @param idp_origin - The IDP that the shopper is associated with.
18834
- * @param redirect_uri - The redirect for Account Manager to redirect to.
18984
+ * @param redirect_uri - The redirect for Account Manager to redirect to. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
18985
+ - `http://localhost:3000/callback`
18986
+ - `https://example.com/callback`
18987
+ - `com.example.app:redirect_uri_path`
18988
+ - ` *.subdomain.topleveldomain.com`
18989
+
18835
18990
  * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
18836
18991
  * @param headers - An object literal of key value pairs of the headers to be
18837
18992
  * sent with this request.
@@ -18871,7 +19026,12 @@ declare namespace ShopperLoginTypes {
18871
19026
  The `code_challenge` is not needed if a using SLAS private `client_id`.
18872
19027
  * @param login_id - The ID of the shopper for trusted agent access.
18873
19028
  * @param idp_origin - The IDP that the shopper is associated with.
18874
- * @param redirect_uri - The redirect for Account Manager to redirect to.
19029
+ * @param redirect_uri - The redirect for Account Manager to redirect to. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
19030
+ - `http://localhost:3000/callback`
19031
+ - `https://example.com/callback`
19032
+ - `com.example.app:redirect_uri_path`
19033
+ - ` *.subdomain.topleveldomain.com`
19034
+
18875
19035
  * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
18876
19036
  * @param headers - An object literal of key value pairs of the headers to be
18877
19037
  * sent with this request.
@@ -19226,6 +19386,9 @@ declare namespace ShopperLoginTypes {
19226
19386
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
19227
19387
  /**
19228
19388
  * Returns a JSON listing of the OpenID/OAuth endpoints, supported scopes and claims, public keys used to sign the tokens, and other details.
19389
+
19390
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
19391
+
19229
19392
  *
19230
19393
  * If you would like to get a raw Response object use the other getWellknownOpenidConfiguration function.
19231
19394
  *
@@ -19248,6 +19411,9 @@ declare namespace ShopperLoginTypes {
19248
19411
  }>): Promise<Object>;
19249
19412
  /**
19250
19413
  * Returns a JSON listing of the OpenID/OAuth endpoints, supported scopes and claims, public keys used to sign the tokens, and other details.
19414
+
19415
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
19416
+
19251
19417
  *
19252
19418
  * @param options - An object containing the options for this method.
19253
19419
  * @param parameters - An object containing the parameters for this method.
@@ -19268,6 +19434,9 @@ declare namespace ShopperLoginTypes {
19268
19434
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
19269
19435
  /**
19270
19436
  * Returns a JSON Web Key Set (JWKS) containing the current, past, and future public keys. The key set enables clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
19437
+
19438
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
19439
+
19271
19440
  *
19272
19441
  * If you would like to get a raw Response object use the other getJwksUri function.
19273
19442
  *
@@ -19290,6 +19459,9 @@ declare namespace ShopperLoginTypes {
19290
19459
  }>): Promise<Object>;
19291
19460
  /**
19292
19461
  * Returns a JSON Web Key Set (JWKS) containing the current, past, and future public keys. The key set enables clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
19462
+
19463
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
19464
+
19293
19465
  *
19294
19466
  * @param options - An object containing the options for this method.
19295
19467
  * @param parameters - An object containing the parameters for this method.
@@ -22036,10 +22208,11 @@ type ShopperProductsPathParameters = {
22036
22208
  * All query parameters that are used by at least one ShopperProducts method.
22037
22209
  */
22038
22210
  type ShopperProductsQueryParameters = {
22211
+ select?: string;
22039
22212
  ids?: string;
22040
22213
  inventoryIds?: string;
22041
22214
  currency?: string;
22042
- expand?: string;
22215
+ expand?: Array<string>;
22043
22216
  locale?: string;
22044
22217
  allImages?: boolean;
22045
22218
  perPricebook?: boolean;
@@ -22051,10 +22224,10 @@ type ShopperProductsQueryParameters = {
22051
22224
  */
22052
22225
  type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
22053
22226
  /**
22054
- * [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
22227
+ * [](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=:Summary)
22055
22228
  * ==================================
22056
22229
  *
22057
- * *Display product details across your storefront.*<br />
22230
+ * **<br />
22058
22231
  *
22059
22232
  * Simple example:
22060
22233
  *
@@ -22073,7 +22246,7 @@ type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParamete
22073
22246
  * ```
22074
22247
  *
22075
22248
  * <span style="font-size:.7em; display:block; text-align: right">
22076
- * API Version: 0.0.24<br />
22249
+ * API Version: <br />
22077
22250
  * Last Updated: <br />
22078
22251
  * </span>
22079
22252
 
@@ -22095,6 +22268,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
22095
22268
  * @param options - An object containing the options for this method.
22096
22269
  * @param parameters - An object containing the parameters for this method.
22097
22270
  * @param organizationId -
22271
+ * @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.
22098
22272
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
22099
22273
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
22100
22274
  * @param currency - The currency mnemonic specified for price.
@@ -22112,10 +22286,11 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
22112
22286
  getProducts(options?: RequireParametersUnlessAllAreOptional<{
22113
22287
  parameters?: CompositeParameters<{
22114
22288
  organizationId: string;
22289
+ select?: string;
22115
22290
  ids: string;
22116
22291
  inventoryIds?: string;
22117
22292
  currency?: string;
22118
- expand?: string;
22293
+ expand?: Array<string>;
22119
22294
  locale?: string;
22120
22295
  allImages?: boolean;
22121
22296
  perPricebook?: boolean;
@@ -22131,6 +22306,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
22131
22306
  * @param options - An object containing the options for this method.
22132
22307
  * @param parameters - An object containing the parameters for this method.
22133
22308
  * @param organizationId -
22309
+ * @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.
22134
22310
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
22135
22311
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
22136
22312
  * @param currency - The currency mnemonic specified for price.
@@ -22148,10 +22324,11 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
22148
22324
  getProducts<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
22149
22325
  parameters?: CompositeParameters<{
22150
22326
  organizationId: string;
22327
+ select?: string;
22151
22328
  ids: string;
22152
22329
  inventoryIds?: string;
22153
22330
  currency?: string;
22154
- expand?: string;
22331
+ expand?: Array<string>;
22155
22332
  locale?: string;
22156
22333
  allImages?: boolean;
22157
22334
  perPricebook?: boolean;
@@ -22170,6 +22347,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
22170
22347
  * @param parameters - An object containing the parameters for this method.
22171
22348
  * @param organizationId -
22172
22349
  * @param id - The ID of the requested product.
22350
+ * @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.
22173
22351
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
22174
22352
  * @param currency - The currency mnemonic specified for price.
22175
22353
  * @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.
@@ -22187,9 +22365,10 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
22187
22365
  parameters?: CompositeParameters<{
22188
22366
  organizationId: string;
22189
22367
  id: string;
22368
+ select?: string;
22190
22369
  inventoryIds?: string;
22191
22370
  currency?: string;
22192
- expand?: string;
22371
+ expand: Array<string>;
22193
22372
  locale?: string;
22194
22373
  allImages?: boolean;
22195
22374
  perPricebook?: boolean;
@@ -22206,6 +22385,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
22206
22385
  * @param parameters - An object containing the parameters for this method.
22207
22386
  * @param organizationId -
22208
22387
  * @param id - The ID of the requested product.
22388
+ * @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.
22209
22389
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
22210
22390
  * @param currency - The currency mnemonic specified for price.
22211
22391
  * @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.
@@ -22223,9 +22403,10 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
22223
22403
  parameters?: CompositeParameters<{
22224
22404
  organizationId: string;
22225
22405
  id: string;
22406
+ select?: string;
22226
22407
  inventoryIds?: string;
22227
22408
  currency?: string;
22228
- expand?: string;
22409
+ expand: Array<string>;
22229
22410
  locale?: string;
22230
22411
  allImages?: boolean;
22231
22412
  perPricebook?: boolean;
@@ -22959,10 +23140,11 @@ declare namespace ShopperProductsTypes {
22959
23140
  * All query parameters that are used by at least one ShopperProducts method.
22960
23141
  */
22961
23142
  type ShopperProductsQueryParameters = {
23143
+ select?: string;
22962
23144
  ids?: string;
22963
23145
  inventoryIds?: string;
22964
23146
  currency?: string;
22965
- expand?: string;
23147
+ expand?: Array<string>;
22966
23148
  locale?: string;
22967
23149
  allImages?: boolean;
22968
23150
  perPricebook?: boolean;
@@ -22974,10 +23156,10 @@ declare namespace ShopperProductsTypes {
22974
23156
  */
22975
23157
  type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParameters & ShopperProductsQueryParameters;
22976
23158
  /**
22977
- * [Shopper Products](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=shopper-products:Summary)
23159
+ * [](https://developer.salesforce.com/docs/commerce/commerce-api/references?meta=:Summary)
22978
23160
  * ==================================
22979
23161
  *
22980
- * *Display product details across your storefront.*<br />
23162
+ * **<br />
22981
23163
  *
22982
23164
  * Simple example:
22983
23165
  *
@@ -22996,7 +23178,7 @@ declare namespace ShopperProductsTypes {
22996
23178
  * ```
22997
23179
  *
22998
23180
  * <span style="font-size:.7em; display:block; text-align: right">
22999
- * API Version: 0.0.24<br />
23181
+ * API Version: <br />
23000
23182
  * Last Updated: <br />
23001
23183
  * </span>
23002
23184
 
@@ -23018,6 +23200,7 @@ declare namespace ShopperProductsTypes {
23018
23200
  * @param options - An object containing the options for this method.
23019
23201
  * @param parameters - An object containing the parameters for this method.
23020
23202
  * @param organizationId -
23203
+ * @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.
23021
23204
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
23022
23205
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
23023
23206
  * @param currency - The currency mnemonic specified for price.
@@ -23035,10 +23218,11 @@ declare namespace ShopperProductsTypes {
23035
23218
  getProducts(options?: RequireParametersUnlessAllAreOptional<{
23036
23219
  parameters?: CompositeParameters<{
23037
23220
  organizationId: string;
23221
+ select?: string;
23038
23222
  ids: string;
23039
23223
  inventoryIds?: string;
23040
23224
  currency?: string;
23041
- expand?: string;
23225
+ expand?: Array<string>;
23042
23226
  locale?: string;
23043
23227
  allImages?: boolean;
23044
23228
  perPricebook?: boolean;
@@ -23054,6 +23238,7 @@ declare namespace ShopperProductsTypes {
23054
23238
  * @param options - An object containing the options for this method.
23055
23239
  * @param parameters - An object containing the parameters for this method.
23056
23240
  * @param organizationId -
23241
+ * @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.
23057
23242
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
23058
23243
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
23059
23244
  * @param currency - The currency mnemonic specified for price.
@@ -23071,10 +23256,11 @@ declare namespace ShopperProductsTypes {
23071
23256
  getProducts<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
23072
23257
  parameters?: CompositeParameters<{
23073
23258
  organizationId: string;
23259
+ select?: string;
23074
23260
  ids: string;
23075
23261
  inventoryIds?: string;
23076
23262
  currency?: string;
23077
- expand?: string;
23263
+ expand?: Array<string>;
23078
23264
  locale?: string;
23079
23265
  allImages?: boolean;
23080
23266
  perPricebook?: boolean;
@@ -23093,6 +23279,7 @@ declare namespace ShopperProductsTypes {
23093
23279
  * @param parameters - An object containing the parameters for this method.
23094
23280
  * @param organizationId -
23095
23281
  * @param id - The ID of the requested product.
23282
+ * @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.
23096
23283
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
23097
23284
  * @param currency - The currency mnemonic specified for price.
23098
23285
  * @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.
@@ -23110,9 +23297,10 @@ declare namespace ShopperProductsTypes {
23110
23297
  parameters?: CompositeParameters<{
23111
23298
  organizationId: string;
23112
23299
  id: string;
23300
+ select?: string;
23113
23301
  inventoryIds?: string;
23114
23302
  currency?: string;
23115
- expand?: string;
23303
+ expand: Array<string>;
23116
23304
  locale?: string;
23117
23305
  allImages?: boolean;
23118
23306
  perPricebook?: boolean;
@@ -23129,6 +23317,7 @@ declare namespace ShopperProductsTypes {
23129
23317
  * @param parameters - An object containing the parameters for this method.
23130
23318
  * @param organizationId -
23131
23319
  * @param id - The ID of the requested product.
23320
+ * @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.
23132
23321
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
23133
23322
  * @param currency - The currency mnemonic specified for price.
23134
23323
  * @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.
@@ -23146,9 +23335,10 @@ declare namespace ShopperProductsTypes {
23146
23335
  parameters?: CompositeParameters<{
23147
23336
  organizationId: string;
23148
23337
  id: string;
23338
+ select?: string;
23149
23339
  inventoryIds?: string;
23150
23340
  currency?: string;
23151
- expand?: string;
23341
+ expand: Array<string>;
23152
23342
  locale?: string;
23153
23343
  allImages?: boolean;
23154
23344
  perPricebook?: boolean;
@@ -25300,9 +25490,10 @@ declare class TemplateURL extends URL {
25300
25490
  */
25301
25491
  replaceOrigin(newOriginString: string): void;
25302
25492
  /**
25303
- * Add append an object literal of query parameters to the URL object. Arrays
25304
- * are allowed and are appended using the "repeat" convention where the \{ a:
25305
- * ["1", "2"] \} becomes "?a=1&a=2"
25493
+ * Add append an object literal of query parameters to the URL object. SCAPI expects
25494
+ * Arrays to be comma separated where \{ a: ["1", "2"] \} becomes ?a=1,2.
25495
+ * The 'refine' query parameter is an exception, where SCAPI expects the the "repeat"
25496
+ * convention where \{ refine: ["1", "2"] \} becomes "?refine=1&refine=2"
25306
25497
  */
25307
25498
  addQueryParams(queryParams?: QueryParameters): void;
25308
25499
  /**
@@ -25426,12 +25617,12 @@ declare namespace helpers {
25426
25617
  scope?: string;
25427
25618
  usid?: string;
25428
25619
  channel_id: string;
25429
- code_challenge: string;
25620
+ code_challenge?: string;
25430
25621
  } & {
25431
25622
  [key: string]: any;
25432
25623
  };
25433
25624
  type TrustedAgentTokenRequest = {
25434
- agent_id: string;
25625
+ agent_id?: string;
25435
25626
  client_id: string;
25436
25627
  channel_id: string;
25437
25628
  code_verifier: string;
@@ -25462,20 +25653,6 @@ declare namespace helpers {
25462
25653
  } & {
25463
25654
  [key: string]: any;
25464
25655
  };
25465
- type CredQualityUserResponse = {
25466
- tenantId: string;
25467
- username: string;
25468
- email: string;
25469
- credQualityMeasure: number;
25470
- pwdStrengthMeasure: number;
25471
- pwdQualityMeasure: number;
25472
- credChangeCount: number;
25473
- loginCount: number;
25474
- lastLoginDatetime: any;
25475
- lastCredCheckDatetime: any;
25476
- } & {
25477
- [key: string]: any;
25478
- };
25479
25656
  type PasswordLessLoginTokenRequest = {
25480
25657
  grant_type: string;
25481
25658
  hint: string;
@@ -25530,6 +25707,7 @@ declare namespace helpers {
25530
25707
  id_token: string;
25531
25708
  refresh_token: string;
25532
25709
  expires_in: number;
25710
+ refresh_token_expires_in: any;
25533
25711
  token_type: string;
25534
25712
  usid: string;
25535
25713
  customer_id: string;
@@ -25564,6 +25742,7 @@ declare namespace helpers {
25564
25742
  dwsid: string;
25565
25743
  grant_type: string;
25566
25744
  login_id: string;
25745
+ dwsgst?: string;
25567
25746
  usid?: string;
25568
25747
  } & {
25569
25748
  [key: string]: any;
@@ -25836,7 +26015,6 @@ declare namespace helpers {
25836
26015
  * All query parameters that are used by at least one ShopperLogin method.
25837
26016
  */
25838
26017
  type ShopperLoginQueryParameters = {
25839
- username?: string;
25840
26018
  client_id?: string;
25841
26019
  refresh_token?: string;
25842
26020
  channel_id?: string;
@@ -25877,7 +26055,7 @@ declare namespace helpers {
25877
26055
  * ```
25878
26056
  *
25879
26057
  * <span style="font-size:.7em; display:block; text-align: right">
25880
- * API Version: 1.39.14<br />
26058
+ * API Version: 1.39.17<br />
25881
26059
  * Last Updated: <br />
25882
26060
  * </span>
25883
26061
 
@@ -25891,52 +26069,6 @@ declare namespace helpers {
25891
26069
  };
25892
26070
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/shopper/auth/{version}";
25893
26071
  constructor(config: ClientConfigInit<ConfigParameters>);
25894
- /**
25895
- * Get credential quality statistics for a user.
25896
- *
25897
- * If you would like to get a raw Response object use the other retrieveCredQualityUserInfo function.
25898
- *
25899
- * @param options - An object containing the options for this method.
25900
- * @param parameters - An object containing the parameters for this method.
25901
- * @param organizationId -
25902
- * @param username - User's login ID or email address.
25903
- * @param headers - An object literal of key value pairs of the headers to be
25904
- * sent with this request.
25905
- *
25906
- * @returns A promise of type CredQualityUserResponse.
25907
- *
25908
- */
25909
- retrieveCredQualityUserInfo(options?: RequireParametersUnlessAllAreOptional<{
25910
- parameters?: CompositeParameters<{
25911
- organizationId: string;
25912
- username: string;
25913
- }, ConfigParameters>;
25914
- headers?: {
25915
- [key: string]: string;
25916
- };
25917
- }>): Promise<CredQualityUserResponse>;
25918
- /**
25919
- * Get credential quality statistics for a user.
25920
- *
25921
- * @param options - An object containing the options for this method.
25922
- * @param parameters - An object containing the parameters for this method.
25923
- * @param organizationId -
25924
- * @param username - User's login ID or email address.
25925
- * @param headers - An object literal of key value pairs of the headers to be
25926
- * sent with this request.
25927
- * @param rawResponse - Set to true to return entire Response object instead of DTO.
25928
- * @returns A promise of type Response if rawResponse is true, a promise of type CredQualityUserResponse otherwise.
25929
- *
25930
- */
25931
- retrieveCredQualityUserInfo<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
25932
- parameters?: CompositeParameters<{
25933
- organizationId: string;
25934
- username: string;
25935
- }, ConfigParameters>;
25936
- headers?: {
25937
- [key: string]: string;
25938
- };
25939
- }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
25940
26072
  /**
25941
26073
  * 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).
25942
26074
 
@@ -25948,7 +26080,7 @@ declare namespace helpers {
25948
26080
 
25949
26081
  Required parameters: `code_challenge`, `channel_id`, `client_id`, and `redirect_uri`.
25950
26082
 
25951
- Optional parameters: `usid``.
26083
+ Optional parameters: `usid`.
25952
26084
 
25953
26085
  The SLAS `/login` endpoint redirects back to the redirect URI and returns an authorization code.
25954
26086
 
@@ -25987,7 +26119,7 @@ declare namespace helpers {
25987
26119
 
25988
26120
  Required parameters: `code_challenge`, `channel_id`, `client_id`, and `redirect_uri`.
25989
26121
 
25990
- Optional parameters: `usid``.
26122
+ Optional parameters: `usid`.
25991
26123
 
25992
26124
  The SLAS `/login` endpoint redirects back to the redirect URI and returns an authorization code.
25993
26125
 
@@ -26135,7 +26267,12 @@ declare namespace helpers {
26135
26267
  * @param options - An object containing the options for this method.
26136
26268
  * @param parameters - An object containing the parameters for this method.
26137
26269
  * @param organizationId -
26138
- * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
26270
+ * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
26271
+ - `http://localhost:3000/callback`
26272
+ - `https://example.com/callback`
26273
+ - `com.example.app:redirect_uri_path`
26274
+ - ` *.subdomain.topleveldomain.com`
26275
+
26139
26276
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
26140
26277
  * @param client_id - The client ID obtained during application registration.
26141
26278
  * @param scope -
@@ -26183,7 +26320,12 @@ declare namespace helpers {
26183
26320
  * @param options - An object containing the options for this method.
26184
26321
  * @param parameters - An object containing the parameters for this method.
26185
26322
  * @param organizationId -
26186
- * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
26323
+ * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
26324
+ - `http://localhost:3000/callback`
26325
+ - `https://example.com/callback`
26326
+ - `com.example.app:redirect_uri_path`
26327
+ - ` *.subdomain.topleveldomain.com`
26328
+
26187
26329
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
26188
26330
  * @param client_id - The client ID obtained during application registration.
26189
26331
  * @param scope -
@@ -26230,7 +26372,7 @@ declare namespace helpers {
26230
26372
 
26231
26373
  For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
26232
26374
 
26233
- For a public client using PKCE, an application will pass a PKCE `code_verifier`` that matches the `code_challenge`` that was used to `authorize` the customer along with the authorization code.
26375
+ For a public client using PKCE, an application will pass a PKCE `code_verifier` that matches the `code_challenge` that was used to `authorize` the customer along with the authorization code.
26234
26376
 
26235
26377
  When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.
26236
26378
 
@@ -26266,7 +26408,7 @@ declare namespace helpers {
26266
26408
 
26267
26409
  For a guest user, get the shopper JWT access token and a refresh token. This is where a client appplication is able to get an access token for the guest user through the back channel (a trusted server) by passing in the client credentials.
26268
26410
 
26269
- For a public client using PKCE, an application will pass a PKCE `code_verifier`` that matches the `code_challenge`` that was used to `authorize` the customer along with the authorization code.
26411
+ For a public client using PKCE, an application will pass a PKCE `code_verifier` that matches the `code_challenge` that was used to `authorize` the customer along with the authorization code.
26270
26412
 
26271
26413
  When refreshing the access token with a private client ID and client secret, the refresh token is _not_ regenerated. However, when refreshing the access token with a public client ID, the refresh token is _always_ regenerated. The old refresh token is voided with every refresh call, so the refresh token on the client needs to be replaced to always store the new refresh token.
26272
26414
 
@@ -26420,7 +26562,12 @@ declare namespace helpers {
26420
26562
  The `code_challenge` is not needed if a using SLAS private `client_id`.
26421
26563
  * @param login_id - The ID of the shopper for trusted agent access.
26422
26564
  * @param idp_origin - The IDP that the shopper is associated with.
26423
- * @param redirect_uri - The redirect for Account Manager to redirect to.
26565
+ * @param redirect_uri - The redirect for Account Manager to redirect to. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
26566
+ - `http://localhost:3000/callback`
26567
+ - `https://example.com/callback`
26568
+ - `com.example.app:redirect_uri_path`
26569
+ - ` *.subdomain.topleveldomain.com`
26570
+
26424
26571
  * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
26425
26572
  * @param headers - An object literal of key value pairs of the headers to be
26426
26573
  * sent with this request.
@@ -26460,7 +26607,12 @@ declare namespace helpers {
26460
26607
  The `code_challenge` is not needed if a using SLAS private `client_id`.
26461
26608
  * @param login_id - The ID of the shopper for trusted agent access.
26462
26609
  * @param idp_origin - The IDP that the shopper is associated with.
26463
- * @param redirect_uri - The redirect for Account Manager to redirect to.
26610
+ * @param redirect_uri - The redirect for Account Manager to redirect to. A variety of URI formats and wildcard for host are supported, but app links like `airbnb://` or `fb://` are not. Examples of supported URIs:
26611
+ - `http://localhost:3000/callback`
26612
+ - `https://example.com/callback`
26613
+ - `com.example.app:redirect_uri_path`
26614
+ - ` *.subdomain.topleveldomain.com`
26615
+
26464
26616
  * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
26465
26617
  * @param headers - An object literal of key value pairs of the headers to be
26466
26618
  * sent with this request.
@@ -26815,6 +26967,9 @@ declare namespace helpers {
26815
26967
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
26816
26968
  /**
26817
26969
  * Returns a JSON listing of the OpenID/OAuth endpoints, supported scopes and claims, public keys used to sign the tokens, and other details.
26970
+
26971
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
26972
+
26818
26973
  *
26819
26974
  * If you would like to get a raw Response object use the other getWellknownOpenidConfiguration function.
26820
26975
  *
@@ -26837,6 +26992,9 @@ declare namespace helpers {
26837
26992
  }>): Promise<Object>;
26838
26993
  /**
26839
26994
  * Returns a JSON listing of the OpenID/OAuth endpoints, supported scopes and claims, public keys used to sign the tokens, and other details.
26995
+
26996
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
26997
+
26840
26998
  *
26841
26999
  * @param options - An object containing the options for this method.
26842
27000
  * @param parameters - An object containing the parameters for this method.
@@ -26857,6 +27015,9 @@ declare namespace helpers {
26857
27015
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
26858
27016
  /**
26859
27017
  * Returns a JSON Web Key Set (JWKS) containing the current, past, and future public keys. The key set enables clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
27018
+
27019
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
27020
+
26860
27021
  *
26861
27022
  * If you would like to get a raw Response object use the other getJwksUri function.
26862
27023
  *
@@ -26879,6 +27040,9 @@ declare namespace helpers {
26879
27040
  }>): Promise<Object>;
26880
27041
  /**
26881
27042
  * Returns a JSON Web Key Set (JWKS) containing the current, past, and future public keys. The key set enables clients to validate the Shopper JSON Web Token (JWT) issued by SLAS.
27043
+
27044
+ For performance purposes, the `/jwks` endpoint is rate limited to 25 call per minute.
27045
+
26882
27046
  *
26883
27047
  * @param options - An object containing the options for this method.
26884
27048
  * @param parameters - An object containing the parameters for this method.