@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

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 (278) hide show
  1. package/README.md +23 -26
  2. package/package.json +5 -1
  3. package/sdk/application/ApplicationClient.d.ts +5 -6
  4. package/sdk/application/ApplicationClient.js +24 -20
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
  6. package/sdk/application/Cart/CartApplicationClient.js +444 -76
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
  16. package/sdk/application/Content/ContentApplicationClient.js +274 -111
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +6 -6
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
  26. package/sdk/application/Order/OrderApplicationClient.js +217 -17
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
  28. package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
  32. package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
  33. package/sdk/application/User/UserApplicationClient.d.ts +103 -53
  34. package/sdk/application/User/UserApplicationClient.js +308 -49
  35. package/sdk/common/AxiosHelper.js +11 -4
  36. package/sdk/common/Constant.d.ts +27 -4
  37. package/sdk/common/Constant.js +33 -6
  38. package/sdk/common/utils.d.ts +10 -0
  39. package/sdk/common/utils.js +24 -3
  40. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
  41. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
  43. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
  44. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
  45. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
  46. package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
  47. package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
  48. package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
  49. package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
  50. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
  51. package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
  52. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
  53. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
  54. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
  55. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
  56. package/sdk/partner/PartnerClient.d.ts +5 -2
  57. package/sdk/partner/PartnerClient.js +21 -7
  58. package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
  59. package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
  60. package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
  61. package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
  62. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  63. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
  64. package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
  65. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
  66. package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
  67. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
  68. package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
  69. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
  70. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
  71. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  73. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
  75. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  81. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  82. package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
  83. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  84. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  85. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  86. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  87. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
  89. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
  91. package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
  92. package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
  93. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
  97. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
  98. package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
  99. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
  101. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
  103. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
  104. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  105. package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
  106. package/sdk/platform/Common/CommonPlatformModel.js +25 -14
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
  111. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  112. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  113. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
  114. package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
  124. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
  126. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
  128. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  130. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
  132. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
  134. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
  135. package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
  136. package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
  137. package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
  138. package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
  139. package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
  140. package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
  141. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
  142. package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
  143. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
  144. package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  146. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
  150. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
  152. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
  154. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  156. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  159. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  160. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  161. package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
  162. package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
  163. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
  164. package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
  165. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
  166. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
  167. package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
  168. package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
  169. package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
  170. package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
  171. package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
  172. package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
  173. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
  175. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  177. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
  178. package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
  179. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
  180. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
  181. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
  182. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
  183. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
  184. package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
  185. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
  186. package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
  187. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  188. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  189. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  190. package/sdk/platform/PlatformApplicationClient.js +0 -4
  191. package/sdk/platform/PlatformClient.d.ts +5 -4
  192. package/sdk/platform/PlatformClient.js +32 -22
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
  203. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  204. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
  206. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  212. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
  214. package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
  215. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
  216. package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
  217. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
  218. package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
  219. package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
  220. package/sdk/platform/User/UserPlatformModel.js +607 -46
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  226. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  227. package/sdk/platform/index.d.ts +0 -2
  228. package/sdk/platform/index.js +0 -4
  229. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  230. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  231. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  232. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  233. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  234. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
  239. package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
  240. package/sdk/public/Content/ContentPublicClient.js +1067 -17
  241. package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
  242. package/sdk/public/Content/ContentPublicModel.js +751 -3
  243. package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
  244. package/sdk/public/Content/ContentPublicValidator.js +119 -2
  245. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  246. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  247. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  248. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  249. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  250. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  251. package/sdk/public/PublicClient.d.ts +5 -2
  252. package/sdk/public/PublicClient.js +16 -6
  253. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
  254. package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
  255. package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
  256. package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
  257. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  258. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  259. package/sdk/public/index.d.ts +1 -0
  260. package/sdk/public/index.js +2 -0
  261. package/utility.d.ts +3 -0
  262. package/utility.js +7 -0
  263. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  264. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  265. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
  266. package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
  267. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  268. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  269. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  270. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  271. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  272. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
@@ -35,9 +35,35 @@ const OrderPlatformModel = require("./OrderPlatformModel");
35
35
  * @property {OrderPlatformModel.OrderStatus} body
36
36
  */
37
37
 
