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