@gofynd/fdk-client-javascript 1.4.16-beta.3 → 1.4.16-beta.4

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 (242) 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 +48 -68
  6. package/sdk/application/Cart/CartApplicationClient.js +27 -117
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  10. package/sdk/application/Common/CommonApplicationClient.js +1 -1
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
  14. package/sdk/application/Content/ContentApplicationClient.js +56 -161
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
  18. package/sdk/application/Lead/LeadApplicationClient.js +1 -1
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
  22. package/sdk/application/Order/OrderApplicationClient.js +8 -56
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
  24. package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
  25. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  26. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  27. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  28. package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
  29. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  30. package/sdk/application/User/UserApplicationClient.js +6 -6
  31. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  32. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  33. package/sdk/common/Utility.js +6 -3
  34. package/sdk/common/utils.d.ts +0 -1
  35. package/sdk/common/utils.js +0 -14
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
  37. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
  38. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
  39. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
  40. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
  41. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
  42. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  43. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  44. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  45. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  46. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
  47. package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
  48. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
  49. package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
  50. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
  51. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
  52. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
  53. package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
  54. package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
  55. package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
  56. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  57. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
  58. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
  59. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
  60. package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
  61. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
  62. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
  64. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
  66. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
  71. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  72. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  73. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  74. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  75. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  76. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  77. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  78. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  79. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
  80. package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
  81. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
  82. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
  83. package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
  84. package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
  85. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
  86. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
  87. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
  88. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
  89. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
  90. package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
  91. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
  92. package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
  93. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
  94. package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
  95. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
  96. package/sdk/platform/Common/CommonPlatformClient.js +2 -3
  97. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  98. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  99. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
  100. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
  101. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  102. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  103. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
  104. package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
  105. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
  106. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
  107. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  108. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
  109. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  110. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  111. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
  112. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
  113. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  114. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  115. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
  116. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
  117. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
  118. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
  119. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
  120. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
  121. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -204
  122. package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
  123. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
  124. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
  125. package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
  126. package/sdk/platform/Content/ContentPlatformClient.js +336 -523
  127. package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
  128. package/sdk/platform/Content/ContentPlatformModel.js +394 -631
  129. package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
  130. package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
  131. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
  132. package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
  133. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  134. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  135. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  137. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
  141. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
  142. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
  144. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
  145. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  146. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  147. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  148. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  149. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
  150. package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
  151. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  152. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  153. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  154. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  155. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  156. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  157. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
  158. package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
  159. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
  160. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
  161. package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
  162. package/sdk/platform/Order/OrderPlatformClient.js +198 -416
  163. package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
  164. package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
  165. package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
  166. package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
  167. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  168. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  169. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  170. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  171. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
  172. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
  173. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  174. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  175. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  176. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  177. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
  178. package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
  179. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  180. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  181. package/sdk/platform/PlatformClient.d.ts +2 -0
  182. package/sdk/platform/PlatformClient.js +4 -0
  183. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  184. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  185. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  186. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  187. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  188. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
  199. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  200. package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
  201. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
  202. package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
  203. package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
  204. package/sdk/platform/Share/SharePlatformModel.js +6 -31
  205. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  206. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
  207. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
  208. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
  209. package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
  210. package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
  211. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  212. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  213. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  214. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  215. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  216. package/sdk/platform/User/UserPlatformModel.js +23 -23
  217. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  218. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  219. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
  220. package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
  221. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  222. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  223. package/sdk/platform/index.d.ts +1 -0
  224. package/sdk/platform/index.js +2 -0
  225. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
  226. package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
  227. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  228. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  229. package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
  230. package/sdk/public/Content/ContentPublicClient.js +6 -810
  231. package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
  232. package/sdk/public/Content/ContentPublicModel.js +3 -649
  233. package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
  234. package/sdk/public/Content/ContentPublicValidator.js +2 -88
  235. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  236. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  237. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  238. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  239. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  240. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  241. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  242. package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
@@ -1,36 +1,34 @@
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 BulkRegionServiceabilityTatRequest
4
+ * @property {string} country
5
+ * @property {string} region
6
+ * @property {string} type
8
7
  */
9
8
  /**
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.
9
+ * @typedef BulkRegionServiceabilityTatResponseItemData
10
+ * @property {string} [country]
11
+ * @property {string} [region]
12
+ * @property {string} [type]
13
+ * @property {string} [batch_id]
14
+ * @property {string} [status]
15
+ * @property {Object[]} [failed_records]
16
+ * @property {string} [file_path]
19
17
  */
20
18
  /**
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.
19
+ * @typedef ErrorResponse
20
+ * @property {string} value
21
+ * @property {string} message
22
+ * @property {string} type
25
23
  */
26
24
  /**
27
- * @typedef FailureResult
28
- * @property {boolean} success - Denotes if the request was successfully executed.
29
- * @property {ErrorResult[]} error
25
+ * @typedef FailureResponse
26
+ * @property {boolean} success
27
+ * @property {ErrorResponse[]} error
30
28
  */
31
29
  /**
32
- * @typedef BulkRegionServiceabilityTatResult
33
- * @property {BulkRegionServiceabilityTatResultItemData[]} [items]
30
+ * @typedef BulkRegionServiceabilityTatResponse
31
+ * @property {BulkRegionServiceabilityTatResponseItemData[]} [items]
34
32
  * @property {Page} [page]
35
33
  */
36
34
  /**
@@ -44,333 +42,114 @@ export = LogisticsPartnerModel;
44
42
  * @property {number} [size] - The number of items per page.
45
43
  */
46
44
  /**
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 {number} [cod_limit] - Limit on the amount of cash on delivery
72
- * (COD) payments allowed in the specified region.
73
- * @property {boolean} [doorstep_return] - Indicates if doorstep return service
74
- * is available. This refers to the ability to return items directly from the
75
- * customer's doorstep.
76
- * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
77
- * service is available. This refers to the ability to perform quality checks
78
- * on items at the customer's doorstep.
79
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
80
- * scheduled to be processed on the same day.
81
- * @property {boolean} [installation] - Boolean value indicating whether
82
- * installation services are available in the specified region or not.
83
- * @property {string} [id] - Unique identifier for the serviceability record.
84
- */
85
- /**
86
- * @typedef ServiceabilityDetails
87
- * @property {boolean} [first_mile] - Boolean value indicating whether
88
- * first-mile service is available or not.
89
- * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
90
- * service is available or not.
91
- * @property {number} [cod_limit] - Limit on the amount of cash on delivery
92
- * (COD) payments allowed in the specified region.
93
- * @property {boolean} [doorstep_return] - Indicates if doorstep return service
94
- * is available. This refers to the ability to return items directly from the
95
- * customer's doorstep.
96
- * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
97
- * service is available. This refers to the ability to perform quality checks
98
- * on items at the customer's doorstep.
99
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
100
- * scheduled to be processed on the same day.
101
- * @property {boolean} [installation] - Boolean value indicating whether
102
- * installation services are available in the specified region or not.
103
- */
104
- /**
105
- * @typedef RegionServiceabilityResult
106
- * @property {string} country_code - ISO2 code representing the country where
107
- * the serviceability is being specified.
108
- * @property {string} [state_code] - Code representing the state or province
109
- * within the country where the serviceability is being specified.
110
- * @property {string} [city_code] - Code representing the city within the state
111
- * where the serviceability is being specified.
112
- * @property {string} [sector_code] - Code representing a specific sector or
113
- * district within the city where the serviceability is being specified.
114
- * @property {string} [pincode] - Postal or ZIP code for the specific area
115
- * within the city where the serviceability is being specified.
116
- * @property {boolean} [first_mile] - Boolean value indicating whether
117
- * first-mile service is available or not.
118
- * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
119
- * service is available or not.
120
- * @property {number} [cod_limit] - Limit on the amount of cash on delivery
121
- * (COD) payments allowed in the specified region.
122
- * @property {boolean} [doorstep_return] - Indicates if doorstep return service
123
- * is available. This refers to the ability to return items directly from the
124
- * customer's doorstep.
125
- * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
126
- * service is available. This refers to the ability to perform quality checks
127
- * on items at the customer's doorstep.
128
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
129
- * scheduled to be processed on the same day.
130
- * @property {boolean} [installation] - Boolean value indicating whether
131
- * installation services are available in the specified region or not.
132
- * @property {string} id - Unique identifier for the serviceability record.
45
+ * @typedef BulkRegionJobSerializer
46
+ * @property {string} [file_path]
47
+ * @property {string} country
48
+ * @property {string} action
49
+ * @property {string} region
133
50
  */
