@gofynd/fdk-client-javascript 1.4.15-beta.14 → 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 +9573 -2678
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
  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
@@ -6,43 +6,46 @@ declare class Order {
6
6
  * @param {OrderPlatformValidator.AddStateManagerConfigParam} arg - Arg object
7
7
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
8
  * @param {import("../PlatformAPIClient").Options} - Options
9
- * @returns {Promise<OrderPlatformModel.ConfigUpdatedResponse>} - Success response
9
+ * @returns {Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>} -
10
+ * Success response
10
11
  * @name addStateManagerConfig
11
12
  * @summary: Allows esm config updation
12
- * @description: Update ESM config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addStateManagerConfig/).
13
+ * @description: Update ESM config - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/addStateManagerConfig/).
13
14
  */
14
- addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ConfigUpdatedResponse>;
15
+ addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>;
15
16
  /**
16
17
  * @param {OrderPlatformValidator.AttachOrderUserParam} arg - Arg object
17
18
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
18
19
  * @param {import("../PlatformAPIClient").Options} - Options
19
- * @returns {Promise<OrderPlatformModel.AttachOrderUserResponse>} - Success response
20
+ * @returns {Promise<OrderPlatformModel.AttachOrderUserResponseSchema>} -
21
+ * Success response
20
22
  * @name attachOrderUser
21
23
  * @summary: Attach order to a user
22
- * @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
24
+ * @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/attachOrderUser/).
23
25
  */
24
- attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponse>;
26
+ attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponseSchema>;
25
27
  /**
26
28
  * @param {OrderPlatformValidator.BulkListingParam} arg - Arg object
27
29
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
28
30
  * @param {import("../PlatformAPIClient").Options} - Options
29
- * @returns {Promise<OrderPlatformModel.BulkListingResponse>} - Success response
31
+ * @returns {Promise<OrderPlatformModel.BulkListingResponseSchema>} - Success response
30
32
  * @name bulkListing
31
33
  * @summary: Lists bulk operations
32
- * @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
34
+ * @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/bulkListing/).
33
35
  */
34
- bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponse>;
36
+ bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponseSchema>;
35
37
  /**
36
38
  * @param {OrderPlatformValidator.BulkStateTransistionParam} arg - Arg object
37
39
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
38
40
  * @param {import("../PlatformAPIClient").Options} - Options
39
- * @returns {Promise<OrderPlatformModel.BulkStateTransistionResponse>} -
40
- * Success response
41
+ * @returns {Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>}
42
+ * - Success response
43
+ *
41
44
  * @name bulkStateTransistion
42
45
  * @summary: Upload bulk state transitions file
43
- * @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
46
+ * @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/bulkStateTransistion/).
44
47
  */
45
- bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponse>;
48
+ bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>;
46
49
  /**
47
50
  * @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
48
51
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -50,60 +53,94 @@ declare class Order {
50
53
  * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
51
54
  * @name checkOrderStatus
52
55
  * @summary: Debug order
53
- * @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
56
+ * @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/checkOrderStatus/).
54
57
  */
55
58
  checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
