commerce-sdk-isomorphic 1.7.1 → 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -78,7 +78,7 @@ declare class ClientConfig<Params extends BaseUriParameters> implements ClientCo
78
78
  static readonly defaults: Pick<Required<ClientConfigInit<never>>, "transformRequest">;
79
79
  }
80
80
  type BoolFilter = {
81
- filters?: Array<any>;
81
+ filters?: Array<Filter>;
82
82
  operator: string;
83
83
  } & {
84
84
  [key: string]: any;
@@ -87,13 +87,13 @@ type MatchAllQuery = {} & {
87
87
  [key: string]: any;
88
88
  };
89
89
  type FilteredQuery = {
90
- filter: any;
91
- query: any;
90
+ filter: Filter;
91
+ query: Query;
92
92
  } & {
93
93
  [key: string]: any;
94
94
  };
95
95
  type QueryFilter = {
96
- query: any;
96
+ query: Query;
97
97
  } & {
98
98
  [key: string]: any;
99
99
  };
@@ -139,15 +139,15 @@ type Range2Filter = {
139
139
  [key: string]: any;
140
140
  };
141
141
  type BoolQuery = {
142
- must?: Array<any>;
143
- mustNot?: Array<any>;
144
- should?: Array<any>;
142
+ must?: Array<Query>;
143
+ mustNot?: Array<Query>;
144
+ should?: Array<Query>;
145
145
  } & {
146
146
  [key: string]: any;
147
147
  };
148
148
  type NestedQuery = {
149
149
  path: string;
150
- query: any;
150
+ query: Query;
151
151
  scoreMode?: string;
152
152
  } & {
153
153
  [key: string]: any;
@@ -176,6 +176,16 @@ type RangeFilter = {
176
176
  } & {
177
177
  [key: string]: any;
178
178
  };
179
+ type L10nString = {} & {
180
+ [key: string]: any;
181
+ };
182
+ type PropertyValueDefinition = {
183
+ description: L10nString;
184
+ displayValue: L10nString;
185
+ id: string;
186
+ position?: number;
187
+ value: string;
188
+ };
179
189
  type TaxItems = {
180
190
  taxItems?: Array<TaxItem>;
181
191
  } & {
@@ -647,7 +657,7 @@ type ShopperBasketsParameters = ShopperBasketsPathParameters & BaseUriParameters
647
657
  * ```
648
658
  *
649
659
  * <span style="font-size:.7em; display:block; text-align: right">
650
- * API Version: 0.6.3<br />
660
+ * API Version: 0.7.2<br />
651
661
  * Last Updated: <br />
652
662
  * </span>
653
663
 
@@ -816,14 +826,14 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
816
826
  body: Basket;
817
827
  }>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
818
828
  /**
819
- * Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs.
829
+ * Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token.
820
830
 
821
831
  A success response contains the transferred basket.
822
832
 
823
- If the current shopper has an active basket, and the `overwriteExisting` request parameter is `false`, then the transfer request returns a BasketTransferException (HTTP status 409). You can proceed with one of these options:
833
+ If the current shopper has an active basket, and the `overrideExisting` request parameter is `false`, then the transfer request returns a BasketTransferException (HTTP status 409). You can proceed with one of these options:
824
834
  - Keep the current shopper's active basket.
825
835
  - Merge the previous and current shoppers' baskets by calling the `baskets/merge` endpoint.
826
- - Force the transfer by calling the `baskets/transfer` endpoint again, with the parameter `overwriteExisting=true`. Forcing the transfer deletes the current shopper's active basket.
836
+ - Force the transfer by calling the `baskets/transfer` endpoint again, with the parameter `overrideExisting=true`. Forcing the transfer deletes the current shopper's active basket.
827
837
  *
828
838
  * If you would like to get a raw Response object use the other transferBasket function.
829
839
  *
@@ -851,14 +861,14 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
851
861
  };
852
862
  }>): Promise<Basket>;
853
863
  /**
854
- * Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs.
864
+ * Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token.
855
865
 
856
866
  A success response contains the transferred basket.
857
867
 
858
- If the current shopper has an active basket, and the `overwriteExisting` request parameter is `false`, then the transfer request returns a BasketTransferException (HTTP status 409). You can proceed with one of these options:
868
+ If the current shopper has an active basket, and the `overrideExisting` request parameter is `false`, then the transfer request returns a BasketTransferException (HTTP status 409). You can proceed with one of these options:
859
869
  - Keep the current shopper's active basket.
860
870
  - Merge the previous and current shoppers' baskets by calling the `baskets/merge` endpoint.
861
- - Force the transfer by calling the `baskets/transfer` endpoint again, with the parameter `overwriteExisting=true`. Forcing the transfer deletes the current shopper's active basket.
871
+ - Force the transfer by calling the `baskets/transfer` endpoint again, with the parameter `overrideExisting=true`. Forcing the transfer deletes the current shopper's active basket.
862
872
  *
863
873
  * @param options - An object containing the options for this method.
864
874
  * @param parameters - An object containing the parameters for this method.
@@ -884,7 +894,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
884
894
  };
885
895
  }>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
886
896
  /**
887
- * Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
897
+ * Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
888
898
 
889
899
  The following information is merged:
890
900
  - custom attributes on the basket and on all copied records
@@ -956,7 +966,7 @@ declare class ShopperBaskets<ConfigParameters extends ShopperBasketsParameters &
956
966
  };
957
967
  }>): Promise<Basket>;
958
968
  /**
959
- * Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
969
+ * Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
960
970
 
961
971
  The following information is merged:
962
972
  - custom attributes on the basket and on all copied records
@@ -3066,26 +3076,53 @@ declare namespace ShopperBasketsTypes {
3066
3076
  type SimpleSearchResult = {
3067
3077
  limit: number;
3068
3078
  hits?: Array<object>;
3069
- offset: number;
3070
- total: number;
3079
+ offset: any;
3080
+ total: any;
3071
3081
  } & {
3072
3082
  [key: string]: any;
3073
3083
  };
3074
3084
  type SearchRequest = {
3075
3085
  limit?: number;
3076
- query: any;
3086
+ query: Query;
3077
3087
  sorts?: Array<Sort>;
3078
- offset?: number;
3088
+ offset?: any;
3089
+ } & {
3090
+ [key: string]: any;
3091
+ };
3092
+ type PropertyDefinition = {
3093
+ defaultValue?: PropertyValueDefinition;
3094
+ id?: string;
3095
+ name: L10nString;
3096
+ description: L10nString;
3097
+ key?: boolean;
3098
+ localizable?: boolean;
3099
+ mandatory?: boolean;
3100
+ max?: number;
3101
+ minLength?: number;
3102
+ min?: number;
3103
+ multiValueType?: boolean;
3104
+ regularExpression?: string;
3105
+ scale?: number;
3106
+ searchable?: boolean;
3107
+ siteSpecific?: boolean;
3108
+ system?: boolean;
3109
+ unit?: L10nString;
3110
+ possibleValues?: Array<PropertyValueDefinition>;
3111
+ type: string;
3112
+ visible?: boolean;
3079
3113
  } & {
3080
3114
  [key: string]: any;
3081
3115
  };
3116
+ type LocalizedString = {} & {
3117
+ [key: string]: any;
3118
+ };
3082
3119
  type PaginatedSearchResult = {
3083
- query: any;
3120
+ query: Query;
3084
3121
  sorts?: Array<Sort>;
3085
3122
  limit: number;
3086
3123
  hits?: Array<object>;
3087
- offset: number;
3088
- total: number;
3124
+ offset: any;
3125
+ total: any;
3089
3126
  } & {
3090
3127
  [key: string]: any;
3091
3128
  };
@@ -3100,18 +3137,18 @@ declare namespace ShopperBasketsTypes {
3100
3137
  [key: string]: any;
3101
3138
  };
3102
3139
  type BoolFilter = {
3103
- filters?: Array<any>;
3140
+ filters?: Array<Filter>;
3104
3141
  operator: string;
3105
3142
  } & {
3106
3143
  [key: string]: any;
3107
3144
  };
3108
3145
  type PaginatedSearchResultBase = {
3109
- query: any;
3146
+ query: Query;
3110
3147
  sorts?: Array<Sort>;
3111
3148
  limit: number;
3112
3149
  hits?: Array<object>;
3113
- offset: number;
3114
- total: number;
3150
+ offset: any;
3151
+ total: any;
3115
3152
  } & {
3116
3153
  [key: string]: any;
3117
3154
  };
@@ -3119,13 +3156,13 @@ declare namespace ShopperBasketsTypes {
3119
3156
  [key: string]: any;
3120
3157
  };
3121
3158
  type FilteredQuery = {
3122
- filter: any;
3123
- query: any;
3159
+ filter: Filter;
3160
+ query: Query;
3124
3161
  } & {
3125
3162
  [key: string]: any;
3126
3163
  };
3127
3164
  type QueryFilter = {
3128
- query: any;
3165
+ query: Query;
3129
3166
  } & {
3130
3167
  [key: string]: any;
3131
3168
  };
@@ -3171,23 +3208,23 @@ declare namespace ShopperBasketsTypes {
3171
3208
  [key: string]: any;
3172
3209
  };
3173
3210
  type BoolQuery = {
3174
- must?: Array<any>;
3175
- mustNot?: Array<any>;
3176
- should?: Array<any>;
3211
+ must?: Array<Query>;
3212
+ mustNot?: Array<Query>;
3213
+ should?: Array<Query>;
3177
3214
  } & {
3178
3215
  [key: string]: any;
3179
3216
  };
3180
3217
  type SimpleSearchResultBase = {
3181
3218
  limit: number;
3182
3219
  hits?: Array<object>;
3183
- offset: number;
3184
- total: number;
3220
+ offset: any;
3221
+ total: any;
3185
3222
  } & {
3186
3223
  [key: string]: any;
3187
3224
  };
3188
3225
  type NestedQuery = {
3189
3226
  path: string;
3190
- query: any;
3227
+ query: Query;
3191
3228
  scoreMode?: string;
3192
3229
  } & {
3193
3230
  [key: string]: any;
@@ -3218,9 +3255,9 @@ declare namespace ShopperBasketsTypes {
3218
3255
  };
3219
3256
  type SearchRequestBase = {
3220
3257
  limit?: number;
3221
- query: any;
3258
+ query: Query;
3222
3259
  sorts?: Array<Sort>;
3223
- offset?: number;
3260
+ offset?: any;
3224
3261
  } & {
3225
3262
  [key: string]: any;
3226
3263
  };
@@ -3230,6 +3267,38 @@ declare namespace ShopperBasketsTypes {
3230
3267
  } & {
3231
3268
  [key: string]: any;
3232
3269
  };
3270
+ type L10nString = {} & {
3271
+ [key: string]: any;
3272
+ };
3273
+ type AttributeDefinition = {
3274
+ defaultValue?: PropertyValueDefinition;
3275
+ id?: string;
3276
+ name: L10nString;
3277
+ description: L10nString;
3278
+ key?: boolean;
3279
+ localizable?: boolean;
3280
+ mandatory?: boolean;
3281
+ max?: number;
3282
+ minLength?: number;
3283
+ min?: number;
3284
+ multiValueType?: boolean;
3285
+ regularExpression?: string;
3286
+ scale?: number;
3287
+ searchable?: boolean;
3288
+ siteSpecific?: boolean;
3289
+ system?: boolean;
3290
+ unit?: L10nString;
3291
+ possibleValues?: Array<PropertyValueDefinition>;
3292
+ type: string;
3293
+ visible?: boolean;
3294
+ };
3295
+ type PropertyValueDefinition = {
3296
+ description: L10nString;
3297
+ displayValue: L10nString;
3298
+ id: string;
3299
+ position?: number;
3300
+ value: string;
3301
+ };
3233
3302
  type TaxItems = {
3234
3303
  taxItems?: Array<TaxItem>;
3235
3304
  } & {
@@ -3736,7 +3805,7 @@ declare namespace ShopperBasketsTypes {
3736
3805
  * ```
3737
3806
  *
3738
3807
  * <span style="font-size:.7em; display:block; text-align: right">
3739
- * API Version: 0.6.3<br />
3808
+ * API Version: 0.7.2<br />
3740
3809
  * Last Updated: <br />
3741
3810
  * </span>
3742
3811
 
@@ -3905,14 +3974,14 @@ declare namespace ShopperBasketsTypes {
3905
3974
  body: Basket;
3906
3975
  }>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
3907
3976
  /**
3908
- * Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs.
3977
+ * Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token.
3909
3978
 
3910
3979
  A success response contains the transferred basket.
3911
3980
 
3912
- If the current shopper has an active basket, and the `overwriteExisting` request parameter is `false`, then the transfer request returns a BasketTransferException (HTTP status 409). You can proceed with one of these options:
3981
+ If the current shopper has an active basket, and the `overrideExisting` request parameter is `false`, then the transfer request returns a BasketTransferException (HTTP status 409). You can proceed with one of these options:
3913
3982
  - Keep the current shopper's active basket.
3914
3983
  - Merge the previous and current shoppers' baskets by calling the `baskets/merge` endpoint.
3915
- - Force the transfer by calling the `baskets/transfer` endpoint again, with the parameter `overwriteExisting=true`. Forcing the transfer deletes the current shopper's active basket.
3984
+ - Force the transfer by calling the `baskets/transfer` endpoint again, with the parameter `overrideExisting=true`. Forcing the transfer deletes the current shopper's active basket.
3916
3985
  *
3917
3986
  * If you would like to get a raw Response object use the other transferBasket function.
3918
3987
  *
@@ -3940,14 +4009,14 @@ declare namespace ShopperBasketsTypes {
3940
4009
  };
3941
4010
  }>): Promise<Basket>;
3942
4011
  /**
3943
- * Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs.
4012
+ * Transfer the previous shopper's basket to the current shopper by updating the basket's owner. No other values change. You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token.
3944
4013
 
3945
4014
  A success response contains the transferred basket.
3946
4015
 
3947
- If the current shopper has an active basket, and the `overwriteExisting` request parameter is `false`, then the transfer request returns a BasketTransferException (HTTP status 409). You can proceed with one of these options:
4016
+ If the current shopper has an active basket, and the `overrideExisting` request parameter is `false`, then the transfer request returns a BasketTransferException (HTTP status 409). You can proceed with one of these options:
3948
4017
  - Keep the current shopper's active basket.
3949
4018
  - Merge the previous and current shoppers' baskets by calling the `baskets/merge` endpoint.
3950
- - Force the transfer by calling the `baskets/transfer` endpoint again, with the parameter `overwriteExisting=true`. Forcing the transfer deletes the current shopper's active basket.
4019
+ - Force the transfer by calling the `baskets/transfer` endpoint again, with the parameter `overrideExisting=true`. Forcing the transfer deletes the current shopper's active basket.
3951
4020
  *
3952
4021
  * @param options - An object containing the options for this method.
3953
4022
  * @param parameters - An object containing the parameters for this method.
@@ -3973,7 +4042,7 @@ declare namespace ShopperBasketsTypes {
3973
4042
  };
3974
4043
  }>, rawResponse?: T): Promise<T extends true ? Response : Basket>;
3975
4044
  /**
3976
- * Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
4045
+ * Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
3977
4046
 
3978
4047
  The following information is merged:
3979
4048
  - custom attributes on the basket and on all copied records
@@ -4045,7 +4114,7 @@ declare namespace ShopperBasketsTypes {
4045
4114
  };
4046
4115
  }>): Promise<Basket>;
4047
4116
  /**
4048
- * Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS, and it must contain both the previous and current shopper IDs. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
4117
+ * Merge data from the previous shopper's basket into the current shopper's active basket and delete the previous shopper's basket. This endpoint doesn't merge Personally Identifiable Information (PII). You must obtain the shopper authorization token via SLAS and you must provide the ‘guest usid‘ in both the ‘/oauth2/login‘ and ‘/oauth2/token‘ calls while fetching the registered user JWT token. After the merge, all basket amounts are recalculated and totaled, including lookups for prices, taxes, shipping, and promotions.
4049
4118
 
4050
4119
  The following information is merged:
4051
4120
  - custom attributes on the basket and on all copied records
@@ -6103,12 +6172,12 @@ type Sort$0 = {
6103
6172
  } & {
6104
6173
  [key: string]: any;
6105
6174
  };
6106
- type L10nString = {} & {
6175
+ type L10nString$0 = {} & {
6107
6176
  [key: string]: any;
6108
6177
  };
6109
- type PropertyValueDefinition = {
6110
- description: L10nString;
6111
- displayValue: L10nString;
6178
+ type PropertyValueDefinition$0 = {
6179
+ description: L10nString$0;
6180
+ displayValue: L10nString$0;
6112
6181
  id: string;
6113
6182
  position?: number;
6114
6183
  value: string;
@@ -6518,10 +6587,10 @@ declare namespace ShopperContextsTypes {
6518
6587
  [key: string]: any;
6519
6588
  };
6520
6589
  type PropertyDefinition = {
6521
- defaultValue?: PropertyValueDefinition;
6590
+ defaultValue?: PropertyValueDefinition$0;
6522
6591
  id?: string;
6523
- name: L10nString;
6524
- description: L10nString;
6592
+ name: L10nString$0;
6593
+ description: L10nString$0;
6525
6594
  key?: boolean;
6526
6595
  localizable?: boolean;
6527
6596
  mandatory?: boolean;
@@ -6534,8 +6603,8 @@ declare namespace ShopperContextsTypes {
6534
6603
  searchable?: boolean;
6535
6604
  siteSpecific?: boolean;
6536
6605
  system?: boolean;
6537
- unit?: L10nString;
6538
- possibleValues?: Array<PropertyValueDefinition>;
6606
+ unit?: L10nString$0;
6607
+ possibleValues?: Array<PropertyValueDefinition$0>;
6539
6608
  type: string;
6540
6609
  visible?: boolean;
6541
6610
  } & {
@@ -6690,7 +6759,7 @@ declare namespace ShopperContextsTypes {
6690
6759
  [key: string]: any;
6691
6760
  };
6692
6761
  type AttributeDefinition = {
6693
- defaultValue?: PropertyValueDefinition;
6762
+ defaultValue?: PropertyValueDefinition$0;
6694
6763
  id?: string;
6695
6764
  name: L10nString;
6696
6765
  description: L10nString;
@@ -6707,7 +6776,7 @@ declare namespace ShopperContextsTypes {
6707
6776
  siteSpecific?: boolean;
6708
6777
  system?: boolean;
6709
6778
  unit?: L10nString;
6710
- possibleValues?: Array<PropertyValueDefinition>;
6779
+ possibleValues?: Array<PropertyValueDefinition$0>;
6711
6780
  type: string;
6712
6781
  visible?: boolean;
6713
6782
  };
@@ -7848,12 +7917,12 @@ type Sort$1 = {
7848
7917
  } & {
7849
7918
  [key: string]: any;
7850
7919
  };
7851
- type L10nString$0 = {} & {
7920
+ type L10nString$1 = {} & {
7852
7921
  [key: string]: any;
7853
7922
  };
7854
- type PropertyValueDefinition$0 = {
7855
- description: L10nString$0;
7856
- displayValue: L10nString$0;
7923
+ type PropertyValueDefinition$1 = {
7924
+ description: L10nString$1;
7925
+ displayValue: L10nString$1;
7857
7926
  id: string;
7858
7927
  position?: number;
7859
7928
  value: string;
@@ -10817,10 +10886,10 @@ declare namespace ShopperCustomersTypes {
10817
10886
  [key: string]: any;
10818
10887
  };
10819
10888
  type PropertyDefinition = {
10820
- defaultValue?: PropertyValueDefinition$0;
10889
+ defaultValue?: PropertyValueDefinition$1;
10821
10890
  id?: string;
10822
- name: L10nString$0;
10823
- description: L10nString$0;
10891
+ name: L10nString$1;
10892
+ description: L10nString$1;
10824
10893
  key?: boolean;
10825
10894
  localizable?: boolean;
10826
10895
  mandatory?: boolean;
@@ -10833,8 +10902,8 @@ declare namespace ShopperCustomersTypes {
10833
10902
  searchable?: boolean;
10834
10903
  siteSpecific?: boolean;
10835
10904
  system?: boolean;
10836
- unit?: L10nString$0;
10837
- possibleValues?: Array<PropertyValueDefinition$0>;
10905
+ unit?: L10nString$1;
10906
+ possibleValues?: Array<PropertyValueDefinition$1>;
10838
10907
  type: string;
10839
10908
  visible?: boolean;
10840
10909
  } & {
@@ -10989,7 +11058,7 @@ declare namespace ShopperCustomersTypes {
10989
11058
  [key: string]: any;
10990
11059
  };
10991
11060
  type AttributeDefinition = {
10992
- defaultValue?: PropertyValueDefinition$0;
11061
+ defaultValue?: PropertyValueDefinition$1;
10993
11062
  id?: string;
10994
11063
  name: L10nString;
10995
11064
  description: L10nString;
@@ -11006,7 +11075,7 @@ declare namespace ShopperCustomersTypes {
11006
11075
  siteSpecific?: boolean;
11007
11076
  system?: boolean;
11008
11077
  unit?: L10nString;
11009
- possibleValues?: Array<PropertyValueDefinition$0>;
11078
+ possibleValues?: Array<PropertyValueDefinition$1>;
11010
11079
  type: string;
11011
11080
  visible?: boolean;
11012
11081
  };
@@ -14127,12 +14196,12 @@ type Sort$3 = {
14127
14196
  } & {
14128
14197
  [key: string]: any;
14129
14198
  };
14130
- type L10nString$1 = {} & {
14199
+ type L10nString$2 = {} & {
14131
14200
  [key: string]: any;
14132
14201
  };
14133
- type PropertyValueDefinition$1 = {
14134
- description: L10nString$1;
14135
- displayValue: L10nString$1;
14202
+ type PropertyValueDefinition$2 = {
14203
+ description: L10nString$2;
14204
+ displayValue: L10nString$2;
14136
14205
  id: string;
14137
14206
  position?: number;
14138
14207
  value: string;
@@ -14396,10 +14465,10 @@ declare namespace ShopperGiftCertificatesTypes {
14396
14465
  [key: string]: any;
14397
14466
  };
14398
14467
  type PropertyDefinition = {
14399
- defaultValue?: PropertyValueDefinition$1;
14468
+ defaultValue?: PropertyValueDefinition$2;
14400
14469
  id?: string;
14401
- name: L10nString$1;
14402
- description: L10nString$1;
14470
+ name: L10nString$2;
14471
+ description: L10nString$2;
14403
14472
  key?: boolean;
14404
14473
  localizable?: boolean;
14405
14474
  mandatory?: boolean;
@@ -14412,8 +14481,8 @@ declare namespace ShopperGiftCertificatesTypes {
14412
14481
  searchable?: boolean;
14413
14482
  siteSpecific?: boolean;
14414
14483
  system?: boolean;
14415
- unit?: L10nString$1;
14416
- possibleValues?: Array<PropertyValueDefinition$1>;
14484
+ unit?: L10nString$2;
14485
+ possibleValues?: Array<PropertyValueDefinition$2>;
14417
14486
  type: string;
14418
14487
  visible?: boolean;
14419
14488
  } & {
@@ -14568,7 +14637,7 @@ declare namespace ShopperGiftCertificatesTypes {
14568
14637
  [key: string]: any;
14569
14638
  };
14570
14639
  type AttributeDefinition = {
14571
- defaultValue?: PropertyValueDefinition$1;
14640
+ defaultValue?: PropertyValueDefinition$2;
14572
14641
  id?: string;
14573
14642
  name: L10nString;
14574
14643
  description: L10nString;
@@ -14585,7 +14654,7 @@ declare namespace ShopperGiftCertificatesTypes {
14585
14654
  siteSpecific?: boolean;
14586
14655
  system?: boolean;
14587
14656
  unit?: L10nString;
14588
- possibleValues?: Array<PropertyValueDefinition$1>;
14657
+ possibleValues?: Array<PropertyValueDefinition$2>;
14589
14658
  type: string;
14590
14659
  visible?: boolean;
14591
14660
  };
@@ -14713,6 +14782,27 @@ type LoginRequest = {
14713
14782
  } & {
14714
14783
  [key: string]: any;
14715
14784
  };
14785
+ type TrustedAgentTokenRequest = {
14786
+ agent_id: string;
14787
+ client_id: string;
14788
+ channel_id: string;
14789
+ code_verifier: string;
14790
+ grant_type: string;
14791
+ login_id: string;
14792
+ idp_origin: string;
14793
+ } & {
14794
+ [key: string]: any;
14795
+ };
14796
+ type PasswordlessLoginRequest = {
14797
+ user_id: string;
14798
+ mode: string;
14799
+ locale?: string;
14800
+ usid?: string;
14801
+ channel_id: string;
14802
+ callback_uri?: string;
14803
+ } & {
14804
+ [key: string]: any;
14805
+ };
14716
14806
  type CredQualityUserResponse = {
14717
14807
  tenantId: string;
14718
14808
  username: string;
@@ -14764,7 +14854,7 @@ type PasswordActionRequest = {
14764
14854
  locale?: string;
14765
14855
  client_id?: string;
14766
14856
  code_challenge?: string;
14767
- redirect_uri?: string;
14857
+ callback_uri?: string;
14768
14858
  idp_name?: string;
14769
14859
  } & {
14770
14860
  [key: string]: any;
@@ -14789,6 +14879,7 @@ type TokenRequest = {
14789
14879
  redirect_uri?: string;
14790
14880
  code_verifier?: string;
14791
14881
  client_id?: string;
14882
+ channel_id?: string;
14792
14883
  } & {
14793
14884
  [key: string]: any;
14794
14885
  };
@@ -14798,11 +14889,23 @@ type TokenActionRequest = {
14798
14889
  } & {
14799
14890
  [key: string]: any;
14800
14891
  };
14892
+ type SessionBridgeTokenRequest = {
14893
+ code: string;
14894
+ client_id: string;
14895
+ channel_id: string;
14896
+ code_verifier: string;
14897
+ dwsid: string;
14898
+ grant_type: string;
14899
+ login_id: string;
14900
+ usid?: string;
14901
+ } & {
14902
+ [key: string]: any;
14903
+ };
14801
14904
  type RangeFilter$4 = {
14802
14905
  [key: string]: any;
14803
14906
  };
14804
14907
  type BoolFilter$4 = {
14805
- filters?: Filter$3;
14908
+ filters?: Array<Filter$3>;
14806
14909
  operator: string;
14807
14910
  } & {
14808
14911
  [key: string]: any;
@@ -14891,12 +14994,12 @@ type Sort$4 = {
14891
14994
  } & {
14892
14995
  [key: string]: any;
14893
14996
  };
14894
- type L10nString$2 = {} & {
14997
+ type L10nString$3 = {} & {
14895
14998
  [key: string]: any;
14896
14999
  };
14897
- type PropertyValueDefinition$2 = {
14898
- description: L10nString$2;
14899
- displayValue: L10nString$2;
15000
+ type PropertyValueDefinition$3 = {
15001
+ description: L10nString$3;
15002
+ displayValue: L10nString$3;
14900
15003
  id: string;
14901
15004
  position?: number;
14902
15005
  value: string;
@@ -14922,6 +15025,8 @@ type ShopperLoginQueryParameters = {
14922
15025
  state?: string;
14923
15026
  usid?: string;
14924
15027
  code_challenge?: string;
15028
+ login_id?: string;
15029
+ idp_origin?: string;
14925
15030
  };
14926
15031
  /**
14927
15032
  * All parameters that are used by ShopperLogin.
@@ -14950,7 +15055,7 @@ type ShopperLoginParameters = ShopperLoginPathParameters & BaseUriParameters & S
14950
15055
  * ```
14951
15056
  *
14952
15057
  * <span style="font-size:.7em; display:block; text-align: right">
14953
- * API Version: 1.32.0<br />
15058
+ * API Version: 1.39.10<br />
14954
15059
  * Last Updated: <br />
14955
15060
  * </span>
14956
15061
 
@@ -15011,7 +15116,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15011
15116
  };
15012
15117
  }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
15013
15118
  /**
15014
- * Get authorization code after authenticating a user using an ECOM instance.
15119
+ * Authenticates an ECOM customer.
15015
15120
  *
15016
15121
  * If you would like to get a raw Response object use the other authenticateCustomer function.
15017
15122
  *
@@ -15035,7 +15140,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15035
15140
  body: LoginRequest;
15036
15141
  }>): Promise<void>;
15037
15142
  /**
15038
- * Get authorization code after authenticating a user using an ECOM instance.
15143
+ * Authenticates an ECOM customer.
15039
15144
  *
15040
15145
  * @param options - An object containing the options for this method.
15041
15146
  * @param parameters - An object containing the parameters for this method.
@@ -15078,7 +15183,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15078
15183
  headers?: {
15079
15184
  [key: string]: string;
15080
15185
  };
15081
- body: PasswordActionRequest;
15186
+ body: PasswordlessLoginRequest;
15082
15187
  }>): Promise<Object>;
15083
15188
  /**
15084
15189
  * Allows the customer to authenticate when their identity provider is down.
@@ -15100,7 +15205,7 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15100
15205
  headers?: {
15101
15206
  [key: string]: string;
15102
15207
  };
15103
- body: PasswordActionRequest;
15208
+ body: PasswordlessLoginRequest;
15104
15209
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
15105
15210
  /**
15106
15211
  * Log out a shopper.
@@ -15161,7 +15266,9 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15161
15266
  };
15162
15267
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
15163
15268
  /**
15164
- * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
15269
+ * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.1 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.
15270
+
15271
+ This endpoint can be called from the front channel (the browser).
15165
15272
  *
15166
15273
  * If you would like to get a raw Response object use the other authorizeCustomer function.
15167
15274
  *
@@ -15171,12 +15278,20 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15171
15278
  * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
15172
15279
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
15173
15280
  * @param client_id - The client ID obtained during application registration.
15174
- * @param scope - (Not Supported)
15281
+ * @param scope -
15175
15282
  * @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
15176
15283
  * @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
15177
- * @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
15284
+ * @param hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
15285
+
15286
+ To use a public client, set `hint` to `guest` and use a public client ID to get an authorization code. If no `hint` is provided, the preferred IDP of the tenant is used by default.
15287
+
15288
+ For session bridge authorization the `hint` should be set to `sb-user` for a registered customer and to `sb-guest` for a guest.
15178
15289
  * @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
15179
- * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
15290
+ * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.
15291
+
15292
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
15293
+
15294
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
15180
15295
  * @param headers - An object literal of key value pairs of the headers to be
15181
15296
  * sent with this request.
15182
15297
  *
@@ -15201,7 +15316,9 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15201
15316
  };
15202
15317
  }>): Promise<void>;
15203
15318
  /**
15204
- * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
15319
+ * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.1 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.
15320
+
15321
+ This endpoint can be called from the front channel (the browser).
15205
15322
  *
15206
15323
  * @param options - An object containing the options for this method.
15207
15324
  * @param parameters - An object containing the parameters for this method.
@@ -15209,12 +15326,20 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15209
15326
  * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
15210
15327
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
15211
15328
  * @param client_id - The client ID obtained during application registration.
15212
- * @param scope - (Not Supported)
15329
+ * @param scope -
15213
15330
  * @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
15214
15331
  * @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
15215
- * @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
15332
+ * @param hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
15333
+
15334
+ To use a public client, set `hint` to `guest` and use a public client ID to get an authorization code. If no `hint` is provided, the preferred IDP of the tenant is used by default.
15335
+
15336
+ For session bridge authorization the `hint` should be set to `sb-user` for a registered customer and to `sb-guest` for a guest.
15216
15337
  * @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
15217
- * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
15338
+ * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.
15339
+
15340
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
15341
+
15342
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
15218
15343
  * @param headers - An object literal of key value pairs of the headers to be
15219
15344
  * sent with this request.
15220
15345
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -15239,7 +15364,15 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15239
15364
  };
15240
15365
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
15241
15366
  /**
15242
- * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As 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.\<br /\>\<br /\>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.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
15367
+ * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
15368
+
15369
+ As 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.
15370
+
15371
+ 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.
15372
+
15373
+ See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
15374
+
15375
+ **Important**: We strongly recommended using the `channel_id` query parameter because **it will be required in the future**.
15243
15376
  *
15244
15377
  * If you would like to get a raw Response object use the other getAccessToken function.
15245
15378
  *
@@ -15263,7 +15396,15 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15263
15396
  body: TokenRequest;
15264
15397
  }>): Promise<TokenResponse>;
15265
15398
  /**
15266
- * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As 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.\<br /\>\<br /\>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.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
15399
+ * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
15400
+
15401
+ As 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.
15402
+
15403
+ 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.
15404
+
15405
+ See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
15406
+
15407
+ **Important**: We strongly recommended using the `channel_id` query parameter because **it will be required in the future**.
15267
15408
  *
15268
15409
  * @param options - An object containing the options for this method.
15269
15410
  * @param parameters - An object containing the parameters for this method.
@@ -15285,9 +15426,13 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15285
15426
  body: TokenRequest;
15286
15427
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
15287
15428
  /**
15288
- * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
15429
+ * Get a shopper JWT access token for a registered customer using session bridge.
15430
+
15431
+ For public client id requests the grant_type must be set to `session_bridge`.
15432
+
15433
+ For private client_id and secret the grant_type must be set to `client_credentials` along with a basic authorization header.
15289
15434
  *
15290
- * If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
15435
+ * If you would like to get a raw Response object use the other getSessionBridgeAccessToken function.
15291
15436
  *
15292
15437
  * @param options - An object containing the options for this method.
15293
15438
  * @param parameters - An object containing the parameters for this method.
@@ -15299,17 +15444,21 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15299
15444
  * @returns A promise of type TokenResponse.
15300
15445
  *
15301
15446
  */
15302
- getTrustedSystemAccessToken(options: RequireParametersUnlessAllAreOptional<{
15447
+ getSessionBridgeAccessToken(options: RequireParametersUnlessAllAreOptional<{
15303
15448
  parameters?: CompositeParameters<{
15304
15449
  organizationId: string;
15305
15450
  }, ConfigParameters>;
15306
15451
  headers?: {
15307
15452
  [key: string]: string;
15308
15453
  };
15309
- body: TrustedSystemTokenRequest;
15454
+ body: SessionBridgeTokenRequest;
15310
15455
  }>): Promise<TokenResponse>;
15311
15456
  /**
15312
- * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
15457
+ * Get a shopper JWT access token for a registered customer using session bridge.
15458
+
15459
+ For public client id requests the grant_type must be set to `session_bridge`.
15460
+
15461
+ For private client_id and secret the grant_type must be set to `client_credentials` along with a basic authorization header.
15313
15462
  *
15314
15463
  * @param options - An object containing the options for this method.
15315
15464
  * @param parameters - An object containing the parameters for this method.
@@ -15321,19 +15470,23 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15321
15470
  * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
15322
15471
  *
15323
15472
  */
15324
- getTrustedSystemAccessToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
15473
+ getSessionBridgeAccessToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
15325
15474
  parameters?: CompositeParameters<{
15326
15475
  organizationId: string;
15327
15476
  }, ConfigParameters>;
15328
15477
  headers?: {
15329
15478
  [key: string]: string;
15330
15479
  };
15331
- body: TrustedSystemTokenRequest;
15480
+ body: SessionBridgeTokenRequest;
15332
15481
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
15333
15482
  /**
15334
- * Request a reset password token
15483
+ * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.
15484
+
15485
+ For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.
15486
+
15487
+ For internal trusted-system requests, the bearer token must be a C2C JWT.
15335
15488
  *
15336
- * If you would like to get a raw Response object use the other getPasswordResetToken function.
15489
+ * If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
15337
15490
  *
15338
15491
  * @param options - An object containing the options for this method.
15339
15492
  * @param parameters - An object containing the parameters for this method.
@@ -15342,7 +15495,181 @@ declare class ShopperLogin<ConfigParameters extends ShopperLoginParameters & Rec
15342
15495
  * sent with this request.
15343
15496
  * @param body - The data to send as the request body.
15344
15497
  *
15345
- * @returns A promise of type void.
15498
+ * @returns A promise of type TokenResponse.
15499
+ *
15500
+ */
15501
+ getTrustedSystemAccessToken(options: RequireParametersUnlessAllAreOptional<{
15502
+ parameters?: CompositeParameters<{
15503
+ organizationId: string;
15504
+ }, ConfigParameters>;
15505
+ headers?: {
15506
+ [key: string]: string;
15507
+ };
15508
+ body: TrustedSystemTokenRequest;
15509
+ }>): Promise<TokenResponse>;
15510
+ /**
15511
+ * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.
15512
+
15513
+ For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.
15514
+
15515
+ For internal trusted-system requests, the bearer token must be a C2C JWT.
15516
+ *
15517
+ * @param options - An object containing the options for this method.
15518
+ * @param parameters - An object containing the parameters for this method.
15519
+ * @param organizationId -
15520
+ * @param headers - An object literal of key value pairs of the headers to be
15521
+ * sent with this request.
15522
+ * @param body - The data to send as the request body.
15523
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
15524
+ * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
15525
+ *
15526
+ */
15527
+ getTrustedSystemAccessToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
15528
+ parameters?: CompositeParameters<{
15529
+ organizationId: string;
15530
+ }, ConfigParameters>;
15531
+ headers?: {
15532
+ [key: string]: string;
15533
+ };
15534
+ body: TrustedSystemTokenRequest;
15535
+ }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
15536
+ /**
15537
+ * Obtains a new agent on behalf authorization token for a registered customer.
15538
+ *
15539
+ * If you would like to get a raw Response object use the other getTrustedAgentAuthorizationToken function.
15540
+ *
15541
+ * @param options - An object containing the options for this method.
15542
+ * @param parameters - An object containing the parameters for this method.
15543
+ * @param organizationId -
15544
+ * @param client_id - The SLAS public client ID for use with internal trusted-agent requests.
15545
+ * @param channel_id - The channel (ECOM site) that the user is associated with.
15546
+ * @param code_challenge - PKCE code challenge. Created by the caller.
15547
+
15548
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
15549
+
15550
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
15551
+ * @param login_id - The ID of the shopper for trusted agent access.
15552
+ * @param idp_origin - The IDP that the shopper is associated with.
15553
+ * @param redirect_uri - The redirect for Account Manager to redirect to.
15554
+ * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
15555
+ * @param headers - An object literal of key value pairs of the headers to be
15556
+ * sent with this request.
15557
+ *
15558
+ * @returns A promise of type void.
15559
+ *
15560
+ */
15561
+ getTrustedAgentAuthorizationToken(options?: RequireParametersUnlessAllAreOptional<{
15562
+ parameters?: CompositeParameters<{
15563
+ organizationId: string;
15564
+ client_id: string;
15565
+ channel_id: string;
15566
+ code_challenge: string;
15567
+ login_id: string;
15568
+ idp_origin: string;
15569
+ redirect_uri: string;
15570
+ response_type: string;
15571
+ }, ConfigParameters>;
15572
+ headers?: {
15573
+ [key: string]: string;
15574
+ };
15575
+ }>): Promise<void>;
15576
+ /**
15577
+ * Obtains a new agent on behalf authorization token for a registered customer.
15578
+ *
15579
+ * @param options - An object containing the options for this method.
15580
+ * @param parameters - An object containing the parameters for this method.
15581
+ * @param organizationId -
15582
+ * @param client_id - The SLAS public client ID for use with internal trusted-agent requests.
15583
+ * @param channel_id - The channel (ECOM site) that the user is associated with.
15584
+ * @param code_challenge - PKCE code challenge. Created by the caller.
15585
+
15586
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
15587
+
15588
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
15589
+ * @param login_id - The ID of the shopper for trusted agent access.
15590
+ * @param idp_origin - The IDP that the shopper is associated with.
15591
+ * @param redirect_uri - The redirect for Account Manager to redirect to.
15592
+ * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
15593
+ * @param headers - An object literal of key value pairs of the headers to be
15594
+ * sent with this request.
15595
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
15596
+ * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
15597
+ *
15598
+ */
15599
+ getTrustedAgentAuthorizationToken<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
15600
+ parameters?: CompositeParameters<{
15601
+ organizationId: string;
15602
+ client_id: string;
15603
+ channel_id: string;
15604
+ code_challenge: string;
15605
+ login_id: string;
15606
+ idp_origin: string;
15607
+ redirect_uri: string;
15608
+ response_type: string;
15609
+ }, ConfigParameters>;
15610
+ headers?: {
15611
+ [key: string]: string;
15612
+ };
15613
+ }>, rawResponse?: T): Promise<T extends true ? Response : void>;
15614
+ /**
15615
+ * Get a shopper JWT access token for a registered customer using a trusted agent (Merchant)
15616
+ *
15617
+ * If you would like to get a raw Response object use the other getTrustedAgentAccessToken function.
15618
+ *
15619
+ * @param options - An object containing the options for this method.
15620
+ * @param parameters - An object containing the parameters for this method.
15621
+ * @param organizationId -
15622
+ * @param headers - An object literal of key value pairs of the headers to be
15623
+ * sent with this request.
15624
+ * @param body - The data to send as the request body.
15625
+ *
15626
+ * @returns A promise of type TokenResponse.
15627
+ *
15628
+ */
15629
+ getTrustedAgentAccessToken(options: RequireParametersUnlessAllAreOptional<{
15630
+ parameters?: CompositeParameters<{
15631
+ organizationId: string;
15632
+ }, ConfigParameters>;
15633
+ headers?: {
15634
+ [key: string]: string;
15635
+ };
15636
+ body: TrustedAgentTokenRequest;
15637
+ }>): Promise<TokenResponse>;
15638
+ /**
15639
+ * Get a shopper JWT access token for a registered customer using a trusted agent (Merchant)
15640
+ *
15641
+ * @param options - An object containing the options for this method.
15642
+ * @param parameters - An object containing the parameters for this method.
15643
+ * @param organizationId -
15644
+ * @param headers - An object literal of key value pairs of the headers to be
15645
+ * sent with this request.
15646
+ * @param body - The data to send as the request body.
15647
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
15648
+ * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
15649
+ *
15650
+ */
15651
+ getTrustedAgentAccessToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
15652
+ parameters?: CompositeParameters<{
15653
+ organizationId: string;
15654
+ }, ConfigParameters>;
15655
+ headers?: {
15656
+ [key: string]: string;
15657
+ };
15658
+ body: TrustedAgentTokenRequest;
15659
+ }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
15660
+ /**
15661
+ * Request a reset password token
15662
+ *
15663
+ * If you would like to get a raw Response object use the other getPasswordResetToken function.
15664
+ *
15665
+ * @param options - An object containing the options for this method.
15666
+ * @param parameters - An object containing the parameters for this method.
15667
+ * @param organizationId -
15668
+ * @param headers - An object literal of key value pairs of the headers to be
15669
+ * sent with this request.
15670
+ * @param body - The data to send as the request body.
15671
+ *
15672
+ * @returns A promise of type void.
15346
15673
  *
15347
15674
  */
15348
15675
  getPasswordResetToken(options: RequireParametersUnlessAllAreOptional<{
@@ -15780,6 +16107,17 @@ declare namespace ShopperLoginTypes {
15780
16107
  } & {
15781
16108
  [key: string]: any;
15782
16109
  };
16110
+ type TrustedAgentTokenRequest = {
16111
+ agent_id: string;
16112
+ client_id: string;
16113
+ channel_id: string;
16114
+ code_verifier: string;
16115
+ grant_type: string;
16116
+ login_id: string;
16117
+ idp_origin: string;
16118
+ } & {
16119
+ [key: string]: any;
16120
+ };
15783
16121
  type IntrospectResponse = {
15784
16122
  active: boolean;
15785
16123
  scope: string;
@@ -15791,6 +16129,16 @@ declare namespace ShopperLoginTypes {
15791
16129
  } & {
15792
16130
  [key: string]: any;
15793
16131
  };
16132
+ type PasswordlessLoginRequest = {
16133
+ user_id: string;
16134
+ mode: string;
16135
+ locale?: string;
16136
+ usid?: string;
16137
+ channel_id: string;
16138
+ callback_uri?: string;
16139
+ } & {
16140
+ [key: string]: any;
16141
+ };
15794
16142
  type CredQualityUserResponse = {
15795
16143
  tenantId: string;
15796
16144
  username: string;
@@ -15849,7 +16197,7 @@ declare namespace ShopperLoginTypes {
15849
16197
  locale?: string;
15850
16198
  client_id?: string;
15851
16199
  code_challenge?: string;
15852
- redirect_uri?: string;
16200
+ callback_uri?: string;
15853
16201
  idp_name?: string;
15854
16202
  } & {
15855
16203
  [key: string]: any;
@@ -15874,6 +16222,7 @@ declare namespace ShopperLoginTypes {
15874
16222
  redirect_uri?: string;
15875
16223
  code_verifier?: string;
15876
16224
  client_id?: string;
16225
+ channel_id?: string;
15877
16226
  } & {
15878
16227
  [key: string]: any;
15879
16228
  };
@@ -15883,6 +16232,18 @@ declare namespace ShopperLoginTypes {
15883
16232
  } & {
15884
16233
  [key: string]: any;
15885
16234
  };
16235
+ type SessionBridgeTokenRequest = {
16236
+ code: string;
16237
+ client_id: string;
16238
+ channel_id: string;
16239
+ code_verifier: string;
16240
+ dwsid: string;
16241
+ grant_type: string;
16242
+ login_id: string;
16243
+ usid?: string;
16244
+ } & {
16245
+ [key: string]: any;
16246
+ };
15886
16247
  type ErrorResponse = {
15887
16248
  type: string;
15888
16249
  title?: string;
@@ -15941,10 +16302,10 @@ declare namespace ShopperLoginTypes {
15941
16302
  [key: string]: any;
15942
16303
  };
15943
16304
  type PropertyDefinition = {
15944
- defaultValue?: PropertyValueDefinition$2;
16305
+ defaultValue?: PropertyValueDefinition$3;
15945
16306
  id?: string;
15946
- name: L10nString$2;
15947
- description: L10nString$2;
16307
+ name: L10nString$3;
16308
+ description: L10nString$3;
15948
16309
  key?: boolean;
15949
16310
  localizable?: boolean;
15950
16311
  mandatory?: boolean;
@@ -15957,8 +16318,8 @@ declare namespace ShopperLoginTypes {
15957
16318
  searchable?: boolean;
15958
16319
  siteSpecific?: boolean;
15959
16320
  system?: boolean;
15960
- unit?: L10nString$2;
15961
- possibleValues?: Array<PropertyValueDefinition$2>;
16321
+ unit?: L10nString$3;
16322
+ possibleValues?: Array<PropertyValueDefinition$3>;
15962
16323
  type: string;
15963
16324
  visible?: boolean;
15964
16325
  } & {
@@ -15988,7 +16349,7 @@ declare namespace ShopperLoginTypes {
15988
16349
  [key: string]: any;
15989
16350
  };
15990
16351
  type BoolFilter = {
15991
- filters?: Filter$4;
16352
+ filters?: Array<Filter$4>;
15992
16353
  operator: string;
15993
16354
  } & {
15994
16355
  [key: string]: any;
@@ -16113,7 +16474,7 @@ declare namespace ShopperLoginTypes {
16113
16474
  [key: string]: any;
16114
16475
  };
16115
16476
  type AttributeDefinition = {
16116
- defaultValue?: PropertyValueDefinition$2;
16477
+ defaultValue?: PropertyValueDefinition$3;
16117
16478
  id?: string;
16118
16479
  name: L10nString;
16119
16480
  description: L10nString;
@@ -16130,7 +16491,7 @@ declare namespace ShopperLoginTypes {
16130
16491
  siteSpecific?: boolean;
16131
16492
  system?: boolean;
16132
16493
  unit?: L10nString;
16133
- possibleValues?: Array<PropertyValueDefinition$2>;
16494
+ possibleValues?: Array<PropertyValueDefinition$3>;
16134
16495
  type: string;
16135
16496
  visible?: boolean;
16136
16497
  };
@@ -16162,6 +16523,8 @@ declare namespace ShopperLoginTypes {
16162
16523
  state?: string;
16163
16524
  usid?: string;
16164
16525
  code_challenge?: string;
16526
+ login_id?: string;
16527
+ idp_origin?: string;
16165
16528
  };
16166
16529
  /**
16167
16530
  * All parameters that are used by ShopperLogin.
@@ -16190,7 +16553,7 @@ declare namespace ShopperLoginTypes {
16190
16553
  * ```
16191
16554
  *
16192
16555
  * <span style="font-size:.7em; display:block; text-align: right">
16193
- * API Version: 1.32.0<br />
16556
+ * API Version: 1.39.10<br />
16194
16557
  * Last Updated: <br />
16195
16558
  * </span>
16196
16559
 
@@ -16251,7 +16614,7 @@ declare namespace ShopperLoginTypes {
16251
16614
  };
16252
16615
  }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
16253
16616
  /**
16254
- * Get authorization code after authenticating a user using an ECOM instance.
16617
+ * Authenticates an ECOM customer.
16255
16618
  *
16256
16619
  * If you would like to get a raw Response object use the other authenticateCustomer function.
16257
16620
  *
@@ -16275,7 +16638,7 @@ declare namespace ShopperLoginTypes {
16275
16638
  body: LoginRequest;
16276
16639
  }>): Promise<void>;
16277
16640
  /**
16278
- * Get authorization code after authenticating a user using an ECOM instance.
16641
+ * Authenticates an ECOM customer.
16279
16642
  *
16280
16643
  * @param options - An object containing the options for this method.
16281
16644
  * @param parameters - An object containing the parameters for this method.
@@ -16318,7 +16681,7 @@ declare namespace ShopperLoginTypes {
16318
16681
  headers?: {
16319
16682
  [key: string]: string;
16320
16683
  };
16321
- body: PasswordActionRequest;
16684
+ body: PasswordlessLoginRequest;
16322
16685
  }>): Promise<Object>;
16323
16686
  /**
16324
16687
  * Allows the customer to authenticate when their identity provider is down.
@@ -16340,7 +16703,7 @@ declare namespace ShopperLoginTypes {
16340
16703
  headers?: {
16341
16704
  [key: string]: string;
16342
16705
  };
16343
- body: PasswordActionRequest;
16706
+ body: PasswordlessLoginRequest;
16344
16707
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
16345
16708
  /**
16346
16709
  * Log out a shopper.
@@ -16401,7 +16764,9 @@ declare namespace ShopperLoginTypes {
16401
16764
  };
16402
16765
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
16403
16766
  /**
16404
- * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
16767
+ * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.1 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.
16768
+
16769
+ This endpoint can be called from the front channel (the browser).
16405
16770
  *
16406
16771
  * If you would like to get a raw Response object use the other authorizeCustomer function.
16407
16772
  *
@@ -16411,12 +16776,20 @@ declare namespace ShopperLoginTypes {
16411
16776
  * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
16412
16777
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
16413
16778
  * @param client_id - The client ID obtained during application registration.
16414
- * @param scope - (Not Supported)
16779
+ * @param scope -
16415
16780
  * @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
16416
16781
  * @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
16417
- * @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
16782
+ * @param hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
16783
+
16784
+ To use a public client, set `hint` to `guest` and use a public client ID to get an authorization code. If no `hint` is provided, the preferred IDP of the tenant is used by default.
16785
+
16786
+ For session bridge authorization the `hint` should be set to `sb-user` for a registered customer and to `sb-guest` for a guest.
16418
16787
  * @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
16419
- * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
16788
+ * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.
16789
+
16790
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
16791
+
16792
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
16420
16793
  * @param headers - An object literal of key value pairs of the headers to be
16421
16794
  * sent with this request.
16422
16795
  *
@@ -16441,7 +16814,9 @@ declare namespace ShopperLoginTypes {
16441
16814
  };
16442
16815
  }>): Promise<void>;
16443
16816
  /**
16444
- * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
16817
+ * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.1 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.
16818
+
16819
+ This endpoint can be called from the front channel (the browser).
16445
16820
  *
16446
16821
  * @param options - An object containing the options for this method.
16447
16822
  * @param parameters - An object containing the parameters for this method.
@@ -16449,12 +16824,20 @@ declare namespace ShopperLoginTypes {
16449
16824
  * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
16450
16825
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
16451
16826
  * @param client_id - The client ID obtained during application registration.
16452
- * @param scope - (Not Supported)
16827
+ * @param scope -
16453
16828
  * @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
16454
16829
  * @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
16455
- * @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
16830
+ * @param hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
16831
+
16832
+ To use a public client, set `hint` to `guest` and use a public client ID to get an authorization code. If no `hint` is provided, the preferred IDP of the tenant is used by default.
16833
+
16834
+ For session bridge authorization the `hint` should be set to `sb-user` for a registered customer and to `sb-guest` for a guest.
16456
16835
  * @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
16457
- * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
16836
+ * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.
16837
+
16838
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
16839
+
16840
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
16458
16841
  * @param headers - An object literal of key value pairs of the headers to be
16459
16842
  * sent with this request.
16460
16843
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -16479,7 +16862,15 @@ declare namespace ShopperLoginTypes {
16479
16862
  };
16480
16863
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
16481
16864
  /**
16482
- * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As 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.\<br /\>\<br /\>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.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
16865
+ * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
16866
+
16867
+ As 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.
16868
+
16869
+ 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.
16870
+
16871
+ See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
16872
+
16873
+ **Important**: We strongly recommended using the `channel_id` query parameter because **it will be required in the future**.
16483
16874
  *
16484
16875
  * If you would like to get a raw Response object use the other getAccessToken function.
16485
16876
  *
@@ -16503,7 +16894,15 @@ declare namespace ShopperLoginTypes {
16503
16894
  body: TokenRequest;
16504
16895
  }>): Promise<TokenResponse>;
16505
16896
  /**
16506
- * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As 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.\<br /\>\<br /\>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.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
16897
+ * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
16898
+
16899
+ As 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.
16900
+
16901
+ 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.
16902
+
16903
+ See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
16904
+
16905
+ **Important**: We strongly recommended using the `channel_id` query parameter because **it will be required in the future**.
16507
16906
  *
16508
16907
  * @param options - An object containing the options for this method.
16509
16908
  * @param parameters - An object containing the parameters for this method.
@@ -16525,7 +16924,65 @@ declare namespace ShopperLoginTypes {
16525
16924
  body: TokenRequest;
16526
16925
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
16527
16926
  /**
16528
- * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
16927
+ * Get a shopper JWT access token for a registered customer using session bridge.
16928
+
16929
+ For public client id requests the grant_type must be set to `session_bridge`.
16930
+
16931
+ For private client_id and secret the grant_type must be set to `client_credentials` along with a basic authorization header.
16932
+ *
16933
+ * If you would like to get a raw Response object use the other getSessionBridgeAccessToken function.
16934
+ *
16935
+ * @param options - An object containing the options for this method.
16936
+ * @param parameters - An object containing the parameters for this method.
16937
+ * @param organizationId -
16938
+ * @param headers - An object literal of key value pairs of the headers to be
16939
+ * sent with this request.
16940
+ * @param body - The data to send as the request body.
16941
+ *
16942
+ * @returns A promise of type TokenResponse.
16943
+ *
16944
+ */
16945
+ getSessionBridgeAccessToken(options: RequireParametersUnlessAllAreOptional<{
16946
+ parameters?: CompositeParameters<{
16947
+ organizationId: string;
16948
+ }, ConfigParameters>;
16949
+ headers?: {
16950
+ [key: string]: string;
16951
+ };
16952
+ body: SessionBridgeTokenRequest;
16953
+ }>): Promise<TokenResponse>;
16954
+ /**
16955
+ * Get a shopper JWT access token for a registered customer using session bridge.
16956
+
16957
+ For public client id requests the grant_type must be set to `session_bridge`.
16958
+
16959
+ For private client_id and secret the grant_type must be set to `client_credentials` along with a basic authorization header.
16960
+ *
16961
+ * @param options - An object containing the options for this method.
16962
+ * @param parameters - An object containing the parameters for this method.
16963
+ * @param organizationId -
16964
+ * @param headers - An object literal of key value pairs of the headers to be
16965
+ * sent with this request.
16966
+ * @param body - The data to send as the request body.
16967
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
16968
+ * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
16969
+ *
16970
+ */
16971
+ getSessionBridgeAccessToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
16972
+ parameters?: CompositeParameters<{
16973
+ organizationId: string;
16974
+ }, ConfigParameters>;
16975
+ headers?: {
16976
+ [key: string]: string;
16977
+ };
16978
+ body: SessionBridgeTokenRequest;
16979
+ }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
16980
+ /**
16981
+ * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.
16982
+
16983
+ For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.
16984
+
16985
+ For internal trusted-system requests, the bearer token must be a C2C JWT.
16529
16986
  *
16530
16987
  * If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
16531
16988
  *
@@ -16549,7 +17006,11 @@ declare namespace ShopperLoginTypes {
16549
17006
  body: TrustedSystemTokenRequest;
16550
17007
  }>): Promise<TokenResponse>;
16551
17008
  /**
16552
- * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
17009
+ * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.
17010
+
17011
+ For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.
17012
+
17013
+ For internal trusted-system requests, the bearer token must be a C2C JWT.
16553
17014
  *
16554
17015
  * @param options - An object containing the options for this method.
16555
17016
  * @param parameters - An object containing the parameters for this method.
@@ -16570,6 +17031,130 @@ declare namespace ShopperLoginTypes {
16570
17031
  };
16571
17032
  body: TrustedSystemTokenRequest;
16572
17033
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
17034
+ /**
17035
+ * Obtains a new agent on behalf authorization token for a registered customer.
17036
+ *
17037
+ * If you would like to get a raw Response object use the other getTrustedAgentAuthorizationToken function.
17038
+ *
17039
+ * @param options - An object containing the options for this method.
17040
+ * @param parameters - An object containing the parameters for this method.
17041
+ * @param organizationId -
17042
+ * @param client_id - The SLAS public client ID for use with internal trusted-agent requests.
17043
+ * @param channel_id - The channel (ECOM site) that the user is associated with.
17044
+ * @param code_challenge - PKCE code challenge. Created by the caller.
17045
+
17046
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
17047
+
17048
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
17049
+ * @param login_id - The ID of the shopper for trusted agent access.
17050
+ * @param idp_origin - The IDP that the shopper is associated with.
17051
+ * @param redirect_uri - The redirect for Account Manager to redirect to.
17052
+ * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
17053
+ * @param headers - An object literal of key value pairs of the headers to be
17054
+ * sent with this request.
17055
+ *
17056
+ * @returns A promise of type void.
17057
+ *
17058
+ */
17059
+ getTrustedAgentAuthorizationToken(options?: RequireParametersUnlessAllAreOptional<{
17060
+ parameters?: CompositeParameters<{
17061
+ organizationId: string;
17062
+ client_id: string;
17063
+ channel_id: string;
17064
+ code_challenge: string;
17065
+ login_id: string;
17066
+ idp_origin: string;
17067
+ redirect_uri: string;
17068
+ response_type: string;
17069
+ }, ConfigParameters>;
17070
+ headers?: {
17071
+ [key: string]: string;
17072
+ };
17073
+ }>): Promise<void>;
17074
+ /**
17075
+ * Obtains a new agent on behalf authorization token for a registered customer.
17076
+ *
17077
+ * @param options - An object containing the options for this method.
17078
+ * @param parameters - An object containing the parameters for this method.
17079
+ * @param organizationId -
17080
+ * @param client_id - The SLAS public client ID for use with internal trusted-agent requests.
17081
+ * @param channel_id - The channel (ECOM site) that the user is associated with.
17082
+ * @param code_challenge - PKCE code challenge. Created by the caller.
17083
+
17084
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
17085
+
17086
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
17087
+ * @param login_id - The ID of the shopper for trusted agent access.
17088
+ * @param idp_origin - The IDP that the shopper is associated with.
17089
+ * @param redirect_uri - The redirect for Account Manager to redirect to.
17090
+ * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
17091
+ * @param headers - An object literal of key value pairs of the headers to be
17092
+ * sent with this request.
17093
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
17094
+ * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
17095
+ *
17096
+ */
17097
+ getTrustedAgentAuthorizationToken<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
17098
+ parameters?: CompositeParameters<{
17099
+ organizationId: string;
17100
+ client_id: string;
17101
+ channel_id: string;
17102
+ code_challenge: string;
17103
+ login_id: string;
17104
+ idp_origin: string;
17105
+ redirect_uri: string;
17106
+ response_type: string;
17107
+ }, ConfigParameters>;
17108
+ headers?: {
17109
+ [key: string]: string;
17110
+ };
17111
+ }>, rawResponse?: T): Promise<T extends true ? Response : void>;
17112
+ /**
17113
+ * Get a shopper JWT access token for a registered customer using a trusted agent (Merchant)
17114
+ *
17115
+ * If you would like to get a raw Response object use the other getTrustedAgentAccessToken function.
17116
+ *
17117
+ * @param options - An object containing the options for this method.
17118
+ * @param parameters - An object containing the parameters for this method.
17119
+ * @param organizationId -
17120
+ * @param headers - An object literal of key value pairs of the headers to be
17121
+ * sent with this request.
17122
+ * @param body - The data to send as the request body.
17123
+ *
17124
+ * @returns A promise of type TokenResponse.
17125
+ *
17126
+ */
17127
+ getTrustedAgentAccessToken(options: RequireParametersUnlessAllAreOptional<{
17128
+ parameters?: CompositeParameters<{
17129
+ organizationId: string;
17130
+ }, ConfigParameters>;
17131
+ headers?: {
17132
+ [key: string]: string;
17133
+ };
17134
+ body: TrustedAgentTokenRequest;
17135
+ }>): Promise<TokenResponse>;
17136
+ /**
17137
+ * Get a shopper JWT access token for a registered customer using a trusted agent (Merchant)
17138
+ *
17139
+ * @param options - An object containing the options for this method.
17140
+ * @param parameters - An object containing the parameters for this method.
17141
+ * @param organizationId -
17142
+ * @param headers - An object literal of key value pairs of the headers to be
17143
+ * sent with this request.
17144
+ * @param body - The data to send as the request body.
17145
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
17146
+ * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
17147
+ *
17148
+ */
17149
+ getTrustedAgentAccessToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
17150
+ parameters?: CompositeParameters<{
17151
+ organizationId: string;
17152
+ }, ConfigParameters>;
17153
+ headers?: {
17154
+ [key: string]: string;
17155
+ };
17156
+ body: TrustedAgentTokenRequest;
17157
+ }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
16573
17158
  /**
16574
17159
  * Request a reset password token
16575
17160
  *
@@ -16932,6 +17517,36 @@ declare namespace ShopperLoginTypes {
16932
17517
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
16933
17518
  }
16934
17519
  }
17520
+ type BoolFilter$5 = {
17521
+ filters?: Array<Filter$4>;
17522
+ operator: string;
17523
+ } & {
17524
+ [key: string]: any;
17525
+ };
17526
+ type MatchAllQuery$5 = {} & {
17527
+ [key: string]: any;
17528
+ };
17529
+ type FilteredQuery$5 = {
17530
+ filter: Filter$4;
17531
+ query: Query$4;
17532
+ } & {
17533
+ [key: string]: any;
17534
+ };
17535
+ type QueryFilter$5 = {
17536
+ query: Query$4;
17537
+ } & {
17538
+ [key: string]: any;
17539
+ };
17540
+ type Query$5 = {
17541
+ boolQuery?: BoolQuery$4;
17542
+ filteredQuery?: FilteredQuery$5;
17543
+ matchAllQuery?: MatchAllQuery$5;
17544
+ nestedQuery?: NestedQuery$4;
17545
+ termQuery?: TermQuery$4;
17546
+ textQuery?: TextQuery$4;
17547
+ } & {
17548
+ [key: string]: any;
17549
+ };
16935
17550
  type TermQuery$5 = {
16936
17551
  fields: Array<string>;
16937
17552
  operator: string;
@@ -16939,26 +17554,53 @@ type TermQuery$5 = {
16939
17554
  } & {
16940
17555
  [key: string]: any;
16941
17556
  };
17557
+ type TermFilter$5 = {
17558
+ field: string;
17559
+ operator: string;
17560
+ values?: Array<any>;
17561
+ } & {
17562
+ [key: string]: any;
17563
+ };
16942
17564
  type TextQuery$5 = {
16943
17565
  fields: Array<string>;
16944
17566
  searchPhrase: string;
16945
17567
  } & {
16946
17568
  [key: string]: any;
16947
17569
  };
17570
+ type Range2Filter$5 = {
17571
+ filterMode?: string;
17572
+ fromField: string;
17573
+ fromInclusive?: boolean;
17574
+ fromValue?: any;
17575
+ toField: string;
17576
+ toInclusive?: boolean;
17577
+ toValue?: any;
17578
+ } & {
17579
+ [key: string]: any;
17580
+ };
16948
17581
  type BoolQuery$5 = {
16949
- must?: Array<any>;
16950
- mustNot?: Array<any>;
16951
- should?: Array<any>;
17582
+ must?: Array<Query$5>;
17583
+ mustNot?: Array<Query$5>;
17584
+ should?: Array<Query$5>;
16952
17585
  } & {
16953
17586
  [key: string]: any;
16954
17587
  };
16955
17588
  type NestedQuery$5 = {
16956
17589
  path: string;
16957
- query: any;
17590
+ query: Query$5;
16958
17591
  scoreMode?: string;
16959
17592
  } & {
16960
17593
  [key: string]: any;
16961
17594
  };
17595
+ type Filter$5 = {
17596
+ boolFilter?: BoolFilter$5;
17597
+ queryFilter?: QueryFilter$5;
17598
+ range2Filter?: Range2Filter$5;
17599
+ rangeFilter?: RangeFilter$4;
17600
+ termFilter?: TermFilter$5;
17601
+ } & {
17602
+ [key: string]: any;
17603
+ };
16962
17604
  type Sort$5 = {
16963
17605
  field: string;
16964
17606
  sortOrder?: string;
@@ -16974,6 +17616,16 @@ type RangeFilter$5 = {
16974
17616
  } & {
16975
17617
  [key: string]: any;
16976
17618
  };
17619
+ type L10nString$4 = {} & {
17620
+ [key: string]: any;
17621
+ };
17622
+ type PropertyValueDefinition$4 = {
17623
+ description: L10nString$4;
17624
+ displayValue: L10nString$4;
17625
+ id: string;
17626
+ position?: number;
17627
+ value: string;
17628
+ };
16977
17629
  type PaymentCardSpec$0 = {
16978
17630
  cardType?: string;
16979
17631
  checksumVerificationEnabled?: boolean;
@@ -17407,7 +18059,7 @@ type ShopperOrdersParameters = ShopperOrdersPathParameters & BaseUriParameters &
17407
18059
  * ```
17408
18060
  *
17409
18061
  * <span style="font-size:.7em; display:block; text-align: right">
17410
- * API Version: 0.2.0<br />
18062
+ * API Version: 0.3.1<br />
17411
18063
  * Last Updated: <br />
17412
18064
  * </span>
17413
18065
 
@@ -17430,7 +18082,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17430
18082
  * @param parameters - An object containing the parameters for this method.
17431
18083
  * @param organizationId - An identifier for the organization the request is being made by.
17432
18084
  * @param siteId -
17433
- * @param locale -
18085
+ * @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.
18086
+ Below are some valid examples:
18087
+ - en-US
18088
+ - de-AT
18089
+ - de
18090
+ - default
17434
18091
  * @param headers - An object literal of key value pairs of the headers to be
17435
18092
  * sent with this request.
17436
18093
  * @param body - The data to send as the request body.
@@ -17456,7 +18113,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17456
18113
  * @param parameters - An object containing the parameters for this method.
17457
18114
  * @param organizationId - An identifier for the organization the request is being made by.
17458
18115
  * @param siteId -
17459
- * @param locale -
18116
+ * @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.
18117
+ Below are some valid examples:
18118
+ - en-US
18119
+ - de-AT
18120
+ - de
18121
+ - default
17460
18122
  * @param headers - An object literal of key value pairs of the headers to be
17461
18123
  * sent with this request.
17462
18124
  * @param body - The data to send as the request body.
@@ -17485,7 +18147,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17485
18147
  * @param organizationId - An identifier for the organization the request is being made by.
17486
18148
  * @param orderNo - The order number of the order to be modified.
17487
18149
  * @param siteId -
17488
- * @param locale -
18150
+ * @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.
18151
+ Below are some valid examples:
18152
+ - en-US
18153
+ - de-AT
18154
+ - de
18155
+ - default
17489
18156
  * @param headers - An object literal of key value pairs of the headers to be
17490
18157
  * sent with this request.
17491
18158
  *
@@ -17511,7 +18178,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17511
18178
  * @param organizationId - An identifier for the organization the request is being made by.
17512
18179
  * @param orderNo - The order number of the order to be modified.
17513
18180
  * @param siteId -
17514
- * @param locale -
18181
+ * @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.
18182
+ Below are some valid examples:
18183
+ - en-US
18184
+ - de-AT
18185
+ - de
18186
+ - default
17515
18187
  * @param headers - An object literal of key value pairs of the headers to be
17516
18188
  * sent with this request.
17517
18189
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -17544,7 +18216,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17544
18216
  * @param organizationId - An identifier for the organization the request is being made by.
17545
18217
  * @param orderNo - The order number of the order to be modified.
17546
18218
  * @param siteId -
17547
- * @param locale -
18219
+ * @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.
18220
+ Below are some valid examples:
18221
+ - en-US
18222
+ - de-AT
18223
+ - de
18224
+ - default
17548
18225
  * @param headers - An object literal of key value pairs of the headers to be
17549
18226
  * sent with this request.
17550
18227
  * @param body - The data to send as the request body.
@@ -17577,7 +18254,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17577
18254
  * @param organizationId - An identifier for the organization the request is being made by.
17578
18255
  * @param orderNo - The order number of the order to be modified.
17579
18256
  * @param siteId -
17580
- * @param locale -
18257
+ * @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.
18258
+ Below are some valid examples:
18259
+ - en-US
18260
+ - de-AT
18261
+ - de
18262
+ - default
17581
18263
  * @param headers - An object literal of key value pairs of the headers to be
17582
18264
  * sent with this request.
17583
18265
  * @param body - The data to send as the request body.
@@ -17608,7 +18290,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17608
18290
  * @param orderNo - The order number of the order to be modified.
17609
18291
  * @param paymentInstrumentId - The ID of the payment instrument to be updated.
17610
18292
  * @param siteId -
17611
- * @param locale -
18293
+ * @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.
18294
+ Below are some valid examples:
18295
+ - en-US
18296
+ - de-AT
18297
+ - de
18298
+ - default
17612
18299
  * @param headers - An object literal of key value pairs of the headers to be
17613
18300
  * sent with this request.
17614
18301
  *
@@ -17636,7 +18323,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17636
18323
  * @param orderNo - The order number of the order to be modified.
17637
18324
  * @param paymentInstrumentId - The ID of the payment instrument to be updated.
17638
18325
  * @param siteId -
17639
- * @param locale -
18326
+ * @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.
18327
+ Below are some valid examples:
18328
+ - en-US
18329
+ - de-AT
18330
+ - de
18331
+ - default
17640
18332
  * @param headers - An object literal of key value pairs of the headers to be
17641
18333
  * sent with this request.
17642
18334
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -17672,7 +18364,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17672
18364
  * @param orderNo - The order number of the order to be modified.
17673
18365
  * @param paymentInstrumentId - The ID of the payment instrument to be updated.
17674
18366
  * @param siteId -
17675
- * @param locale -
18367
+ * @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.
18368
+ Below are some valid examples:
18369
+ - en-US
18370
+ - de-AT
18371
+ - de
18372
+ - default
17676
18373
  * @param headers - An object literal of key value pairs of the headers to be
17677
18374
  * sent with this request.
17678
18375
  * @param body - The data to send as the request body.
@@ -17708,7 +18405,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17708
18405
  * @param orderNo - The order number of the order to be modified.
17709
18406
  * @param paymentInstrumentId - The ID of the payment instrument to be updated.
17710
18407
  * @param siteId -
17711
- * @param locale -
18408
+ * @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.
18409
+ Below are some valid examples:
18410
+ - en-US
18411
+ - de-AT
18412
+ - de
18413
+ - default
17712
18414
  * @param headers - An object literal of key value pairs of the headers to be
17713
18415
  * sent with this request.
17714
18416
  * @param body - The data to send as the request body.
@@ -17739,7 +18441,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17739
18441
  * @param organizationId - An identifier for the organization the request is being made by.
17740
18442
  * @param orderNo - The order number of the order to be modified.
17741
18443
  * @param siteId -
17742
- * @param locale -
18444
+ * @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.
18445
+ Below are some valid examples:
18446
+ - en-US
18447
+ - de-AT
18448
+ - de
18449
+ - default
17743
18450
  * @param headers - An object literal of key value pairs of the headers to be
17744
18451
  * sent with this request.
17745
18452
  *
@@ -17765,7 +18472,12 @@ declare class ShopperOrders<ConfigParameters extends ShopperOrdersParameters & R
17765
18472
  * @param organizationId - An identifier for the organization the request is being made by.
17766
18473
  * @param orderNo - The order number of the order to be modified.
17767
18474
  * @param siteId -
17768
- * @param locale -
18475
+ * @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.
18476
+ Below are some valid examples:
18477
+ - en-US
18478
+ - de-AT
18479
+ - de
18480
+ - default
17769
18481
  * @param headers - An object literal of key value pairs of the headers to be
17770
18482
  * sent with this request.
17771
18483
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -17932,26 +18644,53 @@ declare namespace ShopperOrdersTypes {
17932
18644
  type SimpleSearchResult = {
17933
18645
  limit: number;
17934
18646
  hits?: Array<object>;
17935
- offset: number;
17936
- total: number;
18647
+ offset: any;
18648
+ total: any;
17937
18649
  } & {
17938
18650
  [key: string]: any;
17939
18651
  };
17940
18652
  type SearchRequest = {
17941
18653
  limit?: number;
17942
- query: any;
18654
+ query: Query$5;
17943
18655
  sorts?: Array<Sort$5>;
17944
- offset?: number;
18656
+ offset?: any;
18657
+ } & {
18658
+ [key: string]: any;
18659
+ };
18660
+ type PropertyDefinition = {
18661
+ defaultValue?: PropertyValueDefinition$4;
18662
+ id?: string;
18663
+ name: L10nString$4;
18664
+ description: L10nString$4;
18665
+ key?: boolean;
18666
+ localizable?: boolean;
18667
+ mandatory?: boolean;
18668
+ max?: number;
18669
+ minLength?: number;
18670
+ min?: number;
18671
+ multiValueType?: boolean;
18672
+ regularExpression?: string;
18673
+ scale?: number;
18674
+ searchable?: boolean;
18675
+ siteSpecific?: boolean;
18676
+ system?: boolean;
18677
+ unit?: L10nString$4;
18678
+ possibleValues?: Array<PropertyValueDefinition$4>;
18679
+ type: string;
18680
+ visible?: boolean;
17945
18681
  } & {
17946
18682
  [key: string]: any;
17947
18683
  };
18684
+ type LocalizedString = {} & {
18685
+ [key: string]: any;
18686
+ };
17948
18687
  type PaginatedSearchResult = {
17949
- query: any;
18688
+ query: Query$5;
17950
18689
  sorts?: Array<Sort$5>;
17951
18690
  limit: number;
17952
18691
  hits?: Array<object>;
17953
- offset: number;
17954
- total: number;
18692
+ offset: any;
18693
+ total: any;
17955
18694
  } & {
17956
18695
  [key: string]: any;
17957
18696
  };
@@ -17966,18 +18705,18 @@ declare namespace ShopperOrdersTypes {
17966
18705
  [key: string]: any;
17967
18706
  };
17968
18707
  type BoolFilter = {
17969
- filters?: Array<any>;
18708
+ filters?: Array<Filter$5>;
17970
18709
  operator: string;
17971
18710
  } & {
17972
18711
  [key: string]: any;
17973
18712
  };
17974
18713
  type PaginatedSearchResultBase = {
17975
- query: any;
18714
+ query: Query$5;
17976
18715
  sorts?: Array<Sort$5>;
17977
18716
  limit: number;
17978
18717
  hits?: Array<object>;
17979
- offset: number;
17980
- total: number;
18718
+ offset: any;
18719
+ total: any;
17981
18720
  } & {
17982
18721
  [key: string]: any;
17983
18722
  };
@@ -17985,13 +18724,13 @@ declare namespace ShopperOrdersTypes {
17985
18724
  [key: string]: any;
17986
18725
  };
17987
18726
  type FilteredQuery = {
17988
- filter: any;
17989
- query: any;
18727
+ filter: Filter$5;
18728
+ query: Query$5;
17990
18729
  } & {
17991
18730
  [key: string]: any;
17992
18731
  };
17993
18732
  type QueryFilter = {
17994
- query: any;
18733
+ query: Query$5;
17995
18734
  } & {
17996
18735
  [key: string]: any;
17997
18736
  };
@@ -18037,23 +18776,23 @@ declare namespace ShopperOrdersTypes {
18037
18776
  [key: string]: any;
18038
18777
  };
18039
18778
  type BoolQuery = {
18040
- must?: Array<any>;
18041
- mustNot?: Array<any>;
18042
- should?: Array<any>;
18779
+ must?: Array<Query>;
18780
+ mustNot?: Array<Query>;
18781
+ should?: Array<Query>;
18043
18782
  } & {
18044
18783
  [key: string]: any;
18045
18784
  };
18046
18785
  type SimpleSearchResultBase = {
18047
18786
  limit: number;
18048
18787
  hits?: Array<object>;
18049
- offset: number;
18050
- total: number;
18788
+ offset: any;
18789
+ total: any;
18051
18790
  } & {
18052
18791
  [key: string]: any;
18053
18792
  };
18054
18793
  type NestedQuery = {
18055
18794
  path: string;
18056
- query: any;
18795
+ query: Query;
18057
18796
  scoreMode?: string;
18058
18797
  } & {
18059
18798
  [key: string]: any;
@@ -18084,9 +18823,9 @@ declare namespace ShopperOrdersTypes {
18084
18823
  };
18085
18824
  type SearchRequestBase = {
18086
18825
  limit?: number;
18087
- query: any;
18826
+ query: Query;
18088
18827
  sorts?: Array<Sort>;
18089
- offset?: number;
18828
+ offset?: any;
18090
18829
  } & {
18091
18830
  [key: string]: any;
18092
18831
  };
@@ -18096,6 +18835,38 @@ declare namespace ShopperOrdersTypes {
18096
18835
  } & {
18097
18836
  [key: string]: any;
18098
18837
  };
18838
+ type L10nString = {} & {
18839
+ [key: string]: any;
18840
+ };
18841
+ type AttributeDefinition = {
18842
+ defaultValue?: PropertyValueDefinition$4;
18843
+ id?: string;
18844
+ name: L10nString;
18845
+ description: L10nString;
18846
+ key?: boolean;
18847
+ localizable?: boolean;
18848
+ mandatory?: boolean;
18849
+ max?: number;
18850
+ minLength?: number;
18851
+ min?: number;
18852
+ multiValueType?: boolean;
18853
+ regularExpression?: string;
18854
+ scale?: number;
18855
+ searchable?: boolean;
18856
+ siteSpecific?: boolean;
18857
+ system?: boolean;
18858
+ unit?: L10nString;
18859
+ possibleValues?: Array<PropertyValueDefinition$4>;
18860
+ type: string;
18861
+ visible?: boolean;
18862
+ };
18863
+ type PropertyValueDefinition = {
18864
+ description: L10nString;
18865
+ displayValue: L10nString;
18866
+ id: string;
18867
+ position?: number;
18868
+ value: string;
18869
+ };
18099
18870
  type TaxItems = {
18100
18871
  taxItems?: Array<TaxItem$0>;
18101
18872
  } & {
@@ -18591,7 +19362,7 @@ declare namespace ShopperOrdersTypes {
18591
19362
  * ```
18592
19363
  *
18593
19364
  * <span style="font-size:.7em; display:block; text-align: right">
18594
- * API Version: 0.2.0<br />
19365
+ * API Version: 0.3.1<br />
18595
19366
  * Last Updated: <br />
18596
19367
  * </span>
18597
19368
 
@@ -18614,7 +19385,12 @@ declare namespace ShopperOrdersTypes {
18614
19385
  * @param parameters - An object containing the parameters for this method.
18615
19386
  * @param organizationId - An identifier for the organization the request is being made by.
18616
19387
  * @param siteId -
18617
- * @param locale -
19388
+ * @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.
19389
+ Below are some valid examples:
19390
+ - en-US
19391
+ - de-AT
19392
+ - de
19393
+ - default
18618
19394
  * @param headers - An object literal of key value pairs of the headers to be
18619
19395
  * sent with this request.
18620
19396
  * @param body - The data to send as the request body.
@@ -18640,7 +19416,12 @@ declare namespace ShopperOrdersTypes {
18640
19416
  * @param parameters - An object containing the parameters for this method.
18641
19417
  * @param organizationId - An identifier for the organization the request is being made by.
18642
19418
  * @param siteId -
18643
- * @param locale -
19419
+ * @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.
19420
+ Below are some valid examples:
19421
+ - en-US
19422
+ - de-AT
19423
+ - de
19424
+ - default
18644
19425
  * @param headers - An object literal of key value pairs of the headers to be
18645
19426
  * sent with this request.
18646
19427
  * @param body - The data to send as the request body.
@@ -18669,7 +19450,12 @@ declare namespace ShopperOrdersTypes {
18669
19450
  * @param organizationId - An identifier for the organization the request is being made by.
18670
19451
  * @param orderNo - The order number of the order to be modified.
18671
19452
  * @param siteId -
18672
- * @param locale -
19453
+ * @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.
19454
+ Below are some valid examples:
19455
+ - en-US
19456
+ - de-AT
19457
+ - de
19458
+ - default
18673
19459
  * @param headers - An object literal of key value pairs of the headers to be
18674
19460
  * sent with this request.
18675
19461
  *
@@ -18695,7 +19481,12 @@ declare namespace ShopperOrdersTypes {
18695
19481
  * @param organizationId - An identifier for the organization the request is being made by.
18696
19482
  * @param orderNo - The order number of the order to be modified.
18697
19483
  * @param siteId -
18698
- * @param locale -
19484
+ * @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.
19485
+ Below are some valid examples:
19486
+ - en-US
19487
+ - de-AT
19488
+ - de
19489
+ - default
18699
19490
  * @param headers - An object literal of key value pairs of the headers to be
18700
19491
  * sent with this request.
18701
19492
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -18728,7 +19519,12 @@ declare namespace ShopperOrdersTypes {
18728
19519
  * @param organizationId - An identifier for the organization the request is being made by.
18729
19520
  * @param orderNo - The order number of the order to be modified.
18730
19521
  * @param siteId -
18731
- * @param locale -
19522
+ * @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.
19523
+ Below are some valid examples:
19524
+ - en-US
19525
+ - de-AT
19526
+ - de
19527
+ - default
18732
19528
  * @param headers - An object literal of key value pairs of the headers to be
18733
19529
  * sent with this request.
18734
19530
  * @param body - The data to send as the request body.
@@ -18761,7 +19557,12 @@ declare namespace ShopperOrdersTypes {
18761
19557
  * @param organizationId - An identifier for the organization the request is being made by.
18762
19558
  * @param orderNo - The order number of the order to be modified.
18763
19559
  * @param siteId -
18764
- * @param locale -
19560
+ * @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.
19561
+ Below are some valid examples:
19562
+ - en-US
19563
+ - de-AT
19564
+ - de
19565
+ - default
18765
19566
  * @param headers - An object literal of key value pairs of the headers to be
18766
19567
  * sent with this request.
18767
19568
  * @param body - The data to send as the request body.
@@ -18792,7 +19593,12 @@ declare namespace ShopperOrdersTypes {
18792
19593
  * @param orderNo - The order number of the order to be modified.
18793
19594
  * @param paymentInstrumentId - The ID of the payment instrument to be updated.
18794
19595
  * @param siteId -
18795
- * @param locale -
19596
+ * @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.
19597
+ Below are some valid examples:
19598
+ - en-US
19599
+ - de-AT
19600
+ - de
19601
+ - default
18796
19602
  * @param headers - An object literal of key value pairs of the headers to be
18797
19603
  * sent with this request.
18798
19604
  *
@@ -18820,7 +19626,12 @@ declare namespace ShopperOrdersTypes {
18820
19626
  * @param orderNo - The order number of the order to be modified.
18821
19627
  * @param paymentInstrumentId - The ID of the payment instrument to be updated.
18822
19628
  * @param siteId -
18823
- * @param locale -
19629
+ * @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.
19630
+ Below are some valid examples:
19631
+ - en-US
19632
+ - de-AT
19633
+ - de
19634
+ - default
18824
19635
  * @param headers - An object literal of key value pairs of the headers to be
18825
19636
  * sent with this request.
18826
19637
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -18856,7 +19667,12 @@ declare namespace ShopperOrdersTypes {
18856
19667
  * @param orderNo - The order number of the order to be modified.
18857
19668
  * @param paymentInstrumentId - The ID of the payment instrument to be updated.
18858
19669
  * @param siteId -
18859
- * @param locale -
19670
+ * @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.
19671
+ Below are some valid examples:
19672
+ - en-US
19673
+ - de-AT
19674
+ - de
19675
+ - default
18860
19676
  * @param headers - An object literal of key value pairs of the headers to be
18861
19677
  * sent with this request.
18862
19678
  * @param body - The data to send as the request body.
@@ -18892,7 +19708,12 @@ declare namespace ShopperOrdersTypes {
18892
19708
  * @param orderNo - The order number of the order to be modified.
18893
19709
  * @param paymentInstrumentId - The ID of the payment instrument to be updated.
18894
19710
  * @param siteId -
18895
- * @param locale -
19711
+ * @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.
19712
+ Below are some valid examples:
19713
+ - en-US
19714
+ - de-AT
19715
+ - de
19716
+ - default
18896
19717
  * @param headers - An object literal of key value pairs of the headers to be
18897
19718
  * sent with this request.
18898
19719
  * @param body - The data to send as the request body.
@@ -18923,7 +19744,12 @@ declare namespace ShopperOrdersTypes {
18923
19744
  * @param organizationId - An identifier for the organization the request is being made by.
18924
19745
  * @param orderNo - The order number of the order to be modified.
18925
19746
  * @param siteId -
18926
- * @param locale -
19747
+ * @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.
19748
+ Below are some valid examples:
19749
+ - en-US
19750
+ - de-AT
19751
+ - de
19752
+ - default
18927
19753
  * @param headers - An object literal of key value pairs of the headers to be
18928
19754
  * sent with this request.
18929
19755
  *
@@ -18949,7 +19775,12 @@ declare namespace ShopperOrdersTypes {
18949
19775
  * @param organizationId - An identifier for the organization the request is being made by.
18950
19776
  * @param orderNo - The order number of the order to be modified.
18951
19777
  * @param siteId -
18952
- * @param locale -
19778
+ * @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.
19779
+ Below are some valid examples:
19780
+ - en-US
19781
+ - de-AT
19782
+ - de
19783
+ - default
18953
19784
  * @param headers - An object literal of key value pairs of the headers to be
18954
19785
  * sent with this request.
18955
19786
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -19211,6 +20042,7 @@ type Product$0 = {
19211
20042
  recommendations?: Array<Recommendation$0>;
19212
20043
  setProducts?: Array<Product$0>;
19213
20044
  shortDescription?: string;
20045
+ slugUrl?: string;
19214
20046
  stepQuantity?: number;
19215
20047
  tieredPrices?: Array<ProductPriceTable>;
19216
20048
  type?: ProductType$0;
@@ -19265,6 +20097,39 @@ type BundledProduct$0 = {
19265
20097
  } & {
19266
20098
  [key: string]: any;
19267
20099
  };
20100
+ type RangeFilter$6 = {
20101
+ [key: string]: any;
20102
+ };
20103
+ type BoolFilter$6 = {
20104
+ filters?: Array<Filter$5>;
20105
+ operator: string;
20106
+ } & {
20107
+ [key: string]: any;
20108
+ };
20109
+ type MatchAllQuery$6 = {} & {
20110
+ [key: string]: any;
20111
+ };
20112
+ type FilteredQuery$6 = {
20113
+ filter: Filter$5;
20114
+ query: Query$5;
20115
+ } & {
20116
+ [key: string]: any;
20117
+ };
20118
+ type QueryFilter$6 = {
20119
+ query: Query$5;
20120
+ } & {
20121
+ [key: string]: any;
20122
+ };
20123
+ type Query$6 = {
20124
+ boolQuery?: BoolQuery$5;
20125
+ filteredQuery?: FilteredQuery$6;
20126
+ matchAllQuery?: MatchAllQuery$6;
20127
+ nestedQuery?: NestedQuery$5;
20128
+ termQuery?: TermQuery$5;
20129
+ textQuery?: TextQuery$5;
20130
+ } & {
20131
+ [key: string]: any;
20132
+ };
19268
20133
  type TermQuery$6 = {
19269
20134
  fields: Array<string>;
19270
20135
  operator: string;
@@ -19272,38 +20137,65 @@ type TermQuery$6 = {
19272
20137
  } & {
19273
20138
  [key: string]: any;
19274
20139
  };
20140
+ type TermFilter$6 = {
20141
+ field: string;
20142
+ operator: string;
20143
+ values?: Array<any>;
20144
+ } & {
20145
+ [key: string]: any;
20146
+ };
19275
20147
  type TextQuery$6 = {
19276
20148
  fields: Array<string>;
19277
20149
  searchPhrase: string;
19278
20150
  } & {
19279
20151
  [key: string]: any;
19280
20152
  };
20153
+ type Range2Filter$6 = {
20154
+ filterMode?: string;
20155
+ fromField: string;
20156
+ fromInclusive?: boolean;
20157
+ fromValue?: any;
20158
+ toField: string;
20159
+ toInclusive?: boolean;
20160
+ toValue?: any;
20161
+ } & {
20162
+ [key: string]: any;
20163
+ };
19281
20164
  type BoolQuery$6 = {
19282
- must?: Array<any>;
19283
- mustNot?: Array<any>;
19284
- should?: Array<any>;
20165
+ must?: Array<Query$6>;
20166
+ mustNot?: Array<Query$6>;
20167
+ should?: Array<Query$6>;
19285
20168
  } & {
19286
20169
  [key: string]: any;
19287
20170
  };
19288
20171
  type NestedQuery$6 = {
19289
20172
  path: string;
19290
- query: any;
20173
+ query: Query$6;
19291
20174
  scoreMode?: string;
19292
20175
  } & {
19293
20176
  [key: string]: any;
19294
20177
  };
20178
+ type Filter$6 = {
20179
+ boolFilter?: BoolFilter$6;
20180
+ queryFilter?: QueryFilter$6;
20181
+ range2Filter?: Range2Filter$6;
20182
+ rangeFilter?: RangeFilter$6;
20183
+ termFilter?: TermFilter$6;
20184
+ } & {
20185
+ [key: string]: any;
20186
+ };
19295
20187
  type Sort$6 = {
19296
20188
  field: string;
19297
20189
  sortOrder?: string;
19298
20190
  } & {
19299
20191
  [key: string]: any;
19300
20192
  };
19301
- type L10nString$3 = {} & {
20193
+ type L10nString$5 = {} & {
19302
20194
  [key: string]: any;
19303
20195
  };
19304
- type PropertyValueDefinition$3 = {
19305
- description: L10nString$3;
19306
- displayValue: L10nString$3;
20196
+ type PropertyValueDefinition$5 = {
20197
+ description: L10nString$5;
20198
+ displayValue: L10nString$5;
19307
20199
  id: string;
19308
20200
  position?: number;
19309
20201
  value: string;
@@ -19322,6 +20214,7 @@ type ShopperProductsQueryParameters = {
19322
20214
  ids?: string;
19323
20215
  inventoryIds?: string;
19324
20216
  currency?: string;
20217
+ expand?: string;
19325
20218
  locale?: string;
19326
20219
  allImages?: boolean;
19327
20220
  perPricebook?: boolean;
@@ -19355,7 +20248,7 @@ type ShopperProductsParameters = ShopperProductsPathParameters & BaseUriParamete
19355
20248
  * ```
19356
20249
  *
19357
20250
  * <span style="font-size:.7em; display:block; text-align: right">
19358
- * API Version: 0.0.19<br />
20251
+ * API Version: 0.0.24<br />
19359
20252
  * Last Updated: <br />
19360
20253
  * </span>
19361
20254
 
@@ -19370,7 +20263,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19370
20263
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-products/{version}";
19371
20264
  constructor(config: ClientConfigInit<ConfigParameters>);
19372
20265
  /**
19373
- * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, images, price, promotions, and variations for the valid products will be included, as appropriate.
20266
+ * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
19374
20267
  *
19375
20268
  * If you would like to get a raw Response object use the other getProducts function.
19376
20269
  *
@@ -19380,6 +20273,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19380
20273
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
19381
20274
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
19382
20275
  * @param currency - The currency mnemonic specified for price.
20276
+ * @param expand - The expand parameter. A comma separated list with the allowed values (availability, links, promotions, options, images, prices, variations, 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.
19383
20277
  * @param locale - The locale context.
19384
20278
  * @param allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
19385
20279
  * @param perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
@@ -19396,6 +20290,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19396
20290
  ids: string;
19397
20291
  inventoryIds?: string;
19398
20292
  currency?: string;
20293
+ expand?: string;
19399
20294
  locale?: string;
19400
20295
  allImages?: boolean;
19401
20296
  perPricebook?: boolean;
@@ -19406,7 +20301,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19406
20301
  };
19407
20302
  }>): Promise<ProductResult>;
19408
20303
  /**
19409
- * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, images, price, promotions, and variations for the valid products will be included, as appropriate.
20304
+ * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
19410
20305
  *
19411
20306
  * @param options - An object containing the options for this method.
19412
20307
  * @param parameters - An object containing the parameters for this method.
@@ -19414,6 +20309,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19414
20309
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
19415
20310
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
19416
20311
  * @param currency - The currency mnemonic specified for price.
20312
+ * @param expand - The expand parameter. A comma separated list with the allowed values (availability, links, promotions, options, images, prices, variations, 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.
19417
20313
  * @param locale - The locale context.
19418
20314
  * @param allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
19419
20315
  * @param perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
@@ -19430,6 +20326,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19430
20326
  ids: string;
19431
20327
  inventoryIds?: string;
19432
20328
  currency?: string;
20329
+ expand?: string;
19433
20330
  locale?: string;
19434
20331
  allImages?: boolean;
19435
20332
  perPricebook?: boolean;
@@ -19450,6 +20347,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19450
20347
  * @param id - The ID of the requested product.
19451
20348
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
19452
20349
  * @param currency - The currency mnemonic specified for price.
20350
+ * @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.
19453
20351
  * @param locale - The locale context.
19454
20352
  * @param allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
19455
20353
  * @param perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
@@ -19466,6 +20364,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19466
20364
  id: string;
19467
20365
  inventoryIds?: string;
19468
20366
  currency?: string;
20367
+ expand?: string;
19469
20368
  locale?: string;
19470
20369
  allImages?: boolean;
19471
20370
  perPricebook?: boolean;
@@ -19484,6 +20383,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19484
20383
  * @param id - The ID of the requested product.
19485
20384
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
19486
20385
  * @param currency - The currency mnemonic specified for price.
20386
+ * @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.
19487
20387
  * @param locale - The locale context.
19488
20388
  * @param allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
19489
20389
  * @param perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
@@ -19500,6 +20400,7 @@ declare class ShopperProducts<ConfigParameters extends ShopperProductsParameters
19500
20400
  id: string;
19501
20401
  inventoryIds?: string;
19502
20402
  currency?: string;
20403
+ expand?: string;
19503
20404
  locale?: string;
19504
20405
  allImages?: boolean;
19505
20406
  perPricebook?: boolean;
@@ -19895,6 +20796,7 @@ declare namespace ShopperProductsTypes {
19895
20796
  recommendations?: Array<Recommendation>;
19896
20797
  setProducts?: Array<Product>;
19897
20798
  shortDescription?: string;
20799
+ slugUrl?: string;
19898
20800
  stepQuantity?: number;
19899
20801
  tieredPrices?: Array<ProductPriceTable>;
19900
20802
  type?: ProductType;
@@ -20000,17 +20902,17 @@ declare namespace ShopperProductsTypes {
20000
20902
  };
20001
20903
  type SearchRequest = {
20002
20904
  limit?: number;
20003
- query: any;
20905
+ query: Query$6;
20004
20906
  sorts?: Array<Sort$6>;
20005
20907
  offset?: any;
20006
20908
  } & {
20007
20909
  [key: string]: any;
20008
20910
  };
20009
20911
  type PropertyDefinition = {
20010
- defaultValue?: PropertyValueDefinition$3;
20912
+ defaultValue?: PropertyValueDefinition$5;
20011
20913
  id?: string;
20012
- name: L10nString$3;
20013
- description: L10nString$3;
20914
+ name: L10nString$5;
20915
+ description: L10nString$5;
20014
20916
  key?: boolean;
20015
20917
  localizable?: boolean;
20016
20918
  mandatory?: boolean;
@@ -20023,8 +20925,8 @@ declare namespace ShopperProductsTypes {
20023
20925
  searchable?: boolean;
20024
20926
  siteSpecific?: boolean;
20025
20927
  system?: boolean;
20026
- unit?: L10nString$3;
20027
- possibleValues?: Array<PropertyValueDefinition$3>;
20928
+ unit?: L10nString$5;
20929
+ possibleValues?: Array<PropertyValueDefinition$5>;
20028
20930
  type: string;
20029
20931
  visible?: boolean;
20030
20932
  } & {
@@ -20034,7 +20936,7 @@ declare namespace ShopperProductsTypes {
20034
20936
  [key: string]: any;
20035
20937
  };
20036
20938
  type PaginatedSearchResult = {
20037
- query: any;
20939
+ query: Query$6;
20038
20940
  sorts?: Array<Sort$6>;
20039
20941
  limit: number;
20040
20942
  hits?: Array<object>;
@@ -20054,13 +20956,13 @@ declare namespace ShopperProductsTypes {
20054
20956
  [key: string]: any;
20055
20957
  };
20056
20958
  type BoolFilter = {
20057
- filters?: Array<any>;
20959
+ filters?: Array<Filter$6>;
20058
20960
  operator: string;
20059
20961
  } & {
20060
20962
  [key: string]: any;
20061
20963
  };
20062
20964
  type PaginatedSearchResultBase = {
20063
- query: any;
20965
+ query: Query$6;
20064
20966
  sorts?: Array<Sort$6>;
20065
20967
  limit: number;
20066
20968
  hits?: Array<object>;
@@ -20073,13 +20975,13 @@ declare namespace ShopperProductsTypes {
20073
20975
  [key: string]: any;
20074
20976
  };
20075
20977
  type FilteredQuery = {
20076
- filter: any;
20077
- query: any;
20978
+ filter: Filter$6;
20979
+ query: Query$6;
20078
20980
  } & {
20079
20981
  [key: string]: any;
20080
20982
  };
20081
20983
  type QueryFilter = {
20082
- query: any;
20984
+ query: Query$6;
20083
20985
  } & {
20084
20986
  [key: string]: any;
20085
20987
  };
@@ -20125,9 +21027,9 @@ declare namespace ShopperProductsTypes {
20125
21027
  [key: string]: any;
20126
21028
  };
20127
21029
  type BoolQuery = {
20128
- must?: Array<any>;
20129
- mustNot?: Array<any>;
20130
- should?: Array<any>;
21030
+ must?: Array<Query>;
21031
+ mustNot?: Array<Query>;
21032
+ should?: Array<Query>;
20131
21033
  } & {
20132
21034
  [key: string]: any;
20133
21035
  };
@@ -20141,7 +21043,7 @@ declare namespace ShopperProductsTypes {
20141
21043
  };
20142
21044
  type NestedQuery = {
20143
21045
  path: string;
20144
- query: any;
21046
+ query: Query;
20145
21047
  scoreMode?: string;
20146
21048
  } & {
20147
21049
  [key: string]: any;
@@ -20163,7 +21065,7 @@ declare namespace ShopperProductsTypes {
20163
21065
  };
20164
21066
  type SearchRequestBase = {
20165
21067
  limit?: number;
20166
- query: any;
21068
+ query: Query;
20167
21069
  sorts?: Array<Sort>;
20168
21070
  offset?: any;
20169
21071
  } & {
@@ -20179,7 +21081,7 @@ declare namespace ShopperProductsTypes {
20179
21081
  [key: string]: any;
20180
21082
  };
20181
21083
  type AttributeDefinition = {
20182
- defaultValue?: PropertyValueDefinition$3;
21084
+ defaultValue?: PropertyValueDefinition$5;
20183
21085
  id?: string;
20184
21086
  name: L10nString;
20185
21087
  description: L10nString;
@@ -20196,7 +21098,7 @@ declare namespace ShopperProductsTypes {
20196
21098
  siteSpecific?: boolean;
20197
21099
  system?: boolean;
20198
21100
  unit?: L10nString;
20199
- possibleValues?: Array<PropertyValueDefinition$3>;
21101
+ possibleValues?: Array<PropertyValueDefinition$5>;
20200
21102
  type: string;
20201
21103
  visible?: boolean;
20202
21104
  };
@@ -20221,6 +21123,7 @@ declare namespace ShopperProductsTypes {
20221
21123
  ids?: string;
20222
21124
  inventoryIds?: string;
20223
21125
  currency?: string;
21126
+ expand?: string;
20224
21127
  locale?: string;
20225
21128
  allImages?: boolean;
20226
21129
  perPricebook?: boolean;
@@ -20254,7 +21157,7 @@ declare namespace ShopperProductsTypes {
20254
21157
  * ```
20255
21158
  *
20256
21159
  * <span style="font-size:.7em; display:block; text-align: right">
20257
- * API Version: 0.0.19<br />
21160
+ * API Version: 0.0.24<br />
20258
21161
  * Last Updated: <br />
20259
21162
  * </span>
20260
21163
 
@@ -20269,7 +21172,7 @@ declare namespace ShopperProductsTypes {
20269
21172
  static readonly defaultBaseUri = "https://{shortCode}.api.commercecloud.salesforce.com/product/shopper-products/{version}";
20270
21173
  constructor(config: ClientConfigInit<ConfigParameters>);
20271
21174
  /**
20272
- * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, images, price, promotions, and variations for the valid products will be included, as appropriate.
21175
+ * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
20273
21176
  *
20274
21177
  * If you would like to get a raw Response object use the other getProducts function.
20275
21178
  *
@@ -20279,6 +21182,7 @@ declare namespace ShopperProductsTypes {
20279
21182
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
20280
21183
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
20281
21184
  * @param currency - The currency mnemonic specified for price.
21185
+ * @param expand - The expand parameter. A comma separated list with the allowed values (availability, links, promotions, options, images, prices, variations, 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.
20282
21186
  * @param locale - The locale context.
20283
21187
  * @param allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
20284
21188
  * @param perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
@@ -20295,6 +21199,7 @@ declare namespace ShopperProductsTypes {
20295
21199
  ids: string;
20296
21200
  inventoryIds?: string;
20297
21201
  currency?: string;
21202
+ expand?: string;
20298
21203
  locale?: string;
20299
21204
  allImages?: boolean;
20300
21205
  perPricebook?: boolean;
@@ -20305,7 +21210,7 @@ declare namespace ShopperProductsTypes {
20305
21210
  };
20306
21211
  }>): Promise<ProductResult>;
20307
21212
  /**
20308
- * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, images, price, promotions, and variations for the valid products will be included, as appropriate.
21213
+ * Allows access to multiple products by a single request. Only products that are online and assigned to a site catalog are returned. The maximum number of productIDs that can be requested are 24. Along with product details, the availability, product options, images, price, promotions, and variations for the valid products will be included, as appropriate.
20309
21214
  *
20310
21215
  * @param options - An object containing the options for this method.
20311
21216
  * @param parameters - An object containing the parameters for this method.
@@ -20313,6 +21218,7 @@ declare namespace ShopperProductsTypes {
20313
21218
  * @param ids - The IDs of the requested products (comma-separated, max 24 IDs).
20314
21219
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
20315
21220
  * @param currency - The currency mnemonic specified for price.
21221
+ * @param expand - The expand parameter. A comma separated list with the allowed values (availability, links, promotions, options, images, prices, variations, 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.
20316
21222
  * @param locale - The locale context.
20317
21223
  * @param allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
20318
21224
  * @param perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
@@ -20329,6 +21235,7 @@ declare namespace ShopperProductsTypes {
20329
21235
  ids: string;
20330
21236
  inventoryIds?: string;
20331
21237
  currency?: string;
21238
+ expand?: string;
20332
21239
  locale?: string;
20333
21240
  allImages?: boolean;
20334
21241
  perPricebook?: boolean;
@@ -20349,6 +21256,7 @@ declare namespace ShopperProductsTypes {
20349
21256
  * @param id - The ID of the requested product.
20350
21257
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
20351
21258
  * @param currency - The currency mnemonic specified for price.
21259
+ * @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.
20352
21260
  * @param locale - The locale context.
20353
21261
  * @param allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
20354
21262
  * @param perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
@@ -20365,6 +21273,7 @@ declare namespace ShopperProductsTypes {
20365
21273
  id: string;
20366
21274
  inventoryIds?: string;
20367
21275
  currency?: string;
21276
+ expand?: string;
20368
21277
  locale?: string;
20369
21278
  allImages?: boolean;
20370
21279
  perPricebook?: boolean;
@@ -20383,6 +21292,7 @@ declare namespace ShopperProductsTypes {
20383
21292
  * @param id - The ID of the requested product.
20384
21293
  * @param inventoryIds - The optional inventory list IDs, for which the availability should be shown (comma-separated, max 5 inventoryListIDs).
20385
21294
  * @param currency - The currency mnemonic specified for price.
21295
+ * @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.
20386
21296
  * @param locale - The locale context.
20387
21297
  * @param allImages - The flag that indicates whether to retrieve the whole image model for the requested product.
20388
21298
  * @param perPricebook - The flag that indicates whether to retrieve the per PriceBook prices and tiered prices (if available) for requested Products. Available end of June, 2021.
@@ -20399,6 +21309,7 @@ declare namespace ShopperProductsTypes {
20399
21309
  id: string;
20400
21310
  inventoryIds?: string;
20401
21311
  currency?: string;
21312
+ expand?: string;
20402
21313
  locale?: string;
20403
21314
  allImages?: boolean;
20404
21315
  perPricebook?: boolean;
@@ -20582,12 +21493,12 @@ type Sort$7 = {
20582
21493
  } & {
20583
21494
  [key: string]: any;
20584
21495
  };
20585
- type L10nString$4 = {} & {
20586
- [key: string]: any;
20587
- };
20588
- type PropertyValueDefinition$4 = {
20589
- description: L10nString$4;
20590
- displayValue: L10nString$4;
21496
+ type L10nString$6 = {} & {
21497
+ [key: string]: any;
21498
+ };
21499
+ type PropertyValueDefinition$6 = {
21500
+ description: L10nString$6;
21501
+ displayValue: L10nString$6;
20591
21502
  id: string;
20592
21503
  position?: number;
20593
21504
  value: string;
@@ -20930,10 +21841,10 @@ declare namespace ShopperPromotionsTypes {
20930
21841
  [key: string]: any;
20931
21842
  };
20932
21843
  type PropertyDefinition = {
20933
- defaultValue?: PropertyValueDefinition$4;
21844
+ defaultValue?: PropertyValueDefinition$6;
20934
21845
  id?: string;
20935
- name: L10nString$4;
20936
- description: L10nString$4;
21846
+ name: L10nString$6;
21847
+ description: L10nString$6;
20937
21848
  key?: boolean;
20938
21849
  localizable?: boolean;
20939
21850
  mandatory?: boolean;
@@ -20946,8 +21857,8 @@ declare namespace ShopperPromotionsTypes {
20946
21857
  searchable?: boolean;
20947
21858
  siteSpecific?: boolean;
20948
21859
  system?: boolean;
20949
- unit?: L10nString$4;
20950
- possibleValues?: Array<PropertyValueDefinition$4>;
21860
+ unit?: L10nString$6;
21861
+ possibleValues?: Array<PropertyValueDefinition$6>;
20951
21862
  type: string;
20952
21863
  visible?: boolean;
20953
21864
  } & {
@@ -21102,7 +22013,7 @@ declare namespace ShopperPromotionsTypes {
21102
22013
  [key: string]: any;
21103
22014
  };
21104
22015
  type AttributeDefinition = {
21105
- defaultValue?: PropertyValueDefinition$4;
22016
+ defaultValue?: PropertyValueDefinition$6;
21106
22017
  id?: string;
21107
22018
  name: L10nString;
21108
22019
  description: L10nString;
@@ -21119,7 +22030,7 @@ declare namespace ShopperPromotionsTypes {
21119
22030
  siteSpecific?: boolean;
21120
22031
  system?: boolean;
21121
22032
  unit?: L10nString;
21122
- possibleValues?: Array<PropertyValueDefinition$4>;
22033
+ possibleValues?: Array<PropertyValueDefinition$6>;
21123
22034
  type: string;
21124
22035
  visible?: boolean;
21125
22036
  };
@@ -21357,6 +22268,16 @@ type RangeFilter$8 = {
21357
22268
  } & {
21358
22269
  [key: string]: any;
21359
22270
  };
22271
+ type L10nString$7 = {} & {
22272
+ [key: string]: any;
22273
+ };
22274
+ type PropertyValueDefinition$7 = {
22275
+ description: L10nString$7;
22276
+ displayValue: L10nString$7;
22277
+ id: string;
22278
+ position?: number;
22279
+ value: string;
22280
+ };
21360
22281
  type ProductRef = {
21361
22282
  id: string;
21362
22283
  } & {
@@ -21377,7 +22298,6 @@ type CategorySuggestions = {
21377
22298
  };
21378
22299
  type SuggestedProduct = {
21379
22300
  currency: string;
21380
- image?: Image$0;
21381
22301
  price: number;
21382
22302
  productId: string;
21383
22303
  productName: string;
@@ -21547,6 +22467,7 @@ type ShopperSearchQueryParameters = {
21547
22467
  sort?: string;
21548
22468
  currency?: string;
21549
22469
  locale?: string;
22470
+ expand?: Array<string>;
21550
22471
  offset?: any;
21551
22472
  limit?: number;
21552
22473
  };
@@ -21577,7 +22498,7 @@ type ShopperSearchParameters = ShopperSearchPathParameters & BaseUriParameters &
21577
22498
  * ```
21578
22499
  *
21579
22500
  * <span style="font-size:.7em; display:block; text-align: right">
21580
- * API Version: 1.0.24<br />
22501
+ * API Version: 1.0.29<br />
21581
22502
  * Last Updated: <br />
21582
22503
  * </span>
21583
22504
 
@@ -21611,11 +22532,12 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
21611
22532
  cgid: Allows refinement per single category ID. Multiple category ids are not supported.
21612
22533
  price: Allows refinement per single price range. Multiple price ranges are not supported.
21613
22534
  pmid: Allows refinement per promotion ID.
21614
- htypes: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
22535
+ htype: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
21615
22536
  orderable_only: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.
21616
22537
  * @param sort - The ID of the sorting option to sort the search hits.
21617
22538
  * @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
21618
22539
  * @param locale -
22540
+ * @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations). If the parameter is missing all the values will be returned.
21619
22541
  * @param offset -
21620
22542
  * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
21621
22543
  * @param headers - An object literal of key value pairs of the headers to be
@@ -21633,6 +22555,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
21633
22555
  sort?: string;
21634
22556
  currency?: string;
21635
22557
  locale?: string;
22558
+ expand?: Array<string>;
21636
22559
  offset?: any;
21637
22560
  limit?: number;
21638
22561
  }, ConfigParameters>;
@@ -21658,11 +22581,12 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
21658
22581
  cgid: Allows refinement per single category ID. Multiple category ids are not supported.
21659
22582
  price: Allows refinement per single price range. Multiple price ranges are not supported.
21660
22583
  pmid: Allows refinement per promotion ID.
21661
- htypes: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
22584
+ htype: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
21662
22585
  orderable_only: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.
21663
22586
  * @param sort - The ID of the sorting option to sort the search hits.
21664
22587
  * @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
21665
22588
  * @param locale -
22589
+ * @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations). If the parameter is missing all the values will be returned.
21666
22590
  * @param offset -
21667
22591
  * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
21668
22592
  * @param headers - An object literal of key value pairs of the headers to be
@@ -21680,6 +22604,7 @@ declare class ShopperSearch<ConfigParameters extends ShopperSearchParameters & R
21680
22604
  sort?: string;
21681
22605
  currency?: string;
21682
22606
  locale?: string;
22607
+ expand?: Array<string>;
21683
22608
  offset?: any;
21684
22609
  limit?: number;
21685
22610
  }, ConfigParameters>;
@@ -21849,6 +22774,33 @@ declare namespace ShopperSearchTypes {
21849
22774
  } & {
21850
22775
  [key: string]: any;
21851
22776
  };
22777
+ type PropertyDefinition = {
22778
+ defaultValue?: PropertyValueDefinition$7;
22779
+ id?: string;
22780
+ name: L10nString$7;
22781
+ description: L10nString$7;
22782
+ key?: boolean;
22783
+ localizable?: boolean;
22784
+ mandatory?: boolean;
22785
+ max?: number;
22786
+ minLength?: number;
22787
+ min?: number;
22788
+ multiValueType?: boolean;
22789
+ regularExpression?: string;
22790
+ scale?: number;
22791
+ searchable?: boolean;
22792
+ siteSpecific?: boolean;
22793
+ system?: boolean;
22794
+ unit?: L10nString$7;
22795
+ possibleValues?: Array<PropertyValueDefinition$7>;
22796
+ type: string;
22797
+ visible?: boolean;
22798
+ } & {
22799
+ [key: string]: any;
22800
+ };
22801
+ type LocalizedString = {} & {
22802
+ [key: string]: any;
22803
+ };
21852
22804
  type PaginatedSearchResult = {
21853
22805
  query: any;
21854
22806
  sorts?: Array<Sort$8>;
@@ -22000,6 +22952,38 @@ declare namespace ShopperSearchTypes {
22000
22952
  } & {
22001
22953
  [key: string]: any;
22002
22954
  };
22955
+ type L10nString = {} & {
22956
+ [key: string]: any;
22957
+ };
22958
+ type AttributeDefinition = {
22959
+ defaultValue?: PropertyValueDefinition$7;
22960
+ id?: string;
22961
+ name: L10nString;
22962
+ description: L10nString;
22963
+ key?: boolean;
22964
+ localizable?: boolean;
22965
+ mandatory?: boolean;
22966
+ max?: number;
22967
+ minLength?: number;
22968
+ min?: number;
22969
+ multiValueType?: boolean;
22970
+ regularExpression?: string;
22971
+ scale?: number;
22972
+ searchable?: boolean;
22973
+ siteSpecific?: boolean;
22974
+ system?: boolean;
22975
+ unit?: L10nString;
22976
+ possibleValues?: Array<PropertyValueDefinition$7>;
22977
+ type: string;
22978
+ visible?: boolean;
22979
+ };
22980
+ type PropertyValueDefinition = {
22981
+ description: L10nString;
22982
+ displayValue: L10nString;
22983
+ id: string;
22984
+ position?: number;
22985
+ value: string;
22986
+ };
22003
22987
  type ErrorResponse = {
22004
22988
  type: string;
22005
22989
  title?: string;
@@ -22052,7 +23036,6 @@ declare namespace ShopperSearchTypes {
22052
23036
  };
22053
23037
  type SuggestedProduct = {
22054
23038
  currency: string;
22055
- image?: Image$1;
22056
23039
  price: number;
22057
23040
  productId: string;
22058
23041
  productName: string;
@@ -22222,6 +23205,7 @@ declare namespace ShopperSearchTypes {
22222
23205
  sort?: string;
22223
23206
  currency?: string;
22224
23207
  locale?: string;
23208
+ expand?: Array<string>;
22225
23209
  offset?: any;
22226
23210
  limit?: number;
22227
23211
  };
@@ -22252,7 +23236,7 @@ declare namespace ShopperSearchTypes {
22252
23236
  * ```
22253
23237
  *
22254
23238
  * <span style="font-size:.7em; display:block; text-align: right">
22255
- * API Version: 1.0.24<br />
23239
+ * API Version: 1.0.29<br />
22256
23240
  * Last Updated: <br />
22257
23241
  * </span>
22258
23242
 
@@ -22286,11 +23270,12 @@ declare namespace ShopperSearchTypes {
22286
23270
  cgid: Allows refinement per single category ID. Multiple category ids are not supported.
22287
23271
  price: Allows refinement per single price range. Multiple price ranges are not supported.
22288
23272
  pmid: Allows refinement per promotion ID.
22289
- htypes: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
23273
+ htype: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
22290
23274
  orderable_only: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.
22291
23275
  * @param sort - The ID of the sorting option to sort the search hits.
22292
23276
  * @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
22293
23277
  * @param locale -
23278
+ * @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations). If the parameter is missing all the values will be returned.
22294
23279
  * @param offset -
22295
23280
  * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
22296
23281
  * @param headers - An object literal of key value pairs of the headers to be
@@ -22308,6 +23293,7 @@ declare namespace ShopperSearchTypes {
22308
23293
  sort?: string;
22309
23294
  currency?: string;
22310
23295
  locale?: string;
23296
+ expand?: Array<string>;
22311
23297
  offset?: any;
22312
23298
  limit?: number;
22313
23299
  }, ConfigParameters>;
@@ -22333,11 +23319,12 @@ declare namespace ShopperSearchTypes {
22333
23319
  cgid: Allows refinement per single category ID. Multiple category ids are not supported.
22334
23320
  price: Allows refinement per single price range. Multiple price ranges are not supported.
22335
23321
  pmid: Allows refinement per promotion ID.
22336
- htypes: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
23322
+ htype: Allow refinement by including only the provided hit types. Accepted types are 'product', 'master', 'set', 'bundle', 'slicing_group' (deprecated), 'variation_group'.
22337
23323
  orderable_only: Unavailable products are excluded from the search results if true is set. Multiple refinement values are not supported.
22338
23324
  * @param sort - The ID of the sorting option to sort the search hits.
22339
23325
  * @param currency - The currency mnemonic specified for price. This parameter is effective only if the returned results contain prices.
22340
23326
  * @param locale -
23327
+ * @param expand - The expand parameter. A list with the allowed values (availability, images, prices, represented_products, variations). If the parameter is missing all the values will be returned.
22341
23328
  * @param offset -
22342
23329
  * @param limit - Maximum records to retrieve per request, not to exceed 200. Defaults to 25.
22343
23330
  * @param headers - An object literal of key value pairs of the headers to be
@@ -22355,6 +23342,7 @@ declare namespace ShopperSearchTypes {
22355
23342
  sort?: string;
22356
23343
  currency?: string;
22357
23344
  locale?: string;
23345
+ expand?: Array<string>;
22358
23346
  offset?: any;
22359
23347
  limit?: number;
22360
23348
  }, ConfigParameters>;
@@ -22557,6 +23545,17 @@ declare namespace helpers {
22557
23545
  } & {
22558
23546
  [key: string]: any;
22559
23547
  };
23548
+ type TrustedAgentTokenRequest = {
23549
+ agent_id: string;
23550
+ client_id: string;
23551
+ channel_id: string;
23552
+ code_verifier: string;
23553
+ grant_type: string;
23554
+ login_id: string;
23555
+ idp_origin: string;
23556
+ } & {
23557
+ [key: string]: any;
23558
+ };
22560
23559
  type IntrospectResponse = {
22561
23560
  active: boolean;
22562
23561
  scope: string;
@@ -22568,6 +23567,16 @@ declare namespace helpers {
22568
23567
  } & {
22569
23568
  [key: string]: any;
22570
23569
  };
23570
+ type PasswordlessLoginRequest = {
23571
+ user_id: string;
23572
+ mode: string;
23573
+ locale?: string;
23574
+ usid?: string;
23575
+ channel_id: string;
23576
+ callback_uri?: string;
23577
+ } & {
23578
+ [key: string]: any;
23579
+ };
22571
23580
  type CredQualityUserResponse = {
22572
23581
  tenantId: string;
22573
23582
  username: string;
@@ -22626,7 +23635,7 @@ declare namespace helpers {
22626
23635
  locale?: string;
22627
23636
  client_id?: string;
22628
23637
  code_challenge?: string;
22629
- redirect_uri?: string;
23638
+ callback_uri?: string;
22630
23639
  idp_name?: string;
22631
23640
  } & {
22632
23641
  [key: string]: any;
@@ -22651,6 +23660,7 @@ declare namespace helpers {
22651
23660
  redirect_uri?: string;
22652
23661
  code_verifier?: string;
22653
23662
  client_id?: string;
23663
+ channel_id?: string;
22654
23664
  } & {
22655
23665
  [key: string]: any;
22656
23666
  };
@@ -22660,6 +23670,18 @@ declare namespace helpers {
22660
23670
  } & {
22661
23671
  [key: string]: any;
22662
23672
  };
23673
+ type SessionBridgeTokenRequest = {
23674
+ code: string;
23675
+ client_id: string;
23676
+ channel_id: string;
23677
+ code_verifier: string;
23678
+ dwsid: string;
23679
+ grant_type: string;
23680
+ login_id: string;
23681
+ usid?: string;
23682
+ } & {
23683
+ [key: string]: any;
23684
+ };
22663
23685
  type ErrorResponse = {
22664
23686
  type: string;
22665
23687
  title?: string;
@@ -22765,7 +23787,7 @@ declare namespace helpers {
22765
23787
  [key: string]: any;
22766
23788
  };
22767
23789
  type BoolFilter = {
22768
- filters?: Filter;
23790
+ filters?: Array<Filter>;
22769
23791
  operator: string;
22770
23792
  } & {
22771
23793
  [key: string]: any;
@@ -22939,6 +23961,8 @@ declare namespace helpers {
22939
23961
  state?: string;
22940
23962
  usid?: string;
22941
23963
  code_challenge?: string;
23964
+ login_id?: string;
23965
+ idp_origin?: string;
22942
23966
  };
22943
23967
  /**
22944
23968
  * All parameters that are used by ShopperLogin.
@@ -22967,7 +23991,7 @@ declare namespace helpers {
22967
23991
  * ```
22968
23992
  *
22969
23993
  * <span style="font-size:.7em; display:block; text-align: right">
22970
- * API Version: 1.32.0<br />
23994
+ * API Version: 1.39.10<br />
22971
23995
  * Last Updated: <br />
22972
23996
  * </span>
22973
23997
 
@@ -23028,7 +24052,7 @@ declare namespace helpers {
23028
24052
  };
23029
24053
  }>, rawResponse?: T): Promise<T extends true ? Response : CredQualityUserResponse>;
23030
24054
  /**
23031
- * Get authorization code after authenticating a user using an ECOM instance.
24055
+ * Authenticates an ECOM customer.
23032
24056
  *
23033
24057
  * If you would like to get a raw Response object use the other authenticateCustomer function.
23034
24058
  *
@@ -23052,7 +24076,7 @@ declare namespace helpers {
23052
24076
  body: LoginRequest;
23053
24077
  }>): Promise<void>;
23054
24078
  /**
23055
- * Get authorization code after authenticating a user using an ECOM instance.
24079
+ * Authenticates an ECOM customer.
23056
24080
  *
23057
24081
  * @param options - An object containing the options for this method.
23058
24082
  * @param parameters - An object containing the parameters for this method.
@@ -23095,7 +24119,7 @@ declare namespace helpers {
23095
24119
  headers?: {
23096
24120
  [key: string]: string;
23097
24121
  };
23098
- body: PasswordActionRequest;
24122
+ body: PasswordlessLoginRequest;
23099
24123
  }>): Promise<Object>;
23100
24124
  /**
23101
24125
  * Allows the customer to authenticate when their identity provider is down.
@@ -23117,7 +24141,7 @@ declare namespace helpers {
23117
24141
  headers?: {
23118
24142
  [key: string]: string;
23119
24143
  };
23120
- body: PasswordActionRequest;
24144
+ body: PasswordlessLoginRequest;
23121
24145
  }>, rawResponse?: T): Promise<T extends true ? Response : Object>;
23122
24146
  /**
23123
24147
  * Log out a shopper.
@@ -23178,7 +24202,9 @@ declare namespace helpers {
23178
24202
  };
23179
24203
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
23180
24204
  /**
23181
- * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
24205
+ * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.1 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.
24206
+
24207
+ This endpoint can be called from the front channel (the browser).
23182
24208
  *
23183
24209
  * If you would like to get a raw Response object use the other authorizeCustomer function.
23184
24210
  *
@@ -23188,12 +24214,20 @@ declare namespace helpers {
23188
24214
  * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
23189
24215
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
23190
24216
  * @param client_id - The client ID obtained during application registration.
23191
- * @param scope - (Not Supported)
24217
+ * @param scope -
23192
24218
  * @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
23193
24219
  * @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
23194
- * @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
24220
+ * @param hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
24221
+
24222
+ To use a public client, set `hint` to `guest` and use a public client ID to get an authorization code. If no `hint` is provided, the preferred IDP of the tenant is used by default.
24223
+
24224
+ For session bridge authorization the `hint` should be set to `sb-user` for a registered customer and to `sb-guest` for a guest.
23195
24225
  * @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
23196
- * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
24226
+ * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.
24227
+
24228
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
24229
+
24230
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
23197
24231
  * @param headers - An object literal of key value pairs of the headers to be
23198
24232
  * sent with this request.
23199
24233
  *
@@ -23218,7 +24252,9 @@ declare namespace helpers {
23218
24252
  };
23219
24253
  }>): Promise<void>;
23220
24254
  /**
23221
- * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.0 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.\<br /\>\<br /\>This endpoint can be called from the front channel (the browser).
24255
+ * Get an authorization code after authenticating a user against an identity provider (IDP). This is the first step of the OAuth 2.1 authorization code flow, where a user can log in via federation to the IDP configured for the client. After successfully logging in, the user gets an authorization code via a redirect URI.
24256
+
24257
+ This endpoint can be called from the front channel (the browser).
23222
24258
  *
23223
24259
  * @param options - An object containing the options for this method.
23224
24260
  * @param parameters - An object containing the parameters for this method.
@@ -23226,12 +24262,20 @@ declare namespace helpers {
23226
24262
  * @param redirect_uri - The URL to which the server redirects the browser after the user grants the authorization. The URI must be pre-registered.
23227
24263
  * @param response_type - Must be `code`. Indicates that the client wants an authorization code (using the `authorization_code` grant type).
23228
24264
  * @param client_id - The client ID obtained during application registration.
23229
- * @param scope - (Not Supported)
24265
+ * @param scope -
23230
24266
  * @param state - Value to send the client to determine the state between the authorization request and the server response. Optional, but strongly recommended.
23231
24267
  * @param usid - A unique shopper identifier (USID). If not provided, a new USID is generated.
23232
- * @param hint - IDP name that can be optionally added to redirect to, thereby skipping the IDP selection step.<br /><br />To use a public client, the hint should be set to `guest` and a public client ID should be used to get an authorization code.
24268
+ * @param hint - Name of an identity provider (IDP) to optionally redirect to, thereby skipping the IDP selection step.
24269
+
24270
+ To use a public client, set `hint` to `guest` and use a public client ID to get an authorization code. If no `hint` is provided, the preferred IDP of the tenant is used by default.
24271
+
24272
+ For session bridge authorization the `hint` should be set to `sb-user` for a registered customer and to `sb-guest` for a guest.
23233
24273
  * @param channel_id - The channel that this request is for. For an ECOM request, this is angalous to the site ID.
23234
- * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.<br /><br />The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.<br /><br />The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
24274
+ * @param code_challenge - PKCE code challenge. Created by the client calling the `login` endpoint.
24275
+
24276
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
24277
+
24278
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
23235
24279
  * @param headers - An object literal of key value pairs of the headers to be
23236
24280
  * sent with this request.
23237
24281
  * @param rawResponse - Set to true to return entire Response object instead of DTO.
@@ -23256,7 +24300,15 @@ declare namespace helpers {
23256
24300
  };
23257
24301
  }>, rawResponse?: T): Promise<T extends true ? Response : void>;
23258
24302
  /**
23259
- * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As 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.\<br /\>\<br /\>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.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
24303
+ * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
24304
+
24305
+ As 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.
24306
+
24307
+ 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.
24308
+
24309
+ See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
24310
+
24311
+ **Important**: We strongly recommended using the `channel_id` query parameter because **it will be required in the future**.
23260
24312
  *
23261
24313
  * If you would like to get a raw Response object use the other getAccessToken function.
23262
24314
  *
@@ -23280,7 +24332,15 @@ declare namespace helpers {
23280
24332
  body: TokenRequest;
23281
24333
  }>): Promise<TokenResponse>;
23282
24334
  /**
23283
- * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.0 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.\<br /\>\<br /\>As 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.\<br /\>\<br /\>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.\<br /\>\<br /\>See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
24335
+ * Get the shopper or guest JWT access token and a refresh token. This is the second step of the OAuth 2.1 authorization code flow where a client appplication is able to get an access token for the shopper through the back channel (a trusted server) by passing in the client credentials and the authorization code retrieved from the `authorize` endpoint.
24336
+
24337
+ As 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.
24338
+
24339
+ 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.
24340
+
24341
+ See the Body section for required parameters, including `grant_type` and others, depending on the value of `grant_type`.
24342
+
24343
+ **Important**: We strongly recommended using the `channel_id` query parameter because **it will be required in the future**.
23284
24344
  *
23285
24345
  * @param options - An object containing the options for this method.
23286
24346
  * @param parameters - An object containing the parameters for this method.
@@ -23302,7 +24362,65 @@ declare namespace helpers {
23302
24362
  body: TokenRequest;
23303
24363
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
23304
24364
  /**
23305
- * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
24365
+ * Get a shopper JWT access token for a registered customer using session bridge.
24366
+
24367
+ For public client id requests the grant_type must be set to `session_bridge`.
24368
+
24369
+ For private client_id and secret the grant_type must be set to `client_credentials` along with a basic authorization header.
24370
+ *
24371
+ * If you would like to get a raw Response object use the other getSessionBridgeAccessToken function.
24372
+ *
24373
+ * @param options - An object containing the options for this method.
24374
+ * @param parameters - An object containing the parameters for this method.
24375
+ * @param organizationId -
24376
+ * @param headers - An object literal of key value pairs of the headers to be
24377
+ * sent with this request.
24378
+ * @param body - The data to send as the request body.
24379
+ *
24380
+ * @returns A promise of type TokenResponse.
24381
+ *
24382
+ */
24383
+ getSessionBridgeAccessToken(options: RequireParametersUnlessAllAreOptional<{
24384
+ parameters?: CompositeParameters<{
24385
+ organizationId: string;
24386
+ }, ConfigParameters>;
24387
+ headers?: {
24388
+ [key: string]: string;
24389
+ };
24390
+ body: SessionBridgeTokenRequest;
24391
+ }>): Promise<TokenResponse>;
24392
+ /**
24393
+ * Get a shopper JWT access token for a registered customer using session bridge.
24394
+
24395
+ For public client id requests the grant_type must be set to `session_bridge`.
24396
+
24397
+ For private client_id and secret the grant_type must be set to `client_credentials` along with a basic authorization header.
24398
+ *
24399
+ * @param options - An object containing the options for this method.
24400
+ * @param parameters - An object containing the parameters for this method.
24401
+ * @param organizationId -
24402
+ * @param headers - An object literal of key value pairs of the headers to be
24403
+ * sent with this request.
24404
+ * @param body - The data to send as the request body.
24405
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
24406
+ * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
24407
+ *
24408
+ */
24409
+ getSessionBridgeAccessToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
24410
+ parameters?: CompositeParameters<{
24411
+ organizationId: string;
24412
+ }, ConfigParameters>;
24413
+ headers?: {
24414
+ [key: string]: string;
24415
+ };
24416
+ body: SessionBridgeTokenRequest;
24417
+ }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
24418
+ /**
24419
+ * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.
24420
+
24421
+ For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.
24422
+
24423
+ For internal trusted-system requests, the bearer token must be a C2C JWT.
23306
24424
  *
23307
24425
  * If you would like to get a raw Response object use the other getTrustedSystemAccessToken function.
23308
24426
  *
@@ -23326,7 +24444,11 @@ declare namespace helpers {
23326
24444
  body: TrustedSystemTokenRequest;
23327
24445
  }>): Promise<TokenResponse>;
23328
24446
  /**
23329
- * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.\<br /\>\<br /\>For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.\<br /\>\<br /\>For internal trusted-system requests, the bearer token must be a C2C JWT.
24447
+ * Get a shopper JWT access token for a registered customer whose credentials are stored using a third party system.
24448
+
24449
+ For external trusted-system requests, a basic authorization header that includes a SLAS client ID and SLAS client secret can be used in place of the bearer token.
24450
+
24451
+ For internal trusted-system requests, the bearer token must be a C2C JWT.
23330
24452
  *
23331
24453
  * @param options - An object containing the options for this method.
23332
24454
  * @param parameters - An object containing the parameters for this method.
@@ -23347,6 +24469,130 @@ declare namespace helpers {
23347
24469
  };
23348
24470
  body: TrustedSystemTokenRequest;
23349
24471
  }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
24472
+ /**
24473
+ * Obtains a new agent on behalf authorization token for a registered customer.
24474
+ *
24475
+ * If you would like to get a raw Response object use the other getTrustedAgentAuthorizationToken function.
24476
+ *
24477
+ * @param options - An object containing the options for this method.
24478
+ * @param parameters - An object containing the parameters for this method.
24479
+ * @param organizationId -
24480
+ * @param client_id - The SLAS public client ID for use with internal trusted-agent requests.
24481
+ * @param channel_id - The channel (ECOM site) that the user is associated with.
24482
+ * @param code_challenge - PKCE code challenge. Created by the caller.
24483
+
24484
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
24485
+
24486
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
24487
+ * @param login_id - The ID of the shopper for trusted agent access.
24488
+ * @param idp_origin - The IDP that the shopper is associated with.
24489
+ * @param redirect_uri - The redirect for Account Manager to redirect to.
24490
+ * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
24491
+ * @param headers - An object literal of key value pairs of the headers to be
24492
+ * sent with this request.
24493
+ *
24494
+ * @returns A promise of type void.
24495
+ *
24496
+ */
24497
+ getTrustedAgentAuthorizationToken(options?: RequireParametersUnlessAllAreOptional<{
24498
+ parameters?: CompositeParameters<{
24499
+ organizationId: string;
24500
+ client_id: string;
24501
+ channel_id: string;
24502
+ code_challenge: string;
24503
+ login_id: string;
24504
+ idp_origin: string;
24505
+ redirect_uri: string;
24506
+ response_type: string;
24507
+ }, ConfigParameters>;
24508
+ headers?: {
24509
+ [key: string]: string;
24510
+ };
24511
+ }>): Promise<void>;
24512
+ /**
24513
+ * Obtains a new agent on behalf authorization token for a registered customer.
24514
+ *
24515
+ * @param options - An object containing the options for this method.
24516
+ * @param parameters - An object containing the parameters for this method.
24517
+ * @param organizationId -
24518
+ * @param client_id - The SLAS public client ID for use with internal trusted-agent requests.
24519
+ * @param channel_id - The channel (ECOM site) that the user is associated with.
24520
+ * @param code_challenge - PKCE code challenge. Created by the caller.
24521
+
24522
+ The `code_challenge` is created by SHA256 hashing the `code_verifier` and base64 URL encoding the resulting hash.
24523
+
24524
+ The `code_verifier` should be a high entropy cryptographically random string with a minimum of 43 characters and a maximum of 128 characters.
24525
+ * @param login_id - The ID of the shopper for trusted agent access.
24526
+ * @param idp_origin - The IDP that the shopper is associated with.
24527
+ * @param redirect_uri - The redirect for Account Manager to redirect to.
24528
+ * @param response_type - Must be `code`. Indicates that the caller wants an authorization code.
24529
+ * @param headers - An object literal of key value pairs of the headers to be
24530
+ * sent with this request.
24531
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
24532
+ * @returns A promise of type Response if rawResponse is true, a promise of type void otherwise.
24533
+ *
24534
+ */
24535
+ getTrustedAgentAuthorizationToken<T extends boolean>(options?: RequireParametersUnlessAllAreOptional<{
24536
+ parameters?: CompositeParameters<{
24537
+ organizationId: string;
24538
+ client_id: string;
24539
+ channel_id: string;
24540
+ code_challenge: string;
24541
+ login_id: string;
24542
+ idp_origin: string;
24543
+ redirect_uri: string;
24544
+ response_type: string;
24545
+ }, ConfigParameters>;
24546
+ headers?: {
24547
+ [key: string]: string;
24548
+ };
24549
+ }>, rawResponse?: T): Promise<T extends true ? Response : void>;
24550
+ /**
24551
+ * Get a shopper JWT access token for a registered customer using a trusted agent (Merchant)
24552
+ *
24553
+ * If you would like to get a raw Response object use the other getTrustedAgentAccessToken function.
24554
+ *
24555
+ * @param options - An object containing the options for this method.
24556
+ * @param parameters - An object containing the parameters for this method.
24557
+ * @param organizationId -
24558
+ * @param headers - An object literal of key value pairs of the headers to be
24559
+ * sent with this request.
24560
+ * @param body - The data to send as the request body.
24561
+ *
24562
+ * @returns A promise of type TokenResponse.
24563
+ *
24564
+ */
24565
+ getTrustedAgentAccessToken(options: RequireParametersUnlessAllAreOptional<{
24566
+ parameters?: CompositeParameters<{
24567
+ organizationId: string;
24568
+ }, ConfigParameters>;
24569
+ headers?: {
24570
+ [key: string]: string;
24571
+ };
24572
+ body: TrustedAgentTokenRequest;
24573
+ }>): Promise<TokenResponse>;
24574
+ /**
24575
+ * Get a shopper JWT access token for a registered customer using a trusted agent (Merchant)
24576
+ *
24577
+ * @param options - An object containing the options for this method.
24578
+ * @param parameters - An object containing the parameters for this method.
24579
+ * @param organizationId -
24580
+ * @param headers - An object literal of key value pairs of the headers to be
24581
+ * sent with this request.
24582
+ * @param body - The data to send as the request body.
24583
+ * @param rawResponse - Set to true to return entire Response object instead of DTO.
24584
+ * @returns A promise of type Response if rawResponse is true, a promise of type TokenResponse otherwise.
24585
+ *
24586
+ */
24587
+ getTrustedAgentAccessToken<T extends boolean>(options: RequireParametersUnlessAllAreOptional<{
24588
+ parameters?: CompositeParameters<{
24589
+ organizationId: string;
24590
+ }, ConfigParameters>;
24591
+ headers?: {
24592
+ [key: string]: string;
24593
+ };
24594
+ body: TrustedAgentTokenRequest;
24595
+ }>, rawResponse?: T): Promise<T extends true ? Response : TokenResponse>;
23350
24596
  /**
23351
24597
  * Request a reset password token
23352
24598
  *
@@ -23743,6 +24989,7 @@ declare namespace helpers {
23743
24989
  shortCode: string;
23744
24990
  organizationId: string;
23745
24991
  clientId: string;
24992
+ siteId: string;
23746
24993
  }>, codeVerifier: string, parameters: {
23747
24994
  redirectURI: string;
23748
24995
  hint?: string;
@@ -23764,6 +25011,7 @@ declare namespace helpers {
23764
25011
  shortCode: string;
23765
25012
  organizationId: string;
23766
25013
  clientId: string;
25014
+ siteId: string;
23767
25015
  }>, parameters: {
23768
25016
  redirectURI: string;
23769
25017
  usid?: string;
@@ -23802,6 +25050,7 @@ declare namespace helpers {
23802
25050
  shortCode: string;
23803
25051
  organizationId: string;
23804
25052
  clientId: string;
25053
+ siteId: string;
23805
25054
  }>, parameters: {
23806
25055
  refreshToken: string;
23807
25056
  }): Promise<TokenResponse>;