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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (278) hide show
  1. package/README.md +23 -26
  2. package/package.json +5 -1
  3. package/sdk/application/ApplicationClient.d.ts +5 -6
  4. package/sdk/application/ApplicationClient.js +24 -20
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
  6. package/sdk/application/Cart/CartApplicationClient.js +444 -76
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
  16. package/sdk/application/Content/ContentApplicationClient.js +274 -111
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
  19. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  20. package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +6 -6
  23. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
  24. package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
  25. package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
  26. package/sdk/application/Order/OrderApplicationClient.js +217 -17
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
  28. package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
  32. package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
  33. package/sdk/application/User/UserApplicationClient.d.ts +103 -53
  34. package/sdk/application/User/UserApplicationClient.js +308 -49
  35. package/sdk/common/AxiosHelper.js +11 -4
  36. package/sdk/common/Constant.d.ts +27 -4
  37. package/sdk/common/Constant.js +33 -6
  38. package/sdk/common/utils.d.ts +10 -0
  39. package/sdk/common/utils.js +24 -3
  40. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
  41. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
  42. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
  43. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
  44. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
  45. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
  46. package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
  47. package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
  48. package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
  49. package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
  50. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
  51. package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
  52. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
  53. package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
  54. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
  55. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
  56. package/sdk/partner/PartnerClient.d.ts +5 -2
  57. package/sdk/partner/PartnerClient.js +21 -7
  58. package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
  59. package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
  60. package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
  61. package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
  62. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  63. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
  64. package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
  65. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
  66. package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
  67. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
  68. package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
  69. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
  70. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
  71. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
  72. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  73. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
  74. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
  75. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
  78. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
  79. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  80. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  81. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  82. package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
  83. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  84. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  85. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  86. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  87. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
  88. package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
  89. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
  90. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
  91. package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
  92. package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
  93. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
  94. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
  95. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
  96. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
  97. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
  98. package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
  99. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9573 -2678
  100. package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
  101. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
  102. package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
  103. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
  104. package/sdk/platform/Common/CommonPlatformClient.js +6 -5
  105. package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
  106. package/sdk/platform/Common/CommonPlatformModel.js +25 -14
  107. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
  108. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
  109. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
  110. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
  111. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  112. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  113. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
  114. package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
  115. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
  116. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
  117. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
  118. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
  119. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  120. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  121. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
  122. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
  123. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
  124. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
  125. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
  126. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
  127. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
  128. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
  129. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  130. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  131. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
  132. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
  133. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
  134. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
  135. package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
  136. package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
  137. package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
  138. package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
  139. package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
  140. package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
  141. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
  142. package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
  143. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
  144. package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
  146. package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
  149. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
  150. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
  151. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
  152. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
  153. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
  154. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
  155. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  156. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
  159. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  160. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  161. package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
  162. package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
  163. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
  164. package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
  165. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
  166. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
  167. package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
  168. package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
  169. package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
  170. package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
  171. package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
  172. package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
  173. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
  175. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
  177. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
  178. package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
  179. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
  180. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
  181. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
  182. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
  183. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
  184. package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
  185. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
  186. package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
  187. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  188. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  189. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  190. package/sdk/platform/PlatformApplicationClient.js +0 -4
  191. package/sdk/platform/PlatformClient.d.ts +5 -4
  192. package/sdk/platform/PlatformClient.js +32 -22
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
  202. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
  203. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  204. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
  206. package/sdk/platform/Share/SharePlatformModel.js +31 -6
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
  212. package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
  214. package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
  215. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
  216. package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
  217. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
  218. package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
  219. package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
  220. package/sdk/platform/User/UserPlatformModel.js +607 -46
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  226. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  227. package/sdk/platform/index.d.ts +0 -2
  228. package/sdk/platform/index.js +0 -4
  229. package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
  230. package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
  231. package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
  232. package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
  233. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
  234. package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
  235. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
  236. package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
  237. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
  238. package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
  239. package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
  240. package/sdk/public/Content/ContentPublicClient.js +1067 -17
  241. package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
  242. package/sdk/public/Content/ContentPublicModel.js +751 -3
  243. package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
  244. package/sdk/public/Content/ContentPublicValidator.js +119 -2
  245. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  246. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  247. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  248. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  249. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  250. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  251. package/sdk/public/PublicClient.d.ts +5 -2
  252. package/sdk/public/PublicClient.js +16 -6
  253. package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
  254. package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
  255. package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
  256. package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
  257. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  258. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  259. package/sdk/public/index.d.ts +1 -0
  260. package/sdk/public/index.js +2 -0
  261. package/utility.d.ts +3 -0
  262. package/utility.js +7 -0
  263. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  264. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  265. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
  266. package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
  267. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  268. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  269. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  270. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  271. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  272. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
  273. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  274. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  275. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  276. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  277. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
  278. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
@@ -1,11 +1,6 @@
1
1
  export = FileStoragePlatformModel;
2
2
  /**
3
- * @typedef ProxyResponse
4
- * @property {Object} [data]
5
- * @property {Object} [support]
6
- */
7
- /**
8
- * @typedef FailedResponse
3
+ * @typedef FailedBrowseFilesResult
9
4
  * @property {string} message
10
5
  */
11
6
  /**
@@ -20,7 +15,7 @@ export = FileStoragePlatformModel;
20
15
  * @property {string} url
21
16
  */
22
17
  /**
23
- * @typedef StartResponse
18
+ * @typedef FileUpload
24
19
  * @property {string} file_name
25
20
  * @property {string} file_path
26
21
  * @property {string} content_type
@@ -29,15 +24,10 @@ export = FileStoragePlatformModel;
29
24
  * @property {string} operation
30
25
  * @property {number} size
31
26
  * @property {Upload} upload
32
- * @property {CDN} cdn
33
27
  * @property {string[]} [tags]
34
28
  */
