@gofynd/fdk-client-javascript 1.4.15-beta.6 → 1.4.16-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 (237) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
  6. package/sdk/application/Cart/CartApplicationClient.js +130 -27
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
  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 +19 -30
  14. package/sdk/application/Content/ContentApplicationClient.js +40 -60
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
  17. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  18. package/sdk/application/Finance/FinanceApplicationClient.js +126 -0
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
  20. package/sdk/application/Lead/LeadApplicationClient.js +1 -1
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +118 -8
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
  24. package/sdk/application/Order/OrderApplicationClient.js +62 -8
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
  26. package/sdk/application/Payment/PaymentApplicationClient.js +65 -46
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  30. package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
  31. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  32. package/sdk/application/User/UserApplicationClient.js +6 -6
  33. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  34. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  35. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  37. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  38. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  39. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  40. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  41. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  42. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  43. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  44. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  45. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  46. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  47. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
  48. package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
  49. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  50. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
  51. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  52. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  53. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  54. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  55. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  56. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  57. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  58. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  59. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  60. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  61. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  62. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  64. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  66. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  71. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  72. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  73. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  74. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  75. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  76. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  77. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  78. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  79. package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
  80. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
  81. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
  82. package/sdk/platform/Cart/CartPlatformModel.d.ts +5039 -1300
  83. package/sdk/platform/Cart/CartPlatformModel.js +1976 -1217
  84. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
  85. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
  86. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
  87. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
  88. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
  89. package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
  90. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6941 -2203
  91. package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1687
  92. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
  93. package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
  94. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  95. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  96. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  97. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  98. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  99. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  100. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  101. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  102. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  103. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  104. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  105. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  106. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  107. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  108. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  109. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  110. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  111. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  112. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  113. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  114. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  115. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  116. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  117. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  118. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  119. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  120. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
  121. package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
  122. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
  123. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
  124. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  125. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  126. package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
  127. package/sdk/platform/Content/ContentPlatformModel.js +521 -390
  128. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  129. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  130. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  131. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  132. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  133. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  134. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  136. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  137. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  140. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  141. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  144. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  145. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  146. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  147. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  148. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  149. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  150. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
  151. package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
  152. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
  153. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
  154. package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
  155. package/sdk/platform/Order/OrderPlatformClient.js +416 -198
  156. package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
  157. package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
  158. package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
  159. package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
  160. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  161. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  162. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  163. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  164. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  165. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  166. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  167. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  168. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  169. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  170. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
  171. package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
  172. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  173. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  174. package/sdk/platform/PlatformClient.d.ts +0 -2
  175. package/sdk/platform/PlatformClient.js +0 -4
  176. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  177. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  178. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  179. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  180. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  181. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  182. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +48 -38
  183. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +134 -43
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +38 -44
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +56 -62
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
  192. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  193. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  194. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  195. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  196. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  197. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  198. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  199. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  200. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  201. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  202. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  203. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  204. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  205. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  206. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  207. package/sdk/platform/User/UserPlatformModel.js +23 -23
  208. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  209. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  210. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  211. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  212. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  213. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  214. package/sdk/platform/index.d.ts +0 -1
  215. package/sdk/platform/index.js +0 -2
  216. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  217. package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
  218. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  219. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  220. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  221. package/sdk/public/Content/ContentPublicClient.js +895 -8
  222. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  223. package/sdk/public/Content/ContentPublicModel.js +649 -3
  224. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  225. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  226. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  227. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  228. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  229. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  230. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  231. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  232. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  233. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  234. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  235. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  236. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  237. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -1,10 +1,10 @@
1
1
  export = ServiceabilityPlatformModel;
2
2
  /**
3
- * @typedef UpdateZoneConfigRequest
3
+ * @typedef UpdateZoneConfigDetails
4
4
  * @property {string} [serviceability_type]
5
5
  */
6
6
  /**
7
- * @typedef ServiceabilityErrorResponse
7
+ * @typedef ServiceabilityErrorResult
8
8
  * @property {string} message
9
9
  * @property {string} value
10
10
  * @property {string} type
@@ -16,13 +16,13 @@ export = ServiceabilityPlatformModel;
16
16
  * @property {string} channel_type
17
17
  */
18
18
  /**
19
- * @typedef ApplicationServiceabilityConfigResponse
20
- * @property {ServiceabilityErrorResponse} [error]
19
+ * @typedef ApplicationServiceabilityConfigResult
20
+ * @property {ServiceabilityErrorResult} [error]
21
21
  * @property {ApplicationServiceabilityConfig} [data]
22
22
  * @property {boolean} success
23
23
  */
24
24
  /**
25
- * @typedef EntityRegionView_Request
25
+ * @typedef EntityRegionView_Details
26
26
  * @property {string[]} sub_type
27
27
  * @property {string[]} [parent_id]
28
28
  */
@@ -41,7 +41,7 @@ export = ServiceabilityPlatformModel;
41
41
  * @property {number} current
42
42
  */
43
43
  /**
44
- * @typedef getAppRegionZonesResponse
44
+ * @typedef getAppRegionZonesResult
45
45
  * @property {PageSchema[]} page
46
46
  * @property {ListViewItems[]} items
47
47
  */
@@ -60,7 +60,7 @@ export = ServiceabilityPlatformModel;
60
60
  * @property {string} name
61
61
  */
62
62
  /**
63
- * @typedef EntityRegionView_Response
63
+ * @typedef EntityRegionView_Result
64
64
  * @property {EntityRegionView_Error} error
65
65
  * @property {EntityRegionView_page} page
66
66
  * @property {EntityRegionView_Items[]} data
@@ -106,7 +106,7 @@ export = ServiceabilityPlatformModel;
106
106
  * @property {ListViewChannels[]} channels - The name of the zone.
107
107
  */
108
108
  /**
109
- * @typedef ListViewResponse
109
+ * @typedef ListViewResult
110
110
  * @property {ZoneDataItem} page
111
111
  * @property {ListViewItems[]} items
112
112
  */
@@ -119,7 +119,7 @@ export = ServiceabilityPlatformModel;
119
119
  * @property {number} current
120
120
  */
121
121
  /**
122
- * @typedef CompanyStoreView_Response
122
+ * @typedef CompanyStoreView_Result
123
123
  * @property {CompanyStoreView_PageItems[]} page
124
124
  * @property {Object[]} [items]
125
125
  */
@@ -130,8 +130,9 @@ export = ServiceabilityPlatformModel;
130
130
  */
131
131
  /**
132
132
  * @typedef ZoneProductTypes
133
- * @property {string} type
134
- * @property {string[]} tags
133
+ * @property {string} type - Denotes if the zone is applicable for all the
134
+ * products or specific products.
135
+ * @property {string[]} tags - List of product tags.
135
136
  */
136
137
  /**
137
138
  * @typedef ZoneMappingDetailType
@@ -140,8 +141,8 @@ export = ServiceabilityPlatformModel;
140
141
  */
141
142
  /**
142
143
  * @typedef ZoneMappingType
143
- * @property {string} country
144
- * @property {string[]} regions
144
+ * @property {string} country - Uid for the country.
145
+ * @property {string[]} regions - List of region uid for the given country.
145
146
  */
146
147
  /**
147
148
  * @typedef ZoneMappingRegions
@@ -153,78 +154,89 @@ export = ServiceabilityPlatformModel;
153
154
  */
154
155
  /**
155
156
  * @typedef UpdateZoneData
156
- * @property {string} zone_id
157
- * @property {string} name
158
- * @property {string} slug
159
- * @property {number} company_id
160
- * @property {boolean} is_active
161
- * @property {GetZoneDataViewChannels[]} channels
157
+ * @property {string} zone_id - Unique identifier for the zone.
158
+ * @property {string} name - Name for the zone.
159
+ * @property {string} slug - A human-readable and unique identifier for the
160
+ * zone, derived from the name.
161
+ * @property {number} company_id - Company id associated with the zone.
162
+ * @property {boolean} is_active - A flag indicating whether the zone is active.
163
+ * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
162
164
  * @property {ZoneProductTypes} product
163
- * @property {number[]} store_ids
164
- * @property {string} region_type
165
- * @property {ZoneMappingType[]} mapping
165
+ * @property {number[]} store_ids - A list of store identifiers associated with the zone.
166
+ * @property {string} region_type - Type of region that belongs in the zone.
167
+ * @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
166
168
  */
167
169
  /**
168
- * @typedef ZoneUpdateRequest
170
+ * @typedef ZoneUpdateDetails
169
171
  * @property {string} identifier
170
172
  * @property {UpdateZoneData} data
171
173
  */
172
174
  /**
173
- * @typedef ZoneSuccessResponse
175
+ * @typedef ZoneSuccessResult
174
176
  * @property {number} status_code
175
177
  * @property {boolean} success
176
178
  */
177
179
  /**
178
180
  * @typedef GetZoneDataViewItems
179
- * @property {string} zone_id
180
- * @property {string} name
181
- * @property {string} slug
182
- * @property {number} [company_id]
183
- * @property {boolean} is_active
184
- * @property {GetZoneDataViewChannels[]} channels
181
+ * @property {string} zone_id - The unique identifier for the zone.
182
+ * @property {string} name - The name of the zone for easy identification.
183
+ * @property {string} slug - A URL-friendly version of the zone’s name, used for
184
+ * routing or linking.
185
+ * @property {number} [company_id] - The ID of the company associated with this zone.
186
+ * @property {boolean} is_active - A flag indicating whether the zone is active
187
+ * (true) or inactive (false).
188
+ * @property {GetZoneDataViewChannels[]} channels - A list of channels available
189
+ * within this zone.
185
190
  * @property {ZoneProductTypes} product
186
- * @property {number[]} store_ids
187
- * @property {string} [region_type]
188
- * @property {ZoneMappingType[]} mapping
189
- * @property {number} stores_count
191
+ * @property {number[]} store_ids - A collection of store IDs linked to this zone.
192
+ * @property {string} [region_type] - The type of region the zone represents.
193
+ * @property {ZoneMappingType[]} mapping - A list of mappings defining
194
+ * relationships between this zone and other entities.
195
+ * @property {string} [assignment_preference] - The preferred method for
196
+ * assigning stores or products to the zone.
197
+ * @property {number} stores_count - The total number of stores assigned to this zone.
190
198
  */
191
199
  /**
192
- * @typedef GetSingleZoneDataViewResponse
200
+ * @typedef GetSingleZoneDataViewResult
193
201
  * @property {GetZoneDataViewItems} data
194
202
  */
195
203
  /**
196
204
  * @typedef GetZoneByIdSchema
197
- * @property {string} zone_id
198
- * @property {string} name
199
- * @property {string} slug
200
- * @property {number} [company_id]
201
- * @property {boolean} is_active
202
- * @property {GetZoneDataViewChannels[]} channels
205
+ * @property {string} zone_id - Unique identifier for the zone.
206
+ * @property {string} name - Name for the zone.
207
+ * @property {string} slug - A human-readable and unique identifier for the
208
+ * zone, derived from the name.
209
+ * @property {number} [company_id] - Company id associated with the zone.
210
+ * @property {boolean} is_active - A flag indicating whether the zone is active.
211
+ * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
203
212
  * @property {ZoneProductTypes} product
204
- * @property {number[]} store_ids
205
- * @property {string} region_type
213
+ * @property {number[]} store_ids - A list of store identifiers associated with the zone.
214
+ * @property {string} region_type - Type of region that belongs in the zone.
206
215
  * @property {ZoneMappingDetailType[]} mapping - Country to region mapping for the zone.
216
+ * @property {number} [stores_count]
207
217
  */
208
218
  /**
209
219
  * @typedef CreateZoneData
210
- * @property {string} name
211
- * @property {string} slug
212
- * @property {number} company_id
213
- * @property {boolean} is_active
214
- * @property {GetZoneDataViewChannels[]} channels
215
- * @property {number[]} store_ids
216
- * @property {ZoneProductTypes} product
217
- * @property {string} region_type
218
- * @property {ZoneMappingType[]} mapping
220
+ * @property {string} name - Name of the zone.
221
+ * @property {string} slug - A human-readable and unique identifier for the
222
+ * zone, derived from the name.
223
+ * @property {number} company_id - Unique identifier of the company for which
224
+ * the zone is created.
225
+ * @property {boolean} is_active - A flag indicating whether the zone is active.
226
+ * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
227
+ * @property {number[]} store_ids - A list of store identifiers associated with the zone.
228
+ * @property {string} region_type - Type of region that belongs in the zone.
229
+ * @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
230
+ * @property {ZoneProductTypes} [product]
219
231
  */
220
232
  /**
221
- * @typedef ZoneResponse
222
- * @property {number} status_code
233
+ * @typedef ZoneResult
234
+ * @property {number} [status_code]
223
235
  * @property {string} zone_id
224
236
  * @property {boolean} success
225
237
  */
226
238
  /**
227
- * @typedef GetZoneFromPincodeViewRequest
239
+ * @typedef GetZoneFromPincodeViewDetails
228
240
  * @property {string} country
229
241
  * @property {string} pincode
230
242
  */
@@ -239,17 +251,17 @@ export = ServiceabilityPlatformModel;
239
251
  * @property {number[]} store_ids
240
252
  */
241
253
  /**
242
- * @typedef GetZoneFromPincodeViewResponse
254
+ * @typedef GetZoneFromPincodeViewResult
243
255
  * @property {string} serviceability_type
244
256
  * @property {Zone[]} zones
245
257
  */
246
258
  /**
247
- * @typedef GetZoneFromApplicationIdViewResponse
259
+ * @typedef GetZoneFromApplicationIdViewResult
248
260
  * @property {ZoneDataItem[]} page
249
261
  * @property {ListViewItems[]} items
250
262
  */
251
263
  /**
252
- * @typedef ServiceabilityPageResponse
264
+ * @typedef ServiceabilityPageResult
253
265
  * @property {string} [type]
254
266
  * @property {boolean} [has_next]
255
267
  * @property {number} [item_total]
@@ -262,32 +274,32 @@ export = ServiceabilityPlatformModel;
262
274
  * @property {number} [country_code]
263
275
  */
264
276
  /**
265
- * @typedef ManagerResponse
277
+ * @typedef ManagerResult
266
278
  * @property {string} [email]
267
279
  * @property {MobileNo} [mobile_no]
268
280
  * @property {string} [name]
269
281
  */
270
282
  /**
271
- * @typedef ModifiedByResponse
283
+ * @typedef ModifiedByResult
272
284
  * @property {string} [username]
273
285
  * @property {string} [user_id]
274
286
  */
275
287
  /**
276
- * @typedef IntegrationTypeResponse
288
+ * @typedef IntegrationTypeResult
277
289
  * @property {string} [inventory]
278
290
  * @property {string} [order]
279
291
  */
280
292
  /**
281
- * @typedef ProductReturnConfigResponse
293
+ * @typedef ProductReturnConfigResult
282
294
  * @property {boolean} [on_same_store]
283
295
  */
284
296
  /**
285
- * @typedef ContactNumberResponse
297
+ * @typedef ContactNumberResult
286
298
  * @property {string} [number]
287
299
  * @property {number} [country_code]
288
300
  */
289
301
  /**
290
- * @typedef AddressResponse
302
+ * @typedef AddressResult
291
303
  * @property {string} [city]
292
304
  * @property {string} [address1]
293
305
  * @property {number} [pincode]
@@ -299,25 +311,25 @@ export = ServiceabilityPlatformModel;
299
311
  * @property {number} [longitude]
300
312
  */
301
313
  /**
302
- * @typedef CreatedByResponse
314
+ * @typedef CreatedByResult
303
315
  * @property {string} [username]
304
316
  * @property {string} [user_id]
305
317
  */
306
318
  /**
307
- * @typedef EwayBillResponse
319
+ * @typedef EwayBillResult
308
320
  * @property {boolean} [enabled]
309
321
  */
310
322
  /**
311
- * @typedef EinvoiceResponse
323
+ * @typedef EinvoiceResult
312
324
  * @property {boolean} [enabled]
313
325
  */
314
326
  /**
315
- * @typedef GstCredentialsResponse
316
- * @property {EwayBillResponse} [e_waybill]
317
- * @property {EinvoiceResponse} [e_invoice]
327
+ * @typedef GstCredentialsResult
328
+ * @property {EwayBillResult} [e_waybill]
329
+ * @property {EinvoiceResult} [e_invoice]
318
330
  */
319
331
  /**
320
- * @typedef WarningsResponse
332
+ * @typedef WarningsResult
321
333
  * @property {string} [store_address]
322
334
  */
323
335
  /**
@@ -326,14 +338,14 @@ export = ServiceabilityPlatformModel;
326
338
  * @property {number} [hour]
327
339
  */
328
340
  /**
329
- * @typedef TimmingResponse
341
+ * @typedef TimmingResult
330
342
  * @property {boolean} [open]
331
343
  * @property {string} [weekday]
332
344
  * @property {OpeningClosing} [closing]
333
345
  * @property {OpeningClosing} [opening]
334
346
  */
335
347
  /**
336
- * @typedef DocumentsResponse
348
+ * @typedef DocumentsResult
337
349
  * @property {string} [legal_name]
338
350
  * @property {string} [value]
339
351
  * @property {string} [type]
@@ -353,99 +365,108 @@ export = ServiceabilityPlatformModel;
353
365
  * @property {boolean} [assign_dp_from_sb]
354
366
  */
355
367
  /**
356
- * @typedef LogisticsResponse
368
+ * @typedef LogisticsResult
357
369
  * @property {boolean} [override]
358
370
  * @property {Dp} [dp]
359
371
  */
360
372
  /**
361
- * @typedef ItemResponse
373
+ * @typedef ItemResult
362
374
  * @property {string} [created_on]
363
- * @property {ManagerResponse} [manager]
364
- * @property {ModifiedByResponse} [modified_by]
365
- * @property {IntegrationTypeResponse} [integration_type]
375
+ * @property {ManagerResult} [manager]
376
+ * @property {ModifiedByResult} [modified_by]
377
+ * @property {IntegrationTypeResult} [integration_type]
366
378
  * @property {string} [verified_on]
367
- * @property {ProductReturnConfigResponse} [product_return_config]
368
- * @property {ContactNumberResponse[]} [contact_numbers]
369
- * @property {ModifiedByResponse} [verified_by]
379
+ * @property {ProductReturnConfigResult} [product_return_config]
380
+ * @property {ContactNumberResult[]} [contact_numbers]
381
+ * @property {ModifiedByResult} [verified_by]
370
382
  * @property {string} [stage]
371
- * @property {AddressResponse} [address]
383
+ * @property {AddressResult} [address]
372
384
  * @property {string} [modified_on]
373
- * @property {CreatedByResponse} [created_by]
374
- * @property {GstCredentialsResponse} [gst_credentials]
385
+ * @property {CreatedByResult} [created_by]
386
+ * @property {GstCredentialsResult} [gst_credentials]
375
387
  * @property {string} [display_name]
376
388
  * @property {number} [company_id]
377
389
  * @property {number} [uid]
378
- * @property {Object} [_custom_json]
390
+ * @property {Object} [_custom_json] - Custom JSON for internal usage
379
391
  * @property {string} [code]
380
- * @property {WarningsResponse} [warnings]
392
+ * @property {WarningsResult} [warnings]
381
393
  * @property {string} [name]
382
- * @property {TimmingResponse[]} [timing]
383
- * @property {DocumentsResponse[]} [documents]
394
+ * @property {TimmingResult[]} [timing]
395
+ * @property {DocumentsResult[]} [documents]
384
396
  * @property {string} [store_type]
385
397
  * @property {string} [sub_type]
386
398
  * @property {number} [company]
387
399
  * @property {string} [_cls]
388
- * @property {LogisticsResponse} [logistics]
400
+ * @property {LogisticsResult} [logistics]
389
401
  * @property {string[]} [notification_emails]
390
402
  */