59
+ /**
60
+ * @param {OrderPlatformValidator.CreateAccountParam} arg - Arg object
61
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
62
+ * @param {import("../PlatformAPIClient").Options} - Options
63
+ * @returns {Promise<OrderPlatformModel.Account>} - Success response
64
+ * @name createAccount
65
+ * @summary: Create channel account
66
+ * @description: Creates a new channel account for the company. Channel accounts represent different sales channels or marketplace integrations (e.g., Shopify, custom marketplaces) through which the company receives and processes orders. Each account is identified by a unique name and can be used to segregate orders from different sources. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createAccount/).
67
+ */
68
+ createAccount({ body, requestHeaders }?: OrderPlatformValidator.CreateAccountParam, { responseHeaders }?: object): Promise<OrderPlatformModel.Account>;
69
+ /**
70
+ * @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
71
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
72
+ * @param {import("../PlatformAPIClient").Options} - Options
73
+ * @returns {Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>}
74
+ * - Success response
75
+ *
76
+ * @name createChannelConfig
77
+ * @summary: Create channel configuration
78
+ * @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createChannelConfig/).
79
+ */
80
+ createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>;
56
81
  /**
57
82
  * @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
58
83
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
59
84
  * @param {import("../PlatformAPIClient").Options} - Options
60
- * @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
85
+ * @returns {Promise<Object>} - Success response
61
86
  * @name createOrder
62
- * @summary: Create order
63
- * @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
87
+ * @summary: Create Order
88
+ * @description: Creates an order in the OMS. Note: Use the Serviceability API (<a href='/commerce/sdk/latest/platform/company/serviceability#createShipments'>createShipments</a>) to determine shipments before creating an order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrder/).
89
+ */
90
+ createOrder({ xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<any>;
91
+ /**
92
+ * @param {OrderPlatformValidator.CreateShipmentPackagesParam} arg - Arg object
93
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
94
+ * @param {import("../PlatformAPIClient").Options} - Options
95
+ * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
96
+ * @name createShipmentPackages
97
+ * @summary: Create shipment packages
98
+ * @description: Create new packages for a shipment, enabling Multi-Piece Shipment (MPS) functionality. This operation validates courier partner availability and performs bag breaking as per number of packages. The system automatically validates MPS eligibility and store configuration before creating packages. If the store is not eligible for MPS, it will not let the user create packages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createShipmentPackages/).
64
99
  */
65
- createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
100
+ createShipmentPackages({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.CreateShipmentPackagesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
66
101
  /**
67
102
  * @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
68
103
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
69
104
  * @param {import("../PlatformAPIClient").Options} - Options
70
- * @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
105
+ * @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
71
106
  * @name dispatchManifests
72
107
  * @summary: Dispatch manifest
73
- * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
108
+ * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/dispatchManifests/).
74
109
  */
75
- dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
110
+ dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
76
111
  /**
77
112
  * @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
78
113
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
79
114
  * @param {import("../PlatformAPIClient").Options} - Options
80
- * @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
115
+ * @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
81
116
  * @name downloadBulkActionTemplate
82
117
  * @summary: Download bulk template
83
- * @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
118
+ * @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/downloadBulkActionTemplate/).
84
119
  */
85
- downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
120
+ downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
86
121
  /**
87
122
  * @param {OrderPlatformValidator.DownloadLanesReportParam} arg - Arg object
88
123
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
89
124
  * @param {import("../PlatformAPIClient").Options} - Options
90
- * @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponse>} -
91
- * Success response
125
+ * @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>}
126
+ * - Success response
127
+ *
92
128
  * @name downloadLanesReport
93
129
  * @summary: Download Lane report
94
- * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
130
+ * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/downloadLanesReport/).
95
131
  */
96
- downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponse>;
132
+ downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>;
97
133
  /**
98
134
  * @param {OrderPlatformValidator.EInvoiceRetryParam} arg - Arg object
99
135
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
100
136
  * @param {import("../PlatformAPIClient").Options} - Options
101
- * @returns {Promise<OrderPlatformModel.EInvoiceRetryResponse>} - Success response
137
+ * @returns {Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>} -
138
+ * Success response
102
139
  * @name eInvoiceRetry
103
140
  * @summary: Retry E-invoice
104
- * @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
141
+ * @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/eInvoiceRetry/).
105
142
  */
106
- eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponse>;
143
+ eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>;
107
144
  /**
108
145
  * @param {OrderPlatformValidator.FailedOrderLogDetailsParam} arg - Arg object
109
146
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -111,7 +148,7 @@ declare class Order {
111
148
  * @returns {Promise<OrderPlatformModel.FailedOrderLogDetails>} - Success response
112
149
  * @name failedOrderLogDetails
113
150
  * @summary: Get failed order log
114
- * @description: Get the exact error trace from the log Id provided in the failed order list API response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
151
+ * @description: Get the exact error trace from the log Id provided in the failed order list API response - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/failedOrderLogDetails/).
115
152
  */
116
153
  failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
117
154
  /**
@@ -121,7 +158,7 @@ declare class Order {
121
158
  * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
122
159
  * @name failedOrderLogs
123
160
  * @summary: List failed order logs
124
- * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
161
+ * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/failedOrderLogs/).
125
162
  */
126
163
  failedOrderLogs({ applicationId, pageNo, pageSize, searchType, searchValue, requestHeaders, }?: OrderPlatformValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
127
164
  /**
@@ -132,40 +169,52 @@ declare class Order {
132
169
  * Success response
133
170
  * @name fetchRefundModeConfig
134
171
  * @summary: List refund modes
135
- * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
172
+ * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/fetchRefundModeConfig/).
136
173
  */
137
174
  fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
138
175
  /**
139
176
  * @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
140
177
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
141
178
  * @param {import("../PlatformAPIClient").Options} - Options
142
- * @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponse>} - Success response
179
+ * @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>} -
180
+ * Success response
143
181
  * @name generateInvoiceID
144
182
  * @summary: Generate and attach invoice Id
145
- * @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
183
+ * @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generateInvoiceID/).
146
184
  */
147
- generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponse>;
185
+ generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>;
148
186
  /**
149
187
  * @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
150
188
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
151
189
  * @param {import("../PlatformAPIClient").Options} - Options
152
- * @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
153
- * Success response
190
+ * @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>}
191
+ * - Success response
192
+ *
154
193
  * @name generatePOSReceiptByOrderId
155
194
  * @summary: Generate POS receipt by order Id
156
- * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
195
+ * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generatePOSReceiptByOrderId/).
157
196
  */
158
- generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
197
+ generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>;
159
198
  /**
160
199
  * @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
161
200
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
162
201
  * @param {import("../PlatformAPIClient").Options} - Options
163
- * @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
202
+ * @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
164
203
  * @name generateProcessManifest
165
204
  * @summary: Process Order Manifest
166
- * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
205
+ * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/generateProcessManifest/).
167
206
  */
168
- generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponse>;
207
+ generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponseSchema>;
208
+ /**
209
+ * @param {OrderPlatformValidator.GetAccountByIdParam} arg - Arg object
210
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
211
+ * @param {import("../PlatformAPIClient").Options} - Options
212
+ * @returns {Promise<OrderPlatformModel.Account>} - Success response
213
+ * @name getAccountById
214
+ * @summary: Get channel account details
215
+ * @description: Retrieves detailed information about a specific channel account using its unique identifier. This endpoint returns the complete account details including the account ID, associated company ID, and the channel account name. Use this to fetch information about a particular sales channel or marketplace integration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAccountById/).
216
+ */
217
+ getAccountById({ channelAccountId, requestHeaders }?: OrderPlatformValidator.GetAccountByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.Account>;
169
218
  /**
170
219
  * @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
171
220
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -174,91 +223,106 @@ declare class Order {
174
223
  * Success response
175
224
  * @name getAllowedStateTransition
176
225
  * @summary: Get allowed state transition
177
- * @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
226
+ * @description: Retrieve next possible states based on logged in user's role - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAllowedStateTransition/).
178
227
  */
179
- getAllowedStateTransition({ orderingChannel, status, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
228
+ getAllowedStateTransition({ status, orderingChannel, orderingSource, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
180
229
  /**
181
230
  * @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
182
231
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
183
232
  * @param {import("../PlatformAPIClient").Options} - Options
184
- * @returns {Promise<OrderPlatformModel.AllowedTemplatesResponse>} - Success response
233
+ * @returns {Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>} -
234
+ * Success response
185
235
  * @name getAllowedTemplatesForBulk
186
236
  * @summary: List bulk operation templates
187
- * @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
237
+ * @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAllowedTemplatesForBulk/).
188
238
  */
189
- getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponse>;
239
+ getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>;
190
240
  /**
191
241
  * @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
192
242
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
193
243
  * @param {import("../PlatformAPIClient").Options} - Options
194
- * @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
244
+ * @returns {Promise<OrderPlatformModel.AnnouncementsResponseSchema>} -
245
+ * Success response
195
246
  * @name getAnnouncements
196
247
  * @summary: List announcements
197
- * @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
248
+ * @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getAnnouncements/).
198
249
  */
199
- getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
250
+ getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponseSchema>;
200
251
  /**
201
252
  * @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
202
253
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
203
254
  * @param {import("../PlatformAPIClient").Options} - Options
204
- * @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
205
- * Success response
255
+ * @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>}
256
+ * - Success response
257
+ *
206
258
  * @name getBagById
207
259
  * @summary: Get bag
208
- * @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
260
+ * @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBagById/).
209
261
  */
210
- getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
262
+ getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>;
211
263
  /**
212
264
  * @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
213
265
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
214
266
  * @param {import("../PlatformAPIClient").Options} - Options
215
- * @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
267
+ * @returns {Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>} -
268
+ * Success response
216
269
  * @name getBags
217
270
  * @summary: List bags
218
- * @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
271
+ * @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBags/).
219
272
  */
220
- getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
273
+ getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>;
221
274
  /**
222
275
  * @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
223
276
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
224
277
  * @param {import("../PlatformAPIClient").Options} - Options
225
- * @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
226
- * Success response
278
+ * @returns {Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>}
279
+ * - Success response
280
+ *
227
281
  * @name getBulkActionTemplate
228
282
  * @summary: List supported templates
229
- * @description: Get list of templates so that users can download the required template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
283
+ * @description: Get list of templates so that users can download the required template - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBulkActionTemplate/).
230
284
  */
231
- getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
285
+ getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>;
232
286
  /**
233
287
  * @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
234
288
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
235
289
  * @param {import("../PlatformAPIClient").Options} - Options
236
- * @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
290
+ * @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
237
291
  * @name getBulkShipmentExcelFile
238
292
  * @summary: Generate the report
239
- * @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
293
+ * @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getBulkShipmentExcelFile/).
240
294
  */
241
- getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
295
+ getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
296
+ /**
297
+ * @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
298
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
299
+ * @param {import("../PlatformAPIClient").Options} - Options
300
+ * @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
301
+ * @name getChannelConfig
302
+ * @summary: Get channel configuration
303
+ * @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getChannelConfig/).
304
+ */
305
+ getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
242
306
  /**
243
307
  * @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
244
308
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
245
309
  * @param {import("../PlatformAPIClient").Options} - Options
246
- * @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
310
+ * @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
247
311
  * @name getFileByStatus
248
312
  * @summary: Download file used for Bulk operation
249
- * @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
313
+ * @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getFileByStatus/).
250
314
  */
251
- getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponse>;
315
+ getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponseSchema>;
252
316
  /**
253
317
  * @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
254
318
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
255
319
  * @param {import("../PlatformAPIClient").Options} - Options
256
- * @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
320
+ * @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
257
321
  * @name getLaneConfig
258
322
  * @summary: Get lane configuration
259
- * @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
323
+ * @description: Get configuration settings for lanes - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getLaneConfig/).
260
324
  */
261
- getLaneConfig({ superLane, groupEntity, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponse>;
325
+ getLaneConfig({ superLane, groupEntity, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponseSchema>;
262
326
  /**
263
327
  * @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
264
328
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -266,7 +330,7 @@ declare class Order {
266
330
  * @returns {Promise<OrderPlatformModel.ManifestDetails>} - Success response
267
331
  * @name getManifestDetails
268
332
  * @summary: Get a manifest
269
- * @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
333
+ * @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestDetails/).
270
334
  */
271
335
  getManifestDetails({ manifestId, dpIds, endDate, startDate, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
272
336
  /**
@@ -276,19 +340,20 @@ declare class Order {
276
340
  * @returns {Promise<OrderPlatformModel.ManifestShipmentListing>} - Success response
277
341
  * @name getManifestShipments
278
342
  * @summary: List manifest shipments
279
- * @description: Get list of shipments tagged to that manifest, the user can also search the shipments on the basis of shipment Id, order Id and AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestShipments/).
343
+ * @description: Get list of shipments tagged to that manifest, the user can also search the shipments on the basis of shipment Id, order Id and AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestShipments/).
280
344
  */
281
345
  getManifestShipments({ dpIds, stores, toDate, fromDate, dpName, salesChannels, searchType, searchValue, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestShipmentListing>;
282
346
  /**
283
347
  * @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
284
348
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
285
349
  * @param {import("../PlatformAPIClient").Options} - Options
286
- * @returns {Promise<OrderPlatformModel.ManifestFiltersResponse>} - Success response
350
+ * @returns {Promise<OrderPlatformModel.ManifestFiltersResponseSchema>} -
351
+ * Success response
287
352
  * @name getManifestfilters
288
353
  * @summary: List filters
289
- * @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
354
+ * @description: Get supported filter for listing manifests - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifestfilters/).
290
355
  */
291
- getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponse>;
356
+ getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponseSchema>;
292
357
  /**
293
358
  * @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
294
359
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -296,82 +361,310 @@ declare class Order {
296
361
  * @returns {Promise<OrderPlatformModel.ManifestList>} - Success response
297
362
  * @name getManifests
298
363
  * @summary: List manifests
299
- * @description: Get a list of manifest as per the filter provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifests/).
364
+ * @description: Get a list of manifest as per the filter provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getManifests/).
300
365
  */
301
366
  getManifests({ status, startDate, endDate, searchType, storeId, searchValue, dpIds, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestList>;
302
367
  /**
303
368
  * @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
304
369
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
305
370
  * @param {import("../PlatformAPIClient").Options} - Options
306
- * @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
371
+ * @returns {Promise<OrderPlatformModel.OrderDetailsResponseSchema>} -
372
+ * Success response
307
373
  * @name getOrderById
308
374
  * @summary: Get order
309
- * @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
375
+ * @description: Get detailed information about a specific order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getOrderById/).
310
376
  */
311
- getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
377
+ getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponseSchema>;
312
378
  /**
313
379
  * @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
314
380
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
315
381
  * @param {import("../PlatformAPIClient").Options} - Options
316
- * @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
382
+ * @returns {Promise<OrderPlatformModel.OrderListingResponseSchema>} -
383
+ * Success response
317
384
  * @name getOrders
318
385
  * @summary: List orders
319
- * @description: Get a list of orders based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
320
- */
321
- getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
386
+ * @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getOrders/).
387
+ */
388
+ getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, fulfillmentType, orderingSource, channelAccountId, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
389
+ /**
390
+ * @param {Object} arg - Arg object.
391
+ * @param {string} [arg.lane] - Lane refers to a section where orders are
392
+ * assigned, indicating its grouping.
393
+ * @param {string} [arg.searchType] - Search_type refers to the field that
394
+ * will be used as the target for the search operation.
395
+ * @param {string} [arg.bagStatus] - Bag_status refers to status of the
396
+ * entity. Filters orders based on the status.
397
+ * @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to
398
+ * estimated SLA time.
399
+ * @param {string} [arg.paymentMethods] - Comma separated values of payment
400
+ * methods that were used to place order.
401
+ * @param {string} [arg.tags] - Tags refers to additional descriptive labels
402
+ * associated with the order
403
+ * @param {string} [arg.searchValue] - Search_value is matched against the
404
+ * field specified by the search_type
405
+ * @param {string} [arg.fromDate] - Date time in UTC timezone as per ISO format.
406
+ * @param {string} [arg.toDate] - Date time in UTC timezone as per ISO format.
407
+ * @param {string} [arg.startDate] - Date time in UTC timezone as per ISO format.
408
+ * @param {string} [arg.endDate] - Date time in UTC timezone as per ISO format.
409
+ * @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
410
+ * @param {string} [arg.stores] - A comma-separated list of store IDs used
411
+ * to filter results to only those related to specific stores.
412
+ * @param {string} [arg.salesChannels] - A comma-separated list of sales
413
+ * channel IDs to filter results based on the sales channels involved.
414
+ * @param {number} [arg.pageSize] - Determines the number of results
415
+ * returned per page.
416
+ * @param {boolean} [arg.isPrioritySort] -
417
+ * @param {string} [arg.customMeta] -
418
+ * @param {boolean} [arg.myOrders] -
419
+ * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
420
+ * non-cross company order
421
+ * @param {string} [arg.customerId] - The unique identifier for the customer
422
+ * associated with the query, useful for filtering results to a specific customer.
423
+ * @param {string} [arg.orderType] -
424
+ * @param {boolean} [arg.allowInactive] - Flag indicating whether inactive
425
+ * shipments are allowed
426
+ * @param {string} [arg.groupEntity] - Defines the grouping criterion for
427
+ * retrieving shipments or orders. It specifies whether the results should
428
+ * be organized based on shipment groups or order groups. For example,
429
+ * using 'shipments' groups results by shipment, while an invalid value
430
+ * like 'abcd' may not be recognized, leading to errors or default behavior.
431
+ * @param {boolean} [arg.enforceDateFilter] - Applies a date filter for
432
+ * listing orders. This is useful when fetching data for a specific date
433
+ * range while performing searches.
434
+ * @param {string} [arg.fulfillmentType] - Define the Fulfillment Type for
435
+ * Listing Orders, This is use when we want to get list of shipments or
436
+ * orders by cross store or cross company or fulfilling Store (by
437
+ * default), this is also depends on the login user accessType and store access
438
+ * @param {string} [arg.orderingSource] - Filter orders by ordering source.
439
+ * Accepts comma-separated values for multiple sources.
440
+ * @param {string} [arg.channelAccountId] - Comma-separated channel account
441
+ * IDs to filter orders by specific channel accounts.
442
+ * @returns {Paginator<OrderPlatformModel.OrderListingResponseSchema>}
443
+ * @summary: List orders
444
+ * @description: Get a list of orders based on the filters provided.
445
+ */
446
+ getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, fulfillmentType, orderingSource, channelAccountId, }?: {
447
+ lane?: string;
448
+ searchType?: string;
449
+ bagStatus?: string;
450
+ timeToDispatch?: number;
451
+ paymentMethods?: string;
452
+ tags?: string;
453
+ searchValue?: string;
454
+ fromDate?: string;
455
+ toDate?: string;
456
+ startDate?: string;
457
+ endDate?: string;
458
+ dpIds?: string;
459
+ stores?: string;
460
+ salesChannels?: string;
461
+ pageSize?: number;
462
+ isPrioritySort?: boolean;
463
+ customMeta?: string;
464
+ myOrders?: boolean;
465
+ showCrossCompanyData?: boolean;
466
+ customerId?: string;
467
+ orderType?: string;
468
+ allowInactive?: boolean;
469
+ groupEntity?: string;
470
+ enforceDateFilter?: boolean;
471
+ fulfillmentType?: string;
472
+ orderingSource?: string;
473
+ channelAccountId?: string;
474
+ }): Paginator<OrderPlatformModel.OrderListingResponseSchema>;
322
475
  /**
323
476
  * @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
324
477
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
325
478
  * @param {import("../PlatformAPIClient").Options} - Options
326
- * @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
479
+ * @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
327
480
  * @name getRoleBasedActions
328
481
  * @summary: Get role-based actions
329
- * @description: Retrieve permissible actions based on user roles such as company_admin, company_operation, customer_care, and read_only. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
482
+ * @description: Retrieve permissible actions based on user roles such as company_admin, company_operation, customer_care, and read_only. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getRoleBasedActions/).
330
483
  */
331
- getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
484
+ getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponseSchema>;
332
485
  /**
333
486
  * @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
334
487
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
335
488
  * @param {import("../PlatformAPIClient").Options} - Options
336
- * @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
489
+ * @returns {Promise<OrderPlatformModel.ShipmentInfoResponseSchema>} -
490
+ * Success response
337
491
  * @name getShipmentById
338
- * @summary: Get shipment
339
- * @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
492
+ * @summary: Get shipment details
493
+ * @description: Get detailed information about a specific shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentById/).
340
494
  */
341
- getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
495
+ getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponseSchema>;
342
496
  /**
343
497
  * @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
344
498
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
345
499
  * @param {import("../PlatformAPIClient").Options} - Options
346
- * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
500
+ * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
501
+ * Success response
347
502
  * @name getShipmentHistory
348
503
  * @summary: Get a shipment's history
349
- * @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
504
+ * @description: Get the history of the shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentHistory/).
350
505
  */
351
- getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
506
+ getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
507
+ /**
508
+ * @param {OrderPlatformValidator.GetShipmentPackagesParam} arg - Arg object
509
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
510
+ * @param {import("../PlatformAPIClient").Options} - Options
511
+ * @returns {Promise<OrderPlatformModel.PackagesResponseSchema>} - Success response
512
+ * @name getShipmentPackages
513
+ * @summary: Get shipment packages
514
+ * @description: Retrieve all packages associated with a specific shipment. This endpoint supports both single-piece and multi-piece shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentPackages/).
515
+ */
516
+ getShipmentPackages({ shipmentId, requestHeaders }?: OrderPlatformValidator.GetShipmentPackagesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PackagesResponseSchema>;
352
517
  /**
353
518
  * @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
354
519
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
355
520
  * @param {import("../PlatformAPIClient").Options} - Options
356
- * @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
357
- * Success response
521
+ * @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>}
522
+ * - Success response
523
+ *
358
524
  * @name getShipmentReasons
359
525
  * @summary: List bag cancellation reasons
360
- * @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
526
+ * @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentReasons/).
361
527
  */
362
- getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
528
+ getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>;
363
529
  /**
364
530
  * @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
365
531
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
366
532
  * @param {import("../PlatformAPIClient").Options} - Options
367
- * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
533
+ * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
368
534
  * - Success response
369
535
  *
370
536
  * @name getShipments
371
537
  * @summary: List shipments
372
- * @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
373
- */
374
- getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
538
+ * @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipments/).
539
+ */
540
+ getShipments({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, orderingSource, channelAccountId, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
541
+ /**
542
+ * @param {Object} arg - Arg object.
543
+ * @param {string} [arg.lane] - Name of lane for which data is to be fetched
544
+ * @param {string} [arg.bagStatus] - Comma separated values of bag statuses.
545
+ * @param {string} [arg.statusAssigned] - Used to filter shipments based on
546
+ * status present in shipment_status_history. For more information on
547
+ * these statuses, refer to the Fynd Partners documentation.
548
+ * @param {boolean} [arg.statusOverrideLane] - Use this flag to fetch by
549
+ * bag_status and override lane.
550
+ * @param {number} [arg.timeToDispatch] - Indicates the time to dispatch.
551
+ * @param {string} [arg.searchType] - Specifies the key used to determine
552
+ * the type of search being performed.
553
+ * @param {string} [arg.searchValue] - The value corresponding to the search
554
+ * type, such as a specific shipment ID or order ID.
555
+ * @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
556
+ * @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
557
+ * @param {string} [arg.startDate] - The UTC start date in ISO format
558
+ * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
559
+ * @param {string} [arg.endDate] - The UTC end date in ISO format
560
+ * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
561
+ * @param {string} [arg.statusAssignedStartDate] - Specifies the starting
562
+ * UTC date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the
563
+ * lower boundary for filtering shipments based on the `created_at`
564
+ * timestamp of statuses in the shipment's status history. It allows
565
+ * filtering statuses that were created within a specific time range.
566
+ * @param {string} [arg.statusAssignedEndDate] - Specifies the ending UTC
567
+ * date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper
568
+ * boundary for filtering shipments based on the `created_at` timestamp of
569
+ * statuses in the shipment's status history.
570
+ * @param {string} [arg.dpIds] - A comma-separated list of delivery partner
571
+ * IDs to filter results by specific delivery partners.
572
+ * @param {string} [arg.stores] - A comma-separated list of store IDs used
573
+ * to filter results to only those related to specific stores.
574
+ * @param {string} [arg.salesChannels] - A comma-separated list of sales
575
+ * channel IDs to filter results based on the sales channels involved.
576
+ * @param {number} [arg.pageSize] - Determines the number of results
577
+ * returned per page.
578
+ * @param {boolean} [arg.fetchActiveShipment] - A boolean flag that
579
+ * indicates whether to include only active shipments in the results.
580
+ * @param {boolean} [arg.allowInactive] - A flag indicating whether to allow
581
+ * the inclusion of inactive shipments in the results.
582
+ * @param {boolean} [arg.excludeLockedShipments] - A flag to specify whether
583
+ * to exclude shipments that are locked from the results.
584
+ * @param {string} [arg.paymentMethods] - A comma-separated list of payment methods.
585
+ * @param {string} [arg.channelShipmentId] - The shipment ID used in the
586
+ * application, which can be used to reference specific shipments.
587
+ * @param {string} [arg.channelOrderId] - The order ID used in the application.
588
+ * @param {string} [arg.customMeta] - Custom metadata associated with the
589
+ * query, allowing for additional filtering or information to be passed.
590
+ * @param {string} [arg.orderingChannel] - The channel through which the
591
+ * order was placed.
592
+ * @param {string} [arg.companyAffiliateTag] - A tag used to identify the
593
+ * company's affiliation for filtering or reporting purposes.
594
+ * @param {boolean} [arg.myOrders] - A boolean flag indicating whether the
595
+ * query should return only the user's orders.
596
+ * @param {string} [arg.platformUserId] - The unique identifier of the user
597
+ * on the platform, useful for filtering orders related to a specific user.
598
+ * @param {string} [arg.sortType] - Determines the sorting order of the
599
+ * results based on specific criteria.
600
+ * @param {boolean} [arg.showCrossCompanyData] - A flag indicating whether
601
+ * to include data from both cross-company and non-cross-company orders in
602
+ * the results.
603
+ * @param {string} [arg.tags] - A comma-separated list of tags associated
604
+ * with the orders to filter results based on specific characteristics.
605
+ * @param {string} [arg.customerId] - The unique identifier for the customer
606
+ * associated with the query, useful for filtering results to a specific customer.
607
+ * @param {string} [arg.orderType] - The type of order being queried.
608
+ * @param {string} [arg.groupEntity] - Defines the grouping criterion for
609
+ * retrieving shipments or orders. It specifies whether the results should
610
+ * be organized based on shipment groups or order groups. For example,
611
+ * using 'shipments' groups results by shipment, while an invalid value
612
+ * like 'abcd' may not be recognized, leading to errors or default behavior.
613
+ * @param {boolean} [arg.enforceDateFilter] - Applies a date filter for
614
+ * listing shipments. This is useful when fetching data for a specific
615
+ * date range while performing searches.
616
+ * @param {string} [arg.fulfillmentType] - Define the Fulfillment Type for
617
+ * Listing Orders, This is use when we want to get list of shipments or
618
+ * orders by cross store or cross company or fulfilling Store (by
619
+ * default), this is also depends on the login user accessType and store access
620
+ * @param {string} [arg.orderingSource] - Filter orders by ordering source.
621
+ * Accepts comma-separated values for multiple sources.
622
+ * @param {string} [arg.channelAccountId] - Comma-separated channel account
623
+ * IDs to filter orders by specific channel accounts.
624
+ * @returns {Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
625
+ * @summary: List shipments
626
+ * @description: Get a list of shipments based on the filters provided
627
+ */
628
+ getShipmentsPaginator({ lane, bagStatus, statusAssigned, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, statusAssignedStartDate, statusAssignedEndDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, fulfillmentType, orderingSource, channelAccountId, }?: {
629
+ lane?: string;
630
+ bagStatus?: string;
631
+ statusAssigned?: string;
632
+ statusOverrideLane?: boolean;
633
+ timeToDispatch?: number;
634
+ searchType?: string;
635
+ searchValue?: string;
636
+ fromDate?: string;
637
+ toDate?: string;
638
+ startDate?: string;
639
+ endDate?: string;
640
+ statusAssignedStartDate?: string;
641
+ statusAssignedEndDate?: string;
642
+ dpIds?: string;
643
+ stores?: string;
644
+ salesChannels?: string;
645
+ pageSize?: number;
646
+ fetchActiveShipment?: boolean;
647
+ allowInactive?: boolean;
648
+ excludeLockedShipments?: boolean;
649
+ paymentMethods?: string;
650
+ channelShipmentId?: string;
651
+ channelOrderId?: string;
652
+ customMeta?: string;
653
+ orderingChannel?: string;
654
+ companyAffiliateTag?: string;
655
+ myOrders?: boolean;
656
+ platformUserId?: string;
657
+ sortType?: string;
658
+ showCrossCompanyData?: boolean;
659
+ tags?: string;
660
+ customerId?: string;
661
+ orderType?: string;
662
+ groupEntity?: string;
663
+ enforceDateFilter?: boolean;
664
+ fulfillmentType?: string;
665
+ orderingSource?: string;
666
+ channelAccountId?: string;
667
+ }): Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
375
668
  /**
376
669
  * @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
377
670
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -381,9 +674,9 @@ declare class Order {
381
674
  * @summary: Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
382
675
  * @description: This endpoint retrieves the ESM (Entity State Manager) configuration for a specific application within a company. The retrieval is based on parameters such as application ID, ordering channel, and entity type.
383
676
  * The ESM config stores order processing configuration. Each document in the ESM config collection of Order Management System - OMS's database is a JSON object representing the configuration of a specific application ID. This includes filters, hooks, flags set on different state-transitions. This configuration is picked and accordingly features are enabled.
384
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerConfig/).
677
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getStateManagerConfig/).
385
678
  */
386
- getStateManagerConfig({ appId, orderingChannel, entity, requestHeaders }?: OrderPlatformValidator.GetStateManagerConfigParam, { responseHeaders }?: object): Promise<any>;
679
+ getStateManagerConfig({ appId, orderingChannel, orderingSource, entity, requestHeaders }?: OrderPlatformValidator.GetStateManagerConfigParam, { responseHeaders }?: object): Promise<any>;
387
680
  /**
388
681
  * @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
389
682
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -391,50 +684,50 @@ declare class Order {
391
684
  * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
392
685
  * @name getStateTransitionMap
393
686
  * @summary: Get state transition map
394
- * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
687
+ * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getStateTransitionMap/).
395
688
  */
396
689
  getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
397
690
  /**
398
691
  * @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
399
692
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
400
693
  * @param {import("../PlatformAPIClient").Options} - Options
401
- * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
694
+ * @returns {Promise<OrderPlatformModel.TemplateDownloadResponseSchema>} -
695
+ * Success response
402
696
  * @name getTemplate
403
697
  * @summary: Download bulk operation templates
404
- * @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
698
+ * @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getTemplate/).
405
699
  */
406
- getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
700
+ getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponseSchema>;
407
701
  /**
408
702
  * @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
409
703
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
410
704
  * @param {import("../PlatformAPIClient").Options} - Options
411
- * @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
705
+ * @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
412
706
  * @name getfilters
413
707
  * @summary: List filters
414
- * @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
708
+ * @description: Get supported filters for various listing operations - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getfilters/).
415
709
  */
416
- getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
710
+ getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponseSchema>;
417
711
  /**
418
- * @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
712
+ * @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
419
713
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
420
714
  * @param {import("../PlatformAPIClient").Options} - Options
421
- * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
422
- * Success response
423
- * @name invalidateShipmentCache
424
- * @summary: Invalidate shipment cache
425
- * @description: Clear the existing shipment cache data stored in Redis and serialize the updated data for subsequent use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
715
+ * @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
716
+ * @name jobDetails
717
+ * @summary: Get bulk operation details
718
+ * @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/jobDetails/).
426
719
  */
427
- invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
720
+ jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponseSchema>;
428
721
  /**
429
- * @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
722
+ * @param {OrderPlatformValidator.ListAccountsParam} arg - Arg object
430
723
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
431
724
  * @param {import("../PlatformAPIClient").Options} - Options
432
- * @returns {Promise<OrderPlatformModel.JobDetailsResponse>} - Success response
433
- * @name jobDetails
434
- * @summary: Get bulk operation details
435
- * @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/jobDetails/).
725
+ * @returns {Promise<OrderPlatformModel.AccountsList>} - Success response
726
+ * @name listAccounts
727
+ * @summary: Get channel accounts list
728
+ * @description: Retrieves a paginated list of all channel accounts configured for the company. Channel accounts represent different sales channels or marketplace integrations from which orders are received. This endpoint returns account details including the account ID, company ID, and channel account name for each configured channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/listAccounts/).
436
729
  */
437
- jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponse>;
730
+ listAccounts({ page, size, requestHeaders }?: OrderPlatformValidator.ListAccountsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AccountsList>;
438
731
  /**
439
732
  * @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
440
733
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -442,93 +735,156 @@ declare class Order {
442
735
  * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
443
736
  * @name orderUpdate
444
737
  * @summary: Update an order
445
- * @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
738
+ * @description: Used to update an order's meta information. These meta information can be accessed via order or shipment details API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/orderUpdate/).
446
739
  */
447
740
  orderUpdate({ body, requestHeaders }?: OrderPlatformValidator.OrderUpdateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ResponseDetail>;
448
741
  /**
449
742
  * @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
450
743
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
451
744
  * @param {import("../PlatformAPIClient").Options} - Options
452
- * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
745
+ * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
746
+ * Success response
453
747
  * @name postShipmentHistory
454
748
  * @summary: Create shipment history
455
- * @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
749
+ * @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/postShipmentHistory/).
456
750
  */
457
- postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
751
+ postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
458
752
  /**
459
753
  * @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
460
754
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
461
755
  * @param {import("../PlatformAPIClient").Options} - Options
462
- * @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
756
+ * @returns {Promise<OrderPlatformModel.StoreReassignResponseSchema>} -
757
+ * Success response
463
758
  * @name reassignLocation
464
759
  * @summary: Reassign location
465
- * @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
760
+ * @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/reassignLocation/).
466
761
  */
467
- reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponse>;
762
+ reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponseSchema>;
763
+ /**
764
+ * @param {OrderPlatformValidator.RequestCourierPartnerForShipmentParam} arg
765
+ * - Arg object
766
+ *
767
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
768
+ * @param {import("../PlatformAPIClient").Options} - Options
769
+ * @returns {Promise<OrderPlatformModel.CourierPartnerResponseSchema>} -
770
+ * Success response
771
+ * @name requestCourierPartnerForShipment
772
+ * @summary: Manually request a courier partner for a shipment.
773
+ * @description: Use this API to manually assign a courier partner (delivery partner) to a shipment.
774
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/requestCourierPartnerForShipment/).
775
+ */
776
+ requestCourierPartnerForShipment({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.RequestCourierPartnerForShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerResponseSchema>;
777
+ /**
778
+ * @param {OrderPlatformValidator.SaveCourierPartnerPreferenceForShipmentParam} arg
779
+ * - Arg object
780
+ *
781
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
782
+ * @param {import("../PlatformAPIClient").Options} - Options
783
+ * @returns {Promise<OrderPlatformModel.CourierPartnerResponseSchema>} -
784
+ * Success response
785
+ * @name saveCourierPartnerPreferenceForShipment
786
+ * @summary: Save courier partner preference for a shipment.
787
+ * @description: Use this API to save the preferred courier partner for a shipment. The preferred courier partner will be triggered automatically when the shipment moves to a state where delivery partner assignment is performed (for example, ready for DP assignment).
788
+ * - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/saveCourierPartnerPreferenceForShipment/).
789
+ */
790
+ saveCourierPartnerPreferenceForShipment({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.SaveCourierPartnerPreferenceForShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerResponseSchema>;
468
791
  /**
469
792
  * @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
470
793
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
471
794
  * @param {import("../PlatformAPIClient").Options} - Options
472
- * @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
795
+ * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
473
796
  * @name sendSmsNinja
474
797
  * @summary: Send SMS
475
- * @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
798
+ * @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/sendSmsNinja/).
476
799
  */
477
- sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
800
+ sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
478
801
  /**
479
802
  * @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
480
803
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
481
804
  * @param {import("../PlatformAPIClient").Options} - Options
482
- * @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
805
+ * @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>} -
806
+ * Success response
483
807
  * @name sendUserMobileOTP
484
808
  * @summary: Send user mobile OTP
485
- * @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
809
+ * @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/sendUserMobileOTP/).
486
810
  */
487
- sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
811
+ sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>;
488
812
  /**
489
813
  * @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
490
814
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
491
815
  * @param {import("../PlatformAPIClient").Options} - Options
492
- * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
493
- * Success response
816
+ * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>}
817
+ * - Success response
818
+ *
494
819
  * @name trackShipment
495
820
  * @summary: Track shipment
496
- * @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
821
+ * @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/trackShipment/).
822
+ */
823
+ trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>;
824
+ /**
825
+ * @param {OrderPlatformValidator.UpdateAccountParam} arg - Arg object
826
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
827
+ * @param {import("../PlatformAPIClient").Options} - Options
828
+ * @returns {Promise<OrderPlatformModel.Account>} - Success response
829
+ * @name updateAccount
830
+ * @summary: Update account
831
+ * @description: Updates the details of a specific channel account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateAccount/).
497
832
  */
498
- trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
833
+ updateAccount({ channelAccountId, body, requestHeaders }?: OrderPlatformValidator.UpdateAccountParam, { responseHeaders }?: object): Promise<OrderPlatformModel.Account>;
499
834
  /**
500
835
  * @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
501
836
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
502
837
  * @param {import("../PlatformAPIClient").Options} - Options
503
- * @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
838
+ * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
504
839
  * @name updateAddress
505
840
  * @summary: Update shipment address
506
- * @description: Modify the address details of an existing shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
841
+ * @description: Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateAddress/).
507
842
  */
508
- updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, requestHeaders, }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
843
+ updateAddress({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
509
844
  /**
510
845
  * @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
511
846
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
512
847
  * @param {import("../PlatformAPIClient").Options} - Options
513
- * @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>}
848
+ * @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>}
514
849
  * - Success response
515
850
  *
516
851
  * @name updatePackagingDimensions
517
852
  * @summary: Update packaging dimensions
518
- * @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
853
+ * @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updatePackagingDimensions/).
519
854
  */
520
- updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
855
+ updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>;
856
+ /**
857
+ * @param {OrderPlatformValidator.UpdatePaymentInfoParam} arg - Arg object
858
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
859
+ * @param {import("../PlatformAPIClient").Options} - Options
860
+ * @returns {Promise<Object>} - Success response
861
+ * @name updatePaymentInfo
862
+ * @summary: Update payment details for an order, its shipments and its bags.
863
+ * @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updatePaymentInfo/).
864
+ */
865
+ updatePaymentInfo({ body, requestHeaders }?: OrderPlatformValidator.UpdatePaymentInfoParam, { responseHeaders }?: object): Promise<any>;
521
866
  /**
522
867
  * @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
523
868
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
524
869
  * @param {import("../PlatformAPIClient").Options} - Options
525
- * @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
526
- * Success response
870
+ * @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>}
871
+ * - Success response
872
+ *
527
873
  * @name updateShipmentLock
528
874
  * @summary: Update a shipment lock
529
- * @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
875
+ * @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentLock/).
876
+ */
877
+ updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>;
878
+ /**
879
+ * @param {OrderPlatformValidator.UpdateShipmentPackagesParam} arg - Arg object
880
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
881
+ * @param {import("../PlatformAPIClient").Options} - Options
882
+ * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
883
+ * @name updateShipmentPackages
884
+ * @summary: Update shipment packages
885
+ * @description: Update existing packages for a shipment. This operation replaces all existing packages with the provided package list. The system validates courier partner availability and performs bag breaking as per number of packages. Any packages without IDs will have new unique IDs generated. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentPackages/).
530
886
  */
531
- updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
887
+ updateShipmentPackages({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentPackagesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
532
888
  /**
533
889
  * @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
534
890
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -538,7 +894,7 @@ declare class Order {
538
894
  *
539
895
  * @name updateShipmentStatus
540
896
  * @summary: Update a shipment's status
541
- * @description: Used for updating a shipment and its status. Can also be used for updating bags present in that shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
897
+ * @description: It is used for updating the shipment in the following scenarios: Full Confirmation, Partial Confirmation, Change the status of a shipment, Full Cancellation, Partial Cancellation, Assign the shipment to DP. Click <a href='/commerce/miscellaneous/updateShipmentStatus'>here</a> to get the use case details. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentStatus/).
542
898
  */
543
899
  updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
544
900
  /**
@@ -549,29 +905,30 @@ declare class Order {
549
905
  * Success response
550
906
  * @name updateShipmentTracking
551
907
  * @summary: Update shipment tracking
552
- * @description: Modify courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
908
+ * @description: Modify courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentTracking/).
553
909
  */
554
910
  updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
555
911
  /**
556
912
  * @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
557
913
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
558
914
  * @param {import("../PlatformAPIClient").Options} - Options
559
- * @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
915
+ * @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
560
916
  * @name uploadConsents
561
917
  * @summary: Upload consent
562
- * @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
918
+ * @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/uploadConsents/).
563
919
  */
564
- uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
920
+ uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
565
921
  /**
566
922
  * @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
567
923
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
568
924
  * @param {import("../PlatformAPIClient").Options} - Options
569
- * @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
925
+ * @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
570
926
  * @name verifyMobileOTP
571
927
  * @summary: Verify mobile OTP
572
- * @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
928
+ * @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/verifyMobileOTP/).
573
929
  */
574
- verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponse>;
930
+ verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponseSchema>;
575
931
  }
576
932
  import OrderPlatformValidator = require("./OrderPlatformValidator");
577
933
  import OrderPlatformModel = require("./OrderPlatformModel");
934
+ import Paginator = require("../../common/Paginator");