@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,455 +1,2079 @@
|
|
|
1
1
|
export = LogisticsPartnerModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {
|
|
3
|
+
* @typedef CourierPartnerSchemeModelSchema
|
|
4
|
+
* @property {CreatedBy} [created_by]
|
|
5
|
+
* @property {string} [created_on] - The timestamp when the record was created.
|
|
6
|
+
* @property {ModifiedBy} [modified_by]
|
|
7
|
+
* @property {string} [modified_on] - The timestamp when the record last modified.
|
|
8
|
+
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
9
|
+
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
10
|
+
* fetch or modify scheme details.
|
|
11
|
+
* @property {string} [company_id] - Unique identifier of company.
|
|
12
|
+
* @property {string} name - Name of the scheme.
|
|
13
|
+
* @property {ArithmeticOperations} weight
|
|
14
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
15
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
16
|
+
* courier partner scheme.
|
|
17
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
18
|
+
* partner scheme.
|
|
19
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
20
|
+
* courier partner scheme.
|
|
21
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
22
|
+
* courier partner scheme.
|
|
23
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
24
|
+
* currently active or inactive.
|
|
25
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
26
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
27
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
28
|
+
* (NDR) feature is supported by the courier partner.
|
|
29
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
30
|
+
* of items allowed in a quality check shipment.
|
|
31
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
32
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
33
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
34
|
+
*/
|
|
35
|
+
/**
|
|
36
|
+
* @typedef BulkRegionServiceabilityTatDetails
|
|
37
|
+
* @property {string} country - Country involved in the operation.
|
|
38
|
+
* @property {string} region - Region involved in the operation.
|
|
39
|
+
* @property {string} type - Type of operation, either serviceability or TAT.
|
|
5
40
|
*/
|
|
6
41
|
/**
|
|
7
|
-
* @typedef
|
|
8
|
-
* @property {string} country
|
|
9
|
-
* @property {string} region
|
|
10
|
-
*
|
|
42
|
+
* @typedef BulkRegionServiceabilityTatResultItemData
|
|
43
|
+
* @property {string} [country] - Name of the country.
|
|
44
|
+
* @property {string} [region] - Name of the region for which the
|
|
45
|
+
* tat/serviceability file needs to be downloaded.
|
|
46
|
+
* @property {string} [type] - Denotes the type of data.
|
|
47
|
+
* @property {string} [batch_id] - A unique identifier for the performed batch operation.
|
|
48
|
+
* @property {string} [status] - Current status of the request.
|
|
49
|
+
* @property {Object[]} [failed_records] - Information of records which failed
|
|
50
|
+
* @property {string} [file_path] - CDN path of the file.
|
|
11
51
|
*/
|
|
12
52
|
/**
|
|
13
|
-
* @typedef
|
|
14
|
-
* @property {
|
|
15
|
-
*
|
|
16
|
-
* @property {string} [type]
|
|
17
|
-
* @property {string} [batch_id]
|
|
18
|
-
* @property {string} [status]
|
|
19
|
-
* @property {Object[]} [failed_records]
|
|
20
|
-
* @property {string} [file_path]
|
|
53
|
+
* @typedef CommonErrorResult
|
|
54
|
+
* @property {Error[]} [error] - An array of items referencing the ErrorResult
|
|
55
|
+
* schema, which likely contains detailed information about the errors.
|
|
21
56
|
*/
|
|
22
57
|
/**
|
|
23
|
-
* @typedef
|
|
24
|
-
* @property {
|
|
25
|
-
* @property {
|
|
26
|
-
* @property {string} type
|
|
58
|
+
* @typedef BulkFailureResult
|
|
59
|
+
* @property {boolean} [success] - Whether operation was successful.
|
|
60
|
+
* @property {Error[]} error - An array containing error details.
|
|
27
61
|
*/
|
|
28
62
|
/**
|
|
29
|
-
* @typedef
|
|
30
|
-
* @property {boolean} success
|
|
31
|
-
* @property {
|
|
63
|
+
* @typedef FailureResult
|
|
64
|
+
* @property {boolean} [success] - Whether operation was successful.
|
|
65
|
+
* @property {Error[]} [error] - Array of error details.
|
|
32
66
|
*/
|
|
33
67
|
/**
|
|
34
|
-
* @typedef
|
|
35
|
-
* @property {
|
|
68
|
+
* @typedef BulkRegionServiceabilityTatResult
|
|
69
|
+
* @property {BulkRegionServiceabilityTatResultItemData[]} [items] - Array of
|
|
70
|
+
* bulk region serviceability or TAT result items.
|
|
36
71
|
* @property {Page} [page]
|
|
37
72
|
*/
|
|
38
73
|
/**
|
|
39
|
-
* @typedef
|
|
40
|
-
* @property {
|
|
41
|
-
* @property {
|
|
42
|
-
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
43
|
-
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
44
|
-
* @property {number} [current] - The current page number.
|
|
45
|
-
* @property {string} type - The type of the page, such as 'PageType'.
|
|
46
|
-
* @property {number} [size] - The number of items per page.
|
|
47
|
-
* @property {number} [total] - Total number of items.
|
|
74
|
+
* @typedef RegionTatItemResult
|
|
75
|
+
* @property {RegionTatResult[]} items - An array that contains items of region tat.
|
|
76
|
+
* @property {Page} page
|
|
48
77
|
*/
|
|
49
78
|
/**
|
|
50
|
-
* @typedef
|
|
51
|
-
* @property {
|
|
52
|
-
*
|
|
53
|
-
* @property {
|
|
54
|
-
* @property {string} region
|
|
79
|
+
* @typedef RegionServiceabilityItemResult
|
|
80
|
+
* @property {RegionServiceabilityResult[]} items - An array that contains items
|
|
81
|
+
* of region serviceability.
|
|
82
|
+
* @property {Page} page
|
|
55
83
|
*/
|
|
56
84
|
/**
|
|
57
|
-
* @typedef
|
|
58
|
-
* @property {string}
|
|
59
|
-
*
|
|
60
|
-
* @property {
|
|
61
|
-
*
|
|
62
|
-
* @property {string}
|
|
63
|
-
*
|
|
64
|
-
* @property {
|
|
65
|
-
*
|
|
66
|
-
* @property {string}
|
|
67
|
-
*
|
|
68
|
-
* @property {string} [
|
|
85
|
+
* @typedef ServiceabilityDetailsResult
|
|
86
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
87
|
+
* scheduled to be processed on the same day.
|
|
88
|
+
* @property {string} [country_code] - ISO2 code representing the country where
|
|
89
|
+
* the serviceability is being specified.
|
|
90
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
91
|
+
* within the country where the serviceability is being specified.
|
|
92
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
93
|
+
* where the serviceability is being specified.
|
|
94
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
95
|
+
* district within the city where the serviceability is being specified.
|
|
96
|
+
* @property {string} [pincode] - A string indicating the postal code or PIN
|
|
97
|
+
* code of the address area.
|
|
98
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
99
|
+
* first-mile service is available or not.
|
|
100
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
101
|
+
* service is available or not.
|
|
102
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
103
|
+
* (COD) payments allowed in the specified region.
|
|
104
|
+
* @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
|
|
105
|
+
* allowed in the specified region.
|
|
106
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
107
|
+
* is available. This refers to the ability to return items directly from the
|
|
108
|
+
* customer's doorstep.
|
|
109
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
110
|
+
* service is available. This refers to the ability to perform quality checks
|
|
111
|
+
* on items at the customer's doorstep.
|
|
112
|
+
* @property {string} [forward_pickup_cutoff] - Time of day by which pickups
|
|
113
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
114
|
+
* @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
|
|
115
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
116
|
+
* @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
|
|
117
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
118
|
+
* instead of through a third-party service.
|
|
119
|
+
* @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
|
|
120
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether
|
|
121
|
+
* reverse pickup services is available.
|
|
122
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
123
|
+
* installation services are available in the specified region or not.
|
|
124
|
+
* @property {string} [id] - A string serving as the unique identifier.
|
|
69
125
|
*/
|
|
70
126
|
/**
|
|
71
|
-
* @typedef
|
|
72
|
-
* @property {
|
|
73
|
-
*
|
|
127
|
+
* @typedef ServiceabilityDetails
|
|
128
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
129
|
+
* first-mile service is available or not.
|
|
130
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
131
|
+
* service is available or not.
|
|
132
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
133
|
+
* (COD) payments allowed in the specified region.
|
|
134
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
135
|
+
* is available. This refers to the ability to return items directly from the
|
|
136
|
+
* customer's doorstep.
|
|
137
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
138
|
+
* service is available. This refers to the ability to perform quality checks
|
|
139
|
+
* on items at the customer's doorstep.
|
|
140
|
+
* @property {string} [forward_pickup_cutoff] - Time of day by which pickups
|
|
141
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
142
|
+
* @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
|
|
143
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
144
|
+
* @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
|
|
145
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
146
|
+
* instead of through a third-party service.
|
|
147
|
+
* @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
|
|
148
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
149
|
+
* installation services are available in the specified region or not.
|
|
150
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
151
|
+
* scheduled to be processed on the same day.
|
|
74
152
|
*/
|
|
75
153
|
/**
|
|
76
|
-
* @typedef
|
|
77
|
-
* @property {string}
|
|
78
|
-
*
|
|
79
|
-
* @property {string}
|
|
80
|
-
*
|
|
81
|
-
* @property {string}
|
|
82
|
-
*
|
|
154
|
+
* @typedef RegionServiceabilityResult
|
|
155
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
156
|
+
* scheduled to be processed on the same day.
|
|
157
|
+
* @property {string} country_code - ISO2 code representing the country where
|
|
158
|
+
* the serviceability is being specified.
|
|
159
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
160
|
+
* within the country where the serviceability is being specified.
|
|
161
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
162
|
+
* where the serviceability is being specified.
|
|
163
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
164
|
+
* district within the city where the serviceability is being specified.
|
|
165
|
+
* @property {string} [pincode] - A string indicating the postal code or PIN
|
|
166
|
+
* code of the address area.
|
|
167
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
168
|
+
* first-mile service is available or not.
|
|
169
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
170
|
+
* service is available or not.
|
|
171
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
172
|
+
* (COD) payments allowed in the specified region.
|
|
173
|
+
* @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
|
|
174
|
+
* allowed in the specified region.
|
|
175
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
176
|
+
* is available. This refers to the ability to return items directly from the
|
|
177
|
+
* customer's doorstep.
|
|
178
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
179
|
+
* service is available. This refers to the ability to perform quality checks
|
|
180
|
+
* on items at the customer's doorstep.
|
|
181
|
+
* @property {boolean} [reverse_pickup] - Indicates if reverse pickup is available.
|
|
182
|
+
* @property {string} [forward_pickup_cutoff] - Time of day by which pickups
|
|
183
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
184
|
+
* @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
|
|
185
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
186
|
+
* @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
|
|
187
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
188
|
+
* instead of through a third-party service.
|
|
189
|
+
* @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
|
|
190
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
191
|
+
* installation services are available in the specified region or not.
|
|
192
|
+
* @property {string} id - A string serving as the unique identifier.
|
|
83
193
|
*/
|
|
84
194
|
/**
|
|
85
|
-
* @typedef
|
|
86
|
-
* @property {
|
|
87
|
-
*
|
|
195
|
+
* @typedef RegionServiceabilityDetails
|
|
196
|
+
* @property {string} country_code - ISO2 code representing the country where
|
|
197
|
+
* the serviceability is being specified.
|
|
198
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
199
|
+
* within the country where the serviceability is being specified.
|
|
200
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
201
|
+
* where the serviceability is being specified.
|
|
202
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
203
|
+
* district within the city where the serviceability is being specified.
|
|
204
|
+
* @property {string} [pincode] - A string indicating the postal code or PIN
|
|
205
|
+
* code of the address area.
|
|
206
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
207
|
+
* first-mile service is available or not.
|
|
208
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
209
|
+
* service is available or not.
|
|
210
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
211
|
+
* (COD) payments allowed in the specified region.
|
|
212
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
213
|
+
* is available. This refers to the ability to return items directly from the
|
|
214
|
+
* customer's doorstep.
|
|
215
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
216
|
+
* service is available. This refers to the ability to perform quality checks
|
|
217
|
+
* on items at the customer's doorstep.
|
|
218
|
+
* @property {string} [forward_pickup_cutoff] - Time of day by which pickups
|
|
219
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
220
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
221
|
+
* scheduled to be processed on the same day.
|
|
222
|
+
* @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
|
|
223
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
224
|
+
* @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
|
|
225
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
226
|
+
* instead of through a third-party service.
|
|
227
|
+
* @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
|
|
228
|
+
* allowed in the specified region.
|
|
229
|
+
* @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
|
|
230
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
231
|
+
* installation services are available in the specified region or not.
|
|
88
232
|
*/
|
|
89
233
|
/**
|
|
90
|
-
* @typedef
|
|
91
|
-
* @property {
|
|
234
|
+
* @typedef RegionTatDetails
|
|
235
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
236
|
+
* from the origin to the destination in seconds.
|
|
237
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
238
|
+
* from the origin to the destination in seconds.
|
|
239
|
+
* @property {string} from_country_code - ISO2 code representing the country of
|
|
240
|
+
* origin for the delivery.
|
|
241
|
+
* @property {string} [from_state_code] - Code representing the state or
|
|
242
|
+
* province of origin within the country.
|
|
243
|
+
* @property {string} [from_city_code] - Code representing the city of origin
|
|
244
|
+
* within the state.
|
|
245
|
+
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
246
|
+
* or district within the city of origin.
|
|
247
|
+
* @property {string} [from_pincode] - A string indicating the postal code or
|
|
248
|
+
* PIN code of the address area.
|
|
249
|
+
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
250
|
+
* @property {string} [to_state_code] - Code representing the state or province
|
|
251
|
+
* of the destination within the country.
|
|
252
|
+
* @property {string} [to_city_code] - Code representing the city of destination
|
|
253
|
+
* within the state.
|
|
254
|
+
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
255
|
+
* district within the city of destination.
|
|
256
|
+
* @property {string} [to_pincode] - A string indicating the postal code or PIN
|
|
257
|
+
* code of the address area.
|
|
258
|
+
* @property {TATDetails} [forward]
|
|
259
|
+
* @property {TATDetails} [reverse]
|
|
260
|
+
*/
|
|
261
|
+
/**
|
|
262
|
+
* @typedef RegionTatResult
|
|
263
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
264
|
+
* from the origin to the destination in seconds.
|
|
265
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
266
|
+
* from the origin to the destination in seconds.
|
|
267
|
+
* @property {string} from_country_code - ISO2 code representing the country of
|
|
268
|
+
* origin for the delivery.
|
|
269
|
+
* @property {string} [from_state_code] - Code representing the state or
|
|
270
|
+
* province of origin within the country.
|
|
271
|
+
* @property {string} [from_city_code] - Code representing the city of origin
|
|
272
|
+
* within the state.
|
|
273
|
+
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
274
|
+
* or district within the city of origin.
|
|
275
|
+
* @property {string} [from_pincode] - A string indicating the postal code or
|
|
276
|
+
* PIN code of the address area.
|
|
277
|
+
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
278
|
+
* @property {string} [to_state_code] - Code representing the state or province
|
|
279
|
+
* of the destination within the country.
|
|
280
|
+
* @property {string} [to_city_code] - Code representing the city of destination
|
|
281
|
+
* within the state.
|
|
282
|
+
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
283
|
+
* district within the city of destination.
|
|
284
|
+
* @property {string} [to_pincode] - A string indicating the postal code or PIN
|
|
285
|
+
* code of the address area.
|
|
286
|
+
* @property {TATDetails} [forward]
|
|
287
|
+
* @property {TATDetails} [reverse]
|
|
288
|
+
* @property {string} id - A string serving as the unique identifier.
|
|
289
|
+
*/
|
|
290
|
+
/**
|
|
291
|
+
* @typedef BulkRegionJobDetails
|
|
292
|
+
* @property {string} [file_path] - Path to the file used in the bulk operation.
|
|
293
|
+
* @property {string} country - Country involved in the bulk operation.
|
|
294
|
+
* @property {string} action - Action type for the bulk operation, either import
|
|
295
|
+
* or export.
|
|
296
|
+
* @property {string} region - Region involved in the bulk operation.
|
|
297
|
+
*/
|
|
298
|
+
/**
|
|
299
|
+
* @typedef BulkRegionResultItemData
|
|
300
|
+
* @property {string} file_path - Path to the file associated with the result item.
|
|
301
|
+
* @property {number} [failed] - Number of failed records in the operation.
|
|
302
|
+
* @property {Object[]} [failed_records] - Array of failed records with
|
|
303
|
+
* additional properties.
|
|
304
|
+
* @property {string} action - Action type for the result item.
|
|
305
|
+
* @property {string} batch_id - A unique identifier for the performed batch operation.
|
|
306
|
+
* @property {string} country - Country associated with the result item.
|
|
307
|
+
* @property {number} [success] - Number of successful records in the operation.
|
|
308
|
+
* @property {string} region - Region associated with the result item.
|
|
309
|
+
* @property {string} status - Current status of the result item.
|
|
310
|
+
* @property {number} [total] - Total number of records processed.
|
|
311
|
+
* @property {string} [error_file_path] - Path to the file containing error details.
|
|
312
|
+
* @property {string} [modified_on] - The timestamp when the record last modified.
|
|
313
|
+
* @property {string} [created_on] - The timestamp when the record was created.
|
|
314
|
+
*/
|
|
315
|
+
/**
|
|
316
|
+
* @typedef BulkRegionResult
|
|
317
|
+
* @property {BulkRegionResultItemData[]} items - Array of bulk region result items.
|
|
92
318
|
* @property {Page} page
|
|
93
319
|
*/
|
|
94
320
|
/**
|
|
95
|
-
* @typedef
|
|
96
|
-
* @property {string}
|
|
97
|
-
*
|
|
98
|
-
* @property {string} [
|
|
99
|
-
* @property {
|
|
100
|
-
*
|
|
101
|
-
* @property {
|
|
102
|
-
*
|
|
103
|
-
* @property {string
|
|
104
|
-
*
|
|
105
|
-
* @property {
|
|
321
|
+
* @typedef CourierAccountDetailsBody
|
|
322
|
+
* @property {string} extension_id - The unique identifier for the extension
|
|
323
|
+
* linked to the courier account.
|
|
324
|
+
* @property {string} [account_id] - The unique identifier for the courier account.
|
|
325
|
+
* @property {string} scheme_id - The identifier for the scheme associated with
|
|
326
|
+
* the courier account.
|
|
327
|
+
* @property {boolean} is_self_ship - Indicates whether the courier account
|
|
328
|
+
* supports self-shipping (true if it does, false otherwise).
|
|
329
|
+
* @property {string} stage - The current stage of the courier account, either
|
|
330
|
+
* 'enabled' or 'disabled'.
|
|
331
|
+
* @property {boolean} is_own_account - Indicates whether the courier account is
|
|
332
|
+
* an own account (true if it is, false otherwise).
|
|
106
333
|
*/
|
|
107
334
|
/**
|
|
108
|
-
* @typedef
|
|
109
|
-
* @property {
|
|
110
|
-
*
|
|
111
|
-
* @property {
|
|
112
|
-
* @property {string} scheme_id
|
|
113
|
-
* @property {boolean} is_self_ship
|
|
114
|
-
* @property {string} stage
|
|
115
|
-
* @property {boolean} is_own_account
|
|
116
|
-
* @property {CourierAccountSchemeResponse} scheme_rules
|
|
335
|
+
* @typedef CompanyCourierPartnerAccountListResult
|
|
336
|
+
* @property {CourierAccountResult[]} items - An array containing multiple
|
|
337
|
+
* instances of CourierAccountResult, which details individual courier accounts.
|
|
338
|
+
* @property {Page} page
|
|
117
339
|
*/
|
|
118
340
|
/**
|
|
119
|
-
* @typedef
|
|
120
|
-
* @property {string}
|
|
121
|
-
* @property {
|
|
122
|
-
* @property {string}
|
|
341
|
+
* @typedef CourierAccountResult
|
|
342
|
+
* @property {string} account_id - A string that uniquely identifies the courier account.
|
|
343
|
+
* @property {number} [company_id] - The unique identifier of the company.
|
|
344
|
+
* @property {string} scheme_id - A string that specifies the unique identifier
|
|
345
|
+
* for the scheme associated with the account
|
|
346
|
+
* @property {string} [extension_id] - A string that uniquely identifies the
|
|
347
|
+
* courier partner extension.
|
|
348
|
+
* @property {boolean} is_self_ship - A boolean indicating whether the account
|
|
349
|
+
* is for self-shipping.
|
|
350
|
+
* @property {string} stage - A string indicating the current stage of the
|
|
351
|
+
* account, which can be either enabled or disabled.
|
|
352
|
+
* @property {boolean} is_own_account - A boolean indicating whether the account
|
|
353
|
+
* is owned by the company.
|
|
354
|
+
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
355
|
+
*/
|
|
356
|
+
/**
|
|
357
|
+
* @typedef CourierPartnerSchemeDetailsModel
|
|
358
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
359
|
+
* @property {string} [scheme_id] - Unique identifier for the scheme, used to
|
|
360
|
+
* fetch or modify scheme details.
|
|
361
|
+
* @property {string} name - Name of the scheme.
|
|
123
362
|
* @property {ArithmeticOperations} weight
|
|
124
363
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
125
|
-
* @property {string} transport_type
|
|
126
|
-
*
|
|
127
|
-
* @property {string}
|
|
128
|
-
*
|
|
129
|
-
* @property {string}
|
|
364
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
365
|
+
* courier partner scheme.
|
|
366
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
367
|
+
* partner scheme.
|
|
368
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
369
|
+
* courier partner scheme.
|
|
370
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
371
|
+
* courier partner scheme.
|
|
372
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
373
|
+
* currently active or inactive.
|
|
374
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
375
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
376
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
377
|
+
* (NDR) feature is supported by the courier partner.
|
|
378
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
379
|
+
* of items allowed in a quality check shipment.
|
|
380
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
381
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
130
382
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
131
383
|
*/
|
|
132
384
|
/**
|
|
133
|
-
* @typedef
|
|
134
|
-
* @property {
|
|
135
|
-
* @property {
|
|
136
|
-
* @property {
|
|
137
|
-
* @property {
|
|
138
|
-
* @property {
|
|
139
|
-
* @property {
|
|
140
|
-
* @property {
|
|
141
|
-
* @property {
|
|
142
|
-
* @property {
|
|
143
|
-
* @property {
|
|
144
|
-
* @property {
|
|
145
|
-
*
|
|
146
|
-
* @property {
|
|
147
|
-
*
|
|
148
|
-
* @property {
|
|
149
|
-
*
|
|
150
|
-
* @property {
|
|
151
|
-
*
|
|
385
|
+
* @typedef CourierPartnerPutSchema
|
|
386
|
+
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
387
|
+
* @property {CreatedBy} [created_by]
|
|
388
|
+
* @property {ModifiedBy} [modified_by]
|
|
389
|
+
* @property {string} [created_on] - The timestamp when the record was created.
|
|
390
|
+
* @property {string} [modified_on] - The timestamp when the record last modified.
|
|
391
|
+
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
392
|
+
* @property {string} [company_id] - Unique identifier of company.
|
|
393
|
+
* @property {string} name - Name of the scheme.
|
|
394
|
+
* @property {ArithmeticOperations} weight
|
|
395
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
396
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
397
|
+
* courier partner scheme.
|
|
398
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
399
|
+
* partner scheme.
|
|
400
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
401
|
+
* courier partner scheme.
|
|
402
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
403
|
+
* courier partner scheme.
|
|
404
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
405
|
+
* currently active or inactive.
|
|
406
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
407
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
408
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
409
|
+
* (NDR) feature is supported by the courier partner.
|
|
410
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
411
|
+
* of items allowed in a quality check shipment.
|
|
412
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
413
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
414
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
415
|
+
*/
|
|
416
|
+
/**
|
|
417
|
+
* @typedef CourierPartnerSchemeList
|
|
418
|
+
* @property {CourierPartnerSchemeModelSchema[]} items - List of courier partner schemes
|
|
419
|
+
* @property {Page} page
|
|
420
|
+
*/
|
|
421
|
+
/**
|
|
422
|
+
* @typedef CourierPartnerSchemeUpdateDetails
|
|
423
|
+
* @property {string} name - Name of the scheme.
|
|
424
|
+
* @property {ArithmeticOperations} weight
|
|
425
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
426
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
427
|
+
* courier partner scheme.
|
|
428
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
429
|
+
* partner scheme.
|
|
430
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
431
|
+
* courier partner scheme.
|
|
432
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
433
|
+
* courier partner scheme.
|
|
434
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
435
|
+
* currently active or inactive.
|
|
436
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
437
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
438
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
439
|
+
* (NDR) feature is supported by the courier partner.
|
|
440
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
441
|
+
* of items allowed in a quality check shipment.
|
|
442
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
443
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
444
|
+
* @property {CourierPartnerSchemeFeatures} feature
|
|
445
|
+
*/
|
|
446
|
+
/**
|
|
447
|
+
* @typedef GetCountries
|
|
448
|
+
* @property {GetCountriesItems[]} items - A list of country objects containing
|
|
449
|
+
* detailed information about each country.
|
|
450
|
+
* @property {Page} page
|
|
451
|
+
*/
|
|
452
|
+
/**
|
|
453
|
+
* @typedef TATUpdateDetails
|
|
454
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
455
|
+
* from the origin to the destination in seconds.
|
|
456
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
457
|
+
* from the origin to the destination in seconds.
|
|
458
|
+
* @property {TATDetails} [forward]
|
|
459
|
+
* @property {TATDetails} [reverse]
|
|
460
|
+
*/
|
|
461
|
+
/**
|
|
462
|
+
* @typedef StandardError
|
|
463
|
+
* @property {string} message - A brief description of the error.
|
|
464
|
+
*/
|
|
465
|
+
/**
|
|
466
|
+
* @typedef ValidationErrors
|
|
467
|
+
* @property {ValidationError[]} errors - A list of validation errors in the request.
|
|
468
|
+
*/
|
|
469
|
+
/**
|
|
470
|
+
* @typedef CreatedBy
|
|
471
|
+
* @property {string} [id] - Identifier of the user or system that created the object.
|
|
472
|
+
*/
|
|
473
|
+
/**
|
|
474
|
+
* @typedef ModifiedBy
|
|
475
|
+
* @property {string} [id] - Identifier of the user or system that created the object.
|
|
152
476
|
*/
|
|
153
477
|
/**
|
|
154
478
|
* @typedef ArithmeticOperations
|
|
155
|
-
* @property {number} [lt]
|
|
156
|
-
*
|
|
157
|
-
* @property {number} [
|
|
158
|
-
*
|
|
479
|
+
* @property {number} [lt] - Specifies a less than operation, comparing values
|
|
480
|
+
* smaller than the provided value.
|
|
481
|
+
* @property {number} [gt] - Specifies a greater than operation, comparing
|
|
482
|
+
* values larger than the provided value.
|
|
483
|
+
* @property {number} [lte] - Specifies a less than or equal to operation,
|
|
484
|
+
* comparing values smaller than or equal to the provided value.
|
|
485
|
+
* @property {number} [gte] - Specifies a greater than or equal to operation,
|
|
486
|
+
* comparing values larger than or equal to the provided value.
|
|
487
|
+
*/
|
|
488
|
+
/**
|
|
489
|
+
* @typedef CourierPartnerSchemeFeatures
|
|
490
|
+
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
491
|
+
* doorstep quality check services.
|
|
492
|
+
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
493
|
+
* code-based operations.
|
|
494
|
+
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
495
|
+
* multi-part shipment services.
|
|
496
|
+
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
497
|
+
* feature is supported by the courier partner.
|
|
498
|
+
* @property {number} [ndr_attempts] - Number of attempts allowed for resolving
|
|
499
|
+
* Non-Delivery Reports (NDR).
|
|
500
|
+
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
501
|
+
* handles the transportation of dangerous goods.
|
|
502
|
+
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
503
|
+
* manages the shipment of fragile goods.
|
|
504
|
+
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
505
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
506
|
+
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
507
|
+
* provides cold storage facilities for goods.
|
|
508
|
+
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
509
|
+
* supports doorstep exchange services.
|
|
510
|
+
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
511
|
+
* offers doorstep return services.
|
|
512
|
+
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
513
|
+
* provides product installation services upon delivery.
|
|
514
|
+
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
515
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
516
|
+
* before accepting.
|
|
517
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
518
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
519
|
+
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
520
|
+
* partner supports multiple pickups to a single drop location.
|
|
521
|
+
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
522
|
+
* partner supports single pickup to multiple drop locations.
|
|
523
|
+
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
524
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
525
|
+
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
526
|
+
* supports the generation of e-waybills for shipments.
|
|
527
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
528
|
+
* of items allowed in a quality check shipment.
|
|
529
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
530
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
531
|
+
*/
|
|
532
|
+
/**
|
|
533
|
+
* @typedef Error
|
|
534
|
+
* @property {string} [type] - The type of the error.
|
|
535
|
+
* @property {string} [value] - The value associated with the error.
|
|
536
|
+
* @property {string} [message] - The error message describing the issue.
|
|
537
|
+
*/
|
|
538
|
+
/**
|
|
539
|
+
* @typedef Page
|
|
540
|
+
* @property {number} [item_total] - The total number of items on the page.
|
|
541
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
542
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
543
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
544
|
+
* @property {number} [current] - The current page number.
|
|
545
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
546
|
+
* @property {number} [size] - The number of items per page.
|
|
547
|
+
* @property {number} [page_size] - The number of items per page.
|
|
548
|
+
*/
|
|
549
|
+
/**
|
|
550
|
+
* @typedef TATDetails
|
|
551
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
552
|
+
* from the origin to the destination in seconds.
|
|
553
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
554
|
+
* from the origin to the destination in seconds.
|
|
159
555
|
*/
|
|
160
556
|
/**
|
|
161
|
-
* @typedef
|
|
162
|
-
* @property {string}
|
|
557
|
+
* @typedef CourierPartnerSchemeModel
|
|
558
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
559
|
+
* @property {string} scheme_id - A string representing the unique identifier
|
|
560
|
+
* for the scheme. This is a required field.
|
|
561
|
+
* @property {string} name - A string that specifies the name of the scheme.
|
|
562
|
+
* This is a required field.
|
|
163
563
|
* @property {ArithmeticOperations} weight
|
|
164
564
|
* @property {ArithmeticOperations} [volumetric_weight]
|
|
165
|
-
* @property {string} transport_type
|
|
166
|
-
* @property {string} region
|
|
167
|
-
* @property {string} delivery_type
|
|
168
|
-
* @property {string[]} payment_mode
|
|
169
|
-
*
|
|
565
|
+
* @property {string} transport_type - A string that specifies the type of transport.
|
|
566
|
+
* @property {string} region - A string that indicates the region type.
|
|
567
|
+
* @property {string} delivery_type - A string that defines the delivery type.
|
|
568
|
+
* @property {string[]} payment_mode - An array of strings specifying the
|
|
569
|
+
* payment modes available.
|
|
570
|
+
* @property {string} stage - A string indicating the current stage of the scheme.
|
|
170
571
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
171
572
|
*/
|
|
172
573
|
/**
|
|
173
|
-
* @typedef
|
|
174
|
-
* @property {string} [
|
|
175
|
-
* @property {string} [
|
|
574
|
+
* @typedef GetCountriesItems
|
|
575
|
+
* @property {string} [id] - A string serving as the unique identifier.
|
|
576
|
+
* @property {string} [sub_type] - A category for classifying the country into a
|
|
577
|
+
* specific subtype.
|
|
578
|
+
* @property {string} [uid] - A globally unique identifier for the country.
|
|
579
|
+
* @property {string} [name] - The official or widely recognized name of the
|
|
580
|
+
* country used in general contexts.
|
|
581
|
+
* @property {string} [iso2] - The 2-letter ISO code for the country.
|
|
582
|
+
* @property {string} [iso3] - The 3-letter ISO code for the country.
|
|
583
|
+
* @property {string[]} [timezones] - A list of timezones associated with the country.
|
|
584
|
+
* @property {HierarchyItems[]} [hierarchy] - A hierarchical list of items
|
|
585
|
+
* representing organizational levels within the country.
|
|
586
|
+
* @property {string} [phone_code] - A country-specific phone code.
|
|
587
|
+
* @property {CurrencyObject} [currency]
|
|
588
|
+
* @property {string} [type] - The type or classification of the country (e.g.,
|
|
589
|
+
* sovereign or dependent).
|
|
590
|
+
* @property {string} [latitude] - The latitude of the central point of the country.
|
|
591
|
+
* @property {string} [longitude] - The longitude of the central point of the country.
|
|
592
|
+
* @property {string} [display_name] - A user-friendly name for the country,
|
|
593
|
+
* typically for display purposes.
|
|
594
|
+
* @property {boolean} [has_next_hierarchy] - A boolean indicating whether
|
|
595
|
+
* additional hierarchical regions or divisions are present.
|
|
596
|
+
*/
|
|
597
|
+
/**
|
|
598
|
+
* @typedef HierarchyItems
|
|
599
|
+
* @property {string} [name] - The name of the item as displayed to the user,
|
|
600
|
+
* usually in a UI or listing.
|
|
601
|
+
* @property {string} [display_name] - It represent a country display name.
|
|
602
|
+
* @property {string} [slug] - A slug is a human-readable URL segment, typically
|
|
603
|
+
* generated from a title with special characters removed.
|
|
176
604
|
*/
|
|
177
605
|
/**
|
|
178
606
|
* @typedef CurrencyObject
|
|
179
|
-
* @property {string} [code]
|
|
180
|
-
* @property {string} [name]
|
|
181
|
-
* @property {string} [symbol]
|
|
182
|
-
*/
|
|
183
|
-
/**
|
|
184
|
-
* @typedef CountryObject
|
|
185
|
-
* @property {string} [id]
|
|
186
|
-
* @property {string} [name]
|
|
187
|
-
* @property {string} [display_name]
|
|
188
|
-
* @property {string} [iso2]
|
|
189
|
-
* @property {string} [iso3]
|
|
190
|
-
* @property {string[]} [timezones]
|
|
191
|
-
* @property {CountryHierarchy[]} [hierarchy]
|
|
192
|
-
* @property {string} [phone_code]
|
|
193
|
-
* @property {string} [latitude]
|
|
194
|
-
* @property {string} [longitude]
|
|
195
|
-
* @property {CurrencyObject} [currency]
|
|
196
|
-
* @property {string} [type]
|
|
607
|
+
* @property {string} [code] - A string representing the currency code.
|
|
608
|
+
* @property {string} [name] - A string representing the currency name.
|
|
609
|
+
* @property {string} [symbol] - A string representing the currency symbol.
|
|
197
610
|
*/
|
|
198
611
|
/**
|
|
199
|
-
* @typedef
|
|
200
|
-
* @property {
|
|
201
|
-
* @property {
|
|
612
|
+
* @typedef ValidationError
|
|
613
|
+
* @property {string} message - A brief description of the error encountered.
|
|
614
|
+
* @property {string} field - The field in the request that caused the error.
|
|
202
615
|
*/
|
|
203
616
|
declare class LogisticsPartnerModel {
|
|
204
617
|
}
|
|
205
618
|
declare namespace LogisticsPartnerModel {
|
|
206
|
-
export {
|
|
619
|
+
export { CourierPartnerSchemeModelSchema, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, CommonErrorResult, BulkFailureResult, FailureResult, BulkRegionServiceabilityTatResult, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccountDetailsBody, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeDetailsModel, CourierPartnerPutSchema, CourierPartnerSchemeList, CourierPartnerSchemeUpdateDetails, GetCountries, TATUpdateDetails, StandardError, ValidationErrors, CreatedBy, ModifiedBy, ArithmeticOperations, CourierPartnerSchemeFeatures, Error, Page, TATDetails, CourierPartnerSchemeModel, GetCountriesItems, HierarchyItems, CurrencyObject, ValidationError };
|
|
207
620
|
}
|
|
208
|
-
/** @returns {
|
|
209
|
-
declare function
|
|
210
|
-
type
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
621
|
+
/** @returns {CourierPartnerSchemeModelSchema} */
|
|
622
|
+
declare function CourierPartnerSchemeModelSchema(): CourierPartnerSchemeModelSchema;
|
|
623
|
+
type CourierPartnerSchemeModelSchema = {
|
|
624
|
+
created_by?: CreatedBy;
|
|
625
|
+
/**
|
|
626
|
+
* - The timestamp when the record was created.
|
|
627
|
+
*/
|
|
628
|
+
created_on?: string;
|
|
629
|
+
modified_by?: ModifiedBy;
|
|
630
|
+
/**
|
|
631
|
+
* - The timestamp when the record last modified.
|
|
632
|
+
*/
|
|
633
|
+
modified_on?: string;
|
|
634
|
+
/**
|
|
635
|
+
* - Unique identifier of courier partner extension.
|
|
636
|
+
*/
|
|
637
|
+
extension_id?: string;
|
|
638
|
+
/**
|
|
639
|
+
* - Unique identifier for the scheme, used to
|
|
640
|
+
* fetch or modify scheme details.
|
|
641
|
+
*/
|
|
642
|
+
scheme_id?: string;
|
|
643
|
+
/**
|
|
644
|
+
* - Unique identifier of company.
|
|
645
|
+
*/
|
|
646
|
+
company_id?: string;
|
|
647
|
+
/**
|
|
648
|
+
* - Name of the scheme.
|
|
649
|
+
*/
|
|
650
|
+
name: string;
|
|
651
|
+
weight: ArithmeticOperations;
|
|
652
|
+
volumetric_weight?: ArithmeticOperations;
|
|
653
|
+
/**
|
|
654
|
+
* - Mode of transport associated with the
|
|
655
|
+
* courier partner scheme.
|
|
656
|
+
*/
|
|
657
|
+
transport_type: string;
|
|
658
|
+
/**
|
|
659
|
+
* - Serviceable region associated with the courier
|
|
660
|
+
* partner scheme.
|
|
661
|
+
*/
|
|
662
|
+
region: string;
|
|
663
|
+
/**
|
|
664
|
+
* - Type of delivery associated with the
|
|
665
|
+
* courier partner scheme.
|
|
666
|
+
*/
|
|
667
|
+
delivery_type: string;
|
|
668
|
+
/**
|
|
669
|
+
* - Mode of payment associated with the
|
|
670
|
+
* courier partner scheme.
|
|
671
|
+
*/
|
|
672
|
+
payment_mode: string[];
|
|
673
|
+
/**
|
|
674
|
+
* - Indicates if the courier partner scheme is
|
|
675
|
+
* currently active or inactive.
|
|
676
|
+
*/
|
|
677
|
+
stage: string;
|
|
678
|
+
/**
|
|
679
|
+
* - Describes the type of status updates
|
|
680
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
681
|
+
*/
|
|
682
|
+
status_updates?: string;
|
|
683
|
+
/**
|
|
684
|
+
* - Indicates if the Non-Delivery Report
|
|
685
|
+
* (NDR) feature is supported by the courier partner.
|
|
686
|
+
*/
|
|
687
|
+
ndr_attempts?: number;
|
|
688
|
+
/**
|
|
689
|
+
* - Defines the maximum quantity
|
|
690
|
+
* of items allowed in a quality check shipment.
|
|
691
|
+
*/
|
|
692
|
+
qc_shipment_item_quantity?: number;
|
|
693
|
+
/**
|
|
694
|
+
* - Defines the maximum
|
|
695
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
696
|
+
*/
|
|
697
|
+
non_qc_shipment_item_quantity?: number;
|
|
698
|
+
feature: CourierPartnerSchemeFeatures;
|
|
699
|
+
};
|
|
700
|
+
/** @returns {BulkRegionServiceabilityTatDetails} */
|
|
701
|
+
declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
|
|
702
|
+
type BulkRegionServiceabilityTatDetails = {
|
|
703
|
+
/**
|
|
704
|
+
* - Country involved in the operation.
|
|
705
|
+
*/
|
|
216
706
|
country: string;
|
|
707
|
+
/**
|
|
708
|
+
* - Region involved in the operation.
|
|
709
|
+
*/
|
|
217
710
|
region: string;
|
|
711
|
+
/**
|
|
712
|
+
* - Type of operation, either serviceability or TAT.
|
|
713
|
+
*/
|
|
218
714
|
type: string;
|
|
219
715
|
};
|
|
220
|
-
/** @returns {
|
|
221
|
-
declare function
|
|
222
|
-
type
|
|
716
|
+
/** @returns {BulkRegionServiceabilityTatResultItemData} */
|
|
717
|
+
declare function BulkRegionServiceabilityTatResultItemData(): BulkRegionServiceabilityTatResultItemData;
|
|
718
|
+
type BulkRegionServiceabilityTatResultItemData = {
|
|
719
|
+
/**
|
|
720
|
+
* - Name of the country.
|
|
721
|
+
*/
|
|
223
722
|
country?: string;
|
|
723
|
+
/**
|
|
724
|
+
* - Name of the region for which the
|
|
725
|
+
* tat/serviceability file needs to be downloaded.
|
|
726
|
+
*/
|
|
224
727
|
region?: string;
|
|
728
|
+
/**
|
|
729
|
+
* - Denotes the type of data.
|
|
730
|
+
*/
|
|
225
731
|
type?: string;
|
|
732
|
+
/**
|
|
733
|
+
* - A unique identifier for the performed batch operation.
|
|
734
|
+
*/
|
|
226
735
|
batch_id?: string;
|
|
736
|
+
/**
|
|
737
|
+
* - Current status of the request.
|
|
738
|
+
*/
|
|
227
739
|
status?: string;
|
|
740
|
+
/**
|
|
741
|
+
* - Information of records which failed
|
|
742
|
+
*/
|
|
228
743
|
failed_records?: any[];
|
|
744
|
+
/**
|
|
745
|
+
* - CDN path of the file.
|
|
746
|
+
*/
|
|
229
747
|
file_path?: string;
|
|
230
748
|
};
|
|
231
|
-
/** @returns {
|
|
232
|
-
declare function
|
|
233
|
-
type
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
749
|
+
/** @returns {CommonErrorResult} */
|
|
750
|
+
declare function CommonErrorResult(): CommonErrorResult;
|
|
751
|
+
type CommonErrorResult = {
|
|
752
|
+
/**
|
|
753
|
+
* - An array of items referencing the ErrorResult
|
|
754
|
+
* schema, which likely contains detailed information about the errors.
|
|
755
|
+
*/
|
|
756
|
+
error?: Error[];
|
|
757
|
+
};
|
|
758
|
+
/** @returns {BulkFailureResult} */
|
|
759
|
+
declare function BulkFailureResult(): BulkFailureResult;
|
|
760
|
+
type BulkFailureResult = {
|
|
761
|
+
/**
|
|
762
|
+
* - Whether operation was successful.
|
|
763
|
+
*/
|
|
764
|
+
success?: boolean;
|
|
765
|
+
/**
|
|
766
|
+
* - An array containing error details.
|
|
767
|
+
*/
|
|
768
|
+
error: Error[];
|
|
237
769
|
};
|
|
238
|
-
/** @returns {
|
|
239
|
-
declare function
|
|
240
|
-
type
|
|
241
|
-
|
|
242
|
-
|
|
770
|
+
/** @returns {FailureResult} */
|
|
771
|
+
declare function FailureResult(): FailureResult;
|
|
772
|
+
type FailureResult = {
|
|
773
|
+
/**
|
|
774
|
+
* - Whether operation was successful.
|
|
775
|
+
*/
|
|
776
|
+
success?: boolean;
|
|
777
|
+
/**
|
|
778
|
+
* - Array of error details.
|
|
779
|
+
*/
|
|
780
|
+
error?: Error[];
|
|
243
781
|
};
|
|
244
|
-
/** @returns {
|
|
245
|
-
declare function
|
|
246
|
-
type
|
|
247
|
-
|
|
782
|
+
/** @returns {BulkRegionServiceabilityTatResult} */
|
|
783
|
+
declare function BulkRegionServiceabilityTatResult(): BulkRegionServiceabilityTatResult;
|
|
784
|
+
type BulkRegionServiceabilityTatResult = {
|
|
785
|
+
/**
|
|
786
|
+
* - Array of
|
|
787
|
+
* bulk region serviceability or TAT result items.
|
|
788
|
+
*/
|
|
789
|
+
items?: BulkRegionServiceabilityTatResultItemData[];
|
|
248
790
|
page?: Page;
|
|
249
791
|
};
|
|
250
|
-
/** @returns {
|
|
251
|
-
declare function
|
|
252
|
-
type
|
|
792
|
+
/** @returns {RegionTatItemResult} */
|
|
793
|
+
declare function RegionTatItemResult(): RegionTatItemResult;
|
|
794
|
+
type RegionTatItemResult = {
|
|
253
795
|
/**
|
|
254
|
-
* -
|
|
796
|
+
* - An array that contains items of region tat.
|
|
255
797
|
*/
|
|
256
|
-
|
|
798
|
+
items: RegionTatResult[];
|
|
799
|
+
page: Page;
|
|
800
|
+
};
|
|
801
|
+
/** @returns {RegionServiceabilityItemResult} */
|
|
802
|
+
declare function RegionServiceabilityItemResult(): RegionServiceabilityItemResult;
|
|
803
|
+
type RegionServiceabilityItemResult = {
|
|
257
804
|
/**
|
|
258
|
-
* -
|
|
805
|
+
* - An array that contains items
|
|
806
|
+
* of region serviceability.
|
|
259
807
|
*/
|
|
260
|
-
|
|
808
|
+
items: RegionServiceabilityResult[];
|
|
809
|
+
page: Page;
|
|
810
|
+
};
|
|
811
|
+
/** @returns {ServiceabilityDetailsResult} */
|
|
812
|
+
declare function ServiceabilityDetailsResult(): ServiceabilityDetailsResult;
|
|
813
|
+
type ServiceabilityDetailsResult = {
|
|
261
814
|
/**
|
|
262
|
-
* -
|
|
815
|
+
* - Time of day by which pickups must be
|
|
816
|
+
* scheduled to be processed on the same day.
|
|
263
817
|
*/
|
|
264
|
-
|
|
818
|
+
pickup_cutoff?: string;
|
|
265
819
|
/**
|
|
266
|
-
* -
|
|
820
|
+
* - ISO2 code representing the country where
|
|
821
|
+
* the serviceability is being specified.
|
|
267
822
|
*/
|
|
268
|
-
|
|
823
|
+
country_code?: string;
|
|
269
824
|
/**
|
|
270
|
-
* -
|
|
825
|
+
* - Code representing the state or province
|
|
826
|
+
* within the country where the serviceability is being specified.
|
|
271
827
|
*/
|
|
272
|
-
|
|
828
|
+
state_code?: string;
|
|
273
829
|
/**
|
|
274
|
-
* -
|
|
830
|
+
* - Code representing the city within the state
|
|
831
|
+
* where the serviceability is being specified.
|
|
275
832
|
*/
|
|
276
|
-
|
|
833
|
+
city_code?: string;
|
|
277
834
|
/**
|
|
278
|
-
* -
|
|
835
|
+
* - Code representing a specific sector or
|
|
836
|
+
* district within the city where the serviceability is being specified.
|
|
279
837
|
*/
|
|
280
|
-
|
|
838
|
+
sector_code?: string;
|
|
281
839
|
/**
|
|
282
|
-
* -
|
|
840
|
+
* - A string indicating the postal code or PIN
|
|
841
|
+
* code of the address area.
|
|
283
842
|
*/
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
843
|
+
pincode?: string;
|
|
844
|
+
/**
|
|
845
|
+
* - Boolean value indicating whether
|
|
846
|
+
* first-mile service is available or not.
|
|
847
|
+
*/
|
|
848
|
+
first_mile?: boolean;
|
|
849
|
+
/**
|
|
850
|
+
* - Boolean value indicating whether last-mile
|
|
851
|
+
* service is available or not.
|
|
852
|
+
*/
|
|
853
|
+
last_mile?: boolean;
|
|
854
|
+
/**
|
|
855
|
+
* - Limit on the amount of cash on delivery
|
|
856
|
+
* (COD) payments allowed in the specified region.
|
|
857
|
+
*/
|
|
858
|
+
cod_limit?: number;
|
|
859
|
+
/**
|
|
860
|
+
* - Limit on the amount of prepaid payments
|
|
861
|
+
* allowed in the specified region.
|
|
862
|
+
*/
|
|
863
|
+
prepaid_limit?: number;
|
|
864
|
+
/**
|
|
865
|
+
* - Indicates if doorstep return service
|
|
866
|
+
* is available. This refers to the ability to return items directly from the
|
|
867
|
+
* customer's doorstep.
|
|
868
|
+
*/
|
|
869
|
+
doorstep_return?: boolean;
|
|
870
|
+
/**
|
|
871
|
+
* - Indicates if doorstep quality check
|
|
872
|
+
* service is available. This refers to the ability to perform quality checks
|
|
873
|
+
* on items at the customer's doorstep.
|
|
874
|
+
*/
|
|
875
|
+
doorstep_qc?: boolean;
|
|
876
|
+
/**
|
|
877
|
+
* - Time of day by which pickups
|
|
878
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
879
|
+
*/
|
|
880
|
+
forward_pickup_cutoff?: string;
|
|
881
|
+
/**
|
|
882
|
+
* - Time of day by which pickups
|
|
883
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
884
|
+
*/
|
|
885
|
+
reverse_pickup_cutoff?: string;
|
|
886
|
+
/**
|
|
887
|
+
* - Indicates whether the product
|
|
888
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
889
|
+
* instead of through a third-party service.
|
|
890
|
+
*/
|
|
891
|
+
hand_to_hand_exchange?: boolean;
|
|
892
|
+
/**
|
|
893
|
+
* - List of holidays for a courier partner scheme.
|
|
894
|
+
*/
|
|
895
|
+
holiday_list?: string[];
|
|
896
|
+
/**
|
|
897
|
+
* - Boolean value indicating whether
|
|
898
|
+
* reverse pickup services is available.
|
|
899
|
+
*/
|
|
900
|
+
reverse_pickup?: boolean;
|
|
901
|
+
/**
|
|
902
|
+
* - Boolean value indicating whether
|
|
903
|
+
* installation services are available in the specified region or not.
|
|
904
|
+
*/
|
|
905
|
+
installation?: boolean;
|
|
906
|
+
/**
|
|
907
|
+
* - A string serving as the unique identifier.
|
|
908
|
+
*/
|
|
909
|
+
id?: string;
|
|
308
910
|
};
|
|
309
|
-
/** @returns {
|
|
310
|
-
declare function
|
|
311
|
-
type
|
|
312
|
-
|
|
313
|
-
|
|
911
|
+
/** @returns {ServiceabilityDetails} */
|
|
912
|
+
declare function ServiceabilityDetails(): ServiceabilityDetails;
|
|
913
|
+
type ServiceabilityDetails = {
|
|
914
|
+
/**
|
|
915
|
+
* - Boolean value indicating whether
|
|
916
|
+
* first-mile service is available or not.
|
|
917
|
+
*/
|
|
918
|
+
first_mile?: boolean;
|
|
919
|
+
/**
|
|
920
|
+
* - Boolean value indicating whether last-mile
|
|
921
|
+
* service is available or not.
|
|
922
|
+
*/
|
|
923
|
+
last_mile?: boolean;
|
|
924
|
+
/**
|
|
925
|
+
* - Limit on the amount of cash on delivery
|
|
926
|
+
* (COD) payments allowed in the specified region.
|
|
927
|
+
*/
|
|
928
|
+
cod_limit?: number;
|
|
929
|
+
/**
|
|
930
|
+
* - Indicates if doorstep return service
|
|
931
|
+
* is available. This refers to the ability to return items directly from the
|
|
932
|
+
* customer's doorstep.
|
|
933
|
+
*/
|
|
934
|
+
doorstep_return?: boolean;
|
|
935
|
+
/**
|
|
936
|
+
* - Indicates if doorstep quality check
|
|
937
|
+
* service is available. This refers to the ability to perform quality checks
|
|
938
|
+
* on items at the customer's doorstep.
|
|
939
|
+
*/
|
|
940
|
+
doorstep_qc?: boolean;
|
|
941
|
+
/**
|
|
942
|
+
* - Time of day by which pickups
|
|
943
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
944
|
+
*/
|
|
945
|
+
forward_pickup_cutoff?: string;
|
|
946
|
+
/**
|
|
947
|
+
* - Time of day by which pickups
|
|
948
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
949
|
+
*/
|
|
950
|
+
reverse_pickup_cutoff?: string;
|
|
951
|
+
/**
|
|
952
|
+
* - Indicates whether the product
|
|
953
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
954
|
+
* instead of through a third-party service.
|
|
955
|
+
*/
|
|
956
|
+
hand_to_hand_exchange?: boolean;
|
|
957
|
+
/**
|
|
958
|
+
* - List of holidays for a courier partner scheme.
|
|
959
|
+
*/
|
|
960
|
+
holiday_list?: string[];
|
|
961
|
+
/**
|
|
962
|
+
* - Boolean value indicating whether
|
|
963
|
+
* installation services are available in the specified region or not.
|
|
964
|
+
*/
|
|
965
|
+
installation?: boolean;
|
|
966
|
+
/**
|
|
967
|
+
* - Time of day by which pickups must be
|
|
968
|
+
* scheduled to be processed on the same day.
|
|
969
|
+
*/
|
|
970
|
+
pickup_cutoff?: string;
|
|
314
971
|
};
|
|
315
|
-
/** @returns {
|
|
316
|
-
declare function
|
|
317
|
-
type
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
972
|
+
/** @returns {RegionServiceabilityResult} */
|
|
973
|
+
declare function RegionServiceabilityResult(): RegionServiceabilityResult;
|
|
974
|
+
type RegionServiceabilityResult = {
|
|
975
|
+
/**
|
|
976
|
+
* - Time of day by which pickups must be
|
|
977
|
+
* scheduled to be processed on the same day.
|
|
978
|
+
*/
|
|
979
|
+
pickup_cutoff?: string;
|
|
980
|
+
/**
|
|
981
|
+
* - ISO2 code representing the country where
|
|
982
|
+
* the serviceability is being specified.
|
|
983
|
+
*/
|
|
984
|
+
country_code: string;
|
|
985
|
+
/**
|
|
986
|
+
* - Code representing the state or province
|
|
987
|
+
* within the country where the serviceability is being specified.
|
|
988
|
+
*/
|
|
989
|
+
state_code?: string;
|
|
990
|
+
/**
|
|
991
|
+
* - Code representing the city within the state
|
|
992
|
+
* where the serviceability is being specified.
|
|
993
|
+
*/
|
|
994
|
+
city_code?: string;
|
|
995
|
+
/**
|
|
996
|
+
* - Code representing a specific sector or
|
|
997
|
+
* district within the city where the serviceability is being specified.
|
|
998
|
+
*/
|
|
999
|
+
sector_code?: string;
|
|
1000
|
+
/**
|
|
1001
|
+
* - A string indicating the postal code or PIN
|
|
1002
|
+
* code of the address area.
|
|
1003
|
+
*/
|
|
1004
|
+
pincode?: string;
|
|
1005
|
+
/**
|
|
1006
|
+
* - Boolean value indicating whether
|
|
1007
|
+
* first-mile service is available or not.
|
|
1008
|
+
*/
|
|
1009
|
+
first_mile?: boolean;
|
|
1010
|
+
/**
|
|
1011
|
+
* - Boolean value indicating whether last-mile
|
|
1012
|
+
* service is available or not.
|
|
1013
|
+
*/
|
|
1014
|
+
last_mile?: boolean;
|
|
1015
|
+
/**
|
|
1016
|
+
* - Limit on the amount of cash on delivery
|
|
1017
|
+
* (COD) payments allowed in the specified region.
|
|
1018
|
+
*/
|
|
1019
|
+
cod_limit?: number;
|
|
1020
|
+
/**
|
|
1021
|
+
* - Limit on the amount of prepaid payments
|
|
1022
|
+
* allowed in the specified region.
|
|
1023
|
+
*/
|
|
1024
|
+
prepaid_limit?: number;
|
|
1025
|
+
/**
|
|
1026
|
+
* - Indicates if doorstep return service
|
|
1027
|
+
* is available. This refers to the ability to return items directly from the
|
|
1028
|
+
* customer's doorstep.
|
|
1029
|
+
*/
|
|
1030
|
+
doorstep_return?: boolean;
|
|
1031
|
+
/**
|
|
1032
|
+
* - Indicates if doorstep quality check
|
|
1033
|
+
* service is available. This refers to the ability to perform quality checks
|
|
1034
|
+
* on items at the customer's doorstep.
|
|
1035
|
+
*/
|
|
1036
|
+
doorstep_qc?: boolean;
|
|
1037
|
+
/**
|
|
1038
|
+
* - Indicates if reverse pickup is available.
|
|
1039
|
+
*/
|
|
1040
|
+
reverse_pickup?: boolean;
|
|
1041
|
+
/**
|
|
1042
|
+
* - Time of day by which pickups
|
|
1043
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
1044
|
+
*/
|
|
1045
|
+
forward_pickup_cutoff?: string;
|
|
1046
|
+
/**
|
|
1047
|
+
* - Time of day by which pickups
|
|
1048
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
1049
|
+
*/
|
|
1050
|
+
reverse_pickup_cutoff?: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* - Indicates whether the product
|
|
1053
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
1054
|
+
* instead of through a third-party service.
|
|
1055
|
+
*/
|
|
1056
|
+
hand_to_hand_exchange?: boolean;
|
|
1057
|
+
/**
|
|
1058
|
+
* - List of holidays for a courier partner scheme.
|
|
1059
|
+
*/
|
|
1060
|
+
holiday_list?: string[];
|
|
1061
|
+
/**
|
|
1062
|
+
* - Boolean value indicating whether
|
|
1063
|
+
* installation services are available in the specified region or not.
|
|
1064
|
+
*/
|
|
1065
|
+
installation?: boolean;
|
|
1066
|
+
/**
|
|
1067
|
+
* - A string serving as the unique identifier.
|
|
1068
|
+
*/
|
|
1069
|
+
id: string;
|
|
1070
|
+
};
|
|
1071
|
+
/** @returns {RegionServiceabilityDetails} */
|
|
1072
|
+
declare function RegionServiceabilityDetails(): RegionServiceabilityDetails;
|
|
1073
|
+
type RegionServiceabilityDetails = {
|
|
1074
|
+
/**
|
|
1075
|
+
* - ISO2 code representing the country where
|
|
1076
|
+
* the serviceability is being specified.
|
|
1077
|
+
*/
|
|
1078
|
+
country_code: string;
|
|
1079
|
+
/**
|
|
1080
|
+
* - Code representing the state or province
|
|
1081
|
+
* within the country where the serviceability is being specified.
|
|
1082
|
+
*/
|
|
1083
|
+
state_code?: string;
|
|
1084
|
+
/**
|
|
1085
|
+
* - Code representing the city within the state
|
|
1086
|
+
* where the serviceability is being specified.
|
|
1087
|
+
*/
|
|
1088
|
+
city_code?: string;
|
|
1089
|
+
/**
|
|
1090
|
+
* - Code representing a specific sector or
|
|
1091
|
+
* district within the city where the serviceability is being specified.
|
|
1092
|
+
*/
|
|
1093
|
+
sector_code?: string;
|
|
1094
|
+
/**
|
|
1095
|
+
* - A string indicating the postal code or PIN
|
|
1096
|
+
* code of the address area.
|
|
1097
|
+
*/
|
|
1098
|
+
pincode?: string;
|
|
1099
|
+
/**
|
|
1100
|
+
* - Boolean value indicating whether
|
|
1101
|
+
* first-mile service is available or not.
|
|
1102
|
+
*/
|
|
1103
|
+
first_mile?: boolean;
|
|
1104
|
+
/**
|
|
1105
|
+
* - Boolean value indicating whether last-mile
|
|
1106
|
+
* service is available or not.
|
|
1107
|
+
*/
|
|
1108
|
+
last_mile?: boolean;
|
|
1109
|
+
/**
|
|
1110
|
+
* - Limit on the amount of cash on delivery
|
|
1111
|
+
* (COD) payments allowed in the specified region.
|
|
1112
|
+
*/
|
|
1113
|
+
cod_limit?: number;
|
|
1114
|
+
/**
|
|
1115
|
+
* - Indicates if doorstep return service
|
|
1116
|
+
* is available. This refers to the ability to return items directly from the
|
|
1117
|
+
* customer's doorstep.
|
|
1118
|
+
*/
|
|
1119
|
+
doorstep_return?: boolean;
|
|
1120
|
+
/**
|
|
1121
|
+
* - Indicates if doorstep quality check
|
|
1122
|
+
* service is available. This refers to the ability to perform quality checks
|
|
1123
|
+
* on items at the customer's doorstep.
|
|
1124
|
+
*/
|
|
1125
|
+
doorstep_qc?: boolean;
|
|
1126
|
+
/**
|
|
1127
|
+
* - Time of day by which pickups
|
|
1128
|
+
* must be scheduled to be processed on the same day in the forward journey.
|
|
1129
|
+
*/
|
|
1130
|
+
forward_pickup_cutoff?: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* - Time of day by which pickups must be
|
|
1133
|
+
* scheduled to be processed on the same day.
|
|
1134
|
+
*/
|
|
1135
|
+
pickup_cutoff?: string;
|
|
1136
|
+
/**
|
|
1137
|
+
* - Time of day by which pickups
|
|
1138
|
+
* must be scheduled to be processed on the same day in the reverse journey.
|
|
1139
|
+
*/
|
|
1140
|
+
reverse_pickup_cutoff?: string;
|
|
1141
|
+
/**
|
|
1142
|
+
* - Indicates whether the product
|
|
1143
|
+
* exchange happens directly between the buyer and seller (e.g., in person),
|
|
1144
|
+
* instead of through a third-party service.
|
|
1145
|
+
*/
|
|
1146
|
+
hand_to_hand_exchange?: boolean;
|
|
1147
|
+
/**
|
|
1148
|
+
* - Limit on the amount of prepaid payments
|
|
1149
|
+
* allowed in the specified region.
|
|
1150
|
+
*/
|
|
1151
|
+
prepaid_limit?: number;
|
|
1152
|
+
/**
|
|
1153
|
+
* - List of holidays for a courier partner scheme.
|
|
1154
|
+
*/
|
|
1155
|
+
holiday_list?: string[];
|
|
1156
|
+
/**
|
|
1157
|
+
* - Boolean value indicating whether
|
|
1158
|
+
* installation services are available in the specified region or not.
|
|
1159
|
+
*/
|
|
1160
|
+
installation?: boolean;
|
|
1161
|
+
};
|
|
1162
|
+
/** @returns {RegionTatDetails} */
|
|
1163
|
+
declare function RegionTatDetails(): RegionTatDetails;
|
|
1164
|
+
type RegionTatDetails = {
|
|
1165
|
+
/**
|
|
1166
|
+
* - Maximum time required for delivery
|
|
1167
|
+
* from the origin to the destination in seconds.
|
|
1168
|
+
*/
|
|
1169
|
+
max_delivery_time?: number;
|
|
1170
|
+
/**
|
|
1171
|
+
* - Minimum time required for delivery
|
|
1172
|
+
* from the origin to the destination in seconds.
|
|
1173
|
+
*/
|
|
1174
|
+
min_delivery_time?: number;
|
|
1175
|
+
/**
|
|
1176
|
+
* - ISO2 code representing the country of
|
|
1177
|
+
* origin for the delivery.
|
|
1178
|
+
*/
|
|
1179
|
+
from_country_code: string;
|
|
1180
|
+
/**
|
|
1181
|
+
* - Code representing the state or
|
|
1182
|
+
* province of origin within the country.
|
|
1183
|
+
*/
|
|
1184
|
+
from_state_code?: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* - Code representing the city of origin
|
|
1187
|
+
* within the state.
|
|
1188
|
+
*/
|
|
1189
|
+
from_city_code?: string;
|
|
1190
|
+
/**
|
|
1191
|
+
* - Code representing a specific sector
|
|
1192
|
+
* or district within the city of origin.
|
|
1193
|
+
*/
|
|
1194
|
+
from_sector_code?: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* - A string indicating the postal code or
|
|
1197
|
+
* PIN code of the address area.
|
|
1198
|
+
*/
|
|
1199
|
+
from_pincode?: string;
|
|
1200
|
+
/**
|
|
1201
|
+
* - ISO2 code representing the destination country.
|
|
1202
|
+
*/
|
|
1203
|
+
to_country_code: string;
|
|
1204
|
+
/**
|
|
1205
|
+
* - Code representing the state or province
|
|
1206
|
+
* of the destination within the country.
|
|
1207
|
+
*/
|
|
1208
|
+
to_state_code?: string;
|
|
1209
|
+
/**
|
|
1210
|
+
* - Code representing the city of destination
|
|
1211
|
+
* within the state.
|
|
1212
|
+
*/
|
|
1213
|
+
to_city_code?: string;
|
|
1214
|
+
/**
|
|
1215
|
+
* - Code representing a specific sector or
|
|
1216
|
+
* district within the city of destination.
|
|
1217
|
+
*/
|
|
1218
|
+
to_sector_code?: string;
|
|
1219
|
+
/**
|
|
1220
|
+
* - A string indicating the postal code or PIN
|
|
1221
|
+
* code of the address area.
|
|
1222
|
+
*/
|
|
1223
|
+
to_pincode?: string;
|
|
1224
|
+
forward?: TATDetails;
|
|
1225
|
+
reverse?: TATDetails;
|
|
1226
|
+
};
|
|
1227
|
+
/** @returns {RegionTatResult} */
|
|
1228
|
+
declare function RegionTatResult(): RegionTatResult;
|
|
1229
|
+
type RegionTatResult = {
|
|
1230
|
+
/**
|
|
1231
|
+
* - Minimum time required for delivery
|
|
1232
|
+
* from the origin to the destination in seconds.
|
|
1233
|
+
*/
|
|
1234
|
+
min_delivery_time?: number;
|
|
1235
|
+
/**
|
|
1236
|
+
* - Maximum time required for delivery
|
|
1237
|
+
* from the origin to the destination in seconds.
|
|
1238
|
+
*/
|
|
1239
|
+
max_delivery_time?: number;
|
|
1240
|
+
/**
|
|
1241
|
+
* - ISO2 code representing the country of
|
|
1242
|
+
* origin for the delivery.
|
|
1243
|
+
*/
|
|
1244
|
+
from_country_code: string;
|
|
1245
|
+
/**
|
|
1246
|
+
* - Code representing the state or
|
|
1247
|
+
* province of origin within the country.
|
|
1248
|
+
*/
|
|
1249
|
+
from_state_code?: string;
|
|
1250
|
+
/**
|
|
1251
|
+
* - Code representing the city of origin
|
|
1252
|
+
* within the state.
|
|
1253
|
+
*/
|
|
1254
|
+
from_city_code?: string;
|
|
1255
|
+
/**
|
|
1256
|
+
* - Code representing a specific sector
|
|
1257
|
+
* or district within the city of origin.
|
|
1258
|
+
*/
|
|
1259
|
+
from_sector_code?: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* - A string indicating the postal code or
|
|
1262
|
+
* PIN code of the address area.
|
|
1263
|
+
*/
|
|
1264
|
+
from_pincode?: string;
|
|
1265
|
+
/**
|
|
1266
|
+
* - ISO2 code representing the destination country.
|
|
1267
|
+
*/
|
|
1268
|
+
to_country_code: string;
|
|
1269
|
+
/**
|
|
1270
|
+
* - Code representing the state or province
|
|
1271
|
+
* of the destination within the country.
|
|
1272
|
+
*/
|
|
1273
|
+
to_state_code?: string;
|
|
1274
|
+
/**
|
|
1275
|
+
* - Code representing the city of destination
|
|
1276
|
+
* within the state.
|
|
1277
|
+
*/
|
|
1278
|
+
to_city_code?: string;
|
|
1279
|
+
/**
|
|
1280
|
+
* - Code representing a specific sector or
|
|
1281
|
+
* district within the city of destination.
|
|
1282
|
+
*/
|
|
1283
|
+
to_sector_code?: string;
|
|
1284
|
+
/**
|
|
1285
|
+
* - A string indicating the postal code or PIN
|
|
1286
|
+
* code of the address area.
|
|
1287
|
+
*/
|
|
1288
|
+
to_pincode?: string;
|
|
1289
|
+
forward?: TATDetails;
|
|
1290
|
+
reverse?: TATDetails;
|
|
1291
|
+
/**
|
|
1292
|
+
* - A string serving as the unique identifier.
|
|
1293
|
+
*/
|
|
1294
|
+
id: string;
|
|
1295
|
+
};
|
|
1296
|
+
/** @returns {BulkRegionJobDetails} */
|
|
1297
|
+
declare function BulkRegionJobDetails(): BulkRegionJobDetails;
|
|
1298
|
+
type BulkRegionJobDetails = {
|
|
1299
|
+
/**
|
|
1300
|
+
* - Path to the file used in the bulk operation.
|
|
1301
|
+
*/
|
|
1302
|
+
file_path?: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* - Country involved in the bulk operation.
|
|
1305
|
+
*/
|
|
1306
|
+
country: string;
|
|
1307
|
+
/**
|
|
1308
|
+
* - Action type for the bulk operation, either import
|
|
1309
|
+
* or export.
|
|
1310
|
+
*/
|
|
1311
|
+
action: string;
|
|
1312
|
+
/**
|
|
1313
|
+
* - Region involved in the bulk operation.
|
|
1314
|
+
*/
|
|
1315
|
+
region: string;
|
|
1316
|
+
};
|
|
1317
|
+
/** @returns {BulkRegionResultItemData} */
|
|
1318
|
+
declare function BulkRegionResultItemData(): BulkRegionResultItemData;
|
|
1319
|
+
type BulkRegionResultItemData = {
|
|
1320
|
+
/**
|
|
1321
|
+
* - Path to the file associated with the result item.
|
|
1322
|
+
*/
|
|
1323
|
+
file_path: string;
|
|
1324
|
+
/**
|
|
1325
|
+
* - Number of failed records in the operation.
|
|
1326
|
+
*/
|
|
1327
|
+
failed?: number;
|
|
1328
|
+
/**
|
|
1329
|
+
* - Array of failed records with
|
|
1330
|
+
* additional properties.
|
|
1331
|
+
*/
|
|
1332
|
+
failed_records?: any[];
|
|
1333
|
+
/**
|
|
1334
|
+
* - Action type for the result item.
|
|
1335
|
+
*/
|
|
1336
|
+
action: string;
|
|
1337
|
+
/**
|
|
1338
|
+
* - A unique identifier for the performed batch operation.
|
|
1339
|
+
*/
|
|
1340
|
+
batch_id: string;
|
|
1341
|
+
/**
|
|
1342
|
+
* - Country associated with the result item.
|
|
1343
|
+
*/
|
|
1344
|
+
country: string;
|
|
1345
|
+
/**
|
|
1346
|
+
* - Number of successful records in the operation.
|
|
1347
|
+
*/
|
|
1348
|
+
success?: number;
|
|
1349
|
+
/**
|
|
1350
|
+
* - Region associated with the result item.
|
|
1351
|
+
*/
|
|
1352
|
+
region: string;
|
|
1353
|
+
/**
|
|
1354
|
+
* - Current status of the result item.
|
|
1355
|
+
*/
|
|
1356
|
+
status: string;
|
|
1357
|
+
/**
|
|
1358
|
+
* - Total number of records processed.
|
|
1359
|
+
*/
|
|
1360
|
+
total?: number;
|
|
1361
|
+
/**
|
|
1362
|
+
* - Path to the file containing error details.
|
|
1363
|
+
*/
|
|
1364
|
+
error_file_path?: string;
|
|
1365
|
+
/**
|
|
1366
|
+
* - The timestamp when the record last modified.
|
|
1367
|
+
*/
|
|
1368
|
+
modified_on?: string;
|
|
1369
|
+
/**
|
|
1370
|
+
* - The timestamp when the record was created.
|
|
1371
|
+
*/
|
|
1372
|
+
created_on?: string;
|
|
1373
|
+
};
|
|
1374
|
+
/** @returns {BulkRegionResult} */
|
|
1375
|
+
declare function BulkRegionResult(): BulkRegionResult;
|
|
1376
|
+
type BulkRegionResult = {
|
|
1377
|
+
/**
|
|
1378
|
+
* - Array of bulk region result items.
|
|
1379
|
+
*/
|
|
1380
|
+
items: BulkRegionResultItemData[];
|
|
1381
|
+
page: Page;
|
|
324
1382
|
};
|
|
325
|
-
/** @returns {
|
|
326
|
-
declare function
|
|
327
|
-
type
|
|
328
|
-
|
|
329
|
-
|
|
1383
|
+
/** @returns {CourierAccountDetailsBody} */
|
|
1384
|
+
declare function CourierAccountDetailsBody(): CourierAccountDetailsBody;
|
|
1385
|
+
type CourierAccountDetailsBody = {
|
|
1386
|
+
/**
|
|
1387
|
+
* - The unique identifier for the extension
|
|
1388
|
+
* linked to the courier account.
|
|
1389
|
+
*/
|
|
1390
|
+
extension_id: string;
|
|
1391
|
+
/**
|
|
1392
|
+
* - The unique identifier for the courier account.
|
|
1393
|
+
*/
|
|
1394
|
+
account_id?: string;
|
|
1395
|
+
/**
|
|
1396
|
+
* - The identifier for the scheme associated with
|
|
1397
|
+
* the courier account.
|
|
1398
|
+
*/
|
|
1399
|
+
scheme_id: string;
|
|
1400
|
+
/**
|
|
1401
|
+
* - Indicates whether the courier account
|
|
1402
|
+
* supports self-shipping (true if it does, false otherwise).
|
|
1403
|
+
*/
|
|
1404
|
+
is_self_ship: boolean;
|
|
1405
|
+
/**
|
|
1406
|
+
* - The current stage of the courier account, either
|
|
1407
|
+
* 'enabled' or 'disabled'.
|
|
1408
|
+
*/
|
|
1409
|
+
stage: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* - Indicates whether the courier account is
|
|
1412
|
+
* an own account (true if it is, false otherwise).
|
|
1413
|
+
*/
|
|
1414
|
+
is_own_account: boolean;
|
|
330
1415
|
};
|
|
331
|
-
/** @returns {
|
|
332
|
-
declare function
|
|
333
|
-
type
|
|
334
|
-
|
|
1416
|
+
/** @returns {CompanyCourierPartnerAccountListResult} */
|
|
1417
|
+
declare function CompanyCourierPartnerAccountListResult(): CompanyCourierPartnerAccountListResult;
|
|
1418
|
+
type CompanyCourierPartnerAccountListResult = {
|
|
1419
|
+
/**
|
|
1420
|
+
* - An array containing multiple
|
|
1421
|
+
* instances of CourierAccountResult, which details individual courier accounts.
|
|
1422
|
+
*/
|
|
1423
|
+
items: CourierAccountResult[];
|
|
335
1424
|
page: Page;
|
|
336
1425
|
};
|
|
337
|
-
/** @returns {
|
|
338
|
-
declare function
|
|
339
|
-
type
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
weight?: ArithmeticOperations;
|
|
344
|
-
transport_type?: string;
|
|
345
|
-
region?: string;
|
|
346
|
-
delivery_type?: string;
|
|
347
|
-
payment_mode?: string[];
|
|
348
|
-
stage?: string;
|
|
349
|
-
feature?: CourierPartnerSchemeFeatures;
|
|
350
|
-
};
|
|
351
|
-
/** @returns {CourierAccountResponse} */
|
|
352
|
-
declare function CourierAccountResponse(): CourierAccountResponse;
|
|
353
|
-
type CourierAccountResponse = {
|
|
354
|
-
company_id?: number;
|
|
355
|
-
extension_id?: string;
|
|
1426
|
+
/** @returns {CourierAccountResult} */
|
|
1427
|
+
declare function CourierAccountResult(): CourierAccountResult;
|
|
1428
|
+
type CourierAccountResult = {
|
|
1429
|
+
/**
|
|
1430
|
+
* - A string that uniquely identifies the courier account.
|
|
1431
|
+
*/
|
|
356
1432
|
account_id: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* - The unique identifier of the company.
|
|
1435
|
+
*/
|
|
1436
|
+
company_id?: number;
|
|
1437
|
+
/**
|
|
1438
|
+
* - A string that specifies the unique identifier
|
|
1439
|
+
* for the scheme associated with the account
|
|
1440
|
+
*/
|
|
357
1441
|
scheme_id: string;
|
|
1442
|
+
/**
|
|
1443
|
+
* - A string that uniquely identifies the
|
|
1444
|
+
* courier partner extension.
|
|
1445
|
+
*/
|
|
1446
|
+
extension_id?: string;
|
|
1447
|
+
/**
|
|
1448
|
+
* - A boolean indicating whether the account
|
|
1449
|
+
* is for self-shipping.
|
|
1450
|
+
*/
|
|
358
1451
|
is_self_ship: boolean;
|
|
1452
|
+
/**
|
|
1453
|
+
* - A string indicating the current stage of the
|
|
1454
|
+
* account, which can be either enabled or disabled.
|
|
1455
|
+
*/
|
|
359
1456
|
stage: string;
|
|
1457
|
+
/**
|
|
1458
|
+
* - A boolean indicating whether the account
|
|
1459
|
+
* is owned by the company.
|
|
1460
|
+
*/
|
|
360
1461
|
is_own_account: boolean;
|
|
361
|
-
scheme_rules:
|
|
1462
|
+
scheme_rules: CourierPartnerSchemeModel;
|
|
362
1463
|
};
|
|
363
|
-
/** @returns {
|
|
364
|
-
declare function
|
|
365
|
-
type
|
|
1464
|
+
/** @returns {CourierPartnerSchemeDetailsModel} */
|
|
1465
|
+
declare function CourierPartnerSchemeDetailsModel(): CourierPartnerSchemeDetailsModel;
|
|
1466
|
+
type CourierPartnerSchemeDetailsModel = {
|
|
1467
|
+
/**
|
|
1468
|
+
* - Unique identifier of courier partner extension.
|
|
1469
|
+
*/
|
|
366
1470
|
extension_id: string;
|
|
367
|
-
|
|
1471
|
+
/**
|
|
1472
|
+
* - Unique identifier for the scheme, used to
|
|
1473
|
+
* fetch or modify scheme details.
|
|
1474
|
+
*/
|
|
1475
|
+
scheme_id?: string;
|
|
1476
|
+
/**
|
|
1477
|
+
* - Name of the scheme.
|
|
1478
|
+
*/
|
|
1479
|
+
name: string;
|
|
1480
|
+
weight: ArithmeticOperations;
|
|
1481
|
+
volumetric_weight?: ArithmeticOperations;
|
|
1482
|
+
/**
|
|
1483
|
+
* - Mode of transport associated with the
|
|
1484
|
+
* courier partner scheme.
|
|
1485
|
+
*/
|
|
1486
|
+
transport_type: string;
|
|
1487
|
+
/**
|
|
1488
|
+
* - Serviceable region associated with the courier
|
|
1489
|
+
* partner scheme.
|
|
1490
|
+
*/
|
|
1491
|
+
region: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* - Type of delivery associated with the
|
|
1494
|
+
* courier partner scheme.
|
|
1495
|
+
*/
|
|
1496
|
+
delivery_type: string;
|
|
1497
|
+
/**
|
|
1498
|
+
* - Mode of payment associated with the
|
|
1499
|
+
* courier partner scheme.
|
|
1500
|
+
*/
|
|
1501
|
+
payment_mode: string[];
|
|
1502
|
+
/**
|
|
1503
|
+
* - Indicates if the courier partner scheme is
|
|
1504
|
+
* currently active or inactive.
|
|
1505
|
+
*/
|
|
1506
|
+
stage: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* - Describes the type of status updates
|
|
1509
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1510
|
+
*/
|
|
1511
|
+
status_updates?: string;
|
|
1512
|
+
/**
|
|
1513
|
+
* - Indicates if the Non-Delivery Report
|
|
1514
|
+
* (NDR) feature is supported by the courier partner.
|
|
1515
|
+
*/
|
|
1516
|
+
ndr_attempts?: number;
|
|
1517
|
+
/**
|
|
1518
|
+
* - Defines the maximum quantity
|
|
1519
|
+
* of items allowed in a quality check shipment.
|
|
1520
|
+
*/
|
|
1521
|
+
qc_shipment_item_quantity?: number;
|
|
1522
|
+
/**
|
|
1523
|
+
* - Defines the maximum
|
|
1524
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1525
|
+
*/
|
|
1526
|
+
non_qc_shipment_item_quantity?: number;
|
|
1527
|
+
feature: CourierPartnerSchemeFeatures;
|
|
1528
|
+
};
|
|
1529
|
+
/** @returns {CourierPartnerPutSchema} */
|
|
1530
|
+
declare function CourierPartnerPutSchema(): CourierPartnerPutSchema;
|
|
1531
|
+
type CourierPartnerPutSchema = {
|
|
1532
|
+
/**
|
|
1533
|
+
* - Unique identifier of courier partner extension.
|
|
1534
|
+
*/
|
|
1535
|
+
extension_id?: string;
|
|
1536
|
+
created_by?: CreatedBy;
|
|
1537
|
+
modified_by?: ModifiedBy;
|
|
1538
|
+
/**
|
|
1539
|
+
* - The timestamp when the record was created.
|
|
1540
|
+
*/
|
|
1541
|
+
created_on?: string;
|
|
1542
|
+
/**
|
|
1543
|
+
* - The timestamp when the record last modified.
|
|
1544
|
+
*/
|
|
1545
|
+
modified_on?: string;
|
|
1546
|
+
/**
|
|
1547
|
+
* - Unique identifier of courier partner scheme.
|
|
1548
|
+
*/
|
|
1549
|
+
scheme_id?: string;
|
|
1550
|
+
/**
|
|
1551
|
+
* - Unique identifier of company.
|
|
1552
|
+
*/
|
|
1553
|
+
company_id?: string;
|
|
1554
|
+
/**
|
|
1555
|
+
* - Name of the scheme.
|
|
1556
|
+
*/
|
|
1557
|
+
name: string;
|
|
1558
|
+
weight: ArithmeticOperations;
|
|
1559
|
+
volumetric_weight?: ArithmeticOperations;
|
|
1560
|
+
/**
|
|
1561
|
+
* - Mode of transport associated with the
|
|
1562
|
+
* courier partner scheme.
|
|
1563
|
+
*/
|
|
1564
|
+
transport_type: string;
|
|
1565
|
+
/**
|
|
1566
|
+
* - Serviceable region associated with the courier
|
|
1567
|
+
* partner scheme.
|
|
1568
|
+
*/
|
|
1569
|
+
region: string;
|
|
1570
|
+
/**
|
|
1571
|
+
* - Type of delivery associated with the
|
|
1572
|
+
* courier partner scheme.
|
|
1573
|
+
*/
|
|
1574
|
+
delivery_type: string;
|
|
1575
|
+
/**
|
|
1576
|
+
* - Mode of payment associated with the
|
|
1577
|
+
* courier partner scheme.
|
|
1578
|
+
*/
|
|
1579
|
+
payment_mode: string[];
|
|
1580
|
+
/**
|
|
1581
|
+
* - Indicates if the courier partner scheme is
|
|
1582
|
+
* currently active or inactive.
|
|
1583
|
+
*/
|
|
1584
|
+
stage: string;
|
|
1585
|
+
/**
|
|
1586
|
+
* - Describes the type of status updates
|
|
1587
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1588
|
+
*/
|
|
1589
|
+
status_updates?: string;
|
|
1590
|
+
/**
|
|
1591
|
+
* - Indicates if the Non-Delivery Report
|
|
1592
|
+
* (NDR) feature is supported by the courier partner.
|
|
1593
|
+
*/
|
|
1594
|
+
ndr_attempts?: number;
|
|
1595
|
+
/**
|
|
1596
|
+
* - Defines the maximum quantity
|
|
1597
|
+
* of items allowed in a quality check shipment.
|
|
1598
|
+
*/
|
|
1599
|
+
qc_shipment_item_quantity?: number;
|
|
1600
|
+
/**
|
|
1601
|
+
* - Defines the maximum
|
|
1602
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1603
|
+
*/
|
|
1604
|
+
non_qc_shipment_item_quantity?: number;
|
|
1605
|
+
feature: CourierPartnerSchemeFeatures;
|
|
1606
|
+
};
|
|
1607
|
+
/** @returns {CourierPartnerSchemeList} */
|
|
1608
|
+
declare function CourierPartnerSchemeList(): CourierPartnerSchemeList;
|
|
1609
|
+
type CourierPartnerSchemeList = {
|
|
1610
|
+
/**
|
|
1611
|
+
* - List of courier partner schemes
|
|
1612
|
+
*/
|
|
1613
|
+
items: CourierPartnerSchemeModelSchema[];
|
|
1614
|
+
page: Page;
|
|
1615
|
+
};
|
|
1616
|
+
/** @returns {CourierPartnerSchemeUpdateDetails} */
|
|
1617
|
+
declare function CourierPartnerSchemeUpdateDetails(): CourierPartnerSchemeUpdateDetails;
|
|
1618
|
+
type CourierPartnerSchemeUpdateDetails = {
|
|
1619
|
+
/**
|
|
1620
|
+
* - Name of the scheme.
|
|
1621
|
+
*/
|
|
368
1622
|
name: string;
|
|
369
1623
|
weight: ArithmeticOperations;
|
|
370
1624
|
volumetric_weight?: ArithmeticOperations;
|
|
1625
|
+
/**
|
|
1626
|
+
* - Mode of transport associated with the
|
|
1627
|
+
* courier partner scheme.
|
|
1628
|
+
*/
|
|
371
1629
|
transport_type: string;
|
|
1630
|
+
/**
|
|
1631
|
+
* - Serviceable region associated with the courier
|
|
1632
|
+
* partner scheme.
|
|
1633
|
+
*/
|
|
372
1634
|
region: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* - Type of delivery associated with the
|
|
1637
|
+
* courier partner scheme.
|
|
1638
|
+
*/
|
|
373
1639
|
delivery_type: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* - Mode of payment associated with the
|
|
1642
|
+
* courier partner scheme.
|
|
1643
|
+
*/
|
|
374
1644
|
payment_mode: string[];
|
|
1645
|
+
/**
|
|
1646
|
+
* - Indicates if the courier partner scheme is
|
|
1647
|
+
* currently active or inactive.
|
|
1648
|
+
*/
|
|
375
1649
|
stage: string;
|
|
1650
|
+
/**
|
|
1651
|
+
* - Describes the type of status updates
|
|
1652
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1653
|
+
*/
|
|
1654
|
+
status_updates?: string;
|
|
1655
|
+
/**
|
|
1656
|
+
* - Indicates if the Non-Delivery Report
|
|
1657
|
+
* (NDR) feature is supported by the courier partner.
|
|
1658
|
+
*/
|
|
1659
|
+
ndr_attempts?: number;
|
|
1660
|
+
/**
|
|
1661
|
+
* - Defines the maximum quantity
|
|
1662
|
+
* of items allowed in a quality check shipment.
|
|
1663
|
+
*/
|
|
1664
|
+
qc_shipment_item_quantity?: number;
|
|
1665
|
+
/**
|
|
1666
|
+
* - Defines the maximum
|
|
1667
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1668
|
+
*/
|
|
1669
|
+
non_qc_shipment_item_quantity?: number;
|
|
376
1670
|
feature: CourierPartnerSchemeFeatures;
|
|
377
1671
|
};
|
|
1672
|
+
/** @returns {GetCountries} */
|
|
1673
|
+
declare function GetCountries(): GetCountries;
|
|
1674
|
+
type GetCountries = {
|
|
1675
|
+
/**
|
|
1676
|
+
* - A list of country objects containing
|
|
1677
|
+
* detailed information about each country.
|
|
1678
|
+
*/
|
|
1679
|
+
items: GetCountriesItems[];
|
|
1680
|
+
page: Page;
|
|
1681
|
+
};
|
|
1682
|
+
/** @returns {TATUpdateDetails} */
|
|
1683
|
+
declare function TATUpdateDetails(): TATUpdateDetails;
|
|
1684
|
+
type TATUpdateDetails = {
|
|
1685
|
+
/**
|
|
1686
|
+
* - Maximum time required for delivery
|
|
1687
|
+
* from the origin to the destination in seconds.
|
|
1688
|
+
*/
|
|
1689
|
+
max_delivery_time?: number;
|
|
1690
|
+
/**
|
|
1691
|
+
* - Minimum time required for delivery
|
|
1692
|
+
* from the origin to the destination in seconds.
|
|
1693
|
+
*/
|
|
1694
|
+
min_delivery_time?: number;
|
|
1695
|
+
forward?: TATDetails;
|
|
1696
|
+
reverse?: TATDetails;
|
|
1697
|
+
};
|
|
1698
|
+
/** @returns {StandardError} */
|
|
1699
|
+
declare function StandardError(): StandardError;
|
|
1700
|
+
type StandardError = {
|
|
1701
|
+
/**
|
|
1702
|
+
* - A brief description of the error.
|
|
1703
|
+
*/
|
|
1704
|
+
message: string;
|
|
1705
|
+
};
|
|
1706
|
+
/** @returns {ValidationErrors} */
|
|
1707
|
+
declare function ValidationErrors(): ValidationErrors;
|
|
1708
|
+
type ValidationErrors = {
|
|
1709
|
+
/**
|
|
1710
|
+
* - A list of validation errors in the request.
|
|
1711
|
+
*/
|
|
1712
|
+
errors: ValidationError[];
|
|
1713
|
+
};
|
|
1714
|
+
/** @returns {CreatedBy} */
|
|
1715
|
+
declare function CreatedBy(): CreatedBy;
|
|
1716
|
+
type CreatedBy = {
|
|
1717
|
+
/**
|
|
1718
|
+
* - Identifier of the user or system that created the object.
|
|
1719
|
+
*/
|
|
1720
|
+
id?: string;
|
|
1721
|
+
};
|
|
1722
|
+
/** @returns {ModifiedBy} */
|
|
1723
|
+
declare function ModifiedBy(): ModifiedBy;
|
|
1724
|
+
type ModifiedBy = {
|
|
1725
|
+
/**
|
|
1726
|
+
* - Identifier of the user or system that created the object.
|
|
1727
|
+
*/
|
|
1728
|
+
id?: string;
|
|
1729
|
+
};
|
|
1730
|
+
/** @returns {ArithmeticOperations} */
|
|
1731
|
+
declare function ArithmeticOperations(): ArithmeticOperations;
|
|
1732
|
+
type ArithmeticOperations = {
|
|
1733
|
+
/**
|
|
1734
|
+
* - Specifies a less than operation, comparing values
|
|
1735
|
+
* smaller than the provided value.
|
|
1736
|
+
*/
|
|
1737
|
+
lt?: number;
|
|
1738
|
+
/**
|
|
1739
|
+
* - Specifies a greater than operation, comparing
|
|
1740
|
+
* values larger than the provided value.
|
|
1741
|
+
*/
|
|
1742
|
+
gt?: number;
|
|
1743
|
+
/**
|
|
1744
|
+
* - Specifies a less than or equal to operation,
|
|
1745
|
+
* comparing values smaller than or equal to the provided value.
|
|
1746
|
+
*/
|
|
1747
|
+
lte?: number;
|
|
1748
|
+
/**
|
|
1749
|
+
* - Specifies a greater than or equal to operation,
|
|
1750
|
+
* comparing values larger than or equal to the provided value.
|
|
1751
|
+
*/
|
|
1752
|
+
gte?: number;
|
|
1753
|
+
};
|
|
378
1754
|
/** @returns {CourierPartnerSchemeFeatures} */
|
|
379
1755
|
declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
|
|
380
1756
|
type CourierPartnerSchemeFeatures = {
|
|
1757
|
+
/**
|
|
1758
|
+
* - Indicates if the courier partner offers
|
|
1759
|
+
* doorstep quality check services.
|
|
1760
|
+
*/
|
|
381
1761
|
doorstep_qc?: boolean;
|
|
1762
|
+
/**
|
|
1763
|
+
* - Specifies whether the courier partner supports QR
|
|
1764
|
+
* code-based operations.
|
|
1765
|
+
*/
|
|
382
1766
|
qr?: boolean;
|
|
1767
|
+
/**
|
|
1768
|
+
* - Denotes if the courier partner supports
|
|
1769
|
+
* multi-part shipment services.
|
|
1770
|
+
*/
|
|
383
1771
|
mps?: boolean;
|
|
1772
|
+
/**
|
|
1773
|
+
* - Indicates if the Non-Delivery Report (NDR)
|
|
1774
|
+
* feature is supported by the courier partner.
|
|
1775
|
+
*/
|
|
384
1776
|
ndr?: boolean;
|
|
1777
|
+
/**
|
|
1778
|
+
* - Number of attempts allowed for resolving
|
|
1779
|
+
* Non-Delivery Reports (NDR).
|
|
1780
|
+
*/
|
|
385
1781
|
ndr_attempts?: number;
|
|
1782
|
+
/**
|
|
1783
|
+
* - Specifies if the courier partner
|
|
1784
|
+
* handles the transportation of dangerous goods.
|
|
1785
|
+
*/
|
|
386
1786
|
dangerous_goods?: boolean;
|
|
1787
|
+
/**
|
|
1788
|
+
* - Indicates whether the courier partner
|
|
1789
|
+
* manages the shipment of fragile goods.
|
|
1790
|
+
*/
|
|
387
1791
|
fragile_goods?: boolean;
|
|
1792
|
+
/**
|
|
1793
|
+
* - Indicates if the courier partner
|
|
1794
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
1795
|
+
*/
|
|
388
1796
|
restricted_goods?: boolean;
|
|
1797
|
+
/**
|
|
1798
|
+
* - Denotes if the courier partner
|
|
1799
|
+
* provides cold storage facilities for goods.
|
|
1800
|
+
*/
|
|
389
1801
|
cold_storage_goods?: boolean;
|
|
1802
|
+
/**
|
|
1803
|
+
* - Indicates if the courier partner
|
|
1804
|
+
* supports doorstep exchange services.
|
|
1805
|
+
*/
|
|
390
1806
|
doorstep_exchange?: boolean;
|
|
1807
|
+
/**
|
|
1808
|
+
* - Specifies if the courier partner
|
|
1809
|
+
* offers doorstep return services.
|
|
1810
|
+
*/
|
|
391
1811
|
doorstep_return?: boolean;
|
|
1812
|
+
/**
|
|
1813
|
+
* - Indicates if the courier partner
|
|
1814
|
+
* provides product installation services upon delivery.
|
|
1815
|
+
*/
|
|
392
1816
|
product_installation?: boolean;
|
|
1817
|
+
/**
|
|
1818
|
+
* - Specifies whether the courier
|
|
1819
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
1820
|
+
* before accepting.
|
|
1821
|
+
*/
|
|
393
1822
|
openbox_delivery?: boolean;
|
|
1823
|
+
/**
|
|
1824
|
+
* - Describes the type of status updates
|
|
1825
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1826
|
+
*/
|
|
394
1827
|
status_updates?: string;
|
|
1828
|
+
/**
|
|
1829
|
+
* - Indicates if the courier
|
|
1830
|
+
* partner supports multiple pickups to a single drop location.
|
|
1831
|
+
*/
|
|
395
1832
|
multi_pick_single_drop?: boolean;
|
|
1833
|
+
/**
|
|
1834
|
+
* - Indicates whether the courier
|
|
1835
|
+
* partner supports single pickup to multiple drop locations.
|
|
1836
|
+
*/
|
|
396
1837
|
single_pick_multi_drop?: boolean;
|
|
1838
|
+
/**
|
|
1839
|
+
* - Denotes if the courier partner
|
|
1840
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
1841
|
+
*/
|
|
397
1842
|
multi_pick_multi_drop?: boolean;
|
|
1843
|
+
/**
|
|
1844
|
+
* - Specifies if the courier partner requires or
|
|
1845
|
+
* supports the generation of e-waybills for shipments.
|
|
1846
|
+
*/
|
|
398
1847
|
ewaybill?: boolean;
|
|
1848
|
+
/**
|
|
1849
|
+
* - Defines the maximum quantity
|
|
1850
|
+
* of items allowed in a quality check shipment.
|
|
1851
|
+
*/
|
|
1852
|
+
qc_shipment_item_quantity?: number;
|
|
1853
|
+
/**
|
|
1854
|
+
* - Defines the maximum
|
|
1855
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1856
|
+
*/
|
|
1857
|
+
non_qc_shipment_item_quantity?: number;
|
|
399
1858
|
};
|
|
400
|
-
/** @returns {
|
|
401
|
-
declare function
|
|
402
|
-
type
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
1859
|
+
/** @returns {Error} */
|
|
1860
|
+
declare function Error(): Error;
|
|
1861
|
+
type Error = {
|
|
1862
|
+
/**
|
|
1863
|
+
* - The type of the error.
|
|
1864
|
+
*/
|
|
1865
|
+
type?: string;
|
|
1866
|
+
/**
|
|
1867
|
+
* - The value associated with the error.
|
|
1868
|
+
*/
|
|
1869
|
+
value?: string;
|
|
1870
|
+
/**
|
|
1871
|
+
* - The error message describing the issue.
|
|
1872
|
+
*/
|
|
1873
|
+
message?: string;
|
|
1874
|
+
};
|
|
1875
|
+
/** @returns {Page} */
|
|
1876
|
+
declare function Page(): Page;
|
|
1877
|
+
type Page = {
|
|
1878
|
+
/**
|
|
1879
|
+
* - The total number of items on the page.
|
|
1880
|
+
*/
|
|
1881
|
+
item_total?: number;
|
|
1882
|
+
/**
|
|
1883
|
+
* - The identifier for the next page.
|
|
1884
|
+
*/
|
|
1885
|
+
next_id?: string;
|
|
1886
|
+
/**
|
|
1887
|
+
* - Indicates whether there is a previous page.
|
|
1888
|
+
*/
|
|
1889
|
+
has_previous?: boolean;
|
|
1890
|
+
/**
|
|
1891
|
+
* - Indicates whether there is a next page.
|
|
1892
|
+
*/
|
|
1893
|
+
has_next?: boolean;
|
|
1894
|
+
/**
|
|
1895
|
+
* - The current page number.
|
|
1896
|
+
*/
|
|
1897
|
+
current?: number;
|
|
1898
|
+
/**
|
|
1899
|
+
* - The type of the page, such as 'PageType'.
|
|
1900
|
+
*/
|
|
1901
|
+
type: string;
|
|
1902
|
+
/**
|
|
1903
|
+
* - The number of items per page.
|
|
1904
|
+
*/
|
|
1905
|
+
size?: number;
|
|
1906
|
+
/**
|
|
1907
|
+
* - The number of items per page.
|
|
1908
|
+
*/
|
|
1909
|
+
page_size?: number;
|
|
1910
|
+
};
|
|
1911
|
+
/** @returns {TATDetails} */
|
|
1912
|
+
declare function TATDetails(): TATDetails;
|
|
1913
|
+
type TATDetails = {
|
|
1914
|
+
/**
|
|
1915
|
+
* - Maximum time required for delivery
|
|
1916
|
+
* from the origin to the destination in seconds.
|
|
1917
|
+
*/
|
|
1918
|
+
max_delivery_time?: number;
|
|
1919
|
+
/**
|
|
1920
|
+
* - Minimum time required for delivery
|
|
1921
|
+
* from the origin to the destination in seconds.
|
|
1922
|
+
*/
|
|
1923
|
+
min_delivery_time?: number;
|
|
407
1924
|
};
|
|
408
|
-
/** @returns {
|
|
409
|
-
declare function
|
|
410
|
-
type
|
|
1925
|
+
/** @returns {CourierPartnerSchemeModel} */
|
|
1926
|
+
declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
|
|
1927
|
+
type CourierPartnerSchemeModel = {
|
|
1928
|
+
/**
|
|
1929
|
+
* - Unique identifier of courier partner extension.
|
|
1930
|
+
*/
|
|
1931
|
+
extension_id: string;
|
|
1932
|
+
/**
|
|
1933
|
+
* - A string representing the unique identifier
|
|
1934
|
+
* for the scheme. This is a required field.
|
|
1935
|
+
*/
|
|
1936
|
+
scheme_id: string;
|
|
1937
|
+
/**
|
|
1938
|
+
* - A string that specifies the name of the scheme.
|
|
1939
|
+
* This is a required field.
|
|
1940
|
+
*/
|
|
411
1941
|
name: string;
|
|
412
1942
|
weight: ArithmeticOperations;
|
|
413
1943
|
volumetric_weight?: ArithmeticOperations;
|
|
1944
|
+
/**
|
|
1945
|
+
* - A string that specifies the type of transport.
|
|
1946
|
+
*/
|
|
414
1947
|
transport_type: string;
|
|
1948
|
+
/**
|
|
1949
|
+
* - A string that indicates the region type.
|
|
1950
|
+
*/
|
|
415
1951
|
region: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* - A string that defines the delivery type.
|
|
1954
|
+
*/
|
|
416
1955
|
delivery_type: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* - An array of strings specifying the
|
|
1958
|
+
* payment modes available.
|
|
1959
|
+
*/
|
|
417
1960
|
payment_mode: string[];
|
|
1961
|
+
/**
|
|
1962
|
+
* - A string indicating the current stage of the scheme.
|
|
1963
|
+
*/
|
|
418
1964
|
stage: string;
|
|
419
1965
|
feature: CourierPartnerSchemeFeatures;
|
|
420
1966
|
};
|
|
421
|
-
/** @returns {
|
|
422
|
-
declare function
|
|
423
|
-
type
|
|
1967
|
+
/** @returns {GetCountriesItems} */
|
|
1968
|
+
declare function GetCountriesItems(): GetCountriesItems;
|
|
1969
|
+
type GetCountriesItems = {
|
|
1970
|
+
/**
|
|
1971
|
+
* - A string serving as the unique identifier.
|
|
1972
|
+
*/
|
|
1973
|
+
id?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* - A category for classifying the country into a
|
|
1976
|
+
* specific subtype.
|
|
1977
|
+
*/
|
|
1978
|
+
sub_type?: string;
|
|
1979
|
+
/**
|
|
1980
|
+
* - A globally unique identifier for the country.
|
|
1981
|
+
*/
|
|
1982
|
+
uid?: string;
|
|
1983
|
+
/**
|
|
1984
|
+
* - The official or widely recognized name of the
|
|
1985
|
+
* country used in general contexts.
|
|
1986
|
+
*/
|
|
1987
|
+
name?: string;
|
|
1988
|
+
/**
|
|
1989
|
+
* - The 2-letter ISO code for the country.
|
|
1990
|
+
*/
|
|
1991
|
+
iso2?: string;
|
|
1992
|
+
/**
|
|
1993
|
+
* - The 3-letter ISO code for the country.
|
|
1994
|
+
*/
|
|
1995
|
+
iso3?: string;
|
|
1996
|
+
/**
|
|
1997
|
+
* - A list of timezones associated with the country.
|
|
1998
|
+
*/
|
|
1999
|
+
timezones?: string[];
|
|
2000
|
+
/**
|
|
2001
|
+
* - A hierarchical list of items
|
|
2002
|
+
* representing organizational levels within the country.
|
|
2003
|
+
*/
|
|
2004
|
+
hierarchy?: HierarchyItems[];
|
|
2005
|
+
/**
|
|
2006
|
+
* - A country-specific phone code.
|
|
2007
|
+
*/
|
|
2008
|
+
phone_code?: string;
|
|
2009
|
+
currency?: CurrencyObject;
|
|
2010
|
+
/**
|
|
2011
|
+
* - The type or classification of the country (e.g.,
|
|
2012
|
+
* sovereign or dependent).
|
|
2013
|
+
*/
|
|
2014
|
+
type?: string;
|
|
2015
|
+
/**
|
|
2016
|
+
* - The latitude of the central point of the country.
|
|
2017
|
+
*/
|
|
2018
|
+
latitude?: string;
|
|
2019
|
+
/**
|
|
2020
|
+
* - The longitude of the central point of the country.
|
|
2021
|
+
*/
|
|
2022
|
+
longitude?: string;
|
|
2023
|
+
/**
|
|
2024
|
+
* - A user-friendly name for the country,
|
|
2025
|
+
* typically for display purposes.
|
|
2026
|
+
*/
|
|
2027
|
+
display_name?: string;
|
|
2028
|
+
/**
|
|
2029
|
+
* - A boolean indicating whether
|
|
2030
|
+
* additional hierarchical regions or divisions are present.
|
|
2031
|
+
*/
|
|
2032
|
+
has_next_hierarchy?: boolean;
|
|
2033
|
+
};
|
|
2034
|
+
/** @returns {HierarchyItems} */
|
|
2035
|
+
declare function HierarchyItems(): HierarchyItems;
|
|
2036
|
+
type HierarchyItems = {
|
|
2037
|
+
/**
|
|
2038
|
+
* - The name of the item as displayed to the user,
|
|
2039
|
+
* usually in a UI or listing.
|
|
2040
|
+
*/
|
|
2041
|
+
name?: string;
|
|
2042
|
+
/**
|
|
2043
|
+
* - It represent a country display name.
|
|
2044
|
+
*/
|
|
424
2045
|
display_name?: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* - A slug is a human-readable URL segment, typically
|
|
2048
|
+
* generated from a title with special characters removed.
|
|
2049
|
+
*/
|
|
425
2050
|
slug?: string;
|
|
426
2051
|
};
|
|
427
2052
|
/** @returns {CurrencyObject} */
|
|
428
2053
|
declare function CurrencyObject(): CurrencyObject;
|
|
429
2054
|
type CurrencyObject = {
|
|
2055
|
+
/**
|
|
2056
|
+
* - A string representing the currency code.
|
|
2057
|
+
*/
|
|
430
2058
|
code?: string;
|
|
2059
|
+
/**
|
|
2060
|
+
* - A string representing the currency name.
|
|
2061
|
+
*/
|
|
431
2062
|
name?: string;
|
|
2063
|
+
/**
|
|
2064
|
+
* - A string representing the currency symbol.
|
|
2065
|
+
*/
|
|
432
2066
|
symbol?: string;
|
|
433
2067
|
};
|
|
434
|
-
/** @returns {
|
|
435
|
-
declare function
|
|
436
|
-
type
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
latitude?: string;
|
|
446
|
-
longitude?: string;
|
|
447
|
-
currency?: CurrencyObject;
|
|
448
|
-
type?: string;
|
|
449
|
-
};
|
|
450
|
-
/** @returns {GetCountries} */
|
|
451
|
-
declare function GetCountries(): GetCountries;
|
|
452
|
-
type GetCountries = {
|
|
453
|
-
items?: CountryObject[];
|
|
454
|
-
page?: Page;
|
|
2068
|
+
/** @returns {ValidationError} */
|
|
2069
|
+
declare function ValidationError(): ValidationError;
|
|
2070
|
+
type ValidationError = {
|
|
2071
|
+
/**
|
|
2072
|
+
* - A brief description of the error encountered.
|
|
2073
|
+
*/
|
|
2074
|
+
message: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* - The field in the request that caused the error.
|
|
2077
|
+
*/
|
|
2078
|
+
field: string;
|
|
455
2079
|
};
|