@gofynd/fdk-client-javascript 1.6.3 → 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 -612
  83. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -234
  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 +4111 -9093
  198. package/sdk/platform/Order/OrderPlatformModel.js +3202 -4230
  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 +22 -12
  250. package/sdk/platform/User/UserPlatformApplicationClient.js +91 -12
  251. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +15 -3
  252. package/sdk/platform/User/UserPlatformApplicationValidator.js +14 -2
  253. package/sdk/platform/User/UserPlatformModel.d.ts +223 -59
  254. package/sdk/platform/User/UserPlatformModel.js +204 -65
  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 +434 -758
  258. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -410
  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
@@ -1,7 +1,7 @@
1
1
  export = OrderPlatformValidator;
2
2
  /**
3
- * @typedef AddStateManagerConfigParam
4
- * @property {OrderPlatformModel.TransitionConfigPayload} body
3
+ * @typedef AddUserViewsParam
4
+ * @property {OrderPlatformModel.UserViewsResponse} body
5
5
  */
6
6
  /**
7
7
  * @typedef AttachOrderUserParam
@@ -9,35 +9,37 @@ export = OrderPlatformValidator;
9
9
  */
10
10
  /**
11
11
  * @typedef BulkListingParam
12
- * @property {number} pageSize - The number of records to return per page in the response.
13
- * @property {number} pageNo - The page number to fetch from the paginated results.
14
- * @property {string} startDate - The start date for filtering the jobs,
15
- * expressed in UTC format
16
- * @property {string} endDate - The end date for filtering the jobs, expressed
17
- * in UTC format
18
- * @property {string} [status] - The status of the jobs to filter the results.
19
- * @property {string} [bulkActionType] - Pecifies the type of job action being requested.
20
- * @property {string} [searchKey] - A key or keyword used to search for specific jobs.
12
+ * @property {number} pageSize - Page size
13
+ * @property {number} pageNo - Page number
14
+ * @property {string} [startDate] - UTC start date in ISO format
15
+ * @property {string} [endDate] - UTC end date in ISO format
16
+ * @property {string} [status] - Status for which to fetch the jobs.
17
+ * @property {string} [bulkActionType] - Job type.
18
+ * @property {string} [searchKey] - Search_key.
21
19
  */
22
20
  /**
23
21
  * @typedef BulkStateTransistionParam
24
- * @property {OrderPlatformModel.BulkStateTransistionRequestSchema} body
22
+ * @property {OrderPlatformModel.BulkStateTransistionRequest} body
25
23
  */
26
24
  /**
27
25
  * @typedef CheckOrderStatusParam
28
26
  * @property {OrderPlatformModel.OrderStatus} body
29
27
  */
30
28
  /**
31
- * @typedef CreateChannelConfigParam
32
- * @property {OrderPlatformModel.CreateChannelConfigData} body
29
+ * @typedef Click2CallParam
30
+ * @property {string} caller - Call Number
31
+ * @property {string} receiver - Receiver Number
32
+ * @property {string} bagId - Bag Id for the query
33
+ * @property {string} [callerId] - Caller Id
34
+ * @property {string} [method] - Provider Method to Call
33
35
  */
34
36
  /**
35
37
  * @typedef CreateOrderParam
36
38
  * @property {OrderPlatformModel.CreateOrderAPI} body
37
39
  */
38
40
  /**
39
- * @typedef DispatchManifestsParam
40
- * @property {OrderPlatformModel.DispatchManifest} body
41
+ * @typedef DeleteUserViewsParam
42
+ * @property {string} viewId - Comma separated values of view ids
41
43
  */
42
44
  /**
43
45
  * @typedef DownloadBulkActionTemplateParam
@@ -45,7 +47,7 @@ export = OrderPlatformValidator;
45
47
  */
46
48
  /**
47
49
  * @typedef DownloadLanesReportParam
48
- * @property {OrderPlatformModel.BulkReportsDownloadRequestSchema} body
50
+ * @property {OrderPlatformModel.BulkReportsDownloadRequest} body
49
51
  */
50
52
  /**
51
53
  * @typedef EInvoiceRetryParam
@@ -56,13 +58,12 @@ export = OrderPlatformValidator;
56
58
  * @property {string} logId - Log Error ID
57
59
  */
58
60
  /**
59
- * @typedef FetchRefundModeConfigParam
60
- * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
61
+ * @typedef FetchCreditBalanceDetailParam
62
+ * @property {OrderPlatformModel.FetchCreditBalanceRequestPayload} body
61
63
  */
62
64
  /**
63
- * @typedef GenerateInvoiceIDParam
64
- * @property {string} invoiceType - Mention the type of invoice id to generate
65
- * @property {OrderPlatformModel.GenerateInvoiceIDRequestSchema} body
65
+ * @typedef FetchRefundModeConfigParam
66
+ * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
66
67
  */
67
68
  /**
68
69
  * @typedef GeneratePOSReceiptByOrderIdParam
@@ -70,24 +71,20 @@ export = OrderPlatformValidator;
70
71
  * @property {string} [shipmentId]
71
72
  * @property {string} [documentType]
72
73
  */
73
- /**
74
- * @typedef GenerateProcessManifestParam
75
- * @property {OrderPlatformModel.ProcessManifestRequestSchema} body
76
- */
77
74
  /**
78
75
  * @typedef GetAllowedStateTransitionParam
79
- * @property {string} orderingChannel - The channel through which orders are placed.
80
- * @property {string} status - The status key indicates the current status for
81
- * which the API will provide a list of possible next state transitions.
76
+ * @property {string} orderingChannel - Ordering channel
77
+ * @property {string} status - Current status of a shipment
82
78
  */
83
79
  /** @typedef GetAllowedTemplatesForBulkParam */
84
80
  /**
85
81
  * @typedef GetAnnouncementsParam
86
- * @property {string} [date] - Date On which the announcement is Active.
82
+ * @property {string} [date] - Date On which the announcement is Active (Date
83
+ * should in ISO Datetime format IST Time)
87
84
  */
88
85
  /**
89
86
  * @typedef GetBagByIdParam
90
- * @property {string} [bagId] - Unique identifier of a bag
87
+ * @property {string} [bagId] - Id of bag
91
88
  * @property {string} [channelBagId] - Id of application bag
92
89
  * @property {string} [channelId] - Id of application
93
90
  */
@@ -108,8 +105,8 @@ export = OrderPlatformValidator;
108
105
  * @typedef GetBulkShipmentExcelFileParam
109
106
  * @property {string} [salesChannels] - Comma separated values of sales channel ids
110
107
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
111
- * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
112
- * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
108
+ * @property {string} [startDate] - UTC start date in ISO format
109
+ * @property {string} [endDate] - UTC end date in ISO format
113
110
  * @property {string} [stores] - Comma separated values of store ids
114
111
  * @property {string} [tags] - Comma separated values of tags
115
112
  * @property {string} [bagStatus] - Comma separated values of bag statuses
@@ -119,20 +116,30 @@ export = OrderPlatformValidator;
119
116
  * @property {number} [pageNo]
120
117
  * @property {number} [pageSize]
121
118
  */
122
- /** @typedef GetChannelConfigParam */
119
+ /**
120
+ * @typedef GetFailedOrderLogsParam
121
+ * @property {number} [pageNo] - Page Number
122
+ * @property {number} [pageSize] - Page Size
123
+ * @property {string} [searchType] - Search type for filter
124
+ * @property {string} [searchValue] - Search value for filter
125
+ */
123
126
  /**
124
127
  * @typedef GetFileByStatusParam
125
- * @property {string} batchId - Batch Id to identify the bulk operation request.
126
- * @property {string} status - The status of the jobs to filter the results.
128
+ * @property {string} batchId
129
+ * @property {string} status
127
130
  * @property {string} fileType
128
- * @property {string} [reportType] - The type of report to be downloaded.
131
+ * @property {string} [reportType]
132
+ */
133
+ /**
134
+ * @typedef GetGlobalFiltersParam
135
+ * @property {string} showIn - Name of view to get filters for
129
136
  */
