@gofynd/fdk-client-javascript 1.4.13 → 1.4.14

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 (294) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +60 -53
  6. package/sdk/application/Cart/CartApplicationClient.js +130 -53
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +489 -143
  8. package/sdk/application/Cart/CartApplicationModel.js +380 -159
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +38 -19
  10. package/sdk/application/Cart/CartApplicationValidator.js +34 -18
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +88 -68
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +114 -94
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +194 -142
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +171 -133
  15. package/sdk/application/Common/CommonApplicationClient.d.ts +3 -2
  16. package/sdk/application/Common/CommonApplicationClient.js +6 -5
  17. package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
  18. package/sdk/application/Common/CommonApplicationModel.js +6 -6
  19. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -27
  20. package/sdk/application/Configuration/ConfigurationApplicationClient.js +34 -27
  21. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +45 -57
  22. package/sdk/application/Configuration/ConfigurationApplicationModel.js +35 -47
  23. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
  24. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
  25. package/sdk/application/Content/ContentApplicationClient.d.ts +23 -33
  26. package/sdk/application/Content/ContentApplicationClient.js +54 -75
  27. package/sdk/application/Content/ContentApplicationModel.d.ts +93 -37
  28. package/sdk/application/Content/ContentApplicationModel.js +83 -32
  29. package/sdk/application/Content/ContentApplicationValidator.d.ts +23 -17
  30. package/sdk/application/Content/ContentApplicationValidator.js +15 -10
  31. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -8
  32. package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -13
  33. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -25
  34. package/sdk/application/FileStorage/FileStorageApplicationModel.js +16 -18
  35. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
  36. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
  37. package/sdk/application/Finance/FinanceApplicationClient.d.ts +36 -0
  38. package/sdk/application/Finance/FinanceApplicationClient.js +202 -0
  39. package/sdk/application/Finance/FinanceApplicationModel.d.ts +289 -0
  40. package/sdk/application/Finance/FinanceApplicationModel.js +208 -0
  41. package/sdk/application/Finance/FinanceApplicationValidator.d.ts +25 -0
  42. package/sdk/application/Finance/FinanceApplicationValidator.js +31 -0
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +2 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
  46. package/sdk/application/Lead/LeadApplicationModel.js +19 -19
  47. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +39 -16
  48. package/sdk/application/Logistic/LogisticApplicationClient.js +189 -21
  49. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +532 -173
  50. package/sdk/application/Logistic/LogisticApplicationModel.js +409 -139
  51. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +54 -9
  52. package/sdk/application/Logistic/LogisticApplicationValidator.js +42 -8
  53. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -10
  54. package/sdk/application/Order/OrderApplicationClient.js +96 -13
  55. package/sdk/application/Order/OrderApplicationModel.d.ts +434 -102
  56. package/sdk/application/Order/OrderApplicationModel.js +278 -73
  57. package/sdk/application/Order/OrderApplicationValidator.d.ts +17 -3
  58. package/sdk/application/Order/OrderApplicationValidator.js +15 -2
  59. package/sdk/application/Payment/PaymentApplicationClient.d.ts +96 -99
  60. package/sdk/application/Payment/PaymentApplicationClient.js +111 -114
  61. package/sdk/application/Payment/PaymentApplicationModel.d.ts +293 -289
  62. package/sdk/application/Payment/PaymentApplicationModel.js +243 -241
  63. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
  64. package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
  65. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -16
  66. package/sdk/application/Rewards/RewardsApplicationClient.js +19 -22
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
  69. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
  70. package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
  71. package/sdk/application/Share/ShareApplicationModel.js +1 -1
  72. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  73. package/sdk/application/Theme/ThemeApplicationClient.js +8 -6
  74. package/sdk/application/Theme/ThemeApplicationModel.d.ts +48 -17
  75. package/sdk/application/Theme/ThemeApplicationModel.js +42 -22
  76. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +16 -3
  77. package/sdk/application/Theme/ThemeApplicationValidator.js +9 -2
  78. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  79. package/sdk/application/User/UserApplicationClient.js +10 -10
  80. package/sdk/application/User/UserApplicationModel.d.ts +17 -17
  81. package/sdk/application/User/UserApplicationModel.js +16 -16
  82. package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
  83. package/sdk/application/User/UserApplicationValidator.js +2 -2
  84. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  85. package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
  86. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +11 -9
  87. package/sdk/application/Webhook/WebhookApplicationModel.js +8 -6
  88. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
  89. package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
  90. package/sdk/application/index.d.ts +1 -0
  91. package/sdk/application/index.js +2 -0
  92. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  93. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  94. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  95. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  96. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  97. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  98. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  99. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  100. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  101. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  102. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  103. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  104. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +767 -85
  105. package/sdk/partner/Logistics/LogisticsPartnerModel.js +429 -76
  106. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  107. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +120 -6
  108. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  109. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  110. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  111. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  112. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  113. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  114. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  115. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  116. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  117. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  118. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  119. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  120. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  121. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  122. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  123. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  124. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  125. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  126. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  127. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  128. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  129. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  130. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  131. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  132. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  133. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  134. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  135. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  136. package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
  137. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
  138. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
  139. package/sdk/platform/Cart/CartPlatformModel.d.ts +4978 -1303
  140. package/sdk/platform/Cart/CartPlatformModel.js +1922 -1217
  141. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +208 -183
  142. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +383 -358
  143. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +122 -126
  144. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +66 -68
  145. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +141 -118
  146. package/sdk/platform/Catalog/CatalogPlatformClient.js +193 -170
  147. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1516 -1766
  148. package/sdk/platform/Catalog/CatalogPlatformModel.js +1393 -1224
  149. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
  150. package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
  151. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  152. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  153. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  154. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  155. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  156. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  157. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  158. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  159. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  160. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  161. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  162. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  163. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  164. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  165. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  166. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  167. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  168. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  169. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  170. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  171. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  172. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  173. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  174. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  175. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  176. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  177. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
  178. package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
  179. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
  180. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
  181. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  182. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  183. package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
  184. package/sdk/platform/Content/ContentPlatformModel.js +521 -390
  185. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  186. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  187. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  188. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  189. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  190. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  191. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  192. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  193. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  194. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  195. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  196. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  197. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  198. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  199. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  200. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  201. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  202. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  203. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  204. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  205. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  206. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  207. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +15 -4
  208. package/sdk/platform/Order/OrderPlatformApplicationClient.js +83 -5
  209. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +25 -4
  210. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
  211. package/sdk/platform/Order/OrderPlatformClient.d.ts +178 -97
  212. package/sdk/platform/Order/OrderPlatformClient.js +589 -229
  213. package/sdk/platform/Order/OrderPlatformModel.d.ts +5447 -3071
  214. package/sdk/platform/Order/OrderPlatformModel.js +3496 -1653
  215. package/sdk/platform/Order/OrderPlatformValidator.d.ts +241 -176
  216. package/sdk/platform/Order/OrderPlatformValidator.js +153 -97
  217. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  218. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  219. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  220. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  221. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  222. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  223. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  224. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  225. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  226. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  227. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +327 -313
  228. package/sdk/platform/Payment/PaymentPlatformModel.js +283 -273
  229. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  230. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  231. package/sdk/platform/PlatformClient.d.ts +0 -2
  232. package/sdk/platform/PlatformClient.js +0 -4
  233. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  234. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  235. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  236. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  237. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  238. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  239. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +45 -35
  240. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +117 -38
  241. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +22 -13
  242. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +24 -12
  243. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
  244. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
  245. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +602 -341
  246. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +483 -284
  247. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
  248. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
  249. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  250. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  251. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  252. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  253. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  254. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  255. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  256. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  257. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  258. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  259. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  260. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  261. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  262. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  263. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  264. package/sdk/platform/User/UserPlatformModel.js +23 -23
  265. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  266. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  267. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  268. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  269. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  270. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  271. package/sdk/platform/index.d.ts +0 -1
  272. package/sdk/platform/index.js +0 -2
  273. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  274. package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
  275. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  276. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  277. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  278. package/sdk/public/Content/ContentPublicClient.js +791 -5
  279. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  280. package/sdk/public/Content/ContentPublicModel.js +649 -3
  281. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  282. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  283. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  284. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  285. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  286. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  287. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  288. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  289. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  290. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  291. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  292. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  293. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  294. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -1,12 +1,12 @@