391
403
  /**
392
- * @typedef GetStoresViewResponse
393
- * @property {ServiceabilityPageResponse} page
394
- * @property {ItemResponse[]} [items]
404
+ * @typedef GetStoresViewResult
405
+ * @property {ServiceabilityPageResult} page
406
+ * @property {ItemResult[]} [items]
395
407
  */
396
408
  /**
397
409
  * @typedef PincodeMopData
398
- * @property {number[]} pincodes
399
- * @property {string} country
400
- * @property {string} action
410
+ * @property {number[]} pincodes - A list of pincodes.
411
+ * @property {string} country - Name of the country.
412
+ * @property {string} action - Denotes wether to activate or deavtivate pincodes
413
+ * for COD mode of payment.
401
414
  */
402
415
  /**
403
- * @typedef PincodeMopUpdateResponse
404
- * @property {number} pincode
405
- * @property {string} channel_id
406
- * @property {string} country
407
- * @property {boolean} is_active
416
+ * @typedef PincodeMopUpdateResult
417
+ * @property {number} pincode - Pincode of the region.
418
+ * @property {string} channel_id - Unique identifier of the sales channel.
419
+ * @property {string} country - Country name.
420
+ * @property {boolean} is_active - Denotes whether the pincode mode of payment
421
+ * is active or not.
408
422
  */
409
423
  /**
410
- * @typedef PincodeMOPresponse
411
- * @property {boolean} success
412
- * @property {number} status_code
413
- * @property {string} batch_id
414
- * @property {string} country
415
- * @property {string} action
416
- * @property {number[]} [pincodes]
417
- * @property {PincodeMopUpdateResponse[]} [updated_pincodes]
424
+ * @typedef PincodeMOPResult
425
+ * @property {boolean} success - Denotes if the action was successful or not.
426
+ * @property {number} status_code - Status code for the response.
427
+ * @property {string} batch_id - Unique identifier identifying the perticular request.
428
+ * @property {string} country - Name of the country.
429
+ * @property {string} action - Denotes wether to activate or deavtivate pincodes
430
+ * for COD mode of payment.
431
+ * @property {number[]} [pincodes] - List of pincodes.
432
+ * @property {PincodeMopUpdateResult[]} [updated_pincodes] - Details of the
433
+ * updated pincodes.
418
434
  */
419
435
  /**
420
436
  * @typedef CommonError
421
- * @property {string} [status_code]
437
+ * @property {string} [status_code] - Status code for the error.
422
438
  * @property {Object} [error]
423
- * @property {string} [success]
439
+ * @property {string} [success] - Whether operation was successful.
424
440
  */
425
441
  /**
426
442
  * @typedef PincodeMopBulkData
427
- * @property {string} batch_id
428
- * @property {string} s3_url
443
+ * @property {string} batch_id - Unique identifier for the request.
444
+ * @property {string} s3_url - CDN url for the uploaded file.
429
445
  */
430
446
  /**
431
- * @typedef PincodeBulkViewResponse
447
+ * @typedef PincodeBulkViewResult
432
448
  * @property {string} batch_id
433
- * @property {string} s3_url
449
+ * @property {string} s3_url - CDN url for the uploaded file.
434
450
  */
435
451
  /**
436
- * @typedef PincodeCodStatusListingRequest
437
- * @property {string} [country]
438
- * @property {boolean} [is_active]
439
- * @property {number} [pincode]
452
+ * @typedef PincodeCodStatusListingDetails
453
+ * @property {string} [country] - Name of the country.
454
+ * @property {boolean} [is_active] - Search based on the active or inactive flag.
455
+ * @property {number} [pincode] - Search based on the pincode.
440
456
  * @property {number} [current]
441
457
  * @property {number} [page_size]
442
458
  */
443
459
  /**
444
- * @typedef PincodeCodStatusListingResponse
445
- * @property {string} country
446
- * @property {PincodeCodStatusListingResponse[]} data
447
- * @property {boolean} success
448
- * @property {Error[]} [errors]
460
+ * @typedef PincodeCodStatusItem
461
+ * @property {boolean} [active] - Denoted if the pincode is active or not.
462
+ * @property {string} [pincode] - Name of the pincode.
463
+ */
464
+ /**
465
+ * @typedef PincodeCodStatusListingResult
466
+ * @property {string} country - Name of the country.
467
+ * @property {PincodeCodStatusListingResult[]} data - List of pincode details.
468
+ * @property {boolean} success - Denotes if the request was successful or not.
469
+ * @property {Error[]} [errors] - List of error object in case of unsuccessful response.
449
470
  * @property {PincodeCodStatusListingPage} page
450
471
  * @property {PincodeCodStatusListingSummary} summary
451
472
  */
@@ -465,13 +486,13 @@ export = ServiceabilityPlatformModel;
465
486
  */
466
487
  /**
467
488
  * @typedef PincodeCodStatusListingSummary
468
- * @property {number} total_active_pincodes
469
- * @property {number} total_inactive_pincodes
489
+ * @property {number} total_active_pincodes - Count of the total active pincodes.
490
+ * @property {number} total_inactive_pincodes - Count of the total inactive pincodes.
470
491
  */
471
492
  /**
472
- * @typedef PincodeMopUpdateAuditHistoryRequest
473
- * @property {string} entity_type
474
- * @property {string} [file_name]
493
+ * @typedef PincodeMopUpdateAuditHistoryDetails
494
+ * @property {string} entity_type - Type of the entity requested.
495
+ * @property {string} [file_name] - Name of the file.
475
496
  */
476
497
  /**
477
498
  * @typedef PincodeMopUpdateAuditHistoryPaging
@@ -482,21 +503,22 @@ export = ServiceabilityPlatformModel;
482
503
  * @property {number} [item_total]
483
504
  */
484
505
  /**
485
- * @typedef PincodeMopUpdateAuditHistoryResponse
486
- * @property {string} [batch_id]
487
- * @property {string} [entity_type]
488
- * @property {string} [error_file_s3_url]
489
- * @property {string} [s3_url]
490
- * @property {string} [file_name]
506
+ * @typedef PincodeMopUpdateAuditHistoryResult
507
+ * @property {string} [batch_id] - Uniquie identifier of the request.
508
+ * @property {string} [entity_type] - Type of the entity requested.
509
+ * @property {string} [error_file_s3_url] - URL for the error file.
510
+ * @property {string} [s3_url] - CDN url for the file uploaded.
511
+ * @property {string} [file_name] - Name of the file.
491
512
  * @property {string} [updated_at]
492
513
  * @property {string} [updated_by]
493
- * @property {boolean} [success]
514
+ * @property {boolean} [success] - Denotes if the request was successfully processed.
494
515
  */
495
516
  /**
496
- * @typedef PincodeMopUpdateAuditHistoryResponseData
497
- * @property {string} [entity_type]
517
+ * @typedef PincodeMopUpdateAuditHistoryResultData
518
+ * @property {string} [entity_type] - Type of the entity requested.
498
519
  * @property {PincodeMopUpdateAuditHistoryPaging} page
499
- * @property {PincodeMopUpdateAuditHistoryResponse[]} data
520
+ * @property {PincodeMopUpdateAuditHistoryResult[]} data - History records of
521
+ * the uploaded files.
500
522
  */
501
523
  /**
502
524
  * @typedef ArithmeticOperations
@@ -523,34 +545,49 @@ export = ServiceabilityPlatformModel;
523
545
  * @property {string[]} [payment_mode]
524
546
  * @property {SchemeRulesFeatures} [feature]
525
547
  */
548
+ /**
549
+ * @typedef CourierAccountUpdateDetails
550
+ * @property {string} extension_id - Unique identifier of courier partner extension.
551
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
552
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
553
+ * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
554
+ * @property {boolean} is_own_account - Denotes whether it is the seller's own
555
+ * account or not.
556
+ */
526
557
  /**
527
558
  * @typedef CourierAccount
528
- * @property {string} extension_id
529
- * @property {string} account_id
530
- * @property {string} scheme_id
531
- * @property {boolean} is_self_ship
532
- * @property {string} stage
533
- * @property {boolean} is_own_account
559
+ * @property {number} company_id - Company id associated with the account.
560
+ * @property {string} extension_id - Unique identifier of courier partner extension.
561
+ * @property {string} account_id - Unique identifier of courier partner scheme
562
+ * and company id combination.
563
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
564
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
565
+ * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
566
+ * @property {boolean} is_own_account - Denotes whether it is the seller's own
567
+ * account or not.
568
+ * @property {CourierPartnerSchemeModel} scheme_rules
534
569
  */
535
570
  /**
536
- * @typedef CourierAccountRequestBody
537
- * @property {string} extension_id
538
- * @property {string} [account_id]
539
- * @property {string} scheme_id
540
- * @property {boolean} is_self_ship
541
- * @property {string} stage
542
- * @property {boolean} is_own_account
571
+ * @typedef CourierAccountDetailsBody
572
+ * @property {string} extension_id - Unique identifier of courier partner extension.
573
+ * @property {string} [account_id] - Unique identifier of courier partner scheme
574
+ * and company id combination.
575
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
576
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
577
+ * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
578
+ * @property {boolean} is_own_account - Denotes whether it is the seller's own
579
+ * account or not.
543
580
  */
544
581
  /**
545
- * @typedef ErrorResponse
546
- * @property {string} value
547
- * @property {string} message
548
- * @property {string} type
582
+ * @typedef ErrorResult
583
+ * @property {string} value - Fields containing the error.
584
+ * @property {string} message - Description of the error.
585
+ * @property {string} type - Type of the error.
549
586
  */
550
587
  /**
551
- * @typedef CourierPartnerAccountFailureResponse
552
- * @property {boolean} success
553
- * @property {ErrorResponse[]} error
588
+ * @typedef CourierPartnerAccountFailureResult
589
+ * @property {boolean} success - Denotes whether the request is a success or failure.
590
+ * @property {ErrorResult[]} error
554
591
  */
555
592
  /**
556
593
  * @typedef Page
@@ -563,31 +600,38 @@ export = ServiceabilityPlatformModel;
563
600
  * @property {number} [size] - The number of items per page.
564
601
  */
565
602
  /**
566
- * @typedef CourierPartnerRuleCPListResponse
567
- * @property {string} [account_id]
568
- * @property {string} [extension_id]
569
- * @property {boolean} [is_self_ship]
570
- * @property {Object} [scheme_rules]
603
+ * @typedef CourierPartnerRuleCPListResult
604
+ * @property {string} account_id - Unique identifier of courier partner scheme
605
+ * and company id combination.
606
+ * @property {string} extension_id - Unique identifier of courier partner extension.
607
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
608
+ * @property {Object} [scheme_rules] - Denotes the scheme rules associated with
609
+ * the courier partner account.
571
610
  */
572
611
  /**
573
- * @typedef CourierPartnerRuleResponse
574
- * @property {boolean} [is_active]
575
- * @property {string} [application_id]
576
- * @property {number} [company_id]
577
- * @property {CourierPartnerRuleConditions} [conditions]
578
- * @property {string[]} [sort]
579
- * @property {Object} [created_by]
580
- * @property {string} [id]
581
- * @property {Object} [modified_by]
582
- * @property {string} [modified_on]
583
- * @property {string} [name]
584
- * @property {string} [type]
585
- * @property {CourierPartnerRuleCPListResponse[]} [cp_list]
612
+ * @typedef CourierPartnerRuleResult
613
+ * @property {boolean} is_active - Denotes whether the given courier partner
614
+ * rule is inactive or active.
615
+ * @property {string} application_id - Unique identifier of the sales channel.
616
+ * @property {number} company_id - Unique identifier of the company.
617
+ * @property {CourierPartnerRuleConditions} conditions
618
+ * @property {string[]} sort - Sort Strategy of the courier partners.
619
+ * @property {Object} [created_by] - The Fynd account used to create the courier
620
+ * partner rule.
621
+ * @property {string} id - Unique identifier of the courier partner rule.
622
+ * @property {Object} [modified_by] - The Fynd account used to modify the
623
+ * courier partner rule.
624
+ * @property {string} [modified_on] - The datetime at which courier partner rule
625
+ * is modified.
626
+ * @property {string} name - Name for the courier partner rule.
627
+ * @property {string} type - The type of the rule.
628
+ * @property {CourierPartnerRuleCPListResult[]} [cp_list]
586
629
  */
587
630
  /**
588
631
  * @typedef CourierPartnerList
589
- * @property {string} extension_id
590
- * @property {string} account_id
632
+ * @property {string} extension_id - Unique identifier of courier partner extension.
633
+ * @property {string} account_id - Unique identifier of courier partner scheme
634
+ * and company id combination.
591
635
  */
592
636
  /**
593
637
  * @typedef LocationRuleValues
@@ -595,7 +639,7 @@ export = ServiceabilityPlatformModel;
595
639
  * @property {string} [sub_type]
596
640
  * @property {string} [name]
597
641
  * @property {string} [display_name]
598
- * @property {string} [parent_id]
642
+ * @property {string[]} [parent_id]
599
643
  * @property {string[]} [parent_ids]
600
644
  */
601
645
  /**
@@ -632,86 +676,168 @@ export = ServiceabilityPlatformModel;
632
676
  */
633
677
  /**
634
678
  * @typedef CourierPartnerRule
635
- * @property {boolean} is_active
636
- * @property {CourierPartnerList[]} [cp_list]
637
- * @property {string} name
679
+ * @property {boolean} is_active - Denotes whether the given courier partner
680
+ * rule is inactive or active.
681
+ * @property {CourierPartnerList[]} [cp_list] - A list of courier partners.
682
+ * @property {string} name - Name for the courier partner rule.
638
683
  * @property {CourierPartnerRuleConditions} conditions
639
- * @property {string[]} sort
684
+ * @property {string[]} sort - Sort Strategy for the courier partners.
685
+ * @property {string} [type] - Denotes the type of the rule.
640
686
  */
641
687
  /**
642
- * @typedef FailureResponse
688
+ * @typedef FailureResult
643
689
  * @property {boolean} success
644
- * @property {ErrorResponse[]} error
690
+ * @property {ErrorResult[]} error
645
691
  */
646
692
  /**
647
- * @typedef CourierPartnerRulesListResponse
648
- * @property {CourierPartnerRuleResponse[]} items
693
+ * @typedef CourierPartnerRulesListResult
694
+ * @property {CourierPartnerRuleResult[]} items
649
695
  * @property {Page} page
650
696
  */
697
+ /**
698
+ * @typedef ShipmentsArticles
699
+ * @property {number} [item_id] - Unique identifier of the item.
700
+ * @property {number} [category_id] - Unique identifier of the category.
701
+ * @property {number} [brand_id] - Unique identifier of the brand.
702
+ * @property {number} [department_id] - Unique identifier of the department.
703
+ * @property {string[]} [tags] - Tags associated with the item.
704
+ */
705
+ /**
706
+ * @typedef ShipmentDimension
707
+ * @property {number} height - Height of the shipment in centimeters.
708
+ * @property {number} length - Length of the shipment in centimeters.
709
+ * @property {number} width - Width of the shipment in centimeters.
710
+ */
711
+ /**
712
+ * @typedef Shipments
713
+ * @property {string} [id] - Unique identifier of the shipment.
714
+ * @property {number} [location_id] - Unique identifier of the selling location.
715
+ * @property {string[]} [location_tags] - Tags associated with the selling location.
716
+ * @property {number} [shipment_weight] - Weight of the shipment.
717
+ * @property {number} [shipment_volumetric_weight] - Volumetric weight of the shipment.
718
+ * @property {number} [shipment_cost] - Total Cost of the shipment.
719
+ * @property {ShipmentDimension} [shipment_dimension]
720
+ * @property {string[]} [courier_partner_schemes] - A List of courier schemes.
721
+ * @property {ShipmentsArticles[]} [articles] - List of articles in the shipment.
722
+ */
723
+ /**
724
+ * @typedef ShipmentCourierPartnerDetails
725
+ * @property {ShipmentsCourierPartnersServiceability} from_location
726
+ * @property {ShipmentsCourierPartnersServiceability} to_location
727
+ * @property {Shipments[]} [shipments] - List of shipments.
728
+ * @property {string} [journey] - Journey type of the shipment forward or return.
729
+ * @property {string} [payment_mode] - Payment mode opted for the shipment.
730
+ */
731
+ /**
732
+ * @typedef CourierPartnerPromise
733
+ * @property {string} min - The earliest possible timestamp.
734
+ * @property {string} max - The latest possible timestamp.
735
+ */
736
+ /**
737
+ * @typedef CourierPartners
738
+ * @property {string} [extension_id] - Unique identifier of courier partner extension.
739
+ * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
740
+ * @property {string} [name] - Name of the courier partner.
741
+ * @property {CourierPartnerPromise} [delivery_promise]
742
+ */
743
+ /**
744
+ * @typedef ShipmentCourierPartners
745
+ * @property {string} [id] - Unique identifier of the shipment.
746
+ * @property {CourierPartners[]} [courier_partners] - Courier partners of the shipment.
747
+ */
748
+ /**
749
+ * @typedef ShipmentCourierPartnerResult
750
+ * @property {CourierPartners[]} [courier_partners]
751
+ * @property {ShipmentCourierPartners[]} [shipments]
752
+ */
753
+ /**
754
+ * @typedef ShipmentsCourierPartnersServiceability
755
+ * @property {string} [pincode] - Postal code or PIN code of the address area.
756
+ * @property {string} [sector_code] - Specifies the sector or district code of
757
+ * the address if applicable.
758
+ * @property {string} [state_code] - Indicates the state or province code of the address.
759
+ * @property {string} [city_code] - Denote the city or municipality code of the address.
760
+ * @property {string} country_code - ISO2 code for the country of the address.
761
+ */
651
762
  /**
652
763
  * @typedef CompanyConfig
653
- * @property {string[]} rule_ids
654
- * @property {string[]} sort
655
- * @property {boolean} [logistics_as_actual]
764
+ * @property {string[]} rule_ids - A list for courier partner rules.
765
+ * @property {string[]} sort - Sort strategy for the courier partners.
766
+ * @property {string} [logistics_as_actual] - Depicts if the courier partner
767
+ * rule configuration plan is subscribed by the seller for which mode.
768
+ * @property {number} company_id - Unique identifier of the company.
769
+ * @property {string} [application_id] - Unique identifier of the sales channel.
656
770
  */