35
29
  /**
36
- * @typedef Params
37
- * @property {string} [subpath] - The subpath for the file.
38
- */
39
- /**
40
- * @typedef StartRequest
30
+ * @typedef FileUploadStart
41
31
  * @property {string} file_name
42
32
  * @property {string} content_type
43
33
  * @property {number} size
@@ -49,7 +39,7 @@ export = FileStoragePlatformModel;
49
39
  * @property {string} [username]
50
40
  */
51
41
  /**
52
- * @typedef CompleteResponse
42
+ * @typedef FileUploadComplete
53
43
  * @property {string} _id
54
44
  * @property {string} file_name
55
45
  * @property {string} file_path
@@ -66,6 +56,12 @@ export = FileStoragePlatformModel;
66
56
  * @property {string} modified_on
67
57
  * @property {CreatedBy} [created_by]
68
58
  */
59
+ /**
60
+ * @typedef ProxyFileAccess
61
+ * @property {boolean} [success] - A boolean value indicating whether the proxy
62
+ * request was successful. Returns true when the external URL was successfully
63
+ * fetched and processed.
64
+ */
69
65
  /**
70
66
  * @typedef DestinationNamespace
71
67
  * @property {string} [namespace]
@@ -82,386 +78,37 @@ export = FileStoragePlatformModel;
82
78
  * @property {number} expiry
83
79
  */
84
80
  /**
85
- * @typedef SignUrlResponse
81
+ * @typedef SignUrlResult
86
82
  * @property {Urls[]} urls
87
83
  */
88
84
  /**
89
- * @typedef SignUrlRequest
85
+ * @typedef SignUrl
90
86
  * @property {number} expiry
91
87
  * @property {string[]} urls
92
88
  */