130
137
  /**
131
138
  * @typedef GetLaneConfigParam
132
139
  * @property {string} [superLane] - Name of lane for which data is to be fetched
133
140
  * @property {string} [groupEntity] - Name of group entity
134
141
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
135
- * @property {string} [toDate] - End Date in DD-MM-YYYY format
142
+ * @property {string} [toDate]
136
143
  * @property {string} [startDate] - UTC Start Date in ISO format
137
144
  * @property {string} [endDate] - UTC End Date in ISO format
138
145
  * @property {string} [dpIds] - Comma separated values of delivery partner ids
@@ -140,144 +147,115 @@ export = OrderPlatformValidator;
140
147
  * @property {string} [salesChannels]
141
148
  * @property {string} [paymentMode] - Comma separated values of payment modes
142
149
  * @property {string} [bagStatus] - Comma separated values of bag statuses
143
- * @property {string} [searchType] - Search_type refers to the field that will
144
- * be used as the target for the search operation
150
+ * @property {string} [searchType]
145
151
  * @property {string} [searchValue]
146
152
  * @property {string} [tags]
147
- * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
153
+ * @property {number} [timeToDispatch]
148
154
  * @property {string} [paymentMethods]
149
155
  * @property {boolean} [myOrders]
150
156
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
151
157
  * company order
152
- * @property {string} [orderType] - Defines the specific journey a shipment will
153
- * follow based on the application's operational needs and customer
154
- * preferences. This field categorizes orders into distinct types, each
155
- * associated with a unique processing flow. For example:
156
- *
157
- * - "HomeDelivery": The order goes through all the steps needed for delivery,
158
- * from being packed to arriving at the customer’s address.
159
- * - "PickAtStore": The order is prepared for pickup at the store, skipping
160
- * shipping steps to make it ready faster for the customer to collect in person.
161
- * - "Digital": This order type likely refers to orders that involve digital goods
162
- * or services, such as software, digital subscriptions, e-books, online
163
- * courses, or any other item that can be delivered electronically.
164
- */
165
- /**
166
- * @typedef GetManifestDetailsParam
167
- * @property {string} manifestId - The unique identifier assigned to the manifest.
168
- * @property {string} [dpIds] - Filter shipments with the specific Courier
169
- * partner Ids which is a combination of courier partner extension and scheme Ids.
170
- * @property {string} [endDate] - End date for the shipment search range in manifest.
171
- * @property {string} [startDate] - Start date for the shipment search range in manifest.
172
- * @property {number} [pageNo] - Page number for pagination.
173
- * @property {number} [pageSize] - Number of records per page for pagination.
174
- */
175
- /**
176
- * @typedef GetManifestShipmentsParam
177
- * @property {string} dpIds - Filter shipments with the specific Courier partner
178
- * Ids which is a combination of courier partner extension and scheme Ids.
179
- * @property {number} stores - Filter results based on specific store IDs.
180
- * @property {string} toDate - End date for the shipment search range.
181
- * @property {string} fromDate - Start date for the shipment search range.
182
- * @property {string} [dpName] - Filter results based on specific courier partner name.
183
- * @property {string} [salesChannels] - Filter results based on comma-separated
184
- * list of sales channels.
185
- * @property {string} [searchType] - Filter results based on search type.
186
- * @property {string} [searchValue] - Filter results based on the search value.
187
- * @property {number} [pageNo] - Page number for pagination.
188
- * @property {number} [pageSize] - Number of records per page for pagination.
158
+ * @property {string} [orderType]
189
159
  */
190
160
  /**
191
161
  * @typedef GetManifestfiltersParam
192
162
  * @property {string} view - Name of View
193
163
  */
194
- /**
195
- * @typedef GetManifestsParam
196
- * @property {string} [status] - Filter for the status of manifests.
197
- * @property {string} [startDate] - The starting date for filtering manifests in
198
- * ISO format
199
- * @property {string} [endDate] - The end date for filtering manifests in ISO format
200
- * @property {string} [searchType] - Specifies the type of search to perform.
201
- * @property {number} [storeId] - Filter to fetch manifests for a specific store
202
- * by its ID.
203
- * @property {string} [searchValue] - The value to search for based on the
204
- * selected search type.
205
- * @property {string} [dpIds] - A comma-separated list of courier partner IDs
206
- * (DP IDs) to filter the manifests.
207
- * @property {number} [pageNo] - The number of the page to fetch data.
208
- * @property {number} [pageSize] - The number of records to return per page for
209
- * pagination.
210
- */
211
164
  /**
212
165
  * @typedef GetOrderByIdParam
213
- * @property {string} orderId
166
+ * @property {string} orderId - Flag for order id
214
167
  * @property {boolean} [myOrders]
215
168
  * @property {boolean} [allowInactive] - Flag to allow inactive shipments
216
169
  */
217
170
  /**
218
171
  * @typedef GetOrdersParam
219
172
  * @property {string} [lane] - Lane refers to a section where orders are
220
- * assigned, indicating its grouping.
173
+ * assigned, indicating its grouping
221
174
  * @property {string} [searchType] - Search_type refers to the field that will
222
- * be used as the target for the search operation.
223
- * @property {string} [bagStatus] - Bag_status refers to status of the entity.
224
- * Filters orders based on the status.
225
- * @property {number} [timeToDispatch] - Time_to_dispatch refers to estimated SLA time.
226
- * @property {string} [paymentMethods] - Comma separated values of payment
227
- * methods that were used to place order.
228
- * @property {string} [tags] - Tags refers to additional descriptive labels
175
+ * be used as the target for the search operation
176
+ * @property {string} [bagStatus] - Bag_status refers to the status of the
177
+ * entity. Filters orders based on the status.
178
+ * @property {number} [timeToDispatch] - Time_to_dispatch refers to the
179
+ * estimated SLA time.
180
+ * @property {string} [paymentMethods]
181
+ * @property {string} [tags] - Tags refer to additional descriptive labels
229
182
  * associated with the order
230
183
  * @property {string} [searchValue] - Search_value is matched against the field
231
184
  * specified by the search_type
232
- * @property {string} [fromDate] - Date time in UTC timezone as per ISO format.
233
- * @property {string} [toDate] - Date time in UTC timezone as per ISO format.
234
- * @property {string} [startDate] - Date time in UTC timezone as per ISO format.
235
- * @property {string} [endDate] - Date time in UTC timezone as per ISO format.
185
+ * @property {string} [fromDate]
186
+ * @property {string} [toDate]
187
+ * @property {string} [startDate]
188
+ * @property {string} [endDate]
236
189
  * @property {string} [dpIds] - Delivery Partner IDs to which shipments are assigned.
237
- * @property {string} [stores] - A comma-separated list of store IDs used to
238
- * filter results to only those related to specific stores.
239
- * @property {string} [salesChannels] - A comma-separated list of sales channel
240
- * IDs to filter results based on the sales channels involved.
241
- * @property {number} [pageNo] - Specifies the page number for paginated results.
242
- * @property {number} [pageSize] - Determines the number of results returned per page.
190
+ * @property {string} [stores]
191
+ * @property {string} [salesChannels]
192
+ * @property {number} [pageNo]
193
+ * @property {number} [pageSize]
243
194
  * @property {boolean} [isPrioritySort]
244
- * @property {string} [customMeta]
195
+ * @property {Object[]} [customMeta]
245
196
  * @property {boolean} [myOrders]
246
197
  * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
247
198
  * company order
248
- * @property {string} [customerId] - The unique identifier for the customer
249
- * associated with the query, useful for filtering results to a specific customer.
199
+ * @property {string} [customerId]
250
200
  * @property {string} [orderType]
251
- * @property {boolean} [allowInactive] - Flag indicating whether inactive
252
- * shipments are allowed
201
+ * @property {string} [operationalStatus] - Statuses relating to shipment
202
+ * transition in order processing journey. Comma separated values of
203
+ * operational statuses.
204
+ * @property {string} [financialStatus] - Statuses relating to finance related
205
+ * operations in the order processing journey. Comma separated values of
206
+ * financial statuses.
207
+ * @property {string} [logisticsStatus] - Statuses relating to delivery and
208
+ * pickup related operations in the order processing journey. Comma separated
209
+ * values of logistics statuses.
210
+ * @property {string} [parentViewSlug] - Parent view is used for grouping of
211
+ * child views. Slug of parent view.
212
+ * @property {string} [childViewSlug] - Child view is user configured view,
213
+ * which has filters added by the user on which shipments/orders are fetched.
214
+ * Slug of child view.
253
215
  * @property {string} [groupEntity] - Defines the grouping criterion for
254
216
  * retrieving shipments or orders. It specifies whether the results should be
255
217
  * organized based on shipment groups or order groups. For example, using
256
218
  * 'shipments' groups results by shipment, while an invalid value like 'abcd'
257
219
  * may not be recognized, leading to errors or default behavior.
258
- * @property {boolean} [enforceDateFilter] - Applies a date filter for listing
259
- * orders. This is useful when fetching data for a specific date range while
260
- * performing searches.
261
- * @property {string} [fulfillmentType] - Define the Fulfillment Type for
262
- * Listing Orders, This is use when we want to get list of shipments or orders
263
- * by cross store or cross company or fulfilling Store (by default), this is
264
- * also depends on the login user accessType and store access
220
+ */
221
+ /**
222
+ * @typedef GetRefundConfigurationParam
223
+ * @property {string} appId
224
+ */
225
+ /** @typedef GetRefundEnableStateListParam */
226
+ /**
227
+ * @typedef GetRefundOptionsParam
228
+ * @property {string} shipmentId - ID of the shipment. An order may contain
229
+ * multiple items and may get divided into one or more shipment, each having
230
+ * its own ID.
231
+ * @property {string} [bagIds] - It is the bag_id of the bags with comma separated.
232
+ * @property {string} [state] - It is the desired state at which refund amount
233
+ * needs to be calculated.
234
+ * @property {string} [optinAppId] - It is affiliate id of the order in case of
235
+ * cross selling.
236
+ * @property {number} [optinCompanyId] - It is company id of the order in case
237
+ * of cross selling.
238
+ * @property {string} [status] - It specifies the desired status to which the
239
+ * shipment should be updated. It represents the next step in the shipment's
240
+ * lifecycle, such as being cancelled by the customer or moved to another
241
+ * status in the shipping process.
242
+ */
243
+ /**
244
+ * @typedef GetRefundStateConfigurationParam
245
+ * @property {string} appId
265
246
  */
266
247
  /** @typedef GetRoleBasedActionsParam */
267
248
  /**
268
249
  * @typedef GetShipmentByIdParam
269
- * @property {string} [channelShipmentId] - The shipment ID used in the
270
- * application, which can be used to reference specific shipments.
271
- * @property {string} [shipmentId] - The unique identifier for a shipment.
250
+ * @property {string} [channelShipmentId] - App Shipment Id
251
+ * @property {string} [shipmentId] - Shipment Id
272
252
  * @property {boolean} [fetchActiveShipment] - Flag to fetch active or
273
253
  * deactivated shipments
274
- * @property {boolean} [allowInactive] - Flag indicating whether inactive
275
- * shipments are allowed
276
254
  */
