@gofynd/fdk-client-javascript 1.4.6 → 1.4.8-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 (140) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +16 -3
  6. package/sdk/application/Cart/CartApplicationClient.js +118 -13
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +121 -45
  8. package/sdk/application/Cart/CartApplicationModel.js +98 -26
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +45 -1
  10. package/sdk/application/Cart/CartApplicationValidator.js +26 -0
  11. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +10 -2
  12. package/sdk/application/Catalog/CatalogApplicationModel.js +10 -2
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +1 -1
  14. package/sdk/application/Content/ContentApplicationClient.js +5 -3
  15. package/sdk/application/Content/ContentApplicationModel.d.ts +7 -18
  16. package/sdk/application/Content/ContentApplicationModel.js +6 -20
  17. package/sdk/application/Content/ContentApplicationValidator.d.ts +10 -0
  18. package/sdk/application/Content/ContentApplicationValidator.js +4 -0
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +0 -27
  20. package/sdk/application/Lead/LeadApplicationClient.js +0 -167
  21. package/sdk/application/Lead/LeadApplicationModel.d.ts +1 -146
  22. package/sdk/application/Lead/LeadApplicationModel.js +0 -126
  23. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -25
  24. package/sdk/application/Lead/LeadApplicationValidator.js +0 -24
  25. package/sdk/application/Logistic/LogisticApplicationClient.js +1 -1
  26. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +2 -0
  27. package/sdk/application/Logistic/LogisticApplicationModel.js +2 -0
  28. package/sdk/application/Order/OrderApplicationModel.d.ts +72 -9
  29. package/sdk/application/Order/OrderApplicationModel.js +45 -7
  30. package/sdk/application/Payment/PaymentApplicationModel.d.ts +27 -20
  31. package/sdk/application/Payment/PaymentApplicationModel.js +23 -20
  32. package/sdk/application/Theme/ThemeApplicationModel.d.ts +2 -0
  33. package/sdk/application/Theme/ThemeApplicationModel.js +2 -0
  34. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +22 -0
  35. package/sdk/application/Webhook/WebhookApplicationClient.js +115 -0
  36. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +37 -0
  37. package/sdk/application/Webhook/WebhookApplicationModel.js +46 -0
  38. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +16 -0
  39. package/sdk/application/Webhook/WebhookApplicationValidator.js +19 -0
  40. package/sdk/application/index.d.ts +1 -0
  41. package/sdk/application/index.js +2 -0
  42. package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -23
  43. package/sdk/partner/Lead/LeadPartnerClient.js +0 -157
  44. package/sdk/partner/Lead/LeadPartnerModel.d.ts +12 -581
  45. package/sdk/partner/Lead/LeadPartnerModel.js +14 -403
  46. package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -2
  47. package/sdk/partner/Lead/LeadPartnerValidator.js +0 -12
  48. package/sdk/partner/Logistics/LogisticsPartnerClient.js +1 -1
  49. package/sdk/partner/Logistics/LogisticsPartnerModel.js +4 -4
  50. package/sdk/partner/Theme/ThemePartnerClient.d.ts +22 -0
  51. package/sdk/partner/Theme/ThemePartnerClient.js +162 -0
  52. package/sdk/partner/Theme/ThemePartnerModel.d.ts +119 -1
  53. package/sdk/partner/Theme/ThemePartnerModel.js +142 -0
  54. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  55. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  56. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
  57. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  58. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +23 -19
  59. package/sdk/partner/Webhook/WebhookPartnerModel.js +19 -22
  60. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +43 -0
  61. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +257 -0
  62. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +39 -0
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +45 -0
  64. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +60 -0
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +57 -0
  66. package/sdk/platform/Billing/BillingPlatformClient.d.ts +304 -43
  67. package/sdk/platform/Billing/BillingPlatformClient.js +2218 -118
  68. package/sdk/platform/Billing/BillingPlatformModel.d.ts +1330 -282
  69. package/sdk/platform/Billing/BillingPlatformModel.js +1808 -590
  70. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +324 -16
  71. package/sdk/platform/Billing/BillingPlatformValidator.js +340 -12
  72. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +36 -3
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.js +276 -3
  74. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +93 -1
  75. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +60 -0
  76. package/sdk/platform/Cart/CartPlatformModel.d.ts +216 -40
  77. package/sdk/platform/Cart/CartPlatformModel.js +166 -24
  78. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +11 -7
  79. package/sdk/platform/Catalog/CatalogPlatformClient.js +37 -14
  80. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +122 -17
  81. package/sdk/platform/Catalog/CatalogPlatformModel.js +141 -15
  82. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -7
  83. package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -5
  84. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
  85. package/sdk/platform/Content/ContentPlatformApplicationClient.js +18 -1
  86. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +25 -0
  87. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +10 -0
  88. package/sdk/platform/Content/ContentPlatformModel.d.ts +8 -4
  89. package/sdk/platform/Content/ContentPlatformModel.js +8 -4
  90. package/sdk/platform/Finance/FinancePlatformClient.d.ts +49 -28
  91. package/sdk/platform/Finance/FinancePlatformClient.js +181 -28
  92. package/sdk/platform/Finance/FinancePlatformModel.d.ts +350 -127
  93. package/sdk/platform/Finance/FinancePlatformModel.js +378 -108
  94. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +56 -43
  95. package/sdk/platform/Finance/FinancePlatformValidator.js +61 -42
  96. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +0 -47
  97. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +0 -321
  98. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -46
  99. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +0 -48
  100. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -25
  101. package/sdk/platform/Lead/LeadPlatformClient.js +2 -167
  102. package/sdk/platform/Lead/LeadPlatformModel.d.ts +82 -204
  103. package/sdk/platform/Lead/LeadPlatformModel.js +98 -178
  104. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -25
  105. package/sdk/platform/Lead/LeadPlatformValidator.js +0 -24
  106. package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -1
  107. package/sdk/platform/Order/OrderPlatformClient.js +82 -5
  108. package/sdk/platform/Order/OrderPlatformModel.d.ts +270 -29
  109. package/sdk/platform/Order/OrderPlatformModel.js +139 -28
  110. package/sdk/platform/Order/OrderPlatformValidator.d.ts +58 -17
  111. package/sdk/platform/Order/OrderPlatformValidator.js +28 -16
  112. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +14 -2
  113. package/sdk/platform/Payment/PaymentPlatformModel.js +7 -2
  114. package/sdk/platform/PlatformApplicationClient.d.ts +2 -0
  115. package/sdk/platform/PlatformApplicationClient.js +4 -0
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -4
  117. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +12 -0
  118. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +82 -0
  119. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -1
  120. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +14 -0
  121. package/sdk/platform/Theme/ThemePlatformModel.d.ts +67 -1
  122. package/sdk/platform/Theme/ThemePlatformModel.js +78 -0
  123. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +24 -40
  124. package/sdk/platform/Webhook/WebhookPlatformClient.js +78 -221
  125. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +168 -167
  126. package/sdk/platform/Webhook/WebhookPlatformModel.js +180 -178
  127. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +23 -31
  128. package/sdk/platform/Webhook/WebhookPlatformValidator.js +28 -42
  129. package/sdk/platform/index.d.ts +1 -0
  130. package/sdk/platform/index.js +2 -0
  131. package/sdk/public/Billing/BillingPublicClient.d.ts +24 -2
  132. package/sdk/public/Billing/BillingPublicClient.js +156 -3
  133. package/sdk/public/Billing/BillingPublicModel.d.ts +368 -26
  134. package/sdk/public/Billing/BillingPublicModel.js +317 -18
  135. package/sdk/public/Billing/BillingPublicValidator.d.ts +19 -3
  136. package/sdk/public/Billing/BillingPublicValidator.js +22 -3
  137. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  138. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
  139. package/sdk/public/Webhook/WebhookPublicModel.d.ts +24 -22
  140. package/sdk/public/Webhook/WebhookPublicModel.js +24 -22
