@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +53 -60
- package/sdk/application/Cart/CartApplicationClient.js +53 -130
- package/sdk/application/Cart/CartApplicationModel.d.ts +143 -489
- package/sdk/application/Cart/CartApplicationModel.js +159 -380
- package/sdk/application/Cart/CartApplicationValidator.d.ts +19 -38
- package/sdk/application/Cart/CartApplicationValidator.js +18 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +68 -88
- package/sdk/application/Catalog/CatalogApplicationClient.js +94 -114
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +142 -194
- package/sdk/application/Catalog/CatalogApplicationModel.js +133 -171
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -3
- package/sdk/application/Common/CommonApplicationClient.js +5 -6
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +57 -45
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +47 -35
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +33 -23
- package/sdk/application/Content/ContentApplicationClient.js +75 -54
- package/sdk/application/Content/ContentApplicationModel.d.ts +37 -93
- package/sdk/application/Content/ContentApplicationModel.js +32 -83
- package/sdk/application/Content/ContentApplicationValidator.d.ts +17 -23
- package/sdk/application/Content/ContentApplicationValidator.js +10 -15
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +13 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +25 -23
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +18 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -2
- package/sdk/application/Lead/LeadApplicationClient.js +3 -2
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +21 -189
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +173 -532
- package/sdk/application/Logistic/LogisticApplicationModel.js +139 -409
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +9 -54
- package/sdk/application/Logistic/LogisticApplicationValidator.js +8 -42
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -24
- package/sdk/application/Order/OrderApplicationClient.js +13 -96
- package/sdk/application/Order/OrderApplicationModel.d.ts +120 -436
- package/sdk/application/Order/OrderApplicationModel.js +81 -279
- package/sdk/application/Order/OrderApplicationValidator.d.ts +3 -17
- package/sdk/application/Order/OrderApplicationValidator.js +2 -15
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +99 -96
- package/sdk/application/Payment/PaymentApplicationClient.js +114 -111
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +289 -293
- package/sdk/application/Payment/PaymentApplicationModel.js +241 -243
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +22 -19
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
- package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
- package/sdk/application/Share/ShareApplicationModel.js +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +6 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +17 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +22 -42
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +3 -16
- package/sdk/application/Theme/ThemeApplicationValidator.js +2 -9
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +10 -10
- package/sdk/application/User/UserApplicationModel.d.ts +17 -17
- package/sdk/application/User/UserApplicationModel.js +16 -16
- package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
- package/sdk/application/User/UserApplicationValidator.js +2 -2
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +9 -11
- package/sdk/application/Webhook/WebhookApplicationModel.js +6 -8
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +0 -1
- package/sdk/application/index.js +0 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- 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 +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1304 -4979
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1922
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
- package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1751 -1501
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1224 -1393
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +124 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +94 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- 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 +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +4 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -83
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -25
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -16
- package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -178
- package/sdk/platform/Order/OrderPlatformClient.js +245 -597
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3071 -5449
- package/sdk/platform/Order/OrderPlatformModel.js +1656 -3501
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +190 -237
- package/sdk/platform/Order/OrderPlatformValidator.js +105 -153
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
- package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +35 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +341 -602
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +284 -483
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- 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 +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +5 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- 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/Finance/FinanceApplicationClient.d.ts +0 -36
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
- package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
- package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
export = LogisticApplicationModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {
|
|
3
|
+
* @typedef GetStoreResponse
|
|
4
|
+
* @property {StoreItemResponse[]} [items] - List of locations, each containing
|
|
5
5
|
* detailed information about individual location.
|
|
6
6
|
* @property {Page} [page]
|
|
7
7
|
*/
|
|
8
8
|
/**
|
|
9
|
-
* @typedef
|
|
9
|
+
* @typedef StoreItemResponse
|
|
10
10
|
* @property {number} [id] - A unique identifier for the location.
|
|
11
11
|
* @property {string} [store_type] - The type of store, indicating the nature of
|
|
12
12
|
* the store, such as retail or warehouse.
|
|
@@ -24,7 +24,7 @@ export = LogisticApplicationModel;
|
|
|
24
24
|
* store location.
|
|
25
25
|
*/
|
|
26
26
|
/**
|
|
27
|
-
* @typedef
|
|
27
|
+
* @typedef ValidateAddressRequest
|
|
28
28
|
* @property {string} [address] - Complete address, combining address line 1,
|
|
29
29
|
* address line 2, area, landmark, sector, city, state, and pincode.
|
|
30
30
|
* @property {string} [address1] - First line of the address, typically
|
|
@@ -44,7 +44,7 @@ export = LogisticApplicationModel;
|
|
|
44
44
|
* @property {string} [email] - Recipient's email address.
|
|
45
45
|
*/
|
|
46
46
|
/**
|
|
47
|
-
* @typedef
|
|
47
|
+
* @typedef PincodeParentsResponse
|
|
48
48
|
* @property {string} [sub_type] - Specific type of locality hierarchy the
|
|
49
49
|
* pincode belongs to (e.g., city, state, country).
|
|
50
50
|
* @property {string} [display_name] - User-friendly version of the geographical
|
|
@@ -55,7 +55,7 @@ export = LogisticApplicationModel;
|
|
|
55
55
|
* @property {string} [uid] - Unique identifier for the locality.
|
|
56
56
|
*/
|
|
57
57
|
/**
|
|
58
|
-
* @typedef
|
|
58
|
+
* @typedef PincodeMetaResponse
|
|
59
59
|
* @property {string} [zone] - Geographical region to which the pincode belongs,
|
|
60
60
|
* often used to categorize or group pincodes for regional management or
|
|
61
61
|
* postal purposes.
|
|
@@ -63,7 +63,7 @@ export = LogisticApplicationModel;
|
|
|
63
63
|
* system to track or reference the specific zone associated with the pincode.
|
|
64
64
|
*/
|
|
65
65
|
/**
|
|
66
|
-
* @typedef
|
|
66
|
+
* @typedef PincodeErrorSchemaResponse
|
|
67
67
|
* @property {string} [message] - A user-readable description of the error,
|
|
68
68
|
* explaining what went wrong.
|
|
69
69
|
* @property {string} [value] - A specific code or identifier related to the
|
|
@@ -72,7 +72,7 @@ export = LogisticApplicationModel;
|
|
|
72
72
|
* kind of issue.
|
|
73
73
|
*/
|
|
74
74
|
/**
|
|
75
|
-
* @typedef
|
|
75
|
+
* @typedef CountryMetaResponse
|
|
76
76
|
* @property {string} [country_code] - The ISO 3166-1 alpha-2 code representing
|
|
77
77
|
* the country (e.g., "IN" for India, "US" for the United States).
|
|
78
78
|
* @property {string} [isd_code] - The International Subscriber Dialing (ISD)
|
|
@@ -88,15 +88,15 @@ export = LogisticApplicationModel;
|
|
|
88
88
|
* with two values: [longitude, latitude].
|
|
89
89
|
*/
|
|
90
90
|
/**
|
|
91
|
-
* @typedef
|
|
92
|
-
* @property {
|
|
93
|
-
* collection of geographical locations, each associated with specific
|
|
91
|
+
* @typedef PincodeDataResponse
|
|
92
|
+
* @property {PincodeParentsResponse[]} [parents] - List of object representing
|
|
93
|
+
* a collection of geographical locations, each associated with specific
|
|
94
94
|
* hierarchical data such as cities, states, or countries.
|
|
95
|
-
* @property {
|
|
95
|
+
* @property {PincodeMetaResponse} [meta]
|
|
96
96
|
* @property {string} [display_name] - User-friendly version of the geographical
|
|
97
97
|
* data, which may be more descriptive or formatted differently.
|
|
98
|
-
* @property {
|
|
99
|
-
* @property {
|
|
98
|
+
* @property {PincodeErrorSchemaResponse} error
|
|
99
|
+
* @property {CountryMetaResponse} [meta_code]
|
|
100
100
|
* @property {PincodeLatLongData} [lat_long]
|
|
101
101
|
* @property {string} [sub_type] - Indicates the specific type of locality
|
|
102
102
|
* hierarchy the pincode belongs to (e.g., city, state, country).
|
|
@@ -107,40 +107,40 @@ export = LogisticApplicationModel;
|
|
|
107
107
|
* unique value assigned to each instance to ensure differentiation and reference.
|
|
108
108
|
*/
|
|
109
109
|
/**
|
|
110
|
-
* @typedef
|
|
110
|
+
* @typedef PincodeApiResponse
|
|
111
111
|
* @property {boolean} success - Indicates whether the API request was
|
|
112
112
|
* successful (true) or failed (false).
|
|
113
|
-
* @property {
|
|
113
|
+
* @property {PincodeDataResponse[]} [data] - Contains the actual response data
|
|
114
114
|
* when the request is successful, providing details like pincode information
|
|
115
115
|
* or related data.
|
|
116
|
-
* @property {
|
|
116
|
+
* @property {PincodeErrorSchemaResponse} error
|
|
117
117
|
*/
|
|
118
118
|
/**
|
|
119
|
-
* @typedef
|
|
119
|
+
* @typedef TATCategoryRequest
|
|
120
120
|
* @property {string} [level] - Specifies the hierarchical level of the category
|
|
121
121
|
* (e.g., country, state, city).
|
|
122
122
|
* @property {number} [id] - Represents the unique identifier for the category
|
|
123
123
|
* at the specified level.
|
|
124
124
|
*/
|
|
125
125
|
/**
|
|
126
|
-
* @typedef
|
|
127
|
-
* @property {
|
|
126
|
+
* @typedef TATArticlesRequest
|
|
127
|
+
* @property {TATCategoryRequest} [category]
|
|
128
128
|
* @property {string} [manufacturing_time_unit] - The unit of measurement for
|
|
129
129
|
* the manufacturing time, such as hours or days.
|
|
130
130
|
* @property {number} [manufacturing_time] - The amount of time required to
|
|
131
131
|
* manufacture the article, specified in the unit given by `manufacturing_time_unit`.
|
|
132
132
|
*/
|
|
133
133
|
/**
|
|
134
|
-
* @typedef
|
|
134
|
+
* @typedef TATLocationDetailsRequest
|
|
135
135
|
* @property {number} [fulfillment_id] - A unique identifier of the fulfilling location.
|
|
136
136
|
* @property {string} [from_pincode] - The postal code of the location from
|
|
137
137
|
* which the fulfillment originates.
|
|
138
|
-
* @property {
|
|
138
|
+
* @property {TATArticlesRequest[]} [articles] - List of articles included in
|
|
139
139
|
* the fulfillment request, which provides details about the items to be
|
|
140
140
|
* processed or shipped.
|
|
141
141
|
*/
|
|
142
142
|
/**
|
|
143
|
-
* @typedef
|
|
143
|
+
* @typedef TATViewRequest
|
|
144
144
|
* @property {string} [to_pincode] - The postal code of the destination location
|
|
145
145
|
* where the fulfillment or shipment is headed.
|
|
146
146
|
* @property {string} [source] - The origin or source of the request, indicating
|
|
@@ -149,14 +149,14 @@ export = LogisticApplicationModel;
|
|
|
149
149
|
* such as viewing, updating, or managing data.
|
|
150
150
|
* @property {string} [identifier] - A unique ID used to reference or track the
|
|
151
151
|
* specific request or item within the system.
|
|
152
|
-
* @property {
|
|
152
|
+
* @property {TATLocationDetailsRequest[]} [location_details] - Locations
|
|
153
153
|
* involved in the request, including details about both the source and destination.
|
|
154
154
|
* @property {string} [journey] - Indicates the direction of the request or
|
|
155
155
|
* shipment. It can either be "forward" (from the source to the destination)
|
|
156
156
|
* or "return" (from the destination back to the source).
|
|
157
157
|
*/
|
|
158
158
|
/**
|
|
159
|
-
* @typedef
|
|
159
|
+
* @typedef TATErrorSchemaResponse
|
|
160
160
|
* @property {string} [message] - A user-readable description of the error,
|
|
161
161
|
* explaining what went wrong.
|
|
162
162
|
* @property {string} [value] - A specific code or identifier related to the
|
|
@@ -165,51 +165,51 @@ export = LogisticApplicationModel;
|
|
|
165
165
|
* kind of issue.
|
|
166
166
|
*/
|
|
167
167
|
/**
|
|
168
|
-
* @typedef
|
|
168
|
+
* @typedef TATTimestampResponse
|
|
169
169
|
* @property {number} [min] - The earliest possible timestamp.
|
|
170
170
|
* @property {number} [max] - The latest possible timestamp.
|
|
171
171
|
*/
|
|
172
172
|
/**
|
|
173
|
-
* @typedef
|
|
173
|
+
* @typedef TATFormattedResponse
|
|
174
174
|
* @property {string} [min] - The earliest possible timestamp.
|
|
175
175
|
* @property {string} [max] - The latest possible timestamp.
|
|
176
176
|
*/
|
|
177
177
|
/**
|
|
178
|
-
* @typedef
|
|
179
|
-
* @property {
|
|
180
|
-
* @property {
|
|
178
|
+
* @typedef TATPromiseResponse
|
|
179
|
+
* @property {TATTimestampResponse} [timestamp]
|
|
180
|
+
* @property {TATFormattedResponse} [formatted]
|
|
181
181
|
*/
|
|
182
182
|
/**
|
|
183
|
-
* @typedef
|
|
183
|
+
* @typedef TATArticlesResponse
|
|
184
184
|
* @property {string} [manufacturing_time_unit] - The unit of measurement for
|
|
185
185
|
* the manufacturing time such as hours or days.
|
|
186
|
-
* @property {
|
|
186
|
+
* @property {TATErrorSchemaResponse} [error]
|
|
187
187
|
* @property {boolean} [is_cod_available] - Indicates whether Cash on Delivery
|
|
188
188
|
* (COD) is available for the articles.
|
|
189
|
-
* @property {
|
|
189
|
+
* @property {TATPromiseResponse} [promise]
|
|
190
190
|
* @property {number} [manufacturing_time] - The time required to manufacture
|
|
191
191
|
* the articles, measured in the unit specified by manufacturing_time_unit.
|
|
192
|
-
* @property {
|
|
192
|
+
* @property {TATCategoryRequest} [category]
|
|
193
193
|
* @property {number} [_manufacturing_time_seconds] - The manufacturing time
|
|
194
194
|
* converted into seconds.
|
|
195
195
|
*/
|
|
196
196
|
/**
|
|
197
|
-
* @typedef
|
|
197
|
+
* @typedef TATLocationDetailsResponse
|
|
198
198
|
* @property {number} [fulfillment_id] - A unique identifier of the fulfilling location.
|
|
199
199
|
* @property {string} [from_pincode] - The postal code of the location from
|
|
200
200
|
* which the fulfillment originates.
|
|
201
|
-
* @property {
|
|
202
|
-
* fulfillment request, which provides details about the items to be
|
|
203
|
-
* or shipped.
|
|
201
|
+
* @property {TATArticlesResponse[]} [articles] - List of articles included in
|
|
202
|
+
* the fulfillment request, which provides details about the items to be
|
|
203
|
+
* processed or shipped.
|
|
204
204
|
*/
|
|
205
205
|
/**
|
|
206
|
-
* @typedef
|
|
206
|
+
* @typedef TATViewResponse
|
|
207
207
|
* @property {string} [to_pincode] - The postal code of the destination location
|
|
208
208
|
* where the fulfillment or shipment is headed.
|
|
209
209
|
* @property {string} [request_uuid] - A unique identifier for the request.
|
|
210
210
|
* @property {string} [payment_mode] - The mode of payment used for the transaction.
|
|
211
211
|
* @property {boolean} [success] - Whether the request was successful (true/false).
|
|
212
|
-
* @property {
|
|
212
|
+
* @property {TATErrorSchemaResponse} [error]
|
|
213
213
|
* @property {boolean} [is_cod_available] - Whether Cash on Delivery (COD) is
|
|
214
214
|
* available for the request.
|
|
215
215
|
* @property {string} [source] - The origin or source of the request.
|
|
@@ -219,8 +219,8 @@ export = LogisticApplicationModel;
|
|
|
219
219
|
* stormbreaker process.
|
|
220
220
|
* @property {string} [to_city] - The city corresponding to the destination pincode.
|
|
221
221
|
* @property {string} [identifier] - A unique identifier for the request or transaction.
|
|
222
|
-
* @property {
|
|
223
|
-
* in the request.
|
|
222
|
+
* @property {TATLocationDetailsResponse[]} [location_details] - Location
|
|
223
|
+
* involved in the request.
|
|
224
224
|
* @property {string} [journey] - Type of journey, either forward or return.
|
|
225
225
|
*/
|
|
226
226
|
/**
|
|
@@ -249,13 +249,14 @@ export = LogisticApplicationModel;
|
|
|
249
249
|
* delivering goods, such as road, rail, air, or sea.
|
|
250
250
|
*/
|
|
251
251
|
/**
|
|
252
|
-
* @typedef
|
|
253
|
-
* @property {
|
|
252
|
+
* @typedef LogisticsResponse
|
|
253
|
+
* @property {Object} [dp] - Provide entity responsible for handling the
|
|
254
|
+
* delivery of goods.
|
|
254
255
|
*/
|
|
255
256
|
/**
|
|
256
|
-
* @typedef
|
|
257
|
-
* @property {
|
|
258
|
-
* @property {
|
|
257
|
+
* @typedef CountryEntityResponse
|
|
258
|
+
* @property {CountryMetaResponse} [meta]
|
|
259
|
+
* @property {LogisticsResponse} [logistics]
|
|
259
260
|
* @property {string} [display_name] - User-friendly version of the geographical
|
|
260
261
|
* data, which may be more descriptive or formatted differently.
|
|
261
262
|
* @property {string} [type] - Specifies the type of geographical feature or
|
|
@@ -269,18 +270,18 @@ export = LogisticApplicationModel;
|
|
|
269
270
|
* @property {string} [uid] - Unique identifier for the country.
|
|
270
271
|
*/
|
|
271
272
|
/**
|
|
272
|
-
* @typedef
|
|
273
|
-
* @property {
|
|
273
|
+
* @typedef CountryListResponse
|
|
274
|
+
* @property {CountryEntityResponse[]} [results] - A list of country entities,
|
|
274
275
|
* each containing details about individual countries.
|
|
275
276
|
*/
|
|
276
277
|
/**
|
|
277
|
-
* @typedef
|
|
278
|
+
* @typedef GetZoneFromPincodeViewRequest
|
|
278
279
|
* @property {string} pincode - The postal code or ZIP code used to pinpoint a
|
|
279
280
|
* specific geographic area or location.
|
|
280
281
|
* @property {string} country - The country where the pincode is located.
|
|
281
282
|
*/
|
|
282
283
|
/**
|
|
283
|
-
* @typedef
|
|
284
|
+
* @typedef GetZoneFromPincodeViewResponse
|
|
284
285
|
* @property {string} serviceability_type - Specifies the type of serviceability
|
|
285
286
|
* for the given pincode, indicating whether it's deliverable or serviceable
|
|
286
287
|
* under certain conditions.
|
|
@@ -288,7 +289,7 @@ export = LogisticApplicationModel;
|
|
|
288
289
|
* detailing the geographical or logistical zones for service.
|
|
289
290
|
*/
|
|
290
291
|
/**
|
|
291
|
-
* @typedef
|
|
292
|
+
* @typedef ReAssignStoreRequest
|
|
292
293
|
* @property {Object} configuration - Specifies the configuration settings or
|
|
293
294
|
* parameters for the store reassignment.
|
|
294
295
|
* @property {string} to_pincode - The postal code of the destination location
|
|
@@ -300,7 +301,7 @@ export = LogisticApplicationModel;
|
|
|
300
301
|
* store reassignment.
|
|
301
302
|
*/
|
|
302
303
|
/**
|
|
303
|
-
* @typedef
|
|
304
|
+
* @typedef ReAssignStoreResponse
|
|
304
305
|
* @property {string} to_pincode - The postal code of the destination location
|
|
305
306
|
* where the fulfillment or shipment is headed.
|
|
306
307
|
* @property {string} pystormbreaker_uuid - A unique identifier for tracking the
|
|
@@ -473,7 +474,6 @@ export = LogisticApplicationModel;
|
|
|
473
474
|
* @property {string} [name] - The actual geographical data, such as country
|
|
474
475
|
* names (India), state names (Maharashtra), pin codes (400603), city names
|
|
475
476
|
* (Dubai), or local sectors (Deira).
|
|
476
|
-
* @property {Object} [custom_meta] - Custom meta to store custom json against hierarchy.
|
|
477
477
|
* @property {string} [display_name] - User-friendly version of the geographical
|
|
478
478
|
* data, which may be more descriptive or formatted differently.
|
|
479
479
|
* @property {string[]} [parent_ids] - Identifiers for the parent of the current locality.
|
|
@@ -492,9 +492,6 @@ export = LogisticApplicationModel;
|
|
|
492
492
|
* (Dubai), or local sectors (Deira).
|
|
493
493
|
* @property {string} [display_name] - User-friendly version of the geographical
|
|
494
494
|
* data, which may be more descriptive or formatted differently.
|
|
495
|
-
* @property {string} [code] - Code assigned to a locality, which is unique to
|
|
496
|
-
* its immediate parent.
|
|
497
|
-
* @property {Object} [custom_meta] - Custom meta to store custom json against hierarchy.
|
|
498
495
|
* @property {string[]} [parent_ids] - Identifiers for the parent of the current locality.
|
|
499
496
|
* @property {string} [type] - Specifies the category of the address component,
|
|
500
497
|
* such as pincode, state, city, country, or sector.
|
|
@@ -513,9 +510,6 @@ export = LogisticApplicationModel;
|
|
|
513
510
|
* (Dubai), or local sectors (Deira).
|
|
514
511
|
* @property {string} [display_name] - User-friendly version of the geographical
|
|
515
512
|
* data, which may be more descriptive or formatted differently.
|
|
516
|
-
* @property {string} [code] - Code assigned to a locality, which is unique to
|
|
517
|
-
* its immediate parent.
|
|
518
|
-
* @property {Object} [custom_meta] - Custom meta to store custom json against hierarchy.
|
|
519
513
|
* @property {string[]} [parent_ids] - Identifiers for the parent of the current locality.
|
|
520
514
|
* @property {string} [type] - Specifies the category of the address component,
|
|
521
515
|
* such as pincode, state, city, country, or sector.
|
|
@@ -525,125 +519,28 @@ export = LogisticApplicationModel;
|
|
|
525
519
|
* identifiers, and hierarchical relationships.
|
|
526
520
|
*/
|
|
527
521
|
/**
|
|
528
|
-
* @typedef
|
|
529
|
-
* @property {number} [item_id] - Unique identifier of the item.
|
|
530
|
-
* @property {number} [category_id] - Unique identifier of the category.
|
|
531
|
-
* @property {number} [brand_id] - Unique identifier of the brand.
|
|
532
|
-
* @property {number} [department_id] - Unique identifier of the department.
|
|
533
|
-
* @property {string[]} [tags] - Tags associated with the item.
|
|
534
|
-
*/
|
|
535
|
-
/**
|
|
536
|
-
* @typedef ShipmentDimension
|
|
537
|
-
* @property {number} height - Height of the shipment in centimeters.
|
|
538
|
-
* @property {number} length - Length of the shipment in centimeters.
|
|
539
|
-
* @property {number} width - Width of the shipment in centimeters.
|
|
540
|
-
*/
|
|
541
|
-
/**
|
|
542
|
-
* @typedef Shipments
|
|
543
|
-
* @property {string} [id] - Unique identifier of the shipment.
|
|
544
|
-
* @property {number} [location_id] - Unique identifier of the selling location.
|
|
545
|
-
* @property {string[]} [location_tags] - Tags associated with the selling location.
|
|
546
|
-
* @property {number} [shipment_weight] - Weight of the shipment.
|
|
547
|
-
* @property {number} [shipment_volumetric_weight] - Volumetric weight of the shipment.
|
|
548
|
-
* @property {number} [shipment_cost] - Total Cost of the shipment.
|
|
549
|
-
* @property {ShipmentDimension} [shipment_dimension]
|
|
550
|
-
* @property {string[]} [courier_partner_schemes] - A List of courier schemes.
|
|
551
|
-
* @property {ShipmentsArticles[]} [articles] - List of articles in the shipment.
|
|
552
|
-
*/
|
|
553
|
-
/**
|
|
554
|
-
* @typedef ShipmentCourierPartnerDetails
|
|
555
|
-
* @property {ShipmentsCourierPartnersServiceability} from_location
|
|
556
|
-
* @property {ShipmentsCourierPartnersServiceability} to_location
|
|
557
|
-
* @property {Shipments[]} [shipments] - List of shipments.
|
|
558
|
-
* @property {string} [journey] - Journey type of the shipment forward or return.
|
|
559
|
-
* @property {string} [payment_mode] - Payment mode opted for the shipment.
|
|
560
|
-
*/
|
|
561
|
-
/**
|
|
562
|
-
* @typedef CourierPartnerPromise
|
|
563
|
-
* @property {string} min - The earliest possible timestamp.
|
|
564
|
-
* @property {string} max - The latest possible timestamp.
|
|
565
|
-
*/
|
|
566
|
-
/**
|
|
567
|
-
* @typedef CourierPartners
|
|
568
|
-
* @property {string} [extension_id] - Unique identifier of courier partner extension.
|
|
569
|
-
* @property {string} [scheme_id] - Unique identifier of courier partner scheme.
|
|
570
|
-
* @property {string} [name] - Name of the courier partner.
|
|
571
|
-
* @property {CourierPartnerPromise} [delivery_promise]
|
|
572
|
-
*/
|
|
573
|
-
/**
|
|
574
|
-
* @typedef ShipmentCourierPartners
|
|
575
|
-
* @property {string} [id] - Unique identifier of the shipment.
|
|
576
|
-
* @property {CourierPartners[]} [courier_partners] - Courier partners of the shipment.
|
|
577
|
-
*/
|
|
578
|
-
/**
|
|
579
|
-
* @typedef ShipmentCourierPartnerResult
|
|
580
|
-
* @property {CourierPartners[]} [courier_partners]
|
|
581
|
-
* @property {ShipmentCourierPartners[]} [shipments]
|
|
582
|
-
*/
|
|
583
|
-
/**
|
|
584
|
-
* @typedef ShipmentsCourierPartnersServiceability
|
|
585
|
-
* @property {string} [pincode] - Postal code or PIN code of the address area.
|
|
586
|
-
* @property {string} [sector_code] - Specifies the sector or district code of
|
|
587
|
-
* the address if applicable.
|
|
588
|
-
* @property {string} [state_code] - Indicates the state or province code of the address.
|
|
589
|
-
* @property {string} [city_code] - Denote the city or municipality code of the address.
|
|
590
|
-
* @property {string} country_code - ISO2 code for the country of the address.
|
|
591
|
-
*/
|
|
592
|
-
/**
|
|
593
|
-
* @typedef ServiceabilityLocation
|
|
594
|
-
* @property {string} longitude - Geographical longitude coordinate of the location.
|
|
595
|
-
* @property {string} latitude - Geographical latitude coordinate of the location.
|
|
596
|
-
*/
|
|
597
|
-
/**
|
|
598
|
-
* @typedef GetPromiseDetails
|
|
599
|
-
* @property {StorePromise[]} [items] - List of delivery promises for each store.
|
|
600
|
-
* @property {Promise} [delivery_promise]
|
|
601
|
-
* @property {Page} [page]
|
|
602
|
-
*/
|
|
603
|
-
/**
|
|
604
|
-
* @typedef StorePromise
|
|
605
|
-
* @property {number} [uid] - Unique identifier of a store.
|
|
606
|
-
* @property {string} [code] - Code assigned to a store.
|
|
607
|
-
* @property {string} [name] - Name of a store.
|
|
608
|
-
* @property {Promise} [delivery_promise]
|
|
609
|
-
*/
|
|
610
|
-
/**
|
|
611
|
-
* @typedef Promise
|
|
612
|
-
* @property {string} [min] - Earliest delivery time.
|
|
613
|
-
* @property {string} [max] - Latest delivery time.
|
|
614
|
-
*/
|
|
615
|
-
/**
|
|
616
|
-
* @typedef ErrorResult
|
|
522
|
+
* @typedef ErrorResponse
|
|
617
523
|
* @property {string} [error] - Error code identifying the type of error.
|
|
618
524
|
* @property {string} [message] - User-friendly explanation of what went wrong.
|
|
619
525
|
*/
|
|
620
|
-
/**
|
|
621
|
-
* @typedef ValidationError
|
|
622
|
-
* @property {string} message - A brief description of the error encountered.
|
|
623
|
-
* @property {string} field - The field in the request that caused the error.
|
|
624
|
-
*/
|
|
625
|
-
/**
|
|
626
|
-
* @typedef StandardError
|
|
627
|
-
* @property {string} message - A brief description of the error.
|
|
628
|
-
*/
|
|
629
526
|
declare class LogisticApplicationModel {
|
|
630
527
|
}
|
|
631
528
|
declare namespace LogisticApplicationModel {
|
|
632
|
-
export {
|
|
529
|
+
export { GetStoreResponse, StoreItemResponse, ValidateAddressRequest, PincodeParentsResponse, PincodeMetaResponse, PincodeErrorSchemaResponse, CountryMetaResponse, PincodeLatLongData, PincodeDataResponse, PincodeApiResponse, TATCategoryRequest, TATArticlesRequest, TATLocationDetailsRequest, TATViewRequest, TATErrorSchemaResponse, TATTimestampResponse, TATFormattedResponse, TATPromiseResponse, TATArticlesResponse, TATLocationDetailsResponse, TATViewResponse, DP, LogisticsResponse, CountryEntityResponse, CountryListResponse, GetZoneFromPincodeViewRequest, GetZoneFromPincodeViewResponse, ReAssignStoreRequest, ReAssignStoreResponse, CountryHierarchy, CurrencyObject, CountryObject, GetCountries, GetOneOrAllPath, GetOneOrAllQuery, GetOneOrAllParams, GetOneOrAll, LengthValidation, FieldValidationRegex, FieldValidation, GetCountryFieldsAddressValues, GetCountryFieldsAddress, GetCountryFieldsAddressTemplate, GetCountryFields, GetCountry, Page, Localities, LocalityParent, GetLocalities, GetLocality, ErrorResponse };
|
|
633
530
|
}
|
|
634
|
-
/** @returns {
|
|
635
|
-
declare function
|
|
636
|
-
type
|
|
531
|
+
/** @returns {GetStoreResponse} */
|
|
532
|
+
declare function GetStoreResponse(): GetStoreResponse;
|
|
533
|
+
type GetStoreResponse = {
|
|
637
534
|
/**
|
|
638
535
|
* - List of locations, each containing
|
|
639
536
|
* detailed information about individual location.
|
|
640
537
|
*/
|
|
641
|
-
items?:
|
|
538
|
+
items?: StoreItemResponse[];
|
|
642
539
|
page?: Page;
|
|
643
540
|
};
|
|
644
|
-
/** @returns {
|
|
645
|
-
declare function
|
|
646
|
-
type
|
|
541
|
+
/** @returns {StoreItemResponse} */
|
|
542
|
+
declare function StoreItemResponse(): StoreItemResponse;
|
|
543
|
+
type StoreItemResponse = {
|
|
647
544
|
/**
|
|
648
545
|
* - A unique identifier for the location.
|
|
649
546
|
*/
|
|
@@ -684,9 +581,9 @@ type StoreItemResult = {
|
|
|
684
581
|
*/
|
|
685
582
|
longitude?: number;
|
|
686
583
|
};
|
|
687
|
-
/** @returns {
|
|
688
|
-
declare function
|
|
689
|
-
type
|
|
584
|
+
/** @returns {ValidateAddressRequest} */
|
|
585
|
+
declare function ValidateAddressRequest(): ValidateAddressRequest;
|
|
586
|
+
type ValidateAddressRequest = {
|
|
690
587
|
/**
|
|
691
588
|
* - Complete address, combining address line 1,
|
|
692
589
|
* address line 2, area, landmark, sector, city, state, and pincode.
|
|
@@ -741,9 +638,9 @@ type ValidateAddressDetails = {
|
|
|
741
638
|
*/
|
|
742
639
|
email?: string;
|
|
743
640
|
};
|
|
744
|
-
/** @returns {
|
|
745
|
-
declare function
|
|
746
|
-
type
|
|
641
|
+
/** @returns {PincodeParentsResponse} */
|
|
642
|
+
declare function PincodeParentsResponse(): PincodeParentsResponse;
|
|
643
|
+
type PincodeParentsResponse = {
|
|
747
644
|
/**
|
|
748
645
|
* - Specific type of locality hierarchy the
|
|
749
646
|
* pincode belongs to (e.g., city, state, country).
|
|
@@ -765,9 +662,9 @@ type PincodeParentsResult = {
|
|
|
765
662
|
*/
|
|
766
663
|
uid?: string;
|
|
767
664
|
};
|
|
768
|
-
/** @returns {
|
|
769
|
-
declare function
|
|
770
|
-
type
|
|
665
|
+
/** @returns {PincodeMetaResponse} */
|
|
666
|
+
declare function PincodeMetaResponse(): PincodeMetaResponse;
|
|
667
|
+
type PincodeMetaResponse = {
|
|
771
668
|
/**
|
|
772
669
|
* - Geographical region to which the pincode belongs,
|
|
773
670
|
* often used to categorize or group pincodes for regional management or
|
|
@@ -780,9 +677,9 @@ type PincodeMetaResult = {
|
|
|
780
677
|
*/
|
|
781
678
|
internal_zone_id?: number;
|
|
782
679
|
};
|
|
783
|
-
/** @returns {
|
|
784
|
-
declare function
|
|
785
|
-
type
|
|
680
|
+
/** @returns {PincodeErrorSchemaResponse} */
|
|
681
|
+
declare function PincodeErrorSchemaResponse(): PincodeErrorSchemaResponse;
|
|
682
|
+
type PincodeErrorSchemaResponse = {
|
|
786
683
|
/**
|
|
787
684
|
* - A user-readable description of the error,
|
|
788
685
|
* explaining what went wrong.
|
|
@@ -799,9 +696,9 @@ type PincodeErrorSchemaResult = {
|
|
|
799
696
|
*/
|
|
800
697
|
type?: string;
|
|
801
698
|
};
|
|
802
|
-
/** @returns {
|
|
803
|
-
declare function
|
|
804
|
-
type
|
|
699
|
+
/** @returns {CountryMetaResponse} */
|
|
700
|
+
declare function CountryMetaResponse(): CountryMetaResponse;
|
|
701
|
+
type CountryMetaResponse = {
|
|
805
702
|
/**
|
|
806
703
|
* - The ISO 3166-1 alpha-2 code representing
|
|
807
704
|
* the country (e.g., "IN" for India, "US" for the United States).
|
|
@@ -829,23 +726,23 @@ type PincodeLatLongData = {
|
|
|
829
726
|
*/
|
|
830
727
|
coordinates?: string[];
|
|
831
728
|
};
|
|
832
|
-
/** @returns {
|
|
833
|
-
declare function
|
|
834
|
-
type
|
|
729
|
+
/** @returns {PincodeDataResponse} */
|
|
730
|
+
declare function PincodeDataResponse(): PincodeDataResponse;
|
|
731
|
+
type PincodeDataResponse = {
|
|
835
732
|
/**
|
|
836
|
-
* - List of object representing
|
|
837
|
-
* collection of geographical locations, each associated with specific
|
|
733
|
+
* - List of object representing
|
|
734
|
+
* a collection of geographical locations, each associated with specific
|
|
838
735
|
* hierarchical data such as cities, states, or countries.
|
|
839
736
|
*/
|
|
840
|
-
parents?:
|
|
841
|
-
meta?:
|
|
737
|
+
parents?: PincodeParentsResponse[];
|
|
738
|
+
meta?: PincodeMetaResponse;
|
|
842
739
|
/**
|
|
843
740
|
* - User-friendly version of the geographical
|
|
844
741
|
* data, which may be more descriptive or formatted differently.
|
|
845
742
|
*/
|
|
846
743
|
display_name?: string;
|
|
847
|
-
error:
|
|
848
|
-
meta_code?:
|
|
744
|
+
error: PincodeErrorSchemaResponse;
|
|
745
|
+
meta_code?: CountryMetaResponse;
|
|
849
746
|
lat_long?: PincodeLatLongData;
|
|
850
747
|
/**
|
|
851
748
|
* - Indicates the specific type of locality
|
|
@@ -864,9 +761,9 @@ type PincodeDataResult = {
|
|
|
864
761
|
*/
|
|
865
762
|
uid?: string;
|
|
866
763
|
};
|
|
867
|
-
/** @returns {
|
|
868
|
-
declare function
|
|
869
|
-
type
|
|
764
|
+
/** @returns {PincodeApiResponse} */
|
|
765
|
+
declare function PincodeApiResponse(): PincodeApiResponse;
|
|
766
|
+
type PincodeApiResponse = {
|
|
870
767
|
/**
|
|
871
768
|
* - Indicates whether the API request was
|
|
872
769
|
* successful (true) or failed (false).
|
|
@@ -877,12 +774,12 @@ type PincodeDetails = {
|
|
|
877
774
|
* when the request is successful, providing details like pincode information
|
|
878
775
|
* or related data.
|
|
879
776
|
*/
|
|
880
|
-
data?:
|
|
881
|
-
error:
|
|
777
|
+
data?: PincodeDataResponse[];
|
|
778
|
+
error: PincodeErrorSchemaResponse;
|
|
882
779
|
};
|
|
883
|
-
/** @returns {
|
|
884
|
-
declare function
|
|
885
|
-
type
|
|
780
|
+
/** @returns {TATCategoryRequest} */
|
|
781
|
+
declare function TATCategoryRequest(): TATCategoryRequest;
|
|
782
|
+
type TATCategoryRequest = {
|
|
886
783
|
/**
|
|
887
784
|
* - Specifies the hierarchical level of the category
|
|
888
785
|
* (e.g., country, state, city).
|
|
@@ -894,10 +791,10 @@ type TATCategoryDetails = {
|
|
|
894
791
|
*/
|
|
895
792
|
id?: number;
|
|
896
793
|
};
|
|
897
|
-
/** @returns {
|
|
898
|
-
declare function
|
|
899
|
-
type
|
|
900
|
-
category?:
|
|
794
|
+
/** @returns {TATArticlesRequest} */
|
|
795
|
+
declare function TATArticlesRequest(): TATArticlesRequest;
|
|
796
|
+
type TATArticlesRequest = {
|
|
797
|
+
category?: TATCategoryRequest;
|
|
901
798
|
/**
|
|
902
799
|
* - The unit of measurement for
|
|
903
800
|
* the manufacturing time, such as hours or days.
|
|
@@ -909,9 +806,9 @@ type TATArticlesDetails = {
|
|
|
909
806
|
*/
|
|
910
807
|
manufacturing_time?: number;
|
|
911
808
|
};
|
|
912
|
-
/** @returns {
|
|
913
|
-
declare function
|
|
914
|
-
type
|
|
809
|
+
/** @returns {TATLocationDetailsRequest} */
|
|
810
|
+
declare function TATLocationDetailsRequest(): TATLocationDetailsRequest;
|
|
811
|
+
type TATLocationDetailsRequest = {
|
|
915
812
|
/**
|
|
916
813
|
* - A unique identifier of the fulfilling location.
|
|
917
814
|
*/
|
|
@@ -926,11 +823,11 @@ type TATLocationDetailsDetails = {
|
|
|
926
823
|
* the fulfillment request, which provides details about the items to be
|
|
927
824
|
* processed or shipped.
|
|
928
825
|
*/
|
|
929
|
-
articles?:
|
|
826
|
+
articles?: TATArticlesRequest[];
|
|
930
827
|
};
|
|
931
|
-
/** @returns {
|
|
932
|
-
declare function
|
|
933
|
-
type
|
|
828
|
+
/** @returns {TATViewRequest} */
|
|
829
|
+
declare function TATViewRequest(): TATViewRequest;
|
|
830
|
+
type TATViewRequest = {
|
|
934
831
|
/**
|
|
935
832
|
* - The postal code of the destination location
|
|
936
833
|
* where the fulfillment or shipment is headed.
|
|
@@ -955,7 +852,7 @@ type TATViewDetails = {
|
|
|
955
852
|
* - Locations
|
|
956
853
|
* involved in the request, including details about both the source and destination.
|
|
957
854
|
*/
|
|
958
|
-
location_details?:
|
|
855
|
+
location_details?: TATLocationDetailsRequest[];
|
|
959
856
|
/**
|
|
960
857
|
* - Indicates the direction of the request or
|
|
961
858
|
* shipment. It can either be "forward" (from the source to the destination)
|
|
@@ -963,9 +860,9 @@ type TATViewDetails = {
|
|
|
963
860
|
*/
|
|
964
861
|
journey?: string;
|
|
965
862
|
};
|
|
966
|
-
/** @returns {
|
|
967
|
-
declare function
|
|
968
|
-
type
|
|
863
|
+
/** @returns {TATErrorSchemaResponse} */
|
|
864
|
+
declare function TATErrorSchemaResponse(): TATErrorSchemaResponse;
|
|
865
|
+
type TATErrorSchemaResponse = {
|
|
969
866
|
/**
|
|
970
867
|
* - A user-readable description of the error,
|
|
971
868
|
* explaining what went wrong.
|
|
@@ -982,9 +879,9 @@ type TATErrorSchemaResult = {
|
|
|
982
879
|
*/
|
|
983
880
|
type?: string;
|
|
984
881
|
};
|
|
985
|
-
/** @returns {
|
|
986
|
-
declare function
|
|
987
|
-
type
|
|
882
|
+
/** @returns {TATTimestampResponse} */
|
|
883
|
+
declare function TATTimestampResponse(): TATTimestampResponse;
|
|
884
|
+
type TATTimestampResponse = {
|
|
988
885
|
/**
|
|
989
886
|
* - The earliest possible timestamp.
|
|
990
887
|
*/
|
|
@@ -994,9 +891,9 @@ type TATTimestampResult = {
|
|
|
994
891
|
*/
|
|
995
892
|
max?: number;
|
|
996
893
|
};
|
|
997
|
-
/** @returns {
|
|
998
|
-
declare function
|
|
999
|
-
type
|
|
894
|
+
/** @returns {TATFormattedResponse} */
|
|
895
|
+
declare function TATFormattedResponse(): TATFormattedResponse;
|
|
896
|
+
type TATFormattedResponse = {
|
|
1000
897
|
/**
|
|
1001
898
|
* - The earliest possible timestamp.
|
|
1002
899
|
*/
|
|
@@ -1006,42 +903,42 @@ type TATFormattedResult = {
|
|
|
1006
903
|
*/
|
|
1007
904
|
max?: string;
|
|
1008
905
|
};
|
|
1009
|
-
/** @returns {
|
|
1010
|
-
declare function
|
|
1011
|
-
type
|
|
1012
|
-
timestamp?:
|
|
1013
|
-
formatted?:
|
|
906
|
+
/** @returns {TATPromiseResponse} */
|
|
907
|
+
declare function TATPromiseResponse(): TATPromiseResponse;
|
|
908
|
+
type TATPromiseResponse = {
|
|
909
|
+
timestamp?: TATTimestampResponse;
|
|
910
|
+
formatted?: TATFormattedResponse;
|
|
1014
911
|
};
|
|
1015
|
-
/** @returns {
|
|
1016
|
-
declare function
|
|
1017
|
-
type
|
|
912
|
+
/** @returns {TATArticlesResponse} */
|
|
913
|
+
declare function TATArticlesResponse(): TATArticlesResponse;
|
|
914
|
+
type TATArticlesResponse = {
|
|
1018
915
|
/**
|
|
1019
916
|
* - The unit of measurement for
|
|
1020
917
|
* the manufacturing time such as hours or days.
|
|
1021
918
|
*/
|
|
1022
919
|
manufacturing_time_unit?: string;
|
|
1023
|
-
error?:
|
|
920
|
+
error?: TATErrorSchemaResponse;
|
|
1024
921
|
/**
|
|
1025
922
|
* - Indicates whether Cash on Delivery
|
|
1026
923
|
* (COD) is available for the articles.
|
|
1027
924
|
*/
|
|
1028
925
|
is_cod_available?: boolean;
|
|
1029
|
-
promise?:
|
|
926
|
+
promise?: TATPromiseResponse;
|
|
1030
927
|
/**
|
|
1031
928
|
* - The time required to manufacture
|
|
1032
929
|
* the articles, measured in the unit specified by manufacturing_time_unit.
|
|
1033
930
|
*/
|
|
1034
931
|
manufacturing_time?: number;
|
|
1035
|
-
category?:
|
|
932
|
+
category?: TATCategoryRequest;
|
|
1036
933
|
/**
|
|
1037
934
|
* - The manufacturing time
|
|
1038
935
|
* converted into seconds.
|
|
1039
936
|
*/
|
|
1040
937
|
_manufacturing_time_seconds?: number;
|
|
1041
938
|
};
|
|
1042
|
-
/** @returns {
|
|
1043
|
-
declare function
|
|
1044
|
-
type
|
|
939
|
+
/** @returns {TATLocationDetailsResponse} */
|
|
940
|
+
declare function TATLocationDetailsResponse(): TATLocationDetailsResponse;
|
|
941
|
+
type TATLocationDetailsResponse = {
|
|
1045
942
|
/**
|
|
1046
943
|
* - A unique identifier of the fulfilling location.
|
|
1047
944
|
*/
|
|
@@ -1052,15 +949,15 @@ type TATLocationDetailsResult = {
|
|
|
1052
949
|
*/
|
|
1053
950
|
from_pincode?: string;
|
|
1054
951
|
/**
|
|
1055
|
-
* - List of articles included in
|
|
1056
|
-
* fulfillment request, which provides details about the items to be
|
|
1057
|
-
* or shipped.
|
|
952
|
+
* - List of articles included in
|
|
953
|
+
* the fulfillment request, which provides details about the items to be
|
|
954
|
+
* processed or shipped.
|
|
1058
955
|
*/
|
|
1059
|
-
articles?:
|
|
956
|
+
articles?: TATArticlesResponse[];
|
|
1060
957
|
};
|
|
1061
|
-
/** @returns {
|
|
1062
|
-
declare function
|
|
1063
|
-
type
|
|
958
|
+
/** @returns {TATViewResponse} */
|
|
959
|
+
declare function TATViewResponse(): TATViewResponse;
|
|
960
|
+
type TATViewResponse = {
|
|
1064
961
|
/**
|
|
1065
962
|
* - The postal code of the destination location
|
|
1066
963
|
* where the fulfillment or shipment is headed.
|
|
@@ -1078,7 +975,7 @@ type TATViewResult = {
|
|
|
1078
975
|
* - Whether the request was successful (true/false).
|
|
1079
976
|
*/
|
|
1080
977
|
success?: boolean;
|
|
1081
|
-
error?:
|
|
978
|
+
error?: TATErrorSchemaResponse;
|
|
1082
979
|
/**
|
|
1083
980
|
* - Whether Cash on Delivery (COD) is
|
|
1084
981
|
* available for the request.
|
|
@@ -1107,10 +1004,10 @@ type TATViewResult = {
|
|
|
1107
1004
|
*/
|
|
1108
1005
|
identifier?: string;
|
|
1109
1006
|
/**
|
|
1110
|
-
* - Location
|
|
1111
|
-
* in the request.
|
|
1007
|
+
* - Location
|
|
1008
|
+
* involved in the request.
|
|
1112
1009
|
*/
|
|
1113
|
-
location_details?:
|
|
1010
|
+
location_details?: TATLocationDetailsResponse[];
|
|
1114
1011
|
/**
|
|
1115
1012
|
* - Type of journey, either forward or return.
|
|
1116
1013
|
*/
|
|
@@ -1172,16 +1069,20 @@ type DP = {
|
|
|
1172
1069
|
*/
|
|
1173
1070
|
transport_mode?: string;
|
|
1174
1071
|
};
|
|
1175
|
-
/** @returns {
|
|
1176
|
-
declare function
|
|
1177
|
-
type
|
|
1178
|
-
|
|
1072
|
+
/** @returns {LogisticsResponse} */
|
|
1073
|
+
declare function LogisticsResponse(): LogisticsResponse;
|
|
1074
|
+
type LogisticsResponse = {
|
|
1075
|
+
/**
|
|
1076
|
+
* - Provide entity responsible for handling the
|
|
1077
|
+
* delivery of goods.
|
|
1078
|
+
*/
|
|
1079
|
+
dp?: any;
|
|
1179
1080
|
};
|
|
1180
|
-
/** @returns {
|
|
1181
|
-
declare function
|
|
1182
|
-
type
|
|
1183
|
-
meta?:
|
|
1184
|
-
logistics?:
|
|
1081
|
+
/** @returns {CountryEntityResponse} */
|
|
1082
|
+
declare function CountryEntityResponse(): CountryEntityResponse;
|
|
1083
|
+
type CountryEntityResponse = {
|
|
1084
|
+
meta?: CountryMetaResponse;
|
|
1085
|
+
logistics?: LogisticsResponse;
|
|
1185
1086
|
/**
|
|
1186
1087
|
* - User-friendly version of the geographical
|
|
1187
1088
|
* data, which may be more descriptive or formatted differently.
|
|
@@ -1215,18 +1116,18 @@ type CountryEntityResult = {
|
|
|
1215
1116
|
*/
|
|
1216
1117
|
uid?: string;
|
|
1217
1118
|
};
|
|
1218
|
-
/** @returns {
|
|
1219
|
-
declare function
|
|
1220
|
-
type
|
|
1119
|
+
/** @returns {CountryListResponse} */
|
|
1120
|
+
declare function CountryListResponse(): CountryListResponse;
|
|
1121
|
+
type CountryListResponse = {
|
|
1221
1122
|
/**
|
|
1222
1123
|
* - A list of country entities,
|
|
1223
1124
|
* each containing details about individual countries.
|
|
1224
1125
|
*/
|
|
1225
|
-
results?:
|
|
1126
|
+
results?: CountryEntityResponse[];
|
|
1226
1127
|
};
|
|
1227
|
-
/** @returns {
|
|
1228
|
-
declare function
|
|
1229
|
-
type
|
|
1128
|
+
/** @returns {GetZoneFromPincodeViewRequest} */
|
|
1129
|
+
declare function GetZoneFromPincodeViewRequest(): GetZoneFromPincodeViewRequest;
|
|
1130
|
+
type GetZoneFromPincodeViewRequest = {
|
|
1230
1131
|
/**
|
|
1231
1132
|
* - The postal code or ZIP code used to pinpoint a
|
|
1232
1133
|
* specific geographic area or location.
|
|
@@ -1237,9 +1138,9 @@ type GetZoneFromPincodeViewDetails = {
|
|
|
1237
1138
|
*/
|
|
1238
1139
|
country: string;
|
|
1239
1140
|
};
|
|
1240
|
-
/** @returns {
|
|
1241
|
-
declare function
|
|
1242
|
-
type
|
|
1141
|
+
/** @returns {GetZoneFromPincodeViewResponse} */
|
|
1142
|
+
declare function GetZoneFromPincodeViewResponse(): GetZoneFromPincodeViewResponse;
|
|
1143
|
+
type GetZoneFromPincodeViewResponse = {
|
|
1243
1144
|
/**
|
|
1244
1145
|
* - Specifies the type of serviceability
|
|
1245
1146
|
* for the given pincode, indicating whether it's deliverable or serviceable
|
|
@@ -1252,9 +1153,9 @@ type GetZoneFromPincodeViewResult = {
|
|
|
1252
1153
|
*/
|
|
1253
1154
|
zones: string[];
|
|
1254
1155
|
};
|
|
1255
|
-
/** @returns {
|
|
1256
|
-
declare function
|
|
1257
|
-
type
|
|
1156
|
+
/** @returns {ReAssignStoreRequest} */
|
|
1157
|
+
declare function ReAssignStoreRequest(): ReAssignStoreRequest;
|
|
1158
|
+
type ReAssignStoreRequest = {
|
|
1258
1159
|
/**
|
|
1259
1160
|
* - Specifies the configuration settings or
|
|
1260
1161
|
* parameters for the store reassignment.
|
|
@@ -1280,9 +1181,9 @@ type ReAssignStoreDetails = {
|
|
|
1280
1181
|
*/
|
|
1281
1182
|
articles: any[];
|
|
1282
1183
|
};
|
|
1283
|
-
/** @returns {
|
|
1284
|
-
declare function
|
|
1285
|
-
type
|
|
1184
|
+
/** @returns {ReAssignStoreResponse} */
|
|
1185
|
+
declare function ReAssignStoreResponse(): ReAssignStoreResponse;
|
|
1186
|
+
type ReAssignStoreResponse = {
|
|
1286
1187
|
/**
|
|
1287
1188
|
* - The postal code of the destination location
|
|
1288
1189
|
* where the fulfillment or shipment is headed.
|
|
@@ -1665,10 +1566,6 @@ type Localities = {
|
|
|
1665
1566
|
* (Dubai), or local sectors (Deira).
|
|
1666
1567
|
*/
|
|
1667
1568
|
name?: string;
|
|
1668
|
-
/**
|
|
1669
|
-
* - Custom meta to store custom json against hierarchy.
|
|
1670
|
-
*/
|
|
1671
|
-
custom_meta?: any;
|
|
1672
1569
|
/**
|
|
1673
1570
|
* - User-friendly version of the geographical
|
|
1674
1571
|
* data, which may be more descriptive or formatted differently.
|
|
@@ -1709,15 +1606,6 @@ type LocalityParent = {
|
|
|
1709
1606
|
* data, which may be more descriptive or formatted differently.
|
|
1710
1607
|
*/
|
|
1711
1608
|
display_name?: string;
|
|
1712
|
-
/**
|
|
1713
|
-
* - Code assigned to a locality, which is unique to
|
|
1714
|
-
* its immediate parent.
|
|
1715
|
-
*/
|
|
1716
|
-
code?: string;
|
|
1717
|
-
/**
|
|
1718
|
-
* - Custom meta to store custom json against hierarchy.
|
|
1719
|
-
*/
|
|
1720
|
-
custom_meta?: any;
|
|
1721
1609
|
/**
|
|
1722
1610
|
* - Identifiers for the parent of the current locality.
|
|
1723
1611
|
*/
|
|
@@ -1756,15 +1644,6 @@ type GetLocality = {
|
|
|
1756
1644
|
* data, which may be more descriptive or formatted differently.
|
|
1757
1645
|
*/
|
|
1758
1646
|
display_name?: string;
|
|
1759
|
-
/**
|
|
1760
|
-
* - Code assigned to a locality, which is unique to
|
|
1761
|
-
* its immediate parent.
|
|
1762
|
-
*/
|
|
1763
|
-
code?: string;
|
|
1764
|
-
/**
|
|
1765
|
-
* - Custom meta to store custom json against hierarchy.
|
|
1766
|
-
*/
|
|
1767
|
-
custom_meta?: any;
|
|
1768
1647
|
/**
|
|
1769
1648
|
* - Identifiers for the parent of the current locality.
|
|
1770
1649
|
*/
|
|
@@ -1782,227 +1661,9 @@ type GetLocality = {
|
|
|
1782
1661
|
*/
|
|
1783
1662
|
localities?: LocalityParent[];
|
|
1784
1663
|
};
|
|
1785
|
-
/** @returns {
|
|
1786
|
-
declare function
|
|
1787
|
-
type
|
|
1788
|
-
/**
|
|
1789
|
-
* - Unique identifier of the item.
|
|
1790
|
-
*/
|
|
1791
|
-
item_id?: number;
|
|
1792
|
-
/**
|
|
1793
|
-
* - Unique identifier of the category.
|
|
1794
|
-
*/
|
|
1795
|
-
category_id?: number;
|
|
1796
|
-
/**
|
|
1797
|
-
* - Unique identifier of the brand.
|
|
1798
|
-
*/
|
|
1799
|
-
brand_id?: number;
|
|
1800
|
-
/**
|
|
1801
|
-
* - Unique identifier of the department.
|
|
1802
|
-
*/
|
|
1803
|
-
department_id?: number;
|
|
1804
|
-
/**
|
|
1805
|
-
* - Tags associated with the item.
|
|
1806
|
-
*/
|
|
1807
|
-
tags?: string[];
|
|
1808
|
-
};
|
|
1809
|
-
/** @returns {ShipmentDimension} */
|
|
1810
|
-
declare function ShipmentDimension(): ShipmentDimension;
|
|
1811
|
-
type ShipmentDimension = {
|
|
1812
|
-
/**
|
|
1813
|
-
* - Height of the shipment in centimeters.
|
|
1814
|
-
*/
|
|
1815
|
-
height: number;
|
|
1816
|
-
/**
|
|
1817
|
-
* - Length of the shipment in centimeters.
|
|
1818
|
-
*/
|
|
1819
|
-
length: number;
|
|
1820
|
-
/**
|
|
1821
|
-
* - Width of the shipment in centimeters.
|
|
1822
|
-
*/
|
|
1823
|
-
width: number;
|
|
1824
|
-
};
|
|
1825
|
-
/** @returns {Shipments} */
|
|
1826
|
-
declare function Shipments(): Shipments;
|
|
1827
|
-
type Shipments = {
|
|
1828
|
-
/**
|
|
1829
|
-
* - Unique identifier of the shipment.
|
|
1830
|
-
*/
|
|
1831
|
-
id?: string;
|
|
1832
|
-
/**
|
|
1833
|
-
* - Unique identifier of the selling location.
|
|
1834
|
-
*/
|
|
1835
|
-
location_id?: number;
|
|
1836
|
-
/**
|
|
1837
|
-
* - Tags associated with the selling location.
|
|
1838
|
-
*/
|
|
1839
|
-
location_tags?: string[];
|
|
1840
|
-
/**
|
|
1841
|
-
* - Weight of the shipment.
|
|
1842
|
-
*/
|
|
1843
|
-
shipment_weight?: number;
|
|
1844
|
-
/**
|
|
1845
|
-
* - Volumetric weight of the shipment.
|
|
1846
|
-
*/
|
|
1847
|
-
shipment_volumetric_weight?: number;
|
|
1848
|
-
/**
|
|
1849
|
-
* - Total Cost of the shipment.
|
|
1850
|
-
*/
|
|
1851
|
-
shipment_cost?: number;
|
|
1852
|
-
shipment_dimension?: ShipmentDimension;
|
|
1853
|
-
/**
|
|
1854
|
-
* - A List of courier schemes.
|
|
1855
|
-
*/
|
|
1856
|
-
courier_partner_schemes?: string[];
|
|
1857
|
-
/**
|
|
1858
|
-
* - List of articles in the shipment.
|
|
1859
|
-
*/
|
|
1860
|
-
articles?: ShipmentsArticles[];
|
|
1861
|
-
};
|
|
1862
|
-
/** @returns {ShipmentCourierPartnerDetails} */
|
|
1863
|
-
declare function ShipmentCourierPartnerDetails(): ShipmentCourierPartnerDetails;
|
|
1864
|
-
type ShipmentCourierPartnerDetails = {
|
|
1865
|
-
from_location: ShipmentsCourierPartnersServiceability;
|
|
1866
|
-
to_location: ShipmentsCourierPartnersServiceability;
|
|
1867
|
-
/**
|
|
1868
|
-
* - List of shipments.
|
|
1869
|
-
*/
|
|
1870
|
-
shipments?: Shipments[];
|
|
1871
|
-
/**
|
|
1872
|
-
* - Journey type of the shipment forward or return.
|
|
1873
|
-
*/
|
|
1874
|
-
journey?: string;
|
|
1875
|
-
/**
|
|
1876
|
-
* - Payment mode opted for the shipment.
|
|
1877
|
-
*/
|
|
1878
|
-
payment_mode?: string;
|
|
1879
|
-
};
|
|
1880
|
-
/** @returns {CourierPartnerPromise} */
|
|
1881
|
-
declare function CourierPartnerPromise(): CourierPartnerPromise;
|
|
1882
|
-
type CourierPartnerPromise = {
|
|
1883
|
-
/**
|
|
1884
|
-
* - The earliest possible timestamp.
|
|
1885
|
-
*/
|
|
1886
|
-
min: string;
|
|
1887
|
-
/**
|
|
1888
|
-
* - The latest possible timestamp.
|
|
1889
|
-
*/
|
|
1890
|
-
max: string;
|
|
1891
|
-
};
|
|
1892
|
-
/** @returns {CourierPartners} */
|
|
1893
|
-
declare function CourierPartners(): CourierPartners;
|
|
1894
|
-
type CourierPartners = {
|
|
1895
|
-
/**
|
|
1896
|
-
* - Unique identifier of courier partner extension.
|
|
1897
|
-
*/
|
|
1898
|
-
extension_id?: string;
|
|
1899
|
-
/**
|
|
1900
|
-
* - Unique identifier of courier partner scheme.
|
|
1901
|
-
*/
|
|
1902
|
-
scheme_id?: string;
|
|
1903
|
-
/**
|
|
1904
|
-
* - Name of the courier partner.
|
|
1905
|
-
*/
|
|
1906
|
-
name?: string;
|
|
1907
|
-
delivery_promise?: CourierPartnerPromise;
|
|
1908
|
-
};
|
|
1909
|
-
/** @returns {ShipmentCourierPartners} */
|
|
1910
|
-
declare function ShipmentCourierPartners(): ShipmentCourierPartners;
|
|
1911
|
-
type ShipmentCourierPartners = {
|
|
1912
|
-
/**
|
|
1913
|
-
* - Unique identifier of the shipment.
|
|
1914
|
-
*/
|
|
1915
|
-
id?: string;
|
|
1916
|
-
/**
|
|
1917
|
-
* - Courier partners of the shipment.
|
|
1918
|
-
*/
|
|
1919
|
-
courier_partners?: CourierPartners[];
|
|
1920
|
-
};
|
|
1921
|
-
/** @returns {ShipmentCourierPartnerResult} */
|
|
1922
|
-
declare function ShipmentCourierPartnerResult(): ShipmentCourierPartnerResult;
|
|
1923
|
-
type ShipmentCourierPartnerResult = {
|
|
1924
|
-
courier_partners?: CourierPartners[];
|
|
1925
|
-
shipments?: ShipmentCourierPartners[];
|
|
1926
|
-
};
|
|
1927
|
-
/** @returns {ShipmentsCourierPartnersServiceability} */
|
|
1928
|
-
declare function ShipmentsCourierPartnersServiceability(): ShipmentsCourierPartnersServiceability;
|
|
1929
|
-
type ShipmentsCourierPartnersServiceability = {
|
|
1930
|
-
/**
|
|
1931
|
-
* - Postal code or PIN code of the address area.
|
|
1932
|
-
*/
|
|
1933
|
-
pincode?: string;
|
|
1934
|
-
/**
|
|
1935
|
-
* - Specifies the sector or district code of
|
|
1936
|
-
* the address if applicable.
|
|
1937
|
-
*/
|
|
1938
|
-
sector_code?: string;
|
|
1939
|
-
/**
|
|
1940
|
-
* - Indicates the state or province code of the address.
|
|
1941
|
-
*/
|
|
1942
|
-
state_code?: string;
|
|
1943
|
-
/**
|
|
1944
|
-
* - Denote the city or municipality code of the address.
|
|
1945
|
-
*/
|
|
1946
|
-
city_code?: string;
|
|
1947
|
-
/**
|
|
1948
|
-
* - ISO2 code for the country of the address.
|
|
1949
|
-
*/
|
|
1950
|
-
country_code: string;
|
|
1951
|
-
};
|
|
1952
|
-
/** @returns {ServiceabilityLocation} */
|
|
1953
|
-
declare function ServiceabilityLocation(): ServiceabilityLocation;
|
|
1954
|
-
type ServiceabilityLocation = {
|
|
1955
|
-
/**
|
|
1956
|
-
* - Geographical longitude coordinate of the location.
|
|
1957
|
-
*/
|
|
1958
|
-
longitude: string;
|
|
1959
|
-
/**
|
|
1960
|
-
* - Geographical latitude coordinate of the location.
|
|
1961
|
-
*/
|
|
1962
|
-
latitude: string;
|
|
1963
|
-
};
|
|
1964
|
-
/** @returns {GetPromiseDetails} */
|
|
1965
|
-
declare function GetPromiseDetails(): GetPromiseDetails;
|
|
1966
|
-
type GetPromiseDetails = {
|
|
1967
|
-
/**
|
|
1968
|
-
* - List of delivery promises for each store.
|
|
1969
|
-
*/
|
|
1970
|
-
items?: StorePromise[];
|
|
1971
|
-
delivery_promise?: Promise;
|
|
1972
|
-
page?: Page;
|
|
1973
|
-
};
|
|
1974
|
-
/** @returns {StorePromise} */
|
|
1975
|
-
declare function StorePromise(): StorePromise;
|
|
1976
|
-
type StorePromise = {
|
|
1977
|
-
/**
|
|
1978
|
-
* - Unique identifier of a store.
|
|
1979
|
-
*/
|
|
1980
|
-
uid?: number;
|
|
1981
|
-
/**
|
|
1982
|
-
* - Code assigned to a store.
|
|
1983
|
-
*/
|
|
1984
|
-
code?: string;
|
|
1985
|
-
/**
|
|
1986
|
-
* - Name of a store.
|
|
1987
|
-
*/
|
|
1988
|
-
name?: string;
|
|
1989
|
-
delivery_promise?: Promise;
|
|
1990
|
-
};
|
|
1991
|
-
/** @returns {Promise} */
|
|
1992
|
-
declare function Promise(): Promise;
|
|
1993
|
-
type Promise = {
|
|
1994
|
-
/**
|
|
1995
|
-
* - Earliest delivery time.
|
|
1996
|
-
*/
|
|
1997
|
-
min?: string;
|
|
1998
|
-
/**
|
|
1999
|
-
* - Latest delivery time.
|
|
2000
|
-
*/
|
|
2001
|
-
max?: string;
|
|
2002
|
-
};
|
|
2003
|
-
/** @returns {ErrorResult} */
|
|
2004
|
-
declare function ErrorResult(): ErrorResult;
|
|
2005
|
-
type ErrorResult = {
|
|
1664
|
+
/** @returns {ErrorResponse} */
|
|
1665
|
+
declare function ErrorResponse(): ErrorResponse;
|
|
1666
|
+
type ErrorResponse = {
|
|
2006
1667
|
/**
|
|
2007
1668
|
* - Error code identifying the type of error.
|
|
2008
1669
|
*/
|
|
@@ -2012,23 +1673,3 @@ type ErrorResult = {
|
|
|
2012
1673
|
*/
|
|
2013
1674
|
message?: string;
|
|
2014
1675
|
};
|
|
2015
|
-
/** @returns {ValidationError} */
|
|
2016
|
-
declare function ValidationError(): ValidationError;
|
|
2017
|
-
type ValidationError = {
|
|
2018
|
-
/**
|
|
2019
|
-
* - A brief description of the error encountered.
|
|
2020
|
-
*/
|
|
2021
|
-
message: string;
|
|
2022
|
-
/**
|
|
2023
|
-
* - The field in the request that caused the error.
|
|
2024
|
-
*/
|
|
2025
|
-
field: string;
|
|
2026
|
-
};
|
|
2027
|
-
/** @returns {StandardError} */
|
|
2028
|
-
declare function StandardError(): StandardError;
|
|
2029
|
-
type StandardError = {
|
|
2030
|
-
/**
|
|
2031
|
-
* - A brief description of the error.
|
|
2032
|
-
*/
|
|
2033
|
-
message: string;
|
|
2034
|
-
};
|