@gofynd/fdk-client-javascript 1.4.15 → 1.4.16-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +16 -16
- package/sdk/application/Cart/CartApplicationClient.js +101 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -16
- package/sdk/application/Catalog/CatalogApplicationClient.js +159 -0
- package/sdk/application/Common/CommonApplicationClient.js +6 -0
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +24 -0
- package/sdk/application/Content/ContentApplicationClient.d.ts +59 -7
- package/sdk/application/Content/ContentApplicationClient.js +290 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +24 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +6 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
- package/sdk/application/Lead/LeadApplicationClient.js +42 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.js +69 -2
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
- package/sdk/application/Order/OrderApplicationClient.js +117 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -11
- package/sdk/application/Payment/PaymentApplicationClient.js +15 -39
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +15 -0
- package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationClient.js +42 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +36 -0
- package/sdk/application/User/UserApplicationClient.js +6 -0
- package/sdk/application/Webhook/WebhookApplicationClient.js +6 -0
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +4 -4
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +12 -33
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +38 -209
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +19 -399
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +11 -212
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -3
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -22
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
- package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +12 -3
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -1
- package/sdk/platform/Cart/CartPlatformModel.d.ts +49 -28
- package/sdk/platform/Cart/CartPlatformModel.js +23 -13
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -24
- package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -176
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.js +36 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -45
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -35
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +132 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1104 -122
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +159 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +161 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +220 -5
- package/sdk/platform/Content/ContentPlatformModel.js +214 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +12 -2
- package/sdk/platform/Order/OrderPlatformClient.js +99 -8
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3 -75
- package/sdk/platform/Order/OrderPlatformModel.js +2 -43
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -23
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -95
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +78 -701
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +23 -598
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +20 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +3 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -110
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +10 -2
- package/sdk/platform/Share/SharePlatformModel.js +4 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
- package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +3 -3
- package/sdk/public/Content/ContentPublicClient.js +28 -0
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +10 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +1 -0
|
@@ -1,6 +1,12 @@
|
|
|
1
|
+
const {
|
|
2
|
+
FDKClientValidationError,
|
|
3
|
+
FDKResponseValidationError,
|
|
4
|
+
} = require("../../common/FDKError");
|
|
5
|
+
|
|
1
6
|
const ApplicationAPIClient = require("../ApplicationAPIClient");
|
|
2
7
|
const constructUrl = require("../constructUrl");
|
|
3
8
|
const Paginator = require("../../common/Paginator");
|
|
9
|
+
const { validateRequiredParams } = require("../../common/Validator");
|
|
4
10
|
|
|
5
11
|
class Share {
|
|
6
12
|
constructor(_conf) {
|
|
@@ -120,6 +126,15 @@ class Share {
|
|
|
120
126
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
121
127
|
{ responseHeaders } = { responseHeaders: false }
|
|
122
128
|
) {
|
|
129
|
+
const errors = validateRequiredParams(arguments[0], ["slug"]);
|
|
130
|
+
if (errors.length > 0) {
|
|
131
|
+
const error = new FDKClientValidationError({
|
|
132
|
+
message: "Missing required field",
|
|
133
|
+
details: errors,
|
|
134
|
+
});
|
|
135
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
136
|
+
}
|
|
137
|
+
|
|
123
138
|
const query_params = {};
|
|
124
139
|
|
|
125
140
|
const xHeaders = {};
|
|
@@ -157,6 +172,15 @@ class Share {
|
|
|
157
172
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
158
173
|
{ responseHeaders } = { responseHeaders: false }
|
|
159
174
|
) {
|
|
175
|
+
const errors = validateRequiredParams(arguments[0], ["hash"]);
|
|
176
|
+
if (errors.length > 0) {
|
|
177
|
+
const error = new FDKClientValidationError({
|
|
178
|
+
message: "Missing required field",
|
|
179
|
+
details: errors,
|
|
180
|
+
});
|
|
181
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
182
|
+
}
|
|
183
|
+
|
|
160
184
|
const query_params = {};
|
|
161
185
|
|
|
162
186
|
const xHeaders = {};
|
|
@@ -194,6 +218,15 @@ class Share {
|
|
|
194
218
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
195
219
|
{ responseHeaders } = { responseHeaders: false }
|
|
196
220
|
) {
|
|
221
|
+
const errors = validateRequiredParams(arguments[0], ["slug"]);
|
|
222
|
+
if (errors.length > 0) {
|
|
223
|
+
const error = new FDKClientValidationError({
|
|
224
|
+
message: "Missing required field",
|
|
225
|
+
details: errors,
|
|
226
|
+
});
|
|
227
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
228
|
+
}
|
|
229
|
+
|
|
197
230
|
const query_params = {};
|
|
198
231
|
|
|
199
232
|
const xHeaders = {};
|
|
@@ -231,6 +264,15 @@ class Share {
|
|
|
231
264
|
{ hash, requestHeaders } = { requestHeaders: {} },
|
|
232
265
|
{ responseHeaders } = { responseHeaders: false }
|
|
233
266
|
) {
|
|
267
|
+
const errors = validateRequiredParams(arguments[0], ["hash"]);
|
|
268
|
+
if (errors.length > 0) {
|
|
269
|
+
const error = new FDKClientValidationError({
|
|
270
|
+
message: "Missing required field",
|
|
271
|
+
details: errors,
|
|
272
|
+
});
|
|
273
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
274
|
+
}
|
|
275
|
+
|
|
234
276
|
const query_params = {};
|
|
235
277
|
|
|
236
278
|
const xHeaders = {};
|
|
@@ -18,7 +18,7 @@ declare class Theme {
|
|
|
18
18
|
* @summary: List pages
|
|
19
19
|
* @description: Get all page level configs, sections and seo data of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
|
|
20
20
|
*/
|
|
21
|
-
getAllPages({ themeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AllAvailablePageSchema>;
|
|
21
|
+
getAllPages({ themeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<AllAvailablePageSchema>;
|
|
22
22
|
/**
|
|
23
23
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
24
24
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -36,7 +36,7 @@ declare class Theme {
|
|
|
36
36
|
* @summary: Get theme page
|
|
37
37
|
* @description: Get page level configurations, applied sections and seo data of a page by `page_value` received from list pages api. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getPage/).
|
|
38
38
|
*/
|
|
39
|
-
getPage({ themeId, pageValue, filters, sectionPreviewHash, company, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AvailablePageSchema>;
|
|
39
|
+
getPage({ themeId, pageValue, filters, sectionPreviewHash, company, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<AvailablePageSchema>;
|
|
40
40
|
/**
|
|
41
41
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
42
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -45,5 +45,5 @@ declare class Theme {
|
|
|
45
45
|
* @summary: Get theme for preview
|
|
46
46
|
* @description: Gets the theme configuration and template details of a theme by theme id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
|
|
47
47
|
*/
|
|
48
|
-
getThemeForPreview({ themeId, filters, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ThemesSchema>;
|
|
48
|
+
getThemeForPreview({ themeId, filters, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ThemesSchema>;
|
|
49
49
|
}
|
|
@@ -1,6 +1,12 @@
|
|
|
1
|
+
const {
|
|
2
|
+
FDKClientValidationError,
|
|
3
|
+
FDKResponseValidationError,
|
|
4
|
+
} = require("../../common/FDKError");
|
|
5
|
+
|
|
1
6
|
const ApplicationAPIClient = require("../ApplicationAPIClient");
|
|
2
7
|
const constructUrl = require("../constructUrl");
|
|
3
8
|
const Paginator = require("../../common/Paginator");
|
|
9
|
+
const { validateRequiredParams } = require("../../common/Validator");
|
|
4
10
|
|
|
5
11
|
class Theme {
|
|
6
12
|
constructor(_conf) {
|
|
@@ -39,6 +45,15 @@ class Theme {
|
|
|
39
45
|
{ themeId, requestHeaders } = { requestHeaders: {} },
|
|
40
46
|
{ responseHeaders } = { responseHeaders: false }
|
|
41
47
|
) {
|
|
48
|
+
const errors = validateRequiredParams(arguments[0], ["themeId"]);
|
|
49
|
+
if (errors.length > 0) {
|
|
50
|
+
const error = new FDKClientValidationError({
|
|
51
|
+
message: "Missing required field",
|
|
52
|
+
details: errors,
|
|
53
|
+
});
|
|
54
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
55
|
+
}
|
|
56
|
+
|
|
42
57
|
const query_params = {};
|
|
43
58
|
|
|
44
59
|
const xHeaders = {};
|
|
@@ -121,6 +136,18 @@ class Theme {
|
|
|
121
136
|
} = { requestHeaders: {} },
|
|
122
137
|
{ responseHeaders } = { responseHeaders: false }
|
|
123
138
|
) {
|
|
139
|
+
const errors = validateRequiredParams(arguments[0], [
|
|
140
|
+
"themeId",
|
|
141
|
+
"pageValue",
|
|
142
|
+
]);
|
|
143
|
+
if (errors.length > 0) {
|
|
144
|
+
const error = new FDKClientValidationError({
|
|
145
|
+
message: "Missing required field",
|
|
146
|
+
details: errors,
|
|
147
|
+
});
|
|
148
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
149
|
+
}
|
|
150
|
+
|
|
124
151
|
const query_params = {};
|
|
125
152
|
query_params["filters"] = filters;
|
|
126
153
|
query_params["section_preview_hash"] = sectionPreviewHash;
|
|
@@ -161,6 +188,15 @@ class Theme {
|
|
|
161
188
|
{ themeId, filters, requestHeaders } = { requestHeaders: {} },
|
|
162
189
|
{ responseHeaders } = { responseHeaders: false }
|
|
163
190
|
) {
|
|
191
|
+
const errors = validateRequiredParams(arguments[0], ["themeId"]);
|
|
192
|
+
if (errors.length > 0) {
|
|
193
|
+
const error = new FDKClientValidationError({
|
|
194
|
+
message: "Missing required field",
|
|
195
|
+
details: errors,
|
|
196
|
+
});
|
|
197
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
198
|
+
}
|
|
199
|
+
|
|
164
200
|
const query_params = {};
|
|
165
201
|
query_params["filters"] = filters;
|
|
166
202
|
|
|
@@ -1,6 +1,12 @@
|
|
|
1
|
+
const {
|
|
2
|
+
FDKClientValidationError,
|
|
3
|
+
FDKResponseValidationError,
|
|
4
|
+
} = require("../../common/FDKError");
|
|
5
|
+
|
|
1
6
|
const ApplicationAPIClient = require("../ApplicationAPIClient");
|
|
2
7
|
const constructUrl = require("../constructUrl");
|
|
3
8
|
const Paginator = require("../../common/Paginator");
|
|
9
|
+
const { validateRequiredParams } = require("../../common/Validator");
|
|
4
10
|
|
|
5
11
|
class User {
|
|
6
12
|
constructor(_conf) {
|
|
@@ -1,6 +1,12 @@
|
|
|
1
|
+
const {
|
|
2
|
+
FDKClientValidationError,
|
|
3
|
+
FDKResponseValidationError,
|
|
4
|
+
} = require("../../common/FDKError");
|
|
5
|
+
|
|
1
6
|
const ApplicationAPIClient = require("../ApplicationAPIClient");
|
|
2
7
|
const constructUrl = require("../constructUrl");
|
|
3
8
|
const Paginator = require("../../common/Paginator");
|
|
9
|
+
const { validateRequiredParams } = require("../../common/Validator");
|
|
4
10
|
|
|
5
11
|
class Webhook {
|
|
6
12
|
constructor(_conf) {
|
package/sdk/common/Utility.d.ts
CHANGED
package/sdk/common/Utility.js
CHANGED
|
@@ -65,7 +65,7 @@ function convertUrlToAction(url) {
|
|
|
65
65
|
}
|
|
66
66
|
}
|
|
67
67
|
|
|
68
|
-
function convertActionToUrl(action) {
|
|
68
|
+
function convertActionToUrl(action, locale) {
|
|
69
69
|
if (action && action.page && action.page.type) {
|
|
70
70
|
switch (action.type) {
|
|
71
71
|
case utils.NAV_TYPE.PAGE: {
|
|
@@ -83,16 +83,16 @@ function convertActionToUrl(action) {
|
|
|
83
83
|
item.link +=
|
|
84
84
|
"/?" + utils.transformRequestOptions(action.page.query);
|
|
85
85
|
}
|
|
86
|
-
return item.link;
|
|
86
|
+
return locale ? `/${locale}${item.link}` : item.link;
|
|
87
87
|
}
|
|
88
|
-
return "";
|
|
88
|
+
return locale ? `/${locale}` : "";
|
|
89
89
|
}
|
|
90
90
|
case utils.NAV_TYPE.POPUP: {
|
|
91
91
|
break;
|
|
92
92
|
}
|
|
93
93
|
}
|
|
94
94
|
} else {
|
|
95
|
-
return "";
|
|
95
|
+
return locale ? `/${locale}` : "";
|
|
96
96
|
}
|
|
97
97
|
}
|
|
98
98
|
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export function validateRequiredParams(params: any, requiredParams: any): any[];
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
function validateRequiredParams(params, requiredParams) {
|
|
2
|
+
const errors = [];
|
|
3
|
+
requiredParams.forEach((key) => {
|
|
4
|
+
const value = params[key];
|
|
5
|
+
|
|
6
|
+
// Reject missing or empty values (except for boolean false)
|
|
7
|
+
if (
|
|
8
|
+
value === undefined ||
|
|
9
|
+
value === null ||
|
|
10
|
+
(typeof value !== "boolean" && value === "")
|
|
11
|
+
) {
|
|
12
|
+
errors.push(`Missing or empty required parameter: ${key}`);
|
|
13
|
+
}
|
|
14
|
+
});
|
|
15
|
+
return errors;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
module.exports = {
|
|
19
|
+
validateRequiredParams,
|
|
20
|
+
};
|
|
@@ -222,61 +222,40 @@ declare class Logistics {
|
|
|
222
222
|
* @description: This API returns response DpAccount of a company from mongo database. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCourierPartnerAccount/).
|
|
223
223
|
*/
|
|
224
224
|
getCourierPartnerAccount({ companyId, accountId, requestHeaders }?: LogisticsPartnerValidator.GetCourierPartnerAccountParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.CourierAccountResult>;
|
|
225
|
-
/**
|
|
226
|
-
* @param {LogisticsPartnerValidator.GetCountriesParam} arg - Arg object.
|
|
227
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
228
|
-
* @param {import("../PartnerAPIClient").Options} - Options
|
|
229
|
-
* @returns {Promise<LogisticsPartnerModel.GetCountries>} - Success response
|
|
230
|
-
* @name getCountries
|
|
231
|
-
* @summary: Get all countries and associated data
|
|
232
|
-
* @description: Retrieve of all countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCountries/).
|
|
233
|
-
*/
|
|
234
|
-
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: LogisticsPartnerValidator.GetCountriesParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.GetCountries>;
|
|
235
225
|
/**
|
|
236
226
|
* @param {LogisticsPartnerValidator.CreateCourierPartnerSchemeParam} arg -
|
|
237
227
|
* Arg object.
|
|
238
228
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
239
229
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
240
|
-
* @returns {Promise<LogisticsPartnerModel.
|
|
230
|
+
* @returns {Promise<LogisticsPartnerModel.CourierPartnerSchemeModel>} -
|
|
241
231
|
* Success response
|
|
242
232
|
* @name createCourierPartnerScheme
|
|
243
233
|
* @summary: Create Scheme for courier partner extension
|
|
244
234
|
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/createCourierPartnerScheme/).
|
|
245
235
|
*/
|
|
246
|
-
createCourierPartnerScheme({ body, requestHeaders }?: LogisticsPartnerValidator.CreateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.
|
|
247
|
-
/**
|
|
248
|
-
* @param {LogisticsPartnerValidator.GetCourierPartnerSchemesParam} arg - Arg object.
|
|
249
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
250
|
-
* @param {import("../PartnerAPIClient").Options} - Options
|
|
251
|
-
* @returns {Promise<LogisticsPartnerModel.courierPartnerSchemeV2List>} -
|
|
252
|
-
* Success response
|
|
253
|
-
* @name getCourierPartnerSchemes
|
|
254
|
-
* @summary: Get created Schemes for courier partner
|
|
255
|
-
* @description: Get created Schemes for courier partner - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCourierPartnerSchemes/).
|
|
256
|
-
*/
|
|
257
|
-
getCourierPartnerSchemes({ schemeType, paymentMode, capabilities, schemeIds, requestHeaders }?: LogisticsPartnerValidator.GetCourierPartnerSchemesParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.courierPartnerSchemeV2List>;
|
|
236
|
+
createCourierPartnerScheme({ body, requestHeaders }?: LogisticsPartnerValidator.CreateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.CourierPartnerSchemeModel>;
|
|
258
237
|
/**
|
|
259
238
|
* @param {LogisticsPartnerValidator.UpdateCourierPartnerSchemeParam} arg -
|
|
260
239
|
* Arg object.
|
|
261
240
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
262
241
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
263
|
-
* @returns {Promise<LogisticsPartnerModel.
|
|
264
|
-
* Success response
|
|
242
|
+
* @returns {Promise<LogisticsPartnerModel.CourierPartnerSchemeUpdateDetails>}
|
|
243
|
+
* - Success response
|
|
244
|
+
*
|
|
265
245
|
* @name updateCourierPartnerScheme
|
|
266
246
|
* @summary: Update Scheme for courier partner extension
|
|
267
247
|
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/updateCourierPartnerScheme/).
|
|
268
248
|
*/
|
|
269
|
-
updateCourierPartnerScheme({ schemeId, body, requestHeaders }?: LogisticsPartnerValidator.UpdateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.
|
|
249
|
+
updateCourierPartnerScheme({ schemeId, body, requestHeaders }?: LogisticsPartnerValidator.UpdateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.CourierPartnerSchemeUpdateDetails>;
|
|
270
250
|
/**
|
|
271
|
-
* @param {LogisticsPartnerValidator.
|
|
251
|
+
* @param {LogisticsPartnerValidator.GetCountriesParam} arg - Arg object.
|
|
272
252
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
273
253
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
274
|
-
* @returns {Promise<LogisticsPartnerModel.
|
|
275
|
-
*
|
|
276
|
-
* @
|
|
277
|
-
* @
|
|
278
|
-
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCourierPartnerScheme/).
|
|
254
|
+
* @returns {Promise<LogisticsPartnerModel.GetCountries>} - Success response
|
|
255
|
+
* @name getCountries
|
|
256
|
+
* @summary: Get all countries and associated data
|
|
257
|
+
* @description: Retrieve of all countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCountries/).
|
|
279
258
|
*/
|
|
280
|
-
|
|
259
|
+
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: LogisticsPartnerValidator.GetCountriesParam, { responseHeaders }?: object): Promise<LogisticsPartnerModel.GetCountries>;
|
|
281
260
|
}
|
|
282
261
|
import LogisticsPartnerModel = require("./LogisticsPartnerModel");
|
|
@@ -1888,101 +1888,12 @@ class Logistics {
|
|
|
1888
1888
|
return response;
|
|
1889
1889
|
}
|
|
1890
1890
|
|
|
1891
|
-
/**
|
|
1892
|
-
* @param {LogisticsPartnerValidator.GetCountriesParam} arg - Arg object.
|
|
1893
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1894
|
-
* @param {import("../PartnerAPIClient").Options} - Options
|
|
1895
|
-
* @returns {Promise<LogisticsPartnerModel.GetCountries>} - Success response
|
|
1896
|
-
* @name getCountries
|
|
1897
|
-
* @summary: Get all countries and associated data
|
|
1898
|
-
* @description: Retrieve of all countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCountries/).
|
|
1899
|
-
*/
|
|
1900
|
-
async getCountries(
|
|
1901
|
-
{ onboarding, pageNo, pageSize, q, requestHeaders } = {
|
|
1902
|
-
requestHeaders: {},
|
|
1903
|
-
},
|
|
1904
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
1905
|
-
) {
|
|
1906
|
-
const { error } = LogisticsPartnerValidator.getCountries().validate(
|
|
1907
|
-
{
|
|
1908
|
-
onboarding,
|
|
1909
|
-
pageNo,
|
|
1910
|
-
pageSize,
|
|
1911
|
-
q,
|
|
1912
|
-
},
|
|
1913
|
-
{ abortEarly: false, allowUnknown: true }
|
|
1914
|
-
);
|
|
1915
|
-
if (error) {
|
|
1916
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
1917
|
-
}
|
|
1918
|
-
|
|
1919
|
-
// Showing warrnings if extra unknown parameters are found
|
|
1920
|
-
const {
|
|
1921
|
-
error: warrning,
|
|
1922
|
-
} = LogisticsPartnerValidator.getCountries().validate(
|
|
1923
|
-
{
|
|
1924
|
-
onboarding,
|
|
1925
|
-
pageNo,
|
|
1926
|
-
pageSize,
|
|
1927
|
-
q,
|
|
1928
|
-
},
|
|
1929
|
-
{ abortEarly: false, allowUnknown: false }
|
|
1930
|
-
);
|
|
1931
|
-
if (warrning) {
|
|
1932
|
-
Logger({
|
|
1933
|
-
level: "WARN",
|
|
1934
|
-
message: `Parameter Validation warrnings for partner > Logistics > getCountries \n ${warrning}`,
|
|
1935
|
-
});
|
|
1936
|
-
}
|
|
1937
|
-
|
|
1938
|
-
const query_params = {};
|
|
1939
|
-
query_params["onboarding"] = onboarding;
|
|
1940
|
-
query_params["page_no"] = pageNo;
|
|
1941
|
-
query_params["page_size"] = pageSize;
|
|
1942
|
-
query_params["q"] = q;
|
|
1943
|
-
|
|
1944
|
-
const response = await PartnerAPIClient.execute(
|
|
1945
|
-
this.config,
|
|
1946
|
-
"get",
|
|
1947
|
-
`/service/partner/logistics/v2.0/organization/${this.config.organizationId}/countries`,
|
|
1948
|
-
query_params,
|
|
1949
|
-
undefined,
|
|
1950
|
-
requestHeaders,
|
|
1951
|
-
{ responseHeaders }
|
|
1952
|
-
);
|
|
1953
|
-
|
|
1954
|
-
let responseData = response;
|
|
1955
|
-
if (responseHeaders) {
|
|
1956
|
-
responseData = response[0];
|
|
1957
|
-
}
|
|
1958
|
-
|
|
1959
|
-
const {
|
|
1960
|
-
error: res_error,
|
|
1961
|
-
} = LogisticsPartnerModel.GetCountries().validate(responseData, {
|
|
1962
|
-
abortEarly: false,
|
|
1963
|
-
allowUnknown: true,
|
|
1964
|
-
});
|
|
1965
|
-
|
|
1966
|
-
if (res_error) {
|
|
1967
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
1968
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1969
|
-
} else {
|
|
1970
|
-
Logger({
|
|
1971
|
-
level: "WARN",
|
|
1972
|
-
message: `Response Validation Warnings for partner > Logistics > getCountries \n ${res_error}`,
|
|
1973
|
-
});
|
|
1974
|
-
}
|
|
1975
|
-
}
|
|
1976
|
-
|
|
1977
|
-
return response;
|
|
1978
|
-
}
|
|
1979
|
-
|
|
1980
1891
|
/**
|
|
1981
1892
|
* @param {LogisticsPartnerValidator.CreateCourierPartnerSchemeParam} arg -
|
|
1982
1893
|
* Arg object.
|
|
1983
1894
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1984
1895
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
1985
|
-
* @returns {Promise<LogisticsPartnerModel.
|
|
1896
|
+
* @returns {Promise<LogisticsPartnerModel.CourierPartnerSchemeModel>} -
|
|
1986
1897
|
* Success response
|
|
1987
1898
|
* @name createCourierPartnerScheme
|
|
1988
1899
|
* @summary: Create Scheme for courier partner extension
|
|
@@ -2025,7 +1936,7 @@ class Logistics {
|
|
|
2025
1936
|
const response = await PartnerAPIClient.execute(
|
|
2026
1937
|
this.config,
|
|
2027
1938
|
"post",
|
|
2028
|
-
`/service/partner/logistics/
|
|
1939
|
+
`/service/partner/logistics/v1.0/organization/${this.config.organizationId}/courier-partner/scheme/`,
|
|
2029
1940
|
query_params,
|
|
2030
1941
|
body,
|
|
2031
1942
|
requestHeaders,
|
|
@@ -2039,7 +1950,7 @@ class Logistics {
|
|
|
2039
1950
|
|
|
2040
1951
|
const {
|
|
2041
1952
|
error: res_error,
|
|
2042
|
-
} = LogisticsPartnerModel.
|
|
1953
|
+
} = LogisticsPartnerModel.CourierPartnerSchemeModel().validate(
|
|
2043
1954
|
responseData,
|
|
2044
1955
|
{ abortEarly: false, allowUnknown: true }
|
|
2045
1956
|
);
|
|
@@ -2058,105 +1969,14 @@ class Logistics {
|
|
|
2058
1969
|
return response;
|
|
2059
1970
|
}
|
|
2060
1971
|
|
|
2061
|
-
/**
|
|
2062
|
-
* @param {LogisticsPartnerValidator.GetCourierPartnerSchemesParam} arg - Arg object.
|
|
2063
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2064
|
-
* @param {import("../PartnerAPIClient").Options} - Options
|
|
2065
|
-
* @returns {Promise<LogisticsPartnerModel.courierPartnerSchemeV2List>} -
|
|
2066
|
-
* Success response
|
|
2067
|
-
* @name getCourierPartnerSchemes
|
|
2068
|
-
* @summary: Get created Schemes for courier partner
|
|
2069
|
-
* @description: Get created Schemes for courier partner - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCourierPartnerSchemes/).
|
|
2070
|
-
*/
|
|
2071
|
-
async getCourierPartnerSchemes(
|
|
2072
|
-
{ schemeType, paymentMode, capabilities, schemeIds, requestHeaders } = {
|
|
2073
|
-
requestHeaders: {},
|
|
2074
|
-
},
|
|
2075
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
2076
|
-
) {
|
|
2077
|
-
const {
|
|
2078
|
-
error,
|
|
2079
|
-
} = LogisticsPartnerValidator.getCourierPartnerSchemes().validate(
|
|
2080
|
-
{
|
|
2081
|
-
schemeType,
|
|
2082
|
-
paymentMode,
|
|
2083
|
-
capabilities,
|
|
2084
|
-
schemeIds,
|
|
2085
|
-
},
|
|
2086
|
-
{ abortEarly: false, allowUnknown: true }
|
|
2087
|
-
);
|
|
2088
|
-
if (error) {
|
|
2089
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
2090
|
-
}
|
|
2091
|
-
|
|
2092
|
-
// Showing warrnings if extra unknown parameters are found
|
|
2093
|
-
const {
|
|
2094
|
-
error: warrning,
|
|
2095
|
-
} = LogisticsPartnerValidator.getCourierPartnerSchemes().validate(
|
|
2096
|
-
{
|
|
2097
|
-
schemeType,
|
|
2098
|
-
paymentMode,
|
|
2099
|
-
capabilities,
|
|
2100
|
-
schemeIds,
|
|
2101
|
-
},
|
|
2102
|
-
{ abortEarly: false, allowUnknown: false }
|
|
2103
|
-
);
|
|
2104
|
-
if (warrning) {
|
|
2105
|
-
Logger({
|
|
2106
|
-
level: "WARN",
|
|
2107
|
-
message: `Parameter Validation warrnings for partner > Logistics > getCourierPartnerSchemes \n ${warrning}`,
|
|
2108
|
-
});
|
|
2109
|
-
}
|
|
2110
|
-
|
|
2111
|
-
const query_params = {};
|
|
2112
|
-
query_params["scheme_type"] = schemeType;
|
|
2113
|
-
query_params["payment_mode"] = paymentMode;
|
|
2114
|
-
query_params["capabilities"] = capabilities;
|
|
2115
|
-
query_params["scheme_ids"] = schemeIds;
|
|
2116
|
-
|
|
2117
|
-
const response = await PartnerAPIClient.execute(
|
|
2118
|
-
this.config,
|
|
2119
|
-
"get",
|
|
2120
|
-
`/service/partner/logistics/v2.0/organization/${this.config.organizationId}/courier-partner/scheme`,
|
|
2121
|
-
query_params,
|
|
2122
|
-
undefined,
|
|
2123
|
-
requestHeaders,
|
|
2124
|
-
{ responseHeaders }
|
|
2125
|
-
);
|
|
2126
|
-
|
|
2127
|
-
let responseData = response;
|
|
2128
|
-
if (responseHeaders) {
|
|
2129
|
-
responseData = response[0];
|
|
2130
|
-
}
|
|
2131
|
-
|
|
2132
|
-
const {
|
|
2133
|
-
error: res_error,
|
|
2134
|
-
} = LogisticsPartnerModel.courierPartnerSchemeV2List().validate(
|
|
2135
|
-
responseData,
|
|
2136
|
-
{ abortEarly: false, allowUnknown: true }
|
|
2137
|
-
);
|
|
2138
|
-
|
|
2139
|
-
if (res_error) {
|
|
2140
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
2141
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
2142
|
-
} else {
|
|
2143
|
-
Logger({
|
|
2144
|
-
level: "WARN",
|
|
2145
|
-
message: `Response Validation Warnings for partner > Logistics > getCourierPartnerSchemes \n ${res_error}`,
|
|
2146
|
-
});
|
|
2147
|
-
}
|
|
2148
|
-
}
|
|
2149
|
-
|
|
2150
|
-
return response;
|
|
2151
|
-
}
|
|
2152
|
-
|
|
2153
1972
|
/**
|
|
2154
1973
|
* @param {LogisticsPartnerValidator.UpdateCourierPartnerSchemeParam} arg -
|
|
2155
1974
|
* Arg object.
|
|
2156
1975
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2157
1976
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
2158
|
-
* @returns {Promise<LogisticsPartnerModel.
|
|
2159
|
-
* Success response
|
|
1977
|
+
* @returns {Promise<LogisticsPartnerModel.CourierPartnerSchemeUpdateDetails>}
|
|
1978
|
+
* - Success response
|
|
1979
|
+
*
|
|
2160
1980
|
* @name updateCourierPartnerScheme
|
|
2161
1981
|
* @summary: Update Scheme for courier partner extension
|
|
2162
1982
|
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/updateCourierPartnerScheme/).
|
|
@@ -2200,7 +2020,7 @@ class Logistics {
|
|
|
2200
2020
|
const response = await PartnerAPIClient.execute(
|
|
2201
2021
|
this.config,
|
|
2202
2022
|
"put",
|
|
2203
|
-
`/service/partner/logistics/
|
|
2023
|
+
`/service/partner/logistics/v1.0/organization/${this.config.organizationId}/courier-partner/scheme/${schemeId}`,
|
|
2204
2024
|
query_params,
|
|
2205
2025
|
body,
|
|
2206
2026
|
requestHeaders,
|
|
@@ -2214,7 +2034,7 @@ class Logistics {
|
|
|
2214
2034
|
|
|
2215
2035
|
const {
|
|
2216
2036
|
error: res_error,
|
|
2217
|
-
} = LogisticsPartnerModel.
|
|
2037
|
+
} = LogisticsPartnerModel.CourierPartnerSchemeUpdateDetails().validate(
|
|
2218
2038
|
responseData,
|
|
2219
2039
|
{ abortEarly: false, allowUnknown: true }
|
|
2220
2040
|
);
|
|
@@ -2234,24 +2054,26 @@ class Logistics {
|
|
|
2234
2054
|
}
|
|
2235
2055
|
|
|
2236
2056
|
/**
|
|
2237
|
-
* @param {LogisticsPartnerValidator.
|
|
2057
|
+
* @param {LogisticsPartnerValidator.GetCountriesParam} arg - Arg object.
|
|
2238
2058
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2239
2059
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
2240
|
-
* @returns {Promise<LogisticsPartnerModel.
|
|
2241
|
-
*
|
|
2242
|
-
* @
|
|
2243
|
-
* @
|
|
2244
|
-
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCourierPartnerScheme/).
|
|
2060
|
+
* @returns {Promise<LogisticsPartnerModel.GetCountries>} - Success response
|
|
2061
|
+
* @name getCountries
|
|
2062
|
+
* @summary: Get all countries and associated data
|
|
2063
|
+
* @description: Retrieve of all countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/logistics/getCountries/).
|
|
2245
2064
|
*/
|
|
2246
|
-
async
|
|
2247
|
-
{
|
|
2065
|
+
async getCountries(
|
|
2066
|
+
{ onboarding, pageNo, pageSize, q, requestHeaders } = {
|
|
2067
|
+
requestHeaders: {},
|
|
2068
|
+
},
|
|
2248
2069
|
{ responseHeaders } = { responseHeaders: false }
|
|
2249
2070
|
) {
|
|
2250
|
-
const {
|
|
2251
|
-
error,
|
|
2252
|
-
} = LogisticsPartnerValidator.getCourierPartnerScheme().validate(
|
|
2071
|
+
const { error } = LogisticsPartnerValidator.getCountries().validate(
|
|
2253
2072
|
{
|
|
2254
|
-
|
|
2073
|
+
onboarding,
|
|
2074
|
+
pageNo,
|
|
2075
|
+
pageSize,
|
|
2076
|
+
q,
|
|
2255
2077
|
},
|
|
2256
2078
|
{ abortEarly: false, allowUnknown: true }
|
|
2257
2079
|
);
|
|
@@ -2262,25 +2084,32 @@ class Logistics {
|
|
|
2262
2084
|
// Showing warrnings if extra unknown parameters are found
|
|
2263
2085
|
const {
|
|
2264
2086
|
error: warrning,
|
|
2265
|
-
} = LogisticsPartnerValidator.
|
|
2087
|
+
} = LogisticsPartnerValidator.getCountries().validate(
|
|
2266
2088
|
{
|
|
2267
|
-
|
|
2089
|
+
onboarding,
|
|
2090
|
+
pageNo,
|
|
2091
|
+
pageSize,
|
|
2092
|
+
q,
|
|
2268
2093
|
},
|
|
2269
2094
|
{ abortEarly: false, allowUnknown: false }
|
|
2270
2095
|
);
|
|
2271
2096
|
if (warrning) {
|
|
2272
2097
|
Logger({
|
|
2273
2098
|
level: "WARN",
|
|
2274
|
-
message: `Parameter Validation warrnings for partner > Logistics >
|
|
2099
|
+
message: `Parameter Validation warrnings for partner > Logistics > getCountries \n ${warrning}`,
|
|
2275
2100
|
});
|
|
2276
2101
|
}
|
|
2277
2102
|
|
|
2278
2103
|
const query_params = {};
|
|
2104
|
+
query_params["onboarding"] = onboarding;
|
|
2105
|
+
query_params["page_no"] = pageNo;
|
|
2106
|
+
query_params["page_size"] = pageSize;
|
|
2107
|
+
query_params["q"] = q;
|
|
2279
2108
|
|
|
2280
2109
|
const response = await PartnerAPIClient.execute(
|
|
2281
2110
|
this.config,
|
|
2282
2111
|
"get",
|
|
2283
|
-
`/service/partner/logistics/v2.0/organization/${this.config.organizationId}/
|
|
2112
|
+
`/service/partner/logistics/v2.0/organization/${this.config.organizationId}/countries`,
|
|
2284
2113
|
query_params,
|
|
2285
2114
|
undefined,
|
|
2286
2115
|
requestHeaders,
|
|
@@ -2294,10 +2123,10 @@ class Logistics {
|
|
|
2294
2123
|
|
|
2295
2124
|
const {
|
|
2296
2125
|
error: res_error,
|
|
2297
|
-
} = LogisticsPartnerModel.
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
);
|
|
2126
|
+
} = LogisticsPartnerModel.GetCountries().validate(responseData, {
|
|
2127
|
+
abortEarly: false,
|
|
2128
|
+
allowUnknown: true,
|
|
2129
|
+
});
|
|
2301
2130
|
|
|
2302
2131
|
if (res_error) {
|
|
2303
2132
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -2305,7 +2134,7 @@ class Logistics {
|
|
|
2305
2134
|
} else {
|
|
2306
2135
|
Logger({
|
|
2307
2136
|
level: "WARN",
|
|
2308
|
-
message: `Response Validation Warnings for partner > Logistics >
|
|
2137
|
+
message: `Response Validation Warnings for partner > Logistics > getCountries \n ${res_error}`,
|
|
2309
2138
|
});
|
|
2310
2139
|
}
|
|
2311
2140
|
}
|