657
771
  /**
658
772
  * @typedef ZoneConfig
659
- * @property {string} [serviceability_type]
773
+ * @property {string} [serviceability_type] - Serviceability type of the delivery zone.
774
+ * @property {number} [active_count] - Count of active delivery zones associated
775
+ * with the sales channel.
776
+ * @property {number} [total_count] - Count of total delivery zones associated
777
+ * with the sales channel.
660
778
  */
661
779
  /**
662
780
  * @typedef ApplicationConfig
663
- * @property {string[]} [rule_ids]
664
- * @property {string[]} [sort]
781
+ * @property {string[]} [rule_ids] - A list of courier partner rules.
782
+ * @property {string[]} [sort] - Strategy adopted to sort the courier partners.
665
783
  * @property {ZoneConfig} [zones]
666
784
  */
667
785
  /**
668
- * @typedef BulkRegionJobSerializer
669
- * @property {string} [file_path]
670
- * @property {string} country
671
- * @property {string} action
672
- * @property {string} region
786
+ * @typedef BulkRegionJobDetails
787
+ * @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
788
+ * @property {string} country - Country for which the tat or serviceability is
789
+ * to be imported or exported.
790
+ * @property {string} action - Denotes the import or export action to be performed.
791
+ * @property {string} region - Region of the country for which import or export
792
+ * is triggered.
673
793
  */
674
794
  /**
675
- * @typedef BulkRegionResponseItemData
676
- * @property {string} file_path
677
- * @property {number} [failed]
795
+ * @typedef BulkRegionResultItemData
796
+ * @property {string} [file_path] - CDN path of the file which was used for bulk import.
797
+ * @property {number} [failed] - Count of the failed records.
678
798
  * @property {Object[]} [failed_records]
679
- * @property {string} action
680
- * @property {string} batch_id
681
- * @property {string} country
682
- * @property {number} [success]
683
- * @property {string} region
684
- * @property {string} status
685
- * @property {number} [total]
686
- * @property {string} [error_file_path]
687
- */
688
- /**
689
- * @typedef BulkRegionResponse
690
- * @property {BulkRegionResponseItemData[]} items
799
+ * @property {string} action - Denotes the import or export action performed.
800
+ * @property {string} batch_id - Unique id to identify the import or export query.
801
+ * @property {string} country - Country for which the import or export action is
802
+ * performed.
803
+ * @property {number} [success] - Denoted if the import or export was successful
804
+ * or failure.
805
+ * @property {string} region - Region of the country for which import or export
806
+ * is triggered.
807
+ * @property {string} status - Current status of the import or export action performed.
808
+ * @property {number} [total] - Count of total records.
809
+ * @property {string} [error_file_path] - Path of the error file.
810
+ */
811
+ /**
812
+ * @typedef BulkRegionResult
813
+ * @property {BulkRegionResultItemData[]} items
691
814
  * @property {Page} page
692
815
  */
693
816
  /**
694
- * @typedef SelfShipResponse
817
+ * @typedef SelfShipResult
695
818
  * @property {boolean} is_active
696
819
  * @property {number} tat
697
820
  */
698
821
  /**
699
822
  * @typedef ApplicationSelfShipConfig
700
- * @property {Object} [self_ship]
823
+ * @property {SelfShipResult} [self_ship]
701
824
  */
702
825
  /**
703
- * @typedef ApplicationSelfShipConfigResponse
704
- * @property {ServiceabilityErrorResponse} [error]
826
+ * @typedef ApplicationSelfShipConfigResult
827
+ * @property {ServiceabilityErrorResult} [error]
705
828
  * @property {ApplicationSelfShipConfig} [data]
706
829
  * @property {boolean} success
707
830
  */
708
831
  /**
709
832
  * @typedef StoreRuleConfigData
710
- * @property {string[]} [rule_ids]
711
- * @property {string[]} [type_based_priority]
712
- * @property {string[]} [tag_based_priority]
713
- * @property {StorePrioritySchema[]} [store_priority]
714
- * @property {string[]} [sort]
833
+ * @property {string[]} [rule_ids] - List of rule ids which are active in the application.
834
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
835
+ * used in the basic prioritization sorting of stores.
836
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
837
+ * used in the basic prioritization sorting of stores.
838
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
839
+ * stores to be used for sorting of stores.
840
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
715
841
  */
716
842
  /**
717
843
  * @typedef CustomerRadiusSchema
@@ -737,69 +863,81 @@ export = ServiceabilityPlatformModel;
737
863
  */
738
864
  /**
739
865
  * @typedef StoreRuleDataSchema
740
- * @property {string} [id]
741
- * @property {string} [name]
742
- * @property {number} [company_id]
743
- * @property {string} [application_id]
744
- * @property {string[]} [type_based_priority]
745
- * @property {string[]} [tag_based_priority]
746
- * @property {StorePrioritySchema[]} [store_priority]
747
- * @property {string[]} [sort]
866
+ * @property {string} [id] - Id of the rule.
867
+ * @property {string} [name] - Name of the rule.
868
+ * @property {number} [company_id] - Company id for which the rule is created.
869
+ * @property {string} [application_id] - Application id for which the rule is created.
870
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
871
+ * used in the basic prioritization sorting of stores.
872
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
873
+ * used in the basic prioritization sorting of stores.
874
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
875
+ * stores to be used for sorting of stores.
876
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
748
877
  * @property {StoreRuleConditionSchema} [conditions]
749
- * @property {boolean} [is_active]
878
+ * @property {boolean} [is_active] - Denotes whether the rule is active or inactive.
750
879
  */
751
880
  /**
752
881
  * @typedef StorePrioritySchema
753
- * @property {string} [id]
754
- * @property {string} [name]
882
+ * @property {number} [id] - Id of the store.
883
+ * @property {string} [name] - Name of the store.
755
884
  */
756
885
  /**
757
- * @typedef GetStoreRulesApiResponse
886
+ * @typedef GetStoreRulesApiResult
758
887
  * @property {StoreRuleDataSchema[]} [items]
759
888
  * @property {Page} [page]
760
889
  */
761
890
  /**
762
- * @typedef CreateStoreRuleRequestSchema
763
- * @property {string} [name]
764
- * @property {boolean} [is_active]
891
+ * @typedef CreateStoreRuleDetailsSchema
892
+ * @property {string} [name] - Name of the rule.
893
+ * @property {boolean} [is_active] - Denotes if the rule is active or not.
765
894
  * @property {StoreRuleConditionSchema} [conditions]
766
- * @property {string[]} [type_based_priority]
767
- * @property {string[]} [tag_based_priority]
768
- * @property {StorePrioritySchema[]} [store_priority]
769
- * @property {string[]} [sort]
770
- */
771
- /**
772
- * @typedef StoreRuleResponseSchema
773
- * @property {string} [id]
774
- * @property {string} [name]
775
- * @property {string} [type]
776
- * @property {string[]} [type_based_priority]
777
- * @property {string[]} [tag_based_priority]
778
- * @property {StorePrioritySchema[]} [store_priority]
779
- * @property {string[]} [sort]
895
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
896
+ * used in the basic prioritization sorting of stores.
897
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
898
+ * used in the basic prioritization sorting of stores.
899
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
900
+ * stores to be used for sorting of stores.
901
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
902
+ */
903
+ /**
904
+ * @typedef StoreRuleResultSchema
905
+ * @property {string} [id] - Id of the rule created.
906
+ * @property {string} [name] - Name of the rule created.
907
+ * @property {string} [type] - Type of the rule created.
908
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
909
+ * used in the rule for sorting of stores.
910
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
911
+ * used in the rule for sorting of stores.
912
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
913
+ * stores to be used for sorting of stores.
914
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
780
915
  * @property {StoreRuleConditionSchema} [conditions]
781
- * @property {boolean} [is_active]
782
- */
783
- /**
784
- * @typedef StoreRuleUpdateResponseSchema
785
- * @property {string} [id]
786
- * @property {string} [name]
787
- * @property {string} [type]
788
- * @property {string[]} [type_based_priority]
789
- * @property {string[]} [tag_based_priority]
790
- * @property {StorePrioritySchema[]} [store_priority]
791
- * @property {string[]} [sort]
916
+ * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
917
+ */
918
+ /**
919
+ * @typedef StoreRuleUpdateResultSchema
920
+ * @property {string} [id] - Id of the rule created.
921
+ * @property {string} [name] - Name of the rule created.
922
+ * @property {string} [type] - Type of the rule created.
923
+ * @property {string[]} [type_based_priority] - Priority of the store type to be
924
+ * used in the rule for sorting of stores.
925
+ * @property {string[]} [tag_based_priority] - Priority of the store tags to be
926
+ * used in the rule for sorting of stores.
927
+ * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
928
+ * stores to be used for sorting of stores.
929
+ * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
792
930
  * @property {StoreRuleConditionSchema} [conditions]
793
- * @property {boolean} [is_active]
794
- * @property {number} [company_id]
795
- * @property {string} [application_id]
931
+ * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
932
+ * @property {number} [company_id] - Company id for which the rule is created.
933
+ * @property {string} [application_id] - Application id for which the rule is created.
796
934
  */
797
935
  /**
798
936
  * @typedef ServiceabilityModel
799
937
  * @property {number} lm_cod_limit
800
938
  * @property {boolean} is_qc
801
- * @property {string} pickup_cutoff
802
- * @property {string} route_code
939
+ * @property {string} [pickup_cutoff]
940
+ * @property {string} [route_code]
803
941
  * @property {boolean} is_first_mile
804
942
  * @property {boolean} is_return
805
943
  * @property {boolean} is_installation
@@ -828,112 +966,136 @@ export = ServiceabilityPlatformModel;
828
966
  */
829
967
  /**
830
968
  * @typedef CourierPartnerSchemeModel
831
- * @property {string} extension_id
832
- * @property {string} scheme_id
969
+ * @property {string} [name] - Name of the scheme.
970
+ * @property {string} extension_id - Unique identifier of courier partner extension.
971
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
972
+ * @property {ArithmeticOperations} [volumetric_weight]
833
973
  * @property {ArithmeticOperations} weight
834
- * @property {string} transport_type
835
- * @property {string} region
836
- * @property {string} delivery_type
837
- * @property {string[]} payment_mode
838
- * @property {string} stage
974
+ * @property {string} transport_type - Mode of transport associated with the
975
+ * courier partner scheme.
976
+ * @property {string} region - Serviceable region associated with the courier
977
+ * partner scheme.
978
+ * @property {string} delivery_type - Type of delivery associated with the
979
+ * courier partner scheme.
980
+ * @property {string[]} payment_mode - Mode of payment associated with the
981
+ * courier partner scheme.
982
+ * @property {string} stage - Denotes whether the courier partner scheme is in
983
+ * enabled or disabled stage.
839
984
  * @property {CourierPartnerSchemeFeatures} feature
840
985
  */
841
986
  /**
842
- * @typedef CourierAccountResponse
843
- * @property {string} account_id
844
- * @property {string} scheme_id
845
- * @property {boolean} is_self_ship
846
- * @property {string} stage
847
- * @property {boolean} is_own_account
848
- * @property {CourierPartnerSchemeModel} scheme_rules
987
+ * @typedef CourierAccountResult
988
+ * @property {number} company_id - Company id associated with the account.
989
+ * @property {string} [extension_id] - Unique identifier of courier partner extension.
990
+ * @property {string} account_id - Unique identifier of courier partner scheme
991
+ * and company id combination.
992
+ * @property {string} scheme_id - Unique identifier of courier partner scheme.
993
+ * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
994
+ * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
995
+ * @property {boolean} is_own_account - Denotes whether it is the seller's own
996
+ * account or not.
997
+ * @property {CourierPartnerSchemeModel} [scheme_rules]
849
998
  */
850
999
  /**
851
- * @typedef CompanyCourierPartnerAccountListResponse
852
- * @property {CourierAccountResponse[]} items
1000
+ * @typedef CompanyCourierPartnerAccountListResult
1001
+ * @property {CourierAccountResult[]} items
853
1002
  * @property {Page} page
854
1003
  */
855
1004
  /**
856
1005
  * @typedef PackageMaterial
857
- * @property {string} name
858
- * @property {number} width
859
- * @property {number} height
860
- * @property {number} length
861
- * @property {PackageMaterialRule[]} [rules]
862
- * @property {number[]} store_ids
863
- * @property {number} weight
864
- * @property {number} error_rate
865
- * @property {string} package_type
866
- * @property {string} size
867
- * @property {string[]} [media]
868
- * @property {Channel[]} channels
869
- * @property {boolean} [track_inventory]
870
- * @property {string} status
871
- * @property {number} [max_weight]
872
- * @property {number} [package_vol_weight]
873
- * @property {boolean} [auto_calculate]
874
- */
875
- /**
876
- * @typedef PackageMaterialResponse
877
- * @property {string} name
878
- * @property {string} [id]
879
- * @property {number} [item_id]
880
- * @property {number} width
881
- * @property {number} height
882
- * @property {number} length
883
- * @property {PackageMaterialRule[]} [rules]
884
- * @property {number[]} store_ids
885
- * @property {number} weight
886
- * @property {number} error_rate
887
- * @property {string} package_type
888
- * @property {string} size
889
- * @property {string[]} [media]
890
- * @property {Channel[]} channels
891
- * @property {boolean} [track_inventory]
892
- * @property {string} status
893
- * @property {number} [max_weight]
894
- * @property {number} [package_vol_weight]
895
- * @property {boolean} [auto_calculate]
1006
+ * @property {string} name - Name of the packaging material.
1007
+ * @property {number} width - Width of the packaging material dimentions in centimeter.
1008
+ * @property {number} height - Height of the packaging material dimentions in centimeter.
1009
+ * @property {number} length - Length of the packaging material dimentions in centimeter.
1010
+ * @property {PackageMaterialRule[]} [rules] - Product group rules associated
1011
+ * with the packaging.
1012
+ * @property {number[]} store_ids - Store ids where the packaging is avaiable.
1013
+ * @property {number} weight - Package's weight in gram.
1014
+ * @property {number} error_rate - Error Rate associated with the packaging dimensions.
1015
+ * @property {string} package_type - Type of package material.
1016
+ * @property {string} size - Physical size of the packaging.
1017
+ * @property {string[]} [media] - Image urls associated with the packaging material.
1018
+ * @property {Channel[]} channels - Sales channel where packaging is applicable.
1019
+ * @property {boolean} [track_inventory] - Denotes if the track of the inventory
1020
+ * should be kept.
1021
+ * @property {string} status - Current status of the packaging material, if it
1022
+ * is active or inactive.
1023
+ * @property {number} [max_weight] - Maximum weight holding capacity.
1024
+ * @property {number} [package_vol_weight] - Volumetric weight that a packaging
1025
+ * material can carry.
1026
+ * @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
1027
+ * should be auto calculated or not.
1028
+ */
1029
+ /**
1030
+ * @typedef PackageMaterialResult
1031
+ * @property {string} name - Name of the packaging material.
1032
+ * @property {string} [id] - Id of the packaging material.
1033
+ * @property {number} [item_id] - Unique identifier of an item associated with
1034
+ * the packaging material.
1035
+ * @property {number} [company_id] - Company id associated with the packaging material.
1036
+ * @property {number} width - Width of the packaging material dimentions in centimeter.
1037
+ * @property {number} height - Height of the packaging material dimentions in centimeter.
1038
+ * @property {number} length - Length of the packaging material dimentions in centimeter.
1039
+ * @property {PackageMaterialRule[]} [rules] - Product group rules associated
1040
+ * with the packaging.
1041
+ * @property {number[]} store_ids - Store ids where the packaging is avaiable.
1042
+ * @property {number} weight - Package's weight in gram.
1043
+ * @property {number} error_rate - Error Rate associated with the packaging dimensions.
1044
+ * @property {string} package_type - Type of package material.
1045
+ * @property {string} size - Physical size of the packaging.
1046
+ * @property {string[]} [media] - Image urls associated with the packaging material.
1047
+ * @property {Channel[]} channels - Sales channel where packaging is applicable.
1048
+ * @property {boolean} [track_inventory] - Denotes if the track of the inventory
1049
+ * should be kept.
1050
+ * @property {string} status - Current status of the packaging material, if it
1051
+ * is active or inactive.
1052
+ * @property {number} [max_weight] - Maximum weight holding capacity.
1053
+ * @property {number} [package_vol_weight] - Volumetric weight that a packaging
1054
+ * material can carry.
1055
+ * @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
1056
+ * should be auto calculated or not.
896
1057
  */
897
1058
  /**
898
1059
  * @typedef PackageMaterialRule
899
- * @property {string} [rule_id]
1060
+ * @property {string} [rule_id] - Unique identifier of the package rule.
900
1061
  * @property {PackageMaterialRuleQuantity} [quantity]
901
- * @property {number} [weight]
1062
+ * @property {number} [weight] - Volumetric weight in gram.
902
1063
  */
903
1064
  /**
904
1065
  * @typedef PackageRule
905
- * @property {string} name
906
- * @property {number} company_id
907
- * @property {string} type
908
- * @property {boolean} [is_active]
1066
+ * @property {string} name - Name of the package rule.
1067
+ * @property {number} company_id - Unique identifier of the company.
1068
+ * @property {string} type - Type of the rule.
1069
+ * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
909
1070
  * @property {PackageRuleProductTag} [product_tag]
910
1071
  * @property {PackageRuleProduct} [product_id]
911
1072
  * @property {PackageRuleCategory} [category_id]
912
1073
  */
913
1074
  /**
914
- * @typedef PackageRuleResponse
915
- * @property {string} [id]
916
- * @property {string} name
917
- * @property {number} company_id
918
- * @property {string} type
919
- * @property {boolean} [is_active]
1075
+ * @typedef PackageRuleResult
1076
+ * @property {string} [id] - Unique id of a package rule.
1077
+ * @property {string} name - Name of a package rule.
1078
+ * @property {number} company_id - Unique identifier of a company associated
1079
+ * with the package rule.
1080
+ * @property {string} type - Type of the rule created.
1081
+ * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
920
1082
  * @property {PackageRuleProductTag} [product_tag]
921
1083
  * @property {PackageRuleProduct} [product_id]
922
1084
  * @property {PackageRuleCategory} [category_id]
923
1085
  */
924
1086
  /**
925
1087
  * @typedef Channel
926
- * @property {string} [type]
927
- * @property {string} [id]
1088
+ * @property {string} [type] - Type of the channel.
1089
+ * @property {string} [id] - Unique identifier of the channel.
928
1090
  */
929
1091
  /**
930
1092
  * @typedef PackageMaterialRuleList
931
- * @property {PackageRuleResponse} [items]
1093
+ * @property {PackageRuleResult} [items]
932
1094
  * @property {Page} [page]
933
1095
  */