38
+ /**
39
+ * @typedef CreateAccountParam
40
+ * @property {OrderPlatformModel.CreateAccount} body
41
+ */
42
+
43
+ /**
44
+ * @typedef CreateChannelConfigParam
45
+ * @property {OrderPlatformModel.CreateChannelConfigData} body
46
+ */
47
+
38
48
  /**
39
49
  * @typedef CreateOrderParam
40
- * @property {OrderPlatformModel.CreateOrderAPI} body
50
+ * @property {string} xOrderingSource - To uniquely identify the source through
51
+ * which order has been placed.
52
+ * @property {string} [xApplicationId] - The Application ID is a unique
53
+ * identifier assigned to a storefront that typically follows a 24-character
54
+ * hexadecimal string. Either `x-application-id` or `x-extension-id` header is
55
+ * mandatory. At least one of them must be provided.
56
+ * @property {string} [xExtensionId] - The Extension ID is a unique identifier
57
+ * assigned to an extension that typically follows a 24-character hexadecimal
58
+ * string. Either `x-application-id` or `x-extension-id` header is mandatory.
59
+ * At least one of them must be provided.
60
+ * @property {OrderPlatformModel.CreateOrderRequestSchema} body
61
+ */
62
+
63
+ /**
64
+ * @typedef CreateShipmentPackagesParam
65
+ * @property {string} shipmentId - Unique identifier of the shipment.
66
+ * @property {OrderPlatformModel.PackagesSchema} body
41
67
  */
42
68
 
43
69
  /**
@@ -52,7 +78,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
52
78
 
53
79
  /**
54
80
  * @typedef DownloadLanesReportParam
55
- * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
81
+ * @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
56
82
  */
57
83
 
58
84
  /**
@@ -94,12 +120,22 @@ const OrderPlatformModel = require("./OrderPlatformModel");
94
120
 
95
121
  /**
96
122
  * @typedef GenerateProcessManifestParam
97
- * @property {OrderPlatformModel.ProcessManifestRequest} body
123
+ * @property {OrderPlatformModel.ProcessManifestRequestSchema} body
124
+ */
125
+
126
+ /**
127
+ * @typedef GetAccountByIdParam
128
+ * @property {string} channelAccountId - Unique identifier of the channel
129
+ * account to retrieve.
98
130
  */
99
131
 
100
132
  /**
101
133
  * @typedef GetAllowedStateTransitionParam
102
- * @property {string} orderingChannel - The channel through which orders are placed.
134
+ * @property {string} [orderingChannel] - The specific channel through which
135
+ * your order was placed. This field will be phased out after version 2.4.0.
136
+ * Please use ordering_source instead to ensure accurate order tracking and processing.
137
+ * @property {string} [orderingSource] - To uniquely identify the source through
138
+ * which order has been placed.
103
139
  * @property {string} status - The status key indicates the current status for
104
140
  * which the API will provide a list of possible next state transitions.
105
141
  */
@@ -113,7 +149,7 @@ const OrderPlatformModel = require("./OrderPlatformModel");
113
149
 
114
150
  /**
115
151
  * @typedef GetBagByIdParam
116
- * @property {string} [bagId] - Id of bag
152
+ * @property {string} [bagId] - Unique identifier of a bag
117
153
  * @property {string} [channelBagId] - Id of application bag
118
154
  * @property {string} [channelId] - Id of application
119
155
  */
@@ -137,8 +173,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
137
173
  * @typedef GetBulkShipmentExcelFileParam
138
174
  * @property {string} [salesChannels] - Comma separated values of sales channel ids
139
175
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
140
- * @property {string} [startDate] - UTC start date in ISO format
141
- * @property {string} [endDate] - UTC end date in ISO format
176
+ * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
177
+ * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
142
178
  * @property {string} [stores] - Comma separated values of store ids
143
179
  * @property {string} [tags] - Comma separated values of tags
144
180
  * @property {string} [bagStatus] - Comma separated values of bag statuses
@@ -149,11 +185,13 @@ const OrderPlatformModel = require("./OrderPlatformModel");
149
185
  * @property {number} [pageSize]
150
186
  */
151
187
 
188
+ /** @typedef GetChannelConfigParam */
189
+
152
190
  /**
153
191
  * @typedef GetFileByStatusParam
154
192
  * @property {string} batchId - Batch Id to identify the bulk operation request.
155
193
  * @property {string} status - The status of the jobs to filter the results.
156
- * @property {string} fileType - The type of file to be downloaded.
194
+ * @property {string} fileType
157
195
  * @property {string} [reportType] - The type of report to be downloaded.
158
196
  */
159
197
 
@@ -170,15 +208,27 @@ const OrderPlatformModel = require("./OrderPlatformModel");
170
208
  * @property {string} [salesChannels]
171
209
  * @property {string} [paymentMode] - Comma separated values of payment modes
172
210
  * @property {string} [bagStatus] - Comma separated values of bag statuses
173
- * @property {string} [searchType]
211
+ * @property {string} [searchType] - Search_type refers to the field that will
212
+ * be used as the target for the search operation
174
213
  * @property {string} [searchValue]
