@gofynd/fdk-client-javascript 3.3.5 → 3.4.0
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 +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -24,7 +24,7 @@ class Serviceability {
|
|
|
24
24
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneBulkExport>} - Success response
|
|
25
25
|
* @name createBulkExport
|
|
26
26
|
* @summary: Create Bulk Export of Zones
|
|
27
|
-
* @description: Export zones defined at the application level. - Check out [method documentation](https://
|
|
27
|
+
* @description: Export zones defined at the application level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createBulkExport/).
|
|
28
28
|
*/
|
|
29
29
|
async createBulkExport(
|
|
30
30
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -106,7 +106,7 @@ class Serviceability {
|
|
|
106
106
|
* Success response
|
|
107
107
|
* @name createBulkGeoArea
|
|
108
108
|
* @summary: Bulk Creation of GeoArea Regions
|
|
109
|
-
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions in bulk. - Check out [method documentation](https://
|
|
109
|
+
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createBulkGeoArea/).
|
|
110
110
|
*/
|
|
111
111
|
async createBulkGeoArea(
|
|
112
112
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -189,7 +189,7 @@ class Serviceability {
|
|
|
189
189
|
*
|
|
190
190
|
* @name createCourierPartnerRule
|
|
191
191
|
* @summary: Create courier rule
|
|
192
|
-
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://
|
|
192
|
+
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerRule/).
|
|
193
193
|
*/
|
|
194
194
|
async createCourierPartnerRule(
|
|
195
195
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -261,6 +261,88 @@ class Serviceability {
|
|
|
261
261
|
return response;
|
|
262
262
|
}
|
|
263
263
|
|
|
264
|
+
/**
|
|
265
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateFulfillmentOptionParam} arg
|
|
266
|
+
* - Arg object
|
|
267
|
+
*
|
|
268
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
269
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
271
|
+
* Success response
|
|
272
|
+
* @name createFulfillmentOption
|
|
273
|
+
* @summary: Create a new fulfillment option
|
|
274
|
+
* @description: Creates a new fulfillment option for the specified company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createFulfillmentOption/).
|
|
275
|
+
*/
|
|
276
|
+
async createFulfillmentOption(
|
|
277
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
278
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
279
|
+
) {
|
|
280
|
+
const {
|
|
281
|
+
error,
|
|
282
|
+
} = ServiceabilityPlatformApplicationValidator.createFulfillmentOption().validate(
|
|
283
|
+
{
|
|
284
|
+
body,
|
|
285
|
+
},
|
|
286
|
+
{ abortEarly: false, allowUnknown: true }
|
|
287
|
+
);
|
|
288
|
+
if (error) {
|
|
289
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
// Showing warrnings if extra unknown parameters are found
|
|
293
|
+
const {
|
|
294
|
+
error: warrning,
|
|
295
|
+
} = ServiceabilityPlatformApplicationValidator.createFulfillmentOption().validate(
|
|
296
|
+
{
|
|
297
|
+
body,
|
|
298
|
+
},
|
|
299
|
+
{ abortEarly: false, allowUnknown: false }
|
|
300
|
+
);
|
|
301
|
+
if (warrning) {
|
|
302
|
+
Logger({
|
|
303
|
+
level: "WARN",
|
|
304
|
+
message: `Parameter Validation warrnings for platform > Serviceability > createFulfillmentOption \n ${warrning}`,
|
|
305
|
+
});
|
|
306
|
+
}
|
|
307
|
+
|
|
308
|
+
const query_params = {};
|
|
309
|
+
|
|
310
|
+
const response = await PlatformAPIClient.execute(
|
|
311
|
+
this.config,
|
|
312
|
+
"post",
|
|
313
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options`,
|
|
314
|
+
query_params,
|
|
315
|
+
body,
|
|
316
|
+
requestHeaders,
|
|
317
|
+
{ responseHeaders }
|
|
318
|
+
);
|
|
319
|
+
|
|
320
|
+
let responseData = response;
|
|
321
|
+
if (responseHeaders) {
|
|
322
|
+
responseData = response[0];
|
|
323
|
+
}
|
|
324
|
+
|
|
325
|
+
const {
|
|
326
|
+
error: res_error,
|
|
327
|
+
} = ServiceabilityPlatformModel.FulfillmentOption().validate(responseData, {
|
|
328
|
+
abortEarly: false,
|
|
329
|
+
allowUnknown: true,
|
|
330
|
+
});
|
|
331
|
+
|
|
332
|
+
if (res_error) {
|
|
333
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
334
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
335
|
+
} else {
|
|
336
|
+
Logger({
|
|
337
|
+
level: "WARN",
|
|
338
|
+
message: `Response Validation Warnings for platform > Serviceability > createFulfillmentOption \n ${res_error}`,
|
|
339
|
+
});
|
|
340
|
+
}
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
return response;
|
|
344
|
+
}
|
|
345
|
+
|
|
264
346
|
/**
|
|
265
347
|
* @param {ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam} arg
|
|
266
348
|
* - Arg object
|
|
@@ -271,7 +353,7 @@ class Serviceability {
|
|
|
271
353
|
* Success response
|
|
272
354
|
* @name createGeoArea
|
|
273
355
|
* @summary: Creation of GeoArea
|
|
274
|
-
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions. - Check out [method documentation](https://
|
|
356
|
+
* @description: Allows to create and manage GeoAreas, representing groups of geographic regions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createGeoArea/).
|
|
275
357
|
*/
|
|
276
358
|
async createGeoArea(
|
|
277
359
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -354,7 +436,7 @@ class Serviceability {
|
|
|
354
436
|
*
|
|
355
437
|
* @name createGeoAreaExportJob
|
|
356
438
|
* @summary: Create job for exporting Geoarea regions
|
|
357
|
-
* @description: Create the job for exporting the regions in Geoarea in CSV format. - Check out [method documentation](https://
|
|
439
|
+
* @description: Create the job for exporting the regions in Geoarea in CSV format. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createGeoAreaExportJob/).
|
|
358
440
|
*/
|
|
359
441
|
async createGeoAreaExportJob(
|
|
360
442
|
{ geoareaId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -436,7 +518,7 @@ class Serviceability {
|
|
|
436
518
|
* Success response
|
|
437
519
|
* @name createStoreRules
|
|
438
520
|
* @summary: Create store rule
|
|
439
|
-
* @description: Create a rule within the order routing rules - Check out [method documentation](https://
|
|
521
|
+
* @description: Create a rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createStoreRules/).
|
|
440
522
|
*/
|
|
441
523
|
async createStoreRules(
|
|
442
524
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -517,7 +599,7 @@ class Serviceability {
|
|
|
517
599
|
* @returns {Promise<ServiceabilityPlatformModel.ZoneSchema>} - Success response
|
|
518
600
|
* @name createZone
|
|
519
601
|
* @summary: Create zone
|
|
520
|
-
* @description: Creates a delivery zone. - Check out [method documentation](https://
|
|
602
|
+
* @description: Creates a delivery zone. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZone/).
|
|
521
603
|
*/
|
|
522
604
|
async createZone(
|
|
523
605
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -589,6 +671,89 @@ class Serviceability {
|
|
|
589
671
|
return response;
|
|
590
672
|
}
|
|
591
673
|
|
|
674
|
+
/**
|
|
675
|
+
* @param {ServiceabilityPlatformApplicationValidator.DeleteFulfillmentOptionsParam} arg
|
|
676
|
+
* - Arg object
|
|
677
|
+
*
|
|
678
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
679
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
680
|
+
* @returns {Promise<ServiceabilityPlatformModel.OperationResponseSchema>}
|
|
681
|
+
* - Success response
|
|
682
|
+
*
|
|
683
|
+
* @name deleteFulfillmentOptions
|
|
684
|
+
* @summary: Delete fulfillment options
|
|
685
|
+
* @description: Deletes fulfillment options for provided slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteFulfillmentOptions/).
|
|
686
|
+
*/
|
|
687
|
+
async deleteFulfillmentOptions(
|
|
688
|
+
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
689
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
690
|
+
) {
|
|
691
|
+
const {
|
|
692
|
+
error,
|
|
693
|
+
} = ServiceabilityPlatformApplicationValidator.deleteFulfillmentOptions().validate(
|
|
694
|
+
{
|
|
695
|
+
slug,
|
|
696
|
+
},
|
|
697
|
+
{ abortEarly: false, allowUnknown: true }
|
|
698
|
+
);
|
|
699
|
+
if (error) {
|
|
700
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
701
|
+
}
|
|
702
|
+
|
|
703
|
+
// Showing warrnings if extra unknown parameters are found
|
|
704
|
+
const {
|
|
705
|
+
error: warrning,
|
|
706
|
+
} = ServiceabilityPlatformApplicationValidator.deleteFulfillmentOptions().validate(
|
|
707
|
+
{
|
|
708
|
+
slug,
|
|
709
|
+
},
|
|
710
|
+
{ abortEarly: false, allowUnknown: false }
|
|
711
|
+
);
|
|
712
|
+
if (warrning) {
|
|
713
|
+
Logger({
|
|
714
|
+
level: "WARN",
|
|
715
|
+
message: `Parameter Validation warrnings for platform > Serviceability > deleteFulfillmentOptions \n ${warrning}`,
|
|
716
|
+
});
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
const query_params = {};
|
|
720
|
+
|
|
721
|
+
const response = await PlatformAPIClient.execute(
|
|
722
|
+
this.config,
|
|
723
|
+
"delete",
|
|
724
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options/${slug}`,
|
|
725
|
+
query_params,
|
|
726
|
+
undefined,
|
|
727
|
+
requestHeaders,
|
|
728
|
+
{ responseHeaders }
|
|
729
|
+
);
|
|
730
|
+
|
|
731
|
+
let responseData = response;
|
|
732
|
+
if (responseHeaders) {
|
|
733
|
+
responseData = response[0];
|
|
734
|
+
}
|
|
735
|
+
|
|
736
|
+
const {
|
|
737
|
+
error: res_error,
|
|
738
|
+
} = ServiceabilityPlatformModel.OperationResponseSchema().validate(
|
|
739
|
+
responseData,
|
|
740
|
+
{ abortEarly: false, allowUnknown: true }
|
|
741
|
+
);
|
|
742
|
+
|
|
743
|
+
if (res_error) {
|
|
744
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
745
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
746
|
+
} else {
|
|
747
|
+
Logger({
|
|
748
|
+
level: "WARN",
|
|
749
|
+
message: `Response Validation Warnings for platform > Serviceability > deleteFulfillmentOptions \n ${res_error}`,
|
|
750
|
+
});
|
|
751
|
+
}
|
|
752
|
+
}
|
|
753
|
+
|
|
754
|
+
return response;
|
|
755
|
+
}
|
|
756
|
+
|
|
592
757
|
/**
|
|
593
758
|
* @param {ServiceabilityPlatformApplicationValidator.DeleteZoneParam} arg
|
|
594
759
|
* - Arg object
|
|
@@ -600,7 +765,7 @@ class Serviceability {
|
|
|
600
765
|
*
|
|
601
766
|
* @name deleteZone
|
|
602
767
|
* @summary: Delete a Specific Zone
|
|
603
|
-
* @description: Delete a Zone under that application. - Check out [method documentation](https://
|
|
768
|
+
* @description: Delete a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteZone/).
|
|
604
769
|
*/
|
|
605
770
|
async deleteZone(
|
|
606
771
|
{ zoneId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -681,7 +846,7 @@ class Serviceability {
|
|
|
681
846
|
* @returns {Promise<string>} - Success response
|
|
682
847
|
* @name downloadGeoareaSampleFile
|
|
683
848
|
* @summary: Download geoarea sample file
|
|
684
|
-
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://
|
|
849
|
+
* @description: Download a sample file for geoarea data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/downloadGeoareaSampleFile/).
|
|
685
850
|
*/
|
|
686
851
|
async downloadGeoareaSampleFile(
|
|
687
852
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -756,7 +921,7 @@ class Serviceability {
|
|
|
756
921
|
* Success response
|
|
757
922
|
* @name getApplicationConfig
|
|
758
923
|
* @summary: Get store rule configuration
|
|
759
|
-
* @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://
|
|
924
|
+
* @description: Retrieves information about the order routing setup for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationConfig/).
|
|
760
925
|
*/
|
|
761
926
|
async getApplicationConfig(
|
|
762
927
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -835,7 +1000,7 @@ class Serviceability {
|
|
|
835
1000
|
*
|
|
836
1001
|
* @name getApplicationConfiguration
|
|
837
1002
|
* @summary: Get delivery configuration
|
|
838
|
-
* @description: This API returns all the Application config that has been applied to the given company and application. - Check out [method documentation](https://
|
|
1003
|
+
* @description: This API returns all the Application config that has been applied to the given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getApplicationConfiguration/).
|
|
839
1004
|
*/
|
|
840
1005
|
async getApplicationConfiguration(
|
|
841
1006
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -913,7 +1078,7 @@ class Serviceability {
|
|
|
913
1078
|
* Success response
|
|
914
1079
|
* @name getBulkExport
|
|
915
1080
|
* @summary: Get Bulk Export of Zones
|
|
916
|
-
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://
|
|
1081
|
+
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkExport/).
|
|
917
1082
|
*/
|
|
918
1083
|
async getBulkExport(
|
|
919
1084
|
{ batchId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -985,6 +1150,89 @@ class Serviceability {
|
|
|
985
1150
|
return response;
|
|
986
1151
|
}
|
|
987
1152
|
|
|
1153
|
+
/**
|
|
1154
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetBulkFulfillmentValidationStatusParam} arg
|
|
1155
|
+
* - Arg object
|
|
1156
|
+
*
|
|
1157
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1158
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1159
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidate>}
|
|
1160
|
+
* - Success response
|
|
1161
|
+
*
|
|
1162
|
+
* @name getBulkFulfillmentValidationStatus
|
|
1163
|
+
* @summary: Validate bulk fulfillment options.
|
|
1164
|
+
* @description: Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkFulfillmentValidationStatus/).
|
|
1165
|
+
*/
|
|
1166
|
+
async getBulkFulfillmentValidationStatus(
|
|
1167
|
+
{ bulkId, requestHeaders } = { requestHeaders: {} },
|
|
1168
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1169
|
+
) {
|
|
1170
|
+
const {
|
|
1171
|
+
error,
|
|
1172
|
+
} = ServiceabilityPlatformApplicationValidator.getBulkFulfillmentValidationStatus().validate(
|
|
1173
|
+
{
|
|
1174
|
+
bulkId,
|
|
1175
|
+
},
|
|
1176
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1177
|
+
);
|
|
1178
|
+
if (error) {
|
|
1179
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1180
|
+
}
|
|
1181
|
+
|
|
1182
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1183
|
+
const {
|
|
1184
|
+
error: warrning,
|
|
1185
|
+
} = ServiceabilityPlatformApplicationValidator.getBulkFulfillmentValidationStatus().validate(
|
|
1186
|
+
{
|
|
1187
|
+
bulkId,
|
|
1188
|
+
},
|
|
1189
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1190
|
+
);
|
|
1191
|
+
if (warrning) {
|
|
1192
|
+
Logger({
|
|
1193
|
+
level: "WARN",
|
|
1194
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getBulkFulfillmentValidationStatus \n ${warrning}`,
|
|
1195
|
+
});
|
|
1196
|
+
}
|
|
1197
|
+
|
|
1198
|
+
const query_params = {};
|
|
1199
|
+
|
|
1200
|
+
const response = await PlatformAPIClient.execute(
|
|
1201
|
+
this.config,
|
|
1202
|
+
"get",
|
|
1203
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options/poll/validate/${bulkId}`,
|
|
1204
|
+
query_params,
|
|
1205
|
+
undefined,
|
|
1206
|
+
requestHeaders,
|
|
1207
|
+
{ responseHeaders }
|
|
1208
|
+
);
|
|
1209
|
+
|
|
1210
|
+
let responseData = response;
|
|
1211
|
+
if (responseHeaders) {
|
|
1212
|
+
responseData = response[0];
|
|
1213
|
+
}
|
|
1214
|
+
|
|
1215
|
+
const {
|
|
1216
|
+
error: res_error,
|
|
1217
|
+
} = ServiceabilityPlatformModel.FulfillmentOptionBulkValidate().validate(
|
|
1218
|
+
responseData,
|
|
1219
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1220
|
+
);
|
|
1221
|
+
|
|
1222
|
+
if (res_error) {
|
|
1223
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1224
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1225
|
+
} else {
|
|
1226
|
+
Logger({
|
|
1227
|
+
level: "WARN",
|
|
1228
|
+
message: `Response Validation Warnings for platform > Serviceability > getBulkFulfillmentValidationStatus \n ${res_error}`,
|
|
1229
|
+
});
|
|
1230
|
+
}
|
|
1231
|
+
}
|
|
1232
|
+
|
|
1233
|
+
return response;
|
|
1234
|
+
}
|
|
1235
|
+
|
|
988
1236
|
/**
|
|
989
1237
|
* @param {ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam} arg
|
|
990
1238
|
* - Arg object
|
|
@@ -995,7 +1243,7 @@ class Serviceability {
|
|
|
995
1243
|
* Success response
|
|
996
1244
|
* @name getBulkGeoArea
|
|
997
1245
|
* @summary: Get status of GeoAreas created in bulk
|
|
998
|
-
* @description: Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk. - Check out [method documentation](https://
|
|
1246
|
+
* @description: Allows to Get GeoArea status which is created, representing groups of geographic regions in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkGeoArea/).
|
|
999
1247
|
*/
|
|
1000
1248
|
async getBulkGeoArea(
|
|
1001
1249
|
{ geoareaId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1078,7 +1326,7 @@ class Serviceability {
|
|
|
1078
1326
|
*
|
|
1079
1327
|
* @name getCourierPartnerRule
|
|
1080
1328
|
* @summary: Get courier rule
|
|
1081
|
-
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://
|
|
1329
|
+
* @description: Retrieves a single rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRule/).
|
|
1082
1330
|
*/
|
|
1083
1331
|
async getCourierPartnerRule(
|
|
1084
1332
|
{ ruleUid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1161,7 +1409,7 @@ class Serviceability {
|
|
|
1161
1409
|
*
|
|
1162
1410
|
* @name getCourierPartnerRules
|
|
1163
1411
|
* @summary: Get courier rules
|
|
1164
|
-
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://
|
|
1412
|
+
* @description: Retrieve a list of rules within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartnerRules/).
|
|
1165
1413
|
*/
|
|
1166
1414
|
async getCourierPartnerRules(
|
|
1167
1415
|
{ pageNo, pageSize, status, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1171,9 +1419,270 @@ class Serviceability {
|
|
|
1171
1419
|
error,
|
|
1172
1420
|
} = ServiceabilityPlatformApplicationValidator.getCourierPartnerRules().validate(
|
|
1173
1421
|
{
|
|
1174
|
-
pageNo,
|
|
1175
|
-
pageSize,
|
|
1176
|
-
status,
|
|
1422
|
+
pageNo,
|
|
1423
|
+
pageSize,
|
|
1424
|
+
status,
|
|
1425
|
+
},
|
|
1426
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1427
|
+
);
|
|
1428
|
+
if (error) {
|
|
1429
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1430
|
+
}
|
|
1431
|
+
|
|
1432
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1433
|
+
const {
|
|
1434
|
+
error: warrning,
|
|
1435
|
+
} = ServiceabilityPlatformApplicationValidator.getCourierPartnerRules().validate(
|
|
1436
|
+
{
|
|
1437
|
+
pageNo,
|
|
1438
|
+
pageSize,
|
|
1439
|
+
status,
|
|
1440
|
+
},
|
|
1441
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1442
|
+
);
|
|
1443
|
+
if (warrning) {
|
|
1444
|
+
Logger({
|
|
1445
|
+
level: "WARN",
|
|
1446
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getCourierPartnerRules \n ${warrning}`,
|
|
1447
|
+
});
|
|
1448
|
+
}
|
|
1449
|
+
|
|
1450
|
+
const query_params = {};
|
|
1451
|
+
query_params["page_no"] = pageNo;
|
|
1452
|
+
query_params["page_size"] = pageSize;
|
|
1453
|
+
query_params["status"] = status;
|
|
1454
|
+
|
|
1455
|
+
const response = await PlatformAPIClient.execute(
|
|
1456
|
+
this.config,
|
|
1457
|
+
"get",
|
|
1458
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/courier-partner/rules`,
|
|
1459
|
+
query_params,
|
|
1460
|
+
undefined,
|
|
1461
|
+
requestHeaders,
|
|
1462
|
+
{ responseHeaders }
|
|
1463
|
+
);
|
|
1464
|
+
|
|
1465
|
+
let responseData = response;
|
|
1466
|
+
if (responseHeaders) {
|
|
1467
|
+
responseData = response[0];
|
|
1468
|
+
}
|
|
1469
|
+
|
|
1470
|
+
const {
|
|
1471
|
+
error: res_error,
|
|
1472
|
+
} = ServiceabilityPlatformModel.CourierPartnerRulesListResult().validate(
|
|
1473
|
+
responseData,
|
|
1474
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1475
|
+
);
|
|
1476
|
+
|
|
1477
|
+
if (res_error) {
|
|
1478
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1479
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1480
|
+
} else {
|
|
1481
|
+
Logger({
|
|
1482
|
+
level: "WARN",
|
|
1483
|
+
message: `Response Validation Warnings for platform > Serviceability > getCourierPartnerRules \n ${res_error}`,
|
|
1484
|
+
});
|
|
1485
|
+
}
|
|
1486
|
+
}
|
|
1487
|
+
|
|
1488
|
+
return response;
|
|
1489
|
+
}
|
|
1490
|
+
|
|
1491
|
+
/**
|
|
1492
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetCourierPartnersParam} arg
|
|
1493
|
+
* - Arg object
|
|
1494
|
+
*
|
|
1495
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1496
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1497
|
+
* @returns {Promise<ServiceabilityPlatformModel.ShipmentCourierPartnerResult>}
|
|
1498
|
+
* - Success response
|
|
1499
|
+
*
|
|
1500
|
+
* @name getCourierPartners
|
|
1501
|
+
* @summary: Serviceable Courier Partners
|
|
1502
|
+
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartners/).
|
|
1503
|
+
*/
|
|
1504
|
+
async getCourierPartners(
|
|
1505
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
1506
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1507
|
+
) {
|
|
1508
|
+
const {
|
|
1509
|
+
error,
|
|
1510
|
+
} = ServiceabilityPlatformApplicationValidator.getCourierPartners().validate(
|
|
1511
|
+
{
|
|
1512
|
+
body,
|
|
1513
|
+
},
|
|
1514
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1515
|
+
);
|
|
1516
|
+
if (error) {
|
|
1517
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1518
|
+
}
|
|
1519
|
+
|
|
1520
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1521
|
+
const {
|
|
1522
|
+
error: warrning,
|
|
1523
|
+
} = ServiceabilityPlatformApplicationValidator.getCourierPartners().validate(
|
|
1524
|
+
{
|
|
1525
|
+
body,
|
|
1526
|
+
},
|
|
1527
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1528
|
+
);
|
|
1529
|
+
if (warrning) {
|
|
1530
|
+
Logger({
|
|
1531
|
+
level: "WARN",
|
|
1532
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getCourierPartners \n ${warrning}`,
|
|
1533
|
+
});
|
|
1534
|
+
}
|
|
1535
|
+
|
|
1536
|
+
const query_params = {};
|
|
1537
|
+
|
|
1538
|
+
const response = await PlatformAPIClient.execute(
|
|
1539
|
+
this.config,
|
|
1540
|
+
"post",
|
|
1541
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/shipment/courier-partners`,
|
|
1542
|
+
query_params,
|
|
1543
|
+
body,
|
|
1544
|
+
requestHeaders,
|
|
1545
|
+
{ responseHeaders }
|
|
1546
|
+
);
|
|
1547
|
+
|
|
1548
|
+
let responseData = response;
|
|
1549
|
+
if (responseHeaders) {
|
|
1550
|
+
responseData = response[0];
|
|
1551
|
+
}
|
|
1552
|
+
|
|
1553
|
+
const {
|
|
1554
|
+
error: res_error,
|
|
1555
|
+
} = ServiceabilityPlatformModel.ShipmentCourierPartnerResult().validate(
|
|
1556
|
+
responseData,
|
|
1557
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1558
|
+
);
|
|
1559
|
+
|
|
1560
|
+
if (res_error) {
|
|
1561
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1562
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1563
|
+
} else {
|
|
1564
|
+
Logger({
|
|
1565
|
+
level: "WARN",
|
|
1566
|
+
message: `Response Validation Warnings for platform > Serviceability > getCourierPartners \n ${res_error}`,
|
|
1567
|
+
});
|
|
1568
|
+
}
|
|
1569
|
+
}
|
|
1570
|
+
|
|
1571
|
+
return response;
|
|
1572
|
+
}
|
|
1573
|
+
|
|
1574
|
+
/**
|
|
1575
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionProductsParam} arg
|
|
1576
|
+
* - Arg object
|
|
1577
|
+
*
|
|
1578
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1579
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1580
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionProducts>}
|
|
1581
|
+
* - Success response
|
|
1582
|
+
*
|
|
1583
|
+
* @name getFulfillmentOptionProducts
|
|
1584
|
+
* @summary: Get products for a specific fulfillment option.
|
|
1585
|
+
* @description: Retrieves products available for a specific fulfillment option in an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionProducts/).
|
|
1586
|
+
*/
|
|
1587
|
+
async getFulfillmentOptionProducts(
|
|
1588
|
+
{ slug, storeId, q, requestHeaders } = { requestHeaders: {} },
|
|
1589
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1590
|
+
) {
|
|
1591
|
+
const {
|
|
1592
|
+
error,
|
|
1593
|
+
} = ServiceabilityPlatformApplicationValidator.getFulfillmentOptionProducts().validate(
|
|
1594
|
+
{
|
|
1595
|
+
slug,
|
|
1596
|
+
storeId,
|
|
1597
|
+
q,
|
|
1598
|
+
},
|
|
1599
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1600
|
+
);
|
|
1601
|
+
if (error) {
|
|
1602
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1603
|
+
}
|
|
1604
|
+
|
|
1605
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1606
|
+
const {
|
|
1607
|
+
error: warrning,
|
|
1608
|
+
} = ServiceabilityPlatformApplicationValidator.getFulfillmentOptionProducts().validate(
|
|
1609
|
+
{
|
|
1610
|
+
slug,
|
|
1611
|
+
storeId,
|
|
1612
|
+
q,
|
|
1613
|
+
},
|
|
1614
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1615
|
+
);
|
|
1616
|
+
if (warrning) {
|
|
1617
|
+
Logger({
|
|
1618
|
+
level: "WARN",
|
|
1619
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getFulfillmentOptionProducts \n ${warrning}`,
|
|
1620
|
+
});
|
|
1621
|
+
}
|
|
1622
|
+
|
|
1623
|
+
const query_params = {};
|
|
1624
|
+
query_params["q"] = q;
|
|
1625
|
+
query_params["store_id"] = storeId;
|
|
1626
|
+
|
|
1627
|
+
const response = await PlatformAPIClient.execute(
|
|
1628
|
+
this.config,
|
|
1629
|
+
"get",
|
|
1630
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options/${slug}/products`,
|
|
1631
|
+
query_params,
|
|
1632
|
+
undefined,
|
|
1633
|
+
requestHeaders,
|
|
1634
|
+
{ responseHeaders }
|
|
1635
|
+
);
|
|
1636
|
+
|
|
1637
|
+
let responseData = response;
|
|
1638
|
+
if (responseHeaders) {
|
|
1639
|
+
responseData = response[0];
|
|
1640
|
+
}
|
|
1641
|
+
|
|
1642
|
+
const {
|
|
1643
|
+
error: res_error,
|
|
1644
|
+
} = ServiceabilityPlatformModel.FulfillmentOptionProducts().validate(
|
|
1645
|
+
responseData,
|
|
1646
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1647
|
+
);
|
|
1648
|
+
|
|
1649
|
+
if (res_error) {
|
|
1650
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1651
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1652
|
+
} else {
|
|
1653
|
+
Logger({
|
|
1654
|
+
level: "WARN",
|
|
1655
|
+
message: `Response Validation Warnings for platform > Serviceability > getFulfillmentOptionProducts \n ${res_error}`,
|
|
1656
|
+
});
|
|
1657
|
+
}
|
|
1658
|
+
}
|
|
1659
|
+
|
|
1660
|
+
return response;
|
|
1661
|
+
}
|
|
1662
|
+
|
|
1663
|
+
/**
|
|
1664
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionStoresParam} arg
|
|
1665
|
+
* - Arg object
|
|
1666
|
+
*
|
|
1667
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1668
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1669
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionStores>}
|
|
1670
|
+
* - Success response
|
|
1671
|
+
*
|
|
1672
|
+
* @name getFulfillmentOptionStores
|
|
1673
|
+
* @summary: Get stores for a specific fulfillment option.
|
|
1674
|
+
* @description: Retrieves stores available for a specific fulfillment option in an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionStores/).
|
|
1675
|
+
*/
|
|
1676
|
+
async getFulfillmentOptionStores(
|
|
1677
|
+
{ slug, q, requestHeaders } = { requestHeaders: {} },
|
|
1678
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1679
|
+
) {
|
|
1680
|
+
const {
|
|
1681
|
+
error,
|
|
1682
|
+
} = ServiceabilityPlatformApplicationValidator.getFulfillmentOptionStores().validate(
|
|
1683
|
+
{
|
|
1684
|
+
slug,
|
|
1685
|
+
q,
|
|
1177
1686
|
},
|
|
1178
1687
|
{ abortEarly: false, allowUnknown: true }
|
|
1179
1688
|
);
|
|
@@ -1184,30 +1693,27 @@ class Serviceability {
|
|
|
1184
1693
|
// Showing warrnings if extra unknown parameters are found
|
|
1185
1694
|
const {
|
|
1186
1695
|
error: warrning,
|
|
1187
|
-
} = ServiceabilityPlatformApplicationValidator.
|
|
1696
|
+
} = ServiceabilityPlatformApplicationValidator.getFulfillmentOptionStores().validate(
|
|
1188
1697
|
{
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
status,
|
|
1698
|
+
slug,
|
|
1699
|
+
q,
|
|
1192
1700
|
},
|
|
1193
1701
|
{ abortEarly: false, allowUnknown: false }
|
|
1194
1702
|
);
|
|
1195
1703
|
if (warrning) {
|
|
1196
1704
|
Logger({
|
|
1197
1705
|
level: "WARN",
|
|
1198
|
-
message: `Parameter Validation warrnings for platform > Serviceability >
|
|
1706
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getFulfillmentOptionStores \n ${warrning}`,
|
|
1199
1707
|
});
|
|
1200
1708
|
}
|
|
1201
1709
|
|
|
1202
1710
|
const query_params = {};
|
|
1203
|
-
query_params["
|
|
1204
|
-
query_params["page_size"] = pageSize;
|
|
1205
|
-
query_params["status"] = status;
|
|
1711
|
+
query_params["q"] = q;
|
|
1206
1712
|
|
|
1207
1713
|
const response = await PlatformAPIClient.execute(
|
|
1208
1714
|
this.config,
|
|
1209
1715
|
"get",
|
|
1210
|
-
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/
|
|
1716
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options/${slug}/stores`,
|
|
1211
1717
|
query_params,
|
|
1212
1718
|
undefined,
|
|
1213
1719
|
requestHeaders,
|
|
@@ -1221,7 +1727,7 @@ class Serviceability {
|
|
|
1221
1727
|
|
|
1222
1728
|
const {
|
|
1223
1729
|
error: res_error,
|
|
1224
|
-
} = ServiceabilityPlatformModel.
|
|
1730
|
+
} = ServiceabilityPlatformModel.FulfillmentOptionStores().validate(
|
|
1225
1731
|
responseData,
|
|
1226
1732
|
{ abortEarly: false, allowUnknown: true }
|
|
1227
1733
|
);
|
|
@@ -1232,7 +1738,7 @@ class Serviceability {
|
|
|
1232
1738
|
} else {
|
|
1233
1739
|
Logger({
|
|
1234
1740
|
level: "WARN",
|
|
1235
|
-
message: `Response Validation Warnings for platform > Serviceability >
|
|
1741
|
+
message: `Response Validation Warnings for platform > Serviceability > getFulfillmentOptionStores \n ${res_error}`,
|
|
1236
1742
|
});
|
|
1237
1743
|
}
|
|
1238
1744
|
}
|
|
@@ -1241,27 +1747,28 @@ class Serviceability {
|
|
|
1241
1747
|
}
|
|
1242
1748
|
|
|
1243
1749
|
/**
|
|
1244
|
-
* @param {ServiceabilityPlatformApplicationValidator.
|
|
1750
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsParam} arg
|
|
1245
1751
|
* - Arg object
|
|
1246
1752
|
*
|
|
1247
1753
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1248
1754
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1249
|
-
* @returns {Promise<ServiceabilityPlatformModel.
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1252
|
-
* @
|
|
1253
|
-
* @
|
|
1254
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartners/).
|
|
1755
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
1756
|
+
* Success response
|
|
1757
|
+
* @name getFulfillmentOptions
|
|
1758
|
+
* @summary: Get fulfillment options
|
|
1759
|
+
* @description: Fetches available fulfillment options for a given product and store. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptions/).
|
|
1255
1760
|
*/
|
|
1256
|
-
async
|
|
1257
|
-
{
|
|
1761
|
+
async getFulfillmentOptions(
|
|
1762
|
+
{ slug, productId, storeId, requestHeaders } = { requestHeaders: {} },
|
|
1258
1763
|
{ responseHeaders } = { responseHeaders: false }
|
|
1259
1764
|
) {
|
|
1260
1765
|
const {
|
|
1261
1766
|
error,
|
|
1262
|
-
} = ServiceabilityPlatformApplicationValidator.
|
|
1767
|
+
} = ServiceabilityPlatformApplicationValidator.getFulfillmentOptions().validate(
|
|
1263
1768
|
{
|
|
1264
|
-
|
|
1769
|
+
slug,
|
|
1770
|
+
productId,
|
|
1771
|
+
storeId,
|
|
1265
1772
|
},
|
|
1266
1773
|
{ abortEarly: false, allowUnknown: true }
|
|
1267
1774
|
);
|
|
@@ -1272,27 +1779,31 @@ class Serviceability {
|
|
|
1272
1779
|
// Showing warrnings if extra unknown parameters are found
|
|
1273
1780
|
const {
|
|
1274
1781
|
error: warrning,
|
|
1275
|
-
} = ServiceabilityPlatformApplicationValidator.
|
|
1782
|
+
} = ServiceabilityPlatformApplicationValidator.getFulfillmentOptions().validate(
|
|
1276
1783
|
{
|
|
1277
|
-
|
|
1784
|
+
slug,
|
|
1785
|
+
productId,
|
|
1786
|
+
storeId,
|
|
1278
1787
|
},
|
|
1279
1788
|
{ abortEarly: false, allowUnknown: false }
|
|
1280
1789
|
);
|
|
1281
1790
|
if (warrning) {
|
|
1282
1791
|
Logger({
|
|
1283
1792
|
level: "WARN",
|
|
1284
|
-
message: `Parameter Validation warrnings for platform > Serviceability >
|
|
1793
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getFulfillmentOptions \n ${warrning}`,
|
|
1285
1794
|
});
|
|
1286
1795
|
}
|
|
1287
1796
|
|
|
1288
1797
|
const query_params = {};
|
|
1798
|
+
query_params["product_id"] = productId;
|
|
1799
|
+
query_params["store_id"] = storeId;
|
|
1289
1800
|
|
|
1290
1801
|
const response = await PlatformAPIClient.execute(
|
|
1291
1802
|
this.config,
|
|
1292
|
-
"
|
|
1293
|
-
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/
|
|
1803
|
+
"get",
|
|
1804
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options/${slug}`,
|
|
1294
1805
|
query_params,
|
|
1295
|
-
|
|
1806
|
+
undefined,
|
|
1296
1807
|
requestHeaders,
|
|
1297
1808
|
{ responseHeaders }
|
|
1298
1809
|
);
|
|
@@ -1304,10 +1815,10 @@ class Serviceability {
|
|
|
1304
1815
|
|
|
1305
1816
|
const {
|
|
1306
1817
|
error: res_error,
|
|
1307
|
-
} = ServiceabilityPlatformModel.
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
);
|
|
1818
|
+
} = ServiceabilityPlatformModel.FulfillmentOption().validate(responseData, {
|
|
1819
|
+
abortEarly: false,
|
|
1820
|
+
allowUnknown: true,
|
|
1821
|
+
});
|
|
1311
1822
|
|
|
1312
1823
|
if (res_error) {
|
|
1313
1824
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1315,7 +1826,7 @@ class Serviceability {
|
|
|
1315
1826
|
} else {
|
|
1316
1827
|
Logger({
|
|
1317
1828
|
level: "WARN",
|
|
1318
|
-
message: `Response Validation Warnings for platform > Serviceability >
|
|
1829
|
+
message: `Response Validation Warnings for platform > Serviceability > getFulfillmentOptions \n ${res_error}`,
|
|
1319
1830
|
});
|
|
1320
1831
|
}
|
|
1321
1832
|
}
|
|
@@ -1332,7 +1843,7 @@ class Serviceability {
|
|
|
1332
1843
|
* @returns {Promise<ServiceabilityPlatformModel.GeoAreaDetails>} - Success response
|
|
1333
1844
|
* @name getGeoArea
|
|
1334
1845
|
* @summary: Get details of the specific geoarea
|
|
1335
|
-
* @description: This API Returns the data of the specific GeoArea which exists on the platform. - Check out [method documentation](https://
|
|
1846
|
+
* @description: This API Returns the data of the specific GeoArea which exists on the platform. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoArea/).
|
|
1336
1847
|
*/
|
|
1337
1848
|
async getGeoArea(
|
|
1338
1849
|
{ geoareaId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1415,7 +1926,7 @@ class Serviceability {
|
|
|
1415
1926
|
*
|
|
1416
1927
|
* @name getGeoAreaExportJobStatus
|
|
1417
1928
|
* @summary: Get status of Geoarea export job
|
|
1418
|
-
* @description: Get the status and details of the Geoarea bulk export process. - Check out [method documentation](https://
|
|
1929
|
+
* @description: Get the status and details of the Geoarea bulk export process. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreaExportJobStatus/).
|
|
1419
1930
|
*/
|
|
1420
1931
|
async getGeoAreaExportJobStatus(
|
|
1421
1932
|
{ geoareaId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1497,7 +2008,7 @@ class Serviceability {
|
|
|
1497
2008
|
* Success response
|
|
1498
2009
|
* @name getGeoAreas
|
|
1499
2010
|
* @summary: Get all geoareas in the current application
|
|
1500
|
-
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://
|
|
2011
|
+
* @description: Retrieves a listing view of created GeoAreas. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getGeoAreas/).
|
|
1501
2012
|
*/
|
|
1502
2013
|
async getGeoAreas(
|
|
1503
2014
|
{
|
|
@@ -1619,7 +2130,7 @@ class Serviceability {
|
|
|
1619
2130
|
* Success response
|
|
1620
2131
|
* @name getStoreRule
|
|
1621
2132
|
* @summary: Get store rule
|
|
1622
|
-
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://
|
|
2133
|
+
* @description: Retrieves a single rule within the order routing rules - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getStoreRule/).
|
|
1623
2134
|
*/
|
|
1624
2135
|
async getStoreRule(
|
|
1625
2136
|
{ ruleUid, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1701,7 +2212,7 @@ class Serviceability {
|
|
|
1701
2212
|
* Success response
|
|
1702
2213
|
* @name getStoreRules
|
|
1703
2214
|
* @summary: Get store rules
|
|
1704
|
-
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://
|
|
2215
|
+
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getStoreRules/).
|
|
1705
2216
|
*/
|
|
1706
2217
|
async getStoreRules(
|
|
1707
2218
|
{ pageNo, pageSize, status, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1788,7 +2299,7 @@ class Serviceability {
|
|
|
1788
2299
|
* Success response
|
|
1789
2300
|
* @name getZone
|
|
1790
2301
|
* @summary: Get zone details
|
|
1791
|
-
* @description: Retrieves a single delivery zone - Check out [method documentation](https://
|
|
2302
|
+
* @description: Retrieves a single delivery zone - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZone/).
|
|
1792
2303
|
*/
|
|
1793
2304
|
async getZone(
|
|
1794
2305
|
{ zoneId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1867,13 +2378,14 @@ class Serviceability {
|
|
|
1867
2378
|
* @returns {Promise<ServiceabilityPlatformModel.ListViewSchema>} - Success response
|
|
1868
2379
|
* @name getZones
|
|
1869
2380
|
* @summary: Get zones
|
|
1870
|
-
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://
|
|
2381
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZones/).
|
|
1871
2382
|
*/
|
|
1872
2383
|
async getZones(
|
|
1873
2384
|
{
|
|
1874
2385
|
stage,
|
|
1875
2386
|
pageSize,
|
|
1876
2387
|
pageNo,
|
|
2388
|
+
fulfillmentOptionSlug,
|
|
1877
2389
|
isActive,
|
|
1878
2390
|
q,
|
|
1879
2391
|
countryIsoCode,
|
|
@@ -1892,6 +2404,7 @@ class Serviceability {
|
|
|
1892
2404
|
stage,
|
|
1893
2405
|
pageSize,
|
|
1894
2406
|
pageNo,
|
|
2407
|
+
fulfillmentOptionSlug,
|
|
1895
2408
|
isActive,
|
|
1896
2409
|
q,
|
|
1897
2410
|
countryIsoCode,
|
|
@@ -1914,6 +2427,7 @@ class Serviceability {
|
|
|
1914
2427
|
stage,
|
|
1915
2428
|
pageSize,
|
|
1916
2429
|
pageNo,
|
|
2430
|
+
fulfillmentOptionSlug,
|
|
1917
2431
|
isActive,
|
|
1918
2432
|
q,
|
|
1919
2433
|
countryIsoCode,
|
|
@@ -1935,6 +2449,7 @@ class Serviceability {
|
|
|
1935
2449
|
query_params["stage"] = stage;
|
|
1936
2450
|
query_params["page_size"] = pageSize;
|
|
1937
2451
|
query_params["page_no"] = pageNo;
|
|
2452
|
+
query_params["fulfillment_option_slug"] = fulfillmentOptionSlug;
|
|
1938
2453
|
query_params["is_active"] = isActive;
|
|
1939
2454
|
query_params["q"] = q;
|
|
1940
2455
|
query_params["country_iso_code"] = countryIsoCode;
|
|
@@ -1989,7 +2504,7 @@ class Serviceability {
|
|
|
1989
2504
|
* Success response
|
|
1990
2505
|
* @name insertApplicationConfig
|
|
1991
2506
|
* @summary: Create store rule configuration
|
|
1992
|
-
* @description: Creates a order routing setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://
|
|
2507
|
+
* @description: Creates a order routing setup for an application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/insertApplicationConfig/).
|
|
1993
2508
|
*/
|
|
1994
2509
|
async insertApplicationConfig(
|
|
1995
2510
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2072,7 +2587,7 @@ class Serviceability {
|
|
|
2072
2587
|
*
|
|
2073
2588
|
* @name patchApplicationConfiguration
|
|
2074
2589
|
* @summary: To patch any config which can be applied to application
|
|
2075
|
-
* @description: Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples - Check out [method documentation](https://
|
|
2590
|
+
* @description: Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchApplicationConfiguration/).
|
|
2076
2591
|
*/
|
|
2077
2592
|
async patchApplicationConfiguration(
|
|
2078
2593
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2144,6 +2659,90 @@ class Serviceability {
|
|
|
2144
2659
|
return response;
|
|
2145
2660
|
}
|
|
2146
2661
|
|
|
2662
|
+
/**
|
|
2663
|
+
* @param {ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam} arg
|
|
2664
|
+
* - Arg object
|
|
2665
|
+
*
|
|
2666
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2667
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2668
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
2669
|
+
* Success response
|
|
2670
|
+
* @name putFulfillmentOption
|
|
2671
|
+
* @summary: Update an existing fulfillment option
|
|
2672
|
+
* @description: Updates the details of an existing fulfillment option for the specified company and application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/putFulfillmentOption/).
|
|
2673
|
+
*/
|
|
2674
|
+
async putFulfillmentOption(
|
|
2675
|
+
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
2676
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
2677
|
+
) {
|
|
2678
|
+
const {
|
|
2679
|
+
error,
|
|
2680
|
+
} = ServiceabilityPlatformApplicationValidator.putFulfillmentOption().validate(
|
|
2681
|
+
{
|
|
2682
|
+
slug,
|
|
2683
|
+
body,
|
|
2684
|
+
},
|
|
2685
|
+
{ abortEarly: false, allowUnknown: true }
|
|
2686
|
+
);
|
|
2687
|
+
if (error) {
|
|
2688
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
2689
|
+
}
|
|
2690
|
+
|
|
2691
|
+
// Showing warrnings if extra unknown parameters are found
|
|
2692
|
+
const {
|
|
2693
|
+
error: warrning,
|
|
2694
|
+
} = ServiceabilityPlatformApplicationValidator.putFulfillmentOption().validate(
|
|
2695
|
+
{
|
|
2696
|
+
slug,
|
|
2697
|
+
body,
|
|
2698
|
+
},
|
|
2699
|
+
{ abortEarly: false, allowUnknown: false }
|
|
2700
|
+
);
|
|
2701
|
+
if (warrning) {
|
|
2702
|
+
Logger({
|
|
2703
|
+
level: "WARN",
|
|
2704
|
+
message: `Parameter Validation warrnings for platform > Serviceability > putFulfillmentOption \n ${warrning}`,
|
|
2705
|
+
});
|
|
2706
|
+
}
|
|
2707
|
+
|
|
2708
|
+
const query_params = {};
|
|
2709
|
+
|
|
2710
|
+
const response = await PlatformAPIClient.execute(
|
|
2711
|
+
this.config,
|
|
2712
|
+
"put",
|
|
2713
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options/${slug}`,
|
|
2714
|
+
query_params,
|
|
2715
|
+
body,
|
|
2716
|
+
requestHeaders,
|
|
2717
|
+
{ responseHeaders }
|
|
2718
|
+
);
|
|
2719
|
+
|
|
2720
|
+
let responseData = response;
|
|
2721
|
+
if (responseHeaders) {
|
|
2722
|
+
responseData = response[0];
|
|
2723
|
+
}
|
|
2724
|
+
|
|
2725
|
+
const {
|
|
2726
|
+
error: res_error,
|
|
2727
|
+
} = ServiceabilityPlatformModel.FulfillmentOption().validate(responseData, {
|
|
2728
|
+
abortEarly: false,
|
|
2729
|
+
allowUnknown: true,
|
|
2730
|
+
});
|
|
2731
|
+
|
|
2732
|
+
if (res_error) {
|
|
2733
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
2734
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
2735
|
+
} else {
|
|
2736
|
+
Logger({
|
|
2737
|
+
level: "WARN",
|
|
2738
|
+
message: `Response Validation Warnings for platform > Serviceability > putFulfillmentOption \n ${res_error}`,
|
|
2739
|
+
});
|
|
2740
|
+
}
|
|
2741
|
+
}
|
|
2742
|
+
|
|
2743
|
+
return response;
|
|
2744
|
+
}
|
|
2745
|
+
|
|
2147
2746
|
/**
|
|
2148
2747
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam} arg
|
|
2149
2748
|
* - Arg object
|
|
@@ -2154,7 +2753,7 @@ class Serviceability {
|
|
|
2154
2753
|
* Success response
|
|
2155
2754
|
* @name updateApplicationConfiguration
|
|
2156
2755
|
* @summary: Apply configuration to an application
|
|
2157
|
-
* @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://
|
|
2756
|
+
* @description: Apply configuration to application to set DP rules and Zone configuration - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateApplicationConfiguration/).
|
|
2158
2757
|
*/
|
|
2159
2758
|
async updateApplicationConfiguration(
|
|
2160
2759
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2236,7 +2835,7 @@ class Serviceability {
|
|
|
2236
2835
|
* Success response
|
|
2237
2836
|
* @name updateBulkGeoArea
|
|
2238
2837
|
* @summary: Update geoareas and their associated regions in bulk
|
|
2239
|
-
* @description: Update geoarea details and their associated regions through a CSV file in bulk. - Check out [method documentation](https://
|
|
2838
|
+
* @description: Update geoarea details and their associated regions through a CSV file in bulk. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateBulkGeoArea/).
|
|
2240
2839
|
*/
|
|
2241
2840
|
async updateBulkGeoArea(
|
|
2242
2841
|
{ geoareaId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2320,7 +2919,7 @@ class Serviceability {
|
|
|
2320
2919
|
* Success response
|
|
2321
2920
|
* @name updateCourierPartnerRulePriority
|
|
2322
2921
|
* @summary: Update courier partner rule priority
|
|
2323
|
-
* @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://
|
|
2922
|
+
* @description: Updates a courier partner rule priority for a single application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierPartnerRulePriority/).
|
|
2324
2923
|
*/
|
|
2325
2924
|
async updateCourierPartnerRulePriority(
|
|
2326
2925
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2403,7 +3002,7 @@ class Serviceability {
|
|
|
2403
3002
|
*
|
|
2404
3003
|
* @name updateCourierRule
|
|
2405
3004
|
* @summary: Update courier rule
|
|
2406
|
-
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://
|
|
3005
|
+
* @description: Updates an existing rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateCourierRule/).
|
|
2407
3006
|
*/
|
|
2408
3007
|
async updateCourierRule(
|
|
2409
3008
|
{ ruleUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2487,7 +3086,7 @@ class Serviceability {
|
|
|
2487
3086
|
* Success response
|
|
2488
3087
|
* @name updateGeoArea
|
|
2489
3088
|
* @summary: Update the details of existing GeoArea
|
|
2490
|
-
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://
|
|
3089
|
+
* @description: Updates the GeoArea with a new name, regions, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateGeoArea/).
|
|
2491
3090
|
*/
|
|
2492
3091
|
async updateGeoArea(
|
|
2493
3092
|
{ geoareaId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2574,7 +3173,7 @@ class Serviceability {
|
|
|
2574
3173
|
*
|
|
2575
3174
|
* @name updatePincodeAuditHistory
|
|
2576
3175
|
* @summary: Get audit trail
|
|
2577
|
-
* @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://
|
|
3176
|
+
* @description: Retrieves the history of changes made to cash on delivery settings for pincodes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeAuditHistory/).
|
|
2578
3177
|
*/
|
|
2579
3178
|
async updatePincodeAuditHistory(
|
|
2580
3179
|
{ body, pageNumber, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2662,7 +3261,7 @@ class Serviceability {
|
|
|
2662
3261
|
* Success response
|
|
2663
3262
|
* @name updatePincodeBulkView
|
|
2664
3263
|
* @summary: Bulk update pincode COD support
|
|
2665
|
-
* @description: Updates the cash on delivery settings for multiple specified pin codes simultaneously. - Check out [method documentation](https://
|
|
3264
|
+
* @description: Updates the cash on delivery settings for multiple specified pin codes simultaneously. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeBulkView/).
|
|
2666
3265
|
*/
|
|
2667
3266
|
async updatePincodeBulkView(
|
|
2668
3267
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2745,7 +3344,7 @@ class Serviceability {
|
|
|
2745
3344
|
*
|
|
2746
3345
|
* @name updatePincodeCoDListing
|
|
2747
3346
|
* @summary: Get COD enabled pincodes
|
|
2748
|
-
* @description: Retrieves a list of pincodes along with the count based on whether cash on delivery settings. - Check out [method documentation](https://
|
|
3347
|
+
* @description: Retrieves a list of pincodes along with the count based on whether cash on delivery settings. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeCoDListing/).
|
|
2749
3348
|
*/
|
|
2750
3349
|
async updatePincodeCoDListing(
|
|
2751
3350
|
{ body, pageNumber, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2832,7 +3431,7 @@ class Serviceability {
|
|
|
2832
3431
|
* @returns {Promise<ServiceabilityPlatformModel.PincodeMOPResult>} - Success response
|
|
2833
3432
|
* @name updatePincodeMopView
|
|
2834
3433
|
* @summary: Update pincode COD support
|
|
2835
|
-
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://
|
|
3434
|
+
* @description: Modify and update views related to pincode MOP (Mode of Payment). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updatePincodeMopView/).
|
|
2836
3435
|
*/
|
|
2837
3436
|
async updatePincodeMopView(
|
|
2838
3437
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2914,7 +3513,7 @@ class Serviceability {
|
|
|
2914
3513
|
* Success response
|
|
2915
3514
|
* @name updateStoreRulePriority
|
|
2916
3515
|
* @summary: Update Store Rule priority
|
|
2917
|
-
* @description: Update Store Rule priority - Check out [method documentation](https://
|
|
3516
|
+
* @description: Update Store Rule priority - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRulePriority/).
|
|
2918
3517
|
*/
|
|
2919
3518
|
async updateStoreRulePriority(
|
|
2920
3519
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2997,7 +3596,7 @@ class Serviceability {
|
|
|
2997
3596
|
*
|
|
2998
3597
|
* @name updateStoreRules
|
|
2999
3598
|
* @summary: Update store rule
|
|
3000
|
-
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://
|
|
3599
|
+
* @description: Updates an existing rule within the order routing rules. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRules/).
|
|
3001
3600
|
*/
|
|
3002
3601
|
async updateStoreRules(
|
|
3003
3602
|
{ ruleUid, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3081,7 +3680,7 @@ class Serviceability {
|
|
|
3081
3680
|
* Success response
|
|
3082
3681
|
* @name updateStoreRulesConfig
|
|
3083
3682
|
* @summary: Update store rules configuration
|
|
3084
|
-
* @description: Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://
|
|
3683
|
+
* @description: Updates an existing order routing setup for a single application, which involves updating sorting settings or rule priorities. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateStoreRulesConfig/).
|
|
3085
3684
|
*/
|
|
3086
3685
|
async updateStoreRulesConfig(
|
|
3087
3686
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3164,7 +3763,7 @@ class Serviceability {
|
|
|
3164
3763
|
*
|
|
3165
3764
|
* @name updateZone
|
|
3166
3765
|
* @summary: Update details of a Zone to enable or disable
|
|
3167
|
-
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://
|
|
3766
|
+
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateZone/).
|
|
3168
3767
|
*/
|
|
3169
3768
|
async updateZone(
|
|
3170
3769
|
{ zoneId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3239,6 +3838,174 @@ class Serviceability {
|
|
|
3239
3838
|
|
|
3240
3839
|
return response;
|
|
3241
3840
|
}
|
|
3841
|
+
|
|
3842
|
+
/**
|
|
3843
|
+
* @param {ServiceabilityPlatformApplicationValidator.UploadBulkFulfillmentOptionsParam} arg
|
|
3844
|
+
* - Arg object
|
|
3845
|
+
*
|
|
3846
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3847
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3848
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkData>}
|
|
3849
|
+
* - Success response
|
|
3850
|
+
*
|
|
3851
|
+
* @name uploadBulkFulfillmentOptions
|
|
3852
|
+
* @summary: Upload bulk fulfillment options.
|
|
3853
|
+
* @description: Uploads a bulk list of fulfillment options for an application, allowing multiple fulfillment configurations to be processed at once. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/uploadBulkFulfillmentOptions/).
|
|
3854
|
+
*/
|
|
3855
|
+
async uploadBulkFulfillmentOptions(
|
|
3856
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
3857
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3858
|
+
) {
|
|
3859
|
+
const {
|
|
3860
|
+
error,
|
|
3861
|
+
} = ServiceabilityPlatformApplicationValidator.uploadBulkFulfillmentOptions().validate(
|
|
3862
|
+
{
|
|
3863
|
+
body,
|
|
3864
|
+
},
|
|
3865
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3866
|
+
);
|
|
3867
|
+
if (error) {
|
|
3868
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3869
|
+
}
|
|
3870
|
+
|
|
3871
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3872
|
+
const {
|
|
3873
|
+
error: warrning,
|
|
3874
|
+
} = ServiceabilityPlatformApplicationValidator.uploadBulkFulfillmentOptions().validate(
|
|
3875
|
+
{
|
|
3876
|
+
body,
|
|
3877
|
+
},
|
|
3878
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3879
|
+
);
|
|
3880
|
+
if (warrning) {
|
|
3881
|
+
Logger({
|
|
3882
|
+
level: "WARN",
|
|
3883
|
+
message: `Parameter Validation warrnings for platform > Serviceability > uploadBulkFulfillmentOptions \n ${warrning}`,
|
|
3884
|
+
});
|
|
3885
|
+
}
|
|
3886
|
+
|
|
3887
|
+
const query_params = {};
|
|
3888
|
+
|
|
3889
|
+
const response = await PlatformAPIClient.execute(
|
|
3890
|
+
this.config,
|
|
3891
|
+
"post",
|
|
3892
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options/bulk`,
|
|
3893
|
+
query_params,
|
|
3894
|
+
body,
|
|
3895
|
+
requestHeaders,
|
|
3896
|
+
{ responseHeaders }
|
|
3897
|
+
);
|
|
3898
|
+
|
|
3899
|
+
let responseData = response;
|
|
3900
|
+
if (responseHeaders) {
|
|
3901
|
+
responseData = response[0];
|
|
3902
|
+
}
|
|
3903
|
+
|
|
3904
|
+
const {
|
|
3905
|
+
error: res_error,
|
|
3906
|
+
} = ServiceabilityPlatformModel.FulfillmentOptionBulkData().validate(
|
|
3907
|
+
responseData,
|
|
3908
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3909
|
+
);
|
|
3910
|
+
|
|
3911
|
+
if (res_error) {
|
|
3912
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3913
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3914
|
+
} else {
|
|
3915
|
+
Logger({
|
|
3916
|
+
level: "WARN",
|
|
3917
|
+
message: `Response Validation Warnings for platform > Serviceability > uploadBulkFulfillmentOptions \n ${res_error}`,
|
|
3918
|
+
});
|
|
3919
|
+
}
|
|
3920
|
+
}
|
|
3921
|
+
|
|
3922
|
+
return response;
|
|
3923
|
+
}
|
|
3924
|
+
|
|
3925
|
+
/**
|
|
3926
|
+
* @param {ServiceabilityPlatformApplicationValidator.ValidateBulkFulfillmentOptionsParam} arg
|
|
3927
|
+
* - Arg object
|
|
3928
|
+
*
|
|
3929
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3930
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3931
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidateData>}
|
|
3932
|
+
* - Success response
|
|
3933
|
+
*
|
|
3934
|
+
* @name validateBulkFulfillmentOptions
|
|
3935
|
+
* @summary: Validate bulk fulfillment options.
|
|
3936
|
+
* @description: Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/validateBulkFulfillmentOptions/).
|
|
3937
|
+
*/
|
|
3938
|
+
async validateBulkFulfillmentOptions(
|
|
3939
|
+
{ type, body, requestHeaders } = { requestHeaders: {} },
|
|
3940
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
3941
|
+
) {
|
|
3942
|
+
const {
|
|
3943
|
+
error,
|
|
3944
|
+
} = ServiceabilityPlatformApplicationValidator.validateBulkFulfillmentOptions().validate(
|
|
3945
|
+
{
|
|
3946
|
+
type,
|
|
3947
|
+
body,
|
|
3948
|
+
},
|
|
3949
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3950
|
+
);
|
|
3951
|
+
if (error) {
|
|
3952
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
3953
|
+
}
|
|
3954
|
+
|
|
3955
|
+
// Showing warrnings if extra unknown parameters are found
|
|
3956
|
+
const {
|
|
3957
|
+
error: warrning,
|
|
3958
|
+
} = ServiceabilityPlatformApplicationValidator.validateBulkFulfillmentOptions().validate(
|
|
3959
|
+
{
|
|
3960
|
+
type,
|
|
3961
|
+
body,
|
|
3962
|
+
},
|
|
3963
|
+
{ abortEarly: false, allowUnknown: false }
|
|
3964
|
+
);
|
|
3965
|
+
if (warrning) {
|
|
3966
|
+
Logger({
|
|
3967
|
+
level: "WARN",
|
|
3968
|
+
message: `Parameter Validation warrnings for platform > Serviceability > validateBulkFulfillmentOptions \n ${warrning}`,
|
|
3969
|
+
});
|
|
3970
|
+
}
|
|
3971
|
+
|
|
3972
|
+
const query_params = {};
|
|
3973
|
+
|
|
3974
|
+
const response = await PlatformAPIClient.execute(
|
|
3975
|
+
this.config,
|
|
3976
|
+
"post",
|
|
3977
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options/bulk/validate/${type}`,
|
|
3978
|
+
query_params,
|
|
3979
|
+
body,
|
|
3980
|
+
requestHeaders,
|
|
3981
|
+
{ responseHeaders }
|
|
3982
|
+
);
|
|
3983
|
+
|
|
3984
|
+
let responseData = response;
|
|
3985
|
+
if (responseHeaders) {
|
|
3986
|
+
responseData = response[0];
|
|
3987
|
+
}
|
|
3988
|
+
|
|
3989
|
+
const {
|
|
3990
|
+
error: res_error,
|
|
3991
|
+
} = ServiceabilityPlatformModel.FulfillmentOptionBulkValidateData().validate(
|
|
3992
|
+
responseData,
|
|
3993
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3994
|
+
);
|
|
3995
|
+
|
|
3996
|
+
if (res_error) {
|
|
3997
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
3998
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
3999
|
+
} else {
|
|
4000
|
+
Logger({
|
|
4001
|
+
level: "WARN",
|
|
4002
|
+
message: `Response Validation Warnings for platform > Serviceability > validateBulkFulfillmentOptions \n ${res_error}`,
|
|
4003
|
+
});
|
|
4004
|
+
}
|
|
4005
|
+
}
|
|
4006
|
+
|
|
4007
|
+
return response;
|
|
4008
|
+
}
|
|
3242
4009
|
}
|
|
3243
4010
|
|
|
3244
4011
|
module.exports = Serviceability;
|