934
1096
  /**
935
1097
  * @typedef PackageMaterialList
936
- * @property {PackageMaterialResponse} [items]
1098
+ * @property {PackageMaterialResult} [items]
937
1099
  * @property {Page} [page]
938
1100
  */
939
1101
  /**
@@ -950,17 +1112,18 @@ export = ServiceabilityPlatformModel;
950
1112
  */
951
1113
  /**
952
1114
  * @typedef PackageMaterialRuleQuantity
953
- * @property {number} [min]
954
- * @property {number} [max]
1115
+ * @property {number} [min] - Minimum product's quantity that a packaging can contain.
1116
+ * @property {number} [max] - Maximum product's quantity that a packaging can contain.
955
1117
  */
956
1118
  /**
957
- * @typedef RulePriorityRequest
958
- * @property {string} rule_id
959
- * @property {number} priority
1119
+ * @typedef RulePriorityDetails
1120
+ * @property {string} rule_id - Rule id whose priority needs to be changed.
1121
+ * @property {number} priority - New priority of the rule.
960
1122
  */
961
1123
  /**
962
- * @typedef RulePriorityResponse
963
- * @property {boolean} [success]
1124
+ * @typedef RulePriorityResult
1125
+ * @property {boolean} [success] - Denotes if the priority of the rule is
1126
+ * changes successfully or not.
964
1127
  */
965
1128
  /**
966
1129
  * @typedef ArticleAssignment
@@ -987,7 +1150,7 @@ export = ServiceabilityPlatformModel;
987
1150
  * @typedef OptimalLocationsArticles
988
1151
  * @property {number} item_id
989
1152
  * @property {string} size
990
- * @property {string} quantity
1153
+ * @property {number} quantity
991
1154
  * @property {string} [group_id]
992
1155
  * @property {boolean} [is_primary_item]
993
1156
  * @property {Object} [meta]
@@ -997,15 +1160,15 @@ export = ServiceabilityPlatformModel;
997
1160
  * @property {number} [seller_id]
998
1161
  */
999
1162
  /**
1000
- * @typedef OptimlLocationsRequestSchema
1163
+ * @typedef OptimlLocationsDetailsSchema
1001
1164
  * @property {string} channel_id
1002
1165
  * @property {string} channel_type
1003
1166
  * @property {string} [channel_identifier]
1004
1167
  * @property {LocationDetailsServiceability} to_serviceability
1005
- * @property {OptimalLocationsArticles} [article]
1168
+ * @property {OptimalLocationsArticles[]} [articles]
1006
1169
  */
1007
1170
  /**
1008
- * @typedef OptimalLocationArticlesResponse
1171
+ * @typedef OptimalLocationArticlesResult
1009
1172
  * @property {number} item_id
1010
1173
  * @property {string} size
1011
1174
  * @property {number} quantity
@@ -1022,28 +1185,37 @@ export = ServiceabilityPlatformModel;
1022
1185
  * @property {string} uid
1023
1186
  */
1024
1187
  /**
1025
- * @typedef OptimalLocationAssignedStoresResponse
1188
+ * @typedef OptimalLocationAssignedStoresResult
1026
1189
  * @property {number} store_id
1027
- * @property {OptimalLocationArticlesResponse[]} articles
1190
+ * @property {OptimalLocationArticlesResult[]} articles
1191
+ */
1192
+ /**
1193
+ * @typedef OptimalLocationsResult
1194
+ * @property {OptimalLocationAssignedStoresResult[]} assigned_stores
1195
+ * @property {ErrorResult[]} [faulty_articles]
1196
+ */
1197
+ /**
1198
+ * @typedef ValidationError
1199
+ * @property {string} message - A brief description of the error encountered.
1200
+ * @property {string} field - The field in the request that caused the error.
1028
1201
  */
1029
1202
  /**
1030
- * @typedef OptimalLocationsResponse
1031
- * @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
1032
- * @property {ErrorResponse[]} [faulty_articles]
1203
+ * @typedef StandardError
1204
+ * @property {string} message - A brief description of the error.
1033
1205
  */
1034
1206
  declare class ServiceabilityPlatformModel {
1035
1207
  }
1036
1208
  declare namespace ServiceabilityPlatformModel {
1037
- export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingDetailType, ZoneMappingType, ZoneMappingRegions, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, CourierAccountRequestBody, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerRuleCPListResponse, CourierPartnerRuleResponse, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
1209
+ export { UpdateZoneConfigDetails, ServiceabilityErrorResult, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResult, EntityRegionView_Details, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResult, PageSchema, EntityRegionView_Items, EntityRegionView_Result, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResult, CompanyStoreView_PageItems, CompanyStoreView_Result, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingDetailType, ZoneMappingType, ZoneMappingRegions, UpdateZoneData, ZoneUpdateDetails, ZoneSuccessResult, GetZoneDataViewItems, GetSingleZoneDataViewResult, GetZoneByIdSchema, CreateZoneData, ZoneResult, GetZoneFromPincodeViewDetails, Zone, GetZoneFromPincodeViewResult, GetZoneFromApplicationIdViewResult, ServiceabilityPageResult, MobileNo, ManagerResult, ModifiedByResult, IntegrationTypeResult, ProductReturnConfigResult, ContactNumberResult, AddressResult, CreatedByResult, EwayBillResult, EinvoiceResult, GstCredentialsResult, WarningsResult, OpeningClosing, TimmingResult, DocumentsResult, Dp, LogisticsResult, ItemResult, GetStoresViewResult, PincodeMopData, PincodeMopUpdateResult, PincodeMOPResult, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusItem, PincodeCodStatusListingResult, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, PincodeMopUpdateAuditHistoryResultData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccountUpdateDetails, CourierAccount, CourierAccountDetailsBody, ErrorResult, CourierPartnerAccountFailureResult, Page, CourierPartnerRuleCPListResult, CourierPartnerRuleResult, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResult, CourierPartnerRulesListResult, ShipmentsArticles, ShipmentDimension, Shipments, ShipmentCourierPartnerDetails, CourierPartnerPromise, CourierPartners, ShipmentCourierPartners, ShipmentCourierPartnerResult, ShipmentsCourierPartnersServiceability, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, SelfShipResult, ApplicationSelfShipConfig, ApplicationSelfShipConfigResult, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialResult, PackageMaterialRule, PackageRule, PackageRuleResult, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityDetails, RulePriorityResult, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsDetailsSchema, OptimalLocationArticlesResult, OptimalLocationAssignedStoresResult, OptimalLocationsResult, ValidationError, StandardError };
1038
1210
  }
