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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (242) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
  6. package/sdk/application/Cart/CartApplicationClient.js +27 -114
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  10. package/sdk/application/Common/CommonApplicationClient.js +1 -1
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
  14. package/sdk/application/Content/ContentApplicationClient.js +56 -161
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
  18. package/sdk/application/Lead/LeadApplicationClient.js +1 -1
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
  22. package/sdk/application/Order/OrderApplicationClient.js +8 -56
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
  24. package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
  25. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  26. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  27. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  28. package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
  29. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  30. package/sdk/application/User/UserApplicationClient.js +6 -6
  31. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  32. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  33. package/sdk/common/Utility.js +6 -3
  34. package/sdk/common/utils.d.ts +0 -1
  35. package/sdk/common/utils.js +0 -14
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
  37. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
  38. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
  39. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
  40. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
  41. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
  42. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  43. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  44. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  45. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  46. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
  47. package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
  48. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
  49. package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
  50. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
  51. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
  52. package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
  53. package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
  54. package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
  55. package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
  56. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  57. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
  58. package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
  59. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
  60. package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
  61. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
  62. package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
  64. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
  66. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
  71. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
  72. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
  73. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  74. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  75. package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
  76. package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
  77. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
  78. package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
  79. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
  80. package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
  81. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
  82. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
  83. package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
  84. package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
  85. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
  86. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
  87. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
  88. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
  89. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
  90. package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
  91. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
  92. package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
  93. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
  94. package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
  95. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
  96. package/sdk/platform/Common/CommonPlatformClient.js +2 -3
  97. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  98. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  99. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
  100. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
  101. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  102. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  103. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
  104. package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
  105. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
  106. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
  107. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  108. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
  109. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  110. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  111. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
  112. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
  113. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  114. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  115. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
  116. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
  117. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
  118. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
  119. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
  120. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
  121. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -204
  122. package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
  123. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
  124. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
  125. package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
  126. package/sdk/platform/Content/ContentPlatformClient.js +336 -523
  127. package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
  128. package/sdk/platform/Content/ContentPlatformModel.js +394 -631
  129. package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
  130. package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
  131. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
  132. package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
  133. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  134. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  135. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  136. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  137. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
  140. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
  141. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
  142. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
  144. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
  145. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  146. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  147. package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
  148. package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
  149. package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
  150. package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
  151. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
  152. package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
  153. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  154. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  155. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  156. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  157. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
  158. package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
  159. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
  160. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
  161. package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
  162. package/sdk/platform/Order/OrderPlatformClient.js +198 -416
  163. package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
  164. package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
  165. package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
  166. package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
  167. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
  168. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
  169. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  170. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  171. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
  172. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
  173. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  174. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  175. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  176. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  177. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
  178. package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
  179. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  180. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  181. package/sdk/platform/PlatformClient.d.ts +2 -0
  182. package/sdk/platform/PlatformClient.js +4 -0
  183. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  184. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  185. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  186. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  187. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  188. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
  192. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
  193. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
  199. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  200. package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
  201. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
  202. package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
  203. package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
  204. package/sdk/platform/Share/SharePlatformModel.js +6 -31
  205. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  206. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
  207. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
  208. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
  209. package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
  210. package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
  211. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  212. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  213. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  214. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  215. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  216. package/sdk/platform/User/UserPlatformModel.js +23 -23
  217. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
  218. package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
  219. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
  220. package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
  221. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
  222. package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
  223. package/sdk/platform/index.d.ts +1 -0
  224. package/sdk/platform/index.js +2 -0
  225. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
  226. package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
  227. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  228. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  229. package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
  230. package/sdk/public/Content/ContentPublicClient.js +6 -810
  231. package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
  232. package/sdk/public/Content/ContentPublicModel.js +3 -649
  233. package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
  234. package/sdk/public/Content/ContentPublicValidator.js +2 -88
  235. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  236. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  237. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  238. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  239. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  240. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  241. package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
  242. package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
@@ -1,12 +1,12 @@
1
1
  const Joi = require("joi");
2
2
 
3
3
  /**
4
- * @typedef UpdateZoneConfigDetails
4
+ * @typedef UpdateZoneConfigRequest
5
5
  * @property {string} [serviceability_type]
6
6
  */
7
7
 
8
8
  /**
9
- * @typedef ServiceabilityErrorResult
9
+ * @typedef ServiceabilityErrorResponse
10
10
  * @property {string} message
11
11
  * @property {string} value
12
12
  * @property {string} type
@@ -20,14 +20,14 @@ const Joi = require("joi");
20
20
  */
21
21
 
22
22
  /**
23
- * @typedef ApplicationServiceabilityConfigResult
24
- * @property {ServiceabilityErrorResult} [error]
23
+ * @typedef ApplicationServiceabilityConfigResponse
24
+ * @property {ServiceabilityErrorResponse} [error]
25
25
  * @property {ApplicationServiceabilityConfig} [data]
26
26
  * @property {boolean} success
27
27
  */
28
28
 
29
29
  /**
30
- * @typedef EntityRegionView_Details
30
+ * @typedef EntityRegionView_Request
31
31
  * @property {string[]} sub_type
32
32
  * @property {string[]} [parent_id]
33
33
  */
@@ -49,7 +49,7 @@ const Joi = require("joi");
49
49
  */
50
50
 
51
51
  /**
52
- * @typedef getAppRegionZonesResult
52
+ * @typedef getAppRegionZonesResponse
53
53
  * @property {PageSchema[]} page
54
54
  * @property {ListViewItems[]} items
55
55
  */
@@ -71,7 +71,7 @@ const Joi = require("joi");
71
71
  */
72
72
 
73
73
  /**
74
- * @typedef EntityRegionView_Result
74
+ * @typedef EntityRegionView_Response
75
75
  * @property {EntityRegionView_Error} error
76
76
  * @property {EntityRegionView_page} page
77
77
  * @property {EntityRegionView_Items[]} data
@@ -123,7 +123,7 @@ const Joi = require("joi");
123
123
  */
124
124
 
125
125
  /**
126
- * @typedef ListViewResult
126
+ * @typedef ListViewResponse
127
127
  * @property {ZoneDataItem} page
128
128
  * @property {ListViewItems[]} items
129
129
  */
@@ -138,7 +138,7 @@ const Joi = require("joi");
138
138
  */
139
139
 
140
140
  /**
141
- * @typedef CompanyStoreView_Result
141
+ * @typedef CompanyStoreView_Response
142
142
  * @property {CompanyStoreView_PageItems[]} page
143
143
  * @property {Object[]} [items]
144
144
  */
@@ -151,9 +151,8 @@ const Joi = require("joi");
151
151
 
152
152
  /**
153
153
  * @typedef ZoneProductTypes
154
- * @property {string} type - Denotes if the zone is applicable for all the
155
- * products or specific products.
156
- * @property {string[]} tags - List of product tags.
154
+ * @property {string} type
155
+ * @property {string[]} tags
157
156
  */
158
157
 
159
158
  /**
@@ -164,8 +163,8 @@ const Joi = require("joi");
164
163
 
165
164
  /**
166
165
  * @typedef ZoneMappingType
167
- * @property {string} country - Uid for the country.
168
- * @property {string[]} regions - List of region uid for the given country.
166
+ * @property {string} country
167
+ * @property {string[]} regions
169
168
  */
170
169
 
171
170
  /**
@@ -179,97 +178,86 @@ const Joi = require("joi");
179
178
 
180
179
  /**
181
180
  * @typedef UpdateZoneData
182
- * @property {string} zone_id - Unique identifier for the zone.
183
- * @property {string} name - Name for the zone.
184
- * @property {string} slug - A human-readable and unique identifier for the
185
- * zone, derived from the name.
186
- * @property {number} company_id - Company id associated with the zone.
187
- * @property {boolean} is_active - A flag indicating whether the zone is active.
188
- * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
181
+ * @property {string} zone_id
182
+ * @property {string} name
183
+ * @property {string} slug
184
+ * @property {number} company_id
185
+ * @property {boolean} is_active
186
+ * @property {GetZoneDataViewChannels[]} channels
189
187
  * @property {ZoneProductTypes} product
190
- * @property {number[]} store_ids - A list of store identifiers associated with the zone.
191
- * @property {string} region_type - Type of region that belongs in the zone.
192
- * @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
188
+ * @property {number[]} store_ids
189
+ * @property {string} region_type
190
+ * @property {ZoneMappingType[]} mapping
193
191
  */
194
192
 
195
193
  /**
196
- * @typedef ZoneUpdateDetails
194
+ * @typedef ZoneUpdateRequest
197
195
  * @property {string} identifier
198
196
  * @property {UpdateZoneData} data
199
197
  */
200
198
 
201
199
  /**
202
- * @typedef ZoneSuccessResult
200
+ * @typedef ZoneSuccessResponse
203
201
  * @property {number} status_code
204
202
  * @property {boolean} success
205
203
  */
206
204
 
207
205
  /**
208
206
  * @typedef GetZoneDataViewItems
209
- * @property {string} zone_id - The unique identifier for the zone.
210
- * @property {string} name - The name of the zone for easy identification.
211
- * @property {string} slug - A URL-friendly version of the zone’s name, used for
212
- * routing or linking.
213
- * @property {number} [company_id] - The ID of the company associated with this zone.
214
- * @property {boolean} is_active - A flag indicating whether the zone is active
215
- * (true) or inactive (false).
216
- * @property {GetZoneDataViewChannels[]} channels - A list of channels available
217
- * within this zone.
207
+ * @property {string} zone_id
208
+ * @property {string} name
209
+ * @property {string} slug
210
+ * @property {number} [company_id]
211
+ * @property {boolean} is_active
212
+ * @property {GetZoneDataViewChannels[]} channels
218
213
  * @property {ZoneProductTypes} product
219
- * @property {number[]} store_ids - A collection of store IDs linked to this zone.
220
- * @property {string} [region_type] - The type of region the zone represents.
221
- * @property {ZoneMappingType[]} mapping - A list of mappings defining
222
- * relationships between this zone and other entities.
223
- * @property {string} [assignment_preference] - The preferred method for
224
- * assigning stores or products to the zone.
225
- * @property {number} stores_count - The total number of stores assigned to this zone.
214
+ * @property {number[]} store_ids
215
+ * @property {string} [region_type]
216
+ * @property {ZoneMappingType[]} mapping
217
+ * @property {number} stores_count
226
218
  */
227
219
 
228
220
  /**
229
- * @typedef GetSingleZoneDataViewResult
221
+ * @typedef GetSingleZoneDataViewResponse
230
222
  * @property {GetZoneDataViewItems} data
231
223
  */
232
224
 
233
225
  /**
234
226
  * @typedef GetZoneByIdSchema
235
- * @property {string} zone_id - Unique identifier for the zone.
236
- * @property {string} name - Name for the zone.
237
- * @property {string} slug - A human-readable and unique identifier for the
238
- * zone, derived from the name.
239
- * @property {number} [company_id] - Company id associated with the zone.
240
- * @property {boolean} is_active - A flag indicating whether the zone is active.
241
- * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
227
+ * @property {string} zone_id
228
+ * @property {string} name
229
+ * @property {string} slug
230
+ * @property {number} [company_id]
231
+ * @property {boolean} is_active
232
+ * @property {GetZoneDataViewChannels[]} channels
242
233
  * @property {ZoneProductTypes} product
243
- * @property {number[]} store_ids - A list of store identifiers associated with the zone.
244
- * @property {string} region_type - Type of region that belongs in the zone.
234
+ * @property {number[]} store_ids
235
+ * @property {string} region_type
245
236
  * @property {ZoneMappingDetailType[]} mapping - Country to region mapping for the zone.
246
- * @property {number} [stores_count]
247
237
  */
248
238
 
249
239
  /**
250
240
  * @typedef CreateZoneData
251
- * @property {string} name - Name of the zone.
252
- * @property {string} slug - A human-readable and unique identifier for the
253
- * zone, derived from the name.
254
- * @property {number} company_id - Unique identifier of the company for which
255
- * the zone is created.
256
- * @property {boolean} is_active - A flag indicating whether the zone is active.
257
- * @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
258
- * @property {number[]} store_ids - A list of store identifiers associated with the zone.
259
- * @property {string} region_type - Type of region that belongs in the zone.
260
- * @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
261
- * @property {ZoneProductTypes} [product]
241
+ * @property {string} name
242
+ * @property {string} slug
243
+ * @property {number} company_id
244
+ * @property {boolean} is_active
245
+ * @property {GetZoneDataViewChannels[]} channels
246
+ * @property {number[]} store_ids
247
+ * @property {ZoneProductTypes} product
248
+ * @property {string} region_type
249
+ * @property {ZoneMappingType[]} mapping
262
250
  */
263
251
 
264
252
  /**
265
- * @typedef ZoneResult
266
- * @property {number} [status_code]
253
+ * @typedef ZoneResponse
254
+ * @property {number} status_code
267
255
  * @property {string} zone_id
268
256
  * @property {boolean} success
269
257
  */
270
258
 
271
259
  /**
272
- * @typedef GetZoneFromPincodeViewDetails
260
+ * @typedef GetZoneFromPincodeViewRequest
273
261
  * @property {string} country
274
262
  * @property {string} pincode
275
263
  */
@@ -286,19 +274,19 @@ const Joi = require("joi");
286
274
  */
287
275
 
288
276
  /**
289
- * @typedef GetZoneFromPincodeViewResult
277
+ * @typedef GetZoneFromPincodeViewResponse
290
278
  * @property {string} serviceability_type
291
279
  * @property {Zone[]} zones
292
280
  */
293
281
 
294
282
  /**
295
- * @typedef GetZoneFromApplicationIdViewResult
283
+ * @typedef GetZoneFromApplicationIdViewResponse
296
284
  * @property {ZoneDataItem[]} page
297
285
  * @property {ListViewItems[]} items
298
286
  */
299
287
 
300
288
  /**
301
- * @typedef ServiceabilityPageResult
289
+ * @typedef ServiceabilityPageResponse
302
290
  * @property {string} [type]
303
291
  * @property {boolean} [has_next]
304
292
  * @property {number} [item_total]
@@ -313,37 +301,37 @@ const Joi = require("joi");
313
301
  */
314
302
 
315
303
  /**
316
- * @typedef ManagerResult
304
+ * @typedef ManagerResponse
317
305
  * @property {string} [email]
318
306
  * @property {MobileNo} [mobile_no]
319
307
  * @property {string} [name]
320
308
  */
321
309
 
322
310
  /**
323
- * @typedef ModifiedByResult
311
+ * @typedef ModifiedByResponse
324
312
  * @property {string} [username]
325
313
  * @property {string} [user_id]
326
314
  */