1
1
  export = LogisticsPartnerModel;
2
2
  /**
3
- * @typedef BulkRegionServiceabilityTatRequest
3
+ * @typedef BulkRegionServiceabilityTatDetails
4
4
  * @property {string} country
5
5
  * @property {string} region
6
6
  * @property {string} type
7
7
  */
8
8
  /**
9
- * @typedef BulkRegionServiceabilityTatResponseItemData
9
+ * @typedef BulkRegionServiceabilityTatResultItemData
10
10
  * @property {string} [country]
11
11
  * @property {string} [region]
12
12
  * @property {string} [type]
@@ -16,19 +16,19 @@ export = LogisticsPartnerModel;
16
16
  * @property {string} [file_path]
17
17
  */
18
18
  /**
19
- * @typedef ErrorResponse
19
+ * @typedef ErrorResult
20
20
  * @property {string} value
21
21
  * @property {string} message
22
22
  * @property {string} type
23
23
  */
24
24
  /**
25
- * @typedef FailureResponse
25
+ * @typedef FailureResult
26
26
  * @property {boolean} success
27
- * @property {ErrorResponse[]} error
27
+ * @property {ErrorResult[]} error
28
28
  */
29
29
  /**
30
- * @typedef BulkRegionServiceabilityTatResponse
31
- * @property {BulkRegionServiceabilityTatResponseItemData[]} [items]
30
+ * @typedef BulkRegionServiceabilityTatResult
31
+ * @property {BulkRegionServiceabilityTatResultItemData[]} [items]
32
32
  * @property {Page} [page]
33
33
  */
34
34
  /**
@@ -42,14 +42,178 @@ export = LogisticsPartnerModel;
42
42
  * @property {number} [size] - The number of items per page.
43
43
  */
