@gofynd/fdk-client-javascript 1.4.12-beta.1 → 1.4.13
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/platform/Catalog/CatalogPlatformApplicationClient.d.ts +38 -35
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +42 -39
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -23
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +14 -12
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1104 -230
- package/sdk/platform/Catalog/CatalogPlatformModel.js +461 -222
- package/sdk/platform/Order/OrderPlatformClient.d.ts +5 -49
- package/sdk/platform/Order/OrderPlatformClient.js +32 -328
- package/sdk/platform/Order/OrderPlatformModel.d.ts +2607 -1393
- package/sdk/platform/Order/OrderPlatformModel.js +1069 -1402
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +142 -110
- package/sdk/platform/Order/OrderPlatformValidator.js +64 -91
|
@@ -53,17 +53,6 @@ declare class Order {
|
|
|
53
53
|
* @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
|
|
54
54
|
*/
|
|
55
55
|
checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
|
|
56
|
-
/**
|
|
57
|
-
* @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
|
|
58
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
|
-
* @returns {Promise<OrderPlatformModel.CreateChannelConfigResponse>} -
|
|
61
|
-
* Success response
|
|
62
|
-
* @name createChannelConfig
|
|
63
|
-
* @summary: Create channel configuration
|
|
64
|
-
* @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
|
|
65
|
-
*/
|
|
66
|
-
createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponse>;
|
|
67
56
|
/**
|
|
68
57
|
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
69
58
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -125,18 +114,6 @@ declare class Order {
|
|
|
125
114
|
* @description: Get the exact error trace from the log Id provided in the failed order list API response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
|
|
126
115
|
*/
|
|
127
116
|
failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
|
|
128
|
-
/**
|
|
129
|
-
* @param {OrderPlatformValidator.FetchCreditBalanceDetailParam} arg - Arg object
|
|
130
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
131
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
132
|
-
* @returns {Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>}
|
|
133
|
-
* - Success response
|
|
134
|
-
*
|
|
135
|
-
* @name fetchCreditBalanceDetail
|
|
136
|
-
* @summary: Get credit balance detail
|
|
137
|
-
* @description: Retrieve details about credit balance on the basis of customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
|
|
138
|
-
*/
|
|
139
|
-
fetchCreditBalanceDetail({ body, requestHeaders }?: OrderPlatformValidator.FetchCreditBalanceDetailParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>;
|
|
140
117
|
/**
|
|
141
118
|
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
142
119
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -252,16 +229,6 @@ declare class Order {
|
|
|
252
229
|
* @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
|
|
253
230
|
*/
|
|
254
231
|
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
255
|
-
/**
|
|
256
|
-
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
257
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
258
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
259
|
-
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
260
|
-
* @name getChannelConfig
|
|
261
|
-
* @summary: Get channel configuration
|
|
262
|
-
* @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
263
|
-
*/
|
|
264
|
-
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
265
232
|
/**
|
|
266
233
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
267
234
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -291,7 +258,7 @@ declare class Order {
|
|
|
291
258
|
* @summary: Get a manifest
|
|
292
259
|
* @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
|
|
293
260
|
*/
|
|
294
|
-
getManifestDetails({ manifestId, requestHeaders }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
|
|
261
|
+
getManifestDetails({ manifestId, dpIds, endDate, startDate, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
|
|
295
262
|
/**
|
|
296
263
|
* @param {OrderPlatformValidator.GetManifestShipmentsParam} arg - Arg object
|
|
297
264
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -478,17 +445,6 @@ declare class Order {
|
|
|
478
445
|
* @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
|
|
479
446
|
*/
|
|
480
447
|
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
481
|
-
/**
|
|
482
|
-
* @param {OrderPlatformValidator.ProcessManifestsParam} arg - Arg object
|
|
483
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
484
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
485
|
-
* @returns {Promise<OrderPlatformModel.ProcessManifestItemResponse>} -
|
|
486
|
-
* Success response
|
|
487
|
-
* @name processManifests
|
|
488
|
-
* @summary: Generate manifest
|
|
489
|
-
* @description: Generate manifest Id and PDF and tags the shipments with that manifest Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/processManifests/).
|
|
490
|
-
*/
|
|
491
|
-
processManifests({ body, requestHeaders }?: OrderPlatformValidator.ProcessManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ProcessManifestItemResponse>;
|
|
492
448
|
/**
|
|
493
449
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
494
450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -503,12 +459,12 @@ declare class Order {
|
|
|
503
459
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
504
460
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
505
461
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
506
|
-
* @returns {Promise<OrderPlatformModel.
|
|
462
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
507
463
|
* @name sendSmsNinja
|
|
508
464
|
* @summary: Send SMS
|
|
509
465
|
* @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
|
|
510
466
|
*/
|
|
511
|
-
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
467
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
|
|
512
468
|
/**
|
|
513
469
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
514
470
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -560,7 +516,7 @@ declare class Order {
|
|
|
560
516
|
* Success response
|
|
561
517
|
* @name updateShipmentLock
|
|
562
518
|
* @summary: Update a shipment lock
|
|
563
|
-
* @description: Modify shipment/bag lock and
|
|
519
|
+
* @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
|
|
564
520
|
*/
|
|
565
521
|
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
|
|
566
522
|
/**
|
|
@@ -595,7 +551,7 @@ declare class Order {
|
|
|
595
551
|
* @summary: Upload consent
|
|
596
552
|
* @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
|
|
597
553
|
*/
|
|
598
|
-
uploadConsents({
|
|
554
|
+
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
599
555
|
/**
|
|
600
556
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
601
557
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -436,86 +436,6 @@ class Order {
|
|
|
436
436
|
return response;
|
|
437
437
|
}
|
|
438
438
|
|
|
439
|
-
/**
|
|
440
|
-
* @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
|
|
441
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
442
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
443
|
-
* @returns {Promise<OrderPlatformModel.CreateChannelConfigResponse>} -
|
|
444
|
-
* Success response
|
|
445
|
-
* @name createChannelConfig
|
|
446
|
-
* @summary: Create channel configuration
|
|
447
|
-
* @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
|
|
448
|
-
*/
|
|
449
|
-
async createChannelConfig(
|
|
450
|
-
{ body, requestHeaders } = { requestHeaders: {} },
|
|
451
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
452
|
-
) {
|
|
453
|
-
const { error } = OrderPlatformValidator.createChannelConfig().validate(
|
|
454
|
-
{
|
|
455
|
-
body,
|
|
456
|
-
},
|
|
457
|
-
{ abortEarly: false, allowUnknown: true }
|
|
458
|
-
);
|
|
459
|
-
if (error) {
|
|
460
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
461
|
-
}
|
|
462
|
-
|
|
463
|
-
// Showing warrnings if extra unknown parameters are found
|
|
464
|
-
const {
|
|
465
|
-
error: warrning,
|
|
466
|
-
} = OrderPlatformValidator.createChannelConfig().validate(
|
|
467
|
-
{
|
|
468
|
-
body,
|
|
469
|
-
},
|
|
470
|
-
{ abortEarly: false, allowUnknown: false }
|
|
471
|
-
);
|
|
472
|
-
if (warrning) {
|
|
473
|
-
Logger({
|
|
474
|
-
level: "WARN",
|
|
475
|
-
message: `Parameter Validation warrnings for platform > Order > createChannelConfig \n ${warrning}`,
|
|
476
|
-
});
|
|
477
|
-
}
|
|
478
|
-
|
|
479
|
-
const query_params = {};
|
|
480
|
-
|
|
481
|
-
const xHeaders = {};
|
|
482
|
-
|
|
483
|
-
const response = await PlatformAPIClient.execute(
|
|
484
|
-
this.config,
|
|
485
|
-
"post",
|
|
486
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/order-config`,
|
|
487
|
-
query_params,
|
|
488
|
-
body,
|
|
489
|
-
{ ...xHeaders, ...requestHeaders },
|
|
490
|
-
{ responseHeaders }
|
|
491
|
-
);
|
|
492
|
-
|
|
493
|
-
let responseData = response;
|
|
494
|
-
if (responseHeaders) {
|
|
495
|
-
responseData = response[0];
|
|
496
|
-
}
|
|
497
|
-
|
|
498
|
-
const {
|
|
499
|
-
error: res_error,
|
|
500
|
-
} = OrderPlatformModel.CreateChannelConfigResponse().validate(
|
|
501
|
-
responseData,
|
|
502
|
-
{ abortEarly: false, allowUnknown: true }
|
|
503
|
-
);
|
|
504
|
-
|
|
505
|
-
if (res_error) {
|
|
506
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
507
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
508
|
-
} else {
|
|
509
|
-
Logger({
|
|
510
|
-
level: "WARN",
|
|
511
|
-
message: `Response Validation Warnings for platform > Order > createChannelConfig \n ${res_error}`,
|
|
512
|
-
});
|
|
513
|
-
}
|
|
514
|
-
}
|
|
515
|
-
|
|
516
|
-
return response;
|
|
517
|
-
}
|
|
518
|
-
|
|
519
439
|
/**
|
|
520
440
|
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
521
441
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -990,89 +910,6 @@ class Order {
|
|
|
990
910
|
return response;
|
|
991
911
|
}
|
|
992
912
|
|
|
993
|
-
/**
|
|
994
|
-
* @param {OrderPlatformValidator.FetchCreditBalanceDetailParam} arg - Arg object
|
|
995
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
996
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
997
|
-
* @returns {Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>}
|
|
998
|
-
* - Success response
|
|
999
|
-
*
|
|
1000
|
-
* @name fetchCreditBalanceDetail
|
|
1001
|
-
* @summary: Get credit balance detail
|
|
1002
|
-
* @description: Retrieve details about credit balance on the basis of customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
|
|
1003
|
-
*/
|
|
1004
|
-
async fetchCreditBalanceDetail(
|
|
1005
|
-
{ body, requestHeaders } = { requestHeaders: {} },
|
|
1006
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
1007
|
-
) {
|
|
1008
|
-
const {
|
|
1009
|
-
error,
|
|
1010
|
-
} = OrderPlatformValidator.fetchCreditBalanceDetail().validate(
|
|
1011
|
-
{
|
|
1012
|
-
body,
|
|
1013
|
-
},
|
|
1014
|
-
{ abortEarly: false, allowUnknown: true }
|
|
1015
|
-
);
|
|
1016
|
-
if (error) {
|
|
1017
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
1018
|
-
}
|
|
1019
|
-
|
|
1020
|
-
// Showing warrnings if extra unknown parameters are found
|
|
1021
|
-
const {
|
|
1022
|
-
error: warrning,
|
|
1023
|
-
} = OrderPlatformValidator.fetchCreditBalanceDetail().validate(
|
|
1024
|
-
{
|
|
1025
|
-
body,
|
|
1026
|
-
},
|
|
1027
|
-
{ abortEarly: false, allowUnknown: false }
|
|
1028
|
-
);
|
|
1029
|
-
if (warrning) {
|
|
1030
|
-
Logger({
|
|
1031
|
-
level: "WARN",
|
|
1032
|
-
message: `Parameter Validation warrnings for platform > Order > fetchCreditBalanceDetail \n ${warrning}`,
|
|
1033
|
-
});
|
|
1034
|
-
}
|
|
1035
|
-
|
|
1036
|
-
const query_params = {};
|
|
1037
|
-
|
|
1038
|
-
const xHeaders = {};
|
|
1039
|
-
|
|
1040
|
-
const response = await PlatformAPIClient.execute(
|
|
1041
|
-
this.config,
|
|
1042
|
-
"post",
|
|
1043
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/customer-credit-balance`,
|
|
1044
|
-
query_params,
|
|
1045
|
-
body,
|
|
1046
|
-
{ ...xHeaders, ...requestHeaders },
|
|
1047
|
-
{ responseHeaders }
|
|
1048
|
-
);
|
|
1049
|
-
|
|
1050
|
-
let responseData = response;
|
|
1051
|
-
if (responseHeaders) {
|
|
1052
|
-
responseData = response[0];
|
|
1053
|
-
}
|
|
1054
|
-
|
|
1055
|
-
const {
|
|
1056
|
-
error: res_error,
|
|
1057
|
-
} = OrderPlatformModel.FetchCreditBalanceResponsePayload().validate(
|
|
1058
|
-
responseData,
|
|
1059
|
-
{ abortEarly: false, allowUnknown: true }
|
|
1060
|
-
);
|
|
1061
|
-
|
|
1062
|
-
if (res_error) {
|
|
1063
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
1064
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1065
|
-
} else {
|
|
1066
|
-
Logger({
|
|
1067
|
-
level: "WARN",
|
|
1068
|
-
message: `Response Validation Warnings for platform > Order > fetchCreditBalanceDetail \n ${res_error}`,
|
|
1069
|
-
});
|
|
1070
|
-
}
|
|
1071
|
-
}
|
|
1072
|
-
|
|
1073
|
-
return response;
|
|
1074
|
-
}
|
|
1075
|
-
|
|
1076
913
|
/**
|
|
1077
914
|
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
1078
915
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -2049,81 +1886,6 @@ class Order {
|
|
|
2049
1886
|
return response;
|
|
2050
1887
|
}
|
|
2051
1888
|
|
|
2052
|
-
/**
|
|
2053
|
-
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
2054
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2055
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2056
|
-
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
2057
|
-
* @name getChannelConfig
|
|
2058
|
-
* @summary: Get channel configuration
|
|
2059
|
-
* @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
2060
|
-
*/
|
|
2061
|
-
async getChannelConfig(
|
|
2062
|
-
{ requestHeaders } = { requestHeaders: {} },
|
|
2063
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
2064
|
-
) {
|
|
2065
|
-
const { error } = OrderPlatformValidator.getChannelConfig().validate(
|
|
2066
|
-
{},
|
|
2067
|
-
{ abortEarly: false, allowUnknown: true }
|
|
2068
|
-
);
|
|
2069
|
-
if (error) {
|
|
2070
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
2071
|
-
}
|
|
2072
|
-
|
|
2073
|
-
// Showing warrnings if extra unknown parameters are found
|
|
2074
|
-
const {
|
|
2075
|
-
error: warrning,
|
|
2076
|
-
} = OrderPlatformValidator.getChannelConfig().validate(
|
|
2077
|
-
{},
|
|
2078
|
-
{ abortEarly: false, allowUnknown: false }
|
|
2079
|
-
);
|
|
2080
|
-
if (warrning) {
|
|
2081
|
-
Logger({
|
|
2082
|
-
level: "WARN",
|
|
2083
|
-
message: `Parameter Validation warrnings for platform > Order > getChannelConfig \n ${warrning}`,
|
|
2084
|
-
});
|
|
2085
|
-
}
|
|
2086
|
-
|
|
2087
|
-
const query_params = {};
|
|
2088
|
-
|
|
2089
|
-
const xHeaders = {};
|
|
2090
|
-
|
|
2091
|
-
const response = await PlatformAPIClient.execute(
|
|
2092
|
-
this.config,
|
|
2093
|
-
"get",
|
|
2094
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/order-config`,
|
|
2095
|
-
query_params,
|
|
2096
|
-
undefined,
|
|
2097
|
-
{ ...xHeaders, ...requestHeaders },
|
|
2098
|
-
{ responseHeaders }
|
|
2099
|
-
);
|
|
2100
|
-
|
|
2101
|
-
let responseData = response;
|
|
2102
|
-
if (responseHeaders) {
|
|
2103
|
-
responseData = response[0];
|
|
2104
|
-
}
|
|
2105
|
-
|
|
2106
|
-
const {
|
|
2107
|
-
error: res_error,
|
|
2108
|
-
} = OrderPlatformModel.CreateChannelConfigData().validate(responseData, {
|
|
2109
|
-
abortEarly: false,
|
|
2110
|
-
allowUnknown: true,
|
|
2111
|
-
});
|
|
2112
|
-
|
|
2113
|
-
if (res_error) {
|
|
2114
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
2115
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
2116
|
-
} else {
|
|
2117
|
-
Logger({
|
|
2118
|
-
level: "WARN",
|
|
2119
|
-
message: `Response Validation Warnings for platform > Order > getChannelConfig \n ${res_error}`,
|
|
2120
|
-
});
|
|
2121
|
-
}
|
|
2122
|
-
}
|
|
2123
|
-
|
|
2124
|
-
return response;
|
|
2125
|
-
}
|
|
2126
|
-
|
|
2127
1889
|
/**
|
|
2128
1890
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
2129
1891
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -2377,12 +2139,25 @@ class Order {
|
|
|
2377
2139
|
* @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
|
|
2378
2140
|
*/
|
|
2379
2141
|
async getManifestDetails(
|
|
2380
|
-
{
|
|
2142
|
+
{
|
|
2143
|
+
manifestId,
|
|
2144
|
+
dpIds,
|
|
2145
|
+
endDate,
|
|
2146
|
+
startDate,
|
|
2147
|
+
pageNo,
|
|
2148
|
+
pageSize,
|
|
2149
|
+
requestHeaders,
|
|
2150
|
+
} = { requestHeaders: {} },
|
|
2381
2151
|
{ responseHeaders } = { responseHeaders: false }
|
|
2382
2152
|
) {
|
|
2383
2153
|
const { error } = OrderPlatformValidator.getManifestDetails().validate(
|
|
2384
2154
|
{
|
|
2385
2155
|
manifestId,
|
|
2156
|
+
dpIds,
|
|
2157
|
+
endDate,
|
|
2158
|
+
startDate,
|
|
2159
|
+
pageNo,
|
|
2160
|
+
pageSize,
|
|
2386
2161
|
},
|
|
2387
2162
|
{ abortEarly: false, allowUnknown: true }
|
|
2388
2163
|
);
|
|
@@ -2396,6 +2171,11 @@ class Order {
|
|
|
2396
2171
|
} = OrderPlatformValidator.getManifestDetails().validate(
|
|
2397
2172
|
{
|
|
2398
2173
|
manifestId,
|
|
2174
|
+
dpIds,
|
|
2175
|
+
endDate,
|
|
2176
|
+
startDate,
|
|
2177
|
+
pageNo,
|
|
2178
|
+
pageSize,
|
|
2399
2179
|
},
|
|
2400
2180
|
{ abortEarly: false, allowUnknown: false }
|
|
2401
2181
|
);
|
|
@@ -2407,13 +2187,19 @@ class Order {
|
|
|
2407
2187
|
}
|
|
2408
2188
|
|
|
2409
2189
|
const query_params = {};
|
|
2190
|
+
query_params["manifest_id"] = manifestId;
|
|
2191
|
+
query_params["dp_ids"] = dpIds;
|
|
2192
|
+
query_params["end_date"] = endDate;
|
|
2193
|
+
query_params["start_date"] = startDate;
|
|
2194
|
+
query_params["page_no"] = pageNo;
|
|
2195
|
+
query_params["page_size"] = pageSize;
|
|
2410
2196
|
|
|
2411
2197
|
const xHeaders = {};
|
|
2412
2198
|
|
|
2413
2199
|
const response = await PlatformAPIClient.execute(
|
|
2414
2200
|
this.config,
|
|
2415
2201
|
"get",
|
|
2416
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/
|
|
2202
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/details`,
|
|
2417
2203
|
query_params,
|
|
2418
2204
|
undefined,
|
|
2419
2205
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -2725,7 +2511,7 @@ class Order {
|
|
|
2725
2511
|
const response = await PlatformAPIClient.execute(
|
|
2726
2512
|
this.config,
|
|
2727
2513
|
"get",
|
|
2728
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/
|
|
2514
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/listing`,
|
|
2729
2515
|
query_params,
|
|
2730
2516
|
undefined,
|
|
2731
2517
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -4185,86 +3971,6 @@ class Order {
|
|
|
4185
3971
|
return response;
|
|
4186
3972
|
}
|
|
4187
3973
|
|
|
4188
|
-
/**
|
|
4189
|
-
* @param {OrderPlatformValidator.ProcessManifestsParam} arg - Arg object
|
|
4190
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4191
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4192
|
-
* @returns {Promise<OrderPlatformModel.ProcessManifestItemResponse>} -
|
|
4193
|
-
* Success response
|
|
4194
|
-
* @name processManifests
|
|
4195
|
-
* @summary: Generate manifest
|
|
4196
|
-
* @description: Generate manifest Id and PDF and tags the shipments with that manifest Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/processManifests/).
|
|
4197
|
-
*/
|
|
4198
|
-
async processManifests(
|
|
4199
|
-
{ body, requestHeaders } = { requestHeaders: {} },
|
|
4200
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
4201
|
-
) {
|
|
4202
|
-
const { error } = OrderPlatformValidator.processManifests().validate(
|
|
4203
|
-
{
|
|
4204
|
-
body,
|
|
4205
|
-
},
|
|
4206
|
-
{ abortEarly: false, allowUnknown: true }
|
|
4207
|
-
);
|
|
4208
|
-
if (error) {
|
|
4209
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
4210
|
-
}
|
|
4211
|
-
|
|
4212
|
-
// Showing warrnings if extra unknown parameters are found
|
|
4213
|
-
const {
|
|
4214
|
-
error: warrning,
|
|
4215
|
-
} = OrderPlatformValidator.processManifests().validate(
|
|
4216
|
-
{
|
|
4217
|
-
body,
|
|
4218
|
-
},
|
|
4219
|
-
{ abortEarly: false, allowUnknown: false }
|
|
4220
|
-
);
|
|
4221
|
-
if (warrning) {
|
|
4222
|
-
Logger({
|
|
4223
|
-
level: "WARN",
|
|
4224
|
-
message: `Parameter Validation warrnings for platform > Order > processManifests \n ${warrning}`,
|
|
4225
|
-
});
|
|
4226
|
-
}
|
|
4227
|
-
|
|
4228
|
-
const query_params = {};
|
|
4229
|
-
|
|
4230
|
-
const xHeaders = {};
|
|
4231
|
-
|
|
4232
|
-
const response = await PlatformAPIClient.execute(
|
|
4233
|
-
this.config,
|
|
4234
|
-
"post",
|
|
4235
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifests`,
|
|
4236
|
-
query_params,
|
|
4237
|
-
body,
|
|
4238
|
-
{ ...xHeaders, ...requestHeaders },
|
|
4239
|
-
{ responseHeaders }
|
|
4240
|
-
);
|
|
4241
|
-
|
|
4242
|
-
let responseData = response;
|
|
4243
|
-
if (responseHeaders) {
|
|
4244
|
-
responseData = response[0];
|
|
4245
|
-
}
|
|
4246
|
-
|
|
4247
|
-
const {
|
|
4248
|
-
error: res_error,
|
|
4249
|
-
} = OrderPlatformModel.ProcessManifestItemResponse().validate(
|
|
4250
|
-
responseData,
|
|
4251
|
-
{ abortEarly: false, allowUnknown: true }
|
|
4252
|
-
);
|
|
4253
|
-
|
|
4254
|
-
if (res_error) {
|
|
4255
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
4256
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
4257
|
-
} else {
|
|
4258
|
-
Logger({
|
|
4259
|
-
level: "WARN",
|
|
4260
|
-
message: `Response Validation Warnings for platform > Order > processManifests \n ${res_error}`,
|
|
4261
|
-
});
|
|
4262
|
-
}
|
|
4263
|
-
}
|
|
4264
|
-
|
|
4265
|
-
return response;
|
|
4266
|
-
}
|
|
4267
|
-
|
|
4268
3974
|
/**
|
|
4269
3975
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
4270
3976
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -4348,7 +4054,7 @@ class Order {
|
|
|
4348
4054
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
4349
4055
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4350
4056
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4351
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4057
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
4352
4058
|
* @name sendSmsNinja
|
|
4353
4059
|
* @summary: Send SMS
|
|
4354
4060
|
* @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
|
|
@@ -4402,7 +4108,7 @@ class Order {
|
|
|
4402
4108
|
|
|
4403
4109
|
const {
|
|
4404
4110
|
error: res_error,
|
|
4405
|
-
} = OrderPlatformModel.
|
|
4111
|
+
} = OrderPlatformModel.BaseResponse().validate(responseData, {
|
|
4406
4112
|
abortEarly: false,
|
|
4407
4113
|
allowUnknown: true,
|
|
4408
4114
|
});
|
|
@@ -4808,7 +4514,7 @@ class Order {
|
|
|
4808
4514
|
* Success response
|
|
4809
4515
|
* @name updateShipmentLock
|
|
4810
4516
|
* @summary: Update a shipment lock
|
|
4811
|
-
* @description: Modify shipment/bag lock and
|
|
4517
|
+
* @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
|
|
4812
4518
|
*/
|
|
4813
4519
|
async updateShipmentLock(
|
|
4814
4520
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5051,12 +4757,11 @@ class Order {
|
|
|
5051
4757
|
* @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
|
|
5052
4758
|
*/
|
|
5053
4759
|
async uploadConsents(
|
|
5054
|
-
{
|
|
4760
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
5055
4761
|
{ responseHeaders } = { responseHeaders: false }
|
|
5056
4762
|
) {
|
|
5057
4763
|
const { error } = OrderPlatformValidator.uploadConsents().validate(
|
|
5058
4764
|
{
|
|
5059
|
-
manifestId,
|
|
5060
4765
|
body,
|
|
5061
4766
|
},
|
|
5062
4767
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -5070,7 +4775,6 @@ class Order {
|
|
|
5070
4775
|
error: warrning,
|
|
5071
4776
|
} = OrderPlatformValidator.uploadConsents().validate(
|
|
5072
4777
|
{
|
|
5073
|
-
manifestId,
|
|
5074
4778
|
body,
|
|
5075
4779
|
},
|
|
5076
4780
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -5089,7 +4793,7 @@ class Order {
|
|
|
5089
4793
|
const response = await PlatformAPIClient.execute(
|
|
5090
4794
|
this.config,
|
|
5091
4795
|
"post",
|
|
5092
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest
|
|
4796
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/uploadConsent`,
|
|
5093
4797
|
query_params,
|
|
5094
4798
|
body,
|
|
5095
4799
|
{ ...xHeaders, ...requestHeaders },
|