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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (298) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
  6. package/sdk/application/Cart/CartApplicationClient.js +270 -139
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +3 -3
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
  16. package/sdk/application/Content/ContentApplicationClient.js +197 -36
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  20. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +140 -21
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
  26. package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  30. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  31. package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
  32. package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
  33. package/sdk/application/User/UserApplicationClient.d.ts +13 -23
  34. package/sdk/application/User/UserApplicationClient.js +9 -57
  35. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  36. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  37. package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
  38. package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
  39. package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
  40. package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
  41. package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
  42. package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
  43. package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
  44. package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
  45. package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
  46. package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
  47. package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
  48. package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
  49. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
  50. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
  51. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
  52. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
  53. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
  54. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
  55. package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
  56. package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
  57. package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
  58. package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
  59. package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
  60. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
  61. package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
  62. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
  63. package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
  64. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
  65. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
  66. package/sdk/partner/PartnerClient.d.ts +6 -0
  67. package/sdk/partner/PartnerClient.js +9 -0
  68. package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
  69. package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
  70. package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
  71. package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
  72. package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
  73. package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
  74. package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
  75. package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
  76. package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
  77. package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
  78. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
  79. package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
  80. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
  81. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
  82. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
  83. package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
  84. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
  85. package/sdk/partner/index.d.ts +3 -0
  86. package/sdk/partner/index.js +6 -0
  87. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
  88. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
  89. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  90. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
  91. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  92. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  93. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
  94. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
  95. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  96. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  97. package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
  98. package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
  99. package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
  100. package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
  101. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
  102. package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
  103. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
  104. package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
  105. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
  106. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
  107. package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
  108. package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
  109. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
  110. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
  111. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
  112. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
  113. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
  114. package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
  115. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
  116. package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
  117. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
  118. package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
  119. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
  120. package/sdk/platform/Common/CommonPlatformClient.js +5 -6
  121. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  122. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  123. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
  124. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
  125. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
  126. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
  127. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
  128. package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
  129. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
  130. package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
  131. package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
  132. package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
  133. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
  134. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
  135. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
  136. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
  137. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
  138. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
  139. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
  140. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
  141. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
  142. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
  143. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
  144. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
  145. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
  146. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
  147. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
  148. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
  149. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
  150. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
  151. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
  152. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
  153. package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
  154. package/sdk/platform/Content/ContentPlatformClient.js +459 -379
  155. package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
  156. package/sdk/platform/Content/ContentPlatformModel.js +893 -582
  157. package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
  158. package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
  159. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
  160. package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
  161. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
  162. package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
  163. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  164. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  165. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
  166. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
  167. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
  168. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
  169. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  170. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
  171. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
  172. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
  173. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  174. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  175. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  176. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  177. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
  178. package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
  179. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  180. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  181. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
  182. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
  183. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
  184. package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
  185. package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
  186. package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
  187. package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
  188. package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
  189. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
  190. package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
  191. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
  192. package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
  193. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
  194. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
  195. package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
  196. package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
  197. package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
  198. package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
  199. package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
  200. package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
  201. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  202. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  203. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  204. package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
  205. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
  206. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
  207. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
  208. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
  209. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
  210. package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
  211. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
  212. package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
  213. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
  214. package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
  215. package/sdk/platform/PlatformClient.d.ts +2 -0
  216. package/sdk/platform/PlatformClient.js +4 -0
  217. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  218. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  219. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  220. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  221. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
  222. package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
  223. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
  224. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
  225. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
  226. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
  227. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
  228. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
  229. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
  230. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
  231. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
  232. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
  233. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
  234. package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
  235. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
  236. package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
  237. package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
  238. package/sdk/platform/Share/SharePlatformModel.js +3 -43
  239. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
  240. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
  241. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
  242. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
  243. package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
  244. package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
  245. package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
  246. package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
  247. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
  248. package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
  249. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
  250. package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
  251. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
  252. package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
  253. package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
  254. package/sdk/platform/User/UserPlatformModel.js +209 -216
  255. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  256. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  257. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
  258. package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
  259. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  260. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  261. package/sdk/platform/index.d.ts +1 -0
  262. package/sdk/platform/index.js +2 -0
  263. package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
  264. package/sdk/public/Billing/BillingPublicClient.js +397 -0
  265. package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
  266. package/sdk/public/Billing/BillingPublicModel.js +560 -0
  267. package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
  268. package/sdk/public/Billing/BillingPublicValidator.js +50 -0
  269. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
  270. package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
  271. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
  272. package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
  273. package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
  274. package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
  275. package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
  276. package/sdk/public/Content/ContentPublicClient.js +183 -0
  277. package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
  278. package/sdk/public/Content/ContentPublicModel.js +47 -1
  279. package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
  280. package/sdk/public/Content/ContentPublicValidator.js +19 -0
  281. package/sdk/public/PublicClient.d.ts +2 -2
  282. package/sdk/public/PublicClient.js +2 -2
  283. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  284. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  285. package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
  286. package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
  287. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  288. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  289. package/sdk/public/index.d.ts +1 -1
  290. package/sdk/public/index.js +1 -1
  291. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  292. package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
  293. package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
  294. package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
  295. package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
  296. package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
  297. package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
  298. package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
@@ -1,36 +1,38 @@
1
1
  export = LogisticsPartnerModel;
2
2
  /**
3
- * @typedef BulkRegionServiceabilityTatDetails
4
- * @property {string} country - Name of the country.
5
- * @property {string} region - Name of the region for which the
6
- * tat/serviceability file needs to be downloaded.
7
- * @property {string} type - Denotes the type of file.
3
+ * @typedef ErrorResponseV1
4
+ * @property {string} [error]
8
5
  */
9
6
  /**
10
- * @typedef BulkRegionServiceabilityTatResultItemData
11
- * @property {string} [country] - Name of the country.
12
- * @property {string} [region] - Name of the region for which the
13
- * tat/serviceability file needs to be downloaded.
14
- * @property {string} [type] - Denotes the type of data.
15
- * @property {string} [batch_id] - Unique identifier identifying the perticular request.
16
- * @property {string} [status] - Current status of the request.
17
- * @property {Object[]} [failed_records] - Information of records which failed
18
- * @property {string} [file_path] - CDN path of the file.
7
+ * @typedef BulkRegionServiceabilityTatRequest
8
+ * @property {string} country
9
+ * @property {string} region
10
+ * @property {string} type
19
11
  */
20
12
  /**
21
- * @typedef ErrorResult
22
- * @property {string} value - Fields containing the error.
23
- * @property {string} message - Description of the error.
24
- * @property {string} type - Type of the error.
13
+ * @typedef BulkRegionServiceabilityTatResponseItemData
14
+ * @property {string} [country]
15
+ * @property {string} [region]
16
+ * @property {string} [type]
17
+ * @property {string} [batch_id]
18
+ * @property {string} [status]
19
+ * @property {Object[]} [failed_records]
20
+ * @property {string} [file_path]
25
21
  */
26
22
  /**
27
- * @typedef FailureResult
28
- * @property {boolean} success - Denotes if the request was successfully executed.
29
- * @property {ErrorResult[]} error
23
+ * @typedef ErrorResponse
24
+ * @property {string} value
25
+ * @property {string} message
26
+ * @property {string} type
30
27
  */
31
28
  /**
32
- * @typedef BulkRegionServiceabilityTatResult
33
- * @property {BulkRegionServiceabilityTatResultItemData[]} [items]
29
+ * @typedef FailureResponse
30
+ * @property {boolean} success
31
+ * @property {ErrorResponse[]} error
32
+ */
33
+ /**
34
+ * @typedef BulkRegionServiceabilityTatResponse
35
+ * @property {BulkRegionServiceabilityTatResponseItemData[]} [items]
34
36
  * @property {Page} [page]
35
37
  */
36
38
  /**
@@ -42,439 +44,111 @@ export = LogisticsPartnerModel;
42
44
  * @property {number} [current] - The current page number.
43
45
  * @property {string} type - The type of the page, such as 'PageType'.
44
46
  * @property {number} [size] - The number of items per page.
47
+ * @property {number} [total] - Total number of items.
45
48
  */
