@gofynd/fdk-client-javascript 1.4.0-beta.1 → 1.4.0-beta.2

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 (36) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +2 -0
  4. package/sdk/application/Cart/CartApplicationModel.js +2 -0
  5. package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
  6. package/sdk/application/Order/OrderApplicationModel.js +2 -0
  7. package/sdk/partner/Theme/ThemePartnerModel.d.ts +185 -315
  8. package/sdk/partner/Theme/ThemePartnerModel.js +182 -222
  9. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -12
  10. package/sdk/platform/Catalog/CatalogPlatformClient.js +17 -87
  11. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +11 -25
  12. package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -17
  13. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -1
  14. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -1
  15. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +5 -0
  16. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +2 -0
  17. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -0
  18. package/sdk/platform/Discount/DiscountPlatformModel.js +2 -0
  19. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -44
  20. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +120 -54
  21. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -12
  22. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -85
  23. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -12
  24. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -14
  25. package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -61
  26. package/sdk/platform/Order/OrderPlatformClient.js +87 -481
  27. package/sdk/platform/Order/OrderPlatformModel.d.ts +442 -171
  28. package/sdk/platform/Order/OrderPlatformModel.js +483 -169
  29. package/sdk/platform/Order/OrderPlatformValidator.d.ts +22 -69
  30. package/sdk/platform/Order/OrderPlatformValidator.js +17 -79
  31. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -21
  32. package/sdk/platform/Theme/ThemePlatformModel.js +108 -20
  33. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +2 -2
  34. package/sdk/platform/Webhook/WebhookPlatformClient.js +4 -2
  35. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +21 -27
  36. package/sdk/platform/Webhook/WebhookPlatformModel.js +30 -27
@@ -262,46 +262,87 @@ export = OrderPlatformModel;
262
262
  * @property {boolean} is_returnable
263
263
  */
264
264
  /**
265
- * @typedef BagDetailsPlatformResponse
265
+ * @typedef BagData
266
+ * @property {BagDetails[]} [items]
267
+ * @property {BagsPage} [page]
268
+ */
269
+ /**
270
+ * @typedef BagDetails
266
271
  * @property {AffiliateBagDetails} [affiliate_bag_details]
267
272
  * @property {AffiliateDetails} [affiliate_details]
268
273
  * @property {Object[]} [applied_promos]
269
274
  * @property {Article} [article]
270
275
  * @property {ArticleStatusDetails} [article_details]
276
+ * @property {number} [bag_id]
271
277
  * @property {BagStatusHistory[]} [bag_status]
272
278
  * @property {BagStatusHistory} [bag_status_history]
273
279
  * @property {number} [bag_update_time]
274
280
  * @property {Brand} [brand]
281
+ * @property {Company} [company]
275
282
  * @property {BagStatusHistory} [current_operational_status]
276
283
  * @property {BagStatusHistory} [current_status]
277
284
  * @property {Dates} [dates]
285
+ * @property {PlatformDeliveryAddress} [delivery_address]
286
+ * @property {DeliverySlotDetails} [delivery_slot]
278
287
  * @property {string} [display_name]
288
+ * @property {Object} [dp_details]
289
+ * @property {Object} [einvoice_info]
279
290
  * @property {string} [entity_type]
291
+ * @property {Object} [fallback_user]
280
292
  * @property {FinancialBreakup[]} [financial_breakup]
293
+ * @property {Store} [fulfilling_store]
294
+ * @property {Object} [fyndstore_emp]
281
295
  * @property {GSTDetailsData} [gst_details]
282
- * @property {number} [id]
296
+ * @property {string} [id]
283
297
  * @property {string} [identifier]
298
+ * @property {InvoiceDetails} [invoice]
284
299
  * @property {Item} [item]
285
300
  * @property {string} [journey_type]
286
301
  * @property {number} [line_number]
302
+ * @property {boolean} [lock_status]
303
+ * @property {string} [manifest_id]
287
304
  * @property {Object} [meta]
305
+ * @property {string} [mode_of_payment]
288
306
  * @property {number} [no_of_bags_order]
289
307
  * @property {string} [operational_status]
308
+ * @property {OrderDetails} [order]
290
309
  * @property {string} [order_integration_id]
310
+ * @property {string} [order_type]
311
+ * @property {number} [order_value]
291
312
  * @property {Store} [ordering_store]
292
313
  * @property {number[]} [original_bag_list]
293
314
  * @property {Object} [parent_promo_bags]
315
+ * @property {Object} [payment_methods]
316
+ * @property {string} [payment_type]
317
+ * @property {Object} [payments]
294
318
  * @property {Prices} [prices]
295
- * @property {Object} [qc_required]
319
+ * @property {boolean} [qc_required]
296
320
  * @property {number} [quantity]
297
321
  * @property {Object[]} [reasons]
298
322
  * @property {boolean} [restore_coupon]
299
323
  * @property {Object} [restore_promos]
324
+ * @property {PlatformDeliveryAddress} [rto_address]
300
325
  * @property {string} [seller_identifier]
326
+ * @property {Shipment} [shipment]
327
+ * @property {ShipmentDetails} [shipment_details]
328
+ * @property {ShipmentGstDetails} [shipment_gst]
301
329
  * @property {string} [shipment_id]
330
+ * @property {ShipmentStatusData} [shipment_status]
331
+ * @property {ShipmentStatusData[]} [shipment_status_history]
302
332
  * @property {BagReturnableCancelableStatus} [status]
303
333
  * @property {string[]} [tags]
334
+ * @property {number} [total_shipment_bags]
335
+ * @property {number} [total_shipments_in_order]
336
+ * @property {string} [transaction_type]
304
337
  * @property {string} [type]
338
+ * @property {string} [updated_at]
339
+ * @property {UserDetails} [user]
340
+ * @property {WeightData} [weight]
341
+ */
342
+ /**
343
+ * @typedef BagDetailsPlatformResponse
344
+ * @property {BagDetails} [data]
345
+ * @property {number} [status_code]
305
346
  */
306
347
  /**
307
348
  * @typedef BagPaymentMethods
@@ -425,15 +466,18 @@ export = OrderPlatformModel;
425
466
  * @property {string} [address2]
426
467
  * @property {string} [alternate_email]
427
468
  * @property {string} [alternate_mobile_number]
469
+ * @property {string} [area]
428
470
  * @property {string} [city]
429
471
  * @property {string} [country]
430
472
  * @property {string} [country_code]
473
+ * @property {string} [country_iso_code] - Country Code in ISO 2 format (e.g. US, IN)
431
474
  * @property {string} [customer_code]
432
475
  * @property {string} [external_customer_code]
433
476
  * @property {string} [first_name]
434
477
  * @property {string} [floor_no]
435
478
  * @property {string} [gender]
436
479
  * @property {string} [house_no]
480
+ * @property {string} [landmark]
437
481
  * @property {string} [last_name]
438
482
  * @property {string} [middle_name]
439
483
  * @property {string} [pincode]
@@ -445,12 +489,13 @@ export = OrderPlatformModel;
445
489
  */
446
490
  /**
447
491
  * @typedef Brand
448
- * @property {number} brand_id
492
+ * @property {number} [brand_id]
449
493
  * @property {string} brand_name
450
- * @property {string} company
451
- * @property {number} [created_on]
494
+ * @property {string} [company]
495
+ * @property {string} [created_on]
452
496
  * @property {boolean} [credit_note_allowed]
453
497
  * @property {number} [credit_note_expiry_days]
498
+ * @property {number} [id]
454
499
  * @property {string} [invoice_prefix]
455
500
  * @property {boolean} [is_virtual_invoice]
456
501
  * @property {string} [logo]
@@ -588,6 +633,19 @@ export = OrderPlatformModel;
588
633
  * @property {string} call_id - Call ID from the provider
589
634
  * @property {boolean} success - Success
590
635
  */
