@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.3
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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
- package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
- package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
- package/sdk/application/Content/ContentApplicationModel.js +757 -757
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
- package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
- package/sdk/application/Order/OrderApplicationModel.d.ts +846 -846
- package/sdk/application/Order/OrderApplicationModel.js +822 -822
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +2155 -2150
- package/sdk/application/Payment/PaymentApplicationModel.js +1460 -1458
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
- package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
- package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
- package/sdk/application/User/UserApplicationModel.d.ts +762 -762
- package/sdk/application/User/UserApplicationModel.js +738 -738
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
- package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
- package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
- package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
- package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
- package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -1013
- package/sdk/platform/Catalog/CatalogPlatformModel.js +923 -923
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1833 -1833
- package/sdk/platform/Content/ContentPlatformModel.js +1837 -1837
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
- package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +865 -865
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +877 -877
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
- package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
- package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5180 -5176
- package/sdk/platform/Order/OrderPlatformModel.js +4740 -4736
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2670 -2660
- package/sdk/platform/Payment/PaymentPlatformModel.js +1831 -1827
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1505 -1507
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1532 -1536
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
- package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
- package/sdk/platform/User/UserPlatformModel.d.ts +758 -758
- package/sdk/platform/User/UserPlatformModel.js +643 -643
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
- package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
- package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
- package/sdk/public/Billing/BillingPublicModel.js +51 -51
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
- package/sdk/public/Content/ContentPublicModel.js +28 -28
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
- package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
|
@@ -1,898 +1,827 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
5
|
-
* @property {string} [
|
|
6
|
-
* @property {string} [address2]
|
|
7
|
-
* @property {string} [city]
|
|
8
|
-
* @property {string} [country]
|
|
9
|
-
* @property {string} [landmark]
|
|
10
|
-
* @property {number} [latitude]
|
|
11
|
-
* @property {number} [longitude]
|
|
12
|
-
* @property {number} [pincode]
|
|
13
|
-
* @property {string} [state]
|
|
14
|
-
*/
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* @typedef ApplicationConfig
|
|
18
|
-
* @property {string[]} [rule_ids]
|
|
19
|
-
* @property {string[]} [sort]
|
|
20
|
-
* @property {ZoneConfig} [zones]
|
|
21
|
-
*/
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* @typedef ApplicationSelfShipConfig
|
|
25
|
-
* @property {Object} [self_ship]
|
|
4
|
+
* @typedef UpdateZoneConfigRequest
|
|
5
|
+
* @property {string} [serviceability_type]
|
|
26
6
|
*/
|
|
27
7
|
|
|
28
8
|
/**
|
|
29
|
-
* @typedef
|
|
30
|
-
* @property {
|
|
31
|
-
* @property {
|
|
32
|
-
* @property {
|
|
9
|
+
* @typedef ServiceabilityErrorResponse
|
|
10
|
+
* @property {string} message
|
|
11
|
+
* @property {string} value
|
|
12
|
+
* @property {string} type
|
|
33
13
|
*/
|
|
34
14
|
|
|
35
15
|
/**
|
|
36
16
|
* @typedef ApplicationServiceabilityConfig
|
|
37
17
|
* @property {string} channel_id
|
|
38
|
-
* @property {string} channel_type
|
|
39
18
|
* @property {string} serviceability_type
|
|
19
|
+
* @property {string} channel_type
|
|
40
20
|
*/
|
|
41
21
|
|
|
42
22
|
/**
|
|
43
23
|
* @typedef ApplicationServiceabilityConfigResponse
|
|
44
|
-
* @property {ApplicationServiceabilityConfig} [data]
|
|
45
24
|
* @property {ServiceabilityErrorResponse} [error]
|
|
25
|
+
* @property {ApplicationServiceabilityConfig} [data]
|
|
46
26
|
* @property {boolean} success
|
|
47
27
|
*/
|
|
48
28
|
|
|
49
29
|
/**
|
|
50
|
-
* @typedef
|
|
51
|
-
* @property {
|
|
52
|
-
* @property {
|
|
53
|
-
* @property {number} [lt]
|
|
54
|
-
* @property {number} [lte]
|
|
30
|
+
* @typedef EntityRegionView_Request
|
|
31
|
+
* @property {string[]} sub_type
|
|
32
|
+
* @property {string[]} [parent_id]
|
|
55
33
|
*/
|
|
56
34
|
|
|
57
35
|
/**
|
|
58
|
-
* @typedef
|
|
59
|
-
* @property {string}
|
|
60
|
-
* @property {string}
|
|
61
|
-
* @property {string} [
|
|
62
|
-
* @property {string} region
|
|
36
|
+
* @typedef EntityRegionView_Error
|
|
37
|
+
* @property {string} [message]
|
|
38
|
+
* @property {string} [value]
|
|
39
|
+
* @property {string} [type]
|
|
63
40
|
*/
|
|
64
41
|
|
|
65
42
|
/**
|
|
66
|
-
* @typedef
|
|
67
|
-
* @property {
|
|
68
|
-
* @property {
|
|
43
|
+
* @typedef EntityRegionView_page
|
|
44
|
+
* @property {string} type
|
|
45
|
+
* @property {boolean} has_next
|
|
46
|
+
* @property {number} item_total
|
|
47
|
+
* @property {number} size
|
|
48
|
+
* @property {number} current
|
|
69
49
|
*/
|
|
70
50
|
|
|
71
51
|
/**
|
|
72
|
-
* @typedef
|
|
73
|
-
* @property {
|
|
74
|
-
* @property {
|
|
75
|
-
* @property {string} country
|
|
76
|
-
* @property {string} [error_file_path]
|
|
77
|
-
* @property {number} [failed]
|
|
78
|
-
* @property {Object[]} [failed_records]
|
|
79
|
-
* @property {string} file_path
|
|
80
|
-
* @property {string} region
|
|
81
|
-
* @property {string} status
|
|
82
|
-
* @property {number} [success]
|
|
83
|
-
* @property {number} [total]
|
|
52
|
+
* @typedef getAppRegionZonesResponse
|
|
53
|
+
* @property {PageSchema[]} page
|
|
54
|
+
* @property {ListViewItems[]} items
|
|
84
55
|
*/
|
|
85
56
|
|
|
86
57
|
/**
|
|
87
|
-
* @typedef
|
|
88
|
-
* @property {
|
|
89
|
-
* @property {
|
|
58
|
+
* @typedef PageSchema
|
|
59
|
+
* @property {boolean} has_next
|
|
60
|
+
* @property {number} item_total
|
|
61
|
+
* @property {number} size
|
|
62
|
+
* @property {number} current
|
|
63
|
+
* @property {string} type
|
|
90
64
|
*/
|
|
91
65
|
|
|
92
66
|
/**
|
|
93
|
-
* @typedef
|
|
94
|
-
* @property {
|
|
95
|
-
* @property {string}
|
|
96
|
-
* @property {string}
|
|
67
|
+
* @typedef EntityRegionView_Items
|
|
68
|
+
* @property {string} sub_type
|
|
69
|
+
* @property {string} uid
|
|
70
|
+
* @property {string} name
|
|
97
71
|
*/
|
|
98
72
|
|
|
99
73
|
/**
|
|
100
|
-
* @typedef
|
|
101
|
-
* @property {
|
|
102
|
-
* @property {
|
|
103
|
-
* @property {
|
|
74
|
+
* @typedef EntityRegionView_Response
|
|
75
|
+
* @property {EntityRegionView_Error} error
|
|
76
|
+
* @property {EntityRegionView_page} page
|
|
77
|
+
* @property {EntityRegionView_Items[]} data
|
|
78
|
+
* @property {boolean} success
|
|
104
79
|
*/
|
|
105
80
|
|
|
106
81
|
/**
|
|
107
|
-
* @typedef
|
|
108
|
-
* @property {
|
|
109
|
-
* @property {
|
|
82
|
+
* @typedef ListViewSummary
|
|
83
|
+
* @property {number} total_zones
|
|
84
|
+
* @property {number} total_pincodes_served
|
|
85
|
+
* @property {number} total_active_zones
|
|
110
86
|
*/
|
|
111
87
|
|
|
112
88
|
/**
|
|
113
|
-
* @typedef
|
|
114
|
-
* @property {number} current
|
|
89
|
+
* @typedef ZoneDataItem
|
|
115
90
|
* @property {boolean} has_next
|
|
116
91
|
* @property {number} item_total
|
|
117
92
|
* @property {number} size
|
|
93
|
+
* @property {number} current
|
|
118
94
|
* @property {string} type
|
|
119
95
|
*/
|
|
120
96
|
|
|
121
97
|
/**
|
|
122
|
-
* @typedef
|
|
123
|
-
* @property {
|
|
124
|
-
* @property {
|
|
98
|
+
* @typedef ListViewProduct
|
|
99
|
+
* @property {number} count
|
|
100
|
+
* @property {string} type
|
|
125
101
|
*/
|
|
126
102
|
|
|
127
103
|
/**
|
|
128
|
-
* @typedef
|
|
129
|
-
* @property {
|
|
130
|
-
* @property {string}
|
|
104
|
+
* @typedef ListViewChannels
|
|
105
|
+
* @property {string} channel_id
|
|
106
|
+
* @property {string} channel_type
|
|
131
107
|
*/
|
|
132
108
|
|
|
133
109
|
/**
|
|
134
|
-
* @typedef
|
|
135
|
-
* @property {string}
|
|
136
|
-
* @property {string}
|
|
137
|
-
* @property {
|
|
138
|
-
* @property {
|
|
139
|
-
* @property {
|
|
140
|
-
* @property {
|
|
110
|
+
* @typedef ListViewItems
|
|
111
|
+
* @property {string} zone_id
|
|
112
|
+
* @property {string} name
|
|
113
|
+
* @property {string} slug
|
|
114
|
+
* @property {number} stores_count
|
|
115
|
+
* @property {boolean} is_active
|
|
116
|
+
* @property {number} regions_count
|
|
117
|
+
* @property {number} company_id
|
|
118
|
+
* @property {ListViewChannels[]} channels
|
|
141
119
|
*/
|
|
142
120
|
|
|
143
121
|
/**
|
|
144
|
-
* @typedef
|
|
145
|
-
* @property {
|
|
146
|
-
* @property {
|
|
147
|
-
* @property {boolean} is_self_ship
|
|
148
|
-
* @property {string} scheme_id
|
|
149
|
-
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
150
|
-
* @property {string} stage
|
|
122
|
+
* @typedef ListViewResponse
|
|
123
|
+
* @property {ZoneDataItem} page
|
|
124
|
+
* @property {ListViewItems[]} items
|
|
151
125
|
*/
|
|
152
126
|
|
|
153
127
|
/**
|
|
154
|
-
* @typedef
|
|
155
|
-
* @property {
|
|
156
|
-
* @property {boolean}
|
|
128
|
+
* @typedef CompanyStoreView_PageItems
|
|
129
|
+
* @property {string} type
|
|
130
|
+
* @property {boolean} has_next
|
|
131
|
+
* @property {number} item_total
|
|
132
|
+
* @property {number} size
|
|
133
|
+
* @property {number} current
|
|
157
134
|
*/
|
|
158
135
|
|
|
159
136
|
/**
|
|
160
|
-
* @typedef
|
|
161
|
-
* @property {
|
|
162
|
-
* @property {
|
|
163
|
-
* @property {boolean} is_self_ship
|
|
164
|
-
* @property {string} name
|
|
137
|
+
* @typedef CompanyStoreView_Response
|
|
138
|
+
* @property {CompanyStoreView_PageItems[]} page
|
|
139
|
+
* @property {Object[]} [items]
|
|
165
140
|
*/
|
|
166
141
|
|
|
167
142
|
/**
|
|
168
|
-
* @typedef
|
|
169
|
-
* @property {
|
|
170
|
-
* @property {
|
|
171
|
-
* @property {boolean} is_active
|
|
172
|
-
* @property {string} name
|
|
173
|
-
* @property {string[]} sort
|
|
143
|
+
* @typedef GetZoneDataViewChannels
|
|
144
|
+
* @property {string} channel_id
|
|
145
|
+
* @property {string} channel_type
|
|
174
146
|
*/
|
|
175
147
|
|
|
176
148
|
/**
|
|
177
|
-
* @typedef
|
|
178
|
-
* @property {
|
|
179
|
-
* @property {
|
|
180
|
-
* @property {IntComparisonOperations} [department_ids]
|
|
181
|
-
* @property {LocationRule} [forward]
|
|
182
|
-
* @property {ArithmeticOperations} [order_place_date]
|
|
183
|
-
* @property {StringComparisonOperations} [payment_mode]
|
|
184
|
-
* @property {IntComparisonOperations} [product_ids]
|
|
185
|
-
* @property {StringComparisonOperations} [product_tags]
|
|
186
|
-
* @property {LocationRule} [reverse]
|
|
187
|
-
* @property {ArithmeticOperations} [shipment_cost]
|
|
188
|
-
* @property {ArithmeticOperations} [shipment_volumetric_weight]
|
|
189
|
-
* @property {ArithmeticOperations} [shipment_weight]
|
|
190
|
-
* @property {IntComparisonOperations} [store_ids]
|
|
191
|
-
* @property {StringComparisonOperations} [store_tags]
|
|
192
|
-
* @property {StringComparisonOperations} [store_type]
|
|
193
|
-
* @property {StringComparisonOperations} [zone_ids]
|
|
149
|
+
* @typedef ZoneProductTypes
|
|
150
|
+
* @property {string} type
|
|
151
|
+
* @property {string[]} tags
|
|
194
152
|
*/
|
|
195
153
|
|
|
196
154
|
/**
|
|
197
|
-
* @typedef
|
|
198
|
-
* @property {
|
|
199
|
-
* @property {
|
|
155
|
+
* @typedef ZoneMappingType
|
|
156
|
+
* @property {string} country
|
|
157
|
+
* @property {string[]} [pincode]
|
|
158
|
+
* @property {string[]} [state]
|
|
200
159
|
*/
|
|
201
160
|
|
|
202
161
|
/**
|
|
203
|
-
* @typedef
|
|
204
|
-
* @property {
|
|
205
|
-
* @property {
|
|
206
|
-
* @property {
|
|
207
|
-
* @property {
|
|
208
|
-
* @property {boolean}
|
|
209
|
-
* @property {
|
|
210
|
-
* @property {
|
|
211
|
-
* @property {
|
|
212
|
-
* @property {
|
|
213
|
-
* @property {
|
|
214
|
-
* @property {
|
|
215
|
-
* @property {number} [ndr_attempts]
|
|
216
|
-
* @property {boolean} [openbox_delivery]
|
|
217
|
-
* @property {boolean} [product_installation]
|
|
218
|
-
* @property {boolean} [qr]
|
|
219
|
-
* @property {boolean} [restricted_goods]
|
|
220
|
-
* @property {boolean} [single_pick_multi_drop]
|
|
221
|
-
* @property {string} [status_updates]
|
|
162
|
+
* @typedef UpdateZoneData
|
|
163
|
+
* @property {string} zone_id
|
|
164
|
+
* @property {string} name
|
|
165
|
+
* @property {string} slug
|
|
166
|
+
* @property {number} company_id
|
|
167
|
+
* @property {boolean} is_active
|
|
168
|
+
* @property {GetZoneDataViewChannels[]} channels
|
|
169
|
+
* @property {ZoneProductTypes} product
|
|
170
|
+
* @property {number[]} store_ids
|
|
171
|
+
* @property {string} region_type
|
|
172
|
+
* @property {ZoneMappingType[]} mapping
|
|
173
|
+
* @property {string} [assignment_preference]
|
|
222
174
|
*/
|
|
223
175
|
|
|
224
176
|
/**
|
|
225
|
-
* @typedef
|
|
226
|
-
* @property {string}
|
|
227
|
-
* @property {
|
|
228
|
-
* @property {CourierPartnerSchemeFeatures} feature
|
|
229
|
-
* @property {string[]} payment_mode
|
|
230
|
-
* @property {string} region
|
|
231
|
-
* @property {string} scheme_id
|
|
232
|
-
* @property {string} stage
|
|
233
|
-
* @property {string} transport_type
|
|
234
|
-
* @property {ArithmeticOperations} weight
|
|
177
|
+
* @typedef ZoneUpdateRequest
|
|
178
|
+
* @property {string} identifier
|
|
179
|
+
* @property {UpdateZoneData} data
|
|
235
180
|
*/
|
|
236
181
|
|
|
237
182
|
/**
|
|
238
|
-
* @typedef
|
|
239
|
-
* @property {
|
|
240
|
-
* @property {
|
|
183
|
+
* @typedef ZoneSuccessResponse
|
|
184
|
+
* @property {number} status_code
|
|
185
|
+
* @property {boolean} success
|
|
241
186
|
*/
|
|
242
187
|
|
|
243
188
|
/**
|
|
244
|
-
* @typedef
|
|
245
|
-
* @property {
|
|
246
|
-
* @property {boolean} [is_active]
|
|
247
|
-
* @property {string} [name]
|
|
248
|
-
* @property {string[]} [sort]
|
|
249
|
-
* @property {StorePrioritySchema[]} [store_priority]
|
|
250
|
-
* @property {string[]} [tag_based_priority]
|
|
251
|
-
* @property {string[]} [type_based_priority]
|
|
252
|
-
*/
|
|
253
|
-
|
|
254
|
-
/**
|
|
255
|
-
* @typedef CreateZoneData
|
|
256
|
-
* @property {string} [assignment_preference]
|
|
257
|
-
* @property {GetZoneDataViewChannels[]} channels
|
|
258
|
-
* @property {number} company_id
|
|
259
|
-
* @property {boolean} is_active
|
|
260
|
-
* @property {ZoneMappingType[]} mapping
|
|
189
|
+
* @typedef GetZoneDataViewItems
|
|
190
|
+
* @property {string} zone_id
|
|
261
191
|
* @property {string} name
|
|
262
|
-
* @property {string} region_type
|
|
263
192
|
* @property {string} slug
|
|
193
|
+
* @property {number} [company_id]
|
|
194
|
+
* @property {boolean} is_active
|
|
195
|
+
* @property {GetZoneDataViewChannels[]} channels
|
|
196
|
+
* @property {ZoneProductTypes} product
|
|
264
197
|
* @property {number[]} store_ids
|
|
198
|
+
* @property {string} [region_type]
|
|
199
|
+
* @property {ZoneMappingType[]} mapping
|
|
200
|
+
* @property {string} [assignment_preference]
|
|
201
|
+
* @property {number} stores_count
|
|
265
202
|
*/
|
|
266
203
|
|
|
267
204
|
/**
|
|
268
|
-
* @typedef
|
|
269
|
-
* @property {
|
|
270
|
-
* @property {number} [gte]
|
|
271
|
-
* @property {number} [lt]
|
|
272
|
-
* @property {number} [lte]
|
|
273
|
-
* @property {string} unit
|
|
205
|
+
* @typedef GetSingleZoneDataViewResponse
|
|
206
|
+
* @property {GetZoneDataViewItems} data
|
|
274
207
|
*/
|
|
275
208
|
|
|
276
209
|
/**
|
|
277
|
-
* @typedef
|
|
278
|
-
* @property {string}
|
|
279
|
-
* @property {string}
|
|
280
|
-
* @property {string}
|
|
281
|
-
* @property {
|
|
210
|
+
* @typedef GetZoneByIdSchema
|
|
211
|
+
* @property {string} zone_id
|
|
212
|
+
* @property {string} name
|
|
213
|
+
* @property {string} slug
|
|
214
|
+
* @property {number} [company_id]
|
|
215
|
+
* @property {boolean} is_active
|
|
216
|
+
* @property {GetZoneDataViewChannels[]} channels
|
|
217
|
+
* @property {ZoneProductTypes} product
|
|
218
|
+
* @property {number[]} store_ids
|
|
219
|
+
* @property {string} region_type
|
|
220
|
+
* @property {ZoneMappingType[]} mapping
|
|
221
|
+
* @property {string} [assignment_preference]
|
|
222
|
+
* @property {number} stores_count
|
|
282
223
|
*/
|
|
283
224
|
|
|
284
225
|
/**
|
|
285
|
-
* @typedef
|
|
286
|
-
* @property {
|
|
287
|
-
* @property {
|
|
288
|
-
* @property {
|
|
289
|
-
* @property {
|
|
290
|
-
* @property {
|
|
291
|
-
* @property {number}
|
|
292
|
-
* @property {string
|
|
293
|
-
* @property {
|
|
294
|
-
* @property {
|
|
295
|
-
* @property {string} [transport_mode]
|
|
226
|
+
* @typedef CreateZoneData
|
|
227
|
+
* @property {string} name
|
|
228
|
+
* @property {string} slug
|
|
229
|
+
* @property {number} company_id
|
|
230
|
+
* @property {boolean} is_active
|
|
231
|
+
* @property {GetZoneDataViewChannels[]} channels
|
|
232
|
+
* @property {number[]} store_ids
|
|
233
|
+
* @property {string} region_type
|
|
234
|
+
* @property {ZoneMappingType[]} mapping
|
|
235
|
+
* @property {string} [assignment_preference]
|
|
296
236
|
*/
|
|
297
237
|
|
|
298
238
|
/**
|
|
299
|
-
* @typedef
|
|
300
|
-
* @property {
|
|
239
|
+
* @typedef ZoneResponse
|
|
240
|
+
* @property {number} status_code
|
|
241
|
+
* @property {string} zone_id
|
|
242
|
+
* @property {boolean} success
|
|
301
243
|
*/
|
|
302
244
|
|
|
303
245
|
/**
|
|
304
|
-
* @typedef
|
|
305
|
-
* @property {string}
|
|
306
|
-
* @property {string}
|
|
307
|
-
* @property {string} [value]
|
|
246
|
+
* @typedef GetZoneFromPincodeViewRequest
|
|
247
|
+
* @property {string} country
|
|
248
|
+
* @property {string} pincode
|
|
308
249
|
*/
|
|
309
250
|
|
|
310
251
|
/**
|
|
311
|
-
* @typedef
|
|
252
|
+
* @typedef Zone
|
|
253
|
+
* @property {string} zone_id
|
|
254
|
+
* @property {string} type
|
|
312
255
|
* @property {string} name
|
|
313
|
-
* @property {string}
|
|
314
|
-
* @property {string}
|
|
256
|
+
* @property {string[]} tags
|
|
257
|
+
* @property {string} slug
|
|
258
|
+
* @property {boolean} is_active
|
|
259
|
+
* @property {number[]} store_ids
|
|
260
|
+
* @property {string} assignment_preference
|
|
315
261
|
*/
|
|
316
262
|
|
|
317
263
|
/**
|
|
318
|
-
* @typedef
|
|
319
|
-
* @property {
|
|
320
|
-
* @property {
|
|
321
|
-
* @property {number} item_total
|
|
322
|
-
* @property {number} size
|
|
323
|
-
* @property {string} type
|
|
264
|
+
* @typedef GetZoneFromPincodeViewResponse
|
|
265
|
+
* @property {string} serviceability_type
|
|
266
|
+
* @property {Zone[]} zones
|
|
324
267
|
*/
|
|
325
268
|
|
|
326
269
|
/**
|
|
327
|
-
* @typedef
|
|
328
|
-
* @property {
|
|
329
|
-
* @property {
|
|
270
|
+
* @typedef GetZoneFromApplicationIdViewResponse
|
|
271
|
+
* @property {ZoneDataItem[]} page
|
|
272
|
+
* @property {ListViewItems[]} items
|
|
330
273
|
*/
|
|
331
274
|
|
|
332
275
|
/**
|
|
333
|
-
* @typedef
|
|
334
|
-
* @property {
|
|
335
|
-
* @property {
|
|
336
|
-
* @property {
|
|
337
|
-
* @property {
|
|
276
|
+
* @typedef ServiceabilityPageResponse
|
|
277
|
+
* @property {string} [type]
|
|
278
|
+
* @property {boolean} [has_next]
|
|
279
|
+
* @property {number} [item_total]
|
|
280
|
+
* @property {number} [size]
|
|
281
|
+
* @property {number} [current]
|
|
338
282
|
*/
|
|
339
283
|
|
|
340
284
|
/**
|
|
341
|
-
* @typedef
|
|
342
|
-
* @property {string} [
|
|
343
|
-
* @property {
|
|
344
|
-
* @property {string} [value]
|
|
285
|
+
* @typedef MobileNo
|
|
286
|
+
* @property {string} [number]
|
|
287
|
+
* @property {number} [country_code]
|
|
345
288
|
*/
|
|
346
289
|
|
|
347
290
|
/**
|
|
348
|
-
* @typedef
|
|
349
|
-
* @property {string}
|
|
350
|
-
* @property {
|
|
351
|
-
* @property {string}
|
|
291
|
+
* @typedef ManagerResponse
|
|
292
|
+
* @property {string} [email]
|
|
293
|
+
* @property {MobileNo} [mobile_no]
|
|
294
|
+
* @property {string} [name]
|
|
352
295
|
*/
|
|
353
296
|
|
|
354
297
|
/**
|
|
355
|
-
* @typedef
|
|
356
|
-
* @property {
|
|
298
|
+
* @typedef ModifiedByResponse
|
|
299
|
+
* @property {string} [username]
|
|
300
|
+
* @property {string} [user_id]
|
|
357
301
|
*/
|
|
358
302
|
|
|
359
303
|
/**
|
|
360
|
-
* @typedef
|
|
361
|
-
* @property {
|
|
362
|
-
* @property {
|
|
304
|
+
* @typedef IntegrationTypeResponse
|
|
305
|
+
* @property {string} [inventory]
|
|
306
|
+
* @property {string} [order]
|
|
363
307
|
*/
|
|
364
308
|
|
|
365
309
|
/**
|
|
366
|
-
* @typedef
|
|
367
|
-
* @property {
|
|
368
|
-
* @property {PageSchema[]} page
|
|
310
|
+
* @typedef ProductReturnConfigResponse
|
|
311
|
+
* @property {boolean} [on_same_store]
|
|
369
312
|
*/
|
|
370
313
|
|
|
371
314
|
/**
|
|
372
|
-
* @typedef
|
|
373
|
-
* @property {
|
|
315
|
+
* @typedef ContactNumberResponse
|
|
316
|
+
* @property {string} [number]
|
|
317
|
+
* @property {number} [country_code]
|
|
374
318
|
*/
|
|
375
319
|
|
|
376
320
|
/**
|
|
377
|
-
* @typedef
|
|
378
|
-
* @property {
|
|
379
|
-
* @property {
|
|
321
|
+
* @typedef AddressResponse
|
|
322
|
+
* @property {string} [city]
|
|
323
|
+
* @property {string} [address1]
|
|
324
|
+
* @property {number} [pincode]
|
|
325
|
+
* @property {string} [address2]
|
|
326
|
+
* @property {string} [landmark]
|
|
327
|
+
* @property {string} [state]
|
|
328
|
+
* @property {string} [country]
|
|
329
|
+
* @property {number} [latitude]
|
|
330
|
+
* @property {number} [longitude]
|
|
380
331
|
*/
|
|
381
332
|
|
|
382
333
|
/**
|
|
383
|
-
* @typedef
|
|
384
|
-
* @property {
|
|
385
|
-
* @property {
|
|
334
|
+
* @typedef CreatedByResponse
|
|
335
|
+
* @property {string} [username]
|
|
336
|
+
* @property {string} [user_id]
|
|
386
337
|
*/
|
|
387
338
|
|
|
388
339
|
/**
|
|
389
|
-
* @typedef
|
|
390
|
-
* @property {
|
|
391
|
-
* @property {GetZoneDataViewChannels[]} channels
|
|
392
|
-
* @property {number} [company_id]
|
|
393
|
-
* @property {boolean} is_active
|
|
394
|
-
* @property {ZoneMappingType[]} mapping
|
|
395
|
-
* @property {string} name
|
|
396
|
-
* @property {ZoneProductTypes} product
|
|
397
|
-
* @property {string} region_type
|
|
398
|
-
* @property {string} slug
|
|
399
|
-
* @property {number[]} store_ids
|
|
400
|
-
* @property {number} stores_count
|
|
401
|
-
* @property {string} zone_id
|
|
340
|
+
* @typedef EwayBillResponse
|
|
341
|
+
* @property {boolean} [enabled]
|
|
402
342
|
*/
|
|
403
343
|
|
|
404
344
|
/**
|
|
405
|
-
* @typedef
|
|
406
|
-
* @property {
|
|
407
|
-
* @property {string} channel_type
|
|
345
|
+
* @typedef EinvoiceResponse
|
|
346
|
+
* @property {boolean} [enabled]
|
|
408
347
|
*/
|
|
409
348
|
|
|
410
349
|
/**
|
|
411
|
-
* @typedef
|
|
412
|
-
* @property {
|
|
413
|
-
* @property {
|
|
414
|
-
* @property {number} [company_id]
|
|
415
|
-
* @property {boolean} is_active
|
|
416
|
-
* @property {ZoneMappingType[]} mapping
|
|
417
|
-
* @property {string} name
|
|
418
|
-
* @property {ZoneProductTypes} product
|
|
419
|
-
* @property {string} [region_type]
|
|
420
|
-
* @property {string} slug
|
|
421
|
-
* @property {number[]} store_ids
|
|
422
|
-
* @property {number} stores_count
|
|
423
|
-
* @property {string} zone_id
|
|
350
|
+
* @typedef GstCredentialsResponse
|
|
351
|
+
* @property {EwayBillResponse} [e_waybill]
|
|
352
|
+
* @property {EinvoiceResponse} [e_invoice]
|
|
424
353
|
*/
|
|
425
354
|
|
|
426
355
|
/**
|
|
427
|
-
* @typedef
|
|
428
|
-
* @property {
|
|
429
|
-
* @property {ZoneDataItem[]} page
|
|
356
|
+
* @typedef WarningsResponse
|
|
357
|
+
* @property {string} [store_address]
|
|
430
358
|
*/
|
|
431
359
|
|
|
432
360
|
/**
|
|
433
|
-
* @typedef
|
|
434
|
-
* @property {
|
|
435
|
-
* @property {
|
|
361
|
+
* @typedef OpeningClosing
|
|
362
|
+
* @property {number} [minute]
|
|
363
|
+
* @property {number} [hour]
|
|
436
364
|
*/
|
|
437
365
|
|
|
438
366
|
/**
|
|
439
|
-
* @typedef
|
|
440
|
-
* @property {
|
|
441
|
-
* @property {
|
|
367
|
+
* @typedef TimmingResponse
|
|
368
|
+
* @property {boolean} [open]
|
|
369
|
+
* @property {string} [weekday]
|
|
370
|
+
* @property {OpeningClosing} [closing]
|
|
371
|
+
* @property {OpeningClosing} [opening]
|
|
442
372
|
*/
|
|
443
373
|
|
|
444
374
|
/**
|
|
445
|
-
* @typedef
|
|
446
|
-
* @property {
|
|
447
|
-
* @property {
|
|
375
|
+
* @typedef DocumentsResponse
|
|
376
|
+
* @property {string} [legal_name]
|
|
377
|
+
* @property {string} [value]
|
|
378
|
+
* @property {string} [type]
|
|
379
|
+
* @property {boolean} [verified]
|
|
448
380
|
*/
|
|
449
381
|
|
|
450
382
|
/**
|
|
451
|
-
* @typedef
|
|
452
|
-
* @property {number
|
|
383
|
+
* @typedef Dp
|
|
384
|
+
* @property {number} [fm_priority]
|
|
385
|
+
* @property {number} [rvp_priority]
|
|
386
|
+
* @property {number} [lm_priority]
|
|
387
|
+
* @property {string} [internal_account_id]
|
|
388
|
+
* @property {number} [area_code]
|
|
389
|
+
* @property {string} [payment_mode]
|
|
390
|
+
* @property {string[]} [operations]
|
|
391
|
+
* @property {string} [external_account_id]
|
|
392
|
+
* @property {string} [transport_mode]
|
|
393
|
+
* @property {boolean} [assign_dp_from_sb]
|
|
453
394
|
*/
|
|
454
395
|
|
|
455
396
|
/**
|
|
456
|
-
* @typedef
|
|
457
|
-
* @property {
|
|
458
|
-
* @property {
|
|
397
|
+
* @typedef LogisticsResponse
|
|
398
|
+
* @property {boolean} [override]
|
|
399
|
+
* @property {Dp} [dp]
|
|
459
400
|
*/
|
|
460
401
|
|
|
461
402
|
/**
|
|
462
403
|
* @typedef ItemResponse
|
|
463
|
-
* @property {string} [_cls]
|
|
464
|
-
* @property {Object} [_custom_json]
|
|
465
|
-
* @property {AddressResponse} [address]
|
|
466
|
-
* @property {string} [code]
|
|
467
|
-
* @property {number} [company]
|
|
468
|
-
* @property {number} [company_id]
|
|
469
|
-
* @property {ContactNumberResponse[]} [contact_numbers]
|
|
470
|
-
* @property {CreatedByResponse} [created_by]
|
|
471
404
|
* @property {string} [created_on]
|
|
472
|
-
* @property {string} [display_name]
|
|
473
|
-
* @property {DocumentsResponse[]} [documents]
|
|
474
|
-
* @property {GstCredentialsResponse} [gst_credentials]
|
|
475
|
-
* @property {IntegrationTypeResponse} [integration_type]
|
|
476
|
-
* @property {LogisticsResponse} [logistics]
|
|
477
405
|
* @property {ManagerResponse} [manager]
|
|
478
406
|
* @property {ModifiedByResponse} [modified_by]
|
|
479
|
-
* @property {
|
|
480
|
-
* @property {string} [
|
|
481
|
-
* @property {string[]} [notification_emails]
|
|
407
|
+
* @property {IntegrationTypeResponse} [integration_type]
|
|
408
|
+
* @property {string} [verified_on]
|
|
482
409
|
* @property {ProductReturnConfigResponse} [product_return_config]
|
|
410
|
+
* @property {ContactNumberResponse[]} [contact_numbers]
|
|
411
|
+
* @property {ModifiedByResponse} [verified_by]
|
|
483
412
|
* @property {string} [stage]
|
|
484
|
-
* @property {
|
|
485
|
-
* @property {string} [
|
|
486
|
-
* @property {
|
|
413
|
+
* @property {AddressResponse} [address]
|
|
414
|
+
* @property {string} [modified_on]
|
|
415
|
+
* @property {CreatedByResponse} [created_by]
|
|
416
|
+
* @property {GstCredentialsResponse} [gst_credentials]
|
|
417
|
+
* @property {string} [display_name]
|
|
418
|
+
* @property {number} [company_id]
|
|
487
419
|
* @property {number} [uid]
|
|
488
|
-
* @property {
|
|
489
|
-
* @property {string} [
|
|
420
|
+
* @property {Object} [_custom_json]
|
|
421
|
+
* @property {string} [code]
|
|
490
422
|
* @property {WarningsResponse} [warnings]
|
|
423
|
+
* @property {string} [name]
|
|
424
|
+
* @property {TimmingResponse[]} [timing]
|
|
425
|
+
* @property {DocumentsResponse[]} [documents]
|
|
426
|
+
* @property {string} [store_type]
|
|
427
|
+
* @property {string} [sub_type]
|
|
428
|
+
* @property {number} [company]
|
|
429
|
+
* @property {string} [_cls]
|
|
430
|
+
* @property {LogisticsResponse} [logistics]
|
|
431
|
+
* @property {string[]} [notification_emails]
|
|
491
432
|
*/
|
|
492
433
|
|
|
493
434
|
/**
|
|
494
|
-
* @typedef
|
|
495
|
-
* @property {
|
|
496
|
-
* @property {
|
|
497
|
-
*/
|
|
498
|
-
|
|
499
|
-
/**
|
|
500
|
-
* @typedef ListViewItems
|
|
501
|
-
* @property {ListViewChannels[]} channels
|
|
502
|
-
* @property {number} company_id
|
|
503
|
-
* @property {boolean} is_active
|
|
504
|
-
* @property {string} name
|
|
505
|
-
* @property {ListViewProduct} product
|
|
506
|
-
* @property {number} regions_count
|
|
507
|
-
* @property {string} slug
|
|
508
|
-
* @property {number} stores_count
|
|
509
|
-
* @property {string} zone_id
|
|
435
|
+
* @typedef GetStoresViewResponse
|
|
436
|
+
* @property {ServiceabilityPageResponse} page
|
|
437
|
+
* @property {ItemResponse[]} [items]
|
|
510
438
|
*/
|
|
511
439
|
|
|
512
440
|
/**
|
|
513
|
-
* @typedef
|
|
514
|
-
* @property {
|
|
515
|
-
* @property {string}
|
|
441
|
+
* @typedef ReAssignStoreRequest
|
|
442
|
+
* @property {string} to_pincode
|
|
443
|
+
* @property {string} identifier
|
|
444
|
+
* @property {Object} configuration
|
|
445
|
+
* @property {string[]} ignored_locations
|
|
446
|
+
* @property {Object[]} articles
|
|
516
447
|
*/
|
|
517
448
|
|
|
518
449
|
/**
|
|
519
|
-
* @typedef
|
|
520
|
-
* @property {
|
|
521
|
-
* @property {
|
|
450
|
+
* @typedef ReAssignStoreResponse
|
|
451
|
+
* @property {string} to_pincode
|
|
452
|
+
* @property {boolean} success
|
|
453
|
+
* @property {Object} error
|
|
454
|
+
* @property {Object[]} [articles]
|
|
522
455
|
*/
|
|
523
456
|
|
|
524
457
|
/**
|
|
525
|
-
* @typedef
|
|
526
|
-
* @property {number}
|
|
527
|
-
* @property {
|
|
528
|
-
* @property {
|
|
458
|
+
* @typedef PincodeMopData
|
|
459
|
+
* @property {number[]} pincodes
|
|
460
|
+
* @property {string} country
|
|
461
|
+
* @property {string} action
|
|
529
462
|
*/
|
|
530
463
|
|
|
531
464
|
/**
|
|
532
|
-
* @typedef
|
|
533
|
-
* @property {
|
|
534
|
-
* @property {string}
|
|
465
|
+
* @typedef PincodeMopUpdateResponse
|
|
466
|
+
* @property {number} pincode
|
|
467
|
+
* @property {string} channel_id
|
|
468
|
+
* @property {string} country
|
|
469
|
+
* @property {boolean} is_active
|
|
535
470
|
*/
|
|
536
471
|
|
|
537
472
|
/**
|
|
538
|
-
* @typedef
|
|
539
|
-
* @property {
|
|
540
|
-
* @property {
|
|
541
|
-
* @property {string}
|
|
542
|
-
* @property {string}
|
|
543
|
-
* @property {string
|
|
544
|
-
* @property {
|
|
473
|
+
* @typedef PincodeMOPresponse
|
|
474
|
+
* @property {boolean} success
|
|
475
|
+
* @property {number} status_code
|
|
476
|
+
* @property {string} batch_id
|
|
477
|
+
* @property {string} country
|
|
478
|
+
* @property {string} action
|
|
479
|
+
* @property {number[]} [pincodes]
|
|
480
|
+
* @property {PincodeMopUpdateResponse[]} [updated_pincodes]
|
|
545
481
|
*/
|
|
546
482
|
|
|
547
483
|
/**
|
|
548
|
-
* @typedef
|
|
549
|
-
* @property {
|
|
550
|
-
* @property {
|
|
484
|
+
* @typedef CommonError
|
|
485
|
+
* @property {string} [status_code]
|
|
486
|
+
* @property {Object} [error]
|
|
487
|
+
* @property {string} [success]
|
|
551
488
|
*/
|
|
552
489
|
|
|
553
490
|
/**
|
|
554
|
-
* @typedef
|
|
555
|
-
* @property {string}
|
|
556
|
-
* @property {
|
|
557
|
-
* @property {string} [name]
|
|
491
|
+
* @typedef PincodeMopBulkData
|
|
492
|
+
* @property {string} batch_id
|
|
493
|
+
* @property {string} s3_url
|
|
558
494
|
*/
|
|
559
495
|
|
|
560
496
|
/**
|
|
561
|
-
* @typedef
|
|
562
|
-
* @property {
|
|
563
|
-
* @property {string}
|
|
497
|
+
* @typedef PincodeBulkViewResponse
|
|
498
|
+
* @property {string} batch_id
|
|
499
|
+
* @property {string} s3_url
|
|
564
500
|
*/
|
|
565
501
|
|
|
566
502
|
/**
|
|
567
|
-
* @typedef
|
|
568
|
-
* @property {string} [
|
|
569
|
-
* @property {
|
|
503
|
+
* @typedef PincodeCodStatusListingRequest
|
|
504
|
+
* @property {string} [country]
|
|
505
|
+
* @property {boolean} [is_active]
|
|
506
|
+
* @property {number} [pincode]
|
|
507
|
+
* @property {number} [current]
|
|
508
|
+
* @property {number} [page_size]
|
|
570
509
|
*/
|
|
571
510
|
|
|
572
511
|
/**
|
|
573
|
-
* @typedef
|
|
574
|
-
* @property {
|
|
575
|
-
* @property {
|
|
512
|
+
* @typedef PincodeCodStatusListingResponse
|
|
513
|
+
* @property {string} country
|
|
514
|
+
* @property {PincodeCodStatusListingResponse[]} data
|
|
515
|
+
* @property {boolean} success
|
|
516
|
+
* @property {Error[]} [errors]
|
|
517
|
+
* @property {PincodeCodStatusListingPage} page
|
|
518
|
+
* @property {PincodeCodStatusListingSummary} summary
|
|
576
519
|
*/
|
|
577
520
|
|
|
578
521
|
/**
|
|
579
|
-
* @typedef
|
|
580
|
-
* @property {
|
|
581
|
-
* @property {
|
|
582
|
-
* @property {
|
|
583
|
-
* @property {number} height
|
|
584
|
-
* @property {number} length
|
|
585
|
-
* @property {number} [max_weight]
|
|
586
|
-
* @property {string[]} [media]
|
|
587
|
-
* @property {string} name
|
|
588
|
-
* @property {string} package_type
|
|
589
|
-
* @property {number} [package_vol_weight]
|
|
590
|
-
* @property {PackageMaterialRule[]} [rules]
|
|
591
|
-
* @property {string} size
|
|
592
|
-
* @property {string} status
|
|
593
|
-
* @property {number[]} store_ids
|
|
594
|
-
* @property {boolean} [track_inventory]
|
|
595
|
-
* @property {number} weight
|
|
596
|
-
* @property {number} width
|
|
522
|
+
* @typedef Error
|
|
523
|
+
* @property {string} [type]
|
|
524
|
+
* @property {string} [value]
|
|
525
|
+
* @property {string} [message]
|
|
597
526
|
*/
|
|
598
527
|
|
|
599
528
|
/**
|
|
600
|
-
* @typedef
|
|
601
|
-
* @property {
|
|
602
|
-
* @property {
|
|
529
|
+
* @typedef PincodeCodStatusListingPage
|
|
530
|
+
* @property {string} type
|
|
531
|
+
* @property {boolean} has_next
|
|
532
|
+
* @property {number} item_total
|
|
533
|
+
* @property {number} size
|
|
534
|
+
* @property {number} current
|
|
603
535
|
*/
|
|
604
536
|
|
|
605
537
|
/**
|
|
606
|
-
* @typedef
|
|
607
|
-
* @property {
|
|
608
|
-
* @property {
|
|
609
|
-
* @property {number} error_rate
|
|
610
|
-
* @property {number} height
|
|
611
|
-
* @property {string} [id]
|
|
612
|
-
* @property {number} [item_id]
|
|
613
|
-
* @property {number} length
|
|
614
|
-
* @property {number} [max_weight]
|
|
615
|
-
* @property {string[]} [media]
|
|
616
|
-
* @property {string} name
|
|
617
|
-
* @property {string} package_type
|
|
618
|
-
* @property {number} [package_vol_weight]
|
|
619
|
-
* @property {PackageMaterialRule[]} [rules]
|
|
620
|
-
* @property {string} size
|
|
621
|
-
* @property {string} status
|
|
622
|
-
* @property {number[]} store_ids
|
|
623
|
-
* @property {boolean} [track_inventory]
|
|
624
|
-
* @property {number} weight
|
|
625
|
-
* @property {number} width
|
|
538
|
+
* @typedef PincodeCodStatusListingSummary
|
|
539
|
+
* @property {number} total_active_pincodes
|
|
540
|
+
* @property {number} total_inactive_pincodes
|
|
626
541
|
*/
|
|
627
542
|
|
|
628
543
|
/**
|
|
629
|
-
* @typedef
|
|
630
|
-
* @property {
|
|
631
|
-
* @property {string} [
|
|
632
|
-
* @property {number} [weight]
|
|
544
|
+
* @typedef PincodeMopUpdateAuditHistoryRequest
|
|
545
|
+
* @property {string} entity_type
|
|
546
|
+
* @property {string} [file_name]
|
|
633
547
|
*/
|
|
634
548
|
|
|
635
549
|
/**
|
|
636
|
-
* @typedef
|
|
637
|
-
* @property {
|
|
638
|
-
* @property {
|
|
550
|
+
* @typedef PincodeMopUpdateAuditHistoryPaging
|
|
551
|
+
* @property {string} [type]
|
|
552
|
+
* @property {number} [size]
|
|
553
|
+
* @property {number} [current]
|
|
554
|
+
* @property {boolean} [has_next]
|
|
555
|
+
* @property {number} [item_total]
|
|
639
556
|
*/
|
|
640
557
|
|
|
641
558
|
/**
|
|
642
|
-
* @typedef
|
|
643
|
-
* @property {
|
|
644
|
-
* @property {
|
|
559
|
+
* @typedef PincodeMopUpdateAuditHistoryResponse
|
|
560
|
+
* @property {string} [batch_id]
|
|
561
|
+
* @property {string} [entity_type]
|
|
562
|
+
* @property {string} [error_file_s3_url]
|
|
563
|
+
* @property {string} [s3_url]
|
|
564
|
+
* @property {string} [file_name]
|
|
565
|
+
* @property {string} [updated_at]
|
|
566
|
+
* @property {string} [updated_by]
|
|
567
|
+
* @property {boolean} [success]
|
|
645
568
|
*/
|
|
646
569
|
|
|
647
570
|
/**
|
|
648
|
-
* @typedef
|
|
649
|
-
* @property {
|
|
650
|
-
* @property {
|
|
651
|
-
* @property {
|
|
652
|
-
* @property {string} name
|
|
653
|
-
* @property {PackageRuleProduct} [product_id]
|
|
654
|
-
* @property {PackageRuleProductTag} [product_tag]
|
|
655
|
-
* @property {string} type
|
|
571
|
+
* @typedef PincodeMopUpdateAuditHistoryResponseData
|
|
572
|
+
* @property {string} [entity_type]
|
|
573
|
+
* @property {PincodeMopUpdateAuditHistoryPaging} page
|
|
574
|
+
* @property {PincodeMopUpdateAuditHistoryResponse[]} data
|
|
656
575
|
*/
|
|
657
576
|
|
|
658
577
|
/**
|
|
659
|
-
* @typedef
|
|
660
|
-
* @property {number
|
|
578
|
+
* @typedef ArithmeticOperations
|
|
579
|
+
* @property {number} [lt]
|
|
580
|
+
* @property {number} [gt]
|
|
581
|
+
* @property {number} [lte]
|
|
582
|
+
* @property {number} [gte]
|
|
661
583
|
*/
|
|
662
584
|
|
|
663
585
|
/**
|
|
664
|
-
* @typedef
|
|
665
|
-
* @property {
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
* @
|
|
670
|
-
* @property {
|
|
586
|
+
* @typedef SchemeRulesFeatures
|
|
587
|
+
* @property {boolean} [quality_check]
|
|
588
|
+
* @property {boolean} [quick_response_code]
|
|
589
|
+
* @property {boolean} [e_waybill]
|
|
590
|
+
* @property {boolean} [multi_part_shipments]
|
|
591
|
+
* @property {boolean} [flammable]
|
|
592
|
+
* @property {boolean} [hazmat]
|
|
593
|
+
* @property {boolean} [battery_operated]
|
|
671
594
|
*/
|
|
672
595
|
|
|
673
596
|
/**
|
|
674
|
-
* @typedef
|
|
675
|
-
* @property {
|
|
676
|
-
* @property {
|
|
677
|
-
* @property {string} [
|
|
678
|
-
* @property {
|
|
679
|
-
* @property {
|
|
680
|
-
* @property {PackageRuleProduct} [product_id]
|
|
681
|
-
* @property {PackageRuleProductTag} [product_tag]
|
|
682
|
-
* @property {string} type
|
|
597
|
+
* @typedef SchemeRules
|
|
598
|
+
* @property {ArithmeticOperations} [weight]
|
|
599
|
+
* @property {string[]} [transport_type]
|
|
600
|
+
* @property {string} [region]
|
|
601
|
+
* @property {string[]} [payment_mode]
|
|
602
|
+
* @property {SchemeRulesFeatures} [feature]
|
|
683
603
|
*/
|
|
684
604
|
|
|
685
605
|
/**
|
|
686
|
-
* @typedef
|
|
687
|
-
* @property {
|
|
688
|
-
* @property {
|
|
689
|
-
* @property {
|
|
690
|
-
* @property {
|
|
691
|
-
* @property {string}
|
|
692
|
-
* @property {
|
|
693
|
-
* @property {string} type
|
|
606
|
+
* @typedef CourierAccount
|
|
607
|
+
* @property {string} extension_id
|
|
608
|
+
* @property {string} account_id
|
|
609
|
+
* @property {string} scheme_id
|
|
610
|
+
* @property {boolean} is_self_ship
|
|
611
|
+
* @property {string} stage
|
|
612
|
+
* @property {boolean} is_own_account
|
|
694
613
|
*/
|
|
695
614
|
|
|
696
615
|
/**
|
|
697
|
-
* @typedef
|
|
698
|
-
* @property {
|
|
699
|
-
* @property {
|
|
700
|
-
* @property {number} item_total
|
|
701
|
-
* @property {number} size
|
|
616
|
+
* @typedef ErrorResponse
|
|
617
|
+
* @property {string} value
|
|
618
|
+
* @property {string} message
|
|
702
619
|
* @property {string} type
|
|
703
620
|
*/
|
|
704
621
|
|
|
705
622
|
/**
|
|
706
|
-
* @typedef
|
|
707
|
-
* @property {
|
|
708
|
-
* @property {
|
|
623
|
+
* @typedef CourierPartnerAccountFailureResponse
|
|
624
|
+
* @property {boolean} success
|
|
625
|
+
* @property {ErrorResponse[]} error
|
|
709
626
|
*/
|
|
710
627
|
|
|
711
628
|
/**
|
|
712
|
-
* @typedef
|
|
713
|
-
* @property {number}
|
|
714
|
-
* @property {
|
|
715
|
-
* @property {
|
|
716
|
-
* @property {
|
|
629
|
+
* @typedef Page
|
|
630
|
+
* @property {number} [item_total]
|
|
631
|
+
* @property {string} [next_id]
|
|
632
|
+
* @property {boolean} [has_previous]
|
|
633
|
+
* @property {boolean} [has_next]
|
|
634
|
+
* @property {number} [current]
|
|
717
635
|
* @property {string} type
|
|
636
|
+
* @property {number} [size]
|
|
718
637
|
*/
|
|
719
638
|
|
|
720
639
|
/**
|
|
721
|
-
* @typedef
|
|
722
|
-
* @property {string}
|
|
723
|
-
* @property {
|
|
724
|
-
* @property {
|
|
725
|
-
* @property {
|
|
726
|
-
* @property {number} [pincode]
|
|
640
|
+
* @typedef CourierPartnerList
|
|
641
|
+
* @property {string} extension_id
|
|
642
|
+
* @property {string} account_id
|
|
643
|
+
* @property {string} name
|
|
644
|
+
* @property {boolean} is_self_ship
|
|
727
645
|
*/
|
|
728
646
|
|
|
729
647
|
/**
|
|
730
|
-
* @typedef
|
|
731
|
-
* @property {string}
|
|
732
|
-
* @property {
|
|
733
|
-
* @property {
|
|
734
|
-
* @property {
|
|
735
|
-
* @property {
|
|
736
|
-
* @property {
|
|
648
|
+
* @typedef LocationRuleValues
|
|
649
|
+
* @property {string} id
|
|
650
|
+
* @property {string} [sub_type]
|
|
651
|
+
* @property {string} [name]
|
|
652
|
+
* @property {string} [display_name]
|
|
653
|
+
* @property {string} [parent_id]
|
|
654
|
+
* @property {string[]} [parent_ids]
|
|
737
655
|
*/
|
|
738
656
|
|
|
739
657
|
/**
|
|
740
|
-
* @typedef
|
|
741
|
-
* @property {
|
|
742
|
-
* @property {
|
|
658
|
+
* @typedef LocationRule
|
|
659
|
+
* @property {string} [type]
|
|
660
|
+
* @property {LocationRuleValues[]} [includes]
|
|
743
661
|
*/
|
|
744
662
|
|
|
745
663
|
/**
|
|
746
|
-
* @typedef
|
|
747
|
-
* @property {string}
|
|
748
|
-
* @property {string} s3_url
|
|
664
|
+
* @typedef StringComparisonOperations
|
|
665
|
+
* @property {string[]} [includes]
|
|
749
666
|
*/
|
|
750
667
|
|
|
751
668
|
/**
|
|
752
|
-
* @typedef
|
|
753
|
-
* @property {
|
|
754
|
-
* @property {string} country
|
|
755
|
-
* @property {number[]} pincodes
|
|
669
|
+
* @typedef IntComparisonOperations
|
|
670
|
+
* @property {number[]} [includes]
|
|
756
671
|
*/
|
|
757
672
|
|
|
758
673
|
/**
|
|
759
|
-
* @typedef
|
|
760
|
-
* @property {
|
|
761
|
-
* @property {
|
|
762
|
-
* @property {
|
|
763
|
-
* @property {
|
|
764
|
-
* @property {
|
|
765
|
-
* @property {
|
|
766
|
-
* @property {
|
|
674
|
+
* @typedef CourierPartnerRuleConditions
|
|
675
|
+
* @property {LocationRule} [forward]
|
|
676
|
+
* @property {LocationRule} [reverse]
|
|
677
|
+
* @property {StringComparisonOperations} [payment_mode]
|
|
678
|
+
* @property {IntComparisonOperations} [category_ids]
|
|
679
|
+
* @property {IntComparisonOperations} [product_ids]
|
|
680
|
+
* @property {StringComparisonOperations} [product_tags]
|
|
681
|
+
* @property {StringComparisonOperations} [zone_ids]
|
|
682
|
+
* @property {IntComparisonOperations} [department_ids]
|
|
683
|
+
* @property {IntComparisonOperations} [brand_ids]
|
|
684
|
+
* @property {ArithmeticOperations} [order_place_date]
|
|
685
|
+
* @property {IntComparisonOperations} [store_ids]
|
|
686
|
+
* @property {StringComparisonOperations} [store_type]
|
|
687
|
+
* @property {StringComparisonOperations} [store_tags]
|
|
688
|
+
* @property {ArithmeticOperations} [shipment_weight]
|
|
689
|
+
* @property {ArithmeticOperations} [shipment_cost]
|
|
690
|
+
* @property {ArithmeticOperations} [shipment_volumetric_weight]
|
|
767
691
|
*/
|
|
768
692
|
|
|
769
693
|
/**
|
|
770
|
-
* @typedef
|
|
771
|
-
* @property {
|
|
772
|
-
* @property {
|
|
773
|
-
* @property {
|
|
774
|
-
* @property {
|
|
775
|
-
* @property {string}
|
|
694
|
+
* @typedef CourierPartnerRule
|
|
695
|
+
* @property {boolean} is_active
|
|
696
|
+
* @property {CourierPartnerList[]} [cp_list]
|
|
697
|
+
* @property {string} name
|
|
698
|
+
* @property {CourierPartnerRuleConditions} conditions
|
|
699
|
+
* @property {string[]} sort
|
|
776
700
|
*/
|
|
777
701
|
|
|
778
702
|
/**
|
|
779
|
-
* @typedef
|
|
780
|
-
* @property {
|
|
781
|
-
* @property {
|
|
703
|
+
* @typedef FailureResponse
|
|
704
|
+
* @property {boolean} success
|
|
705
|
+
* @property {ErrorResponse[]} error
|
|
782
706
|
*/
|
|
783
707
|
|
|
784
708
|
/**
|
|
785
|
-
* @typedef
|
|
786
|
-
* @property {
|
|
787
|
-
* @property {
|
|
788
|
-
* @property {string} [error_file_s3_url]
|
|
789
|
-
* @property {string} [file_name]
|
|
790
|
-
* @property {string} [s3_url]
|
|
791
|
-
* @property {boolean} [success]
|
|
792
|
-
* @property {string} [updated_at]
|
|
793
|
-
* @property {string} [updated_by]
|
|
709
|
+
* @typedef CourierPartnerRulesListResponse
|
|
710
|
+
* @property {CourierPartnerRule[]} items
|
|
711
|
+
* @property {Page} page
|
|
794
712
|
*/
|
|
795
713
|
|
|
796
714
|
/**
|
|
797
|
-
* @typedef
|
|
798
|
-
* @property {
|
|
799
|
-
* @property {string}
|
|
800
|
-
* @property {
|
|
715
|
+
* @typedef CompanyConfig
|
|
716
|
+
* @property {string[]} rule_ids
|
|
717
|
+
* @property {string[]} sort
|
|
718
|
+
* @property {boolean} [logistics_as_actual]
|
|
801
719
|
*/
|
|
802
720
|
|
|
803
721
|
/**
|
|
804
|
-
* @typedef
|
|
805
|
-
* @property {string}
|
|
806
|
-
* @property {string} country
|
|
807
|
-
* @property {boolean} is_active
|
|
808
|
-
* @property {number} pincode
|
|
722
|
+
* @typedef ZoneConfig
|
|
723
|
+
* @property {string} [serviceability_type]
|
|
809
724
|
*/
|
|
810
725
|
|
|
811
726
|
/**
|
|
812
|
-
* @typedef
|
|
813
|
-
* @property {
|
|
727
|
+
* @typedef ApplicationConfig
|
|
728
|
+
* @property {string[]} [rule_ids]
|
|
729
|
+
* @property {string[]} [sort]
|
|
730
|
+
* @property {ZoneConfig} [zones]
|
|
814
731
|
*/
|
|
815
732
|
|
|
816
733
|
/**
|
|
817
|
-
* @typedef
|
|
818
|
-
* @property {
|
|
819
|
-
* @property {
|
|
820
|
-
* @property {string}
|
|
821
|
-
* @property {string
|
|
822
|
-
* @property {string} to_pincode
|
|
734
|
+
* @typedef BulkRegionJobSerializer
|
|
735
|
+
* @property {string} [file_path]
|
|
736
|
+
* @property {string} country
|
|
737
|
+
* @property {string} action
|
|
738
|
+
* @property {string} region
|
|
823
739
|
*/
|
|
824
740
|
|
|
825
741
|
/**
|
|
826
|
-
* @typedef
|
|
827
|
-
* @property {
|
|
828
|
-
* @property {
|
|
829
|
-
* @property {
|
|
830
|
-
* @property {string}
|
|
742
|
+
* @typedef BulkRegionResponseItemData
|
|
743
|
+
* @property {string} file_path
|
|
744
|
+
* @property {number} [failed]
|
|
745
|
+
* @property {Object[]} [failed_records]
|
|
746
|
+
* @property {string} action
|
|
747
|
+
* @property {string} batch_id
|
|
748
|
+
* @property {string} country
|
|
749
|
+
* @property {number} [success]
|
|
750
|
+
* @property {string} region
|
|
751
|
+
* @property {string} status
|
|
752
|
+
* @property {number} [total]
|
|
753
|
+
* @property {string} [error_file_path]
|
|
831
754
|
*/
|
|
832
755
|
|
|
833
756
|
/**
|
|
834
|
-
* @typedef
|
|
835
|
-
* @property {
|
|
836
|
-
* @property {
|
|
757
|
+
* @typedef BulkRegionResponse
|
|
758
|
+
* @property {BulkRegionResponseItemData[]} items
|
|
759
|
+
* @property {Page} page
|
|
837
760
|
*/
|
|
838
761
|
|
|
839
762
|
/**
|
|
840
|
-
* @typedef
|
|
841
|
-
* @property {boolean}
|
|
763
|
+
* @typedef SelfShipResponse
|
|
764
|
+
* @property {boolean} is_active
|
|
765
|
+
* @property {number} tat
|
|
842
766
|
*/
|
|
843
767
|
|
|
844
768
|
/**
|
|
845
|
-
* @typedef
|
|
846
|
-
* @property {
|
|
847
|
-
* @property {string[]} [payment_mode]
|
|
848
|
-
* @property {string} [region]
|
|
849
|
-
* @property {string[]} [transport_type]
|
|
850
|
-
* @property {ArithmeticOperations} [weight]
|
|
769
|
+
* @typedef ApplicationSelfShipConfig
|
|
770
|
+
* @property {Object} [self_ship]
|
|
851
771
|
*/
|
|
852
772
|
|
|
853
773
|
/**
|
|
854
|
-
* @typedef
|
|
855
|
-
* @property {
|
|
856
|
-
* @property {
|
|
857
|
-
* @property {boolean}
|
|
858
|
-
* @property {boolean} [hazmat]
|
|
859
|
-
* @property {boolean} [multi_part_shipments]
|
|
860
|
-
* @property {boolean} [quality_check]
|
|
861
|
-
* @property {boolean} [quick_response_code]
|
|
774
|
+
* @typedef ApplicationSelfShipConfigResponse
|
|
775
|
+
* @property {ServiceabilityErrorResponse} [error]
|
|
776
|
+
* @property {ApplicationSelfShipConfig} [data]
|
|
777
|
+
* @property {boolean} success
|
|
862
778
|
*/
|
|
863
779
|
|
|
864
780
|
/**
|
|
865
|
-
* @typedef
|
|
866
|
-
* @property {
|
|
867
|
-
* @property {
|
|
781
|
+
* @typedef StoreRuleConfigData
|
|
782
|
+
* @property {string[]} [rule_ids]
|
|
783
|
+
* @property {string[]} [type_based_priority]
|
|
784
|
+
* @property {string[]} [tag_based_priority]
|
|
785
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
786
|
+
* @property {string[]} [sort]
|
|
868
787
|
*/
|
|
869
788
|
|
|
870
789
|
/**
|
|
871
|
-
* @typedef
|
|
872
|
-
* @property {string}
|
|
873
|
-
* @property {
|
|
874
|
-
* @property {
|
|
790
|
+
* @typedef CustomerRadiusSchema
|
|
791
|
+
* @property {string} unit
|
|
792
|
+
* @property {number} [lt]
|
|
793
|
+
* @property {number} [lte]
|
|
794
|
+
* @property {number} [gt]
|
|
795
|
+
* @property {number} [gte]
|
|
875
796
|
*/
|
|
876
797
|
|
|
877
798
|
/**
|
|
878
|
-
* @typedef
|
|
879
|
-
* @property {
|
|
880
|
-
* @property {
|
|
881
|
-
* @property {
|
|
882
|
-
* @property {
|
|
883
|
-
* @property {
|
|
884
|
-
* @property {
|
|
885
|
-
* @property {
|
|
886
|
-
* @property {
|
|
799
|
+
* @typedef StoreRuleConditionSchema
|
|
800
|
+
* @property {IntComparisonOperations} [department_ids]
|
|
801
|
+
* @property {IntComparisonOperations} [category_ids]
|
|
802
|
+
* @property {IntComparisonOperations} [brand_ids]
|
|
803
|
+
* @property {LocationRule} [to_location]
|
|
804
|
+
* @property {CustomerRadiusSchema} [customer_radius]
|
|
805
|
+
* @property {StringComparisonOperations} [store_type]
|
|
806
|
+
* @property {StringComparisonOperations} [product_tags]
|
|
807
|
+
* @property {IntComparisonOperations} [product_ids]
|
|
808
|
+
* @property {StringComparisonOperations} [store_tags]
|
|
809
|
+
* @property {ArithmeticOperations} [order_place_date]
|
|
810
|
+
* @property {StringComparisonOperations} [zone_ids]
|
|
887
811
|
*/
|
|
888
812
|
|
|
889
813
|
/**
|
|
890
|
-
* @typedef
|
|
891
|
-
* @property {
|
|
892
|
-
* @property {
|
|
893
|
-
* @property {number} [
|
|
894
|
-
* @property {
|
|
895
|
-
* @property {string} [
|
|
814
|
+
* @typedef StoreRuleDataSchema
|
|
815
|
+
* @property {string} [id]
|
|
816
|
+
* @property {string} [name]
|
|
817
|
+
* @property {number} [company_id]
|
|
818
|
+
* @property {string} [application_id]
|
|
819
|
+
* @property {string[]} [type_based_priority]
|
|
820
|
+
* @property {string[]} [tag_based_priority]
|
|
821
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
822
|
+
* @property {string[]} [sort]
|
|
823
|
+
* @property {StoreRuleConditionSchema} [conditions]
|
|
824
|
+
* @property {boolean} [is_active]
|
|
896
825
|
*/
|
|
897
826
|
|
|
898
827
|
/**
|
|
@@ -902,205 +831,251 @@ const Joi = require("joi");
|
|
|
902
831
|
*/
|
|
903
832
|
|
|
904
833
|
/**
|
|
905
|
-
* @typedef
|
|
906
|
-
* @property {
|
|
907
|
-
* @property {
|
|
908
|
-
* @property {CustomerRadiusSchema} [customer_radius]
|
|
909
|
-
* @property {IntComparisonOperations} [department_ids]
|
|
910
|
-
* @property {ArithmeticOperations} [order_place_date]
|
|
911
|
-
* @property {IntComparisonOperations} [product_ids]
|
|
912
|
-
* @property {StringComparisonOperations} [product_tags]
|
|
913
|
-
* @property {StringComparisonOperations} [store_tags]
|
|
914
|
-
* @property {StringComparisonOperations} [store_type]
|
|
915
|
-
* @property {LocationRule} [to_location]
|
|
916
|
-
* @property {StringComparisonOperations} [zone_ids]
|
|
917
|
-
*/
|
|
918
|
-
|
|
919
|
-
/**
|
|
920
|
-
* @typedef StoreRuleConfigData
|
|
921
|
-
* @property {string[]} [rule_ids]
|
|
922
|
-
* @property {string[]} [sort]
|
|
923
|
-
* @property {StorePrioritySchema[]} [store_priority]
|
|
924
|
-
* @property {string[]} [tag_based_priority]
|
|
925
|
-
* @property {string[]} [type_based_priority]
|
|
834
|
+
* @typedef GetStoreRulesApiResponse
|
|
835
|
+
* @property {StoreRuleDataSchema[]} [items]
|
|
836
|
+
* @property {Page} [page]
|
|
926
837
|
*/
|
|
927
838
|
|
|
928
839
|
/**
|
|
929
|
-
* @typedef
|
|
930
|
-
* @property {string} [application_id]
|
|
931
|
-
* @property {number} [company_id]
|
|
932
|
-
* @property {StoreRuleConditionSchema} [conditions]
|
|
933
|
-
* @property {string} [id]
|
|
934
|
-
* @property {boolean} [is_active]
|
|
840
|
+
* @typedef CreateStoreRuleRequestSchema
|
|
935
841
|
* @property {string} [name]
|
|
936
|
-
* @property {
|
|
937
|
-
* @property {
|
|
938
|
-
* @property {string[]} [tag_based_priority]
|
|
842
|
+
* @property {boolean} [is_active]
|
|
843
|
+
* @property {StoreRuleConditionSchema} [conditions]
|
|
939
844
|
* @property {string[]} [type_based_priority]
|
|
845
|
+
* @property {string[]} [tag_based_priority]
|
|
846
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
847
|
+
* @property {string[]} [sort]
|
|
940
848
|
*/
|
|
941
849
|
|
|
942
850
|
/**
|
|
943
851
|
* @typedef StoreRuleResponseSchema
|
|
944
|
-
* @property {StoreRuleConditionSchema} [conditions]
|
|
945
852
|
* @property {string} [id]
|
|
946
|
-
* @property {boolean} [is_active]
|
|
947
853
|
* @property {string} [name]
|
|
948
|
-
* @property {string[]} [sort]
|
|
949
|
-
* @property {StorePrioritySchema[]} [store_priority]
|
|
950
|
-
* @property {string[]} [tag_based_priority]
|
|
951
854
|
* @property {string} [type]
|
|
952
855
|
* @property {string[]} [type_based_priority]
|
|
856
|
+
* @property {string[]} [tag_based_priority]
|
|
857
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
858
|
+
* @property {string[]} [sort]
|
|
859
|
+
* @property {StoreRuleConditionSchema} [conditions]
|
|
860
|
+
* @property {boolean} [is_active]
|
|
953
861
|
*/
|
|
954
862
|
|
|
955
863
|
/**
|
|
956
864
|
* @typedef StoreRuleUpdateResponseSchema
|
|
957
|
-
* @property {string} [application_id]
|
|
958
|
-
* @property {number} [company_id]
|
|
959
|
-
* @property {StoreRuleConditionSchema} [conditions]
|
|
960
865
|
* @property {string} [id]
|
|
961
|
-
* @property {boolean} [is_active]
|
|
962
866
|
* @property {string} [name]
|
|
963
|
-
* @property {string[]} [sort]
|
|
964
|
-
* @property {StorePrioritySchema[]} [store_priority]
|
|
965
|
-
* @property {string[]} [tag_based_priority]
|
|
966
867
|
* @property {string} [type]
|
|
967
868
|
* @property {string[]} [type_based_priority]
|
|
869
|
+
* @property {string[]} [tag_based_priority]
|
|
870
|
+
* @property {StorePrioritySchema[]} [store_priority]
|
|
871
|
+
* @property {string[]} [sort]
|
|
872
|
+
* @property {StoreRuleConditionSchema} [conditions]
|
|
873
|
+
* @property {boolean} [is_active]
|
|
874
|
+
* @property {number} [company_id]
|
|
875
|
+
* @property {string} [application_id]
|
|
968
876
|
*/
|
|
969
877
|
|
|
970
878
|
/**
|
|
971
|
-
* @typedef
|
|
972
|
-
* @property {
|
|
879
|
+
* @typedef ServiceabilityModel
|
|
880
|
+
* @property {number} lm_cod_limit
|
|
881
|
+
* @property {boolean} is_qc
|
|
882
|
+
* @property {string} pickup_cutoff
|
|
883
|
+
* @property {string} route_code
|
|
884
|
+
* @property {boolean} is_first_mile
|
|
885
|
+
* @property {boolean} is_return
|
|
886
|
+
* @property {boolean} is_installation
|
|
887
|
+
* @property {boolean} is_last_mile
|
|
973
888
|
*/
|
|
974
889
|
|
|
975
890
|
/**
|
|
976
|
-
* @typedef
|
|
977
|
-
* @property {
|
|
978
|
-
* @property {boolean} [
|
|
979
|
-
* @property {
|
|
980
|
-
* @property {
|
|
891
|
+
* @typedef CourierPartnerSchemeFeatures
|
|
892
|
+
* @property {boolean} [doorstep_qc]
|
|
893
|
+
* @property {boolean} [qr]
|
|
894
|
+
* @property {boolean} [mps]
|
|
895
|
+
* @property {boolean} [ndr]
|
|
896
|
+
* @property {number} [ndr_attempts]
|
|
897
|
+
* @property {boolean} [dangerous_goods]
|
|
898
|
+
* @property {boolean} [fragile_goods]
|
|
899
|
+
* @property {boolean} [restricted_goods]
|
|
900
|
+
* @property {boolean} [cold_storage_goods]
|
|
901
|
+
* @property {boolean} [doorstep_exchange]
|
|
902
|
+
* @property {boolean} [doorstep_return]
|
|
903
|
+
* @property {boolean} [product_installation]
|
|
904
|
+
* @property {boolean} [openbox_delivery]
|
|
905
|
+
* @property {string} [status_updates]
|
|
906
|
+
* @property {boolean} [multi_pick_single_drop]
|
|
907
|
+
* @property {boolean} [single_pick_multi_drop]
|
|
908
|
+
* @property {boolean} [multi_pick_multi_drop]
|
|
909
|
+
* @property {boolean} [ewaybill]
|
|
981
910
|
*/
|
|
982
911
|
|
|
983
912
|
/**
|
|
984
|
-
* @typedef
|
|
985
|
-
* @property {string}
|
|
913
|
+
* @typedef CourierPartnerSchemeModel
|
|
914
|
+
* @property {string} extension_id
|
|
915
|
+
* @property {string} scheme_id
|
|
916
|
+
* @property {ArithmeticOperations} weight
|
|
917
|
+
* @property {string} transport_type
|
|
918
|
+
* @property {string} region
|
|
919
|
+
* @property {string} delivery_type
|
|
920
|
+
* @property {string[]} payment_mode
|
|
921
|
+
* @property {string} stage
|
|
922
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
986
923
|
*/
|
|
987
924
|
|
|
988
925
|
/**
|
|
989
|
-
* @typedef
|
|
990
|
-
* @property {string}
|
|
991
|
-
* @property {
|
|
992
|
-
* @property {
|
|
993
|
-
* @property {
|
|
994
|
-
* @property {
|
|
995
|
-
* @property {
|
|
996
|
-
* @property {ZoneProductTypes} product
|
|
997
|
-
* @property {string} region_type
|
|
998
|
-
* @property {string} slug
|
|
999
|
-
* @property {number[]} store_ids
|
|
1000
|
-
* @property {string} zone_id
|
|
926
|
+
* @typedef CourierAccountResponse
|
|
927
|
+
* @property {string} account_id
|
|
928
|
+
* @property {string} scheme_id
|
|
929
|
+
* @property {boolean} is_self_ship
|
|
930
|
+
* @property {string} stage
|
|
931
|
+
* @property {boolean} is_own_account
|
|
932
|
+
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
1001
933
|
*/
|
|
1002
934
|
|
|
1003
935
|
/**
|
|
1004
|
-
* @typedef
|
|
1005
|
-
* @property {
|
|
936
|
+
* @typedef CompanyCourierPartnerAccountListResponse
|
|
937
|
+
* @property {CourierAccountResponse[]} items
|
|
938
|
+
* @property {Page} page
|
|
1006
939
|
*/
|
|
1007
940
|
|
|
1008
941
|
/**
|
|
1009
|
-
* @typedef
|
|
1010
|
-
* @property {string} assignment_preference
|
|
1011
|
-
* @property {boolean} is_active
|
|
942
|
+
* @typedef PackageMaterial
|
|
1012
943
|
* @property {string} name
|
|
1013
|
-
* @property {
|
|
944
|
+
* @property {number} width
|
|
945
|
+
* @property {number} height
|
|
946
|
+
* @property {number} length
|
|
947
|
+
* @property {PackageMaterialRule[]} [rules]
|
|
1014
948
|
* @property {number[]} store_ids
|
|
1015
|
-
* @property {
|
|
1016
|
-
* @property {
|
|
1017
|
-
* @property {string}
|
|
949
|
+
* @property {number} weight
|
|
950
|
+
* @property {number} error_rate
|
|
951
|
+
* @property {string} package_type
|
|
952
|
+
* @property {string} size
|
|
953
|
+
* @property {string[]} [media]
|
|
954
|
+
* @property {Channel[]} channels
|
|
955
|
+
* @property {boolean} [track_inventory]
|
|
956
|
+
* @property {string} status
|
|
957
|
+
* @property {number} [max_weight]
|
|
958
|
+
* @property {number} [package_vol_weight]
|
|
959
|
+
* @property {boolean} [auto_calculate]
|
|
1018
960
|
*/
|
|
1019
961
|
|
|
1020
962
|
/**
|
|
1021
|
-
* @typedef
|
|
1022
|
-
* @property {string}
|
|
963
|
+
* @typedef PackageMaterialResponse
|
|
964
|
+
* @property {string} name
|
|
965
|
+
* @property {string} [id]
|
|
966
|
+
* @property {number} [item_id]
|
|
967
|
+
* @property {number} width
|
|
968
|
+
* @property {number} height
|
|
969
|
+
* @property {number} length
|
|
970
|
+
* @property {PackageMaterialRule[]} [rules]
|
|
971
|
+
* @property {number[]} store_ids
|
|
972
|
+
* @property {number} weight
|
|
973
|
+
* @property {number} error_rate
|
|
974
|
+
* @property {string} package_type
|
|
975
|
+
* @property {string} size
|
|
976
|
+
* @property {string[]} [media]
|
|
977
|
+
* @property {Channel[]} channels
|
|
978
|
+
* @property {boolean} [track_inventory]
|
|
979
|
+
* @property {string} status
|
|
980
|
+
* @property {number} [max_weight]
|
|
981
|
+
* @property {number} [package_vol_weight]
|
|
982
|
+
* @property {boolean} [auto_calculate]
|
|
1023
983
|
*/
|
|
1024
984
|
|
|
1025
985
|
/**
|
|
1026
|
-
* @typedef
|
|
1027
|
-
* @property {
|
|
1028
|
-
* @property {
|
|
1029
|
-
* @property {number}
|
|
1030
|
-
* @property {number} size
|
|
1031
|
-
* @property {string} type
|
|
986
|
+
* @typedef PackageMaterialRule
|
|
987
|
+
* @property {string} [rule_id]
|
|
988
|
+
* @property {PackageMaterialRuleQuantity} [quantity]
|
|
989
|
+
* @property {number} [weight]
|
|
1032
990
|
*/
|
|
1033
991
|
|
|
1034
992
|
/**
|
|
1035
|
-
* @typedef
|
|
1036
|
-
* @property {string}
|
|
1037
|
-
* @property {
|
|
1038
|
-
* @property {string
|
|
993
|
+
* @typedef PackageRule
|
|
994
|
+
* @property {string} name
|
|
995
|
+
* @property {number} company_id
|
|
996
|
+
* @property {string} type
|
|
997
|
+
* @property {boolean} [is_active]
|
|
998
|
+
* @property {PackageRuleProductTag} [product_tag]
|
|
999
|
+
* @property {PackageRuleProduct} [product_id]
|
|
1000
|
+
* @property {PackageRuleCategory} [category_id]
|
|
1039
1001
|
*/
|
|
1040
1002
|
|
|
1041
1003
|
/**
|
|
1042
|
-
* @typedef
|
|
1043
|
-
* @property {string[]
|
|
1004
|
+
* @typedef PackageRuleResponse
|
|
1005
|
+
* @property {string} [id]
|
|
1006
|
+
* @property {string} name
|
|
1007
|
+
* @property {number} company_id
|
|
1044
1008
|
* @property {string} type
|
|
1009
|
+
* @property {boolean} [is_active]
|
|
1010
|
+
* @property {PackageRuleProductTag} [product_tag]
|
|
1011
|
+
* @property {PackageRuleProduct} [product_id]
|
|
1012
|
+
* @property {PackageRuleCategory} [category_id]
|
|
1045
1013
|
*/
|
|
1046
1014
|
|
|
1047
1015
|
/**
|
|
1048
|
-
* @typedef
|
|
1049
|
-
* @property {
|
|
1050
|
-
* @property {
|
|
1051
|
-
* @property {string} zone_id
|
|
1016
|
+
* @typedef Channel
|
|
1017
|
+
* @property {string} [type]
|
|
1018
|
+
* @property {string} [id]
|
|
1052
1019
|
*/
|
|
1053
1020
|
|
|
1054
1021
|
/**
|
|
1055
|
-
* @typedef
|
|
1056
|
-
* @property {
|
|
1057
|
-
* @property {
|
|
1022
|
+
* @typedef PackageMaterialRuleList
|
|
1023
|
+
* @property {PackageRuleResponse} [items]
|
|
1024
|
+
* @property {Page} [page]
|
|
1058
1025
|
*/
|
|
1059
1026
|
|
|
1060
1027
|
/**
|
|
1061
|
-
* @typedef
|
|
1062
|
-
* @property {
|
|
1063
|
-
* @property {
|
|
1028
|
+
* @typedef PackageMaterialList
|
|
1029
|
+
* @property {PackageMaterialResponse} [items]
|
|
1030
|
+
* @property {Page} [page]
|
|
1064
1031
|
*/
|
|
1065
1032
|
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
address1: Joi.string().allow(""),
|
|
1071
|
-
address2: Joi.string().allow(""),
|
|
1072
|
-
city: Joi.string().allow(""),
|
|
1073
|
-
country: Joi.string().allow(""),
|
|
1074
|
-
landmark: Joi.string().allow(""),
|
|
1075
|
-
latitude: Joi.number(),
|
|
1076
|
-
longitude: Joi.number(),
|
|
1077
|
-
pincode: Joi.number(),
|
|
1078
|
-
state: Joi.string().allow(""),
|
|
1079
|
-
});
|
|
1080
|
-
}
|
|
1033
|
+
/**
|
|
1034
|
+
* @typedef PackageRuleProduct
|
|
1035
|
+
* @property {number[]} [includes]
|
|
1036
|
+
*/
|
|
1081
1037
|
|
|
1082
|
-
|
|
1083
|
-
|
|
1084
|
-
|
|
1085
|
-
|
|
1086
|
-
sort: Joi.array().items(Joi.string().allow("")),
|
|
1087
|
-
zones: ServiceabilityPlatformModel.ZoneConfig(),
|
|
1088
|
-
});
|
|
1089
|
-
}
|
|
1038
|
+
/**
|
|
1039
|
+
* @typedef PackageRuleProductTag
|
|
1040
|
+
* @property {string[]} [includes]
|
|
1041
|
+
*/
|
|
1090
1042
|
|
|
1091
|
-
|
|
1092
|
-
|
|
1043
|
+
/**
|
|
1044
|
+
* @typedef PackageRuleCategory
|
|
1045
|
+
* @property {number[]} [includes]
|
|
1046
|
+
*/
|
|
1047
|
+
|
|
1048
|
+
/**
|
|
1049
|
+
* @typedef PackageMaterialRuleQuantity
|
|
1050
|
+
* @property {number} [min]
|
|
1051
|
+
* @property {number} [max]
|
|
1052
|
+
*/
|
|
1053
|
+
|
|
1054
|
+
/**
|
|
1055
|
+
* @typedef RulePriorityRequest
|
|
1056
|
+
* @property {string} rule_id
|
|
1057
|
+
* @property {number} priority
|
|
1058
|
+
*/
|
|
1059
|
+
|
|
1060
|
+
/**
|
|
1061
|
+
* @typedef RulePriorityResponse
|
|
1062
|
+
* @property {boolean} [success]
|
|
1063
|
+
*/
|
|
1064
|
+
|
|
1065
|
+
class ServiceabilityPlatformModel {
|
|
1066
|
+
/** @returns {UpdateZoneConfigRequest} */
|
|
1067
|
+
static UpdateZoneConfigRequest() {
|
|
1093
1068
|
return Joi.object({
|
|
1094
|
-
|
|
1069
|
+
serviceability_type: Joi.string().allow(""),
|
|
1095
1070
|
});
|
|
1096
1071
|
}
|
|
1097
1072
|
|
|
1098
|
-
/** @returns {
|
|
1099
|
-
static
|
|
1073
|
+
/** @returns {ServiceabilityErrorResponse} */
|
|
1074
|
+
static ServiceabilityErrorResponse() {
|
|
1100
1075
|
return Joi.object({
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1076
|
+
message: Joi.string().allow("").required(),
|
|
1077
|
+
value: Joi.string().allow("").required(),
|
|
1078
|
+
type: Joi.string().allow("").required(),
|
|
1104
1079
|
});
|
|
1105
1080
|
}
|
|
1106
1081
|
|
|
@@ -1108,1350 +1083,1371 @@ class ServiceabilityPlatformModel {
|
|
|
1108
1083
|
static ApplicationServiceabilityConfig() {
|
|
1109
1084
|
return Joi.object({
|
|
1110
1085
|
channel_id: Joi.string().allow("").required(),
|
|
1111
|
-
channel_type: Joi.string().allow("").required(),
|
|
1112
1086
|
serviceability_type: Joi.string().allow("").required(),
|
|
1087
|
+
channel_type: Joi.string().allow("").required(),
|
|
1113
1088
|
});
|
|
1114
1089
|
}
|
|
1115
1090
|
|
|
1116
1091
|
/** @returns {ApplicationServiceabilityConfigResponse} */
|
|
1117
1092
|
static ApplicationServiceabilityConfigResponse() {
|
|
1118
1093
|
return Joi.object({
|
|
1119
|
-
data: ServiceabilityPlatformModel.ApplicationServiceabilityConfig(),
|
|
1120
1094
|
error: ServiceabilityPlatformModel.ServiceabilityErrorResponse(),
|
|
1095
|
+
data: ServiceabilityPlatformModel.ApplicationServiceabilityConfig(),
|
|
1121
1096
|
success: Joi.boolean().required(),
|
|
1122
1097
|
});
|
|
1123
1098
|
}
|
|
1124
1099
|
|
|
1125
|
-
/** @returns {
|
|
1126
|
-
static
|
|
1100
|
+
/** @returns {EntityRegionView_Request} */
|
|
1101
|
+
static EntityRegionView_Request() {
|
|
1127
1102
|
return Joi.object({
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
lt: Joi.number(),
|
|
1131
|
-
lte: Joi.number(),
|
|
1103
|
+
sub_type: Joi.array().items(Joi.string().allow("")).required(),
|
|
1104
|
+
parent_id: Joi.array().items(Joi.string().allow("")),
|
|
1132
1105
|
});
|
|
1133
1106
|
}
|
|
1134
1107
|
|
|
1135
|
-
/** @returns {
|
|
1136
|
-
static
|
|
1108
|
+
/** @returns {EntityRegionView_Error} */
|
|
1109
|
+
static EntityRegionView_Error() {
|
|
1137
1110
|
return Joi.object({
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
region: Joi.string().allow("").required(),
|
|
1111
|
+
message: Joi.string().allow(""),
|
|
1112
|
+
value: Joi.string().allow(""),
|
|
1113
|
+
type: Joi.string().allow(""),
|
|
1142
1114
|
});
|
|
1143
1115
|
}
|
|
1144
1116
|
|
|
1145
|
-
/** @returns {
|
|
1146
|
-
static
|
|
1117
|
+
/** @returns {EntityRegionView_page} */
|
|
1118
|
+
static EntityRegionView_page() {
|
|
1119
|
+
return Joi.object({
|
|
1120
|
+
type: Joi.string().allow("").required(),
|
|
1121
|
+
has_next: Joi.boolean().required(),
|
|
1122
|
+
item_total: Joi.number().required(),
|
|
1123
|
+
size: Joi.number().required(),
|
|
1124
|
+
current: Joi.number().required(),
|
|
1125
|
+
});
|
|
1126
|
+
}
|
|
1127
|
+
|
|
1128
|
+
/** @returns {getAppRegionZonesResponse} */
|
|
1129
|
+
static getAppRegionZonesResponse() {
|
|
1147
1130
|
return Joi.object({
|
|
1131
|
+
page: Joi.array()
|
|
1132
|
+
.items(ServiceabilityPlatformModel.PageSchema())
|
|
1133
|
+
.required(),
|
|
1148
1134
|
items: Joi.array()
|
|
1149
|
-
.items(ServiceabilityPlatformModel.
|
|
1135
|
+
.items(ServiceabilityPlatformModel.ListViewItems())
|
|
1150
1136
|
.required(),
|
|
1151
|
-
page: ServiceabilityPlatformModel.Page().required(),
|
|
1152
1137
|
});
|
|
1153
1138
|
}
|
|
1154
1139
|
|
|
1155
|
-
/** @returns {
|
|
1156
|
-
static
|
|
1140
|
+
/** @returns {PageSchema} */
|
|
1141
|
+
static PageSchema() {
|
|
1157
1142
|
return Joi.object({
|
|
1158
|
-
|
|
1159
|
-
|
|
1160
|
-
|
|
1161
|
-
|
|
1162
|
-
|
|
1163
|
-
failed_records: Joi.array().items(Joi.any()),
|
|
1164
|
-
file_path: Joi.string().allow("").required(),
|
|
1165
|
-
region: Joi.string().allow("").required(),
|
|
1166
|
-
status: Joi.string().allow("").required(),
|
|
1167
|
-
success: Joi.number(),
|
|
1168
|
-
total: Joi.number(),
|
|
1143
|
+
has_next: Joi.boolean().required(),
|
|
1144
|
+
item_total: Joi.number().required(),
|
|
1145
|
+
size: Joi.number().required(),
|
|
1146
|
+
current: Joi.number().required(),
|
|
1147
|
+
type: Joi.string().allow("").required(),
|
|
1169
1148
|
});
|
|
1170
1149
|
}
|
|
1171
1150
|
|
|
1172
|
-
/** @returns {
|
|
1173
|
-
static
|
|
1151
|
+
/** @returns {EntityRegionView_Items} */
|
|
1152
|
+
static EntityRegionView_Items() {
|
|
1174
1153
|
return Joi.object({
|
|
1175
|
-
|
|
1176
|
-
|
|
1154
|
+
sub_type: Joi.string().allow("").required(),
|
|
1155
|
+
uid: Joi.string().allow("").required(),
|
|
1156
|
+
name: Joi.string().allow("").required(),
|
|
1177
1157
|
});
|
|
1178
1158
|
}
|
|
1179
1159
|
|
|
1180
|
-
/** @returns {
|
|
1181
|
-
static
|
|
1160
|
+
/** @returns {EntityRegionView_Response} */
|
|
1161
|
+
static EntityRegionView_Response() {
|
|
1182
1162
|
return Joi.object({
|
|
1183
|
-
error:
|
|
1184
|
-
|
|
1185
|
-
|
|
1163
|
+
error: ServiceabilityPlatformModel.EntityRegionView_Error().required(),
|
|
1164
|
+
page: ServiceabilityPlatformModel.EntityRegionView_page().required(),
|
|
1165
|
+
data: Joi.array()
|
|
1166
|
+
.items(ServiceabilityPlatformModel.EntityRegionView_Items())
|
|
1167
|
+
.required(),
|
|
1168
|
+
success: Joi.boolean().required(),
|
|
1186
1169
|
});
|
|
1187
1170
|
}
|
|
1188
1171
|
|
|
1189
|
-
/** @returns {
|
|
1190
|
-
static
|
|
1172
|
+
/** @returns {ListViewSummary} */
|
|
1173
|
+
static ListViewSummary() {
|
|
1191
1174
|
return Joi.object({
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1175
|
+
total_zones: Joi.number().required(),
|
|
1176
|
+
total_pincodes_served: Joi.number().required(),
|
|
1177
|
+
total_active_zones: Joi.number().required(),
|
|
1195
1178
|
});
|
|
1196
1179
|
}
|
|
1197
1180
|
|
|
1198
|
-
/** @returns {
|
|
1199
|
-
static
|
|
1181
|
+
/** @returns {ZoneDataItem} */
|
|
1182
|
+
static ZoneDataItem() {
|
|
1183
|
+
return Joi.object({
|
|
1184
|
+
has_next: Joi.boolean().required(),
|
|
1185
|
+
item_total: Joi.number().required(),
|
|
1186
|
+
size: Joi.number().required(),
|
|
1187
|
+
current: Joi.number().required(),
|
|
1188
|
+
type: Joi.string().allow("").required(),
|
|
1189
|
+
});
|
|
1190
|
+
}
|
|
1191
|
+
|
|
1192
|
+
/** @returns {ListViewProduct} */
|
|
1193
|
+
static ListViewProduct() {
|
|
1194
|
+
return Joi.object({
|
|
1195
|
+
count: Joi.number().required(),
|
|
1196
|
+
type: Joi.string().allow("").required(),
|
|
1197
|
+
});
|
|
1198
|
+
}
|
|
1199
|
+
|
|
1200
|
+
/** @returns {ListViewChannels} */
|
|
1201
|
+
static ListViewChannels() {
|
|
1202
|
+
return Joi.object({
|
|
1203
|
+
channel_id: Joi.string().allow("").required(),
|
|
1204
|
+
channel_type: Joi.string().allow("").required(),
|
|
1205
|
+
});
|
|
1206
|
+
}
|
|
1207
|
+
|
|
1208
|
+
/** @returns {ListViewItems} */
|
|
1209
|
+
static ListViewItems() {
|
|
1210
|
+
return Joi.object({
|
|
1211
|
+
zone_id: Joi.string().allow("").required(),
|
|
1212
|
+
name: Joi.string().allow("").required(),
|
|
1213
|
+
slug: Joi.string().allow("").required(),
|
|
1214
|
+
stores_count: Joi.number().required(),
|
|
1215
|
+
is_active: Joi.boolean().required(),
|
|
1216
|
+
regions_count: Joi.number().required(),
|
|
1217
|
+
company_id: Joi.number().required(),
|
|
1218
|
+
channels: Joi.array()
|
|
1219
|
+
.items(ServiceabilityPlatformModel.ListViewChannels())
|
|
1220
|
+
.required(),
|
|
1221
|
+
});
|
|
1222
|
+
}
|
|
1223
|
+
|
|
1224
|
+
/** @returns {ListViewResponse} */
|
|
1225
|
+
static ListViewResponse() {
|
|
1200
1226
|
return Joi.object({
|
|
1227
|
+
page: ServiceabilityPlatformModel.ZoneDataItem().required(),
|
|
1201
1228
|
items: Joi.array()
|
|
1202
|
-
.items(ServiceabilityPlatformModel.
|
|
1229
|
+
.items(ServiceabilityPlatformModel.ListViewItems())
|
|
1203
1230
|
.required(),
|
|
1204
|
-
page: ServiceabilityPlatformModel.Page().required(),
|
|
1205
1231
|
});
|
|
1206
1232
|
}
|
|
1207
1233
|
|
|
1208
1234
|
/** @returns {CompanyStoreView_PageItems} */
|
|
1209
1235
|
static CompanyStoreView_PageItems() {
|
|
1210
1236
|
return Joi.object({
|
|
1211
|
-
|
|
1237
|
+
type: Joi.string().allow("").required(),
|
|
1212
1238
|
has_next: Joi.boolean().required(),
|
|
1213
1239
|
item_total: Joi.number().required(),
|
|
1214
1240
|
size: Joi.number().required(),
|
|
1215
|
-
|
|
1241
|
+
current: Joi.number().required(),
|
|
1216
1242
|
});
|
|
1217
1243
|
}
|
|
1218
1244
|
|
|
1219
1245
|
/** @returns {CompanyStoreView_Response} */
|
|
1220
1246
|
static CompanyStoreView_Response() {
|
|
1221
1247
|
return Joi.object({
|
|
1222
|
-
items: Joi.array().items(Joi.any()),
|
|
1223
1248
|
page: Joi.array()
|
|
1224
1249
|
.items(ServiceabilityPlatformModel.CompanyStoreView_PageItems())
|
|
1225
1250
|
.required(),
|
|
1251
|
+
items: Joi.array().items(Joi.any()),
|
|
1226
1252
|
});
|
|
1227
1253
|
}
|
|
1228
1254
|
|
|
1229
|
-
/** @returns {
|
|
1230
|
-
static
|
|
1255
|
+
/** @returns {GetZoneDataViewChannels} */
|
|
1256
|
+
static GetZoneDataViewChannels() {
|
|
1231
1257
|
return Joi.object({
|
|
1232
|
-
|
|
1233
|
-
|
|
1258
|
+
channel_id: Joi.string().allow("").required(),
|
|
1259
|
+
channel_type: Joi.string().allow("").required(),
|
|
1234
1260
|
});
|
|
1235
1261
|
}
|
|
1236
1262
|
|
|
1237
|
-
/** @returns {
|
|
1238
|
-
static
|
|
1263
|
+
/** @returns {ZoneProductTypes} */
|
|
1264
|
+
static ZoneProductTypes() {
|
|
1239
1265
|
return Joi.object({
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
is_own_account: Joi.boolean().required(),
|
|
1243
|
-
is_self_ship: Joi.boolean().required(),
|
|
1244
|
-
scheme_id: Joi.string().allow("").required(),
|
|
1245
|
-
stage: Joi.string().allow("").required(),
|
|
1246
|
-
});
|
|
1247
|
-
}
|
|
1248
|
-
|
|
1249
|
-
/** @returns {CourierAccountResponse} */
|
|
1250
|
-
static CourierAccountResponse() {
|
|
1251
|
-
return Joi.object({
|
|
1252
|
-
account_id: Joi.string().allow("").required(),
|
|
1253
|
-
is_own_account: Joi.boolean().required(),
|
|
1254
|
-
is_self_ship: Joi.boolean().required(),
|
|
1255
|
-
scheme_id: Joi.string().allow("").required(),
|
|
1256
|
-
scheme_rules: ServiceabilityPlatformModel.CourierPartnerSchemeModel().required(),
|
|
1257
|
-
stage: Joi.string().allow("").required(),
|
|
1266
|
+
type: Joi.string().allow("").required(),
|
|
1267
|
+
tags: Joi.array().items(Joi.string().allow("")).required(),
|
|
1258
1268
|
});
|
|
1259
1269
|
}
|
|
1260
1270
|
|
|
1261
|
-
/** @returns {
|
|
1262
|
-
static
|
|
1271
|
+
/** @returns {ZoneMappingType} */
|
|
1272
|
+
static ZoneMappingType() {
|
|
1263
1273
|
return Joi.object({
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
success: Joi.boolean().required(),
|
|
1274
|
+
country: Joi.string().allow("").required(),
|
|
1275
|
+
pincode: Joi.array().items(Joi.string().allow("")),
|
|
1276
|
+
state: Joi.array().items(Joi.string().allow("")),
|
|
1268
1277
|
});
|
|
1269
1278
|
}
|
|
1270
1279
|
|
|
1271
|
-
/** @returns {
|
|
1272
|
-
static
|
|
1280
|
+
/** @returns {UpdateZoneData} */
|
|
1281
|
+
static UpdateZoneData() {
|
|
1273
1282
|
return Joi.object({
|
|
1274
|
-
|
|
1275
|
-
extension_id: Joi.string().allow("").required(),
|
|
1276
|
-
is_self_ship: Joi.boolean().required(),
|
|
1283
|
+
zone_id: Joi.string().allow("").required(),
|
|
1277
1284
|
name: Joi.string().allow("").required(),
|
|
1278
|
-
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
-
/** @returns {CourierPartnerRule} */
|
|
1282
|
-
static CourierPartnerRule() {
|
|
1283
|
-
return Joi.object({
|
|
1284
|
-
conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions().required(),
|
|
1285
|
-
cp_list: Joi.array().items(
|
|
1286
|
-
ServiceabilityPlatformModel.CourierPartnerList()
|
|
1287
|
-
),
|
|
1285
|
+
slug: Joi.string().allow("").required(),
|
|
1286
|
+
company_id: Joi.number().required(),
|
|
1288
1287
|
is_active: Joi.boolean().required(),
|
|
1289
|
-
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
department_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
1300
|
-
forward: ServiceabilityPlatformModel.LocationRule(),
|
|
1301
|
-
order_place_date: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
1302
|
-
payment_mode: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1303
|
-
product_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
1304
|
-
product_tags: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1305
|
-
reverse: ServiceabilityPlatformModel.LocationRule(),
|
|
1306
|
-
shipment_cost: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
1307
|
-
shipment_volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
1308
|
-
shipment_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
1309
|
-
store_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
1310
|
-
store_tags: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1311
|
-
store_type: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1312
|
-
zone_ids: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1288
|
+
channels: Joi.array()
|
|
1289
|
+
.items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
|
|
1290
|
+
.required(),
|
|
1291
|
+
product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
|
|
1292
|
+
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1293
|
+
region_type: Joi.string().allow("").required(),
|
|
1294
|
+
mapping: Joi.array()
|
|
1295
|
+
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
1296
|
+
.required(),
|
|
1297
|
+
assignment_preference: Joi.string().allow(""),
|
|
1313
1298
|
});
|
|
1314
1299
|
}
|
|
1315
1300
|
|
|
1316
|
-
/** @returns {
|
|
1317
|
-
static
|
|
1301
|
+
/** @returns {ZoneUpdateRequest} */
|
|
1302
|
+
static ZoneUpdateRequest() {
|
|
1318
1303
|
return Joi.object({
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
.required(),
|
|
1322
|
-
page: ServiceabilityPlatformModel.Page().required(),
|
|
1304
|
+
identifier: Joi.string().allow("").required(),
|
|
1305
|
+
data: ServiceabilityPlatformModel.UpdateZoneData().required(),
|
|
1323
1306
|
});
|
|
1324
1307
|
}
|
|
1325
1308
|
|
|
1326
|
-
/** @returns {
|
|
1327
|
-
static
|
|
1309
|
+
/** @returns {ZoneSuccessResponse} */
|
|
1310
|
+
static ZoneSuccessResponse() {
|
|
1328
1311
|
return Joi.object({
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
doorstep_exchange: Joi.boolean(),
|
|
1332
|
-
doorstep_qc: Joi.boolean(),
|
|
1333
|
-
doorstep_return: Joi.boolean(),
|
|
1334
|
-
ewaybill: Joi.boolean(),
|
|
1335
|
-
fragile_goods: Joi.boolean(),
|
|
1336
|
-
mps: Joi.boolean(),
|
|
1337
|
-
multi_pick_multi_drop: Joi.boolean(),
|
|
1338
|
-
multi_pick_single_drop: Joi.boolean(),
|
|
1339
|
-
ndr: Joi.boolean(),
|
|
1340
|
-
ndr_attempts: Joi.number(),
|
|
1341
|
-
openbox_delivery: Joi.boolean(),
|
|
1342
|
-
product_installation: Joi.boolean(),
|
|
1343
|
-
qr: Joi.boolean(),
|
|
1344
|
-
restricted_goods: Joi.boolean(),
|
|
1345
|
-
single_pick_multi_drop: Joi.boolean(),
|
|
1346
|
-
status_updates: Joi.string().allow(""),
|
|
1312
|
+
status_code: Joi.number().required(),
|
|
1313
|
+
success: Joi.boolean().required(),
|
|
1347
1314
|
});
|
|
1348
1315
|
}
|
|
1349
1316
|
|
|
1350
|
-
/** @returns {
|
|
1351
|
-
static
|
|
1317
|
+
/** @returns {GetZoneDataViewItems} */
|
|
1318
|
+
static GetZoneDataViewItems() {
|
|
1352
1319
|
return Joi.object({
|
|
1353
|
-
|
|
1354
|
-
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
|
|
1361
|
-
|
|
1320
|
+
zone_id: Joi.string().allow("").required(),
|
|
1321
|
+
name: Joi.string().allow("").required(),
|
|
1322
|
+
slug: Joi.string().allow("").required(),
|
|
1323
|
+
company_id: Joi.number(),
|
|
1324
|
+
is_active: Joi.boolean().required(),
|
|
1325
|
+
channels: Joi.array()
|
|
1326
|
+
.items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
|
|
1327
|
+
.required(),
|
|
1328
|
+
product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
|
|
1329
|
+
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1330
|
+
region_type: Joi.string().allow(""),
|
|
1331
|
+
mapping: Joi.array()
|
|
1332
|
+
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
1333
|
+
.required(),
|
|
1334
|
+
assignment_preference: Joi.string().allow(""),
|
|
1335
|
+
stores_count: Joi.number().required(),
|
|
1362
1336
|
});
|
|
1363
1337
|
}
|
|
1364
1338
|
|
|
1365
|
-
/** @returns {
|
|
1366
|
-
static
|
|
1339
|
+
/** @returns {GetSingleZoneDataViewResponse} */
|
|
1340
|
+
static GetSingleZoneDataViewResponse() {
|
|
1367
1341
|
return Joi.object({
|
|
1368
|
-
|
|
1369
|
-
username: Joi.string().allow(""),
|
|
1342
|
+
data: ServiceabilityPlatformModel.GetZoneDataViewItems().required(),
|
|
1370
1343
|
});
|
|
1371
1344
|
}
|
|
1372
1345
|
|
|
1373
|
-
/** @returns {
|
|
1374
|
-
static
|
|
1346
|
+
/** @returns {GetZoneByIdSchema} */
|
|
1347
|
+
static GetZoneByIdSchema() {
|
|
1375
1348
|
return Joi.object({
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1349
|
+
zone_id: Joi.string().allow("").required(),
|
|
1350
|
+
name: Joi.string().allow("").required(),
|
|
1351
|
+
slug: Joi.string().allow("").required(),
|
|
1352
|
+
company_id: Joi.number(),
|
|
1353
|
+
is_active: Joi.boolean().required(),
|
|
1354
|
+
channels: Joi.array()
|
|
1355
|
+
.items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
|
|
1356
|
+
.required(),
|
|
1357
|
+
product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
|
|
1358
|
+
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1359
|
+
region_type: Joi.string().allow("").required(),
|
|
1360
|
+
mapping: Joi.array()
|
|
1361
|
+
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
1362
|
+
.required(),
|
|
1363
|
+
assignment_preference: Joi.string().allow(""),
|
|
1364
|
+
stores_count: Joi.number().required(),
|
|
1385
1365
|
});
|
|
1386
1366
|
}
|
|
1387
1367
|
|
|
1388
1368
|
/** @returns {CreateZoneData} */
|
|
1389
1369
|
static CreateZoneData() {
|
|
1390
1370
|
return Joi.object({
|
|
1391
|
-
|
|
1371
|
+
name: Joi.string().allow("").required(),
|
|
1372
|
+
slug: Joi.string().allow("").required(),
|
|
1373
|
+
company_id: Joi.number().required(),
|
|
1374
|
+
is_active: Joi.boolean().required(),
|
|
1392
1375
|
channels: Joi.array()
|
|
1393
1376
|
.items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
|
|
1394
1377
|
.required(),
|
|
1395
|
-
|
|
1396
|
-
|
|
1378
|
+
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1379
|
+
region_type: Joi.string().allow("").required(),
|
|
1397
1380
|
mapping: Joi.array()
|
|
1398
1381
|
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
1399
1382
|
.required(),
|
|
1400
|
-
|
|
1401
|
-
region_type: Joi.string().allow("").required(),
|
|
1402
|
-
slug: Joi.string().allow("").required(),
|
|
1403
|
-
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1404
|
-
});
|
|
1405
|
-
}
|
|
1406
|
-
|
|
1407
|
-
/** @returns {CustomerRadiusSchema} */
|
|
1408
|
-
static CustomerRadiusSchema() {
|
|
1409
|
-
return Joi.object({
|
|
1410
|
-
gt: Joi.number(),
|
|
1411
|
-
gte: Joi.number(),
|
|
1412
|
-
lt: Joi.number(),
|
|
1413
|
-
lte: Joi.number(),
|
|
1414
|
-
unit: Joi.string().allow("").required(),
|
|
1415
|
-
});
|
|
1416
|
-
}
|
|
1417
|
-
|
|
1418
|
-
/** @returns {DocumentsResponse} */
|
|
1419
|
-
static DocumentsResponse() {
|
|
1420
|
-
return Joi.object({
|
|
1421
|
-
legal_name: Joi.string().allow(""),
|
|
1422
|
-
type: Joi.string().allow(""),
|
|
1423
|
-
value: Joi.string().allow(""),
|
|
1424
|
-
verified: Joi.boolean(),
|
|
1425
|
-
});
|
|
1426
|
-
}
|
|
1427
|
-
|
|
1428
|
-
/** @returns {Dp} */
|
|
1429
|
-
static Dp() {
|
|
1430
|
-
return Joi.object({
|
|
1431
|
-
area_code: Joi.number().allow(null),
|
|
1432
|
-
assign_dp_from_sb: Joi.boolean(),
|
|
1433
|
-
external_account_id: Joi.string().allow("").allow(null),
|
|
1434
|
-
fm_priority: Joi.number(),
|
|
1435
|
-
internal_account_id: Joi.string().allow(""),
|
|
1436
|
-
lm_priority: Joi.number(),
|
|
1437
|
-
operations: Joi.array().items(Joi.string().allow("")),
|
|
1438
|
-
payment_mode: Joi.string().allow(""),
|
|
1439
|
-
rvp_priority: Joi.number(),
|
|
1440
|
-
transport_mode: Joi.string().allow(""),
|
|
1383
|
+
assignment_preference: Joi.string().allow(""),
|
|
1441
1384
|
});
|
|
1442
1385
|
}
|
|
1443
1386
|
|
|
1444
|
-
/** @returns {
|
|
1445
|
-
static
|
|
1387
|
+
/** @returns {ZoneResponse} */
|
|
1388
|
+
static ZoneResponse() {
|
|
1446
1389
|
return Joi.object({
|
|
1447
|
-
|
|
1390
|
+
status_code: Joi.number().required(),
|
|
1391
|
+
zone_id: Joi.string().allow("").required(),
|
|
1392
|
+
success: Joi.boolean().required(),
|
|
1448
1393
|
});
|
|
1449
1394
|
}
|
|
1450
1395
|
|
|
1451
|
-
/** @returns {
|
|
1452
|
-
static
|
|
1396
|
+
/** @returns {GetZoneFromPincodeViewRequest} */
|
|
1397
|
+
static GetZoneFromPincodeViewRequest() {
|
|
1453
1398
|
return Joi.object({
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
value: Joi.string().allow(""),
|
|
1399
|
+
country: Joi.string().allow("").required(),
|
|
1400
|
+
pincode: Joi.string().allow("").required(),
|
|
1457
1401
|
});
|
|
1458
1402
|
}
|
|
1459
1403
|
|
|
1460
|
-
/** @returns {
|
|
1461
|
-
static
|
|
1404
|
+
/** @returns {Zone} */
|
|
1405
|
+
static Zone() {
|
|
1462
1406
|
return Joi.object({
|
|
1407
|
+
zone_id: Joi.string().allow("").required(),
|
|
1408
|
+
type: Joi.string().allow("").required(),
|
|
1463
1409
|
name: Joi.string().allow("").required(),
|
|
1464
|
-
|
|
1465
|
-
|
|
1410
|
+
tags: Joi.array().items(Joi.string().allow("")).required(),
|
|
1411
|
+
slug: Joi.string().allow("").required(),
|
|
1412
|
+
is_active: Joi.boolean().required(),
|
|
1413
|
+
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1414
|
+
assignment_preference: Joi.string().allow("").required(),
|
|
1466
1415
|
});
|
|
1467
1416
|
}
|
|
1468
1417
|
|
|
1469
|
-
/** @returns {
|
|
1470
|
-
static
|
|
1418
|
+
/** @returns {GetZoneFromPincodeViewResponse} */
|
|
1419
|
+
static GetZoneFromPincodeViewResponse() {
|
|
1471
1420
|
return Joi.object({
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
item_total: Joi.number().required(),
|
|
1475
|
-
size: Joi.number().required(),
|
|
1476
|
-
type: Joi.string().allow("").required(),
|
|
1421
|
+
serviceability_type: Joi.string().allow("").required(),
|
|
1422
|
+
zones: Joi.array().items(ServiceabilityPlatformModel.Zone()).required(),
|
|
1477
1423
|
});
|
|
1478
1424
|
}
|
|
1479
1425
|
|
|
1480
|
-
/** @returns {
|
|
1481
|
-
static
|
|
1426
|
+
/** @returns {GetZoneFromApplicationIdViewResponse} */
|
|
1427
|
+
static GetZoneFromApplicationIdViewResponse() {
|
|
1482
1428
|
return Joi.object({
|
|
1483
|
-
|
|
1484
|
-
|
|
1429
|
+
page: Joi.array()
|
|
1430
|
+
.items(ServiceabilityPlatformModel.ZoneDataItem())
|
|
1431
|
+
.required(),
|
|
1432
|
+
items: Joi.array()
|
|
1433
|
+
.items(ServiceabilityPlatformModel.ListViewItems())
|
|
1434
|
+
.required(),
|
|
1485
1435
|
});
|
|
1486
1436
|
}
|
|
1487
1437
|
|
|
1488
|
-
/** @returns {
|
|
1489
|
-
static
|
|
1438
|
+
/** @returns {ServiceabilityPageResponse} */
|
|
1439
|
+
static ServiceabilityPageResponse() {
|
|
1490
1440
|
return Joi.object({
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
success: Joi.boolean().required(),
|
|
1441
|
+
type: Joi.string().allow(""),
|
|
1442
|
+
has_next: Joi.boolean(),
|
|
1443
|
+
item_total: Joi.number(),
|
|
1444
|
+
size: Joi.number(),
|
|
1445
|
+
current: Joi.number(),
|
|
1497
1446
|
});
|
|
1498
1447
|
}
|
|
1499
1448
|
|
|
1500
|
-
/** @returns {
|
|
1501
|
-
static
|
|
1449
|
+
/** @returns {MobileNo} */
|
|
1450
|
+
static MobileNo() {
|
|
1502
1451
|
return Joi.object({
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
value: Joi.string().allow("").allow(null),
|
|
1452
|
+
number: Joi.string().allow(""),
|
|
1453
|
+
country_code: Joi.number(),
|
|
1506
1454
|
});
|
|
1507
1455
|
}
|
|
1508
1456
|
|
|
1509
|
-
/** @returns {
|
|
1510
|
-
static
|
|
1457
|
+
/** @returns {ManagerResponse} */
|
|
1458
|
+
static ManagerResponse() {
|
|
1511
1459
|
return Joi.object({
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1460
|
+
email: Joi.string().allow(""),
|
|
1461
|
+
mobile_no: ServiceabilityPlatformModel.MobileNo(),
|
|
1462
|
+
name: Joi.string().allow(""),
|
|
1515
1463
|
});
|
|
1516
1464
|
}
|
|
1517
1465
|
|
|
1518
|
-
/** @returns {
|
|
1519
|
-
static
|
|
1466
|
+
/** @returns {ModifiedByResponse} */
|
|
1467
|
+
static ModifiedByResponse() {
|
|
1520
1468
|
return Joi.object({
|
|
1521
|
-
|
|
1469
|
+
username: Joi.string().allow(""),
|
|
1470
|
+
user_id: Joi.string().allow(""),
|
|
1522
1471
|
});
|
|
1523
1472
|
}
|
|
1524
1473
|
|
|
1525
|
-
/** @returns {
|
|
1526
|
-
static
|
|
1474
|
+
/** @returns {IntegrationTypeResponse} */
|
|
1475
|
+
static IntegrationTypeResponse() {
|
|
1527
1476
|
return Joi.object({
|
|
1528
|
-
|
|
1529
|
-
|
|
1530
|
-
.required(),
|
|
1531
|
-
success: Joi.boolean().required(),
|
|
1477
|
+
inventory: Joi.string().allow(""),
|
|
1478
|
+
order: Joi.string().allow(""),
|
|
1532
1479
|
});
|
|
1533
1480
|
}
|
|
1534
1481
|
|
|
1535
|
-
/** @returns {
|
|
1536
|
-
static
|
|
1482
|
+
/** @returns {ProductReturnConfigResponse} */
|
|
1483
|
+
static ProductReturnConfigResponse() {
|
|
1537
1484
|
return Joi.object({
|
|
1538
|
-
|
|
1539
|
-
.items(ServiceabilityPlatformModel.ListViewItems())
|
|
1540
|
-
.required(),
|
|
1541
|
-
page: Joi.array()
|
|
1542
|
-
.items(ServiceabilityPlatformModel.PageSchema())
|
|
1543
|
-
.required(),
|
|
1485
|
+
on_same_store: Joi.boolean(),
|
|
1544
1486
|
});
|
|
1545
1487
|
}
|
|
1546
1488
|
|
|
1547
|
-
/** @returns {
|
|
1548
|
-
static
|
|
1489
|
+
/** @returns {ContactNumberResponse} */
|
|
1490
|
+
static ContactNumberResponse() {
|
|
1549
1491
|
return Joi.object({
|
|
1550
|
-
|
|
1492
|
+
number: Joi.string().allow(""),
|
|
1493
|
+
country_code: Joi.number(),
|
|
1551
1494
|
});
|
|
1552
1495
|
}
|
|
1553
1496
|
|
|
1554
|
-
/** @returns {
|
|
1555
|
-
static
|
|
1497
|
+
/** @returns {AddressResponse} */
|
|
1498
|
+
static AddressResponse() {
|
|
1556
1499
|
return Joi.object({
|
|
1557
|
-
|
|
1558
|
-
|
|
1559
|
-
),
|
|
1560
|
-
|
|
1500
|
+
city: Joi.string().allow(""),
|
|
1501
|
+
address1: Joi.string().allow(""),
|
|
1502
|
+
pincode: Joi.number(),
|
|
1503
|
+
address2: Joi.string().allow(""),
|
|
1504
|
+
landmark: Joi.string().allow(""),
|
|
1505
|
+
state: Joi.string().allow(""),
|
|
1506
|
+
country: Joi.string().allow(""),
|
|
1507
|
+
latitude: Joi.number(),
|
|
1508
|
+
longitude: Joi.number(),
|
|
1561
1509
|
});
|
|
1562
1510
|
}
|
|
1563
1511
|
|
|
1564
|
-
/** @returns {
|
|
1565
|
-
static
|
|
1512
|
+
/** @returns {CreatedByResponse} */
|
|
1513
|
+
static CreatedByResponse() {
|
|
1566
1514
|
return Joi.object({
|
|
1567
|
-
|
|
1568
|
-
|
|
1515
|
+
username: Joi.string().allow(""),
|
|
1516
|
+
user_id: Joi.string().allow(""),
|
|
1569
1517
|
});
|
|
1570
1518
|
}
|
|
1571
1519
|
|
|
1572
|
-
/** @returns {
|
|
1573
|
-
static
|
|
1520
|
+
/** @returns {EwayBillResponse} */
|
|
1521
|
+
static EwayBillResponse() {
|
|
1574
1522
|
return Joi.object({
|
|
1575
|
-
|
|
1576
|
-
channels: Joi.array()
|
|
1577
|
-
.items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
|
|
1578
|
-
.required(),
|
|
1579
|
-
company_id: Joi.number(),
|
|
1580
|
-
is_active: Joi.boolean().required(),
|
|
1581
|
-
mapping: Joi.array()
|
|
1582
|
-
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
1583
|
-
.required(),
|
|
1584
|
-
name: Joi.string().allow("").required(),
|
|
1585
|
-
product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
|
|
1586
|
-
region_type: Joi.string().allow("").required(),
|
|
1587
|
-
slug: Joi.string().allow("").required(),
|
|
1588
|
-
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1589
|
-
stores_count: Joi.number().required(),
|
|
1590
|
-
zone_id: Joi.string().allow("").required(),
|
|
1523
|
+
enabled: Joi.boolean(),
|
|
1591
1524
|
});
|
|
1592
1525
|
}
|
|
1593
1526
|
|
|
1594
|
-
/** @returns {
|
|
1595
|
-
static
|
|
1527
|
+
/** @returns {EinvoiceResponse} */
|
|
1528
|
+
static EinvoiceResponse() {
|
|
1596
1529
|
return Joi.object({
|
|
1597
|
-
|
|
1598
|
-
channel_type: Joi.string().allow("").required(),
|
|
1530
|
+
enabled: Joi.boolean(),
|
|
1599
1531
|
});
|
|
1600
1532
|
}
|
|
1601
1533
|
|
|
1602
|
-
/** @returns {
|
|
1603
|
-
static
|
|
1534
|
+
/** @returns {GstCredentialsResponse} */
|
|
1535
|
+
static GstCredentialsResponse() {
|
|
1604
1536
|
return Joi.object({
|
|
1605
|
-
|
|
1606
|
-
|
|
1607
|
-
.items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
|
|
1608
|
-
.required(),
|
|
1609
|
-
company_id: Joi.number(),
|
|
1610
|
-
is_active: Joi.boolean().required(),
|
|
1611
|
-
mapping: Joi.array()
|
|
1612
|
-
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
1613
|
-
.required(),
|
|
1614
|
-
name: Joi.string().allow("").required(),
|
|
1615
|
-
product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
|
|
1616
|
-
region_type: Joi.string().allow(""),
|
|
1617
|
-
slug: Joi.string().allow("").required(),
|
|
1618
|
-
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1619
|
-
stores_count: Joi.number().required(),
|
|
1620
|
-
zone_id: Joi.string().allow("").required(),
|
|
1537
|
+
e_waybill: ServiceabilityPlatformModel.EwayBillResponse(),
|
|
1538
|
+
e_invoice: ServiceabilityPlatformModel.EinvoiceResponse(),
|
|
1621
1539
|
});
|
|
1622
1540
|
}
|
|
1623
1541
|
|
|
1624
|
-
/** @returns {
|
|
1625
|
-
static
|
|
1542
|
+
/** @returns {WarningsResponse} */
|
|
1543
|
+
static WarningsResponse() {
|
|
1626
1544
|
return Joi.object({
|
|
1627
|
-
|
|
1628
|
-
.items(ServiceabilityPlatformModel.ListViewItems())
|
|
1629
|
-
.required(),
|
|
1630
|
-
page: Joi.array()
|
|
1631
|
-
.items(ServiceabilityPlatformModel.ZoneDataItem())
|
|
1632
|
-
.required(),
|
|
1545
|
+
store_address: Joi.string().allow(""),
|
|
1633
1546
|
});
|
|
1634
1547
|
}
|
|
1635
1548
|
|
|
1636
|
-
/** @returns {
|
|
1637
|
-
static
|
|
1549
|
+
/** @returns {OpeningClosing} */
|
|
1550
|
+
static OpeningClosing() {
|
|
1638
1551
|
return Joi.object({
|
|
1639
|
-
|
|
1640
|
-
|
|
1552
|
+
minute: Joi.number(),
|
|
1553
|
+
hour: Joi.number(),
|
|
1641
1554
|
});
|
|
1642
1555
|
}
|
|
1643
1556
|
|
|
1644
|
-
/** @returns {
|
|
1645
|
-
static
|
|
1557
|
+
/** @returns {TimmingResponse} */
|
|
1558
|
+
static TimmingResponse() {
|
|
1646
1559
|
return Joi.object({
|
|
1647
|
-
|
|
1648
|
-
|
|
1560
|
+
open: Joi.boolean(),
|
|
1561
|
+
weekday: Joi.string().allow(""),
|
|
1562
|
+
closing: ServiceabilityPlatformModel.OpeningClosing(),
|
|
1563
|
+
opening: ServiceabilityPlatformModel.OpeningClosing(),
|
|
1649
1564
|
});
|
|
1650
1565
|
}
|
|
1651
1566
|
|
|
1652
|
-
/** @returns {
|
|
1653
|
-
static
|
|
1567
|
+
/** @returns {DocumentsResponse} */
|
|
1568
|
+
static DocumentsResponse() {
|
|
1654
1569
|
return Joi.object({
|
|
1655
|
-
|
|
1656
|
-
|
|
1570
|
+
legal_name: Joi.string().allow(""),
|
|
1571
|
+
value: Joi.string().allow(""),
|
|
1572
|
+
type: Joi.string().allow(""),
|
|
1573
|
+
verified: Joi.boolean(),
|
|
1657
1574
|
});
|
|
1658
1575
|
}
|
|
1659
1576
|
|
|
1660
|
-
/** @returns {
|
|
1661
|
-
static
|
|
1577
|
+
/** @returns {Dp} */
|
|
1578
|
+
static Dp() {
|
|
1662
1579
|
return Joi.object({
|
|
1663
|
-
|
|
1580
|
+
fm_priority: Joi.number(),
|
|
1581
|
+
rvp_priority: Joi.number(),
|
|
1582
|
+
lm_priority: Joi.number(),
|
|
1583
|
+
internal_account_id: Joi.string().allow(""),
|
|
1584
|
+
area_code: Joi.number().allow(null),
|
|
1585
|
+
payment_mode: Joi.string().allow(""),
|
|
1586
|
+
operations: Joi.array().items(Joi.string().allow("")),
|
|
1587
|
+
external_account_id: Joi.string().allow("").allow(null),
|
|
1588
|
+
transport_mode: Joi.string().allow(""),
|
|
1589
|
+
assign_dp_from_sb: Joi.boolean(),
|
|
1664
1590
|
});
|
|
1665
1591
|
}
|
|
1666
1592
|
|
|
1667
|
-
/** @returns {
|
|
1668
|
-
static
|
|
1593
|
+
/** @returns {LogisticsResponse} */
|
|
1594
|
+
static LogisticsResponse() {
|
|
1669
1595
|
return Joi.object({
|
|
1670
|
-
|
|
1671
|
-
|
|
1596
|
+
override: Joi.boolean(),
|
|
1597
|
+
dp: ServiceabilityPlatformModel.Dp(),
|
|
1672
1598
|
});
|
|
1673
1599
|
}
|
|
1674
1600
|
|
|
1675
1601
|
/** @returns {ItemResponse} */
|
|
1676
1602
|
static ItemResponse() {
|
|
1677
1603
|
return Joi.object({
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1604
|
+
created_on: Joi.string().allow(""),
|
|
1605
|
+
manager: ServiceabilityPlatformModel.ManagerResponse(),
|
|
1606
|
+
modified_by: ServiceabilityPlatformModel.ModifiedByResponse(),
|
|
1607
|
+
integration_type: ServiceabilityPlatformModel.IntegrationTypeResponse(),
|
|
1608
|
+
verified_on: Joi.string().allow(""),
|
|
1609
|
+
product_return_config: ServiceabilityPlatformModel.ProductReturnConfigResponse(),
|
|
1684
1610
|
contact_numbers: Joi.array().items(
|
|
1685
1611
|
ServiceabilityPlatformModel.ContactNumberResponse()
|
|
1686
1612
|
),
|
|
1613
|
+
verified_by: ServiceabilityPlatformModel.ModifiedByResponse(),
|
|
1614
|
+
stage: Joi.string().allow(""),
|
|
1615
|
+
address: ServiceabilityPlatformModel.AddressResponse(),
|
|
1616
|
+
modified_on: Joi.string().allow(""),
|
|
1687
1617
|
created_by: ServiceabilityPlatformModel.CreatedByResponse(),
|
|
1688
|
-
|
|
1618
|
+
gst_credentials: ServiceabilityPlatformModel.GstCredentialsResponse(),
|
|
1689
1619
|
display_name: Joi.string().allow(""),
|
|
1620
|
+
company_id: Joi.number(),
|
|
1621
|
+
uid: Joi.number(),
|
|
1622
|
+
_custom_json: Joi.any(),
|
|
1623
|
+
code: Joi.string().allow(""),
|
|
1624
|
+
warnings: ServiceabilityPlatformModel.WarningsResponse(),
|
|
1625
|
+
name: Joi.string().allow(""),
|
|
1626
|
+
timing: Joi.array().items(ServiceabilityPlatformModel.TimmingResponse()),
|
|
1690
1627
|
documents: Joi.array().items(
|
|
1691
1628
|
ServiceabilityPlatformModel.DocumentsResponse()
|
|
1692
1629
|
),
|
|
1693
|
-
gst_credentials: ServiceabilityPlatformModel.GstCredentialsResponse(),
|
|
1694
|
-
integration_type: ServiceabilityPlatformModel.IntegrationTypeResponse(),
|
|
1695
|
-
logistics: ServiceabilityPlatformModel.LogisticsResponse(),
|
|
1696
|
-
manager: ServiceabilityPlatformModel.ManagerResponse(),
|
|
1697
|
-
modified_by: ServiceabilityPlatformModel.ModifiedByResponse(),
|
|
1698
|
-
modified_on: Joi.string().allow(""),
|
|
1699
|
-
name: Joi.string().allow(""),
|
|
1700
|
-
notification_emails: Joi.array().items(Joi.string().allow("")),
|
|
1701
|
-
product_return_config: ServiceabilityPlatformModel.ProductReturnConfigResponse(),
|
|
1702
|
-
stage: Joi.string().allow(""),
|
|
1703
1630
|
store_type: Joi.string().allow(""),
|
|
1704
1631
|
sub_type: Joi.string().allow(""),
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
warnings: ServiceabilityPlatformModel.WarningsResponse(),
|
|
1632
|
+
company: Joi.number(),
|
|
1633
|
+
_cls: Joi.string().allow(""),
|
|
1634
|
+
logistics: ServiceabilityPlatformModel.LogisticsResponse(),
|
|
1635
|
+
notification_emails: Joi.array().items(Joi.string().allow("")),
|
|
1710
1636
|
});
|
|
1711
1637
|
}
|
|
1712
1638
|
|
|
1713
|
-
/** @returns {
|
|
1714
|
-
static
|
|
1639
|
+
/** @returns {GetStoresViewResponse} */
|
|
1640
|
+
static GetStoresViewResponse() {
|
|
1715
1641
|
return Joi.object({
|
|
1716
|
-
|
|
1717
|
-
|
|
1642
|
+
page: ServiceabilityPlatformModel.ServiceabilityPageResponse().required(),
|
|
1643
|
+
items: Joi.array().items(ServiceabilityPlatformModel.ItemResponse()),
|
|
1718
1644
|
});
|
|
1719
1645
|
}
|
|
1720
1646
|
|
|
1721
|
-
/** @returns {
|
|
1722
|
-
static
|
|
1647
|
+
/** @returns {ReAssignStoreRequest} */
|
|
1648
|
+
static ReAssignStoreRequest() {
|
|
1723
1649
|
return Joi.object({
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
name: Joi.string().allow("").required(),
|
|
1730
|
-
product: ServiceabilityPlatformModel.ListViewProduct().required(),
|
|
1731
|
-
regions_count: Joi.number().required(),
|
|
1732
|
-
slug: Joi.string().allow("").required(),
|
|
1733
|
-
stores_count: Joi.number().required(),
|
|
1734
|
-
zone_id: Joi.string().allow("").required(),
|
|
1650
|
+
to_pincode: Joi.string().allow("").required(),
|
|
1651
|
+
identifier: Joi.string().allow("").required(),
|
|
1652
|
+
configuration: Joi.any().required(),
|
|
1653
|
+
ignored_locations: Joi.array().items(Joi.string().allow("")).required(),
|
|
1654
|
+
articles: Joi.array().items(Joi.any()).required(),
|
|
1735
1655
|
});
|
|
1736
1656
|
}
|
|
1737
1657
|
|
|
1738
|
-
/** @returns {
|
|
1739
|
-
static
|
|
1658
|
+
/** @returns {ReAssignStoreResponse} */
|
|
1659
|
+
static ReAssignStoreResponse() {
|
|
1740
1660
|
return Joi.object({
|
|
1741
|
-
|
|
1742
|
-
|
|
1661
|
+
to_pincode: Joi.string().allow("").required(),
|
|
1662
|
+
success: Joi.boolean().required(),
|
|
1663
|
+
error: Joi.any().required(),
|
|
1664
|
+
articles: Joi.array().items(Joi.any()),
|
|
1743
1665
|
});
|
|
1744
1666
|
}
|
|
1745
1667
|
|
|
1746
|
-
/** @returns {
|
|
1747
|
-
static
|
|
1668
|
+
/** @returns {PincodeMopData} */
|
|
1669
|
+
static PincodeMopData() {
|
|
1748
1670
|
return Joi.object({
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
page: Joi.array()
|
|
1753
|
-
.items(ServiceabilityPlatformModel.ZoneDataItem())
|
|
1754
|
-
.required(),
|
|
1671
|
+
pincodes: Joi.array().items(Joi.number()).required(),
|
|
1672
|
+
country: Joi.string().allow("").required(),
|
|
1673
|
+
action: Joi.string().allow("").required(),
|
|
1755
1674
|
});
|
|
1756
1675
|
}
|
|
1757
1676
|
|
|
1758
|
-
/** @returns {
|
|
1759
|
-
static
|
|
1677
|
+
/** @returns {PincodeMopUpdateResponse} */
|
|
1678
|
+
static PincodeMopUpdateResponse() {
|
|
1760
1679
|
return Joi.object({
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1680
|
+
pincode: Joi.number().required(),
|
|
1681
|
+
channel_id: Joi.string().allow("").required(),
|
|
1682
|
+
country: Joi.string().allow("").required(),
|
|
1683
|
+
is_active: Joi.boolean().required(),
|
|
1764
1684
|
});
|
|
1765
1685
|
}
|
|
1766
1686
|
|
|
1767
|
-
/** @returns {
|
|
1768
|
-
static
|
|
1687
|
+
/** @returns {PincodeMOPresponse} */
|
|
1688
|
+
static PincodeMOPresponse() {
|
|
1769
1689
|
return Joi.object({
|
|
1770
|
-
|
|
1771
|
-
|
|
1690
|
+
success: Joi.boolean().required(),
|
|
1691
|
+
status_code: Joi.number().required(),
|
|
1692
|
+
batch_id: Joi.string().allow("").required(),
|
|
1693
|
+
country: Joi.string().allow("").required(),
|
|
1694
|
+
action: Joi.string().allow("").required(),
|
|
1695
|
+
pincodes: Joi.array().items(Joi.number()),
|
|
1696
|
+
updated_pincodes: Joi.array().items(
|
|
1697
|
+
ServiceabilityPlatformModel.PincodeMopUpdateResponse()
|
|
1772
1698
|
),
|
|
1773
|
-
type: Joi.string().allow(""),
|
|
1774
1699
|
});
|
|
1775
1700
|
}
|
|
1776
1701
|
|
|
1777
|
-
/** @returns {
|
|
1778
|
-
static
|
|
1702
|
+
/** @returns {CommonError} */
|
|
1703
|
+
static CommonError() {
|
|
1779
1704
|
return Joi.object({
|
|
1780
|
-
|
|
1781
|
-
|
|
1782
|
-
|
|
1783
|
-
parent_id: Joi.string().allow(""),
|
|
1784
|
-
parent_ids: Joi.array().items(Joi.string().allow("")),
|
|
1785
|
-
sub_type: Joi.string().allow(""),
|
|
1705
|
+
status_code: Joi.string().allow(""),
|
|
1706
|
+
error: Joi.any(),
|
|
1707
|
+
success: Joi.string().allow(""),
|
|
1786
1708
|
});
|
|
1787
1709
|
}
|
|
1788
1710
|
|
|
1789
|
-
/** @returns {
|
|
1790
|
-
static
|
|
1711
|
+
/** @returns {PincodeMopBulkData} */
|
|
1712
|
+
static PincodeMopBulkData() {
|
|
1791
1713
|
return Joi.object({
|
|
1792
|
-
|
|
1793
|
-
|
|
1714
|
+
batch_id: Joi.string().allow("").required(),
|
|
1715
|
+
s3_url: Joi.string().allow("").required(),
|
|
1794
1716
|
});
|
|
1795
1717
|
}
|
|
1796
1718
|
|
|
1797
|
-
/** @returns {
|
|
1798
|
-
static
|
|
1719
|
+
/** @returns {PincodeBulkViewResponse} */
|
|
1720
|
+
static PincodeBulkViewResponse() {
|
|
1799
1721
|
return Joi.object({
|
|
1800
|
-
|
|
1801
|
-
|
|
1802
|
-
name: Joi.string().allow(""),
|
|
1722
|
+
batch_id: Joi.string().allow("").required(),
|
|
1723
|
+
s3_url: Joi.string().allow("").required(),
|
|
1803
1724
|
});
|
|
1804
1725
|
}
|
|
1805
1726
|
|
|
1806
|
-
/** @returns {
|
|
1807
|
-
static
|
|
1727
|
+
/** @returns {PincodeCodStatusListingRequest} */
|
|
1728
|
+
static PincodeCodStatusListingRequest() {
|
|
1808
1729
|
return Joi.object({
|
|
1809
|
-
|
|
1810
|
-
|
|
1730
|
+
country: Joi.string().allow(""),
|
|
1731
|
+
is_active: Joi.boolean(),
|
|
1732
|
+
pincode: Joi.number().allow(null),
|
|
1733
|
+
current: Joi.number(),
|
|
1734
|
+
page_size: Joi.number(),
|
|
1811
1735
|
});
|
|
1812
1736
|
}
|
|
1813
1737
|
|
|
1814
|
-
/** @returns {
|
|
1815
|
-
static
|
|
1738
|
+
/** @returns {PincodeCodStatusListingResponse} */
|
|
1739
|
+
static PincodeCodStatusListingResponse() {
|
|
1816
1740
|
return Joi.object({
|
|
1817
|
-
|
|
1818
|
-
|
|
1741
|
+
country: Joi.string().allow("").required(),
|
|
1742
|
+
data: Joi.array()
|
|
1743
|
+
.items(Joi.link("#PincodeCodStatusListingResponse"))
|
|
1744
|
+
.required(),
|
|
1745
|
+
success: Joi.boolean().required(),
|
|
1746
|
+
errors: Joi.array().items(ServiceabilityPlatformModel.Error()),
|
|
1747
|
+
page: ServiceabilityPlatformModel.PincodeCodStatusListingPage().required(),
|
|
1748
|
+
summary: ServiceabilityPlatformModel.PincodeCodStatusListingSummary().required(),
|
|
1819
1749
|
});
|
|
1820
1750
|
}
|
|
1821
1751
|
|
|
1822
|
-
/** @returns {
|
|
1823
|
-
static
|
|
1752
|
+
/** @returns {Error} */
|
|
1753
|
+
static Error() {
|
|
1824
1754
|
return Joi.object({
|
|
1825
|
-
|
|
1826
|
-
|
|
1755
|
+
type: Joi.string().allow("").allow(null),
|
|
1756
|
+
value: Joi.string().allow("").allow(null),
|
|
1757
|
+
message: Joi.string().allow("").allow(null),
|
|
1827
1758
|
});
|
|
1828
1759
|
}
|
|
1829
1760
|
|
|
1830
|
-
/** @returns {
|
|
1831
|
-
static
|
|
1761
|
+
/** @returns {PincodeCodStatusListingPage} */
|
|
1762
|
+
static PincodeCodStatusListingPage() {
|
|
1832
1763
|
return Joi.object({
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
|
|
1836
|
-
|
|
1837
|
-
|
|
1838
|
-
height: Joi.number().required(),
|
|
1839
|
-
length: Joi.number().required(),
|
|
1840
|
-
max_weight: Joi.number(),
|
|
1841
|
-
media: Joi.array().items(Joi.string().allow("")),
|
|
1842
|
-
name: Joi.string().allow("").required(),
|
|
1843
|
-
package_type: Joi.string().allow("").required(),
|
|
1844
|
-
package_vol_weight: Joi.number(),
|
|
1845
|
-
rules: Joi.array().items(
|
|
1846
|
-
ServiceabilityPlatformModel.PackageMaterialRule()
|
|
1847
|
-
),
|
|
1848
|
-
size: Joi.string().allow("").required(),
|
|
1849
|
-
status: Joi.string().allow("").required(),
|
|
1850
|
-
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1851
|
-
track_inventory: Joi.boolean(),
|
|
1852
|
-
weight: Joi.number().required(),
|
|
1853
|
-
width: Joi.number().required(),
|
|
1764
|
+
type: Joi.string().allow("").required(),
|
|
1765
|
+
has_next: Joi.boolean().required(),
|
|
1766
|
+
item_total: Joi.number().required(),
|
|
1767
|
+
size: Joi.number().required(),
|
|
1768
|
+
current: Joi.number().required(),
|
|
1854
1769
|
});
|
|
1855
1770
|
}
|
|
1856
1771
|
|
|
1857
|
-
/** @returns {
|
|
1858
|
-
static
|
|
1772
|
+
/** @returns {PincodeCodStatusListingSummary} */
|
|
1773
|
+
static PincodeCodStatusListingSummary() {
|
|
1859
1774
|
return Joi.object({
|
|
1860
|
-
|
|
1861
|
-
|
|
1775
|
+
total_active_pincodes: Joi.number().required(),
|
|
1776
|
+
total_inactive_pincodes: Joi.number().required(),
|
|
1862
1777
|
});
|
|
1863
1778
|
}
|
|
1864
1779
|
|
|
1865
|
-
/** @returns {
|
|
1866
|
-
static
|
|
1780
|
+
/** @returns {PincodeMopUpdateAuditHistoryRequest} */
|
|
1781
|
+
static PincodeMopUpdateAuditHistoryRequest() {
|
|
1867
1782
|
return Joi.object({
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
.items(ServiceabilityPlatformModel.Channel())
|
|
1871
|
-
.required(),
|
|
1872
|
-
error_rate: Joi.number().required(),
|
|
1873
|
-
height: Joi.number().required(),
|
|
1874
|
-
id: Joi.string().allow(""),
|
|
1875
|
-
item_id: Joi.number(),
|
|
1876
|
-
length: Joi.number().required(),
|
|
1877
|
-
max_weight: Joi.number(),
|
|
1878
|
-
media: Joi.array().items(Joi.string().allow("")),
|
|
1879
|
-
name: Joi.string().allow("").required(),
|
|
1880
|
-
package_type: Joi.string().allow("").required(),
|
|
1881
|
-
package_vol_weight: Joi.number(),
|
|
1882
|
-
rules: Joi.array().items(
|
|
1883
|
-
ServiceabilityPlatformModel.PackageMaterialRule()
|
|
1884
|
-
),
|
|
1885
|
-
size: Joi.string().allow("").required(),
|
|
1886
|
-
status: Joi.string().allow("").required(),
|
|
1887
|
-
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1888
|
-
track_inventory: Joi.boolean(),
|
|
1889
|
-
weight: Joi.number().required(),
|
|
1890
|
-
width: Joi.number().required(),
|
|
1783
|
+
entity_type: Joi.string().allow("").required(),
|
|
1784
|
+
file_name: Joi.string().allow(""),
|
|
1891
1785
|
});
|
|
1892
1786
|
}
|
|
1893
1787
|
|
|
1894
|
-
/** @returns {
|
|
1895
|
-
static
|
|
1788
|
+
/** @returns {PincodeMopUpdateAuditHistoryPaging} */
|
|
1789
|
+
static PincodeMopUpdateAuditHistoryPaging() {
|
|
1896
1790
|
return Joi.object({
|
|
1897
|
-
|
|
1898
|
-
|
|
1899
|
-
|
|
1791
|
+
type: Joi.string().allow(""),
|
|
1792
|
+
size: Joi.number(),
|
|
1793
|
+
current: Joi.number(),
|
|
1794
|
+
has_next: Joi.boolean(),
|
|
1795
|
+
item_total: Joi.number(),
|
|
1796
|
+
});
|
|
1797
|
+
}
|
|
1798
|
+
|
|
1799
|
+
/** @returns {PincodeMopUpdateAuditHistoryResponse} */
|
|
1800
|
+
static PincodeMopUpdateAuditHistoryResponse() {
|
|
1801
|
+
return Joi.object({
|
|
1802
|
+
batch_id: Joi.string().allow(""),
|
|
1803
|
+
entity_type: Joi.string().allow(""),
|
|
1804
|
+
error_file_s3_url: Joi.string().allow(""),
|
|
1805
|
+
s3_url: Joi.string().allow(""),
|
|
1806
|
+
file_name: Joi.string().allow(""),
|
|
1807
|
+
updated_at: Joi.string().allow(""),
|
|
1808
|
+
updated_by: Joi.string().allow(""),
|
|
1809
|
+
success: Joi.boolean(),
|
|
1900
1810
|
});
|
|
1901
1811
|
}
|
|
1902
1812
|
|
|
1903
|
-
/** @returns {
|
|
1904
|
-
static
|
|
1813
|
+
/** @returns {PincodeMopUpdateAuditHistoryResponseData} */
|
|
1814
|
+
static PincodeMopUpdateAuditHistoryResponseData() {
|
|
1905
1815
|
return Joi.object({
|
|
1906
|
-
|
|
1907
|
-
page: ServiceabilityPlatformModel.
|
|
1816
|
+
entity_type: Joi.string().allow(""),
|
|
1817
|
+
page: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryPaging().required(),
|
|
1818
|
+
data: Joi.array()
|
|
1819
|
+
.items(
|
|
1820
|
+
ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResponse()
|
|
1821
|
+
)
|
|
1822
|
+
.required(),
|
|
1908
1823
|
});
|
|
1909
1824
|
}
|
|
1910
1825
|
|
|
1911
|
-
/** @returns {
|
|
1912
|
-
static
|
|
1826
|
+
/** @returns {ArithmeticOperations} */
|
|
1827
|
+
static ArithmeticOperations() {
|
|
1913
1828
|
return Joi.object({
|
|
1914
|
-
|
|
1915
|
-
|
|
1829
|
+
lt: Joi.number(),
|
|
1830
|
+
gt: Joi.number(),
|
|
1831
|
+
lte: Joi.number(),
|
|
1832
|
+
gte: Joi.number(),
|
|
1916
1833
|
});
|
|
1917
1834
|
}
|
|
1918
1835
|
|
|
1919
|
-
/** @returns {
|
|
1920
|
-
static
|
|
1836
|
+
/** @returns {SchemeRulesFeatures} */
|
|
1837
|
+
static SchemeRulesFeatures() {
|
|
1921
1838
|
return Joi.object({
|
|
1922
|
-
|
|
1923
|
-
|
|
1924
|
-
|
|
1925
|
-
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1839
|
+
quality_check: Joi.boolean(),
|
|
1840
|
+
quick_response_code: Joi.boolean(),
|
|
1841
|
+
e_waybill: Joi.boolean(),
|
|
1842
|
+
multi_part_shipments: Joi.boolean(),
|
|
1843
|
+
flammable: Joi.boolean(),
|
|
1844
|
+
hazmat: Joi.boolean(),
|
|
1845
|
+
battery_operated: Joi.boolean(),
|
|
1929
1846
|
});
|
|
1930
1847
|
}
|
|
1931
1848
|
|
|
1932
|
-
/** @returns {
|
|
1933
|
-
static
|
|
1849
|
+
/** @returns {SchemeRules} */
|
|
1850
|
+
static SchemeRules() {
|
|
1934
1851
|
return Joi.object({
|
|
1935
|
-
|
|
1852
|
+
weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
1853
|
+
transport_type: Joi.array().items(Joi.string().allow("")),
|
|
1854
|
+
region: Joi.string().allow(""),
|
|
1855
|
+
payment_mode: Joi.array().items(Joi.string().allow("")),
|
|
1856
|
+
feature: ServiceabilityPlatformModel.SchemeRulesFeatures(),
|
|
1936
1857
|
});
|
|
1937
1858
|
}
|
|
1938
1859
|
|
|
1939
|
-
/** @returns {
|
|
1940
|
-
static
|
|
1860
|
+
/** @returns {CourierAccount} */
|
|
1861
|
+
static CourierAccount() {
|
|
1941
1862
|
return Joi.object({
|
|
1942
|
-
|
|
1863
|
+
extension_id: Joi.string().allow("").required(),
|
|
1864
|
+
account_id: Joi.string().allow("").required(),
|
|
1865
|
+
scheme_id: Joi.string().allow("").required(),
|
|
1866
|
+
is_self_ship: Joi.boolean().required(),
|
|
1867
|
+
stage: Joi.string().allow("").required(),
|
|
1868
|
+
is_own_account: Joi.boolean().required(),
|
|
1943
1869
|
});
|
|
1944
1870
|
}
|
|
1945
1871
|
|
|
1946
|
-
/** @returns {
|
|
1947
|
-
static
|
|
1872
|
+
/** @returns {ErrorResponse} */
|
|
1873
|
+
static ErrorResponse() {
|
|
1948
1874
|
return Joi.object({
|
|
1949
|
-
|
|
1875
|
+
value: Joi.string().allow("").required(),
|
|
1876
|
+
message: Joi.string().allow("").required(),
|
|
1877
|
+
type: Joi.string().allow("").required(),
|
|
1950
1878
|
});
|
|
1951
1879
|
}
|
|
1952
1880
|
|
|
1953
|
-
/** @returns {
|
|
1954
|
-
static
|
|
1881
|
+
/** @returns {CourierPartnerAccountFailureResponse} */
|
|
1882
|
+
static CourierPartnerAccountFailureResponse() {
|
|
1955
1883
|
return Joi.object({
|
|
1956
|
-
|
|
1957
|
-
|
|
1958
|
-
|
|
1959
|
-
|
|
1960
|
-
name: Joi.string().allow("").required(),
|
|
1961
|
-
product_id: ServiceabilityPlatformModel.PackageRuleProduct(),
|
|
1962
|
-
product_tag: ServiceabilityPlatformModel.PackageRuleProductTag(),
|
|
1963
|
-
type: Joi.string().allow("").required(),
|
|
1884
|
+
success: Joi.boolean().required(),
|
|
1885
|
+
error: Joi.array()
|
|
1886
|
+
.items(ServiceabilityPlatformModel.ErrorResponse())
|
|
1887
|
+
.required(),
|
|
1964
1888
|
});
|
|
1965
1889
|
}
|
|
1966
1890
|
|
|
1967
1891
|
/** @returns {Page} */
|
|
1968
1892
|
static Page() {
|
|
1969
1893
|
return Joi.object({
|
|
1970
|
-
current: Joi.number(),
|
|
1971
|
-
has_next: Joi.boolean(),
|
|
1972
|
-
has_previous: Joi.boolean(),
|
|
1973
1894
|
item_total: Joi.number(),
|
|
1974
1895
|
next_id: Joi.string().allow(""),
|
|
1975
|
-
|
|
1896
|
+
has_previous: Joi.boolean(),
|
|
1897
|
+
has_next: Joi.boolean(),
|
|
1898
|
+
current: Joi.number(),
|
|
1976
1899
|
type: Joi.string().allow("").required(),
|
|
1900
|
+
size: Joi.number(),
|
|
1977
1901
|
});
|
|
1978
1902
|
}
|
|
1979
1903
|
|
|
1980
|
-
/** @returns {
|
|
1981
|
-
static
|
|
1904
|
+
/** @returns {CourierPartnerList} */
|
|
1905
|
+
static CourierPartnerList() {
|
|
1982
1906
|
return Joi.object({
|
|
1983
|
-
|
|
1984
|
-
|
|
1985
|
-
|
|
1986
|
-
|
|
1987
|
-
type: Joi.string().allow("").required(),
|
|
1907
|
+
extension_id: Joi.string().allow("").required(),
|
|
1908
|
+
account_id: Joi.string().allow("").required(),
|
|
1909
|
+
name: Joi.string().allow("").required(),
|
|
1910
|
+
is_self_ship: Joi.boolean().required(),
|
|
1988
1911
|
});
|
|
1989
1912
|
}
|
|
1990
1913
|
|
|
1991
|
-
/** @returns {
|
|
1992
|
-
static
|
|
1914
|
+
/** @returns {LocationRuleValues} */
|
|
1915
|
+
static LocationRuleValues() {
|
|
1993
1916
|
return Joi.object({
|
|
1994
|
-
|
|
1995
|
-
|
|
1917
|
+
id: Joi.string().allow("").required(),
|
|
1918
|
+
sub_type: Joi.string().allow(""),
|
|
1919
|
+
name: Joi.string().allow(""),
|
|
1920
|
+
display_name: Joi.string().allow(""),
|
|
1921
|
+
parent_id: Joi.string().allow(""),
|
|
1922
|
+
parent_ids: Joi.array().items(Joi.string().allow("")),
|
|
1996
1923
|
});
|
|
1997
1924
|
}
|
|
1998
1925
|
|
|
1999
|
-
/** @returns {
|
|
2000
|
-
static
|
|
1926
|
+
/** @returns {LocationRule} */
|
|
1927
|
+
static LocationRule() {
|
|
2001
1928
|
return Joi.object({
|
|
2002
|
-
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
type: Joi.string().allow("").required(),
|
|
1929
|
+
type: Joi.string().allow(""),
|
|
1930
|
+
includes: Joi.array().items(
|
|
1931
|
+
ServiceabilityPlatformModel.LocationRuleValues()
|
|
1932
|
+
),
|
|
2007
1933
|
});
|
|
2008
1934
|
}
|
|
2009
1935
|
|
|
2010
|
-
/** @returns {
|
|
2011
|
-
static
|
|
1936
|
+
/** @returns {StringComparisonOperations} */
|
|
1937
|
+
static StringComparisonOperations() {
|
|
2012
1938
|
return Joi.object({
|
|
2013
|
-
|
|
2014
|
-
current: Joi.number(),
|
|
2015
|
-
is_active: Joi.boolean(),
|
|
2016
|
-
page_size: Joi.number(),
|
|
2017
|
-
pincode: Joi.number().allow(null),
|
|
1939
|
+
includes: Joi.array().items(Joi.string().allow("")),
|
|
2018
1940
|
});
|
|
2019
1941
|
}
|
|
2020
1942
|
|
|
2021
|
-
/** @returns {
|
|
2022
|
-
static
|
|
1943
|
+
/** @returns {IntComparisonOperations} */
|
|
1944
|
+
static IntComparisonOperations() {
|
|
2023
1945
|
return Joi.object({
|
|
2024
|
-
|
|
2025
|
-
data: Joi.array()
|
|
2026
|
-
.items(Joi.link("#PincodeCodStatusListingResponse"))
|
|
2027
|
-
.required(),
|
|
2028
|
-
errors: Joi.array().items(ServiceabilityPlatformModel.Error()),
|
|
2029
|
-
page: ServiceabilityPlatformModel.PincodeCodStatusListingPage().required(),
|
|
2030
|
-
success: Joi.boolean().required(),
|
|
2031
|
-
summary: ServiceabilityPlatformModel.PincodeCodStatusListingSummary().required(),
|
|
1946
|
+
includes: Joi.array().items(Joi.number()),
|
|
2032
1947
|
});
|
|
2033
1948
|
}
|
|
2034
1949
|
|
|
2035
|
-
/** @returns {
|
|
2036
|
-
static
|
|
1950
|
+
/** @returns {CourierPartnerRuleConditions} */
|
|
1951
|
+
static CourierPartnerRuleConditions() {
|
|
2037
1952
|
return Joi.object({
|
|
2038
|
-
|
|
2039
|
-
|
|
1953
|
+
forward: ServiceabilityPlatformModel.LocationRule(),
|
|
1954
|
+
reverse: ServiceabilityPlatformModel.LocationRule(),
|
|
1955
|
+
payment_mode: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1956
|
+
category_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
1957
|
+
product_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
1958
|
+
product_tags: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1959
|
+
zone_ids: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1960
|
+
department_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
1961
|
+
brand_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
1962
|
+
order_place_date: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
1963
|
+
store_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
1964
|
+
store_type: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1965
|
+
store_tags: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
1966
|
+
shipment_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
1967
|
+
shipment_cost: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
1968
|
+
shipment_volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
2040
1969
|
});
|
|
2041
1970
|
}
|
|
2042
1971
|
|
|
2043
|
-
/** @returns {
|
|
2044
|
-
static
|
|
1972
|
+
/** @returns {CourierPartnerRule} */
|
|
1973
|
+
static CourierPartnerRule() {
|
|
2045
1974
|
return Joi.object({
|
|
2046
|
-
|
|
2047
|
-
|
|
1975
|
+
is_active: Joi.boolean().required(),
|
|
1976
|
+
cp_list: Joi.array().items(
|
|
1977
|
+
ServiceabilityPlatformModel.CourierPartnerList()
|
|
1978
|
+
),
|
|
1979
|
+
name: Joi.string().allow("").required(),
|
|
1980
|
+
conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions().required(),
|
|
1981
|
+
sort: Joi.array().items(Joi.string().allow("")).required(),
|
|
2048
1982
|
});
|
|
2049
1983
|
}
|
|
2050
1984
|
|
|
2051
|
-
/** @returns {
|
|
2052
|
-
static
|
|
1985
|
+
/** @returns {FailureResponse} */
|
|
1986
|
+
static FailureResponse() {
|
|
2053
1987
|
return Joi.object({
|
|
2054
|
-
|
|
2055
|
-
|
|
2056
|
-
|
|
1988
|
+
success: Joi.boolean().required(),
|
|
1989
|
+
error: Joi.array()
|
|
1990
|
+
.items(ServiceabilityPlatformModel.ErrorResponse())
|
|
1991
|
+
.required(),
|
|
2057
1992
|
});
|
|
2058
1993
|
}
|
|
2059
1994
|
|
|
2060
|
-
/** @returns {
|
|
2061
|
-
static
|
|
1995
|
+
/** @returns {CourierPartnerRulesListResponse} */
|
|
1996
|
+
static CourierPartnerRulesListResponse() {
|
|
2062
1997
|
return Joi.object({
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
status_code: Joi.number().required(),
|
|
2068
|
-
success: Joi.boolean().required(),
|
|
2069
|
-
updated_pincodes: Joi.array().items(
|
|
2070
|
-
ServiceabilityPlatformModel.PincodeMopUpdateResponse()
|
|
2071
|
-
),
|
|
1998
|
+
items: Joi.array()
|
|
1999
|
+
.items(ServiceabilityPlatformModel.CourierPartnerRule())
|
|
2000
|
+
.required(),
|
|
2001
|
+
page: ServiceabilityPlatformModel.Page().required(),
|
|
2072
2002
|
});
|
|
2073
2003
|
}
|
|
2074
2004
|
|
|
2075
|
-
/** @returns {
|
|
2076
|
-
static
|
|
2005
|
+
/** @returns {CompanyConfig} */
|
|
2006
|
+
static CompanyConfig() {
|
|
2077
2007
|
return Joi.object({
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
size: Joi.number(),
|
|
2082
|
-
type: Joi.string().allow(""),
|
|
2008
|
+
rule_ids: Joi.array().items(Joi.string().allow("")).required(),
|
|
2009
|
+
sort: Joi.array().items(Joi.string().allow("")).required(),
|
|
2010
|
+
logistics_as_actual: Joi.boolean(),
|
|
2083
2011
|
});
|
|
2084
2012
|
}
|
|
2085
2013
|
|
|
2086
|
-
/** @returns {
|
|
2087
|
-
static
|
|
2014
|
+
/** @returns {ZoneConfig} */
|
|
2015
|
+
static ZoneConfig() {
|
|
2088
2016
|
return Joi.object({
|
|
2089
|
-
|
|
2090
|
-
|
|
2017
|
+
serviceability_type: Joi.string().allow(""),
|
|
2018
|
+
});
|
|
2019
|
+
}
|
|
2020
|
+
|
|
2021
|
+
/** @returns {ApplicationConfig} */
|
|
2022
|
+
static ApplicationConfig() {
|
|
2023
|
+
return Joi.object({
|
|
2024
|
+
rule_ids: Joi.array().items(Joi.string().allow("")),
|
|
2025
|
+
sort: Joi.array().items(Joi.string().allow("")),
|
|
2026
|
+
zones: ServiceabilityPlatformModel.ZoneConfig(),
|
|
2091
2027
|
});
|
|
2092
2028
|
}
|
|
2093
2029
|
|
|
2094
|
-
/** @returns {
|
|
2095
|
-
static
|
|
2030
|
+
/** @returns {BulkRegionJobSerializer} */
|
|
2031
|
+
static BulkRegionJobSerializer() {
|
|
2096
2032
|
return Joi.object({
|
|
2097
|
-
|
|
2098
|
-
|
|
2099
|
-
|
|
2100
|
-
|
|
2101
|
-
s3_url: Joi.string().allow(""),
|
|
2102
|
-
success: Joi.boolean(),
|
|
2103
|
-
updated_at: Joi.string().allow(""),
|
|
2104
|
-
updated_by: Joi.string().allow(""),
|
|
2033
|
+
file_path: Joi.string().allow(""),
|
|
2034
|
+
country: Joi.string().allow("").required(),
|
|
2035
|
+
action: Joi.string().allow("").required(),
|
|
2036
|
+
region: Joi.string().allow("").required(),
|
|
2105
2037
|
});
|
|
2106
2038
|
}
|
|
2107
2039
|
|
|
2108
|
-
/** @returns {
|
|
2109
|
-
static
|
|
2040
|
+
/** @returns {BulkRegionResponseItemData} */
|
|
2041
|
+
static BulkRegionResponseItemData() {
|
|
2110
2042
|
return Joi.object({
|
|
2111
|
-
|
|
2112
|
-
|
|
2113
|
-
|
|
2114
|
-
|
|
2115
|
-
|
|
2116
|
-
|
|
2117
|
-
|
|
2043
|
+
file_path: Joi.string().allow("").required(),
|
|
2044
|
+
failed: Joi.number(),
|
|
2045
|
+
failed_records: Joi.array().items(Joi.any()),
|
|
2046
|
+
action: Joi.string().allow("").required(),
|
|
2047
|
+
batch_id: Joi.string().allow("").required(),
|
|
2048
|
+
country: Joi.string().allow("").required(),
|
|
2049
|
+
success: Joi.number(),
|
|
2050
|
+
region: Joi.string().allow("").required(),
|
|
2051
|
+
status: Joi.string().allow("").required(),
|
|
2052
|
+
total: Joi.number(),
|
|
2053
|
+
error_file_path: Joi.string().allow(""),
|
|
2118
2054
|
});
|
|
2119
2055
|
}
|
|
2120
2056
|
|
|
2121
|
-
/** @returns {
|
|
2122
|
-
static
|
|
2057
|
+
/** @returns {BulkRegionResponse} */
|
|
2058
|
+
static BulkRegionResponse() {
|
|
2123
2059
|
return Joi.object({
|
|
2124
|
-
|
|
2125
|
-
|
|
2126
|
-
|
|
2127
|
-
|
|
2060
|
+
items: Joi.array()
|
|
2061
|
+
.items(ServiceabilityPlatformModel.BulkRegionResponseItemData())
|
|
2062
|
+
.required(),
|
|
2063
|
+
page: ServiceabilityPlatformModel.Page().required(),
|
|
2128
2064
|
});
|
|
2129
2065
|
}
|
|
2130
2066
|
|
|
2131
|
-
/** @returns {
|
|
2132
|
-
static
|
|
2067
|
+
/** @returns {SelfShipResponse} */
|
|
2068
|
+
static SelfShipResponse() {
|
|
2133
2069
|
return Joi.object({
|
|
2134
|
-
|
|
2070
|
+
is_active: Joi.boolean().required(),
|
|
2071
|
+
tat: Joi.number().required(),
|
|
2135
2072
|
});
|
|
2136
2073
|
}
|
|
2137
2074
|
|
|
2138
|
-
/** @returns {
|
|
2139
|
-
static
|
|
2075
|
+
/** @returns {ApplicationSelfShipConfig} */
|
|
2076
|
+
static ApplicationSelfShipConfig() {
|
|
2140
2077
|
return Joi.object({
|
|
2141
|
-
|
|
2142
|
-
configuration: Joi.any().required(),
|
|
2143
|
-
identifier: Joi.string().allow("").required(),
|
|
2144
|
-
ignored_locations: Joi.array().items(Joi.string().allow("")).required(),
|
|
2145
|
-
to_pincode: Joi.string().allow("").required(),
|
|
2078
|
+
self_ship: Joi.any().allow(null),
|
|
2146
2079
|
});
|
|
2147
2080
|
}
|
|
2148
2081
|
|
|
2149
|
-
/** @returns {
|
|
2150
|
-
static
|
|
2082
|
+
/** @returns {ApplicationSelfShipConfigResponse} */
|
|
2083
|
+
static ApplicationSelfShipConfigResponse() {
|
|
2151
2084
|
return Joi.object({
|
|
2152
|
-
|
|
2153
|
-
|
|
2085
|
+
error: ServiceabilityPlatformModel.ServiceabilityErrorResponse(),
|
|
2086
|
+
data: ServiceabilityPlatformModel.ApplicationSelfShipConfig(),
|
|
2154
2087
|
success: Joi.boolean().required(),
|
|
2155
|
-
to_pincode: Joi.string().allow("").required(),
|
|
2156
2088
|
});
|
|
2157
2089
|
}
|
|
2158
2090
|
|
|
2159
|
-
/** @returns {
|
|
2160
|
-
static
|
|
2091
|
+
/** @returns {StoreRuleConfigData} */
|
|
2092
|
+
static StoreRuleConfigData() {
|
|
2161
2093
|
return Joi.object({
|
|
2162
|
-
|
|
2163
|
-
|
|
2094
|
+
rule_ids: Joi.array().items(Joi.string().allow("")),
|
|
2095
|
+
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2096
|
+
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2097
|
+
store_priority: Joi.array().items(
|
|
2098
|
+
ServiceabilityPlatformModel.StorePrioritySchema()
|
|
2099
|
+
),
|
|
2100
|
+
sort: Joi.array().items(Joi.string().allow("")),
|
|
2164
2101
|
});
|
|
2165
2102
|
}
|
|
2166
2103
|
|
|
2167
|
-
/** @returns {
|
|
2168
|
-
static
|
|
2104
|
+
/** @returns {CustomerRadiusSchema} */
|
|
2105
|
+
static CustomerRadiusSchema() {
|
|
2169
2106
|
return Joi.object({
|
|
2170
|
-
|
|
2107
|
+
unit: Joi.string().allow("").required(),
|
|
2108
|
+
lt: Joi.number(),
|
|
2109
|
+
lte: Joi.number(),
|
|
2110
|
+
gt: Joi.number(),
|
|
2111
|
+
gte: Joi.number(),
|
|
2171
2112
|
});
|
|
2172
2113
|
}
|
|
2173
2114
|
|
|
2174
|
-
/** @returns {
|
|
2175
|
-
static
|
|
2115
|
+
/** @returns {StoreRuleConditionSchema} */
|
|
2116
|
+
static StoreRuleConditionSchema() {
|
|
2176
2117
|
return Joi.object({
|
|
2177
|
-
|
|
2178
|
-
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2118
|
+
department_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
2119
|
+
category_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
2120
|
+
brand_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
2121
|
+
to_location: ServiceabilityPlatformModel.LocationRule(),
|
|
2122
|
+
customer_radius: ServiceabilityPlatformModel.CustomerRadiusSchema(),
|
|
2123
|
+
store_type: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
2124
|
+
product_tags: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
2125
|
+
product_ids: ServiceabilityPlatformModel.IntComparisonOperations(),
|
|
2126
|
+
store_tags: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
2127
|
+
order_place_date: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
2128
|
+
zone_ids: ServiceabilityPlatformModel.StringComparisonOperations(),
|
|
2182
2129
|
});
|
|
2183
2130
|
}
|
|
2184
2131
|
|
|
2185
|
-
/** @returns {
|
|
2186
|
-
static
|
|
2132
|
+
/** @returns {StoreRuleDataSchema} */
|
|
2133
|
+
static StoreRuleDataSchema() {
|
|
2187
2134
|
return Joi.object({
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2194
|
-
|
|
2135
|
+
id: Joi.string().allow(""),
|
|
2136
|
+
name: Joi.string().allow(""),
|
|
2137
|
+
company_id: Joi.number(),
|
|
2138
|
+
application_id: Joi.string().allow(""),
|
|
2139
|
+
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2140
|
+
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2141
|
+
store_priority: Joi.array().items(
|
|
2142
|
+
ServiceabilityPlatformModel.StorePrioritySchema()
|
|
2143
|
+
),
|
|
2144
|
+
sort: Joi.array().items(Joi.string().allow("")),
|
|
2145
|
+
conditions: ServiceabilityPlatformModel.StoreRuleConditionSchema(),
|
|
2146
|
+
is_active: Joi.boolean(),
|
|
2195
2147
|
});
|
|
2196
2148
|
}
|
|
2197
2149
|
|
|
2198
|
-
/** @returns {
|
|
2199
|
-
static
|
|
2150
|
+
/** @returns {StorePrioritySchema} */
|
|
2151
|
+
static StorePrioritySchema() {
|
|
2200
2152
|
return Joi.object({
|
|
2201
|
-
|
|
2202
|
-
|
|
2153
|
+
id: Joi.string().allow(""),
|
|
2154
|
+
name: Joi.string().allow(""),
|
|
2203
2155
|
});
|
|
2204
2156
|
}
|
|
2205
2157
|
|
|
2206
|
-
/** @returns {
|
|
2207
|
-
static
|
|
2158
|
+
/** @returns {GetStoreRulesApiResponse} */
|
|
2159
|
+
static GetStoreRulesApiResponse() {
|
|
2208
2160
|
return Joi.object({
|
|
2209
|
-
|
|
2210
|
-
|
|
2211
|
-
|
|
2161
|
+
items: Joi.array().items(
|
|
2162
|
+
ServiceabilityPlatformModel.StoreRuleDataSchema()
|
|
2163
|
+
),
|
|
2164
|
+
page: ServiceabilityPlatformModel.Page(),
|
|
2212
2165
|
});
|
|
2213
2166
|
}
|
|
2214
2167
|
|
|
2215
|
-
/** @returns {
|
|
2216
|
-
static
|
|
2168
|
+
/** @returns {CreateStoreRuleRequestSchema} */
|
|
2169
|
+
static CreateStoreRuleRequestSchema() {
|
|
2217
2170
|
return Joi.object({
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
|
|
2222
|
-
|
|
2223
|
-
|
|
2224
|
-
|
|
2225
|
-
|
|
2171
|
+
name: Joi.string().allow(""),
|
|
2172
|
+
is_active: Joi.boolean(),
|
|
2173
|
+
conditions: ServiceabilityPlatformModel.StoreRuleConditionSchema(),
|
|
2174
|
+
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2175
|
+
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2176
|
+
store_priority: Joi.array().items(
|
|
2177
|
+
ServiceabilityPlatformModel.StorePrioritySchema()
|
|
2178
|
+
),
|
|
2179
|
+
sort: Joi.array().items(Joi.string().allow("")),
|
|
2226
2180
|
});
|
|
2227
2181
|
}
|
|
2228
2182
|
|
|
2229
|
-
/** @returns {
|
|
2230
|
-
static
|
|
2183
|
+
/** @returns {StoreRuleResponseSchema} */
|
|
2184
|
+
static StoreRuleResponseSchema() {
|
|
2231
2185
|
return Joi.object({
|
|
2232
|
-
|
|
2233
|
-
|
|
2234
|
-
item_total: Joi.number(),
|
|
2235
|
-
size: Joi.number(),
|
|
2186
|
+
id: Joi.string().allow(""),
|
|
2187
|
+
name: Joi.string().allow(""),
|
|
2236
2188
|
type: Joi.string().allow(""),
|
|
2189
|
+
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2190
|
+
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2191
|
+
store_priority: Joi.array().items(
|
|
2192
|
+
ServiceabilityPlatformModel.StorePrioritySchema()
|
|
2193
|
+
),
|
|
2194
|
+
sort: Joi.array().items(Joi.string().allow("")),
|
|
2195
|
+
conditions: ServiceabilityPlatformModel.StoreRuleConditionSchema(),
|
|
2196
|
+
is_active: Joi.boolean(),
|
|
2237
2197
|
});
|
|
2238
2198
|
}
|
|
2239
2199
|
|
|
2240
|
-
/** @returns {
|
|
2241
|
-
static
|
|
2200
|
+
/** @returns {StoreRuleUpdateResponseSchema} */
|
|
2201
|
+
static StoreRuleUpdateResponseSchema() {
|
|
2242
2202
|
return Joi.object({
|
|
2243
2203
|
id: Joi.string().allow(""),
|
|
2244
2204
|
name: Joi.string().allow(""),
|
|
2205
|
+
type: Joi.string().allow(""),
|
|
2206
|
+
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2207
|
+
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2208
|
+
store_priority: Joi.array().items(
|
|
2209
|
+
ServiceabilityPlatformModel.StorePrioritySchema()
|
|
2210
|
+
),
|
|
2211
|
+
sort: Joi.array().items(Joi.string().allow("")),
|
|
2212
|
+
conditions: ServiceabilityPlatformModel.StoreRuleConditionSchema(),
|
|
2213
|
+
is_active: Joi.boolean(),
|
|
2214
|
+
company_id: Joi.number(),
|
|
2215
|
+
application_id: Joi.string().allow(""),
|
|
2245
2216
|
});
|
|
2246
2217
|
}
|
|
2247
2218
|
|
|
2248
|
-
/** @returns {
|
|
2249
|
-
static
|
|
2219
|
+
/** @returns {ServiceabilityModel} */
|
|
2220
|
+
static ServiceabilityModel() {
|
|
2250
2221
|
return Joi.object({
|
|
2251
|
-
|
|
2252
|
-
|
|
2253
|
-
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2222
|
+
lm_cod_limit: Joi.number().required(),
|
|
2223
|
+
is_qc: Joi.boolean().required(),
|
|
2224
|
+
pickup_cutoff: Joi.string().allow("").allow(null).required(),
|
|
2225
|
+
route_code: Joi.string().allow("").allow(null).required(),
|
|
2226
|
+
is_first_mile: Joi.boolean().required(),
|
|
2227
|
+
is_return: Joi.boolean().required(),
|
|
2228
|
+
is_installation: Joi.boolean().required(),
|
|
2229
|
+
is_last_mile: Joi.boolean().required(),
|
|
2230
|
+
});
|
|
2231
|
+
}
|
|
2232
|
+
|
|
2233
|
+
/** @returns {CourierPartnerSchemeFeatures} */
|
|
2234
|
+
static CourierPartnerSchemeFeatures() {
|
|
2235
|
+
return Joi.object({
|
|
2236
|
+
doorstep_qc: Joi.boolean(),
|
|
2237
|
+
qr: Joi.boolean(),
|
|
2238
|
+
mps: Joi.boolean(),
|
|
2239
|
+
ndr: Joi.boolean(),
|
|
2240
|
+
ndr_attempts: Joi.number(),
|
|
2241
|
+
dangerous_goods: Joi.boolean(),
|
|
2242
|
+
fragile_goods: Joi.boolean(),
|
|
2243
|
+
restricted_goods: Joi.boolean(),
|
|
2244
|
+
cold_storage_goods: Joi.boolean(),
|
|
2245
|
+
doorstep_exchange: Joi.boolean(),
|
|
2246
|
+
doorstep_return: Joi.boolean(),
|
|
2247
|
+
product_installation: Joi.boolean(),
|
|
2248
|
+
openbox_delivery: Joi.boolean(),
|
|
2249
|
+
status_updates: Joi.string().allow(""),
|
|
2250
|
+
multi_pick_single_drop: Joi.boolean(),
|
|
2251
|
+
single_pick_multi_drop: Joi.boolean(),
|
|
2252
|
+
multi_pick_multi_drop: Joi.boolean(),
|
|
2253
|
+
ewaybill: Joi.boolean(),
|
|
2262
2254
|
});
|
|
2263
2255
|
}
|
|
2264
2256
|
|
|
2265
|
-
/** @returns {
|
|
2266
|
-
static
|
|
2257
|
+
/** @returns {CourierPartnerSchemeModel} */
|
|
2258
|
+
static CourierPartnerSchemeModel() {
|
|
2267
2259
|
return Joi.object({
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
),
|
|
2273
|
-
|
|
2274
|
-
|
|
2260
|
+
extension_id: Joi.string().allow("").required(),
|
|
2261
|
+
scheme_id: Joi.string().allow("").required(),
|
|
2262
|
+
weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
|
|
2263
|
+
transport_type: Joi.string().allow("").required(),
|
|
2264
|
+
region: Joi.string().allow("").required(),
|
|
2265
|
+
delivery_type: Joi.string().allow("").required(),
|
|
2266
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
2267
|
+
stage: Joi.string().allow("").required(),
|
|
2268
|
+
feature: ServiceabilityPlatformModel.CourierPartnerSchemeFeatures().required(),
|
|
2275
2269
|
});
|
|
2276
2270
|
}
|
|
2277
2271
|
|
|
2278
|
-
/** @returns {
|
|
2279
|
-
static
|
|
2272
|
+
/** @returns {CourierAccountResponse} */
|
|
2273
|
+
static CourierAccountResponse() {
|
|
2280
2274
|
return Joi.object({
|
|
2281
|
-
|
|
2282
|
-
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
sort: Joi.array().items(Joi.string().allow("")),
|
|
2288
|
-
store_priority: Joi.array().items(
|
|
2289
|
-
ServiceabilityPlatformModel.StorePrioritySchema()
|
|
2290
|
-
),
|
|
2291
|
-
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2292
|
-
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2275
|
+
account_id: Joi.string().allow("").required(),
|
|
2276
|
+
scheme_id: Joi.string().allow("").required(),
|
|
2277
|
+
is_self_ship: Joi.boolean().required(),
|
|
2278
|
+
stage: Joi.string().allow("").required(),
|
|
2279
|
+
is_own_account: Joi.boolean().required(),
|
|
2280
|
+
scheme_rules: ServiceabilityPlatformModel.CourierPartnerSchemeModel().required(),
|
|
2293
2281
|
});
|
|
2294
2282
|
}
|
|
2295
2283
|
|
|
2296
|
-
/** @returns {
|
|
2297
|
-
static
|
|
2284
|
+
/** @returns {CompanyCourierPartnerAccountListResponse} */
|
|
2285
|
+
static CompanyCourierPartnerAccountListResponse() {
|
|
2298
2286
|
return Joi.object({
|
|
2299
|
-
|
|
2300
|
-
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
sort: Joi.array().items(Joi.string().allow("")),
|
|
2304
|
-
store_priority: Joi.array().items(
|
|
2305
|
-
ServiceabilityPlatformModel.StorePrioritySchema()
|
|
2306
|
-
),
|
|
2307
|
-
tag_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2308
|
-
type: Joi.string().allow(""),
|
|
2309
|
-
type_based_priority: Joi.array().items(Joi.string().allow("")),
|
|
2287
|
+
items: Joi.array()
|
|
2288
|
+
.items(ServiceabilityPlatformModel.CourierAccountResponse())
|
|
2289
|
+
.required(),
|
|
2290
|
+
page: ServiceabilityPlatformModel.Page().required(),
|
|
2310
2291
|
});
|
|
2311
2292
|
}
|
|
2312
2293
|
|
|
2313
|
-
/** @returns {
|
|
2314
|
-
static
|
|
2294
|
+
/** @returns {PackageMaterial} */
|
|
2295
|
+
static PackageMaterial() {
|
|
2315
2296
|
return Joi.object({
|
|
2316
|
-
|
|
2317
|
-
|
|
2318
|
-
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
sort: Joi.array().items(Joi.string().allow("")),
|
|
2323
|
-
store_priority: Joi.array().items(
|
|
2324
|
-
ServiceabilityPlatformModel.StorePrioritySchema()
|
|
2297
|
+
name: Joi.string().allow("").required(),
|
|
2298
|
+
width: Joi.number().required(),
|
|
2299
|
+
height: Joi.number().required(),
|
|
2300
|
+
length: Joi.number().required(),
|
|
2301
|
+
rules: Joi.array().items(
|
|
2302
|
+
ServiceabilityPlatformModel.PackageMaterialRule()
|
|
2325
2303
|
),
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
|
|
2304
|
+
store_ids: Joi.array().items(Joi.number()).required(),
|
|
2305
|
+
weight: Joi.number().required(),
|
|
2306
|
+
error_rate: Joi.number().required(),
|
|
2307
|
+
package_type: Joi.string().allow("").required(),
|
|
2308
|
+
size: Joi.string().allow("").required(),
|
|
2309
|
+
media: Joi.array().items(Joi.string().allow("")),
|
|
2310
|
+
channels: Joi.array()
|
|
2311
|
+
.items(ServiceabilityPlatformModel.Channel())
|
|
2312
|
+
.required(),
|
|
2313
|
+
track_inventory: Joi.boolean(),
|
|
2314
|
+
status: Joi.string().allow("").required(),
|
|
2315
|
+
max_weight: Joi.number(),
|
|
2316
|
+
package_vol_weight: Joi.number(),
|
|
2317
|
+
auto_calculate: Joi.boolean(),
|
|
2329
2318
|
});
|
|
2330
2319
|
}
|
|
2331
2320
|
|
|
2332
|
-
/** @returns {
|
|
2333
|
-
static
|
|
2321
|
+
/** @returns {PackageMaterialResponse} */
|
|
2322
|
+
static PackageMaterialResponse() {
|
|
2334
2323
|
return Joi.object({
|
|
2335
|
-
|
|
2324
|
+
name: Joi.string().allow("").required(),
|
|
2325
|
+
id: Joi.string().allow(""),
|
|
2326
|
+
item_id: Joi.number(),
|
|
2327
|
+
width: Joi.number().required(),
|
|
2328
|
+
height: Joi.number().required(),
|
|
2329
|
+
length: Joi.number().required(),
|
|
2330
|
+
rules: Joi.array().items(
|
|
2331
|
+
ServiceabilityPlatformModel.PackageMaterialRule()
|
|
2332
|
+
),
|
|
2333
|
+
store_ids: Joi.array().items(Joi.number()).required(),
|
|
2334
|
+
weight: Joi.number().required(),
|
|
2335
|
+
error_rate: Joi.number().required(),
|
|
2336
|
+
package_type: Joi.string().allow("").required(),
|
|
2337
|
+
size: Joi.string().allow("").required(),
|
|
2338
|
+
media: Joi.array().items(Joi.string().allow("")),
|
|
2339
|
+
channels: Joi.array()
|
|
2340
|
+
.items(ServiceabilityPlatformModel.Channel())
|
|
2341
|
+
.required(),
|
|
2342
|
+
track_inventory: Joi.boolean(),
|
|
2343
|
+
status: Joi.string().allow("").required(),
|
|
2344
|
+
max_weight: Joi.number(),
|
|
2345
|
+
package_vol_weight: Joi.number(),
|
|
2346
|
+
auto_calculate: Joi.boolean(),
|
|
2336
2347
|
});
|
|
2337
2348
|
}
|
|
2338
2349
|
|
|
2339
|
-
/** @returns {
|
|
2340
|
-
static
|
|
2350
|
+
/** @returns {PackageMaterialRule} */
|
|
2351
|
+
static PackageMaterialRule() {
|
|
2341
2352
|
return Joi.object({
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
2345
|
-
weekday: Joi.string().allow(""),
|
|
2353
|
+
rule_id: Joi.string().allow(""),
|
|
2354
|
+
quantity: ServiceabilityPlatformModel.PackageMaterialRuleQuantity(),
|
|
2355
|
+
weight: Joi.number(),
|
|
2346
2356
|
});
|
|
2347
2357
|
}
|
|
2348
2358
|
|
|
2349
|
-
/** @returns {
|
|
2350
|
-
static
|
|
2359
|
+
/** @returns {PackageRule} */
|
|
2360
|
+
static PackageRule() {
|
|
2351
2361
|
return Joi.object({
|
|
2352
|
-
|
|
2362
|
+
name: Joi.string().allow("").required(),
|
|
2363
|
+
company_id: Joi.number().required(),
|
|
2364
|
+
type: Joi.string().allow("").required(),
|
|
2365
|
+
is_active: Joi.boolean(),
|
|
2366
|
+
product_tag: ServiceabilityPlatformModel.PackageRuleProductTag(),
|
|
2367
|
+
product_id: ServiceabilityPlatformModel.PackageRuleProduct(),
|
|
2368
|
+
category_id: ServiceabilityPlatformModel.PackageRuleCategory(),
|
|
2353
2369
|
});
|
|
2354
2370
|
}
|
|
2355
2371
|
|
|
2356
|
-
/** @returns {
|
|
2357
|
-
static
|
|
2372
|
+
/** @returns {PackageRuleResponse} */
|
|
2373
|
+
static PackageRuleResponse() {
|
|
2358
2374
|
return Joi.object({
|
|
2359
|
-
|
|
2360
|
-
channels: Joi.array()
|
|
2361
|
-
.items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
|
|
2362
|
-
.required(),
|
|
2363
|
-
company_id: Joi.number().required(),
|
|
2364
|
-
is_active: Joi.boolean().required(),
|
|
2365
|
-
mapping: Joi.array()
|
|
2366
|
-
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
2367
|
-
.required(),
|
|
2375
|
+
id: Joi.string().allow(""),
|
|
2368
2376
|
name: Joi.string().allow("").required(),
|
|
2369
|
-
|
|
2370
|
-
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2377
|
+
company_id: Joi.number().required(),
|
|
2378
|
+
type: Joi.string().allow("").required(),
|
|
2379
|
+
is_active: Joi.boolean(),
|
|
2380
|
+
product_tag: ServiceabilityPlatformModel.PackageRuleProductTag(),
|
|
2381
|
+
product_id: ServiceabilityPlatformModel.PackageRuleProduct(),
|
|
2382
|
+
category_id: ServiceabilityPlatformModel.PackageRuleCategory(),
|
|
2374
2383
|
});
|
|
2375
2384
|
}
|
|
2376
2385
|
|
|
2377
|
-
/** @returns {
|
|
2378
|
-
static
|
|
2386
|
+
/** @returns {Channel} */
|
|
2387
|
+
static Channel() {
|
|
2379
2388
|
return Joi.object({
|
|
2380
|
-
|
|
2389
|
+
type: Joi.string().allow(""),
|
|
2390
|
+
id: Joi.string().allow(""),
|
|
2381
2391
|
});
|
|
2382
2392
|
}
|
|
2383
2393
|
|
|
2384
|
-
/** @returns {
|
|
2385
|
-
static
|
|
2394
|
+
/** @returns {PackageMaterialRuleList} */
|
|
2395
|
+
static PackageMaterialRuleList() {
|
|
2386
2396
|
return Joi.object({
|
|
2387
|
-
|
|
2388
|
-
|
|
2389
|
-
name: Joi.string().allow("").required(),
|
|
2390
|
-
slug: Joi.string().allow("").required(),
|
|
2391
|
-
store_ids: Joi.array().items(Joi.number()).required(),
|
|
2392
|
-
tags: Joi.array().items(Joi.string().allow("")).required(),
|
|
2393
|
-
type: Joi.string().allow("").required(),
|
|
2394
|
-
zone_id: Joi.string().allow("").required(),
|
|
2397
|
+
items: ServiceabilityPlatformModel.PackageRuleResponse(),
|
|
2398
|
+
page: ServiceabilityPlatformModel.Page(),
|
|
2395
2399
|
});
|
|
2396
2400
|
}
|
|
2397
2401
|
|
|
2398
|
-
/** @returns {
|
|
2399
|
-
static
|
|
2402
|
+
/** @returns {PackageMaterialList} */
|
|
2403
|
+
static PackageMaterialList() {
|
|
2400
2404
|
return Joi.object({
|
|
2401
|
-
|
|
2405
|
+
items: ServiceabilityPlatformModel.PackageMaterialResponse(),
|
|
2406
|
+
page: ServiceabilityPlatformModel.Page(),
|
|
2402
2407
|
});
|
|
2403
2408
|
}
|
|
2404
2409
|
|
|
2405
|
-
/** @returns {
|
|
2406
|
-
static
|
|
2410
|
+
/** @returns {PackageRuleProduct} */
|
|
2411
|
+
static PackageRuleProduct() {
|
|
2407
2412
|
return Joi.object({
|
|
2408
|
-
|
|
2409
|
-
has_next: Joi.boolean().required(),
|
|
2410
|
-
item_total: Joi.number().required(),
|
|
2411
|
-
size: Joi.number().required(),
|
|
2412
|
-
type: Joi.string().allow("").required(),
|
|
2413
|
+
includes: Joi.array().items(Joi.number()),
|
|
2413
2414
|
});
|
|
2414
2415
|
}
|
|
2415
2416
|
|
|
2416
|
-
/** @returns {
|
|
2417
|
-
static
|
|
2417
|
+
/** @returns {PackageRuleProductTag} */
|
|
2418
|
+
static PackageRuleProductTag() {
|
|
2418
2419
|
return Joi.object({
|
|
2419
|
-
|
|
2420
|
-
pincode: Joi.array().items(Joi.string().allow("")),
|
|
2421
|
-
state: Joi.array().items(Joi.string().allow("")),
|
|
2420
|
+
includes: Joi.array().items(Joi.string().allow("")),
|
|
2422
2421
|
});
|
|
2423
2422
|
}
|
|
2424
2423
|
|
|
2425
|
-
/** @returns {
|
|
2426
|
-
static
|
|
2424
|
+
/** @returns {PackageRuleCategory} */
|
|
2425
|
+
static PackageRuleCategory() {
|
|
2427
2426
|
return Joi.object({
|
|
2428
|
-
|
|
2429
|
-
type: Joi.string().allow("").required(),
|
|
2427
|
+
includes: Joi.array().items(Joi.number()),
|
|
2430
2428
|
});
|
|
2431
2429
|
}
|
|
2432
2430
|
|
|
2433
|
-
/** @returns {
|
|
2434
|
-
static
|
|
2431
|
+
/** @returns {PackageMaterialRuleQuantity} */
|
|
2432
|
+
static PackageMaterialRuleQuantity() {
|
|
2435
2433
|
return Joi.object({
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
zone_id: Joi.string().allow("").required(),
|
|
2434
|
+
min: Joi.number(),
|
|
2435
|
+
max: Joi.number(),
|
|
2439
2436
|
});
|
|
2440
2437
|
}
|
|
2441
2438
|
|
|
2442
|
-
/** @returns {
|
|
2443
|
-
static
|
|
2439
|
+
/** @returns {RulePriorityRequest} */
|
|
2440
|
+
static RulePriorityRequest() {
|
|
2444
2441
|
return Joi.object({
|
|
2445
|
-
|
|
2446
|
-
|
|
2442
|
+
rule_id: Joi.string().allow("").required(),
|
|
2443
|
+
priority: Joi.number().required(),
|
|
2447
2444
|
});
|
|
2448
2445
|
}
|
|
2449
2446
|
|
|
2450
|
-
/** @returns {
|
|
2451
|
-
static
|
|
2447
|
+
/** @returns {RulePriorityResponse} */
|
|
2448
|
+
static RulePriorityResponse() {
|
|
2452
2449
|
return Joi.object({
|
|
2453
|
-
|
|
2454
|
-
identifier: Joi.string().allow("").required(),
|
|
2450
|
+
success: Joi.boolean(),
|
|
2455
2451
|
});
|
|
2456
2452
|
}
|
|
2457
2453
|
}
|