277
255
  /**
278
256
  * @typedef GetShipmentHistoryParam
279
- * @property {string} [shipmentId] - Identifier for the shipment
280
- * @property {number} [bagId] - Identifier for a bag or product.
257
+ * @property {string} [shipmentId] - Shipment Id
258
+ * @property {number} [bagId] - Bag/Product Id
281
259
  */
282
260
  /**
283
261
  * @typedef GetShipmentReasonsParam
@@ -291,92 +269,68 @@ export = OrderPlatformValidator;
291
269
  /**
292
270
  * @typedef GetShipmentsParam
293
271
  * @property {string} [lane] - Name of lane for which data is to be fetched
294
- * @property {string} [bagStatus] - Comma separated values of bag statuses.
295
- * @property {string} [statusAssigned] - Used to filter shipments based on
296
- * status present in shipment_status_history. For more information on these
297
- * statuses, refer to the Fynd Partners documentation.
272
+ * @property {string} [bagStatus] - Comma separated values of bag statuses
298
273
  * @property {boolean} [statusOverrideLane] - Use this flag to fetch by
299
- * bag_status and override lane.
300
- * @property {number} [timeToDispatch] - Indicates the time to dispatch.
301
- * @property {string} [searchType] - Specifies the key used to determine the
302
- * type of search being performed.
303
- * @property {string} [searchValue] - The value corresponding to the search
304
- * type, such as a specific shipment ID or order ID.
274
+ * bag_status and override lane
275
+ * @property {number} [timeToDispatch]
276
+ * @property {string} [searchType] - Search type key
277
+ * @property {string} [searchValue] - Search type value
305
278
  * @property {string} [fromDate] - Start Date in DD-MM-YYYY format
306
279
  * @property {string} [toDate] - End Date in DD-MM-YYYY format
307
- * @property {string} [startDate] - The UTC start date in ISO format
308
- * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
309
- * @property {string} [endDate] - The UTC end date in ISO format
310
- * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
311
- * @property {string} [statusAssignedStartDate] - Specifies the starting UTC
312
- * date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
313
- * boundary for filtering shipments based on the `created_at` timestamp of
314
- * statuses in the shipment's status history. It allows filtering statuses
315
- * that were created within a specific time range.
316
- * @property {string} [statusAssignedEndDate] - Specifies the ending UTC date
317
- * and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
318
- * for filtering shipments based on the `created_at` timestamp of statuses in
319
- * the shipment's status history.
320
- * @property {string} [dpIds] - A comma-separated list of delivery partner IDs
321
- * to filter results by specific delivery partners.
322
- * @property {string} [stores] - A comma-separated list of store IDs used to
323
- * filter results to only those related to specific stores.
324
- * @property {string} [salesChannels] - A comma-separated list of sales channel
325
- * IDs to filter results based on the sales channels involved.
326
- * @property {number} [pageNo] - Specifies the page number for paginated results.
327
- * @property {number} [pageSize] - Determines the number of results returned per page.
328
- * @property {boolean} [fetchActiveShipment] - A boolean flag that indicates
329
- * whether to include only active shipments in the results.
330
- * @property {boolean} [allowInactive] - A flag indicating whether to allow the
331
- * inclusion of inactive shipments in the results.
332
- * @property {boolean} [excludeLockedShipments] - A flag to specify whether to
333
- * exclude shipments that are locked from the results.
334
- * @property {string} [paymentMethods] - A comma-separated list of payment methods.
335
- * @property {string} [channelShipmentId] - The shipment ID used in the
336
- * application, which can be used to reference specific shipments.
337
- * @property {string} [channelOrderId] - The order ID used in the application.
338
- * @property {string} [customMeta] - Custom metadata associated with the query,
339
- * allowing for additional filtering or information to be passed.
340
- * @property {string} [orderingChannel] - The channel through which the order was placed.
341
- * @property {string} [companyAffiliateTag] - A tag used to identify the
342
- * company's affiliation for filtering or reporting purposes.
343
- * @property {boolean} [myOrders] - A boolean flag indicating whether the query
344
- * should return only the user's orders.
345
- * @property {string} [platformUserId] - The unique identifier of the user on
346
- * the platform, useful for filtering orders related to a specific user.
347
- * @property {string} [sortType] - Determines the sorting order of the results
348
- * based on specific criteria.
349
- * @property {boolean} [showCrossCompanyData] - A flag indicating whether to
350
- * include data from both cross-company and non-cross-company orders in the results.
351
- * @property {string} [tags] - A comma-separated list of tags associated with
352
- * the orders to filter results based on specific characteristics.
353
- * @property {string} [customerId] - The unique identifier for the customer
354
- * associated with the query, useful for filtering results to a specific customer.
355
- * @property {string} [orderType] - The type of order being queried.
280
+ * @property {string} [startDate] - UTC Start Date in ISO format
281
+ * @property {string} [endDate] - UTC End Date in ISO format
282
+ * @property {string} [dpIds] - Comma separated values of delivery partner ids
283
+ * @property {string} [stores] - Comma separated values of store ids
284
+ * @property {string} [salesChannels] - Comma separated values of sales channel ids
285
+ * @property {number} [pageNo] - Page number for paginated data
286
+ * @property {number} [pageSize] - Page size of data received per page
287
+ * @property {boolean} [fetchActiveShipment] - Flag to fetch active shipments
288
+ * @property {boolean} [allowInactive] - Flag to allow inactive shipments
289
+ * @property {boolean} [excludeLockedShipments] - Flag to fetch locked shipments
290
+ * @property {string} [paymentMethods] - Comma separated values of payment methods
291
+ * @property {string} [channelShipmentId] - App Shipment Id
292
+ * @property {string} [channelOrderId] - App Order Id
293
+ * @property {string} [customMeta]
294
+ * @property {string} [orderingChannel]
295
+ * @property {string} [companyAffiliateTag]
296
+ * @property {boolean} [myOrders]
297
+ * @property {string} [platformUserId]
298
+ * @property {string} [sortType] - Sort the result data on basis of input
299
+ * @property {boolean} [showCrossCompanyData] - Flag to view cross & non-cross
300
+ * company order
301
+ * @property {string} [tags] - Comma separated values of tags
302
+ * @property {string} [customerId]
303
+ * @property {string} [orderType]
304
+ * @property {string} [operationalStatus] - Statuses relating to shipment
305
+ * transition in order processing journey. Comma separated values of
306
+ * operational statuses.
307
+ * @property {string} [financialStatus] - Statuses relating to finance related
308
+ * operations in the order processing journey. Comma separated values of
309
+ * financial statuses.
310
+ * @property {string} [logisticsStatus] - Statuses relating to delivery and
311
+ * pickup related operations in the order processing journey. Comma separated
312
+ * values of logistics statuses.
313
+ * @property {string} [parentViewSlug] - Parent view is used for grouping of
314
+ * child views. Slug of parent view.
315
+ * @property {string} [childViewSlug] - Child view is user configured view which
316
+ * has filters added by the user on which shipments/orders are fetched. Slug
317
+ * of child view.
318
+ * @property {string} [lockStatus] - Flag to identify if a shipment is locked or not.
356
319
  * @property {string} [groupEntity] - Defines the grouping criterion for
357
320
  * retrieving shipments or orders. It specifies whether the results should be
358
321
  * organized based on shipment groups or order groups. For example, using
359
322
  * 'shipments' groups results by shipment, while an invalid value like 'abcd'
360
323
  * may not be recognized, leading to errors or default behavior.
361
- * @property {boolean} [enforceDateFilter] - Applies a date filter for listing
362
- * shipments. This is useful when fetching data for a specific date range
363
- * while performing searches.
364
- * @property {string} [fulfillmentType] - Define the Fulfillment Type for
365
- * Listing Orders, This is use when we want to get list of shipments or orders
366
- * by cross store or cross company or fulfilling Store (by default), this is
367
- * also depends on the login user accessType and store access
368
- */
369
- /**
370
- * @typedef GetStateManagerConfigParam
371
- * @property {string} [appId] - The unique identifier of the application.
372
- * @property {string} [orderingChannel] - The channel through which orders are placed.
373
- * @property {string} [entity] - The entity for which the configuration is applied.
374
324
  */
375
325
  /** @typedef GetStateTransitionMapParam */
376
326
  /**
377
327
  * @typedef GetTemplateParam
378
328
  * @property {string} templateName
379
329
  */
330
+ /**
331
+ * @typedef GetUserViewsParam
332
+ * @property {string} showIn - Name of view to get filters for.
333
+ */
380
334
  /**
381
335
  * @typedef GetfiltersParam
382
336
  * @property {string} view - Name of view
@@ -388,13 +342,22 @@ export = OrderPlatformValidator;
388
342
  */
389
343
  /**
390
344
  * @typedef JobDetailsParam
391
- * @property {string} batchId - A unique identifier for the batch associated
392
- * with this bulk action.
345
+ * @property {string} batchId
393
346
  */
394
347
  /**
395
348
  * @typedef OrderUpdateParam
396
349
  * @property {OrderPlatformModel.PlatformOrderUpdate} body
397
350
  */
