@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.3.11-beta.8
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/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3630 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +342 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +401 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2000 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1094 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1356 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +238 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +310 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -5
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +18 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -1,5 +1,59 @@
|
|
|
1
1
|
export = LogisticApplicationValidator;
|
|
2
2
|
/** @typedef GetAllCountriesParam */
|
|
3
|
+
/**
|
|
4
|
+
* @typedef GetCountriesParam
|
|
5
|
+
* @property {boolean} [onboarding] - Only fetch countries which allowed for
|
|
6
|
+
* onboard on Platform.
|
|
7
|
+
* @property {number} [pageNo] - Page number.
|
|
8
|
+
* @property {number} [pageSize] - Page size.
|
|
9
|
+
* @property {string} [q] - Search.
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* @typedef GetCountryParam
|
|
13
|
+
* @property {string} countryIsoCode - The `country_iso_code` is ISO-2 (alpha-2)
|
|
14
|
+
* code for the country.
|
|
15
|
+
*/
|
|
16
|
+
/**
|
|
17
|
+
* @typedef GetLocalitiesParam
|
|
18
|
+
* @property {string} localityType - A `locality_type` contains unique
|
|
19
|
+
* geographical division.
|
|
20
|
+
* @property {string} [country] - A `country` contains a specific value of the
|
|
21
|
+
* country iso2 code.
|
|
22
|
+
* @property {string} [state] - A `state` contains a specific value of the
|
|
23
|
+
* state, province.
|
|
24
|
+
* @property {string} [city] - A `city` contains a specific value of the city.
|
|
25
|
+
* @property {number} [pageNo] - Page number.
|
|
26
|
+
* @property {number} [pageSize] - Page size.
|
|
27
|
+
* @property {string} [q] - Search.
|
|
28
|
+
*/
|
|
29
|
+
/**
|
|
30
|
+
* @typedef GetLocalityParam
|
|
31
|
+
* @property {string} localityType - A `locality_type` contains value
|
|
32
|
+
* geographical division.
|
|
33
|
+
* @property {string} localityValue - A `locality_value` contains a specific
|
|
34
|
+
* name of the locality.
|
|
35
|
+
* @property {string} [country] - A `country` contains a specific value of the
|
|
36
|
+
* country iso2 code.
|
|
37
|
+
* @property {string} [state] - A `state` contains a specific value of the
|
|
38
|
+
* state, province.
|
|
39
|
+
* @property {string} [city] - A `city` contains a specific value of the city.
|
|
40
|
+
*/
|
|
41
|
+
/**
|
|
42
|
+
* @typedef GetLocationsParam
|
|
43
|
+
* @property {string} xApplicationId - A `x-application-id` is a unique
|
|
44
|
+
* identifier for a particular sale channel.
|
|
45
|
+
* @property {string} xApplicationData - A `x-application-data` is a unique
|
|
46
|
+
* identifier for a particular sale channel.
|
|
47
|
+
* @property {string} [country] - A `country` contains a specific value of the
|
|
48
|
+
* country `iso2` code.
|
|
49
|
+
* @property {string} [state] - A `state` contains a specific value of the
|
|
50
|
+
* state, province.
|
|
51
|
+
* @property {string} [city] - A `city` contains a specific value of the city.
|
|
52
|
+
* @property {number} [pincode] - A `pincode` contains a specific value of the city.
|
|
53
|
+
* @property {string} [sector] - A `sector` contains a specific value of the city.
|
|
54
|
+
* @property {number} [pageNo] - Page number.
|
|
55
|
+
* @property {number} [pageSize] - Page size.
|
|
56
|
+
*/
|
|
3
57
|
/**
|
|
4
58
|
* @typedef GetOptimalLocationsParam
|
|
5
59
|
* @property {LogisticApplicationModel.ReAssignStoreRequest} body
|
|
@@ -16,9 +70,25 @@ export = LogisticApplicationValidator;
|
|
|
16
70
|
* @typedef GetTatProductParam
|
|
17
71
|
* @property {LogisticApplicationModel.TATViewRequest} body
|
|
18
72
|
*/
|
|
73
|
+
/**
|
|
74
|
+
* @typedef ValidateAddressParam
|
|
75
|
+
* @property {string} countryIsoCode - The ISO code of the country.
|
|
76
|
+
* @property {string} templateName - The type of address form.
|
|
77
|
+
* @property {LogisticApplicationModel.ValidateAddressRequest} body
|
|
78
|
+
*/
|
|
19
79
|
declare class LogisticApplicationValidator {
|
|
20
80
|
/** @returns {GetAllCountriesParam} */
|
|
21
81
|
static getAllCountries(): any;
|
|
82
|
+
/** @returns {GetCountriesParam} */
|
|
83
|
+
static getCountries(): GetCountriesParam;
|
|
84
|
+
/** @returns {GetCountryParam} */
|
|
85
|
+
static getCountry(): GetCountryParam;
|
|
86
|
+
/** @returns {GetLocalitiesParam} */
|
|
87
|
+
static getLocalities(): GetLocalitiesParam;
|
|
88
|
+
/** @returns {GetLocalityParam} */
|
|
89
|
+
static getLocality(): GetLocalityParam;
|
|
90
|
+
/** @returns {GetLocationsParam} */
|
|
91
|
+
static getLocations(): GetLocationsParam;
|
|
22
92
|
/** @returns {GetOptimalLocationsParam} */
|
|
23
93
|
static getOptimalLocations(): GetOptimalLocationsParam;
|
|
24
94
|
/** @returns {GetPincodeCityParam} */
|
|
@@ -27,10 +97,139 @@ declare class LogisticApplicationValidator {
|
|
|
27
97
|
static getPincodeZones(): GetPincodeZonesParam;
|
|
28
98
|
/** @returns {GetTatProductParam} */
|
|
29
99
|
static getTatProduct(): GetTatProductParam;
|
|
100
|
+
/** @returns {ValidateAddressParam} */
|
|
101
|
+
static validateAddress(): ValidateAddressParam;
|
|
30
102
|
}
|
|
31
103
|
declare namespace LogisticApplicationValidator {
|
|
32
|
-
export { GetAllCountriesParam, GetOptimalLocationsParam, GetPincodeCityParam, GetPincodeZonesParam, GetTatProductParam };
|
|
104
|
+
export { GetAllCountriesParam, GetCountriesParam, GetCountryParam, GetLocalitiesParam, GetLocalityParam, GetLocationsParam, GetOptimalLocationsParam, GetPincodeCityParam, GetPincodeZonesParam, GetTatProductParam, ValidateAddressParam };
|
|
33
105
|
}
|
|
106
|
+
type GetCountriesParam = {
|
|
107
|
+
/**
|
|
108
|
+
* - Only fetch countries which allowed for
|
|
109
|
+
* onboard on Platform.
|
|
110
|
+
*/
|
|
111
|
+
onboarding?: boolean;
|
|
112
|
+
/**
|
|
113
|
+
* - Page number.
|
|
114
|
+
*/
|
|
115
|
+
pageNo?: number;
|
|
116
|
+
/**
|
|
117
|
+
* - Page size.
|
|
118
|
+
*/
|
|
119
|
+
pageSize?: number;
|
|
120
|
+
/**
|
|
121
|
+
* - Search.
|
|
122
|
+
*/
|
|
123
|
+
q?: string;
|
|
124
|
+
};
|
|
125
|
+
type GetCountryParam = {
|
|
126
|
+
/**
|
|
127
|
+
* - The `country_iso_code` is ISO-2 (alpha-2)
|
|
128
|
+
* code for the country.
|
|
129
|
+
*/
|
|
130
|
+
countryIsoCode: string;
|
|
131
|
+
};
|
|
132
|
+
type GetLocalitiesParam = {
|
|
133
|
+
/**
|
|
134
|
+
* - A `locality_type` contains unique
|
|
135
|
+
* geographical division.
|
|
136
|
+
*/
|
|
137
|
+
localityType: string;
|
|
138
|
+
/**
|
|
139
|
+
* - A `country` contains a specific value of the
|
|
140
|
+
* country iso2 code.
|
|
141
|
+
*/
|
|
142
|
+
country?: string;
|
|
143
|
+
/**
|
|
144
|
+
* - A `state` contains a specific value of the
|
|
145
|
+
* state, province.
|
|
146
|
+
*/
|
|
147
|
+
state?: string;
|
|
148
|
+
/**
|
|
149
|
+
* - A `city` contains a specific value of the city.
|
|
150
|
+
*/
|
|
151
|
+
city?: string;
|
|
152
|
+
/**
|
|
153
|
+
* - Page number.
|
|
154
|
+
*/
|
|
155
|
+
pageNo?: number;
|
|
156
|
+
/**
|
|
157
|
+
* - Page size.
|
|
158
|
+
*/
|
|
159
|
+
pageSize?: number;
|
|
160
|
+
/**
|
|
161
|
+
* - Search.
|
|
162
|
+
*/
|
|
163
|
+
q?: string;
|
|
164
|
+
};
|
|
165
|
+
type GetLocalityParam = {
|
|
166
|
+
/**
|
|
167
|
+
* - A `locality_type` contains value
|
|
168
|
+
* geographical division.
|
|
169
|
+
*/
|
|
170
|
+
localityType: string;
|
|
171
|
+
/**
|
|
172
|
+
* - A `locality_value` contains a specific
|
|
173
|
+
* name of the locality.
|
|
174
|
+
*/
|
|
175
|
+
localityValue: string;
|
|
176
|
+
/**
|
|
177
|
+
* - A `country` contains a specific value of the
|
|
178
|
+
* country iso2 code.
|
|
179
|
+
*/
|
|
180
|
+
country?: string;
|
|
181
|
+
/**
|
|
182
|
+
* - A `state` contains a specific value of the
|
|
183
|
+
* state, province.
|
|
184
|
+
*/
|
|
185
|
+
state?: string;
|
|
186
|
+
/**
|
|
187
|
+
* - A `city` contains a specific value of the city.
|
|
188
|
+
*/
|
|
189
|
+
city?: string;
|
|
190
|
+
};
|
|
191
|
+
type GetLocationsParam = {
|
|
192
|
+
/**
|
|
193
|
+
* - A `x-application-id` is a unique
|
|
194
|
+
* identifier for a particular sale channel.
|
|
195
|
+
*/
|
|
196
|
+
xApplicationId: string;
|
|
197
|
+
/**
|
|
198
|
+
* - A `x-application-data` is a unique
|
|
199
|
+
* identifier for a particular sale channel.
|
|
200
|
+
*/
|
|
201
|
+
xApplicationData: string;
|
|
202
|
+
/**
|
|
203
|
+
* - A `country` contains a specific value of the
|
|
204
|
+
* country `iso2` code.
|
|
205
|
+
*/
|
|
206
|
+
country?: string;
|
|
207
|
+
/**
|
|
208
|
+
* - A `state` contains a specific value of the
|
|
209
|
+
* state, province.
|
|
210
|
+
*/
|
|
211
|
+
state?: string;
|
|
212
|
+
/**
|
|
213
|
+
* - A `city` contains a specific value of the city.
|
|
214
|
+
*/
|
|
215
|
+
city?: string;
|
|
216
|
+
/**
|
|
217
|
+
* - A `pincode` contains a specific value of the city.
|
|
218
|
+
*/
|
|
219
|
+
pincode?: number;
|
|
220
|
+
/**
|
|
221
|
+
* - A `sector` contains a specific value of the city.
|
|
222
|
+
*/
|
|
223
|
+
sector?: string;
|
|
224
|
+
/**
|
|
225
|
+
* - Page number.
|
|
226
|
+
*/
|
|
227
|
+
pageNo?: number;
|
|
228
|
+
/**
|
|
229
|
+
* - Page size.
|
|
230
|
+
*/
|
|
231
|
+
pageSize?: number;
|
|
232
|
+
};
|
|
34
233
|
type GetOptimalLocationsParam = {
|
|
35
234
|
body: LogisticApplicationModel.ReAssignStoreRequest;
|
|
36
235
|
};
|
|
@@ -46,5 +245,16 @@ type GetPincodeZonesParam = {
|
|
|
46
245
|
type GetTatProductParam = {
|
|
47
246
|
body: LogisticApplicationModel.TATViewRequest;
|
|
48
247
|
};
|
|
248
|
+
type ValidateAddressParam = {
|
|
249
|
+
/**
|
|
250
|
+
* - The ISO code of the country.
|
|
251
|
+
*/
|
|
252
|
+
countryIsoCode: string;
|
|
253
|
+
/**
|
|
254
|
+
* - The type of address form.
|
|
255
|
+
*/
|
|
256
|
+
templateName: string;
|
|
257
|
+
body: LogisticApplicationModel.ValidateAddressRequest;
|
|
258
|
+
};
|
|
49
259
|
type GetAllCountriesParam = any;
|
|
50
260
|
import LogisticApplicationModel = require("./LogisticApplicationModel");
|
|
@@ -4,6 +4,65 @@ const LogisticApplicationModel = require("./LogisticApplicationModel");
|
|
|
4
4
|
|
|
5
5
|
/** @typedef GetAllCountriesParam */
|
|
6
6
|
|
|
7
|
+
/**
|
|
8
|
+
* @typedef GetCountriesParam
|
|
9
|
+
* @property {boolean} [onboarding] - Only fetch countries which allowed for
|
|
10
|
+
* onboard on Platform.
|
|
11
|
+
* @property {number} [pageNo] - Page number.
|
|
12
|
+
* @property {number} [pageSize] - Page size.
|
|
13
|
+
* @property {string} [q] - Search.
|
|
14
|
+
*/
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* @typedef GetCountryParam
|
|
18
|
+
* @property {string} countryIsoCode - The `country_iso_code` is ISO-2 (alpha-2)
|
|
19
|
+
* code for the country.
|
|
20
|
+
*/
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* @typedef GetLocalitiesParam
|
|
24
|
+
* @property {string} localityType - A `locality_type` contains unique
|
|
25
|
+
* geographical division.
|
|
26
|
+
* @property {string} [country] - A `country` contains a specific value of the
|
|
27
|
+
* country iso2 code.
|
|
28
|
+
* @property {string} [state] - A `state` contains a specific value of the
|
|
29
|
+
* state, province.
|
|
30
|
+
* @property {string} [city] - A `city` contains a specific value of the city.
|
|
31
|
+
* @property {number} [pageNo] - Page number.
|
|
32
|
+
* @property {number} [pageSize] - Page size.
|
|
33
|
+
* @property {string} [q] - Search.
|
|
34
|
+
*/
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* @typedef GetLocalityParam
|
|
38
|
+
* @property {string} localityType - A `locality_type` contains value
|
|
39
|
+
* geographical division.
|
|
40
|
+
* @property {string} localityValue - A `locality_value` contains a specific
|
|
41
|
+
* name of the locality.
|
|
42
|
+
* @property {string} [country] - A `country` contains a specific value of the
|
|
43
|
+
* country iso2 code.
|
|
44
|
+
* @property {string} [state] - A `state` contains a specific value of the
|
|
45
|
+
* state, province.
|
|
46
|
+
* @property {string} [city] - A `city` contains a specific value of the city.
|
|
47
|
+
*/
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* @typedef GetLocationsParam
|
|
51
|
+
* @property {string} xApplicationId - A `x-application-id` is a unique
|
|
52
|
+
* identifier for a particular sale channel.
|
|
53
|
+
* @property {string} xApplicationData - A `x-application-data` is a unique
|
|
54
|
+
* identifier for a particular sale channel.
|
|
55
|
+
* @property {string} [country] - A `country` contains a specific value of the
|
|
56
|
+
* country `iso2` code.
|
|
57
|
+
* @property {string} [state] - A `state` contains a specific value of the
|
|
58
|
+
* state, province.
|
|
59
|
+
* @property {string} [city] - A `city` contains a specific value of the city.
|
|
60
|
+
* @property {number} [pincode] - A `pincode` contains a specific value of the city.
|
|
61
|
+
* @property {string} [sector] - A `sector` contains a specific value of the city.
|
|
62
|
+
* @property {number} [pageNo] - Page number.
|
|
63
|
+
* @property {number} [pageSize] - Page size.
|
|
64
|
+
*/
|
|
65
|
+
|
|
7
66
|
/**
|
|
8
67
|
* @typedef GetOptimalLocationsParam
|
|
9
68
|
* @property {LogisticApplicationModel.ReAssignStoreRequest} body
|
|
@@ -24,12 +83,75 @@ const LogisticApplicationModel = require("./LogisticApplicationModel");
|
|
|
24
83
|
* @property {LogisticApplicationModel.TATViewRequest} body
|
|
25
84
|
*/
|
|
26
85
|
|
|
86
|
+
/**
|
|
87
|
+
* @typedef ValidateAddressParam
|
|
88
|
+
* @property {string} countryIsoCode - The ISO code of the country.
|
|
89
|
+
* @property {string} templateName - The type of address form.
|
|
90
|
+
* @property {LogisticApplicationModel.ValidateAddressRequest} body
|
|
91
|
+
*/
|
|
92
|
+
|
|
27
93
|
class LogisticApplicationValidator {
|
|
28
94
|
/** @returns {GetAllCountriesParam} */
|
|
29
95
|
static getAllCountries() {
|
|
30
96
|
return Joi.object({});
|
|
31
97
|
}
|
|
32
98
|
|
|
99
|
+
/** @returns {GetCountriesParam} */
|
|
100
|
+
static getCountries() {
|
|
101
|
+
return Joi.object({
|
|
102
|
+
onboarding: Joi.boolean(),
|
|
103
|
+
pageNo: Joi.number(),
|
|
104
|
+
pageSize: Joi.number(),
|
|
105
|
+
q: Joi.string().allow(""),
|
|
106
|
+
});
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/** @returns {GetCountryParam} */
|
|
110
|
+
static getCountry() {
|
|
111
|
+
return Joi.object({
|
|
112
|
+
countryIsoCode: Joi.string().allow("").required(),
|
|
113
|
+
}).required();
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
/** @returns {GetLocalitiesParam} */
|
|
117
|
+
static getLocalities() {
|
|
118
|
+
return Joi.object({
|
|
119
|
+
localityType: Joi.string().allow("").required(),
|
|
120
|
+
country: Joi.string().allow(""),
|
|
121
|
+
state: Joi.string().allow(""),
|
|
122
|
+
city: Joi.string().allow(""),
|
|
123
|
+
pageNo: Joi.number(),
|
|
124
|
+
pageSize: Joi.number(),
|
|
125
|
+
q: Joi.string().allow(""),
|
|
126
|
+
}).required();
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/** @returns {GetLocalityParam} */
|
|
130
|
+
static getLocality() {
|
|
131
|
+
return Joi.object({
|
|
132
|
+
localityType: Joi.string().allow("").required(),
|
|
133
|
+
localityValue: Joi.string().allow("").required(),
|
|
134
|
+
country: Joi.string().allow(""),
|
|
135
|
+
state: Joi.string().allow(""),
|
|
136
|
+
city: Joi.string().allow(""),
|
|
137
|
+
}).required();
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/** @returns {GetLocationsParam} */
|
|
141
|
+
static getLocations() {
|
|
142
|
+
return Joi.object({
|
|
143
|
+
xApplicationId: Joi.string().allow("").required(),
|
|
144
|
+
xApplicationData: Joi.string().allow("").required(),
|
|
145
|
+
country: Joi.string().allow(""),
|
|
146
|
+
state: Joi.string().allow(""),
|
|
147
|
+
city: Joi.string().allow(""),
|
|
148
|
+
pincode: Joi.number(),
|
|
149
|
+
sector: Joi.string().allow(""),
|
|
150
|
+
pageNo: Joi.number(),
|
|
151
|
+
pageSize: Joi.number(),
|
|
152
|
+
}).required();
|
|
153
|
+
}
|
|
154
|
+
|
|
33
155
|
/** @returns {GetOptimalLocationsParam} */
|
|
34
156
|
static getOptimalLocations() {
|
|
35
157
|
return Joi.object({
|
|
@@ -57,6 +179,15 @@ class LogisticApplicationValidator {
|
|
|
57
179
|
body: LogisticApplicationModel.TATViewRequest().required(),
|
|
58
180
|
}).required();
|
|
59
181
|
}
|
|
182
|
+
|
|
183
|
+
/** @returns {ValidateAddressParam} */
|
|
184
|
+
static validateAddress() {
|
|
185
|
+
return Joi.object({
|
|
186
|
+
countryIsoCode: Joi.string().allow("").required(),
|
|
187
|
+
templateName: Joi.string().allow("").required(),
|
|
188
|
+
body: LogisticApplicationModel.ValidateAddressRequest().required(),
|
|
189
|
+
}).required();
|
|
190
|
+
}
|
|
60
191
|
}
|
|
61
192
|
|
|
62
193
|
module.exports = LogisticApplicationValidator;
|
|
@@ -51,7 +51,7 @@ declare class Order {
|
|
|
51
51
|
* @summary: Get details of an order
|
|
52
52
|
* @description: Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
|
|
53
53
|
*/
|
|
54
|
-
getOrderById({ orderId, requestHeaders }?: OrderApplicationValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
|
|
54
|
+
getOrderById({ orderId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
|
|
55
55
|
/**
|
|
56
56
|
* @param {OrderApplicationValidator.GetOrdersParam} arg - Arg object.
|
|
57
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -61,7 +61,7 @@ declare class Order {
|
|
|
61
61
|
* @summary: Get all orders
|
|
62
62
|
* @description: Use this API to retrieve all the orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
|
|
63
63
|
*/
|
|
64
|
-
getOrders({ status, pageNo, pageSize, fromDate, toDate, customMeta, requestHeaders, }?: OrderApplicationValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderList>;
|
|
64
|
+
getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, requestHeaders, }?: OrderApplicationValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderList>;
|
|
65
65
|
/**
|
|
66
66
|
* @param {OrderApplicationValidator.GetPosOrderByIdParam} arg - Arg object.
|
|
67
67
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -91,7 +91,7 @@ declare class Order {
|
|
|
91
91
|
* @summary: Get details of a shipment
|
|
92
92
|
* @description: Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
|
|
93
93
|
*/
|
|
94
|
-
getShipmentById({ shipmentId, requestHeaders }?: OrderApplicationValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentById>;
|
|
94
|
+
getShipmentById({ shipmentId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentById>;
|
|
95
95
|
/**
|
|
96
96
|
* @param {OrderApplicationValidator.GetShipmentReasonsParam} arg - Arg object.
|
|
97
97
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -227,11 +227,11 @@ class Order {
|
|
|
227
227
|
* @description: Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
|
|
228
228
|
*/
|
|
229
229
|
async getOrderById(
|
|
230
|
-
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
230
|
+
{ orderId, allowInactive, requestHeaders } = { requestHeaders: {} },
|
|
231
231
|
{ responseHeaders } = { responseHeaders: false }
|
|
232
232
|
) {
|
|
233
233
|
const { error } = OrderApplicationValidator.getOrderById().validate(
|
|
234
|
-
{ orderId },
|
|
234
|
+
{ orderId, allowInactive },
|
|
235
235
|
{ abortEarly: false, allowUnknown: true }
|
|
236
236
|
);
|
|
237
237
|
if (error) {
|
|
@@ -242,7 +242,7 @@ class Order {
|
|
|
242
242
|
const {
|
|
243
243
|
error: warrning,
|
|
244
244
|
} = OrderApplicationValidator.getOrderById().validate(
|
|
245
|
-
{ orderId },
|
|
245
|
+
{ orderId, allowInactive },
|
|
246
246
|
{ abortEarly: false, allowUnknown: false }
|
|
247
247
|
);
|
|
248
248
|
if (warrning) {
|
|
@@ -253,6 +253,7 @@ class Order {
|
|
|
253
253
|
}
|
|
254
254
|
|
|
255
255
|
const query_params = {};
|
|
256
|
+
query_params["allow_inactive"] = allowInactive;
|
|
256
257
|
|
|
257
258
|
const xHeaders = {};
|
|
258
259
|
|
|
@@ -311,13 +312,24 @@ class Order {
|
|
|
311
312
|
pageSize,
|
|
312
313
|
fromDate,
|
|
313
314
|
toDate,
|
|
315
|
+
startDate,
|
|
316
|
+
endDate,
|
|
314
317
|
customMeta,
|
|
315
318
|
requestHeaders,
|
|
316
319
|
} = { requestHeaders: {} },
|
|
317
320
|
{ responseHeaders } = { responseHeaders: false }
|
|
318
321
|
) {
|
|
319
322
|
const { error } = OrderApplicationValidator.getOrders().validate(
|
|
320
|
-
{
|
|
323
|
+
{
|
|
324
|
+
status,
|
|
325
|
+
pageNo,
|
|
326
|
+
pageSize,
|
|
327
|
+
fromDate,
|
|
328
|
+
toDate,
|
|
329
|
+
startDate,
|
|
330
|
+
endDate,
|
|
331
|
+
customMeta,
|
|
332
|
+
},
|
|
321
333
|
{ abortEarly: false, allowUnknown: true }
|
|
322
334
|
);
|
|
323
335
|
if (error) {
|
|
@@ -326,7 +338,16 @@ class Order {
|
|
|
326
338
|
|
|
327
339
|
// Showing warrnings if extra unknown parameters are found
|
|
328
340
|
const { error: warrning } = OrderApplicationValidator.getOrders().validate(
|
|
329
|
-
{
|
|
341
|
+
{
|
|
342
|
+
status,
|
|
343
|
+
pageNo,
|
|
344
|
+
pageSize,
|
|
345
|
+
fromDate,
|
|
346
|
+
toDate,
|
|
347
|
+
startDate,
|
|
348
|
+
endDate,
|
|
349
|
+
customMeta,
|
|
350
|
+
},
|
|
330
351
|
{ abortEarly: false, allowUnknown: false }
|
|
331
352
|
);
|
|
332
353
|
if (warrning) {
|
|
@@ -342,6 +363,8 @@ class Order {
|
|
|
342
363
|
query_params["page_size"] = pageSize;
|
|
343
364
|
query_params["from_date"] = fromDate;
|
|
344
365
|
query_params["to_date"] = toDate;
|
|
366
|
+
query_params["start_date"] = startDate;
|
|
367
|
+
query_params["end_date"] = endDate;
|
|
345
368
|
query_params["custom_meta"] = customMeta;
|
|
346
369
|
|
|
347
370
|
const xHeaders = {};
|
|
@@ -553,11 +576,11 @@ class Order {
|
|
|
553
576
|
* @description: Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
|
|
554
577
|
*/
|
|
555
578
|
async getShipmentById(
|
|
556
|
-
{ shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
579
|
+
{ shipmentId, allowInactive, requestHeaders } = { requestHeaders: {} },
|
|
557
580
|
{ responseHeaders } = { responseHeaders: false }
|
|
558
581
|
) {
|
|
559
582
|
const { error } = OrderApplicationValidator.getShipmentById().validate(
|
|
560
|
-
{ shipmentId },
|
|
583
|
+
{ shipmentId, allowInactive },
|
|
561
584
|
{ abortEarly: false, allowUnknown: true }
|
|
562
585
|
);
|
|
563
586
|
if (error) {
|
|
@@ -568,7 +591,7 @@ class Order {
|
|
|
568
591
|
const {
|
|
569
592
|
error: warrning,
|
|
570
593
|
} = OrderApplicationValidator.getShipmentById().validate(
|
|
571
|
-
{ shipmentId },
|
|
594
|
+
{ shipmentId, allowInactive },
|
|
572
595
|
{ abortEarly: false, allowUnknown: false }
|
|
573
596
|
);
|
|
574
597
|
if (warrning) {
|
|
@@ -579,6 +602,7 @@ class Order {
|
|
|
579
602
|
}
|
|
580
603
|
|
|
581
604
|
const query_params = {};
|
|
605
|
+
query_params["allow_inactive"] = allowInactive;
|
|
582
606
|
|
|
583
607
|
const xHeaders = {};
|
|
584
608
|
|
|
@@ -252,6 +252,7 @@ export = OrderApplicationModel;
|
|
|
252
252
|
* @property {BagsForReorder[]} [bags_for_reorder]
|
|
253
253
|
* @property {BreakupValues[]} [breakup_values]
|
|
254
254
|
* @property {string} [order_created_time]
|
|
255
|
+
* @property {string} [order_created_ts]
|
|
255
256
|
* @property {string} [order_id]
|
|
256
257
|
* @property {Shipments[]} [shipments]
|
|
257
258
|
* @property {number} [total_shipments_in_order]
|
|
@@ -411,6 +412,7 @@ export = OrderApplicationModel;
|
|
|
411
412
|
* @property {Object} [return_meta]
|
|
412
413
|
* @property {string} [returnable_date]
|
|
413
414
|
* @property {string} [shipment_created_at]
|
|
415
|
+
* @property {string} [shipment_created_ts]
|
|
414
416
|
* @property {string} [shipment_id]
|
|
415
417
|
* @property {ShipmentStatus} [shipment_status]
|
|
416
418
|
* @property {boolean} [show_download_invoice]
|
|
@@ -483,6 +485,7 @@ export = OrderApplicationModel;
|
|
|
483
485
|
*/
|
|
484
486
|
/**
|
|
485
487
|
* @typedef TrackingDetails
|
|
488
|
+
* @property {string} [created_ts]
|
|
486
489
|
* @property {boolean} [is_current]
|
|
487
490
|
* @property {boolean} [is_passed]
|
|
488
491
|
* @property {string} [status]
|
|
@@ -804,6 +807,7 @@ type OrderSchema = {
|
|
|
804
807
|
bags_for_reorder?: BagsForReorder[];
|
|
805
808
|
breakup_values?: BreakupValues[];
|
|
806
809
|
order_created_time?: string;
|
|
810
|
+
order_created_ts?: string;
|
|
807
811
|
order_id?: string;
|
|
808
812
|
shipments?: Shipments[];
|
|
809
813
|
total_shipments_in_order?: number;
|
|
@@ -983,6 +987,7 @@ type Shipments = {
|
|
|
983
987
|
return_meta?: any;
|
|
984
988
|
returnable_date?: string;
|
|
985
989
|
shipment_created_at?: string;
|
|
990
|
+
shipment_created_ts?: string;
|
|
986
991
|
shipment_id?: string;
|
|
987
992
|
shipment_status?: ShipmentStatus;
|
|
988
993
|
show_download_invoice?: boolean;
|
|
@@ -1065,6 +1070,7 @@ type Track = {
|
|
|
1065
1070
|
/** @returns {TrackingDetails} */
|
|
1066
1071
|
declare function TrackingDetails(): TrackingDetails;
|
|
1067
1072
|
type TrackingDetails = {
|
|
1073
|
+
created_ts?: string;
|
|
1068
1074
|
is_current?: boolean;
|
|
1069
1075
|
is_passed?: boolean;
|
|
1070
1076
|
status?: string;
|
|
@@ -282,6 +282,7 @@ const Joi = require("joi");
|
|
|
282
282
|
* @property {BagsForReorder[]} [bags_for_reorder]
|
|
283
283
|
* @property {BreakupValues[]} [breakup_values]
|
|
284
284
|
* @property {string} [order_created_time]
|
|
285
|
+
* @property {string} [order_created_ts]
|
|
285
286
|
* @property {string} [order_id]
|
|
286
287
|
* @property {Shipments[]} [shipments]
|
|
287
288
|
* @property {number} [total_shipments_in_order]
|
|
@@ -461,6 +462,7 @@ const Joi = require("joi");
|
|
|
461
462
|
* @property {Object} [return_meta]
|
|
462
463
|
* @property {string} [returnable_date]
|
|
463
464
|
* @property {string} [shipment_created_at]
|
|
465
|
+
* @property {string} [shipment_created_ts]
|
|
464
466
|
* @property {string} [shipment_id]
|
|
465
467
|
* @property {ShipmentStatus} [shipment_status]
|
|
466
468
|
* @property {boolean} [show_download_invoice]
|
|
@@ -543,6 +545,7 @@ const Joi = require("joi");
|
|
|
543
545
|
|
|
544
546
|
/**
|
|
545
547
|
* @typedef TrackingDetails
|
|
548
|
+
* @property {string} [created_ts]
|
|
546
549
|
* @property {boolean} [is_current]
|
|
547
550
|
* @property {boolean} [is_passed]
|
|
548
551
|
* @property {string} [status]
|
|
@@ -929,6 +932,7 @@ class OrderApplicationModel {
|
|
|
929
932
|
),
|
|
930
933
|
breakup_values: Joi.array().items(OrderApplicationModel.BreakupValues()),
|
|
931
934
|
order_created_time: Joi.string().allow(""),
|
|
935
|
+
order_created_ts: Joi.string().allow(""),
|
|
932
936
|
order_id: Joi.string().allow(""),
|
|
933
937
|
shipments: Joi.array().items(OrderApplicationModel.Shipments()),
|
|
934
938
|
total_shipments_in_order: Joi.number(),
|
|
@@ -1152,6 +1156,7 @@ class OrderApplicationModel {
|
|
|
1152
1156
|
return_meta: Joi.any(),
|
|
1153
1157
|
returnable_date: Joi.string().allow("").allow(null),
|
|
1154
1158
|
shipment_created_at: Joi.string().allow(""),
|
|
1159
|
+
shipment_created_ts: Joi.string().allow(""),
|
|
1155
1160
|
shipment_id: Joi.string().allow(""),
|
|
1156
1161
|
shipment_status: OrderApplicationModel.ShipmentStatus(),
|
|
1157
1162
|
show_download_invoice: Joi.boolean(),
|
|
@@ -1256,6 +1261,7 @@ class OrderApplicationModel {
|
|
|
1256
1261
|
/** @returns {TrackingDetails} */
|
|
1257
1262
|
static TrackingDetails() {
|
|
1258
1263
|
return Joi.object({
|
|
1264
|
+
created_ts: Joi.string().allow(""),
|
|
1259
1265
|
is_current: Joi.boolean(),
|
|
1260
1266
|
is_passed: Joi.boolean(),
|
|
1261
1267
|
status: Joi.string().allow(""),
|
|
@@ -15,6 +15,7 @@ export = OrderApplicationValidator;
|
|
|
15
15
|
* @typedef GetOrderByIdParam
|
|
16
16
|
* @property {string} orderId - A unique number used for identifying and
|
|
17
17
|
* tracking your orders.
|
|
18
|
+
* @property {boolean} [allowInactive] - Flag to allow inactive shipments
|
|
18
19
|
*/
|
|
19
20
|
/**
|
|
20
21
|
* @typedef GetOrdersParam
|
|
@@ -26,6 +27,8 @@ export = OrderApplicationValidator;
|
|
|
26
27
|
* Default value is 10.
|
|
27
28
|
* @property {string} [fromDate] - The date from which the orders should be retrieved.
|
|
28
29
|
* @property {string} [toDate] - The date till which the orders should be retrieved.
|
|
30
|
+
* @property {string} [startDate] - UTC Start Date in ISO format
|
|
31
|
+
* @property {string} [endDate] - UTC Start Date in ISO format
|
|
29
32
|
* @property {string} [customMeta] - A filter and retrieve data using special
|
|
30
33
|
* fields included for special use-cases
|
|
31
34
|
*/
|
|
@@ -46,6 +49,7 @@ export = OrderApplicationValidator;
|
|
|
46
49
|
* @property {string} shipmentId - ID of the shipment. An order may contain
|
|
47
50
|
* multiple items and may get divided into one or more shipment, each having
|
|
48
51
|
* its own ID.
|
|
52
|
+
* @property {boolean} [allowInactive] - Flag to allow inactive shipments
|
|
49
53
|
*/
|
|
50
54
|
/**
|
|
51
55
|
* @typedef GetShipmentReasonsParam
|
|
@@ -137,6 +141,10 @@ type GetOrderByIdParam = {
|
|
|
137
141
|
* tracking your orders.
|
|
138
142
|
*/
|
|
139
143
|
orderId: string;
|
|
144
|
+
/**
|
|
145
|
+
* - Flag to allow inactive shipments
|
|
146
|
+
*/
|
|
147
|
+
allowInactive?: boolean;
|
|
140
148
|
};
|
|
141
149
|
type GetOrdersParam = {
|
|
142
150
|
/**
|
|
@@ -162,6 +170,14 @@ type GetOrdersParam = {
|
|
|
162
170
|
* - The date till which the orders should be retrieved.
|
|
163
171
|
*/
|
|
164
172
|
toDate?: string;
|
|
173
|
+
/**
|
|
174
|
+
* - UTC Start Date in ISO format
|
|
175
|
+
*/
|
|
176
|
+
startDate?: string;
|
|
177
|
+
/**
|
|
178
|
+
* - UTC Start Date in ISO format
|
|
179
|
+
*/
|
|
180
|
+
endDate?: string;
|
|
165
181
|
/**
|
|
166
182
|
* - A filter and retrieve data using special
|
|
167
183
|
* fields included for special use-cases
|
|
@@ -194,6 +210,10 @@ type GetShipmentByIdParam = {
|
|
|
194
210
|
* its own ID.
|
|
195
211
|
*/
|
|
196
212
|
shipmentId: string;
|
|
213
|
+
/**
|
|
214
|
+
* - Flag to allow inactive shipments
|
|
215
|
+
*/
|
|
216
|
+
allowInactive?: boolean;
|
|
197
217
|
};
|
|
198
218
|
type GetShipmentReasonsParam = {
|
|
199
219
|
/**
|