175
214
  * @property {string} [tags]
176
- * @property {number} [timeToDispatch]
215
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
177
216
  * @property {string} [paymentMethods]
178
217
  * @property {boolean} [myOrders]
179
218
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
180
219
  * company order
181
- * @property {string} [orderType]
220
+ * @property {string} [orderType] - Defines the specific journey a shipment will
221
+ * follow based on the application's operational needs and customer
222
+ * preferences. This field categorizes orders into distinct types, each
223
+ * associated with a unique processing flow. For example:
224
+ *
225
+ * - "HomeDelivery": The order goes through all the steps needed for delivery,
226
+ * from being packed to arriving at the customer’s address.
227
+ * - "PickAtStore": The order is prepared for pickup at the store, skipping
228
+ * shipping steps to make it ready faster for the customer to collect in person.
229
+ * - "Digital": This order type likely refers to orders that involve digital goods
230
+ * or services, such as software, digital subscriptions, e-books, online
231
+ * courses, or any other item that can be delivered electronically.
182
232
  */
183
233
 
184
234
  /**
@@ -241,46 +291,64 @@ const OrderPlatformModel = require("./OrderPlatformModel");
241
291
  /**
242
292
  * @typedef GetOrdersParam
243
293
  * @property {string} [lane] - Lane refers to a section where orders are
244
- * assigned, indicating its grouping
294
+ * assigned, indicating its grouping.
245
295
  * @property {string} [searchType] - Search_type refers to the field that will
246
- * be used as the target for the search operation
296
+ * be used as the target for the search operation.
247
297
  * @property {string} [bagStatus] - Bag_status refers to status of the entity.
248
298
  * Filters orders based on the status.
249
299
  * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
250
- * @property {string} [paymentMethods]
300
+ * @property {string} [paymentMethods] - Comma separated values of payment
301
+ * methods that were used to place order.
251
302
  * @property {string} [tags] - Tags refers to additional descriptive labels
252
303
  * associated with the order
253
304
  * @property {string} [searchValue] - Search_value is matched against the field
254
305
  * specified by the search_type
255
- * @property {string} [fromDate]
256
- * @property {string} [toDate]
257
- * @property {string} [startDate]
258
- * @property {string} [endDate]
306
+ * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
307
+ * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
308
+ * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
309
+ * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
259
310
  * @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
260
- * @property {string} [stores]
261
- * @property {string} [salesChannels]
262
- * @property {number} [pageNo]
263
- * @property {number} [pageSize]
311
+ * @property {string} [stores] - A comma-separated list of store IDs used to
312
+ * filter results to only those related to specific stores.
313
+ * @property {string} [salesChannels] - A comma-separated list of sales channel
314
+ * IDs to filter results based on the sales channels involved.
315
+ * @property {number} [pageNo] - Specifies the page number for paginated results.
316
+ * @property {number} [pageSize] - Determines the number of results returned per page.
264
317
  * @property {boolean} [isPrioritySort]
265
318
  * @property {string} [customMeta]
266
319
  * @property {boolean} [myOrders]
267
320
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
268
321
  * company order
269
- * @property {string} [customerId]
322
+ * @property {string} [customerId] - The unique identifier for the customer
323
+ * associated with the query, useful for filtering results to a specific customer.
270
324
  * @property {string} [orderType]
271
325
  * @property {boolean} [allowInactive] - Flag indicating whether inactive
272
326
  * shipments are allowed
327
+ * @property {string} [groupEntity] - Defines the grouping criterion for
328
+ * retrieving shipments or orders. It specifies whether the results should be
329
+ * organized based on shipment groups or order groups. For example, using
330
+ * 'shipments' groups results by shipment, while an invalid value like 'abcd'
331
+ * may not be recognized, leading to errors or default behavior.
273
332
  * @property {boolean} [enforceDateFilter] - Applies a date filter for listing
274
333
  * orders. This is useful when fetching data for a specific date range while
275
334
  * performing searches.
335
+ * @property {string} [fulfillmentType] - Define the Fulfillment Type for
336
+ * Listing Orders, This is use when we want to get list of shipments or orders
337
+ * by cross store or cross company or fulfilling Store (by default), this is
338
+ * also depends on the login user accessType and store access
339
+ * @property {string} [orderingSource] - Filter orders by ordering source.
340
+ * Accepts comma-separated values for multiple sources.
341
+ * @property {string} [channelAccountId] - Comma-separated channel account IDs
342
+ * to filter orders by specific channel accounts.
276
343
  */
277
344
 
278
345
  /** @typedef GetRoleBasedActionsParam */
279
346
 