351
+ /**
352
+ * @typedef PostRefundConfigurationParam
353
+ * @property {string} appId
354
+ * @property {OrderPlatformModel.RefundStateConfigurationManualSchema} body
355
+ */
356
+ /**
357
+ * @typedef PostRefundStateConfigurationParam
358
+ * @property {string} appId
359
+ * @property {OrderPlatformModel.PostRefundStateConfiguration} body
360
+ */
398
361
  /**
399
362
  * @typedef PostShipmentHistoryParam
400
363
  * @property {OrderPlatformModel.PostShipmentHistory} body
@@ -413,23 +376,23 @@ export = OrderPlatformValidator;
413
376
  */
414
377
  /**
415
378
  * @typedef TrackShipmentParam
416
- * @property {string} [shipmentId] - Unique identifier of a shipment on the platform.
379
+ * @property {string} [shipmentId] - Shipment ID
417
380
  * @property {string} [awb] - AWB number
418
- * @property {number} [pageNo] - Page number for pagination.
419
- * @property {number} [pageSize] - Number of records per page for pagination.
381
+ * @property {number} [pageNo] - Page number
382
+ * @property {number} [pageSize] - Page size
420
383
  */
421
384
  /**
422
- * @typedef UpdateAddressParam
423
- * @property {string} shipmentId - Unique shipment no. that is auto-generated
424
- * @property {OrderPlatformModel.UpdateAddressRequestBody} body
385
+ * @typedef UpdateOrderParam
386
+ * @property {string} orderId
387
+ * @property {OrderPlatformModel.OrderUpdatePayload} body
425
388
  */
426
389
  /**
427
390
  * @typedef UpdatePackagingDimensionsParam
428
391
  * @property {OrderPlatformModel.UpdatePackagingDimensionsPayload} body
429
392
  */
430
393
  /**
431
- * @typedef UpdatePaymentInfoParam
432
- * @property {OrderPlatformModel.UpdateShipmentPaymentMode} body
394
+ * @typedef UpdateShipmentParam
395
+ * @property {OrderPlatformModel.UpdateShipmentActionRequest} body
433
396
  */
434
397
  /**
435
398
  * @typedef UpdateShipmentLockParam
@@ -437,23 +400,27 @@ export = OrderPlatformValidator;
437
400
  */
438
401
  /**
439
402
  * @typedef UpdateShipmentStatusParam
440
- * @property {OrderPlatformModel.UpdateShipmentStatusRequestSchema} body
403
+ * @property {OrderPlatformModel.UpdateShipmentStatusRequest} body
441
404
  */
442
405
  /**
443
406
  * @typedef UpdateShipmentTrackingParam
444
407
  * @property {OrderPlatformModel.CourierPartnerTrackingDetails} body
445
408
  */
446
409
  /**
447
- * @typedef UploadConsentsParam
448
- * @property {OrderPlatformModel.UploadManifestConsent} body
410
+ * @typedef UpdateUserViewPositionParam
411
+ * @property {OrderPlatformModel.UserViewPosition} body
412
+ */
413
+ /**
414
+ * @typedef UpdateUserViewsParam
415
+ * @property {OrderPlatformModel.UserViewsResponse} body
449
416
  */
450
417
  /**
451
418
  * @typedef VerifyMobileOTPParam
452
419
  * @property {OrderPlatformModel.VerifyMobileOTP} body
453
420
  */