93
- /**
94
- * @typedef InvoiceTypesDataResponse
95
- * @property {boolean} [status]
96
- * @property {string} _id
97
- * @property {number} pdf_type_id
98
- * @property {string} name
99
- * @property {string[]} format
100
- * @property {number} __v
101
- * @property {boolean} visibility
102
- * @property {string} country_code
103
- */
104
- /**
105
- * @typedef InvoiceTypesResponse
106
- * @property {InvoiceTypesDataResponse[]} data
107
- * @property {boolean} success
108
- */
109
- /**
110
- * @typedef ConversionRate
111
- * @property {string} [base]
112
- * @property {Object} [rates]
113
- * @property {number} [timestamp]
114
- */
115
- /**
116
- * @typedef DeliveryPartnerDetail
117
- * @property {string} [name]
118
- * @property {string} [awb_number_barcode]
119
- * @property {string} [awb_number]
120
- * @property {string} [origin]
121
- * @property {string} [destination]
122
- * @property {string} [eway_bill_number]
123
- */
124
- /**
125
- * @typedef Image
126
- * @property {string} [sales_channel_logo]
127
- */
128
- /**
129
- * @typedef PaymentData
130
- * @property {string} [payment_type]
131
- * @property {number} [amount]
132
- * @property {string} [date]
133
- * @property {string} [transaction_id]
134
- * @property {string} [time]
135
- * @property {string} [mode]
136
- * @property {string} [name]
137
- * @property {Object} [meta]
138
- */
139
- /**
140
- * @typedef InvoiceDetail
141
- * @property {string} [invoice_id]
142
- * @property {string} [invoice_date]
143
- * @property {string} [irn]
144
- * @property {string} [external_order_id]
145
- * @property {string} [shipment_id]
146
- * @property {string} [signed_qrcode]
147
- * @property {string} [upi_qrcode]
148
- * @property {string} [device_id]
149
- * @property {string} [marketplace_invoice_id]
150
- * @property {string} [marketplace_shipment_id]
151
- * @property {string} [channel_order_id]
152
- */
153
- /**
154
- * @typedef CompanyDetail
155
- * @property {string} [name] - The official name of the company.
156
- * @property {string} [address] - The physical street address of the company.
157
- * @property {string} [city] - The city where the company is located.
158
- * @property {string} [state] - The state or province where the company is located.
159
- * @property {string} [country] - The country where the company is based.
160
- * @property {number} [zip_code] - The postal code for the company's location.
161
- * @property {string} [state_code] - A code representing the state, often used
162
- * in official documents and forms.
163
- * @property {string} [country_code] - The code of the country.
164
- * @property {string} [gstin] - The Goods and Services Tax Identification
165
- * Number, unique to each business in India.
166
- * @property {string} [pan] - The Permanent Account Number, unique to each
167
- * taxpayer in India.
168
- * @property {string} [phone_no] - The primary contact phone number for the company.
169
- * @property {string} [cin] - The Corporate Identification Number, unique to
170
- * each company registered in India.
171
- * @property {string} [website_url] - The URL to the company's official website.
172
- * @property {string} [email] - The company's official email address.
173
- * @property {string} [display_address] - The display address of the company.
174
- * @property {string} [sector] - The sector in which company is located.
175
- * @property {Object} [phone] - The provided phone no of country.
176
- * @property {string} [trn] - The trn no of the company.
177
- * @property {string} [vat] - The vat no of the company.
178
- * @property {string} [business_country_timezone] - The bussiness country timezone.
179
- * @property {Object} [business_country_currency] - This object represents the
180
- * bussiness country currency.
181
- * @property {Object} [meta] - This object represents the meta fields for company.
182
- */
183
- /**
184
- * @typedef StoreDetail
185
- * @property {string} [store_name]
186
- * @property {string} [address]
187
- * @property {string} [city]
188
- * @property {string} [state]
189
- * @property {string} [country]
190
- * @property {string} [country_code]
191
- * @property {string} [zip_code]
192
- * @property {string} [state_code]
193
- * @property {string} [gstin]
194
- * @property {string} [display_address]
195
- * @property {string} [sector]
196
- * @property {string} [store_id]
197
- */
198
- /**
199
- * @typedef CustomerBillingDetail
200
- * @property {string} [name]
201
- * @property {string} [phone_no]
202
- * @property {string} [address]
203
- * @property {string} [city]
204
- * @property {string} [state]
205
- * @property {string} [country]
206
- * @property {string} [country_code]
207
- * @property {string} [zip_code]
208
- * @property {string} [state_code]
209
- * @property {string} [gstin]
210
- * @property {string} [display_address]
211
- * @property {string} [sector]
212
- * @property {string} [email]
213
- */
214
- /**
215
- * @typedef CustomerShippingDetail
216
- * @property {string} [name]
217
- * @property {string} [phone_no]
218
- * @property {string} [address]
219
- * @property {string} [city]
220
- * @property {string} [state]
221
- * @property {string} [country]
222
- * @property {string} [country_code]
223
- * @property {string} [zip_code]
224
- * @property {string} [state_code]
225
- * @property {string} [gstin]
226
- * @property {string} [display_address]
227
- * @property {string} [sector]
228
- */
229
- /**
230
- * @typedef ReturnDetail
231
- * @property {string} [address]
232
- * @property {string} [city]
233
- * @property {string} [state]
234
- * @property {string} [country]
235
- * @property {string} [country_code]
236
- * @property {string} [zip_code]
237
- * @property {string} [state_code]
238
- * @property {string} [gstin]
239
- * @property {string} [display_address]
240
- * @property {string} [sector]
241
- */
242
- /**
243
- * @typedef Brand
244
- * @property {string} [logo]
245
- * @property {string} [name]
246
- */
247
- /**
248
- * @typedef Cgst
249
- * @property {number} [value]
250
- * @property {number} [percent]
251
- */
252
- /**
253
- * @typedef Sgst
254
- * @property {number} [value]
255
- * @property {number} [percent]
256
- */
257
- /**
258
- * @typedef Igst
259
- * @property {number} [value]
260
- * @property {number} [percent]
261
- */
262
- /**
263
- * @typedef Tax
264
- * @property {Cgst} [cgst]
265
- * @property {Sgst} [sgst]
266
- * @property {Igst} [igst]
267
- */
268
- /**
269
- * @typedef ItemsProductTable
270
- * @property {string} [name]
271
- * @property {string} [seller_identifier]
272
- * @property {number} [total]
273
- * @property {Brand} [brand]
274
- * @property {string} [hsn_code]
275
- * @property {string} [item_code]
276
- * @property {number} [total_units]
277
- * @property {string} [size]
278
- * @property {number} [mrp]
279
- * @property {number} [discount]
280
- * @property {number} [taxable_amount]
281
- * @property {number} [total_taxable_amount]
282
- * @property {Tax} [tax]
283
- * @property {Object} [meta]
284
- * @property {string} [country_of_origin]
285
- */
286
- /**
287
- * @typedef ProductTable
288
- * @property {number} [total_items]
289
- * @property {ItemsProductTable[]} [products]
290
- * @property {number} [grand_total]
291
- * @property {number} [delivery_charges]
292
- * @property {string} [delivery_charge_text]
293
- * @property {number} [cod_charges]
294
- * @property {number} [fynd_discounts]
295
- * @property {string} [total_in_words]
296
- * @property {number} [gift_price]
297
- * @property {number} [total_quantity]
298
- * @property {number} [sub_total]
299
- * @property {number} [discount]
300
- * @property {number} [promotion]
301
- * @property {number} [coupon]
302
- * @property {number} [reward]
303
- * @property {number} [round_off]
304
- * @property {number} [total_value_of_goods]
305
- */
306
- /**
307
- * @typedef Taxes
308
- * @property {string} [hsn_code]
309
- * @property {Tax} [tax]
310
- * @property {number} [total_tax_value]
311
- */
312
- /**
313
- * @typedef TaxTable
314
- * @property {Taxes[]} [taxes]
315
- * @property {number} [total_tax]
316
- * @property {string} [tax_in_words]
317
- */
318
- /**
319
- * @typedef RegisteredCompanyDetail
320
- * @property {string} [address]
321
- * @property {string} [city]
322
- * @property {string} [state]
323
- * @property {string} [country]
324
- * @property {string} [country_code]
325
- * @property {number} [zip_code]
326
- * @property {string} [state_code]
327
- * @property {string} [display_address]
328
- * @property {string} [sector]
329
- */
330
- /**
331
- * @typedef Kwargs
332
- * @property {string} [value]
333
- */
334
- /**
335
- * @typedef ShipmentIdBarcodeGenerator
336
- * @property {string} [method]
337
- * @property {Kwargs} [kwargs]
338
- */
339
- /**
340
- * @typedef SignedQrcodeGenerator
341
- * @property {string} [method]
342
- * @property {Kwargs} [kwargs]
343
- */
344
- /**
345
- * @typedef KwargsUpiQrcode
346
- * @property {string} [qr_data]
347
- * @property {string} [qr_url]
348
- */
349
- /**
350
- * @typedef UpiQrcodeGenerator
351
- * @property {string} [method]
352
- * @property {KwargsUpiQrcode} [kwargs]
353
- */
354
- /**
355
- * @typedef DigitalsignatureGenerator
356
- * @property {string} [method]
357
- * @property {Kwargs} [kwargs]
358
- */
359
- /**
360
- * @typedef KwargsAwbNumber
361
- * @property {Object[]} [value]
362
- */
363
- /**
364
- * @typedef AwbNumberLabelBarcodeGenerator
365
- * @property {string} [method]
366
- * @property {KwargsAwbNumber} [kwargs]
367
- */
368
- /**
369
- * @typedef AwbNumberBarcodeGenerator
370
- * @property {string} [method]
371
- * @property {Kwargs} [kwargs]
372
- */
373
- /**
374
- * @typedef MetaProperty
375
- * @property {ShipmentIdBarcodeGenerator} [shipment_id_barcode_generator]
376
- * @property {SignedQrcodeGenerator} [signed_qrcode_generator]
377
- * @property {UpiQrcodeGenerator} [upi_qrcode_generator]
378
- * @property {DigitalsignatureGenerator} [digitalsignature_generator]
379
- * @property {AwbNumberLabelBarcodeGenerator} [awb_number_label_barcode_generator]
380
- * @property {AwbNumberBarcodeGenerator} [awb_number_barcode_generator]
381
- */
382
- /**
383
- * @typedef Meta
384
- * @property {MetaProperty} [generator]
385
- */
386
- /**
387
- * @typedef DummyTemplateDataPayload
388
- * @property {boolean} [is_export]
389
- * @property {boolean} [is_export_shipment]
390
- * @property {string} [app_domain_name]
391
- * @property {string} [txn_id]
392
- * @property {string} [utr]
393
- * @property {string} [po_number]
394
- * @property {string} [credit_note_id]
395
- * @property {string} [current_date]
396
- * @property {number} [total_value_of_goods]
397
- * @property {Object} [b2b_buyer_details]
398
- * @property {Object} [is_qwik]
399
- * @property {string} [order_type]
400
- * @property {ConversionRate} [conversion_rate]
401
- * @property {string} [currency_code]
402
- * @property {string} [shipment_id]
403
- * @property {DeliveryPartnerDetail} [delivery_partner_detail]
404
- * @property {Image} [image]
405
- * @property {PaymentData[]} [payments]
406
- * @property {InvoiceDetail} [invoice_detail]
407
- * @property {CompanyDetail} [company_detail]
408
- * @property {StoreDetail} [store_detail]
409
- * @property {CustomerBillingDetail} [customer_billing_detail]
410
- * @property {CustomerShippingDetail} [customer_shipping_detail]
411
- * @property {ReturnDetail} [return_detail]
412
- * @property {ProductTable} [product_table]
413
- * @property {TaxTable} [tax_table]
414
- * @property {string[]} [declaration_texts]
415
- * @property {RegisteredCompanyDetail} [registered_company_detail]
416
- * @property {string} [disclaimer]
417
- * @property {Meta} [meta]
418
- * @property {boolean} [is_self_ship]
419
- * @property {string} [mode]
420
- * @property {boolean} [is_self_pickup]
421
- * @property {Object} [shipment_meta] - This field represents the shipment meta details
422
- * @property {Object} [order_meta] - This field represents the order meta details
423
- * @property {string} [platform_name]
424
- * @property {number} [amount_to_be_collected]
425
- * @property {number} [amount_paid]
426
- * @property {Object[]} [waybills]
427
- * @property {number} [total_items]
428
- * @property {string} [brand_logo]
429
- * @property {string} [shipment_id_barcode]
430
- * @property {string} [signed_qrcode]
431
- * @property {string} [upi_qrcode]
432
- * @property {string} [digitalsignature]
433
- * @property {string} [awb_number_barcode]
434
- * @property {string} [uid]
435
- */
436
- /**
437
- * @typedef DummyTemplateData
438
- * @property {string} [_id] - This field contains the unique identifier for the
439
- * PDF payload.
440
- * @property {number} [pdf_type_id] - This is invoice unique id
441
- * @property {DummyTemplateDataPayload} payload
442
- * @property {string} [country_code] - This field represents the country code.
443
- * @property {number} [__v] - This field holds the version number.
444
- */
445
- /**
446
- * @typedef DummyTemplateDataItems
447
- * @property {DummyTemplateData[]} data
448
- * @property {boolean} success
449
- */
450
89
  /**
451
90
  * @typedef PdfConfig
452
91
  * @property {string} [format] - This is invoice document format such as A4, A6, POS
453
- * @property {string} [template] - This is html template string
454
- * @property {number} [pdf_type_id]
92
+ * @property {string} [template] - This is html template string.
93
+ * @property {number} [pdf_type_id] - This field holds an identifier for the type of PDF.
94
+ * @property {string} [country_code] - This field contains the country code.
95
+ * @property {boolean} [default_template] - This field indicates whether the
96
+ * fetched HTML template is the default template.
455
97
  */
