@gofynd/fdk-client-javascript 1.1.0 → 1.1.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 (102) hide show
  1. package/README.md +0 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +11 -0
  4. package/sdk/application/Cart/CartApplicationClient.js +65 -0
  5. package/sdk/application/Cart/CartApplicationModel.d.ts +6 -0
  6. package/sdk/application/Cart/CartApplicationModel.js +72 -0
  7. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -0
  8. package/sdk/application/Cart/CartApplicationValidator.js +6 -0
  9. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +19 -4
  10. package/sdk/application/Catalog/CatalogApplicationClient.js +27 -6
  11. package/sdk/application/Catalog/CatalogApplicationValidator.js +4 -0
  12. package/sdk/application/Content/ContentApplicationModel.js +1 -4
  13. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -2
  14. package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -2
  15. package/sdk/application/FileStorage/FileStorageApplicationModel.js +2 -2
  16. package/sdk/application/Lead/LeadApplicationModel.js +1 -0
  17. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +4 -0
  18. package/sdk/application/PosCart/PosCartApplicationModel.js +50 -0
  19. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +8 -8
  20. package/sdk/application/Rewards/RewardsApplicationClient.js +8 -8
  21. package/sdk/common/AxiosHelper.js +1 -1
  22. package/sdk/common/Constant.d.ts +0 -18
  23. package/sdk/common/Constant.js +0 -22
  24. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +51 -0
  25. package/sdk/platform/Cart/CartPlatformApplicationClient.js +308 -0
  26. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +5 -0
  27. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +30 -0
  28. package/sdk/platform/Cart/CartPlatformModel.d.ts +13 -0
  29. package/sdk/platform/Cart/CartPlatformModel.js +154 -0
  30. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +3 -1
  31. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +5 -0
  32. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +1 -0
  33. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +1 -1
  34. package/sdk/platform/Catalog/CatalogPlatformClient.js +1 -1
  35. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -7
  36. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +0 -183
  37. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +0 -417
  38. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +0 -10
  39. package/sdk/platform/Communication/CommunicationPlatformClient.js +0 -26
  40. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +4 -0
  41. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -22
  42. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +0 -56
  43. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +12 -1
  44. package/sdk/platform/Content/ContentPlatformApplicationClient.js +62 -2
  45. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -0
  46. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +6 -0
  47. package/sdk/platform/Content/ContentPlatformModel.js +1 -4
  48. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
  49. package/sdk/platform/Discount/DiscountPlatformClient.js +1 -1
  50. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +1 -0
  51. package/sdk/platform/Discount/DiscountPlatformModel.js +15 -0
  52. package/sdk/platform/Discount/DiscountPlatformValidator.js +1 -1
  53. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +10 -4
  54. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +15 -9
  55. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  56. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +1 -1
  57. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -2
  58. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +9 -3
  59. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  60. package/sdk/platform/Lead/LeadPlatformModel.js +1 -0
  61. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -47
  62. package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -201
  63. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -3
  64. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +1 -26
  65. package/sdk/platform/Order/OrderPlatformClient.d.ts +54 -186
  66. package/sdk/platform/Order/OrderPlatformClient.js +246 -934
  67. package/sdk/platform/Order/OrderPlatformModel.d.ts +4 -20
  68. package/sdk/platform/Order/OrderPlatformModel.js +40 -182
  69. package/sdk/platform/Order/OrderPlatformValidator.d.ts +3 -12
  70. package/sdk/platform/Order/OrderPlatformValidator.js +20 -96
  71. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +24 -10
  72. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +111 -44
  73. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +2 -1
  74. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +13 -5
  75. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -0
  76. package/sdk/platform/Payment/PaymentPlatformModel.js +12 -0
  77. package/sdk/platform/PlatformApplicationClient.d.ts +20 -41
  78. package/sdk/platform/PlatformApplicationClient.js +22 -45
  79. package/sdk/platform/PlatformClient.d.ts +190 -266
  80. package/sdk/platform/PlatformClient.js +223 -318
  81. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -26
  82. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +14 -74
  83. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -1
  84. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -7
  85. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +11 -0
  86. package/sdk/platform/Share/SharePlatformApplicationClient.js +61 -0
  87. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -0
  88. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -0
  89. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  90. package/sdk/platform/Share/SharePlatformModel.js +11 -0
  91. package/sdk/platform/index.d.ts +0 -1
  92. package/sdk/platform/index.js +0 -2
  93. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +0 -109
  94. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +0 -558
  95. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +0 -11
  96. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +0 -56
  97. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +0 -88
  98. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +0 -361
  99. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +0 -23
  100. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +0 -169
  101. package/sdk/platform/Analytics/AnalyticsPlatformValidator.d.ts +0 -7
  102. package/sdk/platform/Analytics/AnalyticsPlatformValidator.js +0 -38
@@ -20,8 +20,6 @@ const Inventory = require("./Inventory/InventoryPlatformClient");
20
20
 
21
21
  const Configuration = require("./Configuration/ConfigurationPlatformClient");
22
22
 
23
- const Analytics = require("./Analytics/AnalyticsPlatformClient");
24
-
25
23
  const Discount = require("./Discount/DiscountPlatformClient");
26
24
 
27
25
  const Webhook = require("./Webhook/WebhookPlatformClient");
