@gofynd/fdk-client-javascript 1.4.5 → 1.4.7

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.
Files changed (79) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +2 -2
  4. package/sdk/application/ApplicationClient.js +2 -2
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +5 -5
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +5 -5
  7. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +6 -0
  8. package/sdk/application/Catalog/CatalogApplicationModel.js +6 -0
  9. package/sdk/application/Content/ContentApplicationModel.d.ts +2 -0
  10. package/sdk/application/Content/ContentApplicationModel.js +2 -0
  11. package/sdk/application/Logistic/LogisticApplicationModel.js +2 -2
  12. package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
  13. package/sdk/application/Order/OrderApplicationClient.js +1 -1
  14. package/sdk/application/Order/OrderApplicationModel.d.ts +70 -9
  15. package/sdk/application/Order/OrderApplicationModel.js +43 -7
  16. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -2
  17. package/sdk/application/Order/OrderApplicationValidator.js +1 -1
  18. package/sdk/application/Payment/PaymentApplicationModel.d.ts +18 -18
  19. package/sdk/application/Payment/PaymentApplicationModel.js +41 -35
  20. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +22 -0
  21. package/sdk/application/Webhook/WebhookApplicationClient.js +115 -0
  22. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +37 -0
  23. package/sdk/application/Webhook/WebhookApplicationModel.js +46 -0
  24. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +16 -0
  25. package/sdk/application/Webhook/WebhookApplicationValidator.js +19 -0
  26. package/sdk/application/index.d.ts +1 -1
  27. package/sdk/application/index.js +2 -2
  28. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
  29. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  30. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +23 -19
  31. package/sdk/partner/Webhook/WebhookPartnerModel.js +20 -23
  32. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +43 -0
  33. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +257 -0
  34. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +39 -0
  35. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +45 -0
  36. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +60 -0
  37. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +57 -0
  38. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +10 -0
  39. package/sdk/platform/Cart/CartPlatformApplicationClient.js +80 -0
  40. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -1
  41. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -0
  42. package/sdk/platform/Cart/CartPlatformModel.d.ts +2 -0
  43. package/sdk/platform/Cart/CartPlatformModel.js +2 -0
  44. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +34 -7
  45. package/sdk/platform/Catalog/CatalogPlatformClient.js +88 -13
  46. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +120 -17
  47. package/sdk/platform/Catalog/CatalogPlatformModel.js +153 -27
  48. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +71 -7
  49. package/sdk/platform/Catalog/CatalogPlatformValidator.js +32 -5
  50. package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -0
  51. package/sdk/platform/Content/ContentPlatformModel.js +2 -0
  52. package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -1
  53. package/sdk/platform/Order/OrderPlatformClient.js +82 -5
  54. package/sdk/platform/Order/OrderPlatformModel.d.ts +163 -15
  55. package/sdk/platform/Order/OrderPlatformModel.js +157 -55
  56. package/sdk/platform/Order/OrderPlatformValidator.d.ts +58 -17
  57. package/sdk/platform/Order/OrderPlatformValidator.js +28 -16
  58. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
  59. package/sdk/platform/Payment/PaymentPlatformModel.js +24 -18
  60. package/sdk/platform/PlatformApplicationClient.d.ts +2 -0
  61. package/sdk/platform/PlatformApplicationClient.js +4 -0
  62. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +24 -0
  63. package/sdk/platform/Webhook/WebhookPlatformClient.js +164 -0
  64. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +71 -18
  65. package/sdk/platform/Webhook/WebhookPlatformModel.js +76 -23
  66. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +19 -1
  67. package/sdk/platform/Webhook/WebhookPlatformValidator.js +24 -0
  68. package/sdk/platform/index.d.ts +1 -0
  69. package/sdk/platform/index.js +2 -0
  70. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  71. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
  72. package/sdk/public/Webhook/WebhookPublicModel.d.ts +2 -0
  73. package/sdk/public/Webhook/WebhookPublicModel.js +3 -1
  74. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +0 -323
  75. package/sdk/application/PosCart/PosCartApplicationClient.js +0 -2364
  76. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +0 -1857
  77. package/sdk/application/PosCart/PosCartApplicationModel.js +0 -1906
  78. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +0 -483
  79. package/sdk/application/PosCart/PosCartApplicationValidator.js +0 -492