@@ -255,6 +255,7 @@ const Joi = require("joi");
255
255
  * @property {boolean} [lock_after_transition] - Lock Shipment After Transition
256
256
  * @property {boolean} [unlock_before_transition] - Unlock Shipment After Transition
257
257
  * @property {boolean} [task] - To Run Status Update as a background Task
258
+ * @property {boolean} [resume_tasks_after_unlock] - Resume Tasks After Unlock
258
259
  */
259
260
 
260
261
  /**
@@ -506,7 +507,7 @@ const Joi = require("joi");
506
507
 
507
508
  /**
508
509
  * @typedef DispatchManifest
509
- * @property {string} manifest_id
510
+ * @property {string} manifest_id - Id of the manifest.
510
511
  */
511
512
 
512
513
  /**
@@ -730,21 +731,24 @@ const Joi = require("joi");
730
731
 
731
732
  /**
732
733
  * @typedef Charge
733
- * @property {string} name
734
- * @property {Object} amount
734
+ * @property {string} name - The name of the charge.
735
+ * @property {Object} amount - The monetary value of the charge, including value
736
+ * and currency details.
735
737
  * @property {Tax} [tax]
736
- * @property {string} [code]
737
- * @property {string} type
738
+ * @property {string} [code] - An optional code associated with the charge for
739
+ * internal tracking.
740
+ * @property {string} type - The category or type of the charge.
738
741
  */
739
742
 
740
743
  /**
741
744
  * @typedef LineItem
742
745
  * @property {Charge[]} [charges]
743
- * @property {Object} [meta]
744
- * @property {string} [custom_message]
745
- * @property {number} [quantity]
746
- * @property {string} seller_identifier
747
- * @property {string} [external_line_id]
746
+ * @property {Object} [meta] - Meta data of the articles or line items.
747
+ * @property {string} [custom_message] - Meta data of the articles or line items.
748
+ * @property {number} [quantity] - Quantity of the articles or line items.
749
+ * @property {string} seller_identifier - Seller identifier of the articles or line items.
750
+ * @property {string} [external_line_id] - External unique identifier of the
751
+ * articles or line items.
748
752
  */