456
98
  /**
457
99
  * @typedef PdfConfigSuccessData
458
- * @property {string} [_id]
459
- * @property {number} [company_id]
460
- * @property {string} [application_id]
461
- * @property {number} [pdf_type_id]
462
- * @property {string} [format]
463
- * @property {string} [template]
464
- * @property {number} [__v]
100
+ * @property {string} [_id] - This field contains the unique identifier for the
101
+ * PDF configuration.
102
+ * @property {number} [company_id] - This field holds the identifier for the
103
+ * company associated with the PDF configuration.
104
+ * @property {string} [application_id] - This field contains the identifier for
105
+ * the application that uses this PDF configuration.
106
+ * @property {number} [pdf_type_id] - This field holds an identifier for the type of PDF.
107
+ * @property {string} [format] - This field specifies the format of the invoice document.
108
+ * @property {string} [template] - This field contains the HTML template string
109
+ * for the PDF document.
110
+ * @property {number} [__v] - This field holds the version number of the PDF
111
+ * configuration document.
465
112
  * @property {string} [country_code]
466
113
  */
467
114
  /**
@@ -484,20 +131,6 @@ export = FileStoragePlatformModel;
484
131
  * @property {PdfConfigSaveSuccessData} [data]
485
132
  * @property {boolean} [success]
486
133
  */
