@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +108 -1199
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -111
- package/sdk/application/Content/ContentApplicationClient.js +43 -1065
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +91 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +103 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +84 -2105
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +157 -30
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1177 -56
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1662 -249
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +774 -162
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +141 -12
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5060 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1985 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +178 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +468 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6554 -1772
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3264 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +116 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +85 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +122 -191
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +447 -831
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +174 -220
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +164 -199
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1233 -476
- package/sdk/platform/Content/ContentPlatformModel.js +514 -487
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +424 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7747 -1342
- package/sdk/platform/Order/OrderPlatformModel.js +3960 -1262
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +292 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +145 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +132 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +681 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2458 -650
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1266 -572
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +176 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -7
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +795 -7
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,34 +1,36 @@
|
|
|
1
1
|
export = LogisticsPartnerModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {string} country
|
|
5
|
-
* @property {string} region
|
|
6
|
-
*
|
|
3
|
+
* @typedef BulkRegionServiceabilityTatDetails
|
|
4
|
+
* @property {string} country - Name of the country.
|
|
5
|
+
* @property {string} region - Name of the region for which the
|
|
6
|
+
* tat/serviceability file needs to be downloaded.
|
|
7
|
+
* @property {string} type - Denotes the type of file.
|
|
7
8
|
*/
|
|
8
9
|
/**
|
|
9
|
-
* @typedef
|
|
10
|
-
* @property {string} [country]
|
|
11
|
-
* @property {string} [region]
|
|
12
|
-
*
|
|
13
|
-
* @property {string} [
|
|
14
|
-
* @property {string} [
|
|
15
|
-
* @property {
|
|
16
|
-
* @property {
|
|
10
|
+
* @typedef BulkRegionServiceabilityTatResultItemData
|
|
11
|
+
* @property {string} [country] - Name of the country.
|
|
12
|
+
* @property {string} [region] - Name of the region for which the
|
|
13
|
+
* tat/serviceability file needs to be downloaded.
|
|
14
|
+
* @property {string} [type] - Denotes the type of data.
|
|
15
|
+
* @property {string} [batch_id] - Unique identifier identifying the perticular request.
|
|
16
|
+
* @property {string} [status] - Current status of the request.
|
|
17
|
+
* @property {Object[]} [failed_records] - Information of records which failed
|
|
18
|
+
* @property {string} [file_path] - CDN path of the file.
|
|
17
19
|
*/
|
|
18
20
|
/**
|
|
19
|
-
* @typedef
|
|
20
|
-
* @property {string} value
|
|
21
|
-
* @property {string} message
|
|
22
|
-
* @property {string} type
|
|
21
|
+
* @typedef ErrorResult
|
|
22
|
+
* @property {string} value - Fields containing the error.
|
|
23
|
+
* @property {string} message - Description of the error.
|
|
24
|
+
* @property {string} type - Type of the error.
|
|
23
25
|
*/
|
|
24
26
|
/**
|
|
25
|
-
* @typedef
|
|
26
|
-
* @property {boolean} success
|
|
27
|
-
* @property {
|
|
27
|
+
* @typedef FailureResult
|
|
28
|
+
* @property {boolean} success - Denotes if the request was successfully executed.
|
|
29
|
+
* @property {ErrorResult[]} error
|
|
28
30
|
*/
|
|
29
31
|
/**
|
|
30
|
-
* @typedef
|
|
31
|
-
* @property {
|
|
32
|
+
* @typedef BulkRegionServiceabilityTatResult
|
|
33
|
+
* @property {BulkRegionServiceabilityTatResultItemData[]} [items]
|
|
32
34
|
* @property {Page} [page]
|
|
33
35
|
*/
|
|
34
36
|
/**
|
|
@@ -42,114 +44,437 @@ export = LogisticsPartnerModel;
|
|
|
42
44
|
* @property {number} [size] - The number of items per page.
|
|
43
45
|
*/
|
|
44
46
|
/**
|
|
45
|
-
* @typedef
|
|
46
|
-
* @property {string}
|
|
47
|
-
* @property {string}
|
|
48
|
-
* @property {
|
|
49
|
-
* @property {string}
|
|
47
|
+
* @typedef CourierAccountUpdateDetails
|
|
48
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
49
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
50
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
51
|
+
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
52
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
53
|
+
* account or not.
|
|
54
|
+
*/
|
|
55
|
+
/**
|
|
56
|
+
* @typedef RegionTatItemResult
|
|
57
|
+
* @property {RegionTatResult[]} items
|
|
58
|
+
* @property {Page} page
|
|
59
|
+
*/
|
|
60
|
+
/**
|
|
61
|
+
* @typedef RegionServiceabilityItemResult
|
|
62
|
+
* @property {RegionServiceabilityResult[]} items
|
|
63
|
+
* @property {Page} page
|
|
64
|
+
*/
|
|
65
|
+
/**
|
|
66
|
+
* @typedef ServiceabilityDetailsResult
|
|
67
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
68
|
+
* first-mile service is available or not.
|
|
69
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
70
|
+
* service is available or not.
|
|
71
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
72
|
+
* region is first-mile serviceable or not in return pickup.
|
|
73
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
74
|
+
* (COD) payments allowed in the specified region.
|
|
75
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
76
|
+
* is available. This refers to the ability to return items directly from the
|
|
77
|
+
* customer's doorstep.
|
|
78
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
79
|
+
* service is available. This refers to the ability to perform quality checks
|
|
80
|
+
* on items at the customer's doorstep.
|
|
81
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
82
|
+
* scheduled to be processed on the same day.
|
|
83
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
84
|
+
* installation services are available in the specified region or not.
|
|
85
|
+
* @property {string} [id] - Unique identifier for the serviceability record.
|
|
86
|
+
*/
|
|
87
|
+
/**
|
|
88
|
+
* @typedef ServiceabilityDetails
|
|
89
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
90
|
+
* first-mile service is available or not.
|
|
91
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
92
|
+
* service is available or not.
|
|
93
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
94
|
+
* region is first-mile serviceable or not in return pickup.
|
|
95
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
96
|
+
* (COD) payments allowed in the specified region.
|
|
97
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
98
|
+
* is available. This refers to the ability to return items directly from the
|
|
99
|
+
* customer's doorstep.
|
|
100
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
101
|
+
* service is available. This refers to the ability to perform quality checks
|
|
102
|
+
* on items at the customer's doorstep.
|
|
103
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
104
|
+
* scheduled to be processed on the same day.
|
|
105
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
106
|
+
* installation services are available in the specified region or not.
|
|
107
|
+
*/
|
|
108
|
+
/**
|
|
109
|
+
* @typedef RegionServiceabilityResult
|
|
110
|
+
* @property {string} country_code - ISO2 code representing the country where
|
|
111
|
+
* the serviceability is being specified.
|
|
112
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
113
|
+
* within the country where the serviceability is being specified.
|
|
114
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
115
|
+
* where the serviceability is being specified.
|
|
116
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
117
|
+
* district within the city where the serviceability is being specified.
|
|
118
|
+
* @property {string} [pincode] - Postal or ZIP code for the specific area
|
|
119
|
+
* within the city where the serviceability is being specified.
|
|
120
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
121
|
+
* first-mile service is available or not.
|
|
122
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
123
|
+
* service is available or not.
|
|
124
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
125
|
+
* region is first-mile serviceable or not in return pickup.
|
|
126
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
127
|
+
* (COD) payments allowed in the specified region.
|
|
128
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
129
|
+
* is available. This refers to the ability to return items directly from the
|
|
130
|
+
* customer's doorstep.
|
|
131
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
132
|
+
* service is available. This refers to the ability to perform quality checks
|
|
133
|
+
* on items at the customer's doorstep.
|
|
134
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
135
|
+
* scheduled to be processed on the same day.
|
|
136
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
137
|
+
* installation services are available in the specified region or not.
|
|
138
|
+
* @property {string} id - Unique identifier for the serviceability record.
|
|
139
|
+
*/
|
|
140
|
+
/**
|
|
141
|
+
* @typedef RegionServiceabilityDetails
|
|
142
|
+
* @property {string} country_code - ISO2 code representing the country where
|
|
143
|
+
* the serviceability is being specified.
|
|
144
|
+
* @property {string} [state_code] - Code representing the state or province
|
|
145
|
+
* within the country where the serviceability is being specified.
|
|
146
|
+
* @property {string} [city_code] - Code representing the city within the state
|
|
147
|
+
* where the serviceability is being specified.
|
|
148
|
+
* @property {string} [sector_code] - Code representing a specific sector or
|
|
149
|
+
* district within the city where the serviceability is being specified.
|
|
150
|
+
* @property {string} [pincode] - Postal or ZIP code for the specific area
|
|
151
|
+
* within the city where the serviceability is being specified.
|
|
152
|
+
* @property {boolean} [first_mile] - Boolean value indicating whether
|
|
153
|
+
* first-mile service is available or not.
|
|
154
|
+
* @property {boolean} [last_mile] - Boolean value indicating whether last-mile
|
|
155
|
+
* service is available or not.
|
|
156
|
+
* @property {boolean} [reverse_pickup] - Boolean value indicating whether a
|
|
157
|
+
* region is first-mile serviceable or not in return pickup.
|
|
158
|
+
* @property {number} [cod_limit] - Limit on the amount of cash on delivery
|
|
159
|
+
* (COD) payments allowed in the specified region.
|
|
160
|
+
* @property {boolean} [doorstep_return] - Indicates if doorstep return service
|
|
161
|
+
* is available. This refers to the ability to return items directly from the
|
|
162
|
+
* customer's doorstep.
|
|
163
|
+
* @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
|
|
164
|
+
* service is available. This refers to the ability to perform quality checks
|
|
165
|
+
* on items at the customer's doorstep.
|
|
166
|
+
* @property {string} [pickup_cutoff] - Time of day by which pickups must be
|
|
167
|
+
* scheduled to be processed on the same day.
|
|
168
|
+
* @property {boolean} [installation] - Boolean value indicating whether
|
|
169
|
+
* installation services are available in the specified region or not.
|
|
170
|
+
*/
|
|
171
|
+
/**
|
|
172
|
+
* @typedef RegionTatDetails
|
|
173
|
+
* @property {string} from_country_code - ISO2 code representing the country of
|
|
174
|
+
* origin for the delivery.
|
|
175
|
+
* @property {string} [from_state_code] - Code representing the state or
|
|
176
|
+
* province of origin within the country.
|
|
177
|
+
* @property {string} [from_city_code] - Code representing the city of origin
|
|
178
|
+
* within the state.
|
|
179
|
+
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
180
|
+
* or district within the city of origin.
|
|
181
|
+
* @property {string} [from_pincode] - Postal or ZIP code of the origin area.
|
|
182
|
+
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
183
|
+
* @property {string} [to_state_code] - Code representing the state or province
|
|
184
|
+
* of the destination within the country.
|
|
185
|
+
* @property {string} [to_city_code] - Code representing the city of destination
|
|
186
|
+
* within the state.
|
|
187
|
+
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
188
|
+
* district within the city of destination.
|
|
189
|
+
* @property {string} [to_pincode] - Postal or ZIP code of the destination area.
|
|
190
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
191
|
+
* from the origin to the destination in seconds.
|
|
192
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
193
|
+
* from the origin to the destination in seconds.
|
|
194
|
+
*/
|
|
195
|
+
/**
|
|
196
|
+
* @typedef RegionTatUpdateDetails
|
|
197
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
198
|
+
* from the origin to the destination in seconds.
|
|
199
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
200
|
+
* from the origin to the destination in seconds.
|
|
201
|
+
*/
|
|
202
|
+
/**
|
|
203
|
+
* @typedef RegionTatResult
|
|
204
|
+
* @property {string} from_country_code - ISO2 code representing the country of
|
|
205
|
+
* origin for the delivery.
|
|
206
|
+
* @property {string} [from_state_code] - Code representing the state or
|
|
207
|
+
* province of origin within the country.
|
|
208
|
+
* @property {string} [from_city_code] - Code representing the city of origin
|
|
209
|
+
* within the state.
|
|
210
|
+
* @property {string} [from_sector_code] - Code representing a specific sector
|
|
211
|
+
* or district within the city of origin.
|
|
212
|
+
* @property {string} [from_pincode] - Postal or ZIP code of the origin area.
|
|
213
|
+
* @property {string} to_country_code - ISO2 code representing the destination country.
|
|
214
|
+
* @property {string} [to_state_code] - Code representing the state or province
|
|
215
|
+
* of the destination within the country.
|
|
216
|
+
* @property {string} [to_city_code] - Code representing the city of destination
|
|
217
|
+
* within the state.
|
|
218
|
+
* @property {string} [to_sector_code] - Code representing a specific sector or
|
|
219
|
+
* district within the city of destination.
|
|
220
|
+
* @property {string} [to_pincode] - Postal or ZIP code of the destination area.
|
|
221
|
+
* @property {number} [max_delivery_time] - Maximum time required for delivery
|
|
222
|
+
* from the origin to the destination in seconds.
|
|
223
|
+
* @property {number} [min_delivery_time] - Minimum time required for delivery
|
|
224
|
+
* from the origin to the destination in seconds.
|
|
225
|
+
* @property {string} id - Unique identifier for the delivery time record.
|
|
226
|
+
*/
|
|
227
|
+
/**
|
|
228
|
+
* @typedef BulkRegionJobDetails
|
|
229
|
+
* @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
|
|
230
|
+
* @property {string} country - Country for which the tat or serviceability is
|
|
231
|
+
* to be imported or exported.
|
|
232
|
+
* @property {string} action - Denotes the import or export action to be performed.
|
|
233
|
+
* @property {string} region - Region of the country for which import or export
|
|
234
|
+
* is triggered.
|
|
50
235
|
*/
|
|
51
236
|
/**
|
|
52
|
-
* @typedef
|
|
53
|
-
* @property {string} file_path
|
|
54
|
-
* @property {number} [failed]
|
|
55
|
-
* @property {Object[]} [failed_records]
|
|
56
|
-
* @property {string} action
|
|
57
|
-
* @property {string} batch_id
|
|
58
|
-
* @property {string} country
|
|
59
|
-
*
|
|
60
|
-
* @property {
|
|
61
|
-
*
|
|
62
|
-
* @property {
|
|
63
|
-
*
|
|
237
|
+
* @typedef BulkRegionResultItemData
|
|
238
|
+
* @property {string} [file_path] - CDN path of the file which was used for bulk import.
|
|
239
|
+
* @property {number} [failed] - Count of the failed records.
|
|
240
|
+
* @property {Object[]} [failed_records] - Information of records which failed.
|
|
241
|
+
* @property {string} action - Denotes the import or export action performed.
|
|
242
|
+
* @property {string} batch_id - Unique id to identify the import or export query.
|
|
243
|
+
* @property {string} country - Country for which the import or export action is
|
|
244
|
+
* performed.
|
|
245
|
+
* @property {number} [success] - Denoted if the import or export was successful
|
|
246
|
+
* or failure.
|
|
247
|
+
* @property {string} region - Region of the country for which import or export
|
|
248
|
+
* is triggered.
|
|
249
|
+
* @property {string} status - Current status of the import or export action performed.
|
|
250
|
+
* @property {number} [total] - Count of total records.
|
|
251
|
+
* @property {string} [error_file_path] - Path of the error file.
|
|
64
252
|
*/
|
|
65
253
|
/**
|
|
66
|
-
* @typedef
|
|
67
|
-
* @property {
|
|
254
|
+
* @typedef BulkRegionResult
|
|
255
|
+
* @property {BulkRegionResultItemData[]} items
|
|
68
256
|
* @property {Page} page
|
|
69
257
|
*/
|
|
70
258
|
/**
|
|
71
259
|
* @typedef CourierAccount
|
|
72
|
-
* @property {string} extension_id
|
|
73
|
-
* @property {string} account_id
|
|
74
|
-
*
|
|
75
|
-
* @property {
|
|
76
|
-
* @property {
|
|
77
|
-
* @property {
|
|
260
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
261
|
+
* @property {string} account_id - Unique identifier of courier partner scheme
|
|
262
|
+
* and company id combination.
|
|
263
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
264
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
265
|
+
* @property {string} stage - Denotes whether the account is in enabled or disabled stage.
|
|
266
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
267
|
+
* account or not.
|
|
78
268
|
*/
|
|
79
269
|
/**
|
|
80
|
-
* @typedef
|
|
81
|
-
* @property {string} extension_id
|
|
82
|
-
* @property {string} [account_id]
|
|
83
|
-
*
|
|
84
|
-
* @property {
|
|
85
|
-
* @property {
|
|
86
|
-
* @property {
|
|
270
|
+
* @typedef CourierAccountDetailsBody
|
|
271
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
272
|
+
* @property {string} [account_id] - Unique identifier of courier partner scheme
|
|
273
|
+
* and company id combination.
|
|
274
|
+
* @property {string} scheme_id - Unique identifier of courier account.
|
|
275
|
+
* @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
|
|
276
|
+
* @property {string} stage - Denotes whether the courier account is in enabled
|
|
277
|
+
* or disabled stage.
|
|
278
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
279
|
+
* account or not.
|
|
87
280
|
*/
|
|
88
281
|
/**
|
|
89
|
-
* @typedef
|
|
282
|
+
* @typedef CourierPartnerAccountFailureResult
|
|
90
283
|
* @property {boolean} success
|
|
91
|
-
* @property {
|
|
284
|
+
* @property {ErrorResult[]} error
|
|
92
285
|
*/
|
|
93
286
|
/**
|
|
94
|
-
* @typedef
|
|
95
|
-
* @property {
|
|
287
|
+
* @typedef CompanyCourierPartnerAccountListResult
|
|
288
|
+
* @property {CourierAccountResult[]} items
|
|
96
289
|
* @property {Page} page
|
|
97
290
|
*/
|
|
98
291
|
/**
|
|
99
|
-
* @typedef
|
|
100
|
-
* @property {string} account_id
|
|
101
|
-
*
|
|
292
|
+
* @typedef CourierAccountResult
|
|
293
|
+
* @property {string} account_id - Unique identifier of courier partner scheme
|
|
294
|
+
* and company id combination.
|
|
295
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
102
296
|
* @property {boolean} is_self_ship
|
|
103
|
-
* @property {string} stage
|
|
104
|
-
*
|
|
297
|
+
* @property {string} stage - Denotes whether the courier account is in enabled
|
|
298
|
+
* or disabled stage.
|
|
299
|
+
* @property {boolean} is_own_account - Denotes whether it is the seller's own
|
|
300
|
+
* account or not.
|
|
105
301
|
* @property {CourierPartnerSchemeModel} scheme_rules
|
|
106
302
|
*/
|
|
107
303
|
/**
|
|
108
304
|
* @typedef CourierPartnerSchemeModel
|
|
109
|
-
* @property {string} extension_id
|
|
110
|
-
* @property {string} scheme_id
|
|
111
|
-
* @property {string} name
|
|
305
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
306
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
307
|
+
* @property {string} name - Name of the scheme
|
|
112
308
|
* @property {ArithmeticOperations} weight
|
|
113
|
-
* @property {string} transport_type
|
|
114
|
-
*
|
|
115
|
-
* @property {string}
|
|
116
|
-
*
|
|
117
|
-
* @property {string}
|
|
309
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
310
|
+
* courier partner scheme.
|
|
311
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
312
|
+
* partner scheme.
|
|
313
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
314
|
+
* courier partner scheme.
|
|
315
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
316
|
+
* courier partner scheme.
|
|
317
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
318
|
+
* currently active or inactive.
|
|
118
319
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
119
320
|
*/
|
|
120
321
|
/**
|
|
121
|
-
* @typedef
|
|
122
|
-
* @property {string} extension_id
|
|
123
|
-
* @property {string} [scheme_id]
|
|
124
|
-
* @property {string} name
|
|
322
|
+
* @typedef CourierPartnerSchemeDetailsModel
|
|
323
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
324
|
+
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
325
|
+
* @property {string} name - Name of the courier partner scheme.
|
|
125
326
|
* @property {ArithmeticOperations} weight
|
|
126
|
-
* @property {string} transport_type
|
|
127
|
-
*
|
|
128
|
-
* @property {string}
|
|
129
|
-
*
|
|
130
|
-
* @property {string}
|
|
327
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
328
|
+
* courier partner scheme.
|
|
329
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
330
|
+
* partner scheme.
|
|
331
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
332
|
+
* courier partner scheme.
|
|
333
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
334
|
+
* courier partner scheme.
|
|
335
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
336
|
+
* currently active or inactive.
|
|
131
337
|
* @property {CourierPartnerSchemeFeatures} feature
|
|
132
338
|
*/
|
|
133
339
|
/**
|
|
134
340
|
* @typedef CourierPartnerSchemeFeatures
|
|
135
|
-
* @property {boolean} [doorstep_qc]
|
|
136
|
-
*
|
|
137
|
-
* @property {boolean} [
|
|
138
|
-
*
|
|
139
|
-
* @property {
|
|
140
|
-
*
|
|
141
|
-
* @property {boolean} [
|
|
142
|
-
*
|
|
143
|
-
* @property {
|
|
144
|
-
*
|
|
145
|
-
* @property {boolean} [
|
|
146
|
-
*
|
|
147
|
-
* @property {boolean} [
|
|
148
|
-
*
|
|
149
|
-
* @property {boolean} [
|
|
150
|
-
*
|
|
151
|
-
* @property {boolean} [
|
|
152
|
-
*
|
|
341
|
+
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
342
|
+
* doorstep quality check services.
|
|
343
|
+
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
344
|
+
* code-based operations.
|
|
345
|
+
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
346
|
+
* multi-part shipment services.
|
|
347
|
+
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
348
|
+
* feature is supported by the courier partner.
|
|
349
|
+
* @property {number} [ndr_attempts] - Number of attempts allowed for resolving
|
|
350
|
+
* Non-Delivery Reports (NDR).
|
|
351
|
+
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
352
|
+
* handles the transportation of dangerous goods.
|
|
353
|
+
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
354
|
+
* manages the shipment of fragile goods.
|
|
355
|
+
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
356
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
357
|
+
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
358
|
+
* provides cold storage facilities for goods.
|
|
359
|
+
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
360
|
+
* supports doorstep exchange services.
|
|
361
|
+
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
362
|
+
* offers doorstep return services.
|
|
363
|
+
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
364
|
+
* provides product installation services upon delivery.
|
|
365
|
+
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
366
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
367
|
+
* before accepting.
|
|
368
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
369
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
370
|
+
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
371
|
+
* partner supports multiple pickups to a single drop location.
|
|
372
|
+
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
373
|
+
* partner supports single pickup to multiple drop locations.
|
|
374
|
+
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
375
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
376
|
+
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
377
|
+
* supports the generation of e-waybills for shipments.
|
|
378
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
379
|
+
* of items allowed in a quality check shipment.
|
|
380
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
381
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
382
|
+
*/
|
|
383
|
+
/**
|
|
384
|
+
* @typedef CourierPartnerSchemeV2Features
|
|
385
|
+
* @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
|
|
386
|
+
* doorstep quality check services.
|
|
387
|
+
* @property {boolean} [qr] - Specifies whether the courier partner supports QR
|
|
388
|
+
* code-based operations.
|
|
389
|
+
* @property {boolean} [mps] - Denotes if the courier partner supports
|
|
390
|
+
* multi-part shipment services.
|
|
391
|
+
* @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
|
|
392
|
+
* feature is supported by the courier partner.
|
|
393
|
+
* @property {boolean} [dangerous_goods] - Specifies if the courier partner
|
|
394
|
+
* handles the transportation of dangerous goods.
|
|
395
|
+
* @property {boolean} [fragile_goods] - Indicates whether the courier partner
|
|
396
|
+
* manages the shipment of fragile goods.
|
|
397
|
+
* @property {boolean} [restricted_goods] - Indicates if the courier partner
|
|
398
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
399
|
+
* @property {boolean} [cold_storage_goods] - Denotes if the courier partner
|
|
400
|
+
* provides cold storage facilities for goods.
|
|
401
|
+
* @property {boolean} [doorstep_exchange] - Indicates if the courier partner
|
|
402
|
+
* supports doorstep exchange services.
|
|
403
|
+
* @property {boolean} [doorstep_return] - Specifies if the courier partner
|
|
404
|
+
* offers doorstep return services.
|
|
405
|
+
* @property {boolean} [product_installation] - Indicates if the courier partner
|
|
406
|
+
* provides product installation services upon delivery.
|
|
407
|
+
* @property {boolean} [openbox_delivery] - Specifies whether the courier
|
|
408
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
409
|
+
* before accepting.
|
|
410
|
+
* @property {boolean} [multi_pick_single_drop] - Indicates if the courier
|
|
411
|
+
* partner supports multiple pickups to a single drop location.
|
|
412
|
+
* @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
|
|
413
|
+
* partner supports single pickup to multiple drop locations.
|
|
414
|
+
* @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
|
|
415
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
416
|
+
* @property {boolean} [ewaybill] - Specifies if the courier partner requires or
|
|
417
|
+
* supports the generation of e-waybills for shipments.
|
|
418
|
+
*/
|
|
419
|
+
/**
|
|
420
|
+
* @typedef CourierPartnerSchemeV2DetailsModel
|
|
421
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
422
|
+
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
423
|
+
* @property {string} name - Name of the scheme.
|
|
424
|
+
* @property {ArithmeticOperations} weight
|
|
425
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
426
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
427
|
+
* courier partner scheme.
|
|
428
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
429
|
+
* partner scheme.
|
|
430
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
431
|
+
* courier partner scheme.
|
|
432
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
433
|
+
* courier partner scheme.
|
|
434
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
435
|
+
* currently active or inactive.
|
|
436
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
437
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
438
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
439
|
+
* (NDR) feature is supported by the courier partner.
|
|
440
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
441
|
+
* of items allowed in a quality check shipment.
|
|
442
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
443
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
444
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
445
|
+
*/
|
|
446
|
+
/**
|
|
447
|
+
* @typedef CourierPartnerV2SchemeModel
|
|
448
|
+
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
449
|
+
* @property {string} scheme_id - Unique identifier of courier partner scheme.
|
|
450
|
+
* @property {string} [company_id] - Unique identifier of company.
|
|
451
|
+
* @property {string} name - Name of the scheme.
|
|
452
|
+
* @property {ArithmeticOperations} weight
|
|
453
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
454
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
455
|
+
* courier partner scheme.
|
|
456
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
457
|
+
* partner scheme.
|
|
458
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
459
|
+
* courier partner scheme.
|
|
460
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
461
|
+
* courier partner scheme.
|
|
462
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
463
|
+
* currently active or inactive.
|
|
464
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
465
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
466
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
467
|
+
* (NDR) feature is supported by the courier partner.
|
|
468
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
469
|
+
* of items allowed in a quality check shipment.
|
|
470
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
471
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
472
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
473
|
+
*/
|
|
474
|
+
/**
|
|
475
|
+
* @typedef courierPartnerSchemeV2List
|
|
476
|
+
* @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
|
|
477
|
+
* @property {Page} page
|
|
153
478
|
*/
|
|
154
479
|
/**
|
|
155
480
|
* @typedef ArithmeticOperations
|
|
@@ -159,15 +484,29 @@ export = LogisticsPartnerModel;
|
|
|
159
484
|
* @property {number} [gte]
|
|
160
485
|
*/
|
|
161
486
|
/**
|
|
162
|
-
* @typedef
|
|
163
|
-
* @property {string} name
|
|
487
|
+
* @typedef CourierPartnerSchemeV2UpdateDetails
|
|
488
|
+
* @property {string} name - Name of the scheme.
|
|
164
489
|
* @property {ArithmeticOperations} weight
|
|
165
|
-
* @property {
|
|
166
|
-
* @property {string}
|
|
167
|
-
*
|
|
168
|
-
* @property {string
|
|
169
|
-
*
|
|
170
|
-
* @property {
|
|
490
|
+
* @property {ArithmeticOperations} [volumetric_weight]
|
|
491
|
+
* @property {string} transport_type - Mode of transport associated with the
|
|
492
|
+
* courier partner scheme.
|
|
493
|
+
* @property {string} region - Serviceable region associated with the courier
|
|
494
|
+
* partner scheme.
|
|
495
|
+
* @property {string} delivery_type - Type of delivery associated with the
|
|
496
|
+
* courier partner scheme.
|
|
497
|
+
* @property {string[]} payment_mode - Mode of payment associated with the
|
|
498
|
+
* courier partner scheme.
|
|
499
|
+
* @property {string} stage - Indicates if the courier partner scheme is
|
|
500
|
+
* currently active or inactive.
|
|
501
|
+
* @property {string} [status_updates] - Describes the type of status updates
|
|
502
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
503
|
+
* @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
|
|
504
|
+
* (NDR) feature is supported by the courier partner.
|
|
505
|
+
* @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
|
|
506
|
+
* of items allowed in a quality check shipment.
|
|
507
|
+
* @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
|
|
508
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
509
|
+
* @property {CourierPartnerSchemeV2Features} feature
|
|
171
510
|
*/
|
|
172
511
|
/**
|
|
173
512
|
* @typedef GetCountries
|
|
@@ -176,64 +515,127 @@ export = LogisticsPartnerModel;
|
|
|
176
515
|
*/
|
|
177
516
|
/**
|
|
178
517
|
* @typedef GetCountriesItems
|
|
179
|
-
* @property {string} [id]
|
|
180
|
-
* @property {string} [name]
|
|
181
|
-
* @property {string} [iso2]
|
|
182
|
-
* @property {string} [iso3]
|
|
183
|
-
* @property {string[]} [timezones]
|
|
184
|
-
*
|
|
185
|
-
* @property {
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
* @property {string} [
|
|
189
|
-
*
|
|
190
|
-
* @property {string} [
|
|
518
|
+
* @property {string} [id] - Unique identifier of the country.
|
|
519
|
+
* @property {string} [name] - Name of the country.
|
|
520
|
+
* @property {string} [iso2] - Two-letter ISO code representing the country.
|
|
521
|
+
* @property {string} [iso3] - Three-letter ISO code representing the country.
|
|
522
|
+
* @property {string[]} [timezones] - List of time zones used in the country
|
|
523
|
+
* (e.g., ["America/New_York", "America/Los_Angeles"]).
|
|
524
|
+
* @property {HierarchyItems[]} [hierarchy] - Levels within the country (e.g.,
|
|
525
|
+
* states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
|
|
526
|
+
* {"name": "City", "slug": "city"}]).
|
|
527
|
+
* @property {string} [phone_code] - International dialing code for the country
|
|
528
|
+
* (e.g., "+1").
|
|
529
|
+
* @property {string} [currency] - Indicates currency for the country (e.g., "INR").
|
|
530
|
+
* @property {string} [type] - Indicates the type of object (e.g., "country").
|
|
531
|
+
* @property {string} [latitude] - Geographical latitude of the country (e.g., "37.0902").
|
|
532
|
+
* @property {string} [longitude] - Geographical longitude of the country (e.g.,
|
|
533
|
+
* "-95.7129").
|
|
534
|
+
* @property {string} [display_name] - User-friendly version of the geographical
|
|
535
|
+
* data, which may be more descriptive or formatted differently.
|
|
536
|
+
* @property {boolean} [has_next_hierarchy] - More detailed hierarchical data is
|
|
537
|
+
* available, meaning states, cities, or other regions within the country have
|
|
538
|
+
* been populated in the system.
|
|
191
539
|
*/
|
|
192
540
|
/**
|
|
193
541
|
* @typedef HierarchyItems
|
|
194
|
-
* @property {string} [display_name]
|
|
195
|
-
* @property {string} [slug]
|
|
542
|
+
* @property {string} [display_name] - It represent a country display name.
|
|
543
|
+
* @property {string} [slug] - A URL-friendly version of the name, often used
|
|
544
|
+
* for referencing or querying purposes.
|
|
545
|
+
*/
|
|
546
|
+
/**
|
|
547
|
+
* @typedef ValidationError
|
|
548
|
+
* @property {string} message - A brief description of the error encountered.
|
|
549
|
+
* @property {string} field - The field in the request that caused the error.
|
|
550
|
+
*/
|
|
551
|
+
/**
|
|
552
|
+
* @typedef StandardError
|
|
553
|
+
* @property {string} message - A brief description of the error.
|
|
196
554
|
*/
|
|
197
555
|
declare class LogisticsPartnerModel {
|
|
198
556
|
}
|
|
199
557
|
declare namespace LogisticsPartnerModel {
|
|
200
|
-
export {
|
|
558
|
+
export { BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, ErrorResult, FailureResult, BulkRegionServiceabilityTatResult, Page, CourierAccountUpdateDetails, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatUpdateDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccount, CourierAccountDetailsBody, CourierPartnerAccountFailureResult, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeModel, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeV2Features, CourierPartnerSchemeV2DetailsModel, CourierPartnerV2SchemeModel, courierPartnerSchemeV2List, ArithmeticOperations, CourierPartnerSchemeV2UpdateDetails, GetCountries, GetCountriesItems, HierarchyItems, ValidationError, StandardError };
|
|
201
559
|
}
|
|
202
|
-
/** @returns {
|
|
203
|
-
declare function
|
|
204
|
-
type
|
|
560
|
+
/** @returns {BulkRegionServiceabilityTatDetails} */
|
|
561
|
+
declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
|
|
562
|
+
type BulkRegionServiceabilityTatDetails = {
|
|
563
|
+
/**
|
|
564
|
+
* - Name of the country.
|
|
565
|
+
*/
|
|
205
566
|
country: string;
|
|
567
|
+
/**
|
|
568
|
+
* - Name of the region for which the
|
|
569
|
+
* tat/serviceability file needs to be downloaded.
|
|
570
|
+
*/
|
|
206
571
|
region: string;
|
|
572
|
+
/**
|
|
573
|
+
* - Denotes the type of file.
|
|
574
|
+
*/
|
|
207
575
|
type: string;
|
|
208
576
|
};
|
|
209
|
-
/** @returns {
|
|
210
|
-
declare function
|
|
211
|
-
type
|
|
577
|
+
/** @returns {BulkRegionServiceabilityTatResultItemData} */
|
|
578
|
+
declare function BulkRegionServiceabilityTatResultItemData(): BulkRegionServiceabilityTatResultItemData;
|
|
579
|
+
type BulkRegionServiceabilityTatResultItemData = {
|
|
580
|
+
/**
|
|
581
|
+
* - Name of the country.
|
|
582
|
+
*/
|
|
212
583
|
country?: string;
|
|
584
|
+
/**
|
|
585
|
+
* - Name of the region for which the
|
|
586
|
+
* tat/serviceability file needs to be downloaded.
|
|
587
|
+
*/
|
|
213
588
|
region?: string;
|
|
589
|
+
/**
|
|
590
|
+
* - Denotes the type of data.
|
|
591
|
+
*/
|
|
214
592
|
type?: string;
|
|
593
|
+
/**
|
|
594
|
+
* - Unique identifier identifying the perticular request.
|
|
595
|
+
*/
|
|
215
596
|
batch_id?: string;
|
|
597
|
+
/**
|
|
598
|
+
* - Current status of the request.
|
|
599
|
+
*/
|
|
216
600
|
status?: string;
|
|
601
|
+
/**
|
|
602
|
+
* - Information of records which failed
|
|
603
|
+
*/
|
|
217
604
|
failed_records?: any[];
|
|
605
|
+
/**
|
|
606
|
+
* - CDN path of the file.
|
|
607
|
+
*/
|
|
218
608
|
file_path?: string;
|
|
219
609
|
};
|
|
220
|
-
/** @returns {
|
|
221
|
-
declare function
|
|
222
|
-
type
|
|
610
|
+
/** @returns {ErrorResult} */
|
|
611
|
+
declare function ErrorResult(): ErrorResult;
|
|
612
|
+
type ErrorResult = {
|
|
613
|
+
/**
|
|
614
|
+
* - Fields containing the error.
|
|
615
|
+
*/
|
|
223
616
|
value: string;
|
|
617
|
+
/**
|
|
618
|
+
* - Description of the error.
|
|
619
|
+
*/
|
|
224
620
|
message: string;
|
|
621
|
+
/**
|
|
622
|
+
* - Type of the error.
|
|
623
|
+
*/
|
|
225
624
|
type: string;
|
|
226
625
|
};
|
|
227
|
-
/** @returns {
|
|
228
|
-
declare function
|
|
229
|
-
type
|
|
626
|
+
/** @returns {FailureResult} */
|
|
627
|
+
declare function FailureResult(): FailureResult;
|
|
628
|
+
type FailureResult = {
|
|
629
|
+
/**
|
|
630
|
+
* - Denotes if the request was successfully executed.
|
|
631
|
+
*/
|
|
230
632
|
success: boolean;
|
|
231
|
-
error:
|
|
633
|
+
error: ErrorResult[];
|
|
232
634
|
};
|
|
233
|
-
/** @returns {
|
|
234
|
-
declare function
|
|
235
|
-
type
|
|
236
|
-
items?:
|
|
635
|
+
/** @returns {BulkRegionServiceabilityTatResult} */
|
|
636
|
+
declare function BulkRegionServiceabilityTatResult(): BulkRegionServiceabilityTatResult;
|
|
637
|
+
type BulkRegionServiceabilityTatResult = {
|
|
638
|
+
items?: BulkRegionServiceabilityTatResultItemData[];
|
|
237
639
|
page?: Page;
|
|
238
640
|
};
|
|
239
641
|
/** @returns {Page} */
|
|
@@ -268,128 +670,1020 @@ type Page = {
|
|
|
268
670
|
*/
|
|
269
671
|
size?: number;
|
|
270
672
|
};
|
|
271
|
-
/** @returns {
|
|
272
|
-
declare function
|
|
273
|
-
type
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
region: string;
|
|
278
|
-
};
|
|
279
|
-
/** @returns {BulkRegionResponseItemData} */
|
|
280
|
-
declare function BulkRegionResponseItemData(): BulkRegionResponseItemData;
|
|
281
|
-
type BulkRegionResponseItemData = {
|
|
282
|
-
file_path: string;
|
|
283
|
-
failed?: number;
|
|
284
|
-
failed_records?: any[];
|
|
285
|
-
action: string;
|
|
286
|
-
batch_id: string;
|
|
287
|
-
country: string;
|
|
288
|
-
success?: number;
|
|
289
|
-
region: string;
|
|
290
|
-
status: string;
|
|
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;
|
|
299
|
-
};
|
|
300
|
-
/** @returns {CourierAccount} */
|
|
301
|
-
declare function CourierAccount(): CourierAccount;
|
|
302
|
-
type CourierAccount = {
|
|
303
|
-
extension_id: string;
|
|
304
|
-
account_id: string;
|
|
305
|
-
scheme_id: string;
|
|
306
|
-
is_self_ship: boolean;
|
|
307
|
-
stage: string;
|
|
308
|
-
is_own_account: boolean;
|
|
309
|
-
};
|
|
310
|
-
/** @returns {CourierAccountRequestBody} */
|
|
311
|
-
declare function CourierAccountRequestBody(): CourierAccountRequestBody;
|
|
312
|
-
type CourierAccountRequestBody = {
|
|
673
|
+
/** @returns {CourierAccountUpdateDetails} */
|
|
674
|
+
declare function CourierAccountUpdateDetails(): CourierAccountUpdateDetails;
|
|
675
|
+
type CourierAccountUpdateDetails = {
|
|
676
|
+
/**
|
|
677
|
+
* - Unique identifier of courier partner extension.
|
|
678
|
+
*/
|
|
313
679
|
extension_id: string;
|
|
314
|
-
|
|
680
|
+
/**
|
|
681
|
+
* - Unique identifier of courier partner scheme.
|
|
682
|
+
*/
|
|
315
683
|
scheme_id: string;
|
|
684
|
+
/**
|
|
685
|
+
* - Denotes if the account is of self delivery type.
|
|
686
|
+
*/
|
|
316
687
|
is_self_ship: boolean;
|
|
688
|
+
/**
|
|
689
|
+
* - Denotes whether the account is in enabled or disabled stage.
|
|
690
|
+
*/
|
|
317
691
|
stage: string;
|
|
692
|
+
/**
|
|
693
|
+
* - Denotes whether it is the seller's own
|
|
694
|
+
* account or not.
|
|
695
|
+
*/
|
|
318
696
|
is_own_account: boolean;
|
|
319
697
|
};
|
|
320
|
-
/** @returns {
|
|
321
|
-
declare function
|
|
322
|
-
type
|
|
323
|
-
|
|
324
|
-
error: ErrorResponse[];
|
|
325
|
-
};
|
|
326
|
-
/** @returns {CompanyCourierPartnerAccountListResponse} */
|
|
327
|
-
declare function CompanyCourierPartnerAccountListResponse(): CompanyCourierPartnerAccountListResponse;
|
|
328
|
-
type CompanyCourierPartnerAccountListResponse = {
|
|
329
|
-
items: CourierAccountResponse[];
|
|
698
|
+
/** @returns {RegionTatItemResult} */
|
|
699
|
+
declare function RegionTatItemResult(): RegionTatItemResult;
|
|
700
|
+
type RegionTatItemResult = {
|
|
701
|
+
items: RegionTatResult[];
|
|
330
702
|
page: Page;
|
|
331
703
|
};
|
|
332
|
-
/** @returns {
|
|
333
|
-
declare function
|
|
334
|
-
type
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
is_self_ship: boolean;
|
|
338
|
-
stage: string;
|
|
339
|
-
is_own_account: boolean;
|
|
340
|
-
scheme_rules: CourierPartnerSchemeModel;
|
|
704
|
+
/** @returns {RegionServiceabilityItemResult} */
|
|
705
|
+
declare function RegionServiceabilityItemResult(): RegionServiceabilityItemResult;
|
|
706
|
+
type RegionServiceabilityItemResult = {
|
|
707
|
+
items: RegionServiceabilityResult[];
|
|
708
|
+
page: Page;
|
|
341
709
|
};
|
|
342
|
-
/** @returns {
|
|
343
|
-
declare function
|
|
344
|
-
type
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
710
|
+
/** @returns {ServiceabilityDetailsResult} */
|
|
711
|
+
declare function ServiceabilityDetailsResult(): ServiceabilityDetailsResult;
|
|
712
|
+
type ServiceabilityDetailsResult = {
|
|
713
|
+
/**
|
|
714
|
+
* - Boolean value indicating whether
|
|
715
|
+
* first-mile service is available or not.
|
|
716
|
+
*/
|
|
717
|
+
first_mile?: boolean;
|
|
718
|
+
/**
|
|
719
|
+
* - Boolean value indicating whether last-mile
|
|
720
|
+
* service is available or not.
|
|
721
|
+
*/
|
|
722
|
+
last_mile?: boolean;
|
|
723
|
+
/**
|
|
724
|
+
* - Boolean value indicating whether a
|
|
725
|
+
* region is first-mile serviceable or not in return pickup.
|
|
726
|
+
*/
|
|
727
|
+
reverse_pickup?: boolean;
|
|
728
|
+
/**
|
|
729
|
+
* - Limit on the amount of cash on delivery
|
|
730
|
+
* (COD) payments allowed in the specified region.
|
|
731
|
+
*/
|
|
732
|
+
cod_limit?: number;
|
|
733
|
+
/**
|
|
734
|
+
* - Indicates if doorstep return service
|
|
735
|
+
* is available. This refers to the ability to return items directly from the
|
|
736
|
+
* customer's doorstep.
|
|
737
|
+
*/
|
|
738
|
+
doorstep_return?: boolean;
|
|
739
|
+
/**
|
|
740
|
+
* - Indicates if doorstep quality check
|
|
741
|
+
* service is available. This refers to the ability to perform quality checks
|
|
742
|
+
* on items at the customer's doorstep.
|
|
743
|
+
*/
|
|
744
|
+
doorstep_qc?: boolean;
|
|
745
|
+
/**
|
|
746
|
+
* - Time of day by which pickups must be
|
|
747
|
+
* scheduled to be processed on the same day.
|
|
748
|
+
*/
|
|
749
|
+
pickup_cutoff?: string;
|
|
750
|
+
/**
|
|
751
|
+
* - Boolean value indicating whether
|
|
752
|
+
* installation services are available in the specified region or not.
|
|
753
|
+
*/
|
|
754
|
+
installation?: boolean;
|
|
755
|
+
/**
|
|
756
|
+
* - Unique identifier for the serviceability record.
|
|
757
|
+
*/
|
|
758
|
+
id?: string;
|
|
355
759
|
};
|
|
356
|
-
/** @returns {
|
|
357
|
-
declare function
|
|
358
|
-
type
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
760
|
+
/** @returns {ServiceabilityDetails} */
|
|
761
|
+
declare function ServiceabilityDetails(): ServiceabilityDetails;
|
|
762
|
+
type ServiceabilityDetails = {
|
|
763
|
+
/**
|
|
764
|
+
* - Boolean value indicating whether
|
|
765
|
+
* first-mile service is available or not.
|
|
766
|
+
*/
|
|
767
|
+
first_mile?: boolean;
|
|
768
|
+
/**
|
|
769
|
+
* - Boolean value indicating whether last-mile
|
|
770
|
+
* service is available or not.
|
|
771
|
+
*/
|
|
772
|
+
last_mile?: boolean;
|
|
773
|
+
/**
|
|
774
|
+
* - Boolean value indicating whether a
|
|
775
|
+
* region is first-mile serviceable or not in return pickup.
|
|
776
|
+
*/
|
|
777
|
+
reverse_pickup?: boolean;
|
|
778
|
+
/**
|
|
779
|
+
* - Limit on the amount of cash on delivery
|
|
780
|
+
* (COD) payments allowed in the specified region.
|
|
781
|
+
*/
|
|
782
|
+
cod_limit?: number;
|
|
783
|
+
/**
|
|
784
|
+
* - Indicates if doorstep return service
|
|
785
|
+
* is available. This refers to the ability to return items directly from the
|
|
786
|
+
* customer's doorstep.
|
|
787
|
+
*/
|
|
788
|
+
doorstep_return?: boolean;
|
|
789
|
+
/**
|
|
790
|
+
* - Indicates if doorstep quality check
|
|
791
|
+
* service is available. This refers to the ability to perform quality checks
|
|
792
|
+
* on items at the customer's doorstep.
|
|
793
|
+
*/
|
|
794
|
+
doorstep_qc?: boolean;
|
|
795
|
+
/**
|
|
796
|
+
* - Time of day by which pickups must be
|
|
797
|
+
* scheduled to be processed on the same day.
|
|
798
|
+
*/
|
|
799
|
+
pickup_cutoff?: string;
|
|
800
|
+
/**
|
|
801
|
+
* - Boolean value indicating whether
|
|
802
|
+
* installation services are available in the specified region or not.
|
|
803
|
+
*/
|
|
804
|
+
installation?: boolean;
|
|
369
805
|
};
|
|
370
|
-
/** @returns {
|
|
371
|
-
declare function
|
|
372
|
-
type
|
|
806
|
+
/** @returns {RegionServiceabilityResult} */
|
|
807
|
+
declare function RegionServiceabilityResult(): RegionServiceabilityResult;
|
|
808
|
+
type RegionServiceabilityResult = {
|
|
809
|
+
/**
|
|
810
|
+
* - ISO2 code representing the country where
|
|
811
|
+
* the serviceability is being specified.
|
|
812
|
+
*/
|
|
813
|
+
country_code: string;
|
|
814
|
+
/**
|
|
815
|
+
* - Code representing the state or province
|
|
816
|
+
* within the country where the serviceability is being specified.
|
|
817
|
+
*/
|
|
818
|
+
state_code?: string;
|
|
819
|
+
/**
|
|
820
|
+
* - Code representing the city within the state
|
|
821
|
+
* where the serviceability is being specified.
|
|
822
|
+
*/
|
|
823
|
+
city_code?: string;
|
|
824
|
+
/**
|
|
825
|
+
* - Code representing a specific sector or
|
|
826
|
+
* district within the city where the serviceability is being specified.
|
|
827
|
+
*/
|
|
828
|
+
sector_code?: string;
|
|
829
|
+
/**
|
|
830
|
+
* - Postal or ZIP code for the specific area
|
|
831
|
+
* within the city where the serviceability is being specified.
|
|
832
|
+
*/
|
|
833
|
+
pincode?: string;
|
|
834
|
+
/**
|
|
835
|
+
* - Boolean value indicating whether
|
|
836
|
+
* first-mile service is available or not.
|
|
837
|
+
*/
|
|
838
|
+
first_mile?: boolean;
|
|
839
|
+
/**
|
|
840
|
+
* - Boolean value indicating whether last-mile
|
|
841
|
+
* service is available or not.
|
|
842
|
+
*/
|
|
843
|
+
last_mile?: boolean;
|
|
844
|
+
/**
|
|
845
|
+
* - Boolean value indicating whether a
|
|
846
|
+
* region is first-mile serviceable or not in return pickup.
|
|
847
|
+
*/
|
|
848
|
+
reverse_pickup?: boolean;
|
|
849
|
+
/**
|
|
850
|
+
* - Limit on the amount of cash on delivery
|
|
851
|
+
* (COD) payments allowed in the specified region.
|
|
852
|
+
*/
|
|
853
|
+
cod_limit?: number;
|
|
854
|
+
/**
|
|
855
|
+
* - Indicates if doorstep return service
|
|
856
|
+
* is available. This refers to the ability to return items directly from the
|
|
857
|
+
* customer's doorstep.
|
|
858
|
+
*/
|
|
859
|
+
doorstep_return?: boolean;
|
|
860
|
+
/**
|
|
861
|
+
* - Indicates if doorstep quality check
|
|
862
|
+
* service is available. This refers to the ability to perform quality checks
|
|
863
|
+
* on items at the customer's doorstep.
|
|
864
|
+
*/
|
|
373
865
|
doorstep_qc?: boolean;
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
866
|
+
/**
|
|
867
|
+
* - Time of day by which pickups must be
|
|
868
|
+
* scheduled to be processed on the same day.
|
|
869
|
+
*/
|
|
870
|
+
pickup_cutoff?: string;
|
|
871
|
+
/**
|
|
872
|
+
* - Boolean value indicating whether
|
|
873
|
+
* installation services are available in the specified region or not.
|
|
874
|
+
*/
|
|
875
|
+
installation?: boolean;
|
|
876
|
+
/**
|
|
877
|
+
* - Unique identifier for the serviceability record.
|
|
878
|
+
*/
|
|
879
|
+
id: string;
|
|
880
|
+
};
|
|
881
|
+
/** @returns {RegionServiceabilityDetails} */
|
|
882
|
+
declare function RegionServiceabilityDetails(): RegionServiceabilityDetails;
|
|
883
|
+
type RegionServiceabilityDetails = {
|
|
884
|
+
/**
|
|
885
|
+
* - ISO2 code representing the country where
|
|
886
|
+
* the serviceability is being specified.
|
|
887
|
+
*/
|
|
888
|
+
country_code: string;
|
|
889
|
+
/**
|
|
890
|
+
* - Code representing the state or province
|
|
891
|
+
* within the country where the serviceability is being specified.
|
|
892
|
+
*/
|
|
893
|
+
state_code?: string;
|
|
894
|
+
/**
|
|
895
|
+
* - Code representing the city within the state
|
|
896
|
+
* where the serviceability is being specified.
|
|
897
|
+
*/
|
|
898
|
+
city_code?: string;
|
|
899
|
+
/**
|
|
900
|
+
* - Code representing a specific sector or
|
|
901
|
+
* district within the city where the serviceability is being specified.
|
|
902
|
+
*/
|
|
903
|
+
sector_code?: string;
|
|
904
|
+
/**
|
|
905
|
+
* - Postal or ZIP code for the specific area
|
|
906
|
+
* within the city where the serviceability is being specified.
|
|
907
|
+
*/
|
|
908
|
+
pincode?: string;
|
|
909
|
+
/**
|
|
910
|
+
* - Boolean value indicating whether
|
|
911
|
+
* first-mile service is available or not.
|
|
912
|
+
*/
|
|
913
|
+
first_mile?: boolean;
|
|
914
|
+
/**
|
|
915
|
+
* - Boolean value indicating whether last-mile
|
|
916
|
+
* service is available or not.
|
|
917
|
+
*/
|
|
918
|
+
last_mile?: boolean;
|
|
919
|
+
/**
|
|
920
|
+
* - Boolean value indicating whether a
|
|
921
|
+
* region is first-mile serviceable or not in return pickup.
|
|
922
|
+
*/
|
|
923
|
+
reverse_pickup?: boolean;
|
|
924
|
+
/**
|
|
925
|
+
* - Limit on the amount of cash on delivery
|
|
926
|
+
* (COD) payments allowed in the specified region.
|
|
927
|
+
*/
|
|
928
|
+
cod_limit?: number;
|
|
929
|
+
/**
|
|
930
|
+
* - Indicates if doorstep return service
|
|
931
|
+
* is available. This refers to the ability to return items directly from the
|
|
932
|
+
* customer's doorstep.
|
|
933
|
+
*/
|
|
383
934
|
doorstep_return?: boolean;
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
935
|
+
/**
|
|
936
|
+
* - Indicates if doorstep quality check
|
|
937
|
+
* service is available. This refers to the ability to perform quality checks
|
|
938
|
+
* on items at the customer's doorstep.
|
|
939
|
+
*/
|
|
940
|
+
doorstep_qc?: boolean;
|
|
941
|
+
/**
|
|
942
|
+
* - Time of day by which pickups must be
|
|
943
|
+
* scheduled to be processed on the same day.
|
|
944
|
+
*/
|
|
945
|
+
pickup_cutoff?: string;
|
|
946
|
+
/**
|
|
947
|
+
* - Boolean value indicating whether
|
|
948
|
+
* installation services are available in the specified region or not.
|
|
949
|
+
*/
|
|
950
|
+
installation?: boolean;
|
|
391
951
|
};
|
|
392
|
-
/** @returns {
|
|
952
|
+
/** @returns {RegionTatDetails} */
|
|
953
|
+
declare function RegionTatDetails(): RegionTatDetails;
|
|
954
|
+
type RegionTatDetails = {
|
|
955
|
+
/**
|
|
956
|
+
* - ISO2 code representing the country of
|
|
957
|
+
* origin for the delivery.
|
|
958
|
+
*/
|
|
959
|
+
from_country_code: string;
|
|
960
|
+
/**
|
|
961
|
+
* - Code representing the state or
|
|
962
|
+
* province of origin within the country.
|
|
963
|
+
*/
|
|
964
|
+
from_state_code?: string;
|
|
965
|
+
/**
|
|
966
|
+
* - Code representing the city of origin
|
|
967
|
+
* within the state.
|
|
968
|
+
*/
|
|
969
|
+
from_city_code?: string;
|
|
970
|
+
/**
|
|
971
|
+
* - Code representing a specific sector
|
|
972
|
+
* or district within the city of origin.
|
|
973
|
+
*/
|
|
974
|
+
from_sector_code?: string;
|
|
975
|
+
/**
|
|
976
|
+
* - Postal or ZIP code of the origin area.
|
|
977
|
+
*/
|
|
978
|
+
from_pincode?: string;
|
|
979
|
+
/**
|
|
980
|
+
* - ISO2 code representing the destination country.
|
|
981
|
+
*/
|
|
982
|
+
to_country_code: string;
|
|
983
|
+
/**
|
|
984
|
+
* - Code representing the state or province
|
|
985
|
+
* of the destination within the country.
|
|
986
|
+
*/
|
|
987
|
+
to_state_code?: string;
|
|
988
|
+
/**
|
|
989
|
+
* - Code representing the city of destination
|
|
990
|
+
* within the state.
|
|
991
|
+
*/
|
|
992
|
+
to_city_code?: string;
|
|
993
|
+
/**
|
|
994
|
+
* - Code representing a specific sector or
|
|
995
|
+
* district within the city of destination.
|
|
996
|
+
*/
|
|
997
|
+
to_sector_code?: string;
|
|
998
|
+
/**
|
|
999
|
+
* - Postal or ZIP code of the destination area.
|
|
1000
|
+
*/
|
|
1001
|
+
to_pincode?: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* - Maximum time required for delivery
|
|
1004
|
+
* from the origin to the destination in seconds.
|
|
1005
|
+
*/
|
|
1006
|
+
max_delivery_time?: number;
|
|
1007
|
+
/**
|
|
1008
|
+
* - Minimum time required for delivery
|
|
1009
|
+
* from the origin to the destination in seconds.
|
|
1010
|
+
*/
|
|
1011
|
+
min_delivery_time?: number;
|
|
1012
|
+
};
|
|
1013
|
+
/** @returns {RegionTatUpdateDetails} */
|
|
1014
|
+
declare function RegionTatUpdateDetails(): RegionTatUpdateDetails;
|
|
1015
|
+
type RegionTatUpdateDetails = {
|
|
1016
|
+
/**
|
|
1017
|
+
* - Maximum time required for delivery
|
|
1018
|
+
* from the origin to the destination in seconds.
|
|
1019
|
+
*/
|
|
1020
|
+
max_delivery_time?: number;
|
|
1021
|
+
/**
|
|
1022
|
+
* - Minimum time required for delivery
|
|
1023
|
+
* from the origin to the destination in seconds.
|
|
1024
|
+
*/
|
|
1025
|
+
min_delivery_time?: number;
|
|
1026
|
+
};
|
|
1027
|
+
/** @returns {RegionTatResult} */
|
|
1028
|
+
declare function RegionTatResult(): RegionTatResult;
|
|
1029
|
+
type RegionTatResult = {
|
|
1030
|
+
/**
|
|
1031
|
+
* - ISO2 code representing the country of
|
|
1032
|
+
* origin for the delivery.
|
|
1033
|
+
*/
|
|
1034
|
+
from_country_code: string;
|
|
1035
|
+
/**
|
|
1036
|
+
* - Code representing the state or
|
|
1037
|
+
* province of origin within the country.
|
|
1038
|
+
*/
|
|
1039
|
+
from_state_code?: string;
|
|
1040
|
+
/**
|
|
1041
|
+
* - Code representing the city of origin
|
|
1042
|
+
* within the state.
|
|
1043
|
+
*/
|
|
1044
|
+
from_city_code?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* - Code representing a specific sector
|
|
1047
|
+
* or district within the city of origin.
|
|
1048
|
+
*/
|
|
1049
|
+
from_sector_code?: string;
|
|
1050
|
+
/**
|
|
1051
|
+
* - Postal or ZIP code of the origin area.
|
|
1052
|
+
*/
|
|
1053
|
+
from_pincode?: string;
|
|
1054
|
+
/**
|
|
1055
|
+
* - ISO2 code representing the destination country.
|
|
1056
|
+
*/
|
|
1057
|
+
to_country_code: string;
|
|
1058
|
+
/**
|
|
1059
|
+
* - Code representing the state or province
|
|
1060
|
+
* of the destination within the country.
|
|
1061
|
+
*/
|
|
1062
|
+
to_state_code?: string;
|
|
1063
|
+
/**
|
|
1064
|
+
* - Code representing the city of destination
|
|
1065
|
+
* within the state.
|
|
1066
|
+
*/
|
|
1067
|
+
to_city_code?: string;
|
|
1068
|
+
/**
|
|
1069
|
+
* - Code representing a specific sector or
|
|
1070
|
+
* district within the city of destination.
|
|
1071
|
+
*/
|
|
1072
|
+
to_sector_code?: string;
|
|
1073
|
+
/**
|
|
1074
|
+
* - Postal or ZIP code of the destination area.
|
|
1075
|
+
*/
|
|
1076
|
+
to_pincode?: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* - Maximum time required for delivery
|
|
1079
|
+
* from the origin to the destination in seconds.
|
|
1080
|
+
*/
|
|
1081
|
+
max_delivery_time?: number;
|
|
1082
|
+
/**
|
|
1083
|
+
* - Minimum time required for delivery
|
|
1084
|
+
* from the origin to the destination in seconds.
|
|
1085
|
+
*/
|
|
1086
|
+
min_delivery_time?: number;
|
|
1087
|
+
/**
|
|
1088
|
+
* - Unique identifier for the delivery time record.
|
|
1089
|
+
*/
|
|
1090
|
+
id: string;
|
|
1091
|
+
};
|
|
1092
|
+
/** @returns {BulkRegionJobDetails} */
|
|
1093
|
+
declare function BulkRegionJobDetails(): BulkRegionJobDetails;
|
|
1094
|
+
type BulkRegionJobDetails = {
|
|
1095
|
+
/**
|
|
1096
|
+
* - CDN path of the uploaded csv file for bulk import.
|
|
1097
|
+
*/
|
|
1098
|
+
file_path?: string;
|
|
1099
|
+
/**
|
|
1100
|
+
* - Country for which the tat or serviceability is
|
|
1101
|
+
* to be imported or exported.
|
|
1102
|
+
*/
|
|
1103
|
+
country: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* - Denotes the import or export action to be performed.
|
|
1106
|
+
*/
|
|
1107
|
+
action: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* - Region of the country for which import or export
|
|
1110
|
+
* is triggered.
|
|
1111
|
+
*/
|
|
1112
|
+
region: string;
|
|
1113
|
+
};
|
|
1114
|
+
/** @returns {BulkRegionResultItemData} */
|
|
1115
|
+
declare function BulkRegionResultItemData(): BulkRegionResultItemData;
|
|
1116
|
+
type BulkRegionResultItemData = {
|
|
1117
|
+
/**
|
|
1118
|
+
* - CDN path of the file which was used for bulk import.
|
|
1119
|
+
*/
|
|
1120
|
+
file_path?: string;
|
|
1121
|
+
/**
|
|
1122
|
+
* - Count of the failed records.
|
|
1123
|
+
*/
|
|
1124
|
+
failed?: number;
|
|
1125
|
+
/**
|
|
1126
|
+
* - Information of records which failed.
|
|
1127
|
+
*/
|
|
1128
|
+
failed_records?: any[];
|
|
1129
|
+
/**
|
|
1130
|
+
* - Denotes the import or export action performed.
|
|
1131
|
+
*/
|
|
1132
|
+
action: string;
|
|
1133
|
+
/**
|
|
1134
|
+
* - Unique id to identify the import or export query.
|
|
1135
|
+
*/
|
|
1136
|
+
batch_id: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* - Country for which the import or export action is
|
|
1139
|
+
* performed.
|
|
1140
|
+
*/
|
|
1141
|
+
country: string;
|
|
1142
|
+
/**
|
|
1143
|
+
* - Denoted if the import or export was successful
|
|
1144
|
+
* or failure.
|
|
1145
|
+
*/
|
|
1146
|
+
success?: number;
|
|
1147
|
+
/**
|
|
1148
|
+
* - Region of the country for which import or export
|
|
1149
|
+
* is triggered.
|
|
1150
|
+
*/
|
|
1151
|
+
region: string;
|
|
1152
|
+
/**
|
|
1153
|
+
* - Current status of the import or export action performed.
|
|
1154
|
+
*/
|
|
1155
|
+
status: string;
|
|
1156
|
+
/**
|
|
1157
|
+
* - Count of total records.
|
|
1158
|
+
*/
|
|
1159
|
+
total?: number;
|
|
1160
|
+
/**
|
|
1161
|
+
* - Path of the error file.
|
|
1162
|
+
*/
|
|
1163
|
+
error_file_path?: string;
|
|
1164
|
+
};
|
|
1165
|
+
/** @returns {BulkRegionResult} */
|
|
1166
|
+
declare function BulkRegionResult(): BulkRegionResult;
|
|
1167
|
+
type BulkRegionResult = {
|
|
1168
|
+
items: BulkRegionResultItemData[];
|
|
1169
|
+
page: Page;
|
|
1170
|
+
};
|
|
1171
|
+
/** @returns {CourierAccount} */
|
|
1172
|
+
declare function CourierAccount(): CourierAccount;
|
|
1173
|
+
type CourierAccount = {
|
|
1174
|
+
/**
|
|
1175
|
+
* - Unique identifier of courier partner extension.
|
|
1176
|
+
*/
|
|
1177
|
+
extension_id: string;
|
|
1178
|
+
/**
|
|
1179
|
+
* - Unique identifier of courier partner scheme
|
|
1180
|
+
* and company id combination.
|
|
1181
|
+
*/
|
|
1182
|
+
account_id: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* - Unique identifier of courier partner scheme.
|
|
1185
|
+
*/
|
|
1186
|
+
scheme_id: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* - Denotes if the account is of self delivery type.
|
|
1189
|
+
*/
|
|
1190
|
+
is_self_ship: boolean;
|
|
1191
|
+
/**
|
|
1192
|
+
* - Denotes whether the account is in enabled or disabled stage.
|
|
1193
|
+
*/
|
|
1194
|
+
stage: string;
|
|
1195
|
+
/**
|
|
1196
|
+
* - Denotes whether it is the seller's own
|
|
1197
|
+
* account or not.
|
|
1198
|
+
*/
|
|
1199
|
+
is_own_account: boolean;
|
|
1200
|
+
};
|
|
1201
|
+
/** @returns {CourierAccountDetailsBody} */
|
|
1202
|
+
declare function CourierAccountDetailsBody(): CourierAccountDetailsBody;
|
|
1203
|
+
type CourierAccountDetailsBody = {
|
|
1204
|
+
/**
|
|
1205
|
+
* - Unique identifier of courier partner extension.
|
|
1206
|
+
*/
|
|
1207
|
+
extension_id: string;
|
|
1208
|
+
/**
|
|
1209
|
+
* - Unique identifier of courier partner scheme
|
|
1210
|
+
* and company id combination.
|
|
1211
|
+
*/
|
|
1212
|
+
account_id?: string;
|
|
1213
|
+
/**
|
|
1214
|
+
* - Unique identifier of courier account.
|
|
1215
|
+
*/
|
|
1216
|
+
scheme_id: string;
|
|
1217
|
+
/**
|
|
1218
|
+
* - Denotes if the account is of self delivery type.
|
|
1219
|
+
*/
|
|
1220
|
+
is_self_ship: boolean;
|
|
1221
|
+
/**
|
|
1222
|
+
* - Denotes whether the courier account is in enabled
|
|
1223
|
+
* or disabled stage.
|
|
1224
|
+
*/
|
|
1225
|
+
stage: string;
|
|
1226
|
+
/**
|
|
1227
|
+
* - Denotes whether it is the seller's own
|
|
1228
|
+
* account or not.
|
|
1229
|
+
*/
|
|
1230
|
+
is_own_account: boolean;
|
|
1231
|
+
};
|
|
1232
|
+
/** @returns {CourierPartnerAccountFailureResult} */
|
|
1233
|
+
declare function CourierPartnerAccountFailureResult(): CourierPartnerAccountFailureResult;
|
|
1234
|
+
type CourierPartnerAccountFailureResult = {
|
|
1235
|
+
success: boolean;
|
|
1236
|
+
error: ErrorResult[];
|
|
1237
|
+
};
|
|
1238
|
+
/** @returns {CompanyCourierPartnerAccountListResult} */
|
|
1239
|
+
declare function CompanyCourierPartnerAccountListResult(): CompanyCourierPartnerAccountListResult;
|
|
1240
|
+
type CompanyCourierPartnerAccountListResult = {
|
|
1241
|
+
items: CourierAccountResult[];
|
|
1242
|
+
page: Page;
|
|
1243
|
+
};
|
|
1244
|
+
/** @returns {CourierAccountResult} */
|
|
1245
|
+
declare function CourierAccountResult(): CourierAccountResult;
|
|
1246
|
+
type CourierAccountResult = {
|
|
1247
|
+
/**
|
|
1248
|
+
* - Unique identifier of courier partner scheme
|
|
1249
|
+
* and company id combination.
|
|
1250
|
+
*/
|
|
1251
|
+
account_id: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* - Unique identifier of courier partner scheme.
|
|
1254
|
+
*/
|
|
1255
|
+
scheme_id: string;
|
|
1256
|
+
is_self_ship: boolean;
|
|
1257
|
+
/**
|
|
1258
|
+
* - Denotes whether the courier account is in enabled
|
|
1259
|
+
* or disabled stage.
|
|
1260
|
+
*/
|
|
1261
|
+
stage: string;
|
|
1262
|
+
/**
|
|
1263
|
+
* - Denotes whether it is the seller's own
|
|
1264
|
+
* account or not.
|
|
1265
|
+
*/
|
|
1266
|
+
is_own_account: boolean;
|
|
1267
|
+
scheme_rules: CourierPartnerSchemeModel;
|
|
1268
|
+
};
|
|
1269
|
+
/** @returns {CourierPartnerSchemeModel} */
|
|
1270
|
+
declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
|
|
1271
|
+
type CourierPartnerSchemeModel = {
|
|
1272
|
+
/**
|
|
1273
|
+
* - Unique identifier of courier partner extension.
|
|
1274
|
+
*/
|
|
1275
|
+
extension_id: string;
|
|
1276
|
+
/**
|
|
1277
|
+
* - Unique identifier of courier partner scheme.
|
|
1278
|
+
*/
|
|
1279
|
+
scheme_id: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* - Name of the scheme
|
|
1282
|
+
*/
|
|
1283
|
+
name: string;
|
|
1284
|
+
weight: ArithmeticOperations;
|
|
1285
|
+
/**
|
|
1286
|
+
* - Mode of transport associated with the
|
|
1287
|
+
* courier partner scheme.
|
|
1288
|
+
*/
|
|
1289
|
+
transport_type: string;
|
|
1290
|
+
/**
|
|
1291
|
+
* - Serviceable region associated with the courier
|
|
1292
|
+
* partner scheme.
|
|
1293
|
+
*/
|
|
1294
|
+
region: string;
|
|
1295
|
+
/**
|
|
1296
|
+
* - Type of delivery associated with the
|
|
1297
|
+
* courier partner scheme.
|
|
1298
|
+
*/
|
|
1299
|
+
delivery_type: string;
|
|
1300
|
+
/**
|
|
1301
|
+
* - Mode of payment associated with the
|
|
1302
|
+
* courier partner scheme.
|
|
1303
|
+
*/
|
|
1304
|
+
payment_mode: string[];
|
|
1305
|
+
/**
|
|
1306
|
+
* - Indicates if the courier partner scheme is
|
|
1307
|
+
* currently active or inactive.
|
|
1308
|
+
*/
|
|
1309
|
+
stage: string;
|
|
1310
|
+
feature: CourierPartnerSchemeFeatures;
|
|
1311
|
+
};
|
|
1312
|
+
/** @returns {CourierPartnerSchemeDetailsModel} */
|
|
1313
|
+
declare function CourierPartnerSchemeDetailsModel(): CourierPartnerSchemeDetailsModel;
|
|
1314
|
+
type CourierPartnerSchemeDetailsModel = {
|
|
1315
|
+
/**
|
|
1316
|
+
* - Unique identifier of courier partner extension.
|
|
1317
|
+
*/
|
|
1318
|
+
extension_id: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* - Unique identifier of courier partner scheme.
|
|
1321
|
+
*/
|
|
1322
|
+
scheme_id?: string;
|
|
1323
|
+
/**
|
|
1324
|
+
* - Name of the courier partner scheme.
|
|
1325
|
+
*/
|
|
1326
|
+
name: string;
|
|
1327
|
+
weight: ArithmeticOperations;
|
|
1328
|
+
/**
|
|
1329
|
+
* - Mode of transport associated with the
|
|
1330
|
+
* courier partner scheme.
|
|
1331
|
+
*/
|
|
1332
|
+
transport_type: string;
|
|
1333
|
+
/**
|
|
1334
|
+
* - Serviceable region associated with the courier
|
|
1335
|
+
* partner scheme.
|
|
1336
|
+
*/
|
|
1337
|
+
region: string;
|
|
1338
|
+
/**
|
|
1339
|
+
* - Type of delivery associated with the
|
|
1340
|
+
* courier partner scheme.
|
|
1341
|
+
*/
|
|
1342
|
+
delivery_type: string;
|
|
1343
|
+
/**
|
|
1344
|
+
* - Mode of payment associated with the
|
|
1345
|
+
* courier partner scheme.
|
|
1346
|
+
*/
|
|
1347
|
+
payment_mode: string[];
|
|
1348
|
+
/**
|
|
1349
|
+
* - Indicates if the courier partner scheme is
|
|
1350
|
+
* currently active or inactive.
|
|
1351
|
+
*/
|
|
1352
|
+
stage: string;
|
|
1353
|
+
feature: CourierPartnerSchemeFeatures;
|
|
1354
|
+
};
|
|
1355
|
+
/** @returns {CourierPartnerSchemeFeatures} */
|
|
1356
|
+
declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
|
|
1357
|
+
type CourierPartnerSchemeFeatures = {
|
|
1358
|
+
/**
|
|
1359
|
+
* - Indicates if the courier partner offers
|
|
1360
|
+
* doorstep quality check services.
|
|
1361
|
+
*/
|
|
1362
|
+
doorstep_qc?: boolean;
|
|
1363
|
+
/**
|
|
1364
|
+
* - Specifies whether the courier partner supports QR
|
|
1365
|
+
* code-based operations.
|
|
1366
|
+
*/
|
|
1367
|
+
qr?: boolean;
|
|
1368
|
+
/**
|
|
1369
|
+
* - Denotes if the courier partner supports
|
|
1370
|
+
* multi-part shipment services.
|
|
1371
|
+
*/
|
|
1372
|
+
mps?: boolean;
|
|
1373
|
+
/**
|
|
1374
|
+
* - Indicates if the Non-Delivery Report (NDR)
|
|
1375
|
+
* feature is supported by the courier partner.
|
|
1376
|
+
*/
|
|
1377
|
+
ndr?: boolean;
|
|
1378
|
+
/**
|
|
1379
|
+
* - Number of attempts allowed for resolving
|
|
1380
|
+
* Non-Delivery Reports (NDR).
|
|
1381
|
+
*/
|
|
1382
|
+
ndr_attempts?: number;
|
|
1383
|
+
/**
|
|
1384
|
+
* - Specifies if the courier partner
|
|
1385
|
+
* handles the transportation of dangerous goods.
|
|
1386
|
+
*/
|
|
1387
|
+
dangerous_goods?: boolean;
|
|
1388
|
+
/**
|
|
1389
|
+
* - Indicates whether the courier partner
|
|
1390
|
+
* manages the shipment of fragile goods.
|
|
1391
|
+
*/
|
|
1392
|
+
fragile_goods?: boolean;
|
|
1393
|
+
/**
|
|
1394
|
+
* - Indicates if the courier partner
|
|
1395
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
1396
|
+
*/
|
|
1397
|
+
restricted_goods?: boolean;
|
|
1398
|
+
/**
|
|
1399
|
+
* - Denotes if the courier partner
|
|
1400
|
+
* provides cold storage facilities for goods.
|
|
1401
|
+
*/
|
|
1402
|
+
cold_storage_goods?: boolean;
|
|
1403
|
+
/**
|
|
1404
|
+
* - Indicates if the courier partner
|
|
1405
|
+
* supports doorstep exchange services.
|
|
1406
|
+
*/
|
|
1407
|
+
doorstep_exchange?: boolean;
|
|
1408
|
+
/**
|
|
1409
|
+
* - Specifies if the courier partner
|
|
1410
|
+
* offers doorstep return services.
|
|
1411
|
+
*/
|
|
1412
|
+
doorstep_return?: boolean;
|
|
1413
|
+
/**
|
|
1414
|
+
* - Indicates if the courier partner
|
|
1415
|
+
* provides product installation services upon delivery.
|
|
1416
|
+
*/
|
|
1417
|
+
product_installation?: boolean;
|
|
1418
|
+
/**
|
|
1419
|
+
* - Specifies whether the courier
|
|
1420
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
1421
|
+
* before accepting.
|
|
1422
|
+
*/
|
|
1423
|
+
openbox_delivery?: boolean;
|
|
1424
|
+
/**
|
|
1425
|
+
* - Describes the type of status updates
|
|
1426
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1427
|
+
*/
|
|
1428
|
+
status_updates?: string;
|
|
1429
|
+
/**
|
|
1430
|
+
* - Indicates if the courier
|
|
1431
|
+
* partner supports multiple pickups to a single drop location.
|
|
1432
|
+
*/
|
|
1433
|
+
multi_pick_single_drop?: boolean;
|
|
1434
|
+
/**
|
|
1435
|
+
* - Indicates whether the courier
|
|
1436
|
+
* partner supports single pickup to multiple drop locations.
|
|
1437
|
+
*/
|
|
1438
|
+
single_pick_multi_drop?: boolean;
|
|
1439
|
+
/**
|
|
1440
|
+
* - Denotes if the courier partner
|
|
1441
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
1442
|
+
*/
|
|
1443
|
+
multi_pick_multi_drop?: boolean;
|
|
1444
|
+
/**
|
|
1445
|
+
* - Specifies if the courier partner requires or
|
|
1446
|
+
* supports the generation of e-waybills for shipments.
|
|
1447
|
+
*/
|
|
1448
|
+
ewaybill?: boolean;
|
|
1449
|
+
/**
|
|
1450
|
+
* - Defines the maximum quantity
|
|
1451
|
+
* of items allowed in a quality check shipment.
|
|
1452
|
+
*/
|
|
1453
|
+
qc_shipment_item_quantity?: number;
|
|
1454
|
+
/**
|
|
1455
|
+
* - Defines the maximum
|
|
1456
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1457
|
+
*/
|
|
1458
|
+
non_qc_shipment_item_quantity?: number;
|
|
1459
|
+
};
|
|
1460
|
+
/** @returns {CourierPartnerSchemeV2Features} */
|
|
1461
|
+
declare function CourierPartnerSchemeV2Features(): CourierPartnerSchemeV2Features;
|
|
1462
|
+
type CourierPartnerSchemeV2Features = {
|
|
1463
|
+
/**
|
|
1464
|
+
* - Indicates if the courier partner offers
|
|
1465
|
+
* doorstep quality check services.
|
|
1466
|
+
*/
|
|
1467
|
+
doorstep_qc?: boolean;
|
|
1468
|
+
/**
|
|
1469
|
+
* - Specifies whether the courier partner supports QR
|
|
1470
|
+
* code-based operations.
|
|
1471
|
+
*/
|
|
1472
|
+
qr?: boolean;
|
|
1473
|
+
/**
|
|
1474
|
+
* - Denotes if the courier partner supports
|
|
1475
|
+
* multi-part shipment services.
|
|
1476
|
+
*/
|
|
1477
|
+
mps?: boolean;
|
|
1478
|
+
/**
|
|
1479
|
+
* - Indicates if the Non-Delivery Report (NDR)
|
|
1480
|
+
* feature is supported by the courier partner.
|
|
1481
|
+
*/
|
|
1482
|
+
ndr?: boolean;
|
|
1483
|
+
/**
|
|
1484
|
+
* - Specifies if the courier partner
|
|
1485
|
+
* handles the transportation of dangerous goods.
|
|
1486
|
+
*/
|
|
1487
|
+
dangerous_goods?: boolean;
|
|
1488
|
+
/**
|
|
1489
|
+
* - Indicates whether the courier partner
|
|
1490
|
+
* manages the shipment of fragile goods.
|
|
1491
|
+
*/
|
|
1492
|
+
fragile_goods?: boolean;
|
|
1493
|
+
/**
|
|
1494
|
+
* - Indicates if the courier partner
|
|
1495
|
+
* handles restricted goods, as per regulatory guidelines.
|
|
1496
|
+
*/
|
|
1497
|
+
restricted_goods?: boolean;
|
|
1498
|
+
/**
|
|
1499
|
+
* - Denotes if the courier partner
|
|
1500
|
+
* provides cold storage facilities for goods.
|
|
1501
|
+
*/
|
|
1502
|
+
cold_storage_goods?: boolean;
|
|
1503
|
+
/**
|
|
1504
|
+
* - Indicates if the courier partner
|
|
1505
|
+
* supports doorstep exchange services.
|
|
1506
|
+
*/
|
|
1507
|
+
doorstep_exchange?: boolean;
|
|
1508
|
+
/**
|
|
1509
|
+
* - Specifies if the courier partner
|
|
1510
|
+
* offers doorstep return services.
|
|
1511
|
+
*/
|
|
1512
|
+
doorstep_return?: boolean;
|
|
1513
|
+
/**
|
|
1514
|
+
* - Indicates if the courier partner
|
|
1515
|
+
* provides product installation services upon delivery.
|
|
1516
|
+
*/
|
|
1517
|
+
product_installation?: boolean;
|
|
1518
|
+
/**
|
|
1519
|
+
* - Specifies whether the courier
|
|
1520
|
+
* partner supports open-box delivery, allowing customers to inspect goods
|
|
1521
|
+
* before accepting.
|
|
1522
|
+
*/
|
|
1523
|
+
openbox_delivery?: boolean;
|
|
1524
|
+
/**
|
|
1525
|
+
* - Indicates if the courier
|
|
1526
|
+
* partner supports multiple pickups to a single drop location.
|
|
1527
|
+
*/
|
|
1528
|
+
multi_pick_single_drop?: boolean;
|
|
1529
|
+
/**
|
|
1530
|
+
* - Indicates whether the courier
|
|
1531
|
+
* partner supports single pickup to multiple drop locations.
|
|
1532
|
+
*/
|
|
1533
|
+
single_pick_multi_drop?: boolean;
|
|
1534
|
+
/**
|
|
1535
|
+
* - Denotes if the courier partner
|
|
1536
|
+
* offers services for multiple pickups to multiple drop locations.
|
|
1537
|
+
*/
|
|
1538
|
+
multi_pick_multi_drop?: boolean;
|
|
1539
|
+
/**
|
|
1540
|
+
* - Specifies if the courier partner requires or
|
|
1541
|
+
* supports the generation of e-waybills for shipments.
|
|
1542
|
+
*/
|
|
1543
|
+
ewaybill?: boolean;
|
|
1544
|
+
};
|
|
1545
|
+
/** @returns {CourierPartnerSchemeV2DetailsModel} */
|
|
1546
|
+
declare function CourierPartnerSchemeV2DetailsModel(): CourierPartnerSchemeV2DetailsModel;
|
|
1547
|
+
type CourierPartnerSchemeV2DetailsModel = {
|
|
1548
|
+
/**
|
|
1549
|
+
* - Unique identifier of courier partner extension.
|
|
1550
|
+
*/
|
|
1551
|
+
extension_id: string;
|
|
1552
|
+
/**
|
|
1553
|
+
* - Unique identifier of courier partner scheme.
|
|
1554
|
+
*/
|
|
1555
|
+
scheme_id?: string;
|
|
1556
|
+
/**
|
|
1557
|
+
* - Name of the scheme.
|
|
1558
|
+
*/
|
|
1559
|
+
name: string;
|
|
1560
|
+
weight: ArithmeticOperations;
|
|
1561
|
+
volumetric_weight?: ArithmeticOperations;
|
|
1562
|
+
/**
|
|
1563
|
+
* - Mode of transport associated with the
|
|
1564
|
+
* courier partner scheme.
|
|
1565
|
+
*/
|
|
1566
|
+
transport_type: string;
|
|
1567
|
+
/**
|
|
1568
|
+
* - Serviceable region associated with the courier
|
|
1569
|
+
* partner scheme.
|
|
1570
|
+
*/
|
|
1571
|
+
region: string;
|
|
1572
|
+
/**
|
|
1573
|
+
* - Type of delivery associated with the
|
|
1574
|
+
* courier partner scheme.
|
|
1575
|
+
*/
|
|
1576
|
+
delivery_type: string;
|
|
1577
|
+
/**
|
|
1578
|
+
* - Mode of payment associated with the
|
|
1579
|
+
* courier partner scheme.
|
|
1580
|
+
*/
|
|
1581
|
+
payment_mode: string[];
|
|
1582
|
+
/**
|
|
1583
|
+
* - Indicates if the courier partner scheme is
|
|
1584
|
+
* currently active or inactive.
|
|
1585
|
+
*/
|
|
1586
|
+
stage: string;
|
|
1587
|
+
/**
|
|
1588
|
+
* - Describes the type of status updates
|
|
1589
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1590
|
+
*/
|
|
1591
|
+
status_updates?: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* - Indicates if the Non-Delivery Report
|
|
1594
|
+
* (NDR) feature is supported by the courier partner.
|
|
1595
|
+
*/
|
|
1596
|
+
ndr_attempts?: number;
|
|
1597
|
+
/**
|
|
1598
|
+
* - Defines the maximum quantity
|
|
1599
|
+
* of items allowed in a quality check shipment.
|
|
1600
|
+
*/
|
|
1601
|
+
qc_shipment_item_quantity?: number;
|
|
1602
|
+
/**
|
|
1603
|
+
* - Defines the maximum
|
|
1604
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1605
|
+
*/
|
|
1606
|
+
non_qc_shipment_item_quantity?: number;
|
|
1607
|
+
feature: CourierPartnerSchemeV2Features;
|
|
1608
|
+
};
|
|
1609
|
+
/** @returns {CourierPartnerV2SchemeModel} */
|
|
1610
|
+
declare function CourierPartnerV2SchemeModel(): CourierPartnerV2SchemeModel;
|
|
1611
|
+
type CourierPartnerV2SchemeModel = {
|
|
1612
|
+
/**
|
|
1613
|
+
* - Unique identifier of courier partner extension.
|
|
1614
|
+
*/
|
|
1615
|
+
extension_id: string;
|
|
1616
|
+
/**
|
|
1617
|
+
* - Unique identifier of courier partner scheme.
|
|
1618
|
+
*/
|
|
1619
|
+
scheme_id: string;
|
|
1620
|
+
/**
|
|
1621
|
+
* - Unique identifier of company.
|
|
1622
|
+
*/
|
|
1623
|
+
company_id?: string;
|
|
1624
|
+
/**
|
|
1625
|
+
* - Name of the scheme.
|
|
1626
|
+
*/
|
|
1627
|
+
name: string;
|
|
1628
|
+
weight: ArithmeticOperations;
|
|
1629
|
+
volumetric_weight?: ArithmeticOperations;
|
|
1630
|
+
/**
|
|
1631
|
+
* - Mode of transport associated with the
|
|
1632
|
+
* courier partner scheme.
|
|
1633
|
+
*/
|
|
1634
|
+
transport_type: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* - Serviceable region associated with the courier
|
|
1637
|
+
* partner scheme.
|
|
1638
|
+
*/
|
|
1639
|
+
region: string;
|
|
1640
|
+
/**
|
|
1641
|
+
* - Type of delivery associated with the
|
|
1642
|
+
* courier partner scheme.
|
|
1643
|
+
*/
|
|
1644
|
+
delivery_type: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* - Mode of payment associated with the
|
|
1647
|
+
* courier partner scheme.
|
|
1648
|
+
*/
|
|
1649
|
+
payment_mode: string[];
|
|
1650
|
+
/**
|
|
1651
|
+
* - Indicates if the courier partner scheme is
|
|
1652
|
+
* currently active or inactive.
|
|
1653
|
+
*/
|
|
1654
|
+
stage: string;
|
|
1655
|
+
/**
|
|
1656
|
+
* - Describes the type of status updates
|
|
1657
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1658
|
+
*/
|
|
1659
|
+
status_updates?: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* - Indicates if the Non-Delivery Report
|
|
1662
|
+
* (NDR) feature is supported by the courier partner.
|
|
1663
|
+
*/
|
|
1664
|
+
ndr_attempts?: number;
|
|
1665
|
+
/**
|
|
1666
|
+
* - Defines the maximum quantity
|
|
1667
|
+
* of items allowed in a quality check shipment.
|
|
1668
|
+
*/
|
|
1669
|
+
qc_shipment_item_quantity?: number;
|
|
1670
|
+
/**
|
|
1671
|
+
* - Defines the maximum
|
|
1672
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1673
|
+
*/
|
|
1674
|
+
non_qc_shipment_item_quantity?: number;
|
|
1675
|
+
feature: CourierPartnerSchemeV2Features;
|
|
1676
|
+
};
|
|
1677
|
+
/** @returns {courierPartnerSchemeV2List} */
|
|
1678
|
+
declare function courierPartnerSchemeV2List(): courierPartnerSchemeV2List;
|
|
1679
|
+
type courierPartnerSchemeV2List = {
|
|
1680
|
+
/**
|
|
1681
|
+
* - List of courier partner schemes
|
|
1682
|
+
*/
|
|
1683
|
+
items: CourierPartnerV2SchemeModel[];
|
|
1684
|
+
page: Page;
|
|
1685
|
+
};
|
|
1686
|
+
/** @returns {ArithmeticOperations} */
|
|
393
1687
|
declare function ArithmeticOperations(): ArithmeticOperations;
|
|
394
1688
|
type ArithmeticOperations = {
|
|
395
1689
|
lt?: number;
|
|
@@ -397,17 +1691,61 @@ type ArithmeticOperations = {
|
|
|
397
1691
|
lte?: number;
|
|
398
1692
|
gte?: number;
|
|
399
1693
|
};
|
|
400
|
-
/** @returns {
|
|
401
|
-
declare function
|
|
402
|
-
type
|
|
1694
|
+
/** @returns {CourierPartnerSchemeV2UpdateDetails} */
|
|
1695
|
+
declare function CourierPartnerSchemeV2UpdateDetails(): CourierPartnerSchemeV2UpdateDetails;
|
|
1696
|
+
type CourierPartnerSchemeV2UpdateDetails = {
|
|
1697
|
+
/**
|
|
1698
|
+
* - Name of the scheme.
|
|
1699
|
+
*/
|
|
403
1700
|
name: string;
|
|
404
1701
|
weight: ArithmeticOperations;
|
|
1702
|
+
volumetric_weight?: ArithmeticOperations;
|
|
1703
|
+
/**
|
|
1704
|
+
* - Mode of transport associated with the
|
|
1705
|
+
* courier partner scheme.
|
|
1706
|
+
*/
|
|
405
1707
|
transport_type: string;
|
|
1708
|
+
/**
|
|
1709
|
+
* - Serviceable region associated with the courier
|
|
1710
|
+
* partner scheme.
|
|
1711
|
+
*/
|
|
406
1712
|
region: string;
|
|
1713
|
+
/**
|
|
1714
|
+
* - Type of delivery associated with the
|
|
1715
|
+
* courier partner scheme.
|
|
1716
|
+
*/
|
|
407
1717
|
delivery_type: string;
|
|
1718
|
+
/**
|
|
1719
|
+
* - Mode of payment associated with the
|
|
1720
|
+
* courier partner scheme.
|
|
1721
|
+
*/
|
|
408
1722
|
payment_mode: string[];
|
|
1723
|
+
/**
|
|
1724
|
+
* - Indicates if the courier partner scheme is
|
|
1725
|
+
* currently active or inactive.
|
|
1726
|
+
*/
|
|
409
1727
|
stage: string;
|
|
410
|
-
|
|
1728
|
+
/**
|
|
1729
|
+
* - Describes the type of status updates
|
|
1730
|
+
* provided by the courier partner (e.g., real-time, periodic).
|
|
1731
|
+
*/
|
|
1732
|
+
status_updates?: string;
|
|
1733
|
+
/**
|
|
1734
|
+
* - Indicates if the Non-Delivery Report
|
|
1735
|
+
* (NDR) feature is supported by the courier partner.
|
|
1736
|
+
*/
|
|
1737
|
+
ndr_attempts?: number;
|
|
1738
|
+
/**
|
|
1739
|
+
* - Defines the maximum quantity
|
|
1740
|
+
* of items allowed in a quality check shipment.
|
|
1741
|
+
*/
|
|
1742
|
+
qc_shipment_item_quantity?: number;
|
|
1743
|
+
/**
|
|
1744
|
+
* - Defines the maximum
|
|
1745
|
+
* quantity of items allowed in a non-quality check shipment.
|
|
1746
|
+
*/
|
|
1747
|
+
non_qc_shipment_item_quantity?: number;
|
|
1748
|
+
feature: CourierPartnerSchemeV2Features;
|
|
411
1749
|
};
|
|
412
1750
|
/** @returns {GetCountries} */
|
|
413
1751
|
declare function GetCountries(): GetCountries;
|
|
@@ -418,22 +1756,97 @@ type GetCountries = {
|
|
|
418
1756
|
/** @returns {GetCountriesItems} */
|
|
419
1757
|
declare function GetCountriesItems(): GetCountriesItems;
|
|
420
1758
|
type GetCountriesItems = {
|
|
1759
|
+
/**
|
|
1760
|
+
* - Unique identifier of the country.
|
|
1761
|
+
*/
|
|
421
1762
|
id?: string;
|
|
1763
|
+
/**
|
|
1764
|
+
* - Name of the country.
|
|
1765
|
+
*/
|
|
422
1766
|
name?: string;
|
|
1767
|
+
/**
|
|
1768
|
+
* - Two-letter ISO code representing the country.
|
|
1769
|
+
*/
|
|
423
1770
|
iso2?: string;
|
|
1771
|
+
/**
|
|
1772
|
+
* - Three-letter ISO code representing the country.
|
|
1773
|
+
*/
|
|
424
1774
|
iso3?: string;
|
|
1775
|
+
/**
|
|
1776
|
+
* - List of time zones used in the country
|
|
1777
|
+
* (e.g., ["America/New_York", "America/Los_Angeles"]).
|
|
1778
|
+
*/
|
|
425
1779
|
timezones?: string[];
|
|
1780
|
+
/**
|
|
1781
|
+
* - Levels within the country (e.g.,
|
|
1782
|
+
* states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
|
|
1783
|
+
* {"name": "City", "slug": "city"}]).
|
|
1784
|
+
*/
|
|
426
1785
|
hierarchy?: HierarchyItems[];
|
|
1786
|
+
/**
|
|
1787
|
+
* - International dialing code for the country
|
|
1788
|
+
* (e.g., "+1").
|
|
1789
|
+
*/
|
|
427
1790
|
phone_code?: string;
|
|
1791
|
+
/**
|
|
1792
|
+
* - Indicates currency for the country (e.g., "INR").
|
|
1793
|
+
*/
|
|
428
1794
|
currency?: string;
|
|
1795
|
+
/**
|
|
1796
|
+
* - Indicates the type of object (e.g., "country").
|
|
1797
|
+
*/
|
|
429
1798
|
type?: string;
|
|
1799
|
+
/**
|
|
1800
|
+
* - Geographical latitude of the country (e.g., "37.0902").
|
|
1801
|
+
*/
|
|
430
1802
|
latitude?: string;
|
|
1803
|
+
/**
|
|
1804
|
+
* - Geographical longitude of the country (e.g.,
|
|
1805
|
+
* "-95.7129").
|
|
1806
|
+
*/
|
|
431
1807
|
longitude?: string;
|
|
1808
|
+
/**
|
|
1809
|
+
* - User-friendly version of the geographical
|
|
1810
|
+
* data, which may be more descriptive or formatted differently.
|
|
1811
|
+
*/
|
|
432
1812
|
display_name?: string;
|
|
1813
|
+
/**
|
|
1814
|
+
* - More detailed hierarchical data is
|
|
1815
|
+
* available, meaning states, cities, or other regions within the country have
|
|
1816
|
+
* been populated in the system.
|
|
1817
|
+
*/
|
|
1818
|
+
has_next_hierarchy?: boolean;
|
|
433
1819
|
};
|
|
434
1820
|
/** @returns {HierarchyItems} */
|
|
435
1821
|
declare function HierarchyItems(): HierarchyItems;
|
|
436
1822
|
type HierarchyItems = {
|
|
1823
|
+
/**
|
|
1824
|
+
* - It represent a country display name.
|
|
1825
|
+
*/
|
|
437
1826
|
display_name?: string;
|
|
1827
|
+
/**
|
|
1828
|
+
* - A URL-friendly version of the name, often used
|
|
1829
|
+
* for referencing or querying purposes.
|
|
1830
|
+
*/
|
|
438
1831
|
slug?: string;
|
|
439
1832
|
};
|
|
1833
|
+
/** @returns {ValidationError} */
|
|
1834
|
+
declare function ValidationError(): ValidationError;
|
|
1835
|
+
type ValidationError = {
|
|
1836
|
+
/**
|
|
1837
|
+
* - A brief description of the error encountered.
|
|
1838
|
+
*/
|
|
1839
|
+
message: string;
|
|
1840
|
+
/**
|
|
1841
|
+
* - The field in the request that caused the error.
|
|
1842
|
+
*/
|
|
1843
|
+
field: string;
|
|
1844
|
+
};
|
|
1845
|
+
/** @returns {StandardError} */
|
|
1846
|
+
declare function StandardError(): StandardError;
|
|
1847
|
+
type StandardError = {
|
|
1848
|
+
/**
|
|
1849
|
+
* - A brief description of the error.
|
|
1850
|
+
*/
|
|
1851
|
+
message: string;
|
|
1852
|
+
};
|