@@ -1,1857 +0,0 @@
1
- export = PosCartApplicationModel;
2
- /**
3
- * @typedef BuyRules
4
- * @property {Object} [cart_conditions] - Cart conditions details for promotion
5
- * @property {Object} [item_criteria] - Item criteria of promotion
6
- */
7
- /**
8
- * @typedef DiscountRulesApp
9
- * @property {string[]} [matched_buy_rules] - Matched buy rules for promotion
10
- * @property {Object} [offer] - Offer for promotion
11
- * @property {Object} [item_criteria] - Item criteria of promotion
12
- * @property {Object} [raw_offer] - Raw offer details for promotion
13
- */
14
- /**
15
- * @typedef FreeGiftItem
16
- * @property {string} [item_slug] - Item slug
17
- * @property {Object} [item_price_details] - Item price details
18
- * @property {string[]} [item_images_url] - Item images URL
19
- * @property {string} [item_name] - Item name
20
- * @property {number} [item_id] - Item id
21
- * @property {string} [item_brand_name] - Item brand name
22
- */
23
- /**
24
- * @typedef AppliedFreeArticles
25
- * @property {number} [quantity] - Free article quantity
26
- * @property {string} [parent_item_identifier] - Parent item identifier for free article
27
- * @property {string} [article_id] - Free article id
28
- * @property {FreeGiftItem} [free_gift_item_details] - Free gift items details
29
- */
30
- /**
31
- * @typedef Ownership
32
- * @property {string} [payable_category] - Promo amount payable category
33
- * @property {string} [payable_by] - Promo amount bearable party
34
- */
35
- /**
36
- * @typedef AppliedPromotion
37
- * @property {string} [promotion_name] - Promotion name of current promotion
38
- * @property {boolean} [mrp_promotion] - If applied promotion is applied on
39
- * product MRP or ESP
40
- * @property {BuyRules[]} [buy_rules] - Buy rules for promotions
41
- * @property {string} [promotion_type] - Promotion type of current promotion
42
- * @property {number} [article_quantity] - Quantity of article on which
43
- * promotion is applicable
44
- * @property {number} [amount] - Per unit discount amount applied with current promotion
45
- * @property {DiscountRulesApp[]} [discount_rules] - Discount rules for promotions
46
- * @property {string} [offer_text] - Offer text of current promotion
47
- * @property {string} [promo_id] - Promotion id
48
- * @property {AppliedFreeArticles[]} [applied_free_articles] - Applied free
49
- * article for free gift item promotions
50
- * @property {Ownership} [ownership] - Ownership of promotion
51
- * @property {CartCurrency} [currency]
52
- * @property {string} [promotion_group] - Promotion group for the promotion
53
- */
54
- /**
55
- * @typedef LoyaltyPoints
56
- * @property {string} [description]
57
- * @property {boolean} [is_applied]
58
- * @property {number} [applicable]
59
- * @property {number} [total]
60
- */
61
- /**
62
- * @typedef RawBreakup
63
- * @property {number} [discount]
64
- * @property {number} [you_saved]
65
- * @property {number} [mrp_total]
66
- * @property {number} [gst_charges]
67
- * @property {number} [total]
68
- * @property {number} [vog]
69
- * @property {number} [coupon]
70
- * @property {number} [subtotal]
71
- * @property {number} [delivery_charge]
72
- * @property {number} [cod_charge]
73
- * @property {number} [fynd_cash]
74
- * @property {number} [gift_card]
75
- * @property {number} [convenience_fee]
76
- */
77
- /**
78
- * @typedef DisplayBreakup
79
- * @property {string} [currency_code]
80
- * @property {string} [currency_symbol]
81
- * @property {string} [display]
82
- * @property {string[]} [message]
83
- * @property {string} [key]
84
- * @property {number} [value]
85
- */
86
- /**
87
- * @typedef CouponBreakup
88
- * @property {number} [max_discount_value]
89
- * @property {string} [message]
90
- * @property {boolean} [is_applied]
91
- * @property {string} [uid]
92
- * @property {string} [type]
93
- * @property {string} [coupon_type]
94
- * @property {string} [sub_title]
95
- * @property {number} [coupon_value]
96
- * @property {string} [description]
97
- * @property {string} [code]
98
- * @property {number} [minimum_cart_value]
99
- * @property {number} [value]
100
- * @property {string} [title]
101
- */
102
- /**
103
- * @typedef CartBreakup
104
- * @property {LoyaltyPoints} [loyalty_points]
105
- * @property {RawBreakup} [raw]
106
- * @property {DisplayBreakup[]} [display]
107
- * @property {CouponBreakup} [coupon]
108
- */
109
- /**
110
- * @typedef PaymentSelectionLock
111
- * @property {string} [default_options]
112
- * @property {boolean} [enabled]
113
- * @property {string} [payment_identifier]
114
- */
115
- /**
116
- * @typedef PromiseTimestamp
117
- * @property {number} [max]
118
- * @property {number} [min]
119
- */
120
- /**
121
- * @typedef PromiseFormatted
122
- * @property {string} [max]
123
- * @property {string} [min]
124
- */
125
- /**
126
- * @typedef PromiseISOFormat
127
- * @property {string} [max] - Max promise in ISO format.
128
- * @property {string} [min] - Min Promise in ISO format.
129
- */
130
- /**
131
- * @typedef ShipmentPromise
132
- * @property {PromiseTimestamp} [timestamp]
133
- * @property {PromiseFormatted} [formatted]
134
- * @property {PromiseISOFormat} [iso]
135
- */
136
- /**
137
- * @typedef StoreInfo
138
- * @property {number} [uid]
139
- * @property {string} [store_code]
140
- * @property {string} [name]
141
- */
142
- /**
143
- * @typedef BaseInfo
144
- * @property {number} [uid]
145
- * @property {string} [name]
146
- */
147
- /**
148
- * @typedef BasePrice
149
- * @property {number} [effective]
150
- * @property {string} [currency_code]
151
- * @property {string} [currency_symbol]
152
- * @property {number} [marked]
153
- */
154
- /**
155
- * @typedef ArticlePriceInfo
156
- * @property {BasePrice} [converted]
157
- * @property {BasePrice} [base]
158
- */
159
- /**
160
- * @typedef ProductArticle
161
- * @property {Object} [meta]
162
- * @property {StoreInfo} [store]
163
- * @property {Object} [_custom_json]
164
- * @property {string} [seller_identifier]
165
- * @property {Object} [identifier]
166
- * @property {number} [quantity]
167
- * @property {BaseInfo} [seller]
168
- * @property {number} [mto_quantity]
169
- * @property {string} [uid]
170
- * @property {Object} [cart_item_meta]
171
- * @property {string} [type]
172
- * @property {ArticlePriceInfo} [price]
173
- * @property {Object} [parent_item_identifiers]
174
- * @property {string} [size]
175
- * @property {Object} [extra_meta]
176
- * @property {Object} [gift_card]
177
- * @property {string[]} [product_group_tags]
178
- * @property {boolean} [is_gift_visible]
179
- * @property {string[]} [tags] - A list of article tags
180
- */
181
- /**
182
- * @typedef Tags
183
- * @property {Object} [tags]
184
- */
185
- /**
186
- * @typedef CategoryInfo
187
- * @property {number} [uid] - Product Category Id
188
- * @property {string} [name]
189
- */
190
- /**
191
- * @typedef ProductImage
192
- * @property {string} [aspect_ratio]
193
- * @property {string} [url]
194
- * @property {string} [secure_url]
195
- */
196
- /**
197
- * @typedef ActionQuery
198
- * @property {string[]} [product_slug] - Contains list of product slug
199
- */
200
- /**
201
- * @typedef ProductAction
202
- * @property {ActionQuery} [query]
203
- * @property {string} [url]
204
- * @property {string} [type]
205
- */
206
- /**
207
- * @typedef CartProduct
208
- * @property {Tags} [teaser_tag]
209
- * @property {Object} [_custom_json]
210
- * @property {CategoryInfo[]} [categories]
211
- * @property {string} [item_code]
212
- * @property {string[]} [tags]
213
- * @property {number} [uid]
214
- * @property {string} [type]
215
- * @property {ProductImage[]} [images]
216
- * @property {string} [name]
217
- * @property {string} [slug] - Unique product url name generated via product
218
- * name and other meta data
219
- * @property {ProductAction} [action]
220
- * @property {BaseInfo} [brand]
221
- */
222
- /**
223
- * @typedef ProductPrice
224
- * @property {number} [effective]
225
- * @property {string} [currency_code]
226
- * @property {string} [currency_symbol]
227
- * @property {number} [marked]
228
- * @property {number} [selling]
229
- * @property {number} [add_on]
230
- */
231
- /**
232
- * @typedef ProductPriceInfo
233
- * @property {ProductPrice} [converted]
234
- * @property {ProductPrice} [base]
235
- */
236
- /**
237
- * @typedef CouponDetails
238
- * @property {number} [discount_total_quantity]
239
- * @property {number} [discount_single_quantity]
240
- * @property {string} [code]
241
- */
242
- /**
243
- * @typedef PromoMeta
244
- * @property {string} [message]
245
- */
246
- /**
247
- * @typedef ProductAvailabilitySize
248
- * @property {boolean} [is_available]
249
- * @property {string} [value]
250
- * @property {string} [display]
251
- */
252
- /**
253
- * @typedef ProductAvailability
254
- * @property {ProductAvailabilitySize[]} [available_sizes]
255
- * @property {number} [other_store_quantity]
256
- * @property {boolean} [deliverable]
257
- * @property {boolean} [out_of_stock]
258
- * @property {boolean} [is_valid]
259
- * @property {string[]} [sizes]
260
- */
261
- /**
262
- * @typedef CartProductIdentifer
263
- * @property {string} [identifier] - Article idenfier generated by cart
264
- */
265
- /**
266
- * @typedef CartProductInfo
267
- * @property {Object} [custom_order]
268
- * @property {ProductArticle} [article]
269
- * @property {CartProduct} [product]
270
- * @property {number} [quantity]
271
- * @property {Object} [moq]
272
- * @property {AppliedPromotion[]} [promotions_applied]
273
- * @property {ProductPriceInfo} [price_per_unit]
274
- * @property {string} [key]
275
- * @property {ProductPriceInfo} [price]
276
- * @property {Object} [parent_item_identifiers]
277
- * @property {boolean} [is_set]
278
- * @property {string} [coupon_message]
279
- * @property {string} [message]
280
- * @property {CouponDetails} [coupon]
281
- * @property {string} [discount]
282
- * @property {Object} [bulk_offer]
283
- * @property {PromoMeta} [promo_meta]
284
- * @property {ShipmentPromise} [delivery_promise]
285
- * @property {ProductAvailability} [availability]
286
- * @property {CartProductIdentifer} identifiers
287
- */
288
- /**
289
- * @typedef CartCurrency
290
- * @property {string} [symbol]
291
- * @property {string} [code] - Currency code defined by ISO 4217:2015
292
- */
293
- /**
294
- * @typedef CartDetailResponse
295
- * @property {string} [comment]
296
- * @property {string} [coupon_text]
297
- * @property {string} [last_modified]
298
- * @property {Object} [pan_config]
299
- * @property {boolean} [is_valid]
300
- * @property {string} [id]
301
- * @property {AppliedPromotion[]} [applied_promo_details]
302
- * @property {string} [checkout_mode]
303
- * @property {boolean} [restrict_checkout]
304
- * @property {string} [message]
305
- * @property {boolean} [buy_now]
306
- * @property {CartBreakup} [breakup_values]
307
- * @property {string} [delivery_charge_info]
308
- * @property {PaymentSelectionLock} [payment_selection_lock]
309
- * @property {string} [gstin]
310
- * @property {ShipmentPromise} [delivery_promise]
311
- * @property {string} [pan_no]
312
- * @property {CartProductInfo[]} [items]
313
- * @property {CartCurrency} [currency]
314
- */
315
- /**
316
- * @typedef AddProductCart
317
- * @property {number} [seller_id]
318
- * @property {Object} [_custom_json]
319
- * @property {Object} [meta]
320
- * @property {string} [display]
321
- * @property {number} [quantity]
322
- * @property {string} [item_size]
323
- * @property {number} [item_id]
324
- * @property {number} [store_id]
325
- * @property {boolean} [pos]
326
- * @property {Object[]} [parent_item_identifiers]
327
- * @property {Object} [extra_meta]
328
- * @property {string[]} [product_group_tags]
329
- * @property {Object} [article_assignment]
330
- * @property {string} [article_id]
331
- */
332
- /**
333
- * @typedef AddCartRequest
334
- * @property {AddProductCart[]} [items]
335
- * @property {boolean} [new_cart]
336
- */
337
- /**
338
- * @typedef AddCartDetailResponse
339
- * @property {CartDetailResponse} [cart]
340
- * @property {string} [message]
341
- * @property {boolean} [partial] - When adding multiple items check if all
342
- * added. True if only few are added.
343
- * @property {boolean} [success] - True if all items are added successfully.
344
- * False if partially added or not added.
345
- */
346
- /**
347
- * @typedef UpdateProductCart
348
- * @property {Object} [meta]
349
- * @property {Object} [_custom_json]
350
- * @property {number} [quantity]
351
- * @property {string} [item_size]
352
- * @property {number} [item_id]
353
- * @property {number} [item_index]
354
- * @property {CartProductIdentifer} identifiers
355
- * @property {Object} [parent_item_identifiers]
356
- * @property {Object} [extra_meta]
357
- * @property {string} [article_id]
358
- */
359
- /**
360
- * @typedef UpdateCartRequest
361
- * @property {string} operation
362
- * @property {UpdateProductCart[]} [items]
363
- */
364
- /**
365
- * @typedef UpdateCartDetailResponse
366
- * @property {CartDetailResponse} [cart]
367
- * @property {string} [message]
368
- * @property {boolean} [success] - True if all items are added successfully.
369
- * False if partially added or not added.
370
- */
371
- /**
372
- * @typedef CartItemCountResponse
373
- * @property {number} [user_cart_items_count] - Item count present in cart
374
- */
375
- /**
376
- * @typedef PageCoupon
377
- * @property {boolean} [has_previous]
378
- * @property {number} [current]
379
- * @property {number} [total]
380
- * @property {number} [total_item_count]
381
- * @property {boolean} [has_next]
382
- */
383
- /**
384
- * @typedef Coupon
385
- * @property {number} [max_discount_value]
386
- * @property {string} [coupon_code]
387
- * @property {string} [message]
388
- * @property {boolean} [is_applied]
389
- * @property {string} [coupon_type]
390
- * @property {string} [sub_title]
391
- * @property {number} [coupon_value]
392
- * @property {boolean} [is_applicable]
393
- * @property {string} [description]
394
- * @property {number} [minimum_cart_value]
395
- * @property {string} [title]
396
- * @property {string} [expires_on]
397
- */
398
- /**
399
- * @typedef GetCouponResponse
400
- * @property {PageCoupon} [page]
401
- * @property {Coupon[]} [available_coupon_list]
402
- */
403
- /**
404
- * @typedef ApplyCouponRequest
405
- * @property {string} coupon_code - Coupon code to be applied
406
- */
407
- /**
408
- * @typedef OfferSeller
409
- * @property {number} [uid] - Seller id
410
- * @property {string} [name]
411
- */
412
- /**
413
- * @typedef OfferPrice
414
- * @property {number} [effective] - Current per unit price of product after
415
- * existing deductions
416
- * @property {string} [currency_code] - Currency code for all amounts
417
- * @property {string} [currency_symbol] - Currency symbol for currency
418
- * @property {number} [marked] - Original price of product
419
- * @property {number} [bulk_effective] - Discounted per unit price for current
420
- * offer object
421
- */
422
- /**
423
- * @typedef OfferItem
424
- * @property {number} [margin] - Percentage value of discount
425
- * @property {number} [quantity] - Quantity on which offer is applicable
426
- * @property {number} [total] - Total price of offer quantity with discount
427
- * @property {boolean} [best] - Is true for best offer from all offers present
428
- * for all sellers
429
- * @property {string} [type] - Offer type
430
- * @property {OfferPrice} [price]
431
- * @property {boolean} [auto_applied] - Whether offer discount is auto applied in cart
432
- */
433
- /**
434
- * @typedef BulkPriceOffer
435
- * @property {OfferSeller} [seller]
436
- * @property {OfferItem[]} [offers]
437
- */
438
- /**
439
- * @typedef BulkPriceResponse
440
- * @property {BulkPriceOffer[]} [data] - Consist of offers from multiple seller
441
- */
442
- /**
443
- * @typedef RewardPointRequest
444
- * @property {boolean} points
445
- */
446
- /**
447
- * @typedef GeoLocation
448
- * @property {number} [latitude]
449
- * @property {number} [longitude]
450
- */
451
- /**
452
- * @typedef Address
453
- * @property {Object} [meta]
454
- * @property {string} [country_code]
455
- * @property {string} [country_iso_code]
456
- * @property {string} [country]
457
- * @property {string} [id]
458
- * @property {string} [checkout_mode]
459
- * @property {string} [created_by_user_id]
460
- * @property {string} [area]
461
- * @property {boolean} [is_active]
462
- * @property {string} [city]
463
- * @property {string} [sector]
464
- * @property {string} [state_code] - State code for international address
465
- * @property {string} [address_type]
466
- * @property {string} [state]
467
- * @property {boolean} [is_default_address]
468
- * @property {Object} [_custom_json]
469
- * @property {string} [country_phone_code]
470
- * @property {string} [area_code_slug]
471
- * @property {string} [area_code]
472
- * @property {string} [email]
473
- * @property {Object} [google_map_point]
474
- * @property {GeoLocation} [geo_location]
475
- * @property {string} [address]
476
- * @property {string[]} [tags]
477
- * @property {string} [name]
478
- * @property {string} [landmark]
479
- * @property {string} [user_id]
480
- * @property {string} [phone]
481
- */
482
- /**
483
- * @typedef GetAddressesResponse
484
- * @property {boolean} [pii_masking]
485
- * @property {Address[]} [address]
486
- */
487
- /**
488
- * @typedef SaveAddressResponse
489
- * @property {boolean} [is_default_address]
490
- * @property {boolean} [success]
491
- * @property {string} [id]
492
- */
493
- /**
494
- * @typedef UpdateAddressResponse
495
- * @property {boolean} [is_updated]
496
- * @property {boolean} [is_default_address]
497
- * @property {boolean} [success]
498
- * @property {string} [id]
499
- */
500
- /**
501
- * @typedef DeleteAddressResponse
502
- * @property {boolean} [is_deleted]
503
- * @property {string} [id]
504
- */
505
- /**
506
- * @typedef SelectCartAddressRequest
507
- * @property {string} [billing_address_id]
508
- * @property {string} [cart_id]
509
- * @property {string} [id]
510
- */
511
- /**
512
- * @typedef UpdateCartPaymentRequest
513
- * @property {string} [payment_identifier]
514
- * @property {string} [aggregator_name]
515
- * @property {string} [address_id]
516
- * @property {string} [merchant_code]
517
- * @property {string} [payment_mode]
518
- * @property {string} [id]
519
- */
520
- /**
521
- * @typedef CouponValidity
522
- * @property {number} [discount]
523
- * @property {boolean} [valid]
524
- * @property {boolean} [next_validation_required]
525
- * @property {string} [display_message_en]
526
- * @property {string} [code]
527
- * @property {string} [title]
528
- */
529
- /**
530
- * @typedef PaymentCouponValidate
531
- * @property {string} [message]
532
- * @property {boolean} success
533
- * @property {CouponValidity} [coupon_validity]
534
- */
535
- /**
536
- * @typedef ShipmentResponse
537
- * @property {number} [shipments]
538
- * @property {string} [fulfillment_type]
539
- * @property {ShipmentPromise} [promise]
540
- * @property {string} [dp_id]
541
- * @property {string} [box_type]
542
- * @property {Object} [dp_options]
543
- * @property {CartProductInfo[]} [items]
544
- * @property {string} [order_type]
545
- * @property {string} [shipment_type]
546
- * @property {number} [fulfillment_id]
547
- */
548
- /**
549
- * @typedef CartShipmentsResponse
550
- * @property {string} [comment]
551
- * @property {boolean} [restrict_checkout]
552
- * @property {string} [message]
553
- * @property {boolean} [buy_now]
554
- * @property {string} [coupon_text]
555
- * @property {string} [last_modified]
556
- * @property {number} [cart_id]
557
- * @property {CartBreakup} [breakup_values]
558
- * @property {boolean} [is_valid]
559
- * @property {string} [delivery_charge_info]
560
- * @property {string} [id]
561
- * @property {PaymentSelectionLock} [payment_selection_lock]
562
- * @property {string} [gstin]
563
- * @property {ShipmentResponse[]} [shipments]
564
- * @property {boolean} [error]
565
- * @property {ShipmentPromise} [delivery_promise]
566
- * @property {string} [uid]
567
- * @property {string} [checkout_mode]
568
- * @property {CartCurrency} [currency]
569
- */
570
- /**
571
- * @typedef UpdateCartShipmentItem
572
- * @property {number} [quantity] - Quantity of product in shipment
573
- * @property {string} shipment_type - Shipment delivery type
574
- * @property {string} article_uid - Article mongo id
575
- */
576
- /**
577
- * @typedef UpdateCartShipmentRequest
578
- * @property {UpdateCartShipmentItem[]} shipments
579
- */
580
- /**
581
- * @typedef StaffCheckout
582
- * @property {string} first_name
583
- * @property {string} user
584
- * @property {string} [employee_code]
585
- * @property {string} _id
586
- * @property {string} last_name
587
- */
588
- /**
589
- * @typedef CustomerDetails
590
- * @property {string} mobile
591
- * @property {string} [name]
592
- * @property {string} [email]
593
- */
594
- /**
595
- * @typedef CartCheckoutCustomMeta
596
- * @property {string} value
597
- * @property {string} key
598
- */
599
- /**
600
- * @typedef Files
601
- * @property {string[]} values
602
- * @property {string} key
603
- */
604
- /**
605
- * @typedef CartPosCheckoutDetailRequest
606
- * @property {Object} [meta]
607
- * @property {number} [pick_at_store_uid]
608
- * @property {Object} [billing_address]
609
- * @property {boolean} [payment_auto_confirm]
610
- * @property {string} [callback_url]
611
- * @property {Object} [delivery_address]
612
- * @property {string} [merchant_code]
613
- * @property {string} order_type
614
- * @property {string} [id]
615
- * @property {StaffCheckout} [staff]
616
- * @property {Object} [customer_details] - Customer details
617
- * @property {string} [address_id]
618
- * @property {string} [aggregator]
619
- * @property {Object} [payment_params]
620
- * @property {string} [billing_address_id]
621
- * @property {string} payment_mode
622
- * @property {boolean} [pos]
623
- * @property {Object} [extra_meta]
624
- * @property {CartCheckoutCustomMeta[]} [custom_meta]
625
- * @property {string} [payment_identifier]
626
- * @property {number} [ordering_store]
627
- * @property {Files[]} [files] - List of file url
628
- */
629
- /**
630
- * @typedef CheckCart
631
- * @property {string} [comment]
632
- * @property {number} [delivery_charges]
633
- * @property {string} [coupon_text]
634
- * @property {string} [last_modified]
635
- * @property {boolean} [is_valid]
636
- * @property {string} [cod_message]
637
- * @property {boolean} [success]
638
- * @property {string} [id]
639
- * @property {string} [uid]
640
- * @property {string} [checkout_mode]
641
- * @property {string} [error_message]
642
- * @property {Object[]} [store_emps]
643
- * @property {string} [store_code]
644
- * @property {boolean} [restrict_checkout]
645
- * @property {string} [message]
646
- * @property {boolean} [buy_now]
647
- * @property {boolean} [cod_available]
648
- * @property {number} [cart_id]
649
- * @property {CartBreakup} [breakup_values]
650
- * @property {string} [order_id]
651
- * @property {number} [cod_charges]
652
- * @property {string} [delivery_charge_info]
653
- * @property {string} [user_type]
654
- * @property {PaymentSelectionLock} [payment_selection_lock]
655
- * @property {string} [gstin]
656
- * @property {ShipmentPromise} [delivery_promise]
657
- * @property {CartProductInfo[]} [items]
658
- * @property {CartCurrency} [currency]
659
- * @property {number} [delivery_charge_order_value]
660
- */
661
- /**
662
- * @typedef CartCheckoutResponse
663
- * @property {CheckCart} [cart]
664
- * @property {string} [app_intercept_url]
665
- * @property {string} [callback_url]
666
- * @property {string} [message]
667
- * @property {Object} [data]
668
- * @property {string} [order_id]
669
- * @property {boolean} [success]
670
- * @property {string} [payment_confirm_url]
671
- */
672
- /**
673
- * @typedef GiftDetail
674
- * @property {string} [gift_message]
675
- * @property {boolean} [is_gift_applied]
676
- */
677
- /**
678
- * @typedef ArticleGiftDetail
679
- * @property {GiftDetail} [article_id]
680
- */
681
- /**
682
- * @typedef CartMetaRequest
683
- * @property {string} [comment]
684
- * @property {string} [gstin]
685
- * @property {Object} [pick_up_customer_details] - Customer contact details for
686
- * customer pickup at store
687
- * @property {string} [checkout_mode]
688
- * @property {ArticleGiftDetail} [gift_details]
689
- * @property {Object} [delivery_slots]
690
- */
691
- /**
692
- * @typedef CartMetaResponse
693
- * @property {string} [message]
694
- * @property {boolean} [is_valid]
695
- */
696
- /**
697
- * @typedef CartMetaMissingResponse
698
- * @property {string[]} [errors]
699
- */
700
- /**
701
- * @typedef CartDeliveryModesResponse
702
- * @property {string[]} [available_modes] - Available delivery modes
703
- * @property {number[]} [pickup_stores] - Store pick up available store uids
704
- */
705
- /**
706
- * @typedef PickupStoreDetail
707
- * @property {string} [city]
708
- * @property {string} [address_type]
709
- * @property {string} [address]
710
- * @property {string} [state]
711
- * @property {string} [store_code]
712
- * @property {number} [uid]
713
- * @property {number} [pincode]
714
- * @property {string} [area_code_slug]
715
- * @property {string} [area_code]
716
- * @property {string} [email]
717
- * @property {string} [name]
718
- * @property {string} [landmark]
719
- * @property {string} [area]
720
- * @property {string} [country]
721
- * @property {string} [phone]
722
- * @property {number} [id]
723
- */
724
- /**
725
- * @typedef StoreDetailsResponse
726
- * @property {PickupStoreDetail[]} [items]
727
- */
728
- /**
729
- * @typedef GetShareCartLinkRequest
730
- * @property {Object} [meta] - Staff, Ordering store or any other data. This
731
- * data will be used to generate link as well as sent as shared details.
732
- * @property {string} [id] - Cart uid for generating sharing
733
- */
734
- /**
735
- * @typedef GetShareCartLinkResponse
736
- * @property {string} [share_url] - Short shareable final url
737
- * @property {string} [token] - Short url unique id
738
- */
739
- /**
740
- * @typedef SharedCartDetails
741
- * @property {Object} [meta] - Meta data sent while generating share cart link
742
- * @property {Object} [user] - User details of who generated share link
743
- * @property {string} [created_on]
744
- * @property {string} [token] - Short link id
745
- * @property {Object} [source] - Share link device and other source information
746
- */
747
- /**
748
- * @typedef SharedCart
749
- * @property {string} [comment]
750
- * @property {string} [coupon_text]
751
- * @property {string} [last_modified]
752
- * @property {SharedCartDetails} [shared_cart_details]
753
- * @property {boolean} [is_valid]
754
- * @property {string} [id]
755
- * @property {string} [uid]
756
- * @property {string} [checkout_mode]
757
- * @property {boolean} [restrict_checkout]
758
- * @property {string} [message]
759
- * @property {boolean} [buy_now]
760
- * @property {number} [cart_id]
761
- * @property {CartBreakup} [breakup_values]
762
- * @property {string} [delivery_charge_info]
763
- * @property {PaymentSelectionLock} [payment_selection_lock]
764
- * @property {string} [gstin]
765
- * @property {ShipmentPromise} [delivery_promise]
766
- * @property {CartProductInfo[]} [items]
767
- * @property {CartCurrency} [currency]
768
- */
769
- /**
770
- * @typedef SharedCartResponse
771
- * @property {string} [error]
772
- * @property {SharedCart} [cart]
773
- */
774
- declare class PosCartApplicationModel {
775
- }
776
- declare namespace PosCartApplicationModel {
777
- export { BuyRules, DiscountRulesApp, FreeGiftItem, AppliedFreeArticles, Ownership, AppliedPromotion, LoyaltyPoints, RawBreakup, DisplayBreakup, CouponBreakup, CartBreakup, PaymentSelectionLock, PromiseTimestamp, PromiseFormatted, PromiseISOFormat, ShipmentPromise, StoreInfo, BaseInfo, BasePrice, ArticlePriceInfo, ProductArticle, Tags, CategoryInfo, ProductImage, ActionQuery, ProductAction, CartProduct, ProductPrice, ProductPriceInfo, CouponDetails, PromoMeta, ProductAvailabilitySize, ProductAvailability, CartProductIdentifer, CartProductInfo, CartCurrency, CartDetailResponse, AddProductCart, AddCartRequest, AddCartDetailResponse, UpdateProductCart, UpdateCartRequest, UpdateCartDetailResponse, CartItemCountResponse, PageCoupon, Coupon, GetCouponResponse, ApplyCouponRequest, OfferSeller, OfferPrice, OfferItem, BulkPriceOffer, BulkPriceResponse, RewardPointRequest, GeoLocation, Address, GetAddressesResponse, SaveAddressResponse, UpdateAddressResponse, DeleteAddressResponse, SelectCartAddressRequest, UpdateCartPaymentRequest, CouponValidity, PaymentCouponValidate, ShipmentResponse, CartShipmentsResponse, UpdateCartShipmentItem, UpdateCartShipmentRequest, StaffCheckout, CustomerDetails, CartCheckoutCustomMeta, Files, CartPosCheckoutDetailRequest, CheckCart, CartCheckoutResponse, GiftDetail, ArticleGiftDetail, CartMetaRequest, CartMetaResponse, CartMetaMissingResponse, CartDeliveryModesResponse, PickupStoreDetail, StoreDetailsResponse, GetShareCartLinkRequest, GetShareCartLinkResponse, SharedCartDetails, SharedCart, SharedCartResponse };
778
- }
779
- /** @returns {BuyRules} */
780
- declare function BuyRules(): BuyRules;
781
- type BuyRules = {
782
- /**
783
- * - Cart conditions details for promotion
784
- */
785
- cart_conditions?: any;
786
- /**
787
- * - Item criteria of promotion
788
- */
789
- item_criteria?: any;
790
- };
791
- /** @returns {DiscountRulesApp} */
792
- declare function DiscountRulesApp(): DiscountRulesApp;
793
- type DiscountRulesApp = {
794
- /**
795
- * - Matched buy rules for promotion
796
- */
797
- matched_buy_rules?: string[];
798
- /**
799
- * - Offer for promotion
800
- */
801
- offer?: any;
802
- /**
803
- * - Item criteria of promotion
804
- */
805
- item_criteria?: any;
806
- /**
807
- * - Raw offer details for promotion
808
- */
809
- raw_offer?: any;
810
- };
811
- /** @returns {FreeGiftItem} */
812
- declare function FreeGiftItem(): FreeGiftItem;
813
- type FreeGiftItem = {
814
- /**
815
- * - Item slug
816
- */
817
- item_slug?: string;
818
- /**
819
- * - Item price details
820
- */
821
- item_price_details?: any;
822
- /**
823
- * - Item images URL
824
- */
825
- item_images_url?: string[];
826
- /**
827
- * - Item name
828
- */
829
- item_name?: string;
830
- /**
831
- * - Item id
832
- */
833
- item_id?: number;
834
- /**
835
- * - Item brand name
836
- */
837
- item_brand_name?: string;
838
- };
839
- /** @returns {AppliedFreeArticles} */
840
- declare function AppliedFreeArticles(): AppliedFreeArticles;
841
- type AppliedFreeArticles = {
842
- /**
843
- * - Free article quantity
844
- */
845
- quantity?: number;
846
- /**
847
- * - Parent item identifier for free article
848
- */
849
- parent_item_identifier?: string;
850
- /**
851
- * - Free article id
852
- */
853
- article_id?: string;
854
- /**
855
- * - Free gift items details
856
- */
857
- free_gift_item_details?: FreeGiftItem;
858
- };
859
- /** @returns {Ownership} */
860
- declare function Ownership(): Ownership;
861
- type Ownership = {
862
- /**
863
- * - Promo amount payable category
864
- */
865
- payable_category?: string;
866
- /**
867
- * - Promo amount bearable party
868
- */
869
- payable_by?: string;
870
- };
871
- /** @returns {AppliedPromotion} */
872
- declare function AppliedPromotion(): AppliedPromotion;
873
- type AppliedPromotion = {
874
- /**
875
- * - Promotion name of current promotion
876
- */
877
- promotion_name?: string;
878
- /**
879
- * - If applied promotion is applied on
880
- * product MRP or ESP
881
- */
882
- mrp_promotion?: boolean;
883
- /**
884
- * - Buy rules for promotions
885
- */
886
- buy_rules?: BuyRules[];
887
- /**
888
- * - Promotion type of current promotion
889
- */
890
- promotion_type?: string;
891
- /**
892
- * - Quantity of article on which
893
- * promotion is applicable
894
- */
895
- article_quantity?: number;
896
- /**
897
- * - Per unit discount amount applied with current promotion
898
- */
899
- amount?: number;
900
- /**
901
- * - Discount rules for promotions
902
- */
903
- discount_rules?: DiscountRulesApp[];
904
- /**
905
- * - Offer text of current promotion
906
- */
907
- offer_text?: string;
908
- /**
909
- * - Promotion id
910
- */
911
- promo_id?: string;
912
- /**
913
- * - Applied free
914
- * article for free gift item promotions
915
- */
916
- applied_free_articles?: AppliedFreeArticles[];
917
- /**
918
- * - Ownership of promotion
919
- */
920
- ownership?: Ownership;
921
- currency?: CartCurrency;
922
- /**
923
- * - Promotion group for the promotion
924
- */
925
- promotion_group?: string;
926
- };
927
- /** @returns {LoyaltyPoints} */
928
- declare function LoyaltyPoints(): LoyaltyPoints;
929
- type LoyaltyPoints = {
930
- description?: string;
931
- is_applied?: boolean;
932
- applicable?: number;
933
- total?: number;
934
- };
935
- /** @returns {RawBreakup} */
936
- declare function RawBreakup(): RawBreakup;
937
- type RawBreakup = {
938
- discount?: number;
939
- you_saved?: number;
940
- mrp_total?: number;
941
- gst_charges?: number;
942
- total?: number;
943
- vog?: number;
944
- coupon?: number;
945
- subtotal?: number;
946
- delivery_charge?: number;
947
- cod_charge?: number;
948
- fynd_cash?: number;
949
- gift_card?: number;
950
- convenience_fee?: number;
951
- };
952
- /** @returns {DisplayBreakup} */
953
- declare function DisplayBreakup(): DisplayBreakup;
954
- type DisplayBreakup = {
955
- currency_code?: string;
956
- currency_symbol?: string;
957
- display?: string;
958
- message?: string[];
959
- key?: string;
960
- value?: number;
961
- };
962
- /** @returns {CouponBreakup} */
963
- declare function CouponBreakup(): CouponBreakup;
964
- type CouponBreakup = {
965
- max_discount_value?: number;
966
- message?: string;
967
- is_applied?: boolean;
968
- uid?: string;
969
- type?: string;
970
- coupon_type?: string;
971
- sub_title?: string;
972
- coupon_value?: number;
973
- description?: string;
974
- code?: string;
975
- minimum_cart_value?: number;
976
- value?: number;
977
- title?: string;
978
- };
979
- /** @returns {CartBreakup} */
980
- declare function CartBreakup(): CartBreakup;
981
- type CartBreakup = {
982
- loyalty_points?: LoyaltyPoints;
983
- raw?: RawBreakup;
984
- display?: DisplayBreakup[];
985
- coupon?: CouponBreakup;
986
- };
987
- /** @returns {PaymentSelectionLock} */
988
- declare function PaymentSelectionLock(): PaymentSelectionLock;
989
- type PaymentSelectionLock = {
990
- default_options?: string;
991
- enabled?: boolean;
992
- payment_identifier?: string;
993
- };
994
- /** @returns {PromiseTimestamp} */
995
- declare function PromiseTimestamp(): PromiseTimestamp;
996
- type PromiseTimestamp = {
997
- max?: number;
998
- min?: number;
999
- };
1000
- /** @returns {PromiseFormatted} */
1001
- declare function PromiseFormatted(): PromiseFormatted;
1002
- type PromiseFormatted = {
1003
- max?: string;
1004
- min?: string;
1005
- };
1006
- /** @returns {PromiseISOFormat} */
1007
- declare function PromiseISOFormat(): PromiseISOFormat;
1008
- type PromiseISOFormat = {
1009
- /**
1010
- * - Max promise in ISO format.
1011
- */
1012
- max?: string;
1013
- /**
1014
- * - Min Promise in ISO format.
1015
- */
1016
- min?: string;
1017
- };
1018
- /** @returns {ShipmentPromise} */
1019
- declare function ShipmentPromise(): ShipmentPromise;
1020
- type ShipmentPromise = {
1021
- timestamp?: PromiseTimestamp;
1022
- formatted?: PromiseFormatted;
1023
- iso?: PromiseISOFormat;
1024
- };
1025
- /** @returns {StoreInfo} */
1026
- declare function StoreInfo(): StoreInfo;
1027
- type StoreInfo = {
1028
- uid?: number;
1029
- store_code?: string;
1030
- name?: string;
1031
- };
1032
- /** @returns {BaseInfo} */
1033
- declare function BaseInfo(): BaseInfo;
1034
- type BaseInfo = {
1035
- uid?: number;
1036
- name?: string;
1037
- };
1038
- /** @returns {BasePrice} */
1039
- declare function BasePrice(): BasePrice;
1040
- type BasePrice = {
1041
- effective?: number;
1042
- currency_code?: string;
1043
- currency_symbol?: string;
1044
- marked?: number;
1045
- };
1046
- /** @returns {ArticlePriceInfo} */
1047
- declare function ArticlePriceInfo(): ArticlePriceInfo;
1048
- type ArticlePriceInfo = {
1049
- converted?: BasePrice;
1050
- base?: BasePrice;
1051
- };
1052
- /** @returns {ProductArticle} */
1053
- declare function ProductArticle(): ProductArticle;
1054
- type ProductArticle = {
1055
- meta?: any;
1056
- store?: StoreInfo;
1057
- _custom_json?: any;
1058
- seller_identifier?: string;
1059
- identifier?: any;
1060
- quantity?: number;
1061
- seller?: BaseInfo;
1062
- mto_quantity?: number;
1063
- uid?: string;
1064
- cart_item_meta?: any;
1065
- type?: string;
1066
- price?: ArticlePriceInfo;
1067
- parent_item_identifiers?: any;
1068
- size?: string;
1069
- extra_meta?: any;
1070
- gift_card?: any;
1071
- product_group_tags?: string[];
1072
- is_gift_visible?: boolean;
1073
- /**
1074
- * - A list of article tags
1075
- */
1076
- tags?: string[];
1077
- };
1078
- /** @returns {Tags} */
1079
- declare function Tags(): Tags;
1080
- type Tags = {
1081
- tags?: any;
1082
- };
1083
- /** @returns {CategoryInfo} */
1084
- declare function CategoryInfo(): CategoryInfo;
1085
- type CategoryInfo = {
1086
- /**
1087
- * - Product Category Id
1088
- */
1089
- uid?: number;
1090
- name?: string;
1091
- };
1092
- /** @returns {ProductImage} */
1093
- declare function ProductImage(): ProductImage;
1094
- type ProductImage = {
1095
- aspect_ratio?: string;
1096
- url?: string;
1097
- secure_url?: string;
1098
- };
1099
- /** @returns {ActionQuery} */
1100
- declare function ActionQuery(): ActionQuery;
1101
- type ActionQuery = {
1102
- /**
1103
- * - Contains list of product slug
1104
- */
1105
- product_slug?: string[];
1106
- };
1107
- /** @returns {ProductAction} */
1108
- declare function ProductAction(): ProductAction;
1109
- type ProductAction = {
1110
- query?: ActionQuery;
1111
- url?: string;
1112
- type?: string;
1113
- };
1114
- /** @returns {CartProduct} */
1115
- declare function CartProduct(): CartProduct;
1116
- type CartProduct = {
1117
- teaser_tag?: Tags;
1118
- _custom_json?: any;
1119
- categories?: CategoryInfo[];
1120
- item_code?: string;
1121
- tags?: string[];
1122
- uid?: number;
1123
- type?: string;
1124
- images?: ProductImage[];
1125
- name?: string;
1126
- /**
1127
- * - Unique product url name generated via product
1128
- * name and other meta data
1129
- */
1130
- slug?: string;
1131
- action?: ProductAction;
1132
- brand?: BaseInfo;
1133
- };
1134
- /** @returns {ProductPrice} */
1135
- declare function ProductPrice(): ProductPrice;
1136
- type ProductPrice = {
1137
- effective?: number;
1138
- currency_code?: string;
1139
- currency_symbol?: string;
1140
- marked?: number;
1141
- selling?: number;
1142
- add_on?: number;
1143
- };
1144
- /** @returns {ProductPriceInfo} */
1145
- declare function ProductPriceInfo(): ProductPriceInfo;
1146
- type ProductPriceInfo = {
1147
- converted?: ProductPrice;
1148
- base?: ProductPrice;
1149
- };
1150
- /** @returns {CouponDetails} */
1151
- declare function CouponDetails(): CouponDetails;
1152
- type CouponDetails = {
1153
- discount_total_quantity?: number;
1154
- discount_single_quantity?: number;
1155
- code?: string;
1156
- };
1157
- /** @returns {PromoMeta} */
1158
- declare function PromoMeta(): PromoMeta;
1159
- type PromoMeta = {
1160
- message?: string;
1161
- };
1162
- /** @returns {ProductAvailabilitySize} */
1163
- declare function ProductAvailabilitySize(): ProductAvailabilitySize;
1164
- type ProductAvailabilitySize = {
1165
- is_available?: boolean;
1166
- value?: string;
1167
- display?: string;
1168
- };
1169
- /** @returns {ProductAvailability} */
1170
- declare function ProductAvailability(): ProductAvailability;
1171
- type ProductAvailability = {
1172
- available_sizes?: ProductAvailabilitySize[];
1173
- other_store_quantity?: number;
1174
- deliverable?: boolean;
1175
- out_of_stock?: boolean;
1176
- is_valid?: boolean;
1177
- sizes?: string[];
1178
- };
1179
- /** @returns {CartProductIdentifer} */
1180
- declare function CartProductIdentifer(): CartProductIdentifer;
1181
- type CartProductIdentifer = {
1182
- /**
1183
- * - Article idenfier generated by cart
1184
- */
1185
- identifier?: string;
1186
- };
1187
- /** @returns {CartProductInfo} */
1188
- declare function CartProductInfo(): CartProductInfo;
1189
- type CartProductInfo = {
1190
- custom_order?: any;
1191
- article?: ProductArticle;
1192
- product?: CartProduct;
1193
- quantity?: number;
1194
- moq?: any;
1195
- promotions_applied?: AppliedPromotion[];
1196
- price_per_unit?: ProductPriceInfo;
1197
- key?: string;
1198
- price?: ProductPriceInfo;
1199
- parent_item_identifiers?: any;
1200
- is_set?: boolean;
1201
- coupon_message?: string;
1202
- message?: string;
1203
- coupon?: CouponDetails;
1204
- discount?: string;
1205
- bulk_offer?: any;
1206
- promo_meta?: PromoMeta;
1207
- delivery_promise?: ShipmentPromise;
1208
- availability?: ProductAvailability;
1209
- identifiers: CartProductIdentifer;
1210
- };
1211
- /** @returns {CartCurrency} */
1212
- declare function CartCurrency(): CartCurrency;
1213
- type CartCurrency = {
1214
- symbol?: string;
1215
- /**
1216
- * - Currency code defined by ISO 4217:2015
1217
- */
1218
- code?: string;
1219
- };
1220
- /** @returns {CartDetailResponse} */
1221
- declare function CartDetailResponse(): CartDetailResponse;
1222
- type CartDetailResponse = {
1223
- comment?: string;
1224
- coupon_text?: string;
1225
- last_modified?: string;
1226
- pan_config?: any;
1227
- is_valid?: boolean;
1228
- id?: string;
1229
- applied_promo_details?: AppliedPromotion[];
1230
- checkout_mode?: string;
1231
- restrict_checkout?: boolean;
1232
- message?: string;
1233
- buy_now?: boolean;
1234
- breakup_values?: CartBreakup;
1235
- delivery_charge_info?: string;
1236
- payment_selection_lock?: PaymentSelectionLock;
1237
- gstin?: string;
1238
- delivery_promise?: ShipmentPromise;
1239
- pan_no?: string;
1240
- items?: CartProductInfo[];
1241
- currency?: CartCurrency;
1242
- };
1243
- /** @returns {AddProductCart} */
1244
- declare function AddProductCart(): AddProductCart;
1245
- type AddProductCart = {
1246
- seller_id?: number;
1247
- _custom_json?: any;
1248
- meta?: any;
1249
- display?: string;
1250
- quantity?: number;
1251
- item_size?: string;
1252
- item_id?: number;
1253
- store_id?: number;
1254
- pos?: boolean;
1255
- parent_item_identifiers?: any[];
1256
- extra_meta?: any;
1257
- product_group_tags?: string[];
1258
- article_assignment?: any;
1259
- article_id?: string;
1260
- };
1261
- /** @returns {AddCartRequest} */
1262
- declare function AddCartRequest(): AddCartRequest;
1263
- type AddCartRequest = {
1264
- items?: AddProductCart[];
1265
- new_cart?: boolean;
1266
- };
1267
- /** @returns {AddCartDetailResponse} */
1268
- declare function AddCartDetailResponse(): AddCartDetailResponse;
1269
- type AddCartDetailResponse = {
1270
- cart?: CartDetailResponse;
1271
- message?: string;
1272
- /**
1273
- * - When adding multiple items check if all
1274
- * added. True if only few are added.
1275
- */
1276
- partial?: boolean;
1277
- /**
1278
- * - True if all items are added successfully.
1279
- * False if partially added or not added.
1280
- */
1281
- success?: boolean;
1282
- };
1283
- /** @returns {UpdateProductCart} */
1284
- declare function UpdateProductCart(): UpdateProductCart;
1285
- type UpdateProductCart = {
1286
- meta?: any;
1287
- _custom_json?: any;
1288
- quantity?: number;
1289
- item_size?: string;
1290
- item_id?: number;
1291
- item_index?: number;
1292
- identifiers: CartProductIdentifer;
1293
- parent_item_identifiers?: any;
1294
- extra_meta?: any;
1295
- article_id?: string;
1296
- };
1297
- /** @returns {UpdateCartRequest} */
1298
- declare function UpdateCartRequest(): UpdateCartRequest;
1299
- type UpdateCartRequest = {
1300
- operation: string;
1301
- items?: UpdateProductCart[];
1302
- };
1303
- /** @returns {UpdateCartDetailResponse} */
1304
- declare function UpdateCartDetailResponse(): UpdateCartDetailResponse;
1305
- type UpdateCartDetailResponse = {
1306
- cart?: CartDetailResponse;
1307
- message?: string;
1308
- /**
1309
- * - True if all items are added successfully.
1310
- * False if partially added or not added.
1311
- */
1312
- success?: boolean;
1313
- };
1314
- /** @returns {CartItemCountResponse} */
1315
- declare function CartItemCountResponse(): CartItemCountResponse;
1316
- type CartItemCountResponse = {
1317
- /**
1318
- * - Item count present in cart
1319
- */
1320
- user_cart_items_count?: number;
1321
- };
1322
- /** @returns {PageCoupon} */
1323
- declare function PageCoupon(): PageCoupon;
1324
- type PageCoupon = {
1325
- has_previous?: boolean;
1326
- current?: number;
1327
- total?: number;
1328
- total_item_count?: number;
1329
- has_next?: boolean;
1330
- };
1331
- /** @returns {Coupon} */
1332
- declare function Coupon(): Coupon;
1333
- type Coupon = {
1334
- max_discount_value?: number;
1335
- coupon_code?: string;
1336
- message?: string;
1337
- is_applied?: boolean;
1338
- coupon_type?: string;
1339
- sub_title?: string;
1340
- coupon_value?: number;
1341
- is_applicable?: boolean;
1342
- description?: string;
1343
- minimum_cart_value?: number;
1344
- title?: string;
1345
- expires_on?: string;
1346
- };
1347
- /** @returns {GetCouponResponse} */
1348
- declare function GetCouponResponse(): GetCouponResponse;
1349
- type GetCouponResponse = {
1350
- page?: PageCoupon;
1351
- available_coupon_list?: Coupon[];
1352
- };
1353
- /** @returns {ApplyCouponRequest} */
1354
- declare function ApplyCouponRequest(): ApplyCouponRequest;
1355
- type ApplyCouponRequest = {
1356
- /**
1357
- * - Coupon code to be applied
1358
- */
1359
- coupon_code: string;
1360
- };
1361
- /** @returns {OfferSeller} */
1362
- declare function OfferSeller(): OfferSeller;
1363
- type OfferSeller = {
1364
- /**
1365
- * - Seller id
1366
- */
1367
- uid?: number;
1368
- name?: string;
1369
- };
1370
- /** @returns {OfferPrice} */
1371
- declare function OfferPrice(): OfferPrice;
1372
- type OfferPrice = {
1373
- /**
1374
- * - Current per unit price of product after
1375
- * existing deductions
1376
- */
1377
- effective?: number;
1378
- /**
1379
- * - Currency code for all amounts
1380
- */
1381
- currency_code?: string;
1382
- /**
1383
- * - Currency symbol for currency
1384
- */
1385
- currency_symbol?: string;
1386
- /**
1387
- * - Original price of product
1388
- */
1389
- marked?: number;
1390
- /**
1391
- * - Discounted per unit price for current
1392
- * offer object
1393
- */
1394
- bulk_effective?: number;
1395
- };
1396
- /** @returns {OfferItem} */
1397
- declare function OfferItem(): OfferItem;
1398
- type OfferItem = {
1399
- /**
1400
- * - Percentage value of discount
1401
- */
1402
- margin?: number;
1403
- /**
1404
- * - Quantity on which offer is applicable
1405
- */
1406
- quantity?: number;
1407
- /**
1408
- * - Total price of offer quantity with discount
1409
- */
1410
- total?: number;
1411
- /**
1412
- * - Is true for best offer from all offers present
1413
- * for all sellers
1414
- */
1415
- best?: boolean;
1416
- /**
1417
- * - Offer type
1418
- */
1419
- type?: string;
1420
- price?: OfferPrice;
1421
- /**
1422
- * - Whether offer discount is auto applied in cart
1423
- */
1424
- auto_applied?: boolean;
1425
- };
1426
- /** @returns {BulkPriceOffer} */
1427
- declare function BulkPriceOffer(): BulkPriceOffer;
1428
- type BulkPriceOffer = {
1429
- seller?: OfferSeller;
1430
- offers?: OfferItem[];
1431
- };
1432
- /** @returns {BulkPriceResponse} */
1433
- declare function BulkPriceResponse(): BulkPriceResponse;
1434
- type BulkPriceResponse = {
1435
- /**
1436
- * - Consist of offers from multiple seller
1437
- */
1438
- data?: BulkPriceOffer[];
1439
- };
1440
- /** @returns {RewardPointRequest} */
1441
- declare function RewardPointRequest(): RewardPointRequest;
1442
- type RewardPointRequest = {
1443
- points: boolean;
1444
- };
1445
- /** @returns {GeoLocation} */
1446
- declare function GeoLocation(): GeoLocation;
1447
- type GeoLocation = {
1448
- latitude?: number;
1449
- longitude?: number;
1450
- };
1451
- /** @returns {Address} */
1452
- declare function Address(): Address;
1453
- type Address = {
1454
- meta?: any;
1455
- country_code?: string;
1456
- country_iso_code?: string;
1457
- country?: string;
1458
- id?: string;
1459
- checkout_mode?: string;
1460
- created_by_user_id?: string;
1461
- area?: string;
1462
- is_active?: boolean;
1463
- city?: string;
1464
- sector?: string;
1465
- /**
1466
- * - State code for international address
1467
- */
1468
- state_code?: string;
1469
- address_type?: string;
1470
- state?: string;
1471
- is_default_address?: boolean;
1472
- _custom_json?: any;
1473
- country_phone_code?: string;
1474
- area_code_slug?: string;
1475
- area_code?: string;
1476
- email?: string;
1477
- google_map_point?: any;
1478
- geo_location?: GeoLocation;
1479
- address?: string;
1480
- tags?: string[];
1481
- name?: string;
1482
- landmark?: string;
1483
- user_id?: string;
1484
- phone?: string;
1485
- };
1486
- /** @returns {GetAddressesResponse} */
1487
- declare function GetAddressesResponse(): GetAddressesResponse;
1488
- type GetAddressesResponse = {
1489
- pii_masking?: boolean;
1490
- address?: Address[];
1491
- };
1492
- /** @returns {SaveAddressResponse} */
1493
- declare function SaveAddressResponse(): SaveAddressResponse;
1494
- type SaveAddressResponse = {
1495
- is_default_address?: boolean;
1496
- success?: boolean;
1497
- id?: string;
1498
- };
1499
- /** @returns {UpdateAddressResponse} */
1500
- declare function UpdateAddressResponse(): UpdateAddressResponse;
1501
- type UpdateAddressResponse = {
1502
- is_updated?: boolean;
1503
- is_default_address?: boolean;
1504
- success?: boolean;
1505
- id?: string;
1506
- };
1507
- /** @returns {DeleteAddressResponse} */
1508
- declare function DeleteAddressResponse(): DeleteAddressResponse;
1509
- type DeleteAddressResponse = {
1510
- is_deleted?: boolean;
1511
- id?: string;
1512
- };
1513
- /** @returns {SelectCartAddressRequest} */
1514
- declare function SelectCartAddressRequest(): SelectCartAddressRequest;
1515
- type SelectCartAddressRequest = {
1516
- billing_address_id?: string;
1517
- cart_id?: string;
1518
- id?: string;
1519
- };
1520
- /** @returns {UpdateCartPaymentRequest} */
1521
- declare function UpdateCartPaymentRequest(): UpdateCartPaymentRequest;
1522
- type UpdateCartPaymentRequest = {
1523
- payment_identifier?: string;
1524
- aggregator_name?: string;
1525
- address_id?: string;
1526
- merchant_code?: string;
1527
- payment_mode?: string;
1528
- id?: string;
1529
- };
1530
- /** @returns {CouponValidity} */
1531
- declare function CouponValidity(): CouponValidity;
1532
- type CouponValidity = {
1533
- discount?: number;
1534
- valid?: boolean;
1535
- next_validation_required?: boolean;
1536
- display_message_en?: string;
1537
- code?: string;
1538
- title?: string;
1539
- };
1540
- /** @returns {PaymentCouponValidate} */
1541
- declare function PaymentCouponValidate(): PaymentCouponValidate;
1542
- type PaymentCouponValidate = {
1543
- message?: string;
1544
- success: boolean;
1545
- coupon_validity?: CouponValidity;
1546
- };
1547
- /** @returns {ShipmentResponse} */
1548
- declare function ShipmentResponse(): ShipmentResponse;
1549
- type ShipmentResponse = {
1550
- shipments?: number;
1551
- fulfillment_type?: string;
1552
- promise?: ShipmentPromise;
1553
- dp_id?: string;
1554
- box_type?: string;
1555
- dp_options?: any;
1556
- items?: CartProductInfo[];
1557
- order_type?: string;
1558
- shipment_type?: string;
1559
- fulfillment_id?: number;
1560
- };
1561
- /** @returns {CartShipmentsResponse} */
1562
- declare function CartShipmentsResponse(): CartShipmentsResponse;
1563
- type CartShipmentsResponse = {
1564
- comment?: string;
1565
- restrict_checkout?: boolean;
1566
- message?: string;
1567
- buy_now?: boolean;
1568
- coupon_text?: string;
1569
- last_modified?: string;
1570
- cart_id?: number;
1571
- breakup_values?: CartBreakup;
1572
- is_valid?: boolean;
1573
- delivery_charge_info?: string;
1574
- id?: string;
1575
- payment_selection_lock?: PaymentSelectionLock;
1576
- gstin?: string;
1577
- shipments?: ShipmentResponse[];
1578
- error?: boolean;
1579
- delivery_promise?: ShipmentPromise;
1580
- uid?: string;
1581
- checkout_mode?: string;
1582
- currency?: CartCurrency;
1583
- };
1584
- /** @returns {UpdateCartShipmentItem} */
1585
- declare function UpdateCartShipmentItem(): UpdateCartShipmentItem;
1586
- type UpdateCartShipmentItem = {
1587
- /**
1588
- * - Quantity of product in shipment
1589
- */
1590
- quantity?: number;
1591
- /**
1592
- * - Shipment delivery type
1593
- */
1594
- shipment_type: string;
1595
- /**
1596
- * - Article mongo id
1597
- */
1598
- article_uid: string;
1599
- };
1600
- /** @returns {UpdateCartShipmentRequest} */
1601
- declare function UpdateCartShipmentRequest(): UpdateCartShipmentRequest;
1602
- type UpdateCartShipmentRequest = {
1603
- shipments: UpdateCartShipmentItem[];
1604
- };
1605
- /** @returns {StaffCheckout} */
1606
- declare function StaffCheckout(): StaffCheckout;
1607
- type StaffCheckout = {
1608
- first_name: string;
1609
- user: string;
1610
- employee_code?: string;
1611
- _id: string;
1612
- last_name: string;
1613
- };
1614
- /** @returns {CustomerDetails} */
1615
- declare function CustomerDetails(): CustomerDetails;
1616
- type CustomerDetails = {
1617
- mobile: string;
1618
- name?: string;
1619
- email?: string;
1620
- };
1621
- /** @returns {CartCheckoutCustomMeta} */
1622
- declare function CartCheckoutCustomMeta(): CartCheckoutCustomMeta;
1623
- type CartCheckoutCustomMeta = {
1624
- value: string;
1625
- key: string;
1626
- };
1627
- /** @returns {Files} */
1628
- declare function Files(): Files;
1629
- type Files = {
1630
- values: string[];
1631
- key: string;
1632
- };
1633
- /** @returns {CartPosCheckoutDetailRequest} */
1634
- declare function CartPosCheckoutDetailRequest(): CartPosCheckoutDetailRequest;
1635
- type CartPosCheckoutDetailRequest = {
1636
- meta?: any;
1637
- pick_at_store_uid?: number;
1638
- billing_address?: any;
1639
- payment_auto_confirm?: boolean;
1640
- callback_url?: string;
1641
- delivery_address?: any;
1642
- merchant_code?: string;
1643
- order_type: string;
1644
- id?: string;
1645
- staff?: StaffCheckout;
1646
- /**
1647
- * - Customer details
1648
- */
1649
- customer_details?: any;
1650
- address_id?: string;
1651
- aggregator?: string;
1652
- payment_params?: any;
1653
- billing_address_id?: string;
1654
- payment_mode: string;
1655
- pos?: boolean;
1656
- extra_meta?: any;
1657
- custom_meta?: CartCheckoutCustomMeta[];
1658
- payment_identifier?: string;
1659
- ordering_store?: number;
1660
- /**
1661
- * - List of file url
1662
- */
1663
- files?: Files[];
1664
- };
1665
- /** @returns {CheckCart} */
1666
- declare function CheckCart(): CheckCart;
1667
- type CheckCart = {
1668
- comment?: string;
1669
- delivery_charges?: number;
1670
- coupon_text?: string;
1671
- last_modified?: string;
1672
- is_valid?: boolean;
1673
- cod_message?: string;
1674
- success?: boolean;
1675
- id?: string;
1676
- uid?: string;
1677
- checkout_mode?: string;
1678
- error_message?: string;
1679
- store_emps?: any[];
1680
- store_code?: string;
1681
- restrict_checkout?: boolean;
1682
- message?: string;
1683
- buy_now?: boolean;
1684
- cod_available?: boolean;
1685
- cart_id?: number;
1686
- breakup_values?: CartBreakup;
1687
- order_id?: string;
1688
- cod_charges?: number;
1689
- delivery_charge_info?: string;
1690
- user_type?: string;
1691
- payment_selection_lock?: PaymentSelectionLock;
1692
- gstin?: string;
1693
- delivery_promise?: ShipmentPromise;
1694
- items?: CartProductInfo[];
1695
- currency?: CartCurrency;
1696
- delivery_charge_order_value?: number;
1697
- };
1698
- /** @returns {CartCheckoutResponse} */
1699
- declare function CartCheckoutResponse(): CartCheckoutResponse;
1700
- type CartCheckoutResponse = {
1701
- cart?: CheckCart;
1702
- app_intercept_url?: string;
1703
- callback_url?: string;
1704
- message?: string;
1705
- data?: any;
1706
- order_id?: string;
1707
- success?: boolean;
1708
- payment_confirm_url?: string;
1709
- };
1710
- /** @returns {GiftDetail} */
1711
- declare function GiftDetail(): GiftDetail;
1712
- type GiftDetail = {
1713
- gift_message?: string;
1714
- is_gift_applied?: boolean;
1715
- };
1716
- /** @returns {ArticleGiftDetail} */
1717
- declare function ArticleGiftDetail(): ArticleGiftDetail;
1718
- type ArticleGiftDetail = {
1719
- article_id?: GiftDetail;
1720
- };
1721
- /** @returns {CartMetaRequest} */
1722
- declare function CartMetaRequest(): CartMetaRequest;
1723
- type CartMetaRequest = {
1724
- comment?: string;
1725
- gstin?: string;
1726
- /**
1727
- * - Customer contact details for
1728
- * customer pickup at store
1729
- */
1730
- pick_up_customer_details?: any;
1731
- checkout_mode?: string;
1732
- gift_details?: ArticleGiftDetail;
1733
- delivery_slots?: any;
1734
- };
1735
- /** @returns {CartMetaResponse} */
1736
- declare function CartMetaResponse(): CartMetaResponse;
1737
- type CartMetaResponse = {
1738
- message?: string;
1739
- is_valid?: boolean;
1740
- };
1741
- /** @returns {CartMetaMissingResponse} */
1742
- declare function CartMetaMissingResponse(): CartMetaMissingResponse;
1743
- type CartMetaMissingResponse = {
1744
- errors?: string[];
1745
- };
1746
- /** @returns {CartDeliveryModesResponse} */
1747
- declare function CartDeliveryModesResponse(): CartDeliveryModesResponse;
1748
- type CartDeliveryModesResponse = {
1749
- /**
1750
- * - Available delivery modes
1751
- */
1752
- available_modes?: string[];
1753
- /**
1754
- * - Store pick up available store uids
1755
- */
1756
- pickup_stores?: number[];
1757
- };
1758
- /** @returns {PickupStoreDetail} */
1759
- declare function PickupStoreDetail(): PickupStoreDetail;
1760
- type PickupStoreDetail = {
1761
- city?: string;
1762
- address_type?: string;
1763
- address?: string;
1764
- state?: string;
1765
- store_code?: string;
1766
- uid?: number;
1767
- pincode?: number;
1768
- area_code_slug?: string;
1769
- area_code?: string;
1770
- email?: string;
1771
- name?: string;
1772
- landmark?: string;
1773
- area?: string;
1774
- country?: string;
1775
- phone?: string;
1776
- id?: number;
1777
- };
1778
- /** @returns {StoreDetailsResponse} */
1779
- declare function StoreDetailsResponse(): StoreDetailsResponse;
1780
- type StoreDetailsResponse = {
1781
- items?: PickupStoreDetail[];
1782
- };
1783
- /** @returns {GetShareCartLinkRequest} */
1784
- declare function GetShareCartLinkRequest(): GetShareCartLinkRequest;
1785
- type GetShareCartLinkRequest = {
1786
- /**
1787
- * - Staff, Ordering store or any other data. This
1788
- * data will be used to generate link as well as sent as shared details.
1789
- */
1790
- meta?: any;
1791
- /**
1792
- * - Cart uid for generating sharing
1793
- */
1794
- id?: string;
1795
- };
1796
- /** @returns {GetShareCartLinkResponse} */
1797
- declare function GetShareCartLinkResponse(): GetShareCartLinkResponse;
1798
- type GetShareCartLinkResponse = {
1799
- /**
1800
- * - Short shareable final url
1801
- */
1802
- share_url?: string;
1803
- /**
1804
- * - Short url unique id
1805
- */
1806
- token?: string;
1807
- };
1808
- /** @returns {SharedCartDetails} */
1809
- declare function SharedCartDetails(): SharedCartDetails;
1810
- type SharedCartDetails = {
1811
- /**
1812
- * - Meta data sent while generating share cart link
1813
- */
1814
- meta?: any;
1815
- /**
1816
- * - User details of who generated share link
1817
- */
1818
- user?: any;
1819
- created_on?: string;
1820
- /**
1821
- * - Short link id
1822
- */
1823
- token?: string;
1824
- /**
1825
- * - Share link device and other source information
1826
- */
1827
- source?: any;
1828
- };
1829
- /** @returns {SharedCart} */
1830
- declare function SharedCart(): SharedCart;
1831
- type SharedCart = {
1832
- comment?: string;
1833
- coupon_text?: string;
1834
- last_modified?: string;
1835
- shared_cart_details?: SharedCartDetails;
1836
- is_valid?: boolean;
1837
- id?: string;
1838
- uid?: string;
1839
- checkout_mode?: string;
1840
- restrict_checkout?: boolean;
1841
- message?: string;
1842
- buy_now?: boolean;
1843
- cart_id?: number;
1844
- breakup_values?: CartBreakup;
1845
- delivery_charge_info?: string;
1846
- payment_selection_lock?: PaymentSelectionLock;
1847
- gstin?: string;
1848
- delivery_promise?: ShipmentPromise;
1849
- items?: CartProductInfo[];
1850
- currency?: CartCurrency;
1851
- };
1852
- /** @returns {SharedCartResponse} */
1853
- declare function SharedCartResponse(): SharedCartResponse;
1854
- type SharedCartResponse = {
1855
- error?: string;
1856
- cart?: SharedCart;
1857
- };