134
51
  /**
135
- * @typedef RegionServiceabilityDetails
136
- * @property {string} country_code - ISO2 code representing the country where
137
- * the serviceability is being specified.
138
- * @property {string} [state_code] - Code representing the state or province
139
- * within the country where the serviceability is being specified.
140
- * @property {string} [city_code] - Code representing the city within the state
141
- * where the serviceability is being specified.
142
- * @property {string} [sector_code] - Code representing a specific sector or
143
- * district within the city where the serviceability is being specified.
144
- * @property {string} [pincode] - Postal or ZIP code for the specific area
145
- * within the city where the serviceability is being specified.
146
- * @property {boolean} [first_mile] - Boolean value indicating whether
147
- * first-mile service is available or not.
148
- * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
149
- * service is available or not.
150
- * @property {number} [cod_limit] - Limit on the amount of cash on delivery
151
- * (COD) payments allowed in the specified region.
152
- * @property {boolean} [doorstep_return] - Indicates if doorstep return service
153
- * is available. This refers to the ability to return items directly from the
154
- * customer's doorstep.
155
- * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
156
- * service is available. This refers to the ability to perform quality checks
157
- * on items at the customer's doorstep.
158
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
159
- * scheduled to be processed on the same day.
160
- * @property {boolean} [installation] - Boolean value indicating whether
161
- * installation services are available in the specified region or not.
52
+ * @typedef BulkRegionResponseItemData
53
+ * @property {string} file_path
54
+ * @property {number} [failed]
55
+ * @property {Object[]} [failed_records]
56
+ * @property {string} action
57
+ * @property {string} batch_id
58
+ * @property {string} country
59
+ * @property {number} [success]
60
+ * @property {string} region
61
+ * @property {string} status
62
+ * @property {number} [total]
63
+ * @property {string} [error_file_path]
162
64
  */
163
65
  /**
164
- * @typedef RegionTatDetails
165
- * @property {string} from_country_code - ISO2 code representing the country of
166
- * origin for the delivery.
167
- * @property {string} [from_state_code] - Code representing the state or
168
- * province of origin within the country.
169
- * @property {string} [from_city_code] - Code representing the city of origin
170
- * within the state.
171
- * @property {string} [from_sector_code] - Code representing a specific sector
172
- * or district within the city of origin.
173
- * @property {string} [from_pincode] - Postal or ZIP code of the origin area.
174
- * @property {string} to_country_code - ISO2 code representing the destination country.
175
- * @property {string} [to_state_code] - Code representing the state or province
176
- * of the destination within the country.
177
- * @property {string} [to_city_code] - Code representing the city of destination
178
- * within the state.
179
- * @property {string} [to_sector_code] - Code representing a specific sector or
180
- * district within the city of destination.
181
- * @property {string} [to_pincode] - Postal or ZIP code of the destination area.
182
- * @property {number} [max_delivery_time] - Maximum time required for delivery
183
- * from the origin to the destination in seconds.
184
- * @property {number} [min_delivery_time] - Minimum time required for delivery
185
- * from the origin to the destination in seconds.
186
- */
187
- /**
188
- * @typedef RegionTatUpdateDetails
189
- * @property {number} [max_delivery_time] - Maximum time required for delivery
190
- * from the origin to the destination in seconds.
191
- * @property {number} [min_delivery_time] - Minimum time required for delivery
192
- * from the origin to the destination in seconds.
193
- */
194
- /**
195
- * @typedef RegionTatResult
196
- * @property {string} from_country_code - ISO2 code representing the country of
197
- * origin for the delivery.
198
- * @property {string} [from_state_code] - Code representing the state or
199
- * province of origin within the country.
200
- * @property {string} [from_city_code] - Code representing the city of origin
201
- * within the state.
202
- * @property {string} [from_sector_code] - Code representing a specific sector
203
- * or district within the city of origin.
204
- * @property {string} [from_pincode] - Postal or ZIP code of the origin area.
205
- * @property {string} to_country_code - ISO2 code representing the destination country.
206
- * @property {string} [to_state_code] - Code representing the state or province
207
- * of the destination within the country.
208
- * @property {string} [to_city_code] - Code representing the city of destination
209
- * within the state.
210
- * @property {string} [to_sector_code] - Code representing a specific sector or
211
- * district within the city of destination.
212
- * @property {string} [to_pincode] - Postal or ZIP code of the destination area.
213
- * @property {number} [max_delivery_time] - Maximum time required for delivery
214
- * from the origin to the destination in seconds.
215
- * @property {number} [min_delivery_time] - Minimum time required for delivery
216
- * from the origin to the destination in seconds.
217
- * @property {string} id - Unique identifier for the delivery time record.
218
- */
219
- /**
220
- * @typedef BulkRegionJobDetails
221
- * @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
222
- * @property {string} country - Country for which the tat or serviceability is
223
- * to be imported or exported.
224
- * @property {string} action - Denotes the import or export action to be performed.
225
- * @property {string} region - Region of the country for which import or export
226
- * is triggered.
227
- */
228
- /**
229
- * @typedef BulkRegionResultItemData
230
- * @property {string} [file_path] - CDN path of the file which was used for bulk import.
231
- * @property {number} [failed] - Count of the failed records.
232
- * @property {Object[]} [failed_records] - Information of records which failed.
233
- * @property {string} action - Denotes the import or export action performed.
234
- * @property {string} batch_id - Unique id to identify the import or export query.
235
- * @property {string} country - Country for which the import or export action is
236
- * performed.
237
- * @property {number} [success] - Denoted if the import or export was successful
238
- * or failure.
239
- * @property {string} region - Region of the country for which import or export
240
- * is triggered.
241
- * @property {string} status - Current status of the import or export action performed.
242
- * @property {number} [total] - Count of total records.
243
- * @property {string} [error_file_path] - Path of the error file.
244
- */
245
- /**
246
- * @typedef BulkRegionResult
247
- * @property {BulkRegionResultItemData[]} items
66
+ * @typedef BulkRegionResponse
67
+ * @property {BulkRegionResponseItemData[]} items
248
68
  * @property {Page} page
249
69
  */
250
70
  /**
251
71
  * @typedef CourierAccount
252
- * @property {string} extension_id - Unique identifier of courier partner extension.
253
- * @property {string} account_id - Unique identifier of courier partner scheme
254
- * and company id combination.
255
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
256
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
257
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
258
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
259
- * account or not.
72
+ * @property {string} extension_id
73
+ * @property {string} account_id
74
+ * @property {string} scheme_id
75
+ * @property {boolean} is_self_ship
76
+ * @property {string} stage
77
+ * @property {boolean} is_own_account
260
78
  */
261
79
  /**
262
- * @typedef CourierAccountDetailsBody
263
- * @property {string} extension_id - Unique identifier of courier partner extension.
264
- * @property {string} [account_id] - Unique identifier of courier partner scheme
265
- * and company id combination.
266
- * @property {string} scheme_id - Unique identifier of courier account.
267
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
268
- * @property {string} stage - Denotes whether the courier account is in enabled
269
- * or disabled stage.
270
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
271
- * account or not.
80
+ * @typedef CourierAccountRequestBody
81
+ * @property {string} extension_id
82
+ * @property {string} [account_id]
83
+ * @property {string} scheme_id
84
+ * @property {boolean} is_self_ship
85
+ * @property {string} stage
86
+ * @property {boolean} is_own_account
272
87
  */