636
+ /**
637
+ * @typedef Company
638
+ * @property {string} [agreement_start_date]
639
+ * @property {string} [business_type]
640
+ * @property {string} [company_name]
641
+ * @property {string} [company_type]
642
+ * @property {string} [created_on]
643
+ * @property {string} [gst_number]
644
+ * @property {number} [id]
645
+ * @property {Object} [meta]
646
+ * @property {string} [modified_on]
647
+ * @property {string} [pan_no]
648
+ */
591
649
  /**
592
650
  * @typedef CompanyDetails
593
651
  * @property {Object} [address]
@@ -749,6 +807,14 @@ export = OrderPlatformModel;
749
807
  * @typedef DebugInfo
750
808
  * @property {string} [stormbreaker_uuid]
751
809
  */
810
+ /**
811
+ * @typedef DeliverySlotDetails
812
+ * @property {string} [date]
813
+ * @property {string} [lower_bound]
814
+ * @property {string} [slot]
815
+ * @property {string} [type]
816
+ * @property {string} [upper_bound]
817
+ */
752
818
  /**
753
819
  * @typedef Dimension
754
820
  * @property {string} [height]
@@ -1038,10 +1104,12 @@ export = OrderPlatformModel;
1038
1104
  /**
1039
1105
  * @typedef FulfillingStore
1040
1106
  * @property {string} address
1107
+ * @property {string} [address1]
1041
1108
  * @property {string} city
1042
1109
  * @property {string} code
1043
1110
  * @property {string} contact_person
1044
1111
  * @property {string} country
1112
+ * @property {string} [display_address]
1045
1113
  * @property {string} fulfillment_channel
1046
1114
  * @property {number} id
1047
1115
  * @property {Object} meta
@@ -1054,6 +1122,32 @@ export = OrderPlatformModel;
1054
1122
  * @typedef FyndOrderIdList
1055
1123
  * @property {string[]} [fynd_order_id]
1056
1124
  */
1125
+ /**
1126
+ * @typedef GenerateInvoiceIDErrorResponse
1127
+ * @property {GenerateInvoiceIDErrorResponseData[]} [items]
1128
+ */
1129
+ /**
1130
+ * @typedef GenerateInvoiceIDErrorResponseData
1131
+ * @property {string} [error_message]
1132
+ * @property {boolean} [invoice_id]
1133
+ * @property {string} [shipment_id]
1134
+ * @property {boolean} [success]
1135
+ */
1136
+ /**
1137
+ * @typedef GenerateInvoiceIDRequest
1138
+ * @property {string[]} shipment_ids
1139
+ */
1140
+ /**
1141
+ * @typedef GenerateInvoiceIDResponse
1142
+ * @property {GenerateInvoiceIDResponseData[]} [items]
1143
+ */
1144
+ /**
1145
+ * @typedef GenerateInvoiceIDResponseData
1146
+ * @property {boolean} [error_message]
1147
+ * @property {string} [invoice_id]
1148
+ * @property {string} [shipment_id]
1149
+ * @property {boolean} [success]
1150
+ */
1057
1151
  /**
1058
1152
  * @typedef GeneratePosOrderReceiptResponse
1059
1153
  * @property {string} [customer_cn_receipt]
@@ -1072,8 +1166,8 @@ export = OrderPlatformModel;
1072
1166
  */
1073
1167
  /**
1074
1168
  * @typedef GetBagsPlatformResponse
1075
- * @property {BagDetailsPlatformResponse[]} items
1076
- * @property {BagsPage} page
1169
+ * @property {BagData} [data]
1170
+ * @property {number} [status_code]
1077
1171
  */
1078
1172
  /**
1079
1173
  * @typedef GSTDetailsData
@@ -1173,6 +1267,13 @@ export = OrderPlatformModel;
1173
1267
  * @typedef InvalidateShipmentCacheResponse
1174
1268
  * @property {InvalidateShipmentCacheNestedResponse[]} [response]
1175
1269
  */
1270
+ /**
1271
+ * @typedef InvoiceDetails
1272
+ * @property {string} [invoice_url]
1273
+ * @property {string} [label_url]
1274
+ * @property {string} [store_invoice_id]
1275
+ * @property {string} [updated_date]
1276
+ */
1176
1277
  /**
1177
1278
  * @typedef InvoiceInfo
1178
1279
  * @property {string} [credit_note_id]
@@ -1436,8 +1537,37 @@ export = OrderPlatformModel;
1436
1537
  */
1437
1538
  /**
1438
1539
  * @typedef OrderDetails
1540
+ * @property {string} [affiliate_id]
1541
+ * @property {string} [affiliate_order_date]
1542
+ * @property {string} [affiliate_order_id]
1543
+ * @property {number} [cashback_applied]
1544
+ * @property {number} [cashback_value]
1545
+ * @property {number} [cod_charges]
1546
+ * @property {string} [collect_by]
1547
+ * @property {number} [coupon_value]
1439
1548
  * @property {string} [created_at]
1549
+ * @property {string} [created_time]
1550
+ * @property {string} [currency]
1551
+ * @property {number} [delivery_charges]
1552
+ * @property {number} [discount]
1553
+ * @property {number} [fynd_credits]
1440
1554
  * @property {string} [fynd_order_id]
1555
+ * @property {Object} [headers]
1556
+ * @property {Object} [meta]
1557
+ * @property {string} [mode_of_payment]
1558
+ * @property {number} [mongo_cart_id]
1559
+ * @property {number} [order_value]
1560
+ * @property {string} [ordering_channel]
1561
+ * @property {string} [ordering_channel_logo]
1562
+ * @property {Object} [payment_methods]
1563
+ * @property {number} [payment_mode_id]
1564
+ * @property {Prices} [prices]
1565
+ * @property {number} [promotion_effective_discount]
1566
+ * @property {string} [refund_by]
1567
+ * @property {TaxDetails} [tax_details]
1568
+ * @property {number} [total_order_value]
1569
+ * @property {string} [transaction_id]
1570
+ * @property {string} [user_id]
1441
1571
  */
1442
1572
  /**
1443
1573
  * @typedef OrderDetailsData
@@ -1487,10 +1617,12 @@ export = OrderPlatformModel;
1487
1617
  /**
1488
1618
  * @typedef OrderingStoreDetails
1489
1619
  * @property {string} [address]
1620
+ * @property {string} [address1]
1490
1621
  * @property {string} [city]
1491
1622
  * @property {string} [code]
1492
1623
  * @property {string} [contact_person]
1493
1624
  * @property {string} [country]
1625
+ * @property {string} [display_address]
1494
1626
  * @property {number} [id]
1495
1627
  * @property {Object} [meta]
1496
1628
  * @property {string} [phone]
@@ -1574,21 +1706,6 @@ export = OrderPlatformModel;
1574
1706
  * @property {number} [size] - Page size
1575
1707
  * @property {string} [type] - Type of the page
1576
1708
  */
1577
- /**
1578
- * @typedef PaginatedStates
1579
- * @property {StateManagerState[]} [items]
1580
- * @property {PaginationInfo} [page]
1581
- */
1582
- /**
1583
- * @typedef PaginationInfo
1584
- * @property {number} [current]
1585
- * @property {boolean} [has_next]
1586
- * @property {boolean} [has_previous]
1587
- * @property {number} [item_total]
1588
- * @property {number} [size]
1589
- * @property {number} [total]
1590
- * @property {string} [type]
1591
- */
1592
1709
  /**
1593
1710
  * @typedef PaymentInfo
1594
1711
  * @property {PaymentMethod[]} [payment_methods]
@@ -1665,6 +1782,7 @@ export = OrderPlatformModel;
1665
1782
  * @property {string} [contact_person]
1666
1783
  * @property {string} [country]
1667
1784
  * @property {string} [created_at]
1785
+ * @property {string} [display_address]
1668
1786
  * @property {string} [email]
1669
1787
  * @property {string} [landmark]
1670
1788
  * @property {number} [latitude]
@@ -2008,13 +2126,40 @@ export = OrderPlatformModel;
2008
2126
  */