@@ -57,8 +55,6 @@ class PlatformClient {
57
55
 
58
56
  this.configuration = new Configuration(config);
59
57
 
60
- this.analytics = new Analytics(config);
61
-
62
58
  this.discount = new Discount(config);
63
59
 
64
60
  this.webhook = new Webhook(config);
@@ -439,6 +435,7 @@ class PlatformClient {
439
435
  * @property {CommunicationDetails} [support_email]
440
436
  * @property {CommunicationDetails} [support_faq]
441
437
  * @property {CommunicationDetails} [support_phone]
438
+ * @property {string} [type]
442
439
  */
443
440
  /**
444
441
  * @typedef Ticket
@@ -1789,6 +1786,7 @@ class PlatformClient {
1789
1786
  /**
1790
1787
  * @typedef Detail
1791
1788
  * @property {string} [description]
1789
+ * @property {string} [image_url]
1792
1790
  * @property {string} [title]
1793
1791
  */
1794
1792
  /**
@@ -3575,6 +3573,11 @@ class PlatformClient {
3575
3573
  * @property {string} description
3576
3574
  * @property {boolean} success
3577
3575
  */
3576
+ /**
3577
+ * @typedef GetOauthUrlResponse
3578
+ * @property {boolean} success
3579
+ * @property {string} url
3580
+ */
3578
3581
  /**
3579
3582
  * @typedef GetUserCODLimitResponse
3580
3583
  * @property {boolean} success
@@ -3792,6 +3795,11 @@ class PlatformClient {
3792
3795
  * @property {string} message
3793
3796
  * @property {boolean} success
3794
3797
  */
3798
+ /**
3799
+ * @typedef RevokeOAuthToken
3800
+ * @property {string} message
3801
+ * @property {boolean} success
3802
+ */
3795
3803
  /**
3796
3804
  * @typedef RootPaymentMode
3797
3805
  * @property {boolean} [add_card_enabled]
@@ -3972,6 +3980,7 @@ class PlatformClient {
3972
3980
  * @property {string} [marketplace_invoice_id]
3973
3981
  * @property {string} [order_item_id]
3974
3982
  * @property {number} [quantity]
3983
+ * @property {ReplacementDetails} [replacement_details]
3975
3984
  * @property {number} [size_level_total_qty]
3976
3985
  */
3977
3986
  /**
@@ -3995,6 +4004,8 @@ class PlatformClient {
3995
4004
  /**
3996
4005
  * @typedef AnnouncementsResponse
3997
4006
  * @property {AnnouncementResponse[]} [announcements]
4007
+ * @property {string} [message]
4008
+ * @property {boolean} [success]
3998
4009
  */
3999
4010
  /**
4000
4011
  * @typedef AppliedPromos
@@ -4172,6 +4183,11 @@ class PlatformClient {
4172
4183
  * @property {boolean} [notify_customer]
4173
4184
  * @property {string} state_type
4174
4185
  */
4186
+ /**
4187
+ * @typedef BagStateTransitionMap
4188
+ * @property {Object} [affiliate]
4189
+ * @property {Object} [fynd]
4190
+ */
4175
4191
  /**
4176
4192
  * @typedef BagStatusHistory
4177
4193
  * @property {string} [app_display_name]
@@ -4208,8 +4224,8 @@ class PlatformClient {
4208
4224
  */
4209
4225
  /**
4210
4226
  * @typedef BaseResponse
4211
- * @property {string} message
4212
- * @property {boolean} success
4227
+ * @property {string} [message]
4228
+ * @property {boolean} [success]
4213
4229
  */
4214
4230
  /**
4215
4231
  * @typedef BillingInfo
@@ -4260,91 +4276,13 @@ class PlatformClient {
4260
4276
  * @property {string} [start_date]
4261
4277
  */
4262
4278
  /**
4263
- * @typedef BulkActionDetailsDataField
4264
- * @property {string} [batch_id]
4265
- * @property {string} [company_id]
4266
- * @property {number} [failed_shipments_count]
4267
- * @property {number} [processing_shipments_count]
4268
- * @property {string[]} [successful_shipment_ids]
4269
- * @property {number} [successful_shipments_count]
4270
- * @property {number} [total_shipments_count]
4271
- */
4272
- /**
4273
- * @typedef BulkActionDetailsResponse
4274
- * @property {BulkActionDetailsDataField[]} [data]
4275
- * @property {string[]} [error]
4276
- * @property {string[]} [failed_records]
4277
- * @property {string} [message]
4278
- * @property {boolean} [status]
4279
- * @property {string} [success]
4280
- * @property {string} [uploaded_by]
4281
- * @property {string} [uploaded_on]
4282
- * @property {string} [user_id]
4283
- */
4284
- /**
4285
- * @typedef BulkActionPayload
4286
- * @property {string} url
4287
- */
4288
- /**
4289
- * @typedef BulkActionResponse
4290
- * @property {string} [message]
4291
- * @property {boolean} [status]
4292
- */
4293
- /**
4294
- * @typedef BulkInvoiceLabelResponse
4295
- * @property {string} batch_id
4296
- * @property {string} [company_id]
4297
- * @property {Object} [data]
4298
- * @property {boolean} do_invoice_label_generated
4299
- * @property {Object} [invoice]
4300
- * @property {string} [invoice_status]
4301
- * @property {Object} [label]
4302
- * @property {string} [store_code]
4303
- * @property {string} [store_id]
4304
- * @property {string} [store_name]
4305
- */
4306
- /**
4307
- * @typedef BulkInvoicingResponse
4308
- * @property {string} [message]
4309
- * @property {boolean} success
4310
- */
4311
- /**
4312
- * @typedef bulkListingData
4313
- * @property {string} [batch_id]
4314
- * @property {number} [company_id]
4315
- * @property {string} [excel_url]
4316
- * @property {number} [failed]
4317
- * @property {Object[]} [failed_shipments]
4318
- * @property {string} [file_name]
4319
- * @property {string} [id]
4320
- * @property {number} [processing]
4321
- * @property {string[]} [processing_shipments]
4322
- * @property {string} [status]
4323
- * @property {string} [store_code]
4324
- * @property {number} [store_id]
4325
- * @property {string} [store_name]
4326
- * @property {number} [successful]
4327
- * @property {Object[]} [successful_shipments]
4328
- * @property {number} [total]
4329
- * @property {string} [uploaded_on]
4330
- * @property {string} [user_id]
4331
- * @property {string} [user_name]
4332
- */
4333
- /**
4334
- * @typedef BulkListingPage
4335
- * @property {number} [current]
4336
- * @property {boolean} [has_next]
4337
- * @property {boolean} [has_previous]
4338
- * @property {number} [size]
4339
- * @property {number} [total]
4340
- * @property {string} [type]
4279
+ * @typedef BulkActionTemplate
4280
+ * @property {string} [text]
4281
+ * @property {string} [value]
4341
4282
  */
4342
4283
  /**
4343
- * @typedef BulkListingResponse
4344
- * @property {bulkListingData[]} [data]
4345
- * @property {string} [error]
4346
- * @property {BulkListingPage} [page]
4347
- * @property {boolean} [success]
4284
+ * @typedef BulkActionTemplateResponse
4285
+ * @property {BulkActionTemplate[]} [template_x_slug]
4348
4286
  */
4349
4287
  /**
4350
4288
  * @typedef BuyerDetails
@@ -4376,7 +4314,7 @@ class PlatformClient {
4376
4314
  * @property {Bags[]} [bags]
4377
4315
  * @property {boolean} [is_bag_locked]
4378
4316
  * @property {boolean} [is_shipment_locked]
4379
- * @property {boolean} [lock_status]
4317
+ * @property {string} [lock_status]
4380
4318
  * @property {OriginalFilter} [original_filter]
4381
4319
  * @property {string} [shipment_id]
4382
4320
  * @property {string} [status]
@@ -4384,7 +4322,7 @@ class PlatformClient {
4384
4322
  /**
4385
4323
  * @typedef Click2CallResponse
4386
4324
  * @property {string} call_id
4387
- * @property {boolean} status
4325
+ * @property {boolean} success
4388
4326
  */
4389
4327
  /**
4390
4328
  * @typedef CompanyDetails
@@ -4587,8 +4525,9 @@ class PlatformClient {
4587
4525
  /**
4588
4526
  * @typedef ErrorResponse1
4589
4527
  * @property {string} [error_trace]
4590
- * @property {string} message
4591
- * @property {number} status
4528
+ * @property {string} [message]
4529
+ * @property {number} [status]
4530
+ * @property {boolean} [success]
4592
4531
  */
4593
4532
  /**
4594
4533
  * @typedef FileResponse
@@ -4698,12 +4637,15 @@ class PlatformClient {
4698
4637
  */
4699
4638
  /**
4700
4639
  * @typedef HistoryDict
4640
+ * @property {string} [assigned_agent]
4701
4641
  * @property {number} [bag_id]
4702
4642
  * @property {string} createdat
4643
+ * @property {string} [display_message]
4703
4644
  * @property {string} [l1_detail]
4704
4645
  * @property {string} [l2_detail]
4705
4646
  * @property {string} [l3_detail]
4706
4647
  * @property {string} message
4648
+ * @property {Object} [meta]
4707
4649
  * @property {string} [ticket_id]
4708
4650
  * @property {string} [ticket_url]
4709
4651
  * @property {string} type
@@ -4722,7 +4664,9 @@ class PlatformClient {
4722
4664
  */
4723
4665
  /**
4724
4666
  * @typedef InvalidateShipmentCachePayload
4725
- * @property {string[]} shipment_ids
4667
+ * @property {string[]} [affiliate_bag_ids]
4668
+ * @property {string[]} [bag_ids]
4669
+ * @property {string[]} [shipment_ids]
4726
4670
  */
4727
4671
  /**
4728
4672
  * @typedef InvalidateShipmentCacheResponse
@@ -4767,25 +4711,6 @@ class PlatformClient {
4767
4711
  * @typedef ItemCriterias
4768
4712
  * @property {number[]} [item_brand]
4769
4713
  */
4770
- /**
4771
- * @typedef JioCodeUpsertDataSet
4772
- * @property {string} [article_id]
4773
- * @property {string} [company_id]
4774
- * @property {string} [item_id]
4775
- * @property {string} [jio_code]
4776
- */
4777
- /**
4778
- * @typedef JioCodeUpsertPayload
4779
- * @property {JioCodeUpsertDataSet[]} [data]
4780
- */
4781
- /**
4782
- * @typedef JioCodeUpsertResponse
4783
- * @property {Object[]} [data]
4784
- * @property {NestedErrorSchemaDataSet[]} [error]
4785
- * @property {string} [identifier]
4786
- * @property {boolean} [success]
4787
- * @property {string} [trace_id]
4788
- */
4789
4714
  /**
4790
4715
  * @typedef LaneConfigResponse
4791
4716
  * @property {SuperLane[]} [super_lanes]
@@ -4811,18 +4736,6 @@ class PlatformClient {
4811
4736
  * @property {boolean} [locked]
4812
4737
  * @property {boolean} [mto]
4813
4738
  */
4814
- /**
4815
- * @typedef ManualAssignDPToShipment
4816
- * @property {number} dp_id
4817
- * @property {string} order_type
4818
- * @property {string} qc_required
4819
- * @property {string[]} [shipment_ids]
4820
- */
4821
- /**
4822
- * @typedef ManualAssignDPToShipmentResponse
4823
- * @property {string[]} [errors]
4824
- * @property {string} success
4825
- */
4826
4739
  /**
4827
4740
  * @typedef MarketPlacePdf
4828
4741
  * @property {string} [invoice]
@@ -4837,40 +4750,6 @@ class PlatformClient {
4837
4750
  * @property {number} [kafka_emission_status]
4838
4751
  * @property {string} [state_manager_used]
4839
4752
  */
4840
- /**
4841
- * @typedef MetricCountResponse
4842
- * @property {MetricsCount[]} [items]
4843
- */
4844
- /**
4845
- * @typedef MetricsCount
4846
- * @property {string} key
4847
- * @property {Options[]} [options]
4848
- * @property {string} text
4849
- * @property {number} value
4850
- */
4851
- /**
4852
- * @typedef NestedErrorSchemaDataSet
4853
- * @property {string} [message]
4854
- * @property {string} [type]
4855
- * @property {string} [value]
4856
- */
4857
- /**
4858
- * @typedef OmsReports
4859
- * @property {string} [display_name]
4860
- * @property {string} [report_created_at]
4861
- * @property {string} [report_id]
4862
- * @property {string} [report_name]
4863
- * @property {string} [report_requested_at]
4864
- * @property {string} [report_type]
4865
- * @property {Object} [request_details]
4866
- * @property {string} [s3_key]
4867
- * @property {string} [status]
4868
- */
4869
- /**
4870
- * @typedef Options
4871
- * @property {string} [text]
4872
- * @property {number} [value]
4873
- */
4874
4753
  /**
4875
4754
  * @typedef OrderBagArticle
4876
4755
  * @property {Object} [identifiers]
@@ -5358,6 +5237,11 @@ class PlatformClient {
5358
5237
  * @property {EntitiesReasons[]} [entities]
5359
5238
  * @property {ProductsReasons[]} [products]
5360
5239
  */
5240
+ /**
5241
+ * @typedef ReplacementDetails
5242
+ * @property {string} [original_affiliate_order_id]
5243
+ * @property {string} [replacement_type]
5244
+ */
5361
5245
  /**
5362
5246
  * @typedef ResponseDetail
5363
5247
  * @property {string[]} [message]
@@ -5427,6 +5311,7 @@ class PlatformClient {
5427
5311
  /**
5428
5312
  * @typedef ShipmentHistoryResponse
5429
5313
  * @property {HistoryDict[]} activity_history
5314
+ * @property {boolean} [success]
5430
5315
  */
5431
5316
  /**
5432
5317
  * @typedef ShipmentInfoResponse
@@ -5446,6 +5331,7 @@ class PlatformClient {
5446
5331
  * @property {Object} [application]
5447
5332
  * @property {BagUnit[]} [bags]
5448
5333
  * @property {Object} [channel]
5334
+ * @property {Object} [company]
5449
5335
  * @property {string} created_at
5450
5336
  * @property {string} fulfilling_centre
5451
5337
  * @property {ShipmentItemFulFillingStore} [fulfilling_store]
@@ -5581,13 +5467,13 @@ class PlatformClient {
5581
5467
  */
5582
5468
  /**
5583
5469
  * @typedef SmsDataPayload
5584
- * @property {number} amount_paid
5585
- * @property {string} brand_name
5470
+ * @property {number} [amount_paid]
5471
+ * @property {string} [brand_name]
5586
5472
  * @property {string} country_code
5587
- * @property {string} customer_name
5473
+ * @property {string} [customer_name]
5588
5474
  * @property {string} message
5589
5475
  * @property {string} order_id
5590
- * @property {string} payment_mode
5476
+ * @property {string} [payment_mode]
5591
5477
  * @property {number} phone_number
5592
5478
  * @property {number} shipment_id
5593
5479
  */
@@ -5595,6 +5481,7 @@ class PlatformClient {
5595
5481
  * @typedef StatuesRequest
5596
5482
  * @property {string} [exclude_bags_next_state]
5597
5483
  * @property {ShipmentsRequest[]} [shipments]
5484
+ * @property {boolean} [split_shipment]
5598
5485
  * @property {string} [status]
5599
5486
  */
5600
5487
  /**
@@ -5721,11 +5608,6 @@ class PlatformClient {
5721
5608
  * @property {number} [total_items]
5722
5609
  * @property {string} [value]
5723
5610
  */
5724
- /**
5725
- * @typedef Success
5726
- * @property {string} [message]
5727
- * @property {boolean} [success]
5728
- */
5729
5611
  /**
5730
5612
  * @typedef SuccessResponse
5731
5613
  * @property {string} [message]
@@ -6695,7 +6577,7 @@ class PlatformClient {
6695
6577
  * @property {UserDetail} [created_by]
6696
6578
  * @property {string} created_on
6697
6579
  * @property {boolean} [is_active]
6698
- * @property {string} logo
6580
+ * @property {Object} logo
6699
6581
  * @property {UserDetail} [modified_by]
6700
6582
  * @property {string} modified_on
6701
6583
  * @property {Object} name
@@ -7879,7 +7761,7 @@ class PlatformClient {
7879
7761
  * @property {NetQuantity} [net_quantity]
7880
7762
  * @property {number} [no_of_boxes]
7881
7763
  * @property {string[]} [product_group_tag]
7882
- * @property {ProductPublish1} [product_publish]
7764
+ * @property {ProductPublish} [product_publish]
7883
7765
  * @property {string} [requester]
7884
7766
  * @property {ReturnConfig} return_config
7885
7767
  * @property {string} [short_description]
@@ -8075,7 +7957,7 @@ class PlatformClient {
8075
7957
  * @property {string} [pending]
8076
7958
  * @property {string} [primary_color]
8077
7959
  * @property {string[]} [product_group_tag]
8078
- * @property {ProductPublish} [product_publish]
7960
+ * @property {ProductPublish1} [product_publish]
8079
7961
  * @property {ReturnConfigResponse} [return_config]
8080
7962
  * @property {string} [short_description]
8081
7963
  * @property {string} [size_guide]
@@ -8827,11 +8709,13 @@ class PlatformClient {
8827
8709
  * @typedef GetLocationSerializer
8828
8710
  * @property {Object} [_custom_json]
8829
8711
  * @property {GetAddressSerializer} address
8712
+ * @property {boolean} [auto_invoice]
8830
8713
  * @property {string} code
8831
8714
  * @property {GetCompanySerializer} [company]
8832
8715
  * @property {SellerPhoneNumber[]} [contact_numbers]
8833
8716
  * @property {UserSerializer} [created_by]
8834
8717
  * @property {string} [created_on]
8718
+ * @property {boolean} [credit_note]
8835
8719
  * @property {string} display_name
8836
8720
  * @property {Document[]} [documents]
8837
8721
  * @property {InvoiceDetailsSerializer} [gst_credentials]
@@ -8895,9 +8779,11 @@ class PlatformClient {
8895
8779
  * @typedef LocationSerializer
8896
8780
  * @property {Object} [_custom_json]
8897
8781
  * @property {AddressSerializer} address
8782
+ * @property {boolean} [auto_invoice]
8898
8783
  * @property {string} code
8899
8784
  * @property {number} company
8900
8785
  * @property {SellerPhoneNumber[]} [contact_numbers]
8786
+ * @property {boolean} [credit_note]
8901
8787
  * @property {string} display_name
8902
8788
  * @property {Document[]} [documents]
8903
8789
  * @property {InvoiceDetailsSerializer} [gst_credentials]
@@ -8998,8 +8884,8 @@ class PlatformClient {
8998
8884
  */
8999
8885
  /**
9000
8886
  * @typedef CDN
9001
- * @property {string} [absolute_url]
9002
- * @property {string} [relative_url]
8887
+ * @property {string} absolute_url
8888
+ * @property {string} relative_url
9003
8889
  * @property {string} url
9004
8890
  */
9005
8891
  /**
@@ -9128,6 +9014,15 @@ class PlatformClient {
9128
9014
  * @property {string} [medium]
9129
9015
  * @property {string} [source]
9130
9016
  */
9017
+ /**
9018
+ * @typedef ClickStatsItem
9019
+ * @property {string} [display]
9020
+ * @property {number} [total]
9021
+ */
9022
+ /**
9023
+ * @typedef ClickStatsResponse
9024
+ * @property {ClickStatsItem[]} click_stats
9025
+ */
9131
9026
  /**
9132
9027
  * @typedef ErrorRes
9133
9028
  * @property {string} [message]
@@ -11137,6 +11032,19 @@ class PlatformClient {
11137
11032
  * @typedef ActionQuery
11138
11033
  * @property {string[]} [product_slug]
11139
11034
  */
11035
+ /**
11036
+ * @typedef ActivePromosResponse
11037
+ * @property {string} [created_on]
11038
+ * @property {string} [description]
11039
+ * @property {string} [entity_slug]
11040
+ * @property {string} [entity_type]
11041
+ * @property {string} [example]
11042
+ * @property {boolean} [is_hidden]
11043
+ * @property {string} [modified_on]
11044
+ * @property {string} [subtitle]
11045
+ * @property {string} [title]
11046
+ * @property {string} [type]
11047
+ */
11140
11048
  /**
11141
11049
  * @typedef AddCartDetailResponse
11142
11050
  * @property {CartDetailResponse} [cart]
@@ -11164,14 +11072,26 @@ class PlatformClient {
11164
11072
  * @property {number} [seller_id]
11165
11073
  * @property {number} [store_id]
11166
11074
  */
11075
+ /**
11076
+ * @typedef AppliedFreeArticles
11077
+ * @property {string} [article_id]
11078
+ * @property {FreeGiftItem} [free_gift_item_details]
11079
+ * @property {string} [parent_item_identifier]
11080
+ * @property {number} [quantity]
11081
+ */
11167
11082
  /**
11168
11083
  * @typedef AppliedPromotion
11169
11084
  * @property {number} [amount]
11085
+ * @property {AppliedFreeArticles[]} [applied_free_articles]
11170
11086
  * @property {number} [article_quantity]
11087
+ * @property {BuyRules[]} [buy_rules]
11088
+ * @property {DiscountRulesApp[]} [discount_rules]
11171
11089
  * @property {boolean} [mrp_promotion]
11172
11090
  * @property {string} [offer_text]
11173
11091
  * @property {Ownership2} [ownership]
11174
11092
  * @property {string} [promo_id]
11093
+ * @property {string} [promotion_group]
11094
+ * @property {string} [promotion_name]
11175
11095
  * @property {string} [promotion_type]
11176
11096
  */
11177
11097
  /**
@@ -11195,6 +11115,11 @@ class PlatformClient {
11195
11115
  * @typedef BulkBundleRestriction
11196
11116
  * @property {boolean} multi_store_allowed
11197
11117
  */
11118
+ /**
11119
+ * @typedef BuyRules
11120
+ * @property {Object} [cart_conditions]
11121
+ * @property {Object} [item_criteria]
11122
+ */
11198
11123
  /**
11199
11124
  * @typedef CartBreakup
11200
11125
  * @property {CouponBreakup} [coupon]
@@ -11238,6 +11163,28 @@ class PlatformClient {
11238
11163
  * @property {string} [group_id]
11239
11164
  * @property {boolean} [primary_item]
11240
11165
  */
11166
+ /**
11167
+ * @typedef CartMetaConfigAdd
11168
+ * @property {boolean} [bulk_coupons]
11169
+ * @property {DeliveryCharges} [delivery_charges]
11170
+ * @property {boolean} [enabled]
11171
+ * @property {string} [gift_display_text]
11172
+ * @property {number} [gift_pricing]
11173
+ * @property {number} [max_cart_items]
11174
+ * @property {number} [min_cart_value]
11175
+ * @property {boolean} [revenue_engine_coupon]
11176
+ */
11177
+ /**
11178
+ * @typedef CartMetaConfigUpdate
11179
+ * @property {boolean} [bulk_coupons]
11180
+ * @property {DeliveryCharges} [delivery_charges]
11181
+ * @property {boolean} [enabled]
11182
+ * @property {string} [gift_display_text]
11183
+ * @property {number} [gift_pricing]
11184
+ * @property {number} [max_cart_items]
11185
+ * @property {number} [min_cart_value]
11186
+ * @property {boolean} [revenue_engine_coupon]
11187
+ */
11241
11188
  /**
11242
11189
  * @typedef CartProduct
11243
11190
  * @property {ProductAction} [action]
@@ -11279,6 +11226,11 @@ class PlatformClient {
11279
11226
  * @property {string} [name]
11280
11227
  * @property {number} [uid]
11281
11228
  */
11229
+ /**
11230
+ * @typedef Charges
11231
+ * @property {number} [charges]
11232
+ * @property {number} [threshold]
11233
+ */
11282
11234
  /**
11283
11235
  * @typedef CompareObject
11284
11236
  * @property {number} [equals]
@@ -11319,8 +11271,15 @@ class PlatformClient {
11319
11271
  /**
11320
11272
  * @typedef CouponBreakup
11321
11273
  * @property {string} [code]
11274
+ * @property {string} [coupon_type]
11275
+ * @property {number} [coupon_value]
11276
+ * @property {string} [description]
11322
11277
  * @property {boolean} [is_applied]
11278
+ * @property {number} [max_discount_value]
11323
11279
  * @property {string} [message]
11280
+ * @property {number} [minimum_cart_value]
11281
+ * @property {string} [sub_title]
11282
+ * @property {string} [title]
11324
11283
  * @property {string} [type]
11325
11284
  * @property {string} [uid]
11326
11285
  * @property {number} [value]
@@ -11367,15 +11326,23 @@ class PlatformClient {
11367
11326
  * @property {Validation} [validation]
11368
11327
  * @property {Validity} validity
11369
11328
  */
11329
+ /**
11330
+ * @typedef DeliveryCharges
11331
+ * @property {Charges[]} [charges]
11332
+ * @property {boolean} [enabled]
11333
+ */
11370
11334
  /**
11371
11335
  * @typedef DiscountOffer
11336
+ * @property {boolean} [apportion_discount]
11372
11337
  * @property {string} [code]
11373
11338
  * @property {number} [discount_amount]
11374
11339
  * @property {number} [discount_percentage]
11375
11340
  * @property {number} [discount_price]
11376
11341
  * @property {number} [max_discount_amount]
11377
11342
  * @property {number} [max_offer_quantity]
11343
+ * @property {number} [max_usage_per_transaction]
11378
11344
  * @property {number} [min_offer_quantity]
11345
+ * @property {boolean} [partial_can_ret]
11379
11346
  */
11380
11347
  /**
11381
11348
  * @typedef DiscountRule
@@ -11384,6 +11351,13 @@ class PlatformClient {
11384
11351
  * @property {ItemCriteria} item_criteria
11385
11352
  * @property {DiscountOffer} offer
11386
11353
  */
11354
+ /**
11355
+ * @typedef DiscountRulesApp
11356
+ * @property {Object} [item_criteria]
11357
+ * @property {string[]} [matched_buy_rules]
11358
+ * @property {Object} [offer]
11359
+ * @property {Object} [raw_offer]
11360
+ */
11387
11361
  /**
11388
11362
  * @typedef DisplayBreakup
11389
11363
  * @property {string} [currency_code]
@@ -11413,6 +11387,15 @@ class PlatformClient {
11413
11387
  * @property {string} [subtitle]
11414
11388
  * @property {string} [title]
11415
11389
  */
11390
+ /**
11391
+ * @typedef FreeGiftItem
11392
+ * @property {string} [item_brand_name]
11393
+ * @property {number} [item_id]
11394
+ * @property {string[]} [item_images_url]
11395
+ * @property {string} [item_name]
11396
+ * @property {Object} [item_price_details]
11397
+ * @property {string} [item_slug]
11398
+ */
11416
11399
  /**
11417
11400
  * @typedef Identifier
11418
11401
  * @property {string[]} [article_id]
@@ -11428,15 +11411,19 @@ class PlatformClient {
11428
11411
  /**
11429
11412
  * @typedef ItemCriteria
11430
11413
  * @property {boolean} [all_items]
11414
+ * @property {string[]} [available_zones]
11431
11415
  * @property {string[]} [buy_rules]
11432
11416
  * @property {CompareObject} [cart_quantity]
11433
11417
  * @property {CompareObject} [cart_total]
11418
+ * @property {CompareObject} [cart_unique_item_amount]
11419
+ * @property {CompareObject} [cart_unique_item_quantity]
11434
11420
  * @property {number[]} [item_brand]
11435
11421
  * @property {number[]} [item_category]
11436
11422
  * @property {number[]} [item_company]
11437
11423
  * @property {number[]} [item_exclude_brand]
11438
11424
  * @property {number[]} [item_exclude_category]
11439
11425
  * @property {number[]} [item_exclude_company]
11426
+ * @property {number[]} [item_exclude_id]
11440
11427
  * @property {string[]} [item_exclude_sku]
11441
11428
  * @property {number[]} [item_exclude_store]
11442
11429
  * @property {number[]} [item_id]
@@ -11556,6 +11543,49 @@ class PlatformClient {
11556
11543
  * @property {string} [message]
11557
11544
  * @property {boolean} [success]
11558
11545
  */
11546
+ /**
11547
+ * @typedef OverrideCartItem
11548
+ * @property {number} amount_paid
11549
+ * @property {number} discount
11550
+ * @property {Object} [extra_meta]
11551
+ * @property {number} item_id
11552
+ * @property {number} price_effective
11553
+ * @property {number} price_marked
11554
+ * @property {OverrideCartItemPromo[]} [promo_list]
11555
+ * @property {number} [quantity]
11556
+ * @property {string} [seller_identifier]
11557
+ * @property {string} size
11558
+ */
11559
+ /**
11560
+ * @typedef OverrideCartItemPromo
11561
+ * @property {Object[]} [item_list]
11562
+ * @property {string} promo_amount
11563
+ * @property {string} [promo_desc]
11564
+ * @property {string} promo_id
11565
+ * @property {string} [rwrd_tndr]
11566
+ */
11567
+ /**
11568
+ * @typedef OverrideCheckoutReq
11569
+ * @property {string} aggregator
11570
+ * @property {Object} [billing_address]
11571
+ * @property {string} cart_id
11572
+ * @property {OverrideCartItem[]} cart_items
11573
+ * @property {string} currency_code
11574
+ * @property {string} merchant_code
11575
+ * @property {string} order_type
11576
+ * @property {number} [ordering_store]
11577
+ * @property {string} payment_identifier
11578
+ * @property {string} payment_mode
11579
+ * @property {Object} [shipping_address]
11580
+ */
11581
+ /**
11582
+ * @typedef OverrideCheckoutResponse
11583
+ * @property {Object} cart
11584
+ * @property {Object} data
11585
+ * @property {string} message
11586
+ * @property {string} order_id
11587
+ * @property {string} success
11588
+ */
11559
11589
  /**
11560
11590
  * @typedef Ownership
11561
11591
  * @property {string} payable_by
@@ -11627,11 +11657,13 @@ class PlatformClient {
11627
11657
  * @typedef ProductArticle
11628
11658
  * @property {Object} [_custom_json]
11629
11659
  * @property {Object} [extra_meta]
11660
+ * @property {Object} [identifier]
11630
11661
  * @property {Object} [parent_item_identifiers]
11631
11662
  * @property {ArticlePriceInfo} [price]
11632
11663
  * @property {string[]} [product_group_tags]
11633
11664
  * @property {number} [quantity]
11634
11665
  * @property {BaseInfo} [seller]
11666
+ * @property {string} [seller_identifier]
11635
11667
  * @property {string} [size]
11636
11668
  * @property {BaseInfo} [store]
11637
11669
  * @property {string} [type]
@@ -11701,6 +11733,7 @@ class PlatformClient {
11701
11733
  * @property {number} [apply_priority]
11702
11734
  * @property {PromotionAuthor} [author]
11703
11735
  * @property {Object} buy_rules
11736
+ * @property {string} [calculate_on]
11704
11737
  * @property {string} [code]
11705
11738
  * @property {string} [currency]
11706
11739
  * @property {PromotionDateMeta} [date_meta]
@@ -11735,6 +11768,7 @@ class PlatformClient {
11735
11768
  * @property {number} [apply_priority]
11736
11769
  * @property {PromotionAuthor} [author]
11737
11770
  * @property {Object} buy_rules
11771
+ * @property {string} [calculate_on]
11738
11772
  * @property {string} [code]
11739
11773
  * @property {string} [currency]
11740
11774
  * @property {PromotionDateMeta} [date_meta]
@@ -11784,6 +11818,7 @@ class PlatformClient {
11784
11818
  * @property {number} [apply_priority]
11785
11819
  * @property {PromotionAuthor} [author]
11786
11820
  * @property {Object} buy_rules
11821
+ * @property {string} [calculate_on]
11787
11822
  * @property {string} [code]
11788
11823
  * @property {string} [currency]
11789
11824
  * @property {PromotionDateMeta} [date_meta]
@@ -11829,6 +11864,7 @@ class PlatformClient {
11829
11864
  * @typedef Restrictions1
11830
11865
  * @property {boolean} [anonymous_users]
11831
11866
  * @property {number} [order_quantity]
11867
+ * @property {number[]} [ordering_stores]
11832
11868
  * @property {PromotionPaymentModes[]} [payments]
11833
11869
  * @property {string[]} [platforms]
11834
11870
  * @property {PostOrder1} [post_order]
@@ -12124,151 +12160,6 @@ class PlatformClient {
12124
12160
  * @property {RewardUser} [user]
12125
12161
  */
12126
12162
 
12127
- /**
12128
- * @typedef AbandonCartDetail
12129
- * @property {string} [_id]
12130
- * @property {Object} [address]
12131
- * @property {Object[]} [articles]
12132
- * @property {Object} [breakup]
12133
- * @property {string} [cart_value]
12134
- * @property {string} [user_id]
12135
- */
12136
- /**
12137
- * @typedef AbandonCartsDetail
12138
- * @property {string} [context_app_application_id]
12139
- * @property {string} [context_traits_email]
12140
- * @property {string} [context_traits_first_name]
12141
- * @property {string} [context_traits_last_name]
12142
- * @property {string} [context_traits_phone_number]
12143
- * @property {string} [properties_breakup_values_raw_total]
12144
- * @property {string} [properties_cart_id]
12145
- * @property {ReceivedAt} [received_at]
12146
- */
12147
- /**
12148
- * @typedef AbandonCartsList
12149
- * @property {string} [cart_total]
12150
- * @property {AbandonCartsDetail[]} [items]
12151
- * @property {Page} [page]
12152
- */
12153
- /**
12154
- * @typedef ErrorRes
12155
- * @property {string} [message]
12156
- */
12157
- /**
12158
- * @typedef ExportJobReq
12159
- * @property {string} [end_time]
12160
- * @property {string} [event_type]
12161
- * @property {string} [marketplace_name]
12162
- * @property {string} [start_time]
12163
- * @property {string} [trace_id]
12164
- */
12165
- /**
12166
- * @typedef ExportJobRes
12167
- * @property {string} [job_id]
12168
- * @property {string} [status]
12169
- */
12170
- /**
12171
- * @typedef ExportJobStatusRes
12172
- * @property {string} [download_url]
12173
- * @property {string} [job_id]
12174
- * @property {string} [status]
12175
- */
12176
- /**
12177
- * @typedef GetLogsListReq
12178
- * @property {string} [company_id]
12179
- * @property {string} [end_date]
12180
- * @property {string} [marketplace_name]
12181
- * @property {string} [start_date]
12182
- */
12183
- /**
12184
- * @typedef GetLogsListRes
12185
- * @property {MkpLogsResp[]} [items]
12186
- * @property {Page} [page]
12187
- */
12188
- /**
12189
- * @typedef LogInfo
12190
- * @property {string} [_id]
12191
- * @property {string} [article_id]
12192
- * @property {number} [brand_id]
12193
- * @property {number} [company_id]
12194
- * @property {string} [event]
12195
- * @property {string} [event_type]
12196
- * @property {number} [item_id]
12197
- * @property {string} [marketplace_name]
12198
- * @property {string} [seller_identifier]
12199
- * @property {string} [status]
12200
- * @property {string} [store_code]
12201
- * @property {number} [store_id]
12202
- * @property {string} [trace_id]
12203
- */
12204
- /**
12205
- * @typedef MkpLogsResp
12206
- * @property {string} [count]
12207
- * @property {string} [end_time_iso]
12208
- * @property {string} [event_type]
12209
- * @property {string} [start_time_iso]
12210
- * @property {string} [status]
12211
- * @property {string} [trace_id]
12212
- */
12213
- /**
12214
- * @typedef Page
12215
- * @property {number} [current]
12216
- * @property {boolean} [has_next]
12217
- * @property {boolean} [has_previous]
12218
- * @property {number} [item_total]
12219
- * @property {string} [next_id]
12220
- * @property {number} [size]
12221
- * @property {string} type
12222
- */
12223
- /**
12224
- * @typedef ReceivedAt
12225
- * @property {string} [value]
12226
- */
12227
- /**
12228
- * @typedef SearchLogReq
12229
- * @property {string} [company_id]
12230
- * @property {string} [end_date]
12231
- * @property {string} [identifier]
12232
- * @property {string} [identifier_value]
12233
- * @property {string} [marketplace_name]
12234
- * @property {string} [start_date]
12235
- */
12236
- /**
12237
- * @typedef SearchLogRes
12238
- * @property {LogInfo[]} [items]
12239
- * @property {Page} [page]
12240
- */
12241
- /**
12242
- * @typedef StatGroup
12243
- * @property {string} [key]
12244
- * @property {string} [title]
12245
- * @property {string} [url]
12246
- */
12247
- /**
12248
- * @typedef StatsGroupComponent
12249
- * @property {Object} [filters]
12250
- * @property {string} [key]
12251
- * @property {string} [title]
12252
- * @property {string} [type]
12253
- * @property {string} [url]
12254
- */
12255
- /**
12256
- * @typedef StatsGroupComponents
12257
- * @property {StatsGroupComponent[]} [components]
12258
- * @property {string} [title]
12259
- */
12260
- /**
12261
- * @typedef StatsGroups
12262
- * @property {StatGroup[]} [groups]
12263
- */
12264
- /**
12265
- * @typedef StatsRes
12266
- * @property {Object} [data]
12267
- * @property {string} [key]
12268
- * @property {string} [title]
12269
- * @property {string} [type]
12270
- */
12271
-
12272
12163
  /**
12273
12164
  * @typedef BadRequestObject
12274
12165
  * @property {string} message
@@ -12332,6 +12223,20 @@ class PlatformClient {
12332
12223
  * @property {number[]} [brand_ids]
12333
12224
  * @property {number[]} [store_ids]
12334
12225
  */
12226
+ /**
12227
+ * @typedef FileJobRequest
12228
+ * @property {string[]} [app_ids]
12229
+ * @property {number[]} [brand_ids]
12230
+ * @property {string} [discount_level]
12231
+ * @property {string} [discount_type]
12232
+ * @property {string} [file_path]
12233
+ * @property {boolean} is_active
12234
+ * @property {string} [job_type]
12235
+ * @property {Object} [meta]
12236
+ * @property {string} name
12237
+ * @property {number[]} [store_ids]
12238
+ * @property {ValidityObject} validity
12239
+ */
12335
12240
  /**
12336
12241
  * @typedef FileJobResponse
12337
12242
  * @property {Object} [body]