273
88
  /**
274
- * @typedef CourierPartnerAccountFailureResult
89
+ * @typedef CourierPartnerAccountFailureResponse
275
90
  * @property {boolean} success
276
- * @property {ErrorResult[]} error
91
+ * @property {ErrorResponse[]} error
277
92
  */
278
93
  /**
279
- * @typedef CompanyCourierPartnerAccountListResult
280
- * @property {CourierAccountResult[]} items
94
+ * @typedef CompanyCourierPartnerAccountListResponse
95
+ * @property {CourierAccountResponse[]} items
281
96
  * @property {Page} page
282
97
  */
283
98
  /**
284
- * @typedef CourierAccountResult
285
- * @property {string} account_id - Unique identifier of courier partner scheme
286
- * and company id combination.
287
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
99
+ * @typedef CourierAccountResponse
100
+ * @property {string} account_id
101
+ * @property {string} scheme_id
288
102
  * @property {boolean} is_self_ship
289
- * @property {string} stage - Denotes whether the courier account is in enabled
290
- * or disabled stage.
291
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
292
- * account or not.
103
+ * @property {string} stage
104
+ * @property {boolean} is_own_account
293
105
  * @property {CourierPartnerSchemeModel} scheme_rules
294
106
  */
295
107
  /**
296
108
  * @typedef CourierPartnerSchemeModel
297
- * @property {string} extension_id - Unique identifier of courier partner extension.
298
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
299
- * @property {string} name - Name of the scheme
109
+ * @property {string} extension_id
110
+ * @property {string} scheme_id
111
+ * @property {string} name
300
112
  * @property {ArithmeticOperations} weight
301
- * @property {string} transport_type - Mode of transport associated with the
302
- * courier partner scheme.
303
- * @property {string} region - Serviceable region associated with the courier
304
- * partner scheme.
305
- * @property {string} delivery_type - Type of delivery associated with the
306
- * courier partner scheme.
307
- * @property {string[]} payment_mode - Mode of payment associated with the
308
- * courier partner scheme.
309
- * @property {string} stage - Denotes whether the courier partner scheme is in
310
- * enabled or disabled stage.
113
+ * @property {string} transport_type
114
+ * @property {string} region
115
+ * @property {string} delivery_type
116
+ * @property {string[]} payment_mode
117
+ * @property {string} stage
311
118
  * @property {CourierPartnerSchemeFeatures} feature
312
119
  */
313
120
  /**
314
- * @typedef CourierPartnerSchemeDetailsModel
315
- * @property {string} extension_id - Unique identifier of courier partner extension.
316
- * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
317
- * @property {string} name - Name of the courier partner scheme.
121
+ * @typedef CourierPartnerSchemeRequestModel
122
+ * @property {string} extension_id
123
+ * @property {string} [scheme_id]
124
+ * @property {string} name
318
125
  * @property {ArithmeticOperations} weight
319
- * @property {string} transport_type - Mode of transport associated with the
320
- * courier partner scheme.
321
- * @property {string} region - Serviceable region associated with the courier
322
- * partner scheme.
323
- * @property {string} delivery_type - Type of delivery associated with the
324
- * courier partner scheme.
325
- * @property {string[]} payment_mode - Mode of payment associated with the
326
- * courier partner scheme.
327
- * @property {string} stage - Denotes whether the courier partner scheme is in
328
- * enabled or disabled stage.
126
+ * @property {string} transport_type
127
+ * @property {string} region
128
+ * @property {string} delivery_type
129
+ * @property {string[]} payment_mode
130
+ * @property {string} stage
329
131
  * @property {CourierPartnerSchemeFeatures} feature
330
132
  */
331
133
  /**
332
134
  * @typedef CourierPartnerSchemeFeatures
333
- * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
334
- * doorstep quality check services.
335
- * @property {boolean} [qr] - Specifies whether the courier partner supports QR
336
- * code-based operations.
337
- * @property {boolean} [mps] - Denotes if the courier partner supports
338
- * multi-part shipment services.
339
- * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
340
- * feature is supported by the courier partner.
341
- * @property {number} [ndr_attempts] - Number of attempts allowed for resolving
342
- * Non-Delivery Reports (NDR).
343
- * @property {boolean} [dangerous_goods] - Specifies if the courier partner
344
- * handles the transportation of dangerous goods.
345
- * @property {boolean} [fragile_goods] - Indicates whether the courier partner
346
- * manages the shipment of fragile goods.
347
- * @property {boolean} [restricted_goods] - Indicates if the courier partner
348
- * handles restricted goods, as per regulatory guidelines.
349
- * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
350
- * provides cold storage facilities for goods.
351
- * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
352
- * supports doorstep exchange services.
353
- * @property {boolean} [doorstep_return] - Specifies if the courier partner
354
- * offers doorstep return services.
355
- * @property {boolean} [product_installation] - Indicates if the courier partner
356
- * provides product installation services upon delivery.
357
- * @property {boolean} [openbox_delivery] - Specifies whether the courier
358
- * partner supports open-box delivery, allowing customers to inspect goods
359
- * before accepting.
360
- * @property {string} [status_updates] - Describes the type of status updates
361
- * provided by the courier partner (e.g., real-time, periodic).
362
- * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
363
- * partner supports multiple pickups to a single drop location.
364
- * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
365
- * partner supports single pickup to multiple drop locations.
366
- * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
367
- * offers services for multiple pickups to multiple drop locations.
368
- * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
369
- * supports the generation of e-waybills for shipments.
370
- * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
371
- * of items allowed in a quality check shipment.
372
- * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
373
- * quantity of items allowed in a non-quality check shipment.
135
+ * @property {boolean} [doorstep_qc]
136
+ * @property {boolean} [qr]
137
+ * @property {boolean} [mps]
138
+ * @property {boolean} [ndr]
139
+ * @property {number} [ndr_attempts]
140
+ * @property {boolean} [dangerous_goods]
141
+ * @property {boolean} [fragile_goods]
142
+ * @property {boolean} [restricted_goods]
143
+ * @property {boolean} [cold_storage_goods]
144
+ * @property {boolean} [doorstep_exchange]
145
+ * @property {boolean} [doorstep_return]
146
+ * @property {boolean} [product_installation]
147
+ * @property {boolean} [openbox_delivery]
148
+ * @property {string} [status_updates]
149
+ * @property {boolean} [multi_pick_single_drop]
150
+ * @property {boolean} [single_pick_multi_drop]
151
+ * @property {boolean} [multi_pick_multi_drop]
152
+ * @property {boolean} [ewaybill]
374
153
  */
375
154
  /**
376
155
  * @typedef ArithmeticOperations
@@ -380,19 +159,14 @@ export = LogisticsPartnerModel;
380
159
  * @property {number} [gte]
381
160
  */
382
161
  /**
383
- * @typedef CourierPartnerSchemeUpdateDetails
384
- * @property {string} name - Name of the scheme.
162
+ * @typedef CourierPartnerSchemeUpdateRequest
163
+ * @property {string} name
385
164
  * @property {ArithmeticOperations} weight
386
- * @property {string} transport_type - Mode of transport associated with the
387
- * courier partner scheme.
388
- * @property {string} region - Serviceable region associated with the courier
389
- * partner scheme.
390
- * @property {string} delivery_type - Type of delivery associated with the
391
- * courier partner scheme.
392
- * @property {string[]} payment_mode - Mode of payment associated with the
393
- * courier partner scheme.
394
- * @property {string} stage - Denotes whether the courier partner scheme is in
395
- * enabled or disabled stage.
165
+ * @property {string} transport_type
166
+ * @property {string} region
167
+ * @property {string} delivery_type
168
+ * @property {string[]} payment_mode
169
+ * @property {string} stage
396
170
  * @property {CourierPartnerSchemeFeatures} feature
397
171
  */