2009
2127
  /**
2010
2128
  * @typedef Shipment
2129
+ * @property {string} [affiliate_id]
2130
+ * @property {string} [affiliate_shipment_id]
2131
+ * @property {PlatformDeliveryAddress} [billing_address_json]
2132
+ * @property {string} [created_at]
2133
+ * @property {string} [credit_note_id]
2134
+ * @property {PlatformDeliveryAddress} [delivery_address_json]
2135
+ * @property {string} [delivery_awb_number]
2136
+ * @property {string} [eway_bill_id]
2011
2137
  * @property {string} [external_shipment_id]
2138
+ * @property {number} [fulfilment_priority]
2139
+ * @property {string} [fynd_order_id]
2140
+ * @property {ShipmentGstDetails} [gst]
2141
+ * @property {PlatformDeliveryAddress} [hand_over_contact_json]
2142
+ * @property {string} [id]
2143
+ * @property {boolean} [is_active]
2012
2144
  * @property {LineItem[]} line_items
2013
2145
  * @property {number} location_id
2146
+ * @property {string} [lock_status]
2014
2147
  * @property {Object} [meta]
2015
2148
  * @property {string} [order_type]
2149
+ * @property {string} [packaging_type]
2150
+ * @property {string} [parent_id]
2151
+ * @property {string} [parent_type]
2152
+ * @property {Object} [pdf_links]
2153
+ * @property {string} [previous_shipment_id]
2154
+ * @property {Prices} [price]
2016
2155
  * @property {number} [priority]
2017
2156
  * @property {ProcessingDates} [processing_dates]
2157
+ * @property {number} [quantity]
2158
+ * @property {ShipmentStatusData} [status]
2159
+ * @property {string} [store_invoice_id]
2160
+ * @property {string[]} [tags]
2161
+ * @property {string} [type]
2162
+ * @property {string} [vertical]
2018
2163
  */
2019
2164
  /**
2020
2165
  * @typedef ShipmentActionInfo
@@ -2059,14 +2204,25 @@ export = OrderPlatformModel;
2059
2204
  */
2060
2205
  /**
2061
2206
  * @typedef ShipmentDetails
2207
+ * @property {Object} [action_to_status]
2062
2208
  * @property {string} affiliate_shipment_id
2063
2209
  * @property {ArticleDetails[]} articles
2064
2210
  * @property {string} [box_type]
2065
- * @property {number} [dp_id]
2211
+ * @property {string} [dp_id]
2212
+ * @property {Object} [dp_options]
2066
2213
  * @property {number} fulfillment_id
2214
+ * @property {boolean} [lock_status]
2067
2215
  * @property {Object} [meta]
2068
2216
  * @property {number} shipments
2069
2217
  */
2218
+ /**
2219
+ * @typedef ShipmentGstDetails
2220
+ * @property {number} [brand_calculated_amount]
2221
+ * @property {number} [gst_fee]
2222
+ * @property {number} [gstin_code]
2223
+ * @property {number} [tax_collected_at_source]
2224
+ * @property {number} [value_of_good]
2225
+ */
2070
2226
  /**
2071
2227
  * @typedef ShipmentHistoryResponse
2072
2228
  * @property {HistoryDict[]} activity_history
@@ -2124,9 +2280,11 @@ export = OrderPlatformModel;
2124
2280
  /**
2125
2281
  * @typedef ShipmentItemFulFillingStore
2126
2282
  * @property {string} [address]
2283
+ * @property {string} [address1]
2127
2284
  * @property {string[]} [brand_store_tags]
2128
2285
  * @property {string} [city]
2129
2286
  * @property {string} code
2287
+ * @property {string} [display_address]
2130
2288
  * @property {number} id
2131
2289
  * @property {string} [location_type]
2132
2290
  * @property {Object} [meta]
@@ -2263,6 +2421,7 @@ export = OrderPlatformModel;
2263
2421
  * @property {Object} [meta]
2264
2422
  * @property {string} [shipment_id]
2265
2423
  * @property {string} [status]
2424
+ * @property {string} [status_created_at]
2266
2425
  */
2267
2426
  /**
2268
2427
  * @typedef ShipmentTags
@@ -2283,9 +2442,11 @@ export = OrderPlatformModel;
2283
2442
  * @property {string} [address2]
2284
2443
  * @property {string} [alternate_email]
2285
2444
  * @property {string} [alternate_mobile_number]
2445
+ * @property {string} [area]
2286
2446
  * @property {string} [city]
2287
2447
  * @property {string} [country]
2288
2448
  * @property {string} [country_code]
2449
+ * @property {string} [country_iso_code] - Country Code in ISO 2 format (e.g. US, IN)
2289
2450
  * @property {string} [customer_code]
2290
2451
  * @property {string} [external_customer_code]
2291
2452
  * @property {string} [first_name]
@@ -2318,46 +2479,6 @@ export = OrderPlatformModel;
2318
2479
  * @property {number} phone_number - Phone number for communication
2319
2480
  * @property {number} shipment_id - ShipmentId
2320
2481
  */
2321
- /**
2322
- * @typedef StateManagerFilter
2323
- * @property {string} [default_value]
2324
- * @property {string} [description]
2325
- * @property {string} [display_name]
2326
- * @property {number} [id]
2327
- * @property {string} [name]
2328
- * @property {Object} [options]
2329
- * @property {string} [type]
2330
- */
2331
- /**
2332
- * @typedef StateManagerState
2333
- * @property {string} [app_display_name] - The application display name
2334
- * @property {boolean} [app_facing] - Whether state is for app facing or not
2335
- * @property {number} [id] - Unique identifier for the state
2336
- * @property {boolean} [is_active] - Whether state is active or not
2337
- * @property {string} [journey_type] - Type of the journey
2338
- * @property {string} [platform_display_name] - The platform display name
2339
- * @property {string} [state] - The name of the state
2340
- * @property {string} [state_type] - Type of the state
2341
- */
2342
- /**
2343
- * @typedef StateManagerTask
2344
- * @property {string} [description]
2345
- * @property {string} [display_name]
2346
- * @property {string} [doc_string]
2347
- * @property {number} [id]
2348
- * @property {Object} [kwargs]
2349
- * @property {string} [name]
2350
- */
2351
- /**
2352
- * @typedef StateTransitionFlag
2353
- * @property {string} [default_value]
2354
- * @property {string} [description]
2355
- * @property {string} [display_name]
2356
- * @property {number} [id]
2357
- * @property {string} [name]
2358
- * @property {Object} [options]
2359
- * @property {string} [type]
2360
- */
2361
2482
  /**
2362
2483
  * @typedef StatuesRequest
2363
2484
  * @property {string} [exclude_bags_next_state] - State to be change for
@@ -2375,7 +2496,6 @@ export = OrderPlatformModel;
2375
2496
  * @property {string} address1
2376
2497
  * @property {string} [address2]
2377
2498
  * @property {number} [alohomora_user_id]
2378
- * @property {Object} [brand_id]
2379
2499
  * @property {string[]} [brand_store_tags]
2380
2500
  * @property {string} city
2381
2501
  * @property {string} [code]
@@ -2383,14 +2503,15 @@ export = OrderPlatformModel;
2383
2503
  * @property {string} contact_person
2384
2504
  * @property {string} country
2385
2505
  * @property {string} created_at
2506
+ * @property {string} [display_address]
2386
2507
  * @property {string} fulfillment_channel
2387
2508
  * @property {boolean} [is_active]
2388
2509
  * @property {boolean} [is_archived]
2389
2510
  * @property {boolean} [is_enabled_for_recon]
2390
- * @property {number} latitude
2511
+ * @property {number} [latitude]
2391
2512
  * @property {string} location_type
2392
- * @property {string} login_username
2393
- * @property {number} longitude
2513
+ * @property {string} [login_username]
2514
+ * @property {number} [longitude]
2394
2515
  * @property {string} [mall_area]
2395
2516
  * @property {string} [mall_name]
2396
2517
  * @property {StoreMeta} meta
@@ -2400,7 +2521,7 @@ export = OrderPlatformModel;
2400
2521
  * @property {number} [parent_store_id]
2401
2522
  * @property {number} phone
2402
2523
  * @property {string} pincode
2403
- * @property {string} s_id
2524
+ * @property {string} [s_id]
2404
2525
  * @property {string} state
2405
2526
  * @property {string} [store_active_from]
2406
2527
  * @property {StoreAddress} [store_address_json]
@@ -2420,6 +2541,7 @@ export = OrderPlatformModel;
2420
2541
  * @property {string} country
2421
2542
  * @property {string} country_code
2422
2543
  * @property {string} created_at
2544
+ * @property {string} [display_address]
2423
2545
  * @property {string} [email]
2424
2546
  * @property {string} [landmark]
2425
2547
  * @property {number} latitude
@@ -2609,6 +2731,19 @@ export = OrderPlatformModel;
2609
2731
  * @property {number} [uid]
2610
2732
  * @property {string} [user_oid]
2611
2733
  */
