@gofynd/fdk-client-javascript 1.4.16-beta.2 → 1.4.16-beta.4
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 +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
- package/sdk/application/Content/ContentApplicationClient.js +56 -161
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/common/Utility.js +6 -3
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -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 +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- 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 +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- 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 +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -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 -204
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
- package/sdk/platform/Content/ContentPlatformModel.js +394 -631
- 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 +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -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 +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -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 +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- 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 +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- 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 +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
- package/sdk/platform/Share/SharePlatformModel.js +6 -31
- 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 +6 -810
- 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 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
|
@@ -6,8 +6,6 @@ declare class Logistic {
|
|
|
6
6
|
getAllCountries: string;
|
|
7
7
|
getCountries: string;
|
|
8
8
|
getCountry: string;
|
|
9
|
-
getCourierPartners: string;
|
|
10
|
-
getDeliveryPromise: string;
|
|
11
9
|
getLocalities: string;
|
|
12
10
|
getLocality: string;
|
|
13
11
|
getLocations: string;
|
|
@@ -22,12 +20,12 @@ declare class Logistic {
|
|
|
22
20
|
/**
|
|
23
21
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
24
22
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
25
|
-
* @returns {Promise<
|
|
23
|
+
* @returns {Promise<CountryListResponse>} - Success response
|
|
26
24
|
* @name getAllCountries
|
|
27
25
|
* @summary: Get deliverable countries
|
|
28
26
|
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
|
|
29
27
|
*/
|
|
30
|
-
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
28
|
+
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CountryListResponse>;
|
|
31
29
|
/**
|
|
32
30
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
33
31
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -36,7 +34,7 @@ declare class Logistic {
|
|
|
36
34
|
* @summary: Get countries
|
|
37
35
|
* @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
38
36
|
*/
|
|
39
|
-
getCountries({ onboarding, pageNo, pageSize, q,
|
|
37
|
+
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
|
|
40
38
|
/**
|
|
41
39
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
40
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -46,24 +44,6 @@ declare class Logistic {
|
|
|
46
44
|
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
|
|
47
45
|
*/
|
|
48
46
|
getCountry({ countryIsoCode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetCountry>;
|
|
49
|
-
/**
|
|
50
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
52
|
-
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
53
|
-
* @name getCourierPartners
|
|
54
|
-
* @summary: Serviceable Courier Partners.
|
|
55
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCourierPartners/).
|
|
56
|
-
*/
|
|
57
|
-
getCourierPartners({ companyId, applicationId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentCourierPartnerResult>;
|
|
58
|
-
/**
|
|
59
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
60
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
61
|
-
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
62
|
-
* @name getDeliveryPromise
|
|
63
|
-
* @summary: Get delivery promise
|
|
64
|
-
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getDeliveryPromise/).
|
|
65
|
-
*/
|
|
66
|
-
getDeliveryPromise({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
|
|
67
47
|
/**
|
|
68
48
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
49
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -85,55 +65,55 @@ declare class Logistic {
|
|
|
85
65
|
/**
|
|
86
66
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
87
67
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
88
|
-
* @returns {Promise<
|
|
68
|
+
* @returns {Promise<GetStoreResponse>} - Success response
|
|
89
69
|
* @name getLocations
|
|
90
70
|
* @summary: Get available selling locations
|
|
91
71
|
* @description: Get stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
|
|
92
72
|
*/
|
|
93
|
-
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
73
|
+
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetStoreResponse>;
|
|
94
74
|
/**
|
|
95
75
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
96
76
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
97
|
-
* @returns {Promise<
|
|
77
|
+
* @returns {Promise<ReAssignStoreResponse>} - Success response
|
|
98
78
|
* @name getOptimalLocations
|
|
99
79
|
* @summary: Get selling locations
|
|
100
80
|
* @description: Get optimal fulfillment centre for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
|
|
101
81
|
*/
|
|
102
|
-
getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
82
|
+
getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReAssignStoreResponse>;
|
|
103
83
|
/**
|
|
104
84
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
105
85
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
106
|
-
* @returns {Promise<
|
|
86
|
+
* @returns {Promise<PincodeApiResponse>} - Success response
|
|
107
87
|
* @name getPincodeCity
|
|
108
88
|
* @summary: Get pincode details
|
|
109
89
|
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
|
|
110
90
|
*/
|
|
111
|
-
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
91
|
+
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<PincodeApiResponse>;
|
|
112
92
|
/**
|
|
113
93
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
114
94
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
115
|
-
* @returns {Promise<
|
|
95
|
+
* @returns {Promise<GetZoneFromPincodeViewResponse>} - Success response
|
|
116
96
|
* @name getPincodeZones
|
|
117
97
|
* @summary: Get zones
|
|
118
98
|
* @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
119
99
|
*/
|
|
120
|
-
getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
100
|
+
getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetZoneFromPincodeViewResponse>;
|
|
121
101
|
/**
|
|
122
102
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
103
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
124
|
-
* @returns {Promise<
|
|
104
|
+
* @returns {Promise<TATViewResponse>} - Success response
|
|
125
105
|
* @name getTatProduct
|
|
126
106
|
* @summary: Get product's turnaround time
|
|
127
107
|
* @description: Get the estimated delivery time frame for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
128
108
|
*/
|
|
129
|
-
getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
109
|
+
getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TATViewResponse>;
|
|
130
110
|
/**
|
|
131
111
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
132
112
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
133
|
-
* @returns {Promise<
|
|
113
|
+
* @returns {Promise<ValidateAddressRequest>} - Success response
|
|
134
114
|
* @name validateAddress
|
|
135
115
|
* @summary: Validate address
|
|
136
116
|
* @description: Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/validateAddress/).
|
|
137
117
|
*/
|
|
138
|
-
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
118
|
+
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ValidateAddressRequest>;
|
|
139
119
|
}
|
|
@@ -16,10 +16,6 @@ class Logistic {
|
|
|
16
16
|
getCountries: "/service/application/logistics/v2.0/countries",
|
|
17
17
|
getCountry:
|
|
18
18
|
"/service/application/logistics/v1.0/countries/{country_iso_code}",
|
|
19
|
-
getCourierPartners:
|
|
20
|
-
"/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners",
|
|
21
|
-
getDeliveryPromise:
|
|
22
|
-
"/service/application/logistics/v1.0/delivery-promise",
|
|
23
19
|
getLocalities:
|
|
24
20
|
"/service/application/logistics/v1.0/localities/{locality_type}",
|
|
25
21
|
getLocality:
|
|
@@ -52,7 +48,7 @@ class Logistic {
|
|
|
52
48
|
/**
|
|
53
49
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
54
50
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
55
|
-
* @returns {Promise<
|
|
51
|
+
* @returns {Promise<CountryListResponse>} - Success response
|
|
56
52
|
* @name getAllCountries
|
|
57
53
|
* @summary: Get deliverable countries
|
|
58
54
|
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
|
|
@@ -95,7 +91,7 @@ class Logistic {
|
|
|
95
91
|
* @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
96
92
|
*/
|
|
97
93
|
async getCountries(
|
|
98
|
-
{ onboarding, pageNo, pageSize, q,
|
|
94
|
+
{ onboarding, pageNo, pageSize, q, requestHeaders } = {
|
|
99
95
|
requestHeaders: {},
|
|
100
96
|
},
|
|
101
97
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -105,7 +101,6 @@ class Logistic {
|
|
|
105
101
|
query_params["page_no"] = pageNo;
|
|
106
102
|
query_params["page_size"] = pageSize;
|
|
107
103
|
query_params["q"] = q;
|
|
108
|
-
query_params["hierarchy"] = hierarchy;
|
|
109
104
|
|
|
110
105
|
const xHeaders = {};
|
|
111
106
|
|
|
@@ -176,94 +171,6 @@ class Logistic {
|
|
|
176
171
|
return response;
|
|
177
172
|
}
|
|
178
173
|
|
|
179
|
-
/**
|
|
180
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
182
|
-
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
183
|
-
* @name getCourierPartners
|
|
184
|
-
* @summary: Serviceable Courier Partners.
|
|
185
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCourierPartners/).
|
|
186
|
-
*/
|
|
187
|
-
async getCourierPartners(
|
|
188
|
-
{ companyId, applicationId, body, requestHeaders } = { requestHeaders: {} },
|
|
189
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
190
|
-
) {
|
|
191
|
-
const errors = validateRequiredParams(arguments[0], [
|
|
192
|
-
"companyId",
|
|
193
|
-
"applicationId",
|
|
194
|
-
]);
|
|
195
|
-
if (errors.length > 0) {
|
|
196
|
-
const error = new FDKClientValidationError({
|
|
197
|
-
message: "Missing required field",
|
|
198
|
-
details: errors,
|
|
199
|
-
});
|
|
200
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
const query_params = {};
|
|
204
|
-
|
|
205
|
-
const xHeaders = {};
|
|
206
|
-
|
|
207
|
-
const response = await ApplicationAPIClient.execute(
|
|
208
|
-
this._conf,
|
|
209
|
-
"post",
|
|
210
|
-
constructUrl({
|
|
211
|
-
url: this._urls["getCourierPartners"],
|
|
212
|
-
params: { companyId, applicationId },
|
|
213
|
-
}),
|
|
214
|
-
query_params,
|
|
215
|
-
body,
|
|
216
|
-
{ ...xHeaders, ...requestHeaders },
|
|
217
|
-
{ responseHeaders }
|
|
218
|
-
);
|
|
219
|
-
|
|
220
|
-
let responseData = response;
|
|
221
|
-
if (responseHeaders) {
|
|
222
|
-
responseData = response[0];
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
return response;
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
/**
|
|
229
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
230
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
231
|
-
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
232
|
-
* @name getDeliveryPromise
|
|
233
|
-
* @summary: Get delivery promise
|
|
234
|
-
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getDeliveryPromise/).
|
|
235
|
-
*/
|
|
236
|
-
async getDeliveryPromise(
|
|
237
|
-
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
238
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
239
|
-
) {
|
|
240
|
-
const query_params = {};
|
|
241
|
-
query_params["page_no"] = pageNo;
|
|
242
|
-
query_params["page_size"] = pageSize;
|
|
243
|
-
|
|
244
|
-
const xHeaders = {};
|
|
245
|
-
|
|
246
|
-
const response = await ApplicationAPIClient.execute(
|
|
247
|
-
this._conf,
|
|
248
|
-
"get",
|
|
249
|
-
constructUrl({
|
|
250
|
-
url: this._urls["getDeliveryPromise"],
|
|
251
|
-
params: {},
|
|
252
|
-
}),
|
|
253
|
-
query_params,
|
|
254
|
-
undefined,
|
|
255
|
-
{ ...xHeaders, ...requestHeaders },
|
|
256
|
-
{ responseHeaders }
|
|
257
|
-
);
|
|
258
|
-
|
|
259
|
-
let responseData = response;
|
|
260
|
-
if (responseHeaders) {
|
|
261
|
-
responseData = response[0];
|
|
262
|
-
}
|
|
263
|
-
|
|
264
|
-
return response;
|
|
265
|
-
}
|
|
266
|
-
|
|
267
174
|
/**
|
|
268
175
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
269
176
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -382,7 +289,7 @@ class Logistic {
|
|
|
382
289
|
/**
|
|
383
290
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
384
291
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
385
|
-
* @returns {Promise<
|
|
292
|
+
* @returns {Promise<GetStoreResponse>} - Success response
|
|
386
293
|
* @name getLocations
|
|
387
294
|
* @summary: Get available selling locations
|
|
388
295
|
* @description: Get stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
|
|
@@ -439,7 +346,7 @@ class Logistic {
|
|
|
439
346
|
/**
|
|
440
347
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
441
348
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
442
|
-
* @returns {Promise<
|
|
349
|
+
* @returns {Promise<ReAssignStoreResponse>} - Success response
|
|
443
350
|
* @name getOptimalLocations
|
|
444
351
|
* @summary: Get selling locations
|
|
445
352
|
* @description: Get optimal fulfillment centre for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
|
|
@@ -476,7 +383,7 @@ class Logistic {
|
|
|
476
383
|
/**
|
|
477
384
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
478
385
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
479
|
-
* @returns {Promise<
|
|
386
|
+
* @returns {Promise<PincodeApiResponse>} - Success response
|
|
480
387
|
* @name getPincodeCity
|
|
481
388
|
* @summary: Get pincode details
|
|
482
389
|
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
|
|
@@ -522,7 +429,7 @@ class Logistic {
|
|
|
522
429
|
/**
|
|
523
430
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
524
431
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
525
|
-
* @returns {Promise<
|
|
432
|
+
* @returns {Promise<GetZoneFromPincodeViewResponse>} - Success response
|
|
526
433
|
* @name getPincodeZones
|
|
527
434
|
* @summary: Get zones
|
|
528
435
|
* @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
@@ -559,7 +466,7 @@ class Logistic {
|
|
|
559
466
|
/**
|
|
560
467
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
561
468
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
562
|
-
* @returns {Promise<
|
|
469
|
+
* @returns {Promise<TATViewResponse>} - Success response
|
|
563
470
|
* @name getTatProduct
|
|
564
471
|
* @summary: Get product's turnaround time
|
|
565
472
|
* @description: Get the estimated delivery time frame for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
@@ -596,7 +503,7 @@ class Logistic {
|
|
|
596
503
|
/**
|
|
597
504
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
598
505
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
599
|
-
* @returns {Promise<
|
|
506
|
+
* @returns {Promise<ValidateAddressRequest>} - Success response
|
|
600
507
|
* @name validateAddress
|
|
601
508
|
* @summary: Validate address
|
|
602
509
|
* @description: Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/validateAddress/).
|
|
@@ -7,7 +7,6 @@ declare class Order {
|
|
|
7
7
|
getInvoiceByShipmentId: string;
|
|
8
8
|
getOrderById: string;
|
|
9
9
|
getOrders: string;
|
|
10
|
-
getPosOrderById: string;
|
|
11
10
|
getShipmentBagReasons: string;
|
|
12
11
|
getShipmentById: string;
|
|
13
12
|
getShipmentReasons: string;
|
|
@@ -21,12 +20,12 @@ declare class Order {
|
|
|
21
20
|
/**
|
|
22
21
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
22
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<
|
|
23
|
+
* @returns {Promise<CustomerDetailsResponse>} - Success response
|
|
25
24
|
* @name getCustomerDetailsByShipmentId
|
|
26
25
|
* @summary: Get shipment's customer
|
|
27
26
|
* @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
|
|
28
27
|
*/
|
|
29
|
-
getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
28
|
+
getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CustomerDetailsResponse>;
|
|
30
29
|
/**
|
|
31
30
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
32
31
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -54,22 +53,13 @@ declare class Order {
|
|
|
54
53
|
* @description: Get all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
|
|
55
54
|
*/
|
|
56
55
|
getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, allowInactive, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderList>;
|
|
57
|
-
/**
|
|
58
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
60
|
-
* @returns {Promise<OrderById>} - Success response
|
|
61
|
-
* @name getPosOrderById
|
|
62
|
-
* @summary: Retrieves POS order details
|
|
63
|
-
* @description: Retrieve a POS order and all its 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/getPosOrderById/).
|
|
64
|
-
*/
|
|
65
|
-
getPosOrderById({ orderId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderById>;
|
|
66
56
|
/**
|
|
67
57
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
58
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
69
59
|
* @returns {Promise<ShipmentBagReasons>} - Success response
|
|
70
60
|
* @name getShipmentBagReasons
|
|
71
|
-
* @summary:
|
|
72
|
-
* @description:
|
|
61
|
+
* @summary: List bag cancellation reasons
|
|
62
|
+
* @description: Get reasons to perform full or partial cancellation of a bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
|
|
73
63
|
*/
|
|
74
64
|
getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentBagReasons>;
|
|
75
65
|
/**
|
|
@@ -93,12 +83,12 @@ declare class Order {
|
|
|
93
83
|
/**
|
|
94
84
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
85
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
96
|
-
* @returns {Promise<
|
|
86
|
+
* @returns {Promise<SendOtpToCustomerResponse>} - Success response
|
|
97
87
|
* @name sendOtpToShipmentCustomer
|
|
98
88
|
* @summary: Send OTP to customer
|
|
99
89
|
* @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
|
|
100
90
|
*/
|
|
101
|
-
sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
91
|
+
sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SendOtpToCustomerResponse>;
|
|
102
92
|
/**
|
|
103
93
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
104
94
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -111,19 +101,19 @@ declare class Order {
|
|
|
111
101
|
/**
|
|
112
102
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
113
103
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
114
|
-
* @returns {Promise<
|
|
104
|
+
* @returns {Promise<ShipmentApplicationStatusResponse>} - Success response
|
|
115
105
|
* @name updateShipmentStatus
|
|
116
106
|
* @summary: Updates shipment status
|
|
117
|
-
* @description:
|
|
107
|
+
* @description: Update current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
|
|
118
108
|
*/
|
|
119
|
-
updateShipmentStatus({ shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
109
|
+
updateShipmentStatus({ shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentApplicationStatusResponse>;
|
|
120
110
|
/**
|
|
121
111
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
112
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
123
|
-
* @returns {Promise<
|
|
113
|
+
* @returns {Promise<VerifyOtpResponse>} - Success response
|
|
124
114
|
* @name verifyOtpShipmentCustomer
|
|
125
115
|
* @summary: Verifies OTP
|
|
126
|
-
* @description: Verify OTP
|
|
116
|
+
* @description: Verify OTP sent by customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
|
|
127
117
|
*/
|
|
128
|
-
verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
118
|
+
verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<VerifyOtpResponse>;
|
|
129
119
|
}
|
|
@@ -18,8 +18,6 @@ class Order {
|
|
|
18
18
|
"/service/application/order/v1.0/orders/shipments/{shipment_id}/invoice",
|
|
19
19
|
getOrderById: "/service/application/order/v1.0/orders/{order_id}",
|
|
20
20
|
getOrders: "/service/application/order/v1.0/orders",
|
|
21
|
-
getPosOrderById:
|
|
22
|
-
"/service/application/order/v1.0/orders/pos-order/{order_id}",
|
|
23
21
|
getShipmentBagReasons:
|
|
24
22
|
"/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons",
|
|
25
23
|
getShipmentById:
|
|
@@ -54,7 +52,7 @@ class Order {
|
|
|
54
52
|
/**
|
|
55
53
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
56
54
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
57
|
-
* @returns {Promise<
|
|
55
|
+
* @returns {Promise<CustomerDetailsResponse>} - Success response
|
|
58
56
|
* @name getCustomerDetailsByShipmentId
|
|
59
57
|
* @summary: Get shipment's customer
|
|
60
58
|
* @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
|
|
@@ -250,59 +248,13 @@ class Order {
|
|
|
250
248
|
return response;
|
|
251
249
|
}
|
|
252
250
|
|
|
253
|
-
/**
|
|
254
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
255
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
256
|
-
* @returns {Promise<OrderById>} - Success response
|
|
257
|
-
* @name getPosOrderById
|
|
258
|
-
* @summary: Retrieves POS order details
|
|
259
|
-
* @description: Retrieve a POS order and all its 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/getPosOrderById/).
|
|
260
|
-
*/
|
|
261
|
-
async getPosOrderById(
|
|
262
|
-
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
263
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
264
|
-
) {
|
|
265
|
-
const errors = validateRequiredParams(arguments[0], ["orderId"]);
|
|
266
|
-
if (errors.length > 0) {
|
|
267
|
-
const error = new FDKClientValidationError({
|
|
268
|
-
message: "Missing required field",
|
|
269
|
-
details: errors,
|
|
270
|
-
});
|
|
271
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
const query_params = {};
|
|
275
|
-
|
|
276
|
-
const xHeaders = {};
|
|
277
|
-
|
|
278
|
-
const response = await ApplicationAPIClient.execute(
|
|
279
|
-
this._conf,
|
|
280
|
-
"get",
|
|
281
|
-
constructUrl({
|
|
282
|
-
url: this._urls["getPosOrderById"],
|
|
283
|
-
params: { orderId },
|
|
284
|
-
}),
|
|
285
|
-
query_params,
|
|
286
|
-
undefined,
|
|
287
|
-
{ ...xHeaders, ...requestHeaders },
|
|
288
|
-
{ responseHeaders }
|
|
289
|
-
);
|
|
290
|
-
|
|
291
|
-
let responseData = response;
|
|
292
|
-
if (responseHeaders) {
|
|
293
|
-
responseData = response[0];
|
|
294
|
-
}
|
|
295
|
-
|
|
296
|
-
return response;
|
|
297
|
-
}
|
|
298
|
-
|
|
299
251
|
/**
|
|
300
252
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
301
253
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
302
254
|
* @returns {Promise<ShipmentBagReasons>} - Success response
|
|
303
255
|
* @name getShipmentBagReasons
|
|
304
|
-
* @summary:
|
|
305
|
-
* @description:
|
|
256
|
+
* @summary: List bag cancellation reasons
|
|
257
|
+
* @description: Get reasons to perform full or partial cancellation of a bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
|
|
306
258
|
*/
|
|
307
259
|
async getShipmentBagReasons(
|
|
308
260
|
{ shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -441,7 +393,7 @@ class Order {
|
|
|
441
393
|
/**
|
|
442
394
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
443
395
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
444
|
-
* @returns {Promise<
|
|
396
|
+
* @returns {Promise<SendOtpToCustomerResponse>} - Success response
|
|
445
397
|
* @name sendOtpToShipmentCustomer
|
|
446
398
|
* @summary: Send OTP to customer
|
|
447
399
|
* @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
|
|
@@ -536,10 +488,10 @@ class Order {
|
|
|
536
488
|
/**
|
|
537
489
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
538
490
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
539
|
-
* @returns {Promise<
|
|
491
|
+
* @returns {Promise<ShipmentApplicationStatusResponse>} - Success response
|
|
540
492
|
* @name updateShipmentStatus
|
|
541
493
|
* @summary: Updates shipment status
|
|
542
|
-
* @description:
|
|
494
|
+
* @description: Update current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
|
|
543
495
|
*/
|
|
544
496
|
async updateShipmentStatus(
|
|
545
497
|
{ shipmentId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -582,10 +534,10 @@ class Order {
|
|
|
582
534
|
/**
|
|
583
535
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
584
536
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
585
|
-
* @returns {Promise<
|
|
537
|
+
* @returns {Promise<VerifyOtpResponse>} - Success response
|
|
586
538
|
* @name verifyOtpShipmentCustomer
|
|
587
539
|
* @summary: Verifies OTP
|
|
588
|
-
* @description: Verify OTP
|
|
540
|
+
* @description: Verify OTP sent by customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
|
|
589
541
|
*/
|
|
590
542
|
async verifyOtpShipmentCustomer(
|
|
591
543
|
{ orderId, shipmentId, body, requestHeaders } = { requestHeaders: {} },
|