398
172
  /**
@@ -402,127 +176,64 @@ export = LogisticsPartnerModel;
402
176
  */
403
177
  /**
404
178
  * @typedef GetCountriesItems
405
- * @property {string} [id] - Unique identifier of the country.
406
- * @property {string} [name] - Name of the country.
407
- * @property {string} [iso2] - Two-letter ISO code representing the country.
408
- * @property {string} [iso3] - Three-letter ISO code representing the country.
409
- * @property {string[]} [timezones] - List of time zones used in the country
410
- * (e.g., ["America/New_York", "America/Los_Angeles"]).
411
- * @property {HierarchyItems[]} [hierarchy] - Levels within the country (e.g.,
412
- * states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
413
- * {"name": "City", "slug": "city"}]).
414
- * @property {string} [phone_code] - International dialing code for the country
415
- * (e.g., "+1").
416
- * @property {string} [currency] - Indicates currency for the country (e.g., "INR").
417
- * @property {string} [type] - Indicates the type of object (e.g., "country").
418
- * @property {string} [latitude] - Geographical latitude of the country (e.g., "37.0902").
419
- * @property {string} [longitude] - Geographical longitude of the country (e.g.,
420
- * "-95.7129").
421
- * @property {string} [display_name] - User-friendly version of the geographical
422
- * data, which may be more descriptive or formatted differently.
423
- * @property {boolean} [has_next_hierarchy] - More detailed hierarchical data is
424
- * available, meaning states, cities, or other regions within the country have
425
- * been populated in the system.
179
+ * @property {string} [id]
180
+ * @property {string} [name]
181
+ * @property {string} [iso2]
182
+ * @property {string} [iso3]
183
+ * @property {string[]} [timezones]
184
+ * @property {HierarchyItems[]} [hierarchy]
185
+ * @property {string} [phone_code]
186
+ * @property {string} [currency]
187
+ * @property {string} [type]
188
+ * @property {string} [latitude]
189
+ * @property {string} [longitude]
190
+ * @property {string} [display_name]
426
191
  */
427
192
  /**
428
193
  * @typedef HierarchyItems
429
- * @property {string} [display_name] - It represent a country display name.
430
- * @property {string} [slug] - A URL-friendly version of the name, often used
431
- * for referencing or querying purposes.
432
- */
433
- /**
434
- * @typedef ValidationError
435
- * @property {string} message - A brief description of the error encountered.
436
- * @property {string} field - The field in the request that caused the error.
437
- */
438
- /**
439
- * @typedef StandardError
440
- * @property {string} message - A brief description of the error.
194
+ * @property {string} [display_name]
195
+ * @property {string} [slug]
441
196
  */
442
197
  declare class LogisticsPartnerModel {
443
198
  }
444
199
  declare namespace LogisticsPartnerModel {
445
- 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, ArithmeticOperations, CourierPartnerSchemeUpdateDetails, GetCountries, GetCountriesItems, HierarchyItems, ValidationError, StandardError };
200
+ export { BulkRegionServiceabilityTatRequest, BulkRegionServiceabilityTatResponseItemData, ErrorResponse, FailureResponse, BulkRegionServiceabilityTatResponse, Page, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, CourierAccount, CourierAccountRequestBody, CourierPartnerAccountFailureResponse, CompanyCourierPartnerAccountListResponse, CourierAccountResponse, CourierPartnerSchemeModel, CourierPartnerSchemeRequestModel, CourierPartnerSchemeFeatures, ArithmeticOperations, CourierPartnerSchemeUpdateRequest, GetCountries, GetCountriesItems, HierarchyItems };
446
201
  }
