@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +108 -1199
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -111
- package/sdk/application/Content/ContentApplicationClient.js +43 -1065
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +91 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +103 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +84 -2105
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- 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 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- 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 +157 -30
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1177 -56
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1662 -249
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +774 -162
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +141 -12
- 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 +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5060 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1985 -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 +178 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +468 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6554 -1772
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3264 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +116 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +85 -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 +122 -191
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +447 -831
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +174 -220
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +164 -199
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1233 -476
- package/sdk/platform/Content/ContentPlatformModel.js +514 -487
- 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 +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- 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 +424 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7747 -1342
- package/sdk/platform/Order/OrderPlatformModel.js +3960 -1262
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +292 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +145 -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 +132 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +681 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2458 -650
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1266 -572
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +176 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- 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 +10 -7
- 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 +795 -7
- 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/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- 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/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- 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,12 +1,12 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef UpdateZoneConfigDetails
|
|
5
5
|
* @property {string} [serviceability_type]
|
|
6
6
|
*/
|
|
7
7
|
|
|
8
8
|
/**
|
|
9
|
-
* @typedef
|
|
9
|
+
* @typedef ServiceabilityErrorResult
|
|
10
10
|
* @property {string} message
|
|
11
11
|
* @property {string} value
|
|
12
12
|
* @property {string} type
|
|
@@ -20,14 +20,14 @@ const Joi = require("joi");
|
|
|
20
20
|
*/
|
|
21
21
|
|
|
22
22
|
/**
|
|
23
|
-
* @typedef
|
|
24
|
-
* @property {
|
|
23
|
+
* @typedef ApplicationServiceabilityConfigResult
|
|
24
|
+
* @property {ServiceabilityErrorResult} [error]
|
|
25
25
|
* @property {ApplicationServiceabilityConfig} [data]
|
|
26
26
|
* @property {boolean} success
|
|
27
27
|
*/
|
|
28
28
|
|
|
29
29
|
/**
|
|
30
|
-
* @typedef
|
|
30
|
+
* @typedef EntityRegionView_Details
|
|
31
31
|
* @property {string[]} sub_type
|
|
32
32
|
* @property {string[]} [parent_id]
|
|
33
33
|
*/
|
|
@@ -49,7 +49,7 @@ const Joi = require("joi");
|
|
|
49
49
|
*/
|
|
50
50
|
|
|
51
51
|
/**
|
|
52
|
-
* @typedef
|
|
52
|
+
* @typedef getAppRegionZonesResult
|
|
53
53
|
* @property {PageSchema[]} page
|
|
54
54
|
* @property {ListViewItems[]} items
|
|
55
55
|
*/
|
|
@@ -71,7 +71,7 @@ const Joi = require("joi");
|
|
|
71
71
|
*/
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
* @typedef
|
|
74
|
+
* @typedef EntityRegionView_Result
|
|
75
75
|
* @property {EntityRegionView_Error} error
|
|
76
76
|
* @property {EntityRegionView_page} page
|
|
77
77
|
* @property {EntityRegionView_Items[]} data
|
|
@@ -123,7 +123,7 @@ const Joi = require("joi");
|
|
|
123
123
|
*/
|
|
124
124
|
|
|
125
125
|
/**
|
|
126
|
-
* @typedef
|
|
126
|
+
* @typedef ListViewResult
|
|
127
127
|
* @property {ZoneDataItem} page
|
|
128
128
|
* @property {ListViewItems[]} items
|
|
129
129
|
*/
|
|
@@ -138,7 +138,7 @@ const Joi = require("joi");
|
|
|
138
138
|
*/
|
|
139
139
|
|
|
140
140
|
/**
|
|
141
|
-
* @typedef
|
|
141
|
+
* @typedef CompanyStoreView_Result
|
|
142
142
|
* @property {CompanyStoreView_PageItems[]} page
|
|
143
143
|
* @property {Object[]} [items]
|
|
144
144
|
*/
|
|
@@ -151,8 +151,9 @@ const Joi = require("joi");
|
|
|
151
151
|
|
|
152
152
|
/**
|
|
153
153
|
* @typedef ZoneProductTypes
|
|
154
|
-
* @property {string} type
|
|
155
|
-
*
|
|
154
|
+
* @property {string} type - Denotes if the zone is applicable for all the
|
|
155
|
+
* products or specific products.
|
|
156
|
+
* @property {string[]} tags - List of product tags.
|
|
156
157
|
*/
|
|
157
158
|
|
|
158
159
|
/**
|
|
@@ -163,8 +164,8 @@ const Joi = require("joi");
|
|
|
163
164
|
|
|
164
165
|
/**
|
|
165
166
|
* @typedef ZoneMappingType
|
|
166
|
-
* @property {string} country
|
|
167
|
-
* @property {string[]} regions
|
|
167
|
+
* @property {string} country - Uid for the country.
|
|
168
|
+
* @property {string[]} regions - List of region uid for the given country.
|
|
168
169
|
*/
|
|
169
170
|
|
|
170
171
|
/**
|
|
@@ -178,86 +179,97 @@ const Joi = require("joi");
|
|
|
178
179
|
|
|
179
180
|
/**
|
|
180
181
|
* @typedef UpdateZoneData
|
|
181
|
-
* @property {string} zone_id
|
|
182
|
-
* @property {string} name
|
|
183
|
-
* @property {string} slug
|
|
184
|
-
*
|
|
185
|
-
* @property {
|
|
186
|
-
* @property {
|
|
182
|
+
* @property {string} zone_id - Unique identifier for the zone.
|
|
183
|
+
* @property {string} name - Name for the zone.
|
|
184
|
+
* @property {string} slug - A human-readable and unique identifier for the
|
|
185
|
+
* zone, derived from the name.
|
|
186
|
+
* @property {number} company_id - Company id associated with the zone.
|
|
187
|
+
* @property {boolean} is_active - A flag indicating whether the zone is active.
|
|
188
|
+
* @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
|
|
187
189
|
* @property {ZoneProductTypes} product
|
|
188
|
-
* @property {number[]} store_ids
|
|
189
|
-
* @property {string} region_type
|
|
190
|
-
* @property {ZoneMappingType[]} mapping
|
|
190
|
+
* @property {number[]} store_ids - A list of store identifiers associated with the zone.
|
|
191
|
+
* @property {string} region_type - Type of region that belongs in the zone.
|
|
192
|
+
* @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
|
|
191
193
|
*/
|
|
192
194
|
|
|
193
195
|
/**
|
|
194
|
-
* @typedef
|
|
196
|
+
* @typedef ZoneUpdateDetails
|
|
195
197
|
* @property {string} identifier
|
|
196
198
|
* @property {UpdateZoneData} data
|
|
197
199
|
*/
|
|
198
200
|
|
|
199
201
|
/**
|
|
200
|
-
* @typedef
|
|
202
|
+
* @typedef ZoneSuccessResult
|
|
201
203
|
* @property {number} status_code
|
|
202
204
|
* @property {boolean} success
|
|
203
205
|
*/
|
|
204
206
|
|
|
205
207
|
/**
|
|
206
208
|
* @typedef GetZoneDataViewItems
|
|
207
|
-
* @property {string} zone_id
|
|
208
|
-
* @property {string} name
|
|
209
|
-
* @property {string} slug
|
|
210
|
-
*
|
|
211
|
-
* @property {
|
|
212
|
-
* @property {
|
|
209
|
+
* @property {string} zone_id - The unique identifier for the zone.
|
|
210
|
+
* @property {string} name - The name of the zone for easy identification.
|
|
211
|
+
* @property {string} slug - A URL-friendly version of the zone’s name, used for
|
|
212
|
+
* routing or linking.
|
|
213
|
+
* @property {number} [company_id] - The ID of the company associated with this zone.
|
|
214
|
+
* @property {boolean} is_active - A flag indicating whether the zone is active
|
|
215
|
+
* (true) or inactive (false).
|
|
216
|
+
* @property {GetZoneDataViewChannels[]} channels - A list of channels available
|
|
217
|
+
* within this zone.
|
|
213
218
|
* @property {ZoneProductTypes} product
|
|
214
|
-
* @property {number[]} store_ids
|
|
215
|
-
* @property {string} [region_type]
|
|
216
|
-
* @property {ZoneMappingType[]} mapping
|
|
217
|
-
*
|
|
219
|
+
* @property {number[]} store_ids - A collection of store IDs linked to this zone.
|
|
220
|
+
* @property {string} [region_type] - The type of region the zone represents.
|
|
221
|
+
* @property {ZoneMappingType[]} mapping - A list of mappings defining
|
|
222
|
+
* relationships between this zone and other entities.
|
|
223
|
+
* @property {string} [assignment_preference] - The preferred method for
|
|
224
|
+
* assigning stores or products to the zone.
|
|
225
|
+
* @property {number} stores_count - The total number of stores assigned to this zone.
|
|
218
226
|
*/
|
|
219
227
|
|
|
220
228
|
/**
|
|
221
|
-
* @typedef
|
|
229
|
+
* @typedef GetSingleZoneDataViewResult
|
|
222
230
|
* @property {GetZoneDataViewItems} data
|
|
223
231
|
*/
|
|
224
232
|
|
|
225
233
|
/**
|
|
226
234
|
* @typedef GetZoneByIdSchema
|
|
227
|
-
* @property {string} zone_id
|
|
228
|
-
* @property {string} name
|
|
229
|
-
* @property {string} slug
|
|
230
|
-
*
|
|
231
|
-
* @property {
|
|
232
|
-
* @property {
|
|
235
|
+
* @property {string} zone_id - Unique identifier for the zone.
|
|
236
|
+
* @property {string} name - Name for the zone.
|
|
237
|
+
* @property {string} slug - A human-readable and unique identifier for the
|
|
238
|
+
* zone, derived from the name.
|
|
239
|
+
* @property {number} [company_id] - Company id associated with the zone.
|
|
240
|
+
* @property {boolean} is_active - A flag indicating whether the zone is active.
|
|
241
|
+
* @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
|
|
233
242
|
* @property {ZoneProductTypes} product
|
|
234
|
-
* @property {number[]} store_ids
|
|
235
|
-
* @property {string} region_type
|
|
243
|
+
* @property {number[]} store_ids - A list of store identifiers associated with the zone.
|
|
244
|
+
* @property {string} region_type - Type of region that belongs in the zone.
|
|
236
245
|
* @property {ZoneMappingDetailType[]} mapping - Country to region mapping for the zone.
|
|
246
|
+
* @property {number} [stores_count]
|
|
237
247
|
*/
|
|
238
248
|
|
|
239
249
|
/**
|
|
240
250
|
* @typedef CreateZoneData
|
|
241
|
-
* @property {string} name
|
|
242
|
-
* @property {string} slug
|
|
243
|
-
*
|
|
244
|
-
* @property {
|
|
245
|
-
*
|
|
246
|
-
* @property {
|
|
247
|
-
* @property {
|
|
248
|
-
* @property {
|
|
249
|
-
* @property {
|
|
251
|
+
* @property {string} name - Name of the zone.
|
|
252
|
+
* @property {string} slug - A human-readable and unique identifier for the
|
|
253
|
+
* zone, derived from the name.
|
|
254
|
+
* @property {number} company_id - Unique identifier of the company for which
|
|
255
|
+
* the zone is created.
|
|
256
|
+
* @property {boolean} is_active - A flag indicating whether the zone is active.
|
|
257
|
+
* @property {GetZoneDataViewChannels[]} channels - Channels for which the zone is active.
|
|
258
|
+
* @property {number[]} store_ids - A list of store identifiers associated with the zone.
|
|
259
|
+
* @property {string} region_type - Type of region that belongs in the zone.
|
|
260
|
+
* @property {ZoneMappingType[]} mapping - Country to region mapping for the zone.
|
|
261
|
+
* @property {ZoneProductTypes} [product]
|
|
250
262
|
*/
|
|
251
263
|
|
|
252
264
|
/**
|
|
253
|
-
* @typedef
|
|
254
|
-
* @property {number} status_code
|
|
265
|
+
* @typedef ZoneResult
|
|
266
|
+
* @property {number} [status_code]
|
|
255
267
|
* @property {string} zone_id
|
|
256
268
|
* @property {boolean} success
|
|
257
269
|
*/
|
|
258
270
|
|
|
259
271
|
/**
|
|
260
|
-
* @typedef
|
|
272
|
+
* @typedef GetZoneFromPincodeViewDetails
|
|
261
273
|
* @property {string} country
|
|
262
274
|
* @property {string} pincode
|
|
263
275
|
*/
|
|
@@ -274,19 +286,19 @@ const Joi = require("joi");
|
|
|
274
286
|
*/
|
|
275
287
|
|
|
276
288
|
/**
|
|
277
|
-
* @typedef
|
|
289
|
+
* @typedef GetZoneFromPincodeViewResult
|
|
278
290
|
* @property {string} serviceability_type
|
|
279
291
|
* @property {Zone[]} zones
|
|
280
292
|
*/
|
|
281
293
|
|
|
282
294
|
/**
|
|
283
|
-
* @typedef
|
|
295
|
+
* @typedef GetZoneFromApplicationIdViewResult
|
|
284
296
|
* @property {ZoneDataItem[]} page
|
|
285
297
|
* @property {ListViewItems[]} items
|
|
286
298
|
*/
|
|
287
299
|
|
|
288
300
|
/**
|
|
289
|
-
* @typedef
|
|
301
|
+
* @typedef ServiceabilityPageResult
|
|
290
302
|
* @property {string} [type]
|
|
291
303
|
* @property {boolean} [has_next]
|
|
292
304
|
* @property {number} [item_total]
|
|
@@ -301,37 +313,37 @@ const Joi = require("joi");
|
|
|
301
313
|
*/
|
|
302
314
|
|
|
303
315
|
/**
|
|
304
|
-
* @typedef
|
|
316
|
+
* @typedef ManagerResult
|
|
305
317
|
* @property {string} [email]
|
|
306
318
|
* @property {MobileNo} [mobile_no]
|
|
307
319
|
* @property {string} [name]
|
|
308
320
|
*/
|
|
309
321
|
|
|
310
322
|
/**
|
|
311
|
-
* @typedef
|
|
323
|
+
* @typedef ModifiedByResult
|
|
312
324
|
* @property {string} [username]
|
|
313
325
|
* @property {string} [user_id]
|
|
314
326
|
*/
|
|
315
327
|
|
|
316
328
|
/**
|
|
317
|
-
* @typedef
|
|
329
|
+
* @typedef IntegrationTypeResult
|
|
318
330
|
* @property {string} [inventory]
|
|
319
331
|
* @property {string} [order]
|
|
320
332
|
*/
|
|
321
333
|
|
|
322
334
|
/**
|
|
323
|
-
* @typedef
|
|
335
|
+
* @typedef ProductReturnConfigResult
|
|
324
336
|
* @property {boolean} [on_same_store]
|
|
325
337
|
*/
|
|
326
338
|
|
|
327
339
|
/**
|
|
328
|
-
* @typedef
|
|
340
|
+
* @typedef ContactNumberResult
|
|
329
341
|
* @property {string} [number]
|
|
330
342
|
* @property {number} [country_code]
|
|
331
343
|
*/
|
|
332
344
|
|
|
333
345
|
/**
|
|
334
|
-
* @typedef
|
|
346
|
+
* @typedef AddressResult
|
|
335
347
|
* @property {string} [city]
|
|
336
348
|
* @property {string} [address1]
|
|
337
349
|
* @property {number} [pincode]
|
|
@@ -344,29 +356,29 @@ const Joi = require("joi");
|
|
|
344
356
|
*/
|
|
345
357
|
|
|
346
358
|
/**
|
|
347
|
-
* @typedef
|
|
359
|
+
* @typedef CreatedByResult
|
|
348
360
|
* @property {string} [username]
|
|
349
361
|
* @property {string} [user_id]
|
|
350
362
|
*/
|
|
351
363
|
|
|
352
364
|
/**
|
|
353
|
-
* @typedef
|
|
365
|
+
* @typedef EwayBillResult
|
|
354
366
|
* @property {boolean} [enabled]
|
|
355
367
|
*/
|
|
356
368
|
|
|
357
369
|
/**
|
|
358
|
-
* @typedef
|
|
370
|
+
* @typedef EinvoiceResult
|
|
359
371
|
* @property {boolean} [enabled]
|
|
360
372
|
*/
|
|
361
373
|
|
|
362
374
|
/**
|
|
363
|
-
* @typedef
|
|
364
|
-
* @property {
|
|
365
|
-
* @property {
|
|
375
|
+
* @typedef GstCredentialsResult
|
|
376
|
+
* @property {EwayBillResult} [e_waybill]
|
|
377
|
+
* @property {EinvoiceResult} [e_invoice]
|
|
366
378
|
*/
|
|
367
379
|
|
|
368
380
|
/**
|
|
369
|
-
* @typedef
|
|
381
|
+
* @typedef WarningsResult
|
|
370
382
|
* @property {string} [store_address]
|
|
371
383
|
*/
|
|
372
384
|
|
|
@@ -377,7 +389,7 @@ const Joi = require("joi");
|
|
|
377
389
|
*/
|
|
378
390
|
|
|
379
391
|
/**
|
|
380
|
-
* @typedef
|
|
392
|
+
* @typedef TimmingResult
|
|
381
393
|
* @property {boolean} [open]
|
|
382
394
|
* @property {string} [weekday]
|
|
383
395
|
* @property {OpeningClosing} [closing]
|
|
@@ -385,7 +397,7 @@ const Joi = require("joi");
|
|
|
385
397
|
*/
|
|
386
398
|
|
|
387
399
|
/**
|
|
388
|
-
* @typedef
|
|
400
|
+
* @typedef DocumentsResult
|
|
389
401
|
* @property {string} [legal_name]
|
|
390
402
|
* @property {string} [value]
|
|
391
403
|
* @property {string} [type]
|
|
@@ -407,109 +419,119 @@ const Joi = require("joi");
|
|
|
407
419
|
*/
|
|
408
420
|
|
|
409
421
|
/**
|
|
410
|
-
* @typedef
|
|
422
|
+
* @typedef LogisticsResult
|
|
411
423
|
* @property {boolean} [override]
|
|
412
424
|
* @property {Dp} [dp]
|
|
413
425
|
*/
|
|
414
426
|
|
|
415
427
|
/**
|
|
416
|
-
* @typedef
|
|
428
|
+
* @typedef ItemResult
|
|
417
429
|
* @property {string} [created_on]
|
|
418
|
-
* @property {
|
|
419
|
-
* @property {
|
|
420
|
-
* @property {
|
|
430
|
+
* @property {ManagerResult} [manager]
|
|
431
|
+
* @property {ModifiedByResult} [modified_by]
|
|
432
|
+
* @property {IntegrationTypeResult} [integration_type]
|
|
421
433
|
* @property {string} [verified_on]
|
|
422
|
-
* @property {
|
|
423
|
-
* @property {
|
|
424
|
-
* @property {
|
|
434
|
+
* @property {ProductReturnConfigResult} [product_return_config]
|
|
435
|
+
* @property {ContactNumberResult[]} [contact_numbers]
|
|
436
|
+
* @property {ModifiedByResult} [verified_by]
|
|
425
437
|
* @property {string} [stage]
|
|
426
|
-
* @property {
|
|
438
|
+
* @property {AddressResult} [address]
|
|
427
439
|
* @property {string} [modified_on]
|
|
428
|
-
* @property {
|
|
429
|
-
* @property {
|
|
440
|
+
* @property {CreatedByResult} [created_by]
|
|
441
|
+
* @property {GstCredentialsResult} [gst_credentials]
|
|
430
442
|
* @property {string} [display_name]
|
|
431
443
|
* @property {number} [company_id]
|
|
432
444
|
* @property {number} [uid]
|
|
433
|
-
* @property {Object} [_custom_json]
|
|
445
|
+
* @property {Object} [_custom_json] - Custom JSON for internal usage
|
|
434
446
|
* @property {string} [code]
|
|
435
|
-
* @property {
|
|
447
|
+
* @property {WarningsResult} [warnings]
|
|
436
448
|
* @property {string} [name]
|
|
437
|
-
* @property {
|
|
438
|
-
* @property {
|
|
449
|
+
* @property {TimmingResult[]} [timing]
|
|
450
|
+
* @property {DocumentsResult[]} [documents]
|
|
439
451
|
* @property {string} [store_type]
|
|
440
452
|
* @property {string} [sub_type]
|
|
441
453
|
* @property {number} [company]
|
|
442
454
|
* @property {string} [_cls]
|
|
443
|
-
* @property {
|
|
455
|
+
* @property {LogisticsResult} [logistics]
|
|
444
456
|
* @property {string[]} [notification_emails]
|
|
445
457
|
*/
|
|
446
458
|
|
|
447
459
|
/**
|
|
448
|
-
* @typedef
|
|
449
|
-
* @property {
|
|
450
|
-
* @property {
|
|
460
|
+
* @typedef GetStoresViewResult
|
|
461
|
+
* @property {ServiceabilityPageResult} page
|
|
462
|
+
* @property {ItemResult[]} [items]
|
|
451
463
|
*/
|
|
452
464
|
|
|
453
465
|
/**
|
|
454
466
|
* @typedef PincodeMopData
|
|
455
|
-
* @property {number[]} pincodes
|
|
456
|
-
* @property {string} country
|
|
457
|
-
* @property {string} action
|
|
467
|
+
* @property {number[]} pincodes - A list of pincodes.
|
|
468
|
+
* @property {string} country - Name of the country.
|
|
469
|
+
* @property {string} action - Denotes wether to activate or deavtivate pincodes
|
|
470
|
+
* for COD mode of payment.
|
|
458
471
|
*/
|
|
459
472
|
|
|
460
473
|
/**
|
|
461
|
-
* @typedef
|
|
462
|
-
* @property {number} pincode
|
|
463
|
-
* @property {string} channel_id
|
|
464
|
-
* @property {string} country
|
|
465
|
-
* @property {boolean} is_active
|
|
474
|
+
* @typedef PincodeMopUpdateResult
|
|
475
|
+
* @property {number} pincode - Pincode of the region.
|
|
476
|
+
* @property {string} channel_id - Unique identifier of the sales channel.
|
|
477
|
+
* @property {string} country - Country name.
|
|
478
|
+
* @property {boolean} is_active - Denotes whether the pincode mode of payment
|
|
479
|
+
* is active or not.
|
|
466
480
|
*/
|
|
467
481
|
|
|
468
482
|
/**
|
|
469
|
-
* @typedef
|
|
470
|
-
* @property {boolean} success
|
|
471
|
-
* @property {number} status_code
|
|
472
|
-
* @property {string} batch_id
|
|
473
|
-
* @property {string} country
|
|
474
|
-
* @property {string} action
|
|
475
|
-
*
|
|
476
|
-
* @property {
|
|
483
|
+
* @typedef PincodeMOPResult
|
|
484
|
+
* @property {boolean} success - Denotes if the action was successful or not.
|
|
485
|
+
* @property {number} status_code - Status code for the response.
|
|
486
|
+
* @property {string} batch_id - Unique identifier identifying the perticular request.
|
|
487
|
+
* @property {string} country - Name of the country.
|
|
488
|
+
* @property {string} action - Denotes wether to activate or deavtivate pincodes
|
|
489
|
+
* for COD mode of payment.
|
|
490
|
+
* @property {number[]} [pincodes] - List of pincodes.
|
|
491
|
+
* @property {PincodeMopUpdateResult[]} [updated_pincodes] - Details of the
|
|
492
|
+
* updated pincodes.
|
|
477
493
|
*/
|
|
478
494
|
|
|
479
495
|
/**
|
|
480
496
|
* @typedef CommonError
|
|
481
|
-
* @property {string} [status_code]
|
|
497
|
+
* @property {string} [status_code] - Status code for the error.
|
|
482
498
|
* @property {Object} [error]
|
|
483
|
-
* @property {string} [success]
|
|
499
|
+
* @property {string} [success] - Whether operation was successful.
|
|
484
500
|
*/
|
|
485
501
|
|
|
486
502
|
/**
|
|
487
503
|
* @typedef PincodeMopBulkData
|
|
488
|
-
* @property {string} batch_id
|
|
489
|
-
* @property {string} s3_url
|
|
504
|
+
* @property {string} batch_id - Unique identifier for the request.
|
|
505
|
+
* @property {string} s3_url - CDN url for the uploaded file.
|
|
490
506
|
*/
|
|
491
507
|
|
|
492
508
|
/**
|
|
493
|
-
* @typedef
|
|
509
|
+
* @typedef PincodeBulkViewResult
|
|
494
510
|
* @property {string} batch_id
|
|
495
|
-
* @property {string} s3_url
|
|
511
|
+
* @property {string} s3_url - CDN url for the uploaded file.
|
|
496
512
|
*/
|
|
497
513
|
|
|
498
514
|
/**
|
|
499
|
-
* @typedef
|
|
500
|
-
* @property {string} [country]
|
|
501
|
-
* @property {boolean} [is_active]
|
|
502
|
-
* @property {number} [pincode]
|
|
515
|
+
* @typedef PincodeCodStatusListingDetails
|
|
516
|
+
* @property {string} [country] - Name of the country.
|
|
517
|
+
* @property {boolean} [is_active] - Search based on the active or inactive flag.
|
|
518
|
+
* @property {number} [pincode] - Search based on the pincode.
|
|
503
519
|
* @property {number} [current]
|
|
504
520
|
* @property {number} [page_size]
|
|
505
521
|
*/
|
|
506
522
|
|
|
507
523
|
/**
|
|
508
|
-
* @typedef
|
|
509
|
-
* @property {
|
|
510
|
-
* @property {
|
|
511
|
-
|
|
512
|
-
|
|
524
|
+
* @typedef PincodeCodStatusItem
|
|
525
|
+
* @property {boolean} [active] - Denoted if the pincode is active or not.
|
|
526
|
+
* @property {string} [pincode] - Name of the pincode.
|
|
527
|
+
*/
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* @typedef PincodeCodStatusListingResult
|
|
531
|
+
* @property {string} country - Name of the country.
|
|
532
|
+
* @property {PincodeCodStatusListingResult[]} data - List of pincode details.
|
|
533
|
+
* @property {boolean} success - Denotes if the request was successful or not.
|
|
534
|
+
* @property {Error[]} [errors] - List of error object in case of unsuccessful response.
|
|
513
535
|
* @property {PincodeCodStatusListingPage} page
|
|
514
536
|
* @property {PincodeCodStatusListingSummary} summary
|
|
515
537
|
*/
|
|
@@ -532,14 +554,14 @@ const Joi = require("joi");
|
|
|
532
554
|
|
|
533
555
|
/**
|
|
534
556
|
* @typedef PincodeCodStatusListingSummary
|
|
535
|
-
* @property {number} total_active_pincodes
|
|
536
|
-
* @property {number} total_inactive_pincodes
|
|
557
|
+
* @property {number} total_active_pincodes - Count of the total active pincodes.
|
|
558
|
+
* @property {number} total_inactive_pincodes - Count of the total inactive pincodes.
|
|
537
559
|
*/
|
|
538
560
|
|
|
539
561
|
/**
|
|
540
|
-
* @typedef
|
|
541
|
-
* @property {string} entity_type
|
|
542
|
-
* @property {string} [file_name]
|
|
562
|
+
* @typedef PincodeMopUpdateAuditHistoryDetails
|
|
563
|
+
* @property {string} entity_type - Type of the entity requested.
|
|
564
|
+
* @property {string} [file_name] - Name of the file.
|
|
543
565
|
*/
|
|
544
566
|
|
|
545
567
|
/**
|
|
@@ -552,22 +574,23 @@ const Joi = require("joi");
|
|
|
552
574
|
*/
|
|
553
575
|
|
|
554
576
|
/**
|
|
555
|
-
* @typedef
|
|
556
|
-
* @property {string} [batch_id]
|
|
557
|
-
* @property {string} [entity_type]
|
|
558
|
-
* @property {string} [error_file_s3_url]
|
|
559
|
-
* @property {string} [s3_url]
|
|
560
|
-
* @property {string} [file_name]
|
|
577
|
+
* @typedef PincodeMopUpdateAuditHistoryResult
|
|
578
|
+
* @property {string} [batch_id] - Uniquie identifier of the request.
|
|
579
|
+
* @property {string} [entity_type] - Type of the entity requested.
|
|
580
|
+
* @property {string} [error_file_s3_url] - URL for the error file.
|
|
581
|
+
* @property {string} [s3_url] - CDN url for the file uploaded.
|
|
582
|
+
* @property {string} [file_name] - Name of the file.
|
|
561
583
|
* @property {string} [updated_at]
|
|
562
584
|
* @property {string} [updated_by]
|
|
563
|
-
* @property {boolean} [success]
|
|
585
|
+
* @property {boolean} [success] - Denotes if the request was successfully processed.
|
|
564
586
|
*/
|
|
565
587
|
|
|
566
588
|
/**
|
|
567
|
-
* @typedef
|
|
568
|
-
* @property {string} [entity_type]
|
|
589
|
+
* @typedef PincodeMopUpdateAuditHistoryResultData
|
|
590
|
+
* @property {string} [entity_type] - Type of the entity requested.
|
|
569
591
|
* @property {PincodeMopUpdateAuditHistoryPaging} page
|
|
570
|
-
* @property {
|
|
592
|
+
* @property {PincodeMopUpdateAuditHistoryResult[]} data - History records of
|
|
593
|
+
* the uploaded files.
|
|
571
594
|
*/
|
|
572
595
|
|
|
573
596
|
/**
|
|
@@ -598,37 +621,53 @@ const Joi = require("joi");
|
|
|
598
621
|
* @property {SchemeRulesFeatures} [feature]
|
|
599
622
|
*/
|
|
600
623
|
|
|
624
|
+
/**
|
|
625
|
+
* @typedef CourierAccountUpdateDetails
|
|
626
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
627
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
628
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
629
|
+
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
630
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
631
|
+
* account or not.
|
|
632
|
+
*/
|
|
633
|
+
|
|
601
634
|
/**
|
|
602
635
|
* @typedef CourierAccount
|
|
603
|
-
* @property {
|
|
604
|
-
* @property {string}
|
|
605
|
-
* @property {string}
|
|
606
|
-
*
|
|
607
|
-
* @property {string}
|
|
608
|
-
* @property {boolean}
|
|
636
|
+
* @property {number} company_id - Company id associated with the account.
|
|
637
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
638
|
+
* @property {string} account_id - Unique identifier of courier partner scheme
|
|
639
|
+
* and company id combination.
|
|
640
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
641
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
642
|
+
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
643
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
644
|
+
* account or not.
|
|
645
|
+
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
609
646
|
*/
|
|
610
647
|
|
|
611
648
|
/**
|
|
612
|
-
* @typedef
|
|
613
|
-
* @property {string} extension_id
|
|
614
|
-
* @property {string} [account_id]
|
|
615
|
-
*
|
|
616
|
-
* @property {
|
|
617
|
-
* @property {
|
|
618
|
-
* @property {
|
|
649
|
+
* @typedef CourierAccountDetailsBody
|
|
650
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
651
|
+
* @property {string} [account_id] - Unique identifier of courier partner scheme
|
|
652
|
+
* and company id combination.
|
|
653
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
654
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
655
|
+
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
656
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
657
|
+
* account or not.
|
|
619
658
|
*/
|
|
620
659
|
|
|
621
660
|
/**
|
|
622
|
-
* @typedef
|
|
623
|
-
* @property {string} value
|
|
624
|
-
* @property {string} message
|
|
625
|
-
* @property {string} type
|
|
661
|
+
* @typedef ErrorResult
|
|
662
|
+
* @property {string} value - Fields containing the error.
|
|
663
|
+
* @property {string} message - Description of the error.
|
|
664
|
+
* @property {string} type - Type of the error.
|
|
626
665
|
*/
|
|
627
666
|
|
|
628
667
|
/**
|
|
629
|
-
* @typedef
|
|
630
|
-
* @property {boolean} success
|
|
631
|
-
* @property {
|
|
668
|
+
* @typedef CourierPartnerAccountFailureResult
|
|
669
|
+
* @property {boolean} success - Denotes whether the request is a success or failure.
|
|
670
|
+
* @property {ErrorResult[]} error
|
|
632
671
|
*/
|
|
633
672
|
|
|
634
673
|
/**
|
|
@@ -643,33 +682,40 @@ const Joi = require("joi");
|
|
|
643
682
|
*/
|
|
644
683
|
|
|
645
684
|
/**
|
|
646
|
-
* @typedef
|
|
647
|
-
* @property {string}
|
|
648
|
-
*
|
|
649
|
-
* @property {
|
|
650
|
-
* @property {
|
|
685
|
+
* @typedef CourierPartnerRuleCPListResult
|
|
686
|
+
* @property {string} account_id - Unique identifier of courier partner scheme
|
|
687
|
+
* and company id combination.
|
|
688
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
689
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
690
|
+
* @property {Object} [scheme_rules] - Denotes the scheme rules associated with
|
|
691
|
+
* the courier partner account.
|
|
651
692
|
*/
|
|
652
693
|
|
|
653
694
|
/**
|
|
654
|
-
* @typedef
|
|
655
|
-
* @property {boolean}
|
|
656
|
-
*
|
|
657
|
-
* @property {
|
|
658
|
-
* @property {
|
|
659
|
-
* @property {
|
|
660
|
-
* @property {
|
|
661
|
-
* @property {
|
|
662
|
-
*
|
|
663
|
-
* @property {string}
|
|
664
|
-
* @property {
|
|
665
|
-
*
|
|
666
|
-
* @property {
|
|
695
|
+
* @typedef CourierPartnerRuleResult
|
|
696
|
+
* @property {boolean} is_active - Denotes whether the given courier partner
|
|
697
|
+
* rule is inactive or active.
|
|
698
|
+
* @property {string} application_id - Unique identifier of the sales channel.
|
|
699
|
+
* @property {number} company_id - Unique identifier of the company.
|
|
700
|
+
* @property {CourierPartnerRuleConditions} conditions
|
|
701
|
+
* @property {string[]} sort - Sort Strategy of the courier partners.
|
|
702
|
+
* @property {Object} [created_by] - The Fynd account used to create the courier
|
|
703
|
+
* partner rule.
|
|
704
|
+
* @property {string} id - Unique identifier of the courier partner rule.
|
|
705
|
+
* @property {Object} [modified_by] - The Fynd account used to modify the
|
|
706
|
+
* courier partner rule.
|
|
707
|
+
* @property {string} [modified_on] - The datetime at which courier partner rule
|
|
708
|
+
* is modified.
|
|
709
|
+
* @property {string} name - Name for the courier partner rule.
|
|
710
|
+
* @property {string} type - The type of the rule.
|
|
711
|
+
* @property {CourierPartnerRuleCPListResult[]} [cp_list]
|
|
667
712
|
*/
|
|
668
713
|
|
|
669
714
|
/**
|
|
670
715
|
* @typedef CourierPartnerList
|
|
671
|
-
* @property {string} extension_id
|
|
672
|
-
* @property {string} account_id
|
|
716
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
717
|
+
* @property {string} account_id - Unique identifier of courier partner scheme
|
|
718
|
+
* and company id combination.
|
|
673
719
|
*/
|
|
674
720
|
|
|
675
721
|
/**
|
|
@@ -678,7 +724,7 @@ const Joi = require("joi");
|
|
|
678
724
|
* @property {string} [sub_type]
|
|
679
725
|
* @property {string} [name]
|
|
680
726
|
* @property {string} [display_name]
|
|
681
|
-
* @property {string} [parent_id]
|
|
727
|
+
* @property {string[]} [parent_id]
|
|
682
728
|
* @property {string[]} [parent_ids]
|
|
683
729
|
*/
|
|
684
730
|
|
|
@@ -720,98 +766,189 @@ const Joi = require("joi");
|
|
|
720
766
|
|
|
721
767
|
/**
|
|
722
768
|
* @typedef CourierPartnerRule
|
|
723
|
-
* @property {boolean} is_active
|
|
724
|
-
*
|
|
725
|
-
* @property {
|
|
769
|
+
* @property {boolean} is_active - Denotes whether the given courier partner
|
|
770
|
+
* rule is inactive or active.
|
|
771
|
+
* @property {CourierPartnerList[]} [cp_list] - A list of courier partners.
|
|
772
|
+
* @property {string} name - Name for the courier partner rule.
|
|
726
773
|
* @property {CourierPartnerRuleConditions} conditions
|
|
727
|
-
* @property {string[]} sort
|
|
774
|
+
* @property {string[]} sort - Sort Strategy for the courier partners.
|
|
775
|
+
* @property {string} [type] - Denotes the type of the rule.
|
|
728
776
|
*/
|
|
729
777
|
|
|
730
778
|
/**
|
|
731
|
-
* @typedef
|
|
779
|
+
* @typedef FailureResult
|
|
732
780
|
* @property {boolean} success
|
|
733
|
-
* @property {
|
|
781
|
+
* @property {ErrorResult[]} error
|
|
734
782
|
*/
|
|
735
783
|
|
|
736
784
|
/**
|
|
737
|
-
* @typedef
|
|
738
|
-
* @property {
|
|
785
|
+
* @typedef CourierPartnerRulesListResult
|
|
786
|
+
* @property {CourierPartnerRuleResult[]} items
|
|
739
787
|
* @property {Page} page
|
|
740
788
|
*/
|
|
741
789
|
|
|
790
|
+
/**
|
|
791
|
+
* @typedef ShipmentsArticles
|
|
792
|
+
* @property {number} [item_id] - Unique identifier of the item.
|
|
793
|
+
* @property {number} [category_id] - Unique identifier of the category.
|
|
794
|
+
* @property {number} [brand_id] - Unique identifier of the brand.
|
|
795
|
+
* @property {number} [department_id] - Unique identifier of the department.
|
|
796
|
+
* @property {string[]} [tags] - Tags associated with the item.
|
|
797
|
+
*/
|
|
798
|
+
|
|
799
|
+
/**
|
|
800
|
+
* @typedef ShipmentDimension
|
|
801
|
+
* @property {number} height - Height of the shipment in centimeters.
|
|
802
|
+
* @property {number} length - Length of the shipment in centimeters.
|
|
803
|
+
* @property {number} width - Width of the shipment in centimeters.
|
|
804
|
+
*/
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* @typedef Shipments
|
|
808
|
+
* @property {string} [id] - Unique identifier of the shipment.
|
|
809
|
+
* @property {number} [location_id] - Unique identifier of the selling location.
|
|
810
|
+
* @property {string[]} [location_tags] - Tags associated with the selling location.
|
|
811
|
+
* @property {number} [shipment_weight] - Weight of the shipment.
|
|
812
|
+
* @property {number} [shipment_volumetric_weight] - Volumetric weight of the shipment.
|
|
813
|
+
* @property {number} [shipment_cost] - Total Cost of the shipment.
|
|
814
|
+
* @property {ShipmentDimension} [shipment_dimension]
|
|
815
|
+
* @property {string[]} [courier_partner_schemes] - A List of courier schemes.
|
|
816
|
+
* @property {ShipmentsArticles[]} [articles] - List of articles in the shipment.
|
|
817
|
+
*/
|
|
818
|
+
|
|
819
|
+
/**
|
|
820
|
+
* @typedef ShipmentCourierPartnerDetails
|
|
821
|
+
* @property {ShipmentsCourierPartnersServiceability} from_location
|
|
822
|
+
* @property {ShipmentsCourierPartnersServiceability} to_location
|
|
823
|
+
* @property {Shipments[]} [shipments] - List of shipments.
|
|
824
|
+
* @property {string} [journey] - Journey type of the shipment forward or return.
|
|
825
|
+
* @property {string} [payment_mode] - Payment mode opted for the shipment.
|
|
826
|
+
*/
|
|
827
|
+
|
|
828
|
+
/**
|
|
829
|
+
* @typedef CourierPartnerPromise
|
|
830
|
+
* @property {string} min - The earliest possible timestamp.
|
|
831
|
+
* @property {string} max - The latest possible timestamp.
|
|
832
|
+
*/
|
|
833
|
+
|
|
834
|
+
/**
|
|
835
|
+
* @typedef CourierPartners
|
|
836
|
+
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
837
|
+
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
838
|
+
* @property {string} [name] - Name of the courier partner.
|
|
839
|
+
* @property {CourierPartnerPromise} [delivery_promise]
|
|
840
|
+
*/
|
|
841
|
+
|
|
842
|
+
/**
|
|
843
|
+
* @typedef ShipmentCourierPartners
|
|
844
|
+
* @property {string} [id] - Unique identifier of the shipment.
|
|
845
|
+
* @property {CourierPartners[]} [courier_partners] - Courier partners of the shipment.
|
|
846
|
+
*/
|
|
847
|
+
|
|
848
|
+
/**
|
|
849
|
+
* @typedef ShipmentCourierPartnerResult
|
|
850
|
+
* @property {CourierPartners[]} [courier_partners]
|
|
851
|
+
* @property {ShipmentCourierPartners[]} [shipments]
|
|
852
|
+
*/
|
|
853
|
+
|
|
854
|
+
/**
|
|
855
|
+
* @typedef ShipmentsCourierPartnersServiceability
|
|
856
|
+
* @property {string} [pincode] - Postal code or PIN code of the address area.
|
|
857
|
+
* @property {string} [sector_code] - Specifies the sector or district code of
|
|
858
|
+
* the address if applicable.
|
|
859
|
+
* @property {string} [state_code] - Indicates the state or province code of the address.
|
|
860
|
+
* @property {string} [city_code] - Denote the city or municipality code of the address.
|
|
861
|
+
* @property {string} country_code - ISO2 code for the country of the address.
|
|
862
|
+
*/
|
|
863
|
+
|
|
742
864
|
/**
|
|
743
865
|
* @typedef CompanyConfig
|
|
744
|
-
* @property {string[]} rule_ids
|
|
745
|
-
* @property {string[]} sort
|
|
746
|
-
* @property {
|
|
866
|
+
* @property {string[]} rule_ids - A list for courier partner rules.
|
|
867
|
+
* @property {string[]} sort - Sort strategy for the courier partners.
|
|
868
|
+
* @property {string} [logistics_as_actual] - Depicts if the courier partner
|
|
869
|
+
* rule configuration plan is subscribed by the seller for which mode.
|
|
870
|
+
* @property {number} company_id - Unique identifier of the company.
|
|
871
|
+
* @property {string} [application_id] - Unique identifier of the sales channel.
|
|
747
872
|
*/
|
|
748
873
|
|
|
749
874
|
/**
|
|
750
875
|
* @typedef ZoneConfig
|
|
751
|
-
* @property {string} [serviceability_type]
|
|
876
|
+
* @property {string} [serviceability_type] - Serviceability type of the delivery zone.
|
|
877
|
+
* @property {number} [active_count] - Count of active delivery zones associated
|
|
878
|
+
* with the sales channel.
|
|
879
|
+
* @property {number} [total_count] - Count of total delivery zones associated
|
|
880
|
+
* with the sales channel.
|
|
752
881
|
*/
|
|
753
882
|
|
|
754
883
|
/**
|
|
755
884
|
* @typedef ApplicationConfig
|
|
756
|
-
* @property {string[]} [rule_ids]
|
|
757
|
-
* @property {string[]} [sort]
|
|
885
|
+
* @property {string[]} [rule_ids] - A list of courier partner rules.
|
|
886
|
+
* @property {string[]} [sort] - Strategy adopted to sort the courier partners.
|
|
758
887
|
* @property {ZoneConfig} [zones]
|
|
759
888
|
*/
|
|
760
889
|
|
|
761
890
|
/**
|
|
762
|
-
* @typedef
|
|
763
|
-
* @property {string} [file_path]
|
|
764
|
-
* @property {string} country
|
|
765
|
-
*
|
|
766
|
-
* @property {string}
|
|
891
|
+
* @typedef BulkRegionJobDetails
|
|
892
|
+
* @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
|
|
893
|
+
* @property {string} country - Country for which the tat or serviceability is
|
|
894
|
+
* to be imported or exported.
|
|
895
|
+
* @property {string} action - Denotes the import or export action to be performed.
|
|
896
|
+
* @property {string} region - Region of the country for which import or export
|
|
897
|
+
* is triggered.
|
|
767
898
|
*/
|
|
768
899
|
|
|
769
900
|
/**
|
|
770
|
-
* @typedef
|
|
771
|
-
* @property {string} file_path
|
|
772
|
-
* @property {number} [failed]
|
|
901
|
+
* @typedef BulkRegionResultItemData
|
|
902
|
+
* @property {string} [file_path] - CDN path of the file which was used for bulk import.
|
|
903
|
+
* @property {number} [failed] - Count of the failed records.
|
|
773
904
|
* @property {Object[]} [failed_records]
|
|
774
|
-
* @property {string} action
|
|
775
|
-
* @property {string} batch_id
|
|
776
|
-
* @property {string} country
|
|
777
|
-
*
|
|
778
|
-
* @property {
|
|
779
|
-
*
|
|
780
|
-
* @property {
|
|
781
|
-
*
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
905
|
+
* @property {string} action - Denotes the import or export action performed.
|
|
906
|
+
* @property {string} batch_id - Unique id to identify the import or export query.
|
|
907
|
+
* @property {string} country - Country for which the import or export action is
|
|
908
|
+
* performed.
|
|
909
|
+
* @property {number} [success] - Denoted if the import or export was successful
|
|
910
|
+
* or failure.
|
|
911
|
+
* @property {string} region - Region of the country for which import or export
|
|
912
|
+
* is triggered.
|
|
913
|
+
* @property {string} status - Current status of the import or export action performed.
|
|
914
|
+
* @property {number} [total] - Count of total records.
|
|
915
|
+
* @property {string} [error_file_path] - Path of the error file.
|
|
916
|
+
*/
|
|
917
|
+
|
|
918
|
+
/**
|
|
919
|
+
* @typedef BulkRegionResult
|
|
920
|
+
* @property {BulkRegionResultItemData[]} items
|
|
787
921
|
* @property {Page} page
|
|
788
922
|
*/
|
|
789
923
|
|
|
790
924
|
/**
|
|
791
|
-
* @typedef
|
|
925
|
+
* @typedef SelfShipResult
|
|
792
926
|
* @property {boolean} is_active
|
|
793
927
|
* @property {number} tat
|
|
794
928
|
*/
|
|
795
929
|
|
|
796
930
|
/**
|
|
797
931
|
* @typedef ApplicationSelfShipConfig
|
|
798
|
-
* @property {
|
|
932
|
+
* @property {SelfShipResult} [self_ship]
|
|
799
933
|
*/
|
|
800
934
|
|
|
801
935
|
/**
|
|
802
|
-
* @typedef
|
|
803
|
-
* @property {
|
|
936
|
+
* @typedef ApplicationSelfShipConfigResult
|
|
937
|
+
* @property {ServiceabilityErrorResult} [error]
|
|
804
938
|
* @property {ApplicationSelfShipConfig} [data]
|
|
805
939
|
* @property {boolean} success
|
|
806
940
|
*/
|
|
807
941
|
|
|
808
942
|
/**
|
|
809
943
|
* @typedef StoreRuleConfigData
|
|
810
|
-
* @property {string[]} [rule_ids]
|
|
811
|
-
* @property {string[]} [type_based_priority]
|
|
812
|
-
*
|
|
813
|
-
* @property {
|
|
814
|
-
*
|
|
944
|
+
* @property {string[]} [rule_ids] - List of rule ids which are active in the application.
|
|
945
|
+
* @property {string[]} [type_based_priority] - Priority of the store type to be
|
|
946
|
+
* used in the basic prioritization sorting of stores.
|
|
947
|
+
* @property {string[]} [tag_based_priority] - Priority of the store tags to be
|
|
948
|
+
* used in the basic prioritization sorting of stores.
|
|
949
|
+
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
950
|
+
* stores to be used for sorting of stores.
|
|
951
|
+
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
815
952
|
*/
|
|
816
953
|
|
|
817
954
|
/**
|
|
@@ -840,76 +977,89 @@ const Joi = require("joi");
|
|
|
840
977
|
|
|
841
978
|
/**
|
|
842
979
|
* @typedef StoreRuleDataSchema
|
|
843
|
-
* @property {string} [id]
|
|
844
|
-
* @property {string} [name]
|
|
845
|
-
* @property {number} [company_id]
|
|
846
|
-
* @property {string} [application_id]
|
|
847
|
-
* @property {string[]} [type_based_priority]
|
|
848
|
-
*
|
|
849
|
-
* @property {
|
|
850
|
-
*
|
|
980
|
+
* @property {string} [id] - Id of the rule.
|
|
981
|
+
* @property {string} [name] - Name of the rule.
|
|
982
|
+
* @property {number} [company_id] - Company id for which the rule is created.
|
|
983
|
+
* @property {string} [application_id] - Application id for which the rule is created.
|
|
984
|
+
* @property {string[]} [type_based_priority] - Priority of the store type to be
|
|
985
|
+
* used in the basic prioritization sorting of stores.
|
|
986
|
+
* @property {string[]} [tag_based_priority] - Priority of the store tags to be
|
|
987
|
+
* used in the basic prioritization sorting of stores.
|
|
988
|
+
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
989
|
+
* stores to be used for sorting of stores.
|
|
990
|
+
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
851
991
|
* @property {StoreRuleConditionSchema} [conditions]
|
|
852
|
-
* @property {boolean} [is_active]
|
|
992
|
+
* @property {boolean} [is_active] - Denotes whether the rule is active or inactive.
|
|
853
993
|
*/
|
|
854
994
|
|
|
855
995
|
/**
|
|
856
996
|
* @typedef StorePrioritySchema
|
|
857
|
-
* @property {
|
|
858
|
-
* @property {string} [name]
|
|
997
|
+
* @property {number} [id] - Id of the store.
|
|
998
|
+
* @property {string} [name] - Name of the store.
|
|
859
999
|
*/
|
|
860
1000
|
|
|
861
1001
|
/**
|
|
862
|
-
* @typedef
|
|
1002
|
+
* @typedef GetStoreRulesApiResult
|
|
863
1003
|
* @property {StoreRuleDataSchema[]} [items]
|
|
864
1004
|
* @property {Page} [page]
|
|
865
1005
|
*/
|
|
866
1006
|
|
|
867
1007
|
/**
|
|
868
|
-
* @typedef
|
|
869
|
-
* @property {string} [name]
|
|
870
|
-
* @property {boolean} [is_active]
|
|
1008
|
+
* @typedef CreateStoreRuleDetailsSchema
|
|
1009
|
+
* @property {string} [name] - Name of the rule.
|
|
1010
|
+
* @property {boolean} [is_active] - Denotes if the rule is active or not.
|
|
871
1011
|
* @property {StoreRuleConditionSchema} [conditions]
|
|
872
|
-
* @property {string[]} [type_based_priority]
|
|
873
|
-
*
|
|
874
|
-
* @property {
|
|
875
|
-
*
|
|
876
|
-
|
|
877
|
-
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
|
|
882
|
-
* @
|
|
883
|
-
* @property {string
|
|
884
|
-
* @property {string
|
|
885
|
-
* @property {
|
|
886
|
-
* @property {string[]} [
|
|
1012
|
+
* @property {string[]} [type_based_priority] - Priority of the store type to be
|
|
1013
|
+
* used in the basic prioritization sorting of stores.
|
|
1014
|
+
* @property {string[]} [tag_based_priority] - Priority of the store tags to be
|
|
1015
|
+
* used in the basic prioritization sorting of stores.
|
|
1016
|
+
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
1017
|
+
* stores to be used for sorting of stores.
|
|
1018
|
+
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
1019
|
+
*/
|
|
1020
|
+
|
|
1021
|
+
/**
|
|
1022
|
+
* @typedef StoreRuleResultSchema
|
|
1023
|
+
* @property {string} [id] - Id of the rule created.
|
|
1024
|
+
* @property {string} [name] - Name of the rule created.
|
|
1025
|
+
* @property {string} [type] - Type of the rule created.
|
|
1026
|
+
* @property {string[]} [type_based_priority] - Priority of the store type to be
|
|
1027
|
+
* used in the rule for sorting of stores.
|
|
1028
|
+
* @property {string[]} [tag_based_priority] - Priority of the store tags to be
|
|
1029
|
+
* used in the rule for sorting of stores.
|
|
1030
|
+
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
1031
|
+
* stores to be used for sorting of stores.
|
|
1032
|
+
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
887
1033
|
* @property {StoreRuleConditionSchema} [conditions]
|
|
888
|
-
* @property {boolean} [is_active]
|
|
1034
|
+
* @property {boolean} [is_active] - Denotes if the rule is active or inactive.
|
|
889
1035
|
*/
|
|
890
1036
|
|
|
891
1037
|
/**
|
|
892
|
-
* @typedef
|
|
893
|
-
* @property {string} [id]
|
|
894
|
-
* @property {string} [name]
|
|
895
|
-
* @property {string} [type]
|
|
896
|
-
* @property {string[]} [type_based_priority]
|
|
897
|
-
*
|
|
898
|
-
* @property {
|
|
899
|
-
*
|
|
1038
|
+
* @typedef StoreRuleUpdateResultSchema
|
|
1039
|
+
* @property {string} [id] - Id of the rule created.
|
|
1040
|
+
* @property {string} [name] - Name of the rule created.
|
|
1041
|
+
* @property {string} [type] - Type of the rule created.
|
|
1042
|
+
* @property {string[]} [type_based_priority] - Priority of the store type to be
|
|
1043
|
+
* used in the rule for sorting of stores.
|
|
1044
|
+
* @property {string[]} [tag_based_priority] - Priority of the store tags to be
|
|
1045
|
+
* used in the rule for sorting of stores.
|
|
1046
|
+
* @property {StorePrioritySchema[]} [store_priority] - Priority of explicit
|
|
1047
|
+
* stores to be used for sorting of stores.
|
|
1048
|
+
* @property {string[]} [sort] - Criteria on which the selected stores should be sorted.
|
|
900
1049
|
* @property {StoreRuleConditionSchema} [conditions]
|
|
901
|
-
* @property {boolean} [is_active]
|
|
902
|
-
* @property {number} [company_id]
|
|
903
|
-
* @property {string} [application_id]
|
|
1050
|
+
* @property {boolean} [is_active] - Denotes if the rule is active or inactive.
|
|
1051
|
+
* @property {number} [company_id] - Company id for which the rule is created.
|
|
1052
|
+
* @property {string} [application_id] - Application id for which the rule is created.
|
|
904
1053
|
*/
|
|
905
1054
|
|
|
906
1055
|
/**
|
|
907
1056
|
* @typedef ServiceabilityModel
|
|
908
1057
|
* @property {number} lm_cod_limit
|
|
909
1058
|
* @property {boolean} is_qc
|
|
910
|
-
* @property {string} pickup_cutoff
|
|
911
|
-
* @property {string} route_code
|
|
1059
|
+
* @property {string} [pickup_cutoff]
|
|
1060
|
+
* @property {string} [route_code]
|
|
912
1061
|
* @property {boolean} is_first_mile
|
|
1062
|
+
* @property {boolean} [is_reverse_pickup]
|
|
913
1063
|
* @property {boolean} is_return
|
|
914
1064
|
* @property {boolean} is_installation
|
|
915
1065
|
* @property {boolean} is_last_mile
|
|
@@ -917,124 +1067,171 @@ const Joi = require("joi");
|
|
|
917
1067
|
|
|
918
1068
|
/**
|
|
919
1069
|
* @typedef CourierPartnerSchemeFeatures
|
|
920
|
-
* @property {boolean} [doorstep_qc]
|
|
921
|
-
*
|
|
922
|
-
* @property {boolean} [
|
|
923
|
-
*
|
|
924
|
-
* @property {
|
|
925
|
-
*
|
|
926
|
-
* @property {boolean} [
|
|
927
|
-
*
|
|
928
|
-
* @property {
|
|
929
|
-
*
|
|
930
|
-
* @property {boolean} [
|
|
931
|
-
*
|
|
932
|
-
* @property {boolean} [
|
|
933
|
-
*
|
|
934
|
-
* @property {boolean} [
|
|
935
|
-
*
|
|
936
|
-
* @property {boolean} [
|
|
937
|
-
*
|
|
1070
|
+
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
1071
|
+
* doorstep quality check services.
|
|
1072
|
+
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
1073
|
+
* code-based operations.
|
|
1074
|
+
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
1075
|
+
* multi-part shipment services.
|
|
1076
|
+
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
1077
|
+
* feature is supported by the courier partner.
|
|
1078
|
+
* @property {number} [ndr_attempts] - Number of attempts allowed for resolving
|
|
1079
|
+
* Non-Delivery Reports (NDR).
|
|
1080
|
+
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
1081
|
+
* handles the transportation of dangerous goods.
|
|
1082
|
+
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
1083
|
+
* manages the shipment of fragile goods.
|
|
1084
|
+
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
1085
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
1086
|
+
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
1087
|
+
* provides cold storage facilities for goods.
|
|
1088
|
+
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
1089
|
+
* supports doorstep exchange services.
|
|
1090
|
+
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
1091
|
+
* offers doorstep return services.
|
|
1092
|
+
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
1093
|
+
* provides product installation services upon delivery.
|
|
1094
|
+
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
1095
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
1096
|
+
* before accepting.
|
|
1097
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
1098
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1099
|
+
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
1100
|
+
* partner supports multiple pickups to a single drop location.
|
|
1101
|
+
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
1102
|
+
* partner supports single pickup to multiple drop locations.
|
|
1103
|
+
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
1104
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
1105
|
+
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
1106
|
+
* supports the generation of e-waybills for shipments.
|
|
1107
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
1108
|
+
* of items allowed in a quality check shipment.
|
|
1109
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
1110
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
938
1111
|
*/
|
|
939
1112
|
|
|
940
1113
|
/**
|
|
941
1114
|
* @typedef CourierPartnerSchemeModel
|
|
942
|
-
* @property {string}
|
|
943
|
-
* @property {string}
|
|
1115
|
+
* @property {string} [name] - Name of the scheme.
|
|
1116
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
1117
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
1118
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
944
1119
|
* @property {ArithmeticOperations} weight
|
|
945
|
-
* @property {string} transport_type
|
|
946
|
-
*
|
|
947
|
-
* @property {string}
|
|
948
|
-
*
|
|
949
|
-
* @property {string}
|
|
1120
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
1121
|
+
* courier partner scheme.
|
|
1122
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
1123
|
+
* partner scheme.
|
|
1124
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
1125
|
+
* courier partner scheme.
|
|
1126
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
1127
|
+
* courier partner scheme.
|
|
1128
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
1129
|
+
* currently active or inactive.
|
|
950
1130
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
951
1131
|
*/
|
|
952
1132
|
|
|
953
1133
|
/**
|
|
954
|
-
* @typedef
|
|
955
|
-
* @property {
|
|
956
|
-
* @property {string}
|
|
957
|
-
* @property {
|
|
958
|
-
*
|
|
959
|
-
* @property {
|
|
960
|
-
* @property {
|
|
1134
|
+
* @typedef CourierAccountResult
|
|
1135
|
+
* @property {number} company_id - Company id associated with the account.
|
|
1136
|
+
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
1137
|
+
* @property {string} account_id - Unique identifier of courier partner scheme
|
|
1138
|
+
* and company id combination.
|
|
1139
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
1140
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
1141
|
+
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
1142
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
1143
|
+
* account or not.
|
|
1144
|
+
* @property {CourierPartnerSchemeModel} [scheme_rules]
|
|
961
1145
|
*/
|
|
962
1146
|
|
|
963
1147
|
/**
|
|
964
|
-
* @typedef
|
|
965
|
-
* @property {
|
|
1148
|
+
* @typedef CompanyCourierPartnerAccountListResult
|
|
1149
|
+
* @property {CourierAccountResult[]} items
|
|
966
1150
|
* @property {Page} page
|
|
967
1151
|
*/
|
|
968
1152
|
|
|
969
1153
|
/**
|
|
970
1154
|
* @typedef PackageMaterial
|
|
971
|
-
* @property {string} name
|
|
972
|
-
* @property {number} width
|
|
973
|
-
* @property {number} height
|
|
974
|
-
* @property {number} length
|
|
975
|
-
* @property {PackageMaterialRule[]} [rules]
|
|
976
|
-
*
|
|
977
|
-
* @property {number}
|
|
978
|
-
* @property {number}
|
|
979
|
-
* @property {
|
|
980
|
-
* @property {string}
|
|
981
|
-
* @property {string
|
|
982
|
-
* @property {
|
|
983
|
-
* @property {
|
|
984
|
-
* @property {
|
|
985
|
-
*
|
|
986
|
-
* @property {
|
|
987
|
-
*
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
* @
|
|
992
|
-
*
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
* @
|
|
997
|
-
* @property {
|
|
998
|
-
* @property {
|
|
999
|
-
* @property {number[]
|
|
1000
|
-
*
|
|
1001
|
-
* @property {number}
|
|
1002
|
-
* @property {
|
|
1003
|
-
* @property {
|
|
1004
|
-
* @property {
|
|
1005
|
-
* @property {
|
|
1006
|
-
*
|
|
1007
|
-
* @property {
|
|
1008
|
-
* @property {number}
|
|
1009
|
-
* @property {number}
|
|
1010
|
-
* @property {
|
|
1155
|
+
* @property {string} name - Name of the packaging material.
|
|
1156
|
+
* @property {number} width - Width of the packaging material dimentions in centimeter.
|
|
1157
|
+
* @property {number} height - Height of the packaging material dimentions in centimeter.
|
|
1158
|
+
* @property {number} length - Length of the packaging material dimentions in centimeter.
|
|
1159
|
+
* @property {PackageMaterialRule[]} [rules] - Product group rules associated
|
|
1160
|
+
* with the packaging.
|
|
1161
|
+
* @property {number[]} store_ids - Store ids where the packaging is avaiable.
|
|
1162
|
+
* @property {number} weight - Package's weight in gram.
|
|
1163
|
+
* @property {number} error_rate - Error Rate associated with the packaging dimensions.
|
|
1164
|
+
* @property {string} package_type - Type of package material.
|
|
1165
|
+
* @property {string} size - Physical size of the packaging.
|
|
1166
|
+
* @property {string[]} [media] - Image urls associated with the packaging material.
|
|
1167
|
+
* @property {Channel[]} channels - Sales channel where packaging is applicable.
|
|
1168
|
+
* @property {boolean} [track_inventory] - Denotes if the track of the inventory
|
|
1169
|
+
* should be kept.
|
|
1170
|
+
* @property {string} status - Current status of the packaging material, if it
|
|
1171
|
+
* is active or inactive.
|
|
1172
|
+
* @property {number} [max_weight] - Maximum weight holding capacity.
|
|
1173
|
+
* @property {number} [package_vol_weight] - Volumetric weight that a packaging
|
|
1174
|
+
* material can carry.
|
|
1175
|
+
* @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
|
|
1176
|
+
* should be auto calculated or not.
|
|
1177
|
+
*/
|
|
1178
|
+
|
|
1179
|
+
/**
|
|
1180
|
+
* @typedef PackageMaterialResult
|
|
1181
|
+
* @property {string} name - Name of the packaging material.
|
|
1182
|
+
* @property {string} [id] - Id of the packaging material.
|
|
1183
|
+
* @property {number} [item_id] - Unique identifier of an item associated with
|
|
1184
|
+
* the packaging material.
|
|
1185
|
+
* @property {number} [company_id] - Company id associated with the packaging material.
|
|
1186
|
+
* @property {number} width - Width of the packaging material dimentions in centimeter.
|
|
1187
|
+
* @property {number} height - Height of the packaging material dimentions in centimeter.
|
|
1188
|
+
* @property {number} length - Length of the packaging material dimentions in centimeter.
|
|
1189
|
+
* @property {PackageMaterialRule[]} [rules] - Product group rules associated
|
|
1190
|
+
* with the packaging.
|
|
1191
|
+
* @property {number[]} store_ids - Store ids where the packaging is avaiable.
|
|
1192
|
+
* @property {number} weight - Package's weight in gram.
|
|
1193
|
+
* @property {number} error_rate - Error Rate associated with the packaging dimensions.
|
|
1194
|
+
* @property {string} package_type - Type of package material.
|
|
1195
|
+
* @property {string} size - Physical size of the packaging.
|
|
1196
|
+
* @property {string[]} [media] - Image urls associated with the packaging material.
|
|
1197
|
+
* @property {Channel[]} channels - Sales channel where packaging is applicable.
|
|
1198
|
+
* @property {boolean} [track_inventory] - Denotes if the track of the inventory
|
|
1199
|
+
* should be kept.
|
|
1200
|
+
* @property {string} status - Current status of the packaging material, if it
|
|
1201
|
+
* is active or inactive.
|
|
1202
|
+
* @property {number} [max_weight] - Maximum weight holding capacity.
|
|
1203
|
+
* @property {number} [package_vol_weight] - Volumetric weight that a packaging
|
|
1204
|
+
* material can carry.
|
|
1205
|
+
* @property {boolean} [auto_calculate] - Denotes whether the volumetric weight
|
|
1206
|
+
* should be auto calculated or not.
|
|
1011
1207
|
*/
|
|
1012
1208
|
|
|
1013
1209
|
/**
|
|
1014
1210
|
* @typedef PackageMaterialRule
|
|
1015
|
-
* @property {string} [rule_id]
|
|
1211
|
+
* @property {string} [rule_id] - Unique identifier of the package rule.
|
|
1016
1212
|
* @property {PackageMaterialRuleQuantity} [quantity]
|
|
1017
|
-
* @property {number} [weight]
|
|
1213
|
+
* @property {number} [weight] - Volumetric weight in gram.
|
|
1018
1214
|
*/
|
|
1019
1215
|
|
|
1020
1216
|
/**
|
|
1021
1217
|
* @typedef PackageRule
|
|
1022
|
-
* @property {string} name
|
|
1023
|
-
* @property {number} company_id
|
|
1024
|
-
* @property {string} type
|
|
1025
|
-
* @property {boolean} [is_active]
|
|
1218
|
+
* @property {string} name - Name of the package rule.
|
|
1219
|
+
* @property {number} company_id - Unique identifier of the company.
|
|
1220
|
+
* @property {string} type - Type of the rule.
|
|
1221
|
+
* @property {boolean} [is_active] - Denotes if the rule is active or inactive.
|
|
1026
1222
|
* @property {PackageRuleProductTag} [product_tag]
|
|
1027
1223
|
* @property {PackageRuleProduct} [product_id]
|
|
1028
1224
|
* @property {PackageRuleCategory} [category_id]
|
|
1029
1225
|
*/
|
|
1030
1226
|
|
|
1031
1227
|
/**
|
|
1032
|
-
* @typedef
|
|
1033
|
-
* @property {string} [id]
|
|
1034
|
-
* @property {string} name
|
|
1035
|
-
* @property {number} company_id
|
|
1036
|
-
*
|
|
1037
|
-
* @property {
|
|
1228
|
+
* @typedef PackageRuleResult
|
|
1229
|
+
* @property {string} [id] - Unique id of a package rule.
|
|
1230
|
+
* @property {string} name - Name of a package rule.
|
|
1231
|
+
* @property {number} company_id - Unique identifier of a company associated
|
|
1232
|
+
* with the package rule.
|
|
1233
|
+
* @property {string} type - Type of the rule created.
|
|
1234
|
+
* @property {boolean} [is_active] - Denotes if the rule is active or inactive.
|
|
1038
1235
|
* @property {PackageRuleProductTag} [product_tag]
|
|
1039
1236
|
* @property {PackageRuleProduct} [product_id]
|
|
1040
1237
|
* @property {PackageRuleCategory} [category_id]
|
|
@@ -1042,19 +1239,19 @@ const Joi = require("joi");
|
|
|
1042
1239
|
|
|
1043
1240
|
/**
|
|
1044
1241
|
* @typedef Channel
|
|
1045
|
-
* @property {string} [type]
|
|
1046
|
-
* @property {string} [id]
|
|
1242
|
+
* @property {string} [type] - Type of the channel.
|
|
1243
|
+
* @property {string} [id] - Unique identifier of the channel.
|
|
1047
1244
|
*/
|
|
1048
1245
|
|
|
1049
1246
|
/**
|
|
1050
1247
|
* @typedef PackageMaterialRuleList
|
|
1051
|
-
* @property {
|
|
1248
|
+
* @property {PackageRuleResult} [items]
|
|
1052
1249
|
* @property {Page} [page]
|
|
1053
1250
|
*/
|
|
1054
1251
|
|
|
1055
1252
|
/**
|
|
1056
1253
|
* @typedef PackageMaterialList
|
|
1057
|
-
* @property {
|
|
1254
|
+
* @property {PackageMaterialResult} [items]
|
|
1058
1255
|
* @property {Page} [page]
|
|
1059
1256
|
*/
|
|
1060
1257
|
|
|
@@ -1075,19 +1272,20 @@ const Joi = require("joi");
|
|
|
1075
1272
|
|
|
1076
1273
|
/**
|
|
1077
1274
|
* @typedef PackageMaterialRuleQuantity
|
|
1078
|
-
* @property {number} [min]
|
|
1079
|
-
* @property {number} [max]
|
|
1275
|
+
* @property {number} [min] - Minimum product's quantity that a packaging can contain.
|
|
1276
|
+
* @property {number} [max] - Maximum product's quantity that a packaging can contain.
|
|
1080
1277
|
*/
|
|
1081
1278
|
|
|
1082
1279
|
/**
|
|
1083
|
-
* @typedef
|
|
1084
|
-
* @property {string} rule_id
|
|
1085
|
-
* @property {number} priority
|
|
1280
|
+
* @typedef RulePriorityDetails
|
|
1281
|
+
* @property {string} rule_id - Rule id whose priority needs to be changed.
|
|
1282
|
+
* @property {number} priority - New priority of the rule.
|
|
1086
1283
|
*/
|
|
1087
1284
|
|
|
1088
1285
|
/**
|
|
1089
|
-
* @typedef
|
|
1090
|
-
* @property {boolean} [success]
|
|
1286
|
+
* @typedef RulePriorityResult
|
|
1287
|
+
* @property {boolean} [success] - Denotes if the priority of the rule is
|
|
1288
|
+
* changes successfully or not.
|
|
1091
1289
|
*/
|
|
1092
1290
|
|
|
1093
1291
|
/**
|
|
@@ -1118,7 +1316,7 @@ const Joi = require("joi");
|
|
|
1118
1316
|
* @typedef OptimalLocationsArticles
|
|
1119
1317
|
* @property {number} item_id
|
|
1120
1318
|
* @property {string} size
|
|
1121
|
-
* @property {
|
|
1319
|
+
* @property {number} quantity
|
|
1122
1320
|
* @property {string} [group_id]
|
|
1123
1321
|
* @property {boolean} [is_primary_item]
|
|
1124
1322
|
* @property {Object} [meta]
|
|
@@ -1129,16 +1327,16 @@ const Joi = require("joi");
|
|
|
1129
1327
|
*/
|
|
1130
1328
|
|
|
1131
1329
|
/**
|
|
1132
|
-
* @typedef
|
|
1330
|
+
* @typedef OptimlLocationsDetailsSchema
|
|
1133
1331
|
* @property {string} channel_id
|
|
1134
1332
|
* @property {string} channel_type
|
|
1135
1333
|
* @property {string} [channel_identifier]
|
|
1136
1334
|
* @property {LocationDetailsServiceability} to_serviceability
|
|
1137
|
-
* @property {OptimalLocationsArticles} [
|
|
1335
|
+
* @property {OptimalLocationsArticles[]} [articles]
|
|
1138
1336
|
*/
|
|
1139
1337
|
|
|
1140
1338
|
/**
|
|
1141
|
-
* @typedef
|
|
1339
|
+
* @typedef OptimalLocationArticlesResult
|
|
1142
1340
|
* @property {number} item_id
|
|
1143
1341
|
* @property {string} size
|
|
1144
1342
|
* @property {number} quantity
|
|
@@ -1156,27 +1354,208 @@ const Joi = require("joi");
|
|
|
1156
1354
|
*/
|
|
1157
1355
|
|
|
1158
1356
|
/**
|
|
1159
|
-
* @typedef
|
|
1357
|
+
* @typedef OptimalLocationAssignedStoresResult
|
|
1160
1358
|
* @property {number} store_id
|
|
1161
|
-
* @property {
|
|
1359
|
+
* @property {OptimalLocationArticlesResult[]} articles
|
|
1360
|
+
*/
|
|
1361
|
+
|
|
1362
|
+
/**
|
|
1363
|
+
* @typedef OptimalLocationsResult
|
|
1364
|
+
* @property {OptimalLocationAssignedStoresResult[]} assigned_stores
|
|
1365
|
+
* @property {ErrorResult[]} [faulty_articles]
|
|
1366
|
+
*/
|
|
1367
|
+
|
|
1368
|
+
/**
|
|
1369
|
+
* @typedef ValidationError
|
|
1370
|
+
* @property {string} message - A brief description of the error encountered.
|
|
1371
|
+
* @property {string} field - The field in the request that caused the error.
|
|
1372
|
+
*/
|
|
1373
|
+
|
|
1374
|
+
/**
|
|
1375
|
+
* @typedef StandardError
|
|
1376
|
+
* @property {string} message - A brief description of the error.
|
|
1377
|
+
*/
|
|
1378
|
+
|
|
1379
|
+
/**
|
|
1380
|
+
* @typedef CourierPartnerSchemeV2Features
|
|
1381
|
+
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
1382
|
+
* doorstep quality check services.
|
|
1383
|
+
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
1384
|
+
* code-based operations.
|
|
1385
|
+
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
1386
|
+
* multi-part shipment services.
|
|
1387
|
+
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
1388
|
+
* feature is supported by the courier partner.
|
|
1389
|
+
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
1390
|
+
* handles the transportation of dangerous goods.
|
|
1391
|
+
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
1392
|
+
* manages the shipment of fragile goods.
|
|
1393
|
+
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
1394
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
1395
|
+
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
1396
|
+
* provides cold storage facilities for goods.
|
|
1397
|
+
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
1398
|
+
* supports doorstep exchange services.
|
|
1399
|
+
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
1400
|
+
* offers doorstep return services.
|
|
1401
|
+
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
1402
|
+
* provides product installation services upon delivery.
|
|
1403
|
+
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
1404
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
1405
|
+
* before accepting.
|
|
1406
|
+
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
1407
|
+
* partner supports multiple pickups to a single drop location.
|
|
1408
|
+
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
1409
|
+
* partner supports single pickup to multiple drop locations.
|
|
1410
|
+
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
1411
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
1412
|
+
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
1413
|
+
* supports the generation of e-waybills for shipments.
|
|
1414
|
+
*/
|
|
1415
|
+
|
|
1416
|
+
/**
|
|
1417
|
+
* @typedef CourierPartnerSchemeV2DetailsModel
|
|
1418
|
+
* @property {string} extension_id - Unique identifier of courier partner extension
|
|
1419
|
+
* @property {string} [scheme_id]
|
|
1420
|
+
* @property {string} name
|
|
1421
|
+
* @property {ArithmeticOperations} weight
|
|
1422
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
1423
|
+
* @property {string} transport_type
|
|
1424
|
+
* @property {string} region
|
|
1425
|
+
* @property {string} delivery_type
|
|
1426
|
+
* @property {string[]} payment_mode
|
|
1427
|
+
* @property {string} stage
|
|
1428
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
1429
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1430
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
1431
|
+
* (NDR) feature is supported by the courier partner.
|
|
1432
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
1433
|
+
* of items allowed in a quality check shipment.
|
|
1434
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
1435
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1436
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
1437
|
+
*/
|
|
1438
|
+
|
|
1439
|
+
/**
|
|
1440
|
+
* @typedef CourierPartnerV2SchemeModel
|
|
1441
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
1442
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
1443
|
+
* @property {string} [company_id] - Unique identifier of company.
|
|
1444
|
+
* @property {string} name - Name of the scheme.
|
|
1445
|
+
* @property {ArithmeticOperations} weight
|
|
1446
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
1447
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
1448
|
+
* courier partner scheme.
|
|
1449
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
1450
|
+
* partner scheme.
|
|
1451
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
1452
|
+
* courier partner scheme.
|
|
1453
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
1454
|
+
* courier partner scheme.
|
|
1455
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
1456
|
+
* currently active or inactive.
|
|
1457
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
1458
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1459
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
1460
|
+
* (NDR) feature is supported by the courier partner.
|
|
1461
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
1462
|
+
* of items allowed in a quality check shipment.
|
|
1463
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
1464
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1465
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
1466
|
+
*/
|
|
1467
|
+
|
|
1468
|
+
/**
|
|
1469
|
+
* @typedef CourierPartnerSchemeV2UpdateDetails
|
|
1470
|
+
* @property {string} name
|
|
1471
|
+
* @property {ArithmeticOperations} weight
|
|
1472
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
1473
|
+
* @property {string} transport_type
|
|
1474
|
+
* @property {string} region
|
|
1475
|
+
* @property {string} delivery_type
|
|
1476
|
+
* @property {string[]} payment_mode
|
|
1477
|
+
* @property {string} stage
|
|
1478
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
1479
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1480
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
1481
|
+
* (NDR) feature is supported by the courier partner.
|
|
1482
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
1483
|
+
* of items allowed in a quality check shipment.
|
|
1484
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
1485
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1486
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
1487
|
+
*/
|
|
1488
|
+
|
|
1489
|
+
/**
|
|
1490
|
+
* @typedef courierPartnerSchemeV2List
|
|
1491
|
+
* @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
|
|
1492
|
+
* @property {Page} page
|
|
1493
|
+
*/
|
|
1494
|
+
|
|
1495
|
+
/**
|
|
1496
|
+
* @typedef BulkRegionServiceabilityTatDetails
|
|
1497
|
+
* @property {string} country
|
|
1498
|
+
* @property {string} region
|
|
1499
|
+
* @property {string} type
|
|
1500
|
+
*/
|
|
1501
|
+
|
|
1502
|
+
/**
|
|
1503
|
+
* @typedef BulkRegionServiceabilityTatResultItemData
|
|
1504
|
+
* @property {string} [country] - Name of the country.
|
|
1505
|
+
* @property {string} [region] - Name of the region for which the
|
|
1506
|
+
* tat/serviceability file needs to be downloaded.
|
|
1507
|
+
* @property {string} [type] - Denotes the type of data.
|
|
1508
|
+
* @property {string} [batch_id] - Unique identifier identifying the perticular request.
|
|
1509
|
+
* @property {string} [status] - Current status of the request.
|
|
1510
|
+
* @property {Object[]} [failed_records] - Information of records which failed
|
|
1511
|
+
* @property {string} [file_path] - CDN path of the file.
|
|
1512
|
+
*/
|
|
1513
|
+
|
|
1514
|
+
/**
|
|
1515
|
+
* @typedef BulkRegionServiceabilityTatResult
|
|
1516
|
+
* @property {BulkRegionServiceabilityTatResultItemData[]} [items]
|
|
1517
|
+
* @property {Page} [page]
|
|
1518
|
+
*/
|
|
1519
|
+
|
|
1520
|
+
/**
|
|
1521
|
+
* @typedef HierarchyItems
|
|
1522
|
+
* @property {string} [display_name]
|
|
1523
|
+
* @property {string} [slug]
|
|
1162
1524
|
*/
|
|
1163
1525
|
|
|
1164
1526
|
/**
|
|
1165
|
-
* @typedef
|
|
1166
|
-
* @property {
|
|
1167
|
-
* @property {
|
|
1527
|
+
* @typedef GetCountriesItems
|
|
1528
|
+
* @property {string} [id]
|
|
1529
|
+
* @property {string} [name]
|
|
1530
|
+
* @property {string} [iso2]
|
|
1531
|
+
* @property {string} [iso3]
|
|
1532
|
+
* @property {string[]} [timezones]
|
|
1533
|
+
* @property {HierarchyItems[]} [hierarchy]
|
|
1534
|
+
* @property {string} [phone_code]
|
|
1535
|
+
* @property {string} [currency]
|
|
1536
|
+
* @property {string} [type]
|
|
1537
|
+
* @property {string} [latitude]
|
|
1538
|
+
* @property {string} [longitude]
|
|
1539
|
+
* @property {string} [display_name]
|
|
1540
|
+
* @property {boolean} [has_next_hierarchy]
|
|
1541
|
+
*/
|
|
1542
|
+
|
|
1543
|
+
/**
|
|
1544
|
+
* @typedef GetCountries
|
|
1545
|
+
* @property {GetCountriesItems[]} items
|
|
1546
|
+
* @property {Page} page
|
|
1168
1547
|
*/
|
|
1169
1548
|
|
|
1170
1549
|
class ServiceabilityPlatformModel {
|
|
1171
|
-
/** @returns {
|
|
1172
|
-
static
|
|
1550
|
+
/** @returns {UpdateZoneConfigDetails} */
|
|
1551
|
+
static UpdateZoneConfigDetails() {
|
|
1173
1552
|
return Joi.object({
|
|
1174
1553
|
serviceability_type: Joi.string().allow(""),
|
|
1175
1554
|
});
|
|
1176
1555
|
}
|
|
1177
1556
|
|
|
1178
|
-
/** @returns {
|
|
1179
|
-
static
|
|
1557
|
+
/** @returns {ServiceabilityErrorResult} */
|
|
1558
|
+
static ServiceabilityErrorResult() {
|
|
1180
1559
|
return Joi.object({
|
|
1181
1560
|
message: Joi.string().allow("").required(),
|
|
1182
1561
|
value: Joi.string().allow("").required(),
|
|
@@ -1193,17 +1572,17 @@ class ServiceabilityPlatformModel {
|
|
|
1193
1572
|
});
|
|
1194
1573
|
}
|
|
1195
1574
|
|
|
1196
|
-
/** @returns {
|
|
1197
|
-
static
|
|
1575
|
+
/** @returns {ApplicationServiceabilityConfigResult} */
|
|
1576
|
+
static ApplicationServiceabilityConfigResult() {
|
|
1198
1577
|
return Joi.object({
|
|
1199
|
-
error: ServiceabilityPlatformModel.
|
|
1578
|
+
error: ServiceabilityPlatformModel.ServiceabilityErrorResult(),
|
|
1200
1579
|
data: ServiceabilityPlatformModel.ApplicationServiceabilityConfig(),
|
|
1201
1580
|
success: Joi.boolean().required(),
|
|
1202
1581
|
});
|
|
1203
1582
|
}
|
|
1204
1583
|
|
|
1205
|
-
/** @returns {
|
|
1206
|
-
static
|
|
1584
|
+
/** @returns {EntityRegionView_Details} */
|
|
1585
|
+
static EntityRegionView_Details() {
|
|
1207
1586
|
return Joi.object({
|
|
1208
1587
|
sub_type: Joi.array().items(Joi.string().allow("")).required(),
|
|
1209
1588
|
parent_id: Joi.array().items(Joi.string().allow("")),
|
|
@@ -1230,8 +1609,8 @@ class ServiceabilityPlatformModel {
|
|
|
1230
1609
|
});
|
|
1231
1610
|
}
|
|
1232
1611
|
|
|
1233
|
-
/** @returns {
|
|
1234
|
-
static
|
|
1612
|
+
/** @returns {getAppRegionZonesResult} */
|
|
1613
|
+
static getAppRegionZonesResult() {
|
|
1235
1614
|
return Joi.object({
|
|
1236
1615
|
page: Joi.array()
|
|
1237
1616
|
.items(ServiceabilityPlatformModel.PageSchema())
|
|
@@ -1262,8 +1641,8 @@ class ServiceabilityPlatformModel {
|
|
|
1262
1641
|
});
|
|
1263
1642
|
}
|
|
1264
1643
|
|
|
1265
|
-
/** @returns {
|
|
1266
|
-
static
|
|
1644
|
+
/** @returns {EntityRegionView_Result} */
|
|
1645
|
+
static EntityRegionView_Result() {
|
|
1267
1646
|
return Joi.object({
|
|
1268
1647
|
error: ServiceabilityPlatformModel.EntityRegionView_Error().required(),
|
|
1269
1648
|
page: ServiceabilityPlatformModel.EntityRegionView_page().required(),
|
|
@@ -1327,8 +1706,8 @@ class ServiceabilityPlatformModel {
|
|
|
1327
1706
|
});
|
|
1328
1707
|
}
|
|
1329
1708
|
|
|
1330
|
-
/** @returns {
|
|
1331
|
-
static
|
|
1709
|
+
/** @returns {ListViewResult} */
|
|
1710
|
+
static ListViewResult() {
|
|
1332
1711
|
return Joi.object({
|
|
1333
1712
|
page: ServiceabilityPlatformModel.ZoneDataItem().required(),
|
|
1334
1713
|
items: Joi.array()
|
|
@@ -1348,8 +1727,8 @@ class ServiceabilityPlatformModel {
|
|
|
1348
1727
|
});
|
|
1349
1728
|
}
|
|
1350
1729
|
|
|
1351
|
-
/** @returns {
|
|
1352
|
-
static
|
|
1730
|
+
/** @returns {CompanyStoreView_Result} */
|
|
1731
|
+
static CompanyStoreView_Result() {
|
|
1353
1732
|
return Joi.object({
|
|
1354
1733
|
page: Joi.array()
|
|
1355
1734
|
.items(ServiceabilityPlatformModel.CompanyStoreView_PageItems())
|
|
@@ -1423,16 +1802,16 @@ class ServiceabilityPlatformModel {
|
|
|
1423
1802
|
});
|
|
1424
1803
|
}
|
|
1425
1804
|
|
|
1426
|
-
/** @returns {
|
|
1427
|
-
static
|
|
1805
|
+
/** @returns {ZoneUpdateDetails} */
|
|
1806
|
+
static ZoneUpdateDetails() {
|
|
1428
1807
|
return Joi.object({
|
|
1429
1808
|
identifier: Joi.string().allow("").required(),
|
|
1430
1809
|
data: ServiceabilityPlatformModel.UpdateZoneData().required(),
|
|
1431
1810
|
});
|
|
1432
1811
|
}
|
|
1433
1812
|
|
|
1434
|
-
/** @returns {
|
|
1435
|
-
static
|
|
1813
|
+
/** @returns {ZoneSuccessResult} */
|
|
1814
|
+
static ZoneSuccessResult() {
|
|
1436
1815
|
return Joi.object({
|
|
1437
1816
|
status_code: Joi.number().required(),
|
|
1438
1817
|
success: Joi.boolean().required(),
|
|
@@ -1456,12 +1835,13 @@ class ServiceabilityPlatformModel {
|
|
|
1456
1835
|
mapping: Joi.array()
|
|
1457
1836
|
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
1458
1837
|
.required(),
|
|
1838
|
+
assignment_preference: Joi.string().allow(""),
|
|
1459
1839
|
stores_count: Joi.number().required(),
|
|
1460
1840
|
});
|
|
1461
1841
|
}
|
|
1462
1842
|
|
|
1463
|
-
/** @returns {
|
|
1464
|
-
static
|
|
1843
|
+
/** @returns {GetSingleZoneDataViewResult} */
|
|
1844
|
+
static GetSingleZoneDataViewResult() {
|
|
1465
1845
|
return Joi.object({
|
|
1466
1846
|
data: ServiceabilityPlatformModel.GetZoneDataViewItems().required(),
|
|
1467
1847
|
});
|
|
@@ -1484,6 +1864,7 @@ class ServiceabilityPlatformModel {
|
|
|
1484
1864
|
mapping: Joi.array()
|
|
1485
1865
|
.items(ServiceabilityPlatformModel.ZoneMappingDetailType())
|
|
1486
1866
|
.required(),
|
|
1867
|
+
stores_count: Joi.number(),
|
|
1487
1868
|
});
|
|
1488
1869
|
}
|
|
1489
1870
|
|
|
@@ -1498,25 +1879,25 @@ class ServiceabilityPlatformModel {
|
|
|
1498
1879
|
.items(ServiceabilityPlatformModel.GetZoneDataViewChannels())
|
|
1499
1880
|
.required(),
|
|
1500
1881
|
store_ids: Joi.array().items(Joi.number()).required(),
|
|
1501
|
-
product: ServiceabilityPlatformModel.ZoneProductTypes().required(),
|
|
1502
1882
|
region_type: Joi.string().allow("").required(),
|
|
1503
1883
|
mapping: Joi.array()
|
|
1504
1884
|
.items(ServiceabilityPlatformModel.ZoneMappingType())
|
|
1505
1885
|
.required(),
|
|
1886
|
+
product: ServiceabilityPlatformModel.ZoneProductTypes(),
|
|
1506
1887
|
});
|
|
1507
1888
|
}
|
|
1508
1889
|
|
|
1509
|
-
/** @returns {
|
|
1510
|
-
static
|
|
1890
|
+
/** @returns {ZoneResult} */
|
|
1891
|
+
static ZoneResult() {
|
|
1511
1892
|
return Joi.object({
|
|
1512
|
-
status_code: Joi.number()
|
|
1893
|
+
status_code: Joi.number(),
|
|
1513
1894
|
zone_id: Joi.string().allow("").required(),
|
|
1514
1895
|
success: Joi.boolean().required(),
|
|
1515
1896
|
});
|
|
1516
1897
|
}
|
|
1517
1898
|
|
|
1518
|
-
/** @returns {
|
|
1519
|
-
static
|
|
1899
|
+
/** @returns {GetZoneFromPincodeViewDetails} */
|
|
1900
|
+
static GetZoneFromPincodeViewDetails() {
|
|
1520
1901
|
return Joi.object({
|
|
1521
1902
|
country: Joi.string().allow("").required(),
|
|
1522
1903
|
pincode: Joi.string().allow("").required(),
|
|
@@ -1536,16 +1917,16 @@ class ServiceabilityPlatformModel {
|
|
|
1536
1917
|
});
|
|
1537
1918
|
}
|
|
1538
1919
|
|
|
1539
|
-
/** @returns {
|
|
1540
|
-
static
|
|
1920
|
+
/** @returns {GetZoneFromPincodeViewResult} */
|
|
1921
|
+
static GetZoneFromPincodeViewResult() {
|
|
1541
1922
|
return Joi.object({
|
|
1542
1923
|
serviceability_type: Joi.string().allow("").required(),
|
|
1543
1924
|
zones: Joi.array().items(ServiceabilityPlatformModel.Zone()).required(),
|
|
1544
1925
|
});
|
|
1545
1926
|
}
|
|
1546
1927
|
|
|
1547
|
-
/** @returns {
|
|
1548
|
-
static
|
|
1928
|
+
/** @returns {GetZoneFromApplicationIdViewResult} */
|
|
1929
|
+
static GetZoneFromApplicationIdViewResult() {
|
|
1549
1930
|
return Joi.object({
|
|
1550
1931
|
page: Joi.array()
|
|
1551
1932
|
.items(ServiceabilityPlatformModel.ZoneDataItem())
|
|
@@ -1556,8 +1937,8 @@ class ServiceabilityPlatformModel {
|
|
|
1556
1937
|
});
|
|
1557
1938
|
}
|
|
1558
1939
|
|
|
1559
|
-
/** @returns {
|
|
1560
|
-
static
|
|
1940
|
+
/** @returns {ServiceabilityPageResult} */
|
|
1941
|
+
static ServiceabilityPageResult() {
|
|
1561
1942
|
return Joi.object({
|
|
1562
1943
|
type: Joi.string().allow(""),
|
|
1563
1944
|
has_next: Joi.boolean(),
|
|
@@ -1575,8 +1956,8 @@ class ServiceabilityPlatformModel {
|
|
|
1575
1956
|
});
|
|
1576
1957
|
}
|
|
1577
1958
|
|
|
1578
|
-
/** @returns {
|
|
1579
|
-
static
|
|
1959
|
+
/** @returns {ManagerResult} */
|
|
1960
|
+
static ManagerResult() {
|
|
1580
1961
|
return Joi.object({
|
|
1581
1962
|
email: Joi.string().allow(""),
|
|
1582
1963
|
mobile_no: ServiceabilityPlatformModel.MobileNo(),
|
|
@@ -1584,39 +1965,39 @@ class ServiceabilityPlatformModel {
|
|
|
1584
1965
|
});
|
|
1585
1966
|
}
|
|
1586
1967
|
|
|
1587
|
-
/** @returns {
|
|
1588
|
-
static
|
|
1968
|
+
/** @returns {ModifiedByResult} */
|
|
1969
|
+
static ModifiedByResult() {
|
|
1589
1970
|
return Joi.object({
|
|
1590
1971
|
username: Joi.string().allow(""),
|
|
1591
1972
|
user_id: Joi.string().allow(""),
|
|
1592
1973
|
});
|
|
1593
1974
|
}
|
|
1594
1975
|
|
|
1595
|
-
/** @returns {
|
|
1596
|
-
static
|
|
1976
|
+
/** @returns {IntegrationTypeResult} */
|
|
1977
|
+
static IntegrationTypeResult() {
|
|
1597
1978
|
return Joi.object({
|
|
1598
1979
|
inventory: Joi.string().allow(""),
|
|
1599
1980
|
order: Joi.string().allow(""),
|
|
1600
1981
|
});
|
|
1601
1982
|
}
|
|
1602
1983
|
|
|
1603
|
-
/** @returns {
|
|
1604
|
-
static
|
|
1984
|
+
/** @returns {ProductReturnConfigResult} */
|
|
1985
|
+
static ProductReturnConfigResult() {
|
|
1605
1986
|
return Joi.object({
|
|
1606
1987
|
on_same_store: Joi.boolean(),
|
|
1607
1988
|
});
|
|
1608
1989
|
}
|
|
1609
1990
|
|
|
1610
|
-
/** @returns {
|
|
1611
|
-
static
|
|
1991
|
+
/** @returns {ContactNumberResult} */
|
|
1992
|
+
static ContactNumberResult() {
|
|
1612
1993
|
return Joi.object({
|
|
1613
1994
|
number: Joi.string().allow(""),
|
|
1614
1995
|
country_code: Joi.number(),
|
|
1615
1996
|
});
|
|
1616
1997
|
}
|
|
1617
1998
|
|
|
1618
|
-
/** @returns {
|
|
1619
|
-
static
|
|
1999
|
+
/** @returns {AddressResult} */
|
|
2000
|
+
static AddressResult() {
|
|
1620
2001
|
return Joi.object({
|
|
1621
2002
|
city: Joi.string().allow(""),
|
|
1622
2003
|
address1: Joi.string().allow(""),
|
|
@@ -1630,38 +2011,38 @@ class ServiceabilityPlatformModel {
|
|
|
1630
2011
|
});
|
|
1631
2012
|
}
|
|
1632
2013
|
|
|
1633
|
-
/** @returns {
|
|
1634
|
-
static
|
|
2014
|
+
/** @returns {CreatedByResult} */
|
|
2015
|
+
static CreatedByResult() {
|
|
1635
2016
|
return Joi.object({
|
|
1636
2017
|
username: Joi.string().allow(""),
|
|
1637
2018
|
user_id: Joi.string().allow(""),
|
|
1638
2019
|
});
|
|
1639
2020
|
}
|
|
1640
2021
|
|
|
1641
|
-
/** @returns {
|
|
1642
|
-
static
|
|
2022
|
+
/** @returns {EwayBillResult} */
|
|
2023
|
+
static EwayBillResult() {
|
|
1643
2024
|
return Joi.object({
|
|
1644
2025
|
enabled: Joi.boolean(),
|
|
1645
2026
|
});
|
|
1646
2027
|
}
|
|
1647
2028
|
|
|
1648
|
-
/** @returns {
|
|
1649
|
-
static
|
|
2029
|
+
/** @returns {EinvoiceResult} */
|
|
2030
|
+
static EinvoiceResult() {
|
|
1650
2031
|
return Joi.object({
|
|
1651
2032
|
enabled: Joi.boolean(),
|
|
1652
2033
|
});
|
|
1653
2034
|
}
|
|
1654
2035
|
|
|
1655
|
-
/** @returns {
|
|
1656
|
-
static
|
|
2036
|
+
/** @returns {GstCredentialsResult} */
|
|
2037
|
+
static GstCredentialsResult() {
|
|
1657
2038
|
return Joi.object({
|
|
1658
|
-
e_waybill: ServiceabilityPlatformModel.
|
|
1659
|
-
e_invoice: ServiceabilityPlatformModel.
|
|
2039
|
+
e_waybill: ServiceabilityPlatformModel.EwayBillResult(),
|
|
2040
|
+
e_invoice: ServiceabilityPlatformModel.EinvoiceResult(),
|
|
1660
2041
|
});
|
|
1661
2042
|
}
|
|
1662
2043
|
|
|
1663
|
-
/** @returns {
|
|
1664
|
-
static
|
|
2044
|
+
/** @returns {WarningsResult} */
|
|
2045
|
+
static WarningsResult() {
|
|
1665
2046
|
return Joi.object({
|
|
1666
2047
|
store_address: Joi.string().allow(""),
|
|
1667
2048
|
});
|
|
@@ -1675,8 +2056,8 @@ class ServiceabilityPlatformModel {
|
|
|
1675
2056
|
});
|
|
1676
2057
|
}
|
|
1677
2058
|
|
|
1678
|
-
/** @returns {
|
|
1679
|
-
static
|
|
2059
|
+
/** @returns {TimmingResult} */
|
|
2060
|
+
static TimmingResult() {
|
|
1680
2061
|
return Joi.object({
|
|
1681
2062
|
open: Joi.boolean(),
|
|
1682
2063
|
weekday: Joi.string().allow(""),
|
|
@@ -1685,8 +2066,8 @@ class ServiceabilityPlatformModel {
|
|
|
1685
2066
|
});
|
|
1686
2067
|
}
|
|
1687
2068
|
|
|
1688
|
-
/** @returns {
|
|
1689
|
-
static
|
|
2069
|
+
/** @returns {DocumentsResult} */
|
|
2070
|
+
static DocumentsResult() {
|
|
1690
2071
|
return Joi.object({
|
|
1691
2072
|
legal_name: Joi.string().allow(""),
|
|
1692
2073
|
value: Joi.string().allow(""),
|
|
@@ -1711,57 +2092,57 @@ class ServiceabilityPlatformModel {
|
|
|
1711
2092
|
});
|
|
1712
2093
|
}
|
|
1713
2094
|
|
|
1714
|
-
/** @returns {
|
|
1715
|
-
static
|
|
2095
|
+
/** @returns {LogisticsResult} */
|
|
2096
|
+
static LogisticsResult() {
|
|
1716
2097
|
return Joi.object({
|
|
1717
2098
|
override: Joi.boolean(),
|
|
1718
2099
|
dp: ServiceabilityPlatformModel.Dp(),
|
|
1719
2100
|
});
|
|
1720
2101
|
}
|
|
1721
2102
|
|
|
1722
|
-
/** @returns {
|
|
1723
|
-
static
|
|
2103
|
+
/** @returns {ItemResult} */
|
|
2104
|
+
static ItemResult() {
|
|
1724
2105
|
return Joi.object({
|
|
1725
2106
|
created_on: Joi.string().allow(""),
|
|
1726
|
-
manager: ServiceabilityPlatformModel.
|
|
1727
|
-
modified_by: ServiceabilityPlatformModel.
|
|
1728
|
-
integration_type: ServiceabilityPlatformModel.
|
|
2107
|
+
manager: ServiceabilityPlatformModel.ManagerResult(),
|
|
2108
|
+
modified_by: ServiceabilityPlatformModel.ModifiedByResult(),
|
|
2109
|
+
integration_type: ServiceabilityPlatformModel.IntegrationTypeResult(),
|
|
1729
2110
|
verified_on: Joi.string().allow(""),
|
|
1730
|
-
product_return_config: ServiceabilityPlatformModel.
|
|
2111
|
+
product_return_config: ServiceabilityPlatformModel.ProductReturnConfigResult(),
|
|
1731
2112
|
contact_numbers: Joi.array().items(
|
|
1732
|
-
ServiceabilityPlatformModel.
|
|
2113
|
+
ServiceabilityPlatformModel.ContactNumberResult()
|
|
1733
2114
|
),
|
|
1734
|
-
verified_by: ServiceabilityPlatformModel.
|
|
2115
|
+
verified_by: ServiceabilityPlatformModel.ModifiedByResult(),
|
|
1735
2116
|
stage: Joi.string().allow(""),
|
|
1736
|
-
address: ServiceabilityPlatformModel.
|
|
2117
|
+
address: ServiceabilityPlatformModel.AddressResult(),
|
|
1737
2118
|
modified_on: Joi.string().allow(""),
|
|
1738
|
-
created_by: ServiceabilityPlatformModel.
|
|
1739
|
-
gst_credentials: ServiceabilityPlatformModel.
|
|
2119
|
+
created_by: ServiceabilityPlatformModel.CreatedByResult(),
|
|
2120
|
+
gst_credentials: ServiceabilityPlatformModel.GstCredentialsResult(),
|
|
1740
2121
|
display_name: Joi.string().allow(""),
|
|
1741
2122
|
company_id: Joi.number(),
|
|
1742
2123
|
uid: Joi.number(),
|
|
1743
|
-
_custom_json: Joi.any(),
|
|
2124
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
1744
2125
|
code: Joi.string().allow(""),
|
|
1745
|
-
warnings: ServiceabilityPlatformModel.
|
|
2126
|
+
warnings: ServiceabilityPlatformModel.WarningsResult(),
|
|
1746
2127
|
name: Joi.string().allow(""),
|
|
1747
|
-
timing: Joi.array().items(ServiceabilityPlatformModel.
|
|
2128
|
+
timing: Joi.array().items(ServiceabilityPlatformModel.TimmingResult()),
|
|
1748
2129
|
documents: Joi.array().items(
|
|
1749
|
-
ServiceabilityPlatformModel.
|
|
2130
|
+
ServiceabilityPlatformModel.DocumentsResult()
|
|
1750
2131
|
),
|
|
1751
2132
|
store_type: Joi.string().allow(""),
|
|
1752
2133
|
sub_type: Joi.string().allow(""),
|
|
1753
2134
|
company: Joi.number(),
|
|
1754
2135
|
_cls: Joi.string().allow(""),
|
|
1755
|
-
logistics: ServiceabilityPlatformModel.
|
|
2136
|
+
logistics: ServiceabilityPlatformModel.LogisticsResult(),
|
|
1756
2137
|
notification_emails: Joi.array().items(Joi.string().allow("")),
|
|
1757
2138
|
});
|
|
1758
2139
|
}
|
|
1759
2140
|
|
|
1760
|
-
/** @returns {
|
|
1761
|
-
static
|
|
2141
|
+
/** @returns {GetStoresViewResult} */
|
|
2142
|
+
static GetStoresViewResult() {
|
|
1762
2143
|
return Joi.object({
|
|
1763
|
-
page: ServiceabilityPlatformModel.
|
|
1764
|
-
items: Joi.array().items(ServiceabilityPlatformModel.
|
|
2144
|
+
page: ServiceabilityPlatformModel.ServiceabilityPageResult().required(),
|
|
2145
|
+
items: Joi.array().items(ServiceabilityPlatformModel.ItemResult()),
|
|
1765
2146
|
});
|
|
1766
2147
|
}
|
|
1767
2148
|
|
|
@@ -1774,8 +2155,8 @@ class ServiceabilityPlatformModel {
|
|
|
1774
2155
|
});
|
|
1775
2156
|
}
|
|
1776
2157
|
|
|
1777
|
-
/** @returns {
|
|
1778
|
-
static
|
|
2158
|
+
/** @returns {PincodeMopUpdateResult} */
|
|
2159
|
+
static PincodeMopUpdateResult() {
|
|
1779
2160
|
return Joi.object({
|
|
1780
2161
|
pincode: Joi.number().required(),
|
|
1781
2162
|
channel_id: Joi.string().allow("").required(),
|
|
@@ -1784,8 +2165,8 @@ class ServiceabilityPlatformModel {
|
|
|
1784
2165
|
});
|
|
1785
2166
|
}
|
|
1786
2167
|
|
|
1787
|
-
/** @returns {
|
|
1788
|
-
static
|
|
2168
|
+
/** @returns {PincodeMOPResult} */
|
|
2169
|
+
static PincodeMOPResult() {
|
|
1789
2170
|
return Joi.object({
|
|
1790
2171
|
success: Joi.boolean().required(),
|
|
1791
2172
|
status_code: Joi.number().required(),
|
|
@@ -1794,7 +2175,7 @@ class ServiceabilityPlatformModel {
|
|
|
1794
2175
|
action: Joi.string().allow("").required(),
|
|
1795
2176
|
pincodes: Joi.array().items(Joi.number()),
|
|
1796
2177
|
updated_pincodes: Joi.array().items(
|
|
1797
|
-
ServiceabilityPlatformModel.
|
|
2178
|
+
ServiceabilityPlatformModel.PincodeMopUpdateResult()
|
|
1798
2179
|
),
|
|
1799
2180
|
});
|
|
1800
2181
|
}
|
|
@@ -1816,16 +2197,16 @@ class ServiceabilityPlatformModel {
|
|
|
1816
2197
|
});
|
|
1817
2198
|
}
|
|
1818
2199
|
|
|
1819
|
-
/** @returns {
|
|
1820
|
-
static
|
|
2200
|
+
/** @returns {PincodeBulkViewResult} */
|
|
2201
|
+
static PincodeBulkViewResult() {
|
|
1821
2202
|
return Joi.object({
|
|
1822
2203
|
batch_id: Joi.string().allow("").required(),
|
|
1823
2204
|
s3_url: Joi.string().allow("").required(),
|
|
1824
2205
|
});
|
|
1825
2206
|
}
|
|
1826
2207
|
|
|
1827
|
-
/** @returns {
|
|
1828
|
-
static
|
|
2208
|
+
/** @returns {PincodeCodStatusListingDetails} */
|
|
2209
|
+
static PincodeCodStatusListingDetails() {
|
|
1829
2210
|
return Joi.object({
|
|
1830
2211
|
country: Joi.string().allow(""),
|
|
1831
2212
|
is_active: Joi.boolean(),
|
|
@@ -1835,18 +2216,26 @@ class ServiceabilityPlatformModel {
|
|
|
1835
2216
|
});
|
|
1836
2217
|
}
|
|
1837
2218
|
|
|
1838
|
-
/** @returns {
|
|
1839
|
-
static
|
|
2219
|
+
/** @returns {PincodeCodStatusItem} */
|
|
2220
|
+
static PincodeCodStatusItem() {
|
|
2221
|
+
return Joi.object({
|
|
2222
|
+
active: Joi.boolean(),
|
|
2223
|
+
pincode: Joi.string().allow(""),
|
|
2224
|
+
});
|
|
2225
|
+
}
|
|
2226
|
+
|
|
2227
|
+
/** @returns {PincodeCodStatusListingResult} */
|
|
2228
|
+
static PincodeCodStatusListingResult() {
|
|
1840
2229
|
return Joi.object({
|
|
1841
2230
|
country: Joi.string().allow("").required(),
|
|
1842
2231
|
data: Joi.array()
|
|
1843
|
-
.items(Joi.link("#
|
|
2232
|
+
.items(Joi.link("#PincodeCodStatusListingResult"))
|
|
1844
2233
|
.required(),
|
|
1845
2234
|
success: Joi.boolean().required(),
|
|
1846
2235
|
errors: Joi.array().items(ServiceabilityPlatformModel.Error()),
|
|
1847
2236
|
page: ServiceabilityPlatformModel.PincodeCodStatusListingPage().required(),
|
|
1848
2237
|
summary: ServiceabilityPlatformModel.PincodeCodStatusListingSummary().required(),
|
|
1849
|
-
}).id("
|
|
2238
|
+
}).id("PincodeCodStatusListingResult");
|
|
1850
2239
|
}
|
|
1851
2240
|
|
|
1852
2241
|
/** @returns {Error} */
|
|
@@ -1877,8 +2266,8 @@ class ServiceabilityPlatformModel {
|
|
|
1877
2266
|
});
|
|
1878
2267
|
}
|
|
1879
2268
|
|
|
1880
|
-
/** @returns {
|
|
1881
|
-
static
|
|
2269
|
+
/** @returns {PincodeMopUpdateAuditHistoryDetails} */
|
|
2270
|
+
static PincodeMopUpdateAuditHistoryDetails() {
|
|
1882
2271
|
return Joi.object({
|
|
1883
2272
|
entity_type: Joi.string().allow("").required(),
|
|
1884
2273
|
file_name: Joi.string().allow(""),
|
|
@@ -1896,8 +2285,8 @@ class ServiceabilityPlatformModel {
|
|
|
1896
2285
|
});
|
|
1897
2286
|
}
|
|
1898
2287
|
|
|
1899
|
-
/** @returns {
|
|
1900
|
-
static
|
|
2288
|
+
/** @returns {PincodeMopUpdateAuditHistoryResult} */
|
|
2289
|
+
static PincodeMopUpdateAuditHistoryResult() {
|
|
1901
2290
|
return Joi.object({
|
|
1902
2291
|
batch_id: Joi.string().allow(""),
|
|
1903
2292
|
entity_type: Joi.string().allow(""),
|
|
@@ -1910,15 +2299,13 @@ class ServiceabilityPlatformModel {
|
|
|
1910
2299
|
});
|
|
1911
2300
|
}
|
|
1912
2301
|
|
|
1913
|
-
/** @returns {
|
|
1914
|
-
static
|
|
2302
|
+
/** @returns {PincodeMopUpdateAuditHistoryResultData} */
|
|
2303
|
+
static PincodeMopUpdateAuditHistoryResultData() {
|
|
1915
2304
|
return Joi.object({
|
|
1916
2305
|
entity_type: Joi.string().allow(""),
|
|
1917
2306
|
page: ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryPaging().required(),
|
|
1918
2307
|
data: Joi.array()
|
|
1919
|
-
.items(
|
|
1920
|
-
ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResponse()
|
|
1921
|
-
)
|
|
2308
|
+
.items(ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResult())
|
|
1922
2309
|
.required(),
|
|
1923
2310
|
});
|
|
1924
2311
|
}
|
|
@@ -1957,20 +2344,33 @@ class ServiceabilityPlatformModel {
|
|
|
1957
2344
|
});
|
|
1958
2345
|
}
|
|
1959
2346
|
|
|
2347
|
+
/** @returns {CourierAccountUpdateDetails} */
|
|
2348
|
+
static CourierAccountUpdateDetails() {
|
|
2349
|
+
return Joi.object({
|
|
2350
|
+
extension_id: Joi.string().allow("").required(),
|
|
2351
|
+
scheme_id: Joi.string().allow("").required(),
|
|
2352
|
+
is_self_ship: Joi.boolean().required(),
|
|
2353
|
+
stage: Joi.string().allow("").required(),
|
|
2354
|
+
is_own_account: Joi.boolean().required(),
|
|
2355
|
+
});
|
|
2356
|
+
}
|
|
2357
|
+
|
|
1960
2358
|
/** @returns {CourierAccount} */
|
|
1961
2359
|
static CourierAccount() {
|
|
1962
2360
|
return Joi.object({
|
|
2361
|
+
company_id: Joi.number().required(),
|
|
1963
2362
|
extension_id: Joi.string().allow("").required(),
|
|
1964
2363
|
account_id: Joi.string().allow("").required(),
|
|
1965
2364
|
scheme_id: Joi.string().allow("").required(),
|
|
1966
2365
|
is_self_ship: Joi.boolean().required(),
|
|
1967
2366
|
stage: Joi.string().allow("").required(),
|
|
1968
2367
|
is_own_account: Joi.boolean().required(),
|
|
2368
|
+
scheme_rules: ServiceabilityPlatformModel.CourierPartnerSchemeModel().required(),
|
|
1969
2369
|
});
|
|
1970
2370
|
}
|
|
1971
2371
|
|
|
1972
|
-
/** @returns {
|
|
1973
|
-
static
|
|
2372
|
+
/** @returns {CourierAccountDetailsBody} */
|
|
2373
|
+
static CourierAccountDetailsBody() {
|
|
1974
2374
|
return Joi.object({
|
|
1975
2375
|
extension_id: Joi.string().allow("").required(),
|
|
1976
2376
|
account_id: Joi.string().allow(""),
|
|
@@ -1981,8 +2381,8 @@ class ServiceabilityPlatformModel {
|
|
|
1981
2381
|
});
|
|
1982
2382
|
}
|
|
1983
2383
|
|
|
1984
|
-
/** @returns {
|
|
1985
|
-
static
|
|
2384
|
+
/** @returns {ErrorResult} */
|
|
2385
|
+
static ErrorResult() {
|
|
1986
2386
|
return Joi.object({
|
|
1987
2387
|
value: Joi.string().allow("").required(),
|
|
1988
2388
|
message: Joi.string().allow("").required(),
|
|
@@ -1990,12 +2390,12 @@ class ServiceabilityPlatformModel {
|
|
|
1990
2390
|
});
|
|
1991
2391
|
}
|
|
1992
2392
|
|
|
1993
|
-
/** @returns {
|
|
1994
|
-
static
|
|
2393
|
+
/** @returns {CourierPartnerAccountFailureResult} */
|
|
2394
|
+
static CourierPartnerAccountFailureResult() {
|
|
1995
2395
|
return Joi.object({
|
|
1996
2396
|
success: Joi.boolean().required(),
|
|
1997
2397
|
error: Joi.array()
|
|
1998
|
-
.items(ServiceabilityPlatformModel.
|
|
2398
|
+
.items(ServiceabilityPlatformModel.ErrorResult())
|
|
1999
2399
|
.required(),
|
|
2000
2400
|
});
|
|
2001
2401
|
}
|
|
@@ -2013,32 +2413,32 @@ class ServiceabilityPlatformModel {
|
|
|
2013
2413
|
});
|
|
2014
2414
|
}
|
|
2015
2415
|
|
|
2016
|
-
/** @returns {
|
|
2017
|
-
static
|
|
2416
|
+
/** @returns {CourierPartnerRuleCPListResult} */
|
|
2417
|
+
static CourierPartnerRuleCPListResult() {
|
|
2018
2418
|
return Joi.object({
|
|
2019
|
-
account_id: Joi.string().allow(""),
|
|
2020
|
-
extension_id: Joi.string().allow(""),
|
|
2021
|
-
is_self_ship: Joi.boolean(),
|
|
2022
|
-
scheme_rules: Joi.any(),
|
|
2419
|
+
account_id: Joi.string().allow("").required(),
|
|
2420
|
+
extension_id: Joi.string().allow("").required(),
|
|
2421
|
+
is_self_ship: Joi.boolean().required(),
|
|
2422
|
+
scheme_rules: Joi.object().pattern(/\S/, Joi.any()),
|
|
2023
2423
|
});
|
|
2024
2424
|
}
|
|
2025
2425
|
|
|
2026
|
-
/** @returns {
|
|
2027
|
-
static
|
|
2426
|
+
/** @returns {CourierPartnerRuleResult} */
|
|
2427
|
+
static CourierPartnerRuleResult() {
|
|
2028
2428
|
return Joi.object({
|
|
2029
|
-
is_active: Joi.boolean(),
|
|
2030
|
-
application_id: Joi.string().allow(""),
|
|
2031
|
-
company_id: Joi.number(),
|
|
2032
|
-
conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions(),
|
|
2033
|
-
sort: Joi.array().items(Joi.string().allow("")),
|
|
2034
|
-
created_by: Joi.any().allow(null),
|
|
2035
|
-
id: Joi.string().allow(""),
|
|
2036
|
-
modified_by: Joi.any().allow(null),
|
|
2429
|
+
is_active: Joi.boolean().required(),
|
|
2430
|
+
application_id: Joi.string().allow("").required(),
|
|
2431
|
+
company_id: Joi.number().required(),
|
|
2432
|
+
conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions().required(),
|
|
2433
|
+
sort: Joi.array().items(Joi.string().allow("")).required(),
|
|
2434
|
+
created_by: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
2435
|
+
id: Joi.string().allow("").required(),
|
|
2436
|
+
modified_by: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
2037
2437
|
modified_on: Joi.string().allow("").allow(null),
|
|
2038
|
-
name: Joi.string().allow(""),
|
|
2039
|
-
type: Joi.string().allow(""),
|
|
2438
|
+
name: Joi.string().allow("").required(),
|
|
2439
|
+
type: Joi.string().allow("").required(),
|
|
2040
2440
|
cp_list: Joi.array().items(
|
|
2041
|
-
ServiceabilityPlatformModel.
|
|
2441
|
+
ServiceabilityPlatformModel.CourierPartnerRuleCPListResult()
|
|
2042
2442
|
),
|
|
2043
2443
|
});
|
|
2044
2444
|
}
|
|
@@ -2058,7 +2458,7 @@ class ServiceabilityPlatformModel {
|
|
|
2058
2458
|
sub_type: Joi.string().allow(""),
|
|
2059
2459
|
name: Joi.string().allow(""),
|
|
2060
2460
|
display_name: Joi.string().allow(""),
|
|
2061
|
-
parent_id: Joi.string().allow(""),
|
|
2461
|
+
parent_id: Joi.array().items(Joi.string().allow("")),
|
|
2062
2462
|
parent_ids: Joi.array().items(Joi.string().allow("")),
|
|
2063
2463
|
});
|
|
2064
2464
|
}
|
|
@@ -2119,35 +2519,137 @@ class ServiceabilityPlatformModel {
|
|
|
2119
2519
|
name: Joi.string().allow("").required(),
|
|
2120
2520
|
conditions: ServiceabilityPlatformModel.CourierPartnerRuleConditions().required(),
|
|
2121
2521
|
sort: Joi.array().items(Joi.string().allow("")).required(),
|
|
2522
|
+
type: Joi.string().allow(""),
|
|
2122
2523
|
});
|
|
2123
2524
|
}
|
|
2124
2525
|
|
|
2125
|
-
/** @returns {
|
|
2126
|
-
static
|
|
2526
|
+
/** @returns {FailureResult} */
|
|
2527
|
+
static FailureResult() {
|
|
2127
2528
|
return Joi.object({
|
|
2128
2529
|
success: Joi.boolean().required(),
|
|
2129
2530
|
error: Joi.array()
|
|
2130
|
-
.items(ServiceabilityPlatformModel.
|
|
2531
|
+
.items(ServiceabilityPlatformModel.ErrorResult())
|
|
2131
2532
|
.required(),
|
|
2132
2533
|
});
|
|
2133
2534
|
}
|
|
2134
2535
|
|
|
2135
|
-
/** @returns {
|
|
2136
|
-
static
|
|
2536
|
+
/** @returns {CourierPartnerRulesListResult} */
|
|
2537
|
+
static CourierPartnerRulesListResult() {
|
|
2137
2538
|
return Joi.object({
|
|
2138
2539
|
items: Joi.array()
|
|
2139
|
-
.items(ServiceabilityPlatformModel.
|
|
2540
|
+
.items(ServiceabilityPlatformModel.CourierPartnerRuleResult())
|
|
2140
2541
|
.required(),
|
|
2141
2542
|
page: ServiceabilityPlatformModel.Page().required(),
|
|
2142
2543
|
});
|
|
2143
2544
|
}
|
|
2144
2545
|
|
|
2546
|
+
/** @returns {ShipmentsArticles} */
|
|
2547
|
+
static ShipmentsArticles() {
|
|
2548
|
+
return Joi.object({
|
|
2549
|
+
item_id: Joi.number(),
|
|
2550
|
+
category_id: Joi.number(),
|
|
2551
|
+
brand_id: Joi.number(),
|
|
2552
|
+
department_id: Joi.number(),
|
|
2553
|
+
tags: Joi.array().items(Joi.string().allow("")),
|
|
2554
|
+
});
|
|
2555
|
+
}
|
|
2556
|
+
|
|
2557
|
+
/** @returns {ShipmentDimension} */
|
|
2558
|
+
static ShipmentDimension() {
|
|
2559
|
+
return Joi.object({
|
|
2560
|
+
height: Joi.number().required(),
|
|
2561
|
+
length: Joi.number().required(),
|
|
2562
|
+
width: Joi.number().required(),
|
|
2563
|
+
});
|
|
2564
|
+
}
|
|
2565
|
+
|
|
2566
|
+
/** @returns {Shipments} */
|
|
2567
|
+
static Shipments() {
|
|
2568
|
+
return Joi.object({
|
|
2569
|
+
id: Joi.string().allow(""),
|
|
2570
|
+
location_id: Joi.number(),
|
|
2571
|
+
location_tags: Joi.array().items(Joi.string().allow("")),
|
|
2572
|
+
shipment_weight: Joi.number(),
|
|
2573
|
+
shipment_volumetric_weight: Joi.number(),
|
|
2574
|
+
shipment_cost: Joi.number(),
|
|
2575
|
+
shipment_dimension: ServiceabilityPlatformModel.ShipmentDimension(),
|
|
2576
|
+
courier_partner_schemes: Joi.array().items(Joi.string().allow("")),
|
|
2577
|
+
articles: Joi.array().items(
|
|
2578
|
+
ServiceabilityPlatformModel.ShipmentsArticles()
|
|
2579
|
+
),
|
|
2580
|
+
});
|
|
2581
|
+
}
|
|
2582
|
+
|
|
2583
|
+
/** @returns {ShipmentCourierPartnerDetails} */
|
|
2584
|
+
static ShipmentCourierPartnerDetails() {
|
|
2585
|
+
return Joi.object({
|
|
2586
|
+
from_location: ServiceabilityPlatformModel.ShipmentsCourierPartnersServiceability().required(),
|
|
2587
|
+
to_location: ServiceabilityPlatformModel.ShipmentsCourierPartnersServiceability().required(),
|
|
2588
|
+
shipments: Joi.array().items(ServiceabilityPlatformModel.Shipments()),
|
|
2589
|
+
journey: Joi.string().allow(""),
|
|
2590
|
+
payment_mode: Joi.string().allow(""),
|
|
2591
|
+
});
|
|
2592
|
+
}
|
|
2593
|
+
|
|
2594
|
+
/** @returns {CourierPartnerPromise} */
|
|
2595
|
+
static CourierPartnerPromise() {
|
|
2596
|
+
return Joi.object({
|
|
2597
|
+
min: Joi.string().allow("").required(),
|
|
2598
|
+
max: Joi.string().allow("").required(),
|
|
2599
|
+
});
|
|
2600
|
+
}
|
|
2601
|
+
|
|
2602
|
+
/** @returns {CourierPartners} */
|
|
2603
|
+
static CourierPartners() {
|
|
2604
|
+
return Joi.object({
|
|
2605
|
+
extension_id: Joi.string().allow(""),
|
|
2606
|
+
scheme_id: Joi.string().allow(""),
|
|
2607
|
+
name: Joi.string().allow(""),
|
|
2608
|
+
delivery_promise: ServiceabilityPlatformModel.CourierPartnerPromise(),
|
|
2609
|
+
});
|
|
2610
|
+
}
|
|
2611
|
+
|
|
2612
|
+
/** @returns {ShipmentCourierPartners} */
|
|
2613
|
+
static ShipmentCourierPartners() {
|
|
2614
|
+
return Joi.object({
|
|
2615
|
+
id: Joi.string().allow(""),
|
|
2616
|
+
courier_partners: Joi.array().items(
|
|
2617
|
+
ServiceabilityPlatformModel.CourierPartners()
|
|
2618
|
+
),
|
|
2619
|
+
});
|
|
2620
|
+
}
|
|
2621
|
+
|
|
2622
|
+
/** @returns {ShipmentCourierPartnerResult} */
|
|
2623
|
+
static ShipmentCourierPartnerResult() {
|
|
2624
|
+
return Joi.object({
|
|
2625
|
+
courier_partners: Joi.array().items(
|
|
2626
|
+
ServiceabilityPlatformModel.CourierPartners()
|
|
2627
|
+
),
|
|
2628
|
+
shipments: Joi.array().items(
|
|
2629
|
+
ServiceabilityPlatformModel.ShipmentCourierPartners()
|
|
2630
|
+
),
|
|
2631
|
+
});
|
|
2632
|
+
}
|
|
2633
|
+
|
|
2634
|
+
/** @returns {ShipmentsCourierPartnersServiceability} */
|
|
2635
|
+
static ShipmentsCourierPartnersServiceability() {
|
|
2636
|
+
return Joi.object({
|
|
2637
|
+
pincode: Joi.string().allow(""),
|
|
2638
|
+
sector_code: Joi.string().allow(""),
|
|
2639
|
+
state_code: Joi.string().allow(""),
|
|
2640
|
+
city_code: Joi.string().allow(""),
|
|
2641
|
+
country_code: Joi.string().allow("").required(),
|
|
2642
|
+
});
|
|
2643
|
+
}
|
|
2644
|
+
|
|
2145
2645
|
/** @returns {CompanyConfig} */
|
|
2146
2646
|
static CompanyConfig() {
|
|
2147
2647
|
return Joi.object({
|
|
2148
2648
|
rule_ids: Joi.array().items(Joi.string().allow("")).required(),
|
|
2149
2649
|
sort: Joi.array().items(Joi.string().allow("")).required(),
|
|
2150
|
-
logistics_as_actual: Joi.
|
|
2650
|
+
logistics_as_actual: Joi.string().allow(""),
|
|
2651
|
+
company_id: Joi.number().required(),
|
|
2652
|
+
application_id: Joi.string().allow(""),
|
|
2151
2653
|
});
|
|
2152
2654
|
}
|
|
2153
2655
|
|
|
@@ -2155,6 +2657,8 @@ class ServiceabilityPlatformModel {
|
|
|
2155
2657
|
static ZoneConfig() {
|
|
2156
2658
|
return Joi.object({
|
|
2157
2659
|
serviceability_type: Joi.string().allow(""),
|
|
2660
|
+
active_count: Joi.number(),
|
|
2661
|
+
total_count: Joi.number(),
|
|
2158
2662
|
});
|
|
2159
2663
|
}
|
|
2160
2664
|
|
|
@@ -2167,22 +2671,22 @@ class ServiceabilityPlatformModel {
|
|
|
2167
2671
|
});
|
|
2168
2672
|
}
|
|
2169
2673
|
|
|
2170
|
-
/** @returns {
|
|
2171
|
-
static
|
|
2674
|
+
/** @returns {BulkRegionJobDetails} */
|
|
2675
|
+
static BulkRegionJobDetails() {
|
|
2172
2676
|
return Joi.object({
|
|
2173
|
-
file_path: Joi.string().allow(""),
|
|
2677
|
+
file_path: Joi.string().allow("").allow(null),
|
|
2174
2678
|
country: Joi.string().allow("").required(),
|
|
2175
2679
|
action: Joi.string().allow("").required(),
|
|
2176
2680
|
region: Joi.string().allow("").required(),
|
|
2177
2681
|
});
|
|
2178
2682
|
}
|
|
2179
2683
|
|
|
2180
|
-
/** @returns {
|
|
2181
|
-
static
|
|
2684
|
+
/** @returns {BulkRegionResultItemData} */
|
|
2685
|
+
static BulkRegionResultItemData() {
|
|
2182
2686
|
return Joi.object({
|
|
2183
|
-
file_path: Joi.string().allow("")
|
|
2687
|
+
file_path: Joi.string().allow(""),
|
|
2184
2688
|
failed: Joi.number(),
|
|
2185
|
-
failed_records: Joi.array().items(Joi.any()),
|
|
2689
|
+
failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
2186
2690
|
action: Joi.string().allow("").required(),
|
|
2187
2691
|
batch_id: Joi.string().allow("").required(),
|
|
2188
2692
|
country: Joi.string().allow("").required(),
|
|
@@ -2194,18 +2698,18 @@ class ServiceabilityPlatformModel {
|
|
|
2194
2698
|
});
|
|
2195
2699
|
}
|
|
2196
2700
|
|
|
2197
|
-
/** @returns {
|
|
2198
|
-
static
|
|
2701
|
+
/** @returns {BulkRegionResult} */
|
|
2702
|
+
static BulkRegionResult() {
|
|
2199
2703
|
return Joi.object({
|
|
2200
2704
|
items: Joi.array()
|
|
2201
|
-
.items(ServiceabilityPlatformModel.
|
|
2705
|
+
.items(ServiceabilityPlatformModel.BulkRegionResultItemData())
|
|
2202
2706
|
.required(),
|
|
2203
2707
|
page: ServiceabilityPlatformModel.Page().required(),
|
|
2204
2708
|
});
|
|
2205
2709
|
}
|
|
2206
2710
|
|
|
2207
|
-
/** @returns {
|
|
2208
|
-
static
|
|
2711
|
+
/** @returns {SelfShipResult} */
|
|
2712
|
+
static SelfShipResult() {
|
|
2209
2713
|
return Joi.object({
|
|
2210
2714
|
is_active: Joi.boolean().required(),
|
|
2211
2715
|
tat: Joi.number().required(),
|
|
@@ -2215,14 +2719,14 @@ class ServiceabilityPlatformModel {
|
|
|
2215
2719
|
/** @returns {ApplicationSelfShipConfig} */
|
|
2216
2720
|
static ApplicationSelfShipConfig() {
|
|
2217
2721
|
return Joi.object({
|
|
2218
|
-
self_ship:
|
|
2722
|
+
self_ship: ServiceabilityPlatformModel.SelfShipResult(),
|
|
2219
2723
|
});
|
|
2220
2724
|
}
|
|
2221
2725
|
|
|
2222
|
-
/** @returns {
|
|
2223
|
-
static
|
|
2726
|
+
/** @returns {ApplicationSelfShipConfigResult} */
|
|
2727
|
+
static ApplicationSelfShipConfigResult() {
|
|
2224
2728
|
return Joi.object({
|
|
2225
|
-
error: ServiceabilityPlatformModel.
|
|
2729
|
+
error: ServiceabilityPlatformModel.ServiceabilityErrorResult(),
|
|
2226
2730
|
data: ServiceabilityPlatformModel.ApplicationSelfShipConfig(),
|
|
2227
2731
|
success: Joi.boolean().required(),
|
|
2228
2732
|
});
|
|
@@ -2290,13 +2794,13 @@ class ServiceabilityPlatformModel {
|
|
|
2290
2794
|
/** @returns {StorePrioritySchema} */
|
|
2291
2795
|
static StorePrioritySchema() {
|
|
2292
2796
|
return Joi.object({
|
|
2293
|
-
id: Joi.
|
|
2797
|
+
id: Joi.number(),
|
|
2294
2798
|
name: Joi.string().allow(""),
|
|
2295
2799
|
});
|
|
2296
2800
|
}
|
|
2297
2801
|
|
|
2298
|
-
/** @returns {
|
|
2299
|
-
static
|
|
2802
|
+
/** @returns {GetStoreRulesApiResult} */
|
|
2803
|
+
static GetStoreRulesApiResult() {
|
|
2300
2804
|
return Joi.object({
|
|
2301
2805
|
items: Joi.array().items(
|
|
2302
2806
|
ServiceabilityPlatformModel.StoreRuleDataSchema()
|
|
@@ -2305,8 +2809,8 @@ class ServiceabilityPlatformModel {
|
|
|
2305
2809
|
});
|
|
2306
2810
|
}
|
|
2307
2811
|
|
|
2308
|
-
/** @returns {
|
|
2309
|
-
static
|
|
2812
|
+
/** @returns {CreateStoreRuleDetailsSchema} */
|
|
2813
|
+
static CreateStoreRuleDetailsSchema() {
|
|
2310
2814
|
return Joi.object({
|
|
2311
2815
|
name: Joi.string().allow(""),
|
|
2312
2816
|
is_active: Joi.boolean(),
|
|
@@ -2320,8 +2824,8 @@ class ServiceabilityPlatformModel {
|
|
|
2320
2824
|
});
|
|
2321
2825
|
}
|
|
2322
2826
|
|
|
2323
|
-
/** @returns {
|
|
2324
|
-
static
|
|
2827
|
+
/** @returns {StoreRuleResultSchema} */
|
|
2828
|
+
static StoreRuleResultSchema() {
|
|
2325
2829
|
return Joi.object({
|
|
2326
2830
|
id: Joi.string().allow(""),
|
|
2327
2831
|
name: Joi.string().allow(""),
|
|
@@ -2337,8 +2841,8 @@ class ServiceabilityPlatformModel {
|
|
|
2337
2841
|
});
|
|
2338
2842
|
}
|
|
2339
2843
|
|
|
2340
|
-
/** @returns {
|
|
2341
|
-
static
|
|
2844
|
+
/** @returns {StoreRuleUpdateResultSchema} */
|
|
2845
|
+
static StoreRuleUpdateResultSchema() {
|
|
2342
2846
|
return Joi.object({
|
|
2343
2847
|
id: Joi.string().allow(""),
|
|
2344
2848
|
name: Joi.string().allow(""),
|
|
@@ -2361,9 +2865,10 @@ class ServiceabilityPlatformModel {
|
|
|
2361
2865
|
return Joi.object({
|
|
2362
2866
|
lm_cod_limit: Joi.number().required(),
|
|
2363
2867
|
is_qc: Joi.boolean().required(),
|
|
2364
|
-
pickup_cutoff: Joi.string().allow("").allow(null)
|
|
2365
|
-
route_code: Joi.string().allow("").allow(null)
|
|
2868
|
+
pickup_cutoff: Joi.string().allow("").allow(null),
|
|
2869
|
+
route_code: Joi.string().allow("").allow(null),
|
|
2366
2870
|
is_first_mile: Joi.boolean().required(),
|
|
2871
|
+
is_reverse_pickup: Joi.boolean().allow(null),
|
|
2367
2872
|
is_return: Joi.boolean().required(),
|
|
2368
2873
|
is_installation: Joi.boolean().required(),
|
|
2369
2874
|
is_last_mile: Joi.boolean().required(),
|
|
@@ -2391,14 +2896,18 @@ class ServiceabilityPlatformModel {
|
|
|
2391
2896
|
single_pick_multi_drop: Joi.boolean(),
|
|
2392
2897
|
multi_pick_multi_drop: Joi.boolean(),
|
|
2393
2898
|
ewaybill: Joi.boolean(),
|
|
2899
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
2900
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
2394
2901
|
});
|
|
2395
2902
|
}
|
|
2396
2903
|
|
|
2397
2904
|
/** @returns {CourierPartnerSchemeModel} */
|
|
2398
2905
|
static CourierPartnerSchemeModel() {
|
|
2399
2906
|
return Joi.object({
|
|
2907
|
+
name: Joi.string().allow(""),
|
|
2400
2908
|
extension_id: Joi.string().allow("").required(),
|
|
2401
2909
|
scheme_id: Joi.string().allow("").required(),
|
|
2910
|
+
volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
2402
2911
|
weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
|
|
2403
2912
|
transport_type: Joi.string().allow("").required(),
|
|
2404
2913
|
region: Joi.string().allow("").required(),
|
|
@@ -2409,23 +2918,25 @@ class ServiceabilityPlatformModel {
|
|
|
2409
2918
|
});
|
|
2410
2919
|
}
|
|
2411
2920
|
|
|
2412
|
-
/** @returns {
|
|
2413
|
-
static
|
|
2921
|
+
/** @returns {CourierAccountResult} */
|
|
2922
|
+
static CourierAccountResult() {
|
|
2414
2923
|
return Joi.object({
|
|
2924
|
+
company_id: Joi.number().required(),
|
|
2925
|
+
extension_id: Joi.string().allow(""),
|
|
2415
2926
|
account_id: Joi.string().allow("").required(),
|
|
2416
2927
|
scheme_id: Joi.string().allow("").required(),
|
|
2417
2928
|
is_self_ship: Joi.boolean().required(),
|
|
2418
2929
|
stage: Joi.string().allow("").required(),
|
|
2419
2930
|
is_own_account: Joi.boolean().required(),
|
|
2420
|
-
scheme_rules: ServiceabilityPlatformModel.CourierPartnerSchemeModel()
|
|
2931
|
+
scheme_rules: ServiceabilityPlatformModel.CourierPartnerSchemeModel(),
|
|
2421
2932
|
});
|
|
2422
2933
|
}
|
|
2423
2934
|
|
|
2424
|
-
/** @returns {
|
|
2425
|
-
static
|
|
2935
|
+
/** @returns {CompanyCourierPartnerAccountListResult} */
|
|
2936
|
+
static CompanyCourierPartnerAccountListResult() {
|
|
2426
2937
|
return Joi.object({
|
|
2427
2938
|
items: Joi.array()
|
|
2428
|
-
.items(ServiceabilityPlatformModel.
|
|
2939
|
+
.items(ServiceabilityPlatformModel.CourierAccountResult())
|
|
2429
2940
|
.required(),
|
|
2430
2941
|
page: ServiceabilityPlatformModel.Page().required(),
|
|
2431
2942
|
});
|
|
@@ -2458,12 +2969,13 @@ class ServiceabilityPlatformModel {
|
|
|
2458
2969
|
});
|
|
2459
2970
|
}
|
|
2460
2971
|
|
|
2461
|
-
/** @returns {
|
|
2462
|
-
static
|
|
2972
|
+
/** @returns {PackageMaterialResult} */
|
|
2973
|
+
static PackageMaterialResult() {
|
|
2463
2974
|
return Joi.object({
|
|
2464
2975
|
name: Joi.string().allow("").required(),
|
|
2465
2976
|
id: Joi.string().allow(""),
|
|
2466
2977
|
item_id: Joi.number(),
|
|
2978
|
+
company_id: Joi.number(),
|
|
2467
2979
|
width: Joi.number().required(),
|
|
2468
2980
|
height: Joi.number().required(),
|
|
2469
2981
|
length: Joi.number().required(),
|
|
@@ -2509,8 +3021,8 @@ class ServiceabilityPlatformModel {
|
|
|
2509
3021
|
});
|
|
2510
3022
|
}
|
|
2511
3023
|
|
|
2512
|
-
/** @returns {
|
|
2513
|
-
static
|
|
3024
|
+
/** @returns {PackageRuleResult} */
|
|
3025
|
+
static PackageRuleResult() {
|
|
2514
3026
|
return Joi.object({
|
|
2515
3027
|
id: Joi.string().allow(""),
|
|
2516
3028
|
name: Joi.string().allow("").required(),
|
|
@@ -2534,7 +3046,7 @@ class ServiceabilityPlatformModel {
|
|
|
2534
3046
|
/** @returns {PackageMaterialRuleList} */
|
|
2535
3047
|
static PackageMaterialRuleList() {
|
|
2536
3048
|
return Joi.object({
|
|
2537
|
-
items: ServiceabilityPlatformModel.
|
|
3049
|
+
items: ServiceabilityPlatformModel.PackageRuleResult(),
|
|
2538
3050
|
page: ServiceabilityPlatformModel.Page(),
|
|
2539
3051
|
});
|
|
2540
3052
|
}
|
|
@@ -2542,7 +3054,7 @@ class ServiceabilityPlatformModel {
|
|
|
2542
3054
|
/** @returns {PackageMaterialList} */
|
|
2543
3055
|
static PackageMaterialList() {
|
|
2544
3056
|
return Joi.object({
|
|
2545
|
-
items: ServiceabilityPlatformModel.
|
|
3057
|
+
items: ServiceabilityPlatformModel.PackageMaterialResult(),
|
|
2546
3058
|
page: ServiceabilityPlatformModel.Page(),
|
|
2547
3059
|
});
|
|
2548
3060
|
}
|
|
@@ -2576,16 +3088,16 @@ class ServiceabilityPlatformModel {
|
|
|
2576
3088
|
});
|
|
2577
3089
|
}
|
|
2578
3090
|
|
|
2579
|
-
/** @returns {
|
|
2580
|
-
static
|
|
3091
|
+
/** @returns {RulePriorityDetails} */
|
|
3092
|
+
static RulePriorityDetails() {
|
|
2581
3093
|
return Joi.object({
|
|
2582
3094
|
rule_id: Joi.string().allow("").required(),
|
|
2583
3095
|
priority: Joi.number().required(),
|
|
2584
3096
|
});
|
|
2585
3097
|
}
|
|
2586
3098
|
|
|
2587
|
-
/** @returns {
|
|
2588
|
-
static
|
|
3099
|
+
/** @returns {RulePriorityResult} */
|
|
3100
|
+
static RulePriorityResult() {
|
|
2589
3101
|
return Joi.object({
|
|
2590
3102
|
success: Joi.boolean(),
|
|
2591
3103
|
});
|
|
@@ -2625,10 +3137,10 @@ class ServiceabilityPlatformModel {
|
|
|
2625
3137
|
return Joi.object({
|
|
2626
3138
|
item_id: Joi.number().required(),
|
|
2627
3139
|
size: Joi.string().allow("").required(),
|
|
2628
|
-
quantity: Joi.
|
|
3140
|
+
quantity: Joi.number().required(),
|
|
2629
3141
|
group_id: Joi.string().allow(""),
|
|
2630
3142
|
is_primary_item: Joi.boolean(),
|
|
2631
|
-
meta: Joi.any(),
|
|
3143
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
2632
3144
|
article_assignment: ServiceabilityPlatformModel.ArticleAssignment().required(),
|
|
2633
3145
|
ignore_locations: Joi.array().items(Joi.number()).required(),
|
|
2634
3146
|
assign_locations: Joi.array().items(Joi.number()).required(),
|
|
@@ -2636,26 +3148,28 @@ class ServiceabilityPlatformModel {
|
|
|
2636
3148
|
});
|
|
2637
3149
|
}
|
|
2638
3150
|
|
|
2639
|
-
/** @returns {
|
|
2640
|
-
static
|
|
3151
|
+
/** @returns {OptimlLocationsDetailsSchema} */
|
|
3152
|
+
static OptimlLocationsDetailsSchema() {
|
|
2641
3153
|
return Joi.object({
|
|
2642
3154
|
channel_id: Joi.string().allow("").required(),
|
|
2643
3155
|
channel_type: Joi.string().allow("").required(),
|
|
2644
3156
|
channel_identifier: Joi.string().allow(""),
|
|
2645
3157
|
to_serviceability: ServiceabilityPlatformModel.LocationDetailsServiceability().required(),
|
|
2646
|
-
|
|
3158
|
+
articles: Joi.array().items(
|
|
3159
|
+
ServiceabilityPlatformModel.OptimalLocationsArticles()
|
|
3160
|
+
),
|
|
2647
3161
|
});
|
|
2648
3162
|
}
|
|
2649
3163
|
|
|
2650
|
-
/** @returns {
|
|
2651
|
-
static
|
|
3164
|
+
/** @returns {OptimalLocationArticlesResult} */
|
|
3165
|
+
static OptimalLocationArticlesResult() {
|
|
2652
3166
|
return Joi.object({
|
|
2653
3167
|
item_id: Joi.number().required(),
|
|
2654
3168
|
size: Joi.string().allow("").required(),
|
|
2655
3169
|
quantity: Joi.number().required(),
|
|
2656
3170
|
group_id: Joi.string().allow(""),
|
|
2657
3171
|
is_primary_item: Joi.boolean(),
|
|
2658
|
-
meta: Joi.any(),
|
|
3172
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
2659
3173
|
article_assignment: ServiceabilityPlatformModel.ArticleAssignment().required(),
|
|
2660
3174
|
seller_id: Joi.number(),
|
|
2661
3175
|
ignore_locations: Joi.array().items(Joi.number()).required(),
|
|
@@ -2667,27 +3181,207 @@ class ServiceabilityPlatformModel {
|
|
|
2667
3181
|
});
|
|
2668
3182
|
}
|
|
2669
3183
|
|
|
2670
|
-
/** @returns {
|
|
2671
|
-
static
|
|
3184
|
+
/** @returns {OptimalLocationAssignedStoresResult} */
|
|
3185
|
+
static OptimalLocationAssignedStoresResult() {
|
|
2672
3186
|
return Joi.object({
|
|
2673
3187
|
store_id: Joi.number().required(),
|
|
2674
3188
|
articles: Joi.array()
|
|
2675
|
-
.items(ServiceabilityPlatformModel.
|
|
3189
|
+
.items(ServiceabilityPlatformModel.OptimalLocationArticlesResult())
|
|
2676
3190
|
.required(),
|
|
2677
3191
|
});
|
|
2678
3192
|
}
|
|
2679
3193
|
|
|
2680
|
-
/** @returns {
|
|
2681
|
-
static
|
|
3194
|
+
/** @returns {OptimalLocationsResult} */
|
|
3195
|
+
static OptimalLocationsResult() {
|
|
2682
3196
|
return Joi.object({
|
|
2683
3197
|
assigned_stores: Joi.array()
|
|
2684
3198
|
.items(
|
|
2685
|
-
ServiceabilityPlatformModel.
|
|
3199
|
+
ServiceabilityPlatformModel.OptimalLocationAssignedStoresResult()
|
|
2686
3200
|
)
|
|
2687
3201
|
.required(),
|
|
2688
3202
|
faulty_articles: Joi.array().items(
|
|
2689
|
-
ServiceabilityPlatformModel.
|
|
3203
|
+
ServiceabilityPlatformModel.ErrorResult()
|
|
3204
|
+
),
|
|
3205
|
+
});
|
|
3206
|
+
}
|
|
3207
|
+
|
|
3208
|
+
/** @returns {ValidationError} */
|
|
3209
|
+
static ValidationError() {
|
|
3210
|
+
return Joi.object({
|
|
3211
|
+
message: Joi.string().allow("").required(),
|
|
3212
|
+
field: Joi.string().allow("").required(),
|
|
3213
|
+
});
|
|
3214
|
+
}
|
|
3215
|
+
|
|
3216
|
+
/** @returns {StandardError} */
|
|
3217
|
+
static StandardError() {
|
|
3218
|
+
return Joi.object({
|
|
3219
|
+
message: Joi.string().allow("").required(),
|
|
3220
|
+
});
|
|
3221
|
+
}
|
|
3222
|
+
|
|
3223
|
+
/** @returns {CourierPartnerSchemeV2Features} */
|
|
3224
|
+
static CourierPartnerSchemeV2Features() {
|
|
3225
|
+
return Joi.object({
|
|
3226
|
+
doorstep_qc: Joi.boolean(),
|
|
3227
|
+
qr: Joi.boolean(),
|
|
3228
|
+
mps: Joi.boolean(),
|
|
3229
|
+
ndr: Joi.boolean(),
|
|
3230
|
+
dangerous_goods: Joi.boolean(),
|
|
3231
|
+
fragile_goods: Joi.boolean(),
|
|
3232
|
+
restricted_goods: Joi.boolean(),
|
|
3233
|
+
cold_storage_goods: Joi.boolean(),
|
|
3234
|
+
doorstep_exchange: Joi.boolean(),
|
|
3235
|
+
doorstep_return: Joi.boolean(),
|
|
3236
|
+
product_installation: Joi.boolean(),
|
|
3237
|
+
openbox_delivery: Joi.boolean(),
|
|
3238
|
+
multi_pick_single_drop: Joi.boolean(),
|
|
3239
|
+
single_pick_multi_drop: Joi.boolean(),
|
|
3240
|
+
multi_pick_multi_drop: Joi.boolean(),
|
|
3241
|
+
ewaybill: Joi.boolean(),
|
|
3242
|
+
});
|
|
3243
|
+
}
|
|
3244
|
+
|
|
3245
|
+
/** @returns {CourierPartnerSchemeV2DetailsModel} */
|
|
3246
|
+
static CourierPartnerSchemeV2DetailsModel() {
|
|
3247
|
+
return Joi.object({
|
|
3248
|
+
extension_id: Joi.string().allow("").required(),
|
|
3249
|
+
scheme_id: Joi.string().allow(""),
|
|
3250
|
+
name: Joi.string().allow("").required(),
|
|
3251
|
+
weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
|
|
3252
|
+
volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3253
|
+
transport_type: Joi.string().allow("").required(),
|
|
3254
|
+
region: Joi.string().allow("").required(),
|
|
3255
|
+
delivery_type: Joi.string().allow("").required(),
|
|
3256
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
3257
|
+
stage: Joi.string().allow("").required(),
|
|
3258
|
+
status_updates: Joi.string().allow(""),
|
|
3259
|
+
ndr_attempts: Joi.number(),
|
|
3260
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
3261
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
3262
|
+
feature: ServiceabilityPlatformModel.CourierPartnerSchemeV2Features().required(),
|
|
3263
|
+
});
|
|
3264
|
+
}
|
|
3265
|
+
|
|
3266
|
+
/** @returns {CourierPartnerV2SchemeModel} */
|
|
3267
|
+
static CourierPartnerV2SchemeModel() {
|
|
3268
|
+
return Joi.object({
|
|
3269
|
+
extension_id: Joi.string().allow("").required(),
|
|
3270
|
+
scheme_id: Joi.string().allow("").required(),
|
|
3271
|
+
company_id: Joi.string().allow(""),
|
|
3272
|
+
name: Joi.string().allow("").required(),
|
|
3273
|
+
weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
|
|
3274
|
+
volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3275
|
+
transport_type: Joi.string().allow("").required(),
|
|
3276
|
+
region: Joi.string().allow("").required(),
|
|
3277
|
+
delivery_type: Joi.string().allow("").required(),
|
|
3278
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
3279
|
+
stage: Joi.string().allow("").required(),
|
|
3280
|
+
status_updates: Joi.string().allow(""),
|
|
3281
|
+
ndr_attempts: Joi.number(),
|
|
3282
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
3283
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
3284
|
+
feature: ServiceabilityPlatformModel.CourierPartnerSchemeV2Features().required(),
|
|
3285
|
+
});
|
|
3286
|
+
}
|
|
3287
|
+
|
|
3288
|
+
/** @returns {CourierPartnerSchemeV2UpdateDetails} */
|
|
3289
|
+
static CourierPartnerSchemeV2UpdateDetails() {
|
|
3290
|
+
return Joi.object({
|
|
3291
|
+
name: Joi.string().allow("").required(),
|
|
3292
|
+
weight: ServiceabilityPlatformModel.ArithmeticOperations().required(),
|
|
3293
|
+
volumetric_weight: ServiceabilityPlatformModel.ArithmeticOperations(),
|
|
3294
|
+
transport_type: Joi.string().allow("").required(),
|
|
3295
|
+
region: Joi.string().allow("").required(),
|
|
3296
|
+
delivery_type: Joi.string().allow("").required(),
|
|
3297
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
3298
|
+
stage: Joi.string().allow("").required(),
|
|
3299
|
+
status_updates: Joi.string().allow(""),
|
|
3300
|
+
ndr_attempts: Joi.number(),
|
|
3301
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
3302
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
3303
|
+
feature: ServiceabilityPlatformModel.CourierPartnerSchemeV2Features().required(),
|
|
3304
|
+
});
|
|
3305
|
+
}
|
|
3306
|
+
|
|
3307
|
+
/** @returns {courierPartnerSchemeV2List} */
|
|
3308
|
+
static courierPartnerSchemeV2List() {
|
|
3309
|
+
return Joi.object({
|
|
3310
|
+
items: Joi.array()
|
|
3311
|
+
.items(ServiceabilityPlatformModel.CourierPartnerV2SchemeModel())
|
|
3312
|
+
.required(),
|
|
3313
|
+
page: ServiceabilityPlatformModel.Page().required(),
|
|
3314
|
+
});
|
|
3315
|
+
}
|
|
3316
|
+
|
|
3317
|
+
/** @returns {BulkRegionServiceabilityTatDetails} */
|
|
3318
|
+
static BulkRegionServiceabilityTatDetails() {
|
|
3319
|
+
return Joi.object({
|
|
3320
|
+
country: Joi.string().allow("").required(),
|
|
3321
|
+
region: Joi.string().allow("").required(),
|
|
3322
|
+
type: Joi.string().allow("").required(),
|
|
3323
|
+
});
|
|
3324
|
+
}
|
|
3325
|
+
|
|
3326
|
+
/** @returns {BulkRegionServiceabilityTatResultItemData} */
|
|
3327
|
+
static BulkRegionServiceabilityTatResultItemData() {
|
|
3328
|
+
return Joi.object({
|
|
3329
|
+
country: Joi.string().allow(""),
|
|
3330
|
+
region: Joi.string().allow(""),
|
|
3331
|
+
type: Joi.string().allow(""),
|
|
3332
|
+
batch_id: Joi.string().allow(""),
|
|
3333
|
+
status: Joi.string().allow(""),
|
|
3334
|
+
failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
3335
|
+
file_path: Joi.string().allow("").allow(null),
|
|
3336
|
+
});
|
|
3337
|
+
}
|
|
3338
|
+
|
|
3339
|
+
/** @returns {BulkRegionServiceabilityTatResult} */
|
|
3340
|
+
static BulkRegionServiceabilityTatResult() {
|
|
3341
|
+
return Joi.object({
|
|
3342
|
+
items: Joi.array().items(
|
|
3343
|
+
ServiceabilityPlatformModel.BulkRegionServiceabilityTatResultItemData()
|
|
2690
3344
|
),
|
|
3345
|
+
page: ServiceabilityPlatformModel.Page(),
|
|
3346
|
+
});
|
|
3347
|
+
}
|
|
3348
|
+
|
|
3349
|
+
/** @returns {HierarchyItems} */
|
|
3350
|
+
static HierarchyItems() {
|
|
3351
|
+
return Joi.object({
|
|
3352
|
+
display_name: Joi.string().allow(""),
|
|
3353
|
+
slug: Joi.string().allow(""),
|
|
3354
|
+
});
|
|
3355
|
+
}
|
|
3356
|
+
|
|
3357
|
+
/** @returns {GetCountriesItems} */
|
|
3358
|
+
static GetCountriesItems() {
|
|
3359
|
+
return Joi.object({
|
|
3360
|
+
id: Joi.string().allow(""),
|
|
3361
|
+
name: Joi.string().allow(""),
|
|
3362
|
+
iso2: Joi.string().allow(""),
|
|
3363
|
+
iso3: Joi.string().allow(""),
|
|
3364
|
+
timezones: Joi.array().items(Joi.string().allow("")),
|
|
3365
|
+
hierarchy: Joi.array().items(
|
|
3366
|
+
ServiceabilityPlatformModel.HierarchyItems()
|
|
3367
|
+
),
|
|
3368
|
+
phone_code: Joi.string().allow(""),
|
|
3369
|
+
currency: Joi.string().allow(""),
|
|
3370
|
+
type: Joi.string().allow(""),
|
|
3371
|
+
latitude: Joi.string().allow(""),
|
|
3372
|
+
longitude: Joi.string().allow(""),
|
|
3373
|
+
display_name: Joi.string().allow(""),
|
|
3374
|
+
has_next_hierarchy: Joi.boolean(),
|
|
3375
|
+
});
|
|
3376
|
+
}
|
|
3377
|
+
|
|
3378
|
+
/** @returns {GetCountries} */
|
|
3379
|
+
static GetCountries() {
|
|
3380
|
+
return Joi.object({
|
|
3381
|
+
items: Joi.array()
|
|
3382
|
+
.items(ServiceabilityPlatformModel.GetCountriesItems())
|
|
3383
|
+
.required(),
|
|
3384
|
+
page: ServiceabilityPlatformModel.Page().required(),
|
|
2691
3385
|
});
|
|
2692
3386
|
}
|
|
2693
3387
|
}
|