@commercengine/storefront-sdk 0.7.0 → 0.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.
- package/dist/index.cjs +1888 -88
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2662 -653
- package/dist/index.d.ts +2662 -653
- package/dist/index.iife.js +1888 -88
- package/dist/index.iife.js.map +1 -1
- package/dist/index.js +1888 -88
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -350,7 +350,7 @@ interface paths {
|
|
|
350
350
|
patch?: never;
|
|
351
351
|
trace?: never;
|
|
352
352
|
};
|
|
353
|
-
"/carts/{id}/
|
|
353
|
+
"/carts/{id}/shipping-method": {
|
|
354
354
|
parameters: {
|
|
355
355
|
query?: never;
|
|
356
356
|
header?: never;
|
|
@@ -363,17 +363,17 @@ interface paths {
|
|
|
363
363
|
get?: never;
|
|
364
364
|
put?: never;
|
|
365
365
|
/**
|
|
366
|
-
* Update
|
|
367
|
-
* @description
|
|
366
|
+
* Update shipping method
|
|
367
|
+
* @description Update preferred shipping method and courier.
|
|
368
368
|
*/
|
|
369
|
-
post: operations["update-
|
|
369
|
+
post: operations["update-shipping-method"];
|
|
370
370
|
delete?: never;
|
|
371
371
|
options?: never;
|
|
372
372
|
head?: never;
|
|
373
373
|
patch?: never;
|
|
374
374
|
trace?: never;
|
|
375
375
|
};
|
|
376
|
-
"/carts/{id}/
|
|
376
|
+
"/carts/{id}/fulfillment-preference": {
|
|
377
377
|
parameters: {
|
|
378
378
|
query?: never;
|
|
379
379
|
header?: never;
|
|
@@ -386,10 +386,10 @@ interface paths {
|
|
|
386
386
|
get?: never;
|
|
387
387
|
put?: never;
|
|
388
388
|
/**
|
|
389
|
-
* Update
|
|
390
|
-
* @description Update
|
|
389
|
+
* Update fulfillment preference
|
|
390
|
+
* @description Update fulfillment preference
|
|
391
391
|
*/
|
|
392
|
-
post: operations["update-
|
|
392
|
+
post: operations["update-fulfillment-preference"];
|
|
393
393
|
delete?: never;
|
|
394
394
|
options?: never;
|
|
395
395
|
head?: never;
|
|
@@ -477,6 +477,29 @@ interface paths {
|
|
|
477
477
|
patch?: never;
|
|
478
478
|
trace?: never;
|
|
479
479
|
};
|
|
480
|
+
"/pos/carts/{id}/fulfillment-preference": {
|
|
481
|
+
parameters: {
|
|
482
|
+
query?: never;
|
|
483
|
+
header?: never;
|
|
484
|
+
path: {
|
|
485
|
+
/** @description Cart ID */
|
|
486
|
+
id: string;
|
|
487
|
+
};
|
|
488
|
+
cookie?: never;
|
|
489
|
+
};
|
|
490
|
+
get?: never;
|
|
491
|
+
put?: never;
|
|
492
|
+
/**
|
|
493
|
+
* Update fulfillment preference
|
|
494
|
+
* @description Update fulfillment preference
|
|
495
|
+
*/
|
|
496
|
+
post: operations["pos-update-fulfillment-preference"];
|
|
497
|
+
delete?: never;
|
|
498
|
+
options?: never;
|
|
499
|
+
head?: never;
|
|
500
|
+
patch?: never;
|
|
501
|
+
trace?: never;
|
|
502
|
+
};
|
|
480
503
|
"/carts/{id}/gift-card": {
|
|
481
504
|
parameters: {
|
|
482
505
|
query?: never;
|
|
@@ -1147,6 +1170,46 @@ interface paths {
|
|
|
1147
1170
|
patch?: never;
|
|
1148
1171
|
trace?: never;
|
|
1149
1172
|
};
|
|
1173
|
+
"/shipping/fulfillment-options": {
|
|
1174
|
+
parameters: {
|
|
1175
|
+
query?: never;
|
|
1176
|
+
header?: never;
|
|
1177
|
+
path?: never;
|
|
1178
|
+
cookie?: never;
|
|
1179
|
+
};
|
|
1180
|
+
get?: never;
|
|
1181
|
+
put?: never;
|
|
1182
|
+
/**
|
|
1183
|
+
* Retrieve fulfillment options
|
|
1184
|
+
* @description This endpoint returns the available fulfillment options for a given cart and delivery pincode. It provides both delivery options and collect-in-store (Click & Collect) options, including details of store locations where the item can be collected.
|
|
1185
|
+
*/
|
|
1186
|
+
post: operations["get-fulfillment-options"];
|
|
1187
|
+
delete?: never;
|
|
1188
|
+
options?: never;
|
|
1189
|
+
head?: never;
|
|
1190
|
+
patch?: never;
|
|
1191
|
+
trace?: never;
|
|
1192
|
+
};
|
|
1193
|
+
"/pos/fulfillment-options": {
|
|
1194
|
+
parameters: {
|
|
1195
|
+
query?: never;
|
|
1196
|
+
header?: never;
|
|
1197
|
+
path?: never;
|
|
1198
|
+
cookie?: never;
|
|
1199
|
+
};
|
|
1200
|
+
get?: never;
|
|
1201
|
+
put?: never;
|
|
1202
|
+
/**
|
|
1203
|
+
* Retrieve fulfillment options
|
|
1204
|
+
* @description This endpoint returns the available fulfillment options for a given cart and delivery pincode. It provides both delivery options and collect-in-store (Click & Collect) options, including details of store locations where the item can be collected.
|
|
1205
|
+
*/
|
|
1206
|
+
post: operations["get-pos-fulfillment-options"];
|
|
1207
|
+
delete?: never;
|
|
1208
|
+
options?: never;
|
|
1209
|
+
head?: never;
|
|
1210
|
+
patch?: never;
|
|
1211
|
+
trace?: never;
|
|
1212
|
+
};
|
|
1150
1213
|
"/shipping/serviceability/{pincode}": {
|
|
1151
1214
|
parameters: {
|
|
1152
1215
|
query?: never;
|
|
@@ -4958,6 +5021,57 @@ interface components {
|
|
|
4958
5021
|
first_name?: string | null;
|
|
4959
5022
|
last_name?: string | null;
|
|
4960
5023
|
};
|
|
5024
|
+
/** CollectInStore */
|
|
5025
|
+
CollectInStore: {
|
|
5026
|
+
id?: string;
|
|
5027
|
+
name?: string;
|
|
5028
|
+
distance_km?: number;
|
|
5029
|
+
collect_eta_minutes?: number;
|
|
5030
|
+
is_recommended?: boolean;
|
|
5031
|
+
};
|
|
5032
|
+
/** CollectInStoreFulfillment */
|
|
5033
|
+
CollectInStoreFulfillment: {
|
|
5034
|
+
/** @constant */
|
|
5035
|
+
fulfillment_type: "collect-in-store";
|
|
5036
|
+
pickup_location_id: string;
|
|
5037
|
+
};
|
|
5038
|
+
/** DeliveryFulfillment */
|
|
5039
|
+
DeliveryFulfillment: {
|
|
5040
|
+
/** @constant */
|
|
5041
|
+
fulfillment_type: "delivery";
|
|
5042
|
+
};
|
|
5043
|
+
/** CollectInStoreFulfillment */
|
|
5044
|
+
POSCollectInStoreFulfillment: {
|
|
5045
|
+
/** @constant */
|
|
5046
|
+
fulfillment_type: "collect-in-store";
|
|
5047
|
+
pickup_location_id?: string;
|
|
5048
|
+
};
|
|
5049
|
+
/** DeliveryFulfillment */
|
|
5050
|
+
POSDeliveryFulfillment: {
|
|
5051
|
+
/** @constant */
|
|
5052
|
+
fulfillment_type: "delivery";
|
|
5053
|
+
shipping_address: components["schemas"]["CustomerAddress"];
|
|
5054
|
+
billing_address?: components["schemas"]["CustomerAddress"];
|
|
5055
|
+
};
|
|
5056
|
+
/** PartialCollectAndDeliveryFulfillment */
|
|
5057
|
+
POSPartialCollectAndDeliveryFulfillment: {
|
|
5058
|
+
/** @constant */
|
|
5059
|
+
fulfillment_type: "partial-collect-and-delivery";
|
|
5060
|
+
shipping_address: components["schemas"]["CustomerAddress"];
|
|
5061
|
+
billing_address?: components["schemas"]["CustomerAddress"];
|
|
5062
|
+
preferences: {
|
|
5063
|
+
collect_in_store: {
|
|
5064
|
+
product_id: string;
|
|
5065
|
+
variant_id: string | null;
|
|
5066
|
+
quantity: number;
|
|
5067
|
+
}[];
|
|
5068
|
+
delivery: {
|
|
5069
|
+
product_id: string;
|
|
5070
|
+
variant_id: string | null;
|
|
5071
|
+
quantity: number;
|
|
5072
|
+
}[];
|
|
5073
|
+
};
|
|
5074
|
+
};
|
|
4961
5075
|
};
|
|
4962
5076
|
responses: {
|
|
4963
5077
|
/** @description Requested resource not found */
|
|
@@ -4999,9 +5113,7 @@ interface components {
|
|
|
4999
5113
|
message: string;
|
|
5000
5114
|
success: boolean;
|
|
5001
5115
|
code: string;
|
|
5002
|
-
error?:
|
|
5003
|
-
fieldname?: string[];
|
|
5004
|
-
};
|
|
5116
|
+
error?: Record<string, never>;
|
|
5005
5117
|
};
|
|
5006
5118
|
};
|
|
5007
5119
|
};
|
|
@@ -5769,7 +5881,7 @@ interface operations {
|
|
|
5769
5881
|
404: components["responses"]["NotFound"];
|
|
5770
5882
|
};
|
|
5771
5883
|
};
|
|
5772
|
-
"update-
|
|
5884
|
+
"update-shipping-method": {
|
|
5773
5885
|
parameters: {
|
|
5774
5886
|
query?: never;
|
|
5775
5887
|
header?: never;
|
|
@@ -5779,10 +5891,12 @@ interface operations {
|
|
|
5779
5891
|
};
|
|
5780
5892
|
cookie?: never;
|
|
5781
5893
|
};
|
|
5782
|
-
/** @description Update billing and shipping address during checkout */
|
|
5783
5894
|
requestBody: {
|
|
5784
5895
|
content: {
|
|
5785
|
-
"application/json":
|
|
5896
|
+
"application/json": {
|
|
5897
|
+
shipping_provider_id: string;
|
|
5898
|
+
courier_company_id: string | null;
|
|
5899
|
+
};
|
|
5786
5900
|
};
|
|
5787
5901
|
};
|
|
5788
5902
|
responses: {
|
|
@@ -5793,7 +5907,6 @@ interface operations {
|
|
|
5793
5907
|
};
|
|
5794
5908
|
content: {
|
|
5795
5909
|
"application/json": {
|
|
5796
|
-
/** @example Address updated successfully */
|
|
5797
5910
|
message: string;
|
|
5798
5911
|
success: boolean;
|
|
5799
5912
|
content: {
|
|
@@ -5807,7 +5920,7 @@ interface operations {
|
|
|
5807
5920
|
404: components["responses"]["NotFound"];
|
|
5808
5921
|
};
|
|
5809
5922
|
};
|
|
5810
|
-
"update-
|
|
5923
|
+
"update-fulfillment-preference": {
|
|
5811
5924
|
parameters: {
|
|
5812
5925
|
query?: never;
|
|
5813
5926
|
header?: never;
|
|
@@ -5819,10 +5932,7 @@ interface operations {
|
|
|
5819
5932
|
};
|
|
5820
5933
|
requestBody: {
|
|
5821
5934
|
content: {
|
|
5822
|
-
"application/json":
|
|
5823
|
-
shipping_provider_id: string;
|
|
5824
|
-
courier_company_id: string | null;
|
|
5825
|
-
};
|
|
5935
|
+
"application/json": components["schemas"]["CollectInStoreFulfillment"] | components["schemas"]["DeliveryFulfillment"];
|
|
5826
5936
|
};
|
|
5827
5937
|
};
|
|
5828
5938
|
responses: {
|
|
@@ -5835,9 +5945,6 @@ interface operations {
|
|
|
5835
5945
|
"application/json": {
|
|
5836
5946
|
message: string;
|
|
5837
5947
|
success: boolean;
|
|
5838
|
-
content: {
|
|
5839
|
-
cart: components["schemas"]["Cart"];
|
|
5840
|
-
};
|
|
5841
5948
|
};
|
|
5842
5949
|
};
|
|
5843
5950
|
};
|
|
@@ -6090,6 +6197,39 @@ interface operations {
|
|
|
6090
6197
|
};
|
|
6091
6198
|
};
|
|
6092
6199
|
};
|
|
6200
|
+
"pos-update-fulfillment-preference": {
|
|
6201
|
+
parameters: {
|
|
6202
|
+
query?: never;
|
|
6203
|
+
header?: never;
|
|
6204
|
+
path: {
|
|
6205
|
+
/** @description Cart ID */
|
|
6206
|
+
id: string;
|
|
6207
|
+
};
|
|
6208
|
+
cookie?: never;
|
|
6209
|
+
};
|
|
6210
|
+
requestBody: {
|
|
6211
|
+
content: {
|
|
6212
|
+
"application/json": components["schemas"]["POSCollectInStoreFulfillment"] | components["schemas"]["POSDeliveryFulfillment"] | components["schemas"]["POSPartialCollectAndDeliveryFulfillment"];
|
|
6213
|
+
};
|
|
6214
|
+
};
|
|
6215
|
+
responses: {
|
|
6216
|
+
/** @description OK */
|
|
6217
|
+
200: {
|
|
6218
|
+
headers: {
|
|
6219
|
+
[name: string]: unknown;
|
|
6220
|
+
};
|
|
6221
|
+
content: {
|
|
6222
|
+
"application/json": {
|
|
6223
|
+
message: string;
|
|
6224
|
+
success: boolean;
|
|
6225
|
+
};
|
|
6226
|
+
};
|
|
6227
|
+
};
|
|
6228
|
+
400: components["responses"]["BadRequest"];
|
|
6229
|
+
401: components["responses"]["Unauthorized"];
|
|
6230
|
+
404: components["responses"]["NotFound"];
|
|
6231
|
+
};
|
|
6232
|
+
};
|
|
6093
6233
|
"redeem-gift-card": {
|
|
6094
6234
|
parameters: {
|
|
6095
6235
|
query?: never;
|
|
@@ -7593,6 +7733,88 @@ interface operations {
|
|
|
7593
7733
|
404: components["responses"]["NotFound"];
|
|
7594
7734
|
};
|
|
7595
7735
|
};
|
|
7736
|
+
"get-fulfillment-options": {
|
|
7737
|
+
parameters: {
|
|
7738
|
+
query?: never;
|
|
7739
|
+
header?: never;
|
|
7740
|
+
path?: never;
|
|
7741
|
+
cookie?: never;
|
|
7742
|
+
};
|
|
7743
|
+
requestBody: {
|
|
7744
|
+
content: {
|
|
7745
|
+
"application/json": components["schemas"]["CartBasedServiceabilityCheck"];
|
|
7746
|
+
};
|
|
7747
|
+
};
|
|
7748
|
+
responses: {
|
|
7749
|
+
/** @description OK */
|
|
7750
|
+
200: {
|
|
7751
|
+
headers: {
|
|
7752
|
+
[name: string]: unknown;
|
|
7753
|
+
};
|
|
7754
|
+
content: {
|
|
7755
|
+
"application/json": {
|
|
7756
|
+
message: string;
|
|
7757
|
+
success: boolean;
|
|
7758
|
+
content: {
|
|
7759
|
+
summary: {
|
|
7760
|
+
collect_available: boolean;
|
|
7761
|
+
deliver_available: boolean;
|
|
7762
|
+
/** @enum {unknown} */
|
|
7763
|
+
recommended_fulfillment_type: "collect-in-store" | "delivery";
|
|
7764
|
+
recommended_store?: components["schemas"]["CollectInStore"];
|
|
7765
|
+
};
|
|
7766
|
+
collect?: components["schemas"]["CollectInStore"][];
|
|
7767
|
+
deliver?: components["schemas"]["PincodeServiceability"];
|
|
7768
|
+
};
|
|
7769
|
+
};
|
|
7770
|
+
};
|
|
7771
|
+
};
|
|
7772
|
+
400: components["responses"]["BadRequest"];
|
|
7773
|
+
401: components["responses"]["Unauthorized"];
|
|
7774
|
+
404: components["responses"]["NotFound"];
|
|
7775
|
+
};
|
|
7776
|
+
};
|
|
7777
|
+
"get-pos-fulfillment-options": {
|
|
7778
|
+
parameters: {
|
|
7779
|
+
query?: never;
|
|
7780
|
+
header?: never;
|
|
7781
|
+
path?: never;
|
|
7782
|
+
cookie?: never;
|
|
7783
|
+
};
|
|
7784
|
+
requestBody: {
|
|
7785
|
+
content: {
|
|
7786
|
+
"application/json": components["schemas"]["CartBasedServiceabilityCheck"];
|
|
7787
|
+
};
|
|
7788
|
+
};
|
|
7789
|
+
responses: {
|
|
7790
|
+
/** @description OK */
|
|
7791
|
+
200: {
|
|
7792
|
+
headers: {
|
|
7793
|
+
[name: string]: unknown;
|
|
7794
|
+
};
|
|
7795
|
+
content: {
|
|
7796
|
+
"application/json": {
|
|
7797
|
+
message: string;
|
|
7798
|
+
success: boolean;
|
|
7799
|
+
content: {
|
|
7800
|
+
summary: {
|
|
7801
|
+
collect_available: boolean;
|
|
7802
|
+
deliver_available: boolean;
|
|
7803
|
+
/** @enum {unknown} */
|
|
7804
|
+
recommended_fulfillment_type: "collect-in-store" | "delivery";
|
|
7805
|
+
recommended_store?: components["schemas"]["CollectInStore"];
|
|
7806
|
+
};
|
|
7807
|
+
collect?: components["schemas"]["CollectInStore"][];
|
|
7808
|
+
deliver?: components["schemas"]["PincodeServiceability"];
|
|
7809
|
+
};
|
|
7810
|
+
};
|
|
7811
|
+
};
|
|
7812
|
+
};
|
|
7813
|
+
400: components["responses"]["BadRequest"];
|
|
7814
|
+
401: components["responses"]["Unauthorized"];
|
|
7815
|
+
404: components["responses"]["NotFound"];
|
|
7816
|
+
};
|
|
7817
|
+
};
|
|
7596
7818
|
"check-pincode-serviceability": {
|
|
7597
7819
|
parameters: {
|
|
7598
7820
|
query?: never;
|
|
@@ -9452,6 +9674,8 @@ interface operations {
|
|
|
9452
9674
|
};
|
|
9453
9675
|
};
|
|
9454
9676
|
};
|
|
9677
|
+
400: components["responses"]["BadRequest"];
|
|
9678
|
+
401: components["responses"]["Unauthorized"];
|
|
9455
9679
|
};
|
|
9456
9680
|
};
|
|
9457
9681
|
"login-pos-device-with-phone": {
|
|
@@ -9493,6 +9717,8 @@ interface operations {
|
|
|
9493
9717
|
};
|
|
9494
9718
|
};
|
|
9495
9719
|
};
|
|
9720
|
+
400: components["responses"]["BadRequest"];
|
|
9721
|
+
401: components["responses"]["Unauthorized"];
|
|
9496
9722
|
};
|
|
9497
9723
|
};
|
|
9498
9724
|
"login-pos-device-with-whatsapp": {
|
|
@@ -9534,6 +9760,8 @@ interface operations {
|
|
|
9534
9760
|
};
|
|
9535
9761
|
};
|
|
9536
9762
|
};
|
|
9763
|
+
400: components["responses"]["BadRequest"];
|
|
9764
|
+
401: components["responses"]["Unauthorized"];
|
|
9537
9765
|
};
|
|
9538
9766
|
};
|
|
9539
9767
|
"login-pos-device-with-email": {
|
|
@@ -9569,6 +9797,8 @@ interface operations {
|
|
|
9569
9797
|
};
|
|
9570
9798
|
};
|
|
9571
9799
|
};
|
|
9800
|
+
400: components["responses"]["BadRequest"];
|
|
9801
|
+
401: components["responses"]["Unauthorized"];
|
|
9572
9802
|
};
|
|
9573
9803
|
};
|
|
9574
9804
|
"verify-pos-login-otp": {
|
|
@@ -9611,6 +9841,8 @@ interface operations {
|
|
|
9611
9841
|
};
|
|
9612
9842
|
};
|
|
9613
9843
|
};
|
|
9844
|
+
400: components["responses"]["BadRequest"];
|
|
9845
|
+
401: components["responses"]["Unauthorized"];
|
|
9614
9846
|
};
|
|
9615
9847
|
};
|
|
9616
9848
|
"refresh-pos-access-token": {
|
|
@@ -9644,6 +9876,7 @@ interface operations {
|
|
|
9644
9876
|
};
|
|
9645
9877
|
};
|
|
9646
9878
|
};
|
|
9879
|
+
400: components["responses"]["BadRequest"];
|
|
9647
9880
|
};
|
|
9648
9881
|
};
|
|
9649
9882
|
"create-pos-cart": {
|
|
@@ -9676,6 +9909,8 @@ interface operations {
|
|
|
9676
9909
|
};
|
|
9677
9910
|
};
|
|
9678
9911
|
};
|
|
9912
|
+
400: components["responses"]["BadRequest"];
|
|
9913
|
+
401: components["responses"]["Unauthorized"];
|
|
9679
9914
|
};
|
|
9680
9915
|
};
|
|
9681
9916
|
"get-pos-cart": {
|
|
@@ -9709,6 +9944,8 @@ interface operations {
|
|
|
9709
9944
|
};
|
|
9710
9945
|
};
|
|
9711
9946
|
};
|
|
9947
|
+
401: components["responses"]["Unauthorized"];
|
|
9948
|
+
404: components["responses"]["NotFound"];
|
|
9712
9949
|
};
|
|
9713
9950
|
};
|
|
9714
9951
|
"update-pos-cart": {
|
|
@@ -9744,6 +9981,9 @@ interface operations {
|
|
|
9744
9981
|
};
|
|
9745
9982
|
};
|
|
9746
9983
|
};
|
|
9984
|
+
400: components["responses"]["BadRequest"];
|
|
9985
|
+
401: components["responses"]["Unauthorized"];
|
|
9986
|
+
404: components["responses"]["NotFound"];
|
|
9747
9987
|
};
|
|
9748
9988
|
};
|
|
9749
9989
|
"update-pos-cart-customer": {
|
|
@@ -9777,6 +10017,9 @@ interface operations {
|
|
|
9777
10017
|
};
|
|
9778
10018
|
};
|
|
9779
10019
|
};
|
|
10020
|
+
400: components["responses"]["BadRequest"];
|
|
10021
|
+
401: components["responses"]["Unauthorized"];
|
|
10022
|
+
404: components["responses"]["NotFound"];
|
|
9780
10023
|
};
|
|
9781
10024
|
};
|
|
9782
10025
|
"update-pos-cart-address": {
|
|
@@ -9813,6 +10056,9 @@ interface operations {
|
|
|
9813
10056
|
};
|
|
9814
10057
|
};
|
|
9815
10058
|
};
|
|
10059
|
+
400: components["responses"]["BadRequest"];
|
|
10060
|
+
401: components["responses"]["Unauthorized"];
|
|
10061
|
+
404: components["responses"]["NotFound"];
|
|
9816
10062
|
};
|
|
9817
10063
|
};
|
|
9818
10064
|
"order-created": {
|
|
@@ -10097,157 +10343,163 @@ interface operations {
|
|
|
10097
10343
|
};
|
|
10098
10344
|
}
|
|
10099
10345
|
|
|
10100
|
-
type AcceleratedRewardCouponPromotion = components[
|
|
10101
|
-
type AcceleratedRewardRule = components[
|
|
10102
|
-
type AdditionalProductDetails = components[
|
|
10103
|
-
type AnalyticsEvent = components[
|
|
10104
|
-
type AnonymousUser = components[
|
|
10105
|
-
type AppliedCoupon = components[
|
|
10106
|
-
type AppliedPromotion = components[
|
|
10107
|
-
type AssociatedOption = components[
|
|
10108
|
-
type AutoScaleBasedOnAmount = components[
|
|
10109
|
-
type AutoScaleBasedOnQuantity = components[
|
|
10110
|
-
type BankTransfer = components[
|
|
10111
|
-
type BooleanAttribute = components[
|
|
10112
|
-
type Brand = components[
|
|
10113
|
-
type Business = components[
|
|
10114
|
-
type BuyXGetYCouponPromotion = components[
|
|
10115
|
-
type BuyXGetYRule = components[
|
|
10116
|
-
type BuyXGetYRuleBasedOnAmount = components[
|
|
10117
|
-
type BuyXGetYRuleBasedOnQuantity = components[
|
|
10118
|
-
type CardPayment = components[
|
|
10119
|
-
type Cart = components[
|
|
10120
|
-
type CartBasedServiceabilityCheck = components[
|
|
10121
|
-
type CartItem = components[
|
|
10122
|
-
type Category = components[
|
|
10123
|
-
type
|
|
10124
|
-
type
|
|
10125
|
-
type
|
|
10126
|
-
type
|
|
10127
|
-
type
|
|
10128
|
-
type
|
|
10129
|
-
type
|
|
10130
|
-
type
|
|
10131
|
-
type
|
|
10132
|
-
type
|
|
10133
|
-
type
|
|
10134
|
-
type
|
|
10135
|
-
type
|
|
10136
|
-
type
|
|
10137
|
-
type
|
|
10138
|
-
type
|
|
10139
|
-
type
|
|
10140
|
-
type
|
|
10141
|
-
type
|
|
10142
|
-
type
|
|
10143
|
-
type
|
|
10144
|
-
type
|
|
10145
|
-
type
|
|
10146
|
-
type
|
|
10147
|
-
type
|
|
10148
|
-
type
|
|
10149
|
-
type
|
|
10150
|
-
type
|
|
10151
|
-
type
|
|
10152
|
-
type
|
|
10153
|
-
type
|
|
10154
|
-
type
|
|
10155
|
-
type
|
|
10156
|
-
type
|
|
10157
|
-
type
|
|
10158
|
-
type
|
|
10159
|
-
type
|
|
10160
|
-
type
|
|
10161
|
-
type
|
|
10162
|
-
type
|
|
10163
|
-
type
|
|
10164
|
-
type
|
|
10165
|
-
type
|
|
10166
|
-
type
|
|
10167
|
-
type
|
|
10168
|
-
type
|
|
10169
|
-
type
|
|
10170
|
-
type
|
|
10171
|
-
type
|
|
10172
|
-
type
|
|
10173
|
-
type
|
|
10174
|
-
type
|
|
10175
|
-
type
|
|
10176
|
-
type
|
|
10177
|
-
type
|
|
10178
|
-
type
|
|
10179
|
-
type
|
|
10180
|
-
type
|
|
10181
|
-
type
|
|
10182
|
-
type
|
|
10183
|
-
type
|
|
10184
|
-
type
|
|
10185
|
-
type
|
|
10186
|
-
type
|
|
10187
|
-
type
|
|
10188
|
-
type
|
|
10189
|
-
type
|
|
10190
|
-
type
|
|
10191
|
-
type
|
|
10192
|
-
type
|
|
10193
|
-
type
|
|
10194
|
-
type
|
|
10195
|
-
type
|
|
10196
|
-
type
|
|
10197
|
-
type
|
|
10198
|
-
type
|
|
10199
|
-
type
|
|
10200
|
-
type
|
|
10201
|
-
type
|
|
10202
|
-
type
|
|
10203
|
-
type
|
|
10204
|
-
type
|
|
10205
|
-
type
|
|
10206
|
-
type
|
|
10207
|
-
type
|
|
10208
|
-
type
|
|
10209
|
-
type
|
|
10210
|
-
type
|
|
10211
|
-
type
|
|
10212
|
-
type
|
|
10213
|
-
type
|
|
10214
|
-
type
|
|
10215
|
-
type
|
|
10216
|
-
type
|
|
10217
|
-
type
|
|
10218
|
-
type
|
|
10219
|
-
type
|
|
10220
|
-
type
|
|
10221
|
-
type
|
|
10222
|
-
type
|
|
10223
|
-
type
|
|
10224
|
-
type
|
|
10225
|
-
type
|
|
10226
|
-
type
|
|
10227
|
-
type
|
|
10228
|
-
type
|
|
10229
|
-
type
|
|
10230
|
-
type
|
|
10231
|
-
type
|
|
10232
|
-
type
|
|
10233
|
-
type
|
|
10234
|
-
type
|
|
10235
|
-
type
|
|
10236
|
-
type
|
|
10237
|
-
type
|
|
10238
|
-
type
|
|
10239
|
-
type
|
|
10240
|
-
type
|
|
10241
|
-
type
|
|
10242
|
-
type
|
|
10243
|
-
type
|
|
10244
|
-
type
|
|
10245
|
-
type
|
|
10246
|
-
type
|
|
10247
|
-
type
|
|
10248
|
-
type
|
|
10249
|
-
type
|
|
10250
|
-
type
|
|
10346
|
+
type AcceleratedRewardCouponPromotion = components['schemas']['AcceleratedRewardCouponPromotion'];
|
|
10347
|
+
type AcceleratedRewardRule = components['schemas']['AcceleratedRewardRule'];
|
|
10348
|
+
type AdditionalProductDetails = components['schemas']['AdditionalProductDetails'];
|
|
10349
|
+
type AnalyticsEvent = components['schemas']['AnalyticsEvent'];
|
|
10350
|
+
type AnonymousUser = components['schemas']['AnonymousUser'];
|
|
10351
|
+
type AppliedCoupon = components['schemas']['AppliedCoupon'];
|
|
10352
|
+
type AppliedPromotion = components['schemas']['AppliedPromotion'];
|
|
10353
|
+
type AssociatedOption = components['schemas']['AssociatedOption'];
|
|
10354
|
+
type AutoScaleBasedOnAmount = components['schemas']['AutoScaleBasedOnAmount'];
|
|
10355
|
+
type AutoScaleBasedOnQuantity = components['schemas']['AutoScaleBasedOnQuantity'];
|
|
10356
|
+
type BankTransfer = components['schemas']['BankTransfer'];
|
|
10357
|
+
type BooleanAttribute = components['schemas']['BooleanAttribute'];
|
|
10358
|
+
type Brand = components['schemas']['Brand'];
|
|
10359
|
+
type Business = components['schemas']['Business'];
|
|
10360
|
+
type BuyXGetYCouponPromotion = components['schemas']['BuyXGetYCouponPromotion'];
|
|
10361
|
+
type BuyXGetYRule = components['schemas']['BuyXGetYRule'];
|
|
10362
|
+
type BuyXGetYRuleBasedOnAmount = components['schemas']['BuyXGetYRuleBasedOnAmount'];
|
|
10363
|
+
type BuyXGetYRuleBasedOnQuantity = components['schemas']['BuyXGetYRuleBasedOnQuantity'];
|
|
10364
|
+
type CardPayment = components['schemas']['CardPayment'];
|
|
10365
|
+
type Cart = components['schemas']['Cart'];
|
|
10366
|
+
type CartBasedServiceabilityCheck = components['schemas']['CartBasedServiceabilityCheck'];
|
|
10367
|
+
type CartItem = components['schemas']['CartItem'];
|
|
10368
|
+
type Category = components['schemas']['Category'];
|
|
10369
|
+
type CollectInStore = components['schemas']['CollectInStore'];
|
|
10370
|
+
type CollectInStoreFulfillment = components['schemas']['CollectInStoreFulfillment'];
|
|
10371
|
+
type ColorAttribute = components['schemas']['ColorAttribute'];
|
|
10372
|
+
type ColorOption = components['schemas']['ColorOption'];
|
|
10373
|
+
type Country = components['schemas']['Country'];
|
|
10374
|
+
type CountryState = components['schemas']['CountryState'];
|
|
10375
|
+
type Coupon = components['schemas']['Coupon'];
|
|
10376
|
+
type CouponPromotionCommonDetail = components['schemas']['CouponPromotionCommonDetail'];
|
|
10377
|
+
type CreateCustomSubscription = components['schemas']['CreateCustomSubscription'];
|
|
10378
|
+
type CreateCustomer = components['schemas']['CreateCustomer'];
|
|
10379
|
+
type CreateOrderReturn = components['schemas']['CreateOrderReturn'];
|
|
10380
|
+
type CreateReview = components['schemas']['CreateReview'];
|
|
10381
|
+
type CreateStandardSubscription = components['schemas']['CreateStandardSubscription'];
|
|
10382
|
+
type CreateSubscription = components['schemas']['CreateSubscription'];
|
|
10383
|
+
type Currency = components['schemas']['Currency'];
|
|
10384
|
+
type CustomSlabsBasedOnAmount = components['schemas']['CustomSlabsBasedOnAmount'];
|
|
10385
|
+
type CustomSlabsBasedOnQuantity = components['schemas']['CustomSlabsBasedOnQuantity'];
|
|
10386
|
+
type CustomerAddress = components['schemas']['CustomerAddress'];
|
|
10387
|
+
type CustomerDetail = components['schemas']['CustomerDetail'];
|
|
10388
|
+
type CustomerGroup = components['schemas']['CustomerGroup'];
|
|
10389
|
+
type CustomerLoyalty = components['schemas']['CustomerLoyalty'];
|
|
10390
|
+
type CustomerReadyForReview = components['schemas']['CustomerReadyForReview'];
|
|
10391
|
+
type CustomerReview = components['schemas']['CustomerReview'];
|
|
10392
|
+
type DateAttribute = components['schemas']['DateAttribute'];
|
|
10393
|
+
type DeliveryFulfillment = components['schemas']['DeliveryFulfillment'];
|
|
10394
|
+
type DiscountBasedPromotion = components['schemas']['DiscountBasedPromotion'];
|
|
10395
|
+
type DiscountCouponPromotion = components['schemas']['DiscountCouponPromotion'];
|
|
10396
|
+
type DiscountRule = components['schemas']['DiscountRule'];
|
|
10397
|
+
type Document = components['schemas']['Document'];
|
|
10398
|
+
type FixedAmountDiscountRule = components['schemas']['FixedAmountDiscountRule'];
|
|
10399
|
+
type FixedPriceCouponPromotion = components['schemas']['FixedPriceCouponPromotion'];
|
|
10400
|
+
type FixedPricePromotion = components['schemas']['FixedPricePromotion'];
|
|
10401
|
+
type FixedPriceRule = components['schemas']['FixedPriceRule'];
|
|
10402
|
+
type FixedPriceRuleBasedAmount = components['schemas']['FixedPriceRuleBasedAmount'];
|
|
10403
|
+
type FixedPriceRuleBasedQuantity = components['schemas']['FixedPriceRuleBasedQuantity'];
|
|
10404
|
+
type FreeGoodCouponPromotion = components['schemas']['FreeGoodCouponPromotion'];
|
|
10405
|
+
type FreeGoodsPromotion = components['schemas']['FreeGoodsPromotion'];
|
|
10406
|
+
type FreeGoodsRule = components['schemas']['FreeGoodsRule'];
|
|
10407
|
+
type FreeShipingCouponPromotion = components['schemas']['FreeShipingCouponPromotion'];
|
|
10408
|
+
type GenerateOtpWithEmail = components['schemas']['GenerateOtpWithEmail'];
|
|
10409
|
+
type GenerateOtpWithPhone = components['schemas']['GenerateOtpWithPhone'];
|
|
10410
|
+
type GstinDetail = components['schemas']['GstinDetail'];
|
|
10411
|
+
type Item = components['schemas']['Item'];
|
|
10412
|
+
type JuspayCardPayload = components['schemas']['JuspayCardPayload'];
|
|
10413
|
+
type JuspayCreateCardResponse = components['schemas']['JuspayCreateCardResponse'];
|
|
10414
|
+
type JuspayCreateCustomerPayload = components['schemas']['JuspayCreateCustomerPayload'];
|
|
10415
|
+
type JuspayCreateOrderPayload = components['schemas']['JuspayCreateOrderPayload'];
|
|
10416
|
+
type JuspayCustomer = components['schemas']['JuspayCustomer'];
|
|
10417
|
+
type JuspayOrder = components['schemas']['JuspayOrder'];
|
|
10418
|
+
type JuspayPaymentGatewayParams = components['schemas']['JuspayPaymentGatewayParams'];
|
|
10419
|
+
type JuspayPaymentInfo = components['schemas']['JuspayPaymentInfo'];
|
|
10420
|
+
type JuspayPaymentMethod = components['schemas']['JuspayPaymentMethod'];
|
|
10421
|
+
type JuspaySavedCard = components['schemas']['JuspaySavedCard'];
|
|
10422
|
+
type KycDocument = components['schemas']['KycDocument'];
|
|
10423
|
+
type KycDocumentConfig = components['schemas']['KycDocumentConfig'];
|
|
10424
|
+
type LoyaltyPointActivity = components['schemas']['LoyaltyPointActivity'];
|
|
10425
|
+
type MeasurementUnit = components['schemas']['MeasurementUnit'];
|
|
10426
|
+
type MultiSelectAttribute = components['schemas']['MultiSelectAttribute'];
|
|
10427
|
+
type NetbankingPayment = components['schemas']['NetbankingPayment'];
|
|
10428
|
+
type NotificationChannelPreferences = components['schemas']['NotificationChannelPreferences'];
|
|
10429
|
+
type NotificationPreferences = components['schemas']['NotificationPreferences'];
|
|
10430
|
+
type NumberAttribute = components['schemas']['NumberAttribute'];
|
|
10431
|
+
type Order = components['schemas']['Order'];
|
|
10432
|
+
type OrderDetail = components['schemas']['OrderDetail'];
|
|
10433
|
+
type OrderItem = components['schemas']['OrderItem'];
|
|
10434
|
+
type OrderList = components['schemas']['OrderList'];
|
|
10435
|
+
type OrderPayment = components['schemas']['OrderPayment'];
|
|
10436
|
+
type OrderRefund = components['schemas']['OrderRefund'];
|
|
10437
|
+
type OrderReturn = components['schemas']['OrderReturn'];
|
|
10438
|
+
type OrderReturnItem = components['schemas']['OrderReturnItem'];
|
|
10439
|
+
type OrderShipment = components['schemas']['OrderShipment'];
|
|
10440
|
+
type POSCollectInStoreFulfillment = components['schemas']['POSCollectInStoreFulfillment'];
|
|
10441
|
+
type POSDeliveryFulfillment = components['schemas']['POSDeliveryFulfillment'];
|
|
10442
|
+
type POSPartialCollectAndDeliveryFulfillment = components['schemas']['POSPartialCollectAndDeliveryFulfillment'];
|
|
10443
|
+
type Pagination = components['schemas']['Pagination'];
|
|
10444
|
+
type PanDetail = components['schemas']['PanDetail'];
|
|
10445
|
+
type PauseSubscription = components['schemas']['PauseSubscription'];
|
|
10446
|
+
type PaymentInfo = components['schemas']['PaymentInfo'];
|
|
10447
|
+
type PayuCardPayload = components['schemas']['PayuCardPayload'];
|
|
10448
|
+
type PayuCreateCardResponse = components['schemas']['PayuCreateCardResponse'];
|
|
10449
|
+
type PayuPaymentGatewayParams = components['schemas']['PayuPaymentGatewayParams'];
|
|
10450
|
+
type PayuPaymentInfo = components['schemas']['PayuPaymentInfo'];
|
|
10451
|
+
type PayuPaymentMethod = components['schemas']['PayuPaymentMethod'];
|
|
10452
|
+
type PayuSavedCard = components['schemas']['PayuSavedCard'];
|
|
10453
|
+
type PercentageDiscountRule = components['schemas']['PercentageDiscountRule'];
|
|
10454
|
+
type Pincode = components['schemas']['Pincode'];
|
|
10455
|
+
type PincodeServiceability = components['schemas']['PincodeServiceability'];
|
|
10456
|
+
type PosDevice = components['schemas']['PosDevice'];
|
|
10457
|
+
type PosUpdateCustomerWithEmail = components['schemas']['PosUpdateCustomerWithEmail'];
|
|
10458
|
+
type PosUpdateCustomerWithId = components['schemas']['PosUpdateCustomerWithId'];
|
|
10459
|
+
type PosUpdateCustomerWithPhone = components['schemas']['PosUpdateCustomerWithPhone'];
|
|
10460
|
+
type PosUser = components['schemas']['PosUser'];
|
|
10461
|
+
type Product = components['schemas']['Product'];
|
|
10462
|
+
type ProductAttribute = components['schemas']['ProductAttribute'];
|
|
10463
|
+
type ProductBundleItem = components['schemas']['ProductBundleItem'];
|
|
10464
|
+
type ProductCategory = components['schemas']['ProductCategory'];
|
|
10465
|
+
type ProductDetail = components['schemas']['ProductDetail'];
|
|
10466
|
+
type ProductImage = components['schemas']['ProductImage'];
|
|
10467
|
+
type ProductPricing = components['schemas']['ProductPricing'];
|
|
10468
|
+
type ProductPromotion = components['schemas']['ProductPromotion'];
|
|
10469
|
+
type ProductReview = components['schemas']['ProductReview'];
|
|
10470
|
+
type ProductShipping = components['schemas']['ProductShipping'];
|
|
10471
|
+
type ProductSubscription = components['schemas']['ProductSubscription'];
|
|
10472
|
+
type ProductVideo = components['schemas']['ProductVideo'];
|
|
10473
|
+
type Promotion = components['schemas']['Promotion'];
|
|
10474
|
+
type RegisterWithEmailPassword = components['schemas']['RegisterWithEmailPassword'];
|
|
10475
|
+
type RegisterWithPhonePassword = components['schemas']['RegisterWithPhonePassword'];
|
|
10476
|
+
type RevokeSubscription = components['schemas']['RevokeSubscription'];
|
|
10477
|
+
type SearchProduct = components['schemas']['SearchProduct'];
|
|
10478
|
+
type Seo = components['schemas']['Seo'];
|
|
10479
|
+
type ShipmentItem = components['schemas']['ShipmentItem'];
|
|
10480
|
+
type SingleSelectAttribute = components['schemas']['SingleSelectAttribute'];
|
|
10481
|
+
type SingleSelectOption = components['schemas']['SingleSelectOption'];
|
|
10482
|
+
type StoreConfig = components['schemas']['StoreConfig'];
|
|
10483
|
+
type StoreTemplate = components['schemas']['StoreTemplate'];
|
|
10484
|
+
type Subscription = components['schemas']['Subscription'];
|
|
10485
|
+
type SubscriptionBehaviour = components['schemas']['SubscriptionBehaviour'];
|
|
10486
|
+
type SubscriptionDetail = components['schemas']['SubscriptionDetail'];
|
|
10487
|
+
type SubscriptionInvoiceItem = components['schemas']['SubscriptionInvoiceItem'];
|
|
10488
|
+
type TextAttribute = components['schemas']['TextAttribute'];
|
|
10489
|
+
type UpdateCartItem = components['schemas']['UpdateCartItem'];
|
|
10490
|
+
type UpdateCustomer = components['schemas']['UpdateCustomer'];
|
|
10491
|
+
type UpdateDigitalProductSubscription = components['schemas']['UpdateDigitalProductSubscription'];
|
|
10492
|
+
type UpdateDocument = components['schemas']['UpdateDocument'];
|
|
10493
|
+
type UpdatePhysicalProductSubscription = components['schemas']['UpdatePhysicalProductSubscription'];
|
|
10494
|
+
type UpiPayment = components['schemas']['UpiPayment'];
|
|
10495
|
+
type User = components['schemas']['User'];
|
|
10496
|
+
type Variant = components['schemas']['Variant'];
|
|
10497
|
+
type VariantDetail = components['schemas']['VariantDetail'];
|
|
10498
|
+
type VariantOption = components['schemas']['VariantOption'];
|
|
10499
|
+
type VolumeBasedCouponPromotion = components['schemas']['VolumeBasedCouponPromotion'];
|
|
10500
|
+
type VolumeBasedPromotion = components['schemas']['VolumeBasedPromotion'];
|
|
10501
|
+
type VolumeBasedRule = components['schemas']['VolumeBasedRule'];
|
|
10502
|
+
type WalletPayment = components['schemas']['WalletPayment'];
|
|
10251
10503
|
type ApiResult<T> = {
|
|
10252
10504
|
data: T;
|
|
10253
10505
|
error: null;
|
|
@@ -10263,410 +10515,418 @@ type ApiErrorResponse = {
|
|
|
10263
10515
|
code?: string;
|
|
10264
10516
|
message?: string;
|
|
10265
10517
|
};
|
|
10266
|
-
type ListProductsResponse = paths[
|
|
10267
|
-
type ListProductsContent = ListProductsResponse[
|
|
10268
|
-
type ListProductsQuery = paths[
|
|
10269
|
-
type ListProductsHeaderParams = paths[
|
|
10270
|
-
type ListSkusResponse = paths[
|
|
10271
|
-
type ListSkusContent = ListSkusResponse[
|
|
10272
|
-
type ListSkusQuery = paths[
|
|
10273
|
-
type ListSkusHeaderParams = paths[
|
|
10274
|
-
type GetProductDetailResponse = paths[
|
|
10275
|
-
type GetProductDetailContent = GetProductDetailResponse[
|
|
10276
|
-
type GetProductDetailPathParams = paths[
|
|
10277
|
-
type GetProductDetailHeaderParams = paths[
|
|
10278
|
-
type ListProductVariantsResponse = paths[
|
|
10279
|
-
type ListProductVariantsContent = ListProductVariantsResponse[
|
|
10280
|
-
type ListProductVariantsPathParams = paths[
|
|
10281
|
-
type ListProductVariantsHeaderParams = paths[
|
|
10282
|
-
type GetVariantDetailResponse = paths[
|
|
10283
|
-
type GetVariantDetailContent = GetVariantDetailResponse[
|
|
10284
|
-
type GetVariantDetailPathParams = paths[
|
|
10285
|
-
type GetVariantDetailHeaderParams = paths[
|
|
10286
|
-
type ListCategoriesResponse = paths[
|
|
10287
|
-
type ListCategoriesContent = ListCategoriesResponse[
|
|
10288
|
-
type ListCategoriesQuery = paths[
|
|
10289
|
-
type ListProductReviewsResponse = paths[
|
|
10290
|
-
type ListProductReviewsContent = ListProductReviewsResponse[
|
|
10291
|
-
type ListProductReviewsQuery = paths[
|
|
10292
|
-
type ListProductReviewsPathParams = paths[
|
|
10293
|
-
type CreateProductReviewResponse = paths[
|
|
10294
|
-
type CreateProductReviewPathParams = paths[
|
|
10295
|
-
type CreateProductReviewFormData = NonNullable<paths[
|
|
10296
|
-
type ListSimilarProductsResponse = paths[
|
|
10297
|
-
type ListSimilarProductsContent = ListSimilarProductsResponse[
|
|
10298
|
-
type ListSimilarProductsQuery = paths[
|
|
10299
|
-
type ListSimilarProductsHeaderParams = paths[
|
|
10300
|
-
type ListUpsellProductsResponse = paths[
|
|
10301
|
-
type ListUpsellProductsContent = ListUpsellProductsResponse[
|
|
10302
|
-
type ListUpsellProductsQuery = paths[
|
|
10303
|
-
type ListUpsellProductsHeaderParams = paths[
|
|
10304
|
-
type ListCrosssellProductsResponse = paths[
|
|
10305
|
-
type ListCrosssellProductsContent = ListCrosssellProductsResponse[
|
|
10306
|
-
type ListCrosssellProductsQuery = paths[
|
|
10307
|
-
type ListCrosssellProductsHeaderParams = paths[
|
|
10308
|
-
type SearchProductsResponse = paths[
|
|
10309
|
-
type SearchProductsContent = SearchProductsResponse[
|
|
10310
|
-
type SearchProductsHeaderParams = paths[
|
|
10311
|
-
type SearchProductsBody = NonNullable<paths[
|
|
10312
|
-
type CreateCartResponse = paths[
|
|
10313
|
-
type CreateCartContent = CreateCartResponse[
|
|
10314
|
-
type CreateCartBody = NonNullable<paths[
|
|
10315
|
-
type GetCartResponse = paths[
|
|
10316
|
-
type GetCartContent = GetCartResponse[
|
|
10317
|
-
type GetCartPathParams = paths[
|
|
10318
|
-
type DeleteCartResponse = paths[
|
|
10319
|
-
type DeleteCartPathParams = paths[
|
|
10320
|
-
type GetUserCartResponse = paths[
|
|
10321
|
-
type GetUserCartContent = GetUserCartResponse[
|
|
10322
|
-
type GetUserCartPathParams = paths[
|
|
10323
|
-
type DeleteUserCartResponse = paths[
|
|
10324
|
-
type DeleteUserCartPathParams = paths[
|
|
10325
|
-
type UpdateCartResponse = paths[
|
|
10326
|
-
type UpdateCartContent = UpdateCartResponse[
|
|
10327
|
-
type UpdateCartPathParams = paths[
|
|
10328
|
-
type UpdateCartBody = NonNullable<paths[
|
|
10329
|
-
type CreateCartAddressResponse = paths[
|
|
10330
|
-
type CreateCartAddressContent = CreateCartAddressResponse[
|
|
10331
|
-
type CreateCartAddressPathParams = paths[
|
|
10332
|
-
type CreateCartAddressBody = NonNullable<paths[
|
|
10333
|
-
type
|
|
10334
|
-
type
|
|
10335
|
-
type
|
|
10336
|
-
type
|
|
10337
|
-
type
|
|
10338
|
-
type
|
|
10339
|
-
type
|
|
10340
|
-
type
|
|
10341
|
-
type
|
|
10342
|
-
type
|
|
10343
|
-
type
|
|
10344
|
-
type
|
|
10345
|
-
type
|
|
10346
|
-
type
|
|
10347
|
-
type
|
|
10348
|
-
type
|
|
10349
|
-
type
|
|
10350
|
-
type
|
|
10351
|
-
type
|
|
10352
|
-
type
|
|
10353
|
-
type
|
|
10354
|
-
type
|
|
10355
|
-
type
|
|
10356
|
-
type
|
|
10357
|
-
type
|
|
10358
|
-
type
|
|
10359
|
-
type
|
|
10360
|
-
type
|
|
10361
|
-
type
|
|
10362
|
-
type
|
|
10363
|
-
type
|
|
10364
|
-
type
|
|
10365
|
-
type
|
|
10366
|
-
type
|
|
10367
|
-
type
|
|
10368
|
-
type
|
|
10369
|
-
type
|
|
10370
|
-
type
|
|
10371
|
-
type
|
|
10372
|
-
type
|
|
10373
|
-
type
|
|
10374
|
-
type
|
|
10375
|
-
type
|
|
10376
|
-
type
|
|
10377
|
-
type
|
|
10378
|
-
type
|
|
10379
|
-
type
|
|
10380
|
-
type
|
|
10381
|
-
type
|
|
10382
|
-
type
|
|
10383
|
-
type
|
|
10384
|
-
type
|
|
10385
|
-
type
|
|
10386
|
-
type
|
|
10387
|
-
type
|
|
10388
|
-
type
|
|
10389
|
-
type
|
|
10390
|
-
type
|
|
10391
|
-
type
|
|
10392
|
-
type
|
|
10393
|
-
type
|
|
10394
|
-
type
|
|
10395
|
-
type
|
|
10396
|
-
type
|
|
10397
|
-
type
|
|
10398
|
-
type
|
|
10399
|
-
type
|
|
10400
|
-
type
|
|
10401
|
-
type
|
|
10402
|
-
type
|
|
10403
|
-
type
|
|
10404
|
-
type
|
|
10405
|
-
type
|
|
10406
|
-
type
|
|
10407
|
-
type
|
|
10408
|
-
type
|
|
10409
|
-
type
|
|
10410
|
-
type
|
|
10411
|
-
type
|
|
10412
|
-
type
|
|
10413
|
-
type
|
|
10414
|
-
type
|
|
10415
|
-
type
|
|
10416
|
-
type
|
|
10417
|
-
type
|
|
10418
|
-
type
|
|
10419
|
-
type
|
|
10420
|
-
type
|
|
10421
|
-
type
|
|
10422
|
-
type
|
|
10423
|
-
type
|
|
10424
|
-
type
|
|
10425
|
-
type
|
|
10426
|
-
type
|
|
10427
|
-
type
|
|
10428
|
-
type
|
|
10429
|
-
type
|
|
10430
|
-
type
|
|
10431
|
-
type
|
|
10432
|
-
type
|
|
10433
|
-
type
|
|
10434
|
-
type
|
|
10435
|
-
type
|
|
10436
|
-
type
|
|
10437
|
-
type
|
|
10438
|
-
type
|
|
10439
|
-
type
|
|
10440
|
-
type
|
|
10441
|
-
type
|
|
10442
|
-
type
|
|
10443
|
-
type
|
|
10444
|
-
type
|
|
10445
|
-
type
|
|
10446
|
-
type
|
|
10447
|
-
type
|
|
10448
|
-
type
|
|
10449
|
-
type
|
|
10450
|
-
type
|
|
10451
|
-
type
|
|
10452
|
-
type
|
|
10453
|
-
type
|
|
10454
|
-
type
|
|
10455
|
-
type
|
|
10456
|
-
type
|
|
10457
|
-
type
|
|
10458
|
-
type
|
|
10459
|
-
type
|
|
10460
|
-
type
|
|
10461
|
-
type
|
|
10462
|
-
type
|
|
10463
|
-
type
|
|
10464
|
-
type
|
|
10465
|
-
type
|
|
10466
|
-
type
|
|
10467
|
-
type
|
|
10468
|
-
type
|
|
10469
|
-
type
|
|
10470
|
-
type
|
|
10471
|
-
type
|
|
10472
|
-
type
|
|
10473
|
-
type
|
|
10474
|
-
type
|
|
10475
|
-
type
|
|
10476
|
-
type
|
|
10477
|
-
type
|
|
10478
|
-
type
|
|
10479
|
-
type
|
|
10480
|
-
type
|
|
10481
|
-
type
|
|
10482
|
-
type
|
|
10483
|
-
type
|
|
10484
|
-
type
|
|
10485
|
-
type
|
|
10486
|
-
type
|
|
10487
|
-
type
|
|
10488
|
-
type
|
|
10489
|
-
type
|
|
10490
|
-
type
|
|
10491
|
-
type
|
|
10492
|
-
type
|
|
10493
|
-
type
|
|
10494
|
-
type
|
|
10495
|
-
type
|
|
10496
|
-
type
|
|
10497
|
-
type
|
|
10498
|
-
type
|
|
10499
|
-
type
|
|
10500
|
-
type
|
|
10501
|
-
type
|
|
10502
|
-
type
|
|
10503
|
-
type
|
|
10504
|
-
type
|
|
10505
|
-
type
|
|
10506
|
-
type
|
|
10507
|
-
type
|
|
10508
|
-
type
|
|
10509
|
-
type
|
|
10510
|
-
type
|
|
10511
|
-
type
|
|
10512
|
-
type
|
|
10513
|
-
type
|
|
10514
|
-
type
|
|
10515
|
-
type
|
|
10516
|
-
type
|
|
10517
|
-
type
|
|
10518
|
-
type
|
|
10519
|
-
type
|
|
10520
|
-
type
|
|
10521
|
-
type
|
|
10522
|
-
type
|
|
10523
|
-
type
|
|
10524
|
-
type
|
|
10525
|
-
type
|
|
10526
|
-
type
|
|
10527
|
-
type
|
|
10528
|
-
type
|
|
10529
|
-
type
|
|
10530
|
-
type
|
|
10531
|
-
type
|
|
10532
|
-
type
|
|
10533
|
-
type
|
|
10534
|
-
type
|
|
10535
|
-
type
|
|
10536
|
-
type
|
|
10537
|
-
type
|
|
10538
|
-
type
|
|
10539
|
-
type
|
|
10540
|
-
type
|
|
10541
|
-
type
|
|
10542
|
-
type
|
|
10543
|
-
type
|
|
10544
|
-
type
|
|
10545
|
-
type
|
|
10546
|
-
type
|
|
10547
|
-
type
|
|
10548
|
-
type
|
|
10549
|
-
type
|
|
10550
|
-
type
|
|
10551
|
-
type
|
|
10552
|
-
type
|
|
10553
|
-
type
|
|
10554
|
-
type
|
|
10555
|
-
type
|
|
10556
|
-
type
|
|
10557
|
-
type
|
|
10558
|
-
type
|
|
10559
|
-
type
|
|
10560
|
-
type
|
|
10561
|
-
type
|
|
10562
|
-
type
|
|
10563
|
-
type
|
|
10564
|
-
type
|
|
10565
|
-
type
|
|
10566
|
-
type
|
|
10567
|
-
type
|
|
10568
|
-
type
|
|
10569
|
-
type
|
|
10570
|
-
type
|
|
10571
|
-
type
|
|
10572
|
-
type
|
|
10573
|
-
type
|
|
10574
|
-
type
|
|
10575
|
-
type
|
|
10576
|
-
type
|
|
10577
|
-
type
|
|
10578
|
-
type
|
|
10579
|
-
type
|
|
10580
|
-
type
|
|
10581
|
-
type
|
|
10582
|
-
type
|
|
10583
|
-
type
|
|
10584
|
-
type
|
|
10585
|
-
type
|
|
10586
|
-
type
|
|
10587
|
-
type
|
|
10588
|
-
type
|
|
10589
|
-
type
|
|
10590
|
-
type
|
|
10591
|
-
type
|
|
10592
|
-
type
|
|
10593
|
-
type
|
|
10594
|
-
type
|
|
10595
|
-
type
|
|
10596
|
-
type
|
|
10597
|
-
type
|
|
10598
|
-
type
|
|
10599
|
-
type
|
|
10600
|
-
type
|
|
10601
|
-
type
|
|
10602
|
-
type
|
|
10603
|
-
type
|
|
10604
|
-
type
|
|
10605
|
-
type
|
|
10606
|
-
type
|
|
10607
|
-
type
|
|
10608
|
-
type
|
|
10609
|
-
type
|
|
10610
|
-
type
|
|
10611
|
-
type
|
|
10612
|
-
type
|
|
10613
|
-
type
|
|
10614
|
-
type
|
|
10615
|
-
type
|
|
10616
|
-
type
|
|
10617
|
-
type
|
|
10618
|
-
type
|
|
10619
|
-
type
|
|
10620
|
-
type
|
|
10621
|
-
type
|
|
10622
|
-
type
|
|
10623
|
-
type
|
|
10624
|
-
type
|
|
10625
|
-
type
|
|
10626
|
-
type
|
|
10627
|
-
type
|
|
10628
|
-
type
|
|
10629
|
-
type
|
|
10630
|
-
type
|
|
10631
|
-
type
|
|
10632
|
-
type
|
|
10633
|
-
type
|
|
10634
|
-
type
|
|
10635
|
-
type
|
|
10636
|
-
type
|
|
10637
|
-
type
|
|
10638
|
-
type
|
|
10639
|
-
type
|
|
10640
|
-
type
|
|
10641
|
-
type
|
|
10642
|
-
type
|
|
10643
|
-
type
|
|
10644
|
-
type
|
|
10645
|
-
type
|
|
10646
|
-
type
|
|
10647
|
-
type
|
|
10648
|
-
type
|
|
10649
|
-
type
|
|
10650
|
-
type
|
|
10651
|
-
type
|
|
10652
|
-
type
|
|
10653
|
-
type
|
|
10654
|
-
type
|
|
10655
|
-
type
|
|
10656
|
-
type
|
|
10657
|
-
type
|
|
10658
|
-
type
|
|
10659
|
-
type
|
|
10660
|
-
type
|
|
10661
|
-
type
|
|
10662
|
-
type
|
|
10663
|
-
type
|
|
10664
|
-
type
|
|
10665
|
-
type
|
|
10666
|
-
type
|
|
10667
|
-
type
|
|
10668
|
-
type
|
|
10669
|
-
type
|
|
10518
|
+
type ListProductsResponse = paths['/catalog/products']['get']['responses'][200]['content']['application/json'];
|
|
10519
|
+
type ListProductsContent = ListProductsResponse['content'];
|
|
10520
|
+
type ListProductsQuery = paths['/catalog/products']['get']['parameters']['query'];
|
|
10521
|
+
type ListProductsHeaderParams = paths['/catalog/products']['get']['parameters']['header'];
|
|
10522
|
+
type ListSkusResponse = paths['/catalog/skus']['get']['responses'][200]['content']['application/json'];
|
|
10523
|
+
type ListSkusContent = ListSkusResponse['content'];
|
|
10524
|
+
type ListSkusQuery = paths['/catalog/skus']['get']['parameters']['query'];
|
|
10525
|
+
type ListSkusHeaderParams = paths['/catalog/skus']['get']['parameters']['header'];
|
|
10526
|
+
type GetProductDetailResponse = paths['/catalog/products/{product_id_or_slug}']['get']['responses'][200]['content']['application/json'];
|
|
10527
|
+
type GetProductDetailContent = GetProductDetailResponse['content'];
|
|
10528
|
+
type GetProductDetailPathParams = paths['/catalog/products/{product_id_or_slug}']['get']['parameters']['path'];
|
|
10529
|
+
type GetProductDetailHeaderParams = paths['/catalog/products/{product_id_or_slug}']['get']['parameters']['header'];
|
|
10530
|
+
type ListProductVariantsResponse = paths['/catalog/products/{product_id}/variants']['get']['responses'][200]['content']['application/json'];
|
|
10531
|
+
type ListProductVariantsContent = ListProductVariantsResponse['content'];
|
|
10532
|
+
type ListProductVariantsPathParams = paths['/catalog/products/{product_id}/variants']['get']['parameters']['path'];
|
|
10533
|
+
type ListProductVariantsHeaderParams = paths['/catalog/products/{product_id}/variants']['get']['parameters']['header'];
|
|
10534
|
+
type GetVariantDetailResponse = paths['/catalog/products/{product_id}/variants/{variant_id}']['get']['responses'][200]['content']['application/json'];
|
|
10535
|
+
type GetVariantDetailContent = GetVariantDetailResponse['content'];
|
|
10536
|
+
type GetVariantDetailPathParams = paths['/catalog/products/{product_id}/variants/{variant_id}']['get']['parameters']['path'];
|
|
10537
|
+
type GetVariantDetailHeaderParams = paths['/catalog/products/{product_id}/variants/{variant_id}']['get']['parameters']['header'];
|
|
10538
|
+
type ListCategoriesResponse = paths['/catalog/categories']['get']['responses'][200]['content']['application/json'];
|
|
10539
|
+
type ListCategoriesContent = ListCategoriesResponse['content'];
|
|
10540
|
+
type ListCategoriesQuery = paths['/catalog/categories']['get']['parameters']['query'];
|
|
10541
|
+
type ListProductReviewsResponse = paths['/catalog/products/{product_id}/reviews']['get']['responses'][200]['content']['application/json'];
|
|
10542
|
+
type ListProductReviewsContent = ListProductReviewsResponse['content'];
|
|
10543
|
+
type ListProductReviewsQuery = paths['/catalog/products/{product_id}/reviews']['get']['parameters']['query'];
|
|
10544
|
+
type ListProductReviewsPathParams = paths['/catalog/products/{product_id}/reviews']['get']['parameters']['path'];
|
|
10545
|
+
type CreateProductReviewResponse = paths['/catalog/products/{product_id}/reviews']['post']['responses'][200]['content']['application/json'];
|
|
10546
|
+
type CreateProductReviewPathParams = paths['/catalog/products/{product_id}/reviews']['post']['parameters']['path'];
|
|
10547
|
+
type CreateProductReviewFormData = NonNullable<paths['/catalog/products/{product_id}/reviews']['post']['requestBody']>['content']['multipart/form-data'];
|
|
10548
|
+
type ListSimilarProductsResponse = paths['/catalog/products/similar']['get']['responses'][200]['content']['application/json'];
|
|
10549
|
+
type ListSimilarProductsContent = ListSimilarProductsResponse['content'];
|
|
10550
|
+
type ListSimilarProductsQuery = paths['/catalog/products/similar']['get']['parameters']['query'];
|
|
10551
|
+
type ListSimilarProductsHeaderParams = paths['/catalog/products/similar']['get']['parameters']['header'];
|
|
10552
|
+
type ListUpsellProductsResponse = paths['/catalog/products/up-sell']['get']['responses'][200]['content']['application/json'];
|
|
10553
|
+
type ListUpsellProductsContent = ListUpsellProductsResponse['content'];
|
|
10554
|
+
type ListUpsellProductsQuery = paths['/catalog/products/up-sell']['get']['parameters']['query'];
|
|
10555
|
+
type ListUpsellProductsHeaderParams = paths['/catalog/products/up-sell']['get']['parameters']['header'];
|
|
10556
|
+
type ListCrosssellProductsResponse = paths['/catalog/products/cross-sell']['get']['responses'][200]['content']['application/json'];
|
|
10557
|
+
type ListCrosssellProductsContent = ListCrosssellProductsResponse['content'];
|
|
10558
|
+
type ListCrosssellProductsQuery = paths['/catalog/products/cross-sell']['get']['parameters']['query'];
|
|
10559
|
+
type ListCrosssellProductsHeaderParams = paths['/catalog/products/cross-sell']['get']['parameters']['header'];
|
|
10560
|
+
type SearchProductsResponse = paths['/catalog/products/search']['post']['responses'][200]['content']['application/json'];
|
|
10561
|
+
type SearchProductsContent = SearchProductsResponse['content'];
|
|
10562
|
+
type SearchProductsHeaderParams = paths['/catalog/products/search']['post']['parameters']['header'];
|
|
10563
|
+
type SearchProductsBody = NonNullable<paths['/catalog/products/search']['post']['requestBody']>['content']['application/json'];
|
|
10564
|
+
type CreateCartResponse = paths['/carts']['post']['responses'][200]['content']['application/json'];
|
|
10565
|
+
type CreateCartContent = CreateCartResponse['content'];
|
|
10566
|
+
type CreateCartBody = NonNullable<paths['/carts']['post']['requestBody']>['content']['application/json'];
|
|
10567
|
+
type GetCartResponse = paths['/carts/{id}']['get']['responses'][200]['content']['application/json'];
|
|
10568
|
+
type GetCartContent = GetCartResponse['content'];
|
|
10569
|
+
type GetCartPathParams = paths['/carts/{id}']['get']['parameters']['path'];
|
|
10570
|
+
type DeleteCartResponse = paths['/carts/{id}']['delete']['responses'][200]['content']['application/json'];
|
|
10571
|
+
type DeleteCartPathParams = paths['/carts/{id}']['delete']['parameters']['path'];
|
|
10572
|
+
type GetUserCartResponse = paths['/carts/users/{user_id}']['get']['responses'][200]['content']['application/json'];
|
|
10573
|
+
type GetUserCartContent = GetUserCartResponse['content'];
|
|
10574
|
+
type GetUserCartPathParams = paths['/carts/users/{user_id}']['get']['parameters']['path'];
|
|
10575
|
+
type DeleteUserCartResponse = paths['/carts/users/{user_id}']['delete']['responses'][200]['content']['application/json'];
|
|
10576
|
+
type DeleteUserCartPathParams = paths['/carts/users/{user_id}']['delete']['parameters']['path'];
|
|
10577
|
+
type UpdateCartResponse = paths['/carts/{id}/items']['post']['responses'][200]['content']['application/json'];
|
|
10578
|
+
type UpdateCartContent = UpdateCartResponse['content'];
|
|
10579
|
+
type UpdateCartPathParams = paths['/carts/{id}/items']['post']['parameters']['path'];
|
|
10580
|
+
type UpdateCartBody = NonNullable<paths['/carts/{id}/items']['post']['requestBody']>['content']['application/json'];
|
|
10581
|
+
type CreateCartAddressResponse = paths['/carts/{id}/address']['post']['responses'][200]['content']['application/json'];
|
|
10582
|
+
type CreateCartAddressContent = CreateCartAddressResponse['content'];
|
|
10583
|
+
type CreateCartAddressPathParams = paths['/carts/{id}/address']['post']['parameters']['path'];
|
|
10584
|
+
type CreateCartAddressBody = NonNullable<paths['/carts/{id}/address']['post']['requestBody']>['content']['application/json'];
|
|
10585
|
+
type UpdateShippingMethodResponse = paths['/carts/{id}/shipping-method']['post']['responses'][200]['content']['application/json'];
|
|
10586
|
+
type UpdateShippingMethodContent = UpdateShippingMethodResponse['content'];
|
|
10587
|
+
type UpdateShippingMethodPathParams = paths['/carts/{id}/shipping-method']['post']['parameters']['path'];
|
|
10588
|
+
type UpdateShippingMethodBody = NonNullable<paths['/carts/{id}/shipping-method']['post']['requestBody']>['content']['application/json'];
|
|
10589
|
+
type UpdateFulfillmentPreferenceResponse = paths['/carts/{id}/fulfillment-preference']['post']['responses'][200]['content']['application/json'];
|
|
10590
|
+
type UpdateFulfillmentPreferencePathParams = paths['/carts/{id}/fulfillment-preference']['post']['parameters']['path'];
|
|
10591
|
+
type UpdateFulfillmentPreferenceBody = NonNullable<paths['/carts/{id}/fulfillment-preference']['post']['requestBody']>['content']['application/json'];
|
|
10592
|
+
type ApplyCouponResponse = paths['/carts/{id}/coupon']['post']['responses'][200]['content']['application/json'];
|
|
10593
|
+
type ApplyCouponContent = ApplyCouponResponse['content'];
|
|
10594
|
+
type ApplyCouponPathParams = paths['/carts/{id}/coupon']['post']['parameters']['path'];
|
|
10595
|
+
type ApplyCouponBody = NonNullable<paths['/carts/{id}/coupon']['post']['requestBody']>['content']['application/json'];
|
|
10596
|
+
type RemoveCouponResponse = paths['/carts/{id}/coupon']['delete']['responses'][200]['content']['application/json'];
|
|
10597
|
+
type RemoveCouponContent = RemoveCouponResponse['content'];
|
|
10598
|
+
type RemoveCouponPathParams = paths['/carts/{id}/coupon']['delete']['parameters']['path'];
|
|
10599
|
+
type RedeemLoyaltyPointsResponse = paths['/carts/{id}/loyalty-points']['post']['responses'][200]['content']['application/json'];
|
|
10600
|
+
type RedeemLoyaltyPointsContent = RedeemLoyaltyPointsResponse['content'];
|
|
10601
|
+
type RedeemLoyaltyPointsPathParams = paths['/carts/{id}/loyalty-points']['post']['parameters']['path'];
|
|
10602
|
+
type RedeemLoyaltyPointsBody = NonNullable<paths['/carts/{id}/loyalty-points']['post']['requestBody']>['content']['application/json'];
|
|
10603
|
+
type RemoveLoyaltyPointsResponse = paths['/carts/{id}/loyalty-points']['delete']['responses'][200]['content']['application/json'];
|
|
10604
|
+
type RemoveLoyaltyPointsContent = RemoveLoyaltyPointsResponse['content'];
|
|
10605
|
+
type RemoveLoyaltyPointsPathParams = paths['/carts/{id}/loyalty-points']['delete']['parameters']['path'];
|
|
10606
|
+
type RedeemCreditBalanceResponse = paths['/carts/{id}/credit-balance']['post']['responses'][200]['content']['application/json'];
|
|
10607
|
+
type RedeemCreditBalanceContent = RedeemCreditBalanceResponse['content'];
|
|
10608
|
+
type RedeemCreditBalancePathParams = paths['/carts/{id}/credit-balance']['post']['parameters']['path'];
|
|
10609
|
+
type RedeemCreditBalanceBody = NonNullable<paths['/carts/{id}/credit-balance']['post']['requestBody']>['content']['application/json'];
|
|
10610
|
+
type RemoveCreditBalanceResponse = paths['/carts/{id}/credit-balance']['delete']['responses'][200]['content']['application/json'];
|
|
10611
|
+
type RemoveCreditBalanceContent = RemoveCreditBalanceResponse['content'];
|
|
10612
|
+
type RemoveCreditBalancePathParams = paths['/carts/{id}/credit-balance']['delete']['parameters']['path'];
|
|
10613
|
+
type PosUpdateFulfillmentPreferenceResponse = paths['/pos/carts/{id}/fulfillment-preference']['post']['responses'][200]['content']['application/json'];
|
|
10614
|
+
type PosUpdateFulfillmentPreferencePathParams = paths['/pos/carts/{id}/fulfillment-preference']['post']['parameters']['path'];
|
|
10615
|
+
type PosUpdateFulfillmentPreferenceBody = NonNullable<paths['/pos/carts/{id}/fulfillment-preference']['post']['requestBody']>['content']['application/json'];
|
|
10616
|
+
type RedeemGiftCardResponse = paths['/carts/{id}/gift-card']['post']['responses'][200]['content']['application/json'];
|
|
10617
|
+
type RedeemGiftCardContent = RedeemGiftCardResponse['content'];
|
|
10618
|
+
type RedeemGiftCardPathParams = paths['/carts/{id}/gift-card']['post']['parameters']['path'];
|
|
10619
|
+
type RedeemGiftCardBody = NonNullable<paths['/carts/{id}/gift-card']['post']['requestBody']>['content']['application/json'];
|
|
10620
|
+
type RemoveGiftCardResponse = paths['/carts/{id}/gift-card']['delete']['responses'][200]['content']['application/json'];
|
|
10621
|
+
type RemoveGiftCardContent = RemoveGiftCardResponse['content'];
|
|
10622
|
+
type RemoveGiftCardPathParams = paths['/carts/{id}/gift-card']['delete']['parameters']['path'];
|
|
10623
|
+
type ListCouponsResponse = paths['/carts/available-coupons']['get']['responses'][200]['content']['application/json'];
|
|
10624
|
+
type ListCouponsContent = ListCouponsResponse['content'];
|
|
10625
|
+
type ListCouponsHeaderParams = paths['/carts/available-coupons']['get']['parameters']['header'];
|
|
10626
|
+
type ListPromotionsResponse = paths['/carts/available-promotions']['get']['responses'][200]['content']['application/json'];
|
|
10627
|
+
type ListPromotionsContent = ListPromotionsResponse['content'];
|
|
10628
|
+
type ListPromotionsHeaderParams = paths['/carts/available-promotions']['get']['parameters']['header'];
|
|
10629
|
+
type GetWishlistResponse = paths['/wishlist/{user_id}']['get']['responses'][200]['content']['application/json'];
|
|
10630
|
+
type GetWishlistContent = GetWishlistResponse['content'];
|
|
10631
|
+
type GetWishlistPathParams = paths['/wishlist/{user_id}']['get']['parameters']['path'];
|
|
10632
|
+
type AddToWishlistResponse = paths['/wishlist/{user_id}']['post']['responses'][200]['content']['application/json'];
|
|
10633
|
+
type AddToWishlistContent = AddToWishlistResponse['content'];
|
|
10634
|
+
type AddToWishlistPathParams = paths['/wishlist/{user_id}']['post']['parameters']['path'];
|
|
10635
|
+
type AddToWishlistBody = NonNullable<paths['/wishlist/{user_id}']['post']['requestBody']>['content']['application/json'];
|
|
10636
|
+
type DeleteFromWishlistResponse = paths['/wishlist/{user_id}']['delete']['responses'][200]['content']['application/json'];
|
|
10637
|
+
type DeleteFromWishlistContent = DeleteFromWishlistResponse['content'];
|
|
10638
|
+
type DeleteFromWishlistPathParams = paths['/wishlist/{user_id}']['delete']['parameters']['path'];
|
|
10639
|
+
type DeleteFromWishlistBody = NonNullable<paths['/wishlist/{user_id}']['delete']['requestBody']>['content']['application/json'];
|
|
10640
|
+
type CreateCustomerResponse = paths['/customers']['post']['responses'][200]['content']['application/json'];
|
|
10641
|
+
type CreateCustomerContent = CreateCustomerResponse['content'];
|
|
10642
|
+
type CreateCustomerBody = NonNullable<paths['/customers']['post']['requestBody']>['content']['application/json'];
|
|
10643
|
+
type EvaluatePromotionsResponse = paths['/carts/{id}/evaluate-promotions']['get']['responses'][200]['content']['application/json'];
|
|
10644
|
+
type EvaluatePromotionsContent = EvaluatePromotionsResponse['content'];
|
|
10645
|
+
type EvaluatePromotionsPathParams = paths['/carts/{id}/evaluate-promotions']['get']['parameters']['path'];
|
|
10646
|
+
type EvaluateCouponsResponse = paths['/carts/{id}/evaluate-coupons']['get']['responses'][200]['content']['application/json'];
|
|
10647
|
+
type EvaluateCouponsContent = EvaluateCouponsResponse['content'];
|
|
10648
|
+
type EvaluateCouponsPathParams = paths['/carts/{id}/evaluate-coupons']['get']['parameters']['path'];
|
|
10649
|
+
type EvaluatePosPromotionsResponse = paths['/pos/carts/{id}/evaluate-promotions']['get']['responses'][200]['content']['application/json'];
|
|
10650
|
+
type EvaluatePosPromotionsContent = EvaluatePosPromotionsResponse['content'];
|
|
10651
|
+
type EvaluatePosPromotionsPathParams = paths['/pos/carts/{id}/evaluate-promotions']['get']['parameters']['path'];
|
|
10652
|
+
type EvaluatePosCouponsResponse = paths['/pos/carts/{id}/evaluate-coupons']['get']['responses'][200]['content']['application/json'];
|
|
10653
|
+
type EvaluatePosCouponsContent = EvaluatePosCouponsResponse['content'];
|
|
10654
|
+
type EvaluatePosCouponsPathParams = paths['/pos/carts/{id}/evaluate-coupons']['get']['parameters']['path'];
|
|
10655
|
+
type GetCustomerDetailResponse = paths['/customers/{id}']['get']['responses'][200]['content']['application/json'];
|
|
10656
|
+
type GetCustomerDetailContent = GetCustomerDetailResponse['content'];
|
|
10657
|
+
type GetCustomerDetailPathParams = paths['/customers/{id}']['get']['parameters']['path'];
|
|
10658
|
+
type UpdateCustomerResponse = paths['/customers/{id}']['put']['responses'][200]['content']['application/json'];
|
|
10659
|
+
type UpdateCustomerContent = UpdateCustomerResponse['content'];
|
|
10660
|
+
type UpdateCustomerPathParams = paths['/customers/{id}']['put']['parameters']['path'];
|
|
10661
|
+
type UpdateCustomerBody = NonNullable<paths['/customers/{id}']['put']['requestBody']>['content']['application/json'];
|
|
10662
|
+
type ListAddressesResponse = paths['/customers/{user_id}/addresses']['get']['responses'][200]['content']['application/json'];
|
|
10663
|
+
type ListAddressesContent = ListAddressesResponse['content'];
|
|
10664
|
+
type ListAddressesQuery = paths['/customers/{user_id}/addresses']['get']['parameters']['query'];
|
|
10665
|
+
type ListAddressesPathParams = paths['/customers/{user_id}/addresses']['get']['parameters']['path'];
|
|
10666
|
+
type CreateAddressResponse = paths['/customers/{user_id}/addresses']['post']['responses'][200]['content']['application/json'];
|
|
10667
|
+
type CreateAddressContent = CreateAddressResponse['content'];
|
|
10668
|
+
type CreateAddressPathParams = paths['/customers/{user_id}/addresses']['post']['parameters']['path'];
|
|
10669
|
+
type CreateAddressBody = NonNullable<paths['/customers/{user_id}/addresses']['post']['requestBody']>['content']['application/json'];
|
|
10670
|
+
type GetAddressDetailResponse = paths['/customers/{user_id}/addresses/{address_id}']['get']['responses'][200]['content']['application/json'];
|
|
10671
|
+
type GetAddressDetailContent = GetAddressDetailResponse['content'];
|
|
10672
|
+
type GetAddressDetailPathParams = paths['/customers/{user_id}/addresses/{address_id}']['get']['parameters']['path'];
|
|
10673
|
+
type UpdateAddressDetailResponse = paths['/customers/{user_id}/addresses/{address_id}']['put']['responses'][200]['content']['application/json'];
|
|
10674
|
+
type UpdateAddressDetailContent = UpdateAddressDetailResponse['content'];
|
|
10675
|
+
type UpdateAddressDetailPathParams = paths['/customers/{user_id}/addresses/{address_id}']['put']['parameters']['path'];
|
|
10676
|
+
type UpdateAddressDetailBody = NonNullable<paths['/customers/{user_id}/addresses/{address_id}']['put']['requestBody']>['content']['application/json'];
|
|
10677
|
+
type DeleteAddressResponse = paths['/customers/{user_id}/addresses/{address_id}']['delete']['responses'][200]['content']['application/json'];
|
|
10678
|
+
type DeleteAddressPathParams = paths['/customers/{user_id}/addresses/{address_id}']['delete']['parameters']['path'];
|
|
10679
|
+
type ListKycDocumentResponse = paths['/store/kyc-document']['get']['responses'][200]['content']['application/json'];
|
|
10680
|
+
type ListKycDocumentContent = ListKycDocumentResponse['content'];
|
|
10681
|
+
type GetConfigResponse = paths['/store/config']['get']['responses'][200]['content']['application/json'];
|
|
10682
|
+
type GetConfigContent = GetConfigResponse['content'];
|
|
10683
|
+
type ListDocumentsResponse = paths['/customers/{id}/documents']['get']['responses'][200]['content']['application/json'];
|
|
10684
|
+
type ListDocumentsContent = ListDocumentsResponse['content'];
|
|
10685
|
+
type ListDocumentsPathParams = paths['/customers/{id}/documents']['get']['parameters']['path'];
|
|
10686
|
+
type CreateDocumentResponse = paths['/customers/{id}/documents']['post']['responses'][200]['content']['application/json'];
|
|
10687
|
+
type CreateDocumentContent = CreateDocumentResponse['content'];
|
|
10688
|
+
type CreateDocumentPathParams = paths['/customers/{id}/documents']['post']['parameters']['path'];
|
|
10689
|
+
type CreateDocumentFormData = NonNullable<paths['/customers/{id}/documents']['post']['requestBody']>['content']['multipart/form-data'];
|
|
10690
|
+
type GetDocumentResponse = paths['/customers/{id}/documents/{document_id}']['get']['responses'][200]['content']['application/json'];
|
|
10691
|
+
type GetDocumentContent = GetDocumentResponse['content'];
|
|
10692
|
+
type GetDocumentPathParams = paths['/customers/{id}/documents/{document_id}']['get']['parameters']['path'];
|
|
10693
|
+
type UpdateDocumentResponse = paths['/customers/{id}/documents/{document_id}']['put']['responses'][200]['content']['application/json'];
|
|
10694
|
+
type UpdateDocumentContent = UpdateDocumentResponse['content'];
|
|
10695
|
+
type UpdateDocumentPathParams = paths['/customers/{id}/documents/{document_id}']['put']['parameters']['path'];
|
|
10696
|
+
type UpdateDocumentFormData = NonNullable<paths['/customers/{id}/documents/{document_id}']['put']['requestBody']>['content']['multipart/form-data'];
|
|
10697
|
+
type DeleteDocumentResponse = paths['/customers/{id}/documents/{document_id}']['delete']['responses'][200]['content']['application/json'];
|
|
10698
|
+
type DeleteDocumentPathParams = paths['/customers/{id}/documents/{document_id}']['delete']['parameters']['path'];
|
|
10699
|
+
type VerifyDocumentResponse = paths['/customers/{id}/documents/verify']['post']['responses'][200]['content']['application/json'];
|
|
10700
|
+
type VerifyDocumentContent = VerifyDocumentResponse['content'];
|
|
10701
|
+
type VerifyDocumentPathParams = paths['/customers/{id}/documents/verify']['post']['parameters']['path'];
|
|
10702
|
+
type VerifyDocumentBody = NonNullable<paths['/customers/{id}/documents/verify']['post']['requestBody']>['content']['application/json'];
|
|
10703
|
+
type GetLoyaltyDetailsResponse = paths['/customers/{user_id}/loyalty']['get']['responses'][200]['content']['application/json'];
|
|
10704
|
+
type GetLoyaltyDetailsContent = GetLoyaltyDetailsResponse['content'];
|
|
10705
|
+
type GetLoyaltyDetailsPathParams = paths['/customers/{user_id}/loyalty']['get']['parameters']['path'];
|
|
10706
|
+
type ListLoyaltyActivitiesResponse = paths['/customers/{user_id}/loyalty-points-activity']['get']['responses'][200]['content']['application/json'];
|
|
10707
|
+
type ListLoyaltyActivitiesContent = ListLoyaltyActivitiesResponse['content'];
|
|
10708
|
+
type ListLoyaltyActivitiesQuery = paths['/customers/{user_id}/loyalty-points-activity']['get']['parameters']['query'];
|
|
10709
|
+
type ListLoyaltyActivitiesPathParams = paths['/customers/{user_id}/loyalty-points-activity']['get']['parameters']['path'];
|
|
10710
|
+
type CreateOrderResponse = paths['/orders']['post']['responses'][200]['content']['application/json'];
|
|
10711
|
+
type CreateOrderContent = CreateOrderResponse['content'];
|
|
10712
|
+
type CreateOrderBody = NonNullable<paths['/orders']['post']['requestBody']>['content']['application/json'];
|
|
10713
|
+
type ListOrdersResponse = paths['/orders']['get']['responses'][200]['content']['application/json'];
|
|
10714
|
+
type ListOrdersContent = ListOrdersResponse['content'];
|
|
10715
|
+
type ListOrdersQuery = paths['/orders']['get']['parameters']['query'];
|
|
10716
|
+
type GetOrderDetailResponse = paths['/orders/{order_number}']['get']['responses'][200]['content']['application/json'];
|
|
10717
|
+
type GetOrderDetailContent = GetOrderDetailResponse['content'];
|
|
10718
|
+
type GetOrderDetailPathParams = paths['/orders/{order_number}']['get']['parameters']['path'];
|
|
10719
|
+
type GetPaymentStatusResponse = paths['/orders/{order_number}/payment-status']['get']['responses'][200]['content']['application/json'];
|
|
10720
|
+
type GetPaymentStatusContent = GetPaymentStatusResponse['content'];
|
|
10721
|
+
type GetPaymentStatusPathParams = paths['/orders/{order_number}/payment-status']['get']['parameters']['path'];
|
|
10722
|
+
type ListOrderShipmentsResponse = paths['/orders/{order_number}/shipments']['get']['responses'][200]['content']['application/json'];
|
|
10723
|
+
type ListOrderShipmentsContent = ListOrderShipmentsResponse['content'];
|
|
10724
|
+
type ListOrderShipmentsPathParams = paths['/orders/{order_number}/shipments']['get']['parameters']['path'];
|
|
10725
|
+
type ListOrderRefundsResponse = paths['/orders/{order_number}/refunds']['get']['responses'][200]['content']['application/json'];
|
|
10726
|
+
type ListOrderRefundsContent = ListOrderRefundsResponse['content'];
|
|
10727
|
+
type ListOrderRefundsPathParams = paths['/orders/{order_number}/refunds']['get']['parameters']['path'];
|
|
10728
|
+
type ListOrderPaymentsResponse = paths['/orders/{order_number}/payments']['get']['responses'][200]['content']['application/json'];
|
|
10729
|
+
type ListOrderPaymentsContent = ListOrderPaymentsResponse['content'];
|
|
10730
|
+
type ListOrderPaymentsPathParams = paths['/orders/{order_number}/payments']['get']['parameters']['path'];
|
|
10731
|
+
type CreateOrderReturnResponse = paths['/orders/{order_number}/return']['post']['responses'][200]['content']['application/json'];
|
|
10732
|
+
type CreateOrderReturnContent = CreateOrderReturnResponse['content'];
|
|
10733
|
+
type CreateOrderReturnPathParams = paths['/orders/{order_number}/return']['post']['parameters']['path'];
|
|
10734
|
+
type CreateOrderReturnBody = NonNullable<paths['/orders/{order_number}/return']['post']['requestBody']>['content']['application/json'];
|
|
10735
|
+
type GetOrderReturnDetailResponse = paths['/orders/{order_number}/return/{return_id}']['get']['responses'][200]['content']['application/json'];
|
|
10736
|
+
type GetOrderReturnDetailContent = GetOrderReturnDetailResponse['content'];
|
|
10737
|
+
type GetOrderReturnDetailPathParams = paths['/orders/{order_number}/return/{return_id}']['get']['parameters']['path'];
|
|
10738
|
+
type CancelOrderResponse = paths['/orders/{order_number}/cancel']['post']['responses'][200]['content']['application/json'];
|
|
10739
|
+
type CancelOrderContent = CancelOrderResponse['content'];
|
|
10740
|
+
type CancelOrderPathParams = paths['/orders/{order_number}/cancel']['post']['parameters']['path'];
|
|
10741
|
+
type CancelOrderBody = NonNullable<paths['/orders/{order_number}/cancel']['post']['requestBody']>['content']['application/json'];
|
|
10742
|
+
type RetryOrderPaymentResponse = paths['/orders/{order_number}/retry-payment']['post']['responses'][200]['content']['application/json'];
|
|
10743
|
+
type RetryOrderPaymentContent = RetryOrderPaymentResponse['content'];
|
|
10744
|
+
type RetryOrderPaymentPathParams = paths['/orders/{order_number}/retry-payment']['post']['parameters']['path'];
|
|
10745
|
+
type RetryOrderPaymentBody = NonNullable<paths['/orders/{order_number}/retry-payment']['post']['requestBody']>['content']['application/json'];
|
|
10746
|
+
type GetShippingMethodsResponse = paths['/shipping/shipping-methods']['post']['responses'][200]['content']['application/json'];
|
|
10747
|
+
type GetShippingMethodsContent = GetShippingMethodsResponse['content'];
|
|
10748
|
+
type GetShippingMethodsBody = NonNullable<paths['/shipping/shipping-methods']['post']['requestBody']>['content']['application/json'];
|
|
10749
|
+
type GetFulfillmentOptionsResponse = paths['/shipping/fulfillment-options']['post']['responses'][200]['content']['application/json'];
|
|
10750
|
+
type GetFulfillmentOptionsContent = GetFulfillmentOptionsResponse['content'];
|
|
10751
|
+
type GetFulfillmentOptionsBody = NonNullable<paths['/shipping/fulfillment-options']['post']['requestBody']>['content']['application/json'];
|
|
10752
|
+
type GetPosFulfillmentOptionsResponse = paths['/pos/fulfillment-options']['post']['responses'][200]['content']['application/json'];
|
|
10753
|
+
type GetPosFulfillmentOptionsContent = GetPosFulfillmentOptionsResponse['content'];
|
|
10754
|
+
type GetPosFulfillmentOptionsBody = NonNullable<paths['/pos/fulfillment-options']['post']['requestBody']>['content']['application/json'];
|
|
10755
|
+
type CheckPincodeServiceabilityResponse = paths['/shipping/serviceability/{pincode}']['get']['responses'][200]['content']['application/json'];
|
|
10756
|
+
type CheckPincodeServiceabilityContent = CheckPincodeServiceabilityResponse['content'];
|
|
10757
|
+
type CheckPincodeServiceabilityPathParams = paths['/shipping/serviceability/{pincode}']['get']['parameters']['path'];
|
|
10758
|
+
type GetAnonymousTokenResponse = paths['/auth/anonymous']['post']['responses'][200]['content']['application/json'];
|
|
10759
|
+
type GetAnonymousTokenContent = GetAnonymousTokenResponse['content'];
|
|
10760
|
+
type LoginWithPhoneResponse = paths['/auth/login/phone']['post']['responses'][200]['content']['application/json'];
|
|
10761
|
+
type LoginWithPhoneContent = LoginWithPhoneResponse['content'];
|
|
10762
|
+
type LoginWithPhoneBody = NonNullable<paths['/auth/login/phone']['post']['requestBody']>['content']['application/json'];
|
|
10763
|
+
type LoginWithEmailResponse = paths['/auth/login/email']['post']['responses'][200]['content']['application/json'];
|
|
10764
|
+
type LoginWithEmailContent = LoginWithEmailResponse['content'];
|
|
10765
|
+
type LoginWithEmailBody = NonNullable<paths['/auth/login/email']['post']['requestBody']>['content']['application/json'];
|
|
10766
|
+
type LoginWithWhatsappResponse = paths['/auth/login/whatsapp']['post']['responses'][200]['content']['application/json'];
|
|
10767
|
+
type LoginWithWhatsappContent = LoginWithWhatsappResponse['content'];
|
|
10768
|
+
type LoginWithWhatsappBody = NonNullable<paths['/auth/login/whatsapp']['post']['requestBody']>['content']['application/json'];
|
|
10769
|
+
type LoginWithPasswordResponse = paths['/auth/login/password']['post']['responses'][200]['content']['application/json'];
|
|
10770
|
+
type LoginWithPasswordContent = LoginWithPasswordResponse['content'];
|
|
10771
|
+
type LoginWithPasswordBody = NonNullable<paths['/auth/login/password']['post']['requestBody']>['content']['application/json'];
|
|
10772
|
+
type VerifyOtpResponse = paths['/auth/verify-otp']['post']['responses'][200]['content']['application/json'];
|
|
10773
|
+
type VerifyOtpContent = VerifyOtpResponse['content'];
|
|
10774
|
+
type VerifyOtpBody = NonNullable<paths['/auth/verify-otp']['post']['requestBody']>['content']['application/json'];
|
|
10775
|
+
type RegisterWithPhoneResponse = paths['/auth/register/phone']['post']['responses'][200]['content']['application/json'];
|
|
10776
|
+
type RegisterWithPhoneContent = RegisterWithPhoneResponse['content'];
|
|
10777
|
+
type RegisterWithPhoneBody = NonNullable<paths['/auth/register/phone']['post']['requestBody']>['content']['application/json'];
|
|
10778
|
+
type RegisterWithEmailResponse = paths['/auth/register/email']['post']['responses'][200]['content']['application/json'];
|
|
10779
|
+
type RegisterWithEmailContent = RegisterWithEmailResponse['content'];
|
|
10780
|
+
type RegisterWithEmailBody = NonNullable<paths['/auth/register/email']['post']['requestBody']>['content']['application/json'];
|
|
10781
|
+
type RegisterWithWhatsappResponse = paths['/auth/register/whatsapp']['post']['responses'][200]['content']['application/json'];
|
|
10782
|
+
type RegisterWithWhatsappContent = RegisterWithWhatsappResponse['content'];
|
|
10783
|
+
type RegisterWithWhatsappBody = NonNullable<paths['/auth/register/whatsapp']['post']['requestBody']>['content']['application/json'];
|
|
10784
|
+
type RegisterWithPasswordResponse = paths['/auth/register/password']['post']['responses'][200]['content']['application/json'];
|
|
10785
|
+
type RegisterWithPasswordContent = RegisterWithPasswordResponse['content'];
|
|
10786
|
+
type RegisterWithPasswordBody = NonNullable<paths['/auth/register/password']['post']['requestBody']>['content']['application/json'];
|
|
10787
|
+
type GetUserDetailResponse = paths['/auth/user/{id}']['get']['responses'][200]['content']['application/json'];
|
|
10788
|
+
type GetUserDetailContent = GetUserDetailResponse['content'];
|
|
10789
|
+
type GetUserDetailPathParams = paths['/auth/user/{id}']['get']['parameters']['path'];
|
|
10790
|
+
type UpdateUserResponse = paths['/auth/user/{id}']['put']['responses'][200]['content']['application/json'];
|
|
10791
|
+
type UpdateUserContent = UpdateUserResponse['content'];
|
|
10792
|
+
type UpdateUserPathParams = paths['/auth/user/{id}']['put']['parameters']['path'];
|
|
10793
|
+
type UpdateUserBody = NonNullable<paths['/auth/user/{id}']['put']['requestBody']>['content']['application/json'];
|
|
10794
|
+
type AddProfileImageResponse = paths['/auth/user/{id}/profile-image']['post']['responses'][200]['content']['application/json'];
|
|
10795
|
+
type AddProfileImageContent = AddProfileImageResponse['content'];
|
|
10796
|
+
type AddProfileImagePathParams = paths['/auth/user/{id}/profile-image']['post']['parameters']['path'];
|
|
10797
|
+
type AddProfileImageFormData = NonNullable<paths['/auth/user/{id}/profile-image']['post']['requestBody']>['content']['multipart/form-data'];
|
|
10798
|
+
type UpdateProfileImageResponse = paths['/auth/user/{id}/profile-image']['put']['responses'][200]['content']['application/json'];
|
|
10799
|
+
type UpdateProfileImageContent = UpdateProfileImageResponse['content'];
|
|
10800
|
+
type UpdateProfileImagePathParams = paths['/auth/user/{id}/profile-image']['put']['parameters']['path'];
|
|
10801
|
+
type UpdateProfileImageFormData = NonNullable<paths['/auth/user/{id}/profile-image']['put']['requestBody']>['content']['multipart/form-data'];
|
|
10802
|
+
type RemoveProfileImageResponse = paths['/auth/user/{id}/profile-image']['delete']['responses'][200]['content']['application/json'];
|
|
10803
|
+
type RemoveProfileImagePathParams = paths['/auth/user/{id}/profile-image']['delete']['parameters']['path'];
|
|
10804
|
+
type GetProfileImageResponse = paths['/auth/user/{id}/profile-image']['get']['responses'][200]['content']['application/json'];
|
|
10805
|
+
type GetProfileImageContent = GetProfileImageResponse['content'];
|
|
10806
|
+
type GetProfileImagePathParams = paths['/auth/user/{id}/profile-image']['get']['parameters']['path'];
|
|
10807
|
+
type DeactivateUserResponse = paths['/auth/user/{id}/deactivate']['put']['responses'][200]['content']['application/json'];
|
|
10808
|
+
type DeactivateUserPathParams = paths['/auth/user/{id}/deactivate']['put']['parameters']['path'];
|
|
10809
|
+
type RefreshTokenResponse = paths['/auth/refresh-token']['post']['responses'][200]['content']['application/json'];
|
|
10810
|
+
type RefreshTokenContent = RefreshTokenResponse['content'];
|
|
10811
|
+
type RefreshTokenBody = NonNullable<paths['/auth/refresh-token']['post']['requestBody']>['content']['application/json'];
|
|
10812
|
+
type ChangePasswordResponse = paths['/auth/change-password']['post']['responses'][200]['content']['application/json'];
|
|
10813
|
+
type ChangePasswordContent = ChangePasswordResponse['content'];
|
|
10814
|
+
type ChangePasswordBody = NonNullable<paths['/auth/change-password']['post']['requestBody']>['content']['application/json'];
|
|
10815
|
+
type ForgotPasswordResponse = paths['/auth/forgot-password']['post']['responses'][200]['content']['application/json'];
|
|
10816
|
+
type ForgotPasswordContent = ForgotPasswordResponse['content'];
|
|
10817
|
+
type ForgotPasswordBody = NonNullable<paths['/auth/forgot-password']['post']['requestBody']>['content']['application/json'];
|
|
10818
|
+
type ResetPasswordResponse = paths['/auth/reset-password']['post']['responses'][200]['content']['application/json'];
|
|
10819
|
+
type ResetPasswordContent = ResetPasswordResponse['content'];
|
|
10820
|
+
type ResetPasswordBody = NonNullable<paths['/auth/reset-password']['post']['requestBody']>['content']['application/json'];
|
|
10821
|
+
type GetNotificationPreferencesResponse = paths['/auth/user/{id}/notification-preferences']['get']['responses'][200]['content']['application/json'];
|
|
10822
|
+
type GetNotificationPreferencesContent = GetNotificationPreferencesResponse['content'];
|
|
10823
|
+
type GetNotificationPreferencesPathParams = paths['/auth/user/{id}/notification-preferences']['get']['parameters']['path'];
|
|
10824
|
+
type CreateNotificationPreferencesResponse = paths['/auth/user/{id}/notification-preferences']['post']['responses'][200]['content']['application/json'];
|
|
10825
|
+
type CreateNotificationPreferencesContent = CreateNotificationPreferencesResponse['content'];
|
|
10826
|
+
type CreateNotificationPreferencesPathParams = paths['/auth/user/{id}/notification-preferences']['post']['parameters']['path'];
|
|
10827
|
+
type CreateNotificationPreferencesBody = NonNullable<paths['/auth/user/{id}/notification-preferences']['post']['requestBody']>['content']['application/json'];
|
|
10828
|
+
type UpdateNotificationPreferencesResponse = paths['/auth/user/{id}/notification-preferences']['put']['responses'][200]['content']['application/json'];
|
|
10829
|
+
type UpdateNotificationPreferencesContent = UpdateNotificationPreferencesResponse['content'];
|
|
10830
|
+
type UpdateNotificationPreferencesPathParams = paths['/auth/user/{id}/notification-preferences']['put']['parameters']['path'];
|
|
10831
|
+
type UpdateNotificationPreferencesBody = NonNullable<paths['/auth/user/{id}/notification-preferences']['put']['requestBody']>['content']['application/json'];
|
|
10832
|
+
type GenerateOtpResponse = paths['/auth/generate-otp']['post']['responses'][200]['content']['application/json'];
|
|
10833
|
+
type GenerateOtpContent = GenerateOtpResponse['content'];
|
|
10834
|
+
type GenerateOtpBody = NonNullable<paths['/auth/generate-otp']['post']['requestBody']>['content']['application/json'];
|
|
10835
|
+
type LogoutResponse = paths['/auth/logout']['post']['responses'][200]['content']['application/json'];
|
|
10836
|
+
type LogoutContent = LogoutResponse['content'];
|
|
10837
|
+
type ListUserReviewsResponse = paths['/customers/{user_id}/reviews']['get']['responses'][200]['content']['application/json'];
|
|
10838
|
+
type ListUserReviewsContent = ListUserReviewsResponse['content'];
|
|
10839
|
+
type ListUserReviewsPathParams = paths['/customers/{user_id}/reviews']['get']['parameters']['path'];
|
|
10840
|
+
type CheckVerificationStatusResponse = paths['/auth/verified-email-phone']['post']['responses'][200]['content']['application/json'];
|
|
10841
|
+
type CheckVerificationStatusContent = CheckVerificationStatusResponse['content'];
|
|
10842
|
+
type CheckVerificationStatusBody = NonNullable<paths['/auth/verified-email-phone']['post']['requestBody']>['content']['application/json'];
|
|
10843
|
+
type GenerateHashResponse = paths['/payments/generate-hash']['post']['responses'][200]['content']['application/json'];
|
|
10844
|
+
type GenerateHashContent = GenerateHashResponse['content'];
|
|
10845
|
+
type GenerateHashBody = NonNullable<paths['/payments/generate-hash']['post']['requestBody']>['content']['application/json'];
|
|
10846
|
+
type ListPaymentMethodsResponse = paths['/payments/payment-methods']['get']['responses'][200]['content']['application/json'];
|
|
10847
|
+
type ListPaymentMethodsContent = ListPaymentMethodsResponse['content'];
|
|
10848
|
+
type ListPaymentMethodsQuery = paths['/payments/payment-methods']['get']['parameters']['query'];
|
|
10849
|
+
type ListSavedCardsResponse = paths['/payments/cards']['get']['responses'][200]['content']['application/json'];
|
|
10850
|
+
type ListSavedCardsContent = ListSavedCardsResponse['content'];
|
|
10851
|
+
type ListSavedCardsQuery = paths['/payments/cards']['get']['parameters']['query'];
|
|
10852
|
+
type AddCardResponse = paths['/payments/cards']['post']['responses'][200]['content']['application/json'];
|
|
10853
|
+
type AddCardContent = AddCardResponse['content'];
|
|
10854
|
+
type AddCardBody = NonNullable<paths['/payments/cards']['post']['requestBody']>['content']['application/json'];
|
|
10855
|
+
type VerifyVpaResponse = paths['/payments/verify-vpa']['get']['responses'][200]['content']['application/json'];
|
|
10856
|
+
type VerifyVpaContent = VerifyVpaResponse['content'];
|
|
10857
|
+
type VerifyVpaQuery = paths['/payments/verify-vpa']['get']['parameters']['query'];
|
|
10858
|
+
type CreateJuspayOrderResponse = paths['/payments/juspay/create-order']['post']['responses'][200]['content']['application/json'];
|
|
10859
|
+
type CreateJuspayOrderContent = CreateJuspayOrderResponse['content'];
|
|
10860
|
+
type CreateJuspayOrderBody = NonNullable<paths['/payments/juspay/create-order']['post']['requestBody']>['content']['application/json'];
|
|
10861
|
+
type CreateJuspayCustomerResponse = paths['/payments/juspay/customers']['post']['responses'][200]['content']['application/json'];
|
|
10862
|
+
type CreateJuspayCustomerContent = CreateJuspayCustomerResponse['content'];
|
|
10863
|
+
type CreateJuspayCustomerBody = NonNullable<paths['/payments/juspay/customers']['post']['requestBody']>['content']['application/json'];
|
|
10864
|
+
type GetJuspayCustomerResponse = paths['/payments/juspay/customers/{user-id}']['get']['responses'][200]['content']['application/json'];
|
|
10865
|
+
type GetJuspayCustomerContent = GetJuspayCustomerResponse['content'];
|
|
10866
|
+
type GetJuspayCustomerPathParams = paths['/payments/juspay/customers/{user-id}']['get']['parameters']['path'];
|
|
10867
|
+
type ListCountriesResponse = paths['/common/countries']['get']['responses'][200]['content']['application/json'];
|
|
10868
|
+
type ListCountriesContent = ListCountriesResponse['content'];
|
|
10869
|
+
type ListCountryStatesResponse = paths['/common/countries/{country_iso_code}/states']['get']['responses'][200]['content']['application/json'];
|
|
10870
|
+
type ListCountryStatesContent = ListCountryStatesResponse['content'];
|
|
10871
|
+
type ListCountryStatesPathParams = paths['/common/countries/{country_iso_code}/states']['get']['parameters']['path'];
|
|
10872
|
+
type ListCountryPincodesResponse = paths['/common/countries/{country_iso_code}/pincodes']['get']['responses'][200]['content']['application/json'];
|
|
10873
|
+
type ListCountryPincodesContent = ListCountryPincodesResponse['content'];
|
|
10874
|
+
type ListCountryPincodesQuery = paths['/common/countries/{country_iso_code}/pincodes']['get']['parameters']['query'];
|
|
10875
|
+
type ListCountryPincodesPathParams = paths['/common/countries/{country_iso_code}/pincodes']['get']['parameters']['path'];
|
|
10876
|
+
type ListReturnsResponse = paths['/orders/returns']['get']['responses'][200]['content']['application/json'];
|
|
10877
|
+
type ListReturnsContent = ListReturnsResponse['content'];
|
|
10878
|
+
type TrackAnalyticsEventResponse = paths['/analytics/track']['post']['responses'][200]['content']['application/json'];
|
|
10879
|
+
type TrackAnalyticsEventBody = NonNullable<paths['/analytics/track']['post']['requestBody']>['content']['application/json'];
|
|
10880
|
+
type SubscribeNewsletterResponse = paths['/campaigns/newsletter-subscribe']['post']['responses'][200]['content']['application/json'];
|
|
10881
|
+
type SubscribeNewsletterBody = NonNullable<paths['/campaigns/newsletter-subscribe']['post']['requestBody']>['content']['application/json'];
|
|
10882
|
+
type CreateSubscriptionResponse = paths['/subscriptions']['post']['responses'][200]['content']['application/json'];
|
|
10883
|
+
type CreateSubscriptionContent = CreateSubscriptionResponse['content'];
|
|
10884
|
+
type CreateSubscriptionBody = NonNullable<paths['/subscriptions']['post']['requestBody']>['content']['application/json'];
|
|
10885
|
+
type ListSubscriptionsResponse = paths['/subscriptions']['get']['responses'][200]['content']['application/json'];
|
|
10886
|
+
type ListSubscriptionsContent = ListSubscriptionsResponse['content'];
|
|
10887
|
+
type GetSubscriptionResponse = paths['/subscriptions/{id}']['get']['responses'][200]['content']['application/json'];
|
|
10888
|
+
type GetSubscriptionContent = GetSubscriptionResponse['content'];
|
|
10889
|
+
type GetSubscriptionPathParams = paths['/subscriptions/{id}']['get']['parameters']['path'];
|
|
10890
|
+
type UpdateSubscriptionResponse = paths['/subscriptions/{id}']['put']['responses'][200]['content']['application/json'];
|
|
10891
|
+
type UpdateSubscriptionContent = UpdateSubscriptionResponse['content'];
|
|
10892
|
+
type UpdateSubscriptionPathParams = paths['/subscriptions/{id}']['put']['parameters']['path'];
|
|
10893
|
+
type UpdateSubscriptionBody = NonNullable<paths['/subscriptions/{id}']['put']['requestBody']>['content']['application/json'];
|
|
10894
|
+
type PairPosDeviceResponse = paths['/pos/auth/pair-device']['post']['responses'][200]['content']['application/json'];
|
|
10895
|
+
type PairPosDeviceContent = PairPosDeviceResponse['content'];
|
|
10896
|
+
type PairPosDeviceBody = NonNullable<paths['/pos/auth/pair-device']['post']['requestBody']>['content']['application/json'];
|
|
10897
|
+
type LoginPosDeviceWithPhoneResponse = paths['/pos/auth/login/phone']['post']['responses'][200]['content']['application/json'];
|
|
10898
|
+
type LoginPosDeviceWithPhoneContent = LoginPosDeviceWithPhoneResponse['content'];
|
|
10899
|
+
type LoginPosDeviceWithPhoneBody = NonNullable<paths['/pos/auth/login/phone']['post']['requestBody']>['content']['application/json'];
|
|
10900
|
+
type LoginPosDeviceWithWhatsappResponse = paths['/pos/auth/login/whatsapp']['post']['responses'][200]['content']['application/json'];
|
|
10901
|
+
type LoginPosDeviceWithWhatsappContent = LoginPosDeviceWithWhatsappResponse['content'];
|
|
10902
|
+
type LoginPosDeviceWithWhatsappBody = NonNullable<paths['/pos/auth/login/whatsapp']['post']['requestBody']>['content']['application/json'];
|
|
10903
|
+
type LoginPosDeviceWithEmailResponse = paths['/pos/auth/login/email']['post']['responses'][200]['content']['application/json'];
|
|
10904
|
+
type LoginPosDeviceWithEmailContent = LoginPosDeviceWithEmailResponse['content'];
|
|
10905
|
+
type LoginPosDeviceWithEmailBody = NonNullable<paths['/pos/auth/login/email']['post']['requestBody']>['content']['application/json'];
|
|
10906
|
+
type VerifyPosLoginOtpResponse = paths['/pos/auth/verify-otp']['post']['responses'][200]['content']['application/json'];
|
|
10907
|
+
type VerifyPosLoginOtpContent = VerifyPosLoginOtpResponse['content'];
|
|
10908
|
+
type VerifyPosLoginOtpBody = NonNullable<paths['/pos/auth/verify-otp']['post']['requestBody']>['content']['application/json'];
|
|
10909
|
+
type RefreshPosAccessTokenResponse = paths['/pos/auth/refresh-token']['post']['responses'][200]['content']['application/json'];
|
|
10910
|
+
type RefreshPosAccessTokenContent = RefreshPosAccessTokenResponse['content'];
|
|
10911
|
+
type RefreshPosAccessTokenBody = NonNullable<paths['/pos/auth/refresh-token']['post']['requestBody']>['content']['application/json'];
|
|
10912
|
+
type CreatePosCartResponse = paths['/pos/carts']['post']['responses'][200]['content']['application/json'];
|
|
10913
|
+
type CreatePosCartContent = CreatePosCartResponse['content'];
|
|
10914
|
+
type CreatePosCartBody = NonNullable<paths['/pos/carts']['post']['requestBody']>['content']['application/json'];
|
|
10915
|
+
type GetPosCartResponse = paths['/pos/carts/{id}']['get']['responses'][200]['content']['application/json'];
|
|
10916
|
+
type GetPosCartContent = GetPosCartResponse['content'];
|
|
10917
|
+
type GetPosCartPathParams = paths['/pos/carts/{id}']['get']['parameters']['path'];
|
|
10918
|
+
type UpdatePosCartResponse = paths['/pos/carts/{id}/items']['post']['responses'][200]['content']['application/json'];
|
|
10919
|
+
type UpdatePosCartContent = UpdatePosCartResponse['content'];
|
|
10920
|
+
type UpdatePosCartPathParams = paths['/pos/carts/{id}/items']['post']['parameters']['path'];
|
|
10921
|
+
type UpdatePosCartBody = NonNullable<paths['/pos/carts/{id}/items']['post']['requestBody']>['content']['application/json'];
|
|
10922
|
+
type UpdatePosCartCustomerResponse = paths['/pos/carts/{id}/update-customer']['post']['responses'][200]['content']['application/json'];
|
|
10923
|
+
type UpdatePosCartCustomerContent = UpdatePosCartCustomerResponse['content'];
|
|
10924
|
+
type UpdatePosCartCustomerPathParams = paths['/pos/carts/{id}/update-customer']['post']['parameters']['path'];
|
|
10925
|
+
type UpdatePosCartCustomerBody = NonNullable<paths['/pos/carts/{id}/update-customer']['post']['requestBody']>['content']['application/json'];
|
|
10926
|
+
type UpdatePosCartAddressResponse = paths['/pos/carts/{id}/address']['post']['responses'][200]['content']['application/json'];
|
|
10927
|
+
type UpdatePosCartAddressContent = UpdatePosCartAddressResponse['content'];
|
|
10928
|
+
type UpdatePosCartAddressPathParams = paths['/pos/carts/{id}/address']['post']['parameters']['path'];
|
|
10929
|
+
type UpdatePosCartAddressBody = NonNullable<paths['/pos/carts/{id}/address']['post']['requestBody']>['content']['application/json'];
|
|
10670
10930
|
|
|
10671
10931
|
/**
|
|
10672
10932
|
* Available API environments
|
|
@@ -10788,6 +11048,50 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
10788
11048
|
* @param options - Optional query parameters
|
|
10789
11049
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
10790
11050
|
* @returns Promise with products and pagination info
|
|
11051
|
+
*
|
|
11052
|
+
* @example
|
|
11053
|
+
* ```typescript
|
|
11054
|
+
* // Basic product listing
|
|
11055
|
+
* const { data, error } = await sdk.catalog.listProducts();
|
|
11056
|
+
*
|
|
11057
|
+
* if (error) {
|
|
11058
|
+
* console.error("Failed to list products:", error);
|
|
11059
|
+
* return;
|
|
11060
|
+
* }
|
|
11061
|
+
*
|
|
11062
|
+
* console.log("Products found:", data.products?.length || 0);
|
|
11063
|
+
* console.log("Pagination:", data.pagination);
|
|
11064
|
+
*
|
|
11065
|
+
* // With filtering and pagination
|
|
11066
|
+
* const { data: filteredData, error: filteredError } = await sdk.catalog.listProducts({
|
|
11067
|
+
* page: 1,
|
|
11068
|
+
* limit: 20,
|
|
11069
|
+
* sort_by: JSON.stringify({ "created_at": "desc" }),
|
|
11070
|
+
* category_slug: ["electronics", "smartphones"]
|
|
11071
|
+
* });
|
|
11072
|
+
*
|
|
11073
|
+
* // Override customer group ID for this specific request
|
|
11074
|
+
* const { data: overrideData, error: overrideError } = await sdk.catalog.listProducts(
|
|
11075
|
+
* {
|
|
11076
|
+
* page: 1,
|
|
11077
|
+
* limit: 20,
|
|
11078
|
+
* sort_by: JSON.stringify({ "created_at": "desc" }),
|
|
11079
|
+
* category_slug: ["electronics", "smartphones"]
|
|
11080
|
+
* },
|
|
11081
|
+
* {
|
|
11082
|
+
* "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config
|
|
11083
|
+
* }
|
|
11084
|
+
* );
|
|
11085
|
+
*
|
|
11086
|
+
* if (filteredError) {
|
|
11087
|
+
* console.error("Failed to get filtered products:", filteredError);
|
|
11088
|
+
* return;
|
|
11089
|
+
* }
|
|
11090
|
+
*
|
|
11091
|
+
* filteredData.products?.forEach(product => {
|
|
11092
|
+
* console.log(`Product: ${product.name} - ${product.price}`);
|
|
11093
|
+
* });
|
|
11094
|
+
* ```
|
|
10791
11095
|
*/
|
|
10792
11096
|
listProducts(options?: ListProductsQuery, headers?: ListProductsHeaderParams): Promise<ApiResult<ListProductsContent>>;
|
|
10793
11097
|
/**
|
|
@@ -10796,6 +11100,46 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
10796
11100
|
* @param options - Optional query parameters
|
|
10797
11101
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
10798
11102
|
* @returns Promise with skus and pagination info
|
|
11103
|
+
*
|
|
11104
|
+
* @example
|
|
11105
|
+
* ```typescript
|
|
11106
|
+
* // Basic SKU listing
|
|
11107
|
+
* const { data, error } = await sdk.catalog.listSkus();
|
|
11108
|
+
*
|
|
11109
|
+
* if (error) {
|
|
11110
|
+
* console.error("Failed to list SKUs:", error);
|
|
11111
|
+
* return;
|
|
11112
|
+
* }
|
|
11113
|
+
*
|
|
11114
|
+
* console.log("SKUs found:", data.skus?.length || 0);
|
|
11115
|
+
* console.log("Pagination:", data.pagination);
|
|
11116
|
+
*
|
|
11117
|
+
* // With pagination
|
|
11118
|
+
* const { data: skuData, error: skuError } = await sdk.catalog.listSkus({
|
|
11119
|
+
* page: 1,
|
|
11120
|
+
* limit: 50
|
|
11121
|
+
* });
|
|
11122
|
+
*
|
|
11123
|
+
* // Override customer group ID for this specific request
|
|
11124
|
+
* const { data: overrideData, error: overrideError } = await sdk.catalog.listSkus(
|
|
11125
|
+
* {
|
|
11126
|
+
* page: 1,
|
|
11127
|
+
* limit: 50
|
|
11128
|
+
* },
|
|
11129
|
+
* {
|
|
11130
|
+
* "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config
|
|
11131
|
+
* }
|
|
11132
|
+
* );
|
|
11133
|
+
*
|
|
11134
|
+
* if (skuError) {
|
|
11135
|
+
* console.error("Failed to get SKUs:", skuError);
|
|
11136
|
+
* return;
|
|
11137
|
+
* }
|
|
11138
|
+
*
|
|
11139
|
+
* skuData.skus?.forEach(sku => {
|
|
11140
|
+
* console.log(`SKU: ${sku.sku} - Price: ${sku.price}`);
|
|
11141
|
+
* });
|
|
11142
|
+
* ```
|
|
10799
11143
|
*/
|
|
10800
11144
|
listSkus(options?: ListSkusQuery, headers?: ListSkusHeaderParams): Promise<ApiResult<ListSkusContent>>;
|
|
10801
11145
|
/**
|
|
@@ -10804,76 +11148,385 @@ declare class CatalogClient extends StorefrontAPIClient {
|
|
|
10804
11148
|
* @param pathParams - The path parameters (product ID or slug)
|
|
10805
11149
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
10806
11150
|
* @returns Promise with product details
|
|
11151
|
+
*
|
|
11152
|
+
* @example
|
|
11153
|
+
* ```typescript
|
|
11154
|
+
* // Get product by ID
|
|
11155
|
+
* const { data, error } = await sdk.catalog.getProductDetail(
|
|
11156
|
+
* { product_id_or_slug: "prod_123" }
|
|
11157
|
+
* );
|
|
11158
|
+
*
|
|
11159
|
+
* if (error) {
|
|
11160
|
+
* console.error("Failed to get product details:", error);
|
|
11161
|
+
* return;
|
|
11162
|
+
* }
|
|
11163
|
+
*
|
|
11164
|
+
* console.log("Product:", data.product.name);
|
|
11165
|
+
* console.log("Price:", data.product.price);
|
|
11166
|
+
* console.log("Description:", data.product.description);
|
|
11167
|
+
*
|
|
11168
|
+
* // Get product by slug
|
|
11169
|
+
* const { data: slugData, error: slugError } = await sdk.catalog.getProductDetail({
|
|
11170
|
+
* product_id_or_slug: "detox-candy"
|
|
11171
|
+
* });
|
|
11172
|
+
*
|
|
11173
|
+
* // Override customer group ID for this specific request
|
|
11174
|
+
* const { data: overrideData, error: overrideError } = await sdk.catalog.getProductDetail(
|
|
11175
|
+
* { product_id_or_slug: "detox-candy" },
|
|
11176
|
+
* {
|
|
11177
|
+
* "x-customer-group-id": "premium_customers" // Override default SDK config
|
|
11178
|
+
* }
|
|
11179
|
+
* );
|
|
11180
|
+
*
|
|
11181
|
+
* if (slugError) {
|
|
11182
|
+
* console.error("Failed to get product by slug:", slugError);
|
|
11183
|
+
* return;
|
|
11184
|
+
* }
|
|
11185
|
+
*
|
|
11186
|
+
* console.log("Product with custom pricing:", slugData.product.price);
|
|
11187
|
+
* ```
|
|
10807
11188
|
*/
|
|
10808
11189
|
getProductDetail(pathParams: GetProductDetailPathParams, headers?: GetProductDetailHeaderParams): Promise<ApiResult<GetProductDetailContent>>;
|
|
10809
11190
|
/**
|
|
10810
|
-
* List variants for a specific product
|
|
11191
|
+
* List all variants for a specific product
|
|
10811
11192
|
*
|
|
10812
11193
|
* @param pathParams - The path parameters (product ID)
|
|
10813
11194
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
10814
|
-
* @returns Promise with variants
|
|
11195
|
+
* @returns Promise with product variants and pagination info
|
|
11196
|
+
*
|
|
11197
|
+
* @example
|
|
11198
|
+
* ```typescript
|
|
11199
|
+
* const { data, error } = await sdk.catalog.listProductVariants(
|
|
11200
|
+
* { product_id: "prod_123" }
|
|
11201
|
+
* );
|
|
11202
|
+
*
|
|
11203
|
+
* if (error) {
|
|
11204
|
+
* console.error("Failed to list product variants:", error);
|
|
11205
|
+
* return;
|
|
11206
|
+
* }
|
|
11207
|
+
*
|
|
11208
|
+
* console.log("Variants found:", data.variants?.length || 0);
|
|
11209
|
+
*
|
|
11210
|
+
* data.variants?.forEach(variant => {
|
|
11211
|
+
* console.log(`Variant: ${variant.name} - SKU: ${variant.sku} - Price: ${variant.price}`);
|
|
11212
|
+
* });
|
|
11213
|
+
*
|
|
11214
|
+
* // Override customer group ID for this specific request
|
|
11215
|
+
* const { data: overrideData, error: overrideError } = await sdk.catalog.listProductVariants(
|
|
11216
|
+
* { product_id: "prod_123" },
|
|
11217
|
+
* {
|
|
11218
|
+
* "x-customer-group-id": "wholesale_customers" // Override default SDK config
|
|
11219
|
+
* }
|
|
11220
|
+
* );
|
|
11221
|
+
* ```
|
|
10815
11222
|
*/
|
|
10816
11223
|
listProductVariants(pathParams: ListProductVariantsPathParams, headers?: ListProductVariantsHeaderParams): Promise<ApiResult<ListProductVariantsContent>>;
|
|
10817
11224
|
/**
|
|
10818
|
-
* Get details for a specific variant
|
|
11225
|
+
* Get details for a specific product variant
|
|
10819
11226
|
*
|
|
10820
11227
|
* @param pathParams - The path parameters (product ID and variant ID)
|
|
10821
11228
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
10822
11229
|
* @returns Promise with variant details
|
|
11230
|
+
*
|
|
11231
|
+
* @example
|
|
11232
|
+
* ```typescript
|
|
11233
|
+
* const { data, error } = await sdk.catalog.getVariantDetail(
|
|
11234
|
+
* {
|
|
11235
|
+
* product_id: "prod_123",
|
|
11236
|
+
* variant_id: "var_456"
|
|
11237
|
+
* }
|
|
11238
|
+
* );
|
|
11239
|
+
*
|
|
11240
|
+
* if (error) {
|
|
11241
|
+
* console.error("Failed to get variant details:", error);
|
|
11242
|
+
* return;
|
|
11243
|
+
* }
|
|
11244
|
+
*
|
|
11245
|
+
* console.log("Variant:", data.variant.name);
|
|
11246
|
+
* console.log("SKU:", data.variant.sku);
|
|
11247
|
+
* console.log("Price:", data.variant.price);
|
|
11248
|
+
* console.log("Stock:", data.variant.stock);
|
|
11249
|
+
* ```
|
|
10823
11250
|
*/
|
|
10824
11251
|
getVariantDetail(pathParams: GetVariantDetailPathParams, headers?: GetVariantDetailHeaderParams): Promise<ApiResult<GetVariantDetailContent>>;
|
|
10825
11252
|
/**
|
|
10826
|
-
* List all categories
|
|
11253
|
+
* List all product categories
|
|
10827
11254
|
*
|
|
10828
11255
|
* @param options - Optional query parameters
|
|
10829
11256
|
* @returns Promise with categories and pagination info
|
|
11257
|
+
*
|
|
11258
|
+
* @example
|
|
11259
|
+
* ```typescript
|
|
11260
|
+
* // Basic category listing
|
|
11261
|
+
* const { data, error } = await sdk.catalog.listCategories();
|
|
11262
|
+
*
|
|
11263
|
+
* if (error) {
|
|
11264
|
+
* console.error("Failed to list categories:", error);
|
|
11265
|
+
* return;
|
|
11266
|
+
* }
|
|
11267
|
+
*
|
|
11268
|
+
* console.log("Categories found:", data.categories?.length || 0);
|
|
11269
|
+
*
|
|
11270
|
+
* data.categories?.forEach(category => {
|
|
11271
|
+
* console.log(`Category: ${category.name} - ${category.description}`);
|
|
11272
|
+
* });
|
|
11273
|
+
*
|
|
11274
|
+
* // With pagination
|
|
11275
|
+
* const { data: catData, error: catError } = await sdk.catalog.listCategories({
|
|
11276
|
+
* page: 1,
|
|
11277
|
+
* limit: 10
|
|
11278
|
+
* });
|
|
11279
|
+
* ```
|
|
10830
11280
|
*/
|
|
10831
11281
|
listCategories(options?: ListCategoriesQuery): Promise<ApiResult<ListCategoriesContent>>;
|
|
10832
11282
|
/**
|
|
10833
|
-
* List reviews for a specific product
|
|
11283
|
+
* List all reviews for a specific product
|
|
10834
11284
|
*
|
|
10835
11285
|
* @param pathParams - The path parameters (product ID)
|
|
10836
11286
|
* @param queryParams - Optional query parameters
|
|
10837
|
-
* @returns Promise with reviews and pagination info
|
|
11287
|
+
* @returns Promise with product reviews and pagination info
|
|
11288
|
+
*
|
|
11289
|
+
* @example
|
|
11290
|
+
* ```typescript
|
|
11291
|
+
* const { data, error } = await sdk.catalog.listProductReviews(
|
|
11292
|
+
* { product_id: "prod_123" }
|
|
11293
|
+
* );
|
|
11294
|
+
*
|
|
11295
|
+
* if (error) {
|
|
11296
|
+
* console.error("Failed to list product reviews:", error);
|
|
11297
|
+
* return;
|
|
11298
|
+
* }
|
|
11299
|
+
*
|
|
11300
|
+
* console.log("Reviews found:", data.reviews?.length || 0);
|
|
11301
|
+
*
|
|
11302
|
+
* data.reviews?.forEach(review => {
|
|
11303
|
+
* console.log(`Review by ${review.customer_name}: ${review.rating}/5`);
|
|
11304
|
+
* console.log("Comment:", review.comment);
|
|
11305
|
+
* });
|
|
11306
|
+
*
|
|
11307
|
+
* // With pagination
|
|
11308
|
+
* const { data: reviewData, error: reviewError } = await sdk.catalog.listProductReviews(
|
|
11309
|
+
* { product_id: "prod_123" },
|
|
11310
|
+
* {
|
|
11311
|
+
* page: 1,
|
|
11312
|
+
* limit: 5
|
|
11313
|
+
* }
|
|
11314
|
+
* );
|
|
11315
|
+
* ```
|
|
10838
11316
|
*/
|
|
10839
11317
|
listProductReviews(pathParams: ListProductReviewsPathParams, queryParams?: ListProductReviewsQuery): Promise<ApiResult<ListProductReviewsContent>>;
|
|
10840
11318
|
/**
|
|
10841
|
-
* Create a review
|
|
11319
|
+
* Create a product review
|
|
10842
11320
|
*
|
|
10843
11321
|
* @param pathParams - The path parameters (product ID)
|
|
10844
|
-
* @param formData - The review data
|
|
10845
|
-
* @returns Promise
|
|
11322
|
+
* @param formData - The review data including rating, comment, and optional images
|
|
11323
|
+
* @returns Promise with review creation response
|
|
11324
|
+
*
|
|
11325
|
+
* @example
|
|
11326
|
+
* ```typescript
|
|
11327
|
+
* const { data, error } = await sdk.catalog.createProductReview(
|
|
11328
|
+
* { product_id: "prod_123" },
|
|
11329
|
+
* {
|
|
11330
|
+
* rating: 5,
|
|
11331
|
+
* comment: "Excellent product! Highly recommended.",
|
|
11332
|
+
* images: [
|
|
11333
|
+
* new File(["image data"], "review1.jpg", { type: "image/jpeg" }),
|
|
11334
|
+
* new File(["image data"], "review2.jpg", { type: "image/jpeg" })
|
|
11335
|
+
* ]
|
|
11336
|
+
* }
|
|
11337
|
+
* );
|
|
11338
|
+
*
|
|
11339
|
+
* if (error) {
|
|
11340
|
+
* console.error("Failed to create review:", error);
|
|
11341
|
+
* return;
|
|
11342
|
+
* }
|
|
11343
|
+
*
|
|
11344
|
+
* console.log("Review created successfully:", data.message);
|
|
11345
|
+
* ```
|
|
10846
11346
|
*/
|
|
10847
11347
|
createProductReview(pathParams: CreateProductReviewPathParams, formData: CreateProductReviewFormData): Promise<ApiResult<CreateProductReviewResponse>>;
|
|
10848
11348
|
/**
|
|
10849
11349
|
* Search for products
|
|
10850
11350
|
*
|
|
10851
|
-
* @param searchData - The search
|
|
10852
|
-
* @
|
|
11351
|
+
* @param searchData - The search query and filters
|
|
11352
|
+
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
11353
|
+
* @returns Promise with search results including products, facets, and pagination
|
|
11354
|
+
*
|
|
11355
|
+
* @example
|
|
11356
|
+
* ```typescript
|
|
11357
|
+
* const { data, error } = await sdk.catalog.searchProducts({
|
|
11358
|
+
* query: "smartphone",
|
|
11359
|
+
* filters: {
|
|
11360
|
+
* category: ["electronics", "mobile"],
|
|
11361
|
+
* price_range: { min: 100, max: 1000 },
|
|
11362
|
+
* brand: ["Apple", "Samsung"] // facet names depend on product configuration
|
|
11363
|
+
* },
|
|
11364
|
+
* page: 1,
|
|
11365
|
+
* limit: 20
|
|
11366
|
+
* });
|
|
11367
|
+
*
|
|
11368
|
+
* if (error) {
|
|
11369
|
+
* console.error("Failed to search products:", error);
|
|
11370
|
+
* return;
|
|
11371
|
+
* }
|
|
11372
|
+
*
|
|
11373
|
+
* console.log("Search results:", data.skus?.length || 0, "products found");
|
|
11374
|
+
* console.log("Facet distribution:", data.facet_distribution);
|
|
11375
|
+
* console.log("Price range:", data.facet_stats.price_range);
|
|
11376
|
+
*
|
|
11377
|
+
* data.skus?.forEach(sku => {
|
|
11378
|
+
* console.log(`Found: ${sku.name} - ${sku.price}`);
|
|
11379
|
+
* });
|
|
11380
|
+
*
|
|
11381
|
+
* // Override customer group ID for this specific request
|
|
11382
|
+
* const { data: overrideData, error: overrideError } = await sdk.catalog.searchProducts(
|
|
11383
|
+
* {
|
|
11384
|
+
* query: "laptop",
|
|
11385
|
+
* filters: { category: ["computers"] }
|
|
11386
|
+
* },
|
|
11387
|
+
* {
|
|
11388
|
+
* "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config
|
|
11389
|
+
* }
|
|
11390
|
+
* );
|
|
11391
|
+
* ```
|
|
10853
11392
|
*/
|
|
10854
11393
|
searchProducts(searchData: SearchProductsBody, headers?: SearchProductsHeaderParams): Promise<ApiResult<SearchProductsContent>>;
|
|
10855
11394
|
/**
|
|
10856
11395
|
* List cross-sell products
|
|
10857
11396
|
*
|
|
10858
|
-
* @param options - Optional query parameters
|
|
11397
|
+
* @param options - Optional query parameters for filtering and pagination
|
|
10859
11398
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
10860
11399
|
* @returns Promise with cross-sell products
|
|
11400
|
+
* @example
|
|
11401
|
+
* ```typescript
|
|
11402
|
+
* // Basic usage - get cross-sell products for cart items
|
|
11403
|
+
* const { data, error } = await sdk.catalog.listCrossSellProducts({
|
|
11404
|
+
* product_id: ["prod_01H9XYZ12345ABCDE", "prod_01H9ABC67890FGHIJ"]
|
|
11405
|
+
* });
|
|
11406
|
+
*
|
|
11407
|
+
* // Advanced usage with pagination and custom sorting
|
|
11408
|
+
* const { data, error } = await sdk.catalog.listCrossSellProducts({
|
|
11409
|
+
* product_id: ["prod_01H9XYZ12345ABCDE"],
|
|
11410
|
+
* page: 1,
|
|
11411
|
+
* limit: 10,
|
|
11412
|
+
* sort_by: '{"price":"asc"}'
|
|
11413
|
+
* });
|
|
11414
|
+
*
|
|
11415
|
+
* // Override customer group ID for this specific request
|
|
11416
|
+
* const { data, error } = await sdk.catalog.listCrossSellProducts(
|
|
11417
|
+
* {
|
|
11418
|
+
* product_id: ["prod_01H9XYZ12345ABCDE"],
|
|
11419
|
+
* page: 1,
|
|
11420
|
+
* limit: 10
|
|
11421
|
+
* },
|
|
11422
|
+
* {
|
|
11423
|
+
* "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config
|
|
11424
|
+
* }
|
|
11425
|
+
* );
|
|
11426
|
+
*
|
|
11427
|
+
* if (error) {
|
|
11428
|
+
* console.error("Failed to get cross-sell products:", error.message);
|
|
11429
|
+
* } else {
|
|
11430
|
+
* console.log("Cross-sell products found:", data.content.products.length);
|
|
11431
|
+
* console.log("Pagination:", data.content.pagination);
|
|
11432
|
+
*
|
|
11433
|
+
* data.content.products.forEach(product => {
|
|
11434
|
+
* console.log(`Product: ${product.name} - ${product.price}`);
|
|
11435
|
+
* });
|
|
11436
|
+
* }
|
|
11437
|
+
* ```
|
|
10861
11438
|
*/
|
|
10862
11439
|
listCrossSellProducts(options?: ListCrosssellProductsQuery, headers?: ListCrosssellProductsHeaderParams): Promise<ApiResult<ListCrosssellProductsContent>>;
|
|
10863
11440
|
/**
|
|
10864
11441
|
* List up-sell products
|
|
10865
11442
|
*
|
|
10866
|
-
* @param options - Optional query parameters
|
|
11443
|
+
* @param options - Optional query parameters for filtering and pagination
|
|
10867
11444
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
10868
11445
|
* @returns Promise with up-sell products
|
|
11446
|
+
* @example
|
|
11447
|
+
* ```typescript
|
|
11448
|
+
* // Basic usage - get up-sell products for cart items
|
|
11449
|
+
* const { data, error } = await sdk.catalog.listUpSellProducts({
|
|
11450
|
+
* product_id: ["prod_01H9XYZ12345ABCDE"]
|
|
11451
|
+
* });
|
|
11452
|
+
*
|
|
11453
|
+
* // Advanced usage with pagination and custom sorting
|
|
11454
|
+
* const { data, error } = await sdk.catalog.listUpSellProducts({
|
|
11455
|
+
* product_id: ["prod_01H9XYZ12345ABCDE"],
|
|
11456
|
+
* page: 1,
|
|
11457
|
+
* limit: 15,
|
|
11458
|
+
* sort_by: '{"relevance":"desc"}'
|
|
11459
|
+
* });
|
|
11460
|
+
*
|
|
11461
|
+
* // Override customer group ID for this specific request
|
|
11462
|
+
* const { data, error } = await sdk.catalog.listUpSellProducts(
|
|
11463
|
+
* {
|
|
11464
|
+
* product_id: ["prod_01H9XYZ12345ABCDE"],
|
|
11465
|
+
* page: 1,
|
|
11466
|
+
* limit: 15
|
|
11467
|
+
* },
|
|
11468
|
+
* {
|
|
11469
|
+
* "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config
|
|
11470
|
+
* }
|
|
11471
|
+
* );
|
|
11472
|
+
*
|
|
11473
|
+
* if (error) {
|
|
11474
|
+
* console.error("Failed to get up-sell products:", error.message);
|
|
11475
|
+
* } else {
|
|
11476
|
+
* console.log("Up-sell products found:", data.content.products.length);
|
|
11477
|
+
* console.log("Pagination:", data.content.pagination);
|
|
11478
|
+
*
|
|
11479
|
+
* data.content.products.forEach(product => {
|
|
11480
|
+
* console.log(`Up-sell: ${product.name} - ${product.price}`);
|
|
11481
|
+
* });
|
|
11482
|
+
* }
|
|
11483
|
+
* ```
|
|
10869
11484
|
*/
|
|
10870
11485
|
listUpSellProducts(options?: ListUpsellProductsQuery, headers?: ListUpsellProductsHeaderParams): Promise<ApiResult<ListUpsellProductsContent>>;
|
|
10871
11486
|
/**
|
|
10872
11487
|
* List similar products
|
|
10873
11488
|
*
|
|
10874
|
-
* @param options - Optional query parameters
|
|
11489
|
+
* @param options - Optional query parameters for filtering and pagination
|
|
10875
11490
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
10876
11491
|
* @returns Promise with similar products
|
|
11492
|
+
* @example
|
|
11493
|
+
* ```typescript
|
|
11494
|
+
* // Basic usage - get similar products for a specific product
|
|
11495
|
+
* const { data, error } = await sdk.catalog.listSimilarProducts({
|
|
11496
|
+
* product_id: ["prod_01H9XYZ12345ABCDE"]
|
|
11497
|
+
* });
|
|
11498
|
+
*
|
|
11499
|
+
* // Advanced usage with pagination and custom sorting
|
|
11500
|
+
* const { data, error } = await sdk.catalog.listSimilarProducts({
|
|
11501
|
+
* product_id: ["prod_01H9XYZ12345ABCDE"],
|
|
11502
|
+
* page: 1,
|
|
11503
|
+
* limit: 20,
|
|
11504
|
+
* sort_by: '{"relevance":"desc"}'
|
|
11505
|
+
* });
|
|
11506
|
+
*
|
|
11507
|
+
* // Override customer group ID for this specific request
|
|
11508
|
+
* const { data, error } = await sdk.catalog.listSimilarProducts(
|
|
11509
|
+
* {
|
|
11510
|
+
* product_id: ["prod_01H9XYZ12345ABCDE"],
|
|
11511
|
+
* page: 1,
|
|
11512
|
+
* limit: 20
|
|
11513
|
+
* },
|
|
11514
|
+
* {
|
|
11515
|
+
* "x-customer-group-id": "01H9XYZ12345USERID" // Override default SDK config
|
|
11516
|
+
* }
|
|
11517
|
+
* );
|
|
11518
|
+
*
|
|
11519
|
+
* if (error) {
|
|
11520
|
+
* console.error("Failed to get similar products:", error.message);
|
|
11521
|
+
* } else {
|
|
11522
|
+
* console.log("Similar products found:", data.content.products.length);
|
|
11523
|
+
* console.log("Pagination:", data.content.pagination);
|
|
11524
|
+
*
|
|
11525
|
+
* data.content.products.forEach(product => {
|
|
11526
|
+
* console.log(`Similar: ${product.name} - ${product.price}`);
|
|
11527
|
+
* });
|
|
11528
|
+
* }
|
|
11529
|
+
* ```
|
|
10877
11530
|
*/
|
|
10878
11531
|
listSimilarProducts(options?: ListSimilarProductsQuery, headers?: ListSimilarProductsHeaderParams): Promise<ApiResult<ListSimilarProductsContent>>;
|
|
10879
11532
|
}
|
|
@@ -10887,6 +11540,33 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10887
11540
|
*
|
|
10888
11541
|
* @param payload - Object containing the items to add to the cart
|
|
10889
11542
|
* @returns Promise with the created cart
|
|
11543
|
+
* @example
|
|
11544
|
+
* ```typescript
|
|
11545
|
+
* const { data, error } = await sdk.cart.createCart({
|
|
11546
|
+
* items: [
|
|
11547
|
+
* {
|
|
11548
|
+
* product_id: "01H9XYZ12345ABCDE",
|
|
11549
|
+
* variant_id: null,
|
|
11550
|
+
* quantity: 2
|
|
11551
|
+
* },
|
|
11552
|
+
* {
|
|
11553
|
+
* product_id: "01H9ABC67890FGHIJ",
|
|
11554
|
+
* variant_id: "01H9XYZ67890KLMNO",
|
|
11555
|
+
* quantity: 1
|
|
11556
|
+
* }
|
|
11557
|
+
* ],
|
|
11558
|
+
* metadata: {
|
|
11559
|
+
* "source": "web",
|
|
11560
|
+
* "campaign": "summer_sale"
|
|
11561
|
+
* }
|
|
11562
|
+
* });
|
|
11563
|
+
*
|
|
11564
|
+
* if (error) {
|
|
11565
|
+
* console.error("Failed to create cart:", error.message);
|
|
11566
|
+
* } else {
|
|
11567
|
+
* console.log("Cart created:", data.cart.id);
|
|
11568
|
+
* }
|
|
11569
|
+
* ```
|
|
10890
11570
|
*/
|
|
10891
11571
|
createCart(payload: CreateCartBody): Promise<ApiResult<CreateCartContent>>;
|
|
10892
11572
|
/**
|
|
@@ -10894,6 +11574,20 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10894
11574
|
*
|
|
10895
11575
|
* @param cartId - The ID of the cart
|
|
10896
11576
|
* @returns Promise with cart details
|
|
11577
|
+
* @example
|
|
11578
|
+
* ```typescript
|
|
11579
|
+
* const { data, error } = await sdk.cart.getCart({
|
|
11580
|
+
* id: "01H9CART12345ABCDE"
|
|
11581
|
+
* });
|
|
11582
|
+
*
|
|
11583
|
+
* if (error) {
|
|
11584
|
+
* console.error("Failed to get cart:", error.message);
|
|
11585
|
+
* } else {
|
|
11586
|
+
* const cart = data.cart;
|
|
11587
|
+
* console.log("Cart total:", cart.total_amount);
|
|
11588
|
+
* console.log("Items count:", cart.items.length);
|
|
11589
|
+
* }
|
|
11590
|
+
* ```
|
|
10897
11591
|
*/
|
|
10898
11592
|
getCart(cartId: GetCartPathParams): Promise<ApiResult<GetCartContent>>;
|
|
10899
11593
|
/**
|
|
@@ -10901,6 +11595,18 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10901
11595
|
*
|
|
10902
11596
|
* @param cartId - The ID of the cart
|
|
10903
11597
|
* @returns Promise that resolves when the cart is deleted
|
|
11598
|
+
* @example
|
|
11599
|
+
* ```typescript
|
|
11600
|
+
* const { data, error } = await sdk.cart.deleteCart({
|
|
11601
|
+
* id: "01H9CART12345ABCDE"
|
|
11602
|
+
* });
|
|
11603
|
+
*
|
|
11604
|
+
* if (error) {
|
|
11605
|
+
* console.error("Failed to delete cart:", error.message);
|
|
11606
|
+
* } else {
|
|
11607
|
+
* console.log("Cart deleted:", data.message);
|
|
11608
|
+
* }
|
|
11609
|
+
* ```
|
|
10904
11610
|
*/
|
|
10905
11611
|
deleteCart(cartId: DeleteCartPathParams): Promise<ApiResult<DeleteCartResponse>>;
|
|
10906
11612
|
/**
|
|
@@ -10909,6 +11615,34 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10909
11615
|
* @param cartId - The cart id
|
|
10910
11616
|
* @param body - The body of the request
|
|
10911
11617
|
* @returns Promise with updated cart
|
|
11618
|
+
* @example
|
|
11619
|
+
* ```typescript
|
|
11620
|
+
* // Add item to cart
|
|
11621
|
+
* const { data, error } = await sdk.cart.addDeleteCartItem(
|
|
11622
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11623
|
+
* {
|
|
11624
|
+
* product_id: "01H9XYZ12345ABCDE",
|
|
11625
|
+
* variant_id: null,
|
|
11626
|
+
* quantity: 3
|
|
11627
|
+
* }
|
|
11628
|
+
* );
|
|
11629
|
+
*
|
|
11630
|
+
* if (error) {
|
|
11631
|
+
* console.error("Failed to update cart:", error.message);
|
|
11632
|
+
* } else {
|
|
11633
|
+
* console.log("Cart updated:", data.cart.items.length);
|
|
11634
|
+
* }
|
|
11635
|
+
*
|
|
11636
|
+
* // Remove item from cart (set quantity to 0)
|
|
11637
|
+
* const { data: removeData, error: removeError } = await sdk.cart.addDeleteCartItem(
|
|
11638
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11639
|
+
* {
|
|
11640
|
+
* product_id: "01H9XYZ12345ABCDE",
|
|
11641
|
+
* variant_id: null,
|
|
11642
|
+
* quantity: 0
|
|
11643
|
+
* }
|
|
11644
|
+
* );
|
|
11645
|
+
* ```
|
|
10912
11646
|
*/
|
|
10913
11647
|
addDeleteCartItem(cartId: UpdateCartPathParams, body: UpdateCartBody): Promise<ApiResult<UpdateCartContent>>;
|
|
10914
11648
|
/**
|
|
@@ -10916,6 +11650,19 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10916
11650
|
*
|
|
10917
11651
|
* @param userId - The ID of the user
|
|
10918
11652
|
* @returns Promise with cart details
|
|
11653
|
+
* @example
|
|
11654
|
+
* ```typescript
|
|
11655
|
+
* const { data, error } = await sdk.cart.getUserCart({
|
|
11656
|
+
* user_id: "01H9USER12345ABCDE"
|
|
11657
|
+
* });
|
|
11658
|
+
*
|
|
11659
|
+
* if (error) {
|
|
11660
|
+
* console.error("Failed to get user cart:", error.message);
|
|
11661
|
+
* } else {
|
|
11662
|
+
* console.log("User cart ID:", data.cart.id);
|
|
11663
|
+
* console.log("Cart value:", data.cart.subtotal_amount);
|
|
11664
|
+
* }
|
|
11665
|
+
* ```
|
|
10919
11666
|
*/
|
|
10920
11667
|
getUserCart(userId: GetUserCartPathParams): Promise<ApiResult<GetUserCartContent>>;
|
|
10921
11668
|
/**
|
|
@@ -10923,6 +11670,18 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10923
11670
|
*
|
|
10924
11671
|
* @param userId - The ID of the user
|
|
10925
11672
|
* @returns Promise that resolves when the cart is deleted
|
|
11673
|
+
* @example
|
|
11674
|
+
* ```typescript
|
|
11675
|
+
* const { data, error } = await sdk.cart.deleteUserCart({
|
|
11676
|
+
* user_id: "01H9USER12345ABCDE"
|
|
11677
|
+
* });
|
|
11678
|
+
*
|
|
11679
|
+
* if (error) {
|
|
11680
|
+
* console.error("Failed to delete user cart:", error.message);
|
|
11681
|
+
* } else {
|
|
11682
|
+
* console.log("User cart cleared:", data.message);
|
|
11683
|
+
* }
|
|
11684
|
+
* ```
|
|
10926
11685
|
*/
|
|
10927
11686
|
deleteUserCart(userId: DeleteUserCartPathParams): Promise<ApiResult<DeleteUserCartResponse>>;
|
|
10928
11687
|
/**
|
|
@@ -10931,6 +11690,62 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10931
11690
|
* @param cartId - The ID of the cart
|
|
10932
11691
|
* @param addressData - The address data
|
|
10933
11692
|
* @returns Promise with updated cart
|
|
11693
|
+
* @example
|
|
11694
|
+
* ```typescript
|
|
11695
|
+
* // For registered users with saved addresses
|
|
11696
|
+
* const { data, error } = await sdk.cart.updateCartAddress(
|
|
11697
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11698
|
+
* {
|
|
11699
|
+
* billing_address_id: "01H9ADDR12345BILL",
|
|
11700
|
+
* shipping_address_id: "01H9ADDR12345SHIP"
|
|
11701
|
+
* }
|
|
11702
|
+
* );
|
|
11703
|
+
*
|
|
11704
|
+
* if (error) {
|
|
11705
|
+
* console.error("Failed to update cart address:", error.message);
|
|
11706
|
+
* } else {
|
|
11707
|
+
* console.log("Addresses updated:", data.message);
|
|
11708
|
+
* }
|
|
11709
|
+
*
|
|
11710
|
+
* // For guest checkout with new addresses
|
|
11711
|
+
* const { data: guestData, error: guestError } = await sdk.cart.updateCartAddress(
|
|
11712
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11713
|
+
* {
|
|
11714
|
+
* billing_address: {
|
|
11715
|
+
* first_name: "John",
|
|
11716
|
+
* last_name: "Doe",
|
|
11717
|
+
* email: "john@example.com",
|
|
11718
|
+
* phone: "9876543210",
|
|
11719
|
+
* country_code: "+91",
|
|
11720
|
+
* address_line1: "123 Main Street",
|
|
11721
|
+
* address_line2: "Apt 4B",
|
|
11722
|
+
* city: "Mumbai",
|
|
11723
|
+
* state: "Maharashtra",
|
|
11724
|
+
* pincode: "400001",
|
|
11725
|
+
* country: "India",
|
|
11726
|
+
* landmark: "Near Station",
|
|
11727
|
+
* tax_identification_number: null,
|
|
11728
|
+
* business_name: null
|
|
11729
|
+
* },
|
|
11730
|
+
* shipping_address: {
|
|
11731
|
+
* first_name: "John",
|
|
11732
|
+
* last_name: "Doe",
|
|
11733
|
+
* email: "john@example.com",
|
|
11734
|
+
* phone: "9876543210",
|
|
11735
|
+
* country_code: "+91",
|
|
11736
|
+
* address_line1: "456 Oak Avenue",
|
|
11737
|
+
* address_line2: null,
|
|
11738
|
+
* city: "Pune",
|
|
11739
|
+
* state: "Maharashtra",
|
|
11740
|
+
* pincode: "411001",
|
|
11741
|
+
* country: "India",
|
|
11742
|
+
* landmark: "Near Mall",
|
|
11743
|
+
* tax_identification_number: null,
|
|
11744
|
+
* business_name: null
|
|
11745
|
+
* }
|
|
11746
|
+
* }
|
|
11747
|
+
* );
|
|
11748
|
+
* ```
|
|
10934
11749
|
*/
|
|
10935
11750
|
updateCartAddress(cartId: CreateCartAddressPathParams, addressData: CreateCartAddressBody): Promise<ApiResult<CreateCartAddressContent>>;
|
|
10936
11751
|
/**
|
|
@@ -10939,6 +11754,20 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10939
11754
|
* @param cartId - The ID of the cart
|
|
10940
11755
|
* @param couponCode - The coupon code
|
|
10941
11756
|
* @returns Promise with updated cart
|
|
11757
|
+
* @example
|
|
11758
|
+
* ```typescript
|
|
11759
|
+
* const { data, error } = await sdk.cart.applyCoupon(
|
|
11760
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11761
|
+
* { coupon_code: "FLAT100OFF" }
|
|
11762
|
+
* );
|
|
11763
|
+
*
|
|
11764
|
+
* if (error) {
|
|
11765
|
+
* console.error("Failed to apply coupon:", error.message);
|
|
11766
|
+
* } else {
|
|
11767
|
+
* console.log("Coupon applied, new total:", data.cart.total_amount);
|
|
11768
|
+
* console.log("Discount amount:", data.cart.coupon_discount_amount);
|
|
11769
|
+
* }
|
|
11770
|
+
* ```
|
|
10942
11771
|
*/
|
|
10943
11772
|
applyCoupon(cartId: ApplyCouponPathParams, couponCode: ApplyCouponBody): Promise<ApiResult<ApplyCouponContent>>;
|
|
10944
11773
|
/**
|
|
@@ -10946,6 +11775,18 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10946
11775
|
*
|
|
10947
11776
|
* @param cartId - The ID of the cart
|
|
10948
11777
|
* @returns Promise with updated cart
|
|
11778
|
+
* @example
|
|
11779
|
+
* ```typescript
|
|
11780
|
+
* const { data, error } = await sdk.cart.removeCoupon({
|
|
11781
|
+
* id: "01H9CART12345ABCDE"
|
|
11782
|
+
* });
|
|
11783
|
+
*
|
|
11784
|
+
* if (error) {
|
|
11785
|
+
* console.error("Failed to remove coupon:", error.message);
|
|
11786
|
+
* } else {
|
|
11787
|
+
* console.log("Coupon removed, new total:", data.cart.total_amount);
|
|
11788
|
+
* }
|
|
11789
|
+
* ```
|
|
10949
11790
|
*/
|
|
10950
11791
|
removeCoupon(cartId: RemoveCouponPathParams): Promise<ApiResult<RemoveCouponContent>>;
|
|
10951
11792
|
/**
|
|
@@ -10954,6 +11795,20 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10954
11795
|
* @param cartId - The ID of the cart
|
|
10955
11796
|
* @param points - The number of points to redeem
|
|
10956
11797
|
* @returns Promise with updated cart
|
|
11798
|
+
* @example
|
|
11799
|
+
* ```typescript
|
|
11800
|
+
* const { data, error } = await sdk.cart.redeemLoyaltyPoints(
|
|
11801
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11802
|
+
* { points: 500 }
|
|
11803
|
+
* );
|
|
11804
|
+
*
|
|
11805
|
+
* if (error) {
|
|
11806
|
+
* console.error("Failed to redeem loyalty points:", error.message);
|
|
11807
|
+
* } else {
|
|
11808
|
+
* console.log("Points redeemed, new total:", data.cart.total_amount);
|
|
11809
|
+
* console.log("Points discount:", data.cart.loyalty_points_discount_amount);
|
|
11810
|
+
* }
|
|
11811
|
+
* ```
|
|
10957
11812
|
*/
|
|
10958
11813
|
redeemLoyaltyPoints(cartId: RedeemLoyaltyPointsPathParams, points: RedeemLoyaltyPointsBody): Promise<ApiResult<RedeemLoyaltyPointsContent>>;
|
|
10959
11814
|
/**
|
|
@@ -10961,6 +11816,18 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10961
11816
|
*
|
|
10962
11817
|
* @param cartId - The ID of the cart
|
|
10963
11818
|
* @returns Promise with updated cart
|
|
11819
|
+
* @example
|
|
11820
|
+
* ```typescript
|
|
11821
|
+
* const { data, error } = await sdk.cart.removeLoyaltyPoints({
|
|
11822
|
+
* id: "01H9CART12345ABCDE"
|
|
11823
|
+
* });
|
|
11824
|
+
*
|
|
11825
|
+
* if (error) {
|
|
11826
|
+
* console.error("Failed to remove loyalty points:", error.message);
|
|
11827
|
+
* } else {
|
|
11828
|
+
* console.log("Loyalty points removed, new total:", data.cart.total_amount);
|
|
11829
|
+
* }
|
|
11830
|
+
* ```
|
|
10964
11831
|
*/
|
|
10965
11832
|
removeLoyaltyPoints(cartId: RemoveLoyaltyPointsPathParams): Promise<ApiResult<RemoveLoyaltyPointsContent>>;
|
|
10966
11833
|
/**
|
|
@@ -10969,6 +11836,23 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10969
11836
|
* @param cartId - The ID of the cart
|
|
10970
11837
|
* @param body - The body of the request
|
|
10971
11838
|
* @returns Promise with updated cart
|
|
11839
|
+
* @example
|
|
11840
|
+
* ```typescript
|
|
11841
|
+
* const { data, error } = await sdk.cart.updateShippingMethod(
|
|
11842
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11843
|
+
* {
|
|
11844
|
+
* shipping_method_id: "01H9SHIP12345FAST",
|
|
11845
|
+
* estimated_delivery_date: "2024-01-15"
|
|
11846
|
+
* }
|
|
11847
|
+
* );
|
|
11848
|
+
*
|
|
11849
|
+
* if (error) {
|
|
11850
|
+
* console.error("Failed to update shipping method:", error.message);
|
|
11851
|
+
* } else {
|
|
11852
|
+
* console.log("Shipping method updated:", data.cart.shipping_method?.name);
|
|
11853
|
+
* console.log("Shipping cost:", data.cart.shipping_cost);
|
|
11854
|
+
* }
|
|
11855
|
+
* ```
|
|
10972
11856
|
*/
|
|
10973
11857
|
updateShippingMethod(cartId: UpdateShippingMethodPathParams, body: UpdateShippingMethodBody): Promise<ApiResult<UpdateShippingMethodContent>>;
|
|
10974
11858
|
/**
|
|
@@ -10977,6 +11861,20 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10977
11861
|
* @param cartId - The ID of the cart
|
|
10978
11862
|
* @param body - The body of the request
|
|
10979
11863
|
* @returns Promise with updated cart
|
|
11864
|
+
* @example
|
|
11865
|
+
* ```typescript
|
|
11866
|
+
* const { data, error } = await sdk.cart.redeemCreditBalance(
|
|
11867
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11868
|
+
* { amount: 250.00 }
|
|
11869
|
+
* );
|
|
11870
|
+
*
|
|
11871
|
+
* if (error) {
|
|
11872
|
+
* console.error("Failed to redeem credit balance:", error.message);
|
|
11873
|
+
* } else {
|
|
11874
|
+
* console.log("Credit applied, new total:", data.cart.total_amount);
|
|
11875
|
+
* console.log("Credit discount:", data.cart.credit_balance_discount_amount);
|
|
11876
|
+
* }
|
|
11877
|
+
* ```
|
|
10980
11878
|
*/
|
|
10981
11879
|
redeemCreditBalance(cartId: RedeemCreditBalancePathParams, body: RedeemCreditBalanceBody): Promise<ApiResult<RedeemCreditBalanceContent>>;
|
|
10982
11880
|
/**
|
|
@@ -10984,6 +11882,18 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10984
11882
|
*
|
|
10985
11883
|
* @param cartId - The ID of the cart
|
|
10986
11884
|
* @returns Promise with updated cart
|
|
11885
|
+
* @example
|
|
11886
|
+
* ```typescript
|
|
11887
|
+
* const { data, error } = await sdk.cart.removeCreditBalance({
|
|
11888
|
+
* id: "01H9CART12345ABCDE"
|
|
11889
|
+
* });
|
|
11890
|
+
*
|
|
11891
|
+
* if (error) {
|
|
11892
|
+
* console.error("Failed to remove credit balance:", error.message);
|
|
11893
|
+
* } else {
|
|
11894
|
+
* console.log("Credit balance removed, new total:", data.cart.total_amount);
|
|
11895
|
+
* }
|
|
11896
|
+
* ```
|
|
10987
11897
|
*/
|
|
10988
11898
|
removeCreditBalance(cartId: RemoveCreditBalancePathParams): Promise<ApiResult<RemoveCreditBalanceContent>>;
|
|
10989
11899
|
/**
|
|
@@ -10992,6 +11902,23 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10992
11902
|
* @param cartId - The ID of the cart
|
|
10993
11903
|
* @param body - The body of the request
|
|
10994
11904
|
* @returns Promise with updated cart
|
|
11905
|
+
* @example
|
|
11906
|
+
* ```typescript
|
|
11907
|
+
* const { data, error } = await sdk.cart.redeemGiftCard(
|
|
11908
|
+
* { id: "01H9CART12345ABCDE" },
|
|
11909
|
+
* {
|
|
11910
|
+
* gift_card_code: "GIFT2024-ABCD-1234",
|
|
11911
|
+
* amount: 100.00
|
|
11912
|
+
* }
|
|
11913
|
+
* );
|
|
11914
|
+
*
|
|
11915
|
+
* if (error) {
|
|
11916
|
+
* console.error("Failed to redeem gift card:", error.message);
|
|
11917
|
+
* } else {
|
|
11918
|
+
* console.log("Gift card applied, new total:", data.cart.total_amount);
|
|
11919
|
+
* console.log("Gift card discount:", data.cart.gift_card_discount_amount);
|
|
11920
|
+
* }
|
|
11921
|
+
* ```
|
|
10995
11922
|
*/
|
|
10996
11923
|
redeemGiftCard(cartId: RedeemGiftCardPathParams, body: RedeemGiftCardBody): Promise<ApiResult<RedeemGiftCardContent>>;
|
|
10997
11924
|
/**
|
|
@@ -10999,6 +11926,18 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
10999
11926
|
*
|
|
11000
11927
|
* @param cartId - The ID of the cart
|
|
11001
11928
|
* @returns Promise with updated cart
|
|
11929
|
+
* @example
|
|
11930
|
+
* ```typescript
|
|
11931
|
+
* const { data, error } = await sdk.cart.removeGiftCard({
|
|
11932
|
+
* id: "01H9CART12345ABCDE"
|
|
11933
|
+
* });
|
|
11934
|
+
*
|
|
11935
|
+
* if (error) {
|
|
11936
|
+
* console.error("Failed to remove gift card:", error.message);
|
|
11937
|
+
* } else {
|
|
11938
|
+
* console.log("Gift card removed, new total:", data.cart.total_amount);
|
|
11939
|
+
* }
|
|
11940
|
+
* ```
|
|
11002
11941
|
*/
|
|
11003
11942
|
removeGiftCard(cartId: RemoveGiftCardPathParams): Promise<ApiResult<RemoveGiftCardContent>>;
|
|
11004
11943
|
/**
|
|
@@ -11006,6 +11945,22 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
11006
11945
|
*
|
|
11007
11946
|
* @param userId - The ID of the user
|
|
11008
11947
|
* @returns Promise with wishlist items
|
|
11948
|
+
* @example
|
|
11949
|
+
* ```typescript
|
|
11950
|
+
* const { data, error } = await sdk.cart.getWishlist({
|
|
11951
|
+
* user_id: "01H9USER12345ABCDE"
|
|
11952
|
+
* });
|
|
11953
|
+
*
|
|
11954
|
+
* if (error) {
|
|
11955
|
+
* console.error("Failed to get wishlist:", error.message);
|
|
11956
|
+
* } else {
|
|
11957
|
+
* const products = data.products;
|
|
11958
|
+
* console.log("Wishlist items:", products.length);
|
|
11959
|
+
* products.forEach(product => {
|
|
11960
|
+
* console.log("Product:", product.name, "Price:", product.price);
|
|
11961
|
+
* });
|
|
11962
|
+
* }
|
|
11963
|
+
* ```
|
|
11009
11964
|
*/
|
|
11010
11965
|
getWishlist(userId: GetWishlistPathParams): Promise<ApiResult<GetWishlistContent>>;
|
|
11011
11966
|
/**
|
|
@@ -11014,14 +11969,48 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
11014
11969
|
* @param userId - The ID of the user
|
|
11015
11970
|
* @param itemId - The ID of the item
|
|
11016
11971
|
* @returns Promise with updated wishlist
|
|
11972
|
+
* @example
|
|
11973
|
+
* ```typescript
|
|
11974
|
+
* const { data, error } = await sdk.cart.addToWishlist(
|
|
11975
|
+
* { user_id: "01H9USER12345ABCDE" },
|
|
11976
|
+
* {
|
|
11977
|
+
* product_id: "01F3Z7KG06J4ACWH1C4926KJEC",
|
|
11978
|
+
* variant_id: null
|
|
11979
|
+
* }
|
|
11980
|
+
* );
|
|
11981
|
+
*
|
|
11982
|
+
* if (error) {
|
|
11983
|
+
* console.error("Failed to add to wishlist:", error.message);
|
|
11984
|
+
* } else {
|
|
11985
|
+
* const products = data.products;
|
|
11986
|
+
* console.log("Item added to wishlist, total items:", products.length);
|
|
11987
|
+
* }
|
|
11988
|
+
* ```
|
|
11017
11989
|
*/
|
|
11018
11990
|
addToWishlist(userId: AddToWishlistPathParams, itemId: AddToWishlistBody): Promise<ApiResult<AddToWishlistContent>>;
|
|
11019
11991
|
/**
|
|
11020
11992
|
* Remove item from wishlist
|
|
11021
11993
|
*
|
|
11022
11994
|
* @param userId - The ID of the user
|
|
11023
|
-
* @param
|
|
11995
|
+
* @param body - The body containing product details to remove
|
|
11024
11996
|
* @returns Promise with updated wishlist
|
|
11997
|
+
* @example
|
|
11998
|
+
* ```typescript
|
|
11999
|
+
* const { data, error } = await sdk.cart.removeFromWishlist(
|
|
12000
|
+
* { user_id: "01H9USER12345ABCDE" },
|
|
12001
|
+
* {
|
|
12002
|
+
* product_id: "01F3Z7KG06J4ACWH1C4926KJEC",
|
|
12003
|
+
* variant_id: null
|
|
12004
|
+
* }
|
|
12005
|
+
* );
|
|
12006
|
+
*
|
|
12007
|
+
* if (error) {
|
|
12008
|
+
* console.error("Failed to remove from wishlist:", error.message);
|
|
12009
|
+
* } else {
|
|
12010
|
+
* const products = data.products;
|
|
12011
|
+
* console.log("Item removed from wishlist, remaining items:", products.length);
|
|
12012
|
+
* }
|
|
12013
|
+
* ```
|
|
11025
12014
|
*/
|
|
11026
12015
|
removeFromWishlist(userId: DeleteFromWishlistPathParams, body: DeleteFromWishlistBody): Promise<ApiResult<DeleteFromWishlistContent>>;
|
|
11027
12016
|
/**
|
|
@@ -11029,6 +12018,26 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
11029
12018
|
*
|
|
11030
12019
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
11031
12020
|
* @returns Promise with all available coupons
|
|
12021
|
+
* @example
|
|
12022
|
+
* ```typescript
|
|
12023
|
+
* // Get all available coupons
|
|
12024
|
+
* const { data, error } = await sdk.cart.getAvailableCoupons();
|
|
12025
|
+
*
|
|
12026
|
+
* if (error) {
|
|
12027
|
+
* console.error("Failed to get available coupons:", error.message);
|
|
12028
|
+
* } else {
|
|
12029
|
+
* const coupons = data.coupons || [];
|
|
12030
|
+
* console.log("Available coupons:", coupons.length);
|
|
12031
|
+
* coupons.forEach(coupon => {
|
|
12032
|
+
* console.log("Coupon:", coupon.code, "Discount:", coupon.discount_amount);
|
|
12033
|
+
* });
|
|
12034
|
+
* }
|
|
12035
|
+
*
|
|
12036
|
+
* // Override customer group ID for this specific request
|
|
12037
|
+
* const { data: overrideData, error: overrideError } = await sdk.cart.getAvailableCoupons({
|
|
12038
|
+
* "x-customer-group-id": "01H9GROUP12345ABC" // Override default SDK config
|
|
12039
|
+
* });
|
|
12040
|
+
* ```
|
|
11032
12041
|
*/
|
|
11033
12042
|
getAvailableCoupons(headers?: ListCouponsHeaderParams): Promise<ApiResult<ListCouponsContent>>;
|
|
11034
12043
|
/**
|
|
@@ -11036,6 +12045,26 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
11036
12045
|
*
|
|
11037
12046
|
* @param headers - Optional header parameters (customer_group_id, etc.)
|
|
11038
12047
|
* @returns Promise with all available promotions
|
|
12048
|
+
* @example
|
|
12049
|
+
* ```typescript
|
|
12050
|
+
* // Get all available promotions
|
|
12051
|
+
* const { data, error } = await sdk.cart.getAvailablePromotions();
|
|
12052
|
+
*
|
|
12053
|
+
* if (error) {
|
|
12054
|
+
* console.error("Failed to get available promotions:", error.message);
|
|
12055
|
+
* } else {
|
|
12056
|
+
* const promotions = data.promotions || [];
|
|
12057
|
+
* console.log("Available promotions:", promotions.length);
|
|
12058
|
+
* promotions.forEach(promotion => {
|
|
12059
|
+
* console.log("Promotion:", promotion.name, "Type:", promotion.promotion_type);
|
|
12060
|
+
* });
|
|
12061
|
+
* }
|
|
12062
|
+
*
|
|
12063
|
+
* // Override customer group ID for this specific request
|
|
12064
|
+
* const { data: overrideData, error: overrideError } = await sdk.cart.getAvailablePromotions({
|
|
12065
|
+
* "x-customer-group-id": "01H9GROUP12345ABC" // Override default SDK config
|
|
12066
|
+
* });
|
|
12067
|
+
* ```
|
|
11039
12068
|
*/
|
|
11040
12069
|
getAvailablePromotions(headers?: ListPromotionsHeaderParams): Promise<ApiResult<ListPromotionsContent>>;
|
|
11041
12070
|
/**
|
|
@@ -11043,6 +12072,29 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
11043
12072
|
*
|
|
11044
12073
|
* @param cartId - The ID of the cart
|
|
11045
12074
|
* @returns Promise with evaluated promotions
|
|
12075
|
+
* @example
|
|
12076
|
+
* ```typescript
|
|
12077
|
+
* const { data, error } = await sdk.cart.evaluatePromotions({
|
|
12078
|
+
* id: "01H9CART12345ABCDE"
|
|
12079
|
+
* });
|
|
12080
|
+
*
|
|
12081
|
+
* if (error) {
|
|
12082
|
+
* console.error("Failed to evaluate promotions:", error.message);
|
|
12083
|
+
* } else {
|
|
12084
|
+
* const applicable = data.applicable_promotions || [];
|
|
12085
|
+
* const inapplicable = data.inapplicable_promotions || [];
|
|
12086
|
+
*
|
|
12087
|
+
* console.log("Applicable promotions:", applicable.length);
|
|
12088
|
+
* applicable.forEach(promo => {
|
|
12089
|
+
* console.log(`- ${promo.name}: ${promo.savings_message}`);
|
|
12090
|
+
* });
|
|
12091
|
+
*
|
|
12092
|
+
* console.log("Inapplicable promotions:", inapplicable.length);
|
|
12093
|
+
* inapplicable.forEach(promo => {
|
|
12094
|
+
* console.log(`- ${promo.name}: ${promo.reason}`);
|
|
12095
|
+
* });
|
|
12096
|
+
* }
|
|
12097
|
+
* ```
|
|
11046
12098
|
*/
|
|
11047
12099
|
evaluatePromotions(cartId: EvaluatePromotionsPathParams): Promise<ApiResult<EvaluatePromotionsContent>>;
|
|
11048
12100
|
/**
|
|
@@ -11050,6 +12102,29 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
11050
12102
|
*
|
|
11051
12103
|
* @param cartId - The ID of the cart
|
|
11052
12104
|
* @returns Promise with evaluated coupons
|
|
12105
|
+
* @example
|
|
12106
|
+
* ```typescript
|
|
12107
|
+
* const { data, error } = await sdk.cart.evaluateCoupons({
|
|
12108
|
+
* id: "01H9CART12345ABCDE"
|
|
12109
|
+
* });
|
|
12110
|
+
*
|
|
12111
|
+
* if (error) {
|
|
12112
|
+
* console.error("Failed to evaluate coupons:", error.message);
|
|
12113
|
+
* } else {
|
|
12114
|
+
* const applicable = data.applicable_coupons || [];
|
|
12115
|
+
* const inapplicable = data.inapplicable_coupons || [];
|
|
12116
|
+
*
|
|
12117
|
+
* console.log("Applicable coupons:", applicable.length);
|
|
12118
|
+
* applicable.forEach(coupon => {
|
|
12119
|
+
* console.log(`- ${coupon.code}: Save $${coupon.estimated_discount}`);
|
|
12120
|
+
* });
|
|
12121
|
+
*
|
|
12122
|
+
* console.log("Inapplicable coupons:", inapplicable.length);
|
|
12123
|
+
* inapplicable.forEach(coupon => {
|
|
12124
|
+
* console.log(`- ${coupon.code}: ${coupon.reason}`);
|
|
12125
|
+
* });
|
|
12126
|
+
* }
|
|
12127
|
+
* ```
|
|
11053
12128
|
*/
|
|
11054
12129
|
evaluateCoupons(cartId: EvaluateCouponsPathParams): Promise<ApiResult<EvaluateCouponsContent>>;
|
|
11055
12130
|
}
|
|
@@ -11060,181 +12135,571 @@ declare class CartClient extends StorefrontAPIClient {
|
|
|
11060
12135
|
declare class AuthClient extends StorefrontAPIClient {
|
|
11061
12136
|
/**
|
|
11062
12137
|
* Get anonymous token for guest users
|
|
12138
|
+
*
|
|
12139
|
+
* @example
|
|
12140
|
+
* ```typescript
|
|
12141
|
+
* // Get token for guest browsing
|
|
12142
|
+
* const { data, error } = await sdk.auth.getAnonymousToken();
|
|
12143
|
+
*
|
|
12144
|
+
* if (error) {
|
|
12145
|
+
* console.error("Failed to get anonymous token:", error.message);
|
|
12146
|
+
* } else {
|
|
12147
|
+
* console.log("Anonymous token:", data.access_token);
|
|
12148
|
+
* // Store token or proceed with guest operations
|
|
12149
|
+
* }
|
|
12150
|
+
* ```
|
|
11063
12151
|
*/
|
|
11064
12152
|
getAnonymousToken(): Promise<ApiResult<GetAnonymousTokenContent>>;
|
|
11065
12153
|
/**
|
|
11066
12154
|
* Login with phone number
|
|
11067
12155
|
*
|
|
11068
|
-
* @param
|
|
11069
|
-
* @param countryCode - Country code (defaults to +91)
|
|
11070
|
-
* @param registerIfNotExists - Whether to register if user doesn't exist
|
|
12156
|
+
* @param body - Login request body containing phone number and options
|
|
11071
12157
|
* @returns Promise with OTP token and action
|
|
12158
|
+
* @example
|
|
12159
|
+
* ```typescript
|
|
12160
|
+
* // Login with phone number
|
|
12161
|
+
* const { data, error } = await sdk.auth.loginWithPhone({
|
|
12162
|
+
* phoneNumber: "9876543210",
|
|
12163
|
+
* countryCode: "+91",
|
|
12164
|
+
* registerIfNotExists: true
|
|
12165
|
+
* });
|
|
12166
|
+
*
|
|
12167
|
+
* if (error) {
|
|
12168
|
+
* console.error("Login failed:", error.message);
|
|
12169
|
+
* } else {
|
|
12170
|
+
* console.log("OTP sent. Token:", data.otpToken);
|
|
12171
|
+
* console.log("Action:", data.action); // "login" or "register"
|
|
12172
|
+
* // Redirect user to OTP verification screen
|
|
12173
|
+
* }
|
|
12174
|
+
* ```
|
|
11072
12175
|
*/
|
|
11073
12176
|
loginWithPhone(body: LoginWithPhoneBody): Promise<ApiResult<LoginWithPhoneContent>>;
|
|
11074
12177
|
/**
|
|
11075
12178
|
* Login with WhatsApp
|
|
11076
12179
|
*
|
|
11077
|
-
* @param
|
|
11078
|
-
* @param countryCode - Country code (defaults to +91)
|
|
11079
|
-
* @param registerIfNotExists - Whether to register if user doesn't exist
|
|
12180
|
+
* @param body - Login request body containing phone number and options
|
|
11080
12181
|
* @returns Promise with OTP token and action
|
|
12182
|
+
* @example
|
|
12183
|
+
* ```typescript
|
|
12184
|
+
* // Login with WhatsApp number
|
|
12185
|
+
* const { data, error } = await sdk.auth.loginWithWhatsApp({
|
|
12186
|
+
* phone: "9876543210",
|
|
12187
|
+
* country_code: "+91",
|
|
12188
|
+
* register_if_not_exists: true
|
|
12189
|
+
* });
|
|
12190
|
+
*
|
|
12191
|
+
* if (error) {
|
|
12192
|
+
* console.error("WhatsApp login failed:", error.message);
|
|
12193
|
+
* } else {
|
|
12194
|
+
* console.log("OTP sent to WhatsApp. Token:", data.otp_token);
|
|
12195
|
+
* console.log("Action:", data.otp_action); // "login" or "register"
|
|
12196
|
+
* }
|
|
12197
|
+
* ```
|
|
11081
12198
|
*/
|
|
11082
12199
|
loginWithWhatsApp(body: LoginWithWhatsappBody): Promise<ApiResult<LoginWithWhatsappContent>>;
|
|
11083
12200
|
/**
|
|
11084
12201
|
* Login with email
|
|
11085
12202
|
*
|
|
11086
|
-
* @param
|
|
11087
|
-
* @param registerIfNotExists - Whether to register if user doesn't exist
|
|
12203
|
+
* @param body - Login request body containing email and options
|
|
11088
12204
|
* @returns Promise with OTP token and action
|
|
12205
|
+
* @example
|
|
12206
|
+
* ```typescript
|
|
12207
|
+
* // Login with email address
|
|
12208
|
+
* const { data, error } = await sdk.auth.loginWithEmail({
|
|
12209
|
+
* email: "customer@example.com",
|
|
12210
|
+
* registerIfNotExists: true
|
|
12211
|
+
* });
|
|
12212
|
+
*
|
|
12213
|
+
* if (error) {
|
|
12214
|
+
* console.error("Email login failed:", error.message);
|
|
12215
|
+
* } else {
|
|
12216
|
+
* console.log("OTP sent to email. Token:", data.otpToken);
|
|
12217
|
+
* console.log("Action:", data.action); // "login" or "register"
|
|
12218
|
+
* // Show OTP input form
|
|
12219
|
+
* }
|
|
12220
|
+
* ```
|
|
11089
12221
|
*/
|
|
11090
12222
|
loginWithEmail(body: LoginWithEmailBody): Promise<ApiResult<LoginWithEmailContent>>;
|
|
11091
12223
|
/**
|
|
11092
12224
|
* Login with password
|
|
11093
12225
|
*
|
|
11094
|
-
* @param
|
|
12226
|
+
* @param body - Login credentials containing email/phone and password
|
|
11095
12227
|
* @returns Promise with user info and tokens
|
|
12228
|
+
* @example
|
|
12229
|
+
* ```typescript
|
|
12230
|
+
* // Login with email and password
|
|
12231
|
+
* const { data, error } = await sdk.auth.loginWithPassword({
|
|
12232
|
+
* email: "customer@example.com",
|
|
12233
|
+
* password: "securePassword123"
|
|
12234
|
+
* });
|
|
12235
|
+
*
|
|
12236
|
+
* if (error) {
|
|
12237
|
+
* console.error("Password login failed:", error.message);
|
|
12238
|
+
* } else {
|
|
12239
|
+
* console.log("Login successful:", data.user.email);
|
|
12240
|
+
* console.log("Access token:", data.access_token);
|
|
12241
|
+
* }
|
|
12242
|
+
* ```
|
|
11096
12243
|
*/
|
|
11097
12244
|
loginWithPassword(body: LoginWithPasswordBody): Promise<ApiResult<LoginWithPasswordContent>>;
|
|
11098
12245
|
/**
|
|
11099
12246
|
* Forgot password
|
|
11100
12247
|
*
|
|
11101
|
-
* @param
|
|
11102
|
-
* @returns Promise with
|
|
12248
|
+
* @param body - Request body containing email address
|
|
12249
|
+
* @returns Promise with password reset information
|
|
12250
|
+
* @example
|
|
12251
|
+
* ```typescript
|
|
12252
|
+
* // Send password reset email
|
|
12253
|
+
* const { data, error } = await sdk.auth.forgotPassword({
|
|
12254
|
+
* email: "customer@example.com"
|
|
12255
|
+
* });
|
|
12256
|
+
*
|
|
12257
|
+
* if (error) {
|
|
12258
|
+
* console.error("Password reset failed:", error.message);
|
|
12259
|
+
* } else {
|
|
12260
|
+
* console.log("Reset email sent successfully");
|
|
12261
|
+
* // Show confirmation message to user
|
|
12262
|
+
* }
|
|
12263
|
+
* ```
|
|
11103
12264
|
*/
|
|
11104
12265
|
forgotPassword(body: ForgotPasswordBody): Promise<ApiResult<ForgotPasswordContent>>;
|
|
11105
12266
|
/**
|
|
11106
12267
|
* Reset password
|
|
11107
12268
|
*
|
|
11108
|
-
* @param
|
|
11109
|
-
* @returns Promise with
|
|
12269
|
+
* @param body - Reset password request body containing new password and OTP token
|
|
12270
|
+
* @returns Promise with new access and refresh tokens
|
|
12271
|
+
* @example
|
|
12272
|
+
* ```typescript
|
|
12273
|
+
* // Reset password with OTP token from forgot password flow
|
|
12274
|
+
* const { data, error } = await sdk.auth.resetPassword({
|
|
12275
|
+
* new_password: "newSecurePassword123",
|
|
12276
|
+
* confirm_password: "newSecurePassword123",
|
|
12277
|
+
* otp_token: "abc123otptoken"
|
|
12278
|
+
* });
|
|
12279
|
+
*
|
|
12280
|
+
* if (error) {
|
|
12281
|
+
* console.error("Password reset failed:", error.message);
|
|
12282
|
+
* } else {
|
|
12283
|
+
* console.log("Password reset successful");
|
|
12284
|
+
* console.log("New access token:", data.access_token);
|
|
12285
|
+
* }
|
|
12286
|
+
* ```
|
|
11110
12287
|
*/
|
|
11111
12288
|
resetPassword(body: ResetPasswordBody): Promise<ApiResult<ResetPasswordContent>>;
|
|
11112
12289
|
/**
|
|
11113
12290
|
* Change password
|
|
11114
12291
|
*
|
|
11115
|
-
* @param
|
|
11116
|
-
* @
|
|
11117
|
-
* @
|
|
11118
|
-
*
|
|
12292
|
+
* @param body - Change password request body containing old and new passwords
|
|
12293
|
+
* @returns Promise with new access and refresh tokens
|
|
12294
|
+
* @example
|
|
12295
|
+
* ```typescript
|
|
12296
|
+
* // Change user's password
|
|
12297
|
+
* const { data, error } = await sdk.auth.changePassword({
|
|
12298
|
+
* old_password: "currentPassword123",
|
|
12299
|
+
* new_password: "newSecurePassword456",
|
|
12300
|
+
* confirm_password: "newSecurePassword456"
|
|
12301
|
+
* });
|
|
12302
|
+
*
|
|
12303
|
+
* if (error) {
|
|
12304
|
+
* console.error("Password change failed:", error.message);
|
|
12305
|
+
* } else {
|
|
12306
|
+
* console.log("Password changed successfully");
|
|
12307
|
+
* console.log("New access token:", data.access_token);
|
|
12308
|
+
* }
|
|
12309
|
+
* ```
|
|
11119
12310
|
*/
|
|
11120
12311
|
changePassword(body: ChangePasswordBody): Promise<ApiResult<ChangePasswordContent>>;
|
|
11121
12312
|
/**
|
|
11122
12313
|
* Verify OTP
|
|
11123
12314
|
*
|
|
11124
|
-
* @param
|
|
11125
|
-
* @param otpToken - OTP token from login request
|
|
11126
|
-
* @param otpAction - OTP action from login request
|
|
12315
|
+
* @param body - OTP verification data including code and tokens
|
|
11127
12316
|
* @returns Promise with user info and tokens
|
|
12317
|
+
* @example
|
|
12318
|
+
* ```typescript
|
|
12319
|
+
* // Verify OTP after login attempt
|
|
12320
|
+
* const { data, error } = await sdk.auth.verifyOtp({
|
|
12321
|
+
* otp: "1234",
|
|
12322
|
+
* otpToken: "56895455",
|
|
12323
|
+
* otpAction: "login" // or "register"
|
|
12324
|
+
* });
|
|
12325
|
+
*
|
|
12326
|
+
* if (error) {
|
|
12327
|
+
* console.error("OTP verification failed:", error.message);
|
|
12328
|
+
* // Show error message, allow retry
|
|
12329
|
+
* } else {
|
|
12330
|
+
* console.log("Login successful:", data.user.email);
|
|
12331
|
+
* console.log("User ID:", data.user.id);
|
|
12332
|
+
* }
|
|
12333
|
+
* ```
|
|
11128
12334
|
*/
|
|
11129
12335
|
verifyOtp(body: VerifyOtpBody): Promise<ApiResult<VerifyOtpContent>>;
|
|
11130
12336
|
/**
|
|
11131
12337
|
* Register with phone
|
|
11132
12338
|
*
|
|
11133
|
-
* @param
|
|
12339
|
+
* @param body - Registration details including phone number and user information
|
|
11134
12340
|
* @returns Promise with user info and tokens
|
|
12341
|
+
* @example
|
|
12342
|
+
* ```typescript
|
|
12343
|
+
* // Register a new user with phone number
|
|
12344
|
+
* const { data, error } = await sdk.auth.registerWithPhone({
|
|
12345
|
+
* phone: "9876543210",
|
|
12346
|
+
* country_code: "+91",
|
|
12347
|
+
* first_name: "John",
|
|
12348
|
+
* last_name: "Doe",
|
|
12349
|
+
* email: "john.doe@example.com"
|
|
12350
|
+
* });
|
|
12351
|
+
*
|
|
12352
|
+
* if (error) {
|
|
12353
|
+
* console.error("Phone registration failed:", error.message);
|
|
12354
|
+
* } else {
|
|
12355
|
+
* console.log("Registration successful:", data.user.first_name);
|
|
12356
|
+
* console.log("User ID:", data.user.id);
|
|
12357
|
+
* console.log("Access token:", data.access_token);
|
|
12358
|
+
* }
|
|
12359
|
+
* ```
|
|
11135
12360
|
*/
|
|
11136
12361
|
registerWithPhone(body: RegisterWithPhoneBody): Promise<ApiResult<RegisterWithPhoneContent>>;
|
|
11137
12362
|
/**
|
|
11138
12363
|
* Register with email
|
|
11139
12364
|
*
|
|
11140
|
-
* @param
|
|
12365
|
+
* @param body - Registration details including email and user information
|
|
11141
12366
|
* @returns Promise with user info and tokens
|
|
12367
|
+
* @example
|
|
12368
|
+
* ```typescript
|
|
12369
|
+
* // Register a new user with email address
|
|
12370
|
+
* const { data, error } = await sdk.auth.registerWithEmail({
|
|
12371
|
+
* email: "jane.smith@example.com",
|
|
12372
|
+
* first_name: "Jane",
|
|
12373
|
+
* last_name: "Smith",
|
|
12374
|
+
* phone: "9876543210"
|
|
12375
|
+
* });
|
|
12376
|
+
*
|
|
12377
|
+
* if (error) {
|
|
12378
|
+
* console.error("Email registration failed:", error.message);
|
|
12379
|
+
* } else {
|
|
12380
|
+
* console.log("Registration successful:", data.user.email);
|
|
12381
|
+
* console.log("User ID:", data.user.id);
|
|
12382
|
+
* console.log("Access token:", data.access_token);
|
|
12383
|
+
* }
|
|
12384
|
+
* ```
|
|
11142
12385
|
*/
|
|
11143
12386
|
registerWithEmail(body: RegisterWithEmailBody): Promise<ApiResult<RegisterWithEmailContent>>;
|
|
11144
12387
|
/**
|
|
11145
12388
|
* Refresh the access token using a refresh token
|
|
11146
|
-
* @param
|
|
12389
|
+
* @param body - Request body containing the refresh token
|
|
11147
12390
|
* @returns Promise with the new access token and refresh token
|
|
12391
|
+
* @example
|
|
12392
|
+
* ```typescript
|
|
12393
|
+
* // Refresh access token when it expires
|
|
12394
|
+
* const { data, error } = await sdk.auth.refreshToken({
|
|
12395
|
+
* refresh_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
|
|
12396
|
+
* });
|
|
12397
|
+
*
|
|
12398
|
+
* if (error) {
|
|
12399
|
+
* console.error("Token refresh failed:", error.message);
|
|
12400
|
+
* // Redirect to login
|
|
12401
|
+
* } else {
|
|
12402
|
+
* console.log("Token refreshed successfully");
|
|
12403
|
+
* console.log("New access token:", data.access_token);
|
|
12404
|
+
* console.log("New refresh token:", data.refresh_token);
|
|
12405
|
+
* }
|
|
12406
|
+
* ```
|
|
11148
12407
|
*/
|
|
11149
12408
|
refreshToken(body: RefreshTokenBody): Promise<ApiResult<RefreshTokenContent>>;
|
|
11150
12409
|
/**
|
|
11151
12410
|
* Logout
|
|
11152
12411
|
*
|
|
11153
12412
|
* @returns Promise that resolves when logout is complete
|
|
12413
|
+
* @example
|
|
12414
|
+
* ```typescript
|
|
12415
|
+
* // Logout current user
|
|
12416
|
+
* const { data, error } = await sdk.auth.logout();
|
|
12417
|
+
*
|
|
12418
|
+
* if (error) {
|
|
12419
|
+
* console.error("Logout failed:", error.message);
|
|
12420
|
+
* } else {
|
|
12421
|
+
* console.log("Logout successful");
|
|
12422
|
+
* console.log("Session ended for user:", data.user.email);
|
|
12423
|
+
* }
|
|
12424
|
+
* ```
|
|
11154
12425
|
*/
|
|
11155
12426
|
logout(): Promise<ApiResult<LogoutContent>>;
|
|
11156
12427
|
/**
|
|
11157
12428
|
* Get user details
|
|
11158
12429
|
*
|
|
11159
|
-
* @param
|
|
12430
|
+
* @param pathParams - Path parameters containing user ID
|
|
11160
12431
|
* @returns Promise with user details
|
|
12432
|
+
* @example
|
|
12433
|
+
* ```typescript
|
|
12434
|
+
* // Get details for a specific user
|
|
12435
|
+
* const { data, error } = await sdk.auth.getUserDetails({
|
|
12436
|
+
* id: "01H9XYZ12345USERID"
|
|
12437
|
+
* });
|
|
12438
|
+
*
|
|
12439
|
+
* if (error) {
|
|
12440
|
+
* console.error("Failed to get user details:", error.message);
|
|
12441
|
+
* } else {
|
|
12442
|
+
* console.log("User details:", data.user);
|
|
12443
|
+
* console.log("Email:", data.user.email);
|
|
12444
|
+
* console.log("Phone:", data.user.phoneNumber);
|
|
12445
|
+
* console.log("Created:", data.user.createdAt);
|
|
12446
|
+
* }
|
|
12447
|
+
* ```
|
|
11161
12448
|
*/
|
|
11162
12449
|
getUserDetails(pathParams: GetUserDetailPathParams): Promise<ApiResult<GetUserDetailContent>>;
|
|
11163
12450
|
/**
|
|
11164
12451
|
* Update user details
|
|
11165
12452
|
*
|
|
11166
|
-
* @param
|
|
11167
|
-
* @
|
|
12453
|
+
* @param pathParams - Path parameters containing user ID
|
|
12454
|
+
* @param body - Updated user information
|
|
12455
|
+
* @returns Promise with updated user details
|
|
12456
|
+
* @example
|
|
12457
|
+
* ```typescript
|
|
12458
|
+
* // Update user profile information
|
|
12459
|
+
* const { data, error } = await sdk.auth.updateUserDetails(
|
|
12460
|
+
* { id: "01H9XYZ12345USERID" },
|
|
12461
|
+
* {
|
|
12462
|
+
* first_name: "John",
|
|
12463
|
+
* last_name: "Doe",
|
|
12464
|
+
* email: "john.doe@example.com",
|
|
12465
|
+
* phone: "9876543210",
|
|
12466
|
+
* country_code: "+91"
|
|
12467
|
+
* }
|
|
12468
|
+
* );
|
|
12469
|
+
*
|
|
12470
|
+
* if (error) {
|
|
12471
|
+
* console.error("Failed to update user:", error.message);
|
|
12472
|
+
* } else {
|
|
12473
|
+
* console.log("User updated successfully:", data.user.first_name);
|
|
12474
|
+
* }
|
|
12475
|
+
* ```
|
|
11168
12476
|
*/
|
|
11169
12477
|
updateUserDetails(pathParams: UpdateUserPathParams, body: UpdateUserBody): Promise<ApiResult<UpdateUserContent>>;
|
|
11170
12478
|
/**
|
|
11171
12479
|
* Add profile image
|
|
11172
12480
|
*
|
|
11173
|
-
* @param
|
|
11174
|
-
* @
|
|
12481
|
+
* @param pathParams - Path parameters containing user ID
|
|
12482
|
+
* @param formData - Form data containing the image file
|
|
12483
|
+
* @returns Promise with profile image URL
|
|
12484
|
+
* @example
|
|
12485
|
+
* ```typescript
|
|
12486
|
+
* // Add profile image for a user
|
|
12487
|
+
* const imageFile = document.getElementById('file-input').files[0];
|
|
12488
|
+
* const { data, error } = await sdk.auth.addProfileImage(
|
|
12489
|
+
* { id: "01H9XYZ12345USERID" },
|
|
12490
|
+
* { image: imageFile }
|
|
12491
|
+
* );
|
|
12492
|
+
*
|
|
12493
|
+
* if (error) {
|
|
12494
|
+
* console.error("Failed to add profile image:", error.message);
|
|
12495
|
+
* } else {
|
|
12496
|
+
* console.log("Profile image added successfully");
|
|
12497
|
+
* console.log("Image URL:", data.profile_image_url);
|
|
12498
|
+
* }
|
|
12499
|
+
* ```
|
|
11175
12500
|
*/
|
|
11176
12501
|
addProfileImage(pathParams: AddProfileImagePathParams, formData: AddProfileImageFormData): Promise<ApiResult<AddProfileImageContent>>;
|
|
11177
12502
|
/**
|
|
11178
12503
|
* Update profile image
|
|
11179
12504
|
*
|
|
11180
|
-
* @param
|
|
11181
|
-
* @
|
|
12505
|
+
* @param pathParams - Path parameters containing user ID
|
|
12506
|
+
* @param formData - Form data containing the new image file
|
|
12507
|
+
* @returns Promise with updated profile image URL
|
|
12508
|
+
* @example
|
|
12509
|
+
* ```typescript
|
|
12510
|
+
* // Update existing profile image
|
|
12511
|
+
* const newImageFile = document.getElementById('file-input').files[0];
|
|
12512
|
+
* const { data, error } = await sdk.auth.updateProfileImage(
|
|
12513
|
+
* { id: "01H9XYZ12345USERID" },
|
|
12514
|
+
* { image: newImageFile }
|
|
12515
|
+
* );
|
|
12516
|
+
*
|
|
12517
|
+
* if (error) {
|
|
12518
|
+
* console.error("Failed to update profile image:", error.message);
|
|
12519
|
+
* } else {
|
|
12520
|
+
* console.log("Profile image updated successfully");
|
|
12521
|
+
* console.log("New image URL:", data.profile_image_url);
|
|
12522
|
+
* }
|
|
12523
|
+
* ```
|
|
11182
12524
|
*/
|
|
11183
12525
|
updateProfileImage(pathParams: UpdateProfileImagePathParams, formData: UpdateProfileImageFormData): Promise<ApiResult<UpdateProfileImageContent>>;
|
|
11184
12526
|
/**
|
|
11185
12527
|
* Delete profile image
|
|
11186
12528
|
*
|
|
11187
|
-
* @param
|
|
11188
|
-
* @returns Promise with
|
|
12529
|
+
* @param pathParams - Path parameters containing user ID
|
|
12530
|
+
* @returns Promise with deletion confirmation
|
|
12531
|
+
* @example
|
|
12532
|
+
* ```typescript
|
|
12533
|
+
* // Delete user's profile image
|
|
12534
|
+
* const { data, error } = await sdk.auth.deleteProfileImage({
|
|
12535
|
+
* id: "01H9XYZ12345USERID"
|
|
12536
|
+
* });
|
|
12537
|
+
*
|
|
12538
|
+
* if (error) {
|
|
12539
|
+
* console.error("Failed to delete profile image:", error.message);
|
|
12540
|
+
* } else {
|
|
12541
|
+
* console.log("Profile image deleted successfully");
|
|
12542
|
+
* console.log("Success:", data.success);
|
|
12543
|
+
* }
|
|
12544
|
+
* ```
|
|
11189
12545
|
*/
|
|
11190
12546
|
deleteProfileImage(pathParams: RemoveProfileImagePathParams): Promise<ApiResult<RemoveProfileImageResponse>>;
|
|
11191
12547
|
/**
|
|
11192
12548
|
* Get profile image
|
|
11193
12549
|
*
|
|
11194
|
-
* @param
|
|
11195
|
-
* @returns Promise with
|
|
12550
|
+
* @param pathParams - Path parameters containing user ID
|
|
12551
|
+
* @returns Promise with profile image URL
|
|
12552
|
+
* @example
|
|
12553
|
+
* ```typescript
|
|
12554
|
+
* // Get user's profile image URL
|
|
12555
|
+
* const { data, error } = await sdk.auth.getProfileImage({
|
|
12556
|
+
* id: "01H9XYZ12345USERID"
|
|
12557
|
+
* });
|
|
12558
|
+
*
|
|
12559
|
+
* if (error) {
|
|
12560
|
+
* console.error("Failed to get profile image:", error.message);
|
|
12561
|
+
* } else {
|
|
12562
|
+
* console.log("Profile image URL:", data.profile_image_url);
|
|
12563
|
+
* }
|
|
12564
|
+
* ```
|
|
11196
12565
|
*/
|
|
11197
12566
|
getProfileImage(pathParams: GetProfileImagePathParams): Promise<ApiResult<GetProfileImageContent>>;
|
|
11198
12567
|
/**
|
|
11199
12568
|
* Deactivate user account
|
|
11200
12569
|
*
|
|
11201
|
-
* @param
|
|
11202
|
-
* @returns Promise with
|
|
12570
|
+
* @param pathParams - Path parameters containing user ID
|
|
12571
|
+
* @returns Promise with deactivation confirmation
|
|
12572
|
+
* @example
|
|
12573
|
+
* ```typescript
|
|
12574
|
+
* // Deactivate a user account
|
|
12575
|
+
* const { data, error } = await sdk.auth.deactivateUserAccount({
|
|
12576
|
+
* id: "01H9XYZ12345USERID"
|
|
12577
|
+
* });
|
|
12578
|
+
*
|
|
12579
|
+
* if (error) {
|
|
12580
|
+
* console.error("Failed to deactivate account:", error.message);
|
|
12581
|
+
* } else {
|
|
12582
|
+
* console.log("Account deactivated successfully");
|
|
12583
|
+
* console.log("Success:", data.success);
|
|
12584
|
+
* }
|
|
12585
|
+
* ```
|
|
11203
12586
|
*/
|
|
11204
12587
|
deactivateUserAccount(pathParams: DeactivateUserPathParams): Promise<ApiResult<DeactivateUserResponse>>;
|
|
11205
12588
|
/**
|
|
11206
12589
|
* Get user notification preferences
|
|
11207
12590
|
*
|
|
11208
|
-
* @param
|
|
11209
|
-
* @returns Promise with user
|
|
12591
|
+
* @param pathParams - Path parameters containing user ID
|
|
12592
|
+
* @returns Promise with user's notification preferences
|
|
12593
|
+
* @example
|
|
12594
|
+
* ```typescript
|
|
12595
|
+
* // Get user's notification preferences
|
|
12596
|
+
* const { data, error } = await sdk.auth.getUserNotificationPreferences({
|
|
12597
|
+
* id: "01H9XYZ12345USERID"
|
|
12598
|
+
* });
|
|
12599
|
+
*
|
|
12600
|
+
* if (error) {
|
|
12601
|
+
* console.error("Failed to get preferences:", error.message);
|
|
12602
|
+
* } else {
|
|
12603
|
+
* console.log("Notification preferences:", data.notification_preferences);
|
|
12604
|
+
* }
|
|
12605
|
+
* ```
|
|
11210
12606
|
*/
|
|
11211
12607
|
getUserNotificationPreferences(pathParams: GetNotificationPreferencesPathParams): Promise<ApiResult<GetNotificationPreferencesContent>>;
|
|
11212
12608
|
/**
|
|
11213
12609
|
* Update user notification preferences
|
|
11214
12610
|
*
|
|
11215
|
-
* @param
|
|
11216
|
-
* @
|
|
12611
|
+
* @param pathParams - Path parameters containing user ID
|
|
12612
|
+
* @param body - Updated notification preferences
|
|
12613
|
+
* @returns Promise with updated notification preferences
|
|
12614
|
+
* @example
|
|
12615
|
+
* ```typescript
|
|
12616
|
+
* // Update user's notification preferences
|
|
12617
|
+
* const { data, error } = await sdk.auth.updateUserNotificationPreferences(
|
|
12618
|
+
* { id: "01H9XYZ12345USERID" },
|
|
12619
|
+
* {
|
|
12620
|
+
* email_notifications: true,
|
|
12621
|
+
* sms_notifications: false,
|
|
12622
|
+
* push_notifications: true
|
|
12623
|
+
* }
|
|
12624
|
+
* );
|
|
12625
|
+
*
|
|
12626
|
+
* if (error) {
|
|
12627
|
+
* console.error("Failed to update preferences:", error.message);
|
|
12628
|
+
* } else {
|
|
12629
|
+
* console.log("Preferences updated successfully");
|
|
12630
|
+
* }
|
|
12631
|
+
* ```
|
|
11217
12632
|
*/
|
|
11218
12633
|
updateUserNotificationPreferences(pathParams: UpdateNotificationPreferencesPathParams, body: UpdateNotificationPreferencesBody): Promise<ApiResult<UpdateNotificationPreferencesContent>>;
|
|
11219
12634
|
/**
|
|
11220
12635
|
* Create user notification preference
|
|
11221
12636
|
*
|
|
11222
|
-
* @param
|
|
11223
|
-
* @
|
|
12637
|
+
* @param pathParams - Path parameters containing user ID
|
|
12638
|
+
* @param body - Notification preferences to create
|
|
12639
|
+
* @returns Promise with created notification preferences
|
|
12640
|
+
* @example
|
|
12641
|
+
* ```typescript
|
|
12642
|
+
* // Create notification preferences for a user
|
|
12643
|
+
* const { data, error } = await sdk.auth.createUserNotificationPreference(
|
|
12644
|
+
* { id: "01H9XYZ12345USERID" },
|
|
12645
|
+
* {
|
|
12646
|
+
* email_notifications: true,
|
|
12647
|
+
* sms_notifications: true,
|
|
12648
|
+
* push_notifications: false
|
|
12649
|
+
* }
|
|
12650
|
+
* );
|
|
12651
|
+
*
|
|
12652
|
+
* if (error) {
|
|
12653
|
+
* console.error("Failed to create preferences:", error.message);
|
|
12654
|
+
* } else {
|
|
12655
|
+
* console.log("Preferences created successfully");
|
|
12656
|
+
* }
|
|
12657
|
+
* ```
|
|
11224
12658
|
*/
|
|
11225
12659
|
createUserNotificationPreference(pathParams: CreateNotificationPreferencesPathParams, body: CreateNotificationPreferencesBody): Promise<ApiResult<CreateNotificationPreferencesContent>>;
|
|
11226
12660
|
/**
|
|
11227
12661
|
* Generate OTP
|
|
11228
12662
|
*
|
|
11229
|
-
* @param body - OTP generation body
|
|
11230
|
-
* @returns Promise with OTP
|
|
12663
|
+
* @param body - OTP generation body (phone or email)
|
|
12664
|
+
* @returns Promise with OTP token and action
|
|
12665
|
+
* @example
|
|
12666
|
+
* ```typescript
|
|
12667
|
+
* // Generate OTP for phone number
|
|
12668
|
+
* const { data, error } = await sdk.auth.generateOtp({
|
|
12669
|
+
* phone: "9876543210",
|
|
12670
|
+
* country_code: "+91"
|
|
12671
|
+
* });
|
|
12672
|
+
*
|
|
12673
|
+
* if (error) {
|
|
12674
|
+
* console.error("OTP generation failed:", error.message);
|
|
12675
|
+
* } else {
|
|
12676
|
+
* console.log("OTP sent successfully");
|
|
12677
|
+
* console.log("OTP token:", data.otp_token);
|
|
12678
|
+
* console.log("Action:", data.otp_action);
|
|
12679
|
+
* }
|
|
12680
|
+
* ```
|
|
11231
12681
|
*/
|
|
11232
12682
|
generateOtp(body: GenerateOtpBody): Promise<ApiResult<GenerateOtpContent>>;
|
|
11233
12683
|
/**
|
|
11234
12684
|
* Check whether email or phone is already verified
|
|
11235
12685
|
*
|
|
11236
|
-
* @param body -
|
|
11237
|
-
* @returns Promise with
|
|
12686
|
+
* @param body - Request body containing phone numbers or email addresses to verify
|
|
12687
|
+
* @returns Promise with verification status for provided contacts
|
|
12688
|
+
* @example
|
|
12689
|
+
* ```typescript
|
|
12690
|
+
* // Check verification status for multiple contacts
|
|
12691
|
+
* const { data, error } = await sdk.auth.checkEmailOrPhoneIsVerified({
|
|
12692
|
+
* phone: ["9876543210", "9123456789"],
|
|
12693
|
+
* email: ["user1@example.com", "user2@example.com"]
|
|
12694
|
+
* });
|
|
12695
|
+
*
|
|
12696
|
+
* if (error) {
|
|
12697
|
+
* console.error("Verification check failed:", error.message);
|
|
12698
|
+
* } else {
|
|
12699
|
+
* console.log("Verified phones:", data.verified_phone);
|
|
12700
|
+
* console.log("Verified emails:", data.verified_email);
|
|
12701
|
+
* }
|
|
12702
|
+
* ```
|
|
11238
12703
|
*/
|
|
11239
12704
|
checkEmailOrPhoneIsVerified(body: CheckVerificationStatusBody): Promise<ApiResult<CheckVerificationStatusContent>>;
|
|
11240
12705
|
}
|
|
@@ -11248,22 +12713,95 @@ declare class OrderClient extends StorefrontAPIClient {
|
|
|
11248
12713
|
*
|
|
11249
12714
|
* @param orderNumber - Order number
|
|
11250
12715
|
* @returns Promise with order details
|
|
12716
|
+
* @example
|
|
12717
|
+
* ```typescript
|
|
12718
|
+
* const { data, error } = await sdk.order.getOrderDetails({
|
|
12719
|
+
* order_number: "ORD-2024-001"
|
|
12720
|
+
* });
|
|
12721
|
+
*
|
|
12722
|
+
* if (error) {
|
|
12723
|
+
* console.error("Failed to get order details:", error.message);
|
|
12724
|
+
* } else {
|
|
12725
|
+
* console.log("Order details:", data.content.order);
|
|
12726
|
+
* console.log("Order status:", data.content.order.status);
|
|
12727
|
+
* console.log("Total amount:", data.content.order.total_amount);
|
|
12728
|
+
* }
|
|
12729
|
+
* ```
|
|
11251
12730
|
*/
|
|
11252
12731
|
getOrderDetails(pathParams: GetOrderDetailPathParams): Promise<ApiResult<GetOrderDetailContent>>;
|
|
11253
12732
|
/**
|
|
11254
12733
|
* Create order
|
|
11255
12734
|
*
|
|
11256
|
-
* @param
|
|
11257
|
-
* @param paymentGateway - Payment gateway
|
|
11258
|
-
* @param paymentGatewayParams - Params for the selected payment gateway
|
|
12735
|
+
* @param body - Order creation request body
|
|
11259
12736
|
* @returns Promise with order details
|
|
12737
|
+
* @example
|
|
12738
|
+
* ```typescript
|
|
12739
|
+
* // Example with PayU payment gateway
|
|
12740
|
+
* const { data, error } = await sdk.order.createOrder({
|
|
12741
|
+
* cart_id: "cart_01H9XYZ12345ABCDE",
|
|
12742
|
+
* payment_gateway: "PAYU",
|
|
12743
|
+
* payment_gateway_params: {
|
|
12744
|
+
* payment_gateway: "PAYU",
|
|
12745
|
+
* furl: "https://yourapp.com/payment/failure",
|
|
12746
|
+
* surl: "https://yourapp.com/payment/success"
|
|
12747
|
+
* }
|
|
12748
|
+
* });
|
|
12749
|
+
*
|
|
12750
|
+
* // Example with Juspay payment gateway
|
|
12751
|
+
* const { data, error } = await sdk.order.createOrder({
|
|
12752
|
+
* cart_id: "cart_01H9XYZ12345ABCDE",
|
|
12753
|
+
* payment_gateway: "JUSPAY",
|
|
12754
|
+
* payment_gateway_params: {
|
|
12755
|
+
* payment_gateway: "JUSPAY",
|
|
12756
|
+
* action: "paymentPage",
|
|
12757
|
+
* integration_type: "hyper-checkout",
|
|
12758
|
+
* return_url: "https://yourapp.com/payment/return",
|
|
12759
|
+
* gateway_reference_id: "juspay_gateway_ref_123"
|
|
12760
|
+
* }
|
|
12761
|
+
* });
|
|
12762
|
+
*
|
|
12763
|
+
* if (error) {
|
|
12764
|
+
* console.error("Failed to create order:", error.message);
|
|
12765
|
+
* } else {
|
|
12766
|
+
* console.log("Order created:", data.content.order.id);
|
|
12767
|
+
* console.log("Payment required:", data.content.payment_required);
|
|
12768
|
+
* console.log("Payment info:", data.content.payment_info);
|
|
12769
|
+
* }
|
|
12770
|
+
* ```
|
|
11260
12771
|
*/
|
|
11261
12772
|
createOrder(body: CreateOrderBody): Promise<ApiResult<CreateOrderContent>>;
|
|
11262
12773
|
/**
|
|
11263
12774
|
* List all orders
|
|
11264
12775
|
*
|
|
11265
|
-
* @param queryParams - Query parameters
|
|
11266
|
-
* @returns Promise with order
|
|
12776
|
+
* @param queryParams - Query parameters for filtering and pagination
|
|
12777
|
+
* @returns Promise with order list
|
|
12778
|
+
* @example
|
|
12779
|
+
* ```typescript
|
|
12780
|
+
* // Basic usage - only required parameter
|
|
12781
|
+
* const { data, error } = await sdk.order.listOrders({
|
|
12782
|
+
* user_id: "user_01H9XYZ12345ABCDE"
|
|
12783
|
+
* });
|
|
12784
|
+
*
|
|
12785
|
+
* // Advanced usage with optional parameters
|
|
12786
|
+
* const { data, error } = await sdk.order.listOrders({
|
|
12787
|
+
* user_id: "user_01H9XYZ12345ABCDE",
|
|
12788
|
+
* page: 1,
|
|
12789
|
+
* limit: 20,
|
|
12790
|
+
* sort_by: '{"created_at":"desc"}',
|
|
12791
|
+
* status: ["confirmed", "shipped", "delivered"]
|
|
12792
|
+
* });
|
|
12793
|
+
*
|
|
12794
|
+
* if (error) {
|
|
12795
|
+
* console.error("Failed to list orders:", error.message);
|
|
12796
|
+
* } else {
|
|
12797
|
+
* console.log("Orders found:", data.content.orders?.length || 0);
|
|
12798
|
+
* console.log("Pagination:", data.content.pagination);
|
|
12799
|
+
*
|
|
12800
|
+
* data.content.orders?.forEach(order => {
|
|
12801
|
+
* console.log(`Order ${order.order_number}: ${order.status}`);
|
|
12802
|
+
* });
|
|
12803
|
+
* }
|
|
12804
|
+
* ```
|
|
11267
12805
|
*/
|
|
11268
12806
|
listOrders(queryParams: ListOrdersQuery): Promise<ApiResult<ListOrdersContent>>;
|
|
11269
12807
|
/**
|
|
@@ -11271,41 +12809,167 @@ declare class OrderClient extends StorefrontAPIClient {
|
|
|
11271
12809
|
*
|
|
11272
12810
|
* @param orderNumber - Order number
|
|
11273
12811
|
* @returns Promise with payment status
|
|
12812
|
+
* @example
|
|
12813
|
+
* ```typescript
|
|
12814
|
+
* const { data, error } = await sdk.order.getPaymentStatus("ORD-2024-001");
|
|
12815
|
+
*
|
|
12816
|
+
* if (error) {
|
|
12817
|
+
* console.error("Failed to get payment status:", error.message);
|
|
12818
|
+
* } else {
|
|
12819
|
+
* console.log("Payment status:", data.content.status);
|
|
12820
|
+
* console.log("Amount paid:", data.content.amount_paid);
|
|
12821
|
+
* console.log("Amount unpaid:", data.content.amount_unpaid);
|
|
12822
|
+
* console.log("Retry available:", data.content.is_retry_available);
|
|
12823
|
+
* }
|
|
12824
|
+
* ```
|
|
11274
12825
|
*/
|
|
11275
12826
|
getPaymentStatus(orderNumber: string): Promise<ApiResult<GetPaymentStatusContent>>;
|
|
11276
12827
|
/**
|
|
11277
12828
|
* Get all shipments for an order
|
|
11278
12829
|
*
|
|
11279
|
-
* @param
|
|
12830
|
+
* @param pathParams - Order number path parameters
|
|
11280
12831
|
* @returns Promise with shipments
|
|
12832
|
+
* @example
|
|
12833
|
+
* ```typescript
|
|
12834
|
+
* const { data, error } = await sdk.order.listOrderShipments({
|
|
12835
|
+
* order_number: "ORD-2024-001"
|
|
12836
|
+
* });
|
|
12837
|
+
*
|
|
12838
|
+
* if (error) {
|
|
12839
|
+
* console.error("Failed to get order shipments:", error.message);
|
|
12840
|
+
* } else {
|
|
12841
|
+
* console.log("Shipments found:", data.content.shipments?.length || 0);
|
|
12842
|
+
*
|
|
12843
|
+
* data.content.shipments?.forEach(shipment => {
|
|
12844
|
+
* console.log(`Shipment ${shipment.id}: ${shipment.status}`);
|
|
12845
|
+
* console.log("Tracking number:", shipment.tracking_number);
|
|
12846
|
+
* console.log("Carrier:", shipment.carrier);
|
|
12847
|
+
* });
|
|
12848
|
+
* }
|
|
12849
|
+
* ```
|
|
11281
12850
|
*/
|
|
11282
12851
|
listOrderShipments(pathParams: ListOrderShipmentsPathParams): Promise<ApiResult<ListOrderShipmentsContent>>;
|
|
11283
12852
|
/**
|
|
11284
12853
|
* List order payments
|
|
11285
12854
|
*
|
|
11286
|
-
* @param
|
|
12855
|
+
* @param pathParams - Order number path parameters
|
|
11287
12856
|
* @returns Promise with payments
|
|
12857
|
+
* @example
|
|
12858
|
+
* ```typescript
|
|
12859
|
+
* const { data, error } = await sdk.order.listOrderPayments({
|
|
12860
|
+
* order_number: "ORD-2024-001"
|
|
12861
|
+
* });
|
|
12862
|
+
*
|
|
12863
|
+
* if (error) {
|
|
12864
|
+
* console.error("Failed to get order payments:", error.message);
|
|
12865
|
+
* } else {
|
|
12866
|
+
* console.log("Payments found:", data.content.payments?.length || 0);
|
|
12867
|
+
*
|
|
12868
|
+
* data.content.payments?.forEach(payment => {
|
|
12869
|
+
* console.log(`Payment ${payment.id}: ${payment.status}`);
|
|
12870
|
+
* console.log("Amount:", payment.amount);
|
|
12871
|
+
* console.log("Gateway:", payment.payment_gateway);
|
|
12872
|
+
* console.log("Transaction ID:", payment.transaction_id);
|
|
12873
|
+
* });
|
|
12874
|
+
* }
|
|
12875
|
+
* ```
|
|
11288
12876
|
*/
|
|
11289
12877
|
listOrderPayments(pathParams: ListOrderPaymentsPathParams): Promise<ApiResult<ListOrderPaymentsContent>>;
|
|
11290
12878
|
/**
|
|
11291
12879
|
* List order refunds
|
|
11292
12880
|
*
|
|
11293
|
-
* @param
|
|
12881
|
+
* @param pathParams - Order number path parameters
|
|
11294
12882
|
* @returns Promise with refunds
|
|
12883
|
+
* @example
|
|
12884
|
+
* ```typescript
|
|
12885
|
+
* const { data, error } = await sdk.order.listOrderRefunds({
|
|
12886
|
+
* order_number: "ORD-2024-001"
|
|
12887
|
+
* });
|
|
12888
|
+
*
|
|
12889
|
+
* if (error) {
|
|
12890
|
+
* console.error("Failed to get order refunds:", error.message);
|
|
12891
|
+
* } else {
|
|
12892
|
+
* console.log("Refunds found:", data.content.refunds?.length || 0);
|
|
12893
|
+
*
|
|
12894
|
+
* data.content.refunds?.forEach(refund => {
|
|
12895
|
+
* console.log(`Refund ${refund.id}: ${refund.status}`);
|
|
12896
|
+
* console.log("Amount:", refund.amount);
|
|
12897
|
+
* console.log("Reason:", refund.reason);
|
|
12898
|
+
* console.log("Processed at:", refund.processed_at);
|
|
12899
|
+
* });
|
|
12900
|
+
* }
|
|
12901
|
+
* ```
|
|
11295
12902
|
*/
|
|
11296
12903
|
listOrderRefunds(pathParams: ListOrderRefundsPathParams): Promise<ApiResult<ListOrderRefundsContent>>;
|
|
11297
12904
|
/**
|
|
11298
12905
|
* Cancel an order
|
|
11299
12906
|
*
|
|
11300
|
-
* @param
|
|
12907
|
+
* @param pathParams - Order number path parameters
|
|
12908
|
+
* @param body - Cancellation request body
|
|
11301
12909
|
* @returns Promise with order details
|
|
12910
|
+
* @example
|
|
12911
|
+
* ```typescript
|
|
12912
|
+
* const { data, error } = await sdk.order.cancelOrder(
|
|
12913
|
+
* { order_number: "ORD-2024-001" },
|
|
12914
|
+
* {
|
|
12915
|
+
* cancellation_reason: "Customer requested cancellation",
|
|
12916
|
+
* refund_mode: "original_payment_mode",
|
|
12917
|
+
* feedback: "Customer changed their mind about the purchase"
|
|
12918
|
+
* }
|
|
12919
|
+
* );
|
|
12920
|
+
*
|
|
12921
|
+
* if (error) {
|
|
12922
|
+
* console.error("Failed to cancel order:", error.message);
|
|
12923
|
+
* } else {
|
|
12924
|
+
* console.log("Order cancelled successfully");
|
|
12925
|
+
* console.log("Updated order status:", data.content.order?.status);
|
|
12926
|
+
* console.log("Cancellation reason:", data.content.order?.cancellation_reason);
|
|
12927
|
+
* }
|
|
12928
|
+
* ```
|
|
11302
12929
|
*/
|
|
11303
12930
|
cancelOrder(pathParams: CancelOrderPathParams, body: CancelOrderBody): Promise<ApiResult<CancelOrderContent>>;
|
|
11304
12931
|
/**
|
|
11305
12932
|
* Retry payment for an order
|
|
11306
12933
|
*
|
|
11307
|
-
* @param
|
|
11308
|
-
* @
|
|
12934
|
+
* @param pathParams - Order number path parameters
|
|
12935
|
+
* @param body - Payment retry request body
|
|
12936
|
+
* @returns Promise with payment information
|
|
12937
|
+
* @example
|
|
12938
|
+
* ```typescript
|
|
12939
|
+
* // Example with PayU payment gateway
|
|
12940
|
+
* const { data, error } = await sdk.order.retryOrderPayment(
|
|
12941
|
+
* { order_number: "ORD-2024-001" },
|
|
12942
|
+
* {
|
|
12943
|
+
* payment_gateway_params: {
|
|
12944
|
+
* payment_gateway: "PAYU",
|
|
12945
|
+
* furl: "https://yourapp.com/payment/failure",
|
|
12946
|
+
* surl: "https://yourapp.com/payment/success"
|
|
12947
|
+
* }
|
|
12948
|
+
* }
|
|
12949
|
+
* );
|
|
12950
|
+
*
|
|
12951
|
+
* // Example with Juspay payment gateway
|
|
12952
|
+
* const { data, error } = await sdk.order.retryOrderPayment(
|
|
12953
|
+
* { order_number: "ORD-2024-001" },
|
|
12954
|
+
* {
|
|
12955
|
+
* payment_gateway_params: {
|
|
12956
|
+
* payment_gateway: "JUSPAY",
|
|
12957
|
+
* action: "paymentPage",
|
|
12958
|
+
* integration_type: "hyper-checkout",
|
|
12959
|
+
* return_url: "https://yourapp.com/payment/return",
|
|
12960
|
+
* gateway_reference_id: "juspay_gateway_ref_123"
|
|
12961
|
+
* }
|
|
12962
|
+
* }
|
|
12963
|
+
* );
|
|
12964
|
+
*
|
|
12965
|
+
* if (error) {
|
|
12966
|
+
* console.error("Failed to retry payment:", error.message);
|
|
12967
|
+
* } else {
|
|
12968
|
+
* console.log("Payment retry initiated");
|
|
12969
|
+
* console.log("Payment info:", data.content.payment_info);
|
|
12970
|
+
* console.log("Transaction ID:", data.content.payment_info.transaction_id);
|
|
12971
|
+
* }
|
|
12972
|
+
* ```
|
|
11309
12973
|
*/
|
|
11310
12974
|
retryOrderPayment(pathParams: RetryOrderPaymentPathParams, body: RetryOrderPaymentBody): Promise<ApiResult<RetryOrderPaymentContent>>;
|
|
11311
12975
|
}
|
|
@@ -11319,6 +12983,31 @@ declare class ShippingClient extends StorefrontAPIClient {
|
|
|
11319
12983
|
*
|
|
11320
12984
|
* @param body - Shipping methods body
|
|
11321
12985
|
* @returns Promise with shipping options
|
|
12986
|
+
* @example
|
|
12987
|
+
* ```typescript
|
|
12988
|
+
* const { data, error } = await sdk.shipping.getShippingMethods({
|
|
12989
|
+
* delivery_pincode: "400001",
|
|
12990
|
+
* cart_id: "cart_01H9XYZ12345ABCDE"
|
|
12991
|
+
* });
|
|
12992
|
+
*
|
|
12993
|
+
* if (error) {
|
|
12994
|
+
* console.error("Failed to get shipping methods:", error.message);
|
|
12995
|
+
* } else {
|
|
12996
|
+
* console.log("Is serviceable:", data.content.is_serviceable);
|
|
12997
|
+
* console.log("Available shipping methods:", data.content.shipping_methods?.length || 0);
|
|
12998
|
+
*
|
|
12999
|
+
* data.content.shipping_methods?.forEach(method => {
|
|
13000
|
+
* console.log(`Method: ${method.name} (${method.shipping_type})`);
|
|
13001
|
+
* console.log(`Shipping cost: ${method.shipping_amount}`);
|
|
13002
|
+
* console.log(`Estimated delivery: ${method.estimated_delivery_days} days`);
|
|
13003
|
+
*
|
|
13004
|
+
* method.courier_companies?.forEach(courier => {
|
|
13005
|
+
* console.log(` - ${courier.name}: ${courier.shipping_amount} (${courier.mode})`);
|
|
13006
|
+
* console.log(` Rating: ${courier.rating}/5, Recommended: ${courier.is_recommended}`);
|
|
13007
|
+
* });
|
|
13008
|
+
* });
|
|
13009
|
+
* }
|
|
13010
|
+
* ```
|
|
11322
13011
|
*/
|
|
11323
13012
|
getShippingMethods(body: GetShippingMethodsBody): Promise<ApiResult<GetShippingMethodsContent>>;
|
|
11324
13013
|
/**
|
|
@@ -11326,6 +13015,24 @@ declare class ShippingClient extends StorefrontAPIClient {
|
|
|
11326
13015
|
*
|
|
11327
13016
|
* @param pathParams - Path parameters
|
|
11328
13017
|
* @returns Promise with pincode deliverability result
|
|
13018
|
+
* @example
|
|
13019
|
+
* ```typescript
|
|
13020
|
+
* const { data, error } = await sdk.shipping.checkPincodeDeliverability({
|
|
13021
|
+
* pincode: "400001"
|
|
13022
|
+
* });
|
|
13023
|
+
*
|
|
13024
|
+
* if (error) {
|
|
13025
|
+
* console.error("Failed to check pincode serviceability:", error.message);
|
|
13026
|
+
* } else {
|
|
13027
|
+
* console.log("Pincode serviceable:", data.content.is_serviceable);
|
|
13028
|
+
*
|
|
13029
|
+
* if (data.content.is_serviceable) {
|
|
13030
|
+
* console.log("Delivery is available to this pincode");
|
|
13031
|
+
* } else {
|
|
13032
|
+
* console.log("Delivery is not available to this pincode");
|
|
13033
|
+
* }
|
|
13034
|
+
* }
|
|
13035
|
+
* ```
|
|
11329
13036
|
*/
|
|
11330
13037
|
checkPincodeDeliverability(pathParams: CheckPincodeServiceabilityPathParams): Promise<ApiResult<CheckPincodeServiceabilityContent>>;
|
|
11331
13038
|
}
|
|
@@ -11338,13 +13045,62 @@ declare class HelpersClient extends StorefrontAPIClient {
|
|
|
11338
13045
|
* Get a list of countries
|
|
11339
13046
|
*
|
|
11340
13047
|
* @returns Promise with countries
|
|
13048
|
+
*
|
|
13049
|
+
* @example
|
|
13050
|
+
* ```typescript
|
|
13051
|
+
* const { data, error } = await sdk.helpers.listCountries();
|
|
13052
|
+
*
|
|
13053
|
+
* if (error) {
|
|
13054
|
+
* console.error("Failed to get countries:", error);
|
|
13055
|
+
* return;
|
|
13056
|
+
* }
|
|
13057
|
+
*
|
|
13058
|
+
* console.log("Countries found:", data.countries?.length || 0);
|
|
13059
|
+
*
|
|
13060
|
+
* data.countries?.forEach(country => {
|
|
13061
|
+
* console.log(`Country: ${country.name} (${country.iso_code})`);
|
|
13062
|
+
* console.log("Phone code:", country.phone_code);
|
|
13063
|
+
* console.log("Currency:", country.currency?.code);
|
|
13064
|
+
* });
|
|
13065
|
+
* ```
|
|
11341
13066
|
*/
|
|
11342
13067
|
listCountries(): Promise<ApiResult<ListCountriesContent>>;
|
|
11343
13068
|
/**
|
|
11344
|
-
*
|
|
13069
|
+
* Get a list of states for a country
|
|
11345
13070
|
*
|
|
11346
13071
|
* @param pathParams - Path parameters
|
|
11347
13072
|
* @returns Promise with states
|
|
13073
|
+
*
|
|
13074
|
+
* @example
|
|
13075
|
+
* ```typescript
|
|
13076
|
+
* const { data, error } = await sdk.helpers.listCountryStates({
|
|
13077
|
+
* country_iso_code: "IN"
|
|
13078
|
+
* });
|
|
13079
|
+
*
|
|
13080
|
+
* if (error) {
|
|
13081
|
+
* console.error("Failed to get states:", error);
|
|
13082
|
+
* return;
|
|
13083
|
+
* }
|
|
13084
|
+
*
|
|
13085
|
+
* console.log("States found:", data.states?.length || 0);
|
|
13086
|
+
*
|
|
13087
|
+
* data.states?.forEach(state => {
|
|
13088
|
+
* console.log(`State: ${state.name} (${state.iso_code})`);
|
|
13089
|
+
* console.log("Type:", state.type);
|
|
13090
|
+
* });
|
|
13091
|
+
*
|
|
13092
|
+
* // Get states for different country
|
|
13093
|
+
* const { data: usStates, error: usError } = await sdk.helpers.listCountryStates({
|
|
13094
|
+
* country_iso_code: "US"
|
|
13095
|
+
* });
|
|
13096
|
+
*
|
|
13097
|
+
* if (usError) {
|
|
13098
|
+
* console.error("Failed to get US states:", usError);
|
|
13099
|
+
* return;
|
|
13100
|
+
* }
|
|
13101
|
+
*
|
|
13102
|
+
* console.log("US States:", usStates.states?.map(s => s.name).join(", "));
|
|
13103
|
+
* ```
|
|
11348
13104
|
*/
|
|
11349
13105
|
listCountryStates(pathParams: ListCountryStatesPathParams): Promise<ApiResult<ListCountryStatesContent>>;
|
|
11350
13106
|
/**
|
|
@@ -11352,6 +13108,38 @@ declare class HelpersClient extends StorefrontAPIClient {
|
|
|
11352
13108
|
*
|
|
11353
13109
|
* @param pathParams - Path parameters
|
|
11354
13110
|
* @returns Promise with pincodes
|
|
13111
|
+
*
|
|
13112
|
+
* @example
|
|
13113
|
+
* ```typescript
|
|
13114
|
+
* const { data, error } = await sdk.helpers.listCountryPincodes({
|
|
13115
|
+
* country_iso_code: "IN"
|
|
13116
|
+
* });
|
|
13117
|
+
*
|
|
13118
|
+
* if (error) {
|
|
13119
|
+
* console.error("Failed to get pincodes:", error);
|
|
13120
|
+
* return;
|
|
13121
|
+
* }
|
|
13122
|
+
*
|
|
13123
|
+
* console.log("Pincodes found:", data.pincodes?.length || 0);
|
|
13124
|
+
*
|
|
13125
|
+
* data.pincodes?.forEach(pincode => {
|
|
13126
|
+
* console.log(`Pincode: ${pincode.pincode} - ${pincode.city}, ${pincode.state}`);
|
|
13127
|
+
* console.log("District:", pincode.district);
|
|
13128
|
+
* console.log("Area:", pincode.area);
|
|
13129
|
+
* });
|
|
13130
|
+
*
|
|
13131
|
+
* // Get pincodes for different country
|
|
13132
|
+
* const { data: usPincodes, error: usError } = await sdk.helpers.listCountryPincodes({
|
|
13133
|
+
* country_iso_code: "US"
|
|
13134
|
+
* });
|
|
13135
|
+
*
|
|
13136
|
+
* if (usError) {
|
|
13137
|
+
* console.error("Failed to get US pincodes:", usError);
|
|
13138
|
+
* return;
|
|
13139
|
+
* }
|
|
13140
|
+
*
|
|
13141
|
+
* console.log("US Pincodes:", usPincodes.pincodes?.map(p => p.pincode).join(", "));
|
|
13142
|
+
* ```
|
|
11355
13143
|
*/
|
|
11356
13144
|
listCountryPincodes(pathParams: ListCountryPincodesPathParams): Promise<ApiResult<ListCountryPincodesContent>>;
|
|
11357
13145
|
}
|
|
@@ -11365,6 +13153,24 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11365
13153
|
*
|
|
11366
13154
|
* @param body - Customer creation body
|
|
11367
13155
|
* @returns Promise with customer details
|
|
13156
|
+
*
|
|
13157
|
+
* @example
|
|
13158
|
+
* ```typescript
|
|
13159
|
+
* const { data, error } = await sdk.customer.createCustomer({
|
|
13160
|
+
* first_name: "John",
|
|
13161
|
+
* last_name: "Doe",
|
|
13162
|
+
* email: "john.doe@example.com",
|
|
13163
|
+
* phone: "+1234567890",
|
|
13164
|
+
* password: "securePassword123"
|
|
13165
|
+
* });
|
|
13166
|
+
*
|
|
13167
|
+
* if (error) {
|
|
13168
|
+
* console.error("Failed to create customer:", error);
|
|
13169
|
+
* return;
|
|
13170
|
+
* }
|
|
13171
|
+
*
|
|
13172
|
+
* console.log("Customer created:", data.customer_detail);
|
|
13173
|
+
* ```
|
|
11368
13174
|
*/
|
|
11369
13175
|
createCustomer(body: CreateCustomerBody): Promise<ApiResult<CreateCustomerContent>>;
|
|
11370
13176
|
/**
|
|
@@ -11372,6 +13178,20 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11372
13178
|
*
|
|
11373
13179
|
* @param pathParams - Path parameters
|
|
11374
13180
|
* @returns Promise with customer details
|
|
13181
|
+
*
|
|
13182
|
+
* @example
|
|
13183
|
+
* ```typescript
|
|
13184
|
+
* const { data, error } = await sdk.customer.getCustomer({
|
|
13185
|
+
* id: "customer_123"
|
|
13186
|
+
* });
|
|
13187
|
+
*
|
|
13188
|
+
* if (error) {
|
|
13189
|
+
* console.error("Failed to get customer:", error);
|
|
13190
|
+
* return;
|
|
13191
|
+
* }
|
|
13192
|
+
*
|
|
13193
|
+
* console.log("Customer details:", data.customer_detail);
|
|
13194
|
+
* ```
|
|
11375
13195
|
*/
|
|
11376
13196
|
getCustomer(pathParams: GetCustomerDetailPathParams): Promise<ApiResult<GetCustomerDetailContent>>;
|
|
11377
13197
|
/**
|
|
@@ -11380,6 +13200,25 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11380
13200
|
* @param pathParams - Path parameters
|
|
11381
13201
|
* @param body - Customer update body
|
|
11382
13202
|
* @returns Promise with customer details
|
|
13203
|
+
*
|
|
13204
|
+
* @example
|
|
13205
|
+
* ```typescript
|
|
13206
|
+
* const { data, error } = await sdk.customer.updateCustomer(
|
|
13207
|
+
* { id: "customer_123" },
|
|
13208
|
+
* {
|
|
13209
|
+
* first_name: "John",
|
|
13210
|
+
* last_name: "Smith",
|
|
13211
|
+
* email: "john.smith@example.com"
|
|
13212
|
+
* }
|
|
13213
|
+
* );
|
|
13214
|
+
*
|
|
13215
|
+
* if (error) {
|
|
13216
|
+
* console.error("Failed to update customer:", error);
|
|
13217
|
+
* return;
|
|
13218
|
+
* }
|
|
13219
|
+
*
|
|
13220
|
+
* console.log("Customer updated:", data.customer_detail);
|
|
13221
|
+
* ```
|
|
11383
13222
|
*/
|
|
11384
13223
|
updateCustomer(pathParams: UpdateCustomerPathParams, body: UpdateCustomerBody): Promise<ApiResult<UpdateCustomerContent>>;
|
|
11385
13224
|
/**
|
|
@@ -11387,6 +13226,28 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11387
13226
|
*
|
|
11388
13227
|
* @param pathParams - Path parameters
|
|
11389
13228
|
* @returns Promise with addresses
|
|
13229
|
+
*
|
|
13230
|
+
* @example
|
|
13231
|
+
* ```typescript
|
|
13232
|
+
* const { data, error } = await sdk.customer.listAddresses({
|
|
13233
|
+
* user_id: "user_456"
|
|
13234
|
+
* });
|
|
13235
|
+
*
|
|
13236
|
+
* if (error) {
|
|
13237
|
+
* console.error("Failed to list addresses:", error);
|
|
13238
|
+
* return;
|
|
13239
|
+
* }
|
|
13240
|
+
*
|
|
13241
|
+
* console.log("Addresses:", data.addresses);
|
|
13242
|
+
* console.log("Pagination:", data.pagination);
|
|
13243
|
+
*
|
|
13244
|
+
* // With pagination
|
|
13245
|
+
* const { data: page2, error: page2Error } = await sdk.customer.listAddresses({
|
|
13246
|
+
* user_id: "user_456",
|
|
13247
|
+
* page: 2,
|
|
13248
|
+
* limit: 10
|
|
13249
|
+
* });
|
|
13250
|
+
* ```
|
|
11390
13251
|
*/
|
|
11391
13252
|
listAddresses(pathParams: ListAddressesPathParams): Promise<ApiResult<ListAddressesContent>>;
|
|
11392
13253
|
/**
|
|
@@ -11395,6 +13256,30 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11395
13256
|
* @param pathParams - Path parameters
|
|
11396
13257
|
* @param body - Address creation body
|
|
11397
13258
|
* @returns Promise with address details
|
|
13259
|
+
*
|
|
13260
|
+
* @example
|
|
13261
|
+
* ```typescript
|
|
13262
|
+
* const { data, error } = await sdk.customer.createAddress(
|
|
13263
|
+
* { user_id: "user_456" },
|
|
13264
|
+
* {
|
|
13265
|
+
* address_line1: "123 Main Street",
|
|
13266
|
+
* address_line2: "Apt 4B",
|
|
13267
|
+
* city: "New York",
|
|
13268
|
+
* state: "NY",
|
|
13269
|
+
* country: "US",
|
|
13270
|
+
* pincode: "10001",
|
|
13271
|
+
* is_default_billing: true,
|
|
13272
|
+
* is_default_shipping: false
|
|
13273
|
+
* }
|
|
13274
|
+
* );
|
|
13275
|
+
*
|
|
13276
|
+
* if (error) {
|
|
13277
|
+
* console.error("Failed to create address:", error);
|
|
13278
|
+
* return;
|
|
13279
|
+
* }
|
|
13280
|
+
*
|
|
13281
|
+
* console.log("Address created:", data.address);
|
|
13282
|
+
* ```
|
|
11398
13283
|
*/
|
|
11399
13284
|
createAddress(pathParams: CreateAddressPathParams, body: CreateAddressBody): Promise<ApiResult<CreateAddressContent>>;
|
|
11400
13285
|
/**
|
|
@@ -11402,6 +13287,21 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11402
13287
|
*
|
|
11403
13288
|
* @param pathParams - Path parameters
|
|
11404
13289
|
* @returns Promise with address details
|
|
13290
|
+
*
|
|
13291
|
+
* @example
|
|
13292
|
+
* ```typescript
|
|
13293
|
+
* const { data, error } = await sdk.customer.getAddress({
|
|
13294
|
+
* user_id: "user_456",
|
|
13295
|
+
* address_id: "addr_789"
|
|
13296
|
+
* });
|
|
13297
|
+
*
|
|
13298
|
+
* if (error) {
|
|
13299
|
+
* console.error("Failed to get address:", error);
|
|
13300
|
+
* return;
|
|
13301
|
+
* }
|
|
13302
|
+
*
|
|
13303
|
+
* console.log("Address details:", data.address);
|
|
13304
|
+
* ```
|
|
11405
13305
|
*/
|
|
11406
13306
|
getAddress(pathParams: GetAddressDetailPathParams): Promise<ApiResult<GetAddressDetailContent>>;
|
|
11407
13307
|
/**
|
|
@@ -11410,13 +13310,51 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11410
13310
|
* @param pathParams - Path parameters
|
|
11411
13311
|
* @param body - Address update body
|
|
11412
13312
|
* @returns Promise with address details
|
|
13313
|
+
*
|
|
13314
|
+
* @example
|
|
13315
|
+
* ```typescript
|
|
13316
|
+
* const { data, error } = await sdk.customer.updateAddress(
|
|
13317
|
+
* {
|
|
13318
|
+
* user_id: "user_456",
|
|
13319
|
+
* address_id: "addr_789"
|
|
13320
|
+
* },
|
|
13321
|
+
* {
|
|
13322
|
+
* address_line1: "456 Oak Avenue",
|
|
13323
|
+
* city: "Los Angeles",
|
|
13324
|
+
* state: "CA",
|
|
13325
|
+
* pincode: "90210"
|
|
13326
|
+
* }
|
|
13327
|
+
* );
|
|
13328
|
+
*
|
|
13329
|
+
* if (error) {
|
|
13330
|
+
* console.error("Failed to update address:", error);
|
|
13331
|
+
* return;
|
|
13332
|
+
* }
|
|
13333
|
+
*
|
|
13334
|
+
* console.log("Address updated:", data.address);
|
|
13335
|
+
* ```
|
|
11413
13336
|
*/
|
|
11414
13337
|
updateAddress(pathParams: UpdateAddressDetailPathParams, body: UpdateAddressDetailBody): Promise<ApiResult<UpdateAddressDetailContent>>;
|
|
11415
13338
|
/**
|
|
11416
13339
|
* Delete an address for a customer
|
|
11417
13340
|
*
|
|
11418
13341
|
* @param pathParams - Path parameters
|
|
11419
|
-
* @returns Promise with
|
|
13342
|
+
* @returns Promise with deletion response
|
|
13343
|
+
*
|
|
13344
|
+
* @example
|
|
13345
|
+
* ```typescript
|
|
13346
|
+
* const { data, error } = await sdk.customer.deleteAddress({
|
|
13347
|
+
* user_id: "user_456",
|
|
13348
|
+
* address_id: "addr_789"
|
|
13349
|
+
* });
|
|
13350
|
+
*
|
|
13351
|
+
* if (error) {
|
|
13352
|
+
* console.error("Failed to delete address:", error);
|
|
13353
|
+
* return;
|
|
13354
|
+
* }
|
|
13355
|
+
*
|
|
13356
|
+
* console.log("Address deleted:", data.message);
|
|
13357
|
+
* ```
|
|
11420
13358
|
*/
|
|
11421
13359
|
deleteAddress(pathParams: DeleteAddressPathParams): Promise<ApiResult<DeleteAddressResponse>>;
|
|
11422
13360
|
/**
|
|
@@ -11424,6 +13362,21 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11424
13362
|
*
|
|
11425
13363
|
* @param pathParams - Path parameters
|
|
11426
13364
|
* @returns Promise with loyalty details
|
|
13365
|
+
*
|
|
13366
|
+
* @example
|
|
13367
|
+
* ```typescript
|
|
13368
|
+
* const { data, error } = await sdk.customer.getLoyaltyDetails({
|
|
13369
|
+
* user_id: "user_456"
|
|
13370
|
+
* });
|
|
13371
|
+
*
|
|
13372
|
+
* if (error) {
|
|
13373
|
+
* console.error("Failed to get loyalty details:", error);
|
|
13374
|
+
* return;
|
|
13375
|
+
* }
|
|
13376
|
+
*
|
|
13377
|
+
* console.log("Loyalty info:", data.loyalty);
|
|
13378
|
+
* console.log("Points balance:", data.loyalty_point_balance);
|
|
13379
|
+
* ```
|
|
11427
13380
|
*/
|
|
11428
13381
|
getLoyaltyDetails(pathParams: GetLoyaltyDetailsPathParams): Promise<ApiResult<GetLoyaltyDetailsContent>>;
|
|
11429
13382
|
/**
|
|
@@ -11431,6 +13384,28 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11431
13384
|
*
|
|
11432
13385
|
* @param pathParams - Path parameters
|
|
11433
13386
|
* @returns Promise with loyalty points activity
|
|
13387
|
+
*
|
|
13388
|
+
* @example
|
|
13389
|
+
* ```typescript
|
|
13390
|
+
* const { data, error } = await sdk.customer.listLoyaltyPointsActivity({
|
|
13391
|
+
* user_id: "user_456"
|
|
13392
|
+
* });
|
|
13393
|
+
*
|
|
13394
|
+
* if (error) {
|
|
13395
|
+
* console.error("Failed to get loyalty activity:", error);
|
|
13396
|
+
* return;
|
|
13397
|
+
* }
|
|
13398
|
+
*
|
|
13399
|
+
* console.log("Loyalty activity:", data.loyalty_points_activity);
|
|
13400
|
+
*
|
|
13401
|
+
* // With pagination and sorting
|
|
13402
|
+
* const { data: sortedData, error: sortedError } = await sdk.customer.listLoyaltyPointsActivity({
|
|
13403
|
+
* user_id: "user_456",
|
|
13404
|
+
* page: 1,
|
|
13405
|
+
* limit: 20,
|
|
13406
|
+
* sort_by: JSON.stringify({ "created_at": "desc" })
|
|
13407
|
+
* });
|
|
13408
|
+
* ```
|
|
11434
13409
|
*/
|
|
11435
13410
|
listLoyaltyPointsActivity(pathParams: ListLoyaltyActivitiesPathParams): Promise<ApiResult<ListLoyaltyActivitiesContent>>;
|
|
11436
13411
|
/**
|
|
@@ -11438,6 +13413,21 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11438
13413
|
*
|
|
11439
13414
|
* @param pathParams - Path parameters
|
|
11440
13415
|
* @returns Promise with reviews
|
|
13416
|
+
*
|
|
13417
|
+
* @example
|
|
13418
|
+
* ```typescript
|
|
13419
|
+
* const { data, error } = await sdk.customer.listCustomerReviews({
|
|
13420
|
+
* user_id: "user_456"
|
|
13421
|
+
* });
|
|
13422
|
+
*
|
|
13423
|
+
* if (error) {
|
|
13424
|
+
* console.error("Failed to get customer reviews:", error);
|
|
13425
|
+
* return;
|
|
13426
|
+
* }
|
|
13427
|
+
*
|
|
13428
|
+
* console.log("Customer reviews:", data.reviews);
|
|
13429
|
+
* console.log("Ready for review:", data.ready_for_review);
|
|
13430
|
+
* ```
|
|
11441
13431
|
*/
|
|
11442
13432
|
listCustomerReviews(pathParams: ListUserReviewsPathParams): Promise<ApiResult<ListUserReviewsContent>>;
|
|
11443
13433
|
}
|
|
@@ -11448,6 +13438,25 @@ declare class CustomerClient extends StorefrontAPIClient {
|
|
|
11448
13438
|
declare class StoreConfigClient extends StorefrontAPIClient {
|
|
11449
13439
|
/**
|
|
11450
13440
|
* Get store config
|
|
13441
|
+
*
|
|
13442
|
+
* @returns Promise with store configuration data
|
|
13443
|
+
*
|
|
13444
|
+
* @example
|
|
13445
|
+
* ```typescript
|
|
13446
|
+
* const { data, error } = await sdk.storeConfig.getStoreConfig();
|
|
13447
|
+
*
|
|
13448
|
+
* if (error) {
|
|
13449
|
+
* console.error('Failed to get store config:', error.message);
|
|
13450
|
+
* return;
|
|
13451
|
+
* }
|
|
13452
|
+
*
|
|
13453
|
+
* // Access store configuration data
|
|
13454
|
+
* const storeConfig = data.store_config;
|
|
13455
|
+
* console.log('Store brand:', storeConfig.brand.name);
|
|
13456
|
+
* console.log('Currency:', storeConfig.currency.code);
|
|
13457
|
+
* console.log('KYC enabled:', storeConfig.is_kyc_enabled);
|
|
13458
|
+
* console.log('Customer groups enabled:', storeConfig.is_customer_group_enabled);
|
|
13459
|
+
* ```
|
|
11451
13460
|
*/
|
|
11452
13461
|
getStoreConfig(): Promise<ApiResult<GetConfigContent>>;
|
|
11453
13462
|
}
|
|
@@ -11810,4 +13819,4 @@ declare class StorefrontSDK {
|
|
|
11810
13819
|
getDefaultHeaders(): SupportedDefaultHeaders | undefined;
|
|
11811
13820
|
}
|
|
11812
13821
|
|
|
11813
|
-
export { type AcceleratedRewardCouponPromotion, type AcceleratedRewardRule, type AddCardBody, type AddCardContent, type AddCardResponse, type AddProfileImageContent, type AddProfileImageFormData, type AddProfileImagePathParams, type AddProfileImageResponse, type AddToWishlistBody, type AddToWishlistContent, type AddToWishlistPathParams, type AddToWishlistResponse, type AdditionalProductDetails, type AnalyticsEvent, type AnonymousUser, type ApiErrorResponse, type ApiResult, type AppliedCoupon, type AppliedPromotion, type ApplyCouponBody, type ApplyCouponContent, type ApplyCouponPathParams, type ApplyCouponResponse, type AssociatedOption, AuthClient, type AutoScaleBasedOnAmount, type AutoScaleBasedOnQuantity, type BankTransfer, type BooleanAttribute, type Brand, BrowserTokenStorage, type Business, type BuyXGetYCouponPromotion, type BuyXGetYRule, type BuyXGetYRuleBasedOnAmount, type BuyXGetYRuleBasedOnQuantity, type CancelOrderBody, type CancelOrderContent, type CancelOrderPathParams, type CancelOrderResponse, type CardPayment, type Cart, type CartBasedServiceabilityCheck, CartClient, type CartItem, CatalogClient, type Category, type ChangePasswordBody, type ChangePasswordContent, type ChangePasswordResponse, type CheckPincodeServiceabilityContent, type CheckPincodeServiceabilityPathParams, type CheckPincodeServiceabilityResponse, type CheckVerificationStatusBody, type CheckVerificationStatusContent, type CheckVerificationStatusResponse, type ColorAttribute, type ColorOption, CookieTokenStorage, type CookieTokenStorageOptions, type Country, type CountryState, type Coupon, type CouponPromotionCommonDetail, type CreateAddressBody, type CreateAddressContent, type CreateAddressPathParams, type CreateAddressResponse, type CreateCartAddressBody, type CreateCartAddressContent, type CreateCartAddressPathParams, type CreateCartAddressResponse, type CreateCartBody, type CreateCartContent, type CreateCartResponse, type CreateCustomSubscription, type CreateCustomer, type CreateCustomerBody, type CreateCustomerContent, type CreateCustomerResponse, type CreateDocumentContent, type CreateDocumentFormData, type CreateDocumentPathParams, type CreateDocumentResponse, type CreateJuspayCustomerBody, type CreateJuspayCustomerContent, type CreateJuspayCustomerResponse, type CreateJuspayOrderBody, type CreateJuspayOrderContent, type CreateJuspayOrderResponse, type CreateNotificationPreferencesBody, type CreateNotificationPreferencesContent, type CreateNotificationPreferencesPathParams, type CreateNotificationPreferencesResponse, type CreateOrderBody, type CreateOrderContent, type CreateOrderResponse, type CreateOrderReturn, type CreateOrderReturnBody, type CreateOrderReturnContent, type CreateOrderReturnPathParams, type CreateOrderReturnResponse, type CreatePosCartBody, type CreatePosCartContent, type CreatePosCartResponse, type CreateProductReviewFormData, type CreateProductReviewPathParams, type CreateProductReviewResponse, type CreateReview, type CreateStandardSubscription, type CreateSubscription, type CreateSubscriptionBody, type CreateSubscriptionContent, type CreateSubscriptionResponse, type Currency, type CustomSlabsBasedOnAmount, type CustomSlabsBasedOnQuantity, type CustomerAddress, CustomerClient, type CustomerDetail, type CustomerGroup, type CustomerLoyalty, type CustomerReadyForReview, type CustomerReview, type DateAttribute, type DeactivateUserPathParams, type DeactivateUserResponse, type DebugLoggerFn, type DeleteAddressPathParams, type DeleteAddressResponse, type DeleteCartPathParams, type DeleteCartResponse, type DeleteDocumentPathParams, type DeleteDocumentResponse, type DeleteFromWishlistBody, type DeleteFromWishlistContent, type DeleteFromWishlistPathParams, type DeleteFromWishlistResponse, type DeleteUserCartPathParams, type DeleteUserCartResponse, type DiscountBasedPromotion, type DiscountCouponPromotion, type DiscountRule, type Document, Environment, type EvaluateCouponsContent, type EvaluateCouponsPathParams, type EvaluateCouponsResponse, type EvaluatePosCouponsContent, type EvaluatePosCouponsPathParams, type EvaluatePosCouponsResponse, type EvaluatePosPromotionsContent, type EvaluatePosPromotionsPathParams, type EvaluatePosPromotionsResponse, type EvaluatePromotionsContent, type EvaluatePromotionsPathParams, type EvaluatePromotionsResponse, type FixedAmountDiscountRule, type FixedPriceCouponPromotion, type FixedPricePromotion, type FixedPriceRule, type FixedPriceRuleBasedAmount, type FixedPriceRuleBasedQuantity, type ForgotPasswordBody, type ForgotPasswordContent, type ForgotPasswordResponse, type FreeGoodCouponPromotion, type FreeGoodsPromotion, type FreeGoodsRule, type FreeShipingCouponPromotion, type GenerateHashBody, type GenerateHashContent, type GenerateHashResponse, type GenerateOtpBody, type GenerateOtpContent, type GenerateOtpResponse, type GenerateOtpWithEmail, type GenerateOtpWithPhone, type GetAddressDetailContent, type GetAddressDetailPathParams, type GetAddressDetailResponse, type GetAnonymousTokenContent, type GetAnonymousTokenResponse, type GetCartContent, type GetCartPathParams, type GetCartResponse, type GetConfigContent, type GetConfigResponse, type GetCustomerDetailContent, type GetCustomerDetailPathParams, type GetCustomerDetailResponse, type GetDocumentContent, type GetDocumentPathParams, type GetDocumentResponse, type GetJuspayCustomerContent, type GetJuspayCustomerPathParams, type GetJuspayCustomerResponse, type GetLoyaltyDetailsContent, type GetLoyaltyDetailsPathParams, type GetLoyaltyDetailsResponse, type GetNotificationPreferencesContent, type GetNotificationPreferencesPathParams, type GetNotificationPreferencesResponse, type GetOrderDetailContent, type GetOrderDetailPathParams, type GetOrderDetailResponse, type GetOrderReturnDetailContent, type GetOrderReturnDetailPathParams, type GetOrderReturnDetailResponse, type GetPaymentStatusContent, type GetPaymentStatusPathParams, type GetPaymentStatusResponse, type GetPosCartContent, type GetPosCartPathParams, type GetPosCartResponse, type GetProductDetailContent, type GetProductDetailHeaderParams, type GetProductDetailPathParams, type GetProductDetailResponse, type GetProfileImageContent, type GetProfileImagePathParams, type GetProfileImageResponse, type GetShippingMethodsBody, type GetShippingMethodsContent, type GetShippingMethodsResponse, type GetSubscriptionContent, type GetSubscriptionPathParams, type GetSubscriptionResponse, type GetUserCartContent, type GetUserCartPathParams, type GetUserCartResponse, type GetUserDetailContent, type GetUserDetailPathParams, type GetUserDetailResponse, type GetVariantDetailContent, type GetVariantDetailHeaderParams, type GetVariantDetailPathParams, type GetVariantDetailResponse, type GetWishlistContent, type GetWishlistPathParams, type GetWishlistResponse, type GstinDetail, HelpersClient, type Item, type JuspayCardPayload, type JuspayCreateCardResponse, type JuspayCreateCustomerPayload, type JuspayCreateOrderPayload, type JuspayCustomer, type JuspayOrder, type JuspayPaymentGatewayParams, type JuspayPaymentInfo, type JuspayPaymentMethod, type JuspaySavedCard, type KycDocument, type KycDocumentConfig, type ListAddressesContent, type ListAddressesPathParams, type ListAddressesQuery, type ListAddressesResponse, type ListCategoriesContent, type ListCategoriesQuery, type ListCategoriesResponse, type ListCountriesContent, type ListCountriesResponse, type ListCountryPincodesContent, type ListCountryPincodesPathParams, type ListCountryPincodesQuery, type ListCountryPincodesResponse, type ListCountryStatesContent, type ListCountryStatesPathParams, type ListCountryStatesResponse, type ListCouponsContent, type ListCouponsHeaderParams, type ListCouponsResponse, type ListCrosssellProductsContent, type ListCrosssellProductsHeaderParams, type ListCrosssellProductsQuery, type ListCrosssellProductsResponse, type ListDocumentsContent, type ListDocumentsPathParams, type ListDocumentsResponse, type ListKycDocumentContent, type ListKycDocumentResponse, type ListLoyaltyActivitiesContent, type ListLoyaltyActivitiesPathParams, type ListLoyaltyActivitiesQuery, type ListLoyaltyActivitiesResponse, type ListOrderPaymentsContent, type ListOrderPaymentsPathParams, type ListOrderPaymentsResponse, type ListOrderRefundsContent, type ListOrderRefundsPathParams, type ListOrderRefundsResponse, type ListOrderShipmentsContent, type ListOrderShipmentsPathParams, type ListOrderShipmentsResponse, type ListOrdersContent, type ListOrdersQuery, type ListOrdersResponse, type ListPaymentMethodsContent, type ListPaymentMethodsQuery, type ListPaymentMethodsResponse, type ListProductReviewsContent, type ListProductReviewsPathParams, type ListProductReviewsQuery, type ListProductReviewsResponse, type ListProductVariantsContent, type ListProductVariantsHeaderParams, type ListProductVariantsPathParams, type ListProductVariantsResponse, type ListProductsContent, type ListProductsHeaderParams, type ListProductsQuery, type ListProductsResponse, type ListPromotionsContent, type ListPromotionsHeaderParams, type ListPromotionsResponse, type ListReturnsContent, type ListReturnsResponse, type ListSavedCardsContent, type ListSavedCardsQuery, type ListSavedCardsResponse, type ListSimilarProductsContent, type ListSimilarProductsHeaderParams, type ListSimilarProductsQuery, type ListSimilarProductsResponse, type ListSkusContent, type ListSkusHeaderParams, type ListSkusQuery, type ListSkusResponse, type ListSubscriptionsContent, type ListSubscriptionsResponse, type ListUpsellProductsContent, type ListUpsellProductsHeaderParams, type ListUpsellProductsQuery, type ListUpsellProductsResponse, type ListUserReviewsContent, type ListUserReviewsPathParams, type ListUserReviewsResponse, type LoginPosDeviceWithEmailBody, type LoginPosDeviceWithEmailContent, type LoginPosDeviceWithEmailResponse, type LoginPosDeviceWithPhoneBody, type LoginPosDeviceWithPhoneContent, type LoginPosDeviceWithPhoneResponse, type LoginPosDeviceWithWhatsappBody, type LoginPosDeviceWithWhatsappContent, type LoginPosDeviceWithWhatsappResponse, type LoginWithEmailBody, type LoginWithEmailContent, type LoginWithEmailResponse, type LoginWithPasswordBody, type LoginWithPasswordContent, type LoginWithPasswordResponse, type LoginWithPhoneBody, type LoginWithPhoneContent, type LoginWithPhoneResponse, type LoginWithWhatsappBody, type LoginWithWhatsappContent, type LoginWithWhatsappResponse, type LogoutContent, type LogoutResponse, type LoyaltyPointActivity, type MeasurementUnit, MemoryTokenStorage, type MultiSelectAttribute, type NetbankingPayment, type NotificationChannelPreferences, type NotificationPreferences, type NumberAttribute, type Order, OrderClient, type OrderDetail, type OrderItem, type OrderList, type OrderPayment, type OrderRefund, type OrderReturn, type OrderReturnItem, type OrderShipment, type Pagination, type PairPosDeviceBody, type PairPosDeviceContent, type PairPosDeviceResponse, type PanDetail, type PauseSubscription, type PaymentInfo, type PayuCardPayload, type PayuCreateCardResponse, type PayuPaymentGatewayParams, type PayuPaymentInfo, type PayuPaymentMethod, type PayuSavedCard, type PercentageDiscountRule, type Pincode, type PincodeServiceability, type PosDevice, type PosUpdateCustomerWithEmail, type PosUpdateCustomerWithId, type PosUpdateCustomerWithPhone, type PosUser, type Product, type ProductAttribute, type ProductBundleItem, type ProductCategory, type ProductDetail, type ProductImage, type ProductPricing, type ProductPromotion, type ProductReview, type ProductShipping, type ProductSubscription, type ProductVideo, type Promotion, type RedeemCreditBalanceBody, type RedeemCreditBalanceContent, type RedeemCreditBalancePathParams, type RedeemCreditBalanceResponse, type RedeemGiftCardBody, type RedeemGiftCardContent, type RedeemGiftCardPathParams, type RedeemGiftCardResponse, type RedeemLoyaltyPointsBody, type RedeemLoyaltyPointsContent, type RedeemLoyaltyPointsPathParams, type RedeemLoyaltyPointsResponse, type RefreshPosAccessTokenBody, type RefreshPosAccessTokenContent, type RefreshPosAccessTokenResponse, type RefreshTokenBody, type RefreshTokenContent, type RefreshTokenResponse, type RegisterWithEmailBody, type RegisterWithEmailContent, type RegisterWithEmailPassword, type RegisterWithEmailResponse, type RegisterWithPasswordBody, type RegisterWithPasswordContent, type RegisterWithPasswordResponse, type RegisterWithPhoneBody, type RegisterWithPhoneContent, type RegisterWithPhonePassword, type RegisterWithPhoneResponse, type RegisterWithWhatsappBody, type RegisterWithWhatsappContent, type RegisterWithWhatsappResponse, type RemoveCouponContent, type RemoveCouponPathParams, type RemoveCouponResponse, type RemoveCreditBalanceContent, type RemoveCreditBalancePathParams, type RemoveCreditBalanceResponse, type RemoveGiftCardContent, type RemoveGiftCardPathParams, type RemoveGiftCardResponse, type RemoveLoyaltyPointsContent, type RemoveLoyaltyPointsPathParams, type RemoveLoyaltyPointsResponse, type RemoveProfileImagePathParams, type RemoveProfileImageResponse, type ResetPasswordBody, type ResetPasswordContent, type ResetPasswordResponse, ResponseUtils, type RetryOrderPaymentBody, type RetryOrderPaymentContent, type RetryOrderPaymentPathParams, type RetryOrderPaymentResponse, type RevokeSubscription, type SearchProduct, type SearchProductsBody, type SearchProductsContent, type SearchProductsHeaderParams, type SearchProductsResponse, type Seo, type ShipmentItem, ShippingClient, type SingleSelectAttribute, type SingleSelectOption, type StoreConfig, StoreConfigClient, type StoreTemplate, StorefrontAPIClient, StorefrontSDK, type StorefrontSDKOptions, type SubscribeNewsletterBody, type SubscribeNewsletterResponse, type Subscription, type SubscriptionBehaviour, type SubscriptionDetail, type SubscriptionInvoiceItem, type SupportedDefaultHeaders, type TextAttribute, type TokenStorage, type TrackAnalyticsEventBody, type TrackAnalyticsEventResponse, type UpdateAddressDetailBody, type UpdateAddressDetailContent, type UpdateAddressDetailPathParams, type UpdateAddressDetailResponse, type UpdateCartBody, type UpdateCartContent, type UpdateCartCustomerBody, type UpdateCartCustomerContent, type UpdateCartCustomerPathParams, type UpdateCartCustomerResponse, type UpdateCartItem, type UpdateCartPathParams, type UpdateCartResponse, type UpdateCustomer, type UpdateCustomerBody, type UpdateCustomerContent, type UpdateCustomerPathParams, type UpdateCustomerResponse, type UpdateDigitalProductSubscription, type UpdateDocument, type UpdateDocumentContent, type UpdateDocumentFormData, type UpdateDocumentPathParams, type UpdateDocumentResponse, type UpdateNotificationPreferencesBody, type UpdateNotificationPreferencesContent, type UpdateNotificationPreferencesPathParams, type UpdateNotificationPreferencesResponse, type UpdatePhysicalProductSubscription, type UpdatePosCartAddressBody, type UpdatePosCartAddressContent, type UpdatePosCartAddressPathParams, type UpdatePosCartAddressResponse, type UpdatePosCartBody, type UpdatePosCartContent, type UpdatePosCartCustomerBody, type UpdatePosCartCustomerContent, type UpdatePosCartCustomerPathParams, type UpdatePosCartCustomerResponse, type UpdatePosCartPathParams, type UpdatePosCartResponse, type UpdateProfileImageContent, type UpdateProfileImageFormData, type UpdateProfileImagePathParams, type UpdateProfileImageResponse, type UpdateShippingMethodBody, type UpdateShippingMethodContent, type UpdateShippingMethodPathParams, type UpdateShippingMethodResponse, type UpdateSubscriptionBody, type UpdateSubscriptionContent, type UpdateSubscriptionPathParams, type UpdateSubscriptionResponse, type UpdateUserBody, type UpdateUserContent, type UpdateUserPathParams, type UpdateUserResponse, type UpiPayment, type User, type UserInfo, type Variant, type VariantDetail, type VariantOption, type VerifyDocumentBody, type VerifyDocumentContent, type VerifyDocumentPathParams, type VerifyDocumentResponse, type VerifyOtpBody, type VerifyOtpContent, type VerifyOtpResponse, type VerifyPosLoginOtpBody, type VerifyPosLoginOtpContent, type VerifyPosLoginOtpResponse, type VerifyVpaContent, type VerifyVpaQuery, type VerifyVpaResponse, type VolumeBasedCouponPromotion, type VolumeBasedPromotion, type VolumeBasedRule, type WalletPayment, type components, StorefrontSDK as default, type operations, type paths };
|
|
13822
|
+
export { type AcceleratedRewardCouponPromotion, type AcceleratedRewardRule, type AddCardBody, type AddCardContent, type AddCardResponse, type AddProfileImageContent, type AddProfileImageFormData, type AddProfileImagePathParams, type AddProfileImageResponse, type AddToWishlistBody, type AddToWishlistContent, type AddToWishlistPathParams, type AddToWishlistResponse, type AdditionalProductDetails, type AnalyticsEvent, type AnonymousUser, type ApiErrorResponse, type ApiResult, type AppliedCoupon, type AppliedPromotion, type ApplyCouponBody, type ApplyCouponContent, type ApplyCouponPathParams, type ApplyCouponResponse, type AssociatedOption, AuthClient, type AutoScaleBasedOnAmount, type AutoScaleBasedOnQuantity, type BankTransfer, type BooleanAttribute, type Brand, BrowserTokenStorage, type Business, type BuyXGetYCouponPromotion, type BuyXGetYRule, type BuyXGetYRuleBasedOnAmount, type BuyXGetYRuleBasedOnQuantity, type CancelOrderBody, type CancelOrderContent, type CancelOrderPathParams, type CancelOrderResponse, type CardPayment, type Cart, type CartBasedServiceabilityCheck, CartClient, type CartItem, CatalogClient, type Category, type ChangePasswordBody, type ChangePasswordContent, type ChangePasswordResponse, type CheckPincodeServiceabilityContent, type CheckPincodeServiceabilityPathParams, type CheckPincodeServiceabilityResponse, type CheckVerificationStatusBody, type CheckVerificationStatusContent, type CheckVerificationStatusResponse, type CollectInStore, type CollectInStoreFulfillment, type ColorAttribute, type ColorOption, CookieTokenStorage, type CookieTokenStorageOptions, type Country, type CountryState, type Coupon, type CouponPromotionCommonDetail, type CreateAddressBody, type CreateAddressContent, type CreateAddressPathParams, type CreateAddressResponse, type CreateCartAddressBody, type CreateCartAddressContent, type CreateCartAddressPathParams, type CreateCartAddressResponse, type CreateCartBody, type CreateCartContent, type CreateCartResponse, type CreateCustomSubscription, type CreateCustomer, type CreateCustomerBody, type CreateCustomerContent, type CreateCustomerResponse, type CreateDocumentContent, type CreateDocumentFormData, type CreateDocumentPathParams, type CreateDocumentResponse, type CreateJuspayCustomerBody, type CreateJuspayCustomerContent, type CreateJuspayCustomerResponse, type CreateJuspayOrderBody, type CreateJuspayOrderContent, type CreateJuspayOrderResponse, type CreateNotificationPreferencesBody, type CreateNotificationPreferencesContent, type CreateNotificationPreferencesPathParams, type CreateNotificationPreferencesResponse, type CreateOrderBody, type CreateOrderContent, type CreateOrderResponse, type CreateOrderReturn, type CreateOrderReturnBody, type CreateOrderReturnContent, type CreateOrderReturnPathParams, type CreateOrderReturnResponse, type CreatePosCartBody, type CreatePosCartContent, type CreatePosCartResponse, type CreateProductReviewFormData, type CreateProductReviewPathParams, type CreateProductReviewResponse, type CreateReview, type CreateStandardSubscription, type CreateSubscription, type CreateSubscriptionBody, type CreateSubscriptionContent, type CreateSubscriptionResponse, type Currency, type CustomSlabsBasedOnAmount, type CustomSlabsBasedOnQuantity, type CustomerAddress, CustomerClient, type CustomerDetail, type CustomerGroup, type CustomerLoyalty, type CustomerReadyForReview, type CustomerReview, type DateAttribute, type DeactivateUserPathParams, type DeactivateUserResponse, type DebugLoggerFn, type DeleteAddressPathParams, type DeleteAddressResponse, type DeleteCartPathParams, type DeleteCartResponse, type DeleteDocumentPathParams, type DeleteDocumentResponse, type DeleteFromWishlistBody, type DeleteFromWishlistContent, type DeleteFromWishlistPathParams, type DeleteFromWishlistResponse, type DeleteUserCartPathParams, type DeleteUserCartResponse, type DeliveryFulfillment, type DiscountBasedPromotion, type DiscountCouponPromotion, type DiscountRule, type Document, Environment, type EvaluateCouponsContent, type EvaluateCouponsPathParams, type EvaluateCouponsResponse, type EvaluatePosCouponsContent, type EvaluatePosCouponsPathParams, type EvaluatePosCouponsResponse, type EvaluatePosPromotionsContent, type EvaluatePosPromotionsPathParams, type EvaluatePosPromotionsResponse, type EvaluatePromotionsContent, type EvaluatePromotionsPathParams, type EvaluatePromotionsResponse, type FixedAmountDiscountRule, type FixedPriceCouponPromotion, type FixedPricePromotion, type FixedPriceRule, type FixedPriceRuleBasedAmount, type FixedPriceRuleBasedQuantity, type ForgotPasswordBody, type ForgotPasswordContent, type ForgotPasswordResponse, type FreeGoodCouponPromotion, type FreeGoodsPromotion, type FreeGoodsRule, type FreeShipingCouponPromotion, type GenerateHashBody, type GenerateHashContent, type GenerateHashResponse, type GenerateOtpBody, type GenerateOtpContent, type GenerateOtpResponse, type GenerateOtpWithEmail, type GenerateOtpWithPhone, type GetAddressDetailContent, type GetAddressDetailPathParams, type GetAddressDetailResponse, type GetAnonymousTokenContent, type GetAnonymousTokenResponse, type GetCartContent, type GetCartPathParams, type GetCartResponse, type GetConfigContent, type GetConfigResponse, type GetCustomerDetailContent, type GetCustomerDetailPathParams, type GetCustomerDetailResponse, type GetDocumentContent, type GetDocumentPathParams, type GetDocumentResponse, type GetFulfillmentOptionsBody, type GetFulfillmentOptionsContent, type GetFulfillmentOptionsResponse, type GetJuspayCustomerContent, type GetJuspayCustomerPathParams, type GetJuspayCustomerResponse, type GetLoyaltyDetailsContent, type GetLoyaltyDetailsPathParams, type GetLoyaltyDetailsResponse, type GetNotificationPreferencesContent, type GetNotificationPreferencesPathParams, type GetNotificationPreferencesResponse, type GetOrderDetailContent, type GetOrderDetailPathParams, type GetOrderDetailResponse, type GetOrderReturnDetailContent, type GetOrderReturnDetailPathParams, type GetOrderReturnDetailResponse, type GetPaymentStatusContent, type GetPaymentStatusPathParams, type GetPaymentStatusResponse, type GetPosCartContent, type GetPosCartPathParams, type GetPosCartResponse, type GetPosFulfillmentOptionsBody, type GetPosFulfillmentOptionsContent, type GetPosFulfillmentOptionsResponse, type GetProductDetailContent, type GetProductDetailHeaderParams, type GetProductDetailPathParams, type GetProductDetailResponse, type GetProfileImageContent, type GetProfileImagePathParams, type GetProfileImageResponse, type GetShippingMethodsBody, type GetShippingMethodsContent, type GetShippingMethodsResponse, type GetSubscriptionContent, type GetSubscriptionPathParams, type GetSubscriptionResponse, type GetUserCartContent, type GetUserCartPathParams, type GetUserCartResponse, type GetUserDetailContent, type GetUserDetailPathParams, type GetUserDetailResponse, type GetVariantDetailContent, type GetVariantDetailHeaderParams, type GetVariantDetailPathParams, type GetVariantDetailResponse, type GetWishlistContent, type GetWishlistPathParams, type GetWishlistResponse, type GstinDetail, HelpersClient, type Item, type JuspayCardPayload, type JuspayCreateCardResponse, type JuspayCreateCustomerPayload, type JuspayCreateOrderPayload, type JuspayCustomer, type JuspayOrder, type JuspayPaymentGatewayParams, type JuspayPaymentInfo, type JuspayPaymentMethod, type JuspaySavedCard, type KycDocument, type KycDocumentConfig, type ListAddressesContent, type ListAddressesPathParams, type ListAddressesQuery, type ListAddressesResponse, type ListCategoriesContent, type ListCategoriesQuery, type ListCategoriesResponse, type ListCountriesContent, type ListCountriesResponse, type ListCountryPincodesContent, type ListCountryPincodesPathParams, type ListCountryPincodesQuery, type ListCountryPincodesResponse, type ListCountryStatesContent, type ListCountryStatesPathParams, type ListCountryStatesResponse, type ListCouponsContent, type ListCouponsHeaderParams, type ListCouponsResponse, type ListCrosssellProductsContent, type ListCrosssellProductsHeaderParams, type ListCrosssellProductsQuery, type ListCrosssellProductsResponse, type ListDocumentsContent, type ListDocumentsPathParams, type ListDocumentsResponse, type ListKycDocumentContent, type ListKycDocumentResponse, type ListLoyaltyActivitiesContent, type ListLoyaltyActivitiesPathParams, type ListLoyaltyActivitiesQuery, type ListLoyaltyActivitiesResponse, type ListOrderPaymentsContent, type ListOrderPaymentsPathParams, type ListOrderPaymentsResponse, type ListOrderRefundsContent, type ListOrderRefundsPathParams, type ListOrderRefundsResponse, type ListOrderShipmentsContent, type ListOrderShipmentsPathParams, type ListOrderShipmentsResponse, type ListOrdersContent, type ListOrdersQuery, type ListOrdersResponse, type ListPaymentMethodsContent, type ListPaymentMethodsQuery, type ListPaymentMethodsResponse, type ListProductReviewsContent, type ListProductReviewsPathParams, type ListProductReviewsQuery, type ListProductReviewsResponse, type ListProductVariantsContent, type ListProductVariantsHeaderParams, type ListProductVariantsPathParams, type ListProductVariantsResponse, type ListProductsContent, type ListProductsHeaderParams, type ListProductsQuery, type ListProductsResponse, type ListPromotionsContent, type ListPromotionsHeaderParams, type ListPromotionsResponse, type ListReturnsContent, type ListReturnsResponse, type ListSavedCardsContent, type ListSavedCardsQuery, type ListSavedCardsResponse, type ListSimilarProductsContent, type ListSimilarProductsHeaderParams, type ListSimilarProductsQuery, type ListSimilarProductsResponse, type ListSkusContent, type ListSkusHeaderParams, type ListSkusQuery, type ListSkusResponse, type ListSubscriptionsContent, type ListSubscriptionsResponse, type ListUpsellProductsContent, type ListUpsellProductsHeaderParams, type ListUpsellProductsQuery, type ListUpsellProductsResponse, type ListUserReviewsContent, type ListUserReviewsPathParams, type ListUserReviewsResponse, type LoginPosDeviceWithEmailBody, type LoginPosDeviceWithEmailContent, type LoginPosDeviceWithEmailResponse, type LoginPosDeviceWithPhoneBody, type LoginPosDeviceWithPhoneContent, type LoginPosDeviceWithPhoneResponse, type LoginPosDeviceWithWhatsappBody, type LoginPosDeviceWithWhatsappContent, type LoginPosDeviceWithWhatsappResponse, type LoginWithEmailBody, type LoginWithEmailContent, type LoginWithEmailResponse, type LoginWithPasswordBody, type LoginWithPasswordContent, type LoginWithPasswordResponse, type LoginWithPhoneBody, type LoginWithPhoneContent, type LoginWithPhoneResponse, type LoginWithWhatsappBody, type LoginWithWhatsappContent, type LoginWithWhatsappResponse, type LogoutContent, type LogoutResponse, type LoyaltyPointActivity, type MeasurementUnit, MemoryTokenStorage, type MultiSelectAttribute, type NetbankingPayment, type NotificationChannelPreferences, type NotificationPreferences, type NumberAttribute, type Order, OrderClient, type OrderDetail, type OrderItem, type OrderList, type OrderPayment, type OrderRefund, type OrderReturn, type OrderReturnItem, type OrderShipment, type POSCollectInStoreFulfillment, type POSDeliveryFulfillment, type POSPartialCollectAndDeliveryFulfillment, type Pagination, type PairPosDeviceBody, type PairPosDeviceContent, type PairPosDeviceResponse, type PanDetail, type PauseSubscription, type PaymentInfo, type PayuCardPayload, type PayuCreateCardResponse, type PayuPaymentGatewayParams, type PayuPaymentInfo, type PayuPaymentMethod, type PayuSavedCard, type PercentageDiscountRule, type Pincode, type PincodeServiceability, type PosDevice, type PosUpdateCustomerWithEmail, type PosUpdateCustomerWithId, type PosUpdateCustomerWithPhone, type PosUpdateFulfillmentPreferenceBody, type PosUpdateFulfillmentPreferencePathParams, type PosUpdateFulfillmentPreferenceResponse, type PosUser, type Product, type ProductAttribute, type ProductBundleItem, type ProductCategory, type ProductDetail, type ProductImage, type ProductPricing, type ProductPromotion, type ProductReview, type ProductShipping, type ProductSubscription, type ProductVideo, type Promotion, type RedeemCreditBalanceBody, type RedeemCreditBalanceContent, type RedeemCreditBalancePathParams, type RedeemCreditBalanceResponse, type RedeemGiftCardBody, type RedeemGiftCardContent, type RedeemGiftCardPathParams, type RedeemGiftCardResponse, type RedeemLoyaltyPointsBody, type RedeemLoyaltyPointsContent, type RedeemLoyaltyPointsPathParams, type RedeemLoyaltyPointsResponse, type RefreshPosAccessTokenBody, type RefreshPosAccessTokenContent, type RefreshPosAccessTokenResponse, type RefreshTokenBody, type RefreshTokenContent, type RefreshTokenResponse, type RegisterWithEmailBody, type RegisterWithEmailContent, type RegisterWithEmailPassword, type RegisterWithEmailResponse, type RegisterWithPasswordBody, type RegisterWithPasswordContent, type RegisterWithPasswordResponse, type RegisterWithPhoneBody, type RegisterWithPhoneContent, type RegisterWithPhonePassword, type RegisterWithPhoneResponse, type RegisterWithWhatsappBody, type RegisterWithWhatsappContent, type RegisterWithWhatsappResponse, type RemoveCouponContent, type RemoveCouponPathParams, type RemoveCouponResponse, type RemoveCreditBalanceContent, type RemoveCreditBalancePathParams, type RemoveCreditBalanceResponse, type RemoveGiftCardContent, type RemoveGiftCardPathParams, type RemoveGiftCardResponse, type RemoveLoyaltyPointsContent, type RemoveLoyaltyPointsPathParams, type RemoveLoyaltyPointsResponse, type RemoveProfileImagePathParams, type RemoveProfileImageResponse, type ResetPasswordBody, type ResetPasswordContent, type ResetPasswordResponse, ResponseUtils, type RetryOrderPaymentBody, type RetryOrderPaymentContent, type RetryOrderPaymentPathParams, type RetryOrderPaymentResponse, type RevokeSubscription, type SearchProduct, type SearchProductsBody, type SearchProductsContent, type SearchProductsHeaderParams, type SearchProductsResponse, type Seo, type ShipmentItem, ShippingClient, type SingleSelectAttribute, type SingleSelectOption, type StoreConfig, StoreConfigClient, type StoreTemplate, StorefrontAPIClient, StorefrontSDK, type StorefrontSDKOptions, type SubscribeNewsletterBody, type SubscribeNewsletterResponse, type Subscription, type SubscriptionBehaviour, type SubscriptionDetail, type SubscriptionInvoiceItem, type SupportedDefaultHeaders, type TextAttribute, type TokenStorage, type TrackAnalyticsEventBody, type TrackAnalyticsEventResponse, type UpdateAddressDetailBody, type UpdateAddressDetailContent, type UpdateAddressDetailPathParams, type UpdateAddressDetailResponse, type UpdateCartBody, type UpdateCartContent, type UpdateCartItem, type UpdateCartPathParams, type UpdateCartResponse, type UpdateCustomer, type UpdateCustomerBody, type UpdateCustomerContent, type UpdateCustomerPathParams, type UpdateCustomerResponse, type UpdateDigitalProductSubscription, type UpdateDocument, type UpdateDocumentContent, type UpdateDocumentFormData, type UpdateDocumentPathParams, type UpdateDocumentResponse, type UpdateFulfillmentPreferenceBody, type UpdateFulfillmentPreferencePathParams, type UpdateFulfillmentPreferenceResponse, type UpdateNotificationPreferencesBody, type UpdateNotificationPreferencesContent, type UpdateNotificationPreferencesPathParams, type UpdateNotificationPreferencesResponse, type UpdatePhysicalProductSubscription, type UpdatePosCartAddressBody, type UpdatePosCartAddressContent, type UpdatePosCartAddressPathParams, type UpdatePosCartAddressResponse, type UpdatePosCartBody, type UpdatePosCartContent, type UpdatePosCartCustomerBody, type UpdatePosCartCustomerContent, type UpdatePosCartCustomerPathParams, type UpdatePosCartCustomerResponse, type UpdatePosCartPathParams, type UpdatePosCartResponse, type UpdateProfileImageContent, type UpdateProfileImageFormData, type UpdateProfileImagePathParams, type UpdateProfileImageResponse, type UpdateShippingMethodBody, type UpdateShippingMethodContent, type UpdateShippingMethodPathParams, type UpdateShippingMethodResponse, type UpdateSubscriptionBody, type UpdateSubscriptionContent, type UpdateSubscriptionPathParams, type UpdateSubscriptionResponse, type UpdateUserBody, type UpdateUserContent, type UpdateUserPathParams, type UpdateUserResponse, type UpiPayment, type User, type UserInfo, type Variant, type VariantDetail, type VariantOption, type VerifyDocumentBody, type VerifyDocumentContent, type VerifyDocumentPathParams, type VerifyDocumentResponse, type VerifyOtpBody, type VerifyOtpContent, type VerifyOtpResponse, type VerifyPosLoginOtpBody, type VerifyPosLoginOtpContent, type VerifyPosLoginOtpResponse, type VerifyVpaContent, type VerifyVpaQuery, type VerifyVpaResponse, type VolumeBasedCouponPromotion, type VolumeBasedPromotion, type VolumeBasedRule, type WalletPayment, type components, StorefrontSDK as default, type operations, type paths };
|