749
753
 
750
754
  /**
@@ -760,12 +764,16 @@ const Joi = require("joi");
760
764
  /**
761
765
  * @typedef Shipment
762
766
  * @property {LineItem[]} line_items
763
- * @property {string} [external_shipment_id]
767
+ * @property {string} [external_shipment_id] - External shipment identifier or
768
+ * marketplace's unique shipment identifier.
764
769
  * @property {ProcessingDates} [processing_dates]
765
- * @property {Object} [meta]
766
- * @property {number} [priority]
767
- * @property {number} location_id
768
- * @property {string} [order_type]
770
+ * @property {Object} [meta] - Meta data of the shipment.
771
+ * @property {number} [priority] - Integer value indicating high and low priority.
772
+ * @property {number} location_id - Location Identifier or Store/Fulfillment
773
+ * Identifier of the shipment.
774
+ * @property {string} [order_type] - The order type of shipment HomeDelivery -
775
+ * If the customer wants the order home-delivered PickAtStore - If the
776
+ * customer wants the handover of an order at the store itself.
769
777
  * @property {string} [parent_type]
770
778
  * @property {string} [store_invoice_id]
771
779
  * @property {string} [lock_status]
@@ -795,6 +803,17 @@ const Joi = require("joi");
795
803
  * @property {ShipmentGstDetails} [gst]
796
804
  */
797
805
 
806
+ /**
807
+ * @typedef ShipmentRequestData
808
+ * @property {LineItem[]} line_items
809
+ * @property {ProcessingDates} [processing_dates]
810
+ * @property {Object} [meta] - Meta data of the shipment.
811
+ * @property {number} [priority] - Integer value indicating high and low priority.
812
+ * @property {string} [order_type] - The order type of shipment HomeDelivery -
813
+ * If the customer wants the order home-delivered PickAtStore - If the
814
+ * customer wants the handover of an order at the store itself.
815
+ */
816
+
798
817
  /**
799
818
  * @typedef ShippingInfo
800
819
  * @property {string} [alternate_mobile_number]
@@ -895,6 +914,7 @@ const Joi = require("joi");
895
914
  /**
896
915
  * @typedef CreateOrderAPI
897
916
  * @property {Shipment[]} shipments
917
+ * @property {ShipmentRequestData} [shipment_request_data]
898
918
  * @property {ShippingInfo} shipping_info
899
919
  * @property {BillingInfo} billing_info
900
920
  * @property {Object} [currency_info]
@@ -1307,15 +1327,18 @@ const Joi = require("joi");
1307
1327
  /**
1308
1328
  * @typedef Filters
1309
1329
  * @property {DateRange} [date_range]
1310
- * @property {string} [logo]
1311
- * @property {string} [from_date]
1312
- * @property {number} [stores]
1313
- * @property {string} [to_date]
1314
- * @property {string} [dp_name]
1315
- * @property {number} [dp_ids]
1316
- * @property {string} [lane]
1317
- * @property {string} [selected_shipments]
1318
- * @property {string} [store_name]
1330
+ * @property {string} [logo] - CDN link of the logo displayed on the manifest page.
1331
+ * @property {string} [from_date] - UTC start date in ISO format.
1332
+ * @property {number} [stores] - Filter with the specific store.
1333
+ * @property {string} [to_date] - UTC end date in ISO format.
1334
+ * @property {string} [dp_name] - Filter with the specific courier partner name.
1335
+ * @property {string} [dp_ids] - Combination of courier partner ids separated by
1336
+ * byte operator.
1337
+ * @property {string} [lane] - Criteria for lane on which shipments must be fetched.
1338
+ * @property {string} [selected_shipments] - Selected shipments mapped to the manifest.
1339
+ * @property {string} [store_name] - Filter with the specific store name.
1340
+ * @property {string} [deselected_shipments] - Deselected shipments unmapped
1341
+ * from the manifest.
1319
1342
  */
1320
1343
 
1321
1344
  /**
@@ -1405,10 +1428,10 @@ const Joi = require("joi");
1405
1428
 
1406
1429
  /**
1407
1430
  * @typedef ProcessManifestResponse
1408
- * @property {number} [company_id]
1431
+ * @property {number} [company_id] - Id of the company.
1409
1432
  * @property {Filters} [filters]
1410
- * @property {string} [user_id]
1411
- * @property {string} [manifest_id]
1433
+ * @property {string} [user_id] - Id of the user.
1434
+ * @property {string} [manifest_id] - Id of the manifest.
1412
1435
  * @property {string} [action]
1413
1436
  * @property {string} [uid]
1414
1437
  * @property {string} [created_by]
@@ -1624,6 +1647,40 @@ const Joi = require("joi");
1624
1647
  * @property {GenerateInvoiceIDErrorResponseData[]} [items]
1625
1648
  */