280
347
  /**
281
348
  * @typedef GetShipmentByIdParam
282
- * @property {string} [channelShipmentId] - App Shipment Id
283
- * @property {string} [shipmentId] - Shipment Id
349
+ * @property {string} [channelShipmentId] - The shipment ID used in the
350
+ * application, which can be used to reference specific shipments.
351
+ * @property {string} [shipmentId] - The unique identifier for a shipment.
284
352
  * @property {boolean} [fetchActiveShipment] - Flag to fetch active or
285
353
  * deactivated shipments
286
354
  * @property {boolean} [allowInactive] - Flag indicating whether inactive
@@ -293,6 +361,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
293
361
  * @property {number} [bagId] - Identifier for a bag or product.
294
362
  */
295
363
 
364
+ /**
365
+ * @typedef GetShipmentPackagesParam
366
+ * @property {string} shipmentId - Unique identifier for the shipment whose
367
+ * packages are being retrieved.
368
+ */
369
+
296
370
  /**
297
371
  * @typedef GetShipmentReasonsParam
298
372
  * @property {string} shipmentId - ID of the shipment. An order may contain
@@ -306,47 +380,92 @@ const OrderPlatformModel = require("./OrderPlatformModel");
306
380
  /**
307
381
  * @typedef GetShipmentsParam
308
382
  * @property {string} [lane] - Name of lane for which data is to be fetched
309
- * @property {string} [bagStatus] - Comma separated values of bag statuses
383
+ * @property {string} [bagStatus] - Comma separated values of bag statuses.
384
+ * @property {string} [statusAssigned] - Used to filter shipments based on
385
+ * status present in shipment_status_history. For more information on these
386
+ * statuses, refer to the Fynd Partners documentation.
310
387
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
311
- * bag_status and override lane
312
- * @property {number} [timeToDispatch]
313
- * @property {string} [searchType] - Search type key
314
- * @property {string} [searchValue] - Search type value
388
+ * bag_status and override lane.
389
+ * @property {number} [timeToDispatch] - Indicates the time to dispatch.
390
+ * @property {string} [searchType] - Specifies the key used to determine the
391
+ * type of search being performed.
392
+ * @property {string} [searchValue] - The value corresponding to the search
393
+ * type, such as a specific shipment ID or order ID.
315
394
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
316
395
  * @property {string} [toDate] - End Date in DD-MM-YYYY format
317
- * @property {string} [startDate] - UTC Start Date in ISO format
318
- * @property {string} [endDate] - UTC End Date in ISO format
319
- * @property {string} [dpIds] - Comma separated values of delivery partner ids
320
- * @property {string} [stores] - Comma separated values of store ids
321
- * @property {string} [salesChannels] - Comma separated values of sales channel ids
322
- * @property {number} [pageNo] - Page number for paginated data
323
- * @property {number} [pageSize] - Page size of data received per page
324
- * @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
325
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments
326
- * @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
327
- * @property {string} [paymentMethods] - Comma separated values of payment methods
328
- * @property {string} [channelShipmentId] - App Shipment Id
329
- * @property {string} [channelOrderId] - App Order Id
330
- * @property {string} [customMeta]
331
- * @property {string} [orderingChannel]
332
- * @property {string} [companyAffiliateTag]
333
- * @property {boolean} [myOrders]
334
- * @property {string} [platformUserId]
335
- * @property {string} [sortType] - Sort the result data on basis of input
336
- * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
337
- * company order
338
- * @property {string} [tags] - Comma separated values of tags
339
- * @property {string} [customerId]
340
- * @property {string} [orderType]
396
+ * @property {string} [startDate] - The UTC start date in ISO format
397
+ * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
398
+ * @property {string} [endDate] - The UTC end date in ISO format
399
+ * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
400
+ * @property {string} [statusAssignedStartDate] - Specifies the starting UTC
401
+ * date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
402
+ * boundary for filtering shipments based on the `created_at` timestamp of
403
+ * statuses in the shipment's status history. It allows filtering statuses
404
+ * that were created within a specific time range.
405
+ * @property {string} [statusAssignedEndDate] - Specifies the ending UTC date
406
+ * and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
407
+ * for filtering shipments based on the `created_at` timestamp of statuses in
408
+ * the shipment's status history.
409
+ * @property {string} [dpIds] - A comma-separated list of delivery partner IDs
410
+ * to filter results by specific delivery partners.
411
+ * @property {string} [stores] - A comma-separated list of store IDs used to
412
+ * filter results to only those related to specific stores.
413
+ * @property {string} [salesChannels] - A comma-separated list of sales channel
414
+ * IDs to filter results based on the sales channels involved.
415
+ * @property {number} [pageNo] - Specifies the page number for paginated results.
416
+ * @property {number} [pageSize] - Determines the number of results returned per page.
417
+ * @property {boolean} [fetchActiveShipment] - A boolean flag that indicates
418
+ * whether to include only active shipments in the results.
419
+ * @property {boolean} [allowInactive] - A flag indicating whether to allow the
420
+ * inclusion of inactive shipments in the results.
421
+ * @property {boolean} [excludeLockedShipments] - A flag to specify whether to
422
+ * exclude shipments that are locked from the results.
423
+ * @property {string} [paymentMethods] - A comma-separated list of payment methods.
424
+ * @property {string} [channelShipmentId] - The shipment ID used in the
425
+ * application, which can be used to reference specific shipments.
426
+ * @property {string} [channelOrderId] - The order ID used in the application.
427
+ * @property {string} [customMeta] - Custom metadata associated with the query,
428
+ * allowing for additional filtering or information to be passed.
429
+ * @property {string} [orderingChannel] - The channel through which the order was placed.
430
+ * @property {string} [companyAffiliateTag] - A tag used to identify the
431
+ * company's affiliation for filtering or reporting purposes.
432
+ * @property {boolean} [myOrders] - A boolean flag indicating whether the query
433
+ * should return only the user's orders.
434
+ * @property {string} [platformUserId] - The unique identifier of the user on
435
+ * the platform, useful for filtering orders related to a specific user.
436
+ * @property {string} [sortType] - Determines the sorting order of the results
437
+ * based on specific criteria.
438
+ * @property {boolean} [showCrossCompanyData] - A flag indicating whether to
439
+ * include data from both cross-company and non-cross-company orders in the results.
440
+ * @property {string} [tags] - A comma-separated list of tags associated with
441
+ * the orders to filter results based on specific characteristics.
442
+ * @property {string} [customerId] - The unique identifier for the customer
443
+ * associated with the query, useful for filtering results to a specific customer.
444
+ * @property {string} [orderType] - The type of order being queried.
445
+ * @property {string} [groupEntity] - Defines the grouping criterion for
446
+ * retrieving shipments or orders. It specifies whether the results should be
447
+ * organized based on shipment groups or order groups. For example, using
448
+ * 'shipments' groups results by shipment, while an invalid value like 'abcd'
449
+ * may not be recognized, leading to errors or default behavior.
341
450
  * @property {boolean} [enforceDateFilter] - Applies a date filter for listing
342
451
  * shipments. This is useful when fetching data for a specific date range
343
452
  * while performing searches.
453
+ * @property {string} [fulfillmentType] - Define the Fulfillment Type for
454
+ * Listing Orders, This is use when we want to get list of shipments or orders
455
+ * by cross store or cross company or fulfilling Store (by default), this is
456
+ * also depends on the login user accessType and store access
457
+ * @property {string} [orderingSource] - Filter orders by ordering source.
458
+ * Accepts comma-separated values for multiple sources.
459
+ * @property {string} [channelAccountId] - Comma-separated channel account IDs
460
+ * to filter orders by specific channel accounts.
344
461
  */