327
315
 
328
316
  /**
329
- * @typedef IntegrationTypeResult
317
+ * @typedef IntegrationTypeResponse
330
318
  * @property {string} [inventory]
331
319
  * @property {string} [order]
332
320
  */
333
321
 
334
322
  /**
335
- * @typedef ProductReturnConfigResult
323
+ * @typedef ProductReturnConfigResponse
336
324
  * @property {boolean} [on_same_store]
337
325
  */
338
326
 
339
327
  /**
340
- * @typedef ContactNumberResult
328
+ * @typedef ContactNumberResponse
341
329
  * @property {string} [number]
342
330
  * @property {number} [country_code]
343
331
  */
344
332
 
345
333
  /**
346
- * @typedef AddressResult
334
+ * @typedef AddressResponse
347
335
  * @property {string} [city]
348
336
  * @property {string} [address1]
349
337
  * @property {number} [pincode]
@@ -356,29 +344,29 @@ const Joi = require("joi");
356
344
  */
357
345
 
358
346
  /**
359
- * @typedef CreatedByResult
347
+ * @typedef CreatedByResponse
360
348
  * @property {string} [username]
361
349
  * @property {string} [user_id]
362
350
  */
363
351
 
364
352
  /**
365
- * @typedef EwayBillResult
353
+ * @typedef EwayBillResponse
366
354
  * @property {boolean} [enabled]
367
355
  */
368
356
 
369
357
  /**
370
- * @typedef EinvoiceResult
358
+ * @typedef EinvoiceResponse
371
359
  * @property {boolean} [enabled]
372
360
  */
373
361
 
374
362
  /**
375
- * @typedef GstCredentialsResult
376
- * @property {EwayBillResult} [e_waybill]
377
- * @property {EinvoiceResult} [e_invoice]
363
+ * @typedef GstCredentialsResponse
364
+ * @property {EwayBillResponse} [e_waybill]
365
+ * @property {EinvoiceResponse} [e_invoice]
378
366
  */
379
367
 
380
368
  /**
381
- * @typedef WarningsResult
369
+ * @typedef WarningsResponse
382
370
  * @property {string} [store_address]
383
371
  */
384
372
 
@@ -389,7 +377,7 @@ const Joi = require("joi");
389
377
  */
390
378
 
391
379
  /**
392
- * @typedef TimmingResult
380
+ * @typedef TimmingResponse
393
381
  * @property {boolean} [open]
394
382
  * @property {string} [weekday]
395
383
  * @property {OpeningClosing} [closing]
@@ -397,7 +385,7 @@ const Joi = require("joi");
397
385
  */
398
386
 
399
387
  /**
400
- * @typedef DocumentsResult
388
+ * @typedef DocumentsResponse
401
389
  * @property {string} [legal_name]
402
390
  * @property {string} [value]
403
391
  * @property {string} [type]
@@ -419,119 +407,109 @@ const Joi = require("joi");
419
407
  */
420
408
 
421
409
  /**
422
- * @typedef LogisticsResult
410
+ * @typedef LogisticsResponse
423
411
  * @property {boolean} [override]
424
412
  * @property {Dp} [dp]
425
413
  */
426
414
 
427
415
  /**
428
- * @typedef ItemResult
416
+ * @typedef ItemResponse
429
417
  * @property {string} [created_on]
430
- * @property {ManagerResult} [manager]
431
- * @property {ModifiedByResult} [modified_by]
432
- * @property {IntegrationTypeResult} [integration_type]
418
+ * @property {ManagerResponse} [manager]
419
+ * @property {ModifiedByResponse} [modified_by]
420
+ * @property {IntegrationTypeResponse} [integration_type]
433
421
  * @property {string} [verified_on]
434
- * @property {ProductReturnConfigResult} [product_return_config]
435
- * @property {ContactNumberResult[]} [contact_numbers]
436
- * @property {ModifiedByResult} [verified_by]
422
+ * @property {ProductReturnConfigResponse} [product_return_config]
423
+ * @property {ContactNumberResponse[]} [contact_numbers]
424
+ * @property {ModifiedByResponse} [verified_by]
437
425
  * @property {string} [stage]
438
- * @property {AddressResult} [address]
426
+ * @property {AddressResponse} [address]
439
427
  * @property {string} [modified_on]
440
- * @property {CreatedByResult} [created_by]
441
- * @property {GstCredentialsResult} [gst_credentials]
428
+ * @property {CreatedByResponse} [created_by]
429
+ * @property {GstCredentialsResponse} [gst_credentials]
442
430
  * @property {string} [display_name]
443
431
  * @property {number} [company_id]
444
432
  * @property {number} [uid]
445
- * @property {Object} [_custom_json] - Custom JSON for internal usage
433
+ * @property {Object} [_custom_json]
446
434
  * @property {string} [code]
447
- * @property {WarningsResult} [warnings]
435
+ * @property {WarningsResponse} [warnings]
448
436
  * @property {string} [name]
449
- * @property {TimmingResult[]} [timing]
450
- * @property {DocumentsResult[]} [documents]
437
+ * @property {TimmingResponse[]} [timing]
438
+ * @property {DocumentsResponse[]} [documents]
451
439
  * @property {string} [store_type]
452
440
  * @property {string} [sub_type]
453
441
  * @property {number} [company]
454
442
  * @property {string} [_cls]
455
- * @property {LogisticsResult} [logistics]
443
+ * @property {LogisticsResponse} [logistics]
456
444
  * @property {string[]} [notification_emails]
457
445
  */
458
446
 
459
447
  /**
460
- * @typedef GetStoresViewResult
461
- * @property {ServiceabilityPageResult} page
462
- * @property {ItemResult[]} [items]
448
+ * @typedef GetStoresViewResponse
449
+ * @property {ServiceabilityPageResponse} page
450
+ * @property {ItemResponse[]} [items]
463
451
  */
464
452
 
465
453
  /**
466
454
  * @typedef PincodeMopData
467
- * @property {number[]} pincodes - A list of pincodes.
468
- * @property {string} country - Name of the country.
469
- * @property {string} action - Denotes wether to activate or deavtivate pincodes
470
- * for COD mode of payment.
455
+ * @property {number[]} pincodes
456
+ * @property {string} country
457
+ * @property {string} action
471
458
  */
472
459
 
473
460
  /**
474
- * @typedef PincodeMopUpdateResult
475
- * @property {number} pincode - Pincode of the region.
476
- * @property {string} channel_id - Unique identifier of the sales channel.
477
- * @property {string} country - Country name.
478
- * @property {boolean} is_active - Denotes whether the pincode mode of payment
479
- * is active or not.
461
+ * @typedef PincodeMopUpdateResponse
462
+ * @property {number} pincode
463
+ * @property {string} channel_id
464
+ * @property {string} country
465
+ * @property {boolean} is_active
480
466
  */
481
467
 
482
468
  /**
483
- * @typedef PincodeMOPResult
484
- * @property {boolean} success - Denotes if the action was successful or not.
485
- * @property {number} status_code - Status code for the response.
486
- * @property {string} batch_id - Unique identifier identifying the perticular request.
487
- * @property {string} country - Name of the country.
488
- * @property {string} action - Denotes wether to activate or deavtivate pincodes
489
- * for COD mode of payment.
490
- * @property {number[]} [pincodes] - List of pincodes.
491
- * @property {PincodeMopUpdateResult[]} [updated_pincodes] - Details of the
492
- * updated pincodes.
469
+ * @typedef PincodeMOPresponse
470
+ * @property {boolean} success
471
+ * @property {number} status_code
472
+ * @property {string} batch_id
473
+ * @property {string} country
474
+ * @property {string} action
475
+ * @property {number[]} [pincodes]
476
+ * @property {PincodeMopUpdateResponse[]} [updated_pincodes]
493
477
  */
494
478
 
495
479
  /**
496
480
  * @typedef CommonError
497
- * @property {string} [status_code] - Status code for the error.
481
+ * @property {string} [status_code]
498
482
  * @property {Object} [error]
499
- * @property {string} [success] - Whether operation was successful.
483
+ * @property {string} [success]
500
484
  */
501
485
 
502
486
  /**
503
487
  * @typedef PincodeMopBulkData
504
- * @property {string} batch_id - Unique identifier for the request.
505
- * @property {string} s3_url - CDN url for the uploaded file.
488
+ * @property {string} batch_id
489
+ * @property {string} s3_url
506
490
  */
507
491
 
508
492
  /**
509
- * @typedef PincodeBulkViewResult
493
+ * @typedef PincodeBulkViewResponse
510
494
  * @property {string} batch_id
511
- * @property {string} s3_url - CDN url for the uploaded file.
495
+ * @property {string} s3_url
512
496
  */
513
497
 
514
498
  /**
515
- * @typedef PincodeCodStatusListingDetails
516
- * @property {string} [country] - Name of the country.
517
- * @property {boolean} [is_active] - Search based on the active or inactive flag.
518
- * @property {number} [pincode] - Search based on the pincode.
499
+ * @typedef PincodeCodStatusListingRequest
500
+ * @property {string} [country]
501
+ * @property {boolean} [is_active]
502
+ * @property {number} [pincode]
519
503
  * @property {number} [current]
520
504
  * @property {number} [page_size]
521
505
  */
522
506
 
523
507
  /**
524
- * @typedef PincodeCodStatusItem
525
- * @property {boolean} [active] - Denoted if the pincode is active or not.
526
- * @property {string} [pincode] - Name of the pincode.
527
- */
528
-
529
- /**
530
- * @typedef PincodeCodStatusListingResult
531
- * @property {string} country - Name of the country.
532
- * @property {PincodeCodStatusListingResult[]} data - List of pincode details.
533
- * @property {boolean} success - Denotes if the request was successful or not.
534
- * @property {Error[]} [errors] - List of error object in case of unsuccessful response.
508
+ * @typedef PincodeCodStatusListingResponse
509
+ * @property {string} country
510
+ * @property {PincodeCodStatusListingResponse[]} data
511
+ * @property {boolean} success
512
+ * @property {Error[]} [errors]
535
513
  * @property {PincodeCodStatusListingPage} page
536
514
  * @property {PincodeCodStatusListingSummary} summary
537
515
  */
@@ -554,14 +532,14 @@ const Joi = require("joi");
554
532
 
555
533
  /**
556
534
  * @typedef PincodeCodStatusListingSummary
557
- * @property {number} total_active_pincodes - Count of the total active pincodes.
558
- * @property {number} total_inactive_pincodes - Count of the total inactive pincodes.
535
+ * @property {number} total_active_pincodes
536
+ * @property {number} total_inactive_pincodes
559
537
  */
560
538
 
561
539
  /**
562
- * @typedef PincodeMopUpdateAuditHistoryDetails
563
- * @property {string} entity_type - Type of the entity requested.
564
- * @property {string} [file_name] - Name of the file.
540
+ * @typedef PincodeMopUpdateAuditHistoryRequest
541
+ * @property {string} entity_type
542
+ * @property {string} [file_name]
565
543
  */
566
544
 
567
545
  /**
@@ -574,23 +552,22 @@ const Joi = require("joi");
574
552
  */
575
553
 
576
554
  /**
577
- * @typedef PincodeMopUpdateAuditHistoryResult
578
- * @property {string} [batch_id] - Uniquie identifier of the request.
579
- * @property {string} [entity_type] - Type of the entity requested.
580
- * @property {string} [error_file_s3_url] - URL for the error file.
581
- * @property {string} [s3_url] - CDN url for the file uploaded.
582
- * @property {string} [file_name] - Name of the file.
555
+ * @typedef PincodeMopUpdateAuditHistoryResponse
556
+ * @property {string} [batch_id]
557
+ * @property {string} [entity_type]
558
+ * @property {string} [error_file_s3_url]
559
+ * @property {string} [s3_url]
560
+ * @property {string} [file_name]
583
561
  * @property {string} [updated_at]
584
562
  * @property {string} [updated_by]
585
- * @property {boolean} [success] - Denotes if the request was successfully processed.
563
+ * @property {boolean} [success]
586
564
  */
587
565
 
588
566
  /**
589
- * @typedef PincodeMopUpdateAuditHistoryResultData
590
- * @property {string} [entity_type] - Type of the entity requested.
567
+ * @typedef PincodeMopUpdateAuditHistoryResponseData
568
+ * @property {string} [entity_type]
591
569
  * @property {PincodeMopUpdateAuditHistoryPaging} page
592
- * @property {PincodeMopUpdateAuditHistoryResult[]} data - History records of
593
- * the uploaded files.
570
+ * @property {PincodeMopUpdateAuditHistoryResponse[]} data
594
571
  */
595
572
 
596
573
  /**
@@ -621,53 +598,37 @@ const Joi = require("joi");
621
598
  * @property {SchemeRulesFeatures} [feature]
622
599
  */
623
600
 
624
- /**
625
- * @typedef CourierAccountUpdateDetails
626
- * @property {string} extension_id - Unique identifier of courier partner extension.
627
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
628
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
629
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
630
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
631
- * account or not.
632
- */
633
-
634
601
  /**
635
602
  * @typedef CourierAccount
636
- * @property {number} company_id - Company id associated with the account.
637
- * @property {string} extension_id - Unique identifier of courier partner extension.
638
- * @property {string} account_id - Unique identifier of courier partner scheme
639
- * and company id combination.
640
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
641
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
642
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
643
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
644
- * account or not.
645
- * @property {CourierPartnerSchemeModel} scheme_rules
603
+ * @property {string} extension_id
604
+ * @property {string} account_id
605
+ * @property {string} scheme_id
606
+ * @property {boolean} is_self_ship
607
+ * @property {string} stage
608
+ * @property {boolean} is_own_account
646
609
  */
647
610
 
648
611
  /**
649
- * @typedef CourierAccountDetailsBody
650
- * @property {string} extension_id - Unique identifier of courier partner extension.
651
- * @property {string} [account_id] - Unique identifier of courier partner scheme
652
- * and company id combination.
653
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
654
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
655
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
656
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
657
- * account or not.
612
+ * @typedef CourierAccountRequestBody
613
+ * @property {string} extension_id
614
+ * @property {string} [account_id]
615
+ * @property {string} scheme_id
616
+ * @property {boolean} is_self_ship
617
+ * @property {string} stage
618
+ * @property {boolean} is_own_account
658
619
  */
659
620
 
660
621
  /**
661
- * @typedef ErrorResult
662
- * @property {string} value - Fields containing the error.
663
- * @property {string} message - Description of the error.
664
- * @property {string} type - Type of the error.
622
+ * @typedef ErrorResponse
623
+ * @property {string} value
624
+ * @property {string} message
625
+ * @property {string} type
665
626
  */