447
- /** @returns {BulkRegionServiceabilityTatDetails} */
448
- declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
449
- type BulkRegionServiceabilityTatDetails = {
450
- /**
451
- * - Name of the country.
452
- */
202
+ /** @returns {BulkRegionServiceabilityTatRequest} */
203
+ declare function BulkRegionServiceabilityTatRequest(): BulkRegionServiceabilityTatRequest;
204
+ type BulkRegionServiceabilityTatRequest = {
453
205
  country: string;
454
- /**
455
- * - Name of the region for which the
456
- * tat/serviceability file needs to be downloaded.
457
- */
458
206
  region: string;
459
- /**
460
- * - Denotes the type of file.
461
- */
462
207
  type: string;
463
208
  };
464
- /** @returns {BulkRegionServiceabilityTatResultItemData} */
465
- declare function BulkRegionServiceabilityTatResultItemData(): BulkRegionServiceabilityTatResultItemData;
466
- type BulkRegionServiceabilityTatResultItemData = {
467
- /**
468
- * - Name of the country.
469
- */
209
+ /** @returns {BulkRegionServiceabilityTatResponseItemData} */
210
+ declare function BulkRegionServiceabilityTatResponseItemData(): BulkRegionServiceabilityTatResponseItemData;
211
+ type BulkRegionServiceabilityTatResponseItemData = {
470
212
  country?: string;
471
- /**
472
- * - Name of the region for which the
473
- * tat/serviceability file needs to be downloaded.
474
- */
475
213
  region?: string;
476
- /**
477
- * - Denotes the type of data.
478
- */
479
214
  type?: string;
480
- /**
481
- * - Unique identifier identifying the perticular request.
482
- */
483
215
  batch_id?: string;
484
- /**
485
- * - Current status of the request.
486
- */
487
216
  status?: string;
488
- /**
489
- * - Information of records which failed
490
- */
491
217
  failed_records?: any[];
492
- /**
493
- * - CDN path of the file.
494
- */
495
218
  file_path?: string;
496
219
  };
497
- /** @returns {ErrorResult} */
498
- declare function ErrorResult(): ErrorResult;
499
- type ErrorResult = {
500
- /**
501
- * - Fields containing the error.
502
- */
220
+ /** @returns {ErrorResponse} */
221
+ declare function ErrorResponse(): ErrorResponse;
222
+ type ErrorResponse = {
503
223
  value: string;
504
- /**
505
- * - Description of the error.
506
- */
507
224
  message: string;
508
- /**
509
- * - Type of the error.
510
- */
511
225
  type: string;
512
226
  };
513
- /** @returns {FailureResult} */
514
- declare function FailureResult(): FailureResult;
515
- type FailureResult = {
516
- /**
517
- * - Denotes if the request was successfully executed.
518
- */
227
+ /** @returns {FailureResponse} */
228
+ declare function FailureResponse(): FailureResponse;
229
+ type FailureResponse = {
519
230
  success: boolean;
520
- error: ErrorResult[];
231
+ error: ErrorResponse[];
521
232
  };
522
- /** @returns {BulkRegionServiceabilityTatResult} */
523
- declare function BulkRegionServiceabilityTatResult(): BulkRegionServiceabilityTatResult;
524
- type BulkRegionServiceabilityTatResult = {
525
- items?: BulkRegionServiceabilityTatResultItemData[];
233
+ /** @returns {BulkRegionServiceabilityTatResponse} */
234
+ declare function BulkRegionServiceabilityTatResponse(): BulkRegionServiceabilityTatResponse;
235
+ type BulkRegionServiceabilityTatResponse = {
236
+ items?: BulkRegionServiceabilityTatResponseItemData[];
526
237
  page?: Page;
527
238
  };
528
239
  /** @returns {Page} */
@@ -557,772 +268,126 @@ type Page = {
557
268
  */
558
269
  size?: number;
559
270
  };
560
- /** @returns {CourierAccountUpdateDetails} */
561
- declare function CourierAccountUpdateDetails(): CourierAccountUpdateDetails;
562
- type CourierAccountUpdateDetails = {
563
- /**
564
- * - Unique identifier of courier partner extension.
565
- */
566
- extension_id: string;
567
- /**
568
- * - Unique identifier of courier partner scheme.
569
- */
570
- scheme_id: string;
571
- /**
572
- * - Denotes if the account is of self delivery type.
573
- */
574
- is_self_ship: boolean;
575
- /**
576
- * - Denotes whether the account is in enabled or disabled stage.
577
- */
578
- stage: string;
579
- /**
580
- * - Denotes whether it is the seller's own
581
- * account or not.
582
- */
583
- is_own_account: boolean;
584
- };
585
- /** @returns {RegionTatItemResult} */
586
- declare function RegionTatItemResult(): RegionTatItemResult;
587
- type RegionTatItemResult = {
588
- items: RegionTatResult[];
589
- page: Page;
590
- };
591
- /** @returns {RegionServiceabilityItemResult} */
592
- declare function RegionServiceabilityItemResult(): RegionServiceabilityItemResult;
593
- type RegionServiceabilityItemResult = {
594
- items: RegionServiceabilityResult[];
595
- page: Page;
596
- };
597
- /** @returns {ServiceabilityDetailsResult} */
598
- declare function ServiceabilityDetailsResult(): ServiceabilityDetailsResult;
599
- type ServiceabilityDetailsResult = {
600
- /**
601
- * - Boolean value indicating whether
602
- * first-mile service is available or not.
603
- */
604
- first_mile?: boolean;
605
- /**
606
- * - Boolean value indicating whether last-mile
607
- * service is available or not.
608
- */
609
- last_mile?: boolean;
610
- /**
611
- * - Limit on the amount of cash on delivery
612
- * (COD) payments allowed in the specified region.
613
- */
614
- cod_limit?: number;
615
- /**
616
- * - Indicates if doorstep return service
617
- * is available. This refers to the ability to return items directly from the
618
- * customer's doorstep.
619
- */
620
- doorstep_return?: boolean;
621
- /**
622
- * - Indicates if doorstep quality check
623
- * service is available. This refers to the ability to perform quality checks
624
- * on items at the customer's doorstep.
625
- */
626
- doorstep_qc?: boolean;
627
- /**
628
- * - Time of day by which pickups must be
629
- * scheduled to be processed on the same day.
630
- */
631
- pickup_cutoff?: string;
632
- /**
633
- * - Boolean value indicating whether
634
- * installation services are available in the specified region or not.
635
- */
636
- installation?: boolean;
637
- /**
638
- * - Unique identifier for the serviceability record.
639
- */
640
- id?: string;
641
- };
642
- /** @returns {ServiceabilityDetails} */
643
- declare function ServiceabilityDetails(): ServiceabilityDetails;
644
- type ServiceabilityDetails = {
645
- /**
646
- * - Boolean value indicating whether
647
- * first-mile service is available or not.
648
- */
649
- first_mile?: boolean;
650
- /**
651
- * - Boolean value indicating whether last-mile
652
- * service is available or not.
653
- */
654
- last_mile?: boolean;
655
- /**
656
- * - Limit on the amount of cash on delivery
657
- * (COD) payments allowed in the specified region.
658
- */
659
- cod_limit?: number;
660
- /**
661
- * - Indicates if doorstep return service
662
- * is available. This refers to the ability to return items directly from the
663
- * customer's doorstep.
664
- */
665
- doorstep_return?: boolean;
666
- /**
667
- * - Indicates if doorstep quality check
668
- * service is available. This refers to the ability to perform quality checks
669
- * on items at the customer's doorstep.
670
- */
671
- doorstep_qc?: boolean;
672
- /**
673
- * - Time of day by which pickups must be
674
- * scheduled to be processed on the same day.
675
- */
676
- pickup_cutoff?: string;
677
- /**
678
- * - Boolean value indicating whether
679
- * installation services are available in the specified region or not.
680
- */
681
- installation?: boolean;
682
- };
683
- /** @returns {RegionServiceabilityResult} */
684
- declare function RegionServiceabilityResult(): RegionServiceabilityResult;
685
- type RegionServiceabilityResult = {
686
- /**
687
- * - ISO2 code representing the country where
688
- * the serviceability is being specified.
689
- */
690
- country_code: string;
691
- /**
692
- * - Code representing the state or province
693
- * within the country where the serviceability is being specified.
694
- */
695
- state_code?: string;
696
- /**
697
- * - Code representing the city within the state
698
- * where the serviceability is being specified.
699
- */
700
- city_code?: string;
701
- /**
702
- * - Code representing a specific sector or
703
- * district within the city where the serviceability is being specified.
704
- */
705
- sector_code?: string;
706
- /**
707
- * - Postal or ZIP code for the specific area
708
- * within the city where the serviceability is being specified.
709
- */
710
- pincode?: string;
711
- /**
712
- * - Boolean value indicating whether
713
- * first-mile service is available or not.
714
- */
715
- first_mile?: boolean;
716
- /**
717
- * - Boolean value indicating whether last-mile
718
- * service is available or not.
719
- */
720
- last_mile?: boolean;
721
- /**
722
- * - Limit on the amount of cash on delivery
723
- * (COD) payments allowed in the specified region.
724
- */
725
- cod_limit?: number;
726
- /**
727
- * - Indicates if doorstep return service
728
- * is available. This refers to the ability to return items directly from the
729
- * customer's doorstep.
730
- */
731
- doorstep_return?: boolean;
732
- /**
733
- * - Indicates if doorstep quality check
734
- * service is available. This refers to the ability to perform quality checks
735
- * on items at the customer's doorstep.
736
- */
737
- doorstep_qc?: boolean;
738
- /**
739
- * - Time of day by which pickups must be
740
- * scheduled to be processed on the same day.
741
- */
742
- pickup_cutoff?: string;
743
- /**
744
- * - Boolean value indicating whether
745
- * installation services are available in the specified region or not.
746
- */
747
- installation?: boolean;
748
- /**
749
- * - Unique identifier for the serviceability record.
750
- */
751
- id: string;
752
- };
753
- /** @returns {RegionServiceabilityDetails} */
754
- declare function RegionServiceabilityDetails(): RegionServiceabilityDetails;
755
- type RegionServiceabilityDetails = {
756
- /**
757
- * - ISO2 code representing the country where
758
- * the serviceability is being specified.
759
- */
760
- country_code: string;
761
- /**
762
- * - Code representing the state or province
763
- * within the country where the serviceability is being specified.
764
- */
765
- state_code?: string;
766
- /**
767
- * - Code representing the city within the state
768
- * where the serviceability is being specified.
769
- */
770
- city_code?: string;
771
- /**
772
- * - Code representing a specific sector or
773
- * district within the city where the serviceability is being specified.
774
- */
775
- sector_code?: string;
776
- /**
777
- * - Postal or ZIP code for the specific area
778
- * within the city where the serviceability is being specified.
779
- */
780
- pincode?: string;
781
- /**
782
- * - Boolean value indicating whether
783
- * first-mile service is available or not.
784
- */
785
- first_mile?: boolean;
786
- /**
787
- * - Boolean value indicating whether last-mile
788
- * service is available or not.
789
- */
790
- last_mile?: boolean;
791
- /**
792
- * - Limit on the amount of cash on delivery
793
- * (COD) payments allowed in the specified region.
794
- */
795
- cod_limit?: number;
796
- /**
797
- * - Indicates if doorstep return service
798
- * is available. This refers to the ability to return items directly from the
799
- * customer's doorstep.
800
- */
801
- doorstep_return?: boolean;
802
- /**
803
- * - Indicates if doorstep quality check
804
- * service is available. This refers to the ability to perform quality checks
805
- * on items at the customer's doorstep.
806
- */
807
- doorstep_qc?: boolean;
808
- /**
809
- * - Time of day by which pickups must be
810
- * scheduled to be processed on the same day.
811
- */
812
- pickup_cutoff?: string;
813
- /**
814
- * - Boolean value indicating whether
815
- * installation services are available in the specified region or not.
816
- */
817
- installation?: boolean;
818
- };
819
- /** @returns {RegionTatDetails} */
820
- declare function RegionTatDetails(): RegionTatDetails;
821
- type RegionTatDetails = {
822
- /**
823
- * - ISO2 code representing the country of
824
- * origin for the delivery.
825
- */
826
- from_country_code: string;
827
- /**
828
- * - Code representing the state or
829
- * province of origin within the country.
830
- */
831
- from_state_code?: string;
832
- /**
833
- * - Code representing the city of origin
834
- * within the state.
835
- */
836
- from_city_code?: string;
837
- /**
838
- * - Code representing a specific sector
839
- * or district within the city of origin.
840
- */
841
- from_sector_code?: string;
842
- /**
843
- * - Postal or ZIP code of the origin area.
844
- */
845
- from_pincode?: string;
846
- /**
847
- * - ISO2 code representing the destination country.
848
- */
849
- to_country_code: string;
850
- /**
851
- * - Code representing the state or province
852
- * of the destination within the country.
853
- */
854
- to_state_code?: string;
855
- /**
856
- * - Code representing the city of destination
857
- * within the state.
858
- */
859
- to_city_code?: string;
860
- /**
861
- * - Code representing a specific sector or
862
- * district within the city of destination.
863
- */
864
- to_sector_code?: string;
865
- /**
866
- * - Postal or ZIP code of the destination area.
867
- */
868
- to_pincode?: string;
869
- /**
870
- * - Maximum time required for delivery
871
- * from the origin to the destination in seconds.
872
- */
873
- max_delivery_time?: number;
874
- /**
875
- * - Minimum time required for delivery
876
- * from the origin to the destination in seconds.
877
- */
878
- min_delivery_time?: number;
879
- };
880
- /** @returns {RegionTatUpdateDetails} */
881
- declare function RegionTatUpdateDetails(): RegionTatUpdateDetails;
882
- type RegionTatUpdateDetails = {
883
- /**
884
- * - Maximum time required for delivery
885
- * from the origin to the destination in seconds.
886
- */
887
- max_delivery_time?: number;
888
- /**
889
- * - Minimum time required for delivery
890
- * from the origin to the destination in seconds.
891
- */
892
- min_delivery_time?: number;
893
- };
894
- /** @returns {RegionTatResult} */
895
- declare function RegionTatResult(): RegionTatResult;
896
- type RegionTatResult = {
897
- /**
898
- * - ISO2 code representing the country of
899
- * origin for the delivery.
900
- */
901
- from_country_code: string;
902
- /**
903
- * - Code representing the state or
904
- * province of origin within the country.
905
- */
906
- from_state_code?: string;
907
- /**
908
- * - Code representing the city of origin
909
- * within the state.
910
- */
911
- from_city_code?: string;
912
- /**
913
- * - Code representing a specific sector
914
- * or district within the city of origin.
915
- */
916
- from_sector_code?: string;
917
- /**
918
- * - Postal or ZIP code of the origin area.
919
- */
920
- from_pincode?: string;
921
- /**
922
- * - ISO2 code representing the destination country.
923
- */
924
- to_country_code: string;
925
- /**
926
- * - Code representing the state or province
927
- * of the destination within the country.
928
- */
929
- to_state_code?: string;
930
- /**
931
- * - Code representing the city of destination
932
- * within the state.
933
- */
934
- to_city_code?: string;
935
- /**
936
- * - Code representing a specific sector or
937
- * district within the city of destination.
938
- */
939
- to_sector_code?: string;
940
- /**
941
- * - Postal or ZIP code of the destination area.
942
- */
943
- to_pincode?: string;
944
- /**
945
- * - Maximum time required for delivery
946
- * from the origin to the destination in seconds.
947
- */
948
- max_delivery_time?: number;
949
- /**
950
- * - Minimum time required for delivery
951
- * from the origin to the destination in seconds.
952
- */
953
- min_delivery_time?: number;
954
- /**
955
- * - Unique identifier for the delivery time record.
956
- */
957
- id: string;
958
- };
959
- /** @returns {BulkRegionJobDetails} */
960
- declare function BulkRegionJobDetails(): BulkRegionJobDetails;
961
- type BulkRegionJobDetails = {
962
- /**
963
- * - CDN path of the uploaded csv file for bulk import.
964
- */
271
+ /** @returns {BulkRegionJobSerializer} */
272
+ declare function BulkRegionJobSerializer(): BulkRegionJobSerializer;
273
+ type BulkRegionJobSerializer = {
965
274
  file_path?: string;
966
- /**
967
- * - Country for which the tat or serviceability is
968
- * to be imported or exported.
969
- */
970
275
  country: string;
971
- /**
972
- * - Denotes the import or export action to be performed.
973
- */
974
276
  action: string;
975
- /**
976
- * - Region of the country for which import or export
977
- * is triggered.
978
- */
979
277
  region: string;
980
278
  };
981
- /** @returns {BulkRegionResultItemData} */
982
- declare function BulkRegionResultItemData(): BulkRegionResultItemData;
983
- type BulkRegionResultItemData = {
984
- /**
985
- * - CDN path of the file which was used for bulk import.
986
- */
987
- file_path?: string;
988
- /**
989
- * - Count of the failed records.
990
- */
279
+ /** @returns {BulkRegionResponseItemData} */
280
+ declare function BulkRegionResponseItemData(): BulkRegionResponseItemData;
281
+ type BulkRegionResponseItemData = {
282
+ file_path: string;
991
283
  failed?: number;
992
- /**
993
- * - Information of records which failed.
994
- */
995
284
  failed_records?: any[];
996
- /**
997
- * - Denotes the import or export action performed.
998
- */
999
285
  action: string;
1000
- /**
1001
- * - Unique id to identify the import or export query.
1002
- */
1003
286
  batch_id: string;
1004
- /**
1005
- * - Country for which the import or export action is
1006
- * performed.
1007
- */
1008
287
  country: string;
1009
- /**
1010
- * - Denoted if the import or export was successful
1011
- * or failure.
1012
- */
1013
288
  success?: number;
1014
- /**
1015
- * - Region of the country for which import or export
1016
- * is triggered.
1017
- */
1018
289
  region: string;
1019
- /**
1020
- * - Current status of the import or export action performed.
1021
- */
1022
290
  status: string;
1023
- /**
1024
- * - Count of total records.
1025
- */
1026
291
  total?: number;
1027
- /**
1028
- * - Path of the error file.
1029
- */
1030
292
  error_file_path?: string;
1031
293
  };
1032
- /** @returns {BulkRegionResult} */
1033
- declare function BulkRegionResult(): BulkRegionResult;
1034
- type BulkRegionResult = {
1035
- items: BulkRegionResultItemData[];
294
+ /** @returns {BulkRegionResponse} */
295
+ declare function BulkRegionResponse(): BulkRegionResponse;
296
+ type BulkRegionResponse = {
297
+ items: BulkRegionResponseItemData[];
1036
298
  page: Page;
1037
299
  };
1038
300
  /** @returns {CourierAccount} */
1039
301
  declare function CourierAccount(): CourierAccount;
1040
302
  type CourierAccount = {
1041
- /**
1042
- * - Unique identifier of courier partner extension.
1043
- */
1044
303
  extension_id: string;
1045
- /**
1046
- * - Unique identifier of courier partner scheme
1047
- * and company id combination.
1048
- */
1049
304
  account_id: string;
1050
- /**
1051
- * - Unique identifier of courier partner scheme.
1052
- */
1053
305
  scheme_id: string;
1054
- /**
1055
- * - Denotes if the account is of self delivery type.
1056
- */
1057
306
  is_self_ship: boolean;
1058
- /**
1059
- * - Denotes whether the account is in enabled or disabled stage.
1060
- */
1061
307
  stage: string;
1062
- /**
1063
- * - Denotes whether it is the seller's own
1064
- * account or not.
1065
- */
1066
308
  is_own_account: boolean;
1067
309
  };
1068
- /** @returns {CourierAccountDetailsBody} */
1069
- declare function CourierAccountDetailsBody(): CourierAccountDetailsBody;
1070
- type CourierAccountDetailsBody = {
1071
- /**
1072
- * - Unique identifier of courier partner extension.
1073
- */
310
+ /** @returns {CourierAccountRequestBody} */
311
+ declare function CourierAccountRequestBody(): CourierAccountRequestBody;
312
+ type CourierAccountRequestBody = {
1074
313
  extension_id: string;
1075
- /**
1076
- * - Unique identifier of courier partner scheme
1077
- * and company id combination.
1078
- */
1079
314
  account_id?: string;
1080
- /**
1081
- * - Unique identifier of courier account.
1082
- */
1083
315
  scheme_id: string;
1084
- /**
1085
- * - Denotes if the account is of self delivery type.
1086
- */
1087
316
  is_self_ship: boolean;
1088
- /**
1089
- * - Denotes whether the courier account is in enabled
1090
- * or disabled stage.
1091
- */
1092
317
  stage: string;
1093
- /**
1094
- * - Denotes whether it is the seller's own
1095
- * account or not.
1096
- */
1097
318
  is_own_account: boolean;
1098
319
  };
1099
- /** @returns {CourierPartnerAccountFailureResult} */
1100
- declare function CourierPartnerAccountFailureResult(): CourierPartnerAccountFailureResult;
1101
- type CourierPartnerAccountFailureResult = {
320
+ /** @returns {CourierPartnerAccountFailureResponse} */
321
+ declare function CourierPartnerAccountFailureResponse(): CourierPartnerAccountFailureResponse;
322
+ type CourierPartnerAccountFailureResponse = {
1102
323
  success: boolean;
1103
- error: ErrorResult[];
324
+ error: ErrorResponse[];
1104
325
  };
1105
- /** @returns {CompanyCourierPartnerAccountListResult} */
1106
- declare function CompanyCourierPartnerAccountListResult(): CompanyCourierPartnerAccountListResult;
1107
- type CompanyCourierPartnerAccountListResult = {
1108
- items: CourierAccountResult[];
326
+ /** @returns {CompanyCourierPartnerAccountListResponse} */
327
+ declare function CompanyCourierPartnerAccountListResponse(): CompanyCourierPartnerAccountListResponse;
328
+ type CompanyCourierPartnerAccountListResponse = {
329
+ items: CourierAccountResponse[];
1109
330
  page: Page;
1110
331
  };
1111
- /** @returns {CourierAccountResult} */
1112
- declare function CourierAccountResult(): CourierAccountResult;
1113
- type CourierAccountResult = {
1114
- /**
1115
- * - Unique identifier of courier partner scheme
1116
- * and company id combination.
1117
- */
332
+ /** @returns {CourierAccountResponse} */
333
+ declare function CourierAccountResponse(): CourierAccountResponse;
334
+ type CourierAccountResponse = {
1118
335
  account_id: string;
1119
- /**
1120
- * - Unique identifier of courier partner scheme.
1121
- */
1122
336
  scheme_id: string;
1123
337
  is_self_ship: boolean;
1124
- /**
1125
- * - Denotes whether the courier account is in enabled
1126
- * or disabled stage.
1127
- */
1128
338
  stage: string;
1129
- /**
1130
- * - Denotes whether it is the seller's own
1131
- * account or not.
1132
- */
1133
339
  is_own_account: boolean;
1134
340
  scheme_rules: CourierPartnerSchemeModel;
1135
341
  };
1136
342
  /** @returns {CourierPartnerSchemeModel} */
1137
343
  declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
1138
344
  type CourierPartnerSchemeModel = {
1139
- /**
1140
- * - Unique identifier of courier partner extension.
1141
- */
1142
345
  extension_id: string;
1143
- /**
1144
- * - Unique identifier of courier partner scheme.
1145
- */
1146
346
  scheme_id: string;
1147
- /**
1148
- * - Name of the scheme
1149
- */
1150
347
  name: string;
1151
348
  weight: ArithmeticOperations;
1152
- /**
1153
- * - Mode of transport associated with the
1154
- * courier partner scheme.
1155
- */
1156
349
  transport_type: string;
1157
- /**
1158
- * - Serviceable region associated with the courier
1159
- * partner scheme.
1160
- */
1161
350
  region: string;
1162
- /**
1163
- * - Type of delivery associated with the
1164
- * courier partner scheme.
1165
- */
1166
351
  delivery_type: string;
1167
- /**
1168
- * - Mode of payment associated with the
1169
- * courier partner scheme.
1170
- */
1171
352
  payment_mode: string[];
1172
- /**
1173
- * - Denotes whether the courier partner scheme is in
1174
- * enabled or disabled stage.
1175
- */
1176
353
  stage: string;
1177
354
  feature: CourierPartnerSchemeFeatures;
1178
355
  };
1179
- /** @returns {CourierPartnerSchemeDetailsModel} */
1180
- declare function CourierPartnerSchemeDetailsModel(): CourierPartnerSchemeDetailsModel;
1181
- type CourierPartnerSchemeDetailsModel = {
1182
- /**
1183
- * - Unique identifier of courier partner extension.
1184
- */
356
+ /** @returns {CourierPartnerSchemeRequestModel} */
357
+ declare function CourierPartnerSchemeRequestModel(): CourierPartnerSchemeRequestModel;
358
+ type CourierPartnerSchemeRequestModel = {
1185
359
  extension_id: string;
1186
- /**
1187
- * - Unique identifier of courier partner scheme.
1188
- */
1189
360
  scheme_id?: string;
1190
- /**
1191
- * - Name of the courier partner scheme.
1192
- */
1193
361
  name: string;
1194
362
  weight: ArithmeticOperations;
1195
- /**
1196
- * - Mode of transport associated with the
1197
- * courier partner scheme.
1198
- */
1199
363
  transport_type: string;
1200
- /**
1201
- * - Serviceable region associated with the courier
1202
- * partner scheme.
1203
- */
1204
364
  region: string;
1205
- /**
1206
- * - Type of delivery associated with the
1207
- * courier partner scheme.
1208
- */
1209
365
  delivery_type: string;
1210
- /**
1211
- * - Mode of payment associated with the
1212
- * courier partner scheme.
1213
- */
1214
366
  payment_mode: string[];
1215
- /**
1216
- * - Denotes whether the courier partner scheme is in
1217
- * enabled or disabled stage.
1218
- */
1219
367
  stage: string;
1220
368
  feature: CourierPartnerSchemeFeatures;
1221
369
  };
1222
370
  /** @returns {CourierPartnerSchemeFeatures} */
1223
371
  declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
1224
372
  type CourierPartnerSchemeFeatures = {
1225
- /**
1226
- * - Indicates if the courier partner offers
1227
- * doorstep quality check services.
1228
- */
1229
373
  doorstep_qc?: boolean;
1230
- /**
1231
- * - Specifies whether the courier partner supports QR
1232
- * code-based operations.
1233
- */
1234
374
  qr?: boolean;
1235
- /**
1236
- * - Denotes if the courier partner supports
1237
- * multi-part shipment services.
1238
- */
1239
375
  mps?: boolean;
1240
- /**
1241
- * - Indicates if the Non-Delivery Report (NDR)
1242
- * feature is supported by the courier partner.
1243
- */
1244
376
  ndr?: boolean;
1245
- /**
1246
- * - Number of attempts allowed for resolving
1247
- * Non-Delivery Reports (NDR).
1248
- */
1249
377
  ndr_attempts?: number;
1250
- /**
1251
- * - Specifies if the courier partner
1252
- * handles the transportation of dangerous goods.
1253
- */
1254
378
  dangerous_goods?: boolean;
1255
- /**
1256
- * - Indicates whether the courier partner
1257
- * manages the shipment of fragile goods.
1258
- */
1259
379
  fragile_goods?: boolean;
1260
- /**
1261
- * - Indicates if the courier partner
1262
- * handles restricted goods, as per regulatory guidelines.
1263
- */
1264
380
  restricted_goods?: boolean;
1265
- /**
1266
- * - Denotes if the courier partner
1267
- * provides cold storage facilities for goods.
1268
- */
1269
381
  cold_storage_goods?: boolean;
1270
- /**
1271
- * - Indicates if the courier partner
1272
- * supports doorstep exchange services.
1273
- */
1274
382
  doorstep_exchange?: boolean;
1275
- /**
1276
- * - Specifies if the courier partner
1277
- * offers doorstep return services.
1278
- */
1279
383
  doorstep_return?: boolean;
1280
- /**
1281
- * - Indicates if the courier partner
1282
- * provides product installation services upon delivery.
1283
- */
1284
384
  product_installation?: boolean;
1285
- /**
1286
- * - Specifies whether the courier
1287
- * partner supports open-box delivery, allowing customers to inspect goods
1288
- * before accepting.
1289
- */
1290
385
  openbox_delivery?: boolean;
1291
- /**
1292
- * - Describes the type of status updates
1293
- * provided by the courier partner (e.g., real-time, periodic).
1294
- */
1295
386
  status_updates?: string;
1296
- /**
1297
- * - Indicates if the courier
1298
- * partner supports multiple pickups to a single drop location.
1299
- */
1300
387
  multi_pick_single_drop?: boolean;
1301
- /**
1302
- * - Indicates whether the courier
1303
- * partner supports single pickup to multiple drop locations.
1304
- */
1305
388
  single_pick_multi_drop?: boolean;
1306
- /**
1307
- * - Denotes if the courier partner
1308
- * offers services for multiple pickups to multiple drop locations.
1309
- */
1310
389
  multi_pick_multi_drop?: boolean;
1311
- /**
1312
- * - Specifies if the courier partner requires or
1313
- * supports the generation of e-waybills for shipments.
1314
- */
1315
390
  ewaybill?: boolean;
1316
- /**
1317
- * - Defines the maximum quantity
1318
- * of items allowed in a quality check shipment.
1319
- */
1320
- qc_shipment_item_quantity?: number;
1321
- /**
1322
- * - Defines the maximum
1323
- * quantity of items allowed in a non-quality check shipment.
1324
- */
1325
- non_qc_shipment_item_quantity?: number;
1326
391
  };
1327
392
  /** @returns {ArithmeticOperations} */
1328
393
  declare function ArithmeticOperations(): ArithmeticOperations;
@@ -1332,38 +397,15 @@ type ArithmeticOperations = {
1332
397
  lte?: number;
1333
398
  gte?: number;
1334
399
  };
1335
- /** @returns {CourierPartnerSchemeUpdateDetails} */
1336
- declare function CourierPartnerSchemeUpdateDetails(): CourierPartnerSchemeUpdateDetails;
1337
- type CourierPartnerSchemeUpdateDetails = {
1338
- /**
1339
- * - Name of the scheme.
1340
- */
400
+ /** @returns {CourierPartnerSchemeUpdateRequest} */
401
+ declare function CourierPartnerSchemeUpdateRequest(): CourierPartnerSchemeUpdateRequest;
402
+ type CourierPartnerSchemeUpdateRequest = {
1341
403
  name: string;
1342
404
  weight: ArithmeticOperations;
1343
- /**
1344
- * - Mode of transport associated with the
1345
- * courier partner scheme.
1346
- */
1347
405
  transport_type: string;
1348
- /**
1349
- * - Serviceable region associated with the courier
1350
- * partner scheme.
1351
- */
1352
406
  region: string;
1353
- /**
1354
- * - Type of delivery associated with the
1355
- * courier partner scheme.
1356
- */
1357
407
  delivery_type: string;
1358
- /**
1359
- * - Mode of payment associated with the
1360
- * courier partner scheme.
1361
- */
1362
408
  payment_mode: string[];
1363
- /**
1364
- * - Denotes whether the courier partner scheme is in
1365
- * enabled or disabled stage.
1366
- */
1367
409
  stage: string;
1368
410
  feature: CourierPartnerSchemeFeatures;
1369
411
  };
@@ -1376,97 +418,22 @@ type GetCountries = {
1376
418
  /** @returns {GetCountriesItems} */
1377
419
  declare function GetCountriesItems(): GetCountriesItems;
1378
420
  type GetCountriesItems = {
1379
- /**
1380
- * - Unique identifier of the country.
1381
- */
1382
421
  id?: string;
1383
- /**
1384
- * - Name of the country.
1385
- */
1386
422
  name?: string;
1387
- /**
1388
- * - Two-letter ISO code representing the country.
1389
- */
1390
423
  iso2?: string;
1391
- /**
1392
- * - Three-letter ISO code representing the country.
1393
- */
1394
424
  iso3?: string;
1395
- /**
1396
- * - List of time zones used in the country
1397
- * (e.g., ["America/New_York", "America/Los_Angeles"]).
1398
- */
1399
425
  timezones?: string[];
1400
- /**
1401
- * - Levels within the country (e.g.,
1402
- * states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
1403
- * {"name": "City", "slug": "city"}]).
1404
- */
1405
426
  hierarchy?: HierarchyItems[];
1406
- /**
1407
- * - International dialing code for the country
1408
- * (e.g., "+1").
1409
- */
1410
427
  phone_code?: string;
1411
- /**
1412
- * - Indicates currency for the country (e.g., "INR").
1413
- */
1414
428
  currency?: string;
1415
- /**
1416
- * - Indicates the type of object (e.g., "country").
1417
- */
1418
429
  type?: string;
1419
- /**
1420
- * - Geographical latitude of the country (e.g., "37.0902").
1421
- */
1422
430
  latitude?: string;
1423
- /**
1424
- * - Geographical longitude of the country (e.g.,
1425
- * "-95.7129").
1426
- */
1427
431
  longitude?: string;
1428
- /**
1429
- * - User-friendly version of the geographical
1430
- * data, which may be more descriptive or formatted differently.
1431
- */
1432
432
  display_name?: string;
1433
- /**
1434
- * - More detailed hierarchical data is
1435
- * available, meaning states, cities, or other regions within the country have
1436
- * been populated in the system.
1437
- */
1438
- has_next_hierarchy?: boolean;
1439
433
  };
1440
434
  /** @returns {HierarchyItems} */
1441
435
  declare function HierarchyItems(): HierarchyItems;
1442
436
  type HierarchyItems = {
1443
- /**
1444
- * - It represent a country display name.
1445
- */
1446
437
  display_name?: string;
1447
- /**
1448
- * - A URL-friendly version of the name, often used
1449
- * for referencing or querying purposes.
1450
- */
1451
438
  slug?: string;
1452
439
  };
1453
- /** @returns {ValidationError} */
1454
- declare function ValidationError(): ValidationError;
1455
- type ValidationError = {
1456
- /**
1457
- * - A brief description of the error encountered.
1458
- */
1459
- message: string;
1460
- /**
1461
- * - The field in the request that caused the error.
1462
- */
1463
- field: string;
1464
- };
1465
- /** @returns {StandardError} */
1466
- declare function StandardError(): StandardError;
1467
- type StandardError = {
1468
- /**
1469
- * - A brief description of the error.
1470
- */
1471
- message: string;
1472
- };