345
462
 
346
463
  /**
347
464
  * @typedef GetStateManagerConfigParam
348
465
  * @property {string} [appId] - The unique identifier of the application.
349
466
  * @property {string} [orderingChannel] - The channel through which orders are placed.
467
+ * @property {string} [orderingSource] - To uniquely identify the source through
468
+ * which order has been placed.
350
469
  * @property {string} [entity] - The entity for which the configuration is applied.
351
470
  */
352
471
 
@@ -363,17 +482,20 @@ const OrderPlatformModel = require("./OrderPlatformModel");
363
482
  * @property {string} [groupEntity] - Name of group entity
364
483
  */
365
484
 
366
- /**
367
- * @typedef InvalidateShipmentCacheParam
368
- * @property {OrderPlatformModel.InvalidateShipmentCachePayload} body
369
- */
370
-
371
485
  /**
372
486
  * @typedef JobDetailsParam
373
487
  * @property {string} batchId - A unique identifier for the batch associated
374
488
  * with this bulk action.
375
489
  */
376
490
 
491
+ /**
492
+ * @typedef ListAccountsParam
493
+ * @property {number} [page] - The page number to retrieve in the paginated
494
+ * results. Default is page 1.
495
+ * @property {number} [size] - Number of channel accounts to return per page.
496
+ * Default is 20 items per page.
497
+ */
498
+
377
499
  /**
378
500
  * @typedef OrderUpdateParam
379
501
  * @property {OrderPlatformModel.PlatformOrderUpdate} body
@@ -389,6 +511,20 @@ const OrderPlatformModel = require("./OrderPlatformModel");
389
511
  * @property {OrderPlatformModel.StoreReassign} body
390
512
  */