666
627
 
667
628
  /**
668
- * @typedef CourierPartnerAccountFailureResult
669
- * @property {boolean} success - Denotes whether the request is a success or failure.
670
- * @property {ErrorResult[]} error
629
+ * @typedef CourierPartnerAccountFailureResponse
630
+ * @property {boolean} success
631
+ * @property {ErrorResponse[]} error
671
632
  */
672
633
 
673
634
  /**
@@ -682,40 +643,33 @@ const Joi = require("joi");
682
643
  */
683
644
 
684
645
  /**
685
- * @typedef CourierPartnerRuleCPListResult
686
- * @property {string} account_id - Unique identifier of courier partner scheme
687
- * and company id combination.
688
- * @property {string} extension_id - Unique identifier of courier partner extension.
689
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
690
- * @property {Object} [scheme_rules] - Denotes the scheme rules associated with
691
- * the courier partner account.
646
+ * @typedef CourierPartnerRuleCPListResponse
647
+ * @property {string} [account_id]
648
+ * @property {string} [extension_id]
649
+ * @property {boolean} [is_self_ship]
650
+ * @property {Object} [scheme_rules]
692
651
  */
693
652
 
694
653
  /**
695
- * @typedef CourierPartnerRuleResult
696
- * @property {boolean} is_active - Denotes whether the given courier partner
697
- * rule is inactive or active.
698
- * @property {string} application_id - Unique identifier of the sales channel.
699
- * @property {number} company_id - Unique identifier of the company.
700
- * @property {CourierPartnerRuleConditions} conditions
701
- * @property {string[]} sort - Sort Strategy of the courier partners.
702
- * @property {Object} [created_by] - The Fynd account used to create the courier
703
- * partner rule.
704
- * @property {string} id - Unique identifier of the courier partner rule.
705
- * @property {Object} [modified_by] - The Fynd account used to modify the
706
- * courier partner rule.
707
- * @property {string} [modified_on] - The datetime at which courier partner rule
708
- * is modified.
709
- * @property {string} name - Name for the courier partner rule.
710
- * @property {string} type - The type of the rule.
711
- * @property {CourierPartnerRuleCPListResult[]} [cp_list]
654
+ * @typedef CourierPartnerRuleResponse
655
+ * @property {boolean} [is_active]
656
+ * @property {string} [application_id]
657
+ * @property {number} [company_id]
658
+ * @property {CourierPartnerRuleConditions} [conditions]
659
+ * @property {string[]} [sort]
660
+ * @property {Object} [created_by]
661
+ * @property {string} [id]
662
+ * @property {Object} [modified_by]
663
+ * @property {string} [modified_on]
664
+ * @property {string} [name]
665
+ * @property {string} [type]
666
+ * @property {CourierPartnerRuleCPListResponse[]} [cp_list]
712
667
  */
713
668
 
714
669
  /**
715
670
  * @typedef CourierPartnerList
716
- * @property {string} extension_id - Unique identifier of courier partner extension.
717
- * @property {string} account_id - Unique identifier of courier partner scheme
718
- * and company id combination.
671
+ * @property {string} extension_id
672
+ * @property {string} account_id
719
673
  */
720
674
 
721
675
  /**
@@ -724,7 +678,7 @@ const Joi = require("joi");
724
678
  * @property {string} [sub_type]
725
679
  * @property {string} [name]
726
680
  * @property {string} [display_name]
727
- * @property {string[]} [parent_id]
681
+ * @property {string} [parent_id]
728
682
  * @property {string[]} [parent_ids]
729
683
  */
730
684
 
@@ -766,189 +720,98 @@ const Joi = require("joi");
766
720
 
767
721
  /**
768
722
  * @typedef CourierPartnerRule
769
- * @property {boolean} is_active - Denotes whether the given courier partner
770
- * rule is inactive or active.
771
- * @property {CourierPartnerList[]} [cp_list] - A list of courier partners.
772
- * @property {string} name - Name for the courier partner rule.
723
+ * @property {boolean} is_active
724
+ * @property {CourierPartnerList[]} [cp_list]
725
+ * @property {string} name
773
726
  * @property {CourierPartnerRuleConditions} conditions
774
- * @property {string[]} sort - Sort Strategy for the courier partners.
775
- * @property {string} [type] - Denotes the type of the rule.
727
+ * @property {string[]} sort
776
728
  */
777
729
 
778
730
  /**
779
- * @typedef FailureResult
731
+ * @typedef FailureResponse
780
732
  * @property {boolean} success
781
- * @property {ErrorResult[]} error
733
+ * @property {ErrorResponse[]} error
782
734
  */
783
735
 
784
736
  /**
785
- * @typedef CourierPartnerRulesListResult
786
- * @property {CourierPartnerRuleResult[]} items
737
+ * @typedef CourierPartnerRulesListResponse
738
+ * @property {CourierPartnerRuleResponse[]} items
787
739
  * @property {Page} page
788
740
  */
789
741
 
790
- /**
791
- * @typedef ShipmentsArticles
792
- * @property {number} [item_id] - Unique identifier of the item.
793
- * @property {number} [category_id] - Unique identifier of the category.
794
- * @property {number} [brand_id] - Unique identifier of the brand.
795
- * @property {number} [department_id] - Unique identifier of the department.
796
- * @property {string[]} [tags] - Tags associated with the item.
797
- */
798
-
799
- /**
800
- * @typedef ShipmentDimension
801
- * @property {number} height - Height of the shipment in centimeters.
802
- * @property {number} length - Length of the shipment in centimeters.
803
- * @property {number} width - Width of the shipment in centimeters.
804
- */
805
-
806
- /**
807
- * @typedef Shipments
808
- * @property {string} [id] - Unique identifier of the shipment.
809
- * @property {number} [location_id] - Unique identifier of the selling location.
810
- * @property {string[]} [location_tags] - Tags associated with the selling location.
811
- * @property {number} [shipment_weight] - Weight of the shipment.
812
- * @property {number} [shipment_volumetric_weight] - Volumetric weight of the shipment.
813
- * @property {number} [shipment_cost] - Total Cost of the shipment.
814
- * @property {ShipmentDimension} [shipment_dimension]
815
- * @property {string[]} [courier_partner_schemes] - A List of courier schemes.
816
- * @property {ShipmentsArticles[]} [articles] - List of articles in the shipment.
817
- */
818
-
819
- /**
820
- * @typedef ShipmentCourierPartnerDetails
821
- * @property {ShipmentsCourierPartnersServiceability} from_location
822
- * @property {ShipmentsCourierPartnersServiceability} to_location
823
- * @property {Shipments[]} [shipments] - List of shipments.
824
- * @property {string} [journey] - Journey type of the shipment forward or return.
825
- * @property {string} [payment_mode] - Payment mode opted for the shipment.
826
- */
827
-
828
- /**
829
- * @typedef CourierPartnerPromise
830
- * @property {string} min - The earliest possible timestamp.
831
- * @property {string} max - The latest possible timestamp.
832
- */
833
-
834
- /**
835
- * @typedef CourierPartners
836
- * @property {string} [extension_id] - Unique identifier of courier partner extension.
837
- * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
838
- * @property {string} [name] - Name of the courier partner.
839
- * @property {CourierPartnerPromise} [delivery_promise]
840
- */
841
-
842
- /**
843
- * @typedef ShipmentCourierPartners
844
- * @property {string} [id] - Unique identifier of the shipment.
845
- * @property {CourierPartners[]} [courier_partners] - Courier partners of the shipment.
846
- */
847
-
848
- /**
849
- * @typedef ShipmentCourierPartnerResult
850
- * @property {CourierPartners[]} [courier_partners]
851
- * @property {ShipmentCourierPartners[]} [shipments]
852
- */
853
-
854
- /**
855
- * @typedef ShipmentsCourierPartnersServiceability
856
- * @property {string} [pincode] - Postal code or PIN code of the address area.
857
- * @property {string} [sector_code] - Specifies the sector or district code of
858
- * the address if applicable.
859
- * @property {string} [state_code] - Indicates the state or province code of the address.
860
- * @property {string} [city_code] - Denote the city or municipality code of the address.
861
- * @property {string} country_code - ISO2 code for the country of the address.
862
- */
863
-
864
742
  /**
865
743
  * @typedef CompanyConfig
866
- * @property {string[]} rule_ids - A list for courier partner rules.
867
- * @property {string[]} sort - Sort strategy for the courier partners.
868
- * @property {string} [logistics_as_actual] - Depicts if the courier partner
869
- * rule configuration plan is subscribed by the seller for which mode.
870
- * @property {number} company_id - Unique identifier of the company.
871
- * @property {string} [application_id] - Unique identifier of the sales channel.
744
+ * @property {string[]} rule_ids
745
+ * @property {string[]} sort
746
+ * @property {boolean} [logistics_as_actual]
872
747
  */
873
748
 
874
749
  /**
875
750
  * @typedef ZoneConfig
876
- * @property {string} [serviceability_type] - Serviceability type of the delivery zone.
877
- * @property {number} [active_count] - Count of active delivery zones associated
878
- * with the sales channel.
879
- * @property {number} [total_count] - Count of total delivery zones associated
880
- * with the sales channel.
751
+ * @property {string} [serviceability_type]
881
752
  */
882
753
 
883
754
  /**
884
755
  * @typedef ApplicationConfig
885
- * @property {string[]} [rule_ids] - A list of courier partner rules.
886
- * @property {string[]} [sort] - Strategy adopted to sort the courier partners.
756
+ * @property {string[]} [rule_ids]
757
+ * @property {string[]} [sort]
887
758
  * @property {ZoneConfig} [zones]
888
759
  */
889
760
 
890
761
  /**
891
- * @typedef BulkRegionJobDetails
892
- * @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
893
- * @property {string} country - Country for which the tat or serviceability is
894
- * to be imported or exported.
895
- * @property {string} action - Denotes the import or export action to be performed.
896
- * @property {string} region - Region of the country for which import or export
897
- * is triggered.
762
+ * @typedef BulkRegionJobSerializer
763
+ * @property {string} [file_path]
764
+ * @property {string} country
765
+ * @property {string} action
766
+ * @property {string} region
898
767
  */
899
768
 
900
769
  /**
901
- * @typedef BulkRegionResultItemData
902
- * @property {string} [file_path] - CDN path of the file which was used for bulk import.
903
- * @property {number} [failed] - Count of the failed records.
770
+ * @typedef BulkRegionResponseItemData
771
+ * @property {string} file_path
772
+ * @property {number} [failed]
904
773
  * @property {Object[]} [failed_records]
905
- * @property {string} action - Denotes the import or export action performed.
906
- * @property {string} batch_id - Unique id to identify the import or export query.
907
- * @property {string} country - Country for which the import or export action is
908
- * performed.
909
- * @property {number} [success] - Denoted if the import or export was successful
910
- * or failure.
911
- * @property {string} region - Region of the country for which import or export
912
- * is triggered.
913
- * @property {string} status - Current status of the import or export action performed.
914
- * @property {number} [total] - Count of total records.
915
- * @property {string} [error_file_path] - Path of the error file.
916
- */
917
-
918
- /**
919
- * @typedef BulkRegionResult
920
- * @property {BulkRegionResultItemData[]} items
774
+ * @property {string} action
775
+ * @property {string} batch_id
776
+ * @property {string} country
777
+ * @property {number} [success]
778
+ * @property {string} region
779
+ * @property {string} status
780
+ * @property {number} [total]
781
+ * @property {string} [error_file_path]
782
+ */
783
+
784
+ /**
785
+ * @typedef BulkRegionResponse
786
+ * @property {BulkRegionResponseItemData[]} items
921
787
  * @property {Page} page
922
788
  */
923
789
 
924
790
  /**
925
- * @typedef SelfShipResult
791
+ * @typedef SelfShipResponse
926
792
  * @property {boolean} is_active
927
793
  * @property {number} tat
928
794
  */
929
795
 
930
796
  /**
931
797
  * @typedef ApplicationSelfShipConfig
932
- * @property {SelfShipResult} [self_ship]
798
+ * @property {Object} [self_ship]
933
799
  */
934
800
 
935
801
  /**
936
- * @typedef ApplicationSelfShipConfigResult
937
- * @property {ServiceabilityErrorResult} [error]
802
+ * @typedef ApplicationSelfShipConfigResponse
803
+ * @property {ServiceabilityErrorResponse} [error]
938
804
  * @property {ApplicationSelfShipConfig} [data]
939
805
  * @property {boolean} success
940
806
  */
941
807
 
942
808
  /**
943
809
  * @typedef StoreRuleConfigData
944
- * @property {string[]} [rule_ids] - List of rule ids which are active in the application.
945
- * @property {string[]} [type_based_priority] - Priority of the store type to be
946
- * used in the basic prioritization sorting of stores.
947
- * @property {string[]} [tag_based_priority] - Priority of the store tags to be
948
- * used in the basic prioritization sorting of stores.
949
- * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
950
- * stores to be used for sorting of stores.
951
- * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
810
+ * @property {string[]} [rule_ids]
811
+ * @property {string[]} [type_based_priority]
812
+ * @property {string[]} [tag_based_priority]
813
+ * @property {StorePrioritySchema[]} [store_priority]
814
+ * @property {string[]} [sort]
952
815
  */
953
816
 
954
817
  /**
@@ -977,87 +840,75 @@ const Joi = require("joi");
977
840
 
978
841
  /**
979
842
  * @typedef StoreRuleDataSchema
980
- * @property {string} [id] - Id of the rule.
981
- * @property {string} [name] - Name of the rule.
982
- * @property {number} [company_id] - Company id for which the rule is created.
983
- * @property {string} [application_id] - Application id for which the rule is created.
984
- * @property {string[]} [type_based_priority] - Priority of the store type to be
985
- * used in the basic prioritization sorting of stores.
986
- * @property {string[]} [tag_based_priority] - Priority of the store tags to be
987
- * used in the basic prioritization sorting of stores.
988
- * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
989
- * stores to be used for sorting of stores.
990
- * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
843
+ * @property {string} [id]
844
+ * @property {string} [name]
845
+ * @property {number} [company_id]
846
+ * @property {string} [application_id]
847
+ * @property {string[]} [type_based_priority]
848
+ * @property {string[]} [tag_based_priority]
849
+ * @property {StorePrioritySchema[]} [store_priority]
850
+ * @property {string[]} [sort]
991
851
  * @property {StoreRuleConditionSchema} [conditions]
992
- * @property {boolean} [is_active] - Denotes whether the rule is active or inactive.
852
+ * @property {boolean} [is_active]
993
853
  */
994
854
 