2734
+ /**
2735
+ * @typedef UserDetails
2736
+ * @property {string} [email]
2737
+ * @property {string} [external_customer_id]
2738
+ * @property {string} [first_name]
2739
+ * @property {string} [gender]
2740
+ * @property {boolean} [is_anonymous_user]
2741
+ * @property {string} [last_name]
2742
+ * @property {Object} [meta]
2743
+ * @property {string} [mobile]
2744
+ * @property {string} [mongo_user_id]
2745
+ * @property {string} [user_oid]
2746
+ */
2612
2747
  /**
2613
2748
  * @typedef UserDetailsData
2614
2749
  * @property {string} address
@@ -2619,6 +2754,7 @@ export = OrderPlatformModel;
2619
2754
  * @property {string} country
2620
2755
  * @property {string} [country_iso_code]
2621
2756
  * @property {string} [country_phone_code]
2757
+ * @property {string} [display_address]
2622
2758
  * @property {string} [email]
2623
2759
  * @property {string} [landmark]
2624
2760
  * @property {string} name
@@ -2668,10 +2804,15 @@ export = OrderPlatformModel;
2668
2804
  * @property {number} [shipping]
2669
2805
  * @property {string} [unit]
2670
2806
  */
2807
+ /**
2808
+ * @typedef WeightData
2809
+ * @property {string} [unit]
2810
+ * @property {number} [value]
2811
+ */
2671
2812
  declare class OrderPlatformModel {
2672
2813
  }
