@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1

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 (298) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
  6. package/sdk/application/Cart/CartApplicationClient.js +270 -139
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +3 -3
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
  16. package/sdk/application/Content/ContentApplicationClient.js +197 -36
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  20. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +140 -21
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
  26. package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
  32. package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
  33. package/sdk/application/User/UserApplicationClient.d.ts +13 -23
  34. package/sdk/application/User/UserApplicationClient.js +9 -57
  35. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  36. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  37. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
  38. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
  39. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
  40. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
  41. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
  42. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
  43. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
  44. package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
  45. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
  46. package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
  47. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
  48. package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  56. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
  58. package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
  59. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
  61. package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
  63. package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
  65. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
  66. package/sdk/partner/PartnerClient.d.ts +6 -0
  67. package/sdk/partner/PartnerClient.js +9 -0
  68. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
  69. package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
  70. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
  71. package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
  72. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
  73. package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
  74. package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
  75. package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
  76. package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
  77. package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
  78. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
  79. package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
  80. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  81. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  82. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
  83. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
  84. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  85. package/sdk/partner/index.d.ts +3 -0
  86. package/sdk/partner/index.js +6 -0
  87. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
  88. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  89. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  90. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
  91. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  92. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  93. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
  94. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
  95. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  96. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  97. package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
  98. package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
  99. package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
  100. package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
  101. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
  102. package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
  103. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
  104. package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
  105. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  106. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
  107. package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
  108. package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
  109. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
  110. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
  111. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
  112. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
  113. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
  114. package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
  115. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
  116. package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
  117. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
  118. package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
  119. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
  120. package/sdk/platform/Common/CommonPlatformClient.js +5 -6
  121. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  122. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  123. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
  124. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
  125. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
  126. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
  127. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
  128. package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
  129. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
  130. package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
  131. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
  132. package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
  133. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
  134. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
  135. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
  136. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
  137. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
  138. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
  139. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
  140. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
  141. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
  142. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
  143. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
  144. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
  145. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
  146. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
  147. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
  148. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
  149. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
  150. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
  151. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
  152. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
  153. package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
  154. package/sdk/platform/Content/ContentPlatformClient.js +459 -379
  155. package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
  156. package/sdk/platform/Content/ContentPlatformModel.js +893 -582
  157. package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
  158. package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
  159. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
  160. package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
  161. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
  162. package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
  163. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  164. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  165. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
  166. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
  167. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
  168. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
  169. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  170. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  171. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
  172. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
  173. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  174. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  175. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  176. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  177. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
  178. package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
  179. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  180. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  181. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  182. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  183. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  184. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  185. package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
  186. package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
  187. package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
  188. package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
  189. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
  190. package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
  191. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
  192. package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
  193. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
  194. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
  195. package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
  196. package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
  197. package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
  198. package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
  199. package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
  200. package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
  201. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  202. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  203. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  204. package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
  205. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
  206. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
  207. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
  208. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
  209. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
  210. package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
  211. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
  212. package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
  213. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
  214. package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
  215. package/sdk/platform/PlatformClient.d.ts +2 -0
  216. package/sdk/platform/PlatformClient.js +4 -0
  217. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  218. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  219. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  220. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  221. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
  222. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
  223. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
  224. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
  225. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
  226. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
  227. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
  228. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
  229. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
  230. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
  231. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
  232. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
  233. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
  234. package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
  235. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
  236. package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
  237. package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
  238. package/sdk/platform/Share/SharePlatformModel.js +3 -43
  239. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
  240. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
  241. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
  242. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
  243. package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
  244. package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
  245. package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
  246. package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
  247. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
  248. package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
  249. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
  250. package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
  251. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
  252. package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
  253. package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
  254. package/sdk/platform/User/UserPlatformModel.js +209 -216
  255. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  256. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  257. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
  258. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
  259. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  260. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  261. package/sdk/platform/index.d.ts +1 -0
  262. package/sdk/platform/index.js +2 -0
  263. package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
  264. package/sdk/public/Billing/BillingPublicClient.js +397 -0
  265. package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
  266. package/sdk/public/Billing/BillingPublicModel.js +560 -0
  267. package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
  268. package/sdk/public/Billing/BillingPublicValidator.js +50 -0
  269. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
  270. package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
  271. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
  272. package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
  273. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
  274. package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
  275. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  276. package/sdk/public/Content/ContentPublicClient.js +183 -0
  277. package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
  278. package/sdk/public/Content/ContentPublicModel.js +47 -1
  279. package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
  280. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  281. package/sdk/public/PublicClient.d.ts +2 -2
  282. package/sdk/public/PublicClient.js +2 -2
  283. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  284. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  285. package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
  286. package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
  287. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  288. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  289. package/sdk/public/index.d.ts +1 -1
  290. package/sdk/public/index.js +1 -1
  291. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  292. package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
  293. package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
  294. package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
  295. package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
  296. package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
  297. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
  298. package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