46
49
  /**
47
- * @typedef CourierAccountUpdateDetails
48
- * @property {string} extension_id - Unique identifier of courier partner extension.
49
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
50
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
51
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
52
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
53
- * account or not.
54
- */
55
- /**
56
- * @typedef RegionTatItemResult
57
- * @property {RegionTatResult[]} items
58
- * @property {Page} page
59
- */
60
- /**
61
- * @typedef RegionServiceabilityItemResult
62
- * @property {RegionServiceabilityResult[]} items
63
- * @property {Page} page
64
- */
65
- /**
66
- * @typedef ServiceabilityDetailsResult
67
- * @property {boolean} [first_mile] - Boolean value indicating whether
68
- * first-mile service is available or not.
69
- * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
70
- * service is available or not.
71
- * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
72
- * region is first-mile serviceable or not in return pickup.
73
- * @property {number} [cod_limit] - Limit on the amount of cash on delivery
74
- * (COD) payments allowed in the specified region.
75
- * @property {boolean} [doorstep_return] - Indicates if doorstep return service
76
- * is available. This refers to the ability to return items directly from the
77
- * customer's doorstep.
78
- * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
79
- * service is available. This refers to the ability to perform quality checks
80
- * on items at the customer's doorstep.
81
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
82
- * scheduled to be processed on the same day.
83
- * @property {boolean} [installation] - Boolean value indicating whether
84
- * installation services are available in the specified region or not.
85
- * @property {string} [id] - Unique identifier for the serviceability record.
86
- */
87
- /**
88
- * @typedef ServiceabilityDetails
89
- * @property {boolean} [first_mile] - Boolean value indicating whether
90
- * first-mile service is available or not.
91
- * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
92
- * service is available or not.
93
- * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
94
- * region is first-mile serviceable or not in return pickup.
95
- * @property {number} [cod_limit] - Limit on the amount of cash on delivery
96
- * (COD) payments allowed in the specified region.
97
- * @property {boolean} [doorstep_return] - Indicates if doorstep return service
98
- * is available. This refers to the ability to return items directly from the
99
- * customer's doorstep.
100
- * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
101
- * service is available. This refers to the ability to perform quality checks
102
- * on items at the customer's doorstep.
103
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
104
- * scheduled to be processed on the same day.
105
- * @property {boolean} [installation] - Boolean value indicating whether
106
- * installation services are available in the specified region or not.
107
- */
108
- /**
109
- * @typedef RegionServiceabilityResult
110
- * @property {string} country_code - ISO2 code representing the country where
111
- * the serviceability is being specified.
112
- * @property {string} [state_code] - Code representing the state or province
113
- * within the country where the serviceability is being specified.
114
- * @property {string} [city_code] - Code representing the city within the state
115
- * where the serviceability is being specified.
116
- * @property {string} [sector_code] - Code representing a specific sector or
117
- * district within the city where the serviceability is being specified.
118
- * @property {string} [pincode] - Postal or ZIP code for the specific area
119
- * within the city where the serviceability is being specified.
120
- * @property {boolean} [first_mile] - Boolean value indicating whether
121
- * first-mile service is available or not.
122
- * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
123
- * service is available or not.
124
- * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
125
- * region is first-mile serviceable or not in return pickup.
126
- * @property {number} [cod_limit] - Limit on the amount of cash on delivery
127
- * (COD) payments allowed in the specified region.
128
- * @property {boolean} [doorstep_return] - Indicates if doorstep return service
129
- * is available. This refers to the ability to return items directly from the
130
- * customer's doorstep.
131
- * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
132
- * service is available. This refers to the ability to perform quality checks
133
- * on items at the customer's doorstep.
134
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
135
- * scheduled to be processed on the same day.
136
- * @property {boolean} [installation] - Boolean value indicating whether
137
- * installation services are available in the specified region or not.
138
- * @property {string} id - Unique identifier for the serviceability record.
139
- */
140
- /**
141
- * @typedef RegionServiceabilityDetails
142
- * @property {string} country_code - ISO2 code representing the country where
143
- * the serviceability is being specified.
144
- * @property {string} [state_code] - Code representing the state or province
145
- * within the country where the serviceability is being specified.
146
- * @property {string} [city_code] - Code representing the city within the state
147
- * where the serviceability is being specified.
148
- * @property {string} [sector_code] - Code representing a specific sector or
149
- * district within the city where the serviceability is being specified.
150
- * @property {string} [pincode] - Postal or ZIP code for the specific area
151
- * within the city where the serviceability is being specified.
152
- * @property {boolean} [first_mile] - Boolean value indicating whether
153
- * first-mile service is available or not.
154
- * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
155
- * service is available or not.
156
- * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
157
- * region is first-mile serviceable or not in return pickup.
158
- * @property {number} [cod_limit] - Limit on the amount of cash on delivery
159
- * (COD) payments allowed in the specified region.
160
- * @property {boolean} [doorstep_return] - Indicates if doorstep return service
161
- * is available. This refers to the ability to return items directly from the
162
- * customer's doorstep.
163
- * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
164
- * service is available. This refers to the ability to perform quality checks
165
- * on items at the customer's doorstep.
166
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
167
- * scheduled to be processed on the same day.
168
- * @property {boolean} [installation] - Boolean value indicating whether
169
- * installation services are available in the specified region or not.
170
- */
171
- /**
172
- * @typedef RegionTatDetails
173
- * @property {string} from_country_code - ISO2 code representing the country of
174
- * origin for the delivery.
175
- * @property {string} [from_state_code] - Code representing the state or
176
- * province of origin within the country.
177
- * @property {string} [from_city_code] - Code representing the city of origin
178
- * within the state.
179
- * @property {string} [from_sector_code] - Code representing a specific sector
180
- * or district within the city of origin.
181
- * @property {string} [from_pincode] - Postal or ZIP code of the origin area.
182
- * @property {string} to_country_code - ISO2 code representing the destination country.
183
- * @property {string} [to_state_code] - Code representing the state or province
184
- * of the destination within the country.
185
- * @property {string} [to_city_code] - Code representing the city of destination
186
- * within the state.
187
- * @property {string} [to_sector_code] - Code representing a specific sector or
188
- * district within the city of destination.
189
- * @property {string} [to_pincode] - Postal or ZIP code of the destination area.
190
- * @property {number} [max_delivery_time] - Maximum time required for delivery
191
- * from the origin to the destination in seconds.
192
- * @property {number} [min_delivery_time] - Minimum time required for delivery
193
- * from the origin to the destination in seconds.
194
- */
195
- /**
196
- * @typedef RegionTatUpdateDetails
197
- * @property {number} [max_delivery_time] - Maximum time required for delivery
198
- * from the origin to the destination in seconds.
199
- * @property {number} [min_delivery_time] - Minimum time required for delivery
200
- * from the origin to the destination in seconds.
201
- */
202
- /**
203
- * @typedef RegionTatResult
204
- * @property {string} from_country_code - ISO2 code representing the country of
205
- * origin for the delivery.
206
- * @property {string} [from_state_code] - Code representing the state or
207
- * province of origin within the country.
208
- * @property {string} [from_city_code] - Code representing the city of origin
209
- * within the state.
210
- * @property {string} [from_sector_code] - Code representing a specific sector
211
- * or district within the city of origin.
212
- * @property {string} [from_pincode] - Postal or ZIP code of the origin area.
213
- * @property {string} to_country_code - ISO2 code representing the destination country.
214
- * @property {string} [to_state_code] - Code representing the state or province
215
- * of the destination within the country.
216
- * @property {string} [to_city_code] - Code representing the city of destination
217
- * within the state.
218
- * @property {string} [to_sector_code] - Code representing a specific sector or
219
- * district within the city of destination.
220
- * @property {string} [to_pincode] - Postal or ZIP code of the destination area.
221
- * @property {number} [max_delivery_time] - Maximum time required for delivery
222
- * from the origin to the destination in seconds.
223
- * @property {number} [min_delivery_time] - Minimum time required for delivery
224
- * from the origin to the destination in seconds.
225
- * @property {string} id - Unique identifier for the delivery time record.
226
- */
227
- /**
228
- * @typedef BulkRegionJobDetails
229
- * @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
230
- * @property {string} country - Country for which the tat or serviceability is
231
- * to be imported or exported.
232
- * @property {string} action - Denotes the import or export action to be performed.
233
- * @property {string} region - Region of the country for which import or export
234
- * is triggered.
50
+ * @typedef BulkRegionJobSerializer
51
+ * @property {string} [file_path]
52
+ * @property {string} country
53
+ * @property {string} action
54
+ * @property {string} region
235
55
  */
236
56
  /**
237
- * @typedef BulkRegionResultItemData
238
- * @property {string} [file_path] - CDN path of the file which was used for bulk import.
239
- * @property {number} [failed] - Count of the failed records.
240
- * @property {Object[]} [failed_records] - Information of records which failed.
241
- * @property {string} action - Denotes the import or export action performed.
242
- * @property {string} batch_id - Unique id to identify the import or export query.
243
- * @property {string} country - Country for which the import or export action is
244
- * performed.
245
- * @property {number} [success] - Denoted if the import or export was successful
246
- * or failure.
247
- * @property {string} region - Region of the country for which import or export
248
- * is triggered.
249
- * @property {string} status - Current status of the import or export action performed.
250
- * @property {number} [total] - Count of total records.
251
- * @property {string} [error_file_path] - Path of the error file.
57
+ * @typedef BulkRegionResponseItemData
58
+ * @property {string} file_path
59
+ * @property {number} [failed]
60
+ * @property {Object[]} [failed_records]
61
+ * @property {string} action
62
+ * @property {string} batch_id
63
+ * @property {string} country
64
+ * @property {number} [success]
65
+ * @property {string} region
66
+ * @property {string} status
67
+ * @property {number} [total]
68
+ * @property {string} [error_file_path]
252
69
  */
253
70
  /**
254
- * @typedef BulkRegionResult
255
- * @property {BulkRegionResultItemData[]} items
71
+ * @typedef BulkRegionResponse
72
+ * @property {BulkRegionResponseItemData[]} items
256
73
  * @property {Page} page
257
74
  */
258
75
  /**
259
76
  * @typedef CourierAccount
260
- * @property {string} extension_id - Unique identifier of courier partner extension.
261
- * @property {string} account_id - Unique identifier of courier partner scheme
262
- * and company id combination.
263
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
264
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
265
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
266
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
267
- * account or not.
268
- */
269
- /**
270
- * @typedef CourierAccountDetailsBody
271
- * @property {string} extension_id - Unique identifier of courier partner extension.
272
- * @property {string} [account_id] - Unique identifier of courier partner scheme
273
- * and company id combination.
274
- * @property {string} scheme_id - Unique identifier of courier account.
275
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
276
- * @property {string} stage - Denotes whether the courier account is in enabled
277
- * or disabled stage.
278
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
279
- * account or not.
77
+ * @property {string} extension_id
78
+ * @property {string} account_id
79
+ * @property {string} scheme_id
80
+ * @property {boolean} is_self_ship
81
+ * @property {string} stage
82
+ * @property {boolean} is_own_account
280
83
  */
281
84
  /**
282
- * @typedef CourierPartnerAccountFailureResult
85
+ * @typedef CourierPartnerAccountFailureResponse
283
86
  * @property {boolean} success
284
- * @property {ErrorResult[]} error
87
+ * @property {ErrorResponse[]} error
285
88
  */
286
89
  /**
287
- * @typedef CompanyCourierPartnerAccountListResult
288
- * @property {CourierAccountResult[]} items
90
+ * @typedef CompanyCourierPartnerAccountListResponse
91
+ * @property {CourierAccountResponse[]} items
289
92
  * @property {Page} page
290
93
  */
291
94
  /**
292
- * @typedef CourierAccountResult
293
- * @property {string} account_id - Unique identifier of courier partner scheme
294
- * and company id combination.
295
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
95
+ * @typedef CourierAccountSchemeResponse
96
+ * @property {string} [extension_id]
97
+ * @property {string} [scheme_id]
98
+ * @property {string} [name]
99
+ * @property {ArithmeticOperations} [weight]
100
+ * @property {string} [transport_type]
101
+ * @property {string} [region]
102
+ * @property {string} [delivery_type]
103
+ * @property {string[]} [payment_mode]
104
+ * @property {string} [stage]
105
+ * @property {CourierPartnerSchemeFeatures} [feature]
106
+ */
107
+ /**
108
+ * @typedef CourierAccountResponse
109
+ * @property {number} [company_id]
110
+ * @property {string} [extension_id]
111
+ * @property {string} account_id
112
+ * @property {string} scheme_id
296
113
  * @property {boolean} is_self_ship
297
- * @property {string} stage - Denotes whether the courier account is in enabled
298
- * or disabled stage.
299
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
300
- * account or not.
301
- * @property {CourierPartnerSchemeModel} scheme_rules
114
+ * @property {string} stage
115
+ * @property {boolean} is_own_account
116
+ * @property {CourierAccountSchemeResponse} scheme_rules
302
117
  */