1626
1649
 
1650
+ /**
1651
+ * @typedef ManifestResponse
1652
+ * @property {ManifestItems} [items]
1653
+ */
1654
+
1655
+ /**
1656
+ * @typedef ProcessManifestRequest
1657
+ * @property {string} [action] - Expected Actions: [save, process,
1658
+ * pdf_generated,invalidate,pdf_failed,complete]
1659
+ * @property {string} [manifest_id] - Id of The Manifest.
1660
+ * @property {Filters} [filters]
1661
+ * @property {string} [unique_id] - Unique Id.
1662
+ */
1663
+
1664
+ /**
1665
+ * @typedef ManifestItems
1666
+ * @property {Filters} [filters]
1667
+ * @property {string} [manifest_id] - Id of the manifest.
1668
+ * @property {string} [unique_id] - Unique Id.
1669
+ * @property {number} [company_id] - Id of the company.
1670
+ * @property {string} [dp_id] - Shipment with the specific courier partner Id.
1671
+ * @property {string} [courier_partner_slug]
1672
+ * @property {string} [action] - Expected Actions: [Save, Process, Pdf
1673
+ * Generated, Invalidate, Pdf Failed, Complete]
1674
+ * @property {string} [created_by] - Created date of the manifest.
1675
+ * @property {string} [user_id] - Id of user.
1676
+ */
1677
+
1678
+ /**
1679
+ * @typedef ManifestErrorResponse
1680
+ * @property {boolean} [success] - Success State.
1681
+ * @property {string} [error] - Error String.
1682
+ */
1683
+
1627
1684
  /**
1628
1685
  * @typedef Page
1629
1686
  * @property {number} [item_total]
@@ -3451,6 +3508,7 @@ class OrderPlatformModel {
3451
3508
  lock_after_transition: Joi.boolean(),
3452
3509
  unlock_before_transition: Joi.boolean(),
3453
3510
  task: Joi.boolean(),
3511
+ resume_tasks_after_unlock: Joi.boolean(),
3454
3512
  });
3455
3513
  }
3456
3514
 
@@ -4111,6 +4169,17 @@ class OrderPlatformModel {
4111
4169
  });
4112
4170
  }
4113
4171
 
4172
+ /** @returns {ShipmentRequestData} */
4173
+ static ShipmentRequestData() {
4174
+ return Joi.object({
4175
+ line_items: Joi.array().items(OrderPlatformModel.LineItem()).required(),
4176
+ processing_dates: OrderPlatformModel.ProcessingDates(),
4177
+ meta: Joi.any(),
4178
+ priority: Joi.number(),
4179
+ order_type: Joi.string().allow(""),
4180
+ });
4181
+ }
4182
+
4114
4183
  /** @returns {ShippingInfo} */