@@ -3,178 +3,164 @@ declare class Order {
3
3
  constructor(config: any);
4
4
  config: any;
5
5
  /**
6
- * @param {OrderPlatformValidator.AddStateManagerConfigParam} arg - Arg object
6
+ * @param {OrderPlatformValidator.AddUserViewsParam} arg - Arg object
7
7
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
8
8
  * @param {import("../PlatformAPIClient").Options} - Options
9
- * @returns {Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>} -
9
+ * @returns {Promise<OrderPlatformModel.CreateUpdateDeleteResponse>} -
10
10
  * Success response
11
- * @name addStateManagerConfig
12
- * @summary: Allows esm config updation
13
- * @description: Update ESM config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addStateManagerConfig/).
11
+ * @name addUserViews
12
+ * @summary: Add custom view for every unique user cross company pair.
13
+ * @description: Add custom view for every unique user cross company pair. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addUserViews/).
14
14
  */
15
- addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>;
15
+ addUserViews({ body, requestHeaders }?: OrderPlatformValidator.AddUserViewsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateUpdateDeleteResponse>;
16
16
  /**
17
17
  * @param {OrderPlatformValidator.AttachOrderUserParam} arg - Arg object
18
18
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
19
19
  * @param {import("../PlatformAPIClient").Options} - Options
20
- * @returns {Promise<OrderPlatformModel.AttachOrderUserResponseSchema>} -
21
- * Success response
20
+ * @returns {Promise<OrderPlatformModel.AttachOrderUserResponse>} - Success response
22
21
  * @name attachOrderUser
23
- * @summary: Attach order to a user
24
- * @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/).
22
+ * @summary: Attach order user.
23
+ * @description: Attach order User - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
25
24
  */
26
- attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponseSchema>;
25
+ attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponse>;
27
26
  /**
28
27
  * @param {OrderPlatformValidator.BulkListingParam} arg - Arg object
29
28
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
30
29
  * @param {import("../PlatformAPIClient").Options} - Options
31
- * @returns {Promise<OrderPlatformModel.BulkListingResponseSchema>} - Success response
30
+ * @returns {Promise<OrderPlatformModel.BulkListingResponse>} - Success response
32
31
  * @name bulkListing
33
- * @summary: Lists bulk operations
34
- * @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/).
32
+ * @summary: Fetches of previous or running bulk jobs.
33
+ * @description: Fetches of previous or running bulk jobs.
34
+ * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
35
35
  */
36
- bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponseSchema>;
36
+ bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponse>;
37
37
  /**
38
38
  * @param {OrderPlatformValidator.BulkStateTransistionParam} arg - Arg object
39
39
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
40
40
  * @param {import("../PlatformAPIClient").Options} - Options
41
- * @returns {Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>}
42
- * - Success response
43
- *
41
+ * @returns {Promise<OrderPlatformModel.BulkStateTransistionResponse>} -
42
+ * Success response
44
43
  * @name bulkStateTransistion
45
- * @summary: Upload bulk state transitions file
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://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
44
+ * @summary: Performs State Transisiton in Bulk for the given shipments in the excel/csv file url.
45
+ * @description: Performs State Transisiton in Bulk for the given shipments in the excel/csv file url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
47
46
  */
48
- bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>;
47
+ bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponse>;
49
48
  /**
50
49
  * @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
51
50
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
52
51
  * @param {import("../PlatformAPIClient").Options} - Options
53
52
  * @returns {Promise<OrderPlatformModel.OrderStatusResult>} - Success response
54
53
  * @name checkOrderStatus
55
- * @summary: Debug order
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://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
54
+ * @summary: Check order status.
55
+ * @description: Verify the current status of an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
57
56
  */
58
57
  checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
59
58
  /**
60
- * @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
59
+ * @param {OrderPlatformValidator.Click2CallParam} arg - Arg object
61
60
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
62
61
  * @param {import("../PlatformAPIClient").Options} - Options
63
- * @returns {Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>}
64
- * - Success response
65
- *
66
- * @name createChannelConfig
67
- * @summary: Create channel configuration
68
- * @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://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
62
+ * @returns {Promise<OrderPlatformModel.Click2CallResponse>} - Success response
63
+ * @name click2Call
64
+ * @summary: Click to call.
65
+ * @description: Click to call. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/click2Call/).
69
66
  */
70
- createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>;
67
+ click2Call({ caller, receiver, bagId, callerId, method, requestHeaders }?: OrderPlatformValidator.Click2CallParam, { responseHeaders }?: object): Promise<OrderPlatformModel.Click2CallResponse>;
71
68
  /**
72
69
  * @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
73
70
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
74
71
  * @param {import("../PlatformAPIClient").Options} - Options
75
- * @returns {Promise<OrderPlatformModel.CreateOrderResponseSchema>} - Success response
72
+ * @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
76
73
  * @name createOrder
77
- * @summary: Create order
78
- * @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
74
+ * @summary: Create order.
75
+ * @description: Create order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
79
76
  */
80
- createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponseSchema>;
77
+ createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
81
78
  /**
82
- * @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
79
+ * @param {OrderPlatformValidator.DeleteUserViewsParam} arg - Arg object
83
80
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
84
81
  * @param {import("../PlatformAPIClient").Options} - Options
85
- * @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
86
- * @name dispatchManifests
87
- * @summary: Dispatch manifest
88
- * @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/).
82
+ * @returns {Promise<OrderPlatformModel.CreateUpdateDeleteResponse>} -
83
+ * Success response
84
+ * @name deleteUserViews
85
+ * @summary: Delete custom view for every unique user cross company pair.
86
+ * @description: Delete custom view for every unique user cross company pair. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/deleteUserViews/).
89
87
  */
90
- dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
88
+ deleteUserViews({ viewId, requestHeaders }?: OrderPlatformValidator.DeleteUserViewsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateUpdateDeleteResponse>;
91
89
  /**
92
90
  * @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
93
91
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
94
92
  * @param {import("../PlatformAPIClient").Options} - Options
95
- * @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
93
+ * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
96
94
  * @name downloadBulkActionTemplate
97
- * @summary: Download bulk template
98
- * @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/).
95
+ * @summary: Download bulk action template.
96
+ * @description: Download bulk actions seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
99
97
  */
100
- downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
98
+ downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
101
99
  /**
102
100
  * @param {OrderPlatformValidator.DownloadLanesReportParam} arg - Arg object
103
101
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
104
102
  * @param {import("../PlatformAPIClient").Options} - Options
105
- * @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>}
106
- * - Success response
107
- *
103
+ * @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponse>} -
104
+ * Success response
108
105
  * @name downloadLanesReport
109
- * @summary: Download Lane report
110
- * @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
106
+ * @summary: Downloads lanes shipment/orders.
107
+ * @description: Downloads lanes shipment/orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
111
108
  */
112
- downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>;
109
+ downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponse>;
113
110
  /**
114
111
  * @param {OrderPlatformValidator.EInvoiceRetryParam} arg - Arg object
115
112
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
116
113
  * @param {import("../PlatformAPIClient").Options} - Options
117
- * @returns {Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>} -
118
- * Success response
114
+ * @returns {Promise<OrderPlatformModel.EInvoiceRetryResponse>} - Success response
119
115
  * @name eInvoiceRetry
120
- * @summary: Retry E-invoice
121
- * @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
116
+ * @summary: Retry e-invoice after failure
117
+ * @description: Retry e-invoice after failure - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
122
118
  */
123
- eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>;
119
+ eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponse>;
124
120
  /**
125
121
  * @param {OrderPlatformValidator.FailedOrderLogDetailsParam} arg - Arg object
126
122
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
127
123
  * @param {import("../PlatformAPIClient").Options} - Options
128
124
  * @returns {Promise<OrderPlatformModel.FailedOrderLogDetails>} - Success response
129
125
  * @name failedOrderLogDetails
130
- * @summary: Get failed order log
131
- * @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/).
126
+ * @summary: Get failed order logs according to the filter provided
127
+ * @description: This endpoint allows users to get the exact error trace from the log id provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
132
128
  */
133
129
  failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
134
130
  /**
135
- * @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
131
+ * @param {OrderPlatformValidator.FetchCreditBalanceDetailParam} arg - Arg object
136
132
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
137
133
  * @param {import("../PlatformAPIClient").Options} - Options
138
- * @returns {Promise<OrderPlatformModel.RefundModeConfigResponsePayload>} -
139
- * Success response
140
- * @name fetchRefundModeConfig
141
- * @summary: List refund modes
142
- * @description: Get list of refund modes to trigger refunds - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
134
+ * @returns {Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>}
135
+ * - Success response
136
+ *
137
+ * @name fetchCreditBalanceDetail
138
+ * @summary: Fetch credit balance detail.
139
+ * @description: Retrieve details about credit balance. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
143
140
  */
144
- fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
141
+ fetchCreditBalanceDetail({ body, requestHeaders }?: OrderPlatformValidator.FetchCreditBalanceDetailParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>;
145
142
  /**
146
- * @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
143
+ * @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
147
144
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
148
145
  * @param {import("../PlatformAPIClient").Options} - Options
149
- * @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>} -
146
+ * @returns {Promise<OrderPlatformModel.RefundModeConfigResponsePayload>} -
150
147
  * Success response
151
- * @name generateInvoiceID
152
- * @summary: Generate and attach invoice Id
153
- * @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
148
+ * @name fetchRefundModeConfig
149
+ * @summary: Fetch refund mode config.
150
+ * @description: Retrieve configuration for refund modes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
154
151
  */
155
- generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>;
152
+ fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
156
153
  /**
157
154
  * @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
158
155
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
159
156
  * @param {import("../PlatformAPIClient").Options} - Options
160
- * @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>}
161
- * - Success response
162
- *
157
+ * @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
158
+ * Success response
163
159
  * @name generatePOSReceiptByOrderId
164
- * @summary: Generate POS receipt by order Id
165
- * @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/).
166
- */
167
- generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>;
168
- /**
169
- * @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
170
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
171
- * @param {import("../PlatformAPIClient").Options} - Options
172
- * @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
173
- * @name generateProcessManifest
174
- * @summary: Process Order Manifest
175
- * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
160
+ * @summary: Generate POS receipt by order ID.
161
+ * @description: Generate POS recipt by order id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
176
162
  */
177
- generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponseSchema>;
163
+ generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
178
164
  /**
179
165
  * @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
180
166
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -182,400 +168,610 @@ declare class Order {
182
168
  * @returns {Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>} -
183
169
  * Success response
184
170
  * @name getAllowedStateTransition
185
- * @summary: Get allowed state transition
186
- * @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/).
171
+ * @summary: Get allowed state transition.
172
+ * @description: Retrieve next possible states based on logged in user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
187
173
  */
188
174
  getAllowedStateTransition({ orderingChannel, status, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
189
175
  /**
190
176
  * @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
191
177
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
192
178
  * @param {import("../PlatformAPIClient").Options} - Options
193
- * @returns {Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>} -
194
- * Success response
179
+ * @returns {Promise<OrderPlatformModel.AllowedTemplatesResponse>} - Success response
195
180
  * @name getAllowedTemplatesForBulk
196
- * @summary: List bulk operation templates
197
- * @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
181
+ * @summary: Gets All the allowed Templates to perform Bulk Operations.
182
+ * @description: Gets All the allowed Templates to perform Bulk Operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
198
183
  */
199
- getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>;
184
+ getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponse>;
200
185
  /**
201
186
  * @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
202
187
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
203
188
  * @param {import("../PlatformAPIClient").Options} - Options
204
- * @returns {Promise<OrderPlatformModel.AnnouncementsResponseSchema>} -
205
- * Success response
189
+ * @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
206
190
  * @name getAnnouncements
207
- * @summary: List announcements
208
- * @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/).
191
+ * @summary: Get announcements.
192
+ * @description: Retrieve announcements related to orders or shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
209
193
  */
210
- getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponseSchema>;
194
+ getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
211
195
  /**
212
196
  * @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
213
197
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
214
198
  * @param {import("../PlatformAPIClient").Options} - Options
215
- * @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>}
216
- * - Success response
217
- *
199
+ * @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
200
+ * Success response
218
201
  * @name getBagById
219
- * @summary: Get bag
220
- * @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
202
+ * @summary: Get bag by ID.
203
+ * @description: Get Order Bag Details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
221
204
  */
222
- getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>;
205
+ getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
223
206
  /**
224
207
  * @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
225
208
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
226
209
  * @param {import("../PlatformAPIClient").Options} - Options
227
- * @returns {Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>} -
228
- * Success response
210
+ * @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
229
211
  * @name getBags
230
- * @summary: List bags
231
- * @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
212
+ * @summary: Get bags.
213
+ * @description: Get Bags for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
232
214
  */
233
- getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>;
215
+ getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
234
216
  /**
235
217
  * @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
236
218
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
237
219
  * @param {import("../PlatformAPIClient").Options} - Options
238
- * @returns {Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>}
239
- * - Success response
240
- *
220
+ * @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
221
+ * Success response
241
222
  * @name getBulkActionTemplate
242
- * @summary: List supported templates
243
- * @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/).
223
+ * @summary: Get bulk action template.
224
+ * @description: Get Bulk Action seller templates. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
244
225
  */
245
- getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>;
226
+ getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
246
227
  /**
247
228
  * @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
248
229
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
249
230
  * @param {import("../PlatformAPIClient").Options} - Options
250
- * @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
231
+ * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
251
232
  * @name getBulkShipmentExcelFile
252
- * @summary: Generate the report
253
- * @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/).
233
+ * @summary: Get bulk shipment Excel file.
234
+ * @description: Generate Bulk Shipment Excel Report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
254
235
  */
255
- getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
236
+ getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
256
237
  /**
257
- * @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
238
+ * @param {OrderPlatformValidator.GetFailedOrderLogsParam} arg - Arg object
258
239
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
259
240
  * @param {import("../PlatformAPIClient").Options} - Options
260
- * @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
261
- * @name getChannelConfig
262
- * @summary: Get channel configuration
263
- * @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
241
+ * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
242
+ * @name getFailedOrderLogs
243
+ * @summary: Get failed order logs according to the filter provided
244
+ * @description: This endpoint allows users to 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/getFailedOrderLogs/).
264
245
  */
265
- getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
246
+ getFailedOrderLogs({ pageNo, pageSize, searchType, searchValue, requestHeaders }?: OrderPlatformValidator.GetFailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
266
247
  /**
267
248
  * @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
268
249
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
269
250
  * @param {import("../PlatformAPIClient").Options} - Options
270
- * @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
251
+ * @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
271
252
  * @name getFileByStatus
272
- * @summary: Download file used for Bulk operation
273
- * @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/).
253
+ * @summary: Get the file URL consisting Records of the provided status.
254
+ * @description: Get the file URL consisting Records of the provided status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
274
255
  */
275
- getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponseSchema>;
256
+ getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponse>;
257
+ /**
258
+ * @param {OrderPlatformValidator.GetGlobalFiltersParam} arg - Arg object
259
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
260
+ * @param {import("../PlatformAPIClient").Options} - Options
261
+ * @returns {Promise<OrderPlatformModel.GlobalFiltersResponse>} - Success response
262
+ * @name getGlobalFilters
263
+ * @summary: Get global filters for populating filter listing and powering views api.
264
+ * @description: Get global filters for populating filter listing and powering views api. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getGlobalFilters/).
265
+ */
266
+ getGlobalFilters({ showIn, requestHeaders }?: OrderPlatformValidator.GetGlobalFiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GlobalFiltersResponse>;
276
267
  /**
277
268
  * @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
278
269
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
279
270
  * @param {import("../PlatformAPIClient").Options} - Options
280
- * @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
271
+ * @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
281
272
  * @name getLaneConfig
282
- * @summary: Get lane configuration
283
- * @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
273
+ * @summary: Get lane configuration.
274
+ * @description: Get lane config for the order and shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
284
275
  */
285
- 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>;
276
+ 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>;
286
277
  /**
287
- * @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
278
+ * @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
288
279
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
289
280
  * @param {import("../PlatformAPIClient").Options} - Options
290
- * @returns {Promise<OrderPlatformModel.ManifestDetails>} - Success response
291
- * @name getManifestDetails
292
- * @summary: Get a manifest
293
- * @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/).
281
+ * @returns {Promise<OrderPlatformModel.ManifestFiltersResponse>} - Success response
282
+ * @name getManifestfilters
283
+ * @summary: get Manifest Filters.
284
+ * @description: get Manifest Filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
294
285
  */
295
- getManifestDetails({ manifestId, dpIds, endDate, startDate, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
286
+ getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponse>;
296
287
  /**
297
- * @param {OrderPlatformValidator.GetManifestShipmentsParam} arg - Arg object
288
+ * @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
298
289
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
299
290
  * @param {import("../PlatformAPIClient").Options} - Options
300
- * @returns {Promise<OrderPlatformModel.ManifestShipmentListing>} - Success response
301
- * @name getManifestShipments
302
- * @summary: List manifest shipments
303
- * @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/).
291
+ * @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
292
+ * @name getOrderById
293
+ * @summary: Get order by ID.
294
+ * @description: Retrieve detailed information about a specific order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
304
295
  */
305
- getManifestShipments({ dpIds, stores, toDate, fromDate, dpName, salesChannels, searchType, searchValue, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestShipmentListing>;
296
+ getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
306
297
  /**
307
- * @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
298
+ * @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
308
299
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
309
300
  * @param {import("../PlatformAPIClient").Options} - Options
310
- * @returns {Promise<OrderPlatformModel.ManifestFiltersResponseSchema>} -
311
- * Success response
312
- * @name getManifestfilters
313
- * @summary: List filters
314
- * @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
301
+ * @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
302
+ * @name getOrders
303
+ * @summary: Get orders.
304
+ * @description: Get Orders Listing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
305
+ */
306
+ getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, operationalStatus, financialStatus, logisticsStatus, parentViewSlug, childViewSlug, groupEntity, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
307
+ /**
308
+ * @param {Object} arg - Arg object.
309
+ * @param {string} [arg.lane] - Lane refers to a section where orders are
310
+ * assigned, indicating its grouping
311
+ * @param {string} [arg.searchType] - Search_type refers to the field that
312
+ * will be used as the target for the search operation
313
+ * @param {string} [arg.bagStatus] - Bag_status refers to the status of the
314
+ * entity. Filters orders based on the status.
315
+ * @param {number} [arg.timeToDispatch] - Time_to_dispatch refers to the
316
+ * estimated SLA time.
317
+ * @param {string} [arg.paymentMethods] -
318
+ * @param {string} [arg.tags] - Tags refer to additional descriptive labels
319
+ * associated with the order
320
+ * @param {string} [arg.searchValue] - Search_value is matched against the
321
+ * field specified by the search_type
322
+ * @param {string} [arg.fromDate] -
323
+ * @param {string} [arg.toDate] -
324
+ * @param {string} [arg.startDate] -
325
+ * @param {string} [arg.endDate] -
326
+ * @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
327
+ * @param {string} [arg.stores] -
328
+ * @param {string} [arg.salesChannels] -
329
+ * @param {number} [arg.pageSize] -
330
+ * @param {boolean} [arg.isPrioritySort] -
331
+ * @param {Object[]} [arg.customMeta] -
332
+ * @param {boolean} [arg.myOrders] -
333
+ * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
334
+ * non-cross company order
335
+ * @param {string} [arg.customerId] -
336
+ * @param {string} [arg.orderType] -
337
+ * @param {string} [arg.operationalStatus] - Statuses relating to shipment
338
+ * transition in order processing journey. Comma separated values of
339
+ * operational statuses.
340
+ * @param {string} [arg.financialStatus] - Statuses relating to finance
341
+ * related operations in the order processing journey. Comma separated
342
+ * values of financial statuses.
343
+ * @param {string} [arg.logisticsStatus] - Statuses relating to delivery and
344
+ * pickup related operations in the order processing journey. Comma
345
+ * separated values of logistics statuses.
346
+ * @param {string} [arg.parentViewSlug] - Parent view is used for grouping
347
+ * of child views. Slug of parent view.
348
+ * @param {string} [arg.childViewSlug] - Child view is user configured view,
349
+ * which has filters added by the user on which shipments/orders are
350
+ * fetched. Slug of child view.
351
+ * @param {string} [arg.groupEntity] - Defines the grouping criterion for
352
+ * retrieving shipments or orders. It specifies whether the results should
353
+ * be organized based on shipment groups or order groups. For example,
354
+ * using 'shipments' groups results by shipment, while an invalid value
355
+ * like 'abcd' may not be recognized, leading to errors or default behavior.
356
+ * @returns {Paginator<OrderPlatformModel.OrderListingResponse>}
357
+ * @summary: Get orders.
358
+ * @description: Get Orders Listing
359
+ */
360
+ getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, operationalStatus, financialStatus, logisticsStatus, parentViewSlug, childViewSlug, groupEntity, }?: {
361
+ lane?: string;
362
+ searchType?: string;
363
+ bagStatus?: string;
364
+ timeToDispatch?: number;
365
+ paymentMethods?: string;
366
+ tags?: string;
367
+ searchValue?: string;
368
+ fromDate?: string;
369
+ toDate?: string;
370
+ startDate?: string;
371
+ endDate?: string;
372
+ dpIds?: string;
373
+ stores?: string;
374
+ salesChannels?: string;
375
+ pageSize?: number;
376
+ isPrioritySort?: boolean;
377
+ customMeta?: any[];
378
+ myOrders?: boolean;
379
+ showCrossCompanyData?: boolean;
380
+ customerId?: string;
381
+ orderType?: string;
382
+ operationalStatus?: string;
383
+ financialStatus?: string;
384
+ logisticsStatus?: string;
385
+ parentViewSlug?: string;
386
+ childViewSlug?: string;
387
+ groupEntity?: string;
388
+ }): Paginator<OrderPlatformModel.OrderListingResponse>;
389
+ /**
390
+ * @param {OrderPlatformValidator.GetRefundConfigurationParam} arg - Arg object
391
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
392
+ * @param {import("../PlatformAPIClient").Options} - Options
393
+ * @returns {Promise<OrderPlatformModel.RefundStateConfigurationManualSchemaResponse>}
394
+ * - Success response
395
+ *
396
+ * @name getRefundConfiguration
397
+ * @summary: refund configuration.
398
+ * @description: refund configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundConfiguration/).
315
399
  */
316
- getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponseSchema>;
400
+ getRefundConfiguration({ appId, requestHeaders }?: OrderPlatformValidator.GetRefundConfigurationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundStateConfigurationManualSchemaResponse>;
317
401
  /**
318
- * @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
402
+ * @param {OrderPlatformValidator.GetRefundEnableStateListParam} arg - Arg object
319
403
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
320
404
  * @param {import("../PlatformAPIClient").Options} - Options
321
- * @returns {Promise<OrderPlatformModel.ManifestList>} - Success response
322
- * @name getManifests
323
- * @summary: List manifests
324
- * @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/).
405
+ * @returns {Promise<OrderPlatformModel.GetRefundStates>} - Success response
406
+ * @name getRefundEnableStateList
407
+ * @summary: Refund State Configuration
408
+ * @description: refund configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundEnableStateList/).
325
409
  */
326
- getManifests({ status, startDate, endDate, searchType, storeId, searchValue, dpIds, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestList>;
410
+ getRefundEnableStateList({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetRefundStates>;
327
411
  /**
328
- * @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
412
+ * @param {OrderPlatformValidator.GetRefundOptionsParam} arg - Arg object
329
413
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
330
414
  * @param {import("../PlatformAPIClient").Options} - Options
331
- * @returns {Promise<OrderPlatformModel.OrderDetailsResponseSchema>} -
415
+ * @returns {Promise<OrderPlatformModel.RefundOptionsSchemaResponse>} -
332
416
  * Success response
333
- * @name getOrderById
334
- * @summary: Get order
335
- * @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
417
+ * @name getRefundOptions
418
+ * @summary: Retrieve refund options with amount breakup for specific shipment and bags.
419
+ * @description: This API can be used for giving the refund amount with available option of MOPs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundOptions/).
336
420
  */
337
- getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponseSchema>;
421
+ getRefundOptions({ shipmentId, bagIds, state, optinAppId, optinCompanyId, status, requestHeaders, }?: OrderPlatformValidator.GetRefundOptionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundOptionsSchemaResponse>;
338
422
  /**
339
- * @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
423
+ * @param {OrderPlatformValidator.GetRefundStateConfigurationParam} arg - Arg object
340
424
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
341
425
  * @param {import("../PlatformAPIClient").Options} - Options
342
- * @returns {Promise<OrderPlatformModel.OrderListingResponseSchema>} -
343
- * Success response
344
- * @name getOrders
345
- * @summary: List orders
346
- * @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/).
426
+ * @returns {Promise<OrderPlatformModel.GetRefundStateConfigurationResponse>}
427
+ * - Success response
428
+ *
429
+ * @name getRefundStateConfiguration
430
+ * @summary: Refund State Configuration
431
+ * @description: Refund State Configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRefundStateConfiguration/).
347
432
  */
348
- 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, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
433
+ getRefundStateConfiguration({ appId, requestHeaders }?: OrderPlatformValidator.GetRefundStateConfigurationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetRefundStateConfigurationResponse>;
349
434
  /**
350
435
  * @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
351
436
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
352
437
  * @param {import("../PlatformAPIClient").Options} - Options
353
- * @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
438
+ * @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
354
439
  * @name getRoleBasedActions
355
- * @summary: Get role-based actions
356
- * @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/).
440
+ * @summary: Get role-based actions.
441
+ * @description: Retrieve role based actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
357
442
  */
358
- getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponseSchema>;
443
+ getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
359
444
  /**
360
445
  * @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
361
446
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
362
447
  * @param {import("../PlatformAPIClient").Options} - Options
363
- * @returns {Promise<OrderPlatformModel.ShipmentInfoResponseSchema>} -
364
- * Success response
448
+ * @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
365
449
  * @name getShipmentById
366
- * @summary: Get shipment details
367
- * @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
450
+ * @summary: Get shipment by ID.
451
+ * @description: Retrieve detailed information about a specific shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
368
452
  */
369
- getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponseSchema>;
453
+ getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, requestHeaders }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
370
454
  /**
371
455
  * @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
372
456
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
373
457
  * @param {import("../PlatformAPIClient").Options} - Options
374
- * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
375
- * Success response
458
+ * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
376
459
  * @name getShipmentHistory
377
- * @summary: Get a shipment's history
378
- * @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
460
+ * @summary: Get shipment history.
461
+ * @description: Retrieve the shipment history. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
379
462
  */
380
- getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
463
+ getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
381
464
  /**
382
465
  * @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
383
466
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
384
467
  * @param {import("../PlatformAPIClient").Options} - Options
385
- * @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>}
386
- * - Success response
387
- *
468
+ * @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
469
+ * Success response
388
470
  * @name getShipmentReasons
389
- * @summary: List bag cancellation reasons
390
- * @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/).
471
+ * @summary: Get reasons behind full or partial cancellation of a shipment
472
+ * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
391
473
  */
392
- getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>;
474
+ getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
393
475
  /**
394
476
  * @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
395
477
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
396
478
  * @param {import("../PlatformAPIClient").Options} - Options
397
- * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
479
+ * @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
398
480
  * - Success response
399
481
  *
400
482
  * @name getShipments
401
- * @summary: List shipments
402
- * @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/).
403
- */
404
- 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, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
405
- /**
406
- * @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
407
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
408
- * @param {import("../PlatformAPIClient").Options} - Options
409
- * @returns {Promise<Object>} - Success response
410
- * @name getStateManagerConfig
411
- * @summary: Retrieves Entity State Manager configuration which includes flags, hooks, and filters, for a specific application within a company's setup.
412
- * @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.
413
- * 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.
414
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerConfig/).
415
- */
416
- getStateManagerConfig({ appId, orderingChannel, entity, requestHeaders }?: OrderPlatformValidator.GetStateManagerConfigParam, { responseHeaders }?: object): Promise<any>;
483
+ * @summary: Get shipments.
484
+ * @description: Get Shipments Listing for the company id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
485
+ */
486
+ 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, operationalStatus, financialStatus, logisticsStatus, parentViewSlug, childViewSlug, lockStatus, groupEntity, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
487
+ /**
488
+ * @param {Object} arg - Arg object.
489
+ * @param {string} [arg.lane] - Name of lane for which data is to be fetched
490
+ * @param {string} [arg.bagStatus] - Comma separated values of bag statuses
491
+ * @param {boolean} [arg.statusOverrideLane] - Use this flag to fetch by
492
+ * bag_status and override lane
493
+ * @param {number} [arg.timeToDispatch] -
494
+ * @param {string} [arg.searchType] - Search type key
495
+ * @param {string} [arg.searchValue] - Search type value
496
+ * @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
497
+ * @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
498
+ * @param {string} [arg.startDate] - UTC Start Date in ISO format
499
+ * @param {string} [arg.endDate] - UTC End Date in ISO format
500
+ * @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
501
+ * @param {string} [arg.stores] - Comma separated values of store ids
502
+ * @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
503
+ * @param {number} [arg.pageSize] - Page size of data received per page
504
+ * @param {boolean} [arg.fetchActiveShipment] - Flag to fetch active shipments
505
+ * @param {boolean} [arg.allowInactive] - Flag to allow inactive shipments
506
+ * @param {boolean} [arg.excludeLockedShipments] - Flag to fetch locked shipments
507
+ * @param {string} [arg.paymentMethods] - Comma separated values of payment methods
508
+ * @param {string} [arg.channelShipmentId] - App Shipment Id
509
+ * @param {string} [arg.channelOrderId] - App Order Id
510
+ * @param {string} [arg.customMeta] -
511
+ * @param {string} [arg.orderingChannel] -
512
+ * @param {string} [arg.companyAffiliateTag] -
513
+ * @param {boolean} [arg.myOrders] -
514
+ * @param {string} [arg.platformUserId] -
515
+ * @param {string} [arg.sortType] - Sort the result data on basis of input
516
+ * @param {boolean} [arg.showCrossCompanyData] - Flag to view cross &
517
+ * non-cross company order
518
+ * @param {string} [arg.tags] - Comma separated values of tags
519
+ * @param {string} [arg.customerId] -
520
+ * @param {string} [arg.orderType] -
521
+ * @param {string} [arg.operationalStatus] - Statuses relating to shipment
522
+ * transition in order processing journey. Comma separated values of
523
+ * operational statuses.
524
+ * @param {string} [arg.financialStatus] - Statuses relating to finance
525
+ * related operations in the order processing journey. Comma separated
526
+ * values of financial statuses.
527
+ * @param {string} [arg.logisticsStatus] - Statuses relating to delivery and
528
+ * pickup related operations in the order processing journey. Comma
529
+ * separated values of logistics statuses.
530
+ * @param {string} [arg.parentViewSlug] - Parent view is used for grouping
531
+ * of child views. Slug of parent view.
532
+ * @param {string} [arg.childViewSlug] - Child view is user configured view
533
+ * which has filters added by the user on which shipments/orders are
534
+ * fetched. Slug of child view.
535
+ * @param {string} [arg.lockStatus] - Flag to identify if a shipment is locked or not.
536
+ * @param {string} [arg.groupEntity] - Defines the grouping criterion for
537
+ * retrieving shipments or orders. It specifies whether the results should
538
+ * be organized based on shipment groups or order groups. For example,
539
+ * using 'shipments' groups results by shipment, while an invalid value
540
+ * like 'abcd' may not be recognized, leading to errors or default behavior.
541
+ * @returns {Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
542
+ * @summary: Get shipments.
543
+ * @description: Get Shipments Listing for the company id
544
+ */
545
+ getShipmentsPaginator({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, operationalStatus, financialStatus, logisticsStatus, parentViewSlug, childViewSlug, lockStatus, groupEntity, }?: {
546
+ lane?: string;
547
+ bagStatus?: string;
548
+ statusOverrideLane?: boolean;
549
+ timeToDispatch?: number;
550
+ searchType?: string;
551
+ searchValue?: string;
552
+ fromDate?: string;
553
+ toDate?: string;
554
+ startDate?: string;
555
+ endDate?: string;
556
+ dpIds?: string;
557
+ stores?: string;
558
+ salesChannels?: string;
559
+ pageSize?: number;
560
+ fetchActiveShipment?: boolean;
561
+ allowInactive?: boolean;
562
+ excludeLockedShipments?: boolean;
563
+ paymentMethods?: string;
564
+ channelShipmentId?: string;
565
+ channelOrderId?: string;
566
+ customMeta?: string;
567
+ orderingChannel?: string;
568
+ companyAffiliateTag?: string;
569
+ myOrders?: boolean;
570
+ platformUserId?: string;
571
+ sortType?: string;
572
+ showCrossCompanyData?: boolean;
573
+ tags?: string;
574
+ customerId?: string;
575
+ orderType?: string;
576
+ operationalStatus?: string;
577
+ financialStatus?: string;
578
+ logisticsStatus?: string;
579
+ parentViewSlug?: string;
580
+ childViewSlug?: string;
581
+ lockStatus?: string;
582
+ groupEntity?: string;
583
+ }): Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
417
584
  /**
418
585
  * @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
419
586
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
420
587
  * @param {import("../PlatformAPIClient").Options} - Options
421
588
  * @returns {Promise<OrderPlatformModel.BagStateTransitionMap>} - Success response
422
589
  * @name getStateTransitionMap
423
- * @summary: Get state transition map
424
- * @description: Retrieve a map of state transitions for orders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
590
+ * @summary: Get state transition map.
591
+ * @description: Retrieve a map of state transitions for orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
425
592
  */
426
593
  getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
427
594
  /**
428
595
  * @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
429
596
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
430
597
  * @param {import("../PlatformAPIClient").Options} - Options
431
- * @returns {Promise<OrderPlatformModel.TemplateDownloadResponseSchema>} -
432
- * Success response
598
+ * @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
433
599
  * @name getTemplate
434
- * @summary: Download bulk operation templates
435
- * @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/).
600
+ * @summary: Get the Excel file URL for the Template.
601
+ * @description: Get the Excel file URL for the Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
602
+ */
603
+ getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
604
+ /**
605
+ * @param {OrderPlatformValidator.GetUserViewsParam} arg - Arg object
606
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
607
+ * @param {import("../PlatformAPIClient").Options} - Options
608
+ * @returns {Promise<OrderPlatformModel.UserViewsResponse>} - Success response
609
+ * @name getUserViews
610
+ * @summary: Get custom view for every unique user cross company pair.
611
+ * @description: Get custom view for every unique user cross company pair. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getUserViews/).
436
612
  */
437
- getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponseSchema>;
613
+ getUserViews({ showIn, requestHeaders }?: OrderPlatformValidator.GetUserViewsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UserViewsResponse>;
438
614
  /**
439
615
  * @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
440
616
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
441
617
  * @param {import("../PlatformAPIClient").Options} - Options
442
- * @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
618
+ * @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
443
619
  * @name getfilters
444
- * @summary: List filters
445
- * @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
620
+ * @summary: Get filters.
621
+ * @description: Retrieve listing filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
446
622
  */
447
- getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponseSchema>;
623
+ getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
448
624
  /**
449
625
  * @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
450
626
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
451
627
  * @param {import("../PlatformAPIClient").Options} - Options
452
- * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>}
453
- * - Success response
454
- *
628
+ * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
629
+ * Success response
455
630
  * @name invalidateShipmentCache
456
- * @summary: Invalidate shipment cache
457
- * @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/).
631
+ * @summary: Invalidate shipment cache.
632
+ * @description: Invalidate shipment Cache. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
458
633
  */
459
- invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>;
634
+ invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
460
635
  /**
461
636
  * @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
462
637
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
463
638
  * @param {import("../PlatformAPIClient").Options} - Options
464
- * @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
639
+ * @returns {Promise<OrderPlatformModel.JobDetailsResponse>} - Success response
465
640
  * @name jobDetails
466
- * @summary: Get bulk operation details
467
- * @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/).
641
+ * @summary: Fetches details for the job of the provided batch_id
642
+ * @description: Fetches details for the job of the provided batch_id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/jobDetails/).
468
643
  */
469
- jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponseSchema>;
644
+ jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponse>;
470
645
  /**
471
646
  * @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
472
647
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
473
648
  * @param {import("../PlatformAPIClient").Options} - Options
474
649
  * @returns {Promise<OrderPlatformModel.ResponseDetail>} - Success response
475
650
  * @name orderUpdate
476
- * @summary: Update an order
477
- * @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/).
651
+ * @summary: Order update.
652
+ * @description: Modify the details and status of an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/orderUpdate/).
478
653
  */
479
654
  orderUpdate({ body, requestHeaders }?: OrderPlatformValidator.OrderUpdateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ResponseDetail>;
655
+ /**
656
+ * @param {OrderPlatformValidator.PostRefundConfigurationParam} arg - Arg object
657
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
658
+ * @param {import("../PlatformAPIClient").Options} - Options
659
+ * @returns {Promise<OrderPlatformModel.RefundStateConfigurationManualSchemaResponse>}
660
+ * - Success response
661
+ *
662
+ * @name postRefundConfiguration
663
+ * @summary: refund configuration.
664
+ * @description: refund configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postRefundConfiguration/).
665
+ */
666
+ postRefundConfiguration({ appId, body, requestHeaders }?: OrderPlatformValidator.PostRefundConfigurationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundStateConfigurationManualSchemaResponse>;
667
+ /**
668
+ * @param {OrderPlatformValidator.PostRefundStateConfigurationParam} arg - Arg object
669
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
670
+ * @param {import("../PlatformAPIClient").Options} - Options
671
+ * @returns {Promise<OrderPlatformModel.PostRefundStateConfigurationResponse>}
672
+ * - Success response
673
+ *
674
+ * @name postRefundStateConfiguration
675
+ * @summary: Refund State Configuration
676
+ * @description: Refund State Configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postRefundStateConfiguration/).
677
+ */
678
+ postRefundStateConfiguration({ appId, body, requestHeaders }?: OrderPlatformValidator.PostRefundStateConfigurationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PostRefundStateConfigurationResponse>;
480
679
  /**
481
680
  * @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
482
681
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
483
682
  * @param {import("../PlatformAPIClient").Options} - Options
484
- * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
485
- * Success response
683
+ * @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
486
684
  * @name postShipmentHistory
487
- * @summary: Create shipment history
488
- * @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/).
685
+ * @summary: Post shipment history.
686
+ * @description: Add history records for a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
489
687
  */
490
- postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
688
+ postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
491
689
  /**
492
690
  * @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
493
691
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
494
692
  * @param {import("../PlatformAPIClient").Options} - Options
495
- * @returns {Promise<OrderPlatformModel.StoreReassignResponseSchema>} -
496
- * Success response
693
+ * @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
497
694
  * @name reassignLocation
498
- * @summary: Reassign location
499
- * @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/).
695
+ * @summary: Reassign location.
696
+ * @description: Change the assigned location for an order or shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
500
697
  */
501
- reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponseSchema>;
698
+ reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponse>;
502
699
  /**
503
700
  * @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
504
701
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
505
702
  * @param {import("../PlatformAPIClient").Options} - Options
506
- * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
703
+ * @returns {Promise<OrderPlatformModel.SendSmsResponse>} - Success response
507
704
  * @name sendSmsNinja
508
- * @summary: Send SMS
509
- * @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/).
705
+ * @summary: Send SMS via Ninja.
706
+ * @description: Send SMS Ninja Panel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
510
707
  */
511
- sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
708
+ sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendSmsResponse>;
512
709
  /**
513
710
  * @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
514
711
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
515
712
  * @param {import("../PlatformAPIClient").Options} - Options
516
- * @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>} -
517
- * Success response
713
+ * @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
518
714
  * @name sendUserMobileOTP
519
- * @summary: Send user mobile OTP
520
- * @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/).
715
+ * @summary: Send user mobile OTP.
716
+ * @description: Send a one-time OTP to a users mobile device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
521
717
  */
522
- sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>;
718
+ sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
523
719
  /**
524
720
  * @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
525
721
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
526
722
  * @param {import("../PlatformAPIClient").Options} - Options
527
- * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>}
528
- * - Success response
529
- *
723
+ * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
724
+ * Success response
530
725
  * @name trackShipment
531
- * @summary: Track shipment
532
- * @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/).
726
+ * @summary: Retrieve courier partner tracking details for a given shipment id or awb no.
727
+ * @description: Retrieve courier partner tracking details for a given shipment id or awb no. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
533
728
  */
534
- trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>;
729
+ trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
535
730
  /**
536
- * @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
731
+ * @param {OrderPlatformValidator.UpdateOrderParam} arg - Arg object
537
732
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
538
733
  * @param {import("../PlatformAPIClient").Options} - Options
539
- * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
540
- * @name updateAddress
541
- * @summary: Update shipment address
542
- * @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://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
734
+ * @returns {Promise<OrderPlatformModel.OrderUpdateResponseDetail>} - Success response
735
+ * @name updateOrder
736
+ * @summary: Enables the updating of various order properties, including tax_details, meta, and more, providing flexibility and precision in order adjustments.
737
+ * @description: Enables the updating of various order properties, including tax_details, meta, and more, providing flexibility and precision in order adjustments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateOrder/).
543
738
  */
544
- updateAddress({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
739
+ updateOrder({ orderId, body, requestHeaders }?: OrderPlatformValidator.UpdateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderUpdateResponseDetail>;
545
740
  /**
546
741
  * @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
547
742
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
548
743
  * @param {import("../PlatformAPIClient").Options} - Options
549
- * @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>}
744
+ * @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>}
550
745
  * - Success response
551
746
  *
552
747
  * @name updatePackagingDimensions
553
- * @summary: Update packaging dimensions
554
- * @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
748
+ * @summary: Update packaging dimensions.
749
+ * @description: Modify the dimensions of packaging. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
555
750
  */
556
- updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>;
751
+ updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
557
752
  /**
558
- * @param {OrderPlatformValidator.UpdatePaymentInfoParam} arg - Arg object
753
+ * @param {OrderPlatformValidator.UpdateShipmentParam} arg - Arg object
559
754
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
560
755
  * @param {import("../PlatformAPIClient").Options} - Options
561
- * @returns {Promise<Object>} - Success response
562
- * @name updatePaymentInfo
563
- * @summary: Update payment details for an order, its shipments and its bags.
564
- * @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://partners.fynd.com/help/docs/sdk/platform/order/updatePaymentInfo/).
756
+ * @returns {Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>}
757
+ * - Success response
758
+ *
759
+ * @name updateShipment
760
+ * @summary: Update shipment status.
761
+ * @description: Shipment action transition or Shipment data update or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipment/).
565
762
  */
566
- updatePaymentInfo({ body, requestHeaders }?: OrderPlatformValidator.UpdatePaymentInfoParam, { responseHeaders }?: object): Promise<any>;
763
+ updateShipment({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
567
764
  /**
568
765
  * @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
569
766
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
570
767
  * @param {import("../PlatformAPIClient").Options} - Options
571
- * @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>}
572
- * - Success response
573
- *
768
+ * @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
769
+ * Success response
574
770
  * @name updateShipmentLock
575
- * @summary: Update a shipment lock
576
- * @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/).
771
+ * @summary: Update shipment lock.
772
+ * @description: Modify shipment/bag lock and check status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
577
773
  */
578
- updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>;
774
+ updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
579
775
  /**
580
776
  * @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
581
777
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -584,8 +780,8 @@ declare class Order {
584
780
  * - Success response
585
781
  *
586
782
  * @name updateShipmentStatus
587
- * @summary: Update a shipment's status
588
- * @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/).
783
+ * @summary: Update shipment status.
784
+ * @description: Shipment state transition or Shipment data update or both. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentStatus/).
589
785
  */
590
786
  updateShipmentStatus({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentStatusResponseBody>;
591
787
  /**
@@ -595,30 +791,43 @@ declare class Order {
595
791
  * @returns {Promise<OrderPlatformModel.CourierPartnerTrackingDetails>} -
596
792
  * Success response
597
793
  * @name updateShipmentTracking
598
- * @summary: Update shipment tracking
599
- * @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/).
794
+ * @summary: Update shipment tracking.
795
+ * @description: Modify courier partner tracking details for a given shipment id or awb no. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentTracking/).
600
796
  */
601
797
  updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
602
798
  /**
603
- * @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
799
+ * @param {OrderPlatformValidator.UpdateUserViewPositionParam} arg - Arg object
604
800
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
605
801
  * @param {import("../PlatformAPIClient").Options} - Options
606
- * @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
607
- * @name uploadConsents
608
- * @summary: Upload consent
609
- * @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/).
802
+ * @returns {Promise<OrderPlatformModel.CreateUpdateDeleteResponse>} -
803
+ * Success response
804
+ * @name updateUserViewPosition
805
+ * @summary: Update User view(Parent view and child view) position
806
+ * @description: Update User view(Parent view and child view) position - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateUserViewPosition/).
807
+ */
808
+ updateUserViewPosition({ body, requestHeaders }?: OrderPlatformValidator.UpdateUserViewPositionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateUpdateDeleteResponse>;
809
+ /**
810
+ * @param {OrderPlatformValidator.UpdateUserViewsParam} arg - Arg object
811
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
812
+ * @param {import("../PlatformAPIClient").Options} - Options
813
+ * @returns {Promise<OrderPlatformModel.CreateUpdateDeleteResponse>} -
814
+ * Success response
815
+ * @name updateUserViews
816
+ * @summary: Update custom view for every unique user cross company pair.
817
+ * @description: Update custom view for every unique user cross company pair. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateUserViews/).
610
818
  */
611
- uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
819
+ updateUserViews({ body, requestHeaders }?: OrderPlatformValidator.UpdateUserViewsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateUpdateDeleteResponse>;
612
820
  /**
613
821
  * @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
614
822
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
615
823
  * @param {import("../PlatformAPIClient").Options} - Options
616
- * @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
824
+ * @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
617
825
  * @name verifyMobileOTP
618
- * @summary: Verify mobile OTP
619
- * @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/).
826
+ * @summary: Verify Mobile OTP
827
+ * @description: Verify Mobile OTP - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
620
828
  */
621
- verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponseSchema>;
829
+ verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponse>;
622
830
  }
623
831
  import OrderPlatformValidator = require("./OrderPlatformValidator");
624
832
  import OrderPlatformModel = require("./OrderPlatformModel");
833
+ import Paginator = require("../../common/Paginator");