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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (278) hide show
  1. package/README.md +23 -26
  2. package/package.json +5 -1
  3. package/sdk/application/ApplicationClient.d.ts +5 -6
  4. package/sdk/application/ApplicationClient.js +24 -20
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
  6. package/sdk/application/Cart/CartApplicationClient.js +444 -76
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
  16. package/sdk/application/Content/ContentApplicationClient.js +274 -111
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +6 -6
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
  26. package/sdk/application/Order/OrderApplicationClient.js +217 -17
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
  28. package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
  32. package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
  33. package/sdk/application/User/UserApplicationClient.d.ts +103 -53
  34. package/sdk/application/User/UserApplicationClient.js +308 -49
  35. package/sdk/common/AxiosHelper.js +11 -4
  36. package/sdk/common/Constant.d.ts +27 -4
  37. package/sdk/common/Constant.js +33 -6
  38. package/sdk/common/utils.d.ts +10 -0
  39. package/sdk/common/utils.js +24 -3
  40. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
  41. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
  43. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
  44. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
  45. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
  46. package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
  47. package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
  48. package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
  49. package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
  50. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
  51. package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
  52. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
  53. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
  54. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
  55. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
  56. package/sdk/partner/PartnerClient.d.ts +5 -2
  57. package/sdk/partner/PartnerClient.js +21 -7
  58. package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
  59. package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
  60. package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
  61. package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
  62. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  63. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
  64. package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
  65. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
  66. package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
  67. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
  68. package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
  69. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
  70. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
  71. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  73. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
  75. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  81. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  82. package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
  83. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  84. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  85. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  86. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  87. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
  89. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
  91. package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
  92. package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
  93. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
  97. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
  98. package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
  99. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
  101. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
  103. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
  104. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  105. package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
  106. package/sdk/platform/Common/CommonPlatformModel.js +25 -14
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
  111. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  112. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  113. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
  114. package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
  124. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
  126. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
  128. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  130. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
  132. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
  134. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
  135. package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
  136. package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
  137. package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
  138. package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
  139. package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
  140. package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
  141. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
  142. package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
  143. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
  144. package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  146. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
  150. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
  152. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
  154. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  156. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  159. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  160. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  161. package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
  162. package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
  163. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
  164. package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
  165. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
  166. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
  167. package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
  168. package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
  169. package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
  170. package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
  171. package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
  172. package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
  173. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
  175. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  177. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
  178. package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
  179. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
  180. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
  181. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
  182. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
  183. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
  184. package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
  185. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
  186. package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
  187. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  188. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  189. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  190. package/sdk/platform/PlatformApplicationClient.js +0 -4
  191. package/sdk/platform/PlatformClient.d.ts +5 -4
  192. package/sdk/platform/PlatformClient.js +32 -22
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
  203. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  204. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
  206. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  212. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
  214. package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
  215. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
  216. package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
  217. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
  218. package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
  219. package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
  220. package/sdk/platform/User/UserPlatformModel.js +607 -46
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  226. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  227. package/sdk/platform/index.d.ts +0 -2
  228. package/sdk/platform/index.js +0 -4
  229. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  230. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  231. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  232. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  233. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  234. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
  239. package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
  240. package/sdk/public/Content/ContentPublicClient.js +1067 -17
  241. package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
  242. package/sdk/public/Content/ContentPublicModel.js +751 -3
  243. package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
  244. package/sdk/public/Content/ContentPublicValidator.js +119 -2
  245. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  246. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  247. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  248. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  249. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  250. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  251. package/sdk/public/PublicClient.d.ts +5 -2
  252. package/sdk/public/PublicClient.js +16 -6
  253. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
  254. package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
  255. package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
  256. package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
  257. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  258. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  259. package/sdk/public/index.d.ts +1 -0
  260. package/sdk/public/index.js +2 -0
  261. package/utility.d.ts +3 -0
  262. package/utility.js +7 -0
  263. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  264. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  265. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
  266. package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
  267. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  268. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  269. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  270. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  271. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  272. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
