@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -1,41 +1,44 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
5
|
-
* @property {string}
|
|
6
|
-
* @property {string} region - Name of the region for which the
|
|
7
|
-
* tat/serviceability file needs to be downloaded.
|
|
8
|
-
* @property {string} type - Denotes the type of file.
|
|
4
|
+
* @typedef ErrorResponseV1
|
|
5
|
+
* @property {string} [error]
|
|
9
6
|
*/
|
|
10
7
|
|
|
11
8
|
/**
|
|
12
|
-
* @typedef
|
|
13
|
-
* @property {string}
|
|
14
|
-
* @property {string}
|
|
15
|
-
*
|
|
16
|
-
* @property {string} [type] - Denotes the type of data.
|
|
17
|
-
* @property {string} [batch_id] - Unique identifier identifying the perticular request.
|
|
18
|
-
* @property {string} [status] - Current status of the request.
|
|
19
|
-
* @property {Object[]} [failed_records] - Information of records which failed
|
|
20
|
-
* @property {string} [file_path] - CDN path of the file.
|
|
9
|
+
* @typedef BulkRegionServiceabilityTatRequest
|
|
10
|
+
* @property {string} country
|
|
11
|
+
* @property {string} region
|
|
12
|
+
* @property {string} type
|
|
21
13
|
*/
|
|
22
14
|
|
|
23
15
|
/**
|
|
24
|
-
* @typedef
|
|
25
|
-
* @property {string}
|
|
26
|
-
* @property {string}
|
|
27
|
-
* @property {string} type
|
|
16
|
+
* @typedef BulkRegionServiceabilityTatResponseItemData
|
|
17
|
+
* @property {string} [country]
|
|
18
|
+
* @property {string} [region]
|
|
19
|
+
* @property {string} [type]
|
|
20
|
+
* @property {string} [batch_id]
|
|
21
|
+
* @property {string} [status]
|
|
22
|
+
* @property {Object[]} [failed_records]
|
|
23
|
+
* @property {string} [file_path]
|
|
28
24
|
*/
|
|
29
25
|
|
|
30
26
|
/**
|
|
31
|
-
* @typedef
|
|
32
|
-
* @property {
|
|
33
|
-
* @property {
|
|
27
|
+
* @typedef ErrorResponse
|
|
28
|
+
* @property {string} value
|
|
29
|
+
* @property {string} message
|
|
30
|
+
* @property {string} type
|
|
34
31
|
*/
|
|
35
32
|
|
|
36
33
|
/**
|
|
37
|
-
* @typedef
|
|
38
|
-
* @property {
|
|
34
|
+
* @typedef FailureResponse
|
|
35
|
+
* @property {boolean} success
|
|
36
|
+
* @property {ErrorResponse[]} error
|
|
37
|
+
*/
|
|
38
|
+
|
|
39
|
+
/**
|
|
40
|
+
* @typedef BulkRegionServiceabilityTatResponse
|
|
41
|
+
* @property {BulkRegionServiceabilityTatResponseItemData[]} [items]
|
|
39
42
|
* @property {Page} [page]
|
|
40
43
|
*/
|
|
41
44
|
|
|
@@ -48,464 +51,121 @@ const Joi = require("joi");
|
|
|
48
51
|
* @property {number} [current] - The current page number.
|
|
49
52
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
50
53
|
* @property {number} [size] - The number of items per page.
|
|
54
|
+
* @property {number} [total] - Total number of items.
|
|
51
55
|
*/
|
|
52
56
|
|
|
53
57
|
/**
|
|
54
|
-
* @typedef
|
|
55
|
-
* @property {string}
|
|
56
|
-
* @property {string}
|
|
57
|
-
* @property {
|
|
58
|
-
* @property {string}
|
|
59
|
-
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
60
|
-
* account or not.
|
|
58
|
+
* @typedef BulkRegionJobSerializer
|
|
59
|
+
* @property {string} [file_path]
|
|
60
|
+
* @property {string} country
|
|
61
|
+
* @property {string} action
|
|
62
|
+
* @property {string} region
|
|
61
63
|
*/
|
|
62
64
|
|
|
63
65
|
/**
|
|
64
|
-
* @typedef
|
|
65
|
-
* @property {
|
|
66
|
-
* @property {
|
|
66
|
+
* @typedef BulkRegionResponseItemData
|
|
67
|
+
* @property {string} file_path
|
|
68
|
+
* @property {number} [failed]
|
|
69
|
+
* @property {Object[]} [failed_records]
|
|
70
|
+
* @property {string} action
|
|
71
|
+
* @property {string} batch_id
|
|
72
|
+
* @property {string} country
|
|
73
|
+
* @property {number} [success]
|
|
74
|
+
* @property {string} region
|
|
75
|
+
* @property {string} status
|
|
76
|
+
* @property {number} [total]
|
|
77
|
+
* @property {string} [error_file_path]
|
|
67
78
|
*/
|
|
68
79
|
|
|
69
80
|
/**
|
|
70
|
-
* @typedef
|
|
71
|
-
* @property {
|
|
72
|
-
* @property {Page} page
|
|
73
|
-
*/
|
|
74
|
-
|
|
75
|
-
/**
|
|
76
|
-
* @typedef ServiceabilityDetailsResult
|
|
77
|
-
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
78
|
-
* first-mile service is available or not.
|
|
79
|
-
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
80
|
-
* service is available or not.
|
|
81
|
-
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
82
|
-
* region is first-mile serviceable or not in return pickup.
|
|
83
|
-
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
84
|
-
* (COD) payments allowed in the specified region.
|
|
85
|
-
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
86
|
-
* is available. This refers to the ability to return items directly from the
|
|
87
|
-
* customer's doorstep.
|
|
88
|
-
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
89
|
-
* service is available. This refers to the ability to perform quality checks
|
|
90
|
-
* on items at the customer's doorstep.
|
|
91
|
-
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
92
|
-
* scheduled to be processed on the same day.
|
|
93
|
-
* @property {boolean} [installation] - Boolean value indicating whether
|
|
94
|
-
* installation services are available in the specified region or not.
|
|
95
|
-
* @property {string} [id] - Unique identifier for the serviceability record.
|
|
96
|
-
*/
|
|
97
|
-
|
|
98
|
-
/**
|
|
99
|
-
* @typedef ServiceabilityDetails
|
|
100
|
-
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
101
|
-
* first-mile service is available or not.
|
|
102
|
-
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
103
|
-
* service is available or not.
|
|
104
|
-
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
105
|
-
* region is first-mile serviceable or not in return pickup.
|
|
106
|
-
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
107
|
-
* (COD) payments allowed in the specified region.
|
|
108
|
-
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
109
|
-
* is available. This refers to the ability to return items directly from the
|
|
110
|
-
* customer's doorstep.
|
|
111
|
-
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
112
|
-
* service is available. This refers to the ability to perform quality checks
|
|
113
|
-
* on items at the customer's doorstep.
|
|
114
|
-
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
115
|
-
* scheduled to be processed on the same day.
|
|
116
|
-
* @property {boolean} [installation] - Boolean value indicating whether
|
|
117
|
-
* installation services are available in the specified region or not.
|
|
118
|
-
*/
|
|
119
|
-
|
|
120
|
-
/**
|
|
121
|
-
* @typedef RegionServiceabilityResult
|
|
122
|
-
* @property {string} country_code - ISO2 code representing the country where
|
|
123
|
-
* the serviceability is being specified.
|
|
124
|
-
* @property {string} [state_code] - Code representing the state or province
|
|
125
|
-
* within the country where the serviceability is being specified.
|
|
126
|
-
* @property {string} [city_code] - Code representing the city within the state
|
|
127
|
-
* where the serviceability is being specified.
|
|
128
|
-
* @property {string} [sector_code] - Code representing a specific sector or
|
|
129
|
-
* district within the city where the serviceability is being specified.
|
|
130
|
-
* @property {string} [pincode] - Postal or ZIP code for the specific area
|
|
131
|
-
* within the city where the serviceability is being specified.
|
|
132
|
-
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
133
|
-
* first-mile service is available or not.
|
|
134
|
-
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
135
|
-
* service is available or not.
|
|
136
|
-
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
137
|
-
* region is first-mile serviceable or not in return pickup.
|
|
138
|
-
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
139
|
-
* (COD) payments allowed in the specified region.
|
|
140
|
-
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
141
|
-
* is available. This refers to the ability to return items directly from the
|
|
142
|
-
* customer's doorstep.
|
|
143
|
-
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
144
|
-
* service is available. This refers to the ability to perform quality checks
|
|
145
|
-
* on items at the customer's doorstep.
|
|
146
|
-
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
147
|
-
* scheduled to be processed on the same day.
|
|
148
|
-
* @property {boolean} [installation] - Boolean value indicating whether
|
|
149
|
-
* installation services are available in the specified region or not.
|
|
150
|
-
* @property {string} id - Unique identifier for the serviceability record.
|
|
151
|
-
*/
|
|
152
|
-
|
|
153
|
-
/**
|
|
154
|
-
* @typedef RegionServiceabilityDetails
|
|
155
|
-
* @property {string} country_code - ISO2 code representing the country where
|
|
156
|
-
* the serviceability is being specified.
|
|
157
|
-
* @property {string} [state_code] - Code representing the state or province
|
|
158
|
-
* within the country where the serviceability is being specified.
|
|
159
|
-
* @property {string} [city_code] - Code representing the city within the state
|
|
160
|
-
* where the serviceability is being specified.
|
|
161
|
-
* @property {string} [sector_code] - Code representing a specific sector or
|
|
162
|
-
* district within the city where the serviceability is being specified.
|
|
163
|
-
* @property {string} [pincode] - Postal or ZIP code for the specific area
|
|
164
|
-
* within the city where the serviceability is being specified.
|
|
165
|
-
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
166
|
-
* first-mile service is available or not.
|
|
167
|
-
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
168
|
-
* service is available or not.
|
|
169
|
-
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
170
|
-
* region is first-mile serviceable or not in return pickup.
|
|
171
|
-
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
172
|
-
* (COD) payments allowed in the specified region.
|
|
173
|
-
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
174
|
-
* is available. This refers to the ability to return items directly from the
|
|
175
|
-
* customer's doorstep.
|
|
176
|
-
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
177
|
-
* service is available. This refers to the ability to perform quality checks
|
|
178
|
-
* on items at the customer's doorstep.
|
|
179
|
-
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
180
|
-
* scheduled to be processed on the same day.
|
|
181
|
-
* @property {boolean} [installation] - Boolean value indicating whether
|
|
182
|
-
* installation services are available in the specified region or not.
|
|
183
|
-
*/
|
|
184
|
-
|
|
185
|
-
/**
|
|
186
|
-
* @typedef RegionTatDetails
|
|
187
|
-
* @property {string} from_country_code - ISO2 code representing the country of
|
|
188
|
-
* origin for the delivery.
|
|
189
|
-
* @property {string} [from_state_code] - Code representing the state or
|
|
190
|
-
* province of origin within the country.
|
|
191
|
-
* @property {string} [from_city_code] - Code representing the city of origin
|
|
192
|
-
* within the state.
|
|
193
|
-
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
194
|
-
* or district within the city of origin.
|
|
195
|
-
* @property {string} [from_pincode] - Postal or ZIP code of the origin area.
|
|
196
|
-
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
197
|
-
* @property {string} [to_state_code] - Code representing the state or province
|
|
198
|
-
* of the destination within the country.
|
|
199
|
-
* @property {string} [to_city_code] - Code representing the city of destination
|
|
200
|
-
* within the state.
|
|
201
|
-
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
202
|
-
* district within the city of destination.
|
|
203
|
-
* @property {string} [to_pincode] - Postal or ZIP code of the destination area.
|
|
204
|
-
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
205
|
-
* from the origin to the destination in seconds.
|
|
206
|
-
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
207
|
-
* from the origin to the destination in seconds.
|
|
208
|
-
*/
|
|
209
|
-
|
|
210
|
-
/**
|
|
211
|
-
* @typedef RegionTatUpdateDetails
|
|
212
|
-
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
213
|
-
* from the origin to the destination in seconds.
|
|
214
|
-
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
215
|
-
* from the origin to the destination in seconds.
|
|
216
|
-
*/
|
|
217
|
-
|
|
218
|
-
/**
|
|
219
|
-
* @typedef RegionTatResult
|
|
220
|
-
* @property {string} from_country_code - ISO2 code representing the country of
|
|
221
|
-
* origin for the delivery.
|
|
222
|
-
* @property {string} [from_state_code] - Code representing the state or
|
|
223
|
-
* province of origin within the country.
|
|
224
|
-
* @property {string} [from_city_code] - Code representing the city of origin
|
|
225
|
-
* within the state.
|
|
226
|
-
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
227
|
-
* or district within the city of origin.
|
|
228
|
-
* @property {string} [from_pincode] - Postal or ZIP code of the origin area.
|
|
229
|
-
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
230
|
-
* @property {string} [to_state_code] - Code representing the state or province
|
|
231
|
-
* of the destination within the country.
|
|
232
|
-
* @property {string} [to_city_code] - Code representing the city of destination
|
|
233
|
-
* within the state.
|
|
234
|
-
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
235
|
-
* district within the city of destination.
|
|
236
|
-
* @property {string} [to_pincode] - Postal or ZIP code of the destination area.
|
|
237
|
-
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
238
|
-
* from the origin to the destination in seconds.
|
|
239
|
-
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
240
|
-
* from the origin to the destination in seconds.
|
|
241
|
-
* @property {string} id - Unique identifier for the delivery time record.
|
|
242
|
-
*/
|
|
243
|
-
|
|
244
|
-
/**
|
|
245
|
-
* @typedef BulkRegionJobDetails
|
|
246
|
-
* @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
|
|
247
|
-
* @property {string} country - Country for which the tat or serviceability is
|
|
248
|
-
* to be imported or exported.
|
|
249
|
-
* @property {string} action - Denotes the import or export action to be performed.
|
|
250
|
-
* @property {string} region - Region of the country for which import or export
|
|
251
|
-
* is triggered.
|
|
252
|
-
*/
|
|
253
|
-
|
|
254
|
-
/**
|
|
255
|
-
* @typedef BulkRegionResultItemData
|
|
256
|
-
* @property {string} [file_path] - CDN path of the file which was used for bulk import.
|
|
257
|
-
* @property {number} [failed] - Count of the failed records.
|
|
258
|
-
* @property {Object[]} [failed_records] - Information of records which failed.
|
|
259
|
-
* @property {string} action - Denotes the import or export action performed.
|
|
260
|
-
* @property {string} batch_id - Unique id to identify the import or export query.
|
|
261
|
-
* @property {string} country - Country for which the import or export action is
|
|
262
|
-
* performed.
|
|
263
|
-
* @property {number} [success] - Denoted if the import or export was successful
|
|
264
|
-
* or failure.
|
|
265
|
-
* @property {string} region - Region of the country for which import or export
|
|
266
|
-
* is triggered.
|
|
267
|
-
* @property {string} status - Current status of the import or export action performed.
|
|
268
|
-
* @property {number} [total] - Count of total records.
|
|
269
|
-
* @property {string} [error_file_path] - Path of the error file.
|
|
270
|
-
*/
|
|
271
|
-
|
|
272
|
-
/**
|
|
273
|
-
* @typedef BulkRegionResult
|
|
274
|
-
* @property {BulkRegionResultItemData[]} items
|
|
81
|
+
* @typedef BulkRegionResponse
|
|
82
|
+
* @property {BulkRegionResponseItemData[]} items
|
|
275
83
|
* @property {Page} page
|
|
276
84
|
*/
|
|
277
85
|
|
|
278
86
|
/**
|
|
279
87
|
* @typedef CourierAccount
|
|
280
|
-
* @property {string} extension_id
|
|
281
|
-
* @property {string} account_id
|
|
282
|
-
*
|
|
283
|
-
* @property {
|
|
284
|
-
* @property {
|
|
285
|
-
* @property {
|
|
286
|
-
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
287
|
-
* account or not.
|
|
288
|
-
*/
|
|
289
|
-
|
|
290
|
-
/**
|
|
291
|
-
* @typedef CourierAccountDetailsBody
|
|
292
|
-
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
293
|
-
* @property {string} [account_id] - Unique identifier of courier partner scheme
|
|
294
|
-
* and company id combination.
|
|
295
|
-
* @property {string} scheme_id - Unique identifier of courier account.
|
|
296
|
-
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
297
|
-
* @property {string} stage - Denotes whether the courier account is in enabled
|
|
298
|
-
* or disabled stage.
|
|
299
|
-
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
300
|
-
* account or not.
|
|
88
|
+
* @property {string} extension_id
|
|
89
|
+
* @property {string} account_id
|
|
90
|
+
* @property {string} scheme_id
|
|
91
|
+
* @property {boolean} is_self_ship
|
|
92
|
+
* @property {string} stage
|
|
93
|
+
* @property {boolean} is_own_account
|
|
301
94
|
*/
|
|
302
95
|
|
|
303
96
|
/**
|
|
304
|
-
* @typedef
|
|
97
|
+
* @typedef CourierPartnerAccountFailureResponse
|
|
305
98
|
* @property {boolean} success
|
|
306
|
-
* @property {
|
|
99
|
+
* @property {ErrorResponse[]} error
|
|
307
100
|
*/
|
|
308
101
|
|
|
309
102
|
/**
|
|
310
|
-
* @typedef
|
|
311
|
-
* @property {
|
|
103
|
+
* @typedef CompanyCourierPartnerAccountListResponse
|
|
104
|
+
* @property {CourierAccountResponse[]} items
|
|
312
105
|
* @property {Page} page
|
|
313
106
|
*/
|
|
314
107
|
|
|
315
108
|
/**
|
|
316
|
-
* @typedef
|
|
317
|
-
* @property {string}
|
|
318
|
-
*
|
|
319
|
-
* @property {string}
|
|
320
|
-
* @property {
|
|
321
|
-
* @property {string}
|
|
322
|
-
*
|
|
323
|
-
* @property {
|
|
324
|
-
*
|
|
325
|
-
* @property {
|
|
109
|
+
* @typedef CourierAccountSchemeResponse
|
|
110
|
+
* @property {string} [extension_id]
|
|
111
|
+
* @property {string} [scheme_id]
|
|
112
|
+
* @property {string} [name]
|
|
113
|
+
* @property {ArithmeticOperations} [weight]
|
|
114
|
+
* @property {string} [transport_type]
|
|
115
|
+
* @property {string} [region]
|
|
116
|
+
* @property {string} [delivery_type]
|
|
117
|
+
* @property {string[]} [payment_mode]
|
|
118
|
+
* @property {string} [stage]
|
|
119
|
+
* @property {CourierPartnerSchemeFeatures} [feature]
|
|
326
120
|
*/
|
|
327
121
|
|
|
328
122
|
/**
|
|
329
|
-
* @typedef
|
|
330
|
-
* @property {
|
|
331
|
-
* @property {string}
|
|
332
|
-
* @property {string}
|
|
333
|
-
* @property {
|
|
334
|
-
* @property {
|
|
335
|
-
*
|
|
336
|
-
* @property {
|
|
337
|
-
*
|
|
338
|
-
* @property {string} delivery_type - Type of delivery associated with the
|
|
339
|
-
* courier partner scheme.
|
|
340
|
-
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
341
|
-
* courier partner scheme.
|
|
342
|
-
* @property {string} stage - Indicates if the courier partner scheme is
|
|
343
|
-
* currently active or inactive.
|
|
344
|
-
* @property {CourierPartnerSchemeFeatures} feature
|
|
123
|
+
* @typedef CourierAccountResponse
|
|
124
|
+
* @property {number} [company_id]
|
|
125
|
+
* @property {string} [extension_id]
|
|
126
|
+
* @property {string} account_id
|
|
127
|
+
* @property {string} scheme_id
|
|
128
|
+
* @property {boolean} is_self_ship
|
|
129
|
+
* @property {string} stage
|
|
130
|
+
* @property {boolean} is_own_account
|
|
131
|
+
* @property {CourierAccountSchemeResponse} scheme_rules
|
|
345
132
|
*/
|
|
346
133
|
|
|
347
134
|
/**
|
|
348
|
-
* @typedef
|
|
349
|
-
* @property {string} extension_id
|
|
350
|
-
* @property {string}
|
|
351
|
-
* @property {string} name
|
|
135
|
+
* @typedef CourierPartnerSchemeModel
|
|
136
|
+
* @property {string} extension_id
|
|
137
|
+
* @property {string} scheme_id
|
|
138
|
+
* @property {string} name
|
|
352
139
|
* @property {ArithmeticOperations} weight
|
|
353
|
-
* @property {
|
|
354
|
-
*
|
|
355
|
-
* @property {string} region
|
|
356
|
-
*
|
|
357
|
-
* @property {string}
|
|
358
|
-
*
|
|
359
|
-
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
360
|
-
* courier partner scheme.
|
|
361
|
-
* @property {string} stage - Indicates if the courier partner scheme is
|
|
362
|
-
* currently active or inactive.
|
|
140
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
141
|
+
* @property {string} transport_type
|
|
142
|
+
* @property {string} region
|
|
143
|
+
* @property {string} delivery_type
|
|
144
|
+
* @property {string[]} payment_mode
|
|
145
|
+
* @property {string} stage
|
|
363
146
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
364
147
|
*/
|
|
365
148
|
|
|
366
149
|
/**
|
|
367
150
|
* @typedef CourierPartnerSchemeFeatures
|
|
368
|
-
* @property {boolean} [doorstep_qc]
|
|
369
|
-
*
|
|
370
|
-
* @property {boolean} [
|
|
371
|
-
*
|
|
372
|
-
* @property {
|
|
373
|
-
*
|
|
374
|
-
* @property {boolean} [
|
|
375
|
-
*
|
|
376
|
-
* @property {
|
|
377
|
-
*
|
|
378
|
-
* @property {boolean} [
|
|
379
|
-
*
|
|
380
|
-
* @property {boolean} [
|
|
381
|
-
*
|
|
382
|
-
* @property {boolean} [
|
|
383
|
-
*
|
|
384
|
-
* @property {boolean} [
|
|
385
|
-
*
|
|
386
|
-
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
387
|
-
* supports doorstep exchange services.
|
|
388
|
-
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
389
|
-
* offers doorstep return services.
|
|
390
|
-
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
391
|
-
* provides product installation services upon delivery.
|
|
392
|
-
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
393
|
-
* partner supports open-box delivery, allowing customers to inspect goods
|
|
394
|
-
* before accepting.
|
|
395
|
-
* @property {string} [status_updates] - Describes the type of status updates
|
|
396
|
-
* provided by the courier partner (e.g., real-time, periodic).
|
|
397
|
-
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
398
|
-
* partner supports multiple pickups to a single drop location.
|
|
399
|
-
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
400
|
-
* partner supports single pickup to multiple drop locations.
|
|
401
|
-
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
402
|
-
* offers services for multiple pickups to multiple drop locations.
|
|
403
|
-
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
404
|
-
* supports the generation of e-waybills for shipments.
|
|
405
|
-
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
406
|
-
* of items allowed in a quality check shipment.
|
|
407
|
-
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
408
|
-
* quantity of items allowed in a non-quality check shipment.
|
|
409
|
-
*/
|
|
410
|
-
|
|
411
|
-
/**
|
|
412
|
-
* @typedef CourierPartnerSchemeV2Features
|
|
413
|
-
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
414
|
-
* doorstep quality check services.
|
|
415
|
-
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
416
|
-
* code-based operations.
|
|
417
|
-
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
418
|
-
* multi-part shipment services.
|
|
419
|
-
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
420
|
-
* feature is supported by the courier partner.
|
|
421
|
-
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
422
|
-
* handles the transportation of dangerous goods.
|
|
423
|
-
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
424
|
-
* manages the shipment of fragile goods.
|
|
425
|
-
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
426
|
-
* handles restricted goods, as per regulatory guidelines.
|
|
427
|
-
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
428
|
-
* provides cold storage facilities for goods.
|
|
429
|
-
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
430
|
-
* supports doorstep exchange services.
|
|
431
|
-
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
432
|
-
* offers doorstep return services.
|
|
433
|
-
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
434
|
-
* provides product installation services upon delivery.
|
|
435
|
-
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
436
|
-
* partner supports open-box delivery, allowing customers to inspect goods
|
|
437
|
-
* before accepting.
|
|
438
|
-
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
439
|
-
* partner supports multiple pickups to a single drop location.
|
|
440
|
-
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
441
|
-
* partner supports single pickup to multiple drop locations.
|
|
442
|
-
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
443
|
-
* offers services for multiple pickups to multiple drop locations.
|
|
444
|
-
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
445
|
-
* supports the generation of e-waybills for shipments.
|
|
446
|
-
*/
|
|
447
|
-
|
|
448
|
-
/**
|
|
449
|
-
* @typedef CourierPartnerSchemeV2DetailsModel
|
|
450
|
-
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
451
|
-
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
452
|
-
* @property {string} name - Name of the scheme.
|
|
453
|
-
* @property {ArithmeticOperations} weight
|
|
454
|
-
* @property {ArithmeticOperations} [volumetric_weight]
|
|
455
|
-
* @property {string} transport_type - Mode of transport associated with the
|
|
456
|
-
* courier partner scheme.
|
|
457
|
-
* @property {string} region - Serviceable region associated with the courier
|
|
458
|
-
* partner scheme.
|
|
459
|
-
* @property {string} delivery_type - Type of delivery associated with the
|
|
460
|
-
* courier partner scheme.
|
|
461
|
-
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
462
|
-
* courier partner scheme.
|
|
463
|
-
* @property {string} stage - Indicates if the courier partner scheme is
|
|
464
|
-
* currently active or inactive.
|
|
465
|
-
* @property {string} [status_updates] - Describes the type of status updates
|
|
466
|
-
* provided by the courier partner (e.g., real-time, periodic).
|
|
467
|
-
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
468
|
-
* (NDR) feature is supported by the courier partner.
|
|
469
|
-
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
470
|
-
* of items allowed in a quality check shipment.
|
|
471
|
-
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
472
|
-
* quantity of items allowed in a non-quality check shipment.
|
|
473
|
-
* @property {CourierPartnerSchemeV2Features} feature
|
|
474
|
-
*/
|
|
475
|
-
|
|
476
|
-
/**
|
|
477
|
-
* @typedef CourierPartnerV2SchemeModel
|
|
478
|
-
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
479
|
-
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
480
|
-
* @property {string} [company_id] - Unique identifier of company.
|
|
481
|
-
* @property {string} name - Name of the scheme.
|
|
482
|
-
* @property {ArithmeticOperations} weight
|
|
483
|
-
* @property {ArithmeticOperations} [volumetric_weight]
|
|
484
|
-
* @property {string} transport_type - Mode of transport associated with the
|
|
485
|
-
* courier partner scheme.
|
|
486
|
-
* @property {string} region - Serviceable region associated with the courier
|
|
487
|
-
* partner scheme.
|
|
488
|
-
* @property {string} delivery_type - Type of delivery associated with the
|
|
489
|
-
* courier partner scheme.
|
|
490
|
-
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
491
|
-
* courier partner scheme.
|
|
492
|
-
* @property {string} stage - Indicates if the courier partner scheme is
|
|
493
|
-
* currently active or inactive.
|
|
494
|
-
* @property {string} [status_updates] - Describes the type of status updates
|
|
495
|
-
* provided by the courier partner (e.g., real-time, periodic).
|
|
496
|
-
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
497
|
-
* (NDR) feature is supported by the courier partner.
|
|
498
|
-
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
499
|
-
* of items allowed in a quality check shipment.
|
|
500
|
-
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
501
|
-
* quantity of items allowed in a non-quality check shipment.
|
|
502
|
-
* @property {CourierPartnerSchemeV2Features} feature
|
|
503
|
-
*/
|
|
504
|
-
|
|
505
|
-
/**
|
|
506
|
-
* @typedef courierPartnerSchemeV2List
|
|
507
|
-
* @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
|
|
508
|
-
* @property {Page} page
|
|
151
|
+
* @property {boolean} [doorstep_qc]
|
|
152
|
+
* @property {boolean} [qr]
|
|
153
|
+
* @property {boolean} [mps]
|
|
154
|
+
* @property {boolean} [ndr]
|
|
155
|
+
* @property {number} [ndr_attempts]
|
|
156
|
+
* @property {boolean} [dangerous_goods]
|
|
157
|
+
* @property {boolean} [fragile_goods]
|
|
158
|
+
* @property {boolean} [restricted_goods]
|
|
159
|
+
* @property {boolean} [cold_storage_goods]
|
|
160
|
+
* @property {boolean} [doorstep_exchange]
|
|
161
|
+
* @property {boolean} [doorstep_return]
|
|
162
|
+
* @property {boolean} [product_installation]
|
|
163
|
+
* @property {boolean} [openbox_delivery]
|
|
164
|
+
* @property {string} [status_updates]
|
|
165
|
+
* @property {boolean} [multi_pick_single_drop]
|
|
166
|
+
* @property {boolean} [single_pick_multi_drop]
|
|
167
|
+
* @property {boolean} [multi_pick_multi_drop]
|
|
168
|
+
* @property {boolean} [ewaybill]
|
|
509
169
|
*/
|
|
510
170
|
|
|
511
171
|
/**
|
|
@@ -517,83 +177,63 @@ const Joi = require("joi");
|
|
|
517
177
|
*/
|
|
518
178
|
|
|
519
179
|
/**
|
|
520
|
-
* @typedef
|
|
521
|
-
* @property {string} name
|
|
180
|
+
* @typedef CourierPartnerSchemeUpdateRequest
|
|
181
|
+
* @property {string} name
|
|
522
182
|
* @property {ArithmeticOperations} weight
|
|
523
183
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
524
|
-
* @property {string} transport_type
|
|
525
|
-
*
|
|
526
|
-
* @property {string}
|
|
527
|
-
*
|
|
528
|
-
* @property {string}
|
|
529
|
-
*
|
|
530
|
-
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
531
|
-
* courier partner scheme.
|
|
532
|
-
* @property {string} stage - Indicates if the courier partner scheme is
|
|
533
|
-
* currently active or inactive.
|
|
534
|
-
* @property {string} [status_updates] - Describes the type of status updates
|
|
535
|
-
* provided by the courier partner (e.g., real-time, periodic).
|
|
536
|
-
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
537
|
-
* (NDR) feature is supported by the courier partner.
|
|
538
|
-
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
539
|
-
* of items allowed in a quality check shipment.
|
|
540
|
-
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
541
|
-
* quantity of items allowed in a non-quality check shipment.
|
|
542
|
-
* @property {CourierPartnerSchemeV2Features} feature
|
|
543
|
-
*/
|
|
544
|
-
|
|
545
|
-
/**
|
|
546
|
-
* @typedef GetCountries
|
|
547
|
-
* @property {GetCountriesItems[]} items
|
|
548
|
-
* @property {Page} page
|
|
184
|
+
* @property {string} transport_type
|
|
185
|
+
* @property {string} region
|
|
186
|
+
* @property {string} delivery_type
|
|
187
|
+
* @property {string[]} payment_mode
|
|
188
|
+
* @property {string} stage
|
|
189
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
549
190
|
*/
|
|
550
191
|
|
|
551
192
|
/**
|
|
552
|
-
* @typedef
|
|
553
|
-
* @property {string} [
|
|
554
|
-
* @property {string} [
|
|
555
|
-
* @property {string} [iso2] - Two-letter ISO code representing the country.
|
|
556
|
-
* @property {string} [iso3] - Three-letter ISO code representing the country.
|
|
557
|
-
* @property {string[]} [timezones] - List of time zones used in the country
|
|
558
|
-
* (e.g., ["America/New_York", "America/Los_Angeles"]).
|
|
559
|
-
* @property {HierarchyItems[]} [hierarchy] - Levels within the country (e.g.,
|
|
560
|
-
* states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
|
|
561
|
-
* {"name": "City", "slug": "city"}]).
|
|
562
|
-
* @property {string} [phone_code] - International dialing code for the country
|
|
563
|
-
* (e.g., "+1").
|
|
564
|
-
* @property {string} [currency] - Indicates currency for the country (e.g., "INR").
|
|
565
|
-
* @property {string} [type] - Indicates the type of object (e.g., "country").
|
|
566
|
-
* @property {string} [latitude] - Geographical latitude of the country (e.g., "37.0902").
|
|
567
|
-
* @property {string} [longitude] - Geographical longitude of the country (e.g.,
|
|
568
|
-
* "-95.7129").
|
|
569
|
-
* @property {string} [display_name] - User-friendly version of the geographical
|
|
570
|
-
* data, which may be more descriptive or formatted differently.
|
|
571
|
-
* @property {boolean} [has_next_hierarchy] - More detailed hierarchical data is
|
|
572
|
-
* available, meaning states, cities, or other regions within the country have
|
|
573
|
-
* been populated in the system.
|
|
193
|
+
* @typedef CountryHierarchy
|
|
194
|
+
* @property {string} [display_name]
|
|
195
|
+
* @property {string} [slug]
|
|
574
196
|
*/
|
|
575
197
|
|
|
576
198
|
/**
|
|
577
|
-
* @typedef
|
|
578
|
-
* @property {string} [
|
|
579
|
-
* @property {string} [
|
|
580
|
-
*
|
|
199
|
+
* @typedef CurrencyObject
|
|
200
|
+
* @property {string} [code]
|
|
201
|
+
* @property {string} [name]
|
|
202
|
+
* @property {string} [symbol]
|
|
581
203
|
*/
|
|
582
204
|
|
|
583
205
|
/**
|
|
584
|
-
* @typedef
|
|
585
|
-
* @property {string}
|
|
586
|
-
* @property {string}
|
|
206
|
+
* @typedef CountryObject
|
|
207
|
+
* @property {string} [id]
|
|
208
|
+
* @property {string} [name]
|
|
209
|
+
* @property {string} [display_name]
|
|
210
|
+
* @property {string} [iso2]
|
|
211
|
+
* @property {string} [iso3]
|
|
212
|
+
* @property {string[]} [timezones]
|
|
213
|
+
* @property {CountryHierarchy[]} [hierarchy]
|
|
214
|
+
* @property {string} [phone_code]
|
|
215
|
+
* @property {string} [latitude]
|
|
216
|
+
* @property {string} [longitude]
|
|
217
|
+
* @property {CurrencyObject} [currency]
|
|
218
|
+
* @property {string} [type]
|
|
587
219
|
*/
|
|
588
220
|
|
|
589
221
|
/**
|
|
590
|
-
* @typedef
|
|
591
|
-
* @property {
|
|
222
|
+
* @typedef GetCountries
|
|
223
|
+
* @property {CountryObject[]} [items]
|
|
224
|
+
* @property {Page} [page]
|
|
592
225
|
*/
|
|
593
226
|
|
|
594
227
|
class LogisticsPartnerModel {
|
|
595
|
-
/** @returns {
|
|
596
|
-
static
|
|
228
|
+
/** @returns {ErrorResponseV1} */
|
|
229
|
+
static ErrorResponseV1() {
|
|
230
|
+
return Joi.object({
|
|
231
|
+
error: Joi.string().allow(""),
|
|
232
|
+
});
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
/** @returns {BulkRegionServiceabilityTatRequest} */
|
|
236
|
+
static BulkRegionServiceabilityTatRequest() {
|
|
597
237
|
return Joi.object({
|
|
598
238
|
country: Joi.string().allow("").required(),
|
|
599
239
|
region: Joi.string().allow("").required(),
|
|
@@ -601,21 +241,21 @@ class LogisticsPartnerModel {
|
|
|
601
241
|
});
|
|
602
242
|
}
|
|
603
243
|
|
|
604
|
-
/** @returns {
|
|
605
|
-
static
|
|
244
|
+
/** @returns {BulkRegionServiceabilityTatResponseItemData} */
|
|
245
|
+
static BulkRegionServiceabilityTatResponseItemData() {
|
|
606
246
|
return Joi.object({
|
|
607
247
|
country: Joi.string().allow(""),
|
|
608
248
|
region: Joi.string().allow(""),
|
|
609
249
|
type: Joi.string().allow(""),
|
|
610
250
|
batch_id: Joi.string().allow(""),
|
|
611
251
|
status: Joi.string().allow(""),
|
|
612
|
-
failed_records: Joi.array().items(Joi.
|
|
252
|
+
failed_records: Joi.array().items(Joi.any()),
|
|
613
253
|
file_path: Joi.string().allow("").allow(null),
|
|
614
254
|
});
|
|
615
255
|
}
|
|
616
256
|
|
|
617
|
-
/** @returns {
|
|
618
|
-
static
|
|
257
|
+
/** @returns {ErrorResponse} */
|
|
258
|
+
static ErrorResponse() {
|
|
619
259
|
return Joi.object({
|
|
620
260
|
value: Joi.string().allow("").required(),
|
|
621
261
|
message: Joi.string().allow("").required(),
|
|
@@ -623,19 +263,21 @@ class LogisticsPartnerModel {
|
|
|
623
263
|
});
|
|
624
264
|
}
|
|
625
265
|
|
|
626
|
-
/** @returns {
|
|
627
|
-
static
|
|
266
|
+
/** @returns {FailureResponse} */
|
|
267
|
+
static FailureResponse() {
|
|
628
268
|
return Joi.object({
|
|
629
269
|
success: Joi.boolean().required(),
|
|
630
|
-
error: Joi.array()
|
|
270
|
+
error: Joi.array()
|
|
271
|
+
.items(LogisticsPartnerModel.ErrorResponse())
|
|
272
|
+
.required(),
|
|
631
273
|
});
|
|
632
274
|
}
|
|
633
275
|
|
|
634
|
-
/** @returns {
|
|
635
|
-
static
|
|
276
|
+
/** @returns {BulkRegionServiceabilityTatResponse} */
|
|
277
|
+
static BulkRegionServiceabilityTatResponse() {
|
|
636
278
|
return Joi.object({
|
|
637
279
|
items: Joi.array().items(
|
|
638
|
-
LogisticsPartnerModel.
|
|
280
|
+
LogisticsPartnerModel.BulkRegionServiceabilityTatResponseItemData()
|
|
639
281
|
),
|
|
640
282
|
page: LogisticsPartnerModel.Page(),
|
|
641
283
|
});
|
|
@@ -651,169 +293,26 @@ class LogisticsPartnerModel {
|
|
|
651
293
|
current: Joi.number(),
|
|
652
294
|
type: Joi.string().allow("").required(),
|
|
653
295
|
size: Joi.number(),
|
|
296
|
+
total: Joi.number(),
|
|
654
297
|
});
|
|
655
298
|
}
|
|
656
299
|
|
|
657
|
-
/** @returns {
|
|
658
|
-
static
|
|
659
|
-
return Joi.object({
|
|
660
|
-
extension_id: Joi.string().allow("").required(),
|
|
661
|
-
scheme_id: Joi.string().allow("").required(),
|
|
662
|
-
is_self_ship: Joi.boolean().required(),
|
|
663
|
-
stage: Joi.string().allow("").required(),
|
|
664
|
-
is_own_account: Joi.boolean().required(),
|
|
665
|
-
});
|
|
666
|
-
}
|
|
667
|
-
|
|
668
|
-
/** @returns {RegionTatItemResult} */
|
|
669
|
-
static RegionTatItemResult() {
|
|
670
|
-
return Joi.object({
|
|
671
|
-
items: Joi.array()
|
|
672
|
-
.items(LogisticsPartnerModel.RegionTatResult())
|
|
673
|
-
.required(),
|
|
674
|
-
page: LogisticsPartnerModel.Page().required(),
|
|
675
|
-
});
|
|
676
|
-
}
|
|
677
|
-
|
|
678
|
-
/** @returns {RegionServiceabilityItemResult} */
|
|
679
|
-
static RegionServiceabilityItemResult() {
|
|
680
|
-
return Joi.object({
|
|
681
|
-
items: Joi.array()
|
|
682
|
-
.items(LogisticsPartnerModel.RegionServiceabilityResult())
|
|
683
|
-
.required(),
|
|
684
|
-
page: LogisticsPartnerModel.Page().required(),
|
|
685
|
-
});
|
|
686
|
-
}
|
|
687
|
-
|
|
688
|
-
/** @returns {ServiceabilityDetailsResult} */
|
|
689
|
-
static ServiceabilityDetailsResult() {
|
|
690
|
-
return Joi.object({
|
|
691
|
-
first_mile: Joi.boolean(),
|
|
692
|
-
last_mile: Joi.boolean(),
|
|
693
|
-
reverse_pickup: Joi.boolean().allow(null),
|
|
694
|
-
cod_limit: Joi.number(),
|
|
695
|
-
doorstep_return: Joi.boolean(),
|
|
696
|
-
doorstep_qc: Joi.boolean(),
|
|
697
|
-
pickup_cutoff: Joi.string().allow(""),
|
|
698
|
-
installation: Joi.boolean(),
|
|
699
|
-
id: Joi.string().allow(""),
|
|
700
|
-
});
|
|
701
|
-
}
|
|
702
|
-
|
|
703
|
-
/** @returns {ServiceabilityDetails} */
|
|
704
|
-
static ServiceabilityDetails() {
|
|
705
|
-
return Joi.object({
|
|
706
|
-
first_mile: Joi.boolean(),
|
|
707
|
-
last_mile: Joi.boolean(),
|
|
708
|
-
reverse_pickup: Joi.boolean().allow(null),
|
|
709
|
-
cod_limit: Joi.number(),
|
|
710
|
-
doorstep_return: Joi.boolean(),
|
|
711
|
-
doorstep_qc: Joi.boolean(),
|
|
712
|
-
pickup_cutoff: Joi.string().allow(""),
|
|
713
|
-
installation: Joi.boolean(),
|
|
714
|
-
});
|
|
715
|
-
}
|
|
716
|
-
|
|
717
|
-
/** @returns {RegionServiceabilityResult} */
|
|
718
|
-
static RegionServiceabilityResult() {
|
|
719
|
-
return Joi.object({
|
|
720
|
-
country_code: Joi.string().allow("").required(),
|
|
721
|
-
state_code: Joi.string().allow(""),
|
|
722
|
-
city_code: Joi.string().allow(""),
|
|
723
|
-
sector_code: Joi.string().allow(""),
|
|
724
|
-
pincode: Joi.string().allow(""),
|
|
725
|
-
first_mile: Joi.boolean(),
|
|
726
|
-
last_mile: Joi.boolean(),
|
|
727
|
-
reverse_pickup: Joi.boolean().allow(null),
|
|
728
|
-
cod_limit: Joi.number(),
|
|
729
|
-
doorstep_return: Joi.boolean(),
|
|
730
|
-
doorstep_qc: Joi.boolean(),
|
|
731
|
-
pickup_cutoff: Joi.string().allow(""),
|
|
732
|
-
installation: Joi.boolean(),
|
|
733
|
-
id: Joi.string().allow("").required(),
|
|
734
|
-
});
|
|
735
|
-
}
|
|
736
|
-
|
|
737
|
-
/** @returns {RegionServiceabilityDetails} */
|
|
738
|
-
static RegionServiceabilityDetails() {
|
|
739
|
-
return Joi.object({
|
|
740
|
-
country_code: Joi.string().allow("").required(),
|
|
741
|
-
state_code: Joi.string().allow(""),
|
|
742
|
-
city_code: Joi.string().allow(""),
|
|
743
|
-
sector_code: Joi.string().allow(""),
|
|
744
|
-
pincode: Joi.string().allow(""),
|
|
745
|
-
first_mile: Joi.boolean(),
|
|
746
|
-
last_mile: Joi.boolean(),
|
|
747
|
-
reverse_pickup: Joi.boolean().allow(null),
|
|
748
|
-
cod_limit: Joi.number(),
|
|
749
|
-
doorstep_return: Joi.boolean(),
|
|
750
|
-
doorstep_qc: Joi.boolean(),
|
|
751
|
-
pickup_cutoff: Joi.string().allow(""),
|
|
752
|
-
installation: Joi.boolean(),
|
|
753
|
-
});
|
|
754
|
-
}
|
|
755
|
-
|
|
756
|
-
/** @returns {RegionTatDetails} */
|
|
757
|
-
static RegionTatDetails() {
|
|
758
|
-
return Joi.object({
|
|
759
|
-
from_country_code: Joi.string().allow("").required(),
|
|
760
|
-
from_state_code: Joi.string().allow(""),
|
|
761
|
-
from_city_code: Joi.string().allow(""),
|
|
762
|
-
from_sector_code: Joi.string().allow(""),
|
|
763
|
-
from_pincode: Joi.string().allow(""),
|
|
764
|
-
to_country_code: Joi.string().allow("").required(),
|
|
765
|
-
to_state_code: Joi.string().allow(""),
|
|
766
|
-
to_city_code: Joi.string().allow(""),
|
|
767
|
-
to_sector_code: Joi.string().allow(""),
|
|
768
|
-
to_pincode: Joi.string().allow(""),
|
|
769
|
-
max_delivery_time: Joi.number(),
|
|
770
|
-
min_delivery_time: Joi.number(),
|
|
771
|
-
});
|
|
772
|
-
}
|
|
773
|
-
|
|
774
|
-
/** @returns {RegionTatUpdateDetails} */
|
|
775
|
-
static RegionTatUpdateDetails() {
|
|
776
|
-
return Joi.object({
|
|
777
|
-
max_delivery_time: Joi.number(),
|
|
778
|
-
min_delivery_time: Joi.number(),
|
|
779
|
-
});
|
|
780
|
-
}
|
|
781
|
-
|
|
782
|
-
/** @returns {RegionTatResult} */
|
|
783
|
-
static RegionTatResult() {
|
|
784
|
-
return Joi.object({
|
|
785
|
-
from_country_code: Joi.string().allow("").required(),
|
|
786
|
-
from_state_code: Joi.string().allow(""),
|
|
787
|
-
from_city_code: Joi.string().allow(""),
|
|
788
|
-
from_sector_code: Joi.string().allow(""),
|
|
789
|
-
from_pincode: Joi.string().allow(""),
|
|
790
|
-
to_country_code: Joi.string().allow("").required(),
|
|
791
|
-
to_state_code: Joi.string().allow(""),
|
|
792
|
-
to_city_code: Joi.string().allow(""),
|
|
793
|
-
to_sector_code: Joi.string().allow(""),
|
|
794
|
-
to_pincode: Joi.string().allow(""),
|
|
795
|
-
max_delivery_time: Joi.number(),
|
|
796
|
-
min_delivery_time: Joi.number(),
|
|
797
|
-
id: Joi.string().allow("").required(),
|
|
798
|
-
});
|
|
799
|
-
}
|
|
800
|
-
|
|
801
|
-
/** @returns {BulkRegionJobDetails} */
|
|
802
|
-
static BulkRegionJobDetails() {
|
|
300
|
+
/** @returns {BulkRegionJobSerializer} */
|
|
301
|
+
static BulkRegionJobSerializer() {
|
|
803
302
|
return Joi.object({
|
|
804
|
-
file_path: Joi.string().allow("")
|
|
303
|
+
file_path: Joi.string().allow(""),
|
|
805
304
|
country: Joi.string().allow("").required(),
|
|
806
305
|
action: Joi.string().allow("").required(),
|
|
807
306
|
region: Joi.string().allow("").required(),
|
|
808
307
|
});
|
|
809
308
|
}
|
|
810
309
|
|
|
811
|
-
/** @returns {
|
|
812
|
-
static
|
|
310
|
+
/** @returns {BulkRegionResponseItemData} */
|
|
311
|
+
static BulkRegionResponseItemData() {
|
|
813
312
|
return Joi.object({
|
|
814
|
-
file_path: Joi.string().allow(""),
|
|
313
|
+
file_path: Joi.string().allow("").required(),
|
|
815
314
|
failed: Joi.number(),
|
|
816
|
-
failed_records: Joi.array().items(Joi.
|
|
315
|
+
failed_records: Joi.array().items(Joi.any()),
|
|
817
316
|
action: Joi.string().allow("").required(),
|
|
818
317
|
batch_id: Joi.string().allow("").required(),
|
|
819
318
|
country: Joi.string().allow("").required(),
|
|
@@ -825,11 +324,11 @@ class LogisticsPartnerModel {
|
|
|
825
324
|
});
|
|
826
325
|
}
|
|
827
326
|
|
|
828
|
-
/** @returns {
|
|
829
|
-
static
|
|
327
|
+
/** @returns {BulkRegionResponse} */
|
|
328
|
+
static BulkRegionResponse() {
|
|
830
329
|
return Joi.object({
|
|
831
330
|
items: Joi.array()
|
|
832
|
-
.items(LogisticsPartnerModel.
|
|
331
|
+
.items(LogisticsPartnerModel.BulkRegionResponseItemData())
|
|
833
332
|
.required(),
|
|
834
333
|
page: LogisticsPartnerModel.Page().required(),
|
|
835
334
|
});
|
|
@@ -847,45 +346,53 @@ class LogisticsPartnerModel {
|
|
|
847
346
|
});
|
|
848
347
|
}
|
|
849
348
|
|
|
850
|
-
/** @returns {
|
|
851
|
-
static
|
|
852
|
-
return Joi.object({
|
|
853
|
-
extension_id: Joi.string().allow("").required(),
|
|
854
|
-
account_id: Joi.string().allow(""),
|
|
855
|
-
scheme_id: Joi.string().allow("").required(),
|
|
856
|
-
is_self_ship: Joi.boolean().required(),
|
|
857
|
-
stage: Joi.string().allow("").required(),
|
|
858
|
-
is_own_account: Joi.boolean().required(),
|
|
859
|
-
});
|
|
860
|
-
}
|
|
861
|
-
|
|
862
|
-
/** @returns {CourierPartnerAccountFailureResult} */
|
|
863
|
-
static CourierPartnerAccountFailureResult() {
|
|
349
|
+
/** @returns {CourierPartnerAccountFailureResponse} */
|
|
350
|
+
static CourierPartnerAccountFailureResponse() {
|
|
864
351
|
return Joi.object({
|
|
865
352
|
success: Joi.boolean().required(),
|
|
866
|
-
error: Joi.array()
|
|
353
|
+
error: Joi.array()
|
|
354
|
+
.items(LogisticsPartnerModel.ErrorResponse())
|
|
355
|
+
.required(),
|
|
867
356
|
});
|
|
868
357
|
}
|
|
869
358
|
|
|
870
|
-
/** @returns {
|
|
871
|
-
static
|
|
359
|
+
/** @returns {CompanyCourierPartnerAccountListResponse} */
|
|
360
|
+
static CompanyCourierPartnerAccountListResponse() {
|
|
872
361
|
return Joi.object({
|
|
873
362
|
items: Joi.array()
|
|
874
|
-
.items(LogisticsPartnerModel.
|
|
363
|
+
.items(LogisticsPartnerModel.CourierAccountResponse())
|
|
875
364
|
.required(),
|
|
876
365
|
page: LogisticsPartnerModel.Page().required(),
|
|
877
366
|
});
|
|
878
367
|
}
|
|
879
368
|
|
|
880
|
-
/** @returns {
|
|
881
|
-
static
|
|
369
|
+
/** @returns {CourierAccountSchemeResponse} */
|
|
370
|
+
static CourierAccountSchemeResponse() {
|
|
882
371
|
return Joi.object({
|
|
372
|
+
extension_id: Joi.string().allow(""),
|
|
373
|
+
scheme_id: Joi.string().allow(""),
|
|
374
|
+
name: Joi.string().allow(""),
|
|
375
|
+
weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
376
|
+
transport_type: Joi.string().allow(""),
|
|
377
|
+
region: Joi.string().allow(""),
|
|
378
|
+
delivery_type: Joi.string().allow(""),
|
|
379
|
+
payment_mode: Joi.array().items(Joi.string().allow("")),
|
|
380
|
+
stage: Joi.string().allow(""),
|
|
381
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures(),
|
|
382
|
+
});
|
|
383
|
+
}
|
|
384
|
+
|
|
385
|
+
/** @returns {CourierAccountResponse} */
|
|
386
|
+
static CourierAccountResponse() {
|
|
387
|
+
return Joi.object({
|
|
388
|
+
company_id: Joi.number(),
|
|
389
|
+
extension_id: Joi.string().allow(""),
|
|
883
390
|
account_id: Joi.string().allow("").required(),
|
|
884
391
|
scheme_id: Joi.string().allow("").required(),
|
|
885
392
|
is_self_ship: Joi.boolean().required(),
|
|
886
393
|
stage: Joi.string().allow("").required(),
|
|
887
394
|
is_own_account: Joi.boolean().required(),
|
|
888
|
-
scheme_rules: LogisticsPartnerModel.
|
|
395
|
+
scheme_rules: LogisticsPartnerModel.CourierAccountSchemeResponse().required(),
|
|
889
396
|
});
|
|
890
397
|
}
|
|
891
398
|
|
|
@@ -896,22 +403,7 @@ class LogisticsPartnerModel {
|
|
|
896
403
|
scheme_id: Joi.string().allow("").required(),
|
|
897
404
|
name: Joi.string().allow("").required(),
|
|
898
405
|
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
899
|
-
|
|
900
|
-
region: Joi.string().allow("").required(),
|
|
901
|
-
delivery_type: Joi.string().allow("").required(),
|
|
902
|
-
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
903
|
-
stage: Joi.string().allow("").required(),
|
|
904
|
-
feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
|
|
905
|
-
});
|
|
906
|
-
}
|
|
907
|
-
|
|
908
|
-
/** @returns {CourierPartnerSchemeDetailsModel} */
|
|
909
|
-
static CourierPartnerSchemeDetailsModel() {
|
|
910
|
-
return Joi.object({
|
|
911
|
-
extension_id: Joi.string().allow("").required(),
|
|
912
|
-
scheme_id: Joi.string().allow(""),
|
|
913
|
-
name: Joi.string().allow("").required(),
|
|
914
|
-
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
406
|
+
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
915
407
|
transport_type: Joi.string().allow("").required(),
|
|
916
408
|
region: Joi.string().allow("").required(),
|
|
917
409
|
delivery_type: Joi.string().allow("").required(),
|
|
@@ -942,83 +434,6 @@ class LogisticsPartnerModel {
|
|
|
942
434
|
single_pick_multi_drop: Joi.boolean(),
|
|
943
435
|
multi_pick_multi_drop: Joi.boolean(),
|
|
944
436
|
ewaybill: Joi.boolean(),
|
|
945
|
-
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
946
|
-
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
947
|
-
});
|
|
948
|
-
}
|
|
949
|
-
|
|
950
|
-
/** @returns {CourierPartnerSchemeV2Features} */
|
|
951
|
-
static CourierPartnerSchemeV2Features() {
|
|
952
|
-
return Joi.object({
|
|
953
|
-
doorstep_qc: Joi.boolean(),
|
|
954
|
-
qr: Joi.boolean(),
|
|
955
|
-
mps: Joi.boolean(),
|
|
956
|
-
ndr: Joi.boolean(),
|
|
957
|
-
dangerous_goods: Joi.boolean(),
|
|
958
|
-
fragile_goods: Joi.boolean(),
|
|
959
|
-
restricted_goods: Joi.boolean(),
|
|
960
|
-
cold_storage_goods: Joi.boolean(),
|
|
961
|
-
doorstep_exchange: Joi.boolean(),
|
|
962
|
-
doorstep_return: Joi.boolean(),
|
|
963
|
-
product_installation: Joi.boolean(),
|
|
964
|
-
openbox_delivery: Joi.boolean(),
|
|
965
|
-
multi_pick_single_drop: Joi.boolean(),
|
|
966
|
-
single_pick_multi_drop: Joi.boolean(),
|
|
967
|
-
multi_pick_multi_drop: Joi.boolean(),
|
|
968
|
-
ewaybill: Joi.boolean(),
|
|
969
|
-
});
|
|
970
|
-
}
|
|
971
|
-
|
|
972
|
-
/** @returns {CourierPartnerSchemeV2DetailsModel} */
|
|
973
|
-
static CourierPartnerSchemeV2DetailsModel() {
|
|
974
|
-
return Joi.object({
|
|
975
|
-
extension_id: Joi.string().allow("").required(),
|
|
976
|
-
scheme_id: Joi.string().allow(""),
|
|
977
|
-
name: Joi.string().allow("").required(),
|
|
978
|
-
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
979
|
-
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
980
|
-
transport_type: Joi.string().allow("").required(),
|
|
981
|
-
region: Joi.string().allow("").required(),
|
|
982
|
-
delivery_type: Joi.string().allow("").required(),
|
|
983
|
-
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
984
|
-
stage: Joi.string().allow("").required(),
|
|
985
|
-
status_updates: Joi.string().allow(""),
|
|
986
|
-
ndr_attempts: Joi.number(),
|
|
987
|
-
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
988
|
-
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
989
|
-
feature: LogisticsPartnerModel.CourierPartnerSchemeV2Features().required(),
|
|
990
|
-
});
|
|
991
|
-
}
|
|
992
|
-
|
|
993
|
-
/** @returns {CourierPartnerV2SchemeModel} */
|
|
994
|
-
static CourierPartnerV2SchemeModel() {
|
|
995
|
-
return Joi.object({
|
|
996
|
-
extension_id: Joi.string().allow("").required(),
|
|
997
|
-
scheme_id: Joi.string().allow("").required(),
|
|
998
|
-
company_id: Joi.string().allow(""),
|
|
999
|
-
name: Joi.string().allow("").required(),
|
|
1000
|
-
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
1001
|
-
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
1002
|
-
transport_type: Joi.string().allow("").required(),
|
|
1003
|
-
region: Joi.string().allow("").required(),
|
|
1004
|
-
delivery_type: Joi.string().allow("").required(),
|
|
1005
|
-
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
1006
|
-
stage: Joi.string().allow("").required(),
|
|
1007
|
-
status_updates: Joi.string().allow(""),
|
|
1008
|
-
ndr_attempts: Joi.number(),
|
|
1009
|
-
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1010
|
-
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1011
|
-
feature: LogisticsPartnerModel.CourierPartnerSchemeV2Features().required(),
|
|
1012
|
-
});
|
|
1013
|
-
}
|
|
1014
|
-
|
|
1015
|
-
/** @returns {courierPartnerSchemeV2List} */
|
|
1016
|
-
static courierPartnerSchemeV2List() {
|
|
1017
|
-
return Joi.object({
|
|
1018
|
-
items: Joi.array()
|
|
1019
|
-
.items(LogisticsPartnerModel.CourierPartnerV2SchemeModel())
|
|
1020
|
-
.required(),
|
|
1021
|
-
page: LogisticsPartnerModel.Page().required(),
|
|
1022
437
|
});
|
|
1023
438
|
}
|
|
1024
439
|
|
|
@@ -1029,11 +444,11 @@ class LogisticsPartnerModel {
|
|
|
1029
444
|
gt: Joi.number().allow(null),
|
|
1030
445
|
lte: Joi.number().allow(null),
|
|
1031
446
|
gte: Joi.number().allow(null),
|
|
1032
|
-
});
|
|
447
|
+
}).allow(null);
|
|
1033
448
|
}
|
|
1034
449
|
|
|
1035
|
-
/** @returns {
|
|
1036
|
-
static
|
|
450
|
+
/** @returns {CourierPartnerSchemeUpdateRequest} */
|
|
451
|
+
static CourierPartnerSchemeUpdateRequest() {
|
|
1037
452
|
return Joi.object({
|
|
1038
453
|
name: Joi.string().allow("").required(),
|
|
1039
454
|
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
@@ -1043,63 +458,50 @@ class LogisticsPartnerModel {
|
|
|
1043
458
|
delivery_type: Joi.string().allow("").required(),
|
|
1044
459
|
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
1045
460
|
stage: Joi.string().allow("").required(),
|
|
1046
|
-
|
|
1047
|
-
ndr_attempts: Joi.number(),
|
|
1048
|
-
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1049
|
-
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1050
|
-
feature: LogisticsPartnerModel.CourierPartnerSchemeV2Features().required(),
|
|
461
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
|
|
1051
462
|
});
|
|
1052
463
|
}
|
|
1053
464
|
|
|
1054
|
-
/** @returns {
|
|
1055
|
-
static
|
|
465
|
+
/** @returns {CountryHierarchy} */
|
|
466
|
+
static CountryHierarchy() {
|
|
1056
467
|
return Joi.object({
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
.required(),
|
|
1060
|
-
page: LogisticsPartnerModel.Page().required(),
|
|
468
|
+
display_name: Joi.string().allow(""),
|
|
469
|
+
slug: Joi.string().allow(""),
|
|
1061
470
|
});
|
|
1062
471
|
}
|
|
1063
472
|
|
|
1064
|
-
/** @returns {
|
|
1065
|
-
static
|
|
473
|
+
/** @returns {CurrencyObject} */
|
|
474
|
+
static CurrencyObject() {
|
|
475
|
+
return Joi.object({
|
|
476
|
+
code: Joi.string().allow(""),
|
|
477
|
+
name: Joi.string().allow(""),
|
|
478
|
+
symbol: Joi.string().allow(""),
|
|
479
|
+
});
|
|
480
|
+
}
|
|
481
|
+
|
|
482
|
+
/** @returns {CountryObject} */
|
|
483
|
+
static CountryObject() {
|
|
1066
484
|
return Joi.object({
|
|
1067
485
|
id: Joi.string().allow(""),
|
|
1068
486
|
name: Joi.string().allow(""),
|
|
487
|
+
display_name: Joi.string().allow(""),
|
|
1069
488
|
iso2: Joi.string().allow(""),
|
|
1070
489
|
iso3: Joi.string().allow(""),
|
|
1071
|
-
timezones: Joi.array().items(Joi.string().allow("")),
|
|
1072
|
-
hierarchy: Joi.array().items(LogisticsPartnerModel.
|
|
490
|
+
timezones: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
491
|
+
hierarchy: Joi.array().items(LogisticsPartnerModel.CountryHierarchy()),
|
|
1073
492
|
phone_code: Joi.string().allow(""),
|
|
1074
|
-
currency: Joi.string().allow(""),
|
|
1075
|
-
type: Joi.string().allow(""),
|
|
1076
493
|
latitude: Joi.string().allow(""),
|
|
1077
494
|
longitude: Joi.string().allow(""),
|
|
1078
|
-
|
|
1079
|
-
|
|
1080
|
-
});
|
|
1081
|
-
}
|
|
1082
|
-
|
|
1083
|
-
/** @returns {HierarchyItems} */
|
|
1084
|
-
static HierarchyItems() {
|
|
1085
|
-
return Joi.object({
|
|
1086
|
-
display_name: Joi.string().allow(""),
|
|
1087
|
-
slug: Joi.string().allow(""),
|
|
1088
|
-
});
|
|
1089
|
-
}
|
|
1090
|
-
|
|
1091
|
-
/** @returns {ValidationError} */
|
|
1092
|
-
static ValidationError() {
|
|
1093
|
-
return Joi.object({
|
|
1094
|
-
message: Joi.string().allow("").required(),
|
|
1095
|
-
field: Joi.string().allow("").required(),
|
|
495
|
+
currency: LogisticsPartnerModel.CurrencyObject(),
|
|
496
|
+
type: Joi.string().allow(""),
|
|
1096
497
|
});
|
|
1097
498
|
}
|
|
1098
499
|
|
|
1099
|
-
/** @returns {
|
|
1100
|
-
static
|
|
500
|
+
/** @returns {GetCountries} */
|
|
501
|
+
static GetCountries() {
|
|
1101
502
|
return Joi.object({
|
|
1102
|
-
|
|
503
|
+
items: Joi.array().items(LogisticsPartnerModel.CountryObject()),
|
|
504
|
+
page: LogisticsPartnerModel.Page(),
|
|
1103
505
|
});
|
|
1104
506
|
}
|
|
1105
507
|
}
|