2673
2814
  declare namespace OrderPlatformModel {
2674
- export { ActionInfo, AdvanceFilterInfo, Affiliate, AffiliateAppConfig, AffiliateAppConfigMeta, AffiliateBag, AffiliateBagDetails, AffiliateBagsDetails, AffiliateConfig, AffiliateDetails, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryOrderConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateMeta, AffiliateStoreIdMapping, AllowedTemplatesResponse, AnnouncementResponse, AnnouncementsResponse, AppliedPromos, Article, ArticleDetails, ArticleStatusDetails, AttachOrderUser, AttachOrderUserResponse, AttachUserInfo, AttachUserOtpData, Attributes, BagConfigs, BagDetailsPlatformResponse, BagPaymentMethods, BagReasonMeta, BagReasons, BagReturnableCancelableStatus, Bags, BagsPage, BagStateMapper, BagStateTransitionMap, BagStatusHistory, BagUnit, BaseResponse, BillingInfo, Brand, BulkActionListingData, BulkActionTemplate, BulkActionTemplateResponse, BulkFailedResponse, BulkListingResponse, BulkListinPage, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, BuyerDetails, BuyRules, Charge, CheckResponse, Click2CallResponse, CompanyDetails, ContactDetails, ConversionRate, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, CreateChannelConfig, CreateChannelConfigData, CreateChannelConfigResponse, CreateChannelConifgErrorResponse, CreateChannelPaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, CreateOrderPayload, CreateOrderResponse, CreditBalanceInfo, Currency, CurrencyInfo, CurrentStatus, DataUpdates, DateRange, Dates, DebugInfo, Dimension, Dimensions, DiscountRules, DispatchManifest, Document, DpConfiguration, DPDetailsData, EInvoiceDetails, EInvoiceErrorDetails, EInvoiceErrorInfo, EInvoiceErrorResponse, EInvoiceErrorResponseData, EInvoiceErrorResponseDetails, EinvoiceInfo, EInvoiceIrnDetails, EInvoicePortalDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceRetryShipmentData, Entities, EntitiesDataUpdates, EntitiesReasons, EntityReasonData, Error, ErrorDetail, ErrorResponse, FailedOrderLogDetails, FailedOrderLogs, FailedOrdersItem, FetchCreditBalanceRequestPayload, FetchCreditBalanceResponsePayload, FileResponse, FilterInfoOption, Filters, FiltersInfo, FiltersRequest, FiltersResponse, FinancialBreakup, Formatted, FulfillingStore, FyndOrderIdList, GeneratePosOrderReceiptResponse, GetActionsResponse, GetBagsPlatformResponse, GSTDetailsData, HistoryDict, HistoryMeta, HistoryReason, Identifier, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCachePayload, InvalidateShipmentCacheResponse, InvoiceInfo, Item, ItemCriterias, JobDetailsData, JobDetailsResponse, JobFailedResponse, LaneConfigResponse, LineItem, LocationDetails, LockData, LogPaymentDetails, LogsChannelDetails, Manifest, ManifestDetails, ManifestFile, ManifestFiltersResponse, ManifestItemDetails, ManifestList, ManifestMediaUpdate, ManifestMeta, ManifestPageInfo, ManifestShipmentListing, MarketPlacePdf, Meta, OrderBagArticle, OrderBags, OrderBrandName, OrderConfig, OrderData, OrderDetails, OrderDetailsData, OrderDetailsResponse, OrderInfo, OrderingCurrency, OrderingStoreDetails, OrderItemDataUpdates, OrderListingResponse, OrderPriority, OrderStatus, OrderStatusData, OrderStatusResult, OrderUser, OriginalFilter, Page, PageDetails, PaginatedStates, PaginationInfo, PaymentInfo, PaymentMethod, PaymentMethods, PDFLinks, PDFMeta, PhoneDetails, PlatformArticleAttributes, PlatformBreakupValues, PlatformChannel, PlatformDeliveryAddress, PlatformItem, PlatformOrderItems, PlatformOrderUpdate, PlatformShipment, PlatformShipmentReasonsResponse, PlatformShipmentTrack, PlatformTrack, PointBlankOtpData, PostActivityHistory, PostHistoryData, PostHistoryDict, PostHistoryFilters, PostShipmentHistory, Prices, ProcessingDates, ProcessManifest, ProcessManifestItemResponse, ProcessManifestResponse, Products, ProductsDataUpdates, ProductsDataUpdatesFilters, ProductsReasons, ProductsReasonsData, ProductsReasonsFilters, QuestionSet, Reason, ReasonsData, RefundModeConfigRequestPayload, RefundModeConfigResponsePayload, RefundModeInfo, RefundOption, ReplacementDetails, ResponseDetail, ReturnConfig, RoleBaseStateTransitionMapping, SendSmsPayload, SendUserMobileOTP, SendUserMobileOtpResponse, Shipment, ShipmentActionInfo, ShipmentBagReasons, ShipmentConfig, ShipmentData, ShipmentDetail, ShipmentDetails, ShipmentHistoryResponse, ShipmentInfoResponse, ShipmentInternalPlatformViewResponse, ShipmentItem, ShipmentItemFulFillingStore, ShipmentListingBrand, ShipmentListingChannel, ShipmentLockDetails, ShipmentMeta, ShipmentPayments, ShipmentReasonsResponse, ShipmentResponseReasons, ShipmentsRequest, ShipmentsResponse, ShipmentStatus, ShipmentStatusData, ShipmentTags, ShipmentTimeStamp, ShippingInfo, SmsDataPayload, StateManagerFilter, StateManagerState, StateManagerTask, StateTransitionFlag, StatuesRequest, StatuesResponse, Store, StoreAddress, StoreDocuments, StoreEinvoice, StoreEwaybill, StoreGstCredentials, StoreMeta, StoreReassign, StoreReassignResponse, SubLane, SuccessResponse, SuperLane, Tax, TaxDetails, TaxInfo, TemplateDownloadResponse, Templates, TotalShipmentPricesCount, TrackingList, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, UpdateShipmentLockPayload, UpdateShipmentLockResponse, UpdateShipmentStatusRequest, UpdateShipmentStatusResponseBody, UploadConsent, URL, UserData, UserDataInfo, UserDetailsData, UserInfo, VerifyMobileOTP, VerifyOtpData, VerifyOtpResponse, VerifyOtpResponseData, Weight };
2815
+ export { ActionInfo, AdvanceFilterInfo, Affiliate, AffiliateAppConfig, AffiliateAppConfigMeta, AffiliateBag, AffiliateBagDetails, AffiliateBagsDetails, AffiliateConfig, AffiliateDetails, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryOrderConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateMeta, AffiliateStoreIdMapping, AllowedTemplatesResponse, AnnouncementResponse, AnnouncementsResponse, AppliedPromos, Article, ArticleDetails, ArticleStatusDetails, AttachOrderUser, AttachOrderUserResponse, AttachUserInfo, AttachUserOtpData, Attributes, BagConfigs, BagData, BagDetails, BagDetailsPlatformResponse, BagPaymentMethods, BagReasonMeta, BagReasons, BagReturnableCancelableStatus, Bags, BagsPage, BagStateMapper, BagStateTransitionMap, BagStatusHistory, BagUnit, BaseResponse, BillingInfo, Brand, BulkActionListingData, BulkActionTemplate, BulkActionTemplateResponse, BulkFailedResponse, BulkListingResponse, BulkListinPage, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, BuyerDetails, BuyRules, Charge, CheckResponse, Click2CallResponse, Company, CompanyDetails, ContactDetails, ConversionRate, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, CreateChannelConfig, CreateChannelConfigData, CreateChannelConfigResponse, CreateChannelConifgErrorResponse, CreateChannelPaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, CreateOrderPayload, CreateOrderResponse, CreditBalanceInfo, Currency, CurrencyInfo, CurrentStatus, DataUpdates, DateRange, Dates, DebugInfo, DeliverySlotDetails, Dimension, Dimensions, DiscountRules, DispatchManifest, Document, DpConfiguration, DPDetailsData, EInvoiceDetails, EInvoiceErrorDetails, EInvoiceErrorInfo, EInvoiceErrorResponse, EInvoiceErrorResponseData, EInvoiceErrorResponseDetails, EinvoiceInfo, EInvoiceIrnDetails, EInvoicePortalDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceRetryShipmentData, Entities, EntitiesDataUpdates, EntitiesReasons, EntityReasonData, Error, ErrorDetail, ErrorResponse, FailedOrderLogDetails, FailedOrderLogs, FailedOrdersItem, FetchCreditBalanceRequestPayload, FetchCreditBalanceResponsePayload, FileResponse, FilterInfoOption, Filters, FiltersInfo, FiltersRequest, FiltersResponse, FinancialBreakup, Formatted, FulfillingStore, FyndOrderIdList, GenerateInvoiceIDErrorResponse, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDResponseData, GeneratePosOrderReceiptResponse, GetActionsResponse, GetBagsPlatformResponse, GSTDetailsData, HistoryDict, HistoryMeta, HistoryReason, Identifier, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCachePayload, InvalidateShipmentCacheResponse, InvoiceDetails, InvoiceInfo, Item, ItemCriterias, JobDetailsData, JobDetailsResponse, JobFailedResponse, LaneConfigResponse, LineItem, LocationDetails, LockData, LogPaymentDetails, LogsChannelDetails, Manifest, ManifestDetails, ManifestFile, ManifestFiltersResponse, ManifestItemDetails, ManifestList, ManifestMediaUpdate, ManifestMeta, ManifestPageInfo, ManifestShipmentListing, MarketPlacePdf, Meta, OrderBagArticle, OrderBags, OrderBrandName, OrderConfig, OrderData, OrderDetails, OrderDetailsData, OrderDetailsResponse, OrderInfo, OrderingCurrency, OrderingStoreDetails, OrderItemDataUpdates, OrderListingResponse, OrderPriority, OrderStatus, OrderStatusData, OrderStatusResult, OrderUser, OriginalFilter, Page, PageDetails, PaymentInfo, PaymentMethod, PaymentMethods, PDFLinks, PDFMeta, PhoneDetails, PlatformArticleAttributes, PlatformBreakupValues, PlatformChannel, PlatformDeliveryAddress, PlatformItem, PlatformOrderItems, PlatformOrderUpdate, PlatformShipment, PlatformShipmentReasonsResponse, PlatformShipmentTrack, PlatformTrack, PointBlankOtpData, PostActivityHistory, PostHistoryData, PostHistoryDict, PostHistoryFilters, PostShipmentHistory, Prices, ProcessingDates, ProcessManifest, ProcessManifestItemResponse, ProcessManifestResponse, Products, ProductsDataUpdates, ProductsDataUpdatesFilters, ProductsReasons, ProductsReasonsData, ProductsReasonsFilters, QuestionSet, Reason, ReasonsData, RefundModeConfigRequestPayload, RefundModeConfigResponsePayload, RefundModeInfo, RefundOption, ReplacementDetails, ResponseDetail, ReturnConfig, RoleBaseStateTransitionMapping, SendSmsPayload, SendUserMobileOTP, SendUserMobileOtpResponse, Shipment, ShipmentActionInfo, ShipmentBagReasons, ShipmentConfig, ShipmentData, ShipmentDetail, ShipmentDetails, ShipmentGstDetails, ShipmentHistoryResponse, ShipmentInfoResponse, ShipmentInternalPlatformViewResponse, ShipmentItem, ShipmentItemFulFillingStore, ShipmentListingBrand, ShipmentListingChannel, ShipmentLockDetails, ShipmentMeta, ShipmentPayments, ShipmentReasonsResponse, ShipmentResponseReasons, ShipmentsRequest, ShipmentsResponse, ShipmentStatus, ShipmentStatusData, ShipmentTags, ShipmentTimeStamp, ShippingInfo, SmsDataPayload, StatuesRequest, StatuesResponse, Store, StoreAddress, StoreDocuments, StoreEinvoice, StoreEwaybill, StoreGstCredentials, StoreMeta, StoreReassign, StoreReassignResponse, SubLane, SuccessResponse, SuperLane, Tax, TaxDetails, TaxInfo, TemplateDownloadResponse, Templates, TotalShipmentPricesCount, TrackingList, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, UpdateShipmentLockPayload, UpdateShipmentLockResponse, UpdateShipmentStatusRequest, UpdateShipmentStatusResponseBody, UploadConsent, URL, UserData, UserDataInfo, UserDetails, UserDetailsData, UserInfo, VerifyMobileOTP, VerifyOtpData, VerifyOtpResponse, VerifyOtpResponseData, Weight, WeightData };
2675
2816
  }
2676
2817
  /** @returns {ActionInfo} */
2677
2818
  declare function ActionInfo(): ActionInfo;
@@ -2966,48 +3107,91 @@ type BagConfigs = {
2966
3107
  is_customer_return_allowed: boolean;
2967
3108
  is_returnable: boolean;
2968
3109
  };