1039
- /** @returns {UpdateZoneConfigRequest} */
1040
- declare function UpdateZoneConfigRequest(): UpdateZoneConfigRequest;
1041
- type UpdateZoneConfigRequest = {
1211
+ /** @returns {UpdateZoneConfigDetails} */
1212
+ declare function UpdateZoneConfigDetails(): UpdateZoneConfigDetails;
1213
+ type UpdateZoneConfigDetails = {
1042
1214
  serviceability_type?: string;
1043
1215
  };
1044
- /** @returns {ServiceabilityErrorResponse} */
1045
- declare function ServiceabilityErrorResponse(): ServiceabilityErrorResponse;
1046
- type ServiceabilityErrorResponse = {
1216
+ /** @returns {ServiceabilityErrorResult} */
1217
+ declare function ServiceabilityErrorResult(): ServiceabilityErrorResult;
1218
+ type ServiceabilityErrorResult = {
1047
1219
  message: string;
1048
1220
  value: string;
1049
1221
  type: string;
@@ -1055,16 +1227,16 @@ type ApplicationServiceabilityConfig = {
1055
1227
  serviceability_type: string;
1056
1228
  channel_type: string;
1057
1229
  };
1058
- /** @returns {ApplicationServiceabilityConfigResponse} */
1059
- declare function ApplicationServiceabilityConfigResponse(): ApplicationServiceabilityConfigResponse;
1060
- type ApplicationServiceabilityConfigResponse = {
1061
- error?: ServiceabilityErrorResponse;
1230
+ /** @returns {ApplicationServiceabilityConfigResult} */
1231
+ declare function ApplicationServiceabilityConfigResult(): ApplicationServiceabilityConfigResult;
1232
+ type ApplicationServiceabilityConfigResult = {
1233
+ error?: ServiceabilityErrorResult;
1062
1234
  data?: ApplicationServiceabilityConfig;
1063
1235
  success: boolean;
1064
1236
  };
1065
- /** @returns {EntityRegionView_Request} */
1066
- declare function EntityRegionView_Request(): EntityRegionView_Request;
1067
- type EntityRegionView_Request = {
1237
+ /** @returns {EntityRegionView_Details} */
1238
+ declare function EntityRegionView_Details(): EntityRegionView_Details;
1239
+ type EntityRegionView_Details = {
1068
1240
  sub_type: string[];
1069
1241
  parent_id?: string[];
1070
1242
  };
@@ -1084,9 +1256,9 @@ type EntityRegionView_page = {
1084
1256
  size: number;
1085
1257
  current: number;
1086
1258
  };
1087
- /** @returns {getAppRegionZonesResponse} */
1088
- declare function getAppRegionZonesResponse(): getAppRegionZonesResponse;
1089
- type getAppRegionZonesResponse = {
1259
+ /** @returns {getAppRegionZonesResult} */
1260
+ declare function getAppRegionZonesResult(): getAppRegionZonesResult;
1261
+ type getAppRegionZonesResult = {
1090
1262
  page: PageSchema[];
1091
1263
  items: ListViewItems[];
1092
1264
  };
@@ -1106,9 +1278,9 @@ type EntityRegionView_Items = {
1106
1278
  uid: string;
1107
1279
  name: string;
1108
1280
  };
1109
- /** @returns {EntityRegionView_Response} */
1110
- declare function EntityRegionView_Response(): EntityRegionView_Response;
1111
- type EntityRegionView_Response = {
1281
+ /** @returns {EntityRegionView_Result} */
1282
+ declare function EntityRegionView_Result(): EntityRegionView_Result;
1283
+ type EntityRegionView_Result = {
1112
1284
  error: EntityRegionView_Error;
1113
1285
  page: EntityRegionView_page;
1114
1286
  data: EntityRegionView_Items[];
@@ -1185,9 +1357,9 @@ type ListViewItems = {
1185
1357
  */
1186
1358
  channels: ListViewChannels[];
1187
1359
  };
1188
- /** @returns {ListViewResponse} */
1189
- declare function ListViewResponse(): ListViewResponse;
1190
- type ListViewResponse = {
1360
+ /** @returns {ListViewResult} */
1361
+ declare function ListViewResult(): ListViewResult;
1362
+ type ListViewResult = {
1191
1363
  page: ZoneDataItem;
1192
1364
  items: ListViewItems[];
1193
1365
  };
@@ -1200,9 +1372,9 @@ type CompanyStoreView_PageItems = {
1200
1372
  size: number;
1201
1373
  current: number;
1202
1374
  };
1203
- /** @returns {CompanyStoreView_Response} */
1204
- declare function CompanyStoreView_Response(): CompanyStoreView_Response;
1205
- type CompanyStoreView_Response = {
1375
+ /** @returns {CompanyStoreView_Result} */
1376
+ declare function CompanyStoreView_Result(): CompanyStoreView_Result;
1377
+ type CompanyStoreView_Result = {
1206
1378
  page: CompanyStoreView_PageItems[];
1207
1379
  items?: any[];
1208
1380
  };
@@ -1215,7 +1387,14 @@ type GetZoneDataViewChannels = {
1215
1387
  /** @returns {ZoneProductTypes} */
1216
1388
  declare function ZoneProductTypes(): ZoneProductTypes;
1217
1389
  type ZoneProductTypes = {
1390
+ /**
1391
+ * - Denotes if the zone is applicable for all the
1392
+ * products or specific products.
1393
+ */
1218
1394
  type: string;
1395
+ /**
1396
+ * - List of product tags.
1397
+ */
1219
1398
  tags: string[];
1220
1399
  };
1221
1400
  /** @returns {ZoneMappingDetailType} */
@@ -1233,7 +1412,13 @@ type ZoneMappingDetailType = {
1233
1412
  /** @returns {ZoneMappingType} */
1234
1413
  declare function ZoneMappingType(): ZoneMappingType;
1235
1414
  type ZoneMappingType = {
1415
+ /**
1416
+ * - Uid for the country.
1417
+ */
1236
1418
  country: string;
1419
+ /**
1420
+ * - List of region uid for the given country.
1421
+ */
1237
1422
  regions: string[];
1238
1423
  };
1239
1424
  /** @returns {ZoneMappingRegions} */
@@ -1260,89 +1445,208 @@ type ZoneMappingRegions = {
1260
1445
  /** @returns {UpdateZoneData} */
1261
1446
  declare function UpdateZoneData(): UpdateZoneData;
1262
1447
  type UpdateZoneData = {
1448
+ /**
1449
+ * - Unique identifier for the zone.
1450
+ */
1263
1451
  zone_id: string;
1452
+ /**
1453
+ * - Name for the zone.
1454
+ */
1264
1455
  name: string;
1456
+ /**
1457
+ * - A human-readable and unique identifier for the
1458
+ * zone, derived from the name.
1459
+ */
1265
1460
  slug: string;
1461
+ /**
1462
+ * - Company id associated with the zone.
1463
+ */
1266
1464
  company_id: number;
1465
+ /**
1466
+ * - A flag indicating whether the zone is active.
1467
+ */
1267
1468
  is_active: boolean;
1469
+ /**
1470
+ * - Channels for which the zone is active.
1471
+ */
1268
1472
  channels: GetZoneDataViewChannels[];
1269
1473
  product: ZoneProductTypes;
1474
+ /**
1475
+ * - A list of store identifiers associated with the zone.
1476
+ */
1270
1477
  store_ids: number[];
1478
+ /**
1479
+ * - Type of region that belongs in the zone.
1480
+ */
1271
1481
  region_type: string;
1482
+ /**
1483
+ * - Country to region mapping for the zone.
1484
+ */
1272
1485
  mapping: ZoneMappingType[];
1273
1486
  };
1274
- /** @returns {ZoneUpdateRequest} */
1275
- declare function ZoneUpdateRequest(): ZoneUpdateRequest;
1276
- type ZoneUpdateRequest = {
1487
+ /** @returns {ZoneUpdateDetails} */
1488
+ declare function ZoneUpdateDetails(): ZoneUpdateDetails;
1489
+ type ZoneUpdateDetails = {
1277
1490
  identifier: string;
1278
1491
  data: UpdateZoneData;
1279
1492
  };
1280
- /** @returns {ZoneSuccessResponse} */
1281
- declare function ZoneSuccessResponse(): ZoneSuccessResponse;
1282
- type ZoneSuccessResponse = {
1493
+ /** @returns {ZoneSuccessResult} */
1494
+ declare function ZoneSuccessResult(): ZoneSuccessResult;
1495
+ type ZoneSuccessResult = {
1283
1496
  status_code: number;
1284
1497
  success: boolean;
1285
1498
  };
1286
1499
  /** @returns {GetZoneDataViewItems} */
1287
1500
  declare function GetZoneDataViewItems(): GetZoneDataViewItems;
1288
1501
  type GetZoneDataViewItems = {
1502
+ /**
1503
+ * - The unique identifier for the zone.
1504
+ */
1289
1505
  zone_id: string;
1506
+ /**
1507
+ * - The name of the zone for easy identification.
1508
+ */
1290
1509
  name: string;
1510
+ /**
1511
+ * - A URL-friendly version of the zone’s name, used for
1512
+ * routing or linking.
1513
+ */
1291
1514
  slug: string;
1515
+ /**
1516
+ * - The ID of the company associated with this zone.
1517
+ */
1292
1518
  company_id?: number;
1519
+ /**
1520
+ * - A flag indicating whether the zone is active
1521
+ * (true) or inactive (false).
1522
+ */
1293
1523
  is_active: boolean;
1524
+ /**
1525
+ * - A list of channels available
1526
+ * within this zone.
1527
+ */
1294
1528
  channels: GetZoneDataViewChannels[];
1295
1529
  product: ZoneProductTypes;
1530
+ /**
1531
+ * - A collection of store IDs linked to this zone.
1532
+ */
1296
1533
  store_ids: number[];
1534
+ /**
1535
+ * - The type of region the zone represents.
1536
+ */
1297
1537
  region_type?: string;
1538
+ /**
1539
+ * - A list of mappings defining
1540
+ * relationships between this zone and other entities.
1541
+ */
1298
1542
  mapping: ZoneMappingType[];
1543
+ /**
1544
+ * - The preferred method for
1545
+ * assigning stores or products to the zone.
1546
+ */
1547
+ assignment_preference?: string;
1548
+ /**
1549
+ * - The total number of stores assigned to this zone.
1550
+ */
1299
1551
  stores_count: number;
1300
1552
  };
1301
- /** @returns {GetSingleZoneDataViewResponse} */
1302
- declare function GetSingleZoneDataViewResponse(): GetSingleZoneDataViewResponse;
1303
- type GetSingleZoneDataViewResponse = {
1553
+ /** @returns {GetSingleZoneDataViewResult} */
1554
+ declare function GetSingleZoneDataViewResult(): GetSingleZoneDataViewResult;
1555
+ type GetSingleZoneDataViewResult = {
1304
1556
  data: GetZoneDataViewItems;
1305
1557
  };
1306
1558
  /** @returns {GetZoneByIdSchema} */
1307
1559
  declare function GetZoneByIdSchema(): GetZoneByIdSchema;
1308
1560
  type GetZoneByIdSchema = {
1561
+ /**
1562
+ * - Unique identifier for the zone.
1563
+ */
1309
1564
  zone_id: string;
1565
+ /**
1566
+ * - Name for the zone.
1567
+ */
1310
1568
  name: string;
1569
+ /**
1570
+ * - A human-readable and unique identifier for the
1571
+ * zone, derived from the name.
1572
+ */
1311
1573
  slug: string;
1574
+ /**
1575
+ * - Company id associated with the zone.
1576
+ */
1312
1577
  company_id?: number;
1578
+ /**
1579
+ * - A flag indicating whether the zone is active.
1580
+ */
1313
1581
  is_active: boolean;
1582
+ /**
1583
+ * - Channels for which the zone is active.
1584
+ */
1314
1585
  channels: GetZoneDataViewChannels[];
1315
1586
  product: ZoneProductTypes;
1587
+ /**
1588
+ * - A list of store identifiers associated with the zone.
1589
+ */
1316
1590
  store_ids: number[];
1591
+ /**
1592
+ * - Type of region that belongs in the zone.
1593
+ */
1317
1594
  region_type: string;
1318
1595
  /**
1319
1596
  * - Country to region mapping for the zone.
1320
1597
  */
1321
1598
  mapping: ZoneMappingDetailType[];
1599
+ stores_count?: number;
1322
1600
  };
1323
1601
  /** @returns {CreateZoneData} */
1324
1602
  declare function CreateZoneData(): CreateZoneData;
1325
1603
  type CreateZoneData = {
1604
+ /**
1605
+ * - Name of the zone.
1606
+ */
1326
1607
  name: string;
1608
+ /**
1609
+ * - A human-readable and unique identifier for the
1610
+ * zone, derived from the name.
1611
+ */
1327
1612
  slug: string;
1613
+ /**
1614
+ * - Unique identifier of the company for which
1615
+ * the zone is created.
1616
+ */
1328
1617
  company_id: number;
1618
+ /**
1619
+ * - A flag indicating whether the zone is active.
1620
+ */
1329
1621
  is_active: boolean;
1622
+ /**
1623
+ * - Channels for which the zone is active.
1624
+ */
1330
1625
  channels: GetZoneDataViewChannels[];
1626
+ /**
1627
+ * - A list of store identifiers associated with the zone.
1628
+ */
1331
1629
  store_ids: number[];
1332
- product: ZoneProductTypes;
1630
+ /**
1631
+ * - Type of region that belongs in the zone.
1632
+ */
1333
1633
  region_type: string;
1634
+ /**
1635
+ * - Country to region mapping for the zone.
1636
+ */
1334
1637
  mapping: ZoneMappingType[];
1638
+ product?: ZoneProductTypes;
1335
1639
  };
1336
- /** @returns {ZoneResponse} */
1337
- declare function ZoneResponse(): ZoneResponse;
1338
- type ZoneResponse = {
1339
- status_code: number;
1640
+ /** @returns {ZoneResult} */
1641
+ declare function ZoneResult(): ZoneResult;
1642
+ type ZoneResult = {
1643
+ status_code?: number;
1340
1644
  zone_id: string;
1341
1645
  success: boolean;
1342
1646
  };
1343
- /** @returns {GetZoneFromPincodeViewRequest} */
1344
- declare function GetZoneFromPincodeViewRequest(): GetZoneFromPincodeViewRequest;
1345
- type GetZoneFromPincodeViewRequest = {
1647
+ /** @returns {GetZoneFromPincodeViewDetails} */
1648
+ declare function GetZoneFromPincodeViewDetails(): GetZoneFromPincodeViewDetails;
1649
+ type GetZoneFromPincodeViewDetails = {
1346
1650
  country: string;
1347
1651
  pincode: string;
1348
1652
  };
@@ -1357,21 +1661,21 @@ type Zone = {
1357
1661
  is_active: boolean;
1358
1662
  store_ids: number[];
1359
1663
  };
1360
- /** @returns {GetZoneFromPincodeViewResponse} */
1361
- declare function GetZoneFromPincodeViewResponse(): GetZoneFromPincodeViewResponse;
1362
- type GetZoneFromPincodeViewResponse = {
1664
+ /** @returns {GetZoneFromPincodeViewResult} */
1665
+ declare function GetZoneFromPincodeViewResult(): GetZoneFromPincodeViewResult;
1666
+ type GetZoneFromPincodeViewResult = {
1363
1667
  serviceability_type: string;
1364
1668
  zones: Zone[];
1365
1669
  };
1366
- /** @returns {GetZoneFromApplicationIdViewResponse} */
1367
- declare function GetZoneFromApplicationIdViewResponse(): GetZoneFromApplicationIdViewResponse;
1368
- type GetZoneFromApplicationIdViewResponse = {
1670
+ /** @returns {GetZoneFromApplicationIdViewResult} */
1671
+ declare function GetZoneFromApplicationIdViewResult(): GetZoneFromApplicationIdViewResult;
1672
+ type GetZoneFromApplicationIdViewResult = {
1369
1673
  page: ZoneDataItem[];
1370
1674
  items: ListViewItems[];
1371
1675
  };
1372
- /** @returns {ServiceabilityPageResponse} */
1373
- declare function ServiceabilityPageResponse(): ServiceabilityPageResponse;
1374
- type ServiceabilityPageResponse = {
1676
+ /** @returns {ServiceabilityPageResult} */
1677
+ declare function ServiceabilityPageResult(): ServiceabilityPageResult;
1678
+ type ServiceabilityPageResult = {
1375
1679
  type?: string;
1376
1680
  has_next?: boolean;
1377
1681
  item_total?: number;
@@ -1384,39 +1688,39 @@ type MobileNo = {
1384
1688
  number?: string;
1385
1689
  country_code?: number;
1386
1690
  };
1387
- /** @returns {ManagerResponse} */
1388
- declare function ManagerResponse(): ManagerResponse;
1389
- type ManagerResponse = {
1691
+ /** @returns {ManagerResult} */
1692
+ declare function ManagerResult(): ManagerResult;
1693
+ type ManagerResult = {
1390
1694
  email?: string;
1391
1695
  mobile_no?: MobileNo;
1392
1696
  name?: string;
1393
1697
  };
1394
- /** @returns {ModifiedByResponse} */
1395
- declare function ModifiedByResponse(): ModifiedByResponse;
1396
- type ModifiedByResponse = {
1698
+ /** @returns {ModifiedByResult} */
1699
+ declare function ModifiedByResult(): ModifiedByResult;
1700
+ type ModifiedByResult = {
1397
1701
  username?: string;
1398
1702
  user_id?: string;
1399
1703
  };
1400
- /** @returns {IntegrationTypeResponse} */
1401
- declare function IntegrationTypeResponse(): IntegrationTypeResponse;
1402
- type IntegrationTypeResponse = {
1704
+ /** @returns {IntegrationTypeResult} */
1705
+ declare function IntegrationTypeResult(): IntegrationTypeResult;
1706
+ type IntegrationTypeResult = {
1403
1707
  inventory?: string;
1404
1708
  order?: string;
1405
1709
  };
1406
- /** @returns {ProductReturnConfigResponse} */
1407
- declare function ProductReturnConfigResponse(): ProductReturnConfigResponse;
1408
- type ProductReturnConfigResponse = {
1710
+ /** @returns {ProductReturnConfigResult} */
1711
+ declare function ProductReturnConfigResult(): ProductReturnConfigResult;
1712
+ type ProductReturnConfigResult = {
1409
1713
  on_same_store?: boolean;
1410
1714
  };
1411
- /** @returns {ContactNumberResponse} */
1412
- declare function ContactNumberResponse(): ContactNumberResponse;
1413
- type ContactNumberResponse = {
1715
+ /** @returns {ContactNumberResult} */
1716
+ declare function ContactNumberResult(): ContactNumberResult;
1717
+ type ContactNumberResult = {
1414
1718
  number?: string;
1415
1719
  country_code?: number;
1416
1720
  };
1417
- /** @returns {AddressResponse} */
1418
- declare function AddressResponse(): AddressResponse;
1419
- type AddressResponse = {
1721
+ /** @returns {AddressResult} */
1722
+ declare function AddressResult(): AddressResult;
1723
+ type AddressResult = {
1420
1724
  city?: string;
1421
1725
  address1?: string;
1422
1726
  pincode?: number;
@@ -1427,31 +1731,31 @@ type AddressResponse = {
1427
1731
  latitude?: number;
1428
1732
  longitude?: number;
1429
1733
  };
1430
- /** @returns {CreatedByResponse} */
1431
- declare function CreatedByResponse(): CreatedByResponse;
1432
- type CreatedByResponse = {
1734
+ /** @returns {CreatedByResult} */
1735
+ declare function CreatedByResult(): CreatedByResult;
1736
+ type CreatedByResult = {
1433
1737
  username?: string;
1434
1738
  user_id?: string;
1435
1739
  };
1436
- /** @returns {EwayBillResponse} */
1437
- declare function EwayBillResponse(): EwayBillResponse;
1438
- type EwayBillResponse = {
1740
+ /** @returns {EwayBillResult} */
1741
+ declare function EwayBillResult(): EwayBillResult;
1742
+ type EwayBillResult = {
1439
1743
  enabled?: boolean;
1440
1744
  };
1441
- /** @returns {EinvoiceResponse} */
1442
- declare function EinvoiceResponse(): EinvoiceResponse;
1443
- type EinvoiceResponse = {
1745
+ /** @returns {EinvoiceResult} */
1746
+ declare function EinvoiceResult(): EinvoiceResult;
1747
+ type EinvoiceResult = {
1444
1748
  enabled?: boolean;
1445
1749
  };
1446
- /** @returns {GstCredentialsResponse} */
1447
- declare function GstCredentialsResponse(): GstCredentialsResponse;
1448
- type GstCredentialsResponse = {
1449
- e_waybill?: EwayBillResponse;
1450
- e_invoice?: EinvoiceResponse;
1750
+ /** @returns {GstCredentialsResult} */
1751
+ declare function GstCredentialsResult(): GstCredentialsResult;
1752
+ type GstCredentialsResult = {
1753
+ e_waybill?: EwayBillResult;
1754
+ e_invoice?: EinvoiceResult;
1451
1755
  };
1452
- /** @returns {WarningsResponse} */
1453
- declare function WarningsResponse(): WarningsResponse;
1454
- type WarningsResponse = {
1756
+ /** @returns {WarningsResult} */
1757
+ declare function WarningsResult(): WarningsResult;
1758
+ type WarningsResult = {
1455
1759
  store_address?: string;
1456
1760
  };
1457
1761
  /** @returns {OpeningClosing} */
@@ -1460,17 +1764,17 @@ type OpeningClosing = {
1460
1764
  minute?: number;
1461
1765
  hour?: number;
1462
1766
  };
1463
- /** @returns {TimmingResponse} */
1464
- declare function TimmingResponse(): TimmingResponse;
1465
- type TimmingResponse = {
1767
+ /** @returns {TimmingResult} */
1768
+ declare function TimmingResult(): TimmingResult;
1769
+ type TimmingResult = {
1466
1770
  open?: boolean;
1467
1771
  weekday?: string;
1468
1772
  closing?: OpeningClosing;
1469
1773
  opening?: OpeningClosing;
1470
1774
  };
1471
- /** @returns {DocumentsResponse} */
1472
- declare function DocumentsResponse(): DocumentsResponse;
1473
- type DocumentsResponse = {
1775
+ /** @returns {DocumentsResult} */
1776
+ declare function DocumentsResult(): DocumentsResult;
1777
+ type DocumentsResult = {
1474
1778
  legal_name?: string;
1475
1779
  value?: string;
1476
1780
  type?: string;
@@ -1490,110 +1794,207 @@ type Dp = {
1490
1794
  transport_mode?: string;
1491
1795
  assign_dp_from_sb?: boolean;
1492
1796
  };
1493
- /** @returns {LogisticsResponse} */
1494
- declare function LogisticsResponse(): LogisticsResponse;
1495
- type LogisticsResponse = {
1797
+ /** @returns {LogisticsResult} */
1798
+ declare function LogisticsResult(): LogisticsResult;
1799
+ type LogisticsResult = {
1496
1800
  override?: boolean;
1497
1801
  dp?: Dp;
1498
1802
  };
1499
- /** @returns {ItemResponse} */
1500
- declare function ItemResponse(): ItemResponse;
1501
- type ItemResponse = {
1803
+ /** @returns {ItemResult} */
1804
+ declare function ItemResult(): ItemResult;
1805
+ type ItemResult = {
1502
1806
  created_on?: string;
1503
- manager?: ManagerResponse;
1504
- modified_by?: ModifiedByResponse;
1505
- integration_type?: IntegrationTypeResponse;
1807
+ manager?: ManagerResult;
1808
+ modified_by?: ModifiedByResult;
1809
+ integration_type?: IntegrationTypeResult;
1506
1810
  verified_on?: string;
1507
- product_return_config?: ProductReturnConfigResponse;
1508
- contact_numbers?: ContactNumberResponse[];
1509
- verified_by?: ModifiedByResponse;
1811
+ product_return_config?: ProductReturnConfigResult;
1812
+ contact_numbers?: ContactNumberResult[];
1813
+ verified_by?: ModifiedByResult;
1510
1814
  stage?: string;
1511
- address?: AddressResponse;
1815
+ address?: AddressResult;
1512
1816
  modified_on?: string;
1513
- created_by?: CreatedByResponse;
1514
- gst_credentials?: GstCredentialsResponse;
1817
+ created_by?: CreatedByResult;
1818
+ gst_credentials?: GstCredentialsResult;
1515
1819
  display_name?: string;
1516
1820
  company_id?: number;
1517
1821
  uid?: number;
1822
+ /**
1823
+ * - Custom JSON for internal usage
1824
+ */
1518
1825
  _custom_json?: any;
1519
1826
  code?: string;
1520
- warnings?: WarningsResponse;
1827
+ warnings?: WarningsResult;
1521
1828
  name?: string;
1522
- timing?: TimmingResponse[];
1523
- documents?: DocumentsResponse[];
1829
+ timing?: TimmingResult[];
1830
+ documents?: DocumentsResult[];
1524
1831
  store_type?: string;
1525
1832
  sub_type?: string;
1526
1833
  company?: number;
1527
1834
  _cls?: string;
1528
- logistics?: LogisticsResponse;
1835
+ logistics?: LogisticsResult;
1529
1836
  notification_emails?: string[];
1530
1837
  };
1531
- /** @returns {GetStoresViewResponse} */
1532
- declare function GetStoresViewResponse(): GetStoresViewResponse;
1533
- type GetStoresViewResponse = {
1534
- page: ServiceabilityPageResponse;
1535
- items?: ItemResponse[];
1838
+ /** @returns {GetStoresViewResult} */
1839
+ declare function GetStoresViewResult(): GetStoresViewResult;
1840
+ type GetStoresViewResult = {
1841
+ page: ServiceabilityPageResult;
1842
+ items?: ItemResult[];
1536
1843
  };
1537
1844
  /** @returns {PincodeMopData} */
1538
1845
  declare function PincodeMopData(): PincodeMopData;
1539
1846
  type PincodeMopData = {
1847
+ /**
1848
+ * - A list of pincodes.
1849
+ */
1540
1850
  pincodes: number[];
1851
+ /**
1852
+ * - Name of the country.
1853
+ */
1541
1854
  country: string;
1855
+ /**
1856
+ * - Denotes wether to activate or deavtivate pincodes
1857
+ * for COD mode of payment.
1858
+ */
1542
1859
  action: string;
1543
1860
  };
1544
- /** @returns {PincodeMopUpdateResponse} */
1545
- declare function PincodeMopUpdateResponse(): PincodeMopUpdateResponse;
1546
- type PincodeMopUpdateResponse = {
1861
+ /** @returns {PincodeMopUpdateResult} */
1862
+ declare function PincodeMopUpdateResult(): PincodeMopUpdateResult;
1863
+ type PincodeMopUpdateResult = {
1864
+ /**
1865
+ * - Pincode of the region.
1866
+ */
1547
1867
  pincode: number;
1868
+ /**
1869
+ * - Unique identifier of the sales channel.
1870
+ */
1548
1871
  channel_id: string;
1872
+ /**
1873
+ * - Country name.
1874
+ */
1549
1875
  country: string;
1876
+ /**
1877
+ * - Denotes whether the pincode mode of payment
1878
+ * is active or not.
1879
+ */
1550
1880
  is_active: boolean;
1551
1881
  };
1552
- /** @returns {PincodeMOPresponse} */
1553
- declare function PincodeMOPresponse(): PincodeMOPresponse;
1554
- type PincodeMOPresponse = {
1882
+ /** @returns {PincodeMOPResult} */
1883
+ declare function PincodeMOPResult(): PincodeMOPResult;
1884
+ type PincodeMOPResult = {
1885
+ /**
1886
+ * - Denotes if the action was successful or not.
1887
+ */
1555
1888
  success: boolean;
1889
+ /**
1890
+ * - Status code for the response.
1891
+ */
1556
1892
  status_code: number;
1893
+ /**
1894
+ * - Unique identifier identifying the perticular request.
1895
+ */
1557
1896
  batch_id: string;
1897
+ /**
1898
+ * - Name of the country.
1899
+ */
1558
1900
  country: string;
1901
+ /**
1902
+ * - Denotes wether to activate or deavtivate pincodes
1903
+ * for COD mode of payment.
1904
+ */
1559
1905
  action: string;
1906
+ /**
1907
+ * - List of pincodes.
1908
+ */
1560
1909
  pincodes?: number[];
1561
- updated_pincodes?: PincodeMopUpdateResponse[];
1910
+ /**
1911
+ * - Details of the
1912
+ * updated pincodes.
1913
+ */
1914
+ updated_pincodes?: PincodeMopUpdateResult[];
1562
1915
  };
1563
1916
  /** @returns {CommonError} */
1564
1917
  declare function CommonError(): CommonError;
1565
1918
  type CommonError = {
1919
+ /**
1920
+ * - Status code for the error.
1921
+ */
1566
1922
  status_code?: string;
1567
1923
  error?: any;
1924
+ /**
1925
+ * - Whether operation was successful.
1926
+ */
1568
1927
  success?: string;
1569
1928
  };
1570
1929
  /** @returns {PincodeMopBulkData} */
1571
1930
  declare function PincodeMopBulkData(): PincodeMopBulkData;
1572
1931
  type PincodeMopBulkData = {
1932
+ /**
1933
+ * - Unique identifier for the request.
1934
+ */
1573
1935
  batch_id: string;
1936
+ /**
1937
+ * - CDN url for the uploaded file.
1938
+ */
1574
1939
  s3_url: string;
1575
1940
  };
1576
- /** @returns {PincodeBulkViewResponse} */
1577
- declare function PincodeBulkViewResponse(): PincodeBulkViewResponse;
1578
- type PincodeBulkViewResponse = {
1941
+ /** @returns {PincodeBulkViewResult} */
1942
+ declare function PincodeBulkViewResult(): PincodeBulkViewResult;
1943
+ type PincodeBulkViewResult = {
1579
1944
  batch_id: string;
1945
+ /**
1946
+ * - CDN url for the uploaded file.
1947
+ */
1580
1948
  s3_url: string;
1581
1949
  };
1582
- /** @returns {PincodeCodStatusListingRequest} */
1583
- declare function PincodeCodStatusListingRequest(): PincodeCodStatusListingRequest;
1584
- type PincodeCodStatusListingRequest = {
1950
+ /** @returns {PincodeCodStatusListingDetails} */
1951
+ declare function PincodeCodStatusListingDetails(): PincodeCodStatusListingDetails;
1952
+ type PincodeCodStatusListingDetails = {
1953
+ /**
1954
+ * - Name of the country.
1955
+ */
1585
1956
  country?: string;
1957
+ /**
1958
+ * - Search based on the active or inactive flag.
1959
+ */
1586
1960
  is_active?: boolean;
1961
+ /**
1962
+ * - Search based on the pincode.
1963
+ */
1587
1964
  pincode?: number;
1588
1965
  current?: number;
1589
1966
  page_size?: number;
1590
1967
  };
1591
- /** @returns {PincodeCodStatusListingResponse} */
1592
- declare function PincodeCodStatusListingResponse(): PincodeCodStatusListingResponse;
1593
- type PincodeCodStatusListingResponse = {
1968
+ /** @returns {PincodeCodStatusItem} */
1969
+ declare function PincodeCodStatusItem(): PincodeCodStatusItem;
1970
+ type PincodeCodStatusItem = {
1971
+ /**
1972
+ * - Denoted if the pincode is active or not.
1973
+ */
1974
+ active?: boolean;
1975
+ /**
1976
+ * - Name of the pincode.
1977
+ */
1978
+ pincode?: string;
1979
+ };
1980
+ /** @returns {PincodeCodStatusListingResult} */
1981
+ declare function PincodeCodStatusListingResult(): PincodeCodStatusListingResult;
1982
+ type PincodeCodStatusListingResult = {
1983
+ /**
1984
+ * - Name of the country.
1985
+ */
1594
1986
  country: string;
1595
- data: PincodeCodStatusListingResponse[];
1987
+ /**
1988
+ * - List of pincode details.
1989
+ */
1990
+ data: PincodeCodStatusListingResult[];
1991
+ /**
1992
+ * - Denotes if the request was successful or not.
1993
+ */
1596
1994
  success: boolean;
1995
+ /**
1996
+ * - List of error object in case of unsuccessful response.
1997
+ */
1597
1998
  errors?: Error[];
1598
1999
  page: PincodeCodStatusListingPage;
1599
2000
  summary: PincodeCodStatusListingSummary;
@@ -1617,13 +2018,25 @@ type PincodeCodStatusListingPage = {
1617
2018
  /** @returns {PincodeCodStatusListingSummary} */
1618
2019
  declare function PincodeCodStatusListingSummary(): PincodeCodStatusListingSummary;
1619
2020
  type PincodeCodStatusListingSummary = {
2021
+ /**
2022
+ * - Count of the total active pincodes.
2023
+ */
1620
2024
  total_active_pincodes: number;
2025
+ /**
2026
+ * - Count of the total inactive pincodes.
2027
+ */
1621
2028
  total_inactive_pincodes: number;
1622
2029
  };
1623
- /** @returns {PincodeMopUpdateAuditHistoryRequest} */
1624
- declare function PincodeMopUpdateAuditHistoryRequest(): PincodeMopUpdateAuditHistoryRequest;
1625
- type PincodeMopUpdateAuditHistoryRequest = {
2030
+ /** @returns {PincodeMopUpdateAuditHistoryDetails} */
2031
+ declare function PincodeMopUpdateAuditHistoryDetails(): PincodeMopUpdateAuditHistoryDetails;
2032
+ type PincodeMopUpdateAuditHistoryDetails = {
2033
+ /**
2034
+ * - Type of the entity requested.
2035
+ */
1626
2036
  entity_type: string;
2037
+ /**
2038
+ * - Name of the file.
2039
+ */
1627
2040
  file_name?: string;
1628
2041
  };
1629
2042
  /** @returns {PincodeMopUpdateAuditHistoryPaging} */
@@ -1635,24 +2048,49 @@ type PincodeMopUpdateAuditHistoryPaging = {
1635
2048
  has_next?: boolean;
1636
2049
  item_total?: number;
1637
2050
  };
1638
- /** @returns {PincodeMopUpdateAuditHistoryResponse} */
1639
- declare function PincodeMopUpdateAuditHistoryResponse(): PincodeMopUpdateAuditHistoryResponse;
1640
- type PincodeMopUpdateAuditHistoryResponse = {
2051
+ /** @returns {PincodeMopUpdateAuditHistoryResult} */
2052
+ declare function PincodeMopUpdateAuditHistoryResult(): PincodeMopUpdateAuditHistoryResult;
2053
+ type PincodeMopUpdateAuditHistoryResult = {
2054
+ /**
2055
+ * - Uniquie identifier of the request.
2056
+ */
1641
2057
  batch_id?: string;
2058
+ /**
2059
+ * - Type of the entity requested.
2060
+ */
1642
2061
  entity_type?: string;
2062
+ /**
2063
+ * - URL for the error file.
2064
+ */
1643
2065
  error_file_s3_url?: string;
2066
+ /**
2067
+ * - CDN url for the file uploaded.
2068
+ */
1644
2069
  s3_url?: string;
2070
+ /**
2071
+ * - Name of the file.
2072
+ */
1645
2073
  file_name?: string;
1646
2074
  updated_at?: string;
1647
2075
  updated_by?: string;
2076
+ /**
2077
+ * - Denotes if the request was successfully processed.
2078
+ */
1648
2079
  success?: boolean;
1649
2080
  };
1650
- /** @returns {PincodeMopUpdateAuditHistoryResponseData} */
1651
- declare function PincodeMopUpdateAuditHistoryResponseData(): PincodeMopUpdateAuditHistoryResponseData;
1652
- type PincodeMopUpdateAuditHistoryResponseData = {
2081
+ /** @returns {PincodeMopUpdateAuditHistoryResultData} */
2082
+ declare function PincodeMopUpdateAuditHistoryResultData(): PincodeMopUpdateAuditHistoryResultData;
2083
+ type PincodeMopUpdateAuditHistoryResultData = {
2084
+ /**
2085
+ * - Type of the entity requested.
2086
+ */
1653
2087
  entity_type?: string;
1654
2088
  page: PincodeMopUpdateAuditHistoryPaging;
1655
- data: PincodeMopUpdateAuditHistoryResponse[];
2089
+ /**
2090
+ * - History records of
2091
+ * the uploaded files.
2092
+ */
2093
+ data: PincodeMopUpdateAuditHistoryResult[];
1656
2094
  };
1657
2095
  /** @returns {ArithmeticOperations} */
1658
2096
  declare function ArithmeticOperations(): ArithmeticOperations;
@@ -1682,38 +2120,120 @@ type SchemeRules = {
1682
2120
  payment_mode?: string[];
1683
2121
  feature?: SchemeRulesFeatures;
1684
2122
  };
2123
+ /** @returns {CourierAccountUpdateDetails} */
2124
+ declare function CourierAccountUpdateDetails(): CourierAccountUpdateDetails;
2125
+ type CourierAccountUpdateDetails = {
2126
+ /**
2127
+ * - Unique identifier of courier partner extension.
2128
+ */
2129
+ extension_id: string;
2130
+ /**
2131
+ * - Unique identifier of courier partner scheme.
2132
+ */
2133
+ scheme_id: string;
2134
+ /**
2135
+ * - Denotes if the account is of self delivery type.
2136
+ */
2137
+ is_self_ship: boolean;
2138
+ /**
2139
+ * - Denotes whether the account is in enabled or disabled stage.
2140
+ */
2141
+ stage: string;
2142
+ /**
2143
+ * - Denotes whether it is the seller's own
2144
+ * account or not.
2145
+ */
2146
+ is_own_account: boolean;
2147
+ };
1685
2148
  /** @returns {CourierAccount} */
1686
2149
  declare function CourierAccount(): CourierAccount;
1687
2150
  type CourierAccount = {
2151
+ /**
2152
+ * - Company id associated with the account.
2153
+ */
2154
+ company_id: number;
2155
+ /**
2156
+ * - Unique identifier of courier partner extension.
2157
+ */
1688
2158
  extension_id: string;
2159
+ /**
2160
+ * - Unique identifier of courier partner scheme
2161
+ * and company id combination.
2162
+ */
1689
2163
  account_id: string;
2164
+ /**
2165
+ * - Unique identifier of courier partner scheme.
2166
+ */
1690
2167
  scheme_id: string;
2168
+ /**
2169
+ * - Denotes if the account is of self delivery type.
2170
+ */
1691
2171
  is_self_ship: boolean;
2172
+ /**
2173
+ * - Denotes whether the account is in enabled or disabled stage.
2174
+ */
1692
2175
  stage: string;
2176
+ /**
2177
+ * - Denotes whether it is the seller's own
2178
+ * account or not.
2179
+ */
1693
2180
  is_own_account: boolean;
2181
+ scheme_rules: CourierPartnerSchemeModel;
1694
2182
  };
1695
- /** @returns {CourierAccountRequestBody} */
1696
- declare function CourierAccountRequestBody(): CourierAccountRequestBody;
1697
- type CourierAccountRequestBody = {
2183
+ /** @returns {CourierAccountDetailsBody} */
2184
+ declare function CourierAccountDetailsBody(): CourierAccountDetailsBody;
2185
+ type CourierAccountDetailsBody = {
2186
+ /**
2187
+ * - Unique identifier of courier partner extension.
2188
+ */
1698
2189
  extension_id: string;
2190
+ /**
2191
+ * - Unique identifier of courier partner scheme
2192
+ * and company id combination.
2193
+ */
1699
2194
  account_id?: string;
2195
+ /**
2196
+ * - Unique identifier of courier partner scheme.
2197
+ */
1700
2198
  scheme_id: string;
2199
+ /**
2200
+ * - Denotes if the account is of self delivery type.
2201
+ */
1701
2202
  is_self_ship: boolean;
2203
+ /**
2204
+ * - Denotes whether the account is in enabled or disabled stage.
2205
+ */
1702
2206
  stage: string;
2207
+ /**
2208
+ * - Denotes whether it is the seller's own
2209
+ * account or not.
2210
+ */
1703
2211
  is_own_account: boolean;
1704
2212
  };
1705
- /** @returns {ErrorResponse} */
1706
- declare function ErrorResponse(): ErrorResponse;
1707
- type ErrorResponse = {
2213
+ /** @returns {ErrorResult} */
2214
+ declare function ErrorResult(): ErrorResult;
2215
+ type ErrorResult = {
2216
+ /**
2217
+ * - Fields containing the error.
2218
+ */
1708
2219
  value: string;
2220
+ /**
2221
+ * - Description of the error.
2222
+ */
1709
2223
  message: string;
2224
+ /**
2225
+ * - Type of the error.
2226
+ */
1710
2227
  type: string;
1711
2228
  };
1712
- /** @returns {CourierPartnerAccountFailureResponse} */
1713
- declare function CourierPartnerAccountFailureResponse(): CourierPartnerAccountFailureResponse;
1714
- type CourierPartnerAccountFailureResponse = {
2229
+ /** @returns {CourierPartnerAccountFailureResult} */
2230
+ declare function CourierPartnerAccountFailureResult(): CourierPartnerAccountFailureResult;
2231
+ type CourierPartnerAccountFailureResult = {
2232
+ /**
2233
+ * - Denotes whether the request is a success or failure.
2234
+ */
1715
2235
  success: boolean;
1716
- error: ErrorResponse[];
2236
+ error: ErrorResult[];
1717
2237
  };
1718
2238
  /** @returns {Page} */
1719
2239
  declare function Page(): Page;
@@ -1747,34 +2267,89 @@ type Page = {
1747
2267
  */
1748
2268
  size?: number;
1749
2269
  };
1750
- /** @returns {CourierPartnerRuleCPListResponse} */
1751
- declare function CourierPartnerRuleCPListResponse(): CourierPartnerRuleCPListResponse;
1752
- type CourierPartnerRuleCPListResponse = {
1753
- account_id?: string;
1754
- extension_id?: string;
1755
- is_self_ship?: boolean;
2270
+ /** @returns {CourierPartnerRuleCPListResult} */
2271
+ declare function CourierPartnerRuleCPListResult(): CourierPartnerRuleCPListResult;
2272
+ type CourierPartnerRuleCPListResult = {
2273
+ /**
2274
+ * - Unique identifier of courier partner scheme
2275
+ * and company id combination.
2276
+ */
2277
+ account_id: string;
2278
+ /**
2279
+ * - Unique identifier of courier partner extension.
2280
+ */
2281
+ extension_id: string;
2282
+ /**
2283
+ * - Denotes if the account is of self delivery type.
2284
+ */
2285
+ is_self_ship: boolean;
2286
+ /**
2287
+ * - Denotes the scheme rules associated with
2288
+ * the courier partner account.
2289
+ */
1756
2290
  scheme_rules?: any;
1757
2291
  };
1758
- /** @returns {CourierPartnerRuleResponse} */
1759
- declare function CourierPartnerRuleResponse(): CourierPartnerRuleResponse;
1760
- type CourierPartnerRuleResponse = {
1761
- is_active?: boolean;
1762
- application_id?: string;
1763
- company_id?: number;
1764
- conditions?: CourierPartnerRuleConditions;
1765
- sort?: string[];
2292
+ /** @returns {CourierPartnerRuleResult} */
2293
+ declare function CourierPartnerRuleResult(): CourierPartnerRuleResult;
2294
+ type CourierPartnerRuleResult = {
2295
+ /**
2296
+ * - Denotes whether the given courier partner
2297
+ * rule is inactive or active.
2298
+ */
2299
+ is_active: boolean;
2300
+ /**
2301
+ * - Unique identifier of the sales channel.
2302
+ */
2303
+ application_id: string;
2304
+ /**
2305
+ * - Unique identifier of the company.
2306
+ */
2307
+ company_id: number;
2308
+ conditions: CourierPartnerRuleConditions;
2309
+ /**
2310
+ * - Sort Strategy of the courier partners.
2311
+ */
2312
+ sort: string[];
2313
+ /**
2314
+ * - The Fynd account used to create the courier
2315
+ * partner rule.
2316
+ */
1766
2317
  created_by?: any;
1767
- id?: string;
2318
+ /**
2319
+ * - Unique identifier of the courier partner rule.
2320
+ */
2321
+ id: string;
2322
+ /**
2323
+ * - The Fynd account used to modify the
2324
+ * courier partner rule.
2325
+ */
1768
2326
  modified_by?: any;
2327
+ /**
2328
+ * - The datetime at which courier partner rule
2329
+ * is modified.
2330
+ */
1769
2331
  modified_on?: string;
1770
- name?: string;
1771
- type?: string;
1772
- cp_list?: CourierPartnerRuleCPListResponse[];
2332
+ /**
2333
+ * - Name for the courier partner rule.
2334
+ */
2335
+ name: string;
2336
+ /**
2337
+ * - The type of the rule.
2338
+ */
2339
+ type: string;
2340
+ cp_list?: CourierPartnerRuleCPListResult[];
1773
2341
  };
1774
2342
  /** @returns {CourierPartnerList} */
1775
2343
  declare function CourierPartnerList(): CourierPartnerList;
1776
2344
  type CourierPartnerList = {
2345
+ /**
2346
+ * - Unique identifier of courier partner extension.
2347
+ */
1777
2348
  extension_id: string;
2349
+ /**
2350
+ * - Unique identifier of courier partner scheme
2351
+ * and company id combination.
2352
+ */
1778
2353
  account_id: string;
1779
2354
  };
1780
2355
  /** @returns {LocationRuleValues} */
@@ -1784,7 +2359,7 @@ type LocationRuleValues = {
1784
2359
  sub_type?: string;
1785
2360
  name?: string;
1786
2361
  display_name?: string;
1787
- parent_id?: string;
2362
+ parent_id?: string[];
1788
2363
  parent_ids?: string[];
1789
2364
  };
1790
2365
  /** @returns {LocationRule} */
@@ -1826,97 +2401,383 @@ type CourierPartnerRuleConditions = {
1826
2401
  /** @returns {CourierPartnerRule} */
1827
2402
  declare function CourierPartnerRule(): CourierPartnerRule;
1828
2403
  type CourierPartnerRule = {
2404
+ /**
2405
+ * - Denotes whether the given courier partner
2406
+ * rule is inactive or active.
2407
+ */
1829
2408
  is_active: boolean;
2409
+ /**
2410
+ * - A list of courier partners.
2411
+ */
1830
2412
  cp_list?: CourierPartnerList[];
2413
+ /**
2414
+ * - Name for the courier partner rule.
2415
+ */
1831
2416
  name: string;
1832
2417
  conditions: CourierPartnerRuleConditions;
2418
+ /**
2419
+ * - Sort Strategy for the courier partners.
2420
+ */
1833
2421
  sort: string[];
2422
+ /**
2423
+ * - Denotes the type of the rule.
2424
+ */
2425
+ type?: string;
1834
2426
  };
1835
- /** @returns {FailureResponse} */
1836
- declare function FailureResponse(): FailureResponse;
1837
- type FailureResponse = {
2427
+ /** @returns {FailureResult} */
2428
+ declare function FailureResult(): FailureResult;
2429
+ type FailureResult = {
1838
2430
  success: boolean;
1839
- error: ErrorResponse[];
2431
+ error: ErrorResult[];
1840
2432
  };
1841
- /** @returns {CourierPartnerRulesListResponse} */
1842
- declare function CourierPartnerRulesListResponse(): CourierPartnerRulesListResponse;
1843
- type CourierPartnerRulesListResponse = {
1844
- items: CourierPartnerRuleResponse[];
2433
+ /** @returns {CourierPartnerRulesListResult} */
2434
+ declare function CourierPartnerRulesListResult(): CourierPartnerRulesListResult;
2435
+ type CourierPartnerRulesListResult = {
2436
+ items: CourierPartnerRuleResult[];
1845
2437
  page: Page;
1846
2438
  };
2439
+ /** @returns {ShipmentsArticles} */
2440
+ declare function ShipmentsArticles(): ShipmentsArticles;
2441
+ type ShipmentsArticles = {
2442
+ /**
2443
+ * - Unique identifier of the item.
2444
+ */
2445
+ item_id?: number;
2446
+ /**
2447
+ * - Unique identifier of the category.
2448
+ */
2449
+ category_id?: number;
2450
+ /**
2451
+ * - Unique identifier of the brand.
2452
+ */
2453
+ brand_id?: number;
2454
+ /**
2455
+ * - Unique identifier of the department.
2456
+ */
2457
+ department_id?: number;
2458
+ /**
2459
+ * - Tags associated with the item.
2460
+ */
2461
+ tags?: string[];
2462
+ };
2463
+ /** @returns {ShipmentDimension} */
2464
+ declare function ShipmentDimension(): ShipmentDimension;
2465
+ type ShipmentDimension = {
2466
+ /**
2467
+ * - Height of the shipment in centimeters.
2468
+ */
2469
+ height: number;
2470
+ /**
2471
+ * - Length of the shipment in centimeters.
2472
+ */
2473
+ length: number;
2474
+ /**
2475
+ * - Width of the shipment in centimeters.
2476
+ */
2477
+ width: number;
2478
+ };
2479
+ /** @returns {Shipments} */
2480
+ declare function Shipments(): Shipments;
2481
+ type Shipments = {
2482
+ /**
2483
+ * - Unique identifier of the shipment.
2484
+ */
2485
+ id?: string;
2486
+ /**
2487
+ * - Unique identifier of the selling location.
2488
+ */
2489
+ location_id?: number;
2490
+ /**
2491
+ * - Tags associated with the selling location.
2492
+ */
2493
+ location_tags?: string[];
2494
+ /**
2495
+ * - Weight of the shipment.
2496
+ */
2497
+ shipment_weight?: number;
2498
+ /**
2499
+ * - Volumetric weight of the shipment.
2500
+ */
2501
+ shipment_volumetric_weight?: number;
2502
+ /**
2503
+ * - Total Cost of the shipment.
2504
+ */
2505
+ shipment_cost?: number;
2506
+ shipment_dimension?: ShipmentDimension;
2507
+ /**
2508
+ * - A List of courier schemes.
2509
+ */
2510
+ courier_partner_schemes?: string[];
2511
+ /**
2512
+ * - List of articles in the shipment.
2513
+ */
2514
+ articles?: ShipmentsArticles[];
2515
+ };
2516
+ /** @returns {ShipmentCourierPartnerDetails} */
2517
+ declare function ShipmentCourierPartnerDetails(): ShipmentCourierPartnerDetails;
2518
+ type ShipmentCourierPartnerDetails = {
2519
+ from_location: ShipmentsCourierPartnersServiceability;
2520
+ to_location: ShipmentsCourierPartnersServiceability;
2521
+ /**
2522
+ * - List of shipments.
2523
+ */
2524
+ shipments?: Shipments[];
2525
+ /**
2526
+ * - Journey type of the shipment forward or return.
2527
+ */
2528
+ journey?: string;
2529
+ /**
2530
+ * - Payment mode opted for the shipment.
2531
+ */
2532
+ payment_mode?: string;
2533
+ };
2534
+ /** @returns {CourierPartnerPromise} */
2535
+ declare function CourierPartnerPromise(): CourierPartnerPromise;
2536
+ type CourierPartnerPromise = {
2537
+ /**
2538
+ * - The earliest possible timestamp.
2539
+ */
2540
+ min: string;
2541
+ /**
2542
+ * - The latest possible timestamp.
2543
+ */
2544
+ max: string;
2545
+ };
2546
+ /** @returns {CourierPartners} */
2547
+ declare function CourierPartners(): CourierPartners;
2548
+ type CourierPartners = {
2549
+ /**
2550
+ * - Unique identifier of courier partner extension.
2551
+ */
2552
+ extension_id?: string;
2553
+ /**
2554
+ * - Unique identifier of courier partner scheme.
2555
+ */
2556
+ scheme_id?: string;
2557
+ /**
2558
+ * - Name of the courier partner.
2559
+ */
2560
+ name?: string;
2561
+ delivery_promise?: CourierPartnerPromise;
2562
+ };
2563
+ /** @returns {ShipmentCourierPartners} */
2564
+ declare function ShipmentCourierPartners(): ShipmentCourierPartners;
2565
+ type ShipmentCourierPartners = {
2566
+ /**
2567
+ * - Unique identifier of the shipment.
2568
+ */
2569
+ id?: string;
2570
+ /**
2571
+ * - Courier partners of the shipment.
2572
+ */
2573
+ courier_partners?: CourierPartners[];
2574
+ };
2575
+ /** @returns {ShipmentCourierPartnerResult} */
2576
+ declare function ShipmentCourierPartnerResult(): ShipmentCourierPartnerResult;
2577
+ type ShipmentCourierPartnerResult = {
2578
+ courier_partners?: CourierPartners[];
2579
+ shipments?: ShipmentCourierPartners[];
2580
+ };
2581
+ /** @returns {ShipmentsCourierPartnersServiceability} */
2582
+ declare function ShipmentsCourierPartnersServiceability(): ShipmentsCourierPartnersServiceability;
2583
+ type ShipmentsCourierPartnersServiceability = {
2584
+ /**
2585
+ * - Postal code or PIN code of the address area.
2586
+ */
2587
+ pincode?: string;
2588
+ /**
2589
+ * - Specifies the sector or district code of
2590
+ * the address if applicable.
2591
+ */
2592
+ sector_code?: string;
2593
+ /**
2594
+ * - Indicates the state or province code of the address.
2595
+ */
2596
+ state_code?: string;
2597
+ /**
2598
+ * - Denote the city or municipality code of the address.
2599
+ */
2600
+ city_code?: string;
2601
+ /**
2602
+ * - ISO2 code for the country of the address.
2603
+ */
2604
+ country_code: string;
2605
+ };
1847
2606
  /** @returns {CompanyConfig} */
1848
2607
  declare function CompanyConfig(): CompanyConfig;
1849
2608
  type CompanyConfig = {
2609
+ /**
2610
+ * - A list for courier partner rules.
2611
+ */
1850
2612
  rule_ids: string[];
2613
+ /**
2614
+ * - Sort strategy for the courier partners.
2615
+ */
1851
2616
  sort: string[];
1852
- logistics_as_actual?: boolean;
2617
+ /**
2618
+ * - Depicts if the courier partner
2619
+ * rule configuration plan is subscribed by the seller for which mode.
2620
+ */
2621
+ logistics_as_actual?: string;
2622
+ /**
2623
+ * - Unique identifier of the company.
2624
+ */
2625
+ company_id: number;
2626
+ /**
2627
+ * - Unique identifier of the sales channel.
2628
+ */
2629
+ application_id?: string;
1853
2630
  };
1854
2631
  /** @returns {ZoneConfig} */
1855
2632
  declare function ZoneConfig(): ZoneConfig;
1856
2633
  type ZoneConfig = {
2634
+ /**
2635
+ * - Serviceability type of the delivery zone.
2636
+ */
1857
2637
  serviceability_type?: string;
2638
+ /**
2639
+ * - Count of active delivery zones associated
2640
+ * with the sales channel.
2641
+ */
2642
+ active_count?: number;
2643
+ /**
2644
+ * - Count of total delivery zones associated
2645
+ * with the sales channel.
2646
+ */
2647
+ total_count?: number;
1858
2648
  };
1859
2649
  /** @returns {ApplicationConfig} */
1860
2650
  declare function ApplicationConfig(): ApplicationConfig;
1861
2651
  type ApplicationConfig = {
2652
+ /**
2653
+ * - A list of courier partner rules.
2654
+ */
1862
2655
  rule_ids?: string[];
2656
+ /**
2657
+ * - Strategy adopted to sort the courier partners.
2658
+ */
1863
2659
  sort?: string[];
1864
2660
  zones?: ZoneConfig;
1865
2661
  };
1866
- /** @returns {BulkRegionJobSerializer} */
1867
- declare function BulkRegionJobSerializer(): BulkRegionJobSerializer;
1868
- type BulkRegionJobSerializer = {
2662
+ /** @returns {BulkRegionJobDetails} */
2663
+ declare function BulkRegionJobDetails(): BulkRegionJobDetails;
2664
+ type BulkRegionJobDetails = {
2665
+ /**
2666
+ * - CDN path of the uploaded csv file for bulk import.
2667
+ */
1869
2668
  file_path?: string;
2669
+ /**
2670
+ * - Country for which the tat or serviceability is
2671
+ * to be imported or exported.
2672
+ */
1870
2673
  country: string;
2674
+ /**
2675
+ * - Denotes the import or export action to be performed.
2676
+ */
1871
2677
  action: string;
2678
+ /**
2679
+ * - Region of the country for which import or export
2680
+ * is triggered.
2681
+ */
1872
2682
  region: string;
1873
2683
  };
1874
- /** @returns {BulkRegionResponseItemData} */
1875
- declare function BulkRegionResponseItemData(): BulkRegionResponseItemData;
1876
- type BulkRegionResponseItemData = {
1877
- file_path: string;
2684
+ /** @returns {BulkRegionResultItemData} */
2685
+ declare function BulkRegionResultItemData(): BulkRegionResultItemData;
2686
+ type BulkRegionResultItemData = {
2687
+ /**
2688
+ * - CDN path of the file which was used for bulk import.
2689
+ */
2690
+ file_path?: string;
2691
+ /**
2692
+ * - Count of the failed records.
2693
+ */
1878
2694
  failed?: number;
1879
2695
  failed_records?: any[];
2696
+ /**
2697
+ * - Denotes the import or export action performed.
2698
+ */
1880
2699
  action: string;
2700
+ /**
2701
+ * - Unique id to identify the import or export query.
2702
+ */
1881
2703
  batch_id: string;
2704
+ /**
2705
+ * - Country for which the import or export action is
2706
+ * performed.
2707
+ */
1882
2708
  country: string;
2709
+ /**
2710
+ * - Denoted if the import or export was successful
2711
+ * or failure.
2712
+ */
1883
2713
  success?: number;
2714
+ /**
2715
+ * - Region of the country for which import or export
2716
+ * is triggered.
2717
+ */
1884
2718
  region: string;
2719
+ /**
2720
+ * - Current status of the import or export action performed.
2721
+ */
1885
2722
  status: string;
2723
+ /**
2724
+ * - Count of total records.
2725
+ */
1886
2726
  total?: number;
2727
+ /**
2728
+ * - Path of the error file.
2729
+ */
1887
2730
  error_file_path?: string;
1888
2731
  };
1889
- /** @returns {BulkRegionResponse} */
1890
- declare function BulkRegionResponse(): BulkRegionResponse;
1891
- type BulkRegionResponse = {
1892
- items: BulkRegionResponseItemData[];
2732
+ /** @returns {BulkRegionResult} */
2733
+ declare function BulkRegionResult(): BulkRegionResult;
2734
+ type BulkRegionResult = {
2735
+ items: BulkRegionResultItemData[];
1893
2736
  page: Page;
1894
2737
  };
1895
- /** @returns {SelfShipResponse} */
1896
- declare function SelfShipResponse(): SelfShipResponse;
1897
- type SelfShipResponse = {
2738
+ /** @returns {SelfShipResult} */
2739
+ declare function SelfShipResult(): SelfShipResult;
2740
+ type SelfShipResult = {
1898
2741
  is_active: boolean;
1899
2742
  tat: number;
1900
2743
  };
1901
2744
  /** @returns {ApplicationSelfShipConfig} */
1902
2745
  declare function ApplicationSelfShipConfig(): ApplicationSelfShipConfig;
1903
2746
  type ApplicationSelfShipConfig = {
1904
- self_ship?: any;
2747
+ self_ship?: SelfShipResult;
1905
2748
  };
1906
- /** @returns {ApplicationSelfShipConfigResponse} */
1907
- declare function ApplicationSelfShipConfigResponse(): ApplicationSelfShipConfigResponse;
1908
- type ApplicationSelfShipConfigResponse = {
1909
- error?: ServiceabilityErrorResponse;
2749
+ /** @returns {ApplicationSelfShipConfigResult} */
2750
+ declare function ApplicationSelfShipConfigResult(): ApplicationSelfShipConfigResult;
2751
+ type ApplicationSelfShipConfigResult = {
2752
+ error?: ServiceabilityErrorResult;
1910
2753
  data?: ApplicationSelfShipConfig;
1911
2754
  success: boolean;
1912
2755
  };
1913
2756
  /** @returns {StoreRuleConfigData} */
1914
2757
  declare function StoreRuleConfigData(): StoreRuleConfigData;
1915
2758
  type StoreRuleConfigData = {
2759
+ /**
2760
+ * - List of rule ids which are active in the application.
2761
+ */
1916
2762
  rule_ids?: string[];
2763
+ /**
2764
+ * - Priority of the store type to be
2765
+ * used in the basic prioritization sorting of stores.
2766
+ */
1917
2767
  type_based_priority?: string[];
2768
+ /**
2769
+ * - Priority of the store tags to be
2770
+ * used in the basic prioritization sorting of stores.
2771
+ */
1918
2772
  tag_based_priority?: string[];
2773
+ /**
2774
+ * - Priority of explicit
2775
+ * stores to be used for sorting of stores.
2776
+ */
1919
2777
  store_priority?: StorePrioritySchema[];
2778
+ /**
2779
+ * - Criteria on which the selected stores should be sorted.
2780
+ */
1920
2781
  sort?: string[];
1921
2782
  };
1922
2783
  /** @returns {CustomerRadiusSchema} */
@@ -1946,66 +2807,183 @@ type StoreRuleConditionSchema = {
1946
2807
  /** @returns {StoreRuleDataSchema} */
1947
2808
  declare function StoreRuleDataSchema(): StoreRuleDataSchema;
1948
2809
  type StoreRuleDataSchema = {
2810
+ /**
2811
+ * - Id of the rule.
2812
+ */
1949
2813
  id?: string;
2814
+ /**
2815
+ * - Name of the rule.
2816
+ */
1950
2817
  name?: string;
2818
+ /**
2819
+ * - Company id for which the rule is created.
2820
+ */
1951
2821
  company_id?: number;
2822
+ /**
2823
+ * - Application id for which the rule is created.
2824
+ */
1952
2825
  application_id?: string;
2826
+ /**
2827
+ * - Priority of the store type to be
2828
+ * used in the basic prioritization sorting of stores.
2829
+ */
1953
2830
  type_based_priority?: string[];
2831
+ /**
2832
+ * - Priority of the store tags to be
2833
+ * used in the basic prioritization sorting of stores.
2834
+ */
1954
2835
  tag_based_priority?: string[];
2836
+ /**
2837
+ * - Priority of explicit
2838
+ * stores to be used for sorting of stores.
2839
+ */
1955
2840
  store_priority?: StorePrioritySchema[];
2841
+ /**
2842
+ * - Criteria on which the selected stores should be sorted.
2843
+ */
1956
2844
  sort?: string[];
1957
2845
  conditions?: StoreRuleConditionSchema;
2846
+ /**
2847
+ * - Denotes whether the rule is active or inactive.
2848
+ */
1958
2849
  is_active?: boolean;
1959
2850
  };
1960
2851
  /** @returns {StorePrioritySchema} */
1961
2852
  declare function StorePrioritySchema(): StorePrioritySchema;
1962
2853
  type StorePrioritySchema = {
1963
- id?: string;
2854
+ /**
2855
+ * - Id of the store.
2856
+ */
2857
+ id?: number;
2858
+ /**
2859
+ * - Name of the store.
2860
+ */
1964
2861
  name?: string;
1965
2862
  };
1966
- /** @returns {GetStoreRulesApiResponse} */
1967
- declare function GetStoreRulesApiResponse(): GetStoreRulesApiResponse;
1968
- type GetStoreRulesApiResponse = {
2863
+ /** @returns {GetStoreRulesApiResult} */
2864
+ declare function GetStoreRulesApiResult(): GetStoreRulesApiResult;
2865
+ type GetStoreRulesApiResult = {
1969
2866
  items?: StoreRuleDataSchema[];
1970
2867
  page?: Page;
1971
2868
  };
1972
- /** @returns {CreateStoreRuleRequestSchema} */
1973
- declare function CreateStoreRuleRequestSchema(): CreateStoreRuleRequestSchema;
1974
- type CreateStoreRuleRequestSchema = {
2869
+ /** @returns {CreateStoreRuleDetailsSchema} */
2870
+ declare function CreateStoreRuleDetailsSchema(): CreateStoreRuleDetailsSchema;
2871
+ type CreateStoreRuleDetailsSchema = {
2872
+ /**
2873
+ * - Name of the rule.
2874
+ */
1975
2875
  name?: string;
2876
+ /**
2877
+ * - Denotes if the rule is active or not.
2878
+ */
1976
2879
  is_active?: boolean;
1977
2880
  conditions?: StoreRuleConditionSchema;
2881
+ /**
2882
+ * - Priority of the store type to be
2883
+ * used in the basic prioritization sorting of stores.
2884
+ */
1978
2885
  type_based_priority?: string[];
2886
+ /**
2887
+ * - Priority of the store tags to be
2888
+ * used in the basic prioritization sorting of stores.
2889
+ */
1979
2890
  tag_based_priority?: string[];
2891
+ /**
2892
+ * - Priority of explicit
2893
+ * stores to be used for sorting of stores.
2894
+ */
1980
2895
  store_priority?: StorePrioritySchema[];
2896
+ /**
2897
+ * - Criteria on which the selected stores should be sorted.
2898
+ */
1981
2899
  sort?: string[];
1982
2900
  };
1983
- /** @returns {StoreRuleResponseSchema} */
1984
- declare function StoreRuleResponseSchema(): StoreRuleResponseSchema;
1985
- type StoreRuleResponseSchema = {
2901
+ /** @returns {StoreRuleResultSchema} */
2902
+ declare function StoreRuleResultSchema(): StoreRuleResultSchema;
2903
+ type StoreRuleResultSchema = {
2904
+ /**
2905
+ * - Id of the rule created.
2906
+ */
1986
2907
  id?: string;
2908
+ /**
2909
+ * - Name of the rule created.
2910
+ */
1987
2911
  name?: string;
2912
+ /**
2913
+ * - Type of the rule created.
2914
+ */
1988
2915
  type?: string;
2916
+ /**
2917
+ * - Priority of the store type to be
2918
+ * used in the rule for sorting of stores.
2919
+ */
1989
2920
  type_based_priority?: string[];
2921
+ /**
2922
+ * - Priority of the store tags to be
2923
+ * used in the rule for sorting of stores.
2924
+ */
1990
2925
  tag_based_priority?: string[];
2926
+ /**
2927
+ * - Priority of explicit
2928
+ * stores to be used for sorting of stores.
2929
+ */
1991
2930
  store_priority?: StorePrioritySchema[];
2931
+ /**
2932
+ * - Criteria on which the selected stores should be sorted.
2933
+ */
1992
2934
  sort?: string[];
1993
2935
  conditions?: StoreRuleConditionSchema;
2936
+ /**
2937
+ * - Denotes if the rule is active or inactive.
2938
+ */
1994
2939
  is_active?: boolean;
1995
2940
  };
1996
- /** @returns {StoreRuleUpdateResponseSchema} */
1997
- declare function StoreRuleUpdateResponseSchema(): StoreRuleUpdateResponseSchema;
1998
- type StoreRuleUpdateResponseSchema = {
2941
+ /** @returns {StoreRuleUpdateResultSchema} */
2942
+ declare function StoreRuleUpdateResultSchema(): StoreRuleUpdateResultSchema;
2943
+ type StoreRuleUpdateResultSchema = {
2944
+ /**
2945
+ * - Id of the rule created.
2946
+ */
1999
2947
  id?: string;
2948
+ /**
2949
+ * - Name of the rule created.
2950
+ */
2000
2951
  name?: string;
2952
+ /**
2953
+ * - Type of the rule created.
2954
+ */
2001
2955
  type?: string;
2956
+ /**
2957
+ * - Priority of the store type to be
2958
+ * used in the rule for sorting of stores.
2959
+ */
2002
2960
  type_based_priority?: string[];
2961
+ /**
2962
+ * - Priority of the store tags to be
2963
+ * used in the rule for sorting of stores.
2964
+ */
2003
2965
  tag_based_priority?: string[];
2966
+ /**
2967
+ * - Priority of explicit
2968
+ * stores to be used for sorting of stores.
2969
+ */
2004
2970
  store_priority?: StorePrioritySchema[];
2971
+ /**
2972
+ * - Criteria on which the selected stores should be sorted.
2973
+ */
2005
2974
  sort?: string[];
2006
2975
  conditions?: StoreRuleConditionSchema;
2976
+ /**
2977
+ * - Denotes if the rule is active or inactive.
2978
+ */
2007
2979
  is_active?: boolean;
2980
+ /**
2981
+ * - Company id for which the rule is created.
2982
+ */
2008
2983
  company_id?: number;
2984
+ /**
2985
+ * - Application id for which the rule is created.
2986
+ */
2009
2987
  application_id?: string;
2010
2988
  };
2011
2989
  /** @returns {ServiceabilityModel} */
@@ -2013,8 +2991,8 @@ declare function ServiceabilityModel(): ServiceabilityModel;
2013
2991
  type ServiceabilityModel = {
2014
2992
  lm_cod_limit: number;
2015
2993
  is_qc: boolean;
2016
- pickup_cutoff: string;
2017
- route_code: string;
2994
+ pickup_cutoff?: string;
2995
+ route_code?: string;
2018
2996
  is_first_mile: boolean;
2019
2997
  is_return: boolean;
2020
2998
  is_installation: boolean;
@@ -2045,101 +3023,314 @@ type CourierPartnerSchemeFeatures = {
2045
3023
  /** @returns {CourierPartnerSchemeModel} */
2046
3024
  declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
2047
3025
  type CourierPartnerSchemeModel = {
3026
+ /**
3027
+ * - Name of the scheme.
3028
+ */
3029
+ name?: string;
3030
+ /**
3031
+ * - Unique identifier of courier partner extension.
3032
+ */
2048
3033
  extension_id: string;
3034
+ /**
3035
+ * - Unique identifier of courier partner scheme.
3036
+ */
2049
3037
  scheme_id: string;
3038
+ volumetric_weight?: ArithmeticOperations;
2050
3039
  weight: ArithmeticOperations;
3040
+ /**
3041
+ * - Mode of transport associated with the
3042
+ * courier partner scheme.
3043
+ */
2051
3044
  transport_type: string;
3045
+ /**
3046
+ * - Serviceable region associated with the courier
3047
+ * partner scheme.
3048
+ */
2052
3049
  region: string;
3050
+ /**
3051
+ * - Type of delivery associated with the
3052
+ * courier partner scheme.
3053
+ */
2053
3054
  delivery_type: string;
3055
+ /**
3056
+ * - Mode of payment associated with the
3057
+ * courier partner scheme.
3058
+ */
2054
3059
  payment_mode: string[];
3060
+ /**
3061
+ * - Denotes whether the courier partner scheme is in
3062
+ * enabled or disabled stage.
3063
+ */
2055
3064
  stage: string;
2056
3065
  feature: CourierPartnerSchemeFeatures;
2057
3066
  };
2058
- /** @returns {CourierAccountResponse} */
2059
- declare function CourierAccountResponse(): CourierAccountResponse;
2060
- type CourierAccountResponse = {
3067
+ /** @returns {CourierAccountResult} */
3068
+ declare function CourierAccountResult(): CourierAccountResult;
3069
+ type CourierAccountResult = {
3070
+ /**
3071
+ * - Company id associated with the account.
3072
+ */
3073
+ company_id: number;
3074
+ /**
3075
+ * - Unique identifier of courier partner extension.
3076
+ */
3077
+ extension_id?: string;
3078
+ /**
3079
+ * - Unique identifier of courier partner scheme
3080
+ * and company id combination.
3081
+ */
2061
3082
  account_id: string;
3083
+ /**
3084
+ * - Unique identifier of courier partner scheme.
3085
+ */
2062
3086
  scheme_id: string;
3087
+ /**
3088
+ * - Denotes if the account is of self delivery type.
3089
+ */
2063
3090
  is_self_ship: boolean;
3091
+ /**
3092
+ * - Denotes whether the account is in enabled or disabled stage.
3093
+ */
2064
3094
  stage: string;
3095
+ /**
3096
+ * - Denotes whether it is the seller's own
3097
+ * account or not.
3098
+ */
2065
3099
  is_own_account: boolean;
2066
- scheme_rules: CourierPartnerSchemeModel;
3100
+ scheme_rules?: CourierPartnerSchemeModel;
2067
3101
  };
2068
- /** @returns {CompanyCourierPartnerAccountListResponse} */
2069
- declare function CompanyCourierPartnerAccountListResponse(): CompanyCourierPartnerAccountListResponse;
2070
- type CompanyCourierPartnerAccountListResponse = {
2071
- items: CourierAccountResponse[];
3102
+ /** @returns {CompanyCourierPartnerAccountListResult} */
3103
+ declare function CompanyCourierPartnerAccountListResult(): CompanyCourierPartnerAccountListResult;
3104
+ type CompanyCourierPartnerAccountListResult = {
3105
+ items: CourierAccountResult[];
2072
3106
  page: Page;
2073
3107
  };
2074
3108
  /** @returns {PackageMaterial} */
2075
3109
  declare function PackageMaterial(): PackageMaterial;
2076
3110
  type PackageMaterial = {
3111
+ /**
3112
+ * - Name of the packaging material.
3113
+ */
2077
3114
  name: string;
3115
+ /**
3116
+ * - Width of the packaging material dimentions in centimeter.
3117
+ */
2078
3118
  width: number;
3119
+ /**
3120
+ * - Height of the packaging material dimentions in centimeter.
3121
+ */
2079
3122
  height: number;
3123
+ /**
3124
+ * - Length of the packaging material dimentions in centimeter.
3125
+ */
2080
3126
  length: number;
3127
+ /**
3128
+ * - Product group rules associated
3129
+ * with the packaging.
3130
+ */
2081
3131
  rules?: PackageMaterialRule[];
3132
+ /**
3133
+ * - Store ids where the packaging is avaiable.
3134
+ */
2082
3135
  store_ids: number[];
3136
+ /**
3137
+ * - Package's weight in gram.
3138
+ */
2083
3139
  weight: number;
3140
+ /**
3141
+ * - Error Rate associated with the packaging dimensions.
3142
+ */
2084
3143
  error_rate: number;
3144
+ /**
3145
+ * - Type of package material.
3146
+ */
2085
3147
  package_type: string;
3148
+ /**
3149
+ * - Physical size of the packaging.
3150
+ */
2086
3151
  size: string;
3152
+ /**
3153
+ * - Image urls associated with the packaging material.
3154
+ */
2087
3155
  media?: string[];
3156
+ /**
3157
+ * - Sales channel where packaging is applicable.
3158
+ */
2088
3159
  channels: Channel[];
3160
+ /**
3161
+ * - Denotes if the track of the inventory
3162
+ * should be kept.
3163
+ */
2089
3164
  track_inventory?: boolean;
3165
+ /**
3166
+ * - Current status of the packaging material, if it
3167
+ * is active or inactive.
3168
+ */
2090
3169
  status: string;
3170
+ /**
3171
+ * - Maximum weight holding capacity.
3172
+ */
2091
3173
  max_weight?: number;
3174
+ /**
3175
+ * - Volumetric weight that a packaging
3176
+ * material can carry.
3177
+ */
2092
3178
  package_vol_weight?: number;
3179
+ /**
3180
+ * - Denotes whether the volumetric weight
3181
+ * should be auto calculated or not.
3182
+ */
2093
3183
  auto_calculate?: boolean;
2094
3184
  };
2095
- /** @returns {PackageMaterialResponse} */
2096
- declare function PackageMaterialResponse(): PackageMaterialResponse;
2097
- type PackageMaterialResponse = {
3185
+ /** @returns {PackageMaterialResult} */
3186
+ declare function PackageMaterialResult(): PackageMaterialResult;
3187
+ type PackageMaterialResult = {
3188
+ /**
3189
+ * - Name of the packaging material.
3190
+ */
2098
3191
  name: string;
3192
+ /**
3193
+ * - Id of the packaging material.
3194
+ */
2099
3195
  id?: string;
3196
+ /**
3197
+ * - Unique identifier of an item associated with
3198
+ * the packaging material.
3199
+ */
2100
3200
  item_id?: number;
3201
+ /**
3202
+ * - Company id associated with the packaging material.
3203
+ */
3204
+ company_id?: number;
3205
+ /**
3206
+ * - Width of the packaging material dimentions in centimeter.
3207
+ */
2101
3208
  width: number;
3209
+ /**
3210
+ * - Height of the packaging material dimentions in centimeter.
3211
+ */
2102
3212
  height: number;
3213
+ /**
3214
+ * - Length of the packaging material dimentions in centimeter.
3215
+ */
2103
3216
  length: number;
3217
+ /**
3218
+ * - Product group rules associated
3219
+ * with the packaging.
3220
+ */
2104
3221
  rules?: PackageMaterialRule[];
3222
+ /**
3223
+ * - Store ids where the packaging is avaiable.
3224
+ */
2105
3225
  store_ids: number[];
3226
+ /**
3227
+ * - Package's weight in gram.
3228
+ */
2106
3229
  weight: number;
3230
+ /**
3231
+ * - Error Rate associated with the packaging dimensions.
3232
+ */
2107
3233
  error_rate: number;
3234
+ /**
3235
+ * - Type of package material.
3236
+ */
2108
3237
  package_type: string;
3238
+ /**
3239
+ * - Physical size of the packaging.
3240
+ */
2109
3241
  size: string;
3242
+ /**
3243
+ * - Image urls associated with the packaging material.
3244
+ */
2110
3245
  media?: string[];
3246
+ /**
3247
+ * - Sales channel where packaging is applicable.
3248
+ */
2111
3249
  channels: Channel[];
3250
+ /**
3251
+ * - Denotes if the track of the inventory
3252
+ * should be kept.
3253
+ */
2112
3254
  track_inventory?: boolean;
3255
+ /**
3256
+ * - Current status of the packaging material, if it
3257
+ * is active or inactive.
3258
+ */
2113
3259
  status: string;
3260
+ /**
3261
+ * - Maximum weight holding capacity.
3262
+ */
2114
3263
  max_weight?: number;
3264
+ /**
3265
+ * - Volumetric weight that a packaging
3266
+ * material can carry.
3267
+ */
2115
3268
  package_vol_weight?: number;
3269
+ /**
3270
+ * - Denotes whether the volumetric weight
3271
+ * should be auto calculated or not.
3272
+ */
2116
3273
  auto_calculate?: boolean;
2117
3274
  };
2118
3275
  /** @returns {PackageMaterialRule} */
2119
3276
  declare function PackageMaterialRule(): PackageMaterialRule;
2120
3277
  type PackageMaterialRule = {
3278
+ /**
3279
+ * - Unique identifier of the package rule.
3280
+ */
2121
3281
  rule_id?: string;
2122
3282
  quantity?: PackageMaterialRuleQuantity;
3283
+ /**
3284
+ * - Volumetric weight in gram.
3285
+ */
2123
3286
  weight?: number;
2124
3287
  };
2125
3288
  /** @returns {PackageRule} */
2126
3289
  declare function PackageRule(): PackageRule;
2127
3290
  type PackageRule = {
3291
+ /**
3292
+ * - Name of the package rule.
3293
+ */
2128
3294
  name: string;
3295
+ /**
3296
+ * - Unique identifier of the company.
3297
+ */
2129
3298
  company_id: number;
3299
+ /**
3300
+ * - Type of the rule.
3301
+ */
2130
3302
  type: string;
3303
+ /**
3304
+ * - Denotes if the rule is active or inactive.
3305
+ */
2131
3306
  is_active?: boolean;
2132
3307
  product_tag?: PackageRuleProductTag;
2133
3308
  product_id?: PackageRuleProduct;
2134
3309
  category_id?: PackageRuleCategory;
2135
3310
  };
2136
- /** @returns {PackageRuleResponse} */
2137
- declare function PackageRuleResponse(): PackageRuleResponse;
2138
- type PackageRuleResponse = {
3311
+ /** @returns {PackageRuleResult} */
3312
+ declare function PackageRuleResult(): PackageRuleResult;
3313
+ type PackageRuleResult = {
3314
+ /**
3315
+ * - Unique id of a package rule.
3316
+ */
2139
3317
  id?: string;
3318
+ /**
3319
+ * - Name of a package rule.
3320
+ */
2140
3321
  name: string;
3322
+ /**
3323
+ * - Unique identifier of a company associated
3324
+ * with the package rule.
3325
+ */
2141
3326
  company_id: number;
3327
+ /**
3328
+ * - Type of the rule created.
3329
+ */
2142
3330
  type: string;
3331
+ /**
3332
+ * - Denotes if the rule is active or inactive.
3333
+ */
2143
3334
  is_active?: boolean;
2144
3335
  product_tag?: PackageRuleProductTag;
2145
3336
  product_id?: PackageRuleProduct;
@@ -2148,19 +3339,25 @@ type PackageRuleResponse = {
2148
3339
  /** @returns {Channel} */
2149
3340
  declare function Channel(): Channel;
2150
3341
  type Channel = {
3342
+ /**
3343
+ * - Type of the channel.
3344
+ */
2151
3345
  type?: string;
3346
+ /**
3347
+ * - Unique identifier of the channel.
3348
+ */
2152
3349
  id?: string;
2153
3350
  };
2154
3351
  /** @returns {PackageMaterialRuleList} */
2155
3352
  declare function PackageMaterialRuleList(): PackageMaterialRuleList;
2156
3353
  type PackageMaterialRuleList = {
2157
- items?: PackageRuleResponse;
3354
+ items?: PackageRuleResult;
2158
3355
  page?: Page;
2159
3356
  };
2160
3357
  /** @returns {PackageMaterialList} */
2161
3358
  declare function PackageMaterialList(): PackageMaterialList;
2162
3359
  type PackageMaterialList = {
2163
- items?: PackageMaterialResponse;
3360
+ items?: PackageMaterialResult;
2164
3361
  page?: Page;
2165
3362
  };
2166
3363
  /** @returns {PackageRuleProduct} */
@@ -2181,18 +3378,34 @@ type PackageRuleCategory = {
2181
3378
  /** @returns {PackageMaterialRuleQuantity} */
2182
3379
  declare function PackageMaterialRuleQuantity(): PackageMaterialRuleQuantity;
2183
3380
  type PackageMaterialRuleQuantity = {
3381
+ /**
3382
+ * - Minimum product's quantity that a packaging can contain.
3383
+ */
2184
3384
  min?: number;
3385
+ /**
3386
+ * - Maximum product's quantity that a packaging can contain.
3387
+ */
2185
3388
  max?: number;
2186
3389
  };
2187
- /** @returns {RulePriorityRequest} */
2188
- declare function RulePriorityRequest(): RulePriorityRequest;
2189
- type RulePriorityRequest = {
3390
+ /** @returns {RulePriorityDetails} */
3391
+ declare function RulePriorityDetails(): RulePriorityDetails;
3392
+ type RulePriorityDetails = {
3393
+ /**
3394
+ * - Rule id whose priority needs to be changed.
3395
+ */
2190
3396
  rule_id: string;
3397
+ /**
3398
+ * - New priority of the rule.
3399
+ */
2191
3400
  priority: number;
2192
3401
  };
2193
- /** @returns {RulePriorityResponse} */
2194
- declare function RulePriorityResponse(): RulePriorityResponse;
2195
- type RulePriorityResponse = {
3402
+ /** @returns {RulePriorityResult} */
3403
+ declare function RulePriorityResult(): RulePriorityResult;
3404
+ type RulePriorityResult = {
3405
+ /**
3406
+ * - Denotes if the priority of the rule is
3407
+ * changes successfully or not.
3408
+ */
2196
3409
  success?: boolean;
2197
3410
  };
2198
3411
  /** @returns {ArticleAssignment} */
@@ -2251,7 +3464,7 @@ declare function OptimalLocationsArticles(): OptimalLocationsArticles;
2251
3464
  type OptimalLocationsArticles = {
2252
3465
  item_id: number;
2253
3466
  size: string;
2254
- quantity: string;
3467
+ quantity: number;
2255
3468
  group_id?: string;
2256
3469
  is_primary_item?: boolean;
2257
3470
  meta?: any;
@@ -2260,18 +3473,18 @@ type OptimalLocationsArticles = {
2260
3473
  assign_locations: number[];
2261
3474
  seller_id?: number;
2262
3475
  };
2263
- /** @returns {OptimlLocationsRequestSchema} */
2264
- declare function OptimlLocationsRequestSchema(): OptimlLocationsRequestSchema;
2265
- type OptimlLocationsRequestSchema = {
3476
+ /** @returns {OptimlLocationsDetailsSchema} */
3477
+ declare function OptimlLocationsDetailsSchema(): OptimlLocationsDetailsSchema;
3478
+ type OptimlLocationsDetailsSchema = {
2266
3479
  channel_id: string;
2267
3480
  channel_type: string;
2268
3481
  channel_identifier?: string;
2269
3482
  to_serviceability: LocationDetailsServiceability;
2270
- article?: OptimalLocationsArticles;
3483
+ articles?: OptimalLocationsArticles[];
2271
3484
  };
2272
- /** @returns {OptimalLocationArticlesResponse} */
2273
- declare function OptimalLocationArticlesResponse(): OptimalLocationArticlesResponse;
2274
- type OptimalLocationArticlesResponse = {
3485
+ /** @returns {OptimalLocationArticlesResult} */
3486
+ declare function OptimalLocationArticlesResult(): OptimalLocationArticlesResult;
3487
+ type OptimalLocationArticlesResult = {
2275
3488
  item_id: number;
2276
3489
  size: string;
2277
3490
  quantity: number;
@@ -2287,15 +3500,35 @@ type OptimalLocationArticlesResponse = {
2287
3500
  _id: string;
2288
3501
  uid: string;
2289
3502
  };
2290
- /** @returns {OptimalLocationAssignedStoresResponse} */
2291
- declare function OptimalLocationAssignedStoresResponse(): OptimalLocationAssignedStoresResponse;
2292
- type OptimalLocationAssignedStoresResponse = {
3503
+ /** @returns {OptimalLocationAssignedStoresResult} */
3504
+ declare function OptimalLocationAssignedStoresResult(): OptimalLocationAssignedStoresResult;
3505
+ type OptimalLocationAssignedStoresResult = {
2293
3506
  store_id: number;
2294
- articles: OptimalLocationArticlesResponse[];
3507
+ articles: OptimalLocationArticlesResult[];
3508
+ };
3509
+ /** @returns {OptimalLocationsResult} */
3510
+ declare function OptimalLocationsResult(): OptimalLocationsResult;
3511
+ type OptimalLocationsResult = {
3512
+ assigned_stores: OptimalLocationAssignedStoresResult[];
3513
+ faulty_articles?: ErrorResult[];
3514
+ };
3515
+ /** @returns {ValidationError} */
3516
+ declare function ValidationError(): ValidationError;
3517
+ type ValidationError = {
3518
+ /**
3519
+ * - A brief description of the error encountered.
3520
+ */
3521
+ message: string;
3522
+ /**
3523
+ * - The field in the request that caused the error.
3524
+ */
3525
+ field: string;
2295
3526
  };
2296
- /** @returns {OptimalLocationsResponse} */
2297
- declare function OptimalLocationsResponse(): OptimalLocationsResponse;
2298
- type OptimalLocationsResponse = {
2299
- assigned_stores: OptimalLocationAssignedStoresResponse[];
2300
- faulty_articles?: ErrorResponse[];
3527
+ /** @returns {StandardError} */
3528
+ declare function StandardError(): StandardError;
3529
+ type StandardError = {
3530
+ /**
3531
+ * - A brief description of the error.
3532
+ */
3533
+ message: string;
2301
3534
  };