995
855
  /**
996
856
  * @typedef StorePrioritySchema
997
- * @property {number} [id] - Id of the store.
998
- * @property {string} [name] - Name of the store.
857
+ * @property {string} [id]
858
+ * @property {string} [name]
999
859
  */
1000
860
 
1001
861
  /**
1002
- * @typedef GetStoreRulesApiResult
862
+ * @typedef GetStoreRulesApiResponse
1003
863
  * @property {StoreRuleDataSchema[]} [items]
1004
864
  * @property {Page} [page]
1005
865
  */
1006
866
 
1007
867
  /**
1008
- * @typedef CreateStoreRuleDetailsSchema
1009
- * @property {string} [name] - Name of the rule.
1010
- * @property {boolean} [is_active] - Denotes if the rule is active or not.
868
+ * @typedef CreateStoreRuleRequestSchema
869
+ * @property {string} [name]
870
+ * @property {boolean} [is_active]
1011
871
  * @property {StoreRuleConditionSchema} [conditions]
1012
- * @property {string[]} [type_based_priority] - Priority of the store type to be
1013
- * used in the basic prioritization sorting of stores.
1014
- * @property {string[]} [tag_based_priority] - Priority of the store tags to be
1015
- * used in the basic prioritization sorting of stores.
1016
- * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
1017
- * stores to be used for sorting of stores.
1018
- * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
1019
- */
1020
-
1021
- /**
1022
- * @typedef StoreRuleResultSchema
1023
- * @property {string} [id] - Id of the rule created.
1024
- * @property {string} [name] - Name of the rule created.
1025
- * @property {string} [type] - Type of the rule created.
1026
- * @property {string[]} [type_based_priority] - Priority of the store type to be
1027
- * used in the rule for sorting of stores.
1028
- * @property {string[]} [tag_based_priority] - Priority of the store tags to be
1029
- * used in the rule for sorting of stores.
1030
- * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
1031
- * stores to be used for sorting of stores.
1032
- * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
872
+ * @property {string[]} [type_based_priority]
873
+ * @property {string[]} [tag_based_priority]
874
+ * @property {StorePrioritySchema[]} [store_priority]
875
+ * @property {string[]} [sort]
876
+ */
877
+
878
+ /**
879
+ * @typedef StoreRuleResponseSchema
880
+ * @property {string} [id]
881
+ * @property {string} [name]
882
+ * @property {string} [type]
883
+ * @property {string[]} [type_based_priority]
884
+ * @property {string[]} [tag_based_priority]
885
+ * @property {StorePrioritySchema[]} [store_priority]
886
+ * @property {string[]} [sort]
1033
887
  * @property {StoreRuleConditionSchema} [conditions]
1034
- * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
888
+ * @property {boolean} [is_active]
1035
889
  */
1036
890
 
1037
891
  /**
1038
- * @typedef StoreRuleUpdateResultSchema
1039
- * @property {string} [id] - Id of the rule created.
1040
- * @property {string} [name] - Name of the rule created.
1041
- * @property {string} [type] - Type of the rule created.
1042
- * @property {string[]} [type_based_priority] - Priority of the store type to be
1043
- * used in the rule for sorting of stores.
1044
- * @property {string[]} [tag_based_priority] - Priority of the store tags to be
1045
- * used in the rule for sorting of stores.
1046
- * @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
1047
- * stores to be used for sorting of stores.
1048
- * @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
892
+ * @typedef StoreRuleUpdateResponseSchema
893
+ * @property {string} [id]
894
+ * @property {string} [name]
895
+ * @property {string} [type]
896
+ * @property {string[]} [type_based_priority]
897
+ * @property {string[]} [tag_based_priority]
898
+ * @property {StorePrioritySchema[]} [store_priority]
899
+ * @property {string[]} [sort]
1049
900
  * @property {StoreRuleConditionSchema} [conditions]
1050
- * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
1051
- * @property {number} [company_id] - Company id for which the rule is created.
1052
- * @property {string} [application_id] - Application id for which the rule is created.
901
+ * @property {boolean} [is_active]
902
+ * @property {number} [company_id]
903
+ * @property {string} [application_id]
1053
904
  */
1054
905
 
1055
906
  /**
1056
907
  * @typedef ServiceabilityModel
1057
908
  * @property {number} lm_cod_limit
1058
909
  * @property {boolean} is_qc
1059
- * @property {string} [pickup_cutoff]
1060
- * @property {string} [route_code]
910
+ * @property {string} pickup_cutoff
911
+ * @property {string} route_code
1061
912
  * @property {boolean} is_first_mile
1062
913
  * @property {boolean} is_return
1063
914
  * @property {boolean} is_installation
@@ -1088,126 +939,102 @@ const Joi = require("joi");
1088
939
 
1089
940
  /**
1090
941
  * @typedef CourierPartnerSchemeModel
1091
- * @property {string} [name] - Name of the scheme.
1092
- * @property {string} extension_id - Unique identifier of courier partner extension.
1093
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
1094
- * @property {ArithmeticOperations} [volumetric_weight]
942
+ * @property {string} extension_id
943
+ * @property {string} scheme_id
1095
944
  * @property {ArithmeticOperations} weight
1096
- * @property {string} transport_type - Mode of transport associated with the
1097
- * courier partner scheme.
1098
- * @property {string} region - Serviceable region associated with the courier
1099
- * partner scheme.
1100
- * @property {string} delivery_type - Type of delivery associated with the
1101
- * courier partner scheme.
1102
- * @property {string[]} payment_mode - Mode of payment associated with the
1103
- * courier partner scheme.
1104
- * @property {string} stage - Denotes whether the courier partner scheme is in
1105
- * enabled or disabled stage.
945
+ * @property {string} transport_type
946
+ * @property {string} region
947
+ * @property {string} delivery_type
948
+ * @property {string[]} payment_mode
949
+ * @property {string} stage
1106
950
  * @property {CourierPartnerSchemeFeatures} feature
1107
951
  */
1108
952
 
1109
953
  /**
1110
- * @typedef CourierAccountResult
1111
- * @property {number} company_id - Company id associated with the account.
1112
- * @property {string} [extension_id] - Unique identifier of courier partner extension.
1113
- * @property {string} account_id - Unique identifier of courier partner scheme
1114
- * and company id combination.
1115
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
1116
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
1117
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
1118
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
1119
- * account or not.
1120
- * @property {CourierPartnerSchemeModel} [scheme_rules]
954
+ * @typedef CourierAccountResponse
955
+ * @property {string} account_id
956
+ * @property {string} scheme_id
957
+ * @property {boolean} is_self_ship
958
+ * @property {string} stage
959
+ * @property {boolean} is_own_account
960
+ * @property {CourierPartnerSchemeModel} scheme_rules
1121
961
  */
1122
962
 
1123
963
  /**
1124
- * @typedef CompanyCourierPartnerAccountListResult
1125
- * @property {CourierAccountResult[]} items
964
+ * @typedef CompanyCourierPartnerAccountListResponse
965
+ * @property {CourierAccountResponse[]} items
1126
966
  * @property {Page} page
1127
967
  */
1128
968
 
1129
969
  /**
1130
970
  * @typedef PackageMaterial
1131
- * @property {string} name - Name of the packaging material.
1132
- * @property {number} width - Width of the packaging material dimentions in centimeter.
1133
- * @property {number} height - Height of the packaging material dimentions in centimeter.
1134
- * @property {number} length - Length of the packaging material dimentions in centimeter.
1135
- * @property {PackageMaterialRule[]} [rules] - Product group rules associated
1136
- * with the packaging.
1137
- * @property {number[]} store_ids - Store ids where the packaging is avaiable.
1138
- * @property {number} weight - Package's weight in gram.
1139
- * @property {number} error_rate - Error Rate associated with the packaging dimensions.
1140
- * @property {string} package_type - Type of package material.
1141
- * @property {string} size - Physical size of the packaging.
1142
- * @property {string[]} [media] - Image urls associated with the packaging material.
1143
- * @property {Channel[]} channels - Sales channel where packaging is applicable.
1144
- * @property {boolean} [track_inventory] - Denotes if the track of the inventory
1145
- * should be kept.
1146
- * @property {string} status - Current status of the packaging material, if it
1147
- * is active or inactive.
1148
- * @property {number} [max_weight] - Maximum weight holding capacity.
1149
- * @property {number} [package_vol_weight] - Volumetric weight that a packaging
1150
- * material can carry.
1151
- * @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
1152
- * should be auto calculated or not.
1153
- */
1154
-
1155
- /**
1156
- * @typedef PackageMaterialResult
1157
- * @property {string} name - Name of the packaging material.
1158
- * @property {string} [id] - Id of the packaging material.
1159
- * @property {number} [item_id] - Unique identifier of an item associated with
1160
- * the packaging material.
1161
- * @property {number} [company_id] - Company id associated with the packaging material.
1162
- * @property {number} width - Width of the packaging material dimentions in centimeter.
1163
- * @property {number} height - Height of the packaging material dimentions in centimeter.
1164
- * @property {number} length - Length of the packaging material dimentions in centimeter.
1165
- * @property {PackageMaterialRule[]} [rules] - Product group rules associated
1166
- * with the packaging.
1167
- * @property {number[]} store_ids - Store ids where the packaging is avaiable.
1168
- * @property {number} weight - Package's weight in gram.
1169
- * @property {number} error_rate - Error Rate associated with the packaging dimensions.
1170
- * @property {string} package_type - Type of package material.
1171
- * @property {string} size - Physical size of the packaging.
1172
- * @property {string[]} [media] - Image urls associated with the packaging material.
1173
- * @property {Channel[]} channels - Sales channel where packaging is applicable.
1174
- * @property {boolean} [track_inventory] - Denotes if the track of the inventory
1175
- * should be kept.
1176
- * @property {string} status - Current status of the packaging material, if it
1177
- * is active or inactive.
1178
- * @property {number} [max_weight] - Maximum weight holding capacity.
1179
- * @property {number} [package_vol_weight] - Volumetric weight that a packaging
1180
- * material can carry.
1181
- * @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
1182
- * should be auto calculated or not.
971
+ * @property {string} name
972
+ * @property {number} width
973
+ * @property {number} height
974
+ * @property {number} length
975
+ * @property {PackageMaterialRule[]} [rules]
976
+ * @property {number[]} store_ids
977
+ * @property {number} weight
978
+ * @property {number} error_rate
979
+ * @property {string} package_type
980
+ * @property {string} size
981
+ * @property {string[]} [media]
982
+ * @property {Channel[]} channels
983
+ * @property {boolean} [track_inventory]
984
+ * @property {string} status
985
+ * @property {number} [max_weight]
986
+ * @property {number} [package_vol_weight]
987
+ * @property {boolean} [auto_calculate]
988
+ */
989
+
990
+ /**
991
+ * @typedef PackageMaterialResponse
992
+ * @property {string} name
993
+ * @property {string} [id]
994
+ * @property {number} [item_id]
995
+ * @property {number} width
996
+ * @property {number} height
997
+ * @property {number} length
998
+ * @property {PackageMaterialRule[]} [rules]
999
+ * @property {number[]} store_ids
1000
+ * @property {number} weight
1001
+ * @property {number} error_rate
1002
+ * @property {string} package_type
1003
+ * @property {string} size
1004
+ * @property {string[]} [media]
1005
+ * @property {Channel[]} channels
1006
+ * @property {boolean} [track_inventory]
1007
+ * @property {string} status
1008
+ * @property {number} [max_weight]
1009
+ * @property {number} [package_vol_weight]
1010
+ * @property {boolean} [auto_calculate]
1183
1011
  */
1184
1012
 
1185
1013
  /**
1186
1014
  * @typedef PackageMaterialRule
1187
- * @property {string} [rule_id] - Unique identifier of the package rule.
1015
+ * @property {string} [rule_id]
1188
1016
  * @property {PackageMaterialRuleQuantity} [quantity]
1189
- * @property {number} [weight] - Volumetric weight in gram.
1017
+ * @property {number} [weight]
1190
1018
  */
1191
1019
 
1192
1020
  /**
1193
1021
  * @typedef PackageRule
1194
- * @property {string} name - Name of the package rule.
1195
- * @property {number} company_id - Unique identifier of the company.
1196
- * @property {string} type - Type of the rule.
1197
- * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
1022
+ * @property {string} name
1023
+ * @property {number} company_id
1024
+ * @property {string} type
1025
+ * @property {boolean} [is_active]
1198
1026
  * @property {PackageRuleProductTag} [product_tag]
1199
1027
  * @property {PackageRuleProduct} [product_id]
1200
1028
  * @property {PackageRuleCategory} [category_id]
1201
1029
  */
1202
1030
 
1203
1031
  /**
1204
- * @typedef PackageRuleResult
1205
- * @property {string} [id] - Unique id of a package rule.
1206
- * @property {string} name - Name of a package rule.
1207
- * @property {number} company_id - Unique identifier of a company associated
1208
- * with the package rule.
1209
- * @property {string} type - Type of the rule created.
1210
- * @property {boolean} [is_active] - Denotes if the rule is active or inactive.
1032
+ * @typedef PackageRuleResponse
1033
+ * @property {string} [id]
1034
+ * @property {string} name
1035
+ * @property {number} company_id
1036
+ * @property {string} type
1037
+ * @property {boolean} [is_active]
1211
1038
  * @property {PackageRuleProductTag} [product_tag]
1212
1039
  * @property {PackageRuleProduct} [product_id]
1213
1040
  * @property {PackageRuleCategory} [category_id]
@@ -1215,19 +1042,19 @@ const Joi = require("joi");
1215
1042
 
1216
1043
  /**
1217
1044
  * @typedef Channel
1218
- * @property {string} [type] - Type of the channel.
1219
- * @property {string} [id] - Unique identifier of the channel.
1045
+ * @property {string} [type]
1046
+ * @property {string} [id]
1220
1047
  */
1221
1048
 
1222
1049
  /**
1223
1050
  * @typedef PackageMaterialRuleList
1224
- * @property {PackageRuleResult} [items]
1051
+ * @property {PackageRuleResponse} [items]
1225
1052
  * @property {Page} [page]
1226
1053
  */
1227
1054
 
1228
1055
  /**
1229
1056
  * @typedef PackageMaterialList
1230
- * @property {PackageMaterialResult} [items]
1057
+ * @property {PackageMaterialResponse} [items]
1231
1058
  * @property {Page} [page]
1232
1059
  */
1233
1060
 
@@ -1248,20 +1075,19 @@ const Joi = require("joi");
1248
1075
 
1249
1076
  /**
1250
1077
  * @typedef PackageMaterialRuleQuantity
1251
- * @property {number} [min] - Minimum product's quantity that a packaging can contain.
1252
- * @property {number} [max] - Maximum product's quantity that a packaging can contain.
1078
+ * @property {number} [min]
1079
+ * @property {number} [max]
1253
1080
  */