@@ -1,2890 +0,0 @@
1
- export = FinancePlatformModel;
2
- /**
3
- * @typedef OrederFreezeResponse
4
- * @property {boolean} [success] - Indicates whether the operation was successful or not.
5
- * @property {boolean} [oms_freeze] - Flag indicating if the system is frozen
6
- * for order management.
7
- * @property {string} [source] - Optional field indicating the data source of
8
- * the information.
9
- */
10
- /**
11
- * @typedef GenerateReportMeta
12
- * @property {string} [brand] - The brand name associated with the report meta
13
- * information.
14
- * @property {string} [company] - The company name associated with the report
15
- * meta information.
16
- * @property {string} [channel] - The sale channel name associated with seller.
17
- */
18
- /**
19
- * @typedef GenerateReportFilters
20
- * @property {string[]} [brand] - An array of brand names to filter the report data.
21
- * @property {string[]} [company] - An array of company id to filter the report data.
22
- * @property {string[]} [channel] - An array of sale channel names associated
23
- * with seller to filter the report data.
24
- */
25
- /**
26
- * @typedef GenerateReportPlatform
27
- * @property {string} [start_date] - The start date to generate report specific preiod.
28
- * @property {string} [end_date] - The end date to generate report specific preiod.
29
- * @property {GenerateReportMeta} [meta]
30
- * @property {string} [report_id] - The unique identifier of the generate report
31
- * where different report configure.
32
- * @property {GenerateReportFilters} [filters]
33
- */
34
- /**
35
- * @typedef GenerateReportReq
36
- * @property {GenerateReportPlatform} [data]
37
- */
38
- /**
39
- * @typedef Page
40
- * @property {number} [item_total] - The total number of items on the page.
41
- * @property {string} [next_id] - The identifier for the next page.
42
- * @property {boolean} [has_previous] - Indicates whether there is a previous page.
43
- * @property {boolean} [has_next] - Indicates whether there is a next page.
44
- * @property {number} [current] - The current page number.
45
- * @property {string} type - The type of the page, such as 'PageType'.
46
- * @property {number} [size] - The number of items per page.
47
- */
48
- /**
49
- * @typedef Currency
50
- * @property {string} [code] - The unique currency code.
51
- * @property {string} [symbol] - The unique currency symbol.
52
- * @property {string} [name] - The unique currency name.
53
- */
54
- /**
55
- * @typedef GenerateReportJson
56
- * @property {Object} [data]
57
- * @property {number} [item_count] - Total number of items in the report.
58
- * @property {Page} [page]
59
- * @property {string} [end_date] - The end date to generate report specific preiod.
60
- * @property {string} [start_date] - The start date to generate report specific preiod.
61
- * @property {string[][]} [items] - Nested array structure representing report
62
- * items or data.
63
- * @property {string[]} [headers] - Headers describing each item in the report data.
64
- */
65
- /**
66
- * @typedef Error
67
- * @property {number} [status]
68
- * @property {string} [reason]
69
- * @property {boolean} [success]
70
- * @property {string} [message]
71
- * @property {string} [code]
72
- * @property {string} [exception]
73
- * @property {string} [info]
74
- * @property {string} [request_id]
75
- * @property {string} [stack_trace]
76
- * @property {ErrorMeta} [meta]
77
- */
78
- /**
79
- * @typedef ErrorMeta
80
- * @property {ErrorMetaItems[]} [columns_errors]
81
- */
82
- /**
83
- * @typedef ErrorMetaItems
84
- * @property {number} [code]
85
- * @property {string} [message]
86
- */
87
- /**
88
- * @typedef DownloadReport
89
- * @property {DownloadReportData} [data]
90
- */
91
- /**
92
- * @typedef DownloadReportData
93
- * @property {number} [page] - The current page number of the report.
94
- * @property {number} [page_size] - The number of items displayed per page.
95
- * @property {string} [start_date] - The start date for fetching the report
96
- * history for download.
97
- * @property {string} [end_date] - The end date for fetching the report history
98
- * for download.
99
- */
100
- /**
101
- * @typedef DownloadReportItems
102
- * @property {string} [start_date] - The start date for the report item.
103
- * @property {string} [end_date] - The end date for the report item.
104
- * @property {GenerateReportMeta} [meta]
105
- * @property {string} [report_id] - The unique identifier of the report item.
106
- * @property {GenerateReportFilters} [filters]
107
- */
108
- /**
109
- * @typedef DownloadReportList
110
- * @property {DownloadReportItems[]} [items] - A list of report items available
111
- * for download.
112
- * @property {Page} [page]
113
- * @property {number} [item_count] - The total number of items in the report list.
114
- */
115
- /**
116
- * @typedef GetEngineFilters
117
- * @property {string} [config_field] - The configuration field used for filtering.
118
- * @property {string} [status] - The status used for filtering.
119
- * @property {boolean} [is_active] - Flag indicating if the filter is active.
120
- * @property {string} [seller_id] - The seller ID used for filtering.
121
- */
122
- /**
123
- * @typedef GetEngineData
124
- * @property {string} [status] - Status of the request.
125
- * @property {GetEngineFilters} [filters]
126
- * @property {string[]} [project] - A list of fields to get data from tables.
127
- * @property {string} [table_name] - The name of the table from which to retrieve data.
128
- * @property {Object} [search] - Search criteria for querying on given table
129
- * specific fields.
130
- * @property {number} [page] - The current page number for pagination.
131
- * @property {number} [page_size] - The number of items displayed per page.
132
- * @property {string} [order_by] - The field by which to order the results.
133
- */
134
- /**
135
- * @typedef GetEngineReq
136
- * @property {GetEngineData} [data]
137
- */
138
- /**
139
- * @typedef GetEngineResponse
140
- * @property {boolean} [success] - Indicates whether the request was successful.
141
- * @property {Object[]} [items] - A list of items returned by the request.
142
- * @property {Page} [page]
143
- * @property {number} [item_count] - The total number of items returned by the request.
144
- */
145
- /**
146
- * @typedef GetReason
147
- * @property {string} [reason_type] - The type of reason associated with the request.
148
- */
149
- /**
150
- * @typedef GetReasonReq
151
- * @property {GetReason} [data]
152
- */
153
- /**
154
- * @typedef ReasonItem
155
- * @property {string} [id] - Id of the reason for reason_type.
156
- * @property {string} [name] - Code of the reason for reason_type.
157
- * @property {string} [display_name] - Display name of the reason for reason_type.
158
- */
159
- /**
160
- * @typedef GetReasonResponse
161
- * @property {boolean} [success] - Indicates whether the request was successfull.
162
- * @property {ReasonItem[]} [item_list] - The list of items returned in the response.
163
- * @property {number} [item_count] - The number of items in the response.
164
- * @property {Page} [page]
165
- */
166
- /**
167
- * @typedef GetReportListData
168
- * @property {string} [role_name] - The name of the role requesting the report list.
169
- * @property {boolean} [listing_enabled] - Indicates whether listing is enabled
170
- * for the role.
171
- */
172
- /**
173
- * @typedef GetReportListReq
174
- * @property {GetReportListData} [data]
175
- */
176
- /**
177
- * @typedef GetReportListResponse
178
- * @property {boolean} [success] - Indicates whether the request was successful.
179
- * @property {ReportItem[]} [items] - The list of report items.
180
- * @property {Page} [page]
181
- * @property {number} [total_count] - The total number of items in the report list.
182
- */
183
- /**
184
- * @typedef ReportItem
185
- * @property {string} [id] - The unique identifier for the report item.
186
- * @property {string} [name] - The name of the report item.
187
- * @property {string} [description] - A brief description of the report item.
188
- * @property {string[]} [allowed_filters] - The filters that can be applied to
189
- * the report item.
190
- * @property {Object} [config_meta] - Metadata related to the report item configuration.
191
- * @property {string} [report_type] - The type of the report item.
192
- * @property {string} [display_date] - The display date of the report item, if applicable.
193
- */
194
- /**
195
- * @typedef GetAffiliate
196
- * @property {number} [company_id] - The unique identifier of the company
197
- * associated with the affiliate.
198
- */
199
- /**
200
- * @typedef GetAffiliateResponse
201
- * @property {string} [reason] - The reason for the response, if applicable.
202
- * @property {boolean} [success] - Indicates whether the request was successful.
203
- * @property {Object[]} [docs] - List of items or data related to the affiliate.
204
- */
205
- /**
206
- * @typedef DownloadCreditDebitNote
207
- * @property {string[]} [note_id] - List of unique identifiers for the
208
- * credit/debit notes to be download.
209
- */
210
- /**
211
- * @typedef DownloadCreditDebitNoteReq
212
- * @property {DownloadCreditDebitNote} [data]
213
- */
214
- /**
215
- * @typedef DownloadCreditDebitNoteResponseData
216
- * @property {string} [id] - The unique identifier of the download credit/debit note.
217
- * @property {string} [pdf_s3_url] - The URL where the PDF of the credit/debit
218
- * note is stored.
219
- */
220
- /**
221
- * @typedef DownloadCreditDebitNoteResponse
222
- * @property {boolean} [success] - Indicates whether the request to download the
223
- * credit/debit notes was successful.
224
- * @property {DownloadCreditDebitNoteResponseData[]} [data] - List of
225
- * credit/debit notes download data.
226
- */
227
- /**
228
- * @typedef InvoiceBillingItem
229
- * @property {string} [invoice_number] - The number of the invoice associated
230
- * with the billing item.
231
- * @property {number} [amount] - The amount of the billing item.
232
- */
233
- /**
234
- * @typedef PaymentProcessPayload
235
- * @property {string} [platform] - The platform through which the payment is processed.
236
- * @property {number} [amount] - The total amount to be processed in the payment.
237
- * @property {string} [transaction_type] - The type of transaction (e.g., seller_online).
238
- * @property {string} [source_reference] - The reference for the source of the payment.
239
- * @property {number} [total_amount] - The total amount to be processed in the payment.
240
- * @property {Object} [meta] - Additional metadata related to the payment.
241
- * @property {string} [currency] - The currency in which the payment is made.
242
- * @property {string} [seller_id] - The unique identifier for the seller
243
- * receiving the payment.
244
- * @property {string} [mode_of_payment] - The mode of payment (e.g., online).
245
- * @property {InvoiceBillingItem[]} [invoice_billing_items]
246
- */
247
- /**
248
- * @typedef PaymentProcessReq
249
- * @property {PaymentProcessPayload} [data]
250
- */
251
- /**
252
- * @typedef PaymentProcessResponse
253
- * @property {number} [code] - Response code indicating the status of the payment process.
254
- * @property {string} [message] - A message providing additional information
255
- * about the payment process response.
256
- * @property {Object} [meta] - Additional metadata related to the payment
257
- * process response.
258
- * @property {string} [transaction_id] - The unique identifier for the payment
259
- * transaction.
260
- * @property {string} [redirect_url] - URL to redirect the user to complete the
261
- * payment process, if applicable.
262
- */
263
- /**
264
- * @typedef CreditlineDataPlatformPayload
265
- * @property {number} [page] - The page number for pagination.
266
- * @property {string} [seller_id] - The unique identifier for the seller.
267
- * @property {string} [end_date] - The end date for the query.
268
- * @property {string} [start_date] - The start date for the query.
269
- * @property {number} [page_size] - The number of items per page.
270
- */
271
- /**
272
- * @typedef CreditlineDataPlatformReq
273
- * @property {CreditlineDataPlatformPayload} [data]
274
- */
275
- /**
276
- * @typedef CreditlineDataPlatformResponse
277
- * @property {Object[]} [items] - The list of items in the response.
278
- * @property {number} [code] - The response status code.
279
- * @property {boolean} [show_mr] - A flag indicating whether to show MR (some
280
- * specific field).
281
- * @property {Page} [page]
282
- * @property {string} [message] - The response message.
283
- * @property {string[]} [headers] - The list of response headers.
284
- * @property {number} [item_count] - The total number of items.
285
- */
286
- /**
287
- * @typedef IsCreditlinePayload
288
- * @property {string} [seller_id] - The unique identifier for the seller to
289
- * check for credit line eligibility.
290
- */
291
- /**
292
- * @typedef IsCreditlinePlatformReq
293
- * @property {IsCreditlinePayload} [data]
294
- */
295
- /**
296
- * @typedef IsCreditlinePlatformResponse
297
- * @property {boolean} [is_creditline_opted] - Indicates whether the seller has
298
- * opted for a credit line.
299
- * @property {number} [code] - Response code indicating the status of the credit
300
- * line check.
301
- */
302
- /**
303
- * @typedef InvoiceTypePayloadData
304
- * @property {boolean} [is_active] - Indicates if the invoice type is active.
305
- */
306
- /**
307
- * @typedef InvoiceTypeReq
308
- * @property {InvoiceTypePayloadData} [data]
309
- */
310
- /**
311
- * @typedef InvoiceTypeResponseItems
312
- * @property {string} [text] - The text description of the invoice type.
313
- * @property {string} [value] - The value or code representing the invoice type.
314
- */
315
- /**
316
- * @typedef InvoiceTypeResponse
317
- * @property {boolean} [success] - Indicates whether the request was successful.
318
- * @property {InvoiceTypeResponseItems[]} [invoice_type_list] - List of invoice
319
- * types available.
320
- * @property {InvoiceTypeResponseItems[]} [payment_status_list] - List of
321
- * payment statuses available.
322
- */
323
- /**
324
- * @typedef InoviceListingPayloadDataFilters
325
- * @property {string[]} [payment_status] - List of payment statuses to filter by.
326
- * @property {string[]} [invoice_type] - List of invoice types to filter by.
327
- * @property {string[]} [company_id] - List of company IDs to filter by.
328
- */
329
- /**
330
- * @typedef InvoiceListingPayloadData
331
- * @property {number} [page_size] - The number of items per page for pagination.
332
- * @property {number} [page] - The page number for pagination.
333
- * @property {string} [start_date] - The start date for the invoice listing filter.
334
- * @property {string} [end_date] - The end date for the invoice listing filter.
335
- * @property {string} [search] - Search term for filtering invoices.
336
- * @property {InoviceListingPayloadDataFilters} [filters]
337
- */
338
- /**
339
- * @typedef InvoiceListingReq
340
- * @property {InvoiceListingPayloadData} [data]
341
- */
342
- /**
343
- * @typedef UnpaidInvoiceDataItems
344
- * @property {number} [total_unpaid_invoice_count] - The total count of unpaid invoices.
345
- * @property {string} [currency] - The currency used for unpaid invoices.
346
- * @property {number} [total_unpaid_amount] - The total amount of unpaid invoices.
347
- */
348
- /**
349
- * @typedef InvoiceListingResponseItems
350
- * @property {number} [amount] - The amount of the invoice.
351
- * @property {string} [company] - The name of the company associated with the invoice.
352
- * @property {string} [status] - The current status of the invoice (e.g.,
353
- * 'paid', 'unpaid').
354
- * @property {string} [due_date] - The due date of the invoice.
355
- * @property {string} [invoice_date] - The date when the invoice was issued.
356
- * @property {string} [invoice_type] - The type of invoice.
357
- * @property {string} [period] - The period covered by the invoice.
358
- * @property {string} [invoice_number] - The invoice number.
359
- * @property {boolean} [is_downloadable] - Indicates if the invoice is available
360
- * for download.
361
- * @property {string} [invoice_id] - The unique identifier of the invoice.
362
- * @property {Currency} [currency]
363
- */
364
- /**
365
- * @typedef InvoiceListingResponse
366
- * @property {boolean} [success] - Indicates whether the request was successful.
367
- * @property {string[]} [headers] - Headers related to the invoice listing response.
368
- * @property {UnpaidInvoiceDataItems} [unpaid_invoice_data]
369
- * @property {InvoiceListingResponseItems[]} [items] - List of invoice items in
370
- * the response.
371
- * @property {Page} [page]
372
- * @property {number} [item_count] - The total number of invoice items in the response.
373
- */
374
- /**
375
- * @typedef InvoicePdfPayloadData
376
- * @property {string[]} [invoice_number] - List of invoice numbers for which
377
- * PDFs are requested.
378
- */
379
- /**
380
- * @typedef InvoicePdfReq
381
- * @property {InvoicePdfPayloadData} [data]
382
- */
383
- /**
384
- * @typedef InvoicePdfResponse
385
- * @property {boolean} [success] - Indicates whether the PDF generation request
386
- * was successful.
387
- * @property {string[]} [data] - List of URLs or paths to the generated PDF files.
388
- * @property {string[]} [error] - List of errors encountered while generating the PDFs.
389
- */
390
- /**
391
- * @typedef IsCnRefundMethodData
392
- * @property {string} [affiliate_id] - The unique identifier of sale channels or
393
- * application as affiliate_id associated with the seller.
394
- * @property {boolean} [toggle_edit_required] - Indicates whether editing the
395
- * refund method is required.
396
- * @property {number} [seller_id] - Unique identifier for the seller.
397
- */
398
- /**
399
- * @typedef IsCnRefundMethodReq
400
- * @property {IsCnRefundMethodData} [data]
401
- */
402
- /**
403
- * @typedef IsCnRefundMethodResponseData
404
- * @property {boolean} [is_first_time_user] - Indicates whether the seller for
405
- * specific sale channel is using the refund method for the first time.
406
- */
407
- /**
408
- * @typedef IsCnRefundMethodResponse
409
- * @property {boolean} [success] - Indicates whether the request to determine
410
- * the refund method was successful.
411
- * @property {IsCnRefundMethodResponseData} [data]
412
- */
413
- /**
414
- * @typedef CreditNoteConfigNotificationEvents
415
- * @property {number} [expiration_reminder_to_customer] - Number of days before
416
- * the expiration date to send a reminder notification to the customer.
417
- */
418
- /**
419
- * @typedef CreateSellerCreditNoteConfig
420
- * @property {boolean} [is_cn_as_refund_method] - Indicates if the credit note
421
- * is used as a refund method.
422
- * @property {string} [affiliate_id] - The unique identifier of sale channels or
423
- * application as affiliate_id associated with the seller.
424
- * @property {string[]} [source_channel] - List of source channels associated
425
- * with the credit note configuration.
426
- * @property {number} [seller_id] - Unique identifier for the seller.
427
- * @property {CreditNoteConfigNotificationEvents} [notification_events]
428
- * @property {string} [sales_channel_name] - Name of the sales channel.
429
- * @property {string[]} [ordering_channel] - List of ordering channels
430
- * associated with the credit note configuration.
431
- * @property {number} [validity] - Validity period of the credit note in days.
432
- * @property {string} [currency_type] - Type of currency used for the credit note.
433
- * @property {string[]} [slug_values] - List of slug values associated with the
434
- * credit note configuration.
435
- */
436
- /**
437
- * @typedef CreateSellerCreditNoteConfigReq
438
- * @property {CreateSellerCreditNoteConfig} [data]
439
- */
440
- /**
441
- * @typedef CreateSellerCreditNoteConfigResponse
442
- * @property {boolean} [success] - Indicates if the credit note configuration
443
- * creation was successful.
444
- * @property {string} [message] - Additional information or message about the
445
- * credit note configuration creation process.
446
- */
447
- /**
448
- * @typedef DeleteConfig
449
- * @property {string} [affiliate_id] - The unique identifier of sale channels or
450
- * application as affiliate_id associated with the seller.
451
- * @property {string[]} [slug_values] - List of slug values associated with the
452
- * credit note configuration.
453
- * @property {number} [seller_id] - Unique identifier for the seller.
454
- */
455
- /**
456
- * @typedef DeleteConfigReq
457
- * @property {DeleteConfig} [data]
458
- */
459
- /**
460
- * @typedef DeleteConfigResponse
461
- * @property {boolean} [success] - Indicates if the configuration deletion was successful.
462
- * @property {string} [message] - Additional information or message about the
463
- * configuration deletion process.
464
- */
465
- /**
466
- * @typedef ChannelDisplayNameItems
467
- * @property {string} [key] - The unique key identifying the channel.
468
- * @property {string} [value] - The display name of the channel associated with the key.
469
- */
470
- /**
471
- * @typedef ChannelDisplayNameResponse
472
- * @property {boolean} [success] - Indicates if the retrieval of channel display
473
- * names was successful.
474
- * @property {ChannelDisplayNameItems[]} [items] - List of items containing
475
- * key-value pairs for channel display names.
476
- */
477
- /**
478
- * @typedef CnReferenceNumber
479
- * @property {string} [cn_reference_number] - The unique reference number of the
480
- * credit note.
481
- */
482
- /**
483
- * @typedef GetPdfUrlViewReq
484
- * @property {CnReferenceNumber} [data]
485
- */
486
- /**
487
- * @typedef GetPdfUrlViewResponseData
488
- * @property {string} [s3_pdf_link] - The URL link where credit nore pdf stored
489
- * to view and download.
490
- * @property {string} [cn_reference_number] - The unique reference number of the
491
- * credit note.
492
- */
493
- /**
494
- * @typedef GetPdfUrlViewResponse
495
- * @property {boolean} [success] - Indicates if the retrieval of the pdf URL was
496
- * successful.
497
- * @property {GetPdfUrlViewResponseData} [data]
498
- */
499
- /**
500
- * @typedef CreditNoteDetailsReq
501
- * @property {CnReferenceNumber} [data]
502
- */
503
- /**
504
- * @typedef CnDetails
505
- * @property {string} [staff_id] - ID of the staff member associated with the credit note.
506
- * @property {string} [expiry_date] - Expiry date of the credit note.
507
- * @property {string} [channel_of_issuance] - Channel through which the credit
508
- * note was issued.
509
- * @property {string} [order_id] - Order ID of order for which credit note created.
510
- * @property {string} [date_issued] - Date when the credit note was issued.
511
- * @property {string} [ordering_channel] - Ordering channel associated with the
512
- * credit note.
513
- * @property {string} [shipment_id] - Shipment Id associated with the credit note.
514
- * @property {string} [store_id] - Store Id associated with the credit note.
515
- * @property {string} [invoice_number] - Invoice number associated with the credit note.
516
- */
517
- /**
518
- * @typedef RedemptionDetails
519
- * @property {Object} [meta] - Additional metadata related to the redemption details.
520
- * @property {string} [staff_id] - ID of the staff member who processed the redemption.
521
- * @property {string} [created_at] - Date and time when the redemption was processed.
522
- * @property {string} [order_id] - Order Id of the order associated with the redemption.
523
- * @property {string} [store_id] - Store Id of the order associated with the redemption.
524
- * @property {string} [shipment_id] - Shipment Id of the order associated with
525
- * the redemption.
526
- * @property {string} [ordering_channel] - Ordering channel associated with the
527
- * redemption.
528
- * @property {number} [amount_debited] - Amount debited from the credit note
529
- * during redemption.
530
- * @property {string} [invoice_number] - Invoice number associated with the redemption.
531
- */
532
- /**
533
- * @typedef CreditNoteDetails
534
- * @property {string} [currency] - Currency in which the credit note is issued.
535
- * @property {number} [current_amount_used] - Current amount used from the credit note.
536
- * @property {string} [cn_status] - Status of the credit note.
537
- * @property {string} [customer_mobile_number] - Mobile number of the customer
538
- * associated with the credit note.
539
- * @property {string} [cn_reference_number] - Unique Credit number of the credit note.
540
- * @property {CnDetails} [cn_details]
541
- * @property {RedemptionDetails[]} [redemption_details] - List of redemption
542
- * details associated with the credit note.
543
- * @property {number} [remaining_cn_amount] - Remaining amount left in the credit note.
544
- * @property {number} [available_cn_balance] - Available balance in the credit note.
545
- * @property {number} [cn_amount] - Total amount of the credit note.
546
- */
547
- /**
548
- * @typedef CreditNoteDetailsResponse
549
- * @property {boolean} [success] - Indicates if the retrieval of credit note
550
- * details was successful.
551
- * @property {CreditNoteDetails} [data]
552
- */
553
- /**
554
- * @typedef GetCustomerCreditBalance
555
- * @property {string} [affiliate_id] - The unique identifier of sale channels or
556
- * application as affiliate_id associated with the seller.
557
- * @property {number} [seller_id] - Unique identifier for the seller.
558
- * @property {string} [customer_mobile_number] - Mobile number of the customer
559
- * for whom the credit balance is requested.
560
- */
561
- /**
562
- * @typedef GetCustomerCreditBalanceReq
563
- * @property {GetCustomerCreditBalance} [data]
564
- */
565
- /**
566
- * @typedef GetCustomerCreditBalanceResponseData
567
- * @property {string} [customer_mobile_number] - Mobile number of the customer.
568
- * @property {number} [total_credited_balance] - Total credited balance
569
- * available for the customer.
570
- */
571
- /**
572
- * @typedef GetCustomerCreditBalanceResponse
573
- * @property {boolean} [success] - Indicates if the retrieval of customer credit
574
- * balance was successful.
575
- * @property {GetCustomerCreditBalanceResponseData} [data]
576
- */
577
- /**
578
- * @typedef GetCnConfigReq
579
- * @property {DeleteConfig} [data]
580
- */
581
- /**
582
- * @typedef GetCnConfigResponseMeta
583
- * @property {string} [reason] - Reason associated with the configuration response.
584
- * @property {string[]} [source_channel] - List of source channels associated
585
- * with the credit note configuration.
586
- */
587
- /**
588
- * @typedef GetCnConfigResponseData
589
- * @property {boolean} [is_cn_as_refund_method] - Indicates if the credit note
590
- * is configured as a refund method.
591
- * @property {string} [affiliate_id] - The unique identifier of sale channels or
592
- * application as affiliate_id associated with the seller.
593
- * @property {Object} [meta]
594
- * @property {number} [seller_id] - Unique identifier for the seller.
595
- * @property {CreditNoteConfigNotificationEvents} [notification_events]
596
- * @property {number} [validity] - Validity period of the credit note
597
- * configuration in days.
598
- * @property {string[]} [redemption_ordering_channel] - List of ordering
599
- * channels associated with credit note redemption.
600
- * @property {string} [currency_type] - Type of currency used for the credit note.
601
- */
602
- /**
603
- * @typedef GetCnConfigResponse
604
- * @property {boolean} [success] - Indicates if the retrieval of credit note
605
- * configuration was successful.
606
- * @property {GetCnConfigResponseData} [data]
607
- */
608
- /**
609
- * @typedef CnGenerateReportFilters
610
- * @property {string[]} [staff_id] - Array of staff IDs for filtering credit note reports.
611
- * @property {string[]} [channel_of_issuance] - Array of channels through which
612
- * credit notes were issued.
613
- * @property {string[]} [utilisation] - Array of utilisation types for filtering
614
- * credit note reports.
615
- * @property {string[]} [ordering_channel] - Array of ordering channels
616
- * associated with credit note reports.
617
- * @property {number[]} [store_id] - Array of store IDs for filtering credit note reports.
618
- * @property {string[]} [type_of_transaction] - Array of transaction types for
619
- * filtering credit note reports.
620
- * @property {string[]} [issuance_channel] - Array of issuance channels for
621
- * filtering credit note reports.
622
- */
623
- /**
624
- * @typedef CnGenerateReport
625
- * @property {number} [page] - Page number of the credit note report.
626
- * @property {string} [end_date] - End date for filtering credit note data.
627
- * @property {number} [page_size] - Number of items per page in the credit note report.
628
- * @property {CnGenerateReportFilters} [filters]
629
- * @property {string} [affiliate_id] - The unique identifier of sale channels or
630
- * application as affiliate_id associated with the seller.
631
- * @property {GenerateReportFilters} [meta]
632
- * @property {string} [search] - Search query to filter credit note data by keyword.
633
- * @property {string} [report_id] - Unique identifier for the credit note report.
634
- * @property {string} [search_type] - Type of search criteria used for filtering
635
- * credit note data.
636
- * @property {string} [start_date] - Start date for filtering credit note data.
637
- */
638
- /**
639
- * @typedef GenerateReportCustomerCnReq
640
- * @property {CnGenerateReport} [data]
641
- */
642
- /**
643
- * @typedef CnGenerateReportItems
644
- * @property {string} [expiry_date] - Expiry date of the credit note item.
645
- * @property {string} [status] - Status of the credit note item.
646
- * @property {number} [total_amount] - Total amount of the credit note item.
647
- * @property {string} [order_id] - Order ID of the order associated with the
648
- * credit note item.
649
- * @property {string} [date_issued] - Date when the credit note item was issued.
650
- * @property {string} [shipment_id] - Shipment ID of the order associated with
651
- * the credit note item.
652
- * @property {string} [invoice_number] - Invoice number associated with the
653
- * credit note item.
654
- * @property {string} [credit_note_number] - Unique number of the credit note item.
655
- */
656
- /**
657
- * @typedef GenerateReportCustomerCnResponseData
658
- * @property {boolean} [success] - Indicates if the credit note report
659
- * generation was successful.
660
- * @property {string} [message] - Additional message or information related to
661
- * the credit note report.
662
- * @property {CnGenerateReportItems[]} [items] - List of credit note items in the report.
663
- * @property {Object} [row_header_display_order] - Display order for row headers
664
- * in the report.
665
- * @property {string} [end_date] - End date used in the credit note report.
666
- * @property {Page} [page]
667
- * @property {string[]} [headers] - Headers included in the credit note report.
668
- * @property {string[]} [primary_headers] - Primary headers used in the credit
669
- * note report.
670
- * @property {string[]} [allowed_filters] - Allowed filters for the credit note report.
671
- * @property {string} [start_date] - Start date used in the credit note report.
672
- * @property {number} [item_count] - Total count of credit note items in the report.
673
- */
674
- /**
675
- * @typedef GenerateReportCustomerCnResponse
676
- * @property {GenerateReportCustomerCnResponseData} [data]
677
- */
678
- /**
679
- * @typedef CnDownloadReport
680
- * @property {number} [page] - Page number of the download report.
681
- * @property {string} [start_date] - Start date for filtering credit note data
682
- * in the report.
683
- * @property {string} [end_date] - End date for filtering credit note data in the report.
684
- * @property {string} [affiliate_id] - The unique identifier of sale channels or
685
- * application as affiliate_id associated with the seller.
686
- * @property {string} [search] - Search query to filter credit note data by keyword.
687
- * @property {string} [status] - Status of the credit note data in the report.
688
- * @property {string} [search_type] - Type of search criteria used for filtering
689
- * credit note data.
690
- * @property {number} [page_size] - Number of items per page in the download report.
691
- */
692
- /**
693
- * @typedef DownloadReportCustomerCnReq
694
- * @property {CnDownloadReport} [data]
695
- */
696
- /**
697
- * @typedef DownloadReportResponseData
698
- * @property {string} [report_config_id] - Unique identifier for the report configuration.
699
- * @property {string} [full_name] - Full name associated with the report request.
700
- * @property {string} [requested_by] - User who requested the report.
701
- * @property {string} [start_date] - Start date used in the report.
702
- * @property {string} [end_date] - End date used in the report.
703
- * @property {Object} [request_dict] - Dictionary containing request parameters
704
- * for the report.
705
- * @property {string} [download_link] - Download link for accessing the generated report.
706
- * @property {string} [created_at] - Date and time when the report was created.
707
- * @property {Object} [meta] - Additional metadata associated with the report.
708
- * @property {string} [msg] - Message related to the report status or generation.
709
- * @property {string} [report_name] - Name of the generated report.
710
- * @property {string} [status] - Status of the report.
711
- * @property {string} [display_name] - Display name of the report.
712
- * @property {Object} [filters] - Filters applied to generate the report.
713
- */
714
- /**
715
- * @typedef DownloadReportCustomerCnResponse
716
- * @property {DownloadReportResponseData[]} [items] - List of download report data items.
717
- * @property {number} [item_count] - Total count of items in the download report.
718
- * @property {Page} [page]
719
- */
720
- /**
721
- * @typedef GetReportingFilters
722
- * @property {string} [text] - Display text for the filter.
723
- * @property {string} [type] - Type of the fields like seach, filter(e.g.,
724
- * single, multi select).
725
- * @property {Object[]} [options] - Options available for the filter.
726
- * @property {string} [value] - Value to be pass in response select from options.
727
- */
728
- /**
729
- * @typedef GetReportingNestedFilters
730
- * @property {string} [text] - Display text for the nested filter.
731
- * @property {Object[]} [options] - Options available for the nested filter.
732
- * @property {boolean} [required] - Indicates if the nested filter is required.
733
- * @property {string} [placeholder_text] - Placeholder text for the nested filter.
734
- * @property {string} [type] - Type of the nested filter (e.g., single, multi select).
735
- * @property {string} [value] - Value to be pass in response select from options.
736
- */
737
- /**
738
- * @typedef GetReportingFiltersReasonOptions
739
- * @property {string} [text] - Display text for the reason option.
740
- * @property {string} [value] - Value of the reason option.
741
- * @property {string} [placeholder_text] - Placeholder text for the reason option.
742
- */
743
- /**
744
- * @typedef GetReportingFiltersReason
745
- * @property {string} [text] - Display text for the reason.
746
- * @property {string} [type] - Type of the reason.
747
- * @property {string} [value] - Value to be pass in response.
748
- * @property {GetReportingFiltersReasonOptions[]} [options] - Options available
749
- * for the reasons select from options.
750
- */
751
- /**
752
- * @typedef GetReportingFiltersResponse
753
- * @property {GetReportingFiltersReason} [reason]
754
- * @property {GetReportingFilters} [search]
755
- * @property {GetReportingNestedFilters[]} [filters] - Array of nested filter objects.
756
- * @property {GetReportingFilters} [status]
757
- */
758
- /**
759
- * @typedef InvoicePaymentOptionsPayloadData
760
- * @property {string[]} [invoice_numbers] - List of invoice numbers for which
761
- * payment options are being requested.
762
- */
763
- /**
764
- * @typedef InvoicePaymentOptionsReq
765
- * @property {InvoicePaymentOptionsPayloadData} [data]
766
- */
767
- /**
768
- * @typedef InvoicePaymentOptionsResponsePayableAmounts
769
- * @property {number} [amount] - Amount that is payable for the invoice.
770
- * @property {string} [amount_key] - Key associated with the payable amount for
771
- * identification.
772
- * @property {string} [header] - Header describing the payable amount.
773
- */
774
- /**
775
- * @typedef InvoicePaymentOptionsResponseDeductedAmounts
776
- * @property {number} [amount] - Amount deducted from the invoice.
777
- * @property {string} [header] - Header describing the deducted amount.
778
- * @property {string} [amount_key] - Key associated with the deducted amount for
779
- * identification.
780
- * @property {boolean} [is_payable] - Indicates whether the deducted amount is payable.
781
- * @property {string} [symbol] - Currency symbol associated with the deducted amount.
782
- */
783
- /**
784
- * @typedef InvoicePaymentOptionsResponseData
785
- * @property {string} [invoice_number] - Invoice number for which payment
786
- * options are provided.
787
- * @property {string} [invoice_type] - Type of the invoice (e.g., 'Seller Fynd',
788
- * 'Platform Subscription').
789
- * @property {InvoicePaymentOptionsResponsePayableAmounts[]} [display_amounts]
790
- * - List of amounts that are payable for the invoice.
791
- *
792
- * @property {Object} [total_amount] - Total amount for the invoice.
793
- * @property {Object} [deducted_amounts] - Amounts deducted from the total,
794
- * including any associated details.
795
- * @property {InvoicePaymentOptionsResponsePayableAmounts[]} [payable_amounts]
796
- * - Amounts that are payable for the invoice.
797
- *
798
- * @property {Currency} [currency]
799
- */
800
- /**
801
- * @typedef InvoicePaymentOptionsResponse
802
- * @property {string} [reason] - Reason for the response or any errors encountered.
803
- * @property {InvoicePaymentOptionsResponseData[]} [data] - List of data objects
804
- * containing details about invoice payment options.
805
- * @property {number} [total_payable_amount] - Total amount payable for the invoices.
806
- * @property {number} [invoice_count] - Number of invoices included in the response.
807
- * @property {boolean} [success] - Indicates whether the request to retrieve
808
- * invoice payment options was successful.
809
- */
810
- /**
811
- * @typedef PaymentDetail
812
- * @property {string} [display_name] - Name or label displayed for the payment detail.
813
- * @property {string} [value] - Value associated with the payment detail (e.g.,
814
- * amount, transaction ID).
815
- */
816
- /**
817
- * @typedef PaidInvoicePaymentDetail
818
- * @property {PaymentDetail[]} [payment_details] - List of payment details for
819
- * the invoice.
820
- * @property {string} [date_of_payment] - Date when the payment was made.
821
- * @property {number} [amount] - Amount paid towards the invoice.
822
- */
823
- /**
824
- * @typedef InvoicePaymentDetailsResponseData
825
- * @property {PaidInvoicePaymentDetail[]} [paid_invoice_payment_details] - List
826
- * of details for paid invoices.
827
- * @property {Object[]} [failed_attempts_details] - Details of any failed
828
- * payment attempts for the invoices.
829
- */
830
- /**
831
- * @typedef InvoicePaymentDetailsResponse
832
- * @property {string} [reason] - Reason for the response or any errors encountered.
833
- * @property {InvoicePaymentDetailsResponseData} [data]
834
- * @property {boolean} [success] - Indicates whether the request to retrieve
835
- * invoice payment details was successful.
836
- * @property {boolean} [payment_details_visible] - Indicates whether payment
837
- * details are visible or hidden in the response.
838
- */
839
- /**
840
- * @typedef InvoiceActivityLogsResponseData
841
- * @property {string} [performed_by] - Identifier of the user or system that
842
- * performed the activity.
843
- * @property {string} [status] - Status of the activity (e.g., 'Completed', 'Pending').
844
- * @property {string} [reason] - Reason for the activity status or any related notes.
845
- * @property {boolean} [is_resolved] - Indicates whether the activity issue is resolved.
846
- * @property {number} [retry_attempts] - Number of retry attempts made for the activity.
847
- * @property {number} [max_retry_attempts] - Maximum number of retry attempts
848
- * allowed for the activity.
849
- */
850
- /**
851
- * @typedef InvoiceActivityLogsResponse
852
- * @property {InvoiceActivityLogsResponseData[]} [data] - List of activity logs
853
- * related to invoices.
854
- */
855
- /**
856
- * @typedef InvoiceActivityLogError
857
- * @property {string} [reason] - Reason for the error or issue encountered with
858
- * the invoice activity logs.
859
- */
860
- /**
861
- * @typedef UnlockCreditNoteRequestData
862
- * @property {string} [seller_id] - The unique identifier for the seller.
863
- * @property {string[]} [locked_credit_notes] - A list of credit notes that are locked.
864
- * @property {string} [unlock_reason] - The reason for unlocking the credit notes.
865
- * @property {string} [description] - Additional details or comments about the
866
- * unlock request.
867
- */
868
- /**
869
- * @typedef UnlockCreditNoteReq
870
- * @property {UnlockCreditNoteRequestData} [data]
871
- */
872
- /**
873
- * @typedef UnlockCreditNoteResponseData
874
- * @property {boolean} [is_cn_unlocked] - Indicates whether the credit note is unlocked.
875
- * @property {string} [status] - The current status of the each credit notes.
876
- */
877
- /**
878
- * @typedef UnlockCreditNoteResponse
879
- * @property {boolean} [success] - Indicates whether the credit note unlock
880
- * request was successful.
881
- * @property {UnlockCreditNoteResponseData} [data]
882
- */
883
- declare class FinancePlatformModel {
884
- }
885
- declare namespace FinancePlatformModel {
886
- export { OrederFreezeResponse, GenerateReportMeta, GenerateReportFilters, GenerateReportPlatform, GenerateReportReq, Page, Currency, GenerateReportJson, Error, ErrorMeta, ErrorMetaItems, DownloadReport, DownloadReportData, DownloadReportItems, DownloadReportList, GetEngineFilters, GetEngineData, GetEngineReq, GetEngineResponse, GetReason, GetReasonReq, ReasonItem, GetReasonResponse, GetReportListData, GetReportListReq, GetReportListResponse, ReportItem, GetAffiliate, GetAffiliateResponse, DownloadCreditDebitNote, DownloadCreditDebitNoteReq, DownloadCreditDebitNoteResponseData, DownloadCreditDebitNoteResponse, InvoiceBillingItem, PaymentProcessPayload, PaymentProcessReq, PaymentProcessResponse, CreditlineDataPlatformPayload, CreditlineDataPlatformReq, CreditlineDataPlatformResponse, IsCreditlinePayload, IsCreditlinePlatformReq, IsCreditlinePlatformResponse, InvoiceTypePayloadData, InvoiceTypeReq, InvoiceTypeResponseItems, InvoiceTypeResponse, InoviceListingPayloadDataFilters, InvoiceListingPayloadData, InvoiceListingReq, UnpaidInvoiceDataItems, InvoiceListingResponseItems, InvoiceListingResponse, InvoicePdfPayloadData, InvoicePdfReq, InvoicePdfResponse, IsCnRefundMethodData, IsCnRefundMethodReq, IsCnRefundMethodResponseData, IsCnRefundMethodResponse, CreditNoteConfigNotificationEvents, CreateSellerCreditNoteConfig, CreateSellerCreditNoteConfigReq, CreateSellerCreditNoteConfigResponse, DeleteConfig, DeleteConfigReq, DeleteConfigResponse, ChannelDisplayNameItems, ChannelDisplayNameResponse, CnReferenceNumber, GetPdfUrlViewReq, GetPdfUrlViewResponseData, GetPdfUrlViewResponse, CreditNoteDetailsReq, CnDetails, RedemptionDetails, CreditNoteDetails, CreditNoteDetailsResponse, GetCustomerCreditBalance, GetCustomerCreditBalanceReq, GetCustomerCreditBalanceResponseData, GetCustomerCreditBalanceResponse, GetCnConfigReq, GetCnConfigResponseMeta, GetCnConfigResponseData, GetCnConfigResponse, CnGenerateReportFilters, CnGenerateReport, GenerateReportCustomerCnReq, CnGenerateReportItems, GenerateReportCustomerCnResponseData, GenerateReportCustomerCnResponse, CnDownloadReport, DownloadReportCustomerCnReq, DownloadReportResponseData, DownloadReportCustomerCnResponse, GetReportingFilters, GetReportingNestedFilters, GetReportingFiltersReasonOptions, GetReportingFiltersReason, GetReportingFiltersResponse, InvoicePaymentOptionsPayloadData, InvoicePaymentOptionsReq, InvoicePaymentOptionsResponsePayableAmounts, InvoicePaymentOptionsResponseDeductedAmounts, InvoicePaymentOptionsResponseData, InvoicePaymentOptionsResponse, PaymentDetail, PaidInvoicePaymentDetail, InvoicePaymentDetailsResponseData, InvoicePaymentDetailsResponse, InvoiceActivityLogsResponseData, InvoiceActivityLogsResponse, InvoiceActivityLogError, UnlockCreditNoteRequestData, UnlockCreditNoteReq, UnlockCreditNoteResponseData, UnlockCreditNoteResponse };
887
- }
888
- /** @returns {OrederFreezeResponse} */
889
- declare function OrederFreezeResponse(): OrederFreezeResponse;
890
- type OrederFreezeResponse = {
891
- /**
892
- * - Indicates whether the operation was successful or not.
893
- */
894
- success?: boolean;
895
- /**
896
- * - Flag indicating if the system is frozen
897
- * for order management.
898
- */
899
- oms_freeze?: boolean;
900
- /**
901
- * - Optional field indicating the data source of
902
- * the information.
903
- */
904
- source?: string;
905
- };
906
- /** @returns {GenerateReportMeta} */
907
- declare function GenerateReportMeta(): GenerateReportMeta;
908
- type GenerateReportMeta = {
909
- /**
910
- * - The brand name associated with the report meta
911
- * information.
912
- */
913
- brand?: string;
914
- /**
915
- * - The company name associated with the report
916
- * meta information.
917
- */
918
- company?: string;
919
- /**
920
- * - The sale channel name associated with seller.
921
- */
922
- channel?: string;
923
- };
924
- /** @returns {GenerateReportFilters} */
925
- declare function GenerateReportFilters(): GenerateReportFilters;
926
- type GenerateReportFilters = {
927
- /**
928
- * - An array of brand names to filter the report data.
929
- */
930
- brand?: string[];
931
- /**
932
- * - An array of company id to filter the report data.
933
- */
934
- company?: string[];
935
- /**
936
- * - An array of sale channel names associated
937
- * with seller to filter the report data.
938
- */
939
- channel?: string[];
940
- };
941
- /** @returns {GenerateReportPlatform} */
942
- declare function GenerateReportPlatform(): GenerateReportPlatform;
943
- type GenerateReportPlatform = {
944
- /**
945
- * - The start date to generate report specific preiod.
946
- */
947
- start_date?: string;
948
- /**
949
- * - The end date to generate report specific preiod.
950
- */
951
- end_date?: string;
952
- meta?: GenerateReportMeta;
953
- /**
954
- * - The unique identifier of the generate report
955
- * where different report configure.
956
- */
957
- report_id?: string;
958
- filters?: GenerateReportFilters;
959
- };
960
- /** @returns {GenerateReportReq} */
961
- declare function GenerateReportReq(): GenerateReportReq;
962
- type GenerateReportReq = {
963
- data?: GenerateReportPlatform;
964
- };
965
- /** @returns {Page} */
966
- declare function Page(): Page;
967
- type Page = {
968
- /**
969
- * - The total number of items on the page.
970
- */
971
- item_total?: number;
972
- /**
973
- * - The identifier for the next page.
974
- */
975
- next_id?: string;
976
- /**
977
- * - Indicates whether there is a previous page.
978
- */
979
- has_previous?: boolean;
980
- /**
981
- * - Indicates whether there is a next page.
982
- */
983
- has_next?: boolean;
984
- /**
985
- * - The current page number.
986
- */
987
- current?: number;
988
- /**
989
- * - The type of the page, such as 'PageType'.
990
- */
991
- type: string;
992
- /**
993
- * - The number of items per page.
994
- */
995
- size?: number;
996
- };
997
- /** @returns {Currency} */
998
- declare function Currency(): Currency;
999
- type Currency = {
1000
- /**
1001
- * - The unique currency code.
1002
- */
1003
- code?: string;
1004
- /**
1005
- * - The unique currency symbol.
1006
- */
1007
- symbol?: string;
1008
- /**
1009
- * - The unique currency name.
1010
- */
1011
- name?: string;
1012
- };
1013
- /** @returns {GenerateReportJson} */
1014
- declare function GenerateReportJson(): GenerateReportJson;
1015
- type GenerateReportJson = {
1016
- data?: any;
1017
- /**
1018
- * - Total number of items in the report.
1019
- */
1020
- item_count?: number;
1021
- page?: Page;
1022
- /**
1023
- * - The end date to generate report specific preiod.
1024
- */
1025
- end_date?: string;
1026
- /**
1027
- * - The start date to generate report specific preiod.
1028
- */
1029
- start_date?: string;
1030
- /**
1031
- * - Nested array structure representing report
1032
- * items or data.
1033
- */
1034
- items?: string[][];
1035
- /**
1036
- * - Headers describing each item in the report data.
1037
- */
1038
- headers?: string[];
1039
- };
1040
- /** @returns {Error} */
1041
- declare function Error(): Error;
1042
- type Error = {
1043
- status?: number;
1044
- reason?: string;
1045
- success?: boolean;
1046
- message?: string;
1047
- code?: string;
1048
- exception?: string;
1049
- info?: string;
1050
- request_id?: string;
1051
- stack_trace?: string;
1052
- meta?: ErrorMeta;
1053
- };
1054
- /** @returns {ErrorMeta} */
1055
- declare function ErrorMeta(): ErrorMeta;
1056
- type ErrorMeta = {
1057
- columns_errors?: ErrorMetaItems[];
1058
- };
1059
- /** @returns {ErrorMetaItems} */
1060
- declare function ErrorMetaItems(): ErrorMetaItems;
1061
- type ErrorMetaItems = {
1062
- code?: number;
1063
- message?: string;
1064
- };
1065
- /** @returns {DownloadReport} */
1066
- declare function DownloadReport(): DownloadReport;
1067
- type DownloadReport = {
1068
- data?: DownloadReportData;
1069
- };
1070
- /** @returns {DownloadReportData} */
1071
- declare function DownloadReportData(): DownloadReportData;
1072
- type DownloadReportData = {
1073
- /**
1074
- * - The current page number of the report.
1075
- */
1076
- page?: number;
1077
- /**
1078
- * - The number of items displayed per page.
1079
- */
1080
- page_size?: number;
1081
- /**
1082
- * - The start date for fetching the report
1083
- * history for download.
1084
- */
1085
- start_date?: string;
1086
- /**
1087
- * - The end date for fetching the report history
1088
- * for download.
1089
- */
1090
- end_date?: string;
1091
- };
1092
- /** @returns {DownloadReportItems} */
1093
- declare function DownloadReportItems(): DownloadReportItems;
1094
- type DownloadReportItems = {
1095
- /**
1096
- * - The start date for the report item.
1097
- */
1098
- start_date?: string;
1099
- /**
1100
- * - The end date for the report item.
1101
- */
1102
- end_date?: string;
1103
- meta?: GenerateReportMeta;
1104
- /**
1105
- * - The unique identifier of the report item.
1106
- */
1107
- report_id?: string;
1108
- filters?: GenerateReportFilters;
1109
- };
1110
- /** @returns {DownloadReportList} */
1111
- declare function DownloadReportList(): DownloadReportList;
1112
- type DownloadReportList = {
1113
- /**
1114
- * - A list of report items available
1115
- * for download.
1116
- */
1117
- items?: DownloadReportItems[];
1118
- page?: Page;
1119
- /**
1120
- * - The total number of items in the report list.
1121
- */
1122
- item_count?: number;
1123
- };
1124
- /** @returns {GetEngineFilters} */
1125
- declare function GetEngineFilters(): GetEngineFilters;
1126
- type GetEngineFilters = {
1127
- /**
1128
- * - The configuration field used for filtering.
1129
- */
1130
- config_field?: string;
1131
- /**
1132
- * - The status used for filtering.
1133
- */
1134
- status?: string;
1135
- /**
1136
- * - Flag indicating if the filter is active.
1137
- */
1138
- is_active?: boolean;
1139
- /**
1140
- * - The seller ID used for filtering.
1141
- */
1142
- seller_id?: string;
1143
- };
1144
- /** @returns {GetEngineData} */
1145
- declare function GetEngineData(): GetEngineData;
1146
- type GetEngineData = {
1147
- /**
1148
- * - Status of the request.
1149
- */
1150
- status?: string;
1151
- filters?: GetEngineFilters;
1152
- /**
1153
- * - A list of fields to get data from tables.
1154
- */
1155
- project?: string[];
1156
- /**
1157
- * - The name of the table from which to retrieve data.
1158
- */
1159
- table_name?: string;
1160
- /**
1161
- * - Search criteria for querying on given table
1162
- * specific fields.
1163
- */
1164
- search?: any;
1165
- /**
1166
- * - The current page number for pagination.
1167
- */
1168
- page?: number;
1169
- /**
1170
- * - The number of items displayed per page.
1171
- */
1172
- page_size?: number;
1173
- /**
1174
- * - The field by which to order the results.
1175
- */
1176
- order_by?: string;
1177
- };
1178
- /** @returns {GetEngineReq} */
1179
- declare function GetEngineReq(): GetEngineReq;
1180
- type GetEngineReq = {
1181
- data?: GetEngineData;
1182
- };
1183
- /** @returns {GetEngineResponse} */
1184
- declare function GetEngineResponse(): GetEngineResponse;
1185
- type GetEngineResponse = {
1186
- /**
1187
- * - Indicates whether the request was successful.
1188
- */
1189
- success?: boolean;
1190
- /**
1191
- * - A list of items returned by the request.
1192
- */
1193
- items?: any[];
1194
- page?: Page;
1195
- /**
1196
- * - The total number of items returned by the request.
1197
- */
1198
- item_count?: number;
1199
- };
1200
- /** @returns {GetReason} */
1201
- declare function GetReason(): GetReason;
1202
- type GetReason = {
1203
- /**
1204
- * - The type of reason associated with the request.
1205
- */
1206
- reason_type?: string;
1207
- };
1208
- /** @returns {GetReasonReq} */
1209
- declare function GetReasonReq(): GetReasonReq;
1210
- type GetReasonReq = {
1211
- data?: GetReason;
1212
- };
1213
- /** @returns {ReasonItem} */
1214
- declare function ReasonItem(): ReasonItem;
1215
- type ReasonItem = {
1216
- /**
1217
- * - Id of the reason for reason_type.
1218
- */
1219
- id?: string;
1220
- /**
1221
- * - Code of the reason for reason_type.
1222
- */
1223
- name?: string;
1224
- /**
1225
- * - Display name of the reason for reason_type.
1226
- */
1227
- display_name?: string;
1228
- };
1229
- /** @returns {GetReasonResponse} */
1230
- declare function GetReasonResponse(): GetReasonResponse;
1231
- type GetReasonResponse = {
1232
- /**
1233
- * - Indicates whether the request was successfull.
1234
- */
1235
- success?: boolean;
1236
- /**
1237
- * - The list of items returned in the response.
1238
- */
1239
- item_list?: ReasonItem[];
1240
- /**
1241
- * - The number of items in the response.
1242
- */
1243
- item_count?: number;
1244
- page?: Page;
1245
- };
1246
- /** @returns {GetReportListData} */
1247
- declare function GetReportListData(): GetReportListData;
1248
- type GetReportListData = {
1249
- /**
1250
- * - The name of the role requesting the report list.
1251
- */
1252
- role_name?: string;
1253
- /**
1254
- * - Indicates whether listing is enabled
1255
- * for the role.
1256
- */
1257
- listing_enabled?: boolean;
1258
- };
1259
- /** @returns {GetReportListReq} */
1260
- declare function GetReportListReq(): GetReportListReq;
1261
- type GetReportListReq = {
1262
- data?: GetReportListData;
1263
- };
1264
- /** @returns {GetReportListResponse} */
1265
- declare function GetReportListResponse(): GetReportListResponse;
1266
- type GetReportListResponse = {
1267
- /**
1268
- * - Indicates whether the request was successful.
1269
- */
1270
- success?: boolean;
1271
- /**
1272
- * - The list of report items.
1273
- */
1274
- items?: ReportItem[];
1275
- page?: Page;
1276
- /**
1277
- * - The total number of items in the report list.
1278
- */
1279
- total_count?: number;
1280
- };
1281
- /** @returns {ReportItem} */
1282
- declare function ReportItem(): ReportItem;
1283
- type ReportItem = {
1284
- /**
1285
- * - The unique identifier for the report item.
1286
- */
1287
- id?: string;
1288
- /**
1289
- * - The name of the report item.
1290
- */
1291
- name?: string;
1292
- /**
1293
- * - A brief description of the report item.
1294
- */
1295
- description?: string;
1296
- /**
1297
- * - The filters that can be applied to
1298
- * the report item.
1299
- */
1300
- allowed_filters?: string[];
1301
- /**
1302
- * - Metadata related to the report item configuration.
1303
- */
1304
- config_meta?: any;
1305
- /**
1306
- * - The type of the report item.
1307
- */
1308
- report_type?: string;
1309
- /**
1310
- * - The display date of the report item, if applicable.
1311
- */
1312
- display_date?: string;
1313
- };
1314
- /** @returns {GetAffiliate} */
1315
- declare function GetAffiliate(): GetAffiliate;
1316
- type GetAffiliate = {
1317
- /**
1318
- * - The unique identifier of the company
1319
- * associated with the affiliate.
1320
- */
1321
- company_id?: number;
1322
- };
1323
- /** @returns {GetAffiliateResponse} */
1324
- declare function GetAffiliateResponse(): GetAffiliateResponse;
1325
- type GetAffiliateResponse = {
1326
- /**
1327
- * - The reason for the response, if applicable.
1328
- */
1329
- reason?: string;
1330
- /**
1331
- * - Indicates whether the request was successful.
1332
- */
1333
- success?: boolean;
1334
- /**
1335
- * - List of items or data related to the affiliate.
1336
- */
1337
- docs?: any[];
1338
- };
1339
- /** @returns {DownloadCreditDebitNote} */
1340
- declare function DownloadCreditDebitNote(): DownloadCreditDebitNote;
1341
- type DownloadCreditDebitNote = {
1342
- /**
1343
- * - List of unique identifiers for the
1344
- * credit/debit notes to be download.
1345
- */
1346
- note_id?: string[];
1347
- };
1348
- /** @returns {DownloadCreditDebitNoteReq} */
1349
- declare function DownloadCreditDebitNoteReq(): DownloadCreditDebitNoteReq;
1350
- type DownloadCreditDebitNoteReq = {
1351
- data?: DownloadCreditDebitNote;
1352
- };
1353
- /** @returns {DownloadCreditDebitNoteResponseData} */
1354
- declare function DownloadCreditDebitNoteResponseData(): DownloadCreditDebitNoteResponseData;
1355
- type DownloadCreditDebitNoteResponseData = {
1356
- /**
1357
- * - The unique identifier of the download credit/debit note.
1358
- */
1359
- id?: string;
1360
- /**
1361
- * - The URL where the PDF of the credit/debit
1362
- * note is stored.
1363
- */
1364
- pdf_s3_url?: string;
1365
- };
1366
- /** @returns {DownloadCreditDebitNoteResponse} */
1367
- declare function DownloadCreditDebitNoteResponse(): DownloadCreditDebitNoteResponse;
1368
- type DownloadCreditDebitNoteResponse = {
1369
- /**
1370
- * - Indicates whether the request to download the
1371
- * credit/debit notes was successful.
1372
- */
1373
- success?: boolean;
1374
- /**
1375
- * - List of
1376
- * credit/debit notes download data.
1377
- */
1378
- data?: DownloadCreditDebitNoteResponseData[];
1379
- };
1380
- /** @returns {InvoiceBillingItem} */
1381
- declare function InvoiceBillingItem(): InvoiceBillingItem;
1382
- type InvoiceBillingItem = {
1383
- /**
1384
- * - The number of the invoice associated
1385
- * with the billing item.
1386
- */
1387
- invoice_number?: string;
1388
- /**
1389
- * - The amount of the billing item.
1390
- */
1391
- amount?: number;
1392
- };
1393
- /** @returns {PaymentProcessPayload} */
1394
- declare function PaymentProcessPayload(): PaymentProcessPayload;
1395
- type PaymentProcessPayload = {
1396
- /**
1397
- * - The platform through which the payment is processed.
1398
- */
1399
- platform?: string;
1400
- /**
1401
- * - The total amount to be processed in the payment.
1402
- */
1403
- amount?: number;
1404
- /**
1405
- * - The type of transaction (e.g., seller_online).
1406
- */
1407
- transaction_type?: string;
1408
- /**
1409
- * - The reference for the source of the payment.
1410
- */
1411
- source_reference?: string;
1412
- /**
1413
- * - The total amount to be processed in the payment.
1414
- */
1415
- total_amount?: number;
1416
- /**
1417
- * - Additional metadata related to the payment.
1418
- */
1419
- meta?: any;
1420
- /**
1421
- * - The currency in which the payment is made.
1422
- */
1423
- currency?: string;
1424
- /**
1425
- * - The unique identifier for the seller
1426
- * receiving the payment.
1427
- */
1428
- seller_id?: string;
1429
- /**
1430
- * - The mode of payment (e.g., online).
1431
- */
1432
- mode_of_payment?: string;
1433
- invoice_billing_items?: InvoiceBillingItem[];
1434
- };
1435
- /** @returns {PaymentProcessReq} */
1436
- declare function PaymentProcessReq(): PaymentProcessReq;
1437
- type PaymentProcessReq = {
1438
- data?: PaymentProcessPayload;
1439
- };
1440
- /** @returns {PaymentProcessResponse} */
1441
- declare function PaymentProcessResponse(): PaymentProcessResponse;
1442
- type PaymentProcessResponse = {
1443
- /**
1444
- * - Response code indicating the status of the payment process.
1445
- */
1446
- code?: number;
1447
- /**
1448
- * - A message providing additional information
1449
- * about the payment process response.
1450
- */
1451
- message?: string;
1452
- /**
1453
- * - Additional metadata related to the payment
1454
- * process response.
1455
- */
1456
- meta?: any;
1457
- /**
1458
- * - The unique identifier for the payment
1459
- * transaction.
1460
- */
1461
- transaction_id?: string;
1462
- /**
1463
- * - URL to redirect the user to complete the
1464
- * payment process, if applicable.
1465
- */
1466
- redirect_url?: string;
1467
- };
1468
- /** @returns {CreditlineDataPlatformPayload} */
1469
- declare function CreditlineDataPlatformPayload(): CreditlineDataPlatformPayload;
1470
- type CreditlineDataPlatformPayload = {
1471
- /**
1472
- * - The page number for pagination.
1473
- */
1474
- page?: number;
1475
- /**
1476
- * - The unique identifier for the seller.
1477
- */
1478
- seller_id?: string;
1479
- /**
1480
- * - The end date for the query.
1481
- */
1482
- end_date?: string;
1483
- /**
1484
- * - The start date for the query.
1485
- */
1486
- start_date?: string;
1487
- /**
1488
- * - The number of items per page.
1489
- */
1490
- page_size?: number;
1491
- };
1492
- /** @returns {CreditlineDataPlatformReq} */
1493
- declare function CreditlineDataPlatformReq(): CreditlineDataPlatformReq;
1494
- type CreditlineDataPlatformReq = {
1495
- data?: CreditlineDataPlatformPayload;
1496
- };
1497
- /** @returns {CreditlineDataPlatformResponse} */
1498
- declare function CreditlineDataPlatformResponse(): CreditlineDataPlatformResponse;
1499
- type CreditlineDataPlatformResponse = {
1500
- /**
1501
- * - The list of items in the response.
1502
- */
1503
- items?: any[];
1504
- /**
1505
- * - The response status code.
1506
- */
1507
- code?: number;
1508
- /**
1509
- * - A flag indicating whether to show MR (some
1510
- * specific field).
1511
- */
1512
- show_mr?: boolean;
1513
- page?: Page;
1514
- /**
1515
- * - The response message.
1516
- */
1517
- message?: string;
1518
- /**
1519
- * - The list of response headers.
1520
- */
1521
- headers?: string[];
1522
- /**
1523
- * - The total number of items.
1524
- */
1525
- item_count?: number;
1526
- };
1527
- /** @returns {IsCreditlinePayload} */
1528
- declare function IsCreditlinePayload(): IsCreditlinePayload;
1529
- type IsCreditlinePayload = {
1530
- /**
1531
- * - The unique identifier for the seller to
1532
- * check for credit line eligibility.
1533
- */
1534
- seller_id?: string;
1535
- };
1536
- /** @returns {IsCreditlinePlatformReq} */
1537
- declare function IsCreditlinePlatformReq(): IsCreditlinePlatformReq;
1538
- type IsCreditlinePlatformReq = {
1539
- data?: IsCreditlinePayload;
1540
- };
1541
- /** @returns {IsCreditlinePlatformResponse} */
1542
- declare function IsCreditlinePlatformResponse(): IsCreditlinePlatformResponse;
1543
- type IsCreditlinePlatformResponse = {
1544
- /**
1545
- * - Indicates whether the seller has
1546
- * opted for a credit line.
1547
- */
1548
- is_creditline_opted?: boolean;
1549
- /**
1550
- * - Response code indicating the status of the credit
1551
- * line check.
1552
- */
1553
- code?: number;
1554
- };
1555
- /** @returns {InvoiceTypePayloadData} */
1556
- declare function InvoiceTypePayloadData(): InvoiceTypePayloadData;
1557
- type InvoiceTypePayloadData = {
1558
- /**
1559
- * - Indicates if the invoice type is active.
1560
- */
1561
- is_active?: boolean;
1562
- };
1563
- /** @returns {InvoiceTypeReq} */
1564
- declare function InvoiceTypeReq(): InvoiceTypeReq;
1565
- type InvoiceTypeReq = {
1566
- data?: InvoiceTypePayloadData;
1567
- };
1568
- /** @returns {InvoiceTypeResponseItems} */
1569
- declare function InvoiceTypeResponseItems(): InvoiceTypeResponseItems;
1570
- type InvoiceTypeResponseItems = {
1571
- /**
1572
- * - The text description of the invoice type.
1573
- */
1574
- text?: string;
1575
- /**
1576
- * - The value or code representing the invoice type.
1577
- */
1578
- value?: string;
1579
- };
1580
- /** @returns {InvoiceTypeResponse} */
1581
- declare function InvoiceTypeResponse(): InvoiceTypeResponse;
1582
- type InvoiceTypeResponse = {
1583
- /**
1584
- * - Indicates whether the request was successful.
1585
- */
1586
- success?: boolean;
1587
- /**
1588
- * - List of invoice
1589
- * types available.
1590
- */
1591
- invoice_type_list?: InvoiceTypeResponseItems[];
1592
- /**
1593
- * - List of
1594
- * payment statuses available.
1595
- */
1596
- payment_status_list?: InvoiceTypeResponseItems[];
1597
- };
1598
- /** @returns {InoviceListingPayloadDataFilters} */
1599
- declare function InoviceListingPayloadDataFilters(): InoviceListingPayloadDataFilters;
1600
- type InoviceListingPayloadDataFilters = {
1601
- /**
1602
- * - List of payment statuses to filter by.
1603
- */
1604
- payment_status?: string[];
1605
- /**
1606
- * - List of invoice types to filter by.
1607
- */
1608
- invoice_type?: string[];
1609
- /**
1610
- * - List of company IDs to filter by.
1611
- */
1612
- company_id?: string[];
1613
- };
1614
- /** @returns {InvoiceListingPayloadData} */
1615
- declare function InvoiceListingPayloadData(): InvoiceListingPayloadData;
1616
- type InvoiceListingPayloadData = {
1617
- /**
1618
- * - The number of items per page for pagination.
1619
- */
1620
- page_size?: number;
1621
- /**
1622
- * - The page number for pagination.
1623
- */
1624
- page?: number;
1625
- /**
1626
- * - The start date for the invoice listing filter.
1627
- */
1628
- start_date?: string;
1629
- /**
1630
- * - The end date for the invoice listing filter.
1631
- */
1632
- end_date?: string;
1633
- /**
1634
- * - Search term for filtering invoices.
1635
- */
1636
- search?: string;
1637
- filters?: InoviceListingPayloadDataFilters;
1638
- };
1639
- /** @returns {InvoiceListingReq} */
1640
- declare function InvoiceListingReq(): InvoiceListingReq;
1641
- type InvoiceListingReq = {
1642
- data?: InvoiceListingPayloadData;
1643
- };
1644
- /** @returns {UnpaidInvoiceDataItems} */
1645
- declare function UnpaidInvoiceDataItems(): UnpaidInvoiceDataItems;
1646
- type UnpaidInvoiceDataItems = {
1647
- /**
1648
- * - The total count of unpaid invoices.
1649
- */
1650
- total_unpaid_invoice_count?: number;
1651
- /**
1652
- * - The currency used for unpaid invoices.
1653
- */
1654
- currency?: string;
1655
- /**
1656
- * - The total amount of unpaid invoices.
1657
- */
1658
- total_unpaid_amount?: number;
1659
- };
1660
- /** @returns {InvoiceListingResponseItems} */
1661
- declare function InvoiceListingResponseItems(): InvoiceListingResponseItems;
1662
- type InvoiceListingResponseItems = {
1663
- /**
1664
- * - The amount of the invoice.
1665
- */
1666
- amount?: number;
1667
- /**
1668
- * - The name of the company associated with the invoice.
1669
- */
1670
- company?: string;
1671
- /**
1672
- * - The current status of the invoice (e.g.,
1673
- * 'paid', 'unpaid').
1674
- */
1675
- status?: string;
1676
- /**
1677
- * - The due date of the invoice.
1678
- */
1679
- due_date?: string;
1680
- /**
1681
- * - The date when the invoice was issued.
1682
- */
1683
- invoice_date?: string;
1684
- /**
1685
- * - The type of invoice.
1686
- */
1687
- invoice_type?: string;
1688
- /**
1689
- * - The period covered by the invoice.
1690
- */
1691
- period?: string;
1692
- /**
1693
- * - The invoice number.
1694
- */
1695
- invoice_number?: string;
1696
- /**
1697
- * - Indicates if the invoice is available
1698
- * for download.
1699
- */
1700
- is_downloadable?: boolean;
1701
- /**
1702
- * - The unique identifier of the invoice.
1703
- */
1704
- invoice_id?: string;
1705
- currency?: Currency;
1706
- };
1707
- /** @returns {InvoiceListingResponse} */
1708
- declare function InvoiceListingResponse(): InvoiceListingResponse;
1709
- type InvoiceListingResponse = {
1710
- /**
1711
- * - Indicates whether the request was successful.
1712
- */
1713
- success?: boolean;
1714
- /**
1715
- * - Headers related to the invoice listing response.
1716
- */
1717
- headers?: string[];
1718
- unpaid_invoice_data?: UnpaidInvoiceDataItems;
1719
- /**
1720
- * - List of invoice items in
1721
- * the response.
1722
- */
1723
- items?: InvoiceListingResponseItems[];
1724
- page?: Page;
1725
- /**
1726
- * - The total number of invoice items in the response.
1727
- */
1728
- item_count?: number;
1729
- };
1730
- /** @returns {InvoicePdfPayloadData} */
1731
- declare function InvoicePdfPayloadData(): InvoicePdfPayloadData;
1732
- type InvoicePdfPayloadData = {
1733
- /**
1734
- * - List of invoice numbers for which
1735
- * PDFs are requested.
1736
- */
1737
- invoice_number?: string[];
1738
- };
1739
- /** @returns {InvoicePdfReq} */
1740
- declare function InvoicePdfReq(): InvoicePdfReq;
1741
- type InvoicePdfReq = {
1742
- data?: InvoicePdfPayloadData;
1743
- };
1744
- /** @returns {InvoicePdfResponse} */
1745
- declare function InvoicePdfResponse(): InvoicePdfResponse;
1746
- type InvoicePdfResponse = {
1747
- /**
1748
- * - Indicates whether the PDF generation request
1749
- * was successful.
1750
- */
1751
- success?: boolean;
1752
- /**
1753
- * - List of URLs or paths to the generated PDF files.
1754
- */
1755
- data?: string[];
1756
- /**
1757
- * - List of errors encountered while generating the PDFs.
1758
- */
1759
- error?: string[];
1760
- };
1761
- /** @returns {IsCnRefundMethodData} */
1762
- declare function IsCnRefundMethodData(): IsCnRefundMethodData;
1763
- type IsCnRefundMethodData = {
1764
- /**
1765
- * - The unique identifier of sale channels or
1766
- * application as affiliate_id associated with the seller.
1767
- */
1768
- affiliate_id?: string;
1769
- /**
1770
- * - Indicates whether editing the
1771
- * refund method is required.
1772
- */
1773
- toggle_edit_required?: boolean;
1774
- /**
1775
- * - Unique identifier for the seller.
1776
- */
1777
- seller_id?: number;
1778
- };
1779
- /** @returns {IsCnRefundMethodReq} */
1780
- declare function IsCnRefundMethodReq(): IsCnRefundMethodReq;
1781
- type IsCnRefundMethodReq = {
1782
- data?: IsCnRefundMethodData;
1783
- };
1784
- /** @returns {IsCnRefundMethodResponseData} */
1785
- declare function IsCnRefundMethodResponseData(): IsCnRefundMethodResponseData;
1786
- type IsCnRefundMethodResponseData = {
1787
- /**
1788
- * - Indicates whether the seller for
1789
- * specific sale channel is using the refund method for the first time.
1790
- */
1791
- is_first_time_user?: boolean;
1792
- };
1793
- /** @returns {IsCnRefundMethodResponse} */
1794
- declare function IsCnRefundMethodResponse(): IsCnRefundMethodResponse;
1795
- type IsCnRefundMethodResponse = {
1796
- /**
1797
- * - Indicates whether the request to determine
1798
- * the refund method was successful.
1799
- */
1800
- success?: boolean;
1801
- data?: IsCnRefundMethodResponseData;
1802
- };
1803
- /** @returns {CreditNoteConfigNotificationEvents} */
1804
- declare function CreditNoteConfigNotificationEvents(): CreditNoteConfigNotificationEvents;
1805
- type CreditNoteConfigNotificationEvents = {
1806
- /**
1807
- * - Number of days before
1808
- * the expiration date to send a reminder notification to the customer.
1809
- */
1810
- expiration_reminder_to_customer?: number;
1811
- };
1812
- /** @returns {CreateSellerCreditNoteConfig} */
1813
- declare function CreateSellerCreditNoteConfig(): CreateSellerCreditNoteConfig;
1814
- type CreateSellerCreditNoteConfig = {
1815
- /**
1816
- * - Indicates if the credit note
1817
- * is used as a refund method.
1818
- */
1819
- is_cn_as_refund_method?: boolean;
1820
- /**
1821
- * - The unique identifier of sale channels or
1822
- * application as affiliate_id associated with the seller.
1823
- */
1824
- affiliate_id?: string;
1825
- /**
1826
- * - List of source channels associated
1827
- * with the credit note configuration.
1828
- */
1829
- source_channel?: string[];
1830
- /**
1831
- * - Unique identifier for the seller.
1832
- */
1833
- seller_id?: number;
1834
- notification_events?: CreditNoteConfigNotificationEvents;
1835
- /**
1836
- * - Name of the sales channel.
1837
- */
1838
- sales_channel_name?: string;
1839
- /**
1840
- * - List of ordering channels
1841
- * associated with the credit note configuration.
1842
- */
1843
- ordering_channel?: string[];
1844
- /**
1845
- * - Validity period of the credit note in days.
1846
- */
1847
- validity?: number;
1848
- /**
1849
- * - Type of currency used for the credit note.
1850
- */
1851
- currency_type?: string;
1852
- /**
1853
- * - List of slug values associated with the
1854
- * credit note configuration.
1855
- */
1856
- slug_values?: string[];
1857
- };
1858
- /** @returns {CreateSellerCreditNoteConfigReq} */
1859
- declare function CreateSellerCreditNoteConfigReq(): CreateSellerCreditNoteConfigReq;
1860
- type CreateSellerCreditNoteConfigReq = {
1861
- data?: CreateSellerCreditNoteConfig;
1862
- };
1863
- /** @returns {CreateSellerCreditNoteConfigResponse} */
1864
- declare function CreateSellerCreditNoteConfigResponse(): CreateSellerCreditNoteConfigResponse;
1865
- type CreateSellerCreditNoteConfigResponse = {
1866
- /**
1867
- * - Indicates if the credit note configuration
1868
- * creation was successful.
1869
- */
1870
- success?: boolean;
1871
- /**
1872
- * - Additional information or message about the
1873
- * credit note configuration creation process.
1874
- */
1875
- message?: string;
1876
- };
1877
- /** @returns {DeleteConfig} */
1878
- declare function DeleteConfig(): DeleteConfig;
1879
- type DeleteConfig = {
1880
- /**
1881
- * - The unique identifier of sale channels or
1882
- * application as affiliate_id associated with the seller.
1883
- */
1884
- affiliate_id?: string;
1885
- /**
1886
- * - List of slug values associated with the
1887
- * credit note configuration.
1888
- */
1889
- slug_values?: string[];
1890
- /**
1891
- * - Unique identifier for the seller.
1892
- */
1893
- seller_id?: number;
1894
- };
1895
- /** @returns {DeleteConfigReq} */
1896
- declare function DeleteConfigReq(): DeleteConfigReq;
1897
- type DeleteConfigReq = {
1898
- data?: DeleteConfig;
1899
- };
1900
- /** @returns {DeleteConfigResponse} */
1901
- declare function DeleteConfigResponse(): DeleteConfigResponse;
1902
- type DeleteConfigResponse = {
1903
- /**
1904
- * - Indicates if the configuration deletion was successful.
1905
- */
1906
- success?: boolean;
1907
- /**
1908
- * - Additional information or message about the
1909
- * configuration deletion process.
1910
- */
1911
- message?: string;
1912
- };
1913
- /** @returns {ChannelDisplayNameItems} */
1914
- declare function ChannelDisplayNameItems(): ChannelDisplayNameItems;
1915
- type ChannelDisplayNameItems = {
1916
- /**
1917
- * - The unique key identifying the channel.
1918
- */
1919
- key?: string;
1920
- /**
1921
- * - The display name of the channel associated with the key.
1922
- */
1923
- value?: string;
1924
- };
1925
- /** @returns {ChannelDisplayNameResponse} */
1926
- declare function ChannelDisplayNameResponse(): ChannelDisplayNameResponse;
1927
- type ChannelDisplayNameResponse = {
1928
- /**
1929
- * - Indicates if the retrieval of channel display
1930
- * names was successful.
1931
- */
1932
- success?: boolean;
1933
- /**
1934
- * - List of items containing
1935
- * key-value pairs for channel display names.
1936
- */
1937
- items?: ChannelDisplayNameItems[];
1938
- };
1939
- /** @returns {CnReferenceNumber} */
1940
- declare function CnReferenceNumber(): CnReferenceNumber;
1941
- type CnReferenceNumber = {
1942
- /**
1943
- * - The unique reference number of the
1944
- * credit note.
1945
- */
1946
- cn_reference_number?: string;
1947
- };
1948
- /** @returns {GetPdfUrlViewReq} */
1949
- declare function GetPdfUrlViewReq(): GetPdfUrlViewReq;
1950
- type GetPdfUrlViewReq = {
1951
- data?: CnReferenceNumber;
1952
- };
1953
- /** @returns {GetPdfUrlViewResponseData} */
1954
- declare function GetPdfUrlViewResponseData(): GetPdfUrlViewResponseData;
1955
- type GetPdfUrlViewResponseData = {
1956
- /**
1957
- * - The URL link where credit nore pdf stored
1958
- * to view and download.
1959
- */
1960
- s3_pdf_link?: string;
1961
- /**
1962
- * - The unique reference number of the
1963
- * credit note.
1964
- */
1965
- cn_reference_number?: string;
1966
- };
1967
- /** @returns {GetPdfUrlViewResponse} */
1968
- declare function GetPdfUrlViewResponse(): GetPdfUrlViewResponse;
1969
- type GetPdfUrlViewResponse = {
1970
- /**
1971
- * - Indicates if the retrieval of the pdf URL was
1972
- * successful.
1973
- */
1974
- success?: boolean;
1975
- data?: GetPdfUrlViewResponseData;
1976
- };
1977
- /** @returns {CreditNoteDetailsReq} */
1978
- declare function CreditNoteDetailsReq(): CreditNoteDetailsReq;
1979
- type CreditNoteDetailsReq = {
1980
- data?: CnReferenceNumber;
1981
- };
1982
- /** @returns {CnDetails} */
1983
- declare function CnDetails(): CnDetails;
1984
- type CnDetails = {
1985
- /**
1986
- * - ID of the staff member associated with the credit note.
1987
- */
1988
- staff_id?: string;
1989
- /**
1990
- * - Expiry date of the credit note.
1991
- */
1992
- expiry_date?: string;
1993
- /**
1994
- * - Channel through which the credit
1995
- * note was issued.
1996
- */
1997
- channel_of_issuance?: string;
1998
- /**
1999
- * - Order ID of order for which credit note created.
2000
- */
2001
- order_id?: string;
2002
- /**
2003
- * - Date when the credit note was issued.
2004
- */
2005
- date_issued?: string;
2006
- /**
2007
- * - Ordering channel associated with the
2008
- * credit note.
2009
- */
2010
- ordering_channel?: string;
2011
- /**
2012
- * - Shipment Id associated with the credit note.
2013
- */
2014
- shipment_id?: string;
2015
- /**
2016
- * - Store Id associated with the credit note.
2017
- */
2018
- store_id?: string;
2019
- /**
2020
- * - Invoice number associated with the credit note.
2021
- */
2022
- invoice_number?: string;
2023
- };
2024
- /** @returns {RedemptionDetails} */
2025
- declare function RedemptionDetails(): RedemptionDetails;
2026
- type RedemptionDetails = {
2027
- /**
2028
- * - Additional metadata related to the redemption details.
2029
- */
2030
- meta?: any;
2031
- /**
2032
- * - ID of the staff member who processed the redemption.
2033
- */
2034
- staff_id?: string;
2035
- /**
2036
- * - Date and time when the redemption was processed.
2037
- */
2038
- created_at?: string;
2039
- /**
2040
- * - Order Id of the order associated with the redemption.
2041
- */
2042
- order_id?: string;
2043
- /**
2044
- * - Store Id of the order associated with the redemption.
2045
- */
2046
- store_id?: string;
2047
- /**
2048
- * - Shipment Id of the order associated with
2049
- * the redemption.
2050
- */
2051
- shipment_id?: string;
2052
- /**
2053
- * - Ordering channel associated with the
2054
- * redemption.
2055
- */
2056
- ordering_channel?: string;
2057
- /**
2058
- * - Amount debited from the credit note
2059
- * during redemption.
2060
- */
2061
- amount_debited?: number;
2062
- /**
2063
- * - Invoice number associated with the redemption.
2064
- */
2065
- invoice_number?: string;
2066
- };
2067
- /** @returns {CreditNoteDetails} */
2068
- declare function CreditNoteDetails(): CreditNoteDetails;
2069
- type CreditNoteDetails = {
2070
- /**
2071
- * - Currency in which the credit note is issued.
2072
- */
2073
- currency?: string;
2074
- /**
2075
- * - Current amount used from the credit note.
2076
- */
2077
- current_amount_used?: number;
2078
- /**
2079
- * - Status of the credit note.
2080
- */
2081
- cn_status?: string;
2082
- /**
2083
- * - Mobile number of the customer
2084
- * associated with the credit note.
2085
- */
2086
- customer_mobile_number?: string;
2087
- /**
2088
- * - Unique Credit number of the credit note.
2089
- */
2090
- cn_reference_number?: string;
2091
- cn_details?: CnDetails;
2092
- /**
2093
- * - List of redemption
2094
- * details associated with the credit note.
2095
- */
2096
- redemption_details?: RedemptionDetails[];
2097
- /**
2098
- * - Remaining amount left in the credit note.
2099
- */
2100
- remaining_cn_amount?: number;
2101
- /**
2102
- * - Available balance in the credit note.
2103
- */
2104
- available_cn_balance?: number;
2105
- /**
2106
- * - Total amount of the credit note.
2107
- */
2108
- cn_amount?: number;
2109
- };
2110
- /** @returns {CreditNoteDetailsResponse} */
2111
- declare function CreditNoteDetailsResponse(): CreditNoteDetailsResponse;
2112
- type CreditNoteDetailsResponse = {
2113
- /**
2114
- * - Indicates if the retrieval of credit note
2115
- * details was successful.
2116
- */
2117
- success?: boolean;
2118
- data?: CreditNoteDetails;
2119
- };
2120
- /** @returns {GetCustomerCreditBalance} */
2121
- declare function GetCustomerCreditBalance(): GetCustomerCreditBalance;
2122
- type GetCustomerCreditBalance = {
2123
- /**
2124
- * - The unique identifier of sale channels or
2125
- * application as affiliate_id associated with the seller.
2126
- */
2127
- affiliate_id?: string;
2128
- /**
2129
- * - Unique identifier for the seller.
2130
- */
2131
- seller_id?: number;
2132
- /**
2133
- * - Mobile number of the customer
2134
- * for whom the credit balance is requested.
2135
- */
2136
- customer_mobile_number?: string;
2137
- };
2138
- /** @returns {GetCustomerCreditBalanceReq} */
2139
- declare function GetCustomerCreditBalanceReq(): GetCustomerCreditBalanceReq;
2140
- type GetCustomerCreditBalanceReq = {
2141
- data?: GetCustomerCreditBalance;
2142
- };
2143
- /** @returns {GetCustomerCreditBalanceResponseData} */
2144
- declare function GetCustomerCreditBalanceResponseData(): GetCustomerCreditBalanceResponseData;
2145
- type GetCustomerCreditBalanceResponseData = {
2146
- /**
2147
- * - Mobile number of the customer.
2148
- */
2149
- customer_mobile_number?: string;
2150
- /**
2151
- * - Total credited balance
2152
- * available for the customer.
2153
- */
2154
- total_credited_balance?: number;
2155
- };
2156
- /** @returns {GetCustomerCreditBalanceResponse} */
2157
- declare function GetCustomerCreditBalanceResponse(): GetCustomerCreditBalanceResponse;
2158
- type GetCustomerCreditBalanceResponse = {
2159
- /**
2160
- * - Indicates if the retrieval of customer credit
2161
- * balance was successful.
2162
- */
2163
- success?: boolean;
2164
- data?: GetCustomerCreditBalanceResponseData;
2165
- };
2166
- /** @returns {GetCnConfigReq} */
2167
- declare function GetCnConfigReq(): GetCnConfigReq;
2168
- type GetCnConfigReq = {
2169
- data?: DeleteConfig;
2170
- };
2171
- /** @returns {GetCnConfigResponseMeta} */
2172
- declare function GetCnConfigResponseMeta(): GetCnConfigResponseMeta;
2173
- type GetCnConfigResponseMeta = {
2174
- /**
2175
- * - Reason associated with the configuration response.
2176
- */
2177
- reason?: string;
2178
- /**
2179
- * - List of source channels associated
2180
- * with the credit note configuration.
2181
- */
2182
- source_channel?: string[];
2183
- };
2184
- /** @returns {GetCnConfigResponseData} */
2185
- declare function GetCnConfigResponseData(): GetCnConfigResponseData;
2186
- type GetCnConfigResponseData = {
2187
- /**
2188
- * - Indicates if the credit note
2189
- * is configured as a refund method.
2190
- */
2191
- is_cn_as_refund_method?: boolean;
2192
- /**
2193
- * - The unique identifier of sale channels or
2194
- * application as affiliate_id associated with the seller.
2195
- */
2196
- affiliate_id?: string;
2197
- meta?: any;
2198
- /**
2199
- * - Unique identifier for the seller.
2200
- */
2201
- seller_id?: number;
2202
- notification_events?: CreditNoteConfigNotificationEvents;
2203
- /**
2204
- * - Validity period of the credit note
2205
- * configuration in days.
2206
- */
2207
- validity?: number;
2208
- /**
2209
- * - List of ordering
2210
- * channels associated with credit note redemption.
2211
- */
2212
- redemption_ordering_channel?: string[];
2213
- /**
2214
- * - Type of currency used for the credit note.
2215
- */
2216
- currency_type?: string;
2217
- };
2218
- /** @returns {GetCnConfigResponse} */
2219
- declare function GetCnConfigResponse(): GetCnConfigResponse;
2220
- type GetCnConfigResponse = {
2221
- /**
2222
- * - Indicates if the retrieval of credit note
2223
- * configuration was successful.
2224
- */
2225
- success?: boolean;
2226
- data?: GetCnConfigResponseData;
2227
- };
2228
- /** @returns {CnGenerateReportFilters} */
2229
- declare function CnGenerateReportFilters(): CnGenerateReportFilters;
2230
- type CnGenerateReportFilters = {
2231
- /**
2232
- * - Array of staff IDs for filtering credit note reports.
2233
- */
2234
- staff_id?: string[];
2235
- /**
2236
- * - Array of channels through which
2237
- * credit notes were issued.
2238
- */
2239
- channel_of_issuance?: string[];
2240
- /**
2241
- * - Array of utilisation types for filtering
2242
- * credit note reports.
2243
- */
2244
- utilisation?: string[];
2245
- /**
2246
- * - Array of ordering channels
2247
- * associated with credit note reports.
2248
- */
2249
- ordering_channel?: string[];
2250
- /**
2251
- * - Array of store IDs for filtering credit note reports.
2252
- */
2253
- store_id?: number[];
2254
- /**
2255
- * - Array of transaction types for
2256
- * filtering credit note reports.
2257
- */
2258
- type_of_transaction?: string[];
2259
- /**
2260
- * - Array of issuance channels for
2261
- * filtering credit note reports.
2262
- */
2263
- issuance_channel?: string[];
2264
- };
2265
- /** @returns {CnGenerateReport} */
2266
- declare function CnGenerateReport(): CnGenerateReport;
2267
- type CnGenerateReport = {
2268
- /**
2269
- * - Page number of the credit note report.
2270
- */
2271
- page?: number;
2272
- /**
2273
- * - End date for filtering credit note data.
2274
- */
2275
- end_date?: string;
2276
- /**
2277
- * - Number of items per page in the credit note report.
2278
- */
2279
- page_size?: number;
2280
- filters?: CnGenerateReportFilters;
2281
- /**
2282
- * - The unique identifier of sale channels or
2283
- * application as affiliate_id associated with the seller.
2284
- */
2285
- affiliate_id?: string;
2286
- meta?: GenerateReportFilters;
2287
- /**
2288
- * - Search query to filter credit note data by keyword.
2289
- */
2290
- search?: string;
2291
- /**
2292
- * - Unique identifier for the credit note report.
2293
- */
2294
- report_id?: string;
2295
- /**
2296
- * - Type of search criteria used for filtering
2297
- * credit note data.
2298
- */
2299
- search_type?: string;
2300
- /**
2301
- * - Start date for filtering credit note data.
2302
- */
2303
- start_date?: string;
2304
- };
2305
- /** @returns {GenerateReportCustomerCnReq} */
2306
- declare function GenerateReportCustomerCnReq(): GenerateReportCustomerCnReq;
2307
- type GenerateReportCustomerCnReq = {
2308
- data?: CnGenerateReport;
2309
- };
2310
- /** @returns {CnGenerateReportItems} */
2311
- declare function CnGenerateReportItems(): CnGenerateReportItems;
2312
- type CnGenerateReportItems = {
2313
- /**
2314
- * - Expiry date of the credit note item.
2315
- */
2316
- expiry_date?: string;
2317
- /**
2318
- * - Status of the credit note item.
2319
- */
2320
- status?: string;
2321
- /**
2322
- * - Total amount of the credit note item.
2323
- */
2324
- total_amount?: number;
2325
- /**
2326
- * - Order ID of the order associated with the
2327
- * credit note item.
2328
- */
2329
- order_id?: string;
2330
- /**
2331
- * - Date when the credit note item was issued.
2332
- */
2333
- date_issued?: string;
2334
- /**
2335
- * - Shipment ID of the order associated with
2336
- * the credit note item.
2337
- */
2338
- shipment_id?: string;
2339
- /**
2340
- * - Invoice number associated with the
2341
- * credit note item.
2342
- */
2343
- invoice_number?: string;
2344
- /**
2345
- * - Unique number of the credit note item.
2346
- */
2347
- credit_note_number?: string;
2348
- };
2349
- /** @returns {GenerateReportCustomerCnResponseData} */
2350
- declare function GenerateReportCustomerCnResponseData(): GenerateReportCustomerCnResponseData;
2351
- type GenerateReportCustomerCnResponseData = {
2352
- /**
2353
- * - Indicates if the credit note report
2354
- * generation was successful.
2355
- */
2356
- success?: boolean;
2357
- /**
2358
- * - Additional message or information related to
2359
- * the credit note report.
2360
- */
2361
- message?: string;
2362
- /**
2363
- * - List of credit note items in the report.
2364
- */
2365
- items?: CnGenerateReportItems[];
2366
- /**
2367
- * - Display order for row headers
2368
- * in the report.
2369
- */
2370
- row_header_display_order?: any;
2371
- /**
2372
- * - End date used in the credit note report.
2373
- */
2374
- end_date?: string;
2375
- page?: Page;
2376
- /**
2377
- * - Headers included in the credit note report.
2378
- */
2379
- headers?: string[];
2380
- /**
2381
- * - Primary headers used in the credit
2382
- * note report.
2383
- */
2384
- primary_headers?: string[];
2385
- /**
2386
- * - Allowed filters for the credit note report.
2387
- */
2388
- allowed_filters?: string[];
2389
- /**
2390
- * - Start date used in the credit note report.
2391
- */
2392
- start_date?: string;
2393
- /**
2394
- * - Total count of credit note items in the report.
2395
- */
2396
- item_count?: number;
2397
- };
2398
- /** @returns {GenerateReportCustomerCnResponse} */
2399
- declare function GenerateReportCustomerCnResponse(): GenerateReportCustomerCnResponse;
2400
- type GenerateReportCustomerCnResponse = {
2401
- data?: GenerateReportCustomerCnResponseData;
2402
- };
2403
- /** @returns {CnDownloadReport} */
2404
- declare function CnDownloadReport(): CnDownloadReport;
2405
- type CnDownloadReport = {
2406
- /**
2407
- * - Page number of the download report.
2408
- */
2409
- page?: number;
2410
- /**
2411
- * - Start date for filtering credit note data
2412
- * in the report.
2413
- */
2414
- start_date?: string;
2415
- /**
2416
- * - End date for filtering credit note data in the report.
2417
- */
2418
- end_date?: string;
2419
- /**
2420
- * - The unique identifier of sale channels or
2421
- * application as affiliate_id associated with the seller.
2422
- */
2423
- affiliate_id?: string;
2424
- /**
2425
- * - Search query to filter credit note data by keyword.
2426
- */
2427
- search?: string;
2428
- /**
2429
- * - Status of the credit note data in the report.
2430
- */
2431
- status?: string;
2432
- /**
2433
- * - Type of search criteria used for filtering
2434
- * credit note data.
2435
- */
2436
- search_type?: string;
2437
- /**
2438
- * - Number of items per page in the download report.
2439
- */
2440
- page_size?: number;
2441
- };
2442
- /** @returns {DownloadReportCustomerCnReq} */
2443
- declare function DownloadReportCustomerCnReq(): DownloadReportCustomerCnReq;
2444
- type DownloadReportCustomerCnReq = {
2445
- data?: CnDownloadReport;
2446
- };
2447
- /** @returns {DownloadReportResponseData} */
2448
- declare function DownloadReportResponseData(): DownloadReportResponseData;
2449
- type DownloadReportResponseData = {
2450
- /**
2451
- * - Unique identifier for the report configuration.
2452
- */
2453
- report_config_id?: string;
2454
- /**
2455
- * - Full name associated with the report request.
2456
- */
2457
- full_name?: string;
2458
- /**
2459
- * - User who requested the report.
2460
- */
2461
- requested_by?: string;
2462
- /**
2463
- * - Start date used in the report.
2464
- */
2465
- start_date?: string;
2466
- /**
2467
- * - End date used in the report.
2468
- */
2469
- end_date?: string;
2470
- /**
2471
- * - Dictionary containing request parameters
2472
- * for the report.
2473
- */
2474
- request_dict?: any;
2475
- /**
2476
- * - Download link for accessing the generated report.
2477
- */
2478
- download_link?: string;
2479
- /**
2480
- * - Date and time when the report was created.
2481
- */
2482
- created_at?: string;
2483
- /**
2484
- * - Additional metadata associated with the report.
2485
- */
2486
- meta?: any;
2487
- /**
2488
- * - Message related to the report status or generation.
2489
- */
2490
- msg?: string;
2491
- /**
2492
- * - Name of the generated report.
2493
- */
2494
- report_name?: string;
2495
- /**
2496
- * - Status of the report.
2497
- */
2498
- status?: string;
2499
- /**
2500
- * - Display name of the report.
2501
- */
2502
- display_name?: string;
2503
- /**
2504
- * - Filters applied to generate the report.
2505
- */
2506
- filters?: any;
2507
- };
2508
- /** @returns {DownloadReportCustomerCnResponse} */
2509
- declare function DownloadReportCustomerCnResponse(): DownloadReportCustomerCnResponse;
2510
- type DownloadReportCustomerCnResponse = {
2511
- /**
2512
- * - List of download report data items.
2513
- */
2514
- items?: DownloadReportResponseData[];
2515
- /**
2516
- * - Total count of items in the download report.
2517
- */
2518
- item_count?: number;
2519
- page?: Page;
2520
- };
2521
- /** @returns {GetReportingFilters} */
2522
- declare function GetReportingFilters(): GetReportingFilters;
2523
- type GetReportingFilters = {
2524
- /**
2525
- * - Display text for the filter.
2526
- */
2527
- text?: string;
2528
- /**
2529
- * - Type of the fields like seach, filter(e.g.,
2530
- * single, multi select).
2531
- */
2532
- type?: string;
2533
- /**
2534
- * - Options available for the filter.
2535
- */
2536
- options?: any[];
2537
- /**
2538
- * - Value to be pass in response select from options.
2539
- */
2540
- value?: string;
2541
- };
2542
- /** @returns {GetReportingNestedFilters} */
2543
- declare function GetReportingNestedFilters(): GetReportingNestedFilters;
2544
- type GetReportingNestedFilters = {
2545
- /**
2546
- * - Display text for the nested filter.
2547
- */
2548
- text?: string;
2549
- /**
2550
- * - Options available for the nested filter.
2551
- */
2552
- options?: any[];
2553
- /**
2554
- * - Indicates if the nested filter is required.
2555
- */
2556
- required?: boolean;
2557
- /**
2558
- * - Placeholder text for the nested filter.
2559
- */
2560
- placeholder_text?: string;
2561
- /**
2562
- * - Type of the nested filter (e.g., single, multi select).
2563
- */
2564
- type?: string;
2565
- /**
2566
- * - Value to be pass in response select from options.
2567
- */
2568
- value?: string;
2569
- };
2570
- /** @returns {GetReportingFiltersReasonOptions} */
2571
- declare function GetReportingFiltersReasonOptions(): GetReportingFiltersReasonOptions;
2572
- type GetReportingFiltersReasonOptions = {
2573
- /**
2574
- * - Display text for the reason option.
2575
- */
2576
- text?: string;
2577
- /**
2578
- * - Value of the reason option.
2579
- */
2580
- value?: string;
2581
- /**
2582
- * - Placeholder text for the reason option.
2583
- */
2584
- placeholder_text?: string;
2585
- };
2586
- /** @returns {GetReportingFiltersReason} */
2587
- declare function GetReportingFiltersReason(): GetReportingFiltersReason;
2588
- type GetReportingFiltersReason = {
2589
- /**
2590
- * - Display text for the reason.
2591
- */
2592
- text?: string;
2593
- /**
2594
- * - Type of the reason.
2595
- */
2596
- type?: string;
2597
- /**
2598
- * - Value to be pass in response.
2599
- */
2600
- value?: string;
2601
- /**
2602
- * - Options available
2603
- * for the reasons select from options.
2604
- */
2605
- options?: GetReportingFiltersReasonOptions[];
2606
- };
2607
- /** @returns {GetReportingFiltersResponse} */
2608
- declare function GetReportingFiltersResponse(): GetReportingFiltersResponse;
2609
- type GetReportingFiltersResponse = {
2610
- reason?: GetReportingFiltersReason;
2611
- search?: GetReportingFilters;
2612
- /**
2613
- * - Array of nested filter objects.
2614
- */
2615
- filters?: GetReportingNestedFilters[];
2616
- status?: GetReportingFilters;
2617
- };
2618
- /** @returns {InvoicePaymentOptionsPayloadData} */
2619
- declare function InvoicePaymentOptionsPayloadData(): InvoicePaymentOptionsPayloadData;
2620
- type InvoicePaymentOptionsPayloadData = {
2621
- /**
2622
- * - List of invoice numbers for which
2623
- * payment options are being requested.
2624
- */
2625
- invoice_numbers?: string[];
2626
- };
2627
- /** @returns {InvoicePaymentOptionsReq} */
2628
- declare function InvoicePaymentOptionsReq(): InvoicePaymentOptionsReq;
2629
- type InvoicePaymentOptionsReq = {
2630
- data?: InvoicePaymentOptionsPayloadData;
2631
- };
2632
- /** @returns {InvoicePaymentOptionsResponsePayableAmounts} */
2633
- declare function InvoicePaymentOptionsResponsePayableAmounts(): InvoicePaymentOptionsResponsePayableAmounts;
2634
- type InvoicePaymentOptionsResponsePayableAmounts = {
2635
- /**
2636
- * - Amount that is payable for the invoice.
2637
- */
2638
- amount?: number;
2639
- /**
2640
- * - Key associated with the payable amount for
2641
- * identification.
2642
- */
2643
- amount_key?: string;
2644
- /**
2645
- * - Header describing the payable amount.
2646
- */
2647
- header?: string;
2648
- };
2649
- /** @returns {InvoicePaymentOptionsResponseDeductedAmounts} */
2650
- declare function InvoicePaymentOptionsResponseDeductedAmounts(): InvoicePaymentOptionsResponseDeductedAmounts;
2651
- type InvoicePaymentOptionsResponseDeductedAmounts = {
2652
- /**
2653
- * - Amount deducted from the invoice.
2654
- */
2655
- amount?: number;
2656
- /**
2657
- * - Header describing the deducted amount.
2658
- */
2659
- header?: string;
2660
- /**
2661
- * - Key associated with the deducted amount for
2662
- * identification.
2663
- */
2664
- amount_key?: string;
2665
- /**
2666
- * - Indicates whether the deducted amount is payable.
2667
- */
2668
- is_payable?: boolean;
2669
- /**
2670
- * - Currency symbol associated with the deducted amount.
2671
- */
2672
- symbol?: string;
2673
- };
2674
- /** @returns {InvoicePaymentOptionsResponseData} */
2675
- declare function InvoicePaymentOptionsResponseData(): InvoicePaymentOptionsResponseData;
2676
- type InvoicePaymentOptionsResponseData = {
2677
- /**
2678
- * - Invoice number for which payment
2679
- * options are provided.
2680
- */
2681
- invoice_number?: string;
2682
- /**
2683
- * - Type of the invoice (e.g., 'Seller Fynd',
2684
- * 'Platform Subscription').
2685
- */
2686
- invoice_type?: string;
2687
- /**
2688
- * - List of amounts that are payable for the invoice.
2689
- */
2690
- display_amounts?: InvoicePaymentOptionsResponsePayableAmounts[];
2691
- /**
2692
- * - Total amount for the invoice.
2693
- */
2694
- total_amount?: any;
2695
- /**
2696
- * - Amounts deducted from the total,
2697
- * including any associated details.
2698
- */
2699
- deducted_amounts?: any;
2700
- /**
2701
- * - Amounts that are payable for the invoice.
2702
- */
2703
- payable_amounts?: InvoicePaymentOptionsResponsePayableAmounts[];
2704
- currency?: Currency;
2705
- };
2706
- /** @returns {InvoicePaymentOptionsResponse} */
2707
- declare function InvoicePaymentOptionsResponse(): InvoicePaymentOptionsResponse;
2708
- type InvoicePaymentOptionsResponse = {
2709
- /**
2710
- * - Reason for the response or any errors encountered.
2711
- */
2712
- reason?: string;
2713
- /**
2714
- * - List of data objects
2715
- * containing details about invoice payment options.
2716
- */
2717
- data?: InvoicePaymentOptionsResponseData[];
2718
- /**
2719
- * - Total amount payable for the invoices.
2720
- */
2721
- total_payable_amount?: number;
2722
- /**
2723
- * - Number of invoices included in the response.
2724
- */
2725
- invoice_count?: number;
2726
- /**
2727
- * - Indicates whether the request to retrieve
2728
- * invoice payment options was successful.
2729
- */
2730
- success?: boolean;
2731
- };
2732
- /** @returns {PaymentDetail} */
2733
- declare function PaymentDetail(): PaymentDetail;
2734
- type PaymentDetail = {
2735
- /**
2736
- * - Name or label displayed for the payment detail.
2737
- */
2738
- display_name?: string;
2739
- /**
2740
- * - Value associated with the payment detail (e.g.,
2741
- * amount, transaction ID).
2742
- */
2743
- value?: string;
2744
- };
2745
- /** @returns {PaidInvoicePaymentDetail} */
2746
- declare function PaidInvoicePaymentDetail(): PaidInvoicePaymentDetail;
2747
- type PaidInvoicePaymentDetail = {
2748
- /**
2749
- * - List of payment details for
2750
- * the invoice.
2751
- */
2752
- payment_details?: PaymentDetail[];
2753
- /**
2754
- * - Date when the payment was made.
2755
- */
2756
- date_of_payment?: string;
2757
- /**
2758
- * - Amount paid towards the invoice.
2759
- */
2760
- amount?: number;
2761
- };
2762
- /** @returns {InvoicePaymentDetailsResponseData} */
2763
- declare function InvoicePaymentDetailsResponseData(): InvoicePaymentDetailsResponseData;
2764
- type InvoicePaymentDetailsResponseData = {
2765
- /**
2766
- * - List
2767
- * of details for paid invoices.
2768
- */
2769
- paid_invoice_payment_details?: PaidInvoicePaymentDetail[];
2770
- /**
2771
- * - Details of any failed
2772
- * payment attempts for the invoices.
2773
- */
2774
- failed_attempts_details?: any[];
2775
- };
2776
- /** @returns {InvoicePaymentDetailsResponse} */
2777
- declare function InvoicePaymentDetailsResponse(): InvoicePaymentDetailsResponse;
2778
- type InvoicePaymentDetailsResponse = {
2779
- /**
2780
- * - Reason for the response or any errors encountered.
2781
- */
2782
- reason?: string;
2783
- data?: InvoicePaymentDetailsResponseData;
2784
- /**
2785
- * - Indicates whether the request to retrieve
2786
- * invoice payment details was successful.
2787
- */
2788
- success?: boolean;
2789
- /**
2790
- * - Indicates whether payment
2791
- * details are visible or hidden in the response.
2792
- */
2793
- payment_details_visible?: boolean;
2794
- };
2795
- /** @returns {InvoiceActivityLogsResponseData} */
2796
- declare function InvoiceActivityLogsResponseData(): InvoiceActivityLogsResponseData;
2797
- type InvoiceActivityLogsResponseData = {
2798
- /**
2799
- * - Identifier of the user or system that
2800
- * performed the activity.
2801
- */
2802
- performed_by?: string;
2803
- /**
2804
- * - Status of the activity (e.g., 'Completed', 'Pending').
2805
- */
2806
- status?: string;
2807
- /**
2808
- * - Reason for the activity status or any related notes.
2809
- */
2810
- reason?: string;
2811
- /**
2812
- * - Indicates whether the activity issue is resolved.
2813
- */
2814
- is_resolved?: boolean;
2815
- /**
2816
- * - Number of retry attempts made for the activity.
2817
- */
2818
- retry_attempts?: number;
2819
- /**
2820
- * - Maximum number of retry attempts
2821
- * allowed for the activity.
2822
- */
2823
- max_retry_attempts?: number;
2824
- };
2825
- /** @returns {InvoiceActivityLogsResponse} */
2826
- declare function InvoiceActivityLogsResponse(): InvoiceActivityLogsResponse;
2827
- type InvoiceActivityLogsResponse = {
2828
- /**
2829
- * - List of activity logs
2830
- * related to invoices.
2831
- */
2832
- data?: InvoiceActivityLogsResponseData[];
2833
- };
2834
- /** @returns {InvoiceActivityLogError} */
2835
- declare function InvoiceActivityLogError(): InvoiceActivityLogError;
2836
- type InvoiceActivityLogError = {
2837
- /**
2838
- * - Reason for the error or issue encountered with
2839
- * the invoice activity logs.
2840
- */
2841
- reason?: string;
2842
- };
2843
- /** @returns {UnlockCreditNoteRequestData} */
2844
- declare function UnlockCreditNoteRequestData(): UnlockCreditNoteRequestData;
2845
- type UnlockCreditNoteRequestData = {
2846
- /**
2847
- * - The unique identifier for the seller.
2848
- */
2849
- seller_id?: string;
2850
- /**
2851
- * - A list of credit notes that are locked.
2852
- */
2853
- locked_credit_notes?: string[];
2854
- /**
2855
- * - The reason for unlocking the credit notes.
2856
- */
2857
- unlock_reason?: string;
2858
- /**
2859
- * - Additional details or comments about the
2860
- * unlock request.
2861
- */
2862
- description?: string;
2863
- };
2864
- /** @returns {UnlockCreditNoteReq} */
2865
- declare function UnlockCreditNoteReq(): UnlockCreditNoteReq;
2866
- type UnlockCreditNoteReq = {
2867
- data?: UnlockCreditNoteRequestData;
2868
- };
2869
- /** @returns {UnlockCreditNoteResponseData} */
2870
- declare function UnlockCreditNoteResponseData(): UnlockCreditNoteResponseData;
2871
- type UnlockCreditNoteResponseData = {
2872
- /**
2873
- * - Indicates whether the credit note is unlocked.
2874
- */
2875
- is_cn_unlocked?: boolean;
2876
- /**
2877
- * - The current status of the each credit notes.
2878
- */
2879
- status?: string;
2880
- };
2881
- /** @returns {UnlockCreditNoteResponse} */
2882
- declare function UnlockCreditNoteResponse(): UnlockCreditNoteResponse;
2883
- type UnlockCreditNoteResponse = {
2884
- /**
2885
- * - Indicates whether the credit note unlock
2886
- * request was successful.
2887
- */
2888
- success?: boolean;
2889
- data?: UnlockCreditNoteResponseData;
2890
- };