303
118
  /**
304
119
  * @typedef CourierPartnerSchemeModel
305
- * @property {string} extension_id - Unique identifier of courier partner extension.
306
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
307
- * @property {string} name - Name of the scheme
308
- * @property {ArithmeticOperations} weight
309
- * @property {string} transport_type - Mode of transport associated with the
310
- * courier partner scheme.
311
- * @property {string} region - Serviceable region associated with the courier
312
- * partner scheme.
313
- * @property {string} delivery_type - Type of delivery associated with the
314
- * courier partner scheme.
315
- * @property {string[]} payment_mode - Mode of payment associated with the
316
- * courier partner scheme.
317
- * @property {string} stage - Indicates if the courier partner scheme is
318
- * currently active or inactive.
319
- * @property {CourierPartnerSchemeFeatures} feature
320
- */
321
- /**
322
- * @typedef CourierPartnerSchemeDetailsModel
323
- * @property {string} extension_id - Unique identifier of courier partner extension.
324
- * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
325
- * @property {string} name - Name of the courier partner scheme.
120
+ * @property {string} extension_id
121
+ * @property {string} scheme_id
122
+ * @property {string} name
326
123
  * @property {ArithmeticOperations} weight
327
- * @property {string} transport_type - Mode of transport associated with the
328
- * courier partner scheme.
329
- * @property {string} region - Serviceable region associated with the courier
330
- * partner scheme.
331
- * @property {string} delivery_type - Type of delivery associated with the
332
- * courier partner scheme.
333
- * @property {string[]} payment_mode - Mode of payment associated with the
334
- * courier partner scheme.
335
- * @property {string} stage - Indicates if the courier partner scheme is
336
- * currently active or inactive.
124
+ * @property {ArithmeticOperations} [volumetric_weight]
125
+ * @property {string} transport_type
126
+ * @property {string} region
127
+ * @property {string} delivery_type
128
+ * @property {string[]} payment_mode
129
+ * @property {string} stage
337
130
  * @property {CourierPartnerSchemeFeatures} feature
338
131
  */
339
132
  /**
340
133
  * @typedef CourierPartnerSchemeFeatures
341
- * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
342
- * doorstep quality check services.
343
- * @property {boolean} [qr] - Specifies whether the courier partner supports QR
344
- * code-based operations.
345
- * @property {boolean} [mps] - Denotes if the courier partner supports
346
- * multi-part shipment services.
347
- * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
348
- * feature is supported by the courier partner.
349
- * @property {number} [ndr_attempts] - Number of attempts allowed for resolving
350
- * Non-Delivery Reports (NDR).
351
- * @property {boolean} [dangerous_goods] - Specifies if the courier partner
352
- * handles the transportation of dangerous goods.
353
- * @property {boolean} [fragile_goods] - Indicates whether the courier partner
354
- * manages the shipment of fragile goods.
355
- * @property {boolean} [restricted_goods] - Indicates if the courier partner
356
- * handles restricted goods, as per regulatory guidelines.
357
- * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
358
- * provides cold storage facilities for goods.
359
- * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
360
- * supports doorstep exchange services.
361
- * @property {boolean} [doorstep_return] - Specifies if the courier partner
362
- * offers doorstep return services.
363
- * @property {boolean} [product_installation] - Indicates if the courier partner
364
- * provides product installation services upon delivery.
365
- * @property {boolean} [openbox_delivery] - Specifies whether the courier
366
- * partner supports open-box delivery, allowing customers to inspect goods
367
- * before accepting.
368
- * @property {string} [status_updates] - Describes the type of status updates
369
- * provided by the courier partner (e.g., real-time, periodic).
370
- * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
371
- * partner supports multiple pickups to a single drop location.
372
- * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
373
- * partner supports single pickup to multiple drop locations.
374
- * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
375
- * offers services for multiple pickups to multiple drop locations.
376
- * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
377
- * supports the generation of e-waybills for shipments.
378
- * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
379
- * of items allowed in a quality check shipment.
380
- * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
381
- * quantity of items allowed in a non-quality check shipment.
382
- */
383
- /**
384
- * @typedef CourierPartnerSchemeV2Features
385
- * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
386
- * doorstep quality check services.
387
- * @property {boolean} [qr] - Specifies whether the courier partner supports QR
388
- * code-based operations.
389
- * @property {boolean} [mps] - Denotes if the courier partner supports
390
- * multi-part shipment services.
391
- * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
392
- * feature is supported by the courier partner.
393
- * @property {boolean} [dangerous_goods] - Specifies if the courier partner
394
- * handles the transportation of dangerous goods.
395
- * @property {boolean} [fragile_goods] - Indicates whether the courier partner
396
- * manages the shipment of fragile goods.
397
- * @property {boolean} [restricted_goods] - Indicates if the courier partner
398
- * handles restricted goods, as per regulatory guidelines.
399
- * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
400
- * provides cold storage facilities for goods.
401
- * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
402
- * supports doorstep exchange services.
403
- * @property {boolean} [doorstep_return] - Specifies if the courier partner
404
- * offers doorstep return services.
405
- * @property {boolean} [product_installation] - Indicates if the courier partner
406
- * provides product installation services upon delivery.
407
- * @property {boolean} [openbox_delivery] - Specifies whether the courier
408
- * partner supports open-box delivery, allowing customers to inspect goods
409
- * before accepting.
410
- * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
411
- * partner supports multiple pickups to a single drop location.
412
- * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
413
- * partner supports single pickup to multiple drop locations.
414
- * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
415
- * offers services for multiple pickups to multiple drop locations.
416
- * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
417
- * supports the generation of e-waybills for shipments.
418
- */
419
- /**
420
- * @typedef CourierPartnerSchemeV2DetailsModel
421
- * @property {string} extension_id - Unique identifier of courier partner extension.
422
- * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
423
- * @property {string} name - Name of the scheme.
424
- * @property {ArithmeticOperations} weight
425
- * @property {ArithmeticOperations} [volumetric_weight]
426
- * @property {string} transport_type - Mode of transport associated with the
427
- * courier partner scheme.
428
- * @property {string} region - Serviceable region associated with the courier
429
- * partner scheme.
430
- * @property {string} delivery_type - Type of delivery associated with the
431
- * courier partner scheme.
432
- * @property {string[]} payment_mode - Mode of payment associated with the
433
- * courier partner scheme.
434
- * @property {string} stage - Indicates if the courier partner scheme is
435
- * currently active or inactive.
436
- * @property {string} [status_updates] - Describes the type of status updates
437
- * provided by the courier partner (e.g., real-time, periodic).
438
- * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
439
- * (NDR) feature is supported by the courier partner.
440
- * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
441
- * of items allowed in a quality check shipment.
442
- * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
443
- * quantity of items allowed in a non-quality check shipment.
444
- * @property {CourierPartnerSchemeV2Features} feature
445
- */
446
- /**
447
- * @typedef CourierPartnerV2SchemeModel
448
- * @property {string} extension_id - Unique identifier of courier partner extension.
449
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
450
- * @property {string} [company_id] - Unique identifier of company.
451
- * @property {string} name - Name of the scheme.
452
- * @property {ArithmeticOperations} weight
453
- * @property {ArithmeticOperations} [volumetric_weight]
454
- * @property {string} transport_type - Mode of transport associated with the
455
- * courier partner scheme.
456
- * @property {string} region - Serviceable region associated with the courier
457
- * partner scheme.
458
- * @property {string} delivery_type - Type of delivery associated with the
459
- * courier partner scheme.
460
- * @property {string[]} payment_mode - Mode of payment associated with the
461
- * courier partner scheme.
462
- * @property {string} stage - Indicates if the courier partner scheme is
463
- * currently active or inactive.
464
- * @property {string} [status_updates] - Describes the type of status updates
465
- * provided by the courier partner (e.g., real-time, periodic).
466
- * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
467
- * (NDR) feature is supported by the courier partner.
468
- * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
469
- * of items allowed in a quality check shipment.
470
- * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
471
- * quantity of items allowed in a non-quality check shipment.
472
- * @property {CourierPartnerSchemeV2Features} feature
473
- */
474
- /**
475
- * @typedef courierPartnerSchemeV2List
476
- * @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
477
- * @property {Page} page
134
+ * @property {boolean} [doorstep_qc]
135
+ * @property {boolean} [qr]
136
+ * @property {boolean} [mps]
137
+ * @property {boolean} [ndr]
138
+ * @property {number} [ndr_attempts]
139
+ * @property {boolean} [dangerous_goods]
140
+ * @property {boolean} [fragile_goods]
141
+ * @property {boolean} [restricted_goods]
142
+ * @property {boolean} [cold_storage_goods]
143
+ * @property {boolean} [doorstep_exchange]
144
+ * @property {boolean} [doorstep_return]
145
+ * @property {boolean} [product_installation]
146
+ * @property {boolean} [openbox_delivery]
147
+ * @property {string} [status_updates]
148
+ * @property {boolean} [multi_pick_single_drop]
149
+ * @property {boolean} [single_pick_multi_drop]
150
+ * @property {boolean} [multi_pick_multi_drop]
151
+ * @property {boolean} [ewaybill]
478
152
  */
479
153
  /**
480
154
  * @typedef ArithmeticOperations
@@ -484,158 +158,93 @@ export = LogisticsPartnerModel;
484
158
  * @property {number} [gte]
485
159
  */
486
160
  /**
487
- * @typedef CourierPartnerSchemeV2UpdateDetails
488
- * @property {string} name - Name of the scheme.
161
+ * @typedef CourierPartnerSchemeUpdateRequest
162
+ * @property {string} name
489
163
  * @property {ArithmeticOperations} weight
490
164
  * @property {ArithmeticOperations} [volumetric_weight]
491
- * @property {string} transport_type - Mode of transport associated with the
492
- * courier partner scheme.
493
- * @property {string} region - Serviceable region associated with the courier
494
- * partner scheme.
495
- * @property {string} delivery_type - Type of delivery associated with the
496
- * courier partner scheme.
497
- * @property {string[]} payment_mode - Mode of payment associated with the
498
- * courier partner scheme.
499
- * @property {string} stage - Indicates if the courier partner scheme is
500
- * currently active or inactive.
501
- * @property {string} [status_updates] - Describes the type of status updates
502
- * provided by the courier partner (e.g., real-time, periodic).
503
- * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
504
- * (NDR) feature is supported by the courier partner.
505
- * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
506
- * of items allowed in a quality check shipment.
507
- * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
508
- * quantity of items allowed in a non-quality check shipment.
509
- * @property {CourierPartnerSchemeV2Features} feature
510
- */
511
- /**
512
- * @typedef GetCountries
513
- * @property {GetCountriesItems[]} items
514
- * @property {Page} page
165
+ * @property {string} transport_type
166
+ * @property {string} region
167
+ * @property {string} delivery_type
168
+ * @property {string[]} payment_mode
169
+ * @property {string} stage
170
+ * @property {CourierPartnerSchemeFeatures} feature
515
171
  */
