@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
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 +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- 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 +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,39 +1,41 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
5
|
-
* @property {string} country
|
|
6
|
-
* @property {string} region
|
|
7
|
-
*
|
|
4
|
+
* @typedef BulkRegionServiceabilityTatDetails
|
|
5
|
+
* @property {string} country - Name of the country.
|
|
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.
|
|
8
9
|
*/
|
|
9
10
|
|
|
10
11
|
/**
|
|
11
|
-
* @typedef
|
|
12
|
-
* @property {string} [country]
|
|
13
|
-
* @property {string} [region]
|
|
14
|
-
*
|
|
15
|
-
* @property {string} [
|
|
16
|
-
* @property {string} [
|
|
17
|
-
* @property {
|
|
18
|
-
* @property {
|
|
12
|
+
* @typedef BulkRegionServiceabilityTatResultItemData
|
|
13
|
+
* @property {string} [country] - Name of the country.
|
|
14
|
+
* @property {string} [region] - Name of the region for which the
|
|
15
|
+
* tat/serviceability file needs to be downloaded.
|
|
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.
|
|
19
21
|
*/
|
|
20
22
|
|
|
21
23
|
/**
|
|
22
|
-
* @typedef
|
|
23
|
-
* @property {string} value
|
|
24
|
-
* @property {string} message
|
|
25
|
-
* @property {string} type
|
|
24
|
+
* @typedef ErrorResult
|
|
25
|
+
* @property {string} value - Fields containing the error.
|
|
26
|
+
* @property {string} message - Description of the error.
|
|
27
|
+
* @property {string} type - Type of the error.
|
|
26
28
|
*/
|
|
27
29
|
|
|
28
30
|
/**
|
|
29
|
-
* @typedef
|
|
30
|
-
* @property {boolean} success
|
|
31
|
-
* @property {
|
|
31
|
+
* @typedef FailureResult
|
|
32
|
+
* @property {boolean} success - Denotes if the request was successfully executed.
|
|
33
|
+
* @property {ErrorResult[]} error
|
|
32
34
|
*/
|
|
33
35
|
|
|
34
36
|
/**
|
|
35
|
-
* @typedef
|
|
36
|
-
* @property {
|
|
37
|
+
* @typedef BulkRegionServiceabilityTatResult
|
|
38
|
+
* @property {BulkRegionServiceabilityTatResultItemData[]} [items]
|
|
37
39
|
* @property {Page} [page]
|
|
38
40
|
*/
|
|
39
41
|
|
|
@@ -49,124 +51,353 @@ const Joi = require("joi");
|
|
|
49
51
|
*/
|
|
50
52
|
|
|
51
53
|
/**
|
|
52
|
-
* @typedef
|
|
53
|
-
* @property {string}
|
|
54
|
-
* @property {string}
|
|
55
|
-
* @property {
|
|
56
|
-
* @property {string}
|
|
54
|
+
* @typedef CourierAccountUpdateDetails
|
|
55
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
56
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
57
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
58
|
+
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
59
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
60
|
+
* account or not.
|
|
61
|
+
*/
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* @typedef RegionTatItemResult
|
|
65
|
+
* @property {RegionTatResult[]} items
|
|
66
|
+
* @property {Page} page
|
|
67
|
+
*/
|
|
68
|
+
|
|
69
|
+
/**
|
|
70
|
+
* @typedef RegionServiceabilityItemResult
|
|
71
|
+
* @property {RegionServiceabilityResult[]} items
|
|
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 {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
82
|
+
* (COD) payments allowed in the specified region.
|
|
83
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
84
|
+
* is available. This refers to the ability to return items directly from the
|
|
85
|
+
* customer's doorstep.
|
|
86
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
87
|
+
* service is available. This refers to the ability to perform quality checks
|
|
88
|
+
* on items at the customer's doorstep.
|
|
89
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
90
|
+
* scheduled to be processed on the same day.
|
|
91
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
92
|
+
* installation services are available in the specified region or not.
|
|
93
|
+
* @property {string} [id] - Unique identifier for the serviceability record.
|
|
94
|
+
*/
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* @typedef ServiceabilityDetails
|
|
98
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
99
|
+
* first-mile service is available or not.
|
|
100
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
101
|
+
* service is available or not.
|
|
102
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
103
|
+
* (COD) payments allowed in the specified region.
|
|
104
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
105
|
+
* is available. This refers to the ability to return items directly from the
|
|
106
|
+
* customer's doorstep.
|
|
107
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
108
|
+
* service is available. This refers to the ability to perform quality checks
|
|
109
|
+
* on items at the customer's doorstep.
|
|
110
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
111
|
+
* scheduled to be processed on the same day.
|
|
112
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
113
|
+
* installation services are available in the specified region or not.
|
|
114
|
+
*/
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* @typedef RegionServiceabilityResult
|
|
118
|
+
* @property {string} country_code - ISO2 code representing the country where
|
|
119
|
+
* the serviceability is being specified.
|
|
120
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
121
|
+
* within the country where the serviceability is being specified.
|
|
122
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
123
|
+
* where the serviceability is being specified.
|
|
124
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
125
|
+
* district within the city where the serviceability is being specified.
|
|
126
|
+
* @property {string} [pincode] - Postal or ZIP code for the specific area
|
|
127
|
+
* within the city where the serviceability is being specified.
|
|
128
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
129
|
+
* first-mile service is available or not.
|
|
130
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
131
|
+
* service is available or not.
|
|
132
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
133
|
+
* (COD) payments allowed in the specified region.
|
|
134
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
135
|
+
* is available. This refers to the ability to return items directly from the
|
|
136
|
+
* customer's doorstep.
|
|
137
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
138
|
+
* service is available. This refers to the ability to perform quality checks
|
|
139
|
+
* on items at the customer's doorstep.
|
|
140
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
141
|
+
* scheduled to be processed on the same day.
|
|
142
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
143
|
+
* installation services are available in the specified region or not.
|
|
144
|
+
* @property {string} id - Unique identifier for the serviceability record.
|
|
145
|
+
*/
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* @typedef RegionServiceabilityDetails
|
|
149
|
+
* @property {string} country_code - ISO2 code representing the country where
|
|
150
|
+
* the serviceability is being specified.
|
|
151
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
152
|
+
* within the country where the serviceability is being specified.
|
|
153
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
154
|
+
* where the serviceability is being specified.
|
|
155
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
156
|
+
* district within the city where the serviceability is being specified.
|
|
157
|
+
* @property {string} [pincode] - Postal or ZIP code for the specific area
|
|
158
|
+
* within the city where the serviceability is being specified.
|
|
159
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
160
|
+
* first-mile service is available or not.
|
|
161
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
162
|
+
* service is available or not.
|
|
163
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
164
|
+
* (COD) payments allowed in the specified region.
|
|
165
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
166
|
+
* is available. This refers to the ability to return items directly from the
|
|
167
|
+
* customer's doorstep.
|
|
168
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
169
|
+
* service is available. This refers to the ability to perform quality checks
|
|
170
|
+
* on items at the customer's doorstep.
|
|
171
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
172
|
+
* scheduled to be processed on the same day.
|
|
173
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
174
|
+
* installation services are available in the specified region or not.
|
|
175
|
+
*/
|
|
176
|
+
|
|
177
|
+
/**
|
|
178
|
+
* @typedef RegionTatDetails
|
|
179
|
+
* @property {string} from_country_code - ISO2 code representing the country of
|
|
180
|
+
* origin for the delivery.
|
|
181
|
+
* @property {string} [from_state_code] - Code representing the state or
|
|
182
|
+
* province of origin within the country.
|
|
183
|
+
* @property {string} [from_city_code] - Code representing the city of origin
|
|
184
|
+
* within the state.
|
|
185
|
+
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
186
|
+
* or district within the city of origin.
|
|
187
|
+
* @property {string} [from_pincode] - Postal or ZIP code of the origin area.
|
|
188
|
+
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
189
|
+
* @property {string} [to_state_code] - Code representing the state or province
|
|
190
|
+
* of the destination within the country.
|
|
191
|
+
* @property {string} [to_city_code] - Code representing the city of destination
|
|
192
|
+
* within the state.
|
|
193
|
+
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
194
|
+
* district within the city of destination.
|
|
195
|
+
* @property {string} [to_pincode] - Postal or ZIP code of the destination area.
|
|
196
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
197
|
+
* from the origin to the destination in seconds.
|
|
198
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
199
|
+
* from the origin to the destination in seconds.
|
|
200
|
+
*/
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* @typedef RegionTatUpdateDetails
|
|
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 RegionTatResult
|
|
212
|
+
* @property {string} from_country_code - ISO2 code representing the country of
|
|
213
|
+
* origin for the delivery.
|
|
214
|
+
* @property {string} [from_state_code] - Code representing the state or
|
|
215
|
+
* province of origin within the country.
|
|
216
|
+
* @property {string} [from_city_code] - Code representing the city of origin
|
|
217
|
+
* within the state.
|
|
218
|
+
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
219
|
+
* or district within the city of origin.
|
|
220
|
+
* @property {string} [from_pincode] - Postal or ZIP code of the origin area.
|
|
221
|
+
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
222
|
+
* @property {string} [to_state_code] - Code representing the state or province
|
|
223
|
+
* of the destination within the country.
|
|
224
|
+
* @property {string} [to_city_code] - Code representing the city of destination
|
|
225
|
+
* within the state.
|
|
226
|
+
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
227
|
+
* district within the city of destination.
|
|
228
|
+
* @property {string} [to_pincode] - Postal or ZIP code of the destination area.
|
|
229
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
230
|
+
* from the origin to the destination in seconds.
|
|
231
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
232
|
+
* from the origin to the destination in seconds.
|
|
233
|
+
* @property {string} id - Unique identifier for the delivery time record.
|
|
234
|
+
*/
|
|
235
|
+
|
|
236
|
+
/**
|
|
237
|
+
* @typedef BulkRegionJobDetails
|
|
238
|
+
* @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
|
|
239
|
+
* @property {string} country - Country for which the tat or serviceability is
|
|
240
|
+
* to be imported or exported.
|
|
241
|
+
* @property {string} action - Denotes the import or export action to be performed.
|
|
242
|
+
* @property {string} region - Region of the country for which import or export
|
|
243
|
+
* is triggered.
|
|
57
244
|
*/
|
|
58
245
|
|
|
59
246
|
/**
|
|
60
|
-
* @typedef
|
|
61
|
-
* @property {string} file_path
|
|
62
|
-
* @property {number} [failed]
|
|
63
|
-
* @property {Object[]} [failed_records]
|
|
64
|
-
* @property {string} action
|
|
65
|
-
* @property {string} batch_id
|
|
66
|
-
* @property {string} country
|
|
67
|
-
*
|
|
68
|
-
* @property {
|
|
69
|
-
*
|
|
70
|
-
* @property {
|
|
71
|
-
*
|
|
247
|
+
* @typedef BulkRegionResultItemData
|
|
248
|
+
* @property {string} [file_path] - CDN path of the file which was used for bulk import.
|
|
249
|
+
* @property {number} [failed] - Count of the failed records.
|
|
250
|
+
* @property {Object[]} [failed_records] - Information of records which failed.
|
|
251
|
+
* @property {string} action - Denotes the import or export action performed.
|
|
252
|
+
* @property {string} batch_id - Unique id to identify the import or export query.
|
|
253
|
+
* @property {string} country - Country for which the import or export action is
|
|
254
|
+
* performed.
|
|
255
|
+
* @property {number} [success] - Denoted if the import or export was successful
|
|
256
|
+
* or failure.
|
|
257
|
+
* @property {string} region - Region of the country for which import or export
|
|
258
|
+
* is triggered.
|
|
259
|
+
* @property {string} status - Current status of the import or export action performed.
|
|
260
|
+
* @property {number} [total] - Count of total records.
|
|
261
|
+
* @property {string} [error_file_path] - Path of the error file.
|
|
72
262
|
*/
|
|
73
263
|
|
|
74
264
|
/**
|
|
75
|
-
* @typedef
|
|
76
|
-
* @property {
|
|
265
|
+
* @typedef BulkRegionResult
|
|
266
|
+
* @property {BulkRegionResultItemData[]} items
|
|
77
267
|
* @property {Page} page
|
|
78
268
|
*/
|
|
79
269
|
|
|
80
270
|
/**
|
|
81
271
|
* @typedef CourierAccount
|
|
82
|
-
* @property {string} extension_id
|
|
83
|
-
* @property {string} account_id
|
|
84
|
-
*
|
|
85
|
-
* @property {
|
|
86
|
-
* @property {
|
|
87
|
-
* @property {
|
|
272
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
273
|
+
* @property {string} account_id - Unique identifier of courier partner scheme
|
|
274
|
+
* and company id combination.
|
|
275
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
276
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
277
|
+
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
278
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
279
|
+
* account or not.
|
|
88
280
|
*/
|
|
89
281
|
|
|
90
282
|
/**
|
|
91
|
-
* @typedef
|
|
92
|
-
* @property {string} extension_id
|
|
93
|
-
* @property {string} [account_id]
|
|
94
|
-
*
|
|
95
|
-
* @property {
|
|
96
|
-
* @property {
|
|
97
|
-
* @property {
|
|
283
|
+
* @typedef CourierAccountDetailsBody
|
|
284
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
285
|
+
* @property {string} [account_id] - Unique identifier of courier partner scheme
|
|
286
|
+
* and company id combination.
|
|
287
|
+
* @property {string} scheme_id - Unique identifier of courier account.
|
|
288
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
289
|
+
* @property {string} stage - Denotes whether the courier account is in enabled
|
|
290
|
+
* or disabled stage.
|
|
291
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
292
|
+
* account or not.
|
|
98
293
|
*/
|
|
99
294
|
|
|
100
295
|
/**
|
|
101
|
-
* @typedef
|
|
296
|
+
* @typedef CourierPartnerAccountFailureResult
|
|
102
297
|
* @property {boolean} success
|
|
103
|
-
* @property {
|
|
298
|
+
* @property {ErrorResult[]} error
|
|
104
299
|
*/
|
|
105
300
|
|
|
106
301
|
/**
|
|
107
|
-
* @typedef
|
|
108
|
-
* @property {
|
|
302
|
+
* @typedef CompanyCourierPartnerAccountListResult
|
|
303
|
+
* @property {CourierAccountResult[]} items
|
|
109
304
|
* @property {Page} page
|
|
110
305
|
*/
|
|
111
306
|
|
|
112
307
|
/**
|
|
113
|
-
* @typedef
|
|
114
|
-
* @property {string} account_id
|
|
115
|
-
*
|
|
308
|
+
* @typedef CourierAccountResult
|
|
309
|
+
* @property {string} account_id - Unique identifier of courier partner scheme
|
|
310
|
+
* and company id combination.
|
|
311
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
116
312
|
* @property {boolean} is_self_ship
|
|
117
|
-
* @property {string} stage
|
|
118
|
-
*
|
|
313
|
+
* @property {string} stage - Denotes whether the courier account is in enabled
|
|
314
|
+
* or disabled stage.
|
|
315
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
316
|
+
* account or not.
|
|
119
317
|
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
120
318
|
*/
|
|
121
319
|
|
|
122
320
|
/**
|
|
123
321
|
* @typedef CourierPartnerSchemeModel
|
|
124
|
-
* @property {string} extension_id
|
|
125
|
-
* @property {string} scheme_id
|
|
126
|
-
* @property {string} name
|
|
322
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
323
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
324
|
+
* @property {string} name - Name of the scheme
|
|
127
325
|
* @property {ArithmeticOperations} weight
|
|
128
|
-
* @property {string} transport_type
|
|
129
|
-
*
|
|
130
|
-
* @property {string}
|
|
131
|
-
*
|
|
132
|
-
* @property {string}
|
|
326
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
327
|
+
* courier partner scheme.
|
|
328
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
329
|
+
* partner scheme.
|
|
330
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
331
|
+
* courier partner scheme.
|
|
332
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
333
|
+
* courier partner scheme.
|
|
334
|
+
* @property {string} stage - Denotes whether the courier partner scheme is in
|
|
335
|
+
* enabled or disabled stage.
|
|
133
336
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
134
337
|
*/
|
|
135
338
|
|
|
136
339
|
/**
|
|
137
|
-
* @typedef
|
|
138
|
-
* @property {string} extension_id
|
|
139
|
-
* @property {string} [scheme_id]
|
|
140
|
-
* @property {string} name
|
|
340
|
+
* @typedef CourierPartnerSchemeDetailsModel
|
|
341
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
342
|
+
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
343
|
+
* @property {string} name - Name of the courier partner scheme.
|
|
141
344
|
* @property {ArithmeticOperations} weight
|
|
142
|
-
* @property {string} transport_type
|
|
143
|
-
*
|
|
144
|
-
* @property {string}
|
|
145
|
-
*
|
|
146
|
-
* @property {string}
|
|
345
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
346
|
+
* courier partner scheme.
|
|
347
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
348
|
+
* partner scheme.
|
|
349
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
350
|
+
* courier partner scheme.
|
|
351
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
352
|
+
* courier partner scheme.
|
|
353
|
+
* @property {string} stage - Denotes whether the courier partner scheme is in
|
|
354
|
+
* enabled or disabled stage.
|
|
147
355
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
148
356
|
*/
|
|
149
357
|
|
|
150
358
|
/**
|
|
151
359
|
* @typedef CourierPartnerSchemeFeatures
|
|
152
|
-
* @property {boolean} [doorstep_qc]
|
|
153
|
-
*
|
|
154
|
-
* @property {boolean} [
|
|
155
|
-
*
|
|
156
|
-
* @property {
|
|
157
|
-
*
|
|
158
|
-
* @property {boolean} [
|
|
159
|
-
*
|
|
160
|
-
* @property {
|
|
161
|
-
*
|
|
162
|
-
* @property {boolean} [
|
|
163
|
-
*
|
|
164
|
-
* @property {boolean} [
|
|
165
|
-
*
|
|
166
|
-
* @property {boolean} [
|
|
167
|
-
*
|
|
168
|
-
* @property {boolean} [
|
|
169
|
-
*
|
|
360
|
+
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
361
|
+
* doorstep quality check services.
|
|
362
|
+
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
363
|
+
* code-based operations.
|
|
364
|
+
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
365
|
+
* multi-part shipment services.
|
|
366
|
+
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
367
|
+
* feature is supported by the courier partner.
|
|
368
|
+
* @property {number} [ndr_attempts] - Number of attempts allowed for resolving
|
|
369
|
+
* Non-Delivery Reports (NDR).
|
|
370
|
+
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
371
|
+
* handles the transportation of dangerous goods.
|
|
372
|
+
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
373
|
+
* manages the shipment of fragile goods.
|
|
374
|
+
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
375
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
376
|
+
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
377
|
+
* provides cold storage facilities for goods.
|
|
378
|
+
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
379
|
+
* supports doorstep exchange services.
|
|
380
|
+
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
381
|
+
* offers doorstep return services.
|
|
382
|
+
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
383
|
+
* provides product installation services upon delivery.
|
|
384
|
+
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
385
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
386
|
+
* before accepting.
|
|
387
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
388
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
389
|
+
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
390
|
+
* partner supports multiple pickups to a single drop location.
|
|
391
|
+
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
392
|
+
* partner supports single pickup to multiple drop locations.
|
|
393
|
+
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
394
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
395
|
+
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
396
|
+
* supports the generation of e-waybills for shipments.
|
|
397
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
398
|
+
* of items allowed in a quality check shipment.
|
|
399
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
400
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
170
401
|
*/
|
|
171
402
|
|
|
172
403
|
/**
|
|
@@ -178,14 +409,19 @@ const Joi = require("joi");
|
|
|
178
409
|
*/
|
|
179
410
|
|
|
180
411
|
/**
|
|
181
|
-
* @typedef
|
|
182
|
-
* @property {string} name
|
|
412
|
+
* @typedef CourierPartnerSchemeUpdateDetails
|
|
413
|
+
* @property {string} name - Name of the scheme.
|
|
183
414
|
* @property {ArithmeticOperations} weight
|
|
184
|
-
* @property {string} transport_type
|
|
185
|
-
*
|
|
186
|
-
* @property {string}
|
|
187
|
-
*
|
|
188
|
-
* @property {string}
|
|
415
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
416
|
+
* courier partner scheme.
|
|
417
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
418
|
+
* partner scheme.
|
|
419
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
420
|
+
* courier partner scheme.
|
|
421
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
422
|
+
* courier partner scheme.
|
|
423
|
+
* @property {string} stage - Denotes whether the courier partner scheme is in
|
|
424
|
+
* enabled or disabled stage.
|
|
189
425
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
190
426
|
*/
|
|
191
427
|
|
|
@@ -197,29 +433,50 @@ const Joi = require("joi");
|
|
|
197
433
|
|
|
198
434
|
/**
|
|
199
435
|
* @typedef GetCountriesItems
|
|
200
|
-
* @property {string} [id]
|
|
201
|
-
* @property {string} [name]
|
|
202
|
-
* @property {string} [iso2]
|
|
203
|
-
* @property {string} [iso3]
|
|
204
|
-
* @property {string[]} [timezones]
|
|
205
|
-
*
|
|
206
|
-
* @property {
|
|
207
|
-
*
|
|
208
|
-
*
|
|
209
|
-
* @property {string} [
|
|
210
|
-
*
|
|
211
|
-
* @property {string} [
|
|
436
|
+
* @property {string} [id] - Unique identifier of the country.
|
|
437
|
+
* @property {string} [name] - Name of the country.
|
|
438
|
+
* @property {string} [iso2] - Two-letter ISO code representing the country.
|
|
439
|
+
* @property {string} [iso3] - Three-letter ISO code representing the country.
|
|
440
|
+
* @property {string[]} [timezones] - List of time zones used in the country
|
|
441
|
+
* (e.g., ["America/New_York", "America/Los_Angeles"]).
|
|
442
|
+
* @property {HierarchyItems[]} [hierarchy] - Levels within the country (e.g.,
|
|
443
|
+
* states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
|
|
444
|
+
* {"name": "City", "slug": "city"}]).
|
|
445
|
+
* @property {string} [phone_code] - International dialing code for the country
|
|
446
|
+
* (e.g., "+1").
|
|
447
|
+
* @property {string} [currency] - Indicates currency for the country (e.g., "INR").
|
|
448
|
+
* @property {string} [type] - Indicates the type of object (e.g., "country").
|
|
449
|
+
* @property {string} [latitude] - Geographical latitude of the country (e.g., "37.0902").
|
|
450
|
+
* @property {string} [longitude] - Geographical longitude of the country (e.g.,
|
|
451
|
+
* "-95.7129").
|
|
452
|
+
* @property {string} [display_name] - User-friendly version of the geographical
|
|
453
|
+
* data, which may be more descriptive or formatted differently.
|
|
454
|
+
* @property {boolean} [has_next_hierarchy] - More detailed hierarchical data is
|
|
455
|
+
* available, meaning states, cities, or other regions within the country have
|
|
456
|
+
* been populated in the system.
|
|
212
457
|
*/
|
|
213
458
|
|
|
214
459
|
/**
|
|
215
460
|
* @typedef HierarchyItems
|
|
216
|
-
* @property {string} [display_name]
|
|
217
|
-
* @property {string} [slug]
|
|
461
|
+
* @property {string} [display_name] - It represent a country display name.
|
|
462
|
+
* @property {string} [slug] - A URL-friendly version of the name, often used
|
|
463
|
+
* for referencing or querying purposes.
|
|
464
|
+
*/
|
|
465
|
+
|
|
466
|
+
/**
|
|
467
|
+
* @typedef ValidationError
|
|
468
|
+
* @property {string} message - A brief description of the error encountered.
|
|
469
|
+
* @property {string} field - The field in the request that caused the error.
|
|
470
|
+
*/
|
|
471
|
+
|
|
472
|
+
/**
|
|
473
|
+
* @typedef StandardError
|
|
474
|
+
* @property {string} message - A brief description of the error.
|
|
218
475
|
*/
|
|
219
476
|
|
|
220
477
|
class LogisticsPartnerModel {
|
|
221
|
-
/** @returns {
|
|
222
|
-
static
|
|
478
|
+
/** @returns {BulkRegionServiceabilityTatDetails} */
|
|
479
|
+
static BulkRegionServiceabilityTatDetails() {
|
|
223
480
|
return Joi.object({
|
|
224
481
|
country: Joi.string().allow("").required(),
|
|
225
482
|
region: Joi.string().allow("").required(),
|
|
@@ -227,21 +484,21 @@ class LogisticsPartnerModel {
|
|
|
227
484
|
});
|
|
228
485
|
}
|
|
229
486
|
|
|
230
|
-
/** @returns {
|
|
231
|
-
static
|
|
487
|
+
/** @returns {BulkRegionServiceabilityTatResultItemData} */
|
|
488
|
+
static BulkRegionServiceabilityTatResultItemData() {
|
|
232
489
|
return Joi.object({
|
|
233
490
|
country: Joi.string().allow(""),
|
|
234
491
|
region: Joi.string().allow(""),
|
|
235
492
|
type: Joi.string().allow(""),
|
|
236
493
|
batch_id: Joi.string().allow(""),
|
|
237
494
|
status: Joi.string().allow(""),
|
|
238
|
-
failed_records: Joi.array().items(Joi.any()),
|
|
239
|
-
file_path: Joi.string().allow(""),
|
|
495
|
+
failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
496
|
+
file_path: Joi.string().allow("").allow(null),
|
|
240
497
|
});
|
|
241
498
|
}
|
|
242
499
|
|
|
243
|
-
/** @returns {
|
|
244
|
-
static
|
|
500
|
+
/** @returns {ErrorResult} */
|
|
501
|
+
static ErrorResult() {
|
|
245
502
|
return Joi.object({
|
|
246
503
|
value: Joi.string().allow("").required(),
|
|
247
504
|
message: Joi.string().allow("").required(),
|
|
@@ -249,21 +506,19 @@ class LogisticsPartnerModel {
|
|
|
249
506
|
});
|
|
250
507
|
}
|
|
251
508
|
|
|
252
|
-
/** @returns {
|
|
253
|
-
static
|
|
509
|
+
/** @returns {FailureResult} */
|
|
510
|
+
static FailureResult() {
|
|
254
511
|
return Joi.object({
|
|
255
512
|
success: Joi.boolean().required(),
|
|
256
|
-
error: Joi.array()
|
|
257
|
-
.items(LogisticsPartnerModel.ErrorResponse())
|
|
258
|
-
.required(),
|
|
513
|
+
error: Joi.array().items(LogisticsPartnerModel.ErrorResult()).required(),
|
|
259
514
|
});
|
|
260
515
|
}
|
|
261
516
|
|
|
262
|
-
/** @returns {
|
|
263
|
-
static
|
|
517
|
+
/** @returns {BulkRegionServiceabilityTatResult} */
|
|
518
|
+
static BulkRegionServiceabilityTatResult() {
|
|
264
519
|
return Joi.object({
|
|
265
520
|
items: Joi.array().items(
|
|
266
|
-
LogisticsPartnerModel.
|
|
521
|
+
LogisticsPartnerModel.BulkRegionServiceabilityTatResultItemData()
|
|
267
522
|
),
|
|
268
523
|
page: LogisticsPartnerModel.Page(),
|
|
269
524
|
});
|
|
@@ -282,22 +537,162 @@ class LogisticsPartnerModel {
|
|
|
282
537
|
});
|
|
283
538
|
}
|
|
284
539
|
|
|
285
|
-
/** @returns {
|
|
286
|
-
static
|
|
540
|
+
/** @returns {CourierAccountUpdateDetails} */
|
|
541
|
+
static CourierAccountUpdateDetails() {
|
|
287
542
|
return Joi.object({
|
|
288
|
-
|
|
543
|
+
extension_id: Joi.string().allow("").required(),
|
|
544
|
+
scheme_id: Joi.string().allow("").required(),
|
|
545
|
+
is_self_ship: Joi.boolean().required(),
|
|
546
|
+
stage: Joi.string().allow("").required(),
|
|
547
|
+
is_own_account: Joi.boolean().required(),
|
|
548
|
+
});
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
/** @returns {RegionTatItemResult} */
|
|
552
|
+
static RegionTatItemResult() {
|
|
553
|
+
return Joi.object({
|
|
554
|
+
items: Joi.array()
|
|
555
|
+
.items(LogisticsPartnerModel.RegionTatResult())
|
|
556
|
+
.required(),
|
|
557
|
+
page: LogisticsPartnerModel.Page().required(),
|
|
558
|
+
});
|
|
559
|
+
}
|
|
560
|
+
|
|
561
|
+
/** @returns {RegionServiceabilityItemResult} */
|
|
562
|
+
static RegionServiceabilityItemResult() {
|
|
563
|
+
return Joi.object({
|
|
564
|
+
items: Joi.array()
|
|
565
|
+
.items(LogisticsPartnerModel.RegionServiceabilityResult())
|
|
566
|
+
.required(),
|
|
567
|
+
page: LogisticsPartnerModel.Page().required(),
|
|
568
|
+
});
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
/** @returns {ServiceabilityDetailsResult} */
|
|
572
|
+
static ServiceabilityDetailsResult() {
|
|
573
|
+
return Joi.object({
|
|
574
|
+
first_mile: Joi.boolean(),
|
|
575
|
+
last_mile: Joi.boolean(),
|
|
576
|
+
cod_limit: Joi.number(),
|
|
577
|
+
doorstep_return: Joi.boolean(),
|
|
578
|
+
doorstep_qc: Joi.boolean(),
|
|
579
|
+
pickup_cutoff: Joi.string().allow(""),
|
|
580
|
+
installation: Joi.boolean(),
|
|
581
|
+
id: Joi.string().allow(""),
|
|
582
|
+
});
|
|
583
|
+
}
|
|
584
|
+
|
|
585
|
+
/** @returns {ServiceabilityDetails} */
|
|
586
|
+
static ServiceabilityDetails() {
|
|
587
|
+
return Joi.object({
|
|
588
|
+
first_mile: Joi.boolean(),
|
|
589
|
+
last_mile: Joi.boolean(),
|
|
590
|
+
cod_limit: Joi.number(),
|
|
591
|
+
doorstep_return: Joi.boolean(),
|
|
592
|
+
doorstep_qc: Joi.boolean(),
|
|
593
|
+
pickup_cutoff: Joi.string().allow(""),
|
|
594
|
+
installation: Joi.boolean(),
|
|
595
|
+
});
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
/** @returns {RegionServiceabilityResult} */
|
|
599
|
+
static RegionServiceabilityResult() {
|
|
600
|
+
return Joi.object({
|
|
601
|
+
country_code: Joi.string().allow("").required(),
|
|
602
|
+
state_code: Joi.string().allow(""),
|
|
603
|
+
city_code: Joi.string().allow(""),
|
|
604
|
+
sector_code: Joi.string().allow(""),
|
|
605
|
+
pincode: Joi.string().allow(""),
|
|
606
|
+
first_mile: Joi.boolean(),
|
|
607
|
+
last_mile: Joi.boolean(),
|
|
608
|
+
cod_limit: Joi.number(),
|
|
609
|
+
doorstep_return: Joi.boolean(),
|
|
610
|
+
doorstep_qc: Joi.boolean(),
|
|
611
|
+
pickup_cutoff: Joi.string().allow(""),
|
|
612
|
+
installation: Joi.boolean(),
|
|
613
|
+
id: Joi.string().allow("").required(),
|
|
614
|
+
});
|
|
615
|
+
}
|
|
616
|
+
|
|
617
|
+
/** @returns {RegionServiceabilityDetails} */
|
|
618
|
+
static RegionServiceabilityDetails() {
|
|
619
|
+
return Joi.object({
|
|
620
|
+
country_code: Joi.string().allow("").required(),
|
|
621
|
+
state_code: Joi.string().allow(""),
|
|
622
|
+
city_code: Joi.string().allow(""),
|
|
623
|
+
sector_code: Joi.string().allow(""),
|
|
624
|
+
pincode: Joi.string().allow(""),
|
|
625
|
+
first_mile: Joi.boolean(),
|
|
626
|
+
last_mile: Joi.boolean(),
|
|
627
|
+
cod_limit: Joi.number(),
|
|
628
|
+
doorstep_return: Joi.boolean(),
|
|
629
|
+
doorstep_qc: Joi.boolean(),
|
|
630
|
+
pickup_cutoff: Joi.string().allow(""),
|
|
631
|
+
installation: Joi.boolean(),
|
|
632
|
+
});
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
/** @returns {RegionTatDetails} */
|
|
636
|
+
static RegionTatDetails() {
|
|
637
|
+
return Joi.object({
|
|
638
|
+
from_country_code: Joi.string().allow("").required(),
|
|
639
|
+
from_state_code: Joi.string().allow(""),
|
|
640
|
+
from_city_code: Joi.string().allow(""),
|
|
641
|
+
from_sector_code: Joi.string().allow(""),
|
|
642
|
+
from_pincode: Joi.string().allow(""),
|
|
643
|
+
to_country_code: Joi.string().allow("").required(),
|
|
644
|
+
to_state_code: Joi.string().allow(""),
|
|
645
|
+
to_city_code: Joi.string().allow(""),
|
|
646
|
+
to_sector_code: Joi.string().allow(""),
|
|
647
|
+
to_pincode: Joi.string().allow(""),
|
|
648
|
+
max_delivery_time: Joi.number(),
|
|
649
|
+
min_delivery_time: Joi.number(),
|
|
650
|
+
});
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
/** @returns {RegionTatUpdateDetails} */
|
|
654
|
+
static RegionTatUpdateDetails() {
|
|
655
|
+
return Joi.object({
|
|
656
|
+
max_delivery_time: Joi.number(),
|
|
657
|
+
min_delivery_time: Joi.number(),
|
|
658
|
+
});
|
|
659
|
+
}
|
|
660
|
+
|
|
661
|
+
/** @returns {RegionTatResult} */
|
|
662
|
+
static RegionTatResult() {
|
|
663
|
+
return Joi.object({
|
|
664
|
+
from_country_code: Joi.string().allow("").required(),
|
|
665
|
+
from_state_code: Joi.string().allow(""),
|
|
666
|
+
from_city_code: Joi.string().allow(""),
|
|
667
|
+
from_sector_code: Joi.string().allow(""),
|
|
668
|
+
from_pincode: Joi.string().allow(""),
|
|
669
|
+
to_country_code: Joi.string().allow("").required(),
|
|
670
|
+
to_state_code: Joi.string().allow(""),
|
|
671
|
+
to_city_code: Joi.string().allow(""),
|
|
672
|
+
to_sector_code: Joi.string().allow(""),
|
|
673
|
+
to_pincode: Joi.string().allow(""),
|
|
674
|
+
max_delivery_time: Joi.number(),
|
|
675
|
+
min_delivery_time: Joi.number(),
|
|
676
|
+
id: Joi.string().allow("").required(),
|
|
677
|
+
});
|
|
678
|
+
}
|
|
679
|
+
|
|
680
|
+
/** @returns {BulkRegionJobDetails} */
|
|
681
|
+
static BulkRegionJobDetails() {
|
|
682
|
+
return Joi.object({
|
|
683
|
+
file_path: Joi.string().allow("").allow(null),
|
|
289
684
|
country: Joi.string().allow("").required(),
|
|
290
685
|
action: Joi.string().allow("").required(),
|
|
291
686
|
region: Joi.string().allow("").required(),
|
|
292
687
|
});
|
|
293
688
|
}
|
|
294
689
|
|
|
295
|
-
/** @returns {
|
|
296
|
-
static
|
|
690
|
+
/** @returns {BulkRegionResultItemData} */
|
|
691
|
+
static BulkRegionResultItemData() {
|
|
297
692
|
return Joi.object({
|
|
298
|
-
file_path: Joi.string().allow("")
|
|
693
|
+
file_path: Joi.string().allow(""),
|
|
299
694
|
failed: Joi.number(),
|
|
300
|
-
failed_records: Joi.array().items(Joi.any()),
|
|
695
|
+
failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
301
696
|
action: Joi.string().allow("").required(),
|
|
302
697
|
batch_id: Joi.string().allow("").required(),
|
|
303
698
|
country: Joi.string().allow("").required(),
|
|
@@ -309,11 +704,11 @@ class LogisticsPartnerModel {
|
|
|
309
704
|
});
|
|
310
705
|
}
|
|
311
706
|
|
|
312
|
-
/** @returns {
|
|
313
|
-
static
|
|
707
|
+
/** @returns {BulkRegionResult} */
|
|
708
|
+
static BulkRegionResult() {
|
|
314
709
|
return Joi.object({
|
|
315
710
|
items: Joi.array()
|
|
316
|
-
.items(LogisticsPartnerModel.
|
|
711
|
+
.items(LogisticsPartnerModel.BulkRegionResultItemData())
|
|
317
712
|
.required(),
|
|
318
713
|
page: LogisticsPartnerModel.Page().required(),
|
|
319
714
|
});
|
|
@@ -331,8 +726,8 @@ class LogisticsPartnerModel {
|
|
|
331
726
|
});
|
|
332
727
|
}
|
|
333
728
|
|
|
334
|
-
/** @returns {
|
|
335
|
-
static
|
|
729
|
+
/** @returns {CourierAccountDetailsBody} */
|
|
730
|
+
static CourierAccountDetailsBody() {
|
|
336
731
|
return Joi.object({
|
|
337
732
|
extension_id: Joi.string().allow("").required(),
|
|
338
733
|
account_id: Joi.string().allow(""),
|
|
@@ -343,28 +738,26 @@ class LogisticsPartnerModel {
|
|
|
343
738
|
});
|
|
344
739
|
}
|
|
345
740
|
|
|
346
|
-
/** @returns {
|
|
347
|
-
static
|
|
741
|
+
/** @returns {CourierPartnerAccountFailureResult} */
|
|
742
|
+
static CourierPartnerAccountFailureResult() {
|
|
348
743
|
return Joi.object({
|
|
349
744
|
success: Joi.boolean().required(),
|
|
350
|
-
error: Joi.array()
|
|
351
|
-
.items(LogisticsPartnerModel.ErrorResponse())
|
|
352
|
-
.required(),
|
|
745
|
+
error: Joi.array().items(LogisticsPartnerModel.ErrorResult()).required(),
|
|
353
746
|
});
|
|
354
747
|
}
|
|
355
748
|
|
|
356
|
-
/** @returns {
|
|
357
|
-
static
|
|
749
|
+
/** @returns {CompanyCourierPartnerAccountListResult} */
|
|
750
|
+
static CompanyCourierPartnerAccountListResult() {
|
|
358
751
|
return Joi.object({
|
|
359
752
|
items: Joi.array()
|
|
360
|
-
.items(LogisticsPartnerModel.
|
|
753
|
+
.items(LogisticsPartnerModel.CourierAccountResult())
|
|
361
754
|
.required(),
|
|
362
755
|
page: LogisticsPartnerModel.Page().required(),
|
|
363
756
|
});
|
|
364
757
|
}
|
|
365
758
|
|
|
366
|
-
/** @returns {
|
|
367
|
-
static
|
|
759
|
+
/** @returns {CourierAccountResult} */
|
|
760
|
+
static CourierAccountResult() {
|
|
368
761
|
return Joi.object({
|
|
369
762
|
account_id: Joi.string().allow("").required(),
|
|
370
763
|
scheme_id: Joi.string().allow("").required(),
|
|
@@ -391,8 +784,8 @@ class LogisticsPartnerModel {
|
|
|
391
784
|
});
|
|
392
785
|
}
|
|
393
786
|
|
|
394
|
-
/** @returns {
|
|
395
|
-
static
|
|
787
|
+
/** @returns {CourierPartnerSchemeDetailsModel} */
|
|
788
|
+
static CourierPartnerSchemeDetailsModel() {
|
|
396
789
|
return Joi.object({
|
|
397
790
|
extension_id: Joi.string().allow("").required(),
|
|
398
791
|
scheme_id: Joi.string().allow(""),
|
|
@@ -428,6 +821,8 @@ class LogisticsPartnerModel {
|
|
|
428
821
|
single_pick_multi_drop: Joi.boolean(),
|
|
429
822
|
multi_pick_multi_drop: Joi.boolean(),
|
|
430
823
|
ewaybill: Joi.boolean(),
|
|
824
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
825
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
431
826
|
});
|
|
432
827
|
}
|
|
433
828
|
|
|
@@ -441,8 +836,8 @@ class LogisticsPartnerModel {
|
|
|
441
836
|
});
|
|
442
837
|
}
|
|
443
838
|
|
|
444
|
-
/** @returns {
|
|
445
|
-
static
|
|
839
|
+
/** @returns {CourierPartnerSchemeUpdateDetails} */
|
|
840
|
+
static CourierPartnerSchemeUpdateDetails() {
|
|
446
841
|
return Joi.object({
|
|
447
842
|
name: Joi.string().allow("").required(),
|
|
448
843
|
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
@@ -480,6 +875,7 @@ class LogisticsPartnerModel {
|
|
|
480
875
|
latitude: Joi.string().allow(""),
|
|
481
876
|
longitude: Joi.string().allow(""),
|
|
482
877
|
display_name: Joi.string().allow(""),
|
|
878
|
+
has_next_hierarchy: Joi.boolean(),
|
|
483
879
|
});
|
|
484
880
|
}
|
|
485
881
|
|
|
@@ -490,5 +886,20 @@ class LogisticsPartnerModel {
|
|
|
490
886
|
slug: Joi.string().allow(""),
|
|
491
887
|
});
|
|
492
888
|
}
|
|
889
|
+
|
|
890
|
+
/** @returns {ValidationError} */
|
|
891
|
+
static ValidationError() {
|
|
892
|
+
return Joi.object({
|
|
893
|
+
message: Joi.string().allow("").required(),
|
|
894
|
+
field: Joi.string().allow("").required(),
|
|
895
|
+
});
|
|
896
|
+
}
|
|
897
|
+
|
|
898
|
+
/** @returns {StandardError} */
|
|
899
|
+
static StandardError() {
|
|
900
|
+
return Joi.object({
|
|
901
|
+
message: Joi.string().allow("").required(),
|
|
902
|
+
});
|
|
903
|
+
}
|
|
493
904
|
}
|
|
494
905
|
module.exports = LogisticsPartnerModel;
|