1254
1081
 
1255
1082
  /**
1256
- * @typedef RulePriorityDetails
1257
- * @property {string} rule_id - Rule id whose priority needs to be changed.
1258
- * @property {number} priority - New priority of the rule.
1083
+ * @typedef RulePriorityRequest
1084
+ * @property {string} rule_id
1085
+ * @property {number} priority
1259
1086
  */
1260
1087
 
1261
1088
  /**
1262
- * @typedef RulePriorityResult
1263
- * @property {boolean} [success] - Denotes if the priority of the rule is
1264
- * changes successfully or not.
1089
+ * @typedef RulePriorityResponse
1090
+ * @property {boolean} [success]
1265
1091
  */
1266
1092
 
1267
1093
  /**
@@ -1292,7 +1118,7 @@ const Joi = require("joi");
1292
1118
  * @typedef OptimalLocationsArticles
1293
1119
  * @property {number} item_id
1294
1120
  * @property {string} size
1295
- * @property {number} quantity
1121
+ * @property {string} quantity
1296
1122
  * @property {string} [group_id]
1297
1123
  * @property {boolean} [is_primary_item]
1298
1124
  * @property {Object} [meta]
@@ -1303,16 +1129,16 @@ const Joi = require("joi");
1303
1129
  */
1304
1130
 
1305
1131
  /**
1306
- * @typedef OptimlLocationsDetailsSchema
1132
+ * @typedef OptimlLocationsRequestSchema
1307
1133
  * @property {string} channel_id
1308
1134
  * @property {string} channel_type
1309
1135
  * @property {string} [channel_identifier]
1310
1136
  * @property {LocationDetailsServiceability} to_serviceability
1311
- * @property {OptimalLocationsArticles[]} [articles]
1137
+ * @property {OptimalLocationsArticles} [article]
1312
1138
  */
1313
1139
 
1314
1140
  /**
1315
- * @typedef OptimalLocationArticlesResult
1141
+ * @typedef OptimalLocationArticlesResponse
1316
1142
  * @property {number} item_id
1317
1143
  * @property {string} size
1318
1144
  * @property {number} quantity
@@ -1330,38 +1156,27 @@ const Joi = require("joi");
1330
1156
  */
1331
1157
 
1332
1158
  /**
1333
- * @typedef OptimalLocationAssignedStoresResult
1159
+ * @typedef OptimalLocationAssignedStoresResponse
1334
1160
  * @property {number} store_id
1335
- * @property {OptimalLocationArticlesResult[]} articles
1336
- */
1337
-
1338
- /**
1339
- * @typedef OptimalLocationsResult
1340
- * @property {OptimalLocationAssignedStoresResult[]} assigned_stores
1341
- * @property {ErrorResult[]} [faulty_articles]
1342
- */
1343
-
1344
- /**
1345
- * @typedef ValidationError
1346
- * @property {string} message - A brief description of the error encountered.
1347
- * @property {string} field - The field in the request that caused the error.
1161
+ * @property {OptimalLocationArticlesResponse[]} articles
1348
1162
  */
1349
1163
 
1350
1164
  /**
1351
- * @typedef StandardError
1352
- * @property {string} message - A brief description of the error.
1165
+ * @typedef OptimalLocationsResponse
1166
+ * @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
1167
+ * @property {ErrorResponse[]} [faulty_articles]
1353
1168
  */
1354
1169
 