516
172
  /**
517
- * @typedef GetCountriesItems
518
- * @property {string} [id] - Unique identifier of the country.
519
- * @property {string} [name] - Name of the country.
520
- * @property {string} [iso2] - Two-letter ISO code representing the country.
521
- * @property {string} [iso3] - Three-letter ISO code representing the country.
522
- * @property {string[]} [timezones] - List of time zones used in the country
523
- * (e.g., ["America/New_York", "America/Los_Angeles"]).
524
- * @property {HierarchyItems[]} [hierarchy] - Levels within the country (e.g.,
525
- * states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
526
- * {"name": "City", "slug": "city"}]).
527
- * @property {string} [phone_code] - International dialing code for the country
528
- * (e.g., "+1").
529
- * @property {string} [currency] - Indicates currency for the country (e.g., "INR").
530
- * @property {string} [type] - Indicates the type of object (e.g., "country").
531
- * @property {string} [latitude] - Geographical latitude of the country (e.g., "37.0902").
532
- * @property {string} [longitude] - Geographical longitude of the country (e.g.,
533
- * "-95.7129").
534
- * @property {string} [display_name] - User-friendly version of the geographical
535
- * data, which may be more descriptive or formatted differently.
536
- * @property {boolean} [has_next_hierarchy] - More detailed hierarchical data is
537
- * available, meaning states, cities, or other regions within the country have
538
- * been populated in the system.
173
+ * @typedef CountryHierarchy
174
+ * @property {string} [display_name]
175
+ * @property {string} [slug]
539
176
  */
540
177
  /**
541
- * @typedef HierarchyItems
542
- * @property {string} [display_name] - It represent a country display name.
543
- * @property {string} [slug] - A URL-friendly version of the name, often used
544
- * for referencing or querying purposes.
178
+ * @typedef CurrencyObject
179
+ * @property {string} [code]
180
+ * @property {string} [name]
181
+ * @property {string} [symbol]
545
182
  */
546
183
  /**
547
- * @typedef ValidationError
548
- * @property {string} message - A brief description of the error encountered.
549
- * @property {string} field - The field in the request that caused the error.
184
+ * @typedef CountryObject
185
+ * @property {string} [id]
186
+ * @property {string} [name]
187
+ * @property {string} [display_name]
188
+ * @property {string} [iso2]
189
+ * @property {string} [iso3]
190
+ * @property {string[]} [timezones]
191
+ * @property {CountryHierarchy[]} [hierarchy]
192
+ * @property {string} [phone_code]
193
+ * @property {string} [latitude]
194
+ * @property {string} [longitude]
195
+ * @property {CurrencyObject} [currency]
196
+ * @property {string} [type]
550
197
  */
551
198
  /**
552
- * @typedef StandardError
553
- * @property {string} message - A brief description of the error.
199
+ * @typedef GetCountries
200
+ * @property {CountryObject[]} [items]
201
+ * @property {Page} [page]
554
202
  */
555
203
  declare class LogisticsPartnerModel {
556
204
  }
557
205
  declare namespace LogisticsPartnerModel {
558
- export { BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, ErrorResult, FailureResult, BulkRegionServiceabilityTatResult, Page, CourierAccountUpdateDetails, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatUpdateDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccount, CourierAccountDetailsBody, CourierPartnerAccountFailureResult, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeModel, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeV2Features, CourierPartnerSchemeV2DetailsModel, CourierPartnerV2SchemeModel, courierPartnerSchemeV2List, ArithmeticOperations, CourierPartnerSchemeV2UpdateDetails, GetCountries, GetCountriesItems, HierarchyItems, ValidationError, StandardError };
206
+ export { ErrorResponseV1, BulkRegionServiceabilityTatRequest, BulkRegionServiceabilityTatResponseItemData, ErrorResponse, FailureResponse, BulkRegionServiceabilityTatResponse, Page, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, CourierAccount, CourierPartnerAccountFailureResponse, CompanyCourierPartnerAccountListResponse, CourierAccountSchemeResponse, CourierAccountResponse, CourierPartnerSchemeModel, CourierPartnerSchemeFeatures, ArithmeticOperations, CourierPartnerSchemeUpdateRequest, CountryHierarchy, CurrencyObject, CountryObject, GetCountries };
559
207
  }