44
44
  /**
45
- * @typedef BulkRegionJobSerializer
45
+ * @typedef RegionTatItemResult
46
+ * @property {RegionTatResult[]} items
47
+ * @property {Page} page
48
+ */
49
+ /**
50
+ * @typedef RegionServiceabilityItemResult
51
+ * @property {RegionServiceabilityResult[]} items
52
+ * @property {Page} page
53
+ */
54
+ /**
55
+ * @typedef ServiceabilityDetailsResult
56
+ * @property {boolean} [first_mile] - Boolean value indicating whether
57
+ * first-mile service is available or not.
58
+ * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
59
+ * service is available or not.
60
+ * @property {number} [cod_limit] - Limit on the amount of cash on delivery
61
+ * (COD) payments allowed in the specified region.
62
+ * @property {boolean} [doorstep_return] - Indicates if doorstep return service
63
+ * is available. This refers to the ability to return items directly from the
64
+ * customer's doorstep.
65
+ * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
66
+ * service is available. This refers to the ability to perform quality checks
67
+ * on items at the customer's doorstep.
68
+ * @property {string} [pickup_cutoff] - Time of day by which pickups must be
69
+ * scheduled to be processed on the same day.
70
+ * @property {boolean} [installation] - Boolean value indicating whether
71
+ * installation services are available in the specified region or not.
72
+ * @property {string} [id] - Unique identifier for the serviceability record.
73
+ */
74
+ /**
75
+ * @typedef ServiceabilityDetails
76
+ * @property {boolean} [first_mile] - Boolean value indicating whether
77
+ * first-mile service is available or not.
78
+ * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
79
+ * service is available or not.
80
+ * @property {number} [cod_limit] - Limit on the amount of cash on delivery
81
+ * (COD) payments allowed in the specified region.
82
+ * @property {boolean} [doorstep_return] - Indicates if doorstep return service
83
+ * is available. This refers to the ability to return items directly from the
84
+ * customer's doorstep.
85
+ * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
86
+ * service is available. This refers to the ability to perform quality checks
87
+ * on items at the customer's doorstep.
88
+ * @property {string} [pickup_cutoff] - Time of day by which pickups must be
89
+ * scheduled to be processed on the same day.
90
+ * @property {boolean} [installation] - Boolean value indicating whether
91
+ * installation services are available in the specified region or not.
92
+ */
93
+ /**
94
+ * @typedef RegionServiceabilityResult
95
+ * @property {string} country_code - ISO2 code representing the country where
96
+ * the serviceability is being specified.
97
+ * @property {string} [state_code] - Code representing the state or province
98
+ * within the country where the serviceability is being specified.
99
+ * @property {string} [city_code] - Code representing the city within the state
100
+ * where the serviceability is being specified.
101
+ * @property {string} [sector_code] - Code representing a specific sector or
102
+ * district within the city where the serviceability is being specified.
103
+ * @property {string} [pincode] - Postal or ZIP code for the specific area
104
+ * within the city where the serviceability is being specified.
105
+ * @property {boolean} [first_mile] - Boolean value indicating whether
106
+ * first-mile service is available or not.
107
+ * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
108
+ * service is available or not.
109
+ * @property {number} [cod_limit] - Limit on the amount of cash on delivery
110
+ * (COD) payments allowed in the specified region.
111
+ * @property {boolean} [doorstep_return] - Indicates if doorstep return service
112
+ * is available. This refers to the ability to return items directly from the
113
+ * customer's doorstep.
114
+ * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
115
+ * service is available. This refers to the ability to perform quality checks
116
+ * on items at the customer's doorstep.
117
+ * @property {string} [pickup_cutoff] - Time of day by which pickups must be
118
+ * scheduled to be processed on the same day.
119
+ * @property {boolean} [installation] - Boolean value indicating whether
120
+ * installation services are available in the specified region or not.
121
+ * @property {string} id - Unique identifier for the serviceability record.
122
+ */
123
+ /**
124
+ * @typedef RegionServiceabilityDetails
125
+ * @property {string} country_code - ISO2 code representing the country where
126
+ * the serviceability is being specified.
127
+ * @property {string} [state_code] - Code representing the state or province
128
+ * within the country where the serviceability is being specified.
129
+ * @property {string} [city_code] - Code representing the city within the state
130
+ * where the serviceability is being specified.
131
+ * @property {string} [sector_code] - Code representing a specific sector or
132
+ * district within the city where the serviceability is being specified.
133
+ * @property {string} [pincode] - Postal or ZIP code for the specific area
134
+ * within the city where the serviceability is being specified.
135
+ * @property {boolean} [first_mile] - Boolean value indicating whether
136
+ * first-mile service is available or not.
137
+ * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
138
+ * service is available or not.
139
+ * @property {number} [cod_limit] - Limit on the amount of cash on delivery
140
+ * (COD) payments allowed in the specified region.
141
+ * @property {boolean} [doorstep_return] - Indicates if doorstep return service
142
+ * is available. This refers to the ability to return items directly from the
143
+ * customer's doorstep.
144
+ * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
145
+ * service is available. This refers to the ability to perform quality checks
146
+ * on items at the customer's doorstep.
147
+ * @property {string} [pickup_cutoff] - Time of day by which pickups must be
148
+ * scheduled to be processed on the same day.
149
+ * @property {boolean} [installation] - Boolean value indicating whether
150
+ * installation services are available in the specified region or not.
151
+ */
152
+ /**
153
+ * @typedef RegionTatDetails
154
+ * @property {string} from_country_code - ISO2 code representing the country of
155
+ * origin for the delivery.
156
+ * @property {string} [from_state_code] - Code representing the state or
157
+ * province of origin within the country.
158
+ * @property {string} [from_city_code] - Code representing the city of origin
159
+ * within the state.
160
+ * @property {string} [from_sector_code] - Code representing a specific sector
161
+ * or district within the city of origin.
162
+ * @property {string} [from_pincode] - Postal or ZIP code of the origin area.
163
+ * @property {string} to_country_code - ISO2 code representing the destination country.
164
+ * @property {string} [to_state_code] - Code representing the state or province
165
+ * of the destination within the country.
166
+ * @property {string} [to_city_code] - Code representing the city of destination
167
+ * within the state.
168
+ * @property {string} [to_sector_code] - Code representing a specific sector or
169
+ * district within the city of destination.
170
+ * @property {string} [to_pincode] - Postal or ZIP code of the destination area.
171
+ * @property {number} [max_delivery_time] - Maximum time required for delivery
172
+ * from the origin to the destination in seconds.
173
+ * @property {number} [min_delivery_time] - Minimum time required for delivery
174
+ * from the origin to the destination in seconds.
175
+ */
176
+ /**
177
+ * @typedef RegionTatUpdateDetails
178
+ * @property {number} [max_delivery_time] - Maximum time required for delivery
179
+ * from the origin to the destination in seconds.
180
+ * @property {number} [min_delivery_time] - Minimum time required for delivery
181
+ * from the origin to the destination in seconds.
182
+ */
183
+ /**
184
+ * @typedef RegionTatResult
185
+ * @property {string} from_country_code - ISO2 code representing the country of
186
+ * origin for the delivery.
187
+ * @property {string} [from_state_code] - Code representing the state or
188
+ * province of origin within the country.
189
+ * @property {string} [from_city_code] - Code representing the city of origin
190
+ * within the state.
191
+ * @property {string} [from_sector_code] - Code representing a specific sector
192
+ * or district within the city of origin.
193
+ * @property {string} [from_pincode] - Postal or ZIP code of the origin area.
194
+ * @property {string} to_country_code - ISO2 code representing the destination country.
195
+ * @property {string} [to_state_code] - Code representing the state or province
196
+ * of the destination within the country.
197
+ * @property {string} [to_city_code] - Code representing the city of destination
198
+ * within the state.
199
+ * @property {string} [to_sector_code] - Code representing a specific sector or
200
+ * district within the city of destination.
201
+ * @property {string} [to_pincode] - Postal or ZIP code of the destination area.
202
+ * @property {number} [max_delivery_time] - Maximum time required for delivery
203
+ * from the origin to the destination in seconds.
204
+ * @property {number} [min_delivery_time] - Minimum time required for delivery
205
+ * from the origin to the destination in seconds.
206
+ * @property {string} id - Unique identifier for the delivery time record.
207
+ */
208
+ /**
209
+ * @typedef BulkRegionJobDetails
46
210
  * @property {string} [file_path]
47
211
  * @property {string} country
48
212
  * @property {string} action
49
213
  * @property {string} region
50
214
  */
51
215
  /**
52
- * @typedef BulkRegionResponseItemData
216
+ * @typedef BulkRegionResultItemData
53
217
  * @property {string} file_path
54
218
  * @property {number} [failed]
55
219
  * @property {Object[]} [failed_records]
@@ -63,8 +227,8 @@ export = LogisticsPartnerModel;
63
227
  * @property {string} [error_file_path]
64
228
  */
65
229
  /**
66
- * @typedef BulkRegionResponse
67
- * @property {BulkRegionResponseItemData[]} items
230
+ * @typedef BulkRegionResult
231
+ * @property {BulkRegionResultItemData[]} items
68
232
  * @property {Page} page
69
233
  */
70
234
  /**
@@ -77,7 +241,7 @@ export = LogisticsPartnerModel;
77
241
  * @property {boolean} is_own_account
78
242
  */
79
243
  /**
80
- * @typedef CourierAccountRequestBody
244
+ * @typedef CourierAccountDetailsBody
81
245
  * @property {string} extension_id
82
246
  * @property {string} [account_id]
83
247
  * @property {string} scheme_id
@@ -86,17 +250,17 @@ export = LogisticsPartnerModel;
86
250
  * @property {boolean} is_own_account
87
251
  */