2969
- /** @returns {BagDetailsPlatformResponse} */
2970
- declare function BagDetailsPlatformResponse(): BagDetailsPlatformResponse;
2971
- type BagDetailsPlatformResponse = {
3110
+ /** @returns {BagData} */
3111
+ declare function BagData(): BagData;
3112
+ type BagData = {
3113
+ items?: BagDetails[];
3114
+ page?: BagsPage;
3115
+ };
3116
+ /** @returns {BagDetails} */
3117
+ declare function BagDetails(): BagDetails;
3118
+ type BagDetails = {
2972
3119
  affiliate_bag_details?: AffiliateBagDetails;
2973
3120
  affiliate_details?: AffiliateDetails;
2974
3121
  applied_promos?: any[];
2975
3122
  article?: Article;
2976
3123
  article_details?: ArticleStatusDetails;
3124
+ bag_id?: number;
2977
3125
  bag_status?: BagStatusHistory[];
2978
3126
  bag_status_history?: BagStatusHistory;
2979
3127
  bag_update_time?: number;
2980
3128
  brand?: Brand;
3129
+ company?: Company;
2981
3130
  current_operational_status?: BagStatusHistory;
2982
3131
  current_status?: BagStatusHistory;
2983
3132
  dates?: Dates;
3133
+ delivery_address?: PlatformDeliveryAddress;
3134
+ delivery_slot?: DeliverySlotDetails;
2984
3135
  display_name?: string;
3136
+ dp_details?: any;
3137
+ einvoice_info?: any;
2985
3138
  entity_type?: string;
3139
+ fallback_user?: any;
2986
3140
  financial_breakup?: FinancialBreakup[];
3141
+ fulfilling_store?: Store;
3142
+ fyndstore_emp?: any;
2987
3143
  gst_details?: GSTDetailsData;
2988
- id?: number;
3144
+ id?: string;
2989
3145
  identifier?: string;
3146
+ invoice?: InvoiceDetails;
2990
3147
  item?: Item;
2991
3148
  journey_type?: string;
2992
3149
  line_number?: number;
3150
+ lock_status?: boolean;
3151
+ manifest_id?: string;
2993
3152
  meta?: any;
3153
+ mode_of_payment?: string;
2994
3154
  no_of_bags_order?: number;
2995
3155
  operational_status?: string;
3156
+ order?: OrderDetails;
2996
3157
  order_integration_id?: string;
3158
+ order_type?: string;
3159
+ order_value?: number;
2997
3160
  ordering_store?: Store;
2998
3161
  original_bag_list?: number[];
2999
3162
  parent_promo_bags?: any;
3163
+ payment_methods?: any;
3164
+ payment_type?: string;
3165
+ payments?: any;
3000
3166
  prices?: Prices;
3001
- qc_required?: any;
3167
+ qc_required?: boolean;
3002
3168
  quantity?: number;
3003
3169
  reasons?: any[];
3004
3170
  restore_coupon?: boolean;
3005
3171
  restore_promos?: any;
3172
+ rto_address?: PlatformDeliveryAddress;
3006
3173
  seller_identifier?: string;
3174
+ shipment?: Shipment;
3175
+ shipment_details?: ShipmentDetails;
3176
+ shipment_gst?: ShipmentGstDetails;
3007
3177
  shipment_id?: string;
3178
+ shipment_status?: ShipmentStatusData;
3179
+ shipment_status_history?: ShipmentStatusData[];
3008
3180
  status?: BagReturnableCancelableStatus;
3009
3181
  tags?: string[];
3182
+ total_shipment_bags?: number;
3183
+ total_shipments_in_order?: number;
3184
+ transaction_type?: string;
3010
3185
  type?: string;
3186
+ updated_at?: string;
3187
+ user?: UserDetails;
3188
+ weight?: WeightData;
3189
+ };
3190
+ /** @returns {BagDetailsPlatformResponse} */
3191
+ declare function BagDetailsPlatformResponse(): BagDetailsPlatformResponse;
3192
+ type BagDetailsPlatformResponse = {
3193
+ data?: BagDetails;
3194
+ status_code?: number;
3011
3195
  };
3012
3196
  /** @returns {BagPaymentMethods} */
3013
3197
  declare function BagPaymentMethods(): BagPaymentMethods;
@@ -3155,15 +3339,21 @@ type BillingInfo = {
3155
3339
  address2?: string;
3156
3340
  alternate_email?: string;
3157
3341
  alternate_mobile_number?: string;
3342
+ area?: string;
3158
3343
  city?: string;
3159
3344
  country?: string;
3160
3345
  country_code?: string;
3346
+ /**
3347
+ * - Country Code in ISO 2 format (e.g. US, IN)
3348
+ */
3349
+ country_iso_code?: string;
3161
3350
  customer_code?: string;
3162
3351
  external_customer_code?: string;
3163
3352
  first_name?: string;
3164
3353
  floor_no?: string;
3165
3354
  gender?: string;
3166
3355
  house_no?: string;
3356
+ landmark?: string;
3167
3357
  last_name?: string;
3168
3358
  middle_name?: string;
3169
3359
  pincode?: string;
@@ -3176,12 +3366,13 @@ type BillingInfo = {
3176
3366
  /** @returns {Brand} */
3177
3367
  declare function Brand(): Brand;
3178
3368
  type Brand = {
3179
- brand_id: number;
3369
+ brand_id?: number;
3180
3370
  brand_name: string;
3181
- company: string;
3182
- created_on?: number;
3371
+ company?: string;
3372
+ created_on?: string;
3183
3373
  credit_note_allowed?: boolean;
3184
3374
  credit_note_expiry_days?: number;
3375
+ id?: number;
3185
3376
  invoice_prefix?: string;
3186
3377
  is_virtual_invoice?: boolean;
3187
3378
  logo?: string;
@@ -3388,6 +3579,20 @@ type Click2CallResponse = {
3388
3579
  */
3389
3580
  success: boolean;
3390
3581
  };
3582
+ /** @returns {Company} */
3583
+ declare function Company(): Company;
3584
+ type Company = {
3585
+ agreement_start_date?: string;
3586
+ business_type?: string;
3587
+ company_name?: string;
3588
+ company_type?: string;
3589
+ created_on?: string;
3590
+ gst_number?: string;
3591
+ id?: number;
3592
+ meta?: any;
3593
+ modified_on?: string;
3594
+ pan_no?: string;
3595
+ };
3391
3596
  /** @returns {CompanyDetails} */
3392
3597
  declare function CompanyDetails(): CompanyDetails;
3393
3598
  type CompanyDetails = {
@@ -3610,6 +3815,15 @@ declare function DebugInfo(): DebugInfo;
3610
3815
  type DebugInfo = {
3611
3816
  stormbreaker_uuid?: string;
3612
3817
  };
3818
+ /** @returns {DeliverySlotDetails} */
3819
+ declare function DeliverySlotDetails(): DeliverySlotDetails;
3820
+ type DeliverySlotDetails = {
3821
+ date?: string;
3822
+ lower_bound?: string;
3823
+ slot?: string;
3824
+ type?: string;
3825
+ upper_bound?: string;
3826
+ };
3613
3827
  /** @returns {Dimension} */
3614
3828
  declare function Dimension(): Dimension;
3615
3829
  type Dimension = {
@@ -3961,10 +4175,12 @@ type Formatted = {
3961
4175
  declare function FulfillingStore(): FulfillingStore;
3962
4176
  type FulfillingStore = {
3963
4177
  address: string;
4178
+ address1?: string;
3964
4179
  city: string;
3965
4180
  code: string;
3966
4181
  contact_person: string;
3967
4182
  country: string;
4183
+ display_address?: string;
3968
4184
  fulfillment_channel: string;
3969
4185
  id: number;
3970
4186
  meta: any;
@@ -3978,6 +4194,37 @@ declare function FyndOrderIdList(): FyndOrderIdList;
3978
4194
  type FyndOrderIdList = {
3979
4195
  fynd_order_id?: string[];
3980
4196
  };
4197
+ /** @returns {GenerateInvoiceIDErrorResponse} */
4198
+ declare function GenerateInvoiceIDErrorResponse(): GenerateInvoiceIDErrorResponse;
4199
+ type GenerateInvoiceIDErrorResponse = {
4200
+ items?: GenerateInvoiceIDErrorResponseData[];
4201
+ };
4202
+ /** @returns {GenerateInvoiceIDErrorResponseData} */
4203
+ declare function GenerateInvoiceIDErrorResponseData(): GenerateInvoiceIDErrorResponseData;
4204
+ type GenerateInvoiceIDErrorResponseData = {
4205
+ error_message?: string;
4206
+ invoice_id?: boolean;
4207
+ shipment_id?: string;
4208
+ success?: boolean;
4209
+ };
4210
+ /** @returns {GenerateInvoiceIDRequest} */
4211
+ declare function GenerateInvoiceIDRequest(): GenerateInvoiceIDRequest;
4212
+ type GenerateInvoiceIDRequest = {
4213
+ shipment_ids: string[];
4214
+ };
4215
+ /** @returns {GenerateInvoiceIDResponse} */
4216
+ declare function GenerateInvoiceIDResponse(): GenerateInvoiceIDResponse;
4217
+ type GenerateInvoiceIDResponse = {
4218
+ items?: GenerateInvoiceIDResponseData[];
4219
+ };
4220
+ /** @returns {GenerateInvoiceIDResponseData} */
4221
+ declare function GenerateInvoiceIDResponseData(): GenerateInvoiceIDResponseData;
4222
+ type GenerateInvoiceIDResponseData = {
4223
+ error_message?: boolean;
4224
+ invoice_id?: string;
4225
+ shipment_id?: string;
4226
+ success?: boolean;
4227
+ };
3981
4228
  /** @returns {GeneratePosOrderReceiptResponse} */
3982
4229
  declare function GeneratePosOrderReceiptResponse(): GeneratePosOrderReceiptResponse;
3983
4230
  type GeneratePosOrderReceiptResponse = {
@@ -3999,8 +4246,8 @@ type GetActionsResponse = {
3999
4246
  /** @returns {GetBagsPlatformResponse} */
4000
4247
  declare function GetBagsPlatformResponse(): GetBagsPlatformResponse;
4001
4248
  type GetBagsPlatformResponse = {
4002
- items: BagDetailsPlatformResponse[];
4003
- page: BagsPage;
4249
+ data?: BagData;
4250
+ status_code?: number;
4004
4251
  };
4005
4252
  /** @returns {GSTDetailsData} */
4006
4253
  declare function GSTDetailsData(): GSTDetailsData;
@@ -4156,6 +4403,14 @@ declare function InvalidateShipmentCacheResponse(): InvalidateShipmentCacheRespo
4156
4403
  type InvalidateShipmentCacheResponse = {
4157
4404
  response?: InvalidateShipmentCacheNestedResponse[];
4158
4405
  };
4406
+ /** @returns {InvoiceDetails} */
4407
+ declare function InvoiceDetails(): InvoiceDetails;
4408
+ type InvoiceDetails = {
4409
+ invoice_url?: string;
4410
+ label_url?: string;
4411
+ store_invoice_id?: string;
4412
+ updated_date?: string;
4413
+ };
4159
4414
  /** @returns {InvoiceInfo} */
4160
4415
  declare function InvoiceInfo(): InvoiceInfo;
4161
4416
  type InvoiceInfo = {
@@ -4449,8 +4704,37 @@ type OrderData = {
4449
4704
  /** @returns {OrderDetails} */
4450
4705
  declare function OrderDetails(): OrderDetails;
4451
4706
  type OrderDetails = {
4707
+ affiliate_id?: string;
4708
+ affiliate_order_date?: string;
4709
+ affiliate_order_id?: string;
4710
+ cashback_applied?: number;
4711
+ cashback_value?: number;
4712
+ cod_charges?: number;
4713
+ collect_by?: string;
4714
+ coupon_value?: number;
4452
4715
  created_at?: string;
4716
+ created_time?: string;
4717
+ currency?: string;
4718
+ delivery_charges?: number;
4719
+ discount?: number;
4720
+ fynd_credits?: number;
4453
4721
  fynd_order_id?: string;
4722
+ headers?: any;
4723
+ meta?: any;
4724
+ mode_of_payment?: string;
4725
+ mongo_cart_id?: number;
4726
+ order_value?: number;
4727
+ ordering_channel?: string;
4728
+ ordering_channel_logo?: string;
4729
+ payment_methods?: any;
4730
+ payment_mode_id?: number;
4731
+ prices?: Prices;
4732
+ promotion_effective_discount?: number;
4733
+ refund_by?: string;
4734
+ tax_details?: TaxDetails;
4735
+ total_order_value?: number;
4736
+ transaction_id?: string;
4737
+ user_id?: string;
4454
4738
  };
4455
4739
  /** @returns {OrderDetailsData} */
4456
4740
  declare function OrderDetailsData(): OrderDetailsData;
@@ -4505,10 +4789,12 @@ type OrderingCurrency = {
4505
4789
  declare function OrderingStoreDetails(): OrderingStoreDetails;
4506
4790
  type OrderingStoreDetails = {
4507
4791
  address?: string;
4792
+ address1?: string;
4508
4793
  city?: string;
4509
4794
  code?: string;
4510
4795
  contact_person?: string;
4511
4796
  country?: string;
4797
+ display_address?: string;
4512
4798
  id?: number;
4513
4799
  meta?: any;
4514
4800
  phone?: string;
@@ -4626,23 +4912,6 @@ type PageDetails = {
4626
4912
  */
4627
4913
  type?: string;
4628
4914
  };
4629
- /** @returns {PaginatedStates} */
4630
- declare function PaginatedStates(): PaginatedStates;
4631
- type PaginatedStates = {
4632
- items?: StateManagerState[];
4633
- page?: PaginationInfo;
4634
- };
4635
- /** @returns {PaginationInfo} */
4636
- declare function PaginationInfo(): PaginationInfo;
4637
- type PaginationInfo = {
4638
- current?: number;
4639
- has_next?: boolean;
4640
- has_previous?: boolean;
4641
- item_total?: number;
4642
- size?: number;
4643
- total?: number;
4644
- type?: string;
4645
- };
4646
4915
  /** @returns {PaymentInfo} */
4647
4916
  declare function PaymentInfo(): PaymentInfo;
4648
4917
  type PaymentInfo = {
@@ -4729,6 +4998,7 @@ type PlatformDeliveryAddress = {
4729
4998
  contact_person?: string;
4730
4999
  country?: string;
4731
5000
  created_at?: string;
5001
+ display_address?: string;
4732
5002
  email?: string;
4733
5003
  landmark?: string;
4734
5004
  latitude?: number;
@@ -5141,13 +5411,40 @@ type SendUserMobileOtpResponse = {
5141
5411
  /** @returns {Shipment} */
5142
5412
  declare function Shipment(): Shipment;
5143
5413
  type Shipment = {
5414
+ affiliate_id?: string;
5415
+ affiliate_shipment_id?: string;
5416
+ billing_address_json?: PlatformDeliveryAddress;
5417
+ created_at?: string;
5418
+ credit_note_id?: string;
5419
+ delivery_address_json?: PlatformDeliveryAddress;
5420
+ delivery_awb_number?: string;
5421
+ eway_bill_id?: string;
5144
5422
  external_shipment_id?: string;
5423
+ fulfilment_priority?: number;
5424
+ fynd_order_id?: string;
5425
+ gst?: ShipmentGstDetails;
5426
+ hand_over_contact_json?: PlatformDeliveryAddress;
5427
+ id?: string;
5428
+ is_active?: boolean;
5145
5429
  line_items: LineItem[];
5146
5430
  location_id: number;
5431
+ lock_status?: string;
5147
5432
  meta?: any;
5148
5433
  order_type?: string;
5434
+ packaging_type?: string;
5435
+ parent_id?: string;
5436
+ parent_type?: string;
5437
+ pdf_links?: any;
5438
+ previous_shipment_id?: string;
5439
+ price?: Prices;
5149
5440
  priority?: number;
5150
5441
  processing_dates?: ProcessingDates;
5442
+ quantity?: number;
5443
+ status?: ShipmentStatusData;
5444
+ store_invoice_id?: string;
5445
+ tags?: string[];
5446
+ type?: string;
5447
+ vertical?: string;
5151
5448
  };
5152
5449
  /** @returns {ShipmentActionInfo} */
5153
5450
  declare function ShipmentActionInfo(): ShipmentActionInfo;
@@ -5198,14 +5495,26 @@ type ShipmentDetail = {
5198
5495
  /** @returns {ShipmentDetails} */
5199
5496
  declare function ShipmentDetails(): ShipmentDetails;
5200
5497
  type ShipmentDetails = {
5498
+ action_to_status?: any;
5201
5499
  affiliate_shipment_id: string;
5202
5500
  articles: ArticleDetails[];
5203
5501
  box_type?: string;
5204
- dp_id?: number;
5502
+ dp_id?: string;
5503
+ dp_options?: any;
5205
5504
  fulfillment_id: number;
5505
+ lock_status?: boolean;
5206
5506
  meta?: any;
5207
5507
  shipments: number;
5208
5508
  };
5509
+ /** @returns {ShipmentGstDetails} */
5510
+ declare function ShipmentGstDetails(): ShipmentGstDetails;
5511
+ type ShipmentGstDetails = {
5512
+ brand_calculated_amount?: number;
5513
+ gst_fee?: number;
5514
+ gstin_code?: number;
5515
+ tax_collected_at_source?: number;
5516
+ value_of_good?: number;
5517
+ };
5209
5518
  /** @returns {ShipmentHistoryResponse} */
5210
5519
  declare function ShipmentHistoryResponse(): ShipmentHistoryResponse;
5211
5520
  type ShipmentHistoryResponse = {
@@ -5268,9 +5577,11 @@ type ShipmentItem = {
5268
5577
  declare function ShipmentItemFulFillingStore(): ShipmentItemFulFillingStore;
5269
5578
  type ShipmentItemFulFillingStore = {
5270
5579
  address?: string;
5580
+ address1?: string;
5271
5581
  brand_store_tags?: string[];
5272
5582
  city?: string;
5273
5583
  code: string;
5584
+ display_address?: string;
5274
5585
  id: number;
5275
5586
  location_type?: string;
5276
5587
  meta?: any;
@@ -5424,6 +5735,7 @@ type ShipmentStatusData = {
5424
5735
  meta?: any;
5425
5736
  shipment_id?: string;
5426
5737
  status?: string;
5738
+ status_created_at?: string;
5427
5739
  };
5428
5740
  /** @returns {ShipmentTags} */
5429
5741
  declare function ShipmentTags(): ShipmentTags;
@@ -5447,9 +5759,14 @@ type ShippingInfo = {
5447
5759
  address2?: string;
5448
5760
  alternate_email?: string;
5449
5761
  alternate_mobile_number?: string;
5762
+ area?: string;
5450
5763
  city?: string;
5451
5764
  country?: string;
5452
5765
  country_code?: string;
5766
+ /**
5767
+ * - Country Code in ISO 2 format (e.g. US, IN)
5768
+ */
5769
+ country_iso_code?: string;
5453
5770
  customer_code?: string;
5454
5771
  external_customer_code?: string;
5455
5772
  first_name?: string;
@@ -5510,74 +5827,6 @@ type SmsDataPayload = {
5510
5827
  */
5511
5828
  shipment_id: number;
5512
5829
  };
5513
- /** @returns {StateManagerFilter} */
5514
- declare function StateManagerFilter(): StateManagerFilter;
5515
- type StateManagerFilter = {
5516
- default_value?: string;
5517
- description?: string;
5518
- display_name?: string;
5519
- id?: number;
5520
- name?: string;
5521
- options?: any;
5522
- type?: string;
5523
- };
5524
- /** @returns {StateManagerState} */
5525
- declare function StateManagerState(): StateManagerState;
5526
- type StateManagerState = {
5527
- /**
5528
- * - The application display name
5529
- */
5530
- app_display_name?: string;
5531
- /**
5532
- * - Whether state is for app facing or not
5533
- */
5534
- app_facing?: boolean;
5535
- /**
5536
- * - Unique identifier for the state
5537
- */
5538
- id?: number;
5539
- /**
5540
- * - Whether state is active or not
5541
- */
5542
- is_active?: boolean;
5543
- /**
5544
- * - Type of the journey
5545
- */
5546
- journey_type?: string;
5547
- /**
5548
- * - The platform display name
5549
- */
5550
- platform_display_name?: string;
5551
- /**
5552
- * - The name of the state
5553
- */
5554
- state?: string;
5555
- /**
5556
- * - Type of the state
5557
- */
5558
- state_type?: string;
5559
- };
5560
- /** @returns {StateManagerTask} */
5561
- declare function StateManagerTask(): StateManagerTask;
5562
- type StateManagerTask = {
5563
- description?: string;
5564
- display_name?: string;
5565
- doc_string?: string;
5566
- id?: number;
5567
- kwargs?: any;
5568
- name?: string;
5569
- };
5570
- /** @returns {StateTransitionFlag} */
5571
- declare function StateTransitionFlag(): StateTransitionFlag;
5572
- type StateTransitionFlag = {
5573
- default_value?: string;
5574
- description?: string;
5575
- display_name?: string;
5576
- id?: number;
5577
- name?: string;
5578
- options?: any;
5579
- type?: string;
5580
- };
5581
5830
  /** @returns {StatuesRequest} */
5582
5831
  declare function StatuesRequest(): StatuesRequest;
5583
5832
  type StatuesRequest = {
@@ -5604,7 +5853,6 @@ type Store = {
5604
5853
  address1: string;
5605
5854
  address2?: string;
5606
5855
  alohomora_user_id?: number;
5607
- brand_id?: any;
5608
5856
  brand_store_tags?: string[];
5609
5857
  city: string;
5610
5858
  code?: string;
@@ -5612,14 +5860,15 @@ type Store = {
5612
5860
  contact_person: string;
5613
5861
  country: string;
5614
5862
  created_at: string;
5863
+ display_address?: string;
5615
5864
  fulfillment_channel: string;
5616
5865
  is_active?: boolean;
5617
5866
  is_archived?: boolean;
5618
5867
  is_enabled_for_recon?: boolean;
5619
- latitude: number;
5868
+ latitude?: number;
5620
5869
  location_type: string;
5621
- login_username: string;
5622
- longitude: number;
5870
+ login_username?: string;
5871
+ longitude?: number;
5623
5872
  mall_area?: string;
5624
5873
  mall_name?: string;
5625
5874
  meta: StoreMeta;
@@ -5629,7 +5878,7 @@ type Store = {
5629
5878
  parent_store_id?: number;
5630
5879
  phone: number;
5631
5880
  pincode: string;
5632
- s_id: string;
5881
+ s_id?: string;
5633
5882
  state: string;
5634
5883
  store_active_from?: string;
5635
5884
  store_address_json?: StoreAddress;
@@ -5650,6 +5899,7 @@ type StoreAddress = {
5650
5899
  country: string;
5651
5900
  country_code: string;
5652
5901
  created_at: string;
5902
+ display_address?: string;
5653
5903
  email?: string;
5654
5904
  landmark?: string;
5655
5905
  latitude: number;
@@ -5893,6 +6143,20 @@ type UserDataInfo = {
5893
6143
  uid?: number;
5894
6144
  user_oid?: string;
5895
6145
  };
6146
+ /** @returns {UserDetails} */
6147
+ declare function UserDetails(): UserDetails;
6148
+ type UserDetails = {
6149
+ email?: string;
6150
+ external_customer_id?: string;
6151
+ first_name?: string;
6152
+ gender?: string;
6153
+ is_anonymous_user?: boolean;
6154
+ last_name?: string;
6155
+ meta?: any;
6156
+ mobile?: string;
6157
+ mongo_user_id?: string;
6158
+ user_oid?: string;
6159
+ };
5896
6160
  /** @returns {UserDetailsData} */
5897
6161
  declare function UserDetailsData(): UserDetailsData;
5898
6162
  type UserDetailsData = {
@@ -5904,6 +6168,7 @@ type UserDetailsData = {
5904
6168
  country: string;
5905
6169
  country_iso_code?: string;
5906
6170
  country_phone_code?: string;
6171
+ display_address?: string;
5907
6172
  email?: string;
5908
6173
  landmark?: string;
5909
6174
  name: string;
@@ -5959,3 +6224,9 @@ type Weight = {
5959
6224
  shipping?: number;
5960
6225
  unit?: string;
5961
6226
  };
6227
+ /** @returns {WeightData} */
6228
+ declare function WeightData(): WeightData;
6229
+ type WeightData = {
6230
+ unit?: string;
6231
+ value?: number;
6232
+ };