1355
1170
  class ServiceabilityPlatformModel {
1356
- /** @returns {UpdateZoneConfigDetails} */
1357
- static UpdateZoneConfigDetails() {
1171
+ /** @returns {UpdateZoneConfigRequest} */
1172
+ static UpdateZoneConfigRequest() {
1358
1173
  return Joi.object({
1359
1174
  serviceability_type: Joi.string().allow(""),
1360
1175
  });
1361
1176
  }
1362
1177
 
1363
- /** @returns {ServiceabilityErrorResult} */
1364
- static ServiceabilityErrorResult() {
1178
+ /** @returns {ServiceabilityErrorResponse} */
1179
+ static ServiceabilityErrorResponse() {
1365
1180
  return Joi.object({
1366
1181
  message: Joi.string().allow("").required(),
1367
1182
  value: Joi.string().allow("").required(),
@@ -1378,17 +1193,17 @@ class ServiceabilityPlatformModel {
1378
1193
  });
1379
1194
  }
1380
1195
 
1381
- /** @returns {ApplicationServiceabilityConfigResult} */
1382
- static ApplicationServiceabilityConfigResult() {
1196
+ /** @returns {ApplicationServiceabilityConfigResponse} */
1197
+ static ApplicationServiceabilityConfigResponse() {
1383
1198
  return Joi.object({
1384
- error: ServiceabilityPlatformModel.ServiceabilityErrorResult(),
1199
+ error: ServiceabilityPlatformModel.ServiceabilityErrorResponse(),
1385
1200
  data: ServiceabilityPlatformModel.ApplicationServiceabilityConfig(),
1386
1201
  success: Joi.boolean().required(),
1387
1202
  });
1388
1203
  }
1389
1204
 
1390
- /** @returns {EntityRegionView_Details} */
1391
- static EntityRegionView_Details() {
1205
+ /** @returns {EntityRegionView_Request} */
1206
+ static EntityRegionView_Request() {
1392
1207
  return Joi.object({
1393
1208
  sub_type: Joi.array().items(Joi.string().allow("")).required(),
1394
1209
  parent_id: Joi.array().items(Joi.string().allow("")),
@@ -1415,8 +1230,8 @@ class ServiceabilityPlatformModel {
1415
1230
  });
1416
1231
  }
1417
1232
 
1418
- /** @returns {getAppRegionZonesResult} */
1419
- static getAppRegionZonesResult() {
1233
+ /** @returns {getAppRegionZonesResponse} */
1234
+ static getAppRegionZonesResponse() {
1420
1235
  return Joi.object({
1421
1236
  page: Joi.array()
1422
1237
  .items(ServiceabilityPlatformModel.PageSchema())
@@ -1447,8 +1262,8 @@ class ServiceabilityPlatformModel {
1447
1262
  });
1448
1263
  }
1449
1264
 
1450
- /** @returns {EntityRegionView_Result} */
1451
- static EntityRegionView_Result() {
1265
+ /** @returns {EntityRegionView_Response} */
1266
+ static EntityRegionView_Response() {
1452
1267
  return Joi.object({
1453
1268
  error: ServiceabilityPlatformModel.EntityRegionView_Error().required(),
1454
1269
  page: ServiceabilityPlatformModel.EntityRegionView_page().required(),
@@ -1512,8 +1327,8 @@ class ServiceabilityPlatformModel {
1512
1327
  });
1513
1328
  }
1514
1329
 
1515
- /** @returns {ListViewResult} */
1516
- static ListViewResult() {
1330
+ /** @returns {ListViewResponse} */
1331
+ static ListViewResponse() {
1517
1332
  return Joi.object({
1518
1333
  page: ServiceabilityPlatformModel.ZoneDataItem().required(),
1519
1334
  items: Joi.array()
@@ -1533,8 +1348,8 @@ class ServiceabilityPlatformModel {
1533
1348
  });
1534
1349
  }
1535
1350
 
1536
- /** @returns {CompanyStoreView_Result} */
1537
- static CompanyStoreView_Result() {
1351
+ /** @returns {CompanyStoreView_Response} */
1352
+ static CompanyStoreView_Response() {
1538
1353
  return Joi.object({
1539
1354
  page: Joi.array()
1540
1355
  .items(ServiceabilityPlatformModel.CompanyStoreView_PageItems())
@@ -1608,16 +1423,16 @@ class ServiceabilityPlatformModel {
1608
1423
  });
1609
1424
  }
1610
1425
 
1611
- /** @returns {ZoneUpdateDetails} */
1612
- static ZoneUpdateDetails() {
1426
+ /** @returns {ZoneUpdateRequest} */
1427
+ static ZoneUpdateRequest() {
1613
1428
  return Joi.object({
1614
1429
  identifier: Joi.string().allow("").required(),
1615
1430
  data: ServiceabilityPlatformModel.UpdateZoneData().required(),
1616
1431
  });
1617
1432
  }
1618
1433
 
1619
- /** @returns {ZoneSuccessResult} */
1620
- static ZoneSuccessResult() {
1434
+ /** @returns {ZoneSuccessResponse} */
1435
+ static ZoneSuccessResponse() {
1621
1436
  return Joi.object({
1622
1437
  status_code: Joi.number().required(),
1623
1438
  success: Joi.boolean().required(),
@@ -1641,13 +1456,12 @@ class ServiceabilityPlatformModel {
1641
1456
  mapping: Joi.array()
1642
1457
  .items(ServiceabilityPlatformModel.ZoneMappingType())
1643
1458
  .required(),
1644
- assignment_preference: Joi.string().allow(""),
1645
1459
  stores_count: Joi.number().required(),
1646
1460
  });
1647
1461
  }
1648
1462
 
1649
- /** @returns {GetSingleZoneDataViewResult} */
1650
- static GetSingleZoneDataViewResult() {
1463
+ /** @returns {GetSingleZoneDataViewResponse} */
1464
+ static GetSingleZoneDataViewResponse() {
1651
1465
  return Joi.object({
1652
1466
  data: ServiceabilityPlatformModel.GetZoneDataViewItems().required(),
1653
1467
  });
@@ -1670,7 +1484,6 @@ class ServiceabilityPlatformModel {
1670
1484
  mapping: Joi.array()
1671
1485
  .items(ServiceabilityPlatformModel.ZoneMappingDetailType())
1672
1486
  .required(),
1673
- stores_count: Joi.number(),
1674
1487
  });
1675
1488
  }
1676
1489
 
@@ -1685,25 +1498,25 @@ class ServiceabilityPlatformModel {
1685
1498
  .items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
1686
1499
  .required(),
1687
1500
  store_ids: Joi.array().items(Joi.number()).required(),
1501
+ product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
1688
1502
  region_type: Joi.string().allow("").required(),
1689
1503
  mapping: Joi.array()
1690
1504
  .items(ServiceabilityPlatformModel.ZoneMappingType())
1691
1505
  .required(),
1692
- product: ServiceabilityPlatformModel.ZoneProductTypes(),
1693
1506
  });
1694
1507
  }
1695
1508
 
1696
- /** @returns {ZoneResult} */
1697
- static ZoneResult() {
1509
+ /** @returns {ZoneResponse} */
1510
+ static ZoneResponse() {
1698
1511
  return Joi.object({
1699
- status_code: Joi.number(),
1512
+ status_code: Joi.number().required(),
1700
1513
  zone_id: Joi.string().allow("").required(),
1701
1514
  success: Joi.boolean().required(),
1702
1515
  });
1703
1516
  }
1704
1517
 
1705
- /** @returns {GetZoneFromPincodeViewDetails} */
1706
- static GetZoneFromPincodeViewDetails() {
1518
+ /** @returns {GetZoneFromPincodeViewRequest} */
1519
+ static GetZoneFromPincodeViewRequest() {
1707
1520
  return Joi.object({
1708
1521
  country: Joi.string().allow("").required(),
1709
1522
  pincode: Joi.string().allow("").required(),
@@ -1723,16 +1536,16 @@ class ServiceabilityPlatformModel {
1723
1536
  });
1724
1537
  }
1725
1538
 
1726
- /** @returns {GetZoneFromPincodeViewResult} */
1727
- static GetZoneFromPincodeViewResult() {
1539
+ /** @returns {GetZoneFromPincodeViewResponse} */
1540
+ static GetZoneFromPincodeViewResponse() {
1728
1541
  return Joi.object({
1729
1542
  serviceability_type: Joi.string().allow("").required(),
1730
1543
  zones: Joi.array().items(ServiceabilityPlatformModel.Zone()).required(),
1731
1544
  });
1732
1545
  }
1733
1546
 
1734
- /** @returns {GetZoneFromApplicationIdViewResult} */
1735
- static GetZoneFromApplicationIdViewResult() {
1547
+ /** @returns {GetZoneFromApplicationIdViewResponse} */
1548
+ static GetZoneFromApplicationIdViewResponse() {
1736
1549
  return Joi.object({
1737
1550
  page: Joi.array()
1738
1551
  .items(ServiceabilityPlatformModel.ZoneDataItem())
@@ -1743,8 +1556,8 @@ class ServiceabilityPlatformModel {
1743
1556
  });
1744
1557
  }
1745
1558
 
1746
- /** @returns {ServiceabilityPageResult} */
1747
- static ServiceabilityPageResult() {
1559
+ /** @returns {ServiceabilityPageResponse} */
1560
+ static ServiceabilityPageResponse() {
1748
1561
  return Joi.object({
1749
1562
  type: Joi.string().allow(""),
1750
1563
  has_next: Joi.boolean(),
@@ -1762,8 +1575,8 @@ class ServiceabilityPlatformModel {
1762
1575
  });
1763
1576
  }
1764
1577
 
1765
- /** @returns {ManagerResult} */
1766
- static ManagerResult() {
1578
+ /** @returns {ManagerResponse} */
1579
+ static ManagerResponse() {
1767
1580
  return Joi.object({
1768
1581
  email: Joi.string().allow(""),
1769
1582
  mobile_no: ServiceabilityPlatformModel.MobileNo(),
@@ -1771,39 +1584,39 @@ class ServiceabilityPlatformModel {
1771
1584
  });
1772
1585
  }
1773
1586
 
1774
- /** @returns {ModifiedByResult} */
1775
- static ModifiedByResult() {
1587
+ /** @returns {ModifiedByResponse} */
1588
+ static ModifiedByResponse() {
1776
1589
  return Joi.object({
1777
1590
  username: Joi.string().allow(""),
1778
1591
  user_id: Joi.string().allow(""),
1779
1592
  });
1780
1593
  }
1781
1594
 
1782
- /** @returns {IntegrationTypeResult} */
1783
- static IntegrationTypeResult() {
1595
+ /** @returns {IntegrationTypeResponse} */
1596
+ static IntegrationTypeResponse() {
1784
1597
  return Joi.object({
1785
1598
  inventory: Joi.string().allow(""),
1786
1599
  order: Joi.string().allow(""),
1787
1600
  });
1788
1601
  }
1789
1602
 
1790
- /** @returns {ProductReturnConfigResult} */
1791
- static ProductReturnConfigResult() {
1603
+ /** @returns {ProductReturnConfigResponse} */
1604
+ static ProductReturnConfigResponse() {
1792
1605
  return Joi.object({
1793
1606
  on_same_store: Joi.boolean(),
1794
1607
  });
1795
1608
  }
1796
1609
 
1797
- /** @returns {ContactNumberResult} */
1798
- static ContactNumberResult() {
1610
+ /** @returns {ContactNumberResponse} */
1611
+ static ContactNumberResponse() {
1799
1612
  return Joi.object({
1800
1613
  number: Joi.string().allow(""),
1801
1614
  country_code: Joi.number(),
1802
1615
  });
1803
1616
  }
1804
1617
 
1805
- /** @returns {AddressResult} */
1806
- static AddressResult() {
1618
+ /** @returns {AddressResponse} */
1619
+ static AddressResponse() {
1807
1620
  return Joi.object({
1808
1621
  city: Joi.string().allow(""),
1809
1622
  address1: Joi.string().allow(""),
@@ -1817,38 +1630,38 @@ class ServiceabilityPlatformModel {
1817
1630
  });
1818
1631
  }
1819
1632
 
1820
- /** @returns {CreatedByResult} */
1821
- static CreatedByResult() {
1633
+ /** @returns {CreatedByResponse} */
1634
+ static CreatedByResponse() {
1822
1635
  return Joi.object({
1823
1636
  username: Joi.string().allow(""),
1824
1637
  user_id: Joi.string().allow(""),
1825
1638
  });
1826
1639
  }
1827
1640
 
1828
- /** @returns {EwayBillResult} */
1829
- static EwayBillResult() {
1641
+ /** @returns {EwayBillResponse} */
1642
+ static EwayBillResponse() {
1830
1643
  return Joi.object({
1831
1644
  enabled: Joi.boolean(),
1832
1645
  });
1833
1646
  }
1834
1647
 
1835
- /** @returns {EinvoiceResult} */
1836
- static EinvoiceResult() {
1648
+ /** @returns {EinvoiceResponse} */
1649
+ static EinvoiceResponse() {
1837
1650
  return Joi.object({
1838
1651
  enabled: Joi.boolean(),
1839
1652
  });
1840
1653
  }
1841
1654
 
1842
- /** @returns {GstCredentialsResult} */
1843
- static GstCredentialsResult() {
1655
+ /** @returns {GstCredentialsResponse} */
1656
+ static GstCredentialsResponse() {
1844
1657
  return Joi.object({
1845
- e_waybill: ServiceabilityPlatformModel.EwayBillResult(),
1846
- e_invoice: ServiceabilityPlatformModel.EinvoiceResult(),
1658
+ e_waybill: ServiceabilityPlatformModel.EwayBillResponse(),
1659
+ e_invoice: ServiceabilityPlatformModel.EinvoiceResponse(),
1847
1660
  });
1848
1661
  }
1849
1662
 
1850
- /** @returns {WarningsResult} */
1851
- static WarningsResult() {
1663
+ /** @returns {WarningsResponse} */
1664
+ static WarningsResponse() {
1852
1665
  return Joi.object({
1853
1666
  store_address: Joi.string().allow(""),
1854
1667
  });
@@ -1862,8 +1675,8 @@ class ServiceabilityPlatformModel {
1862
1675
  });
1863
1676
  }
1864
1677
 
1865
- /** @returns {TimmingResult} */
1866
- static TimmingResult() {
1678
+ /** @returns {TimmingResponse} */
1679
+ static TimmingResponse() {
1867
1680
  return Joi.object({
1868
1681
  open: Joi.boolean(),
1869
1682
  weekday: Joi.string().allow(""),
@@ -1872,8 +1685,8 @@ class ServiceabilityPlatformModel {
1872
1685
  });
1873
1686
  }
1874
1687
 
1875
- /** @returns {DocumentsResult} */
1876
- static DocumentsResult() {
1688
+ /** @returns {DocumentsResponse} */
1689
+ static DocumentsResponse() {
1877
1690
  return Joi.object({
1878
1691
  legal_name: Joi.string().allow(""),
1879
1692
  value: Joi.string().allow(""),
@@ -1898,57 +1711,57 @@ class ServiceabilityPlatformModel {
1898
1711
  });
1899
1712
  }
1900
1713
 
1901
- /** @returns {LogisticsResult} */
1902
- static LogisticsResult() {
1714
+ /** @returns {LogisticsResponse} */
1715
+ static LogisticsResponse() {
1903
1716
  return Joi.object({
1904
1717
  override: Joi.boolean(),
1905
1718
  dp: ServiceabilityPlatformModel.Dp(),
1906
1719
  });
1907
1720
  }
1908
1721
 
1909
- /** @returns {ItemResult} */
1910
- static ItemResult() {
1722
+ /** @returns {ItemResponse} */
1723
+ static ItemResponse() {
1911
1724
  return Joi.object({
1912
1725
  created_on: Joi.string().allow(""),
1913
- manager: ServiceabilityPlatformModel.ManagerResult(),
1914
- modified_by: ServiceabilityPlatformModel.ModifiedByResult(),
1915
- integration_type: ServiceabilityPlatformModel.IntegrationTypeResult(),
1726
+ manager: ServiceabilityPlatformModel.ManagerResponse(),
1727
+ modified_by: ServiceabilityPlatformModel.ModifiedByResponse(),
1728
+ integration_type: ServiceabilityPlatformModel.IntegrationTypeResponse(),
1916
1729
  verified_on: Joi.string().allow(""),
1917
- product_return_config: ServiceabilityPlatformModel.ProductReturnConfigResult(),
1730
+ product_return_config: ServiceabilityPlatformModel.ProductReturnConfigResponse(),
1918
1731
  contact_numbers: Joi.array().items(
1919
- ServiceabilityPlatformModel.ContactNumberResult()
1732
+ ServiceabilityPlatformModel.ContactNumberResponse()
1920
1733
  ),
1921
- verified_by: ServiceabilityPlatformModel.ModifiedByResult(),
1734
+ verified_by: ServiceabilityPlatformModel.ModifiedByResponse(),
1922
1735
  stage: Joi.string().allow(""),
1923
- address: ServiceabilityPlatformModel.AddressResult(),
1736
+ address: ServiceabilityPlatformModel.AddressResponse(),
1924
1737
  modified_on: Joi.string().allow(""),
1925
- created_by: ServiceabilityPlatformModel.CreatedByResult(),
1926
- gst_credentials: ServiceabilityPlatformModel.GstCredentialsResult(),
1738
+ created_by: ServiceabilityPlatformModel.CreatedByResponse(),
1739
+ gst_credentials: ServiceabilityPlatformModel.GstCredentialsResponse(),
1927
1740
  display_name: Joi.string().allow(""),
1928
1741
  company_id: Joi.number(),
1929
1742
  uid: Joi.number(),
1930
- _custom_json: Joi.object().pattern(/\S/, Joi.any()),
1743
+ _custom_json: Joi.any(),
1931
1744
  code: Joi.string().allow(""),
1932
- warnings: ServiceabilityPlatformModel.WarningsResult(),
1745
+ warnings: ServiceabilityPlatformModel.WarningsResponse(),
1933
1746
  name: Joi.string().allow(""),
1934
- timing: Joi.array().items(ServiceabilityPlatformModel.TimmingResult()),
1747
+ timing: Joi.array().items(ServiceabilityPlatformModel.TimmingResponse()),
1935
1748
  documents: Joi.array().items(
1936
- ServiceabilityPlatformModel.DocumentsResult()
1749
+ ServiceabilityPlatformModel.DocumentsResponse()
1937
1750
  ),
1938
1751
  store_type: Joi.string().allow(""),
1939
1752
  sub_type: Joi.string().allow(""),
1940
1753
  company: Joi.number(),
1941
1754
  _cls: Joi.string().allow(""),
1942
- logistics: ServiceabilityPlatformModel.LogisticsResult(),
1755
+ logistics: ServiceabilityPlatformModel.LogisticsResponse(),
1943
1756
  notification_emails: Joi.array().items(Joi.string().allow("")),
1944
1757
  });
1945
1758
  }
1946
1759
 
1947
- /** @returns {GetStoresViewResult} */
1948
- static GetStoresViewResult() {
1760
+ /** @returns {GetStoresViewResponse} */
1761
+ static GetStoresViewResponse() {
1949
1762
  return Joi.object({
1950
- page: ServiceabilityPlatformModel.ServiceabilityPageResult().required(),
1951
- items: Joi.array().items(ServiceabilityPlatformModel.ItemResult()),
1763
+ page: ServiceabilityPlatformModel.ServiceabilityPageResponse().required(),
1764
+ items: Joi.array().items(ServiceabilityPlatformModel.ItemResponse()),
1952
1765
  });
1953
1766
  }
1954
1767
 
@@ -1961,8 +1774,8 @@ class ServiceabilityPlatformModel {
1961
1774
  });
1962
1775
  }
1963
1776
 
1964
- /** @returns {PincodeMopUpdateResult} */
1965
- static PincodeMopUpdateResult() {
1777
+ /** @returns {PincodeMopUpdateResponse} */
1778
+ static PincodeMopUpdateResponse() {
1966
1779
  return Joi.object({
1967
1780
  pincode: Joi.number().required(),
1968
1781
  channel_id: Joi.string().allow("").required(),
@@ -1971,8 +1784,8 @@ class ServiceabilityPlatformModel {
1971
1784
  });
1972
1785
  }
1973
1786
 
1974
- /** @returns {PincodeMOPResult} */
1975
- static PincodeMOPResult() {
1787
+ /** @returns {PincodeMOPresponse} */
1788
+ static PincodeMOPresponse() {
1976
1789
  return Joi.object({
1977
1790
  success: Joi.boolean().required(),
1978
1791
  status_code: Joi.number().required(),
@@ -1981,7 +1794,7 @@ class ServiceabilityPlatformModel {
1981
1794
  action: Joi.string().allow("").required(),
1982
1795
  pincodes: Joi.array().items(Joi.number()),
1983
1796
  updated_pincodes: Joi.array().items(
1984
- ServiceabilityPlatformModel.PincodeMopUpdateResult()
1797
+ ServiceabilityPlatformModel.PincodeMopUpdateResponse()
1985
1798
  ),
1986
1799
  });
1987
1800
  }
@@ -2003,16 +1816,16 @@ class ServiceabilityPlatformModel {
2003
1816
  });
2004
1817
  }
2005
1818
 
2006
- /** @returns {PincodeBulkViewResult} */
2007
- static PincodeBulkViewResult() {
1819
+ /** @returns {PincodeBulkViewResponse} */
1820
+ static PincodeBulkViewResponse() {
2008
1821
  return Joi.object({
2009
1822
  batch_id: Joi.string().allow("").required(),
2010
1823
  s3_url: Joi.string().allow("").required(),
2011
1824
  });
2012
1825
  }
2013
1826
 
2014
- /** @returns {PincodeCodStatusListingDetails} */
2015
- static PincodeCodStatusListingDetails() {
1827
+ /** @returns {PincodeCodStatusListingRequest} */
1828
+ static PincodeCodStatusListingRequest() {
2016
1829
  return Joi.object({
2017
1830
  country: Joi.string().allow(""),
2018
1831
  is_active: Joi.boolean(),
@@ -2022,26 +1835,18 @@ class ServiceabilityPlatformModel {
2022
1835
  });
2023
1836
  }
2024
1837
 
2025
- /** @returns {PincodeCodStatusItem} */
2026
- static PincodeCodStatusItem() {
2027
- return Joi.object({
2028
- active: Joi.boolean(),
2029
- pincode: Joi.string().allow(""),
2030
- });
2031
- }
2032
-
2033
- /** @returns {PincodeCodStatusListingResult} */
2034
- static PincodeCodStatusListingResult() {
1838
+ /** @returns {PincodeCodStatusListingResponse} */
1839
+ static PincodeCodStatusListingResponse() {
2035
1840
  return Joi.object({
2036
1841
  country: Joi.string().allow("").required(),
2037
1842
  data: Joi.array()
2038
- .items(Joi.link("#PincodeCodStatusListingResult"))
1843
+ .items(Joi.link("#PincodeCodStatusListingResponse"))
2039
1844
  .required(),
2040
1845
  success: Joi.boolean().required(),
2041
1846
  errors: Joi.array().items(ServiceabilityPlatformModel.Error()),
2042
1847
  page: ServiceabilityPlatformModel.PincodeCodStatusListingPage().required(),
2043
1848
  summary: ServiceabilityPlatformModel.PincodeCodStatusListingSummary().required(),
2044
- }).id("PincodeCodStatusListingResult");
1849
+ }).id("PincodeCodStatusListingResponse");
2045
1850
  }
2046
1851
 
2047
1852
  /** @returns {Error} */
@@ -2072,8 +1877,8 @@ class ServiceabilityPlatformModel {
2072
1877
  });
2073
1878
  }
2074
1879
 
2075
- /** @returns {PincodeMopUpdateAuditHistoryDetails} */
2076
- static PincodeMopUpdateAuditHistoryDetails() {
1880
+ /** @returns {PincodeMopUpdateAuditHistoryRequest} */
1881
+ static PincodeMopUpdateAuditHistoryRequest() {
2077
1882
  return Joi.object({
2078
1883
  entity_type: Joi.string().allow("").required(),
2079
1884
  file_name: Joi.string().allow(""),
@@ -2091,8 +1896,8 @@ class ServiceabilityPlatformModel {
2091
1896
  });
2092
1897
  }
2093
1898
 
2094
- /** @returns {PincodeMopUpdateAuditHistoryResult} */
2095
- static PincodeMopUpdateAuditHistoryResult() {
1899
+ /** @returns {PincodeMopUpdateAuditHistoryResponse} */
1900
+ static PincodeMopUpdateAuditHistoryResponse() {
2096
1901
  return Joi.object({
2097
1902
  batch_id: Joi.string().allow(""),
2098
1903
  entity_type: Joi.string().allow(""),
@@ -2105,13 +1910,15 @@ class ServiceabilityPlatformModel {
2105
1910
  });
2106
1911
  }
2107
1912
 
2108
- /** @returns {PincodeMopUpdateAuditHistoryResultData} */
2109
- static PincodeMopUpdateAuditHistoryResultData() {
1913
+ /** @returns {PincodeMopUpdateAuditHistoryResponseData} */
1914
+ static PincodeMopUpdateAuditHistoryResponseData() {
2110
1915
  return Joi.object({
2111
1916
  entity_type: Joi.string().allow(""),
2112
1917
  page: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryPaging().required(),
2113
1918
  data: Joi.array()
2114
- .items(ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResult())
1919
+ .items(
1920
+ ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResponse()
1921
+ )
2115
1922
  .required(),
2116
1923
  });
2117
1924
  }
@@ -2150,33 +1957,20 @@ class ServiceabilityPlatformModel {
2150
1957
  });
2151
1958
  }
2152
1959
 
2153
- /** @returns {CourierAccountUpdateDetails} */
2154
- static CourierAccountUpdateDetails() {
2155
- return Joi.object({
2156
- extension_id: Joi.string().allow("").required(),
2157
- scheme_id: Joi.string().allow("").required(),
2158
- is_self_ship: Joi.boolean().required(),
2159
- stage: Joi.string().allow("").required(),
2160
- is_own_account: Joi.boolean().required(),
2161
- });
2162
- }
2163
-
2164
1960
  /** @returns {CourierAccount} */
2165
1961
  static CourierAccount() {
2166
1962
  return Joi.object({
2167
- company_id: Joi.number().required(),
2168
1963
  extension_id: Joi.string().allow("").required(),
2169
1964
  account_id: Joi.string().allow("").required(),
2170
1965
  scheme_id: Joi.string().allow("").required(),
2171
1966
  is_self_ship: Joi.boolean().required(),
2172
1967
  stage: Joi.string().allow("").required(),
2173
1968
  is_own_account: Joi.boolean().required(),
2174
- scheme_rules: ServiceabilityPlatformModel.CourierPartnerSchemeModel().required(),
2175
1969
  });
2176
1970
  }
2177
1971
 
2178
- /** @returns {CourierAccountDetailsBody} */
2179
- static CourierAccountDetailsBody() {
1972
+ /** @returns {CourierAccountRequestBody} */
1973
+ static CourierAccountRequestBody() {
2180
1974
  return Joi.object({
2181
1975
  extension_id: Joi.string().allow("").required(),
2182
1976
  account_id: Joi.string().allow(""),
@@ -2187,8 +1981,8 @@ class ServiceabilityPlatformModel {
2187
1981
  });
2188
1982
  }
2189
1983
 
2190
- /** @returns {ErrorResult} */
2191
- static ErrorResult() {
1984
+ /** @returns {ErrorResponse} */
1985
+ static ErrorResponse() {
2192
1986
  return Joi.object({
2193
1987
  value: Joi.string().allow("").required(),
2194
1988
  message: Joi.string().allow("").required(),
@@ -2196,12 +1990,12 @@ class ServiceabilityPlatformModel {
2196
1990
  });
2197
1991
  }
2198
1992
 
2199
- /** @returns {CourierPartnerAccountFailureResult} */
2200
- static CourierPartnerAccountFailureResult() {
1993
+ /** @returns {CourierPartnerAccountFailureResponse} */
1994
+ static CourierPartnerAccountFailureResponse() {
2201
1995
  return Joi.object({
2202
1996
  success: Joi.boolean().required(),
2203
1997
  error: Joi.array()
2204
- .items(ServiceabilityPlatformModel.ErrorResult())
1998
+ .items(ServiceabilityPlatformModel.ErrorResponse())
2205
1999
  .required(),
2206
2000
  });
2207
2001
  }
@@ -2219,32 +2013,32 @@ class ServiceabilityPlatformModel {
2219
2013
  });
2220
2014
  }
2221
2015
 
2222
- /** @returns {CourierPartnerRuleCPListResult} */
2223
- static CourierPartnerRuleCPListResult() {
2016
+ /** @returns {CourierPartnerRuleCPListResponse} */
2017
+ static CourierPartnerRuleCPListResponse() {
2224
2018
  return Joi.object({
2225
- account_id: Joi.string().allow("").required(),
2226
- extension_id: Joi.string().allow("").required(),
2227
- is_self_ship: Joi.boolean().required(),
2228
- scheme_rules: Joi.object().pattern(/\S/, Joi.any()),
2019
+ account_id: Joi.string().allow(""),
2020
+ extension_id: Joi.string().allow(""),
2021
+ is_self_ship: Joi.boolean(),
2022
+ scheme_rules: Joi.any(),
2229
2023
  });
2230
2024
  }
2231
2025
 
2232
- /** @returns {CourierPartnerRuleResult} */
2233
- static CourierPartnerRuleResult() {
2026
+ /** @returns {CourierPartnerRuleResponse} */
2027
+ static CourierPartnerRuleResponse() {
2234
2028
  return Joi.object({
2235
- is_active: Joi.boolean().required(),
2236
- application_id: Joi.string().allow("").required(),
2237
- company_id: Joi.number().required(),
2238
- conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions().required(),
2239
- sort: Joi.array().items(Joi.string().allow("")).required(),
2240
- created_by: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
2241
- id: Joi.string().allow("").required(),
2242
- modified_by: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
2029
+ is_active: Joi.boolean(),
2030
+ application_id: Joi.string().allow(""),
2031
+ company_id: Joi.number(),
2032
+ conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions(),
2033
+ sort: Joi.array().items(Joi.string().allow("")),
2034
+ created_by: Joi.any().allow(null),
2035
+ id: Joi.string().allow(""),
2036
+ modified_by: Joi.any().allow(null),
2243
2037
  modified_on: Joi.string().allow("").allow(null),
2244
- name: Joi.string().allow("").required(),
2245
- type: Joi.string().allow("").required(),
2038
+ name: Joi.string().allow(""),
2039
+ type: Joi.string().allow(""),
2246
2040
  cp_list: Joi.array().items(
2247
- ServiceabilityPlatformModel.CourierPartnerRuleCPListResult()
2041
+ ServiceabilityPlatformModel.CourierPartnerRuleCPListResponse()
2248
2042
  ),
2249
2043
  });
2250
2044
  }
@@ -2264,7 +2058,7 @@ class ServiceabilityPlatformModel {
2264
2058
  sub_type: Joi.string().allow(""),
2265
2059
  name: Joi.string().allow(""),
2266
2060
  display_name: Joi.string().allow(""),
2267
- parent_id: Joi.array().items(Joi.string().allow("")),
2061
+ parent_id: Joi.string().allow(""),
2268
2062
  parent_ids: Joi.array().items(Joi.string().allow("")),
2269
2063
  });
2270
2064
  }
@@ -2325,137 +2119,35 @@ class ServiceabilityPlatformModel {
2325
2119
  name: Joi.string().allow("").required(),
2326
2120
  conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions().required(),
2327
2121
  sort: Joi.array().items(Joi.string().allow("")).required(),
2328
- type: Joi.string().allow(""),
2329
2122
  });
2330
2123
  }
2331
2124
 
2332
- /** @returns {FailureResult} */
2333
- static FailureResult() {
2125
+ /** @returns {FailureResponse} */
2126
+ static FailureResponse() {
2334
2127
  return Joi.object({
2335
2128
  success: Joi.boolean().required(),
2336
2129
  error: Joi.array()
2337
- .items(ServiceabilityPlatformModel.ErrorResult())
2130
+ .items(ServiceabilityPlatformModel.ErrorResponse())
2338
2131
  .required(),
2339
2132
  });
2340
2133
  }
2341
2134
 
2342
- /** @returns {CourierPartnerRulesListResult} */
2343
- static CourierPartnerRulesListResult() {
2135
+ /** @returns {CourierPartnerRulesListResponse} */
2136
+ static CourierPartnerRulesListResponse() {
2344
2137
  return Joi.object({
2345
2138
  items: Joi.array()
2346
- .items(ServiceabilityPlatformModel.CourierPartnerRuleResult())
2139
+ .items(ServiceabilityPlatformModel.CourierPartnerRuleResponse())
2347
2140
  .required(),
2348
2141
  page: ServiceabilityPlatformModel.Page().required(),
2349
2142
  });
2350
2143
  }
2351
2144
 
2352
- /** @returns {ShipmentsArticles} */
2353
- static ShipmentsArticles() {
2354
- return Joi.object({
2355
- item_id: Joi.number(),
2356
- category_id: Joi.number(),
2357
- brand_id: Joi.number(),
2358
- department_id: Joi.number(),
2359
- tags: Joi.array().items(Joi.string().allow("")),
2360
- });
2361
- }
2362
-
2363
- /** @returns {ShipmentDimension} */
2364
- static ShipmentDimension() {
2365
- return Joi.object({
2366
- height: Joi.number().required(),
2367
- length: Joi.number().required(),
2368
- width: Joi.number().required(),
2369
- });
2370
- }
2371
-
2372
- /** @returns {Shipments} */
2373
- static Shipments() {
2374
- return Joi.object({
2375
- id: Joi.string().allow(""),
2376
- location_id: Joi.number(),
2377
- location_tags: Joi.array().items(Joi.string().allow("")),
2378
- shipment_weight: Joi.number(),
2379
- shipment_volumetric_weight: Joi.number(),
2380
- shipment_cost: Joi.number(),
2381
- shipment_dimension: ServiceabilityPlatformModel.ShipmentDimension(),
2382
- courier_partner_schemes: Joi.array().items(Joi.string().allow("")),
2383
- articles: Joi.array().items(
2384
- ServiceabilityPlatformModel.ShipmentsArticles()
2385
- ),
2386
- });
2387
- }
2388
-
2389
- /** @returns {ShipmentCourierPartnerDetails} */
2390
- static ShipmentCourierPartnerDetails() {
2391
- return Joi.object({
2392
- from_location: ServiceabilityPlatformModel.ShipmentsCourierPartnersServiceability().required(),
2393
- to_location: ServiceabilityPlatformModel.ShipmentsCourierPartnersServiceability().required(),
2394
- shipments: Joi.array().items(ServiceabilityPlatformModel.Shipments()),
2395
- journey: Joi.string().allow(""),
2396
- payment_mode: Joi.string().allow(""),
2397
- });
2398
- }
2399
-
2400
- /** @returns {CourierPartnerPromise} */
2401
- static CourierPartnerPromise() {
2402
- return Joi.object({
2403
- min: Joi.string().allow("").required(),
2404
- max: Joi.string().allow("").required(),
2405
- });
2406
- }
2407
-
2408
- /** @returns {CourierPartners} */
2409
- static CourierPartners() {
2410
- return Joi.object({
2411
- extension_id: Joi.string().allow(""),
2412
- scheme_id: Joi.string().allow(""),
2413
- name: Joi.string().allow(""),
2414
- delivery_promise: ServiceabilityPlatformModel.CourierPartnerPromise(),
2415
- });
2416
- }
2417
-
2418
- /** @returns {ShipmentCourierPartners} */
2419
- static ShipmentCourierPartners() {
2420
- return Joi.object({
2421
- id: Joi.string().allow(""),
2422
- courier_partners: Joi.array().items(
2423
- ServiceabilityPlatformModel.CourierPartners()
2424
- ),
2425
- });
2426
- }
2427
-
2428
- /** @returns {ShipmentCourierPartnerResult} */
2429
- static ShipmentCourierPartnerResult() {
2430
- return Joi.object({
2431
- courier_partners: Joi.array().items(
2432
- ServiceabilityPlatformModel.CourierPartners()
2433
- ),
2434
- shipments: Joi.array().items(
2435
- ServiceabilityPlatformModel.ShipmentCourierPartners()
2436
- ),
2437
- });
2438
- }
2439
-
2440
- /** @returns {ShipmentsCourierPartnersServiceability} */
2441
- static ShipmentsCourierPartnersServiceability() {
2442
- return Joi.object({
2443
- pincode: Joi.string().allow(""),
2444
- sector_code: Joi.string().allow(""),
2445
- state_code: Joi.string().allow(""),
2446
- city_code: Joi.string().allow(""),
2447
- country_code: Joi.string().allow("").required(),
2448
- });
2449
- }
2450
-
2451
2145
  /** @returns {CompanyConfig} */
2452
2146
  static CompanyConfig() {
2453
2147
  return Joi.object({
2454
2148
  rule_ids: Joi.array().items(Joi.string().allow("")).required(),
2455
2149
  sort: Joi.array().items(Joi.string().allow("")).required(),
2456
- logistics_as_actual: Joi.string().allow(""),
2457
- company_id: Joi.number().required(),
2458
- application_id: Joi.string().allow(""),
2150
+ logistics_as_actual: Joi.boolean(),
2459
2151
  });
2460
2152
  }
2461
2153
 
@@ -2463,8 +2155,6 @@ class ServiceabilityPlatformModel {
2463
2155
  static ZoneConfig() {
2464
2156
  return Joi.object({
2465
2157
  serviceability_type: Joi.string().allow(""),
2466
- active_count: Joi.number(),
2467
- total_count: Joi.number(),
2468
2158
  });
2469
2159
  }
2470
2160
 
@@ -2477,22 +2167,22 @@ class ServiceabilityPlatformModel {
2477
2167
  });
2478
2168
  }
2479
2169
 
2480
- /** @returns {BulkRegionJobDetails} */
2481
- static BulkRegionJobDetails() {
2170
+ /** @returns {BulkRegionJobSerializer} */
2171
+ static BulkRegionJobSerializer() {
2482
2172
  return Joi.object({
2483
- file_path: Joi.string().allow("").allow(null),
2173
+ file_path: Joi.string().allow(""),
2484
2174
  country: Joi.string().allow("").required(),
2485
2175
  action: Joi.string().allow("").required(),
2486
2176
  region: Joi.string().allow("").required(),
2487
2177
  });
2488
2178
  }
2489
2179
 
2490
- /** @returns {BulkRegionResultItemData} */
2491
- static BulkRegionResultItemData() {
2180
+ /** @returns {BulkRegionResponseItemData} */
2181
+ static BulkRegionResponseItemData() {
2492
2182
  return Joi.object({
2493
- file_path: Joi.string().allow(""),
2183
+ file_path: Joi.string().allow("").required(),
2494
2184
  failed: Joi.number(),
2495
- failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
2185
+ failed_records: Joi.array().items(Joi.any()),
2496
2186
  action: Joi.string().allow("").required(),
2497
2187
  batch_id: Joi.string().allow("").required(),
2498
2188
  country: Joi.string().allow("").required(),
@@ -2504,18 +2194,18 @@ class ServiceabilityPlatformModel {
2504
2194
  });
2505
2195
  }
2506
2196
 
2507
- /** @returns {BulkRegionResult} */
2508
- static BulkRegionResult() {
2197
+ /** @returns {BulkRegionResponse} */
2198
+ static BulkRegionResponse() {
2509
2199
  return Joi.object({
2510
2200
  items: Joi.array()
2511
- .items(ServiceabilityPlatformModel.BulkRegionResultItemData())
2201
+ .items(ServiceabilityPlatformModel.BulkRegionResponseItemData())
2512
2202
  .required(),
2513
2203
  page: ServiceabilityPlatformModel.Page().required(),
2514
2204
  });
2515
2205
  }
2516
2206
 
2517
- /** @returns {SelfShipResult} */
2518
- static SelfShipResult() {
2207
+ /** @returns {SelfShipResponse} */
2208
+ static SelfShipResponse() {
2519
2209
  return Joi.object({
2520
2210
  is_active: Joi.boolean().required(),
2521
2211
  tat: Joi.number().required(),
@@ -2525,14 +2215,14 @@ class ServiceabilityPlatformModel {
2525
2215
  /** @returns {ApplicationSelfShipConfig} */
2526
2216
  static ApplicationSelfShipConfig() {
2527
2217
  return Joi.object({
2528
- self_ship: ServiceabilityPlatformModel.SelfShipResult(),
2218
+ self_ship: Joi.any().allow(null),
2529
2219
  });
2530
2220
  }
2531
2221
 
2532
- /** @returns {ApplicationSelfShipConfigResult} */
2533
- static ApplicationSelfShipConfigResult() {
2222
+ /** @returns {ApplicationSelfShipConfigResponse} */
2223
+ static ApplicationSelfShipConfigResponse() {
2534
2224
  return Joi.object({
2535
- error: ServiceabilityPlatformModel.ServiceabilityErrorResult(),
2225
+ error: ServiceabilityPlatformModel.ServiceabilityErrorResponse(),
2536
2226
  data: ServiceabilityPlatformModel.ApplicationSelfShipConfig(),
2537
2227
  success: Joi.boolean().required(),
2538
2228
  });
@@ -2600,13 +2290,13 @@ class ServiceabilityPlatformModel {
2600
2290
  /** @returns {StorePrioritySchema} */
2601
2291
  static StorePrioritySchema() {
2602
2292
  return Joi.object({
2603
- id: Joi.number(),
2293
+ id: Joi.string().allow(""),
2604
2294
  name: Joi.string().allow(""),
2605
2295
  });
2606
2296
  }
2607
2297
 
2608
- /** @returns {GetStoreRulesApiResult} */
2609
- static GetStoreRulesApiResult() {
2298
+ /** @returns {GetStoreRulesApiResponse} */
2299
+ static GetStoreRulesApiResponse() {
2610
2300
  return Joi.object({
2611
2301
  items: Joi.array().items(
2612
2302
  ServiceabilityPlatformModel.StoreRuleDataSchema()
@@ -2615,8 +2305,8 @@ class ServiceabilityPlatformModel {
2615
2305
  });
2616
2306
  }
2617
2307
 
2618
- /** @returns {CreateStoreRuleDetailsSchema} */
2619
- static CreateStoreRuleDetailsSchema() {
2308
+ /** @returns {CreateStoreRuleRequestSchema} */
2309
+ static CreateStoreRuleRequestSchema() {
2620
2310
  return Joi.object({
2621
2311
  name: Joi.string().allow(""),
2622
2312
  is_active: Joi.boolean(),
@@ -2630,8 +2320,8 @@ class ServiceabilityPlatformModel {
2630
2320
  });
2631
2321
  }
2632
2322
 
2633
- /** @returns {StoreRuleResultSchema} */
2634
- static StoreRuleResultSchema() {
2323
+ /** @returns {StoreRuleResponseSchema} */
2324
+ static StoreRuleResponseSchema() {
2635
2325
  return Joi.object({
2636
2326
  id: Joi.string().allow(""),
2637
2327
  name: Joi.string().allow(""),
@@ -2647,8 +2337,8 @@ class ServiceabilityPlatformModel {
2647
2337
  });
2648
2338
  }
2649
2339
 
2650
- /** @returns {StoreRuleUpdateResultSchema} */
2651
- static StoreRuleUpdateResultSchema() {
2340
+ /** @returns {StoreRuleUpdateResponseSchema} */
2341
+ static StoreRuleUpdateResponseSchema() {
2652
2342
  return Joi.object({
2653
2343
  id: Joi.string().allow(""),
2654
2344
  name: Joi.string().allow(""),
@@ -2671,8 +2361,8 @@ class ServiceabilityPlatformModel {
2671
2361
  return Joi.object({
2672
2362
  lm_cod_limit: Joi.number().required(),
2673
2363
  is_qc: Joi.boolean().required(),
2674
- pickup_cutoff: Joi.string().allow("").allow(null),
2675
- route_code: Joi.string().allow("").allow(null),
2364
+ pickup_cutoff: Joi.string().allow("").allow(null).required(),
2365
+ route_code: Joi.string().allow("").allow(null).required(),
2676
2366
  is_first_mile: Joi.boolean().required(),
2677
2367
  is_return: Joi.boolean().required(),
2678
2368
  is_installation: Joi.boolean().required(),
@@ -2707,10 +2397,8 @@ class ServiceabilityPlatformModel {
2707
2397
  /** @returns {CourierPartnerSchemeModel} */
2708
2398
  static CourierPartnerSchemeModel() {
2709
2399
  return Joi.object({
2710
- name: Joi.string().allow(""),
2711
2400
  extension_id: Joi.string().allow("").required(),
2712
2401
  scheme_id: Joi.string().allow("").required(),
2713
- volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
2714
2402
  weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
2715
2403
  transport_type: Joi.string().allow("").required(),
2716
2404
  region: Joi.string().allow("").required(),
@@ -2721,25 +2409,23 @@ class ServiceabilityPlatformModel {
2721
2409
  });
2722
2410
  }
2723
2411
 
2724
- /** @returns {CourierAccountResult} */
2725
- static CourierAccountResult() {
2412
+ /** @returns {CourierAccountResponse} */
2413
+ static CourierAccountResponse() {
2726
2414
  return Joi.object({
2727
- company_id: Joi.number().required(),
2728
- extension_id: Joi.string().allow(""),
2729
2415
  account_id: Joi.string().allow("").required(),
2730
2416
  scheme_id: Joi.string().allow("").required(),
2731
2417
  is_self_ship: Joi.boolean().required(),
2732
2418
  stage: Joi.string().allow("").required(),
2733
2419
  is_own_account: Joi.boolean().required(),
2734
- scheme_rules: ServiceabilityPlatformModel.CourierPartnerSchemeModel(),
2420
+ scheme_rules: ServiceabilityPlatformModel.CourierPartnerSchemeModel().required(),
2735
2421
  });
2736
2422
  }
2737
2423
 
2738
- /** @returns {CompanyCourierPartnerAccountListResult} */
2739
- static CompanyCourierPartnerAccountListResult() {
2424
+ /** @returns {CompanyCourierPartnerAccountListResponse} */
2425
+ static CompanyCourierPartnerAccountListResponse() {
2740
2426
  return Joi.object({
2741
2427
  items: Joi.array()
2742
- .items(ServiceabilityPlatformModel.CourierAccountResult())
2428
+ .items(ServiceabilityPlatformModel.CourierAccountResponse())
2743
2429
  .required(),
2744
2430
  page: ServiceabilityPlatformModel.Page().required(),
2745
2431
  });
@@ -2772,13 +2458,12 @@ class ServiceabilityPlatformModel {
2772
2458
  });
2773
2459
  }
2774
2460
 
2775
- /** @returns {PackageMaterialResult} */
2776
- static PackageMaterialResult() {
2461
+ /** @returns {PackageMaterialResponse} */
2462
+ static PackageMaterialResponse() {
2777
2463
  return Joi.object({
2778
2464
  name: Joi.string().allow("").required(),
2779
2465
  id: Joi.string().allow(""),
2780
2466
  item_id: Joi.number(),
2781
- company_id: Joi.number(),
2782
2467
  width: Joi.number().required(),
2783
2468
  height: Joi.number().required(),
2784
2469
  length: Joi.number().required(),
@@ -2824,8 +2509,8 @@ class ServiceabilityPlatformModel {
2824
2509
  });
2825
2510
  }
2826
2511
 
2827
- /** @returns {PackageRuleResult} */
2828
- static PackageRuleResult() {
2512
+ /** @returns {PackageRuleResponse} */
2513
+ static PackageRuleResponse() {
2829
2514
  return Joi.object({
2830
2515
  id: Joi.string().allow(""),
2831
2516
  name: Joi.string().allow("").required(),
@@ -2849,7 +2534,7 @@ class ServiceabilityPlatformModel {
2849
2534
  /** @returns {PackageMaterialRuleList} */
2850
2535
  static PackageMaterialRuleList() {
2851
2536
  return Joi.object({
2852
- items: ServiceabilityPlatformModel.PackageRuleResult(),
2537
+ items: ServiceabilityPlatformModel.PackageRuleResponse(),
2853
2538
  page: ServiceabilityPlatformModel.Page(),
2854
2539
  });
2855
2540
  }
@@ -2857,7 +2542,7 @@ class ServiceabilityPlatformModel {
2857
2542
  /** @returns {PackageMaterialList} */
2858
2543
  static PackageMaterialList() {
2859
2544
  return Joi.object({
2860
- items: ServiceabilityPlatformModel.PackageMaterialResult(),
2545
+ items: ServiceabilityPlatformModel.PackageMaterialResponse(),
2861
2546
  page: ServiceabilityPlatformModel.Page(),
2862
2547
  });
2863
2548
  }
@@ -2891,16 +2576,16 @@ class ServiceabilityPlatformModel {
2891
2576
  });
2892
2577
  }
2893
2578
 
2894
- /** @returns {RulePriorityDetails} */
2895
- static RulePriorityDetails() {
2579
+ /** @returns {RulePriorityRequest} */
2580
+ static RulePriorityRequest() {
2896
2581
  return Joi.object({
2897
2582
  rule_id: Joi.string().allow("").required(),
2898
2583
  priority: Joi.number().required(),
2899
2584
  });
2900
2585
  }
2901
2586
 
2902
- /** @returns {RulePriorityResult} */
2903
- static RulePriorityResult() {
2587
+ /** @returns {RulePriorityResponse} */
2588
+ static RulePriorityResponse() {
2904
2589
  return Joi.object({
2905
2590
  success: Joi.boolean(),
2906
2591
  });
@@ -2940,10 +2625,10 @@ class ServiceabilityPlatformModel {
2940
2625
  return Joi.object({
2941
2626
  item_id: Joi.number().required(),
2942
2627
  size: Joi.string().allow("").required(),
2943
- quantity: Joi.number().required(),
2628
+ quantity: Joi.string().allow("").required(),
2944
2629
  group_id: Joi.string().allow(""),
2945
2630
  is_primary_item: Joi.boolean(),
2946
- meta: Joi.object().pattern(/\S/, Joi.any()),
2631
+ meta: Joi.any(),
2947
2632
  article_assignment: ServiceabilityPlatformModel.ArticleAssignment().required(),
2948
2633
  ignore_locations: Joi.array().items(Joi.number()).required(),
2949
2634
  assign_locations: Joi.array().items(Joi.number()).required(),
@@ -2951,28 +2636,26 @@ class ServiceabilityPlatformModel {
2951
2636
  });
2952
2637
  }
2953
2638
 
2954
- /** @returns {OptimlLocationsDetailsSchema} */
2955
- static OptimlLocationsDetailsSchema() {
2639
+ /** @returns {OptimlLocationsRequestSchema} */
2640
+ static OptimlLocationsRequestSchema() {
2956
2641
  return Joi.object({
2957
2642
  channel_id: Joi.string().allow("").required(),
2958
2643
  channel_type: Joi.string().allow("").required(),
2959
2644
  channel_identifier: Joi.string().allow(""),
2960
2645
  to_serviceability: ServiceabilityPlatformModel.LocationDetailsServiceability().required(),
2961
- articles: Joi.array().items(
2962
- ServiceabilityPlatformModel.OptimalLocationsArticles()
2963
- ),
2646
+ article: ServiceabilityPlatformModel.OptimalLocationsArticles(),
2964
2647
  });
2965
2648
  }
2966
2649
 
2967
- /** @returns {OptimalLocationArticlesResult} */
2968
- static OptimalLocationArticlesResult() {
2650
+ /** @returns {OptimalLocationArticlesResponse} */
2651
+ static OptimalLocationArticlesResponse() {
2969
2652
  return Joi.object({
2970
2653
  item_id: Joi.number().required(),
2971
2654
  size: Joi.string().allow("").required(),
2972
2655
  quantity: Joi.number().required(),
2973
2656
  group_id: Joi.string().allow(""),
2974
2657
  is_primary_item: Joi.boolean(),
2975
- meta: Joi.object().pattern(/\S/, Joi.any()),
2658
+ meta: Joi.any(),
2976
2659
  article_assignment: ServiceabilityPlatformModel.ArticleAssignment().required(),
2977
2660
  seller_id: Joi.number(),
2978
2661
  ignore_locations: Joi.array().items(Joi.number()).required(),
@@ -2984,43 +2667,28 @@ class ServiceabilityPlatformModel {
2984
2667
  });
2985
2668
  }
2986
2669
 
2987
- /** @returns {OptimalLocationAssignedStoresResult} */
2988
- static OptimalLocationAssignedStoresResult() {
2670
+ /** @returns {OptimalLocationAssignedStoresResponse} */
2671
+ static OptimalLocationAssignedStoresResponse() {
2989
2672
  return Joi.object({
2990
2673
  store_id: Joi.number().required(),
2991
2674
  articles: Joi.array()
2992
- .items(ServiceabilityPlatformModel.OptimalLocationArticlesResult())
2675
+ .items(ServiceabilityPlatformModel.OptimalLocationArticlesResponse())
2993
2676
  .required(),
2994
2677
  });
2995
2678
  }
2996
2679
 
2997
- /** @returns {OptimalLocationsResult} */
2998
- static OptimalLocationsResult() {
2680
+ /** @returns {OptimalLocationsResponse} */
2681
+ static OptimalLocationsResponse() {
2999
2682
  return Joi.object({
3000
2683
  assigned_stores: Joi.array()
3001
2684
  .items(
3002
- ServiceabilityPlatformModel.OptimalLocationAssignedStoresResult()
2685
+ ServiceabilityPlatformModel.OptimalLocationAssignedStoresResponse()
3003
2686
  )
3004
2687
  .required(),
3005
2688
  faulty_articles: Joi.array().items(
3006
- ServiceabilityPlatformModel.ErrorResult()
2689
+ ServiceabilityPlatformModel.ErrorResponse()
3007
2690
  ),
3008
2691
  });
3009
2692
  }
3010
-
3011
- /** @returns {ValidationError} */
3012
- static ValidationError() {
3013
- return Joi.object({
3014
- message: Joi.string().allow("").required(),
3015
- field: Joi.string().allow("").required(),
3016
- });
3017
- }
3018
-
3019
- /** @returns {StandardError} */
3020
- static StandardError() {
3021
- return Joi.object({
3022
- message: Joi.string().allow("").required(),
3023
- });
3024
- }
3025
2693
  }
3026
2694
  module.exports = ServiceabilityPlatformModel;