@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
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 +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- 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 +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- 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 +4 -2
- 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/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -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 +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/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/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
const {
|
|
2
|
+
FDKClientValidationError,
|
|
3
|
+
FDKResponseValidationError,
|
|
4
|
+
} = require("../../common/FDKError");
|
|
5
|
+
|
|
6
|
+
const ApplicationAPIClient = require("../ApplicationAPIClient");
|
|
7
|
+
const constructUrl = require("../constructUrl");
|
|
8
|
+
const Paginator = require("../../common/Paginator");
|
|
9
|
+
const { validateRequiredParams } = require("../../common/Validator");
|
|
10
|
+
|
|
11
|
+
class Finance {
|
|
12
|
+
constructor(_conf) {
|
|
13
|
+
this._conf = _conf;
|
|
14
|
+
this._relativeUrls = {
|
|
15
|
+
customerCreditBalance:
|
|
16
|
+
"/service/application/finance/v1.0/customer-credit-balance",
|
|
17
|
+
lockUnlockCreditNote:
|
|
18
|
+
"/service/application/finance/v1.0/lock-unlock-credit-note",
|
|
19
|
+
};
|
|
20
|
+
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
21
|
+
(urls, [method, relativeUrl]) => {
|
|
22
|
+
urls[method] = `${_conf.domain}${relativeUrl}`;
|
|
23
|
+
return urls;
|
|
24
|
+
},
|
|
25
|
+
{}
|
|
26
|
+
);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
updateUrls(urls) {
|
|
30
|
+
this._urls = {
|
|
31
|
+
...this._urls,
|
|
32
|
+
...urls,
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
39
|
+
* @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
|
|
40
|
+
* @name customerCreditBalance
|
|
41
|
+
* @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
|
|
42
|
+
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
|
|
43
|
+
*/
|
|
44
|
+
async customerCreditBalance(
|
|
45
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
46
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
47
|
+
) {
|
|
48
|
+
const query_params = {};
|
|
49
|
+
|
|
50
|
+
const xHeaders = {};
|
|
51
|
+
|
|
52
|
+
const response = await ApplicationAPIClient.execute(
|
|
53
|
+
this._conf,
|
|
54
|
+
"post",
|
|
55
|
+
constructUrl({
|
|
56
|
+
url: this._urls["customerCreditBalance"],
|
|
57
|
+
params: {},
|
|
58
|
+
}),
|
|
59
|
+
query_params,
|
|
60
|
+
body,
|
|
61
|
+
{ ...xHeaders, ...requestHeaders },
|
|
62
|
+
{ responseHeaders }
|
|
63
|
+
);
|
|
64
|
+
|
|
65
|
+
let responseData = response;
|
|
66
|
+
if (responseHeaders) {
|
|
67
|
+
responseData = response[0];
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
return response;
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
75
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
76
|
+
* @returns {Promise<LockUnlockResponseSchema>} - Success response
|
|
77
|
+
* @name lockUnlockCreditNote
|
|
78
|
+
* @summary: Lock or Unlock requested credit note.
|
|
79
|
+
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
|
|
80
|
+
*/
|
|
81
|
+
async lockUnlockCreditNote(
|
|
82
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
83
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
84
|
+
) {
|
|
85
|
+
const query_params = {};
|
|
86
|
+
|
|
87
|
+
const xHeaders = {};
|
|
88
|
+
|
|
89
|
+
const response = await ApplicationAPIClient.execute(
|
|
90
|
+
this._conf,
|
|
91
|
+
"post",
|
|
92
|
+
constructUrl({
|
|
93
|
+
url: this._urls["lockUnlockCreditNote"],
|
|
94
|
+
params: {},
|
|
95
|
+
}),
|
|
96
|
+
query_params,
|
|
97
|
+
body,
|
|
98
|
+
{ ...xHeaders, ...requestHeaders },
|
|
99
|
+
{ responseHeaders }
|
|
100
|
+
);
|
|
101
|
+
|
|
102
|
+
let responseData = response;
|
|
103
|
+
if (responseHeaders) {
|
|
104
|
+
responseData = response[0];
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
return response;
|
|
108
|
+
}
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
module.exports = Finance;
|
|
@@ -50,10 +50,10 @@ declare class Lead {
|
|
|
50
50
|
/**
|
|
51
51
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
52
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
53
|
-
* @returns {Promise<
|
|
53
|
+
* @returns {Promise<SubmitCustomFormDetails>} - Success response
|
|
54
54
|
* @name submitCustomForm
|
|
55
55
|
* @summary: Submits form data
|
|
56
56
|
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
|
|
57
57
|
*/
|
|
58
|
-
submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
58
|
+
submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SubmitCustomFormDetails>;
|
|
59
59
|
}
|
|
@@ -212,7 +212,7 @@ class Lead {
|
|
|
212
212
|
/**
|
|
213
213
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
214
214
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
215
|
-
* @returns {Promise<
|
|
215
|
+
* @returns {Promise<SubmitCustomFormDetails>} - Success response
|
|
216
216
|
* @name submitCustomForm
|
|
217
217
|
* @summary: Submits form data
|
|
218
218
|
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
|
|
@@ -6,6 +6,8 @@ declare class Logistic {
|
|
|
6
6
|
getAllCountries: string;
|
|
7
7
|
getCountries: string;
|
|
8
8
|
getCountry: string;
|
|
9
|
+
getCourierPartners: string;
|
|
10
|
+
getDeliveryPromise: string;
|
|
9
11
|
getLocalities: string;
|
|
10
12
|
getLocality: string;
|
|
11
13
|
getLocations: string;
|
|
@@ -20,12 +22,12 @@ declare class Logistic {
|
|
|
20
22
|
/**
|
|
21
23
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
22
24
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
23
|
-
* @returns {Promise<
|
|
25
|
+
* @returns {Promise<CountryListResult>} - Success response
|
|
24
26
|
* @name getAllCountries
|
|
25
27
|
* @summary: Get deliverable countries
|
|
26
28
|
* @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/).
|
|
27
29
|
*/
|
|
28
|
-
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
30
|
+
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CountryListResult>;
|
|
29
31
|
/**
|
|
30
32
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
33
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -34,7 +36,7 @@ declare class Logistic {
|
|
|
34
36
|
* @summary: Get countries
|
|
35
37
|
* @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
36
38
|
*/
|
|
37
|
-
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
|
|
39
|
+
getCountries({ onboarding, pageNo, pageSize, q, hierarchy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
|
|
38
40
|
/**
|
|
39
41
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
40
42
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -44,6 +46,24 @@ declare class Logistic {
|
|
|
44
46
|
* @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/).
|
|
45
47
|
*/
|
|
46
48
|
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>;
|
|
47
67
|
/**
|
|
48
68
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
49
69
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -65,55 +85,55 @@ declare class Logistic {
|
|
|
65
85
|
/**
|
|
66
86
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
67
87
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
68
|
-
* @returns {Promise<
|
|
88
|
+
* @returns {Promise<GetStoreResult>} - Success response
|
|
69
89
|
* @name getLocations
|
|
70
90
|
* @summary: Get available selling locations
|
|
71
91
|
* @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/).
|
|
72
92
|
*/
|
|
73
|
-
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
93
|
+
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetStoreResult>;
|
|
74
94
|
/**
|
|
75
95
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
76
96
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
77
|
-
* @returns {Promise<
|
|
97
|
+
* @returns {Promise<ReAssignStoreResult>} - Success response
|
|
78
98
|
* @name getOptimalLocations
|
|
79
99
|
* @summary: Get selling locations
|
|
80
100
|
* @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/).
|
|
81
101
|
*/
|
|
82
|
-
getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
102
|
+
getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReAssignStoreResult>;
|
|
83
103
|
/**
|
|
84
104
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
105
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
86
|
-
* @returns {Promise<
|
|
106
|
+
* @returns {Promise<PincodeDetails>} - Success response
|
|
87
107
|
* @name getPincodeCity
|
|
88
108
|
* @summary: Get pincode details
|
|
89
109
|
* @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/).
|
|
90
110
|
*/
|
|
91
|
-
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
111
|
+
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<PincodeDetails>;
|
|
92
112
|
/**
|
|
93
113
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
94
114
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
95
|
-
* @returns {Promise<
|
|
115
|
+
* @returns {Promise<GetZoneFromPincodeViewResult>} - Success response
|
|
96
116
|
* @name getPincodeZones
|
|
97
117
|
* @summary: Get zones
|
|
98
118
|
* @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
99
119
|
*/
|
|
100
|
-
getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
120
|
+
getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetZoneFromPincodeViewResult>;
|
|
101
121
|
/**
|
|
102
122
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
103
123
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
104
|
-
* @returns {Promise<
|
|
124
|
+
* @returns {Promise<TATViewResult>} - Success response
|
|
105
125
|
* @name getTatProduct
|
|
106
126
|
* @summary: Get product's turnaround time
|
|
107
127
|
* @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/).
|
|
108
128
|
*/
|
|
109
|
-
getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
129
|
+
getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TATViewResult>;
|
|
110
130
|
/**
|
|
111
131
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
112
132
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
113
|
-
* @returns {Promise<
|
|
133
|
+
* @returns {Promise<ValidateAddressDetails>} - Success response
|
|
114
134
|
* @name validateAddress
|
|
115
135
|
* @summary: Validate address
|
|
116
136
|
* @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/).
|
|
117
137
|
*/
|
|
118
|
-
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
138
|
+
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ValidateAddressDetails>;
|
|
119
139
|
}
|
|
@@ -16,6 +16,10 @@ 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",
|
|
19
23
|
getLocalities:
|
|
20
24
|
"/service/application/logistics/v1.0/localities/{locality_type}",
|
|
21
25
|
getLocality:
|
|
@@ -48,7 +52,7 @@ class Logistic {
|
|
|
48
52
|
/**
|
|
49
53
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
54
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
51
|
-
* @returns {Promise<
|
|
55
|
+
* @returns {Promise<CountryListResult>} - Success response
|
|
52
56
|
* @name getAllCountries
|
|
53
57
|
* @summary: Get deliverable countries
|
|
54
58
|
* @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/).
|
|
@@ -91,7 +95,7 @@ class Logistic {
|
|
|
91
95
|
* @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
92
96
|
*/
|
|
93
97
|
async getCountries(
|
|
94
|
-
{ onboarding, pageNo, pageSize, q, requestHeaders } = {
|
|
98
|
+
{ onboarding, pageNo, pageSize, q, hierarchy, requestHeaders } = {
|
|
95
99
|
requestHeaders: {},
|
|
96
100
|
},
|
|
97
101
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -101,6 +105,7 @@ class Logistic {
|
|
|
101
105
|
query_params["page_no"] = pageNo;
|
|
102
106
|
query_params["page_size"] = pageSize;
|
|
103
107
|
query_params["q"] = q;
|
|
108
|
+
query_params["hierarchy"] = hierarchy;
|
|
104
109
|
|
|
105
110
|
const xHeaders = {};
|
|
106
111
|
|
|
@@ -171,6 +176,94 @@ class Logistic {
|
|
|
171
176
|
return response;
|
|
172
177
|
}
|
|
173
178
|
|
|
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
|
+
|
|
174
267
|
/**
|
|
175
268
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
176
269
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -289,7 +382,7 @@ class Logistic {
|
|
|
289
382
|
/**
|
|
290
383
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
291
384
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
292
|
-
* @returns {Promise<
|
|
385
|
+
* @returns {Promise<GetStoreResult>} - Success response
|
|
293
386
|
* @name getLocations
|
|
294
387
|
* @summary: Get available selling locations
|
|
295
388
|
* @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/).
|
|
@@ -346,7 +439,7 @@ class Logistic {
|
|
|
346
439
|
/**
|
|
347
440
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
348
441
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
349
|
-
* @returns {Promise<
|
|
442
|
+
* @returns {Promise<ReAssignStoreResult>} - Success response
|
|
350
443
|
* @name getOptimalLocations
|
|
351
444
|
* @summary: Get selling locations
|
|
352
445
|
* @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/).
|
|
@@ -383,7 +476,7 @@ class Logistic {
|
|
|
383
476
|
/**
|
|
384
477
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
385
478
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
386
|
-
* @returns {Promise<
|
|
479
|
+
* @returns {Promise<PincodeDetails>} - Success response
|
|
387
480
|
* @name getPincodeCity
|
|
388
481
|
* @summary: Get pincode details
|
|
389
482
|
* @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/).
|
|
@@ -429,7 +522,7 @@ class Logistic {
|
|
|
429
522
|
/**
|
|
430
523
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
431
524
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
432
|
-
* @returns {Promise<
|
|
525
|
+
* @returns {Promise<GetZoneFromPincodeViewResult>} - Success response
|
|
433
526
|
* @name getPincodeZones
|
|
434
527
|
* @summary: Get zones
|
|
435
528
|
* @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
@@ -466,7 +559,7 @@ class Logistic {
|
|
|
466
559
|
/**
|
|
467
560
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
468
561
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
469
|
-
* @returns {Promise<
|
|
562
|
+
* @returns {Promise<TATViewResult>} - Success response
|
|
470
563
|
* @name getTatProduct
|
|
471
564
|
* @summary: Get product's turnaround time
|
|
472
565
|
* @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/).
|
|
@@ -503,7 +596,7 @@ class Logistic {
|
|
|
503
596
|
/**
|
|
504
597
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
505
598
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
506
|
-
* @returns {Promise<
|
|
599
|
+
* @returns {Promise<ValidateAddressDetails>} - Success response
|
|
507
600
|
* @name validateAddress
|
|
508
601
|
* @summary: Validate address
|
|
509
602
|
* @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,6 +7,7 @@ declare class Order {
|
|
|
7
7
|
getInvoiceByShipmentId: string;
|
|
8
8
|
getOrderById: string;
|
|
9
9
|
getOrders: string;
|
|
10
|
+
getPosOrderById: string;
|
|
10
11
|
getShipmentBagReasons: string;
|
|
11
12
|
getShipmentById: string;
|
|
12
13
|
getShipmentReasons: string;
|
|
@@ -20,12 +21,12 @@ declare class Order {
|
|
|
20
21
|
/**
|
|
21
22
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
22
23
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
23
|
-
* @returns {Promise<
|
|
24
|
+
* @returns {Promise<CustomerDetailsResponseSchema>} - Success response
|
|
24
25
|
* @name getCustomerDetailsByShipmentId
|
|
25
26
|
* @summary: Get shipment's customer
|
|
26
27
|
* @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/).
|
|
27
28
|
*/
|
|
28
|
-
getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
29
|
+
getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CustomerDetailsResponseSchema>;
|
|
29
30
|
/**
|
|
30
31
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
32
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -53,13 +54,22 @@ declare class Order {
|
|
|
53
54
|
* @description: Get all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
|
|
54
55
|
*/
|
|
55
56
|
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>;
|
|
56
66
|
/**
|
|
57
67
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
68
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
59
69
|
* @returns {Promise<ShipmentBagReasons>} - Success response
|
|
60
70
|
* @name getShipmentBagReasons
|
|
61
|
-
* @summary:
|
|
62
|
-
* @description:
|
|
71
|
+
* @summary: Retrieve Reasons for Cancellation and Return journey
|
|
72
|
+
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
|
|
63
73
|
*/
|
|
64
74
|
getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentBagReasons>;
|
|
65
75
|
/**
|
|
@@ -83,12 +93,12 @@ declare class Order {
|
|
|
83
93
|
/**
|
|
84
94
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
95
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
86
|
-
* @returns {Promise<
|
|
96
|
+
* @returns {Promise<SendOtpToCustomerResponseSchema>} - Success response
|
|
87
97
|
* @name sendOtpToShipmentCustomer
|
|
88
98
|
* @summary: Send OTP to customer
|
|
89
99
|
* @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
|
|
90
100
|
*/
|
|
91
|
-
sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
101
|
+
sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SendOtpToCustomerResponseSchema>;
|
|
92
102
|
/**
|
|
93
103
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
94
104
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -101,19 +111,19 @@ declare class Order {
|
|
|
101
111
|
/**
|
|
102
112
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
103
113
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
104
|
-
* @returns {Promise<
|
|
114
|
+
* @returns {Promise<ShipmentApplicationStatusResponseSchema>} - Success response
|
|
105
115
|
* @name updateShipmentStatus
|
|
106
116
|
* @summary: Updates shipment status
|
|
107
|
-
* @description:
|
|
117
|
+
* @description: This operation allows for updating the status and properties of a shipment. For example, it allows users to initiate a return by providing reasons and uploading quality check images. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
|
|
108
118
|
*/
|
|
109
|
-
updateShipmentStatus({ shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
119
|
+
updateShipmentStatus({ shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentApplicationStatusResponseSchema>;
|
|
110
120
|
/**
|
|
111
121
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
112
122
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
113
|
-
* @returns {Promise<
|
|
123
|
+
* @returns {Promise<VerifyOtpResponseSchema>} - Success response
|
|
114
124
|
* @name verifyOtpShipmentCustomer
|
|
115
125
|
* @summary: Verifies OTP
|
|
116
|
-
* @description: Verify OTP
|
|
126
|
+
* @description: Verify OTP for getting shipment details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
|
|
117
127
|
*/
|
|
118
|
-
verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<
|
|
128
|
+
verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<VerifyOtpResponseSchema>;
|
|
119
129
|
}
|