391
513
 
514
+ /**
515
+ * @typedef RequestCourierPartnerForShipmentParam
516
+ * @property {string} shipmentId - The unique identifier for the shipment. This
517
+ * ID is used to track and reference the shipment throughout its journey.
518
+ * @property {OrderPlatformModel.ShipmentCourierPartnerRequestSchema} body
519
+ */
520
+
521
+ /**
522
+ * @typedef SaveCourierPartnerPreferenceForShipmentParam
523
+ * @property {string} shipmentId - The unique identifier for the shipment. This
524
+ * ID is used to track and reference the shipment throughout its journey.
525
+ * @property {OrderPlatformModel.ShipmentCourierPartnerPreference} body
526
+ */
527
+
392
528
  /**
393
529
  * @typedef SendSmsNinjaParam
394
530
  * @property {OrderPlatformModel.SendSmsPayload} body
@@ -407,20 +543,16 @@ const OrderPlatformModel = require("./OrderPlatformModel");
407
543
  * @property {number} [pageSize] - Number of records per page for pagination.
408
544
  */
409
545
 
546
+ /**
547
+ * @typedef UpdateAccountParam
548
+ * @property {string} channelAccountId - Unique identifier of the account.
549
+ * @property {OrderPlatformModel.CreateAccount} body
550
+ */
551
+
410
552
  /**
411
553
  * @typedef UpdateAddressParam
412
- * @property {string} shipmentId
413
- * @property {string} [name]
414
- * @property {string} [address]
415
- * @property {string} [addressType]
416
- * @property {string} [pincode]
417
- * @property {string} [phone]
418
- * @property {string} [email]
419
- * @property {string} [landmark]
420
- * @property {string} addressCategory
421
- * @property {string} [city]
422
- * @property {string} [state]
423
- * @property {string} [country]
554
+ * @property {string} shipmentId - Unique shipment no. that is auto-generated
555
+ * @property {OrderPlatformModel.UpdateAddressRequestBody} body
424
556
  */
425
557
 
426
558
  /**
@@ -428,11 +560,23 @@ const OrderPlatformModel = require("./OrderPlatformModel");
428
560
  * @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
429
561
  */
430
562
 
563
+ /**
564
+ * @typedef UpdatePaymentInfoParam
565
+ * @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
566
+ */
567
+
431
568
  /**
432
569
  * @typedef UpdateShipmentLockParam
433
570
  * @property {OrderPlatformModel.UpdateShipmentLockPayload} body
434
571
  */
435
572
 
573
+ /**
574
+ * @typedef UpdateShipmentPackagesParam
575
+ * @property {string} shipmentId - Unique identifier for the shipment whose
576
+ * packages will be updated.
577
+ * @property {OrderPlatformModel.PackagesSchema} body
578
+ */
579
+
436
580
  /**
437
581
  * @typedef UpdateShipmentStatusParam
438
582
  * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
@@ -495,10 +639,35 @@ class OrderPlatformValidator {
495
639
  }).required();
496
640
  }
497
641
 
642
+ /** @returns {CreateAccountParam} */
643
+ static createAccount() {
644
+ return Joi.object({
645
+ body: OrderPlatformModel.CreateAccount().required(),
646
+ }).required();
647
+ }
648
+
649
+ /** @returns {CreateChannelConfigParam} */
650
+ static createChannelConfig() {
651
+ return Joi.object({
652
+ body: OrderPlatformModel.CreateChannelConfigData().required(),
653
+ }).required();
654
+ }
655
+
498
656
  /** @returns {CreateOrderParam} */
499
657
  static createOrder() {
500
658
  return Joi.object({
501
- body: OrderPlatformModel.CreateOrderAPI().required(),
659
+ xOrderingSource: Joi.string().allow("").required(),
660
+ xApplicationId: Joi.string().allow(""),
661
+ xExtensionId: Joi.string().allow(""),
662
+ body: OrderPlatformModel.CreateOrderRequestSchema().required(),
663
+ }).required();
664
+ }
665
+
666
+ /** @returns {CreateShipmentPackagesParam} */
667
+ static createShipmentPackages() {
668
+ return Joi.object({
669
+ shipmentId: Joi.string().allow("").required(),
670
+ body: OrderPlatformModel.PackagesSchema().required(),
502
671
  }).required();
503
672
  }
504
673
 
