@gofynd/fdk-client-javascript 1.4.15 → 1.4.16-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +16 -16
- package/sdk/application/Cart/CartApplicationClient.js +101 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -16
- package/sdk/application/Catalog/CatalogApplicationClient.js +159 -0
- package/sdk/application/Common/CommonApplicationClient.js +6 -0
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +24 -0
- package/sdk/application/Content/ContentApplicationClient.d.ts +59 -7
- package/sdk/application/Content/ContentApplicationClient.js +290 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +24 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +6 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
- package/sdk/application/Lead/LeadApplicationClient.js +42 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.js +69 -2
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
- package/sdk/application/Order/OrderApplicationClient.js +117 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -11
- package/sdk/application/Payment/PaymentApplicationClient.js +15 -39
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +15 -0
- package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationClient.js +42 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +36 -0
- package/sdk/application/User/UserApplicationClient.js +6 -0
- package/sdk/application/Webhook/WebhookApplicationClient.js +6 -0
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +4 -4
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +12 -33
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +38 -209
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +19 -399
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +11 -212
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -3
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -22
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
- package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +12 -3
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -1
- package/sdk/platform/Cart/CartPlatformModel.d.ts +49 -28
- package/sdk/platform/Cart/CartPlatformModel.js +23 -13
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -24
- package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -176
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.js +36 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -45
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -35
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +132 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1104 -122
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +159 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +161 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +220 -5
- package/sdk/platform/Content/ContentPlatformModel.js +214 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +12 -2
- package/sdk/platform/Order/OrderPlatformClient.js +99 -8
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3 -75
- package/sdk/platform/Order/OrderPlatformModel.js +2 -43
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -23
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -95
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +78 -701
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +23 -598
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +20 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +3 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -110
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +10 -2
- package/sdk/platform/Share/SharePlatformModel.js +4 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
- package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +3 -3
- package/sdk/public/Content/ContentPublicClient.js +28 -0
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +10 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +1 -0
|
@@ -1,11 +1,4 @@
|
|
|
1
1
|
export = OrderPlatformApplicationValidator;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef FailedOrderLogsParam
|
|
4
|
-
* @property {number} [pageNo] - Page Number
|
|
5
|
-
* @property {number} [pageSize] - Page Size
|
|
6
|
-
* @property {string} [searchType] - Search type for filter
|
|
7
|
-
* @property {string} [searchValue] - Search value for filter
|
|
8
|
-
*/
|
|
9
2
|
/**
|
|
10
3
|
* @typedef GetApplicationShipmentsParam
|
|
11
4
|
* @property {string} [lane] - Optional parameter to specify the lane for
|
|
@@ -51,8 +44,6 @@ export = OrderPlatformApplicationValidator;
|
|
|
51
44
|
* @property {string} shipmentId - The unique identifier for the shipment
|
|
52
45
|
*/
|
|
53
46
|
declare class OrderPlatformApplicationValidator {
|
|
54
|
-
/** @returns {FailedOrderLogsParam} */
|
|
55
|
-
static failedOrderLogs(): FailedOrderLogsParam;
|
|
56
47
|
/** @returns {GetApplicationShipmentsParam} */
|
|
57
48
|
static getApplicationShipments(): GetApplicationShipmentsParam;
|
|
58
49
|
/** @returns {GetPlatformShipmentReasonsParam} */
|
|
@@ -65,26 +56,8 @@ declare class OrderPlatformApplicationValidator {
|
|
|
65
56
|
static trackShipmentPlatform(): TrackShipmentPlatformParam;
|
|
66
57
|
}
|
|
67
58
|
declare namespace OrderPlatformApplicationValidator {
|
|
68
|
-
export {
|
|
59
|
+
export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetRulesParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
|
|
69
60
|
}
|
|
70
|
-
type FailedOrderLogsParam = {
|
|
71
|
-
/**
|
|
72
|
-
* - Page Number
|
|
73
|
-
*/
|
|
74
|
-
pageNo?: number;
|
|
75
|
-
/**
|
|
76
|
-
* - Page Size
|
|
77
|
-
*/
|
|
78
|
-
pageSize?: number;
|
|
79
|
-
/**
|
|
80
|
-
* - Search type for filter
|
|
81
|
-
*/
|
|
82
|
-
searchType?: string;
|
|
83
|
-
/**
|
|
84
|
-
* - Search value for filter
|
|
85
|
-
*/
|
|
86
|
-
searchValue?: string;
|
|
87
|
-
};
|
|
88
61
|
type GetApplicationShipmentsParam = {
|
|
89
62
|
/**
|
|
90
63
|
* - Optional parameter to specify the lane for
|
|
@@ -2,14 +2,6 @@ const Joi = require("joi");
|
|
|
2
2
|
|
|
3
3
|
const OrderPlatformModel = require("./OrderPlatformModel");
|
|
4
4
|
|
|
5
|
-
/**
|
|
6
|
-
* @typedef FailedOrderLogsParam
|
|
7
|
-
* @property {number} [pageNo] - Page Number
|
|
8
|
-
* @property {number} [pageSize] - Page Size
|
|
9
|
-
* @property {string} [searchType] - Search type for filter
|
|
10
|
-
* @property {string} [searchValue] - Search value for filter
|
|
11
|
-
*/
|
|
12
|
-
|
|
13
5
|
/**
|
|
14
6
|
* @typedef GetApplicationShipmentsParam
|
|
15
7
|
* @property {string} [lane] - Optional parameter to specify the lane for
|
|
@@ -60,16 +52,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
60
52
|
*/
|
|
61
53
|
|
|
62
54
|
class OrderPlatformApplicationValidator {
|
|
63
|
-
/** @returns {FailedOrderLogsParam} */
|
|
64
|
-
static failedOrderLogs() {
|
|
65
|
-
return Joi.object({
|
|
66
|
-
pageNo: Joi.number(),
|
|
67
|
-
pageSize: Joi.number(),
|
|
68
|
-
searchType: Joi.string().allow(""),
|
|
69
|
-
searchValue: Joi.string().allow(""),
|
|
70
|
-
}).required();
|
|
71
|
-
}
|
|
72
|
-
|
|
73
55
|
/** @returns {GetApplicationShipmentsParam} */
|
|
74
56
|
static getApplicationShipments() {
|
|
75
57
|
return Joi.object({
|
|
@@ -131,6 +131,16 @@ declare class Order {
|
|
|
131
131
|
* @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/).
|
|
132
132
|
*/
|
|
133
133
|
failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
|
|
134
|
+
/**
|
|
135
|
+
* @param {OrderPlatformValidator.FailedOrderLogsParam} arg - Arg object
|
|
136
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
137
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
|
+
* @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
|
|
139
|
+
* @name failedOrderLogs
|
|
140
|
+
* @summary: List failed order logs
|
|
141
|
+
* @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
|
|
142
|
+
*/
|
|
143
|
+
failedOrderLogs({ applicationId, pageNo, pageSize, searchType, searchValue, requestHeaders, }?: OrderPlatformValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
|
|
134
144
|
/**
|
|
135
145
|
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
136
146
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -345,7 +355,7 @@ declare class Order {
|
|
|
345
355
|
* @summary: List orders
|
|
346
356
|
* @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
347
357
|
*/
|
|
348
|
-
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter,
|
|
358
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
|
|
349
359
|
/**
|
|
350
360
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
351
361
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -401,7 +411,7 @@ declare class Order {
|
|
|
401
411
|
* @summary: List shipments
|
|
402
412
|
* @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
403
413
|
*/
|
|
404
|
-
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter,
|
|
414
|
+
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
405
415
|
/**
|
|
406
416
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
407
417
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -996,6 +996,105 @@ class Order {
|
|
|
996
996
|
return response;
|
|
997
997
|
}
|
|
998
998
|
|
|
999
|
+
/**
|
|
1000
|
+
* @param {OrderPlatformValidator.FailedOrderLogsParam} arg - Arg object
|
|
1001
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1002
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1003
|
+
* @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
|
|
1004
|
+
* @name failedOrderLogs
|
|
1005
|
+
* @summary: List failed order logs
|
|
1006
|
+
* @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
|
|
1007
|
+
*/
|
|
1008
|
+
async failedOrderLogs(
|
|
1009
|
+
{
|
|
1010
|
+
applicationId,
|
|
1011
|
+
pageNo,
|
|
1012
|
+
pageSize,
|
|
1013
|
+
searchType,
|
|
1014
|
+
searchValue,
|
|
1015
|
+
requestHeaders,
|
|
1016
|
+
} = { requestHeaders: {} },
|
|
1017
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1018
|
+
) {
|
|
1019
|
+
const { error } = OrderPlatformValidator.failedOrderLogs().validate(
|
|
1020
|
+
{
|
|
1021
|
+
applicationId,
|
|
1022
|
+
pageNo,
|
|
1023
|
+
pageSize,
|
|
1024
|
+
searchType,
|
|
1025
|
+
searchValue,
|
|
1026
|
+
},
|
|
1027
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1028
|
+
);
|
|
1029
|
+
if (error) {
|
|
1030
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1031
|
+
}
|
|
1032
|
+
|
|
1033
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1034
|
+
const {
|
|
1035
|
+
error: warrning,
|
|
1036
|
+
} = OrderPlatformValidator.failedOrderLogs().validate(
|
|
1037
|
+
{
|
|
1038
|
+
applicationId,
|
|
1039
|
+
pageNo,
|
|
1040
|
+
pageSize,
|
|
1041
|
+
searchType,
|
|
1042
|
+
searchValue,
|
|
1043
|
+
},
|
|
1044
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1045
|
+
);
|
|
1046
|
+
if (warrning) {
|
|
1047
|
+
Logger({
|
|
1048
|
+
level: "WARN",
|
|
1049
|
+
message: `Parameter Validation warrnings for platform > Order > failedOrderLogs \n ${warrning}`,
|
|
1050
|
+
});
|
|
1051
|
+
}
|
|
1052
|
+
|
|
1053
|
+
const query_params = {};
|
|
1054
|
+
query_params["application_id"] = applicationId;
|
|
1055
|
+
query_params["page_no"] = pageNo;
|
|
1056
|
+
query_params["page_size"] = pageSize;
|
|
1057
|
+
query_params["search_type"] = searchType;
|
|
1058
|
+
query_params["search_value"] = searchValue;
|
|
1059
|
+
|
|
1060
|
+
const xHeaders = {};
|
|
1061
|
+
|
|
1062
|
+
const response = await PlatformAPIClient.execute(
|
|
1063
|
+
this.config,
|
|
1064
|
+
"get",
|
|
1065
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/orders/failed`,
|
|
1066
|
+
query_params,
|
|
1067
|
+
undefined,
|
|
1068
|
+
{ ...xHeaders, ...requestHeaders },
|
|
1069
|
+
{ responseHeaders }
|
|
1070
|
+
);
|
|
1071
|
+
|
|
1072
|
+
let responseData = response;
|
|
1073
|
+
if (responseHeaders) {
|
|
1074
|
+
responseData = response[0];
|
|
1075
|
+
}
|
|
1076
|
+
|
|
1077
|
+
const {
|
|
1078
|
+
error: res_error,
|
|
1079
|
+
} = OrderPlatformModel.FailedOrderLogs().validate(responseData, {
|
|
1080
|
+
abortEarly: false,
|
|
1081
|
+
allowUnknown: true,
|
|
1082
|
+
});
|
|
1083
|
+
|
|
1084
|
+
if (res_error) {
|
|
1085
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1086
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1087
|
+
} else {
|
|
1088
|
+
Logger({
|
|
1089
|
+
level: "WARN",
|
|
1090
|
+
message: `Response Validation Warnings for platform > Order > failedOrderLogs \n ${res_error}`,
|
|
1091
|
+
});
|
|
1092
|
+
}
|
|
1093
|
+
}
|
|
1094
|
+
|
|
1095
|
+
return response;
|
|
1096
|
+
}
|
|
1097
|
+
|
|
999
1098
|
/**
|
|
1000
1099
|
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
1001
1100
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -2837,7 +2936,6 @@ class Order {
|
|
|
2837
2936
|
allowInactive,
|
|
2838
2937
|
groupEntity,
|
|
2839
2938
|
enforceDateFilter,
|
|
2840
|
-
fulfillmentType,
|
|
2841
2939
|
requestHeaders,
|
|
2842
2940
|
} = { requestHeaders: {} },
|
|
2843
2941
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -2869,7 +2967,6 @@ class Order {
|
|
|
2869
2967
|
allowInactive,
|
|
2870
2968
|
groupEntity,
|
|
2871
2969
|
enforceDateFilter,
|
|
2872
|
-
fulfillmentType,
|
|
2873
2970
|
},
|
|
2874
2971
|
{ abortEarly: false, allowUnknown: true }
|
|
2875
2972
|
);
|
|
@@ -2905,7 +3002,6 @@ class Order {
|
|
|
2905
3002
|
allowInactive,
|
|
2906
3003
|
groupEntity,
|
|
2907
3004
|
enforceDateFilter,
|
|
2908
|
-
fulfillmentType,
|
|
2909
3005
|
},
|
|
2910
3006
|
{ abortEarly: false, allowUnknown: false }
|
|
2911
3007
|
);
|
|
@@ -2942,7 +3038,6 @@ class Order {
|
|
|
2942
3038
|
query_params["allow_inactive"] = allowInactive;
|
|
2943
3039
|
query_params["group_entity"] = groupEntity;
|
|
2944
3040
|
query_params["enforce_date_filter"] = enforceDateFilter;
|
|
2945
|
-
query_params["fulfillment_type"] = fulfillmentType;
|
|
2946
3041
|
|
|
2947
3042
|
const xHeaders = {};
|
|
2948
3043
|
|
|
@@ -3368,7 +3463,6 @@ class Order {
|
|
|
3368
3463
|
orderType,
|
|
3369
3464
|
groupEntity,
|
|
3370
3465
|
enforceDateFilter,
|
|
3371
|
-
fulfillmentType,
|
|
3372
3466
|
requestHeaders,
|
|
3373
3467
|
} = { requestHeaders: {} },
|
|
3374
3468
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -3408,7 +3502,6 @@ class Order {
|
|
|
3408
3502
|
orderType,
|
|
3409
3503
|
groupEntity,
|
|
3410
3504
|
enforceDateFilter,
|
|
3411
|
-
fulfillmentType,
|
|
3412
3505
|
},
|
|
3413
3506
|
{ abortEarly: false, allowUnknown: true }
|
|
3414
3507
|
);
|
|
@@ -3452,7 +3545,6 @@ class Order {
|
|
|
3452
3545
|
orderType,
|
|
3453
3546
|
groupEntity,
|
|
3454
3547
|
enforceDateFilter,
|
|
3455
|
-
fulfillmentType,
|
|
3456
3548
|
},
|
|
3457
3549
|
{ abortEarly: false, allowUnknown: false }
|
|
3458
3550
|
);
|
|
@@ -3497,7 +3589,6 @@ class Order {
|
|
|
3497
3589
|
query_params["order_type"] = orderType;
|
|
3498
3590
|
query_params["group_entity"] = groupEntity;
|
|
3499
3591
|
query_params["enforce_date_filter"] = enforceDateFilter;
|
|
3500
|
-
query_params["fulfillment_type"] = fulfillmentType;
|
|
3501
3592
|
|
|
3502
3593
|
const xHeaders = {};
|
|
3503
3594
|
|
|
@@ -1507,27 +1507,6 @@ export = OrderPlatformModel;
|
|
|
1507
1507
|
* information about the API response.
|
|
1508
1508
|
* @property {VerifyOtpResponseData} [data]
|
|
1509
1509
|
*/
|
|
1510
|
-
/**
|
|
1511
|
-
* @typedef BulkReportsFiltersSchema
|
|
1512
|
-
* @property {string} [bag_status] - Comma separated values of bag statuses(to
|
|
1513
|
-
* be deprecated).
|
|
1514
|
-
* @property {string} [operational_status] - Comma separated values of
|
|
1515
|
-
* shipment's operational statuses.
|
|
1516
|
-
* @property {string} [stores] - Comma separated values of store ids.
|
|
1517
|
-
* @property {string} [time_to_dispatch] - Specifies the type of shipments to
|
|
1518
|
-
* retrieve. Use "1" for non-breached shipments and "-1" for breached shipments.
|
|
1519
|
-
* @property {string} [payment_methods] - Filters shipments by payment method.
|
|
1520
|
-
* Use "PREPAID" for shipments paid in advance, and "COD" for cash-on-delivery
|
|
1521
|
-
* shipments.
|
|
1522
|
-
* @property {string} [dp_ids] - Comma separated values of delivery partners.
|
|
1523
|
-
* Either dp_id or slug(extension_id|scheme_id).
|
|
1524
|
-
* @property {string} [sales_channels] - Comma separated values of sales channels ids.
|
|
1525
|
-
* @property {string} [tags] - A comma-separated list of tags associated with
|
|
1526
|
-
* the entity. Each tag is a keyword or label that categorizes or describes the entity.
|
|
1527
|
-
* @property {string} [lock_status] - Indicates the lock status of the entity.
|
|
1528
|
-
* "true" means the shipment is in a complete or partial lock state, while
|
|
1529
|
-
* "false" means it is unlocked.
|
|
1530
|
-
*/
|
|
1531
1510
|
/**
|
|
1532
1511
|
* @typedef BulkReportsDownloadRequestSchema
|
|
1533
1512
|
* @property {string[]} [store_ids] - A list of specific store IDs for which the
|
|
@@ -1549,7 +1528,6 @@ export = OrderPlatformModel;
|
|
|
1549
1528
|
* should include data from cross-company operations.
|
|
1550
1529
|
* @property {Object} [custom_filters_for_lane] - A flexible object that allows
|
|
1551
1530
|
* users to define custom filters specific to the lanes being reported on.
|
|
1552
|
-
* @property {BulkReportsFiltersSchema} [filters]
|
|
1553
1531
|
*/
|
|
1554
1532
|
/**
|
|
1555
1533
|
* @typedef BulkReportsDownloadResponseSchema
|
|
@@ -3065,7 +3043,7 @@ export = OrderPlatformModel;
|
|
|
3065
3043
|
*/
|
|
3066
3044
|
/**
|
|
3067
3045
|
* @typedef Article
|
|
3068
|
-
* @property {Object
|
|
3046
|
+
* @property {Object} [child_details] - Contains a flexible set of key-value
|
|
3069
3047
|
* pairs representing detailed information about the article's child entities,
|
|
3070
3048
|
* including dimensions (width, height, length), weight, and unique
|
|
3071
3049
|
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
@@ -4914,7 +4892,7 @@ export = OrderPlatformModel;
|
|
|
4914
4892
|
declare class OrderPlatformModel {
|
|
4915
4893
|
}
|
|
4916
4894
|
declare namespace OrderPlatformModel {
|
|
4917
|
-
export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, DataUpdates, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema,
|
|
4895
|
+
export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, DataUpdates, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema };
|
|
4918
4896
|
}
|
|
4919
4897
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
4920
4898
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -7886,55 +7864,6 @@ type VerifyOtpResponseSchema = {
|
|
|
7886
7864
|
message?: string;
|
|
7887
7865
|
data?: VerifyOtpResponseData;
|
|
7888
7866
|
};
|
|
7889
|
-
/** @returns {BulkReportsFiltersSchema} */
|
|
7890
|
-
declare function BulkReportsFiltersSchema(): BulkReportsFiltersSchema;
|
|
7891
|
-
type BulkReportsFiltersSchema = {
|
|
7892
|
-
/**
|
|
7893
|
-
* - Comma separated values of bag statuses(to
|
|
7894
|
-
* be deprecated).
|
|
7895
|
-
*/
|
|
7896
|
-
bag_status?: string;
|
|
7897
|
-
/**
|
|
7898
|
-
* - Comma separated values of
|
|
7899
|
-
* shipment's operational statuses.
|
|
7900
|
-
*/
|
|
7901
|
-
operational_status?: string;
|
|
7902
|
-
/**
|
|
7903
|
-
* - Comma separated values of store ids.
|
|
7904
|
-
*/
|
|
7905
|
-
stores?: string;
|
|
7906
|
-
/**
|
|
7907
|
-
* - Specifies the type of shipments to
|
|
7908
|
-
* retrieve. Use "1" for non-breached shipments and "-1" for breached shipments.
|
|
7909
|
-
*/
|
|
7910
|
-
time_to_dispatch?: string;
|
|
7911
|
-
/**
|
|
7912
|
-
* - Filters shipments by payment method.
|
|
7913
|
-
* Use "PREPAID" for shipments paid in advance, and "COD" for cash-on-delivery
|
|
7914
|
-
* shipments.
|
|
7915
|
-
*/
|
|
7916
|
-
payment_methods?: string;
|
|
7917
|
-
/**
|
|
7918
|
-
* - Comma separated values of delivery partners.
|
|
7919
|
-
* Either dp_id or slug(extension_id|scheme_id).
|
|
7920
|
-
*/
|
|
7921
|
-
dp_ids?: string;
|
|
7922
|
-
/**
|
|
7923
|
-
* - Comma separated values of sales channels ids.
|
|
7924
|
-
*/
|
|
7925
|
-
sales_channels?: string;
|
|
7926
|
-
/**
|
|
7927
|
-
* - A comma-separated list of tags associated with
|
|
7928
|
-
* the entity. Each tag is a keyword or label that categorizes or describes the entity.
|
|
7929
|
-
*/
|
|
7930
|
-
tags?: string;
|
|
7931
|
-
/**
|
|
7932
|
-
* - Indicates the lock status of the entity.
|
|
7933
|
-
* "true" means the shipment is in a complete or partial lock state, while
|
|
7934
|
-
* "false" means it is unlocked.
|
|
7935
|
-
*/
|
|
7936
|
-
lock_status?: string;
|
|
7937
|
-
};
|
|
7938
7867
|
/** @returns {BulkReportsDownloadRequestSchema} */
|
|
7939
7868
|
declare function BulkReportsDownloadRequestSchema(): BulkReportsDownloadRequestSchema;
|
|
7940
7869
|
type BulkReportsDownloadRequestSchema = {
|
|
@@ -7987,7 +7916,6 @@ type BulkReportsDownloadRequestSchema = {
|
|
|
7987
7916
|
* users to define custom filters specific to the lanes being reported on.
|
|
7988
7917
|
*/
|
|
7989
7918
|
custom_filters_for_lane?: any;
|
|
7990
|
-
filters?: BulkReportsFiltersSchema;
|
|
7991
7919
|
};
|
|
7992
7920
|
/** @returns {BulkReportsDownloadResponseSchema} */
|
|
7993
7921
|
declare function BulkReportsDownloadResponseSchema(): BulkReportsDownloadResponseSchema;
|
|
@@ -11191,7 +11119,7 @@ type Article = {
|
|
|
11191
11119
|
* including dimensions (width, height, length), weight, and unique
|
|
11192
11120
|
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
11193
11121
|
*/
|
|
11194
|
-
child_details?: any
|
|
11122
|
+
child_details?: any;
|
|
11195
11123
|
/**
|
|
11196
11124
|
* - Unique identifier assigned by the
|
|
11197
11125
|
* seller to the article, used for inventory management.
|
|
@@ -1648,28 +1648,6 @@ const Joi = require("joi");
|
|
|
1648
1648
|
* @property {VerifyOtpResponseData} [data]
|
|
1649
1649
|
*/
|
|
1650
1650
|
|
|
1651
|
-
/**
|
|
1652
|
-
* @typedef BulkReportsFiltersSchema
|
|
1653
|
-
* @property {string} [bag_status] - Comma separated values of bag statuses(to
|
|
1654
|
-
* be deprecated).
|
|
1655
|
-
* @property {string} [operational_status] - Comma separated values of
|
|
1656
|
-
* shipment's operational statuses.
|
|
1657
|
-
* @property {string} [stores] - Comma separated values of store ids.
|
|
1658
|
-
* @property {string} [time_to_dispatch] - Specifies the type of shipments to
|
|
1659
|
-
* retrieve. Use "1" for non-breached shipments and "-1" for breached shipments.
|
|
1660
|
-
* @property {string} [payment_methods] - Filters shipments by payment method.
|
|
1661
|
-
* Use "PREPAID" for shipments paid in advance, and "COD" for cash-on-delivery
|
|
1662
|
-
* shipments.
|
|
1663
|
-
* @property {string} [dp_ids] - Comma separated values of delivery partners.
|
|
1664
|
-
* Either dp_id or slug(extension_id|scheme_id).
|
|
1665
|
-
* @property {string} [sales_channels] - Comma separated values of sales channels ids.
|
|
1666
|
-
* @property {string} [tags] - A comma-separated list of tags associated with
|
|
1667
|
-
* the entity. Each tag is a keyword or label that categorizes or describes the entity.
|
|
1668
|
-
* @property {string} [lock_status] - Indicates the lock status of the entity.
|
|
1669
|
-
* "true" means the shipment is in a complete or partial lock state, while
|
|
1670
|
-
* "false" means it is unlocked.
|
|
1671
|
-
*/
|
|
1672
|
-
|
|
1673
1651
|
/**
|
|
1674
1652
|
* @typedef BulkReportsDownloadRequestSchema
|
|
1675
1653
|
* @property {string[]} [store_ids] - A list of specific store IDs for which the
|
|
@@ -1691,7 +1669,6 @@ const Joi = require("joi");
|
|
|
1691
1669
|
* should include data from cross-company operations.
|
|
1692
1670
|
* @property {Object} [custom_filters_for_lane] - A flexible object that allows
|
|
1693
1671
|
* users to define custom filters specific to the lanes being reported on.
|
|
1694
|
-
* @property {BulkReportsFiltersSchema} [filters]
|
|
1695
1672
|
*/
|
|
1696
1673
|
|
|
1697
1674
|
/**
|
|
@@ -3321,7 +3298,7 @@ const Joi = require("joi");
|
|
|
3321
3298
|
|
|
3322
3299
|
/**
|
|
3323
3300
|
* @typedef Article
|
|
3324
|
-
* @property {Object
|
|
3301
|
+
* @property {Object} [child_details] - Contains a flexible set of key-value
|
|
3325
3302
|
* pairs representing detailed information about the article's child entities,
|
|
3326
3303
|
* including dimensions (width, height, length), weight, and unique
|
|
3327
3304
|
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
@@ -6835,21 +6812,6 @@ class OrderPlatformModel {
|
|
|
6835
6812
|
});
|
|
6836
6813
|
}
|
|
6837
6814
|
|
|
6838
|
-
/** @returns {BulkReportsFiltersSchema} */
|
|
6839
|
-
static BulkReportsFiltersSchema() {
|
|
6840
|
-
return Joi.object({
|
|
6841
|
-
bag_status: Joi.string().allow(""),
|
|
6842
|
-
operational_status: Joi.string().allow(""),
|
|
6843
|
-
stores: Joi.string().allow(""),
|
|
6844
|
-
time_to_dispatch: Joi.string().allow(""),
|
|
6845
|
-
payment_methods: Joi.string().allow(""),
|
|
6846
|
-
dp_ids: Joi.string().allow(""),
|
|
6847
|
-
sales_channels: Joi.string().allow(""),
|
|
6848
|
-
tags: Joi.string().allow(""),
|
|
6849
|
-
lock_status: Joi.string().allow(""),
|
|
6850
|
-
});
|
|
6851
|
-
}
|
|
6852
|
-
|
|
6853
6815
|
/** @returns {BulkReportsDownloadRequestSchema} */
|
|
6854
6816
|
static BulkReportsDownloadRequestSchema() {
|
|
6855
6817
|
return Joi.object({
|
|
@@ -6863,7 +6825,6 @@ class OrderPlatformModel {
|
|
|
6863
6825
|
filter_type: Joi.string().allow(""),
|
|
6864
6826
|
is_cross_company_enabled: Joi.boolean(),
|
|
6865
6827
|
custom_filters_for_lane: Joi.object().pattern(/\S/, Joi.any()),
|
|
6866
|
-
filters: OrderPlatformModel.BulkReportsFiltersSchema(),
|
|
6867
6828
|
});
|
|
6868
6829
|
}
|
|
6869
6830
|
|
|
@@ -8218,9 +8179,7 @@ class OrderPlatformModel {
|
|
|
8218
8179
|
/** @returns {Article} */
|
|
8219
8180
|
static Article() {
|
|
8220
8181
|
return Joi.object({
|
|
8221
|
-
child_details: Joi.
|
|
8222
|
-
.items(Joi.object().pattern(/\S/, Joi.any()))
|
|
8223
|
-
.allow(null, ""),
|
|
8182
|
+
child_details: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
8224
8183
|
seller_identifier: Joi.string().allow("").required(),
|
|
8225
8184
|
uid: Joi.string().allow("").required(),
|
|
8226
8185
|
set: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
@@ -55,6 +55,14 @@ export = OrderPlatformValidator;
|
|
|
55
55
|
* @typedef FailedOrderLogDetailsParam
|
|
56
56
|
* @property {string} logId - Log Error ID
|
|
57
57
|
*/
|
|
58
|
+
/**
|
|
59
|
+
* @typedef FailedOrderLogsParam
|
|
60
|
+
* @property {string} [applicationId] - Application ID
|
|
61
|
+
* @property {number} [pageNo] - Page Number
|
|
62
|
+
* @property {number} [pageSize] - Page Size
|
|
63
|
+
* @property {string} [searchType] - Search type for filter
|
|
64
|
+
* @property {string} [searchValue] - Search value for filter
|
|
65
|
+
*/
|
|
58
66
|
/**
|
|
59
67
|
* @typedef FetchRefundModeConfigParam
|
|
60
68
|
* @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
|
|
@@ -258,10 +266,6 @@ export = OrderPlatformValidator;
|
|
|
258
266
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
259
267
|
* orders. This is useful when fetching data for a specific date range while
|
|
260
268
|
* performing searches.
|
|
261
|
-
* @property {string} [fulfillmentType] - Define the Fulfillment Type for
|
|
262
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
263
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
264
|
-
* also depends on the login user accessType and store access
|
|
265
269
|
*/
|
|
266
270
|
/** @typedef GetRoleBasedActionsParam */
|
|
267
271
|
/**
|
|
@@ -349,10 +353,6 @@ export = OrderPlatformValidator;
|
|
|
349
353
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
350
354
|
* shipments. This is useful when fetching data for a specific date range
|
|
351
355
|
* while performing searches.
|
|
352
|
-
* @property {string} [fulfillmentType] - Define the Fulfillment Type for
|
|
353
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
354
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
355
|
-
* also depends on the login user accessType and store access
|
|
356
356
|
*/
|
|
357
357
|
/**
|
|
358
358
|
* @typedef GetStateManagerConfigParam
|
|
@@ -464,6 +464,8 @@ declare class OrderPlatformValidator {
|
|
|
464
464
|
static eInvoiceRetry(): EInvoiceRetryParam;
|
|
465
465
|
/** @returns {FailedOrderLogDetailsParam} */
|
|
466
466
|
static failedOrderLogDetails(): FailedOrderLogDetailsParam;
|
|
467
|
+
/** @returns {FailedOrderLogsParam} */
|
|
468
|
+
static failedOrderLogs(): FailedOrderLogsParam;
|
|
467
469
|
/** @returns {FetchRefundModeConfigParam} */
|
|
468
470
|
static fetchRefundModeConfig(): FetchRefundModeConfigParam;
|
|
469
471
|
/** @returns {GenerateInvoiceIDParam} */
|
|
@@ -556,7 +558,7 @@ declare class OrderPlatformValidator {
|
|
|
556
558
|
static verifyMobileOTP(): VerifyMobileOTPParam;
|
|
557
559
|
}
|
|
558
560
|
declare namespace OrderPlatformValidator {
|
|
559
|
-
export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
|
|
561
|
+
export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdatePaymentInfoParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
|
|
560
562
|
}
|
|
561
563
|
type AddStateManagerConfigParam = {
|
|
562
564
|
body: OrderPlatformModel.TransitionConfigPayload;
|
|
@@ -629,6 +631,28 @@ type FailedOrderLogDetailsParam = {
|
|
|
629
631
|
*/
|
|
630
632
|
logId: string;
|
|
631
633
|
};
|
|
634
|
+
type FailedOrderLogsParam = {
|
|
635
|
+
/**
|
|
636
|
+
* - Application ID
|
|
637
|
+
*/
|
|
638
|
+
applicationId?: string;
|
|
639
|
+
/**
|
|
640
|
+
* - Page Number
|
|
641
|
+
*/
|
|
642
|
+
pageNo?: number;
|
|
643
|
+
/**
|
|
644
|
+
* - Page Size
|
|
645
|
+
*/
|
|
646
|
+
pageSize?: number;
|
|
647
|
+
/**
|
|
648
|
+
* - Search type for filter
|
|
649
|
+
*/
|
|
650
|
+
searchType?: string;
|
|
651
|
+
/**
|
|
652
|
+
* - Search value for filter
|
|
653
|
+
*/
|
|
654
|
+
searchValue?: string;
|
|
655
|
+
};
|
|
632
656
|
type FetchRefundModeConfigParam = {
|
|
633
657
|
body: OrderPlatformModel.RefundModeConfigRequestPayload;
|
|
634
658
|
};
|
|
@@ -1085,13 +1109,6 @@ type GetOrdersParam = {
|
|
|
1085
1109
|
* performing searches.
|
|
1086
1110
|
*/
|
|
1087
1111
|
enforceDateFilter?: boolean;
|
|
1088
|
-
/**
|
|
1089
|
-
* - Define the Fulfillment Type for
|
|
1090
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
1091
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
1092
|
-
* also depends on the login user accessType and store access
|
|
1093
|
-
*/
|
|
1094
|
-
fulfillmentType?: string;
|
|
1095
1112
|
};
|
|
1096
1113
|
type GetShipmentByIdParam = {
|
|
1097
1114
|
/**
|
|
@@ -1300,13 +1317,6 @@ type GetShipmentsParam = {
|
|
|
1300
1317
|
* while performing searches.
|
|
1301
1318
|
*/
|
|
1302
1319
|
enforceDateFilter?: boolean;
|
|
1303
|
-
/**
|
|
1304
|
-
* - Define the Fulfillment Type for
|
|
1305
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
1306
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
1307
|
-
* also depends on the login user accessType and store access
|
|
1308
|
-
*/
|
|
1309
|
-
fulfillmentType?: string;
|
|
1310
1320
|
};
|
|
1311
1321
|
type GetStateManagerConfigParam = {
|
|
1312
1322
|
/**
|