88
252
  /**
89
- * @typedef CourierPartnerAccountFailureResponse
253
+ * @typedef CourierPartnerAccountFailureResult
90
254
  * @property {boolean} success
91
- * @property {ErrorResponse[]} error
255
+ * @property {ErrorResult[]} error
92
256
  */
93
257
  /**
94
- * @typedef CompanyCourierPartnerAccountListResponse
95
- * @property {CourierAccountResponse[]} items
258
+ * @typedef CompanyCourierPartnerAccountListResult
259
+ * @property {CourierAccountResult[]} items
96
260
  * @property {Page} page
97
261
  */
98
262
  /**
99
- * @typedef CourierAccountResponse
263
+ * @typedef CourierAccountResult
100
264
  * @property {string} account_id
101
265
  * @property {string} scheme_id
102
266
  * @property {boolean} is_self_ship
@@ -118,7 +282,7 @@ export = LogisticsPartnerModel;
118
282
  * @property {CourierPartnerSchemeFeatures} feature
119
283
  */
120
284
  /**
121
- * @typedef CourierPartnerSchemeRequestModel
285
+ * @typedef CourierPartnerSchemeDetailsModel
122
286
  * @property {string} extension_id
123
287
  * @property {string} [scheme_id]
124
288
  * @property {string} name
@@ -132,24 +296,47 @@ export = LogisticsPartnerModel;
132
296
  */
133
297
  /**
134
298
  * @typedef CourierPartnerSchemeFeatures
135
- * @property {boolean} [doorstep_qc]
136
- * @property {boolean} [qr]
137
- * @property {boolean} [mps]
138
- * @property {boolean} [ndr]
139
- * @property {number} [ndr_attempts]
140
- * @property {boolean} [dangerous_goods]
141
- * @property {boolean} [fragile_goods]
142
- * @property {boolean} [restricted_goods]
143
- * @property {boolean} [cold_storage_goods]
144
- * @property {boolean} [doorstep_exchange]
145
- * @property {boolean} [doorstep_return]
146
- * @property {boolean} [product_installation]
147
- * @property {boolean} [openbox_delivery]
148
- * @property {string} [status_updates]
149
- * @property {boolean} [multi_pick_single_drop]
150
- * @property {boolean} [single_pick_multi_drop]
151
- * @property {boolean} [multi_pick_multi_drop]
152
- * @property {boolean} [ewaybill]
299
+ * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
300
+ * doorstep quality check services.
301
+ * @property {boolean} [qr] - Specifies whether the courier partner supports QR
302
+ * code-based operations.
303
+ * @property {boolean} [mps] - Denotes if the courier partner supports
304
+ * multi-part shipment services.
305
+ * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
306
+ * feature is supported by the courier partner.
307
+ * @property {number} [ndr_attempts] - Number of attempts allowed for resolving
308
+ * Non-Delivery Reports (NDR).
309
+ * @property {boolean} [dangerous_goods] - Specifies if the courier partner
310
+ * handles the transportation of dangerous goods.
311
+ * @property {boolean} [fragile_goods] - Indicates whether the courier partner
312
+ * manages the shipment of fragile goods.
313
+ * @property {boolean} [restricted_goods] - Indicates if the courier partner
314
+ * handles restricted goods, as per regulatory guidelines.
315
+ * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
316
+ * provides cold storage facilities for goods.
317
+ * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
318
+ * supports doorstep exchange services.
319
+ * @property {boolean} [doorstep_return] - Specifies if the courier partner
320
+ * offers doorstep return services.
321
+ * @property {boolean} [product_installation] - Indicates if the courier partner
322
+ * provides product installation services upon delivery.
323
+ * @property {boolean} [openbox_delivery] - Specifies whether the courier
324
+ * partner supports open-box delivery, allowing customers to inspect goods
325
+ * before accepting.
326
+ * @property {string} [status_updates] - Describes the type of status updates
327
+ * provided by the courier partner (e.g., real-time, periodic).
328
+ * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
329
+ * partner supports multiple pickups to a single drop location.
330
+ * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
331
+ * partner supports single pickup to multiple drop locations.
332
+ * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
333
+ * offers services for multiple pickups to multiple drop locations.
334
+ * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
335
+ * supports the generation of e-waybills for shipments.
336
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
337
+ * of items allowed in a quality check shipment.
338
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
339
+ * quantity of items allowed in a non-quality check shipment.
153
340
  */
154
341
  /**
155
342
  * @typedef ArithmeticOperations
@@ -159,7 +346,7 @@ export = LogisticsPartnerModel;
159
346
  * @property {number} [gte]
160
347
  */
161
348
  /**
162
- * @typedef CourierPartnerSchemeUpdateRequest
349
+ * @typedef CourierPartnerSchemeUpdateDetails
163
350
  * @property {string} name
164
351
  * @property {ArithmeticOperations} weight
165
352
  * @property {string} transport_type
@@ -188,27 +375,39 @@ export = LogisticsPartnerModel;
188
375
  * @property {string} [latitude]
189
376
  * @property {string} [longitude]
190
377
  * @property {string} [display_name]
378
+ * @property {boolean} [has_next_hierarchy] - More detailed hierarchical data is
379
+ * available, meaning states, cities, or other regions within the country have
380
+ * been populated in the system.
191
381
  */
192
382
  /**
193
383
  * @typedef HierarchyItems
194
384
  * @property {string} [display_name]
195
385
  * @property {string} [slug]
196
386
  */
387
+ /**
388
+ * @typedef ValidationError
389
+ * @property {string} message - A brief description of the error encountered.
390
+ * @property {string} field - The field in the request that caused the error.
391
+ */
392
+ /**
393
+ * @typedef StandardError
394
+ * @property {string} message - A brief description of the error.
395
+ */
197
396
  declare class LogisticsPartnerModel {
198
397
  }
199
398
  declare namespace LogisticsPartnerModel {
200
- export { BulkRegionServiceabilityTatRequest, BulkRegionServiceabilityTatResponseItemData, ErrorResponse, FailureResponse, BulkRegionServiceabilityTatResponse, Page, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, CourierAccount, CourierAccountRequestBody, CourierPartnerAccountFailureResponse, CompanyCourierPartnerAccountListResponse, CourierAccountResponse, CourierPartnerSchemeModel, CourierPartnerSchemeRequestModel, CourierPartnerSchemeFeatures, ArithmeticOperations, CourierPartnerSchemeUpdateRequest, GetCountries, GetCountriesItems, HierarchyItems };
399
+ export { BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, ErrorResult, FailureResult, BulkRegionServiceabilityTatResult, Page, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatUpdateDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccount, CourierAccountDetailsBody, CourierPartnerAccountFailureResult, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeModel, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeFeatures, ArithmeticOperations, CourierPartnerSchemeUpdateDetails, GetCountries, GetCountriesItems, HierarchyItems, ValidationError, StandardError };
201
400
  }