@@ -519,7 +688,7 @@ class OrderPlatformValidator {
519
688
  /** @returns {DownloadLanesReportParam} */
520
689
  static downloadLanesReport() {
521
690
  return Joi.object({
522
- body: OrderPlatformModel.BulkReportsDownloadRequest().required(),
691
+ body: OrderPlatformModel.BulkReportsDownloadRequestSchema().required(),
523
692
  }).required();
524
693
  }
525
694
 
@@ -575,14 +744,22 @@ class OrderPlatformValidator {
575
744
  /** @returns {GenerateProcessManifestParam} */
576
745
  static generateProcessManifest() {
577
746
  return Joi.object({
578
- body: OrderPlatformModel.ProcessManifestRequest().required(),
747
+ body: OrderPlatformModel.ProcessManifestRequestSchema().required(),
748
+ }).required();
749
+ }
750
+
751
+ /** @returns {GetAccountByIdParam} */
752
+ static getAccountById() {
753
+ return Joi.object({
754
+ channelAccountId: Joi.string().allow("").required(),
579
755
  }).required();
580
756
  }
581
757
 
582
758
  /** @returns {GetAllowedStateTransitionParam} */
583
759
  static getAllowedStateTransition() {
584
760
  return Joi.object({
585
- orderingChannel: Joi.string().allow("").required(),
761
+ orderingChannel: Joi.string().allow(""),
762
+ orderingSource: Joi.string().allow(""),
586
763
  status: Joi.string().allow("").required(),
587
764
  }).required();
588
765
  }
@@ -646,6 +823,11 @@ class OrderPlatformValidator {
646
823
  }).required();
647
824
  }
648
825
 
826
+ /** @returns {GetChannelConfigParam} */
827
+ static getChannelConfig() {
828
+ return Joi.object({}).required();
829
+ }
830
+
649
831
  /** @returns {GetFileByStatusParam} */
650
832
  static getFileByStatus() {
651
833
  return Joi.object({
@@ -766,7 +948,11 @@ class OrderPlatformValidator {
766
948
  customerId: Joi.string().allow(""),
767
949
  orderType: Joi.string().allow(""),
768
950
  allowInactive: Joi.boolean(),
951
+ groupEntity: Joi.string().allow(""),
769
952
  enforceDateFilter: Joi.boolean(),
953
+ fulfillmentType: Joi.string().allow(""),
954
+ orderingSource: Joi.string().allow(""),
955
+ channelAccountId: Joi.string().allow(""),
770
956
  }).required();
771
957
  }
772
958
 
@@ -793,6 +979,13 @@ class OrderPlatformValidator {
793
979
  }).required();
794
980
  }
795
981
 
982
+ /** @returns {GetShipmentPackagesParam} */
983
+ static getShipmentPackages() {
984
+ return Joi.object({
985
+ shipmentId: Joi.string().allow("").required(),
986
+ }).required();
987
+ }
988
+
796
989
  /** @returns {GetShipmentReasonsParam} */