487
- /**
488
- * @typedef PdfDefaultTemplateSuccess
489
- * @property {Document[]} [data]
490
- * @property {boolean} [success] - Indicates if the request was successful.
491
- */
492
- /**
493
- * @typedef Document
494
- * @property {string} [_id]
495
- * @property {number} [pdf_type_id]
496
- * @property {string} [format]
497
- * @property {string} [template]
498
- * @property {string} [country_code]
499
- * @property {number} [__v]
500
- */
501
134
  /**
502
135
  * @typedef PaymentReceiptRequestBody
503
136
  * @property {PaymentReceiptPayload} [payload]
@@ -570,17 +203,11 @@ export = FileStoragePlatformModel;
570
203
  declare class FileStoragePlatformModel {
571
204
  }
572
205
  declare namespace FileStoragePlatformModel {
573
- export { ProxyResponse, FailedResponse, CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
206
+ export { FailedBrowseFilesResult, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, ProxyFileAccess, DestinationNamespace, CopyFiles, Urls, SignUrlResult, SignUrl, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
574
207
  }
575
- /** @returns {ProxyResponse} */
576
- declare function ProxyResponse(): ProxyResponse;
577
- type ProxyResponse = {
578
- data?: any;
579
- support?: any;
580
- };
581
- /** @returns {FailedResponse} */
582
- declare function FailedResponse(): FailedResponse;
583
- type FailedResponse = {
208
+ /** @returns {FailedBrowseFilesResult} */
209
+ declare function FailedBrowseFilesResult(): FailedBrowseFilesResult;
210
+ type FailedBrowseFilesResult = {
584
211
  message: string;
585
212
  };
586
213
  /** @returns {CDN} */
@@ -596,9 +223,9 @@ type Upload = {
596
223
  expiry: number;
597
224
  url: string;
598
225
  };
599
- /** @returns {StartResponse} */
600
- declare function StartResponse(): StartResponse;
601
- type StartResponse = {
226
+ /** @returns {FileUpload} */
227
+ declare function FileUpload(): FileUpload;
228
+ type FileUpload = {
602
229
  file_name: string;
603
230
  file_path: string;
604
231
  content_type: string;
@@ -607,20 +234,11 @@ type StartResponse = {
607
234
  operation: string;
608
235
  size: number;
609
236
  upload: Upload;
610
- cdn: CDN;
611
237
  tags?: string[];
612
238
  };
613
- /** @returns {Params} */
614
- declare function Params(): Params;
615
- type Params = {
616
- /**
617
- * - The subpath for the file.
618
- */
619
- subpath?: string;
620
- };
621
- /** @returns {StartRequest} */
622
- declare function StartRequest(): StartRequest;
623
- type StartRequest = {
239
+ /** @returns {FileUploadStart} */
240
+ declare function FileUploadStart(): FileUploadStart;
241
+ type FileUploadStart = {
624
242
  file_name: string;
625
243
  content_type: string;
626
244
  size: number;
@@ -632,9 +250,9 @@ declare function CreatedBy(): CreatedBy;
632
250
  type CreatedBy = {
633
251
  username?: string;
634
252
  };
635
- /** @returns {CompleteResponse} */
636
- declare function CompleteResponse(): CompleteResponse;
637
- type CompleteResponse = {
253
+ /** @returns {FileUploadComplete} */
254
+ declare function FileUploadComplete(): FileUploadComplete;
255
+ type FileUploadComplete = {
638
256
  _id: string;
639
257
  file_name: string;
640
258
  file_path: string;
@@ -651,6 +269,16 @@ type CompleteResponse = {
651
269
  modified_on: string;
652
270
  created_by?: CreatedBy;
653
271
  };
272
+ /** @returns {ProxyFileAccess} */
273
+ declare function ProxyFileAccess(): ProxyFileAccess;
274
+ type ProxyFileAccess = {
275
+ /**
276
+ * - A boolean value indicating whether the proxy
277
+ * request was successful. Returns true when the external URL was successfully
278
+ * fetched and processed.
279
+ */
280
+ success?: boolean;
281
+ };
654
282
  /** @returns {DestinationNamespace} */
655
283
  declare function DestinationNamespace(): DestinationNamespace;
656
284
  type DestinationNamespace = {
@@ -669,516 +297,77 @@ type Urls = {
669
297
  signed_url: string;
670
298
  expiry: number;
671
299
  };
672
- /** @returns {SignUrlResponse} */
673
- declare function SignUrlResponse(): SignUrlResponse;
674
- type SignUrlResponse = {
300
+ /** @returns {SignUrlResult} */
301
+ declare function SignUrlResult(): SignUrlResult;
302
+ type SignUrlResult = {
675
303
  urls: Urls[];
676
304
  };
677
- /** @returns {SignUrlRequest} */
678
- declare function SignUrlRequest(): SignUrlRequest;
679
- type SignUrlRequest = {
305
+ /** @returns {SignUrl} */
306
+ declare function SignUrl(): SignUrl;
307
+ type SignUrl = {
680
308
  expiry: number;
681
309
  urls: string[];
682
310
  };
683
- /** @returns {InvoiceTypesDataResponse} */
684
- declare function InvoiceTypesDataResponse(): InvoiceTypesDataResponse;
685
- type InvoiceTypesDataResponse = {
686
- status?: boolean;
687
- _id: string;
688
- pdf_type_id: number;
689
- name: string;
690
- format: string[];
691
- __v: number;
692
- visibility: boolean;
693
- country_code: string;
694
- };
695
- /** @returns {InvoiceTypesResponse} */
696
- declare function InvoiceTypesResponse(): InvoiceTypesResponse;
697
- type InvoiceTypesResponse = {
698
- data: InvoiceTypesDataResponse[];
699
- success: boolean;
700
- };
701
- /** @returns {ConversionRate} */
702
- declare function ConversionRate(): ConversionRate;
703
- type ConversionRate = {
704
- base?: string;
705
- rates?: any;
706
- timestamp?: number;
707
- };
708
- /** @returns {DeliveryPartnerDetail} */
709
- declare function DeliveryPartnerDetail(): DeliveryPartnerDetail;
710
- type DeliveryPartnerDetail = {
711
- name?: string;
712
- awb_number_barcode?: string;
713
- awb_number?: string;
714
- origin?: string;
715
- destination?: string;
716
- eway_bill_number?: string;
717
- };
718
- /** @returns {Image} */
719
- declare function Image(): Image;
720
- type Image = {
721
- sales_channel_logo?: string;
722
- };
723
- /** @returns {PaymentData} */
724
- declare function PaymentData(): PaymentData;
725
- type PaymentData = {
726
- payment_type?: string;
727
- amount?: number;
728
- date?: string;
729
- transaction_id?: string;
730
- time?: string;
731
- mode?: string;
732
- name?: string;
733
- meta?: any;
734
- };
735
- /** @returns {InvoiceDetail} */
736
- declare function InvoiceDetail(): InvoiceDetail;
737
- type InvoiceDetail = {
738
- invoice_id?: string;
739
- invoice_date?: string;
740
- irn?: string;
741
- external_order_id?: string;
742
- shipment_id?: string;
743
- signed_qrcode?: string;
744
- upi_qrcode?: string;
745
- device_id?: string;
746
- marketplace_invoice_id?: string;
747
- marketplace_shipment_id?: string;
748
- channel_order_id?: string;
749
- };
750
- /** @returns {CompanyDetail} */
751
- declare function CompanyDetail(): CompanyDetail;
752
- type CompanyDetail = {
753
- /**
754
- * - The official name of the company.
755
- */
756
- name?: string;
757
- /**
758
- * - The physical street address of the company.
759
- */
760
- address?: string;
761
- /**
762
- * - The city where the company is located.
763
- */
764
- city?: string;
765
- /**
766
- * - The state or province where the company is located.
767
- */
768
- state?: string;
769
- /**
770
- * - The country where the company is based.
771
- */
772
- country?: string;
773
- /**
774
- * - The postal code for the company's location.
775
- */
776
- zip_code?: number;
777
- /**
778
- * - A code representing the state, often used
779
- * in official documents and forms.
780
- */
781
- state_code?: string;
782
- /**
783
- * - The code of the country.
784
- */
785
- country_code?: string;
786
- /**
787
- * - The Goods and Services Tax Identification
788
- * Number, unique to each business in India.
789
- */
790
- gstin?: string;
791
- /**
792
- * - The Permanent Account Number, unique to each
793
- * taxpayer in India.
794
- */
795
- pan?: string;
796
- /**
797
- * - The primary contact phone number for the company.
798
- */
799
- phone_no?: string;
800
- /**
801
- * - The Corporate Identification Number, unique to
802
- * each company registered in India.
803
- */
804
- cin?: string;
805
- /**
806
- * - The URL to the company's official website.
807
- */
808
- website_url?: string;
809
- /**
810
- * - The company's official email address.
811
- */
812
- email?: string;
813
- /**
814
- * - The display address of the company.
815
- */
816
- display_address?: string;
817
- /**
818
- * - The sector in which company is located.
819
- */
820
- sector?: string;
821
- /**
822
- * - The provided phone no of country.
823
- */
824
- phone?: any;
825
- /**
826
- * - The trn no of the company.
827
- */
828
- trn?: string;
311
+ /** @returns {PdfConfig} */
312
+ declare function PdfConfig(): PdfConfig;
313
+ type PdfConfig = {
829
314
  /**
830
- * - The vat no of the company.
315
+ * - This is invoice document format such as A4, A6, POS
831
316
  */
832
- vat?: string;
317
+ format?: string;
833
318
  /**
834
- * - The bussiness country timezone.
319
+ * - This is html template string.
835
320
  */
836
- business_country_timezone?: string;
321
+ template?: string;
837
322
  /**
838
- * - This object represents the
839
- * bussiness country currency.
323
+ * - This field holds an identifier for the type of PDF.
840
324
  */
841
- business_country_currency?: any;
325
+ pdf_type_id?: number;
842
326
  /**
843
- * - This object represents the meta fields for company.
327
+ * - This field contains the country code.
844
328
  */
845
- meta?: any;
846
- };
847
- /** @returns {StoreDetail} */
848
- declare function StoreDetail(): StoreDetail;
849
- type StoreDetail = {
850
- store_name?: string;
851
- address?: string;
852
- city?: string;
853
- state?: string;
854
- country?: string;
855
- country_code?: string;
856
- zip_code?: string;
857
- state_code?: string;
858
- gstin?: string;
859
- display_address?: string;
860
- sector?: string;
861
- store_id?: string;
862
- };
863
- /** @returns {CustomerBillingDetail} */
864
- declare function CustomerBillingDetail(): CustomerBillingDetail;
865
- type CustomerBillingDetail = {
866
- name?: string;
867
- phone_no?: string;
868
- address?: string;
869
- city?: string;
870
- state?: string;
871
- country?: string;
872
- country_code?: string;
873
- zip_code?: string;
874
- state_code?: string;
875
- gstin?: string;
876
- display_address?: string;
877
- sector?: string;
878
- email?: string;
879
- };
880
- /** @returns {CustomerShippingDetail} */
881
- declare function CustomerShippingDetail(): CustomerShippingDetail;
882
- type CustomerShippingDetail = {
883
- name?: string;
884
- phone_no?: string;
885
- address?: string;
886
- city?: string;
887
- state?: string;
888
- country?: string;
889
- country_code?: string;
890
- zip_code?: string;
891
- state_code?: string;
892
- gstin?: string;
893
- display_address?: string;
894
- sector?: string;
895
- };
896
- /** @returns {ReturnDetail} */
897
- declare function ReturnDetail(): ReturnDetail;
898
- type ReturnDetail = {
899
- address?: string;
900
- city?: string;
901
- state?: string;
902
- country?: string;
903
- country_code?: string;
904
- zip_code?: string;
905
- state_code?: string;
906
- gstin?: string;
907
- display_address?: string;
908
- sector?: string;
909
- };
910
- /** @returns {Brand} */
911
- declare function Brand(): Brand;
912
- type Brand = {
913
- logo?: string;
914
- name?: string;
915
- };
916
- /** @returns {Cgst} */
917
- declare function Cgst(): Cgst;
918
- type Cgst = {
919
- value?: number;
920
- percent?: number;
921
- };
922
- /** @returns {Sgst} */
923
- declare function Sgst(): Sgst;
924
- type Sgst = {
925
- value?: number;
926
- percent?: number;
927
- };
928
- /** @returns {Igst} */
929
- declare function Igst(): Igst;
930
- type Igst = {
931
- value?: number;
932
- percent?: number;
933
- };
934
- /** @returns {Tax} */
935
- declare function Tax(): Tax;
936
- type Tax = {
937
- cgst?: Cgst;
938
- sgst?: Sgst;
939
- igst?: Igst;
940
- };
941
- /** @returns {ItemsProductTable} */
942
- declare function ItemsProductTable(): ItemsProductTable;
943
- type ItemsProductTable = {
944
- name?: string;
945
- seller_identifier?: string;
946
- total?: number;
947
- brand?: Brand;
948
- hsn_code?: string;
949
- item_code?: string;
950
- total_units?: number;
951
- size?: string;
952
- mrp?: number;
953
- discount?: number;
954
- taxable_amount?: number;
955
- total_taxable_amount?: number;
956
- tax?: Tax;
957
- meta?: any;
958
- country_of_origin?: string;
959
- };
960
- /** @returns {ProductTable} */
961
- declare function ProductTable(): ProductTable;
962
- type ProductTable = {
963
- total_items?: number;
964
- products?: ItemsProductTable[];
965
- grand_total?: number;
966
- delivery_charges?: number;
967
- delivery_charge_text?: string;
968
- cod_charges?: number;
969
- fynd_discounts?: number;
970
- total_in_words?: string;
971
- gift_price?: number;
972
- total_quantity?: number;
973
- sub_total?: number;
974
- discount?: number;
975
- promotion?: number;
976
- coupon?: number;
977
- reward?: number;
978
- round_off?: number;
979
- total_value_of_goods?: number;
980
- };
981
- /** @returns {Taxes} */
982
- declare function Taxes(): Taxes;
983
- type Taxes = {
984
- hsn_code?: string;
985
- tax?: Tax;
986
- total_tax_value?: number;
987
- };
988
- /** @returns {TaxTable} */
989
- declare function TaxTable(): TaxTable;
990
- type TaxTable = {
991
- taxes?: Taxes[];
992
- total_tax?: number;
993
- tax_in_words?: string;
994
- };
995
- /** @returns {RegisteredCompanyDetail} */
996
- declare function RegisteredCompanyDetail(): RegisteredCompanyDetail;
997
- type RegisteredCompanyDetail = {
998
- address?: string;
999
- city?: string;
1000
- state?: string;
1001
- country?: string;
1002
329
  country_code?: string;
1003
- zip_code?: number;
1004
- state_code?: string;
1005
- display_address?: string;
1006
- sector?: string;
1007
- };
1008
- /** @returns {Kwargs} */
1009
- declare function Kwargs(): Kwargs;
1010
- type Kwargs = {
1011
- value?: string;
1012
- };
1013
- /** @returns {ShipmentIdBarcodeGenerator} */
1014
- declare function ShipmentIdBarcodeGenerator(): ShipmentIdBarcodeGenerator;
1015
- type ShipmentIdBarcodeGenerator = {
1016
- method?: string;
1017
- kwargs?: Kwargs;
1018
- };
1019
- /** @returns {SignedQrcodeGenerator} */
1020
- declare function SignedQrcodeGenerator(): SignedQrcodeGenerator;
1021
- type SignedQrcodeGenerator = {
1022
- method?: string;
1023
- kwargs?: Kwargs;
1024
- };
1025
- /** @returns {KwargsUpiQrcode} */
1026
- declare function KwargsUpiQrcode(): KwargsUpiQrcode;
1027
- type KwargsUpiQrcode = {
1028
- qr_data?: string;
1029
- qr_url?: string;
1030
- };
1031
- /** @returns {UpiQrcodeGenerator} */
1032
- declare function UpiQrcodeGenerator(): UpiQrcodeGenerator;
1033
- type UpiQrcodeGenerator = {
1034
- method?: string;
1035
- kwargs?: KwargsUpiQrcode;
1036
- };
1037
- /** @returns {DigitalsignatureGenerator} */
1038
- declare function DigitalsignatureGenerator(): DigitalsignatureGenerator;
1039
- type DigitalsignatureGenerator = {
1040
- method?: string;
1041
- kwargs?: Kwargs;
1042
- };
1043
- /** @returns {KwargsAwbNumber} */
1044
- declare function KwargsAwbNumber(): KwargsAwbNumber;
1045
- type KwargsAwbNumber = {
1046
- value?: any[];
1047
- };
1048
- /** @returns {AwbNumberLabelBarcodeGenerator} */
1049
- declare function AwbNumberLabelBarcodeGenerator(): AwbNumberLabelBarcodeGenerator;
1050
- type AwbNumberLabelBarcodeGenerator = {
1051
- method?: string;
1052
- kwargs?: KwargsAwbNumber;
1053
- };
1054
- /** @returns {AwbNumberBarcodeGenerator} */
1055
- declare function AwbNumberBarcodeGenerator(): AwbNumberBarcodeGenerator;
1056
- type AwbNumberBarcodeGenerator = {
1057
- method?: string;
1058
- kwargs?: Kwargs;
1059
- };
1060
- /** @returns {MetaProperty} */
1061
- declare function MetaProperty(): MetaProperty;
1062
- type MetaProperty = {
1063
- shipment_id_barcode_generator?: ShipmentIdBarcodeGenerator;
1064
- signed_qrcode_generator?: SignedQrcodeGenerator;
1065
- upi_qrcode_generator?: UpiQrcodeGenerator;
1066
- digitalsignature_generator?: DigitalsignatureGenerator;
1067
- awb_number_label_barcode_generator?: AwbNumberLabelBarcodeGenerator;
1068
- awb_number_barcode_generator?: AwbNumberBarcodeGenerator;
1069
- };
1070
- /** @returns {Meta} */
1071
- declare function Meta(): Meta;
1072
- type Meta = {
1073
- generator?: MetaProperty;
1074
- };
1075
- /** @returns {DummyTemplateDataPayload} */
1076
- declare function DummyTemplateDataPayload(): DummyTemplateDataPayload;
1077
- type DummyTemplateDataPayload = {
1078
- is_export?: boolean;
1079
- is_export_shipment?: boolean;
1080
- app_domain_name?: string;
1081
- txn_id?: string;
1082
- utr?: string;
1083
- po_number?: string;
1084
- credit_note_id?: string;
1085
- current_date?: string;
1086
- total_value_of_goods?: number;
1087
- b2b_buyer_details?: any;
1088
- is_qwik?: any;
1089
- order_type?: string;
1090
- conversion_rate?: ConversionRate;
1091
- currency_code?: string;
1092
- shipment_id?: string;
1093
- delivery_partner_detail?: DeliveryPartnerDetail;
1094
- image?: Image;
1095
- payments?: PaymentData[];
1096
- invoice_detail?: InvoiceDetail;
1097
- company_detail?: CompanyDetail;
1098
- store_detail?: StoreDetail;
1099
- customer_billing_detail?: CustomerBillingDetail;
1100
- customer_shipping_detail?: CustomerShippingDetail;
1101
- return_detail?: ReturnDetail;
1102
- product_table?: ProductTable;
1103
- tax_table?: TaxTable;
1104
- declaration_texts?: string[];
1105
- registered_company_detail?: RegisteredCompanyDetail;
1106
- disclaimer?: string;
1107
- meta?: Meta;
1108
- is_self_ship?: boolean;
1109
- mode?: string;
1110
- is_self_pickup?: boolean;
1111
330
  /**
1112
- * - This field represents the shipment meta details
331
+ * - This field indicates whether the
332
+ * fetched HTML template is the default template.
1113
333
  */
1114
- shipment_meta?: any;
1115
- /**
1116
- * - This field represents the order meta details
1117
- */
1118
- order_meta?: any;
1119
- platform_name?: string;
1120
- amount_to_be_collected?: number;
1121
- amount_paid?: number;
1122
- waybills?: any[];
1123
- total_items?: number;
1124
- brand_logo?: string;
1125
- shipment_id_barcode?: string;
1126
- signed_qrcode?: string;
1127
- upi_qrcode?: string;
1128
- digitalsignature?: string;
1129
- awb_number_barcode?: string;
1130
- uid?: string;
334
+ default_template?: boolean;
1131
335
  };
1132
- /** @returns {DummyTemplateData} */
1133
- declare function DummyTemplateData(): DummyTemplateData;
1134
- type DummyTemplateData = {
336
+ /** @returns {PdfConfigSuccessData} */
337
+ declare function PdfConfigSuccessData(): PdfConfigSuccessData;
338
+ type PdfConfigSuccessData = {
1135
339
  /**
1136
340
  * - This field contains the unique identifier for the
1137
- * PDF payload.
341
+ * PDF configuration.
1138
342
  */
1139
343
  _id?: string;
1140
344
  /**
1141
- * - This is invoice unique id
345
+ * - This field holds the identifier for the
346
+ * company associated with the PDF configuration.
1142
347
  */
1143
- pdf_type_id?: number;
1144
- payload: DummyTemplateDataPayload;
348
+ company_id?: number;
1145
349
  /**
1146
- * - This field represents the country code.
350
+ * - This field contains the identifier for
351
+ * the application that uses this PDF configuration.
1147
352
  */
1148
- country_code?: string;
353
+ application_id?: string;
1149
354
  /**
1150
- * - This field holds the version number.
355
+ * - This field holds an identifier for the type of PDF.
1151
356
  */
1152
- __v?: number;
1153
- };
1154
- /** @returns {DummyTemplateDataItems} */
1155
- declare function DummyTemplateDataItems(): DummyTemplateDataItems;
1156
- type DummyTemplateDataItems = {
1157
- data: DummyTemplateData[];
1158
- success: boolean;
1159
- };
1160
- /** @returns {PdfConfig} */
1161
- declare function PdfConfig(): PdfConfig;
1162
- type PdfConfig = {
357
+ pdf_type_id?: number;
1163
358
  /**
1164
- * - This is invoice document format such as A4, A6, POS
359
+ * - This field specifies the format of the invoice document.
1165
360
  */
1166
361
  format?: string;
1167
362
  /**
1168
- * - This is html template string
363
+ * - This field contains the HTML template string
364
+ * for the PDF document.
1169
365
  */
1170
366
  template?: string;
1171
- pdf_type_id?: number;
1172
- };
1173
- /** @returns {PdfConfigSuccessData} */
1174
- declare function PdfConfigSuccessData(): PdfConfigSuccessData;
1175
- type PdfConfigSuccessData = {
1176
- _id?: string;
1177
- company_id?: number;
1178
- application_id?: string;
1179
- pdf_type_id?: number;
1180
- format?: string;
1181
- template?: string;
367
+ /**
368
+ * - This field holds the version number of the PDF
369
+ * configuration document.
370
+ */
1182
371
  __v?: number;
1183
372
  country_code?: string;
1184
373
  };
@@ -1205,25 +394,6 @@ type PdfConfigSaveSuccess = {
1205
394
  data?: PdfConfigSaveSuccessData;
1206
395
  success?: boolean;
1207
396
  };
1208
- /** @returns {PdfDefaultTemplateSuccess} */
1209
- declare function PdfDefaultTemplateSuccess(): PdfDefaultTemplateSuccess;
1210
- type PdfDefaultTemplateSuccess = {
1211
- data?: Document[];
1212
- /**
1213
- * - Indicates if the request was successful.
1214
- */
1215
- success?: boolean;
1216
- };
1217
- /** @returns {Document} */
1218
- declare function Document(): Document;
1219
- type Document = {
1220
- _id?: string;
1221
- pdf_type_id?: number;
1222
- format?: string;
1223
- template?: string;
1224
- country_code?: string;
1225
- __v?: number;
1226
- };
1227
397
  /** @returns {PaymentReceiptRequestBody} */
1228
398
  declare function PaymentReceiptRequestBody(): PaymentReceiptRequestBody;
1229
399
  type PaymentReceiptRequestBody = {