454
421
  declare class OrderPlatformValidator {
455
- /** @returns {AddStateManagerConfigParam} */
456
- static addStateManagerConfig(): AddStateManagerConfigParam;
422
+ /** @returns {AddUserViewsParam} */
423
+ static addUserViews(): AddUserViewsParam;
457
424
  /** @returns {AttachOrderUserParam} */
458
425
  static attachOrderUser(): AttachOrderUserParam;
459
426
  /** @returns {BulkListingParam} */
@@ -462,12 +429,12 @@ declare class OrderPlatformValidator {
462
429
  static bulkStateTransistion(): BulkStateTransistionParam;
463
430
  /** @returns {CheckOrderStatusParam} */
464
431
  static checkOrderStatus(): CheckOrderStatusParam;
465
- /** @returns {CreateChannelConfigParam} */
466
- static createChannelConfig(): CreateChannelConfigParam;
432
+ /** @returns {Click2CallParam} */
433
+ static click2Call(): Click2CallParam;
467
434
  /** @returns {CreateOrderParam} */
468
435
  static createOrder(): CreateOrderParam;
469
- /** @returns {DispatchManifestsParam} */
470
- static dispatchManifests(): DispatchManifestsParam;
436
+ /** @returns {DeleteUserViewsParam} */
437
+ static deleteUserViews(): DeleteUserViewsParam;
471
438
  /** @returns {DownloadBulkActionTemplateParam} */
472
439
  static downloadBulkActionTemplate(): DownloadBulkActionTemplateParam;
473
440
  /** @returns {DownloadLanesReportParam} */
@@ -476,14 +443,12 @@ declare class OrderPlatformValidator {
476
443
  static eInvoiceRetry(): EInvoiceRetryParam;
477
444
  /** @returns {FailedOrderLogDetailsParam} */
478
445
  static failedOrderLogDetails(): FailedOrderLogDetailsParam;
446
+ /** @returns {FetchCreditBalanceDetailParam} */
447
+ static fetchCreditBalanceDetail(): FetchCreditBalanceDetailParam;
479
448
  /** @returns {FetchRefundModeConfigParam} */
480
449
  static fetchRefundModeConfig(): FetchRefundModeConfigParam;
481
- /** @returns {GenerateInvoiceIDParam} */
482
- static generateInvoiceID(): GenerateInvoiceIDParam;
483
450
  /** @returns {GeneratePOSReceiptByOrderIdParam} */
484
451
  static generatePOSReceiptByOrderId(): GeneratePOSReceiptByOrderIdParam;
485
- /** @returns {GenerateProcessManifestParam} */
486
- static generateProcessManifest(): GenerateProcessManifestParam;
487
452
  /** @returns {GetAllowedStateTransitionParam} */
488
453
  static getAllowedStateTransition(): GetAllowedStateTransitionParam;
489
454
  /** @returns {GetAllowedTemplatesForBulkParam} */
@@ -498,24 +463,28 @@ declare class OrderPlatformValidator {
498
463
  static getBulkActionTemplate(): any;
499
464
  /** @returns {GetBulkShipmentExcelFileParam} */
500
465
  static getBulkShipmentExcelFile(): GetBulkShipmentExcelFileParam;
501
- /** @returns {GetChannelConfigParam} */
502
- static getChannelConfig(): any;
466
+ /** @returns {GetFailedOrderLogsParam} */
467
+ static getFailedOrderLogs(): GetFailedOrderLogsParam;
503
468
  /** @returns {GetFileByStatusParam} */
504
469
  static getFileByStatus(): GetFileByStatusParam;
470
+ /** @returns {GetGlobalFiltersParam} */
471
+ static getGlobalFilters(): GetGlobalFiltersParam;
505
472
  /** @returns {GetLaneConfigParam} */
506
473
  static getLaneConfig(): GetLaneConfigParam;
507
- /** @returns {GetManifestDetailsParam} */
508
- static getManifestDetails(): GetManifestDetailsParam;
509
- /** @returns {GetManifestShipmentsParam} */
510
- static getManifestShipments(): GetManifestShipmentsParam;
511
474
  /** @returns {GetManifestfiltersParam} */
512
475
  static getManifestfilters(): GetManifestfiltersParam;
513
- /** @returns {GetManifestsParam} */
514
- static getManifests(): GetManifestsParam;
515
476
  /** @returns {GetOrderByIdParam} */
516
477
  static getOrderById(): GetOrderByIdParam;
517
478
  /** @returns {GetOrdersParam} */
518
479
  static getOrders(): GetOrdersParam;
480
+ /** @returns {GetRefundConfigurationParam} */
481
+ static getRefundConfiguration(): GetRefundConfigurationParam;
482
+ /** @returns {GetRefundEnableStateListParam} */
483
+ static getRefundEnableStateList(): any;
484
+ /** @returns {GetRefundOptionsParam} */
485
+ static getRefundOptions(): GetRefundOptionsParam;
486
+ /** @returns {GetRefundStateConfigurationParam} */
487
+ static getRefundStateConfiguration(): GetRefundStateConfigurationParam;
519
488
  /** @returns {GetRoleBasedActionsParam} */
520
489
  static getRoleBasedActions(): any;
521
490
  /** @returns {GetShipmentByIdParam} */
@@ -526,12 +495,12 @@ declare class OrderPlatformValidator {
526
495
  static getShipmentReasons(): GetShipmentReasonsParam;
527
496
  /** @returns {GetShipmentsParam} */
528
497
  static getShipments(): GetShipmentsParam;
529
- /** @returns {GetStateManagerConfigParam} */
530
- static getStateManagerConfig(): GetStateManagerConfigParam;
531
498
  /** @returns {GetStateTransitionMapParam} */
532
499
  static getStateTransitionMap(): any;
533
500
  /** @returns {GetTemplateParam} */
534
501
  static getTemplate(): GetTemplateParam;
502
+ /** @returns {GetUserViewsParam} */
503
+ static getUserViews(): GetUserViewsParam;
535
504
  /** @returns {GetfiltersParam} */
536
505
  static getfilters(): GetfiltersParam;
537
506
  /** @returns {InvalidateShipmentCacheParam} */
@@ -540,6 +509,10 @@ declare class OrderPlatformValidator {
540
509
  static jobDetails(): JobDetailsParam;
541
510
  /** @returns {OrderUpdateParam} */
542
511
  static orderUpdate(): OrderUpdateParam;
512
+ /** @returns {PostRefundConfigurationParam} */
513
+ static postRefundConfiguration(): PostRefundConfigurationParam;
514
+ /** @returns {PostRefundStateConfigurationParam} */
515
+ static postRefundStateConfiguration(): PostRefundStateConfigurationParam;
543
516
  /** @returns {PostShipmentHistoryParam} */
544
517
  static postShipmentHistory(): PostShipmentHistoryParam;
545
518
  /** @returns {ReassignLocationParam} */
@@ -550,78 +523,100 @@ declare class OrderPlatformValidator {
550
523
  static sendUserMobileOTP(): SendUserMobileOTPParam;
551
524
  /** @returns {TrackShipmentParam} */
552
525
  static trackShipment(): TrackShipmentParam;
553
- /** @returns {UpdateAddressParam} */
554
- static updateAddress(): UpdateAddressParam;
526
+ /** @returns {UpdateOrderParam} */
527
+ static updateOrder(): UpdateOrderParam;
555
528
  /** @returns {UpdatePackagingDimensionsParam} */
556
529
  static updatePackagingDimensions(): UpdatePackagingDimensionsParam;
557
- /** @returns {UpdatePaymentInfoParam} */
558
- static updatePaymentInfo(): UpdatePaymentInfoParam;
530
+ /** @returns {UpdateShipmentParam} */
531
+ static updateShipment(): UpdateShipmentParam;
559
532
  /** @returns {UpdateShipmentLockParam} */
560
533
  static updateShipmentLock(): UpdateShipmentLockParam;
561
534
  /** @returns {UpdateShipmentStatusParam} */
562
535
  static updateShipmentStatus(): UpdateShipmentStatusParam;
563
536
  /** @returns {UpdateShipmentTrackingParam} */
564
537
  static updateShipmentTracking(): UpdateShipmentTrackingParam;
565
- /** @returns {UploadConsentsParam} */
566
- static uploadConsents(): UploadConsentsParam;
538
+ /** @returns {UpdateUserViewPositionParam} */
539
+ static updateUserViewPosition(): UpdateUserViewPositionParam;
540
+ /** @returns {UpdateUserViewsParam} */
541
+ static updateUserViews(): UpdateUserViewsParam;
567
542
  /** @returns {VerifyMobileOTPParam} */
568
543
  static verifyMobileOTP(): VerifyMobileOTPParam;
569
544
  }
570
545
  declare namespace OrderPlatformValidator {
571
- export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
546
+ export { AddUserViewsParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, Click2CallParam, CreateOrderParam, DeleteUserViewsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetFailedOrderLogsParam, GetFileByStatusParam, GetGlobalFiltersParam, GetLaneConfigParam, GetManifestfiltersParam, GetOrderByIdParam, GetOrdersParam, GetRefundConfigurationParam, GetRefundEnableStateListParam, GetRefundOptionsParam, GetRefundStateConfigurationParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetUserViewsParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostRefundConfigurationParam, PostRefundStateConfigurationParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateOrderParam, UpdatePackagingDimensionsParam, UpdateShipmentParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UpdateUserViewPositionParam, UpdateUserViewsParam, VerifyMobileOTPParam };
572
547
  }
573
- type AddStateManagerConfigParam = {
574
- body: OrderPlatformModel.TransitionConfigPayload;
548
+ type AddUserViewsParam = {
549
+ body: OrderPlatformModel.UserViewsResponse;
575
550
  };
576
551
  type AttachOrderUserParam = {
577
552
  body: OrderPlatformModel.AttachOrderUser;
578
553
  };
579
554
  type BulkListingParam = {
580
555
  /**
581
- * - The number of records to return per page in the response.
556
+ * - Page size
582
557
  */
583
558
  pageSize: number;
584
559
  /**
585
- * - The page number to fetch from the paginated results.
560
+ * - Page number
586
561
  */
587
562
  pageNo: number;
588
563
  /**
589
- * - The start date for filtering the jobs,
590
- * expressed in UTC format
564
+ * - UTC start date in ISO format
591
565
  */
592
- startDate: string;
566
+ startDate?: string;
593
567
  /**
594
- * - The end date for filtering the jobs, expressed
595
- * in UTC format
568
+ * - UTC end date in ISO format
596
569
  */
597
- endDate: string;
570
+ endDate?: string;
598
571
  /**
599
- * - The status of the jobs to filter the results.
572
+ * - Status for which to fetch the jobs.
600
573
  */
601
574
  status?: string;
602
575
  /**
603
- * - Pecifies the type of job action being requested.
576
+ * - Job type.
604
577
  */
605
578
  bulkActionType?: string;
606
579
  /**
607
- * - A key or keyword used to search for specific jobs.
580
+ * - Search_key.
608
581
  */
609
582
  searchKey?: string;
610
583
  };
611
584
  type BulkStateTransistionParam = {
612
- body: OrderPlatformModel.BulkStateTransistionRequestSchema;
585
+ body: OrderPlatformModel.BulkStateTransistionRequest;
613
586
  };
614
587
  type CheckOrderStatusParam = {
615
588
  body: OrderPlatformModel.OrderStatus;
616
589
  };
617
- type CreateChannelConfigParam = {
618
- body: OrderPlatformModel.CreateChannelConfigData;
590
+ type Click2CallParam = {
591
+ /**
592
+ * - Call Number
593
+ */
594
+ caller: string;
595
+ /**
596
+ * - Receiver Number
597
+ */
598
+ receiver: string;
599
+ /**
600
+ * - Bag Id for the query
601
+ */
602
+ bagId: string;
603
+ /**
604
+ * - Caller Id
605
+ */
606
+ callerId?: string;
607
+ /**
608
+ * - Provider Method to Call
609
+ */
610
+ method?: string;
619
611
  };
620
612
  type CreateOrderParam = {
621
613
  body: OrderPlatformModel.CreateOrderAPI;
622
614
  };
623
- type DispatchManifestsParam = {
624
- body: OrderPlatformModel.DispatchManifest;
615
+ type DeleteUserViewsParam = {
616
+ /**
617
+ * - Comma separated values of view ids
618
+ */
619
+ viewId: string;
625
620
  };
626
621
  type DownloadBulkActionTemplateParam = {
627
622
  /**
@@ -630,7 +625,7 @@ type DownloadBulkActionTemplateParam = {
630
625
  templateSlug?: string;
631
626
  };
632
627
  type DownloadLanesReportParam = {
633
- body: OrderPlatformModel.BulkReportsDownloadRequestSchema;
628
+ body: OrderPlatformModel.BulkReportsDownloadRequest;
634
629
  };
635
630
  type EInvoiceRetryParam = {
636
631
  body: OrderPlatformModel.EInvoiceRetry;
@@ -641,44 +636,37 @@ type FailedOrderLogDetailsParam = {
641
636
  */
642
637
  logId: string;
643
638
  };
639
+ type FetchCreditBalanceDetailParam = {
640
+ body: OrderPlatformModel.FetchCreditBalanceRequestPayload;
641
+ };
644
642
  type FetchRefundModeConfigParam = {
645
643
  body: OrderPlatformModel.RefundModeConfigRequestPayload;
646
644
  };
647
- type GenerateInvoiceIDParam = {
648
- /**
649
- * - Mention the type of invoice id to generate
650
- */
651
- invoiceType: string;
652
- body: OrderPlatformModel.GenerateInvoiceIDRequestSchema;
653
- };
654
645
  type GeneratePOSReceiptByOrderIdParam = {
655
646
  orderId: string;
656
647
  shipmentId?: string;
657
648
  documentType?: string;
658
649
  };
659
- type GenerateProcessManifestParam = {
660
- body: OrderPlatformModel.ProcessManifestRequestSchema;
661
- };
662
650
  type GetAllowedStateTransitionParam = {
663
651
  /**
664
- * - The channel through which orders are placed.
652
+ * - Ordering channel
665
653
  */
666
654
  orderingChannel: string;
667
655
  /**
668
- * - The status key indicates the current status for
669
- * which the API will provide a list of possible next state transitions.
656
+ * - Current status of a shipment
670
657
  */
671
658
  status: string;
672
659
  };
673
660
  type GetAnnouncementsParam = {
674
661
  /**
675
- * - Date On which the announcement is Active.
662
+ * - Date On which the announcement is Active (Date
663
+ * should in ISO Datetime format IST Time)
676
664
  */
677
665
  date?: string;
678
666
  };
679
667
  type GetBagByIdParam = {
680
668
  /**
681
- * - Unique identifier of a bag
669
+ * - Id of bag
682
670
  */
683
671
  bagId?: string;
684
672
  /**
@@ -738,11 +726,11 @@ type GetBulkShipmentExcelFileParam = {
738
726
  */
739
727
  dpIds?: string;
740
728
  /**
741
- * - Date time in UTC timezone as per ISO format.
729
+ * - UTC start date in ISO format
742
730
  */
743
731
  startDate?: string;
744
732
  /**
745
- * - Date time in UTC timezone as per ISO format.
733
+ * - UTC end date in ISO format
746
734
  */
747
735
  endDate?: string;
748
736
  /**
@@ -772,20 +760,35 @@ type GetBulkShipmentExcelFileParam = {
772
760
  pageNo?: number;
773
761
  pageSize?: number;
774
762
  };
775
- type GetFileByStatusParam = {
763
+ type GetFailedOrderLogsParam = {
776
764
  /**
777
- * - Batch Id to identify the bulk operation request.
765
+ * - Page Number
778
766
  */
779
- batchId: string;
767
+ pageNo?: number;
768
+ /**
769
+ * - Page Size
770
+ */
771
+ pageSize?: number;
780
772
  /**
781
- * - The status of the jobs to filter the results.
773
+ * - Search type for filter
782
774
  */
775
+ searchType?: string;
776
+ /**
777
+ * - Search value for filter
778
+ */
779
+ searchValue?: string;
780
+ };
781
+ type GetFileByStatusParam = {
782
+ batchId: string;
783
783
  status: string;
784
784
  fileType: string;
785
+ reportType?: string;
786
+ };
787
+ type GetGlobalFiltersParam = {
785
788
  /**
786
- * - The type of report to be downloaded.
789
+ * - Name of view to get filters for
787
790
  */
788
- reportType?: string;
791
+ showIn: string;
789
792
  };
790
793
  type GetLaneConfigParam = {
791
794
  /**
@@ -800,9 +803,6 @@ type GetLaneConfigParam = {
800
803
  * - Start Date in DD-MM-YYYY format
801
804
  */
802
805
  fromDate?: string;
803
- /**
804
- * - End Date in DD-MM-YYYY format
805
- */
806
806
  toDate?: string;
807
807
  /**
808
808
  * - UTC Start Date in ISO format
@@ -829,16 +829,9 @@ type GetLaneConfigParam = {
829
829
  * - Comma separated values of bag statuses
830
830
  */
831
831
  bagStatus?: string;
832
- /**
833
- * - Search_type refers to the field that will
834
- * be used as the target for the search operation
835
- */
836
832
  searchType?: string;
837
833
  searchValue?: string;
838
834
  tags?: string;
839
- /**
840
- * - Time_to_dispatch refers to estimated SLA time.
841
- */
842
835
  timeToDispatch?: number;
843
836
  paymentMethods?: string;
844
837
  myOrders?: boolean;
@@ -847,143 +840,18 @@ type GetLaneConfigParam = {
847
840
  * company order
848
841
  */
849
842
  showCrossCompanyData?: boolean;
850
- /**
851
- * - Defines the specific journey a shipment will
852
- * follow based on the application's operational needs and customer
853
- * preferences. This field categorizes orders into distinct types, each
854
- * associated with a unique processing flow. For example:
855
- *
856
- * - "HomeDelivery": The order goes through all the steps needed for delivery,
857
- * from being packed to arriving at the customer’s address.
858
- * - "PickAtStore": The order is prepared for pickup at the store, skipping
859
- * shipping steps to make it ready faster for the customer to collect in person.
860
- * - "Digital": This order type likely refers to orders that involve digital goods
861
- * or services, such as software, digital subscriptions, e-books, online
862
- * courses, or any other item that can be delivered electronically.
863
- */
864
843
  orderType?: string;
865
844
  };
866
- type GetManifestDetailsParam = {
867
- /**
868
- * - The unique identifier assigned to the manifest.
869
- */
870
- manifestId: string;
871
- /**
872
- * - Filter shipments with the specific Courier
873
- * partner Ids which is a combination of courier partner extension and scheme Ids.
874
- */
875
- dpIds?: string;
876
- /**
877
- * - End date for the shipment search range in manifest.
878
- */
879
- endDate?: string;
880
- /**
881
- * - Start date for the shipment search range in manifest.
882
- */
883
- startDate?: string;
884
- /**
885
- * - Page number for pagination.
886
- */
887
- pageNo?: number;
888
- /**
889
- * - Number of records per page for pagination.
890
- */
891
- pageSize?: number;
892
- };
893
- type GetManifestShipmentsParam = {
894
- /**
895
- * - Filter shipments with the specific Courier partner
896
- * Ids which is a combination of courier partner extension and scheme Ids.
897
- */
898
- dpIds: string;
899
- /**
900
- * - Filter results based on specific store IDs.
901
- */
902
- stores: number;
903
- /**
904
- * - End date for the shipment search range.
905
- */
906
- toDate: string;
907
- /**
908
- * - Start date for the shipment search range.
909
- */
910
- fromDate: string;
911
- /**
912
- * - Filter results based on specific courier partner name.
913
- */
914
- dpName?: string;
915
- /**
916
- * - Filter results based on comma-separated
917
- * list of sales channels.
918
- */
919
- salesChannels?: string;
920
- /**
921
- * - Filter results based on search type.
922
- */
923
- searchType?: string;
924
- /**
925
- * - Filter results based on the search value.
926
- */
927
- searchValue?: string;
928
- /**
929
- * - Page number for pagination.
930
- */
931
- pageNo?: number;
932
- /**
933
- * - Number of records per page for pagination.
934
- */
935
- pageSize?: number;
936
- };
937
845
  type GetManifestfiltersParam = {
938
846
  /**
939
847
  * - Name of View
940
848
  */
941
849
  view: string;
942
850
  };
943
- type GetManifestsParam = {
944
- /**
945
- * - Filter for the status of manifests.
946
- */
947
- status?: string;
948
- /**
949
- * - The starting date for filtering manifests in
950
- * ISO format
951
- */
952
- startDate?: string;
953
- /**
954
- * - The end date for filtering manifests in ISO format
955
- */
956
- endDate?: string;
957
- /**
958
- * - Specifies the type of search to perform.
959
- */
960
- searchType?: string;
961
- /**
962
- * - Filter to fetch manifests for a specific store
963
- * by its ID.
964
- */
965
- storeId?: number;
966
- /**
967
- * - The value to search for based on the
968
- * selected search type.
969
- */
970
- searchValue?: string;
971
- /**
972
- * - A comma-separated list of courier partner IDs
973
- * (DP IDs) to filter the manifests.
974
- */
975
- dpIds?: string;
976
- /**
977
- * - The number of the page to fetch data.
978
- */
979
- pageNo?: number;
851
+ type GetOrderByIdParam = {
980
852
  /**
981
- * - The number of records to return per page for
982
- * pagination.
853
+ * - Flag for order id
983
854
  */
984
- pageSize?: number;
985
- };
986
- type GetOrderByIdParam = {
987
855
  orderId: string;
988
856
  myOrders?: boolean;
989
857
  /**
@@ -994,30 +862,27 @@ type GetOrderByIdParam = {
994
862
  type GetOrdersParam = {
995
863
  /**
996
864
  * - Lane refers to a section where orders are
997
- * assigned, indicating its grouping.
865
+ * assigned, indicating its grouping
998
866
  */
999
867
  lane?: string;
1000
868
  /**
1001
869
  * - Search_type refers to the field that will
1002
- * be used as the target for the search operation.
870
+ * be used as the target for the search operation
1003
871
  */
1004
872
  searchType?: string;
1005
873
  /**
1006
- * - Bag_status refers to status of the entity.
1007
- * Filters orders based on the status.
874
+ * - Bag_status refers to the status of the
875
+ * entity. Filters orders based on the status.
1008
876
  */
1009
877
  bagStatus?: string;
1010
878
  /**
1011
- * - Time_to_dispatch refers to estimated SLA time.
879
+ * - Time_to_dispatch refers to the
880
+ * estimated SLA time.
1012
881
  */
1013
882
  timeToDispatch?: number;
1014
- /**
1015
- * - Comma separated values of payment
1016
- * methods that were used to place order.
1017
- */
1018
883
  paymentMethods?: string;
1019
884
  /**
1020
- * - Tags refers to additional descriptive labels
885
+ * - Tags refer to additional descriptive labels
1021
886
  * associated with the order
1022
887
  */
1023
888
  tags?: string;
@@ -1026,63 +891,57 @@ type GetOrdersParam = {
1026
891
  * specified by the search_type
1027
892
  */
1028
893
  searchValue?: string;
1029
- /**
1030
- * - Date time in UTC timezone as per ISO format.
1031
- */
1032
894
  fromDate?: string;
1033
- /**
1034
- * - Date time in UTC timezone as per ISO format.
1035
- */
1036
895
  toDate?: string;
1037
- /**
1038
- * - Date time in UTC timezone as per ISO format.
1039
- */
1040
896
  startDate?: string;
1041
- /**
1042
- * - Date time in UTC timezone as per ISO format.
1043
- */
1044
897
  endDate?: string;
1045
898
  /**
1046
899
  * - Delivery Partner IDs to which shipments are assigned.
1047
900
  */
1048
901
  dpIds?: string;
1049
- /**
1050
- * - A comma-separated list of store IDs used to
1051
- * filter results to only those related to specific stores.
1052
- */
1053
902
  stores?: string;
1054
- /**
1055
- * - A comma-separated list of sales channel
1056
- * IDs to filter results based on the sales channels involved.
1057
- */
1058
903
  salesChannels?: string;
1059
- /**
1060
- * - Specifies the page number for paginated results.
1061
- */
1062
904
  pageNo?: number;
1063
- /**
1064
- * - Determines the number of results returned per page.
1065
- */
1066
905
  pageSize?: number;
1067
906
  isPrioritySort?: boolean;
1068
- customMeta?: string;
907
+ customMeta?: any[];
1069
908
  myOrders?: boolean;
1070
909
  /**
1071
910
  * - Flag to view cross & non-cross
1072
911
  * company order
1073
912
  */
1074
913
  showCrossCompanyData?: boolean;
1075
- /**
1076
- * - The unique identifier for the customer
1077
- * associated with the query, useful for filtering results to a specific customer.
1078
- */
1079
914
  customerId?: string;
1080
915
  orderType?: string;
1081
916
  /**
1082
- * - Flag indicating whether inactive
1083
- * shipments are allowed
917
+ * - Statuses relating to shipment
918
+ * transition in order processing journey. Comma separated values of
919
+ * operational statuses.
1084
920
  */
1085
- allowInactive?: boolean;
921
+ operationalStatus?: string;
922
+ /**
923
+ * - Statuses relating to finance related
924
+ * operations in the order processing journey. Comma separated values of
925
+ * financial statuses.
926
+ */
927
+ financialStatus?: string;
928
+ /**
929
+ * - Statuses relating to delivery and
930
+ * pickup related operations in the order processing journey. Comma separated
931
+ * values of logistics statuses.
932
+ */
933
+ logisticsStatus?: string;
934
+ /**
935
+ * - Parent view is used for grouping of
936
+ * child views. Slug of parent view.
937
+ */
938
+ parentViewSlug?: string;
939
+ /**
940
+ * - Child view is user configured view,
941
+ * which has filters added by the user on which shipments/orders are fetched.
942
+ * Slug of child view.
943
+ */
944
+ childViewSlug?: string;
1086
945
  /**
1087
946
  * - Defines the grouping criterion for
1088
947
  * retrieving shipments or orders. It specifies whether the results should be
@@ -1091,28 +950,54 @@ type GetOrdersParam = {
1091
950
  * may not be recognized, leading to errors or default behavior.
1092
951
  */
1093
952
  groupEntity?: string;
953
+ };
954
+ type GetRefundConfigurationParam = {
955
+ appId: string;
956
+ };
957
+ type GetRefundOptionsParam = {
958
+ /**
959
+ * - ID of the shipment. An order may contain
960
+ * multiple items and may get divided into one or more shipment, each having
961
+ * its own ID.
962
+ */
963
+ shipmentId: string;
1094
964
  /**
1095
- * - Applies a date filter for listing
1096
- * orders. This is useful when fetching data for a specific date range while
1097
- * performing searches.
965
+ * - It is the bag_id of the bags with comma separated.
1098
966
  */
1099
- enforceDateFilter?: boolean;
967
+ bagIds?: string;
968
+ /**
969
+ * - It is the desired state at which refund amount
970
+ * needs to be calculated.
971
+ */
972
+ state?: string;
973
+ /**
974
+ * - It is affiliate id of the order in case of
975
+ * cross selling.
976
+ */
977
+ optinAppId?: string;
1100
978
  /**
1101
- * - Define the Fulfillment Type for
1102
- * Listing Orders, This is use when we want to get list of shipments or orders
1103
- * by cross store or cross company or fulfilling Store (by default), this is
1104
- * also depends on the login user accessType and store access
979
+ * - It is company id of the order in case
980
+ * of cross selling.
1105
981
  */
1106
- fulfillmentType?: string;
982
+ optinCompanyId?: number;
983
+ /**
984
+ * - It specifies the desired status to which the
985
+ * shipment should be updated. It represents the next step in the shipment's
986
+ * lifecycle, such as being cancelled by the customer or moved to another
987
+ * status in the shipping process.
988
+ */
989
+ status?: string;
990
+ };
991
+ type GetRefundStateConfigurationParam = {
992
+ appId: string;
1107
993
  };
1108
994
  type GetShipmentByIdParam = {
1109
995
  /**
1110
- * - The shipment ID used in the
1111
- * application, which can be used to reference specific shipments.
996
+ * - App Shipment Id
1112
997
  */
1113
998
  channelShipmentId?: string;
1114
999
  /**
1115
- * - The unique identifier for a shipment.
1000
+ * - Shipment Id
1116
1001
  */
1117
1002
  shipmentId?: string;
1118
1003
  /**
@@ -1120,19 +1005,14 @@ type GetShipmentByIdParam = {
1120
1005
  * deactivated shipments
1121
1006
  */
1122
1007
  fetchActiveShipment?: boolean;
1123
- /**
1124
- * - Flag indicating whether inactive
1125
- * shipments are allowed
1126
- */
1127
- allowInactive?: boolean;
1128
1008
  };
1129
1009
  type GetShipmentHistoryParam = {
1130
1010
  /**
1131
- * - Identifier for the shipment
1011
+ * - Shipment Id
1132
1012
  */
1133
1013
  shipmentId?: string;
1134
1014
  /**
1135
- * - Identifier for a bag or product.
1015
+ * - Bag/Product Id
1136
1016
  */
1137
1017
  bagId?: number;
1138
1018
  };
@@ -1159,32 +1039,21 @@ type GetShipmentsParam = {
1159
1039
  */
1160
1040
  lane?: string;
1161
1041
  /**
1162
- * - Comma separated values of bag statuses.
1042
+ * - Comma separated values of bag statuses
1163
1043
  */
1164
1044
  bagStatus?: string;
1165
- /**
1166
- * - Used to filter shipments based on
1167
- * status present in shipment_status_history. For more information on these
1168
- * statuses, refer to the Fynd Partners documentation.
1169
- */
1170
- statusAssigned?: string;
1171
1045
  /**
1172
1046
  * - Use this flag to fetch by
1173
- * bag_status and override lane.
1047
+ * bag_status and override lane
1174
1048
  */
1175
1049
  statusOverrideLane?: boolean;
1176
- /**
1177
- * - Indicates the time to dispatch.
1178
- */
1179
1050
  timeToDispatch?: number;
1180
1051
  /**
1181
- * - Specifies the key used to determine the
1182
- * type of search being performed.
1052
+ * - Search type key
1183
1053
  */
1184
1054
  searchType?: string;
1185
1055
  /**
1186
- * - The value corresponding to the search
1187
- * type, such as a specific shipment ID or order ID.
1056
+ * - Search type value
1188
1057
  */
1189
1058
  searchValue?: string;
1190
1059
  /**
@@ -1196,168 +1065,128 @@ type GetShipmentsParam = {
1196
1065
  */
1197
1066
  toDate?: string;
1198
1067
  /**
1199
- * - The UTC start date in ISO format
1200
- * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
1068
+ * - UTC Start Date in ISO format
1201
1069
  */
1202
1070
  startDate?: string;
1203
1071
  /**
1204
- * - The UTC end date in ISO format
1205
- * (YYYY-MM-DDTHH:MM:SSZ) for filtering results.
1072
+ * - UTC End Date in ISO format
1206
1073
  */
1207
1074
  endDate?: string;
1208
1075
  /**
1209
- * - Specifies the starting UTC
1210
- * date and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the lower
1211
- * boundary for filtering shipments based on the `created_at` timestamp of
1212
- * statuses in the shipment's status history. It allows filtering statuses
1213
- * that were created within a specific time range.
1214
- */
1215
- statusAssignedStartDate?: string;
1216
- /**
1217
- * - Specifies the ending UTC date
1218
- * and time (in ISO format, YYYY-MM-DDTHH:MM:SSZ) to define the upper boundary
1219
- * for filtering shipments based on the `created_at` timestamp of statuses in
1220
- * the shipment's status history.
1221
- */
1222
- statusAssignedEndDate?: string;
1223
- /**
1224
- * - A comma-separated list of delivery partner IDs
1225
- * to filter results by specific delivery partners.
1076
+ * - Comma separated values of delivery partner ids
1226
1077
  */
1227
1078
  dpIds?: string;
1228
1079
  /**
1229
- * - A comma-separated list of store IDs used to
1230
- * filter results to only those related to specific stores.
1080
+ * - Comma separated values of store ids
1231
1081
  */
1232
1082
  stores?: string;
1233
1083
  /**
1234
- * - A comma-separated list of sales channel
1235
- * IDs to filter results based on the sales channels involved.
1084
+ * - Comma separated values of sales channel ids
1236
1085
  */
1237
1086
  salesChannels?: string;
1238
1087
  /**
1239
- * - Specifies the page number for paginated results.
1088
+ * - Page number for paginated data
1240
1089
  */
1241
1090
  pageNo?: number;
1242
1091
  /**
1243
- * - Determines the number of results returned per page.
1092
+ * - Page size of data received per page
1244
1093
  */
1245
1094
  pageSize?: number;
1246
1095
  /**
1247
- * - A boolean flag that indicates
1248
- * whether to include only active shipments in the results.
1096
+ * - Flag to fetch active shipments
1249
1097
  */
1250
1098
  fetchActiveShipment?: boolean;
1251
1099
  /**
1252
- * - A flag indicating whether to allow the
1253
- * inclusion of inactive shipments in the results.
1100
+ * - Flag to allow inactive shipments
1254
1101
  */
1255
1102
  allowInactive?: boolean;
1256
1103
  /**
1257
- * - A flag to specify whether to
1258
- * exclude shipments that are locked from the results.
1104
+ * - Flag to fetch locked shipments
1259
1105
  */
1260
1106
  excludeLockedShipments?: boolean;
1261
1107
  /**
1262
- * - A comma-separated list of payment methods.
1108
+ * - Comma separated values of payment methods
1263
1109
  */
1264
1110
  paymentMethods?: string;
1265
1111
  /**
1266
- * - The shipment ID used in the
1267
- * application, which can be used to reference specific shipments.
1112
+ * - App Shipment Id
1268
1113
  */
1269
1114
  channelShipmentId?: string;
1270
1115
  /**
1271
- * - The order ID used in the application.
1116
+ * - App Order Id
1272
1117
  */
1273
1118
  channelOrderId?: string;
1274
- /**
1275
- * - Custom metadata associated with the query,
1276
- * allowing for additional filtering or information to be passed.
1277
- */
1278
1119
  customMeta?: string;
1279
- /**
1280
- * - The channel through which the order was placed.
1281
- */
1282
1120
  orderingChannel?: string;
1283
- /**
1284
- * - A tag used to identify the
1285
- * company's affiliation for filtering or reporting purposes.
1286
- */
1287
1121
  companyAffiliateTag?: string;
1288
- /**
1289
- * - A boolean flag indicating whether the query
1290
- * should return only the user's orders.
1291
- */
1292
1122
  myOrders?: boolean;
1293
- /**
1294
- * - The unique identifier of the user on
1295
- * the platform, useful for filtering orders related to a specific user.
1296
- */
1297
1123
  platformUserId?: string;
1298
1124
  /**
1299
- * - Determines the sorting order of the results
1300
- * based on specific criteria.
1125
+ * - Sort the result data on basis of input
1301
1126
  */
1302
1127
  sortType?: string;
1303
1128
  /**
1304
- * - A flag indicating whether to
1305
- * include data from both cross-company and non-cross-company orders in the results.
1129
+ * - Flag to view cross & non-cross
1130
+ * company order
1306
1131
  */
1307
1132
  showCrossCompanyData?: boolean;
1308
1133
  /**
1309
- * - A comma-separated list of tags associated with
1310
- * the orders to filter results based on specific characteristics.
1134
+ * - Comma separated values of tags
1311
1135
  */
1312
1136
  tags?: string;
1313
- /**
1314
- * - The unique identifier for the customer
1315
- * associated with the query, useful for filtering results to a specific customer.
1316
- */
1317
1137
  customerId?: string;
1138
+ orderType?: string;
1318
1139
  /**
1319
- * - The type of order being queried.
1140
+ * - Statuses relating to shipment
1141
+ * transition in order processing journey. Comma separated values of
1142
+ * operational statuses.
1320
1143
  */
1321
- orderType?: string;
1144
+ operationalStatus?: string;
1322
1145
  /**
1323
- * - Defines the grouping criterion for
1324
- * retrieving shipments or orders. It specifies whether the results should be
1325
- * organized based on shipment groups or order groups. For example, using
1326
- * 'shipments' groups results by shipment, while an invalid value like 'abcd'
1327
- * may not be recognized, leading to errors or default behavior.
1146
+ * - Statuses relating to finance related
1147
+ * operations in the order processing journey. Comma separated values of
1148
+ * financial statuses.
1328
1149
  */
1329
- groupEntity?: string;
1150
+ financialStatus?: string;
1330
1151
  /**
1331
- * - Applies a date filter for listing
1332
- * shipments. This is useful when fetching data for a specific date range
1333
- * while performing searches.
1152
+ * - Statuses relating to delivery and
1153
+ * pickup related operations in the order processing journey. Comma separated
1154
+ * values of logistics statuses.
1334
1155
  */
1335
- enforceDateFilter?: boolean;
1156
+ logisticsStatus?: string;
1336
1157
  /**
1337
- * - Define the Fulfillment Type for
1338
- * Listing Orders, This is use when we want to get list of shipments or orders
1339
- * by cross store or cross company or fulfilling Store (by default), this is
1340
- * also depends on the login user accessType and store access
1158
+ * - Parent view is used for grouping of
1159
+ * child views. Slug of parent view.
1341
1160
  */
1342
- fulfillmentType?: string;
1343
- };
1344
- type GetStateManagerConfigParam = {
1161
+ parentViewSlug?: string;
1345
1162
  /**
1346
- * - The unique identifier of the application.
1163
+ * - Child view is user configured view which
1164
+ * has filters added by the user on which shipments/orders are fetched. Slug
1165
+ * of child view.
1347
1166
  */
1348
- appId?: string;
1167
+ childViewSlug?: string;
1349
1168
  /**
1350
- * - The channel through which orders are placed.
1169
+ * - Flag to identify if a shipment is locked or not.
1351
1170
  */
1352
- orderingChannel?: string;
1171
+ lockStatus?: string;
1353
1172
  /**
1354
- * - The entity for which the configuration is applied.
1173
+ * - Defines the grouping criterion for
1174
+ * retrieving shipments or orders. It specifies whether the results should be
1175
+ * organized based on shipment groups or order groups. For example, using
1176
+ * 'shipments' groups results by shipment, while an invalid value like 'abcd'
1177
+ * may not be recognized, leading to errors or default behavior.
1355
1178
  */
1356
- entity?: string;
1179
+ groupEntity?: string;
1357
1180
  };
1358
1181
  type GetTemplateParam = {
1359
1182
  templateName: string;
1360
1183
  };
1184
+ type GetUserViewsParam = {
1185
+ /**
1186
+ * - Name of view to get filters for.
1187
+ */
1188
+ showIn: string;
1189
+ };
1361
1190
  type GetfiltersParam = {
1362
1191
  /**
1363
1192
  * - Name of view
@@ -1372,15 +1201,19 @@ type InvalidateShipmentCacheParam = {
1372
1201
  body: OrderPlatformModel.InvalidateShipmentCachePayload;
1373
1202
  };
1374
1203
  type JobDetailsParam = {
1375
- /**
1376
- * - A unique identifier for the batch associated
1377
- * with this bulk action.
1378
- */
1379
1204
  batchId: string;
1380
1205
  };
1381
1206
  type OrderUpdateParam = {
1382
1207
  body: OrderPlatformModel.PlatformOrderUpdate;
1383
1208
  };
1209
+ type PostRefundConfigurationParam = {
1210
+ appId: string;
1211
+ body: OrderPlatformModel.RefundStateConfigurationManualSchema;
1212
+ };
1213
+ type PostRefundStateConfigurationParam = {
1214
+ appId: string;
1215
+ body: OrderPlatformModel.PostRefundStateConfiguration;
1216
+ };
1384
1217
  type PostShipmentHistoryParam = {
1385
1218
  body: OrderPlatformModel.PostShipmentHistory;
1386
1219
  };
@@ -1395,7 +1228,7 @@ type SendUserMobileOTPParam = {
1395
1228
  };
1396
1229
  type TrackShipmentParam = {
1397
1230
  /**
1398
- * - Unique identifier of a shipment on the platform.
1231
+ * - Shipment ID
1399
1232
  */
1400
1233
  shipmentId?: string;
1401
1234
  /**
@@ -1403,45 +1236,45 @@ type TrackShipmentParam = {
1403
1236
  */
1404
1237
  awb?: string;
1405
1238
  /**
1406
- * - Page number for pagination.
1239
+ * - Page number
1407
1240
  */
1408
1241
  pageNo?: number;
1409
1242
  /**
1410
- * - Number of records per page for pagination.
1243
+ * - Page size
1411
1244
  */
1412
1245
  pageSize?: number;
1413
1246
  };
1414
- type UpdateAddressParam = {
1415
- /**
1416
- * - Unique shipment no. that is auto-generated
1417
- */
1418
- shipmentId: string;
1419
- body: OrderPlatformModel.UpdateAddressRequestBody;
1247
+ type UpdateOrderParam = {
1248
+ orderId: string;
1249
+ body: OrderPlatformModel.OrderUpdatePayload;
1420
1250
  };
1421
1251
  type UpdatePackagingDimensionsParam = {
1422
1252
  body: OrderPlatformModel.UpdatePackagingDimensionsPayload;
1423
1253
  };
1424
- type UpdatePaymentInfoParam = {
1425
- body: OrderPlatformModel.UpdateShipmentPaymentMode;
1254
+ type UpdateShipmentParam = {
1255
+ body: OrderPlatformModel.UpdateShipmentActionRequest;
1426
1256
  };
1427
1257
  type UpdateShipmentLockParam = {
1428
1258
  body: OrderPlatformModel.UpdateShipmentLockPayload;
1429
1259
  };
1430
1260
  type UpdateShipmentStatusParam = {
1431
- body: OrderPlatformModel.UpdateShipmentStatusRequestSchema;
1261
+ body: OrderPlatformModel.UpdateShipmentStatusRequest;
1432
1262
  };
1433
1263
  type UpdateShipmentTrackingParam = {
1434
1264
  body: OrderPlatformModel.CourierPartnerTrackingDetails;
1435
1265
  };
1436
- type UploadConsentsParam = {
1437
- body: OrderPlatformModel.UploadManifestConsent;
1266
+ type UpdateUserViewPositionParam = {
1267
+ body: OrderPlatformModel.UserViewPosition;
1268
+ };
1269
+ type UpdateUserViewsParam = {
1270
+ body: OrderPlatformModel.UserViewsResponse;
1438
1271
  };
1439
1272
  type VerifyMobileOTPParam = {
1440
1273
  body: OrderPlatformModel.VerifyMobileOTP;
1441
1274
  };
1442
1275
  type GetAllowedTemplatesForBulkParam = any;
1443
1276
  type GetBulkActionTemplateParam = any;
1444
- type GetChannelConfigParam = any;
1277
+ type GetRefundEnableStateListParam = any;
1445
1278
  type GetRoleBasedActionsParam = any;
1446
1279
  type GetStateTransitionMapParam = any;
1447
1280
  import OrderPlatformModel = require("./OrderPlatformModel");