797
990
  static getShipmentReasons() {
798
991
  return Joi.object({
@@ -807,6 +1000,7 @@ class OrderPlatformValidator {
807
1000
  return Joi.object({
808
1001
  lane: Joi.string().allow(""),
809
1002
  bagStatus: Joi.string().allow(""),
1003
+ statusAssigned: Joi.string().allow(""),
810
1004
  statusOverrideLane: Joi.boolean(),
811
1005
  timeToDispatch: Joi.number(),
812
1006
  searchType: Joi.string().allow(""),
@@ -815,6 +1009,8 @@ class OrderPlatformValidator {
815
1009
  toDate: Joi.string().allow(""),
816
1010
  startDate: Joi.string().allow(""),
817
1011
  endDate: Joi.string().allow(""),
1012
+ statusAssignedStartDate: Joi.string().allow(""),
1013
+ statusAssignedEndDate: Joi.string().allow(""),
818
1014
  dpIds: Joi.string().allow(""),
819
1015
  stores: Joi.string().allow(""),
820
1016
  salesChannels: Joi.string().allow(""),
@@ -836,7 +1032,11 @@ class OrderPlatformValidator {
836
1032
  tags: Joi.string().allow(""),
837
1033
  customerId: Joi.string().allow(""),
838
1034
  orderType: Joi.string().allow(""),
1035
+ groupEntity: Joi.string().allow(""),
839
1036
  enforceDateFilter: Joi.boolean(),
1037
+ fulfillmentType: Joi.string().allow(""),
1038
+ orderingSource: Joi.string().allow(""),
1039
+ channelAccountId: Joi.string().allow(""),
840
1040
  }).required();
841
1041
  }
842
1042
 
@@ -845,6 +1045,7 @@ class OrderPlatformValidator {
845
1045
  return Joi.object({
846
1046
  appId: Joi.string().allow(""),
847
1047
  orderingChannel: Joi.string().allow(""),
1048
+ orderingSource: Joi.string().allow(""),
848
1049
  entity: Joi.string().allow(""),
849
1050
  }).required();
850
1051
  }
@@ -869,17 +1070,18 @@ class OrderPlatformValidator {
869
1070
  }).required();
870
1071
  }
871
1072
 
872
- /** @returns {InvalidateShipmentCacheParam} */
873
- static invalidateShipmentCache() {
1073
+ /** @returns {JobDetailsParam} */
1074
+ static jobDetails() {
874
1075
  return Joi.object({
875
- body: OrderPlatformModel.InvalidateShipmentCachePayload().required(),
1076
+ batchId: Joi.string().allow("").required(),
876
1077
  }).required();
877
1078
  }
878
1079
 
879
- /** @returns {JobDetailsParam} */
880
- static jobDetails() {
1080
+ /** @returns {ListAccountsParam} */
1081
+ static listAccounts() {
881
1082
  return Joi.object({
882
- batchId: Joi.string().allow("").required(),
1083
+ page: Joi.number(),
1084
+ size: Joi.number(),
883
1085
  }).required();
884
1086
  }
885
1087
 
@@ -904,6 +1106,22 @@ class OrderPlatformValidator {
904
1106
  }).required();
905
1107
  }
906
1108
 
1109
+ /** @returns {RequestCourierPartnerForShipmentParam} */
1110
+ static requestCourierPartnerForShipment() {
1111
+ return Joi.object({
1112
+ shipmentId: Joi.string().allow("").required(),
1113
+ body: OrderPlatformModel.ShipmentCourierPartnerRequestSchema().required(),
1114
+ }).required();
1115
+ }
1116
+
1117
+ /** @returns {SaveCourierPartnerPreferenceForShipmentParam} */
1118
+ static saveCourierPartnerPreferenceForShipment() {
1119
+ return Joi.object({
1120
+ shipmentId: Joi.string().allow("").required(),
1121
+ body: OrderPlatformModel.ShipmentCourierPartnerPreference().required(),
1122
+ }).required();
1123
+ }
1124
+
907
1125
  /** @returns {SendSmsNinjaParam} */
908
1126
  static sendSmsNinja() {
909
1127
  return Joi.object({
@@ -928,21 +1146,19 @@ class OrderPlatformValidator {
928
1146
  }).required();
929
1147
  }
930
1148
 
1149
+ /** @returns {UpdateAccountParam} */
1150
+ static updateAccount() {
1151
+ return Joi.object({
1152
+ channelAccountId: Joi.string().allow("").required(),
1153
+ body: OrderPlatformModel.CreateAccount().required(),
1154
+ }).required();
1155
+ }
1156
+
931
1157
  /** @returns {UpdateAddressParam} */
932
1158
  static updateAddress() {
933
1159
  return Joi.object({
934
1160
  shipmentId: Joi.string().allow("").required(),
935
- name: Joi.string().allow(""),
936
- address: Joi.string().allow(""),
937
- addressType: Joi.string().allow(""),
938
- pincode: Joi.string().allow(""),
939
- phone: Joi.string().allow(""),
940
- email: Joi.string().allow(""),
941
- landmark: Joi.string().allow(""),
942
- addressCategory: Joi.string().allow("").required(),
943
- city: Joi.string().allow(""),
944
- state: Joi.string().allow(""),
945
- country: Joi.string().allow(""),
1161
+ body: OrderPlatformModel.UpdateAddressRequestBody().required(),
946
1162
  }).required();
947
1163
  }
948
1164
 
@@ -953,6 +1169,13 @@ class OrderPlatformValidator {
953
1169
  }).required();
954
1170
  }
955
1171
 
1172
+ /** @returns {UpdatePaymentInfoParam} */
1173
+ static updatePaymentInfo() {
1174
+ return Joi.object({
1175
+ body: OrderPlatformModel.UpdateShipmentPaymentMode().required(),
1176
+ }).required();
1177
+ }
1178
+
956
1179
  /** @returns {UpdateShipmentLockParam} */
957
1180
  static updateShipmentLock() {
958
1181
  return Joi.object({
@@ -960,6 +1183,14 @@ class OrderPlatformValidator {
960
1183
  }).required();
961
1184
  }
962
1185
 
1186
+ /** @returns {UpdateShipmentPackagesParam} */
1187
+ static updateShipmentPackages() {
1188
+ return Joi.object({
1189
+ shipmentId: Joi.string().allow("").required(),
1190
+ body: OrderPlatformModel.PackagesSchema().required(),
1191
+ }).required();
1192
+ }
1193
+
963
1194
  /** @returns {UpdateShipmentStatusParam} */
964
1195
  static updateShipmentStatus() {
965
1196
  return Joi.object({