4115
4184
  static ShippingInfo() {
4116
4185
  return Joi.object({
@@ -4224,6 +4293,7 @@ class OrderPlatformModel {
4224
4293
  static CreateOrderAPI() {
4225
4294
  return Joi.object({
4226
4295
  shipments: Joi.array().items(OrderPlatformModel.Shipment()).required(),
4296
+ shipment_request_data: OrderPlatformModel.ShipmentRequestData(),
4227
4297
  shipping_info: OrderPlatformModel.ShippingInfo().required(),
4228
4298
  billing_info: OrderPlatformModel.BillingInfo().required(),
4229
4299
  currency_info: Joi.any(),
@@ -4747,10 +4817,11 @@ class OrderPlatformModel {
4747
4817
  stores: Joi.number(),
4748
4818
  to_date: Joi.string().allow(""),
4749
4819
  dp_name: Joi.string().allow(""),
4750
- dp_ids: Joi.number(),
4820
+ dp_ids: Joi.string().allow(""),
4751
4821
  lane: Joi.string().allow(""),
4752
4822
  selected_shipments: Joi.string().allow(""),
4753
4823
  store_name: Joi.string().allow(""),
4824
+ deselected_shipments: Joi.string().allow(""),
4754
4825
  });
4755
4826
  }
4756
4827
 
@@ -5156,6 +5227,46 @@ class OrderPlatformModel {
5156
5227
  });
5157
5228
  }
5158
5229
 
5230
+ /** @returns {ManifestResponse} */
5231
+ static ManifestResponse() {
5232
+ return Joi.object({
5233
+ items: OrderPlatformModel.ManifestItems(),
5234
+ });
5235
+ }
5236
+
5237
+ /** @returns {ProcessManifestRequest} */
5238
+ static ProcessManifestRequest() {
5239
+ return Joi.object({
5240
+ action: Joi.string().allow(""),
5241
+ manifest_id: Joi.string().allow(""),
5242
+ filters: OrderPlatformModel.Filters(),
5243
+ unique_id: Joi.string().allow(""),
5244
+ });
5245
+ }
5246
+
5247
+ /** @returns {ManifestItems} */
5248
+ static ManifestItems() {
5249
+ return Joi.object({
5250
+ filters: OrderPlatformModel.Filters(),
5251
+ manifest_id: Joi.string().allow(""),
5252
+ unique_id: Joi.string().allow(""),
5253
+ company_id: Joi.number(),
5254
+ dp_id: Joi.string().allow("").allow(null),
5255
+ courier_partner_slug: Joi.string().allow(""),
5256
+ action: Joi.string().allow(""),
5257
+ created_by: Joi.string().allow(""),
5258
+ user_id: Joi.string().allow(""),
5259
+ });
5260
+ }
5261
+
5262
+ /** @returns {ManifestErrorResponse} */
5263
+ static ManifestErrorResponse() {
5264
+ return Joi.object({
5265
+ success: Joi.boolean(),
5266
+ error: Joi.string().allow(""),
5267
+ });
5268
+ }
5269
+
5159
5270
  /** @returns {Page} */
5160
5271
  static Page() {
5161
5272
  return Joi.object({
@@ -31,7 +31,6 @@ export = OrderPlatformValidator;
31
31
  */
32
32
  /**
33
33
  * @typedef DispatchManifestsParam
34
- * @property {string} manifestId
35
34
  * @property {OrderPlatformModel.DispatchManifest} body
36
35
  */
37
36
  /**
@@ -69,6 +68,10 @@ export = OrderPlatformValidator;
69
68
  * @property {string} [shipmentId]
70
69
  * @property {string} [documentType]
71
70
  */
71
+ /**
72
+ * @typedef GenerateProcessManifestParam
73
+ * @property {OrderPlatformModel.ProcessManifestRequest} body
74
+ */
72
75
  /**
73
76
  * @typedef GetAllowedStateTransitionParam
74
77
  * @property {string} orderingChannel - Ordering channel
@@ -151,16 +154,18 @@ export = OrderPlatformValidator;
151
154
  */
152
155
  /**
153
156
  * @typedef GetManifestShipmentsParam
154
- * @property {number} dpIds
155
- * @property {string} stores
156
- * @property {string} toDate
157
- * @property {string} fromDate
158
- * @property {string} [dpName]
159
- * @property {string} [salesChannels]
160
- * @property {string} [searchType]
161
- * @property {string} [searchValue]
162
- * @property {string} [pageNo]
163
- * @property {string} [pageSize]
157
+ * @property {string} dpIds - Filter shipments with the specific Courier partner
158
+ * Ids which is a combination of courier partner extension and scheme Ids.
159
+ * @property {number} stores - Filter with the specific store.
160
+ * @property {string} toDate - End date for the shipment search range.
161
+ * @property {string} fromDate - Start date for the shipment search range.
162
+ * @property {string} [dpName] - Filter with the specific courier partner name.
163
+ * @property {string} [salesChannels] - Comma-separated list of sales channels.
164
+ * @property {string} [searchType] - Type of search (e.g., by shipment ID, order
165
+ * ID, AWB number).
166
+ * @property {string} [searchValue] - Value to search for based on the search type.
167
+ * @property {number} [pageNo] - Page number for pagination.
168
+ * @property {number} [pageSize] - Number of records per page for pagination.
164
169
  */
165
170
  /**
166
171
  * @typedef GetManifestfiltersParam
@@ -398,6 +403,8 @@ declare class OrderPlatformValidator {
398
403
  static generateInvoiceID(): GenerateInvoiceIDParam;
399
404
  /** @returns {GeneratePOSReceiptByOrderIdParam} */
400
405
  static generatePOSReceiptByOrderId(): GeneratePOSReceiptByOrderIdParam;
406
+ /** @returns {GenerateProcessManifestParam} */
407
+ static generateProcessManifest(): GenerateProcessManifestParam;
401
408
  /** @returns {GetAllowedStateTransitionParam} */
402
409
  static getAllowedStateTransition(): GetAllowedStateTransitionParam;
403
410
  /** @returns {GetAllowedTemplatesForBulkParam} */
@@ -480,7 +487,7 @@ declare class OrderPlatformValidator {
480
487
  static verifyMobileOTP(): VerifyMobileOTPParam;
481
488
  }
482
489
  declare namespace OrderPlatformValidator {
483
- export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
490
+ export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
484
491
  }
485
492
  type AttachOrderUserParam = {
486
493
  body: OrderPlatformModel.AttachOrderUser;
@@ -528,7 +535,6 @@ type CreateOrderParam = {
528
535
  body: OrderPlatformModel.CreateOrderAPI;
529
536
  };
530
537
  type DispatchManifestsParam = {
531
- manifestId: string;
532
538
  body: OrderPlatformModel.DispatchManifest;
533
539
  };
534
540
  type DownloadBulkActionTemplateParam = {
@@ -567,6 +573,9 @@ type GeneratePOSReceiptByOrderIdParam = {
567
573
  shipmentId?: string;
568
574
  documentType?: string;
569
575
  };
576
+ type GenerateProcessManifestParam = {
577
+ body: OrderPlatformModel.ProcessManifestRequest;
578
+ };
570
579
  type GetAllowedStateTransitionParam = {
571
580
  /**
572
581
  * - Ordering channel
@@ -745,16 +754,48 @@ type GetManifestDetailsParam = {
745
754
  manifestId: string;
746
755
  };
747
756
  type GetManifestShipmentsParam = {
748
- dpIds: number;
749
- stores: string;
757
+ /**
758
+ * - Filter shipments with the specific Courier partner
759
+ * Ids which is a combination of courier partner extension and scheme Ids.
760
+ */
761
+ dpIds: string;
762
+ /**
763
+ * - Filter with the specific store.
764
+ */
765
+ stores: number;
766
+ /**
767
+ * - End date for the shipment search range.
768
+ */
750
769
  toDate: string;
770
+ /**
771
+ * - Start date for the shipment search range.
772
+ */
751
773
  fromDate: string;
774
+ /**
775
+ * - Filter with the specific courier partner name.
776
+ */
752
777
  dpName?: string;
778
+ /**
779
+ * - Comma-separated list of sales channels.
780
+ */
753
781
  salesChannels?: string;
782
+ /**
783
+ * - Type of search (e.g., by shipment ID, order
784
+ * ID, AWB number).
785
+ */
754
786
  searchType?: string;
787
+ /**
788
+ * - Value to search for based on the search type.
789
+ */
755
790
  searchValue?: string;
756
- pageNo?: string;
757
- pageSize?: string;
791
+ /**
792
+ * - Page number for pagination.
793
+ */
794
+ pageNo?: number;
795
+ /**
796
+ * - Number of records per page for pagination.
797
+ */
798
+ pageSize?: number;
758
799
  };
759
800
  type GetManifestfiltersParam = {
760
801
  /**
@@ -40,7 +40,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
40
40
 
41
41
  /**
42
42
  * @typedef DispatchManifestsParam
43
- * @property {string} manifestId
44
43
  * @property {OrderPlatformModel.DispatchManifest} body
45
44
  */
46
45
 
@@ -87,6 +86,11 @@ const OrderPlatformModel = require("./OrderPlatformModel");
87
86
  * @property {string} [documentType]
88
87
  */
89
88
 
89
+ /**
90
+ * @typedef GenerateProcessManifestParam
91
+ * @property {OrderPlatformModel.ProcessManifestRequest} body
92
+ */
93
+
90
94
  /**
91
95
  * @typedef GetAllowedStateTransitionParam
92
96
  * @property {string} orderingChannel - Ordering channel
@@ -180,16 +184,18 @@ const OrderPlatformModel = require("./OrderPlatformModel");
180
184
 
181
185
  /**
182
186
  * @typedef GetManifestShipmentsParam
183
- * @property {number} dpIds
184
- * @property {string} stores
185
- * @property {string} toDate
186
- * @property {string} fromDate
187
- * @property {string} [dpName]
188
- * @property {string} [salesChannels]
189
- * @property {string} [searchType]
190
- * @property {string} [searchValue]
191
- * @property {string} [pageNo]
192
- * @property {string} [pageSize]
187
+ * @property {string} dpIds - Filter shipments with the specific Courier partner
188
+ * Ids which is a combination of courier partner extension and scheme Ids.
189
+ * @property {number} stores - Filter with the specific store.
190
+ * @property {string} toDate - End date for the shipment search range.
191
+ * @property {string} fromDate - Start date for the shipment search range.
192
+ * @property {string} [dpName] - Filter with the specific courier partner name.
193
+ * @property {string} [salesChannels] - Comma-separated list of sales channels.
194
+ * @property {string} [searchType] - Type of search (e.g., by shipment ID, order
195
+ * ID, AWB number).
196
+ * @property {string} [searchValue] - Value to search for based on the search type.
197
+ * @property {number} [pageNo] - Page number for pagination.
198
+ * @property {number} [pageSize] - Number of records per page for pagination.
193
199
  */
194
200
 
195
201
  /**
@@ -477,7 +483,6 @@ class OrderPlatformValidator {
477
483
  /** @returns {DispatchManifestsParam} */
478
484
  static dispatchManifests() {
479
485
  return Joi.object({
480
- manifestId: Joi.string().allow("").required(),
481
486
  body: OrderPlatformModel.DispatchManifest().required(),
482
487
  }).required();
483
488
  }
@@ -541,6 +546,13 @@ class OrderPlatformValidator {
541
546
  }).required();
542
547
  }
543
548
 
549
+ /** @returns {GenerateProcessManifestParam} */
550
+ static generateProcessManifest() {
551
+ return Joi.object({
552
+ body: OrderPlatformModel.ProcessManifestRequest().required(),
553
+ }).required();
554
+ }
555
+
544
556
  /** @returns {GetAllowedStateTransitionParam} */
545
557
  static getAllowedStateTransition() {
546
558
  return Joi.object({
@@ -658,16 +670,16 @@ class OrderPlatformValidator {
658
670
  /** @returns {GetManifestShipmentsParam} */
659
671
  static getManifestShipments() {
660
672
  return Joi.object({
661
- dpIds: Joi.number().required(),
662
- stores: Joi.string().allow("").required(),
673
+ dpIds: Joi.string().allow("").required(),
674
+ stores: Joi.number().required(),
663
675
  toDate: Joi.string().allow("").required(),
664
676
  fromDate: Joi.string().allow("").required(),
665
677
  dpName: Joi.string().allow(""),
666
678
  salesChannels: Joi.string().allow(""),
667
679
  searchType: Joi.string().allow(""),
668
680
  searchValue: Joi.string().allow(""),
669
- pageNo: Joi.string().allow(""),
670
- pageSize: Joi.string().allow(""),
681
+ pageNo: Joi.number(),
682
+ pageSize: Joi.number(),
671
683
  }).required();
672
684
  }
673
685
 
@@ -132,7 +132,7 @@ export = PaymentPlatformModel;
132
132
  /**
133
133
  * @typedef AggregatorRoute
134
134
  * @property {Object} [data] - Data
135
- * @property {string} [payment_flow_data] - Payment_flow_data
135
+ * @property {Object} [payment_flow_data] - Payment_flow_data
136
136
  * @property {string} [payment_flow] - Payment_flow
137
137
  * @property {string} [api_link] - Api_link
138
138
  */
@@ -425,6 +425,7 @@ export = PaymentPlatformModel;
425
425
  */
426
426
  /**
427
427
  * @typedef SetCODForUserRequest
428
+ * @property {string} [business_unit] - Business unit
428
429
  * @property {string} mobileno - Mobile No. of User
429
430
  * @property {boolean} is_active - Either true or false
430
431
  * @property {string} merchant_user_id - Merchant User id
@@ -591,6 +592,8 @@ export = PaymentPlatformModel;
591
592
  * @typedef LinkStatus
592
593
  * @property {string} status - Link action status
593
594
  * @property {string} message - Message
595
+ * @property {boolean} [is_payment_done] - This key specifies payment done
596
+ * status of payment link.
594
597
  */
595
598
  /**
596
599
  * @typedef ResendOrCancelPaymentResponse
@@ -1561,7 +1564,7 @@ type AggregatorRoute = {
1561
1564
  /**
1562
1565
  * - Payment_flow_data
1563
1566
  */
1564
- payment_flow_data?: string;
1567
+ payment_flow_data?: any;
1565
1568
  /**
1566
1569
  * - Payment_flow
1567
1570
  */
@@ -2270,6 +2273,10 @@ type GetUserCODLimitResponse = {
2270
2273
  /** @returns {SetCODForUserRequest} */
2271
2274
  declare function SetCODForUserRequest(): SetCODForUserRequest;
2272
2275
  type SetCODForUserRequest = {
2276
+ /**
2277
+ * - Business unit
2278
+ */
2279
+ business_unit?: string;
2273
2280
  /**
2274
2281
  * - Mobile No. of User
2275
2282
  */
@@ -2740,6 +2747,11 @@ type LinkStatus = {
2740
2747
  * - Message
2741
2748
  */
2742
2749
  message: string;
2750
+ /**
2751
+ * - This key specifies payment done
2752
+ * status of payment link.
2753
+ */
2754
+ is_payment_done?: boolean;
2743
2755
  };
2744
2756
  /** @returns {ResendOrCancelPaymentResponse} */
2745
2757
  declare function ResendOrCancelPaymentResponse(): ResendOrCancelPaymentResponse;
@@ -148,7 +148,7 @@ const Joi = require("joi");
148
148
  /**
149
149
  * @typedef AggregatorRoute
150
150
  * @property {Object} [data] - Data
151
- * @property {string} [payment_flow_data] - Payment_flow_data
151
+ * @property {Object} [payment_flow_data] - Payment_flow_data
152
152
  * @property {string} [payment_flow] - Payment_flow
153
153
  * @property {string} [api_link] - Api_link
154
154
  */
@@ -479,6 +479,7 @@ const Joi = require("joi");
479
479
 
480
480
  /**
481
481
  * @typedef SetCODForUserRequest
482
+ * @property {string} [business_unit] - Business unit
482
483
  * @property {string} mobileno - Mobile No. of User
483
484
  * @property {boolean} is_active - Either true or false
484
485
  * @property {string} merchant_user_id - Merchant User id
@@ -664,6 +665,8 @@ const Joi = require("joi");
664
665
  * @typedef LinkStatus
665
666
  * @property {string} status - Link action status
666
667
  * @property {string} message - Message
668
+ * @property {boolean} [is_payment_done] - This key specifies payment done
669
+ * status of payment link.
667
670
  */
668
671
 
669
672
  /**
@@ -1500,7 +1503,7 @@ class PaymentPlatformModel {
1500
1503
  static AggregatorRoute() {
1501
1504
  return Joi.object({
1502
1505
  data: Joi.any().allow(null),
1503
- payment_flow_data: Joi.string().allow("").allow(null),
1506
+ payment_flow_data: Joi.any().allow(null),
1504
1507
  payment_flow: Joi.string().allow("").allow(null),
1505
1508
  api_link: Joi.string().allow("").allow(null),
1506
1509
  });
@@ -1919,6 +1922,7 @@ class PaymentPlatformModel {
1919
1922
  /** @returns {SetCODForUserRequest} */
1920
1923
  static SetCODForUserRequest() {
1921
1924
  return Joi.object({
1925
+ business_unit: Joi.string().allow(""),
1922
1926
  mobileno: Joi.string().allow("").required(),
1923
1927
  is_active: Joi.boolean().required(),
1924
1928
  merchant_user_id: Joi.string().allow("").required(),
@@ -2139,6 +2143,7 @@ class PaymentPlatformModel {
2139
2143
  return Joi.object({
2140
2144
  status: Joi.string().allow("").required(),
2141
2145
  message: Joi.string().allow("").required(),
2146
+ is_payment_done: Joi.boolean(),
2142
2147
  });
2143
2148
  }
2144
2149
 
@@ -15,6 +15,7 @@ declare class PlatformApplicationClient {
15
15
  config: import("./PlatformConfig");
16
16
  companyId: string;
17
17
  applicationId: string;
18
+ analytics: Analytics;
18
19
  cart: Cart;
19
20
  catalog: Catalog;
20
21
  communication: Communication;
@@ -38,6 +39,7 @@ declare class PlatformApplicationClient {
38
39
  */
39
40
  setExtraHeaders(header: object): void;
40
41
  }
42
+ import Analytics = require("./Analytics/AnalyticsPlatformApplicationClient");
41
43
  import Cart = require("./Cart/CartPlatformApplicationClient");
42
44
  import Catalog = require("./Catalog/CatalogPlatformApplicationClient");
43
45
  import Communication = require("./Communication/CommunicationPlatformApplicationClient");
@@ -1,3 +1,5 @@
1
+ const Analytics = require("./Analytics/AnalyticsPlatformApplicationClient");
2
+
1
3
  const Cart = require("./Cart/CartPlatformApplicationClient");
2
4
 
3
5
  const Catalog = require("./Catalog/CatalogPlatformApplicationClient");
@@ -47,6 +49,8 @@ class PlatformApplicationClient {
47
49
  this.companyId = config.companyId;
48
50
  this.applicationId = applicationId;
49
51
 
52
+ this.analytics = new Analytics(config, applicationId);
53
+
50
54
  this.cart = new Cart(config, applicationId);
51
55
 
52
56
  this.catalog = new Catalog(config, applicationId);
@@ -1865,10 +1865,10 @@ class ServiceabilityPlatformModel {
1865
1865
  /** @returns {ArithmeticOperations} */
1866
1866
  static ArithmeticOperations() {
1867
1867
  return Joi.object({
1868
- lt: Joi.number(),
1869
- gt: Joi.number(),
1870
- lte: Joi.number(),
1871
- gte: Joi.number(),
1868
+ lt: Joi.number().allow(null),
1869
+ gt: Joi.number().allow(null),
1870
+ lte: Joi.number().allow(null),
1871
+ gte: Joi.number().allow(null),
1872
1872
  });
1873
1873
  }
1874
1874
 
@@ -109,6 +109,18 @@ declare class Theme {
109
109
  * @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAppliedTheme/).
110
110
  */
111
111
  getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
112
+ /**
113
+ * @param {ThemePlatformApplicationValidator.GetExtensionSectionsParam} arg
114
+ * - Arg object
115
+ *
116
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
117
+ * @param {import("../PlatformAPIClient").Options} - Options
118
+ * @returns {Promise<ThemePlatformModel.GetExtensionSectionRes[]>} - Success response
119
+ * @name getExtensionSections
120
+ * @summary: Get extension sections
121
+ * @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getExtensionSections/).
122
+ */
123
+ getExtensionSections({ type, companyMode, requestHeaders }?: ThemePlatformApplicationValidator.GetExtensionSectionsParam, { responseHeaders }?: object): Promise<ThemePlatformModel.GetExtensionSectionRes[]>;
112
124
  /**
113
125
  * @param {ThemePlatformApplicationValidator.GetFontsParam} arg - Arg object
114
126
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`