@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- 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 +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- 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 +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- 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/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- 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 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,239 +1,689 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
5
|
-
* @property {
|
|
4
|
+
* @typedef CourierPartnerSchemeModelSchema
|
|
5
|
+
* @property {CreatedBy} [created_by]
|
|
6
|
+
* @property {string} [created_on] - The timestamp when the record was created.
|
|
7
|
+
* @property {ModifiedBy} [modified_by]
|
|
8
|
+
* @property {string} [modified_on] - The timestamp when the record last modified.
|
|
9
|
+
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
10
|
+
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
11
|
+
* fetch or modify scheme details.
|
|
12
|
+
* @property {string} [company_id] - Unique identifier of company.
|
|
13
|
+
* @property {string} name - Name of the scheme.
|
|
14
|
+
* @property {ArithmeticOperations} weight
|
|
15
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
16
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
17
|
+
* courier partner scheme.
|
|
18
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
19
|
+
* partner scheme.
|
|
20
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
21
|
+
* courier partner scheme.
|
|
22
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
23
|
+
* courier partner scheme.
|
|
24
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
25
|
+
* currently active or inactive.
|
|
26
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
27
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
28
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
29
|
+
* (NDR) feature is supported by the courier partner.
|
|
30
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
31
|
+
* of items allowed in a quality check shipment.
|
|
32
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
33
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
34
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
35
|
+
*/
|
|
36
|
+
|
|
37
|
+
/**
|
|
38
|
+
* @typedef BulkRegionServiceabilityTatDetails
|
|
39
|
+
* @property {string} country - Country involved in the operation.
|
|
40
|
+
* @property {string} region - Region involved in the operation.
|
|
41
|
+
* @property {string} type - Type of operation, either serviceability or TAT.
|
|
6
42
|
*/
|
|
7
43
|
|
|
8
44
|
/**
|
|
9
|
-
* @typedef
|
|
10
|
-
* @property {string} country
|
|
11
|
-
* @property {string} region
|
|
12
|
-
*
|
|
45
|
+
* @typedef BulkRegionServiceabilityTatResultItemData
|
|
46
|
+
* @property {string} [country] - Name of the country.
|
|
47
|
+
* @property {string} [region] - Name of the region for which the
|
|
48
|
+
* tat/serviceability file needs to be downloaded.
|
|
49
|
+
* @property {string} [type] - Denotes the type of data.
|
|
50
|
+
* @property {string} [batch_id] - A unique identifier for the performed batch operation.
|
|
51
|
+
* @property {string} [status] - Current status of the request.
|
|
52
|
+
* @property {Object[]} [failed_records] - Information of records which failed
|
|
53
|
+
* @property {string} [file_path] - CDN path of the file.
|
|
13
54
|
*/
|
|
14
55
|
|
|
15
56
|
/**
|
|
16
|
-
* @typedef
|
|
17
|
-
* @property {
|
|
18
|
-
*
|
|
19
|
-
* @property {string} [type]
|
|
20
|
-
* @property {string} [batch_id]
|
|
21
|
-
* @property {string} [status]
|
|
22
|
-
* @property {Object[]} [failed_records]
|
|
23
|
-
* @property {string} [file_path]
|
|
57
|
+
* @typedef CommonErrorResult
|
|
58
|
+
* @property {Error[]} [error] - An array of items referencing the ErrorResult
|
|
59
|
+
* schema, which likely contains detailed information about the errors.
|
|
24
60
|
*/
|
|
25
61
|
|
|
26
62
|
/**
|
|
27
|
-
* @typedef
|
|
28
|
-
* @property {
|
|
29
|
-
* @property {
|
|
30
|
-
* @property {string} type
|
|
63
|
+
* @typedef BulkFailureResult
|
|
64
|
+
* @property {boolean} [success] - Whether operation was successful.
|
|
65
|
+
* @property {Error[]} error - An array containing error details.
|
|
31
66
|
*/
|
|
32
67
|
|
|
33
68
|
/**
|
|
34
|
-
* @typedef
|
|
35
|
-
* @property {boolean} success
|
|
36
|
-
* @property {
|
|
69
|
+
* @typedef FailureResult
|
|
70
|
+
* @property {boolean} [success] - Whether operation was successful.
|
|
71
|
+
* @property {Error[]} [error] - Array of error details.
|
|
37
72
|
*/
|
|
38
73
|
|
|
39
74
|
/**
|
|
40
|
-
* @typedef
|
|
41
|
-
* @property {
|
|
75
|
+
* @typedef BulkRegionServiceabilityTatResult
|
|
76
|
+
* @property {BulkRegionServiceabilityTatResultItemData[]} [items] - Array of
|
|
77
|
+
* bulk region serviceability or TAT result items.
|
|
42
78
|
* @property {Page} [page]
|
|
43
79
|
*/
|
|
44
80
|
|
|
45
81
|
/**
|
|
46
|
-
* @typedef
|
|
47
|
-
* @property {
|
|
48
|
-
* @property {
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
* @
|
|
53
|
-
* @property {
|
|
54
|
-
*
|
|
82
|
+
* @typedef RegionTatItemResult
|
|
83
|
+
* @property {RegionTatResult[]} items - An array that contains items of region tat.
|
|
84
|
+
* @property {Page} page
|
|
85
|
+
*/
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* @typedef RegionServiceabilityItemResult
|
|
89
|
+
* @property {RegionServiceabilityResult[]} items - An array that contains items
|
|
90
|
+
* of region serviceability.
|
|
91
|
+
* @property {Page} page
|
|
55
92
|
*/
|
|
56
93
|
|
|
57
94
|
/**
|
|
58
|
-
* @typedef
|
|
59
|
-
* @property {string} [
|
|
60
|
-
*
|
|
61
|
-
* @property {string}
|
|
62
|
-
*
|
|
95
|
+
* @typedef ServiceabilityDetailsResult
|
|
96
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
97
|
+
* scheduled to be processed on the same day.
|
|
98
|
+
* @property {string} [country_code] - ISO2 code representing the country where
|
|
99
|
+
* the serviceability is being specified.
|
|
100
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
101
|
+
* within the country where the serviceability is being specified.
|
|
102
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
103
|
+
* where the serviceability is being specified.
|
|
104
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
105
|
+
* district within the city where the serviceability is being specified.
|
|
106
|
+
* @property {string} [pincode] - A string indicating the postal code or PIN
|
|
107
|
+
* code of the address area.
|
|
108
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
109
|
+
* first-mile service is available or not.
|
|
110
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
111
|
+
* service is available or not.
|
|
112
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
113
|
+
* (COD) payments allowed in the specified region.
|
|
114
|
+
* @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
|
|
115
|
+
* allowed in the specified region.
|
|
116
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
117
|
+
* is available. This refers to the ability to return items directly from the
|
|
118
|
+
* customer's doorstep.
|
|
119
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
120
|
+
* service is available. This refers to the ability to perform quality checks
|
|
121
|
+
* on items at the customer's doorstep.
|
|
122
|
+
* @property {string} [forward_pickup_cutoff] - Time of day by which pickups
|
|
123
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
124
|
+
* @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
|
|
125
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
126
|
+
* @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
|
|
127
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
128
|
+
* instead of through a third-party service.
|
|
129
|
+
* @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
|
|
130
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether
|
|
131
|
+
* reverse pickup services is available.
|
|
132
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
133
|
+
* installation services are available in the specified region or not.
|
|
134
|
+
* @property {string} [id] - A string serving as the unique identifier.
|
|
63
135
|
*/
|
|
64
136
|
|
|
65
137
|
/**
|
|
66
|
-
* @typedef
|
|
67
|
-
* @property {
|
|
68
|
-
*
|
|
69
|
-
* @property {
|
|
70
|
-
*
|
|
71
|
-
* @property {
|
|
72
|
-
*
|
|
73
|
-
* @property {
|
|
74
|
-
*
|
|
75
|
-
*
|
|
76
|
-
* @property {
|
|
77
|
-
*
|
|
138
|
+
* @typedef ServiceabilityDetails
|
|
139
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
140
|
+
* first-mile service is available or not.
|
|
141
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
142
|
+
* service is available or not.
|
|
143
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
144
|
+
* (COD) payments allowed in the specified region.
|
|
145
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
146
|
+
* is available. This refers to the ability to return items directly from the
|
|
147
|
+
* customer's doorstep.
|
|
148
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
149
|
+
* service is available. This refers to the ability to perform quality checks
|
|
150
|
+
* on items at the customer's doorstep.
|
|
151
|
+
* @property {string} [forward_pickup_cutoff] - Time of day by which pickups
|
|
152
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
153
|
+
* @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
|
|
154
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
155
|
+
* @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
|
|
156
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
157
|
+
* instead of through a third-party service.
|
|
158
|
+
* @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
|
|
159
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
160
|
+
* installation services are available in the specified region or not.
|
|
161
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
162
|
+
* scheduled to be processed on the same day.
|
|
78
163
|
*/
|
|
79
164
|
|
|
80
165
|
/**
|
|
81
|
-
* @typedef
|
|
82
|
-
* @property {
|
|
83
|
-
*
|
|
166
|
+
* @typedef RegionServiceabilityResult
|
|
167
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
168
|
+
* scheduled to be processed on the same day.
|
|
169
|
+
* @property {string} country_code - ISO2 code representing the country where
|
|
170
|
+
* the serviceability is being specified.
|
|
171
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
172
|
+
* within the country where the serviceability is being specified.
|
|
173
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
174
|
+
* where the serviceability is being specified.
|
|
175
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
176
|
+
* district within the city where the serviceability is being specified.
|
|
177
|
+
* @property {string} [pincode] - A string indicating the postal code or PIN
|
|
178
|
+
* code of the address area.
|
|
179
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
180
|
+
* first-mile service is available or not.
|
|
181
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
182
|
+
* service is available or not.
|
|
183
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
184
|
+
* (COD) payments allowed in the specified region.
|
|
185
|
+
* @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
|
|
186
|
+
* allowed in the specified region.
|
|
187
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
188
|
+
* is available. This refers to the ability to return items directly from the
|
|
189
|
+
* customer's doorstep.
|
|
190
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
191
|
+
* service is available. This refers to the ability to perform quality checks
|
|
192
|
+
* on items at the customer's doorstep.
|
|
193
|
+
* @property {boolean} [reverse_pickup] - Indicates if reverse pickup is available.
|
|
194
|
+
* @property {string} [forward_pickup_cutoff] - Time of day by which pickups
|
|
195
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
196
|
+
* @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
|
|
197
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
198
|
+
* @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
|
|
199
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
200
|
+
* instead of through a third-party service.
|
|
201
|
+
* @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
|
|
202
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
203
|
+
* installation services are available in the specified region or not.
|
|
204
|
+
* @property {string} id - A string serving as the unique identifier.
|
|
205
|
+
*/
|
|
206
|
+
|
|
207
|
+
/**
|
|
208
|
+
* @typedef RegionServiceabilityDetails
|
|
209
|
+
* @property {string} country_code - ISO2 code representing the country where
|
|
210
|
+
* the serviceability is being specified.
|
|
211
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
212
|
+
* within the country where the serviceability is being specified.
|
|
213
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
214
|
+
* where the serviceability is being specified.
|
|
215
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
216
|
+
* district within the city where the serviceability is being specified.
|
|
217
|
+
* @property {string} [pincode] - A string indicating the postal code or PIN
|
|
218
|
+
* code of the address area.
|
|
219
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
220
|
+
* first-mile service is available or not.
|
|
221
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
222
|
+
* service is available or not.
|
|
223
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
224
|
+
* (COD) payments allowed in the specified region.
|
|
225
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
226
|
+
* is available. This refers to the ability to return items directly from the
|
|
227
|
+
* customer's doorstep.
|
|
228
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
229
|
+
* service is available. This refers to the ability to perform quality checks
|
|
230
|
+
* on items at the customer's doorstep.
|
|
231
|
+
* @property {string} [forward_pickup_cutoff] - Time of day by which pickups
|
|
232
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
233
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
234
|
+
* scheduled to be processed on the same day.
|
|
235
|
+
* @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
|
|
236
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
237
|
+
* @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
|
|
238
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
239
|
+
* instead of through a third-party service.
|
|
240
|
+
* @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
|
|
241
|
+
* allowed in the specified region.
|
|
242
|
+
* @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
|
|
243
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
244
|
+
* installation services are available in the specified region or not.
|
|
245
|
+
*/
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* @typedef RegionTatDetails
|
|
249
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
250
|
+
* from the origin to the destination in seconds.
|
|
251
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
252
|
+
* from the origin to the destination in seconds.
|
|
253
|
+
* @property {string} from_country_code - ISO2 code representing the country of
|
|
254
|
+
* origin for the delivery.
|
|
255
|
+
* @property {string} [from_state_code] - Code representing the state or
|
|
256
|
+
* province of origin within the country.
|
|
257
|
+
* @property {string} [from_city_code] - Code representing the city of origin
|
|
258
|
+
* within the state.
|
|
259
|
+
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
260
|
+
* or district within the city of origin.
|
|
261
|
+
* @property {string} [from_pincode] - A string indicating the postal code or
|
|
262
|
+
* PIN code of the address area.
|
|
263
|
+
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
264
|
+
* @property {string} [to_state_code] - Code representing the state or province
|
|
265
|
+
* of the destination within the country.
|
|
266
|
+
* @property {string} [to_city_code] - Code representing the city of destination
|
|
267
|
+
* within the state.
|
|
268
|
+
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
269
|
+
* district within the city of destination.
|
|
270
|
+
* @property {string} [to_pincode] - A string indicating the postal code or PIN
|
|
271
|
+
* code of the address area.
|
|
272
|
+
* @property {TATDetails} [forward]
|
|
273
|
+
* @property {TATDetails} [reverse]
|
|
84
274
|
*/
|
|
85
275
|
|
|
86
276
|
/**
|
|
87
|
-
* @typedef
|
|
88
|
-
* @property {
|
|
89
|
-
*
|
|
90
|
-
* @property {
|
|
91
|
-
*
|
|
92
|
-
* @property {string}
|
|
93
|
-
*
|
|
277
|
+
* @typedef RegionTatResult
|
|
278
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
279
|
+
* from the origin to the destination in seconds.
|
|
280
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
281
|
+
* from the origin to the destination in seconds.
|
|
282
|
+
* @property {string} from_country_code - ISO2 code representing the country of
|
|
283
|
+
* origin for the delivery.
|
|
284
|
+
* @property {string} [from_state_code] - Code representing the state or
|
|
285
|
+
* province of origin within the country.
|
|
286
|
+
* @property {string} [from_city_code] - Code representing the city of origin
|
|
287
|
+
* within the state.
|
|
288
|
+
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
289
|
+
* or district within the city of origin.
|
|
290
|
+
* @property {string} [from_pincode] - A string indicating the postal code or
|
|
291
|
+
* PIN code of the address area.
|
|
292
|
+
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
293
|
+
* @property {string} [to_state_code] - Code representing the state or province
|
|
294
|
+
* of the destination within the country.
|
|
295
|
+
* @property {string} [to_city_code] - Code representing the city of destination
|
|
296
|
+
* within the state.
|
|
297
|
+
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
298
|
+
* district within the city of destination.
|
|
299
|
+
* @property {string} [to_pincode] - A string indicating the postal code or PIN
|
|
300
|
+
* code of the address area.
|
|
301
|
+
* @property {TATDetails} [forward]
|
|
302
|
+
* @property {TATDetails} [reverse]
|
|
303
|
+
* @property {string} id - A string serving as the unique identifier.
|
|
94
304
|
*/
|
|
95
305
|
|
|
96
306
|
/**
|
|
97
|
-
* @typedef
|
|
98
|
-
* @property {
|
|
99
|
-
* @property {
|
|
307
|
+
* @typedef BulkRegionJobDetails
|
|
308
|
+
* @property {string} [file_path] - Path to the file used in the bulk operation.
|
|
309
|
+
* @property {string} country - Country involved in the bulk operation.
|
|
310
|
+
* @property {string} action - Action type for the bulk operation, either import
|
|
311
|
+
* or export.
|
|
312
|
+
* @property {string} region - Region involved in the bulk operation.
|
|
100
313
|
*/
|
|
101
314
|
|
|
102
315
|
/**
|
|
103
|
-
* @typedef
|
|
104
|
-
* @property {
|
|
316
|
+
* @typedef BulkRegionResultItemData
|
|
317
|
+
* @property {string} file_path - Path to the file associated with the result item.
|
|
318
|
+
* @property {number} [failed] - Number of failed records in the operation.
|
|
319
|
+
* @property {Object[]} [failed_records] - Array of failed records with
|
|
320
|
+
* additional properties.
|
|
321
|
+
* @property {string} action - Action type for the result item.
|
|
322
|
+
* @property {string} batch_id - A unique identifier for the performed batch operation.
|
|
323
|
+
* @property {string} country - Country associated with the result item.
|
|
324
|
+
* @property {number} [success] - Number of successful records in the operation.
|
|
325
|
+
* @property {string} region - Region associated with the result item.
|
|
326
|
+
* @property {string} status - Current status of the result item.
|
|
327
|
+
* @property {number} [total] - Total number of records processed.
|
|
328
|
+
* @property {string} [error_file_path] - Path to the file containing error details.
|
|
329
|
+
* @property {string} [modified_on] - The timestamp when the record last modified.
|
|
330
|
+
* @property {string} [created_on] - The timestamp when the record was created.
|
|
331
|
+
*/
|
|
332
|
+
|
|
333
|
+
/**
|
|
334
|
+
* @typedef BulkRegionResult
|
|
335
|
+
* @property {BulkRegionResultItemData[]} items - Array of bulk region result items.
|
|
105
336
|
* @property {Page} page
|
|
106
337
|
*/
|
|
107
338
|
|
|
108
339
|
/**
|
|
109
|
-
* @typedef
|
|
110
|
-
* @property {string}
|
|
111
|
-
*
|
|
112
|
-
* @property {string} [
|
|
113
|
-
* @property {
|
|
114
|
-
*
|
|
115
|
-
* @property {
|
|
116
|
-
*
|
|
117
|
-
* @property {string
|
|
118
|
-
*
|
|
119
|
-
* @property {
|
|
340
|
+
* @typedef CourierAccountDetailsBody
|
|
341
|
+
* @property {string} extension_id - The unique identifier for the extension
|
|
342
|
+
* linked to the courier account.
|
|
343
|
+
* @property {string} [account_id] - The unique identifier for the courier account.
|
|
344
|
+
* @property {string} scheme_id - The identifier for the scheme associated with
|
|
345
|
+
* the courier account.
|
|
346
|
+
* @property {boolean} is_self_ship - Indicates whether the courier account
|
|
347
|
+
* supports self-shipping (true if it does, false otherwise).
|
|
348
|
+
* @property {string} stage - The current stage of the courier account, either
|
|
349
|
+
* 'enabled' or 'disabled'.
|
|
350
|
+
* @property {boolean} is_own_account - Indicates whether the courier account is
|
|
351
|
+
* an own account (true if it is, false otherwise).
|
|
120
352
|
*/
|
|
121
353
|
|
|
122
354
|
/**
|
|
123
|
-
* @typedef
|
|
124
|
-
* @property {
|
|
125
|
-
*
|
|
126
|
-
* @property {
|
|
127
|
-
* @property {string} scheme_id
|
|
128
|
-
* @property {boolean} is_self_ship
|
|
129
|
-
* @property {string} stage
|
|
130
|
-
* @property {boolean} is_own_account
|
|
131
|
-
* @property {CourierAccountSchemeResponse} scheme_rules
|
|
355
|
+
* @typedef CompanyCourierPartnerAccountListResult
|
|
356
|
+
* @property {CourierAccountResult[]} items - An array containing multiple
|
|
357
|
+
* instances of CourierAccountResult, which details individual courier accounts.
|
|
358
|
+
* @property {Page} page
|
|
132
359
|
*/
|
|
133
360
|
|
|
134
361
|
/**
|
|
135
|
-
* @typedef
|
|
136
|
-
* @property {string}
|
|
137
|
-
* @property {
|
|
138
|
-
* @property {string}
|
|
362
|
+
* @typedef CourierAccountResult
|
|
363
|
+
* @property {string} account_id - A string that uniquely identifies the courier account.
|
|
364
|
+
* @property {number} [company_id] - The unique identifier of the company.
|
|
365
|
+
* @property {string} scheme_id - A string that specifies the unique identifier
|
|
366
|
+
* for the scheme associated with the account
|
|
367
|
+
* @property {string} [extension_id] - A string that uniquely identifies the
|
|
368
|
+
* courier partner extension.
|
|
369
|
+
* @property {boolean} is_self_ship - A boolean indicating whether the account
|
|
370
|
+
* is for self-shipping.
|
|
371
|
+
* @property {string} stage - A string indicating the current stage of the
|
|
372
|
+
* account, which can be either enabled or disabled.
|
|
373
|
+
* @property {boolean} is_own_account - A boolean indicating whether the account
|
|
374
|
+
* is owned by the company.
|
|
375
|
+
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
376
|
+
*/
|
|
377
|
+
|
|
378
|
+
/**
|
|
379
|
+
* @typedef CourierPartnerSchemeDetailsModel
|
|
380
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
381
|
+
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
382
|
+
* fetch or modify scheme details.
|
|
383
|
+
* @property {string} name - Name of the scheme.
|
|
139
384
|
* @property {ArithmeticOperations} weight
|
|
140
385
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
141
|
-
* @property {string} transport_type
|
|
142
|
-
*
|
|
143
|
-
* @property {string}
|
|
144
|
-
*
|
|
145
|
-
* @property {string}
|
|
386
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
387
|
+
* courier partner scheme.
|
|
388
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
389
|
+
* partner scheme.
|
|
390
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
391
|
+
* courier partner scheme.
|
|
392
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
393
|
+
* courier partner scheme.
|
|
394
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
395
|
+
* currently active or inactive.
|
|
396
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
397
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
398
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
399
|
+
* (NDR) feature is supported by the courier partner.
|
|
400
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
401
|
+
* of items allowed in a quality check shipment.
|
|
402
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
403
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
146
404
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
147
405
|
*/
|
|
148
406
|
|
|
149
407
|
/**
|
|
150
|
-
* @typedef
|
|
151
|
-
* @property {
|
|
152
|
-
* @property {
|
|
153
|
-
* @property {
|
|
154
|
-
* @property {
|
|
155
|
-
* @property {
|
|
156
|
-
* @property {
|
|
157
|
-
* @property {
|
|
158
|
-
* @property {
|
|
159
|
-
* @property {
|
|
160
|
-
* @property {
|
|
161
|
-
* @property {
|
|
162
|
-
*
|
|
163
|
-
* @property {
|
|
164
|
-
*
|
|
165
|
-
* @property {
|
|
166
|
-
*
|
|
167
|
-
* @property {
|
|
168
|
-
*
|
|
408
|
+
* @typedef CourierPartnerPutSchema
|
|
409
|
+
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
410
|
+
* @property {CreatedBy} [created_by]
|
|
411
|
+
* @property {ModifiedBy} [modified_by]
|
|
412
|
+
* @property {string} [created_on] - The timestamp when the record was created.
|
|
413
|
+
* @property {string} [modified_on] - The timestamp when the record last modified.
|
|
414
|
+
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
415
|
+
* @property {string} [company_id] - Unique identifier of company.
|
|
416
|
+
* @property {string} name - Name of the scheme.
|
|
417
|
+
* @property {ArithmeticOperations} weight
|
|
418
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
419
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
420
|
+
* courier partner scheme.
|
|
421
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
422
|
+
* partner scheme.
|
|
423
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
424
|
+
* courier partner scheme.
|
|
425
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
426
|
+
* courier partner scheme.
|
|
427
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
428
|
+
* currently active or inactive.
|
|
429
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
430
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
431
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
432
|
+
* (NDR) feature is supported by the courier partner.
|
|
433
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
434
|
+
* of items allowed in a quality check shipment.
|
|
435
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
436
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
437
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
438
|
+
*/
|
|
439
|
+
|
|
440
|
+
/**
|
|
441
|
+
* @typedef CourierPartnerSchemeList
|
|
442
|
+
* @property {CourierPartnerSchemeModelSchema[]} items - List of courier partner schemes
|
|
443
|
+
* @property {Page} page
|
|
444
|
+
*/
|
|
445
|
+
|
|
446
|
+
/**
|
|
447
|
+
* @typedef CourierPartnerSchemeUpdateDetails
|
|
448
|
+
* @property {string} name - Name of the scheme.
|
|
449
|
+
* @property {ArithmeticOperations} weight
|
|
450
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
451
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
452
|
+
* courier partner scheme.
|
|
453
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
454
|
+
* partner scheme.
|
|
455
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
456
|
+
* courier partner scheme.
|
|
457
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
458
|
+
* courier partner scheme.
|
|
459
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
460
|
+
* currently active or inactive.
|
|
461
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
462
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
463
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
464
|
+
* (NDR) feature is supported by the courier partner.
|
|
465
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
466
|
+
* of items allowed in a quality check shipment.
|
|
467
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
468
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
469
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
470
|
+
*/
|
|
471
|
+
|
|
472
|
+
/**
|
|
473
|
+
* @typedef GetCountries
|
|
474
|
+
* @property {GetCountriesItems[]} items - A list of country objects containing
|
|
475
|
+
* detailed information about each country.
|
|
476
|
+
* @property {Page} page
|
|
477
|
+
*/
|
|
478
|
+
|
|
479
|
+
/**
|
|
480
|
+
* @typedef TATUpdateDetails
|
|
481
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
482
|
+
* from the origin to the destination in seconds.
|
|
483
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
484
|
+
* from the origin to the destination in seconds.
|
|
485
|
+
* @property {TATDetails} [forward]
|
|
486
|
+
* @property {TATDetails} [reverse]
|
|
487
|
+
*/
|
|
488
|
+
|
|
489
|
+
/**
|
|
490
|
+
* @typedef StandardError
|
|
491
|
+
* @property {string} message - A brief description of the error.
|
|
492
|
+
*/
|
|
493
|
+
|
|
494
|
+
/**
|
|
495
|
+
* @typedef ValidationErrors
|
|
496
|
+
* @property {ValidationError[]} errors - A list of validation errors in the request.
|
|
497
|
+
*/
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* @typedef CreatedBy
|
|
501
|
+
* @property {string} [id] - Identifier of the user or system that created the object.
|
|
502
|
+
*/
|
|
503
|
+
|
|
504
|
+
/**
|
|
505
|
+
* @typedef ModifiedBy
|
|
506
|
+
* @property {string} [id] - Identifier of the user or system that created the object.
|
|
169
507
|
*/
|
|
170
508
|
|
|
171
509
|
/**
|
|
172
510
|
* @typedef ArithmeticOperations
|
|
173
|
-
* @property {number} [lt]
|
|
174
|
-
*
|
|
175
|
-
* @property {number} [
|
|
176
|
-
*
|
|
511
|
+
* @property {number} [lt] - Specifies a less than operation, comparing values
|
|
512
|
+
* smaller than the provided value.
|
|
513
|
+
* @property {number} [gt] - Specifies a greater than operation, comparing
|
|
514
|
+
* values larger than the provided value.
|
|
515
|
+
* @property {number} [lte] - Specifies a less than or equal to operation,
|
|
516
|
+
* comparing values smaller than or equal to the provided value.
|
|
517
|
+
* @property {number} [gte] - Specifies a greater than or equal to operation,
|
|
518
|
+
* comparing values larger than or equal to the provided value.
|
|
519
|
+
*/
|
|
520
|
+
|
|
521
|
+
/**
|
|
522
|
+
* @typedef CourierPartnerSchemeFeatures
|
|
523
|
+
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
524
|
+
* doorstep quality check services.
|
|
525
|
+
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
526
|
+
* code-based operations.
|
|
527
|
+
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
528
|
+
* multi-part shipment services.
|
|
529
|
+
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
530
|
+
* feature is supported by the courier partner.
|
|
531
|
+
* @property {number} [ndr_attempts] - Number of attempts allowed for resolving
|
|
532
|
+
* Non-Delivery Reports (NDR).
|
|
533
|
+
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
534
|
+
* handles the transportation of dangerous goods.
|
|
535
|
+
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
536
|
+
* manages the shipment of fragile goods.
|
|
537
|
+
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
538
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
539
|
+
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
540
|
+
* provides cold storage facilities for goods.
|
|
541
|
+
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
542
|
+
* supports doorstep exchange services.
|
|
543
|
+
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
544
|
+
* offers doorstep return services.
|
|
545
|
+
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
546
|
+
* provides product installation services upon delivery.
|
|
547
|
+
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
548
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
549
|
+
* before accepting.
|
|
550
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
551
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
552
|
+
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
553
|
+
* partner supports multiple pickups to a single drop location.
|
|
554
|
+
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
555
|
+
* partner supports single pickup to multiple drop locations.
|
|
556
|
+
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
557
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
558
|
+
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
559
|
+
* supports the generation of e-waybills for shipments.
|
|
560
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
561
|
+
* of items allowed in a quality check shipment.
|
|
562
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
563
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
564
|
+
*/
|
|
565
|
+
|
|
566
|
+
/**
|
|
567
|
+
* @typedef Error
|
|
568
|
+
* @property {string} [type] - The type of the error.
|
|
569
|
+
* @property {string} [value] - The value associated with the error.
|
|
570
|
+
* @property {string} [message] - The error message describing the issue.
|
|
177
571
|
*/
|
|
178
572
|
|
|
179
573
|
/**
|
|
180
|
-
* @typedef
|
|
181
|
-
* @property {
|
|
574
|
+
* @typedef Page
|
|
575
|
+
* @property {number} [item_total] - The total number of items on the page.
|
|
576
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
577
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
578
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
579
|
+
* @property {number} [current] - The current page number.
|
|
580
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
581
|
+
* @property {number} [size] - The number of items per page.
|
|
582
|
+
* @property {number} [page_size] - The number of items per page.
|
|
583
|
+
*/
|
|
584
|
+
|
|
585
|
+
/**
|
|
586
|
+
* @typedef TATDetails
|
|
587
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
588
|
+
* from the origin to the destination in seconds.
|
|
589
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
590
|
+
* from the origin to the destination in seconds.
|
|
591
|
+
*/
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* @typedef CourierPartnerSchemeModel
|
|
595
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
596
|
+
* @property {string} scheme_id - A string representing the unique identifier
|
|
597
|
+
* for the scheme. This is a required field.
|
|
598
|
+
* @property {string} name - A string that specifies the name of the scheme.
|
|
599
|
+
* This is a required field.
|
|
182
600
|
* @property {ArithmeticOperations} weight
|
|
183
601
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
184
|
-
* @property {string} transport_type
|
|
185
|
-
* @property {string} region
|
|
186
|
-
* @property {string} delivery_type
|
|
187
|
-
* @property {string[]} payment_mode
|
|
188
|
-
*
|
|
602
|
+
* @property {string} transport_type - A string that specifies the type of transport.
|
|
603
|
+
* @property {string} region - A string that indicates the region type.
|
|
604
|
+
* @property {string} delivery_type - A string that defines the delivery type.
|
|
605
|
+
* @property {string[]} payment_mode - An array of strings specifying the
|
|
606
|
+
* payment modes available.
|
|
607
|
+
* @property {string} stage - A string indicating the current stage of the scheme.
|
|
189
608
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
190
609
|
*/
|
|
191
610
|
|
|
192
611
|
/**
|
|
193
|
-
* @typedef
|
|
194
|
-
* @property {string} [
|
|
195
|
-
* @property {string} [
|
|
612
|
+
* @typedef GetCountriesItems
|
|
613
|
+
* @property {string} [id] - A string serving as the unique identifier.
|
|
614
|
+
* @property {string} [sub_type] - A category for classifying the country into a
|
|
615
|
+
* specific subtype.
|
|
616
|
+
* @property {string} [uid] - A globally unique identifier for the country.
|
|
617
|
+
* @property {string} [name] - The official or widely recognized name of the
|
|
618
|
+
* country used in general contexts.
|
|
619
|
+
* @property {string} [iso2] - The 2-letter ISO code for the country.
|
|
620
|
+
* @property {string} [iso3] - The 3-letter ISO code for the country.
|
|
621
|
+
* @property {string[]} [timezones] - A list of timezones associated with the country.
|
|
622
|
+
* @property {HierarchyItems[]} [hierarchy] - A hierarchical list of items
|
|
623
|
+
* representing organizational levels within the country.
|
|
624
|
+
* @property {string} [phone_code] - A country-specific phone code.
|
|
625
|
+
* @property {CurrencyObject} [currency]
|
|
626
|
+
* @property {string} [type] - The type or classification of the country (e.g.,
|
|
627
|
+
* sovereign or dependent).
|
|
628
|
+
* @property {string} [latitude] - The latitude of the central point of the country.
|
|
629
|
+
* @property {string} [longitude] - The longitude of the central point of the country.
|
|
630
|
+
* @property {string} [display_name] - A user-friendly name for the country,
|
|
631
|
+
* typically for display purposes.
|
|
632
|
+
* @property {boolean} [has_next_hierarchy] - A boolean indicating whether
|
|
633
|
+
* additional hierarchical regions or divisions are present.
|
|
634
|
+
*/
|
|
635
|
+
|
|
636
|
+
/**
|
|
637
|
+
* @typedef HierarchyItems
|
|
638
|
+
* @property {string} [name] - The name of the item as displayed to the user,
|
|
639
|
+
* usually in a UI or listing.
|
|
640
|
+
* @property {string} [display_name] - It represent a country display name.
|
|
641
|
+
* @property {string} [slug] - A slug is a human-readable URL segment, typically
|
|
642
|
+
* generated from a title with special characters removed.
|
|
196
643
|
*/
|
|
197
644
|
|
|
198
645
|
/**
|
|
199
646
|
* @typedef CurrencyObject
|
|
200
|
-
* @property {string} [code]
|
|
201
|
-
* @property {string} [name]
|
|
202
|
-
* @property {string} [symbol]
|
|
203
|
-
*/
|
|
204
|
-
|
|
205
|
-
/**
|
|
206
|
-
* @typedef CountryObject
|
|
207
|
-
* @property {string} [id]
|
|
208
|
-
* @property {string} [name]
|
|
209
|
-
* @property {string} [display_name]
|
|
210
|
-
* @property {string} [iso2]
|
|
211
|
-
* @property {string} [iso3]
|
|
212
|
-
* @property {string[]} [timezones]
|
|
213
|
-
* @property {CountryHierarchy[]} [hierarchy]
|
|
214
|
-
* @property {string} [phone_code]
|
|
215
|
-
* @property {string} [latitude]
|
|
216
|
-
* @property {string} [longitude]
|
|
217
|
-
* @property {CurrencyObject} [currency]
|
|
218
|
-
* @property {string} [type]
|
|
647
|
+
* @property {string} [code] - A string representing the currency code.
|
|
648
|
+
* @property {string} [name] - A string representing the currency name.
|
|
649
|
+
* @property {string} [symbol] - A string representing the currency symbol.
|
|
219
650
|
*/
|
|
220
651
|
|
|
221
652
|
/**
|
|
222
|
-
* @typedef
|
|
223
|
-
* @property {
|
|
224
|
-
* @property {
|
|
653
|
+
* @typedef ValidationError
|
|
654
|
+
* @property {string} message - A brief description of the error encountered.
|
|
655
|
+
* @property {string} field - The field in the request that caused the error.
|
|
225
656
|
*/
|
|
226
657
|
|
|
227
658
|
class LogisticsPartnerModel {
|
|
228
|
-
/** @returns {
|
|
229
|
-
static
|
|
659
|
+
/** @returns {CourierPartnerSchemeModelSchema} */
|
|
660
|
+
static CourierPartnerSchemeModelSchema() {
|
|
230
661
|
return Joi.object({
|
|
231
|
-
|
|
662
|
+
created_by: LogisticsPartnerModel.CreatedBy(),
|
|
663
|
+
created_on: Joi.string().allow(""),
|
|
664
|
+
modified_by: LogisticsPartnerModel.ModifiedBy(),
|
|
665
|
+
modified_on: Joi.string().allow(""),
|
|
666
|
+
extension_id: Joi.string().allow(""),
|
|
667
|
+
scheme_id: Joi.string().allow(""),
|
|
668
|
+
company_id: Joi.string().allow(""),
|
|
669
|
+
name: Joi.string().allow("").required(),
|
|
670
|
+
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
671
|
+
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
672
|
+
transport_type: Joi.string().allow("").required(),
|
|
673
|
+
region: Joi.string().allow("").required(),
|
|
674
|
+
delivery_type: Joi.string().allow("").required(),
|
|
675
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
676
|
+
stage: Joi.string().allow("").required(),
|
|
677
|
+
status_updates: Joi.string().allow(""),
|
|
678
|
+
ndr_attempts: Joi.number(),
|
|
679
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
680
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
681
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
|
|
232
682
|
});
|
|
233
683
|
}
|
|
234
684
|
|
|
235
|
-
/** @returns {
|
|
236
|
-
static
|
|
685
|
+
/** @returns {BulkRegionServiceabilityTatDetails} */
|
|
686
|
+
static BulkRegionServiceabilityTatDetails() {
|
|
237
687
|
return Joi.object({
|
|
238
688
|
country: Joi.string().allow("").required(),
|
|
239
689
|
region: Joi.string().allow("").required(),
|
|
@@ -241,64 +691,205 @@ class LogisticsPartnerModel {
|
|
|
241
691
|
});
|
|
242
692
|
}
|
|
243
693
|
|
|
244
|
-
/** @returns {
|
|
245
|
-
static
|
|
694
|
+
/** @returns {BulkRegionServiceabilityTatResultItemData} */
|
|
695
|
+
static BulkRegionServiceabilityTatResultItemData() {
|
|
246
696
|
return Joi.object({
|
|
247
697
|
country: Joi.string().allow(""),
|
|
248
698
|
region: Joi.string().allow(""),
|
|
249
699
|
type: Joi.string().allow(""),
|
|
250
700
|
batch_id: Joi.string().allow(""),
|
|
251
701
|
status: Joi.string().allow(""),
|
|
252
|
-
failed_records: Joi.array().items(Joi.any()),
|
|
702
|
+
failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
253
703
|
file_path: Joi.string().allow("").allow(null),
|
|
254
704
|
});
|
|
255
705
|
}
|
|
256
706
|
|
|
257
|
-
/** @returns {
|
|
258
|
-
static
|
|
707
|
+
/** @returns {CommonErrorResult} */
|
|
708
|
+
static CommonErrorResult() {
|
|
259
709
|
return Joi.object({
|
|
260
|
-
|
|
261
|
-
message: Joi.string().allow("").required(),
|
|
262
|
-
type: Joi.string().allow("").required(),
|
|
710
|
+
error: Joi.array().items(LogisticsPartnerModel.Error()),
|
|
263
711
|
});
|
|
264
712
|
}
|
|
265
713
|
|
|
266
|
-
/** @returns {
|
|
267
|
-
static
|
|
714
|
+
/** @returns {BulkFailureResult} */
|
|
715
|
+
static BulkFailureResult() {
|
|
268
716
|
return Joi.object({
|
|
269
|
-
success: Joi.boolean()
|
|
270
|
-
error: Joi.array()
|
|
271
|
-
|
|
272
|
-
|
|
717
|
+
success: Joi.boolean(),
|
|
718
|
+
error: Joi.array().items(LogisticsPartnerModel.Error()).required(),
|
|
719
|
+
});
|
|
720
|
+
}
|
|
721
|
+
|
|
722
|
+
/** @returns {FailureResult} */
|
|
723
|
+
static FailureResult() {
|
|
724
|
+
return Joi.object({
|
|
725
|
+
success: Joi.boolean(),
|
|
726
|
+
error: Joi.array().items(LogisticsPartnerModel.Error()),
|
|
273
727
|
});
|
|
274
728
|
}
|
|
275
729
|
|
|
276
|
-
/** @returns {
|
|
277
|
-
static
|
|
730
|
+
/** @returns {BulkRegionServiceabilityTatResult} */
|
|
731
|
+
static BulkRegionServiceabilityTatResult() {
|
|
278
732
|
return Joi.object({
|
|
279
733
|
items: Joi.array().items(
|
|
280
|
-
LogisticsPartnerModel.
|
|
734
|
+
LogisticsPartnerModel.BulkRegionServiceabilityTatResultItemData()
|
|
281
735
|
),
|
|
282
736
|
page: LogisticsPartnerModel.Page(),
|
|
283
737
|
});
|
|
284
738
|
}
|
|
285
739
|
|
|
286
|
-
/** @returns {
|
|
287
|
-
static
|
|
740
|
+
/** @returns {RegionTatItemResult} */
|
|
741
|
+
static RegionTatItemResult() {
|
|
288
742
|
return Joi.object({
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
743
|
+
items: Joi.array()
|
|
744
|
+
.items(LogisticsPartnerModel.RegionTatResult())
|
|
745
|
+
.required(),
|
|
746
|
+
page: LogisticsPartnerModel.Page().required(),
|
|
747
|
+
});
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
/** @returns {RegionServiceabilityItemResult} */
|
|
751
|
+
static RegionServiceabilityItemResult() {
|
|
752
|
+
return Joi.object({
|
|
753
|
+
items: Joi.array()
|
|
754
|
+
.items(LogisticsPartnerModel.RegionServiceabilityResult())
|
|
755
|
+
.required(),
|
|
756
|
+
page: LogisticsPartnerModel.Page().required(),
|
|
757
|
+
});
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
/** @returns {ServiceabilityDetailsResult} */
|
|
761
|
+
static ServiceabilityDetailsResult() {
|
|
762
|
+
return Joi.object({
|
|
763
|
+
pickup_cutoff: Joi.string().allow("").allow(null),
|
|
764
|
+
country_code: Joi.string().allow(""),
|
|
765
|
+
state_code: Joi.string().allow(""),
|
|
766
|
+
city_code: Joi.string().allow(""),
|
|
767
|
+
sector_code: Joi.string().allow(""),
|
|
768
|
+
pincode: Joi.string().allow(""),
|
|
769
|
+
first_mile: Joi.boolean(),
|
|
770
|
+
last_mile: Joi.boolean(),
|
|
771
|
+
cod_limit: Joi.number(),
|
|
772
|
+
prepaid_limit: Joi.number(),
|
|
773
|
+
doorstep_return: Joi.boolean(),
|
|
774
|
+
doorstep_qc: Joi.boolean(),
|
|
775
|
+
forward_pickup_cutoff: Joi.string().allow(""),
|
|
776
|
+
reverse_pickup_cutoff: Joi.string().allow(""),
|
|
777
|
+
hand_to_hand_exchange: Joi.boolean(),
|
|
778
|
+
holiday_list: Joi.array().items(Joi.string().allow("")),
|
|
779
|
+
reverse_pickup: Joi.boolean().allow(null),
|
|
780
|
+
installation: Joi.boolean(),
|
|
781
|
+
id: Joi.string().allow(""),
|
|
782
|
+
});
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
/** @returns {ServiceabilityDetails} */
|
|
786
|
+
static ServiceabilityDetails() {
|
|
787
|
+
return Joi.object({
|
|
788
|
+
first_mile: Joi.boolean(),
|
|
789
|
+
last_mile: Joi.boolean(),
|
|
790
|
+
cod_limit: Joi.number(),
|
|
791
|
+
doorstep_return: Joi.boolean(),
|
|
792
|
+
doorstep_qc: Joi.boolean(),
|
|
793
|
+
forward_pickup_cutoff: Joi.string().allow(""),
|
|
794
|
+
reverse_pickup_cutoff: Joi.string().allow(""),
|
|
795
|
+
hand_to_hand_exchange: Joi.boolean(),
|
|
796
|
+
holiday_list: Joi.array().items(Joi.string().allow("")),
|
|
797
|
+
installation: Joi.boolean(),
|
|
798
|
+
pickup_cutoff: Joi.string().allow("").allow(null),
|
|
799
|
+
});
|
|
800
|
+
}
|
|
801
|
+
|
|
802
|
+
/** @returns {RegionServiceabilityResult} */
|
|
803
|
+
static RegionServiceabilityResult() {
|
|
804
|
+
return Joi.object({
|
|
805
|
+
pickup_cutoff: Joi.string().allow("").allow(null),
|
|
806
|
+
country_code: Joi.string().allow("").required(),
|
|
807
|
+
state_code: Joi.string().allow(""),
|
|
808
|
+
city_code: Joi.string().allow(""),
|
|
809
|
+
sector_code: Joi.string().allow(""),
|
|
810
|
+
pincode: Joi.string().allow(""),
|
|
811
|
+
first_mile: Joi.boolean(),
|
|
812
|
+
last_mile: Joi.boolean(),
|
|
813
|
+
cod_limit: Joi.number(),
|
|
814
|
+
prepaid_limit: Joi.number(),
|
|
815
|
+
doorstep_return: Joi.boolean(),
|
|
816
|
+
doorstep_qc: Joi.boolean(),
|
|
817
|
+
reverse_pickup: Joi.boolean().allow(null),
|
|
818
|
+
forward_pickup_cutoff: Joi.string().allow(""),
|
|
819
|
+
reverse_pickup_cutoff: Joi.string().allow(""),
|
|
820
|
+
hand_to_hand_exchange: Joi.boolean(),
|
|
821
|
+
holiday_list: Joi.array().items(Joi.string().allow("")),
|
|
822
|
+
installation: Joi.boolean(),
|
|
823
|
+
id: Joi.string().allow("").required(),
|
|
824
|
+
});
|
|
825
|
+
}
|
|
826
|
+
|
|
827
|
+
/** @returns {RegionServiceabilityDetails} */
|
|
828
|
+
static RegionServiceabilityDetails() {
|
|
829
|
+
return Joi.object({
|
|
830
|
+
country_code: Joi.string().allow("").required(),
|
|
831
|
+
state_code: Joi.string().allow(""),
|
|
832
|
+
city_code: Joi.string().allow(""),
|
|
833
|
+
sector_code: Joi.string().allow(""),
|
|
834
|
+
pincode: Joi.string().allow(""),
|
|
835
|
+
first_mile: Joi.boolean(),
|
|
836
|
+
last_mile: Joi.boolean(),
|
|
837
|
+
cod_limit: Joi.number(),
|
|
838
|
+
doorstep_return: Joi.boolean(),
|
|
839
|
+
doorstep_qc: Joi.boolean(),
|
|
840
|
+
forward_pickup_cutoff: Joi.string().allow(""),
|
|
841
|
+
pickup_cutoff: Joi.string().allow("").allow(null),
|
|
842
|
+
reverse_pickup_cutoff: Joi.string().allow(""),
|
|
843
|
+
hand_to_hand_exchange: Joi.boolean(),
|
|
844
|
+
prepaid_limit: Joi.number(),
|
|
845
|
+
holiday_list: Joi.array().items(Joi.string().allow("")),
|
|
846
|
+
installation: Joi.boolean(),
|
|
847
|
+
});
|
|
848
|
+
}
|
|
849
|
+
|
|
850
|
+
/** @returns {RegionTatDetails} */
|
|
851
|
+
static RegionTatDetails() {
|
|
852
|
+
return Joi.object({
|
|
853
|
+
max_delivery_time: Joi.number().allow(null),
|
|
854
|
+
min_delivery_time: Joi.number().allow(null),
|
|
855
|
+
from_country_code: Joi.string().allow("").required(),
|
|
856
|
+
from_state_code: Joi.string().allow(""),
|
|
857
|
+
from_city_code: Joi.string().allow(""),
|
|
858
|
+
from_sector_code: Joi.string().allow(""),
|
|
859
|
+
from_pincode: Joi.string().allow(""),
|
|
860
|
+
to_country_code: Joi.string().allow("").required(),
|
|
861
|
+
to_state_code: Joi.string().allow(""),
|
|
862
|
+
to_city_code: Joi.string().allow(""),
|
|
863
|
+
to_sector_code: Joi.string().allow(""),
|
|
864
|
+
to_pincode: Joi.string().allow(""),
|
|
865
|
+
forward: LogisticsPartnerModel.TATDetails(),
|
|
866
|
+
reverse: LogisticsPartnerModel.TATDetails(),
|
|
867
|
+
});
|
|
868
|
+
}
|
|
869
|
+
|
|
870
|
+
/** @returns {RegionTatResult} */
|
|
871
|
+
static RegionTatResult() {
|
|
872
|
+
return Joi.object({
|
|
873
|
+
min_delivery_time: Joi.number().allow(null),
|
|
874
|
+
max_delivery_time: Joi.number().allow(null),
|
|
875
|
+
from_country_code: Joi.string().allow("").required(),
|
|
876
|
+
from_state_code: Joi.string().allow(""),
|
|
877
|
+
from_city_code: Joi.string().allow(""),
|
|
878
|
+
from_sector_code: Joi.string().allow(""),
|
|
879
|
+
from_pincode: Joi.string().allow(""),
|
|
880
|
+
to_country_code: Joi.string().allow("").required(),
|
|
881
|
+
to_state_code: Joi.string().allow(""),
|
|
882
|
+
to_city_code: Joi.string().allow(""),
|
|
883
|
+
to_sector_code: Joi.string().allow(""),
|
|
884
|
+
to_pincode: Joi.string().allow(""),
|
|
885
|
+
forward: LogisticsPartnerModel.TATDetails(),
|
|
886
|
+
reverse: LogisticsPartnerModel.TATDetails(),
|
|
887
|
+
id: Joi.string().allow("").required(),
|
|
297
888
|
});
|
|
298
889
|
}
|
|
299
890
|
|
|
300
|
-
/** @returns {
|
|
301
|
-
static
|
|
891
|
+
/** @returns {BulkRegionJobDetails} */
|
|
892
|
+
static BulkRegionJobDetails() {
|
|
302
893
|
return Joi.object({
|
|
303
894
|
file_path: Joi.string().allow(""),
|
|
304
895
|
country: Joi.string().allow("").required(),
|
|
@@ -307,12 +898,12 @@ class LogisticsPartnerModel {
|
|
|
307
898
|
});
|
|
308
899
|
}
|
|
309
900
|
|
|
310
|
-
/** @returns {
|
|
311
|
-
static
|
|
901
|
+
/** @returns {BulkRegionResultItemData} */
|
|
902
|
+
static BulkRegionResultItemData() {
|
|
312
903
|
return Joi.object({
|
|
313
904
|
file_path: Joi.string().allow("").required(),
|
|
314
905
|
failed: Joi.number(),
|
|
315
|
-
failed_records: Joi.array().items(Joi.any()),
|
|
906
|
+
failed_records: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
316
907
|
action: Joi.string().allow("").required(),
|
|
317
908
|
batch_id: Joi.string().allow("").required(),
|
|
318
909
|
country: Joi.string().allow("").required(),
|
|
@@ -321,24 +912,26 @@ class LogisticsPartnerModel {
|
|
|
321
912
|
status: Joi.string().allow("").required(),
|
|
322
913
|
total: Joi.number(),
|
|
323
914
|
error_file_path: Joi.string().allow(""),
|
|
915
|
+
modified_on: Joi.string().allow(""),
|
|
916
|
+
created_on: Joi.string().allow(""),
|
|
324
917
|
});
|
|
325
918
|
}
|
|
326
919
|
|
|
327
|
-
/** @returns {
|
|
328
|
-
static
|
|
920
|
+
/** @returns {BulkRegionResult} */
|
|
921
|
+
static BulkRegionResult() {
|
|
329
922
|
return Joi.object({
|
|
330
923
|
items: Joi.array()
|
|
331
|
-
.items(LogisticsPartnerModel.
|
|
924
|
+
.items(LogisticsPartnerModel.BulkRegionResultItemData())
|
|
332
925
|
.required(),
|
|
333
926
|
page: LogisticsPartnerModel.Page().required(),
|
|
334
927
|
});
|
|
335
928
|
}
|
|
336
929
|
|
|
337
|
-
/** @returns {
|
|
338
|
-
static
|
|
930
|
+
/** @returns {CourierAccountDetailsBody} */
|
|
931
|
+
static CourierAccountDetailsBody() {
|
|
339
932
|
return Joi.object({
|
|
340
933
|
extension_id: Joi.string().allow("").required(),
|
|
341
|
-
account_id: Joi.string().allow("")
|
|
934
|
+
account_id: Joi.string().allow(""),
|
|
342
935
|
scheme_id: Joi.string().allow("").required(),
|
|
343
936
|
is_self_ship: Joi.boolean().required(),
|
|
344
937
|
stage: Joi.string().allow("").required(),
|
|
@@ -346,61 +939,90 @@ class LogisticsPartnerModel {
|
|
|
346
939
|
});
|
|
347
940
|
}
|
|
348
941
|
|
|
349
|
-
/** @returns {
|
|
350
|
-
static
|
|
942
|
+
/** @returns {CompanyCourierPartnerAccountListResult} */
|
|
943
|
+
static CompanyCourierPartnerAccountListResult() {
|
|
351
944
|
return Joi.object({
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
.items(LogisticsPartnerModel.ErrorResponse())
|
|
945
|
+
items: Joi.array()
|
|
946
|
+
.items(LogisticsPartnerModel.CourierAccountResult())
|
|
355
947
|
.required(),
|
|
948
|
+
page: LogisticsPartnerModel.Page().required(),
|
|
356
949
|
});
|
|
357
950
|
}
|
|
358
951
|
|
|
359
|
-
/** @returns {
|
|
360
|
-
static
|
|
952
|
+
/** @returns {CourierAccountResult} */
|
|
953
|
+
static CourierAccountResult() {
|
|
361
954
|
return Joi.object({
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
955
|
+
account_id: Joi.string().allow("").required(),
|
|
956
|
+
company_id: Joi.number(),
|
|
957
|
+
scheme_id: Joi.string().allow("").required(),
|
|
958
|
+
extension_id: Joi.string().allow(""),
|
|
959
|
+
is_self_ship: Joi.boolean().required(),
|
|
960
|
+
stage: Joi.string().allow("").required(),
|
|
961
|
+
is_own_account: Joi.boolean().required(),
|
|
962
|
+
scheme_rules: LogisticsPartnerModel.CourierPartnerSchemeModel().required(),
|
|
366
963
|
});
|
|
367
964
|
}
|
|
368
965
|
|
|
369
|
-
/** @returns {
|
|
370
|
-
static
|
|
966
|
+
/** @returns {CourierPartnerSchemeDetailsModel} */
|
|
967
|
+
static CourierPartnerSchemeDetailsModel() {
|
|
371
968
|
return Joi.object({
|
|
372
|
-
extension_id: Joi.string().allow(""),
|
|
969
|
+
extension_id: Joi.string().allow("").required(),
|
|
373
970
|
scheme_id: Joi.string().allow(""),
|
|
374
|
-
name: Joi.string().allow(""),
|
|
375
|
-
weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
971
|
+
name: Joi.string().allow("").required(),
|
|
972
|
+
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
973
|
+
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
974
|
+
transport_type: Joi.string().allow("").required(),
|
|
975
|
+
region: Joi.string().allow("").required(),
|
|
976
|
+
delivery_type: Joi.string().allow("").required(),
|
|
977
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
978
|
+
stage: Joi.string().allow("").required(),
|
|
979
|
+
status_updates: Joi.string().allow(""),
|
|
980
|
+
ndr_attempts: Joi.number(),
|
|
981
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
982
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
983
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
|
|
382
984
|
});
|
|
383
985
|
}
|
|
384
986
|
|
|
385
|
-
/** @returns {
|
|
386
|
-
static
|
|
987
|
+
/** @returns {CourierPartnerPutSchema} */
|
|
988
|
+
static CourierPartnerPutSchema() {
|
|
387
989
|
return Joi.object({
|
|
388
|
-
company_id: Joi.number(),
|
|
389
990
|
extension_id: Joi.string().allow(""),
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
991
|
+
created_by: LogisticsPartnerModel.CreatedBy(),
|
|
992
|
+
modified_by: LogisticsPartnerModel.ModifiedBy(),
|
|
993
|
+
created_on: Joi.string().allow(""),
|
|
994
|
+
modified_on: Joi.string().allow(""),
|
|
995
|
+
scheme_id: Joi.string().allow(""),
|
|
996
|
+
company_id: Joi.string().allow(""),
|
|
997
|
+
name: Joi.string().allow("").required(),
|
|
998
|
+
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
999
|
+
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
1000
|
+
transport_type: Joi.string().allow("").required(),
|
|
1001
|
+
region: Joi.string().allow("").required(),
|
|
1002
|
+
delivery_type: Joi.string().allow("").required(),
|
|
1003
|
+
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
393
1004
|
stage: Joi.string().allow("").required(),
|
|
394
|
-
|
|
395
|
-
|
|
1005
|
+
status_updates: Joi.string().allow(""),
|
|
1006
|
+
ndr_attempts: Joi.number(),
|
|
1007
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1008
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1009
|
+
feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
|
|
396
1010
|
});
|
|
397
1011
|
}
|
|
398
1012
|
|
|
399
|
-
/** @returns {
|
|
400
|
-
static
|
|
1013
|
+
/** @returns {CourierPartnerSchemeList} */
|
|
1014
|
+
static CourierPartnerSchemeList() {
|
|
1015
|
+
return Joi.object({
|
|
1016
|
+
items: Joi.array()
|
|
1017
|
+
.items(LogisticsPartnerModel.CourierPartnerSchemeModelSchema())
|
|
1018
|
+
.required(),
|
|
1019
|
+
page: LogisticsPartnerModel.Page().required(),
|
|
1020
|
+
});
|
|
1021
|
+
}
|
|
1022
|
+
|
|
1023
|
+
/** @returns {CourierPartnerSchemeUpdateDetails} */
|
|
1024
|
+
static CourierPartnerSchemeUpdateDetails() {
|
|
401
1025
|
return Joi.object({
|
|
402
|
-
extension_id: Joi.string().allow("").required(),
|
|
403
|
-
scheme_id: Joi.string().allow("").required(),
|
|
404
1026
|
name: Joi.string().allow("").required(),
|
|
405
1027
|
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
406
1028
|
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
@@ -409,10 +1031,74 @@ class LogisticsPartnerModel {
|
|
|
409
1031
|
delivery_type: Joi.string().allow("").required(),
|
|
410
1032
|
payment_mode: Joi.array().items(Joi.string().allow("")).required(),
|
|
411
1033
|
stage: Joi.string().allow("").required(),
|
|
1034
|
+
status_updates: Joi.string().allow(""),
|
|
1035
|
+
ndr_attempts: Joi.number(),
|
|
1036
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1037
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
412
1038
|
feature: LogisticsPartnerModel.CourierPartnerSchemeFeatures().required(),
|
|
413
1039
|
});
|
|
414
1040
|
}
|
|
415
1041
|
|
|
1042
|
+
/** @returns {GetCountries} */
|
|
1043
|
+
static GetCountries() {
|
|
1044
|
+
return Joi.object({
|
|
1045
|
+
items: Joi.array()
|
|
1046
|
+
.items(LogisticsPartnerModel.GetCountriesItems())
|
|
1047
|
+
.required(),
|
|
1048
|
+
page: LogisticsPartnerModel.Page().required(),
|
|
1049
|
+
});
|
|
1050
|
+
}
|
|
1051
|
+
|
|
1052
|
+
/** @returns {TATUpdateDetails} */
|
|
1053
|
+
static TATUpdateDetails() {
|
|
1054
|
+
return Joi.object({
|
|
1055
|
+
max_delivery_time: Joi.number().allow(null),
|
|
1056
|
+
min_delivery_time: Joi.number().allow(null),
|
|
1057
|
+
forward: LogisticsPartnerModel.TATDetails(),
|
|
1058
|
+
reverse: LogisticsPartnerModel.TATDetails(),
|
|
1059
|
+
});
|
|
1060
|
+
}
|
|
1061
|
+
|
|
1062
|
+
/** @returns {StandardError} */
|
|
1063
|
+
static StandardError() {
|
|
1064
|
+
return Joi.object({
|
|
1065
|
+
message: Joi.string().allow("").required(),
|
|
1066
|
+
});
|
|
1067
|
+
}
|
|
1068
|
+
|
|
1069
|
+
/** @returns {ValidationErrors} */
|
|
1070
|
+
static ValidationErrors() {
|
|
1071
|
+
return Joi.object({
|
|
1072
|
+
errors: Joi.array()
|
|
1073
|
+
.items(LogisticsPartnerModel.ValidationError())
|
|
1074
|
+
.required(),
|
|
1075
|
+
});
|
|
1076
|
+
}
|
|
1077
|
+
|
|
1078
|
+
/** @returns {CreatedBy} */
|
|
1079
|
+
static CreatedBy() {
|
|
1080
|
+
return Joi.object({
|
|
1081
|
+
id: Joi.string().allow("").allow(null),
|
|
1082
|
+
}).allow(null);
|
|
1083
|
+
}
|
|
1084
|
+
|
|
1085
|
+
/** @returns {ModifiedBy} */
|
|
1086
|
+
static ModifiedBy() {
|
|
1087
|
+
return Joi.object({
|
|
1088
|
+
id: Joi.string().allow("").allow(null),
|
|
1089
|
+
}).allow(null);
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
/** @returns {ArithmeticOperations} */
|
|
1093
|
+
static ArithmeticOperations() {
|
|
1094
|
+
return Joi.object({
|
|
1095
|
+
lt: Joi.number().allow(null),
|
|
1096
|
+
gt: Joi.number().allow(null),
|
|
1097
|
+
lte: Joi.number().allow(null),
|
|
1098
|
+
gte: Joi.number().allow(null),
|
|
1099
|
+
});
|
|
1100
|
+
}
|
|
1101
|
+
|
|
416
1102
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
417
1103
|
static CourierPartnerSchemeFeatures() {
|
|
418
1104
|
return Joi.object({
|
|
@@ -434,22 +1120,47 @@ class LogisticsPartnerModel {
|
|
|
434
1120
|
single_pick_multi_drop: Joi.boolean(),
|
|
435
1121
|
multi_pick_multi_drop: Joi.boolean(),
|
|
436
1122
|
ewaybill: Joi.boolean(),
|
|
1123
|
+
qc_shipment_item_quantity: Joi.number().allow(null),
|
|
1124
|
+
non_qc_shipment_item_quantity: Joi.number().allow(null),
|
|
437
1125
|
});
|
|
438
1126
|
}
|
|
439
1127
|
|
|
440
|
-
/** @returns {
|
|
441
|
-
static
|
|
1128
|
+
/** @returns {Error} */
|
|
1129
|
+
static Error() {
|
|
442
1130
|
return Joi.object({
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
1131
|
+
type: Joi.string().allow("").allow(null),
|
|
1132
|
+
value: Joi.string().allow("").allow(null),
|
|
1133
|
+
message: Joi.string().allow("").allow(null),
|
|
1134
|
+
});
|
|
1135
|
+
}
|
|
1136
|
+
|
|
1137
|
+
/** @returns {Page} */
|
|
1138
|
+
static Page() {
|
|
1139
|
+
return Joi.object({
|
|
1140
|
+
item_total: Joi.number(),
|
|
1141
|
+
next_id: Joi.string().allow(""),
|
|
1142
|
+
has_previous: Joi.boolean(),
|
|
1143
|
+
has_next: Joi.boolean(),
|
|
1144
|
+
current: Joi.number(),
|
|
1145
|
+
type: Joi.string().allow("").required(),
|
|
1146
|
+
size: Joi.number(),
|
|
1147
|
+
page_size: Joi.number(),
|
|
1148
|
+
});
|
|
448
1149
|
}
|
|
449
1150
|
|
|
450
|
-
/** @returns {
|
|
451
|
-
static
|
|
1151
|
+
/** @returns {TATDetails} */
|
|
1152
|
+
static TATDetails() {
|
|
452
1153
|
return Joi.object({
|
|
1154
|
+
max_delivery_time: Joi.number(),
|
|
1155
|
+
min_delivery_time: Joi.number(),
|
|
1156
|
+
});
|
|
1157
|
+
}
|
|
1158
|
+
|
|
1159
|
+
/** @returns {CourierPartnerSchemeModel} */
|
|
1160
|
+
static CourierPartnerSchemeModel() {
|
|
1161
|
+
return Joi.object({
|
|
1162
|
+
extension_id: Joi.string().allow("").required(),
|
|
1163
|
+
scheme_id: Joi.string().allow("").required(),
|
|
453
1164
|
name: Joi.string().allow("").required(),
|
|
454
1165
|
weight: LogisticsPartnerModel.ArithmeticOperations().required(),
|
|
455
1166
|
volumetric_weight: LogisticsPartnerModel.ArithmeticOperations(),
|
|
@@ -462,46 +1173,50 @@ class LogisticsPartnerModel {
|
|
|
462
1173
|
});
|
|
463
1174
|
}
|
|
464
1175
|
|
|
465
|
-
/** @returns {
|
|
466
|
-
static
|
|
1176
|
+
/** @returns {GetCountriesItems} */
|
|
1177
|
+
static GetCountriesItems() {
|
|
467
1178
|
return Joi.object({
|
|
1179
|
+
id: Joi.string().allow(""),
|
|
1180
|
+
sub_type: Joi.string().allow(""),
|
|
1181
|
+
uid: Joi.string().allow(""),
|
|
1182
|
+
name: Joi.string().allow(""),
|
|
1183
|
+
iso2: Joi.string().allow(""),
|
|
1184
|
+
iso3: Joi.string().allow(""),
|
|
1185
|
+
timezones: Joi.array().items(Joi.string().allow("")),
|
|
1186
|
+
hierarchy: Joi.array().items(LogisticsPartnerModel.HierarchyItems()),
|
|
1187
|
+
phone_code: Joi.string().allow(""),
|
|
1188
|
+
currency: LogisticsPartnerModel.CurrencyObject(),
|
|
1189
|
+
type: Joi.string().allow(""),
|
|
1190
|
+
latitude: Joi.string().allow(""),
|
|
1191
|
+
longitude: Joi.string().allow(""),
|
|
468
1192
|
display_name: Joi.string().allow(""),
|
|
469
|
-
|
|
1193
|
+
has_next_hierarchy: Joi.boolean(),
|
|
470
1194
|
});
|
|
471
1195
|
}
|
|
472
1196
|
|
|
473
|
-
/** @returns {
|
|
474
|
-
static
|
|
1197
|
+
/** @returns {HierarchyItems} */
|
|
1198
|
+
static HierarchyItems() {
|
|
475
1199
|
return Joi.object({
|
|
476
|
-
code: Joi.string().allow(""),
|
|
477
1200
|
name: Joi.string().allow(""),
|
|
478
|
-
|
|
1201
|
+
display_name: Joi.string().allow(""),
|
|
1202
|
+
slug: Joi.string().allow(""),
|
|
479
1203
|
});
|
|
480
1204
|
}
|
|
481
1205
|
|
|
482
|
-
/** @returns {
|
|
483
|
-
static
|
|
1206
|
+
/** @returns {CurrencyObject} */
|
|
1207
|
+
static CurrencyObject() {
|
|
484
1208
|
return Joi.object({
|
|
485
|
-
|
|
1209
|
+
code: Joi.string().allow(""),
|
|
486
1210
|
name: Joi.string().allow(""),
|
|
487
|
-
|
|
488
|
-
iso2: Joi.string().allow(""),
|
|
489
|
-
iso3: Joi.string().allow(""),
|
|
490
|
-
timezones: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
491
|
-
hierarchy: Joi.array().items(LogisticsPartnerModel.CountryHierarchy()),
|
|
492
|
-
phone_code: Joi.string().allow(""),
|
|
493
|
-
latitude: Joi.string().allow(""),
|
|
494
|
-
longitude: Joi.string().allow(""),
|
|
495
|
-
currency: LogisticsPartnerModel.CurrencyObject(),
|
|
496
|
-
type: Joi.string().allow(""),
|
|
1211
|
+
symbol: Joi.string().allow(""),
|
|
497
1212
|
});
|
|
498
1213
|
}
|
|
499
1214
|
|
|
500
|
-
/** @returns {
|
|
501
|
-
static
|
|
1215
|
+
/** @returns {ValidationError} */
|
|
1216
|
+
static ValidationError() {
|
|
502
1217
|
return Joi.object({
|
|
503
|
-
|
|
504
|
-
|
|
1218
|
+
message: Joi.string().allow("").required(),
|
|
1219
|
+
field: Joi.string().allow("").required(),
|
|
505
1220
|
});
|
|
506
1221
|
}
|
|
507
1222
|
}
|