202
- /** @returns {BulkRegionServiceabilityTatRequest} */
203
- declare function BulkRegionServiceabilityTatRequest(): BulkRegionServiceabilityTatRequest;
204
- type BulkRegionServiceabilityTatRequest = {
401
+ /** @returns {BulkRegionServiceabilityTatDetails} */
402
+ declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
403
+ type BulkRegionServiceabilityTatDetails = {
205
404
  country: string;
206
405
  region: string;
207
406
  type: string;
208
407
  };
209
- /** @returns {BulkRegionServiceabilityTatResponseItemData} */
210
- declare function BulkRegionServiceabilityTatResponseItemData(): BulkRegionServiceabilityTatResponseItemData;
211
- type BulkRegionServiceabilityTatResponseItemData = {
408
+ /** @returns {BulkRegionServiceabilityTatResultItemData} */
409
+ declare function BulkRegionServiceabilityTatResultItemData(): BulkRegionServiceabilityTatResultItemData;
410
+ type BulkRegionServiceabilityTatResultItemData = {
212
411
  country?: string;
213
412
  region?: string;
214
413
  type?: string;
@@ -217,23 +416,23 @@ type BulkRegionServiceabilityTatResponseItemData = {
217
416
  failed_records?: any[];
218
417
  file_path?: string;
219
418
  };
220
- /** @returns {ErrorResponse} */
221
- declare function ErrorResponse(): ErrorResponse;
222
- type ErrorResponse = {
419
+ /** @returns {ErrorResult} */
420
+ declare function ErrorResult(): ErrorResult;
421
+ type ErrorResult = {
223
422
  value: string;
224
423
  message: string;
225
424
  type: string;
226
425
  };
227
- /** @returns {FailureResponse} */
228
- declare function FailureResponse(): FailureResponse;
229
- type FailureResponse = {
426
+ /** @returns {FailureResult} */
427
+ declare function FailureResult(): FailureResult;
428
+ type FailureResult = {
230
429
  success: boolean;
231
- error: ErrorResponse[];
430
+ error: ErrorResult[];
232
431
  };
233
- /** @returns {BulkRegionServiceabilityTatResponse} */
234
- declare function BulkRegionServiceabilityTatResponse(): BulkRegionServiceabilityTatResponse;
235
- type BulkRegionServiceabilityTatResponse = {
236
- items?: BulkRegionServiceabilityTatResponseItemData[];
432
+ /** @returns {BulkRegionServiceabilityTatResult} */
433
+ declare function BulkRegionServiceabilityTatResult(): BulkRegionServiceabilityTatResult;
434
+ type BulkRegionServiceabilityTatResult = {
435
+ items?: BulkRegionServiceabilityTatResultItemData[];
237
436
  page?: Page;
238
437
  };
239
438
  /** @returns {Page} */
@@ -268,17 +467,391 @@ type Page = {
268
467
  */
269
468
  size?: number;
270
469
  };
271
- /** @returns {BulkRegionJobSerializer} */
272
- declare function BulkRegionJobSerializer(): BulkRegionJobSerializer;
273
- type BulkRegionJobSerializer = {
470
+ /** @returns {RegionTatItemResult} */
471
+ declare function RegionTatItemResult(): RegionTatItemResult;
472
+ type RegionTatItemResult = {
473
+ items: RegionTatResult[];
474
+ page: Page;
475
+ };
476
+ /** @returns {RegionServiceabilityItemResult} */
477
+ declare function RegionServiceabilityItemResult(): RegionServiceabilityItemResult;
478
+ type RegionServiceabilityItemResult = {
479
+ items: RegionServiceabilityResult[];
480
+ page: Page;
481
+ };
482
+ /** @returns {ServiceabilityDetailsResult} */
483
+ declare function ServiceabilityDetailsResult(): ServiceabilityDetailsResult;
484
+ type ServiceabilityDetailsResult = {
485
+ /**
486
+ * - Boolean value indicating whether
487
+ * first-mile service is available or not.
488
+ */
489
+ first_mile?: boolean;
490
+ /**
491
+ * - Boolean value indicating whether last-mile
492
+ * service is available or not.
493
+ */
494
+ last_mile?: boolean;
495
+ /**
496
+ * - Limit on the amount of cash on delivery
497
+ * (COD) payments allowed in the specified region.
498
+ */
499
+ cod_limit?: number;
500
+ /**
501
+ * - Indicates if doorstep return service
502
+ * is available. This refers to the ability to return items directly from the
503
+ * customer's doorstep.
504
+ */
505
+ doorstep_return?: boolean;
506
+ /**
507
+ * - Indicates if doorstep quality check
508
+ * service is available. This refers to the ability to perform quality checks
509
+ * on items at the customer's doorstep.
510
+ */
511
+ doorstep_qc?: boolean;
512
+ /**
513
+ * - Time of day by which pickups must be
514
+ * scheduled to be processed on the same day.
515
+ */
516
+ pickup_cutoff?: string;
517
+ /**
518
+ * - Boolean value indicating whether
519
+ * installation services are available in the specified region or not.
520
+ */
521
+ installation?: boolean;
522
+ /**
523
+ * - Unique identifier for the serviceability record.
524
+ */
525
+ id?: string;
526
+ };
527
+ /** @returns {ServiceabilityDetails} */
528
+ declare function ServiceabilityDetails(): ServiceabilityDetails;
529
+ type ServiceabilityDetails = {
530
+ /**
531
+ * - Boolean value indicating whether
532
+ * first-mile service is available or not.
533
+ */
534
+ first_mile?: boolean;
535
+ /**
536
+ * - Boolean value indicating whether last-mile
537
+ * service is available or not.
538
+ */
539
+ last_mile?: boolean;
540
+ /**
541
+ * - Limit on the amount of cash on delivery
542
+ * (COD) payments allowed in the specified region.
543
+ */
544
+ cod_limit?: number;
545
+ /**
546
+ * - Indicates if doorstep return service
547
+ * is available. This refers to the ability to return items directly from the
548
+ * customer's doorstep.
549
+ */
550
+ doorstep_return?: boolean;
551
+ /**
552
+ * - Indicates if doorstep quality check
553
+ * service is available. This refers to the ability to perform quality checks
554
+ * on items at the customer's doorstep.
555
+ */
556
+ doorstep_qc?: boolean;
557
+ /**
558
+ * - Time of day by which pickups must be
559
+ * scheduled to be processed on the same day.
560
+ */
561
+ pickup_cutoff?: string;
562
+ /**
563
+ * - Boolean value indicating whether
564
+ * installation services are available in the specified region or not.
565
+ */
566
+ installation?: boolean;
567
+ };
568
+ /** @returns {RegionServiceabilityResult} */
569
+ declare function RegionServiceabilityResult(): RegionServiceabilityResult;
570
+ type RegionServiceabilityResult = {
571
+ /**
572
+ * - ISO2 code representing the country where
573
+ * the serviceability is being specified.
574
+ */
575
+ country_code: string;
576
+ /**
577
+ * - Code representing the state or province
578
+ * within the country where the serviceability is being specified.
579
+ */
580
+ state_code?: string;
581
+ /**
582
+ * - Code representing the city within the state
583
+ * where the serviceability is being specified.
584
+ */
585
+ city_code?: string;
586
+ /**
587
+ * - Code representing a specific sector or
588
+ * district within the city where the serviceability is being specified.
589
+ */
590
+ sector_code?: string;
591
+ /**
592
+ * - Postal or ZIP code for the specific area
593
+ * within the city where the serviceability is being specified.
594
+ */
595
+ pincode?: string;
596
+ /**
597
+ * - Boolean value indicating whether
598
+ * first-mile service is available or not.
599
+ */
600
+ first_mile?: boolean;
601
+ /**
602
+ * - Boolean value indicating whether last-mile
603
+ * service is available or not.
604
+ */
605
+ last_mile?: boolean;
606
+ /**
607
+ * - Limit on the amount of cash on delivery
608
+ * (COD) payments allowed in the specified region.
609
+ */
610
+ cod_limit?: number;
611
+ /**
612
+ * - Indicates if doorstep return service
613
+ * is available. This refers to the ability to return items directly from the
614
+ * customer's doorstep.
615
+ */
616
+ doorstep_return?: boolean;
617
+ /**
618
+ * - Indicates if doorstep quality check
619
+ * service is available. This refers to the ability to perform quality checks
620
+ * on items at the customer's doorstep.
621
+ */
622
+ doorstep_qc?: boolean;
623
+ /**
624
+ * - Time of day by which pickups must be
625
+ * scheduled to be processed on the same day.
626
+ */
627
+ pickup_cutoff?: string;
628
+ /**
629
+ * - Boolean value indicating whether
630
+ * installation services are available in the specified region or not.
631
+ */
632
+ installation?: boolean;
633
+ /**
634
+ * - Unique identifier for the serviceability record.
635
+ */
636
+ id: string;
637
+ };
638
+ /** @returns {RegionServiceabilityDetails} */
639
+ declare function RegionServiceabilityDetails(): RegionServiceabilityDetails;
640
+ type RegionServiceabilityDetails = {
641
+ /**
642
+ * - ISO2 code representing the country where
643
+ * the serviceability is being specified.
644
+ */
645
+ country_code: string;
646
+ /**
647
+ * - Code representing the state or province
648
+ * within the country where the serviceability is being specified.
649
+ */
650
+ state_code?: string;
651
+ /**
652
+ * - Code representing the city within the state
653
+ * where the serviceability is being specified.
654
+ */
655
+ city_code?: string;
656
+ /**
657
+ * - Code representing a specific sector or
658
+ * district within the city where the serviceability is being specified.
659
+ */
660
+ sector_code?: string;
661
+ /**
662
+ * - Postal or ZIP code for the specific area
663
+ * within the city where the serviceability is being specified.
664
+ */
665
+ pincode?: string;
666
+ /**
667
+ * - Boolean value indicating whether
668
+ * first-mile service is available or not.
669
+ */
670
+ first_mile?: boolean;
671
+ /**
672
+ * - Boolean value indicating whether last-mile
673
+ * service is available or not.
674
+ */
675
+ last_mile?: boolean;
676
+ /**
677
+ * - Limit on the amount of cash on delivery
678
+ * (COD) payments allowed in the specified region.
679
+ */
680
+ cod_limit?: number;
681
+ /**
682
+ * - Indicates if doorstep return service
683
+ * is available. This refers to the ability to return items directly from the
684
+ * customer's doorstep.
685
+ */
686
+ doorstep_return?: boolean;
687
+ /**
688
+ * - Indicates if doorstep quality check
689
+ * service is available. This refers to the ability to perform quality checks
690
+ * on items at the customer's doorstep.
691
+ */
692
+ doorstep_qc?: boolean;
693
+ /**
694
+ * - Time of day by which pickups must be
695
+ * scheduled to be processed on the same day.
696
+ */
697
+ pickup_cutoff?: string;
698
+ /**
699
+ * - Boolean value indicating whether
700
+ * installation services are available in the specified region or not.
701
+ */
702
+ installation?: boolean;
703
+ };
704
+ /** @returns {RegionTatDetails} */
705
+ declare function RegionTatDetails(): RegionTatDetails;
706
+ type RegionTatDetails = {
707
+ /**
708
+ * - ISO2 code representing the country of
709
+ * origin for the delivery.
710
+ */
711
+ from_country_code: string;
712
+ /**
713
+ * - Code representing the state or
714
+ * province of origin within the country.
715
+ */
716
+ from_state_code?: string;
717
+ /**
718
+ * - Code representing the city of origin
719
+ * within the state.
720
+ */
721
+ from_city_code?: string;
722
+ /**
723
+ * - Code representing a specific sector
724
+ * or district within the city of origin.
725
+ */
726
+ from_sector_code?: string;
727
+ /**
728
+ * - Postal or ZIP code of the origin area.
729
+ */
730
+ from_pincode?: string;
731
+ /**
732
+ * - ISO2 code representing the destination country.
733
+ */
734
+ to_country_code: string;
735
+ /**
736
+ * - Code representing the state or province
737
+ * of the destination within the country.
738
+ */
739
+ to_state_code?: string;
740
+ /**
741
+ * - Code representing the city of destination
742
+ * within the state.
743
+ */
744
+ to_city_code?: string;
745
+ /**
746
+ * - Code representing a specific sector or
747
+ * district within the city of destination.
748
+ */
749
+ to_sector_code?: string;
750
+ /**
751
+ * - Postal or ZIP code of the destination area.
752
+ */
753
+ to_pincode?: string;
754
+ /**
755
+ * - Maximum time required for delivery
756
+ * from the origin to the destination in seconds.
757
+ */
758
+ max_delivery_time?: number;
759
+ /**
760
+ * - Minimum time required for delivery
761
+ * from the origin to the destination in seconds.
762
+ */
763
+ min_delivery_time?: number;
764
+ };
765
+ /** @returns {RegionTatUpdateDetails} */
766
+ declare function RegionTatUpdateDetails(): RegionTatUpdateDetails;
767
+ type RegionTatUpdateDetails = {
768
+ /**
769
+ * - Maximum time required for delivery
770
+ * from the origin to the destination in seconds.
771
+ */
772
+ max_delivery_time?: number;
773
+ /**
774
+ * - Minimum time required for delivery
775
+ * from the origin to the destination in seconds.
776
+ */
777
+ min_delivery_time?: number;
778
+ };
779
+ /** @returns {RegionTatResult} */
780
+ declare function RegionTatResult(): RegionTatResult;
781
+ type RegionTatResult = {
782
+ /**
783
+ * - ISO2 code representing the country of
784
+ * origin for the delivery.
785
+ */
786
+ from_country_code: string;
787
+ /**
788
+ * - Code representing the state or
789
+ * province of origin within the country.
790
+ */
791
+ from_state_code?: string;
792
+ /**
793
+ * - Code representing the city of origin
794
+ * within the state.
795
+ */
796
+ from_city_code?: string;
797
+ /**
798
+ * - Code representing a specific sector
799
+ * or district within the city of origin.
800
+ */
801
+ from_sector_code?: string;
802
+ /**
803
+ * - Postal or ZIP code of the origin area.
804
+ */
805
+ from_pincode?: string;
806
+ /**
807
+ * - ISO2 code representing the destination country.
808
+ */
809
+ to_country_code: string;
810
+ /**
811
+ * - Code representing the state or province
812
+ * of the destination within the country.
813
+ */
814
+ to_state_code?: string;
815
+ /**
816
+ * - Code representing the city of destination
817
+ * within the state.
818
+ */
819
+ to_city_code?: string;
820
+ /**
821
+ * - Code representing a specific sector or
822
+ * district within the city of destination.
823
+ */
824
+ to_sector_code?: string;
825
+ /**
826
+ * - Postal or ZIP code of the destination area.
827
+ */
828
+ to_pincode?: string;
829
+ /**
830
+ * - Maximum time required for delivery
831
+ * from the origin to the destination in seconds.
832
+ */
833
+ max_delivery_time?: number;
834
+ /**
835
+ * - Minimum time required for delivery
836
+ * from the origin to the destination in seconds.
837
+ */
838
+ min_delivery_time?: number;
839
+ /**
840
+ * - Unique identifier for the delivery time record.
841
+ */
842
+ id: string;
843
+ };
844
+ /** @returns {BulkRegionJobDetails} */
845
+ declare function BulkRegionJobDetails(): BulkRegionJobDetails;
846
+ type BulkRegionJobDetails = {
274
847
  file_path?: string;
275
848
  country: string;
276
849
  action: string;
277
850
  region: string;
278
851
  };
279
- /** @returns {BulkRegionResponseItemData} */
280
- declare function BulkRegionResponseItemData(): BulkRegionResponseItemData;
281
- type BulkRegionResponseItemData = {
852
+ /** @returns {BulkRegionResultItemData} */
853
+ declare function BulkRegionResultItemData(): BulkRegionResultItemData;
854
+ type BulkRegionResultItemData = {
282
855
  file_path: string;
283
856
  failed?: number;
284
857
  failed_records?: any[];
@@ -291,10 +864,10 @@ type BulkRegionResponseItemData = {
291
864
  total?: number;
292
865
  error_file_path?: string;
293
866
  };
294
- /** @returns {BulkRegionResponse} */
295
- declare function BulkRegionResponse(): BulkRegionResponse;
296
- type BulkRegionResponse = {
297
- items: BulkRegionResponseItemData[];
867
+ /** @returns {BulkRegionResult} */
868
+ declare function BulkRegionResult(): BulkRegionResult;
869
+ type BulkRegionResult = {
870
+ items: BulkRegionResultItemData[];
298
871
  page: Page;
299
872
  };
300
873
  /** @returns {CourierAccount} */
@@ -307,9 +880,9 @@ type CourierAccount = {
307
880
  stage: string;
308
881
  is_own_account: boolean;
309
882
  };
310
- /** @returns {CourierAccountRequestBody} */
311
- declare function CourierAccountRequestBody(): CourierAccountRequestBody;
312
- type CourierAccountRequestBody = {
883
+ /** @returns {CourierAccountDetailsBody} */
884
+ declare function CourierAccountDetailsBody(): CourierAccountDetailsBody;
885
+ type CourierAccountDetailsBody = {
313
886
  extension_id: string;
314
887
  account_id?: string;
315
888
  scheme_id: string;
@@ -317,21 +890,21 @@ type CourierAccountRequestBody = {
317
890
  stage: string;
318
891
  is_own_account: boolean;
319
892
  };
320
- /** @returns {CourierPartnerAccountFailureResponse} */
321
- declare function CourierPartnerAccountFailureResponse(): CourierPartnerAccountFailureResponse;
322
- type CourierPartnerAccountFailureResponse = {
893
+ /** @returns {CourierPartnerAccountFailureResult} */
894
+ declare function CourierPartnerAccountFailureResult(): CourierPartnerAccountFailureResult;
895
+ type CourierPartnerAccountFailureResult = {
323
896
  success: boolean;
324
- error: ErrorResponse[];
897
+ error: ErrorResult[];
325
898
  };
326
- /** @returns {CompanyCourierPartnerAccountListResponse} */
327
- declare function CompanyCourierPartnerAccountListResponse(): CompanyCourierPartnerAccountListResponse;
328
- type CompanyCourierPartnerAccountListResponse = {
329
- items: CourierAccountResponse[];
899
+ /** @returns {CompanyCourierPartnerAccountListResult} */
900
+ declare function CompanyCourierPartnerAccountListResult(): CompanyCourierPartnerAccountListResult;
901
+ type CompanyCourierPartnerAccountListResult = {
902
+ items: CourierAccountResult[];
330
903
  page: Page;
331
904
  };
332
- /** @returns {CourierAccountResponse} */
333
- declare function CourierAccountResponse(): CourierAccountResponse;
334
- type CourierAccountResponse = {
905
+ /** @returns {CourierAccountResult} */
906
+ declare function CourierAccountResult(): CourierAccountResult;
907
+ type CourierAccountResult = {
335
908
  account_id: string;
336
909
  scheme_id: string;
337
910
  is_self_ship: boolean;
@@ -353,9 +926,9 @@ type CourierPartnerSchemeModel = {
353
926
  stage: string;
354
927
  feature: CourierPartnerSchemeFeatures;
355
928
  };
356
- /** @returns {CourierPartnerSchemeRequestModel} */
357
- declare function CourierPartnerSchemeRequestModel(): CourierPartnerSchemeRequestModel;
358
- type CourierPartnerSchemeRequestModel = {
929
+ /** @returns {CourierPartnerSchemeDetailsModel} */
930
+ declare function CourierPartnerSchemeDetailsModel(): CourierPartnerSchemeDetailsModel;
931
+ type CourierPartnerSchemeDetailsModel = {
359
932
  extension_id: string;
360
933
  scheme_id?: string;
361
934
  name: string;
@@ -370,24 +943,107 @@ type CourierPartnerSchemeRequestModel = {
370
943
  /** @returns {CourierPartnerSchemeFeatures} */
371
944
  declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
372
945
  type CourierPartnerSchemeFeatures = {
946
+ /**
947
+ * - Indicates if the courier partner offers
948
+ * doorstep quality check services.
949
+ */
373
950
  doorstep_qc?: boolean;
951
+ /**
952
+ * - Specifies whether the courier partner supports QR
953
+ * code-based operations.
954
+ */
374
955
  qr?: boolean;
956
+ /**
957
+ * - Denotes if the courier partner supports
958
+ * multi-part shipment services.
959
+ */
375
960
  mps?: boolean;
961
+ /**
962
+ * - Indicates if the Non-Delivery Report (NDR)
963
+ * feature is supported by the courier partner.
964
+ */
376
965
  ndr?: boolean;
966
+ /**
967
+ * - Number of attempts allowed for resolving
968
+ * Non-Delivery Reports (NDR).
969
+ */
377
970
  ndr_attempts?: number;
971
+ /**
972
+ * - Specifies if the courier partner
973
+ * handles the transportation of dangerous goods.
974
+ */
378
975
  dangerous_goods?: boolean;
976
+ /**
977
+ * - Indicates whether the courier partner
978
+ * manages the shipment of fragile goods.
979
+ */
379
980
  fragile_goods?: boolean;
981
+ /**
982
+ * - Indicates if the courier partner
983
+ * handles restricted goods, as per regulatory guidelines.
984
+ */
380
985
  restricted_goods?: boolean;
986
+ /**
987
+ * - Denotes if the courier partner
988
+ * provides cold storage facilities for goods.
989
+ */
381
990
  cold_storage_goods?: boolean;
991
+ /**
992
+ * - Indicates if the courier partner
993
+ * supports doorstep exchange services.
994
+ */
382
995
  doorstep_exchange?: boolean;
996
+ /**
997
+ * - Specifies if the courier partner
998
+ * offers doorstep return services.
999
+ */
383
1000
  doorstep_return?: boolean;
1001
+ /**
1002
+ * - Indicates if the courier partner
1003
+ * provides product installation services upon delivery.
1004
+ */
384
1005
  product_installation?: boolean;
1006
+ /**
1007
+ * - Specifies whether the courier
1008
+ * partner supports open-box delivery, allowing customers to inspect goods
1009
+ * before accepting.
1010
+ */
385
1011
  openbox_delivery?: boolean;
1012
+ /**
1013
+ * - Describes the type of status updates
1014
+ * provided by the courier partner (e.g., real-time, periodic).
1015
+ */
386
1016
  status_updates?: string;
1017
+ /**
1018
+ * - Indicates if the courier
1019
+ * partner supports multiple pickups to a single drop location.
1020
+ */
387
1021
  multi_pick_single_drop?: boolean;
1022
+ /**
1023
+ * - Indicates whether the courier
1024
+ * partner supports single pickup to multiple drop locations.
1025
+ */
388
1026
  single_pick_multi_drop?: boolean;
1027
+ /**
1028
+ * - Denotes if the courier partner
1029
+ * offers services for multiple pickups to multiple drop locations.
1030
+ */
389
1031
  multi_pick_multi_drop?: boolean;
1032
+ /**
1033
+ * - Specifies if the courier partner requires or
1034
+ * supports the generation of e-waybills for shipments.
1035
+ */
390
1036
  ewaybill?: boolean;
1037
+ /**
1038
+ * - Defines the maximum quantity
1039
+ * of items allowed in a quality check shipment.
1040
+ */
1041
+ qc_shipment_item_quantity?: number;
1042
+ /**
1043
+ * - Defines the maximum
1044
+ * quantity of items allowed in a non-quality check shipment.
1045
+ */
1046
+ non_qc_shipment_item_quantity?: number;
391
1047
  };
392
1048
  /** @returns {ArithmeticOperations} */
393
1049
  declare function ArithmeticOperations(): ArithmeticOperations;
@@ -397,9 +1053,9 @@ type ArithmeticOperations = {
397
1053
  lte?: number;
398
1054
  gte?: number;
399
1055
  };
400
- /** @returns {CourierPartnerSchemeUpdateRequest} */
401
- declare function CourierPartnerSchemeUpdateRequest(): CourierPartnerSchemeUpdateRequest;
402
- type CourierPartnerSchemeUpdateRequest = {
1056
+ /** @returns {CourierPartnerSchemeUpdateDetails} */
1057
+ declare function CourierPartnerSchemeUpdateDetails(): CourierPartnerSchemeUpdateDetails;
1058
+ type CourierPartnerSchemeUpdateDetails = {
403
1059
  name: string;
404
1060
  weight: ArithmeticOperations;
405
1061
  transport_type: string;
@@ -430,6 +1086,12 @@ type GetCountriesItems = {
430
1086
  latitude?: string;
431
1087
  longitude?: string;
432
1088
  display_name?: string;
1089
+ /**
1090
+ * - More detailed hierarchical data is
1091
+ * available, meaning states, cities, or other regions within the country have
1092
+ * been populated in the system.
1093
+ */
1094
+ has_next_hierarchy?: boolean;
433
1095
  };
434
1096
  /** @returns {HierarchyItems} */
435
1097
  declare function HierarchyItems(): HierarchyItems;
@@ -437,3 +1099,23 @@ type HierarchyItems = {
437
1099
  display_name?: string;
438
1100
  slug?: string;
439
1101
  };
1102
+ /** @returns {ValidationError} */
1103
+ declare function ValidationError(): ValidationError;
1104
+ type ValidationError = {
1105
+ /**
1106
+ * - A brief description of the error encountered.
1107
+ */
1108
+ message: string;
1109
+ /**
1110
+ * - The field in the request that caused the error.
1111
+ */
1112
+ field: string;
1113
+ };
1114
+ /** @returns {StandardError} */
1115
+ declare function StandardError(): StandardError;
1116
+ type StandardError = {
1117
+ /**
1118
+ * - A brief description of the error.
1119
+ */
1120
+ message: string;
1121
+ };