560
- /** @returns {BulkRegionServiceabilityTatDetails} */
561
- declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
562
- type BulkRegionServiceabilityTatDetails = {
563
- /**
564
- * - Name of the country.
565
- */
208
+ /** @returns {ErrorResponseV1} */
209
+ declare function ErrorResponseV1(): ErrorResponseV1;
210
+ type ErrorResponseV1 = {
211
+ error?: string;
212
+ };
213
+ /** @returns {BulkRegionServiceabilityTatRequest} */
214
+ declare function BulkRegionServiceabilityTatRequest(): BulkRegionServiceabilityTatRequest;
215
+ type BulkRegionServiceabilityTatRequest = {
566
216
  country: string;
567
- /**
568
- * - Name of the region for which the
569
- * tat/serviceability file needs to be downloaded.
570
- */
571
217
  region: string;
572
- /**
573
- * - Denotes the type of file.
574
- */
575
218
  type: string;
576
219
  };
577
- /** @returns {BulkRegionServiceabilityTatResultItemData} */
578
- declare function BulkRegionServiceabilityTatResultItemData(): BulkRegionServiceabilityTatResultItemData;
579
- type BulkRegionServiceabilityTatResultItemData = {
580
- /**
581
- * - Name of the country.
582
- */
220
+ /** @returns {BulkRegionServiceabilityTatResponseItemData} */
221
+ declare function BulkRegionServiceabilityTatResponseItemData(): BulkRegionServiceabilityTatResponseItemData;
222
+ type BulkRegionServiceabilityTatResponseItemData = {
583
223
  country?: string;
584
- /**
585
- * - Name of the region for which the
586
- * tat/serviceability file needs to be downloaded.
587
- */
588
224
  region?: string;
589
- /**
590
- * - Denotes the type of data.
591
- */
592
225
  type?: string;
593
- /**
594
- * - Unique identifier identifying the perticular request.
595
- */
596
226
  batch_id?: string;
597
- /**
598
- * - Current status of the request.
599
- */
600
227
  status?: string;
601
- /**
602
- * - Information of records which failed
603
- */
604
228
  failed_records?: any[];
605
- /**
606
- * - CDN path of the file.
607
- */
608
229
  file_path?: string;
609
230
  };
610
- /** @returns {ErrorResult} */
611
- declare function ErrorResult(): ErrorResult;
612
- type ErrorResult = {
613
- /**
614
- * - Fields containing the error.
615
- */
231
+ /** @returns {ErrorResponse} */
232
+ declare function ErrorResponse(): ErrorResponse;
233
+ type ErrorResponse = {
616
234
  value: string;
617
- /**
618
- * - Description of the error.
619
- */
620
235
  message: string;
621
- /**
622
- * - Type of the error.
623
- */
624
236
  type: string;
625
237
  };
626
- /** @returns {FailureResult} */
627
- declare function FailureResult(): FailureResult;
628
- type FailureResult = {
629
- /**
630
- * - Denotes if the request was successfully executed.
631
- */
238
+ /** @returns {FailureResponse} */
239
+ declare function FailureResponse(): FailureResponse;
240
+ type FailureResponse = {
632
241
  success: boolean;
633
- error: ErrorResult[];
242
+ error: ErrorResponse[];
634
243
  };
635
- /** @returns {BulkRegionServiceabilityTatResult} */
636
- declare function BulkRegionServiceabilityTatResult(): BulkRegionServiceabilityTatResult;
637
- type BulkRegionServiceabilityTatResult = {
638
- items?: BulkRegionServiceabilityTatResultItemData[];
244
+ /** @returns {BulkRegionServiceabilityTatResponse} */
245
+ declare function BulkRegionServiceabilityTatResponse(): BulkRegionServiceabilityTatResponse;
246
+ type BulkRegionServiceabilityTatResponse = {
247
+ items?: BulkRegionServiceabilityTatResponseItemData[];
639
248
  page?: Page;
640
249
  };
641
250
  /** @returns {Page} */
@@ -669,1019 +278,124 @@ type Page = {
669
278
  * - The number of items per page.
670
279
  */
671
280
  size?: number;
672
- };
673
- /** @returns {CourierAccountUpdateDetails} */
674
- declare function CourierAccountUpdateDetails(): CourierAccountUpdateDetails;
675
- type CourierAccountUpdateDetails = {
676
281
  /**
677
- * - Unique identifier of courier partner extension.
282
+ * - Total number of items.
678
283
  */
284
+ total?: number;
285
+ };
286
+ /** @returns {BulkRegionJobSerializer} */
287
+ declare function BulkRegionJobSerializer(): BulkRegionJobSerializer;
288
+ type BulkRegionJobSerializer = {
289
+ file_path?: string;
290
+ country: string;
291
+ action: string;
292
+ region: string;
293
+ };
294
+ /** @returns {BulkRegionResponseItemData} */
295
+ declare function BulkRegionResponseItemData(): BulkRegionResponseItemData;
296
+ type BulkRegionResponseItemData = {
297
+ file_path: string;
298
+ failed?: number;
299
+ failed_records?: any[];
300
+ action: string;
301
+ batch_id: string;
302
+ country: string;
303
+ success?: number;
304
+ region: string;
305
+ status: string;
306
+ total?: number;
307
+ error_file_path?: string;
308
+ };
309
+ /** @returns {BulkRegionResponse} */
310
+ declare function BulkRegionResponse(): BulkRegionResponse;
311
+ type BulkRegionResponse = {
312
+ items: BulkRegionResponseItemData[];
313
+ page: Page;
314
+ };
315
+ /** @returns {CourierAccount} */
316
+ declare function CourierAccount(): CourierAccount;
317
+ type CourierAccount = {
679
318
  extension_id: string;
680
- /**
681
- * - Unique identifier of courier partner scheme.
682
- */
319
+ account_id: string;
683
320
  scheme_id: string;
684
- /**
685
- * - Denotes if the account is of self delivery type.
686
- */
687
321
  is_self_ship: boolean;
688
- /**
689
- * - Denotes whether the account is in enabled or disabled stage.
690
- */
691
322
  stage: string;
692
- /**
693
- * - Denotes whether it is the seller's own
694
- * account or not.
695
- */
696
323
  is_own_account: boolean;
697
324
  };
698
- /** @returns {RegionTatItemResult} */
699
- declare function RegionTatItemResult(): RegionTatItemResult;
700
- type RegionTatItemResult = {
701
- items: RegionTatResult[];
702
- page: Page;
325
+ /** @returns {CourierPartnerAccountFailureResponse} */
326
+ declare function CourierPartnerAccountFailureResponse(): CourierPartnerAccountFailureResponse;
327
+ type CourierPartnerAccountFailureResponse = {
328
+ success: boolean;
329
+ error: ErrorResponse[];
703
330
  };
704
- /** @returns {RegionServiceabilityItemResult} */
705
- declare function RegionServiceabilityItemResult(): RegionServiceabilityItemResult;
706
- type RegionServiceabilityItemResult = {
707
- items: RegionServiceabilityResult[];
331
+ /** @returns {CompanyCourierPartnerAccountListResponse} */
332
+ declare function CompanyCourierPartnerAccountListResponse(): CompanyCourierPartnerAccountListResponse;
333
+ type CompanyCourierPartnerAccountListResponse = {
334
+ items: CourierAccountResponse[];
708
335
  page: Page;
709
336
  };
710
- /** @returns {ServiceabilityDetailsResult} */
711
- declare function ServiceabilityDetailsResult(): ServiceabilityDetailsResult;
712
- type ServiceabilityDetailsResult = {
713
- /**
714
- * - Boolean value indicating whether
715
- * first-mile service is available or not.
716
- */
717
- first_mile?: boolean;
718
- /**
719
- * - Boolean value indicating whether last-mile
720
- * service is available or not.
721
- */
722
- last_mile?: boolean;
723
- /**
724
- * - Boolean value indicating whether a
725
- * region is first-mile serviceable or not in return pickup.
726
- */
727
- reverse_pickup?: boolean;
728
- /**
729
- * - Limit on the amount of cash on delivery
730
- * (COD) payments allowed in the specified region.
731
- */
732
- cod_limit?: number;
733
- /**
734
- * - Indicates if doorstep return service
735
- * is available. This refers to the ability to return items directly from the
736
- * customer's doorstep.
737
- */
738
- doorstep_return?: boolean;
739
- /**
740
- * - Indicates if doorstep quality check
741
- * service is available. This refers to the ability to perform quality checks
742
- * on items at the customer's doorstep.
743
- */
744
- doorstep_qc?: boolean;
745
- /**
746
- * - Time of day by which pickups must be
747
- * scheduled to be processed on the same day.
748
- */
749
- pickup_cutoff?: string;
750
- /**
751
- * - Boolean value indicating whether
752
- * installation services are available in the specified region or not.
753
- */
754
- installation?: boolean;
755
- /**
756
- * - Unique identifier for the serviceability record.
757
- */
758
- id?: string;
337
+ /** @returns {CourierAccountSchemeResponse} */
338
+ declare function CourierAccountSchemeResponse(): CourierAccountSchemeResponse;
339
+ type CourierAccountSchemeResponse = {
340
+ extension_id?: string;
341
+ scheme_id?: string;
342
+ name?: string;
343
+ weight?: ArithmeticOperations;
344
+ transport_type?: string;
345
+ region?: string;
346
+ delivery_type?: string;
347
+ payment_mode?: string[];
348
+ stage?: string;
349
+ feature?: CourierPartnerSchemeFeatures;
350
+ };
351
+ /** @returns {CourierAccountResponse} */
352
+ declare function CourierAccountResponse(): CourierAccountResponse;
353
+ type CourierAccountResponse = {
354
+ company_id?: number;
355
+ extension_id?: string;
356
+ account_id: string;
357
+ scheme_id: string;
358
+ is_self_ship: boolean;
359
+ stage: string;
360
+ is_own_account: boolean;
361
+ scheme_rules: CourierAccountSchemeResponse;
759
362
  };
760
- /** @returns {ServiceabilityDetails} */
761
- declare function ServiceabilityDetails(): ServiceabilityDetails;
762
- type ServiceabilityDetails = {
763
- /**
764
- * - Boolean value indicating whether
765
- * first-mile service is available or not.
766
- */
767
- first_mile?: boolean;
768
- /**
769
- * - Boolean value indicating whether last-mile
770
- * service is available or not.
771
- */
772
- last_mile?: boolean;
773
- /**
774
- * - Boolean value indicating whether a
775
- * region is first-mile serviceable or not in return pickup.
776
- */
777
- reverse_pickup?: boolean;
778
- /**
779
- * - Limit on the amount of cash on delivery
780
- * (COD) payments allowed in the specified region.
781
- */
782
- cod_limit?: number;
783
- /**
784
- * - Indicates if doorstep return service
785
- * is available. This refers to the ability to return items directly from the
786
- * customer's doorstep.
787
- */
788
- doorstep_return?: boolean;
789
- /**
790
- * - Indicates if doorstep quality check
791
- * service is available. This refers to the ability to perform quality checks
792
- * on items at the customer's doorstep.
793
- */
794
- doorstep_qc?: boolean;
795
- /**
796
- * - Time of day by which pickups must be
797
- * scheduled to be processed on the same day.
798
- */
799
- pickup_cutoff?: string;
800
- /**
801
- * - Boolean value indicating whether
802
- * installation services are available in the specified region or not.
803
- */
804
- installation?: boolean;
363
+ /** @returns {CourierPartnerSchemeModel} */
364
+ declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
365
+ type CourierPartnerSchemeModel = {
366
+ extension_id: string;
367
+ scheme_id: string;
368
+ name: string;
369
+ weight: ArithmeticOperations;
370
+ volumetric_weight?: ArithmeticOperations;
371
+ transport_type: string;
372
+ region: string;
373
+ delivery_type: string;
374
+ payment_mode: string[];
375
+ stage: string;
376
+ feature: CourierPartnerSchemeFeatures;
805
377
  };
806
- /** @returns {RegionServiceabilityResult} */
807
- declare function RegionServiceabilityResult(): RegionServiceabilityResult;
808
- type RegionServiceabilityResult = {
809
- /**
810
- * - ISO2 code representing the country where
811
- * the serviceability is being specified.
812
- */
813
- country_code: string;
814
- /**
815
- * - Code representing the state or province
816
- * within the country where the serviceability is being specified.
817
- */
818
- state_code?: string;
819
- /**
820
- * - Code representing the city within the state
821
- * where the serviceability is being specified.
822
- */
823
- city_code?: string;
824
- /**
825
- * - Code representing a specific sector or
826
- * district within the city where the serviceability is being specified.
827
- */
828
- sector_code?: string;
829
- /**
830
- * - Postal or ZIP code for the specific area
831
- * within the city where the serviceability is being specified.
832
- */
833
- pincode?: string;
834
- /**
835
- * - Boolean value indicating whether
836
- * first-mile service is available or not.
837
- */
838
- first_mile?: boolean;
839
- /**
840
- * - Boolean value indicating whether last-mile
841
- * service is available or not.
842
- */
843
- last_mile?: boolean;
844
- /**
845
- * - Boolean value indicating whether a
846
- * region is first-mile serviceable or not in return pickup.
847
- */
848
- reverse_pickup?: boolean;
849
- /**
850
- * - Limit on the amount of cash on delivery
851
- * (COD) payments allowed in the specified region.
852
- */
853
- cod_limit?: number;
854
- /**
855
- * - Indicates if doorstep return service
856
- * is available. This refers to the ability to return items directly from the
857
- * customer's doorstep.
858
- */
859
- doorstep_return?: boolean;
860
- /**
861
- * - Indicates if doorstep quality check
862
- * service is available. This refers to the ability to perform quality checks
863
- * on items at the customer's doorstep.
864
- */
378
+ /** @returns {CourierPartnerSchemeFeatures} */
379
+ declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
380
+ type CourierPartnerSchemeFeatures = {
865
381
  doorstep_qc?: boolean;
866
- /**
867
- * - Time of day by which pickups must be
868
- * scheduled to be processed on the same day.
869
- */
870
- pickup_cutoff?: string;
871
- /**
872
- * - Boolean value indicating whether
873
- * installation services are available in the specified region or not.
874
- */
875
- installation?: boolean;
876
- /**
877
- * - Unique identifier for the serviceability record.
878
- */
879
- id: string;
880
- };
881
- /** @returns {RegionServiceabilityDetails} */
882
- declare function RegionServiceabilityDetails(): RegionServiceabilityDetails;
883
- type RegionServiceabilityDetails = {
884
- /**
885
- * - ISO2 code representing the country where
886
- * the serviceability is being specified.
887
- */
888
- country_code: string;
889
- /**
890
- * - Code representing the state or province
891
- * within the country where the serviceability is being specified.
892
- */
893
- state_code?: string;
894
- /**
895
- * - Code representing the city within the state
896
- * where the serviceability is being specified.
897
- */
898
- city_code?: string;
899
- /**
900
- * - Code representing a specific sector or
901
- * district within the city where the serviceability is being specified.
902
- */
903
- sector_code?: string;
904
- /**
905
- * - Postal or ZIP code for the specific area
906
- * within the city where the serviceability is being specified.
907
- */
908
- pincode?: string;
909
- /**
910
- * - Boolean value indicating whether
911
- * first-mile service is available or not.
912
- */
913
- first_mile?: boolean;
914
- /**
915
- * - Boolean value indicating whether last-mile
916
- * service is available or not.
917
- */
918
- last_mile?: boolean;
919
- /**
920
- * - Boolean value indicating whether a
921
- * region is first-mile serviceable or not in return pickup.
922
- */
923
- reverse_pickup?: boolean;
924
- /**
925
- * - Limit on the amount of cash on delivery
926
- * (COD) payments allowed in the specified region.
927
- */
928
- cod_limit?: number;
929
- /**
930
- * - Indicates if doorstep return service
931
- * is available. This refers to the ability to return items directly from the
932
- * customer's doorstep.
933
- */
382
+ qr?: boolean;
383
+ mps?: boolean;
384
+ ndr?: boolean;
385
+ ndr_attempts?: number;
386
+ dangerous_goods?: boolean;
387
+ fragile_goods?: boolean;
388
+ restricted_goods?: boolean;
389
+ cold_storage_goods?: boolean;
390
+ doorstep_exchange?: boolean;
934
391
  doorstep_return?: boolean;
935
- /**
936
- * - Indicates if doorstep quality check
937
- * service is available. This refers to the ability to perform quality checks
938
- * on items at the customer's doorstep.
939
- */
940
- doorstep_qc?: boolean;
941
- /**
942
- * - Time of day by which pickups must be
943
- * scheduled to be processed on the same day.
944
- */
945
- pickup_cutoff?: string;
946
- /**
947
- * - Boolean value indicating whether
948
- * installation services are available in the specified region or not.
949
- */
950
- installation?: boolean;
951
- };
952
- /** @returns {RegionTatDetails} */
953
- declare function RegionTatDetails(): RegionTatDetails;
954
- type RegionTatDetails = {
955
- /**
956
- * - ISO2 code representing the country of
957
- * origin for the delivery.
958
- */
959
- from_country_code: string;
960
- /**
961
- * - Code representing the state or
962
- * province of origin within the country.
963
- */
964
- from_state_code?: string;
965
- /**
966
- * - Code representing the city of origin
967
- * within the state.
968
- */
969
- from_city_code?: string;
970
- /**
971
- * - Code representing a specific sector
972
- * or district within the city of origin.
973
- */
974
- from_sector_code?: string;
975
- /**
976
- * - Postal or ZIP code of the origin area.
977
- */
978
- from_pincode?: string;
979
- /**
980
- * - ISO2 code representing the destination country.
981
- */
982
- to_country_code: string;
983
- /**
984
- * - Code representing the state or province
985
- * of the destination within the country.
986
- */
987
- to_state_code?: string;
988
- /**
989
- * - Code representing the city of destination
990
- * within the state.
991
- */
992
- to_city_code?: string;
993
- /**
994
- * - Code representing a specific sector or
995
- * district within the city of destination.
996
- */
997
- to_sector_code?: string;
998
- /**
999
- * - Postal or ZIP code of the destination area.
1000
- */
1001
- to_pincode?: string;
1002
- /**
1003
- * - Maximum time required for delivery
1004
- * from the origin to the destination in seconds.
1005
- */
1006
- max_delivery_time?: number;
1007
- /**
1008
- * - Minimum time required for delivery
1009
- * from the origin to the destination in seconds.
1010
- */
1011
- min_delivery_time?: number;
1012
- };
1013
- /** @returns {RegionTatUpdateDetails} */
1014
- declare function RegionTatUpdateDetails(): RegionTatUpdateDetails;
1015
- type RegionTatUpdateDetails = {
1016
- /**
1017
- * - Maximum time required for delivery
1018
- * from the origin to the destination in seconds.
1019
- */
1020
- max_delivery_time?: number;
1021
- /**
1022
- * - Minimum time required for delivery
1023
- * from the origin to the destination in seconds.
1024
- */
1025
- min_delivery_time?: number;
1026
- };
1027
- /** @returns {RegionTatResult} */
1028
- declare function RegionTatResult(): RegionTatResult;
1029
- type RegionTatResult = {
1030
- /**
1031
- * - ISO2 code representing the country of
1032
- * origin for the delivery.
1033
- */
1034
- from_country_code: string;
1035
- /**
1036
- * - Code representing the state or
1037
- * province of origin within the country.
1038
- */
1039
- from_state_code?: string;
1040
- /**
1041
- * - Code representing the city of origin
1042
- * within the state.
1043
- */
1044
- from_city_code?: string;
1045
- /**
1046
- * - Code representing a specific sector
1047
- * or district within the city of origin.
1048
- */
1049
- from_sector_code?: string;
1050
- /**
1051
- * - Postal or ZIP code of the origin area.
1052
- */
1053
- from_pincode?: string;
1054
- /**
1055
- * - ISO2 code representing the destination country.
1056
- */
1057
- to_country_code: string;
1058
- /**
1059
- * - Code representing the state or province
1060
- * of the destination within the country.
1061
- */
1062
- to_state_code?: string;
1063
- /**
1064
- * - Code representing the city of destination
1065
- * within the state.
1066
- */
1067
- to_city_code?: string;
1068
- /**
1069
- * - Code representing a specific sector or
1070
- * district within the city of destination.
1071
- */
1072
- to_sector_code?: string;
1073
- /**
1074
- * - Postal or ZIP code of the destination area.
1075
- */
1076
- to_pincode?: string;
1077
- /**
1078
- * - Maximum time required for delivery
1079
- * from the origin to the destination in seconds.
1080
- */
1081
- max_delivery_time?: number;
1082
- /**
1083
- * - Minimum time required for delivery
1084
- * from the origin to the destination in seconds.
1085
- */
1086
- min_delivery_time?: number;
1087
- /**
1088
- * - Unique identifier for the delivery time record.
1089
- */
1090
- id: string;
1091
- };
1092
- /** @returns {BulkRegionJobDetails} */
1093
- declare function BulkRegionJobDetails(): BulkRegionJobDetails;
1094
- type BulkRegionJobDetails = {
1095
- /**
1096
- * - CDN path of the uploaded csv file for bulk import.
1097
- */
1098
- file_path?: string;
1099
- /**
1100
- * - Country for which the tat or serviceability is
1101
- * to be imported or exported.
1102
- */
1103
- country: string;
1104
- /**
1105
- * - Denotes the import or export action to be performed.
1106
- */
1107
- action: string;
1108
- /**
1109
- * - Region of the country for which import or export
1110
- * is triggered.
1111
- */
1112
- region: string;
1113
- };
1114
- /** @returns {BulkRegionResultItemData} */
1115
- declare function BulkRegionResultItemData(): BulkRegionResultItemData;
1116
- type BulkRegionResultItemData = {
1117
- /**
1118
- * - CDN path of the file which was used for bulk import.
1119
- */
1120
- file_path?: string;
1121
- /**
1122
- * - Count of the failed records.
1123
- */
1124
- failed?: number;
1125
- /**
1126
- * - Information of records which failed.
1127
- */
1128
- failed_records?: any[];
1129
- /**
1130
- * - Denotes the import or export action performed.
1131
- */
1132
- action: string;
1133
- /**
1134
- * - Unique id to identify the import or export query.
1135
- */
1136
- batch_id: string;
1137
- /**
1138
- * - Country for which the import or export action is
1139
- * performed.
1140
- */
1141
- country: string;
1142
- /**
1143
- * - Denoted if the import or export was successful
1144
- * or failure.
1145
- */
1146
- success?: number;
1147
- /**
1148
- * - Region of the country for which import or export
1149
- * is triggered.
1150
- */
1151
- region: string;
1152
- /**
1153
- * - Current status of the import or export action performed.
1154
- */
1155
- status: string;
1156
- /**
1157
- * - Count of total records.
1158
- */
1159
- total?: number;
1160
- /**
1161
- * - Path of the error file.
1162
- */
1163
- error_file_path?: string;
1164
- };
1165
- /** @returns {BulkRegionResult} */
1166
- declare function BulkRegionResult(): BulkRegionResult;
1167
- type BulkRegionResult = {
1168
- items: BulkRegionResultItemData[];
1169
- page: Page;
1170
- };
1171
- /** @returns {CourierAccount} */
1172
- declare function CourierAccount(): CourierAccount;
1173
- type CourierAccount = {
1174
- /**
1175
- * - Unique identifier of courier partner extension.
1176
- */
1177
- extension_id: string;
1178
- /**
1179
- * - Unique identifier of courier partner scheme
1180
- * and company id combination.
1181
- */
1182
- account_id: string;
1183
- /**
1184
- * - Unique identifier of courier partner scheme.
1185
- */
1186
- scheme_id: string;
1187
- /**
1188
- * - Denotes if the account is of self delivery type.
1189
- */
1190
- is_self_ship: boolean;
1191
- /**
1192
- * - Denotes whether the account is in enabled or disabled stage.
1193
- */
1194
- stage: string;
1195
- /**
1196
- * - Denotes whether it is the seller's own
1197
- * account or not.
1198
- */
1199
- is_own_account: boolean;
1200
- };
1201
- /** @returns {CourierAccountDetailsBody} */
1202
- declare function CourierAccountDetailsBody(): CourierAccountDetailsBody;
1203
- type CourierAccountDetailsBody = {
1204
- /**
1205
- * - Unique identifier of courier partner extension.
1206
- */
1207
- extension_id: string;
1208
- /**
1209
- * - Unique identifier of courier partner scheme
1210
- * and company id combination.
1211
- */
1212
- account_id?: string;
1213
- /**
1214
- * - Unique identifier of courier account.
1215
- */
1216
- scheme_id: string;
1217
- /**
1218
- * - Denotes if the account is of self delivery type.
1219
- */
1220
- is_self_ship: boolean;
1221
- /**
1222
- * - Denotes whether the courier account is in enabled
1223
- * or disabled stage.
1224
- */
1225
- stage: string;
1226
- /**
1227
- * - Denotes whether it is the seller's own
1228
- * account or not.
1229
- */
1230
- is_own_account: boolean;
1231
- };
1232
- /** @returns {CourierPartnerAccountFailureResult} */
1233
- declare function CourierPartnerAccountFailureResult(): CourierPartnerAccountFailureResult;
1234
- type CourierPartnerAccountFailureResult = {
1235
- success: boolean;
1236
- error: ErrorResult[];
1237
- };
1238
- /** @returns {CompanyCourierPartnerAccountListResult} */
1239
- declare function CompanyCourierPartnerAccountListResult(): CompanyCourierPartnerAccountListResult;
1240
- type CompanyCourierPartnerAccountListResult = {
1241
- items: CourierAccountResult[];
1242
- page: Page;
1243
- };
1244
- /** @returns {CourierAccountResult} */
1245
- declare function CourierAccountResult(): CourierAccountResult;
1246
- type CourierAccountResult = {
1247
- /**
1248
- * - Unique identifier of courier partner scheme
1249
- * and company id combination.
1250
- */
1251
- account_id: string;
1252
- /**
1253
- * - Unique identifier of courier partner scheme.
1254
- */
1255
- scheme_id: string;
1256
- is_self_ship: boolean;
1257
- /**
1258
- * - Denotes whether the courier account is in enabled
1259
- * or disabled stage.
1260
- */
1261
- stage: string;
1262
- /**
1263
- * - Denotes whether it is the seller's own
1264
- * account or not.
1265
- */
1266
- is_own_account: boolean;
1267
- scheme_rules: CourierPartnerSchemeModel;
1268
- };
1269
- /** @returns {CourierPartnerSchemeModel} */
1270
- declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
1271
- type CourierPartnerSchemeModel = {
1272
- /**
1273
- * - Unique identifier of courier partner extension.
1274
- */
1275
- extension_id: string;
1276
- /**
1277
- * - Unique identifier of courier partner scheme.
1278
- */
1279
- scheme_id: string;
1280
- /**
1281
- * - Name of the scheme
1282
- */
1283
- name: string;
1284
- weight: ArithmeticOperations;
1285
- /**
1286
- * - Mode of transport associated with the
1287
- * courier partner scheme.
1288
- */
1289
- transport_type: string;
1290
- /**
1291
- * - Serviceable region associated with the courier
1292
- * partner scheme.
1293
- */
1294
- region: string;
1295
- /**
1296
- * - Type of delivery associated with the
1297
- * courier partner scheme.
1298
- */
1299
- delivery_type: string;
1300
- /**
1301
- * - Mode of payment associated with the
1302
- * courier partner scheme.
1303
- */
1304
- payment_mode: string[];
1305
- /**
1306
- * - Indicates if the courier partner scheme is
1307
- * currently active or inactive.
1308
- */
1309
- stage: string;
1310
- feature: CourierPartnerSchemeFeatures;
1311
- };
1312
- /** @returns {CourierPartnerSchemeDetailsModel} */
1313
- declare function CourierPartnerSchemeDetailsModel(): CourierPartnerSchemeDetailsModel;
1314
- type CourierPartnerSchemeDetailsModel = {
1315
- /**
1316
- * - Unique identifier of courier partner extension.
1317
- */
1318
- extension_id: string;
1319
- /**
1320
- * - Unique identifier of courier partner scheme.
1321
- */
1322
- scheme_id?: string;
1323
- /**
1324
- * - Name of the courier partner scheme.
1325
- */
1326
- name: string;
1327
- weight: ArithmeticOperations;
1328
- /**
1329
- * - Mode of transport associated with the
1330
- * courier partner scheme.
1331
- */
1332
- transport_type: string;
1333
- /**
1334
- * - Serviceable region associated with the courier
1335
- * partner scheme.
1336
- */
1337
- region: string;
1338
- /**
1339
- * - Type of delivery associated with the
1340
- * courier partner scheme.
1341
- */
1342
- delivery_type: string;
1343
- /**
1344
- * - Mode of payment associated with the
1345
- * courier partner scheme.
1346
- */
1347
- payment_mode: string[];
1348
- /**
1349
- * - Indicates if the courier partner scheme is
1350
- * currently active or inactive.
1351
- */
1352
- stage: string;
1353
- feature: CourierPartnerSchemeFeatures;
1354
- };
1355
- /** @returns {CourierPartnerSchemeFeatures} */
1356
- declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
1357
- type CourierPartnerSchemeFeatures = {
1358
- /**
1359
- * - Indicates if the courier partner offers
1360
- * doorstep quality check services.
1361
- */
1362
- doorstep_qc?: boolean;
1363
- /**
1364
- * - Specifies whether the courier partner supports QR
1365
- * code-based operations.
1366
- */
1367
- qr?: boolean;
1368
- /**
1369
- * - Denotes if the courier partner supports
1370
- * multi-part shipment services.
1371
- */
1372
- mps?: boolean;
1373
- /**
1374
- * - Indicates if the Non-Delivery Report (NDR)
1375
- * feature is supported by the courier partner.
1376
- */
1377
- ndr?: boolean;
1378
- /**
1379
- * - Number of attempts allowed for resolving
1380
- * Non-Delivery Reports (NDR).
1381
- */
1382
- ndr_attempts?: number;
1383
- /**
1384
- * - Specifies if the courier partner
1385
- * handles the transportation of dangerous goods.
1386
- */
1387
- dangerous_goods?: boolean;
1388
- /**
1389
- * - Indicates whether the courier partner
1390
- * manages the shipment of fragile goods.
1391
- */
1392
- fragile_goods?: boolean;
1393
- /**
1394
- * - Indicates if the courier partner
1395
- * handles restricted goods, as per regulatory guidelines.
1396
- */
1397
- restricted_goods?: boolean;
1398
- /**
1399
- * - Denotes if the courier partner
1400
- * provides cold storage facilities for goods.
1401
- */
1402
- cold_storage_goods?: boolean;
1403
- /**
1404
- * - Indicates if the courier partner
1405
- * supports doorstep exchange services.
1406
- */
1407
- doorstep_exchange?: boolean;
1408
- /**
1409
- * - Specifies if the courier partner
1410
- * offers doorstep return services.
1411
- */
1412
- doorstep_return?: boolean;
1413
- /**
1414
- * - Indicates if the courier partner
1415
- * provides product installation services upon delivery.
1416
- */
1417
- product_installation?: boolean;
1418
- /**
1419
- * - Specifies whether the courier
1420
- * partner supports open-box delivery, allowing customers to inspect goods
1421
- * before accepting.
1422
- */
1423
- openbox_delivery?: boolean;
1424
- /**
1425
- * - Describes the type of status updates
1426
- * provided by the courier partner (e.g., real-time, periodic).
1427
- */
1428
- status_updates?: string;
1429
- /**
1430
- * - Indicates if the courier
1431
- * partner supports multiple pickups to a single drop location.
1432
- */
1433
- multi_pick_single_drop?: boolean;
1434
- /**
1435
- * - Indicates whether the courier
1436
- * partner supports single pickup to multiple drop locations.
1437
- */
1438
- single_pick_multi_drop?: boolean;
1439
- /**
1440
- * - Denotes if the courier partner
1441
- * offers services for multiple pickups to multiple drop locations.
1442
- */
1443
- multi_pick_multi_drop?: boolean;
1444
- /**
1445
- * - Specifies if the courier partner requires or
1446
- * supports the generation of e-waybills for shipments.
1447
- */
1448
- ewaybill?: boolean;
1449
- /**
1450
- * - Defines the maximum quantity
1451
- * of items allowed in a quality check shipment.
1452
- */
1453
- qc_shipment_item_quantity?: number;
1454
- /**
1455
- * - Defines the maximum
1456
- * quantity of items allowed in a non-quality check shipment.
1457
- */
1458
- non_qc_shipment_item_quantity?: number;
1459
- };
1460
- /** @returns {CourierPartnerSchemeV2Features} */
1461
- declare function CourierPartnerSchemeV2Features(): CourierPartnerSchemeV2Features;
1462
- type CourierPartnerSchemeV2Features = {
1463
- /**
1464
- * - Indicates if the courier partner offers
1465
- * doorstep quality check services.
1466
- */
1467
- doorstep_qc?: boolean;
1468
- /**
1469
- * - Specifies whether the courier partner supports QR
1470
- * code-based operations.
1471
- */
1472
- qr?: boolean;
1473
- /**
1474
- * - Denotes if the courier partner supports
1475
- * multi-part shipment services.
1476
- */
1477
- mps?: boolean;
1478
- /**
1479
- * - Indicates if the Non-Delivery Report (NDR)
1480
- * feature is supported by the courier partner.
1481
- */
1482
- ndr?: boolean;
1483
- /**
1484
- * - Specifies if the courier partner
1485
- * handles the transportation of dangerous goods.
1486
- */
1487
- dangerous_goods?: boolean;
1488
- /**
1489
- * - Indicates whether the courier partner
1490
- * manages the shipment of fragile goods.
1491
- */
1492
- fragile_goods?: boolean;
1493
- /**
1494
- * - Indicates if the courier partner
1495
- * handles restricted goods, as per regulatory guidelines.
1496
- */
1497
- restricted_goods?: boolean;
1498
- /**
1499
- * - Denotes if the courier partner
1500
- * provides cold storage facilities for goods.
1501
- */
1502
- cold_storage_goods?: boolean;
1503
- /**
1504
- * - Indicates if the courier partner
1505
- * supports doorstep exchange services.
1506
- */
1507
- doorstep_exchange?: boolean;
1508
- /**
1509
- * - Specifies if the courier partner
1510
- * offers doorstep return services.
1511
- */
1512
- doorstep_return?: boolean;
1513
- /**
1514
- * - Indicates if the courier partner
1515
- * provides product installation services upon delivery.
1516
- */
1517
- product_installation?: boolean;
1518
- /**
1519
- * - Specifies whether the courier
1520
- * partner supports open-box delivery, allowing customers to inspect goods
1521
- * before accepting.
1522
- */
1523
- openbox_delivery?: boolean;
1524
- /**
1525
- * - Indicates if the courier
1526
- * partner supports multiple pickups to a single drop location.
1527
- */
1528
- multi_pick_single_drop?: boolean;
1529
- /**
1530
- * - Indicates whether the courier
1531
- * partner supports single pickup to multiple drop locations.
1532
- */
1533
- single_pick_multi_drop?: boolean;
1534
- /**
1535
- * - Denotes if the courier partner
1536
- * offers services for multiple pickups to multiple drop locations.
1537
- */
1538
- multi_pick_multi_drop?: boolean;
1539
- /**
1540
- * - Specifies if the courier partner requires or
1541
- * supports the generation of e-waybills for shipments.
1542
- */
1543
- ewaybill?: boolean;
1544
- };
1545
- /** @returns {CourierPartnerSchemeV2DetailsModel} */
1546
- declare function CourierPartnerSchemeV2DetailsModel(): CourierPartnerSchemeV2DetailsModel;
1547
- type CourierPartnerSchemeV2DetailsModel = {
1548
- /**
1549
- * - Unique identifier of courier partner extension.
1550
- */
1551
- extension_id: string;
1552
- /**
1553
- * - Unique identifier of courier partner scheme.
1554
- */
1555
- scheme_id?: string;
1556
- /**
1557
- * - Name of the scheme.
1558
- */
1559
- name: string;
1560
- weight: ArithmeticOperations;
1561
- volumetric_weight?: ArithmeticOperations;
1562
- /**
1563
- * - Mode of transport associated with the
1564
- * courier partner scheme.
1565
- */
1566
- transport_type: string;
1567
- /**
1568
- * - Serviceable region associated with the courier
1569
- * partner scheme.
1570
- */
1571
- region: string;
1572
- /**
1573
- * - Type of delivery associated with the
1574
- * courier partner scheme.
1575
- */
1576
- delivery_type: string;
1577
- /**
1578
- * - Mode of payment associated with the
1579
- * courier partner scheme.
1580
- */
1581
- payment_mode: string[];
1582
- /**
1583
- * - Indicates if the courier partner scheme is
1584
- * currently active or inactive.
1585
- */
1586
- stage: string;
1587
- /**
1588
- * - Describes the type of status updates
1589
- * provided by the courier partner (e.g., real-time, periodic).
1590
- */
1591
- status_updates?: string;
1592
- /**
1593
- * - Indicates if the Non-Delivery Report
1594
- * (NDR) feature is supported by the courier partner.
1595
- */
1596
- ndr_attempts?: number;
1597
- /**
1598
- * - Defines the maximum quantity
1599
- * of items allowed in a quality check shipment.
1600
- */
1601
- qc_shipment_item_quantity?: number;
1602
- /**
1603
- * - Defines the maximum
1604
- * quantity of items allowed in a non-quality check shipment.
1605
- */
1606
- non_qc_shipment_item_quantity?: number;
1607
- feature: CourierPartnerSchemeV2Features;
1608
- };
1609
- /** @returns {CourierPartnerV2SchemeModel} */
1610
- declare function CourierPartnerV2SchemeModel(): CourierPartnerV2SchemeModel;
1611
- type CourierPartnerV2SchemeModel = {
1612
- /**
1613
- * - Unique identifier of courier partner extension.
1614
- */
1615
- extension_id: string;
1616
- /**
1617
- * - Unique identifier of courier partner scheme.
1618
- */
1619
- scheme_id: string;
1620
- /**
1621
- * - Unique identifier of company.
1622
- */
1623
- company_id?: string;
1624
- /**
1625
- * - Name of the scheme.
1626
- */
1627
- name: string;
1628
- weight: ArithmeticOperations;
1629
- volumetric_weight?: ArithmeticOperations;
1630
- /**
1631
- * - Mode of transport associated with the
1632
- * courier partner scheme.
1633
- */
1634
- transport_type: string;
1635
- /**
1636
- * - Serviceable region associated with the courier
1637
- * partner scheme.
1638
- */
1639
- region: string;
1640
- /**
1641
- * - Type of delivery associated with the
1642
- * courier partner scheme.
1643
- */
1644
- delivery_type: string;
1645
- /**
1646
- * - Mode of payment associated with the
1647
- * courier partner scheme.
1648
- */
1649
- payment_mode: string[];
1650
- /**
1651
- * - Indicates if the courier partner scheme is
1652
- * currently active or inactive.
1653
- */
1654
- stage: string;
1655
- /**
1656
- * - Describes the type of status updates
1657
- * provided by the courier partner (e.g., real-time, periodic).
1658
- */
1659
- status_updates?: string;
1660
- /**
1661
- * - Indicates if the Non-Delivery Report
1662
- * (NDR) feature is supported by the courier partner.
1663
- */
1664
- ndr_attempts?: number;
1665
- /**
1666
- * - Defines the maximum quantity
1667
- * of items allowed in a quality check shipment.
1668
- */
1669
- qc_shipment_item_quantity?: number;
1670
- /**
1671
- * - Defines the maximum
1672
- * quantity of items allowed in a non-quality check shipment.
1673
- */
1674
- non_qc_shipment_item_quantity?: number;
1675
- feature: CourierPartnerSchemeV2Features;
1676
- };
1677
- /** @returns {courierPartnerSchemeV2List} */
1678
- declare function courierPartnerSchemeV2List(): courierPartnerSchemeV2List;
1679
- type courierPartnerSchemeV2List = {
1680
- /**
1681
- * - List of courier partner schemes
1682
- */
1683
- items: CourierPartnerV2SchemeModel[];
1684
- page: Page;
392
+ product_installation?: boolean;
393
+ openbox_delivery?: boolean;
394
+ status_updates?: string;
395
+ multi_pick_single_drop?: boolean;
396
+ single_pick_multi_drop?: boolean;
397
+ multi_pick_multi_drop?: boolean;
398
+ ewaybill?: boolean;
1685
399
  };
1686
400
  /** @returns {ArithmeticOperations} */
1687
401
  declare function ArithmeticOperations(): ArithmeticOperations;
@@ -1691,162 +405,51 @@ type ArithmeticOperations = {
1691
405
  lte?: number;
1692
406
  gte?: number;
1693
407
  };
1694
- /** @returns {CourierPartnerSchemeV2UpdateDetails} */
1695
- declare function CourierPartnerSchemeV2UpdateDetails(): CourierPartnerSchemeV2UpdateDetails;
1696
- type CourierPartnerSchemeV2UpdateDetails = {
1697
- /**
1698
- * - Name of the scheme.
1699
- */
408
+ /** @returns {CourierPartnerSchemeUpdateRequest} */
409
+ declare function CourierPartnerSchemeUpdateRequest(): CourierPartnerSchemeUpdateRequest;
410
+ type CourierPartnerSchemeUpdateRequest = {
1700
411
  name: string;
1701
412
  weight: ArithmeticOperations;
1702
413
  volumetric_weight?: ArithmeticOperations;
1703
- /**
1704
- * - Mode of transport associated with the
1705
- * courier partner scheme.
1706
- */
1707
414
  transport_type: string;
1708
- /**
1709
- * - Serviceable region associated with the courier
1710
- * partner scheme.
1711
- */
1712
415
  region: string;
1713
- /**
1714
- * - Type of delivery associated with the
1715
- * courier partner scheme.
1716
- */
1717
416
  delivery_type: string;
1718
- /**
1719
- * - Mode of payment associated with the
1720
- * courier partner scheme.
1721
- */
1722
417
  payment_mode: string[];
1723
- /**
1724
- * - Indicates if the courier partner scheme is
1725
- * currently active or inactive.
1726
- */
1727
418
  stage: string;
1728
- /**
1729
- * - Describes the type of status updates
1730
- * provided by the courier partner (e.g., real-time, periodic).
1731
- */
1732
- status_updates?: string;
1733
- /**
1734
- * - Indicates if the Non-Delivery Report
1735
- * (NDR) feature is supported by the courier partner.
1736
- */
1737
- ndr_attempts?: number;
1738
- /**
1739
- * - Defines the maximum quantity
1740
- * of items allowed in a quality check shipment.
1741
- */
1742
- qc_shipment_item_quantity?: number;
1743
- /**
1744
- * - Defines the maximum
1745
- * quantity of items allowed in a non-quality check shipment.
1746
- */
1747
- non_qc_shipment_item_quantity?: number;
1748
- feature: CourierPartnerSchemeV2Features;
419
+ feature: CourierPartnerSchemeFeatures;
1749
420
  };
1750
- /** @returns {GetCountries} */
1751
- declare function GetCountries(): GetCountries;
1752
- type GetCountries = {
1753
- items: GetCountriesItems[];
1754
- page: Page;
421
+ /** @returns {CountryHierarchy} */
422
+ declare function CountryHierarchy(): CountryHierarchy;
423
+ type CountryHierarchy = {
424
+ display_name?: string;
425
+ slug?: string;
1755
426
  };
1756
- /** @returns {GetCountriesItems} */
1757
- declare function GetCountriesItems(): GetCountriesItems;
1758
- type GetCountriesItems = {
1759
- /**
1760
- * - Unique identifier of the country.
1761
- */
427
+ /** @returns {CurrencyObject} */
428
+ declare function CurrencyObject(): CurrencyObject;
429
+ type CurrencyObject = {
430
+ code?: string;
431
+ name?: string;
432
+ symbol?: string;
433
+ };
434
+ /** @returns {CountryObject} */
435
+ declare function CountryObject(): CountryObject;
436
+ type CountryObject = {
1762
437
  id?: string;
1763
- /**
1764
- * - Name of the country.
1765
- */
1766
438
  name?: string;
1767
- /**
1768
- * - Two-letter ISO code representing the country.
1769
- */
439
+ display_name?: string;
1770
440
  iso2?: string;
1771
- /**
1772
- * - Three-letter ISO code representing the country.
1773
- */
1774
441
  iso3?: string;
1775
- /**
1776
- * - List of time zones used in the country
1777
- * (e.g., ["America/New_York", "America/Los_Angeles"]).
1778
- */
1779
442
  timezones?: string[];
1780
- /**
1781
- * - Levels within the country (e.g.,
1782
- * states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
1783
- * {"name": "City", "slug": "city"}]).
1784
- */
1785
- hierarchy?: HierarchyItems[];
1786
- /**
1787
- * - International dialing code for the country
1788
- * (e.g., "+1").
1789
- */
443
+ hierarchy?: CountryHierarchy[];
1790
444
  phone_code?: string;
1791
- /**
1792
- * - Indicates currency for the country (e.g., "INR").
1793
- */
1794
- currency?: string;
1795
- /**
1796
- * - Indicates the type of object (e.g., "country").
1797
- */
1798
- type?: string;
1799
- /**
1800
- * - Geographical latitude of the country (e.g., "37.0902").
1801
- */
1802
445
  latitude?: string;
1803
- /**
1804
- * - Geographical longitude of the country (e.g.,
1805
- * "-95.7129").
1806
- */
1807
446
  longitude?: string;
1808
- /**
1809
- * - User-friendly version of the geographical
1810
- * data, which may be more descriptive or formatted differently.
1811
- */
1812
- display_name?: string;
1813
- /**
1814
- * - More detailed hierarchical data is
1815
- * available, meaning states, cities, or other regions within the country have
1816
- * been populated in the system.
1817
- */
1818
- has_next_hierarchy?: boolean;
1819
- };
1820
- /** @returns {HierarchyItems} */
1821
- declare function HierarchyItems(): HierarchyItems;
1822
- type HierarchyItems = {
1823
- /**
1824
- * - It represent a country display name.
1825
- */
1826
- display_name?: string;
1827
- /**
1828
- * - A URL-friendly version of the name, often used
1829
- * for referencing or querying purposes.
1830
- */
1831
- slug?: string;
1832
- };
1833
- /** @returns {ValidationError} */
1834
- declare function ValidationError(): ValidationError;
1835
- type ValidationError = {
1836
- /**
1837
- * - A brief description of the error encountered.
1838
- */
1839
- message: string;
1840
- /**
1841
- * - The field in the request that caused the error.
1842
- */
1843
- field: string;
447
+ currency?: CurrencyObject;
448
+ type?: string;
1844
449
  };
1845
- /** @returns {StandardError} */
1846
- declare function StandardError(): StandardError;
1847
- type StandardError = {
1848
- /**
1849
- * - A brief description of the error.
1850
- */
1851
- message: string;
450
+ /** @returns {GetCountries} */
451
+ declare function GetCountries(): GetCountries;
452
+ type GetCountries = {
453
+ items?: CountryObject[];
454
+ page?: Page;
1852
455
  };