@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +3 -5
- package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
- package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
- package/sdk/application/Cart/CartApplicationValidator.js +0 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
- package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
- package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
- package/sdk/application/Content/ContentApplicationClient.js +0 -246
- package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
- package/sdk/application/Content/ContentApplicationModel.js +565 -817
- package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
- package/sdk/application/Content/ContentApplicationValidator.js +0 -41
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
- package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
- package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +8 -32
- package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
- package/sdk/application/Order/OrderApplicationModel.js +816 -824
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
- package/sdk/application/Order/OrderApplicationValidator.js +0 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
- package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
- package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
- package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
- package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
- package/sdk/application/User/UserApplicationClient.d.ts +0 -33
- package/sdk/application/User/UserApplicationClient.js +0 -239
- package/sdk/application/User/UserApplicationModel.d.ts +753 -768
- package/sdk/application/User/UserApplicationModel.js +731 -755
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
- package/sdk/application/User/UserApplicationValidator.js +0 -36
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +254 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
- package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
- package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
- package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
- package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
- package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
- package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
- package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
- package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
- package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
- package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
- package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
- package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
- package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
- package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
- package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +2 -4
- package/sdk/platform/PlatformClient.js +4 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +990 -1589
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +986 -1702
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
- package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
- package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
- package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
- package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
- package/sdk/platform/User/UserPlatformModel.js +428 -679
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
- package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/PublicClient.d.ts +0 -4
- package/sdk/public/PublicClient.js +0 -8
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
- package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
- package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
- package/sdk/public/index.d.ts +0 -2
- package/sdk/public/index.js +0 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
- package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
- package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
- package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
- package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
- package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
- package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
- package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
- package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
- package/sdk/public/Billing/BillingPublicClient.js +0 -116
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
- package/sdk/public/Billing/BillingPublicModel.js +0 -96
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
- package/sdk/public/Billing/BillingPublicValidator.js +0 -19
- package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
- package/sdk/public/Content/ContentPublicClient.js +0 -114
- package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
- package/sdk/public/Content/ContentPublicModel.js +0 -60
- package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
- package/sdk/public/Content/ContentPublicValidator.js +0 -19
|
@@ -3,16 +3,6 @@ declare class Order {
|
|
|
3
3
|
constructor(config: any, applicationId: any);
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
|
-
/**
|
|
7
|
-
* @param {OrderPlatformApplicationValidator.FailedOrderLogsParam} arg - Arg object
|
|
8
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
9
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
|
-
* @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
|
|
11
|
-
* @name failedOrderLogs
|
|
12
|
-
* @summary: Get failed order logs according to the filter provided
|
|
13
|
-
* @description: This endpoint allows users to 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/).
|
|
14
|
-
*/
|
|
15
|
-
failedOrderLogs({ pageNo, pageSize, searchType, searchValue, requestHeaders }?: OrderPlatformApplicationValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
|
|
16
6
|
/**
|
|
17
7
|
* @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
|
|
18
8
|
* - Arg object
|
|
@@ -24,7 +14,7 @@ declare class Order {
|
|
|
24
14
|
*
|
|
25
15
|
* @name getApplicationShipments
|
|
26
16
|
* @summary:
|
|
27
|
-
* @description:
|
|
17
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
|
|
28
18
|
*/
|
|
29
19
|
getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
|
|
30
20
|
/**
|
|
@@ -15,98 +15,6 @@ class Order {
|
|
|
15
15
|
this.applicationId = applicationId;
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
-
/**
|
|
19
|
-
* @param {OrderPlatformApplicationValidator.FailedOrderLogsParam} arg - Arg object
|
|
20
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
21
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
22
|
-
* @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
|
|
23
|
-
* @name failedOrderLogs
|
|
24
|
-
* @summary: Get failed order logs according to the filter provided
|
|
25
|
-
* @description: This endpoint allows users to 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/).
|
|
26
|
-
*/
|
|
27
|
-
async failedOrderLogs(
|
|
28
|
-
{ pageNo, pageSize, searchType, searchValue, requestHeaders } = {
|
|
29
|
-
requestHeaders: {},
|
|
30
|
-
},
|
|
31
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
32
|
-
) {
|
|
33
|
-
const {
|
|
34
|
-
error,
|
|
35
|
-
} = OrderPlatformApplicationValidator.failedOrderLogs().validate(
|
|
36
|
-
{
|
|
37
|
-
pageNo,
|
|
38
|
-
pageSize,
|
|
39
|
-
searchType,
|
|
40
|
-
searchValue,
|
|
41
|
-
},
|
|
42
|
-
{ abortEarly: false, allowUnknown: true }
|
|
43
|
-
);
|
|
44
|
-
if (error) {
|
|
45
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
46
|
-
}
|
|
47
|
-
|
|
48
|
-
// Showing warrnings if extra unknown parameters are found
|
|
49
|
-
const {
|
|
50
|
-
error: warrning,
|
|
51
|
-
} = OrderPlatformApplicationValidator.failedOrderLogs().validate(
|
|
52
|
-
{
|
|
53
|
-
pageNo,
|
|
54
|
-
pageSize,
|
|
55
|
-
searchType,
|
|
56
|
-
searchValue,
|
|
57
|
-
},
|
|
58
|
-
{ abortEarly: false, allowUnknown: false }
|
|
59
|
-
);
|
|
60
|
-
if (warrning) {
|
|
61
|
-
Logger({
|
|
62
|
-
level: "WARN",
|
|
63
|
-
message: `Parameter Validation warrnings for platform > Order > failedOrderLogs \n ${warrning}`,
|
|
64
|
-
});
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
const query_params = {};
|
|
68
|
-
query_params["application_id"] = applicationId;
|
|
69
|
-
query_params["page_no"] = pageNo;
|
|
70
|
-
query_params["page_size"] = pageSize;
|
|
71
|
-
query_params["search_type"] = searchType;
|
|
72
|
-
query_params["search_value"] = searchValue;
|
|
73
|
-
|
|
74
|
-
const response = await PlatformAPIClient.execute(
|
|
75
|
-
this.config,
|
|
76
|
-
"get",
|
|
77
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/orders/failed`,
|
|
78
|
-
query_params,
|
|
79
|
-
undefined,
|
|
80
|
-
requestHeaders,
|
|
81
|
-
{ responseHeaders }
|
|
82
|
-
);
|
|
83
|
-
|
|
84
|
-
let responseData = response;
|
|
85
|
-
if (responseHeaders) {
|
|
86
|
-
responseData = response[0];
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
const {
|
|
90
|
-
error: res_error,
|
|
91
|
-
} = OrderPlatformModel.FailedOrderLogs().validate(responseData, {
|
|
92
|
-
abortEarly: false,
|
|
93
|
-
allowUnknown: true,
|
|
94
|
-
});
|
|
95
|
-
|
|
96
|
-
if (res_error) {
|
|
97
|
-
if (this.config.options.strictResponseCheck === true) {
|
|
98
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
99
|
-
} else {
|
|
100
|
-
Logger({
|
|
101
|
-
level: "WARN",
|
|
102
|
-
message: `Response Validation Warnings for platform > Order > failedOrderLogs \n ${res_error}`,
|
|
103
|
-
});
|
|
104
|
-
}
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
return response;
|
|
108
|
-
}
|
|
109
|
-
|
|
110
18
|
/**
|
|
111
19
|
* @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
|
|
112
20
|
* - Arg object
|
|
@@ -118,7 +26,7 @@ class Order {
|
|
|
118
26
|
*
|
|
119
27
|
* @name getApplicationShipments
|
|
120
28
|
* @summary:
|
|
121
|
-
* @description:
|
|
29
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
|
|
122
30
|
*/
|
|
123
31
|
async getApplicationShipments(
|
|
124
32
|
{
|
|
@@ -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]
|
|
@@ -39,8 +32,6 @@ export = OrderPlatformApplicationValidator;
|
|
|
39
32
|
* @property {string} shipmentId - Shipment Id
|
|
40
33
|
*/
|
|
41
34
|
declare class OrderPlatformApplicationValidator {
|
|
42
|
-
/** @returns {FailedOrderLogsParam} */
|
|
43
|
-
static failedOrderLogs(): FailedOrderLogsParam;
|
|
44
35
|
/** @returns {GetApplicationShipmentsParam} */
|
|
45
36
|
static getApplicationShipments(): GetApplicationShipmentsParam;
|
|
46
37
|
/** @returns {GetPlatformShipmentReasonsParam} */
|
|
@@ -51,26 +42,8 @@ declare class OrderPlatformApplicationValidator {
|
|
|
51
42
|
static trackShipmentPlatform(): TrackShipmentPlatformParam;
|
|
52
43
|
}
|
|
53
44
|
declare namespace OrderPlatformApplicationValidator {
|
|
54
|
-
export {
|
|
45
|
+
export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
|
|
55
46
|
}
|
|
56
|
-
type FailedOrderLogsParam = {
|
|
57
|
-
/**
|
|
58
|
-
* - Page Number
|
|
59
|
-
*/
|
|
60
|
-
pageNo?: number;
|
|
61
|
-
/**
|
|
62
|
-
* - Page Size
|
|
63
|
-
*/
|
|
64
|
-
pageSize?: number;
|
|
65
|
-
/**
|
|
66
|
-
* - Search type for filter
|
|
67
|
-
*/
|
|
68
|
-
searchType?: string;
|
|
69
|
-
/**
|
|
70
|
-
* - Search value for filter
|
|
71
|
-
*/
|
|
72
|
-
searchValue?: string;
|
|
73
|
-
};
|
|
74
47
|
type GetApplicationShipmentsParam = {
|
|
75
48
|
lane?: string;
|
|
76
49
|
searchType?: string;
|
|
@@ -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]
|
|
@@ -47,16 +39,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
47
39
|
*/
|
|
48
40
|
|
|
49
41
|
class OrderPlatformApplicationValidator {
|
|
50
|
-
/** @returns {FailedOrderLogsParam} */
|
|
51
|
-
static failedOrderLogs() {
|
|
52
|
-
return Joi.object({
|
|
53
|
-
pageNo: Joi.number(),
|
|
54
|
-
pageSize: Joi.number(),
|
|
55
|
-
searchType: Joi.string().allow(""),
|
|
56
|
-
searchValue: Joi.string().allow(""),
|
|
57
|
-
}).required();
|
|
58
|
-
}
|
|
59
|
-
|
|
60
42
|
/** @returns {GetApplicationShipmentsParam} */
|
|
61
43
|
static getApplicationShipments() {
|
|
62
44
|
return Joi.object({
|
|
@@ -12,28 +12,6 @@ declare class Order {
|
|
|
12
12
|
* @description: Attach Order User - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
|
|
13
13
|
*/
|
|
14
14
|
attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponse>;
|
|
15
|
-
/**
|
|
16
|
-
* @param {OrderPlatformValidator.BulkListingParam} arg - Arg object
|
|
17
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
-
* @returns {Promise<OrderPlatformModel.BulkListingResponse>} - Success response
|
|
20
|
-
* @name bulkListing
|
|
21
|
-
* @summary:
|
|
22
|
-
* @description: Fetches of previous or running bulk jobs.
|
|
23
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
|
|
24
|
-
*/
|
|
25
|
-
bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponse>;
|
|
26
|
-
/**
|
|
27
|
-
* @param {OrderPlatformValidator.BulkStateTransistionParam} arg - Arg object
|
|
28
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
29
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
|
-
* @returns {Promise<OrderPlatformModel.BulkStateTransistionResponse>} -
|
|
31
|
-
* Success response
|
|
32
|
-
* @name bulkStateTransistion
|
|
33
|
-
* @summary:
|
|
34
|
-
* @description: Performs State Transisiton in Bulk for the given shipments in the excel/csv file url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
|
|
35
|
-
*/
|
|
36
|
-
bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponse>;
|
|
37
15
|
/**
|
|
38
16
|
* @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
|
|
39
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -76,15 +54,15 @@ declare class Order {
|
|
|
76
54
|
*/
|
|
77
55
|
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
|
|
78
56
|
/**
|
|
79
|
-
* @param {OrderPlatformValidator.
|
|
57
|
+
* @param {OrderPlatformValidator.DispatchManifestParam} arg - Arg object
|
|
80
58
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
81
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
82
60
|
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
83
|
-
* @name
|
|
61
|
+
* @name dispatchManifest
|
|
84
62
|
* @summary:
|
|
85
|
-
* @description: Dispatch Manifest - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/
|
|
63
|
+
* @description: Dispatch Manifest - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifest/).
|
|
86
64
|
*/
|
|
87
|
-
|
|
65
|
+
dispatchManifest({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
88
66
|
/**
|
|
89
67
|
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
90
68
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -116,16 +94,6 @@ declare class Order {
|
|
|
116
94
|
* @description: Retry e-invoice after failure - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
|
|
117
95
|
*/
|
|
118
96
|
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponse>;
|
|
119
|
-
/**
|
|
120
|
-
* @param {OrderPlatformValidator.FailedOrderLogDetailsParam} arg - Arg object
|
|
121
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
123
|
-
* @returns {Promise<OrderPlatformModel.FailedOrderLogDetails>} - Success response
|
|
124
|
-
* @name failedOrderLogDetails
|
|
125
|
-
* @summary: Get failed order logs according to the filter provided
|
|
126
|
-
* @description: This endpoint allows users to get the exact error trace from the log id provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
|
|
127
|
-
*/
|
|
128
|
-
failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
|
|
129
97
|
/**
|
|
130
98
|
* @param {OrderPlatformValidator.FetchCreditBalanceDetailParam} arg - Arg object
|
|
131
99
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -182,16 +150,6 @@ declare class Order {
|
|
|
182
150
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
|
|
183
151
|
*/
|
|
184
152
|
getAllowedStateTransition({ orderingChannel, status, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
|
|
185
|
-
/**
|
|
186
|
-
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
187
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
188
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
189
|
-
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponse>} - Success response
|
|
190
|
-
* @name getAllowedTemplatesForBulk
|
|
191
|
-
* @summary:
|
|
192
|
-
* @description: Gets All the allowed Templates to perform Bulk Operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
|
|
193
|
-
*/
|
|
194
|
-
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponse>;
|
|
195
153
|
/**
|
|
196
154
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
197
155
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -243,7 +201,7 @@ declare class Order {
|
|
|
243
201
|
* @summary:
|
|
244
202
|
* @description: Generate Bulk Shipment Excel Report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
|
|
245
203
|
*/
|
|
246
|
-
getBulkShipmentExcelFile({ salesChannels, dpIds,
|
|
204
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, fromDate, toDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
247
205
|
/**
|
|
248
206
|
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
249
207
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -254,16 +212,6 @@ declare class Order {
|
|
|
254
212
|
* @description: getChannelConfig - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
255
213
|
*/
|
|
256
214
|
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
257
|
-
/**
|
|
258
|
-
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
259
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
260
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
261
|
-
* @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
|
|
262
|
-
* @name getFileByStatus
|
|
263
|
-
* @summary:
|
|
264
|
-
* @description: Get the file URL consisting Records of the provided status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
|
|
265
|
-
*/
|
|
266
|
-
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponse>;
|
|
267
215
|
/**
|
|
268
216
|
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
269
217
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -273,47 +221,7 @@ declare class Order {
|
|
|
273
221
|
* @summary:
|
|
274
222
|
* @description: Get lane config for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
275
223
|
*/
|
|
276
|
-
getLaneConfig({ superLane, groupEntity, fromDate, toDate,
|
|
277
|
-
/**
|
|
278
|
-
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
279
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
280
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
281
|
-
* @returns {Promise<OrderPlatformModel.ManifestDetails>} - Success response
|
|
282
|
-
* @name getManifestDetails
|
|
283
|
-
* @summary:
|
|
284
|
-
* @description: get Manifest Details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
|
|
285
|
-
*/
|
|
286
|
-
getManifestDetails({ manifestId, requestHeaders }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
|
|
287
|
-
/**
|
|
288
|
-
* @param {OrderPlatformValidator.GetManifestShipmentsParam} arg - Arg object
|
|
289
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
290
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
291
|
-
* @returns {Promise<OrderPlatformModel.ManifestShipmentListing>} - Success response
|
|
292
|
-
* @name getManifestShipments
|
|
293
|
-
* @summary:
|
|
294
|
-
* @description: get Manifest Shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestShipments/).
|
|
295
|
-
*/
|
|
296
|
-
getManifestShipments({ dpIds, stores, toDate, fromDate, dpName, salesChannels, searchType, searchValue, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestShipmentListing>;
|
|
297
|
-
/**
|
|
298
|
-
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
299
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
300
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
301
|
-
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponse>} - Success response
|
|
302
|
-
* @name getManifestfilters
|
|
303
|
-
* @summary:
|
|
304
|
-
* @description: get Manifest Filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
305
|
-
*/
|
|
306
|
-
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponse>;
|
|
307
|
-
/**
|
|
308
|
-
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
309
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
310
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
311
|
-
* @returns {Promise<OrderPlatformModel.ManifestList>} - Success response
|
|
312
|
-
* @name getManifests
|
|
313
|
-
* @summary:
|
|
314
|
-
* @description: Fetch Manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifests/).
|
|
315
|
-
*/
|
|
316
|
-
getManifests({ status, startDate, endDate, searchType, storeId, searchValue, dpIds, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestList>;
|
|
224
|
+
getLaneConfig({ superLane, groupEntity, fromDate, toDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponse>;
|
|
317
225
|
/**
|
|
318
226
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
319
227
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -323,7 +231,7 @@ declare class Order {
|
|
|
323
231
|
* @summary:
|
|
324
232
|
* @description: Get Order Details by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
325
233
|
*/
|
|
326
|
-
getOrderById({ orderId, myOrders,
|
|
234
|
+
getOrderById({ orderId, myOrders, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
327
235
|
/**
|
|
328
236
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
329
237
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -333,7 +241,7 @@ declare class Order {
|
|
|
333
241
|
* @summary:
|
|
334
242
|
* @description: Get Orders Listing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
335
243
|
*/
|
|
336
|
-
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate,
|
|
244
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
|
|
337
245
|
/**
|
|
338
246
|
* @param {Object} arg - Arg object.
|
|
339
247
|
* @param {string} [arg.lane] - Lane refers to a section where orders are
|
|
@@ -351,8 +259,6 @@ declare class Order {
|
|
|
351
259
|
* field specified by the search_type
|
|
352
260
|
* @param {string} [arg.fromDate] -
|
|
353
261
|
* @param {string} [arg.toDate] -
|
|
354
|
-
* @param {string} [arg.startDate] -
|
|
355
|
-
* @param {string} [arg.endDate] -
|
|
356
262
|
* @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
357
263
|
* @param {string} [arg.stores] -
|
|
358
264
|
* @param {string} [arg.salesChannels] -
|
|
@@ -368,7 +274,7 @@ declare class Order {
|
|
|
368
274
|
* @summary:
|
|
369
275
|
* @description: Get Orders Listing
|
|
370
276
|
*/
|
|
371
|
-
getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate,
|
|
277
|
+
getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, }?: {
|
|
372
278
|
lane?: string;
|
|
373
279
|
searchType?: string;
|
|
374
280
|
bagStatus?: string;
|
|
@@ -378,8 +284,6 @@ declare class Order {
|
|
|
378
284
|
searchValue?: string;
|
|
379
285
|
fromDate?: string;
|
|
380
286
|
toDate?: string;
|
|
381
|
-
startDate?: string;
|
|
382
|
-
endDate?: string;
|
|
383
287
|
dpIds?: string;
|
|
384
288
|
stores?: string;
|
|
385
289
|
salesChannels?: string;
|
|
@@ -410,7 +314,7 @@ declare class Order {
|
|
|
410
314
|
* @summary:
|
|
411
315
|
* @description: Get shipment details for the given shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
412
316
|
*/
|
|
413
|
-
getShipmentById({ channelShipmentId, shipmentId,
|
|
317
|
+
getShipmentById({ channelShipmentId, shipmentId, requestHeaders }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
|
|
414
318
|
/**
|
|
415
319
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
416
320
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -443,7 +347,7 @@ declare class Order {
|
|
|
443
347
|
* @summary:
|
|
444
348
|
* @description: Get Shipments Listing for the company id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
445
349
|
*/
|
|
446
|
-
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate,
|
|
350
|
+
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
|
|
447
351
|
/**
|
|
448
352
|
* @param {Object} arg - Arg object.
|
|
449
353
|
* @param {string} [arg.lane] - Name of lane for which data is to be fetched
|
|
@@ -455,8 +359,6 @@ declare class Order {
|
|
|
455
359
|
* @param {string} [arg.searchValue] - Search type value
|
|
456
360
|
* @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
|
|
457
361
|
* @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
|
|
458
|
-
* @param {string} [arg.startDate] - UTC Start Date in ISO format
|
|
459
|
-
* @param {string} [arg.endDate] - UTC End Date in ISO format
|
|
460
362
|
* @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
|
|
461
363
|
* @param {string} [arg.stores] - Comma separated values of store ids
|
|
462
364
|
* @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
|
|
@@ -482,7 +384,7 @@ declare class Order {
|
|
|
482
384
|
* @summary:
|
|
483
385
|
* @description: Get Shipments Listing for the company id
|
|
484
386
|
*/
|
|
485
|
-
getShipmentsPaginator({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate,
|
|
387
|
+
getShipmentsPaginator({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, }?: {
|
|
486
388
|
lane?: string;
|
|
487
389
|
bagStatus?: string;
|
|
488
390
|
statusOverrideLane?: boolean;
|
|
@@ -491,8 +393,6 @@ declare class Order {
|
|
|
491
393
|
searchValue?: string;
|
|
492
394
|
fromDate?: string;
|
|
493
395
|
toDate?: string;
|
|
494
|
-
startDate?: string;
|
|
495
|
-
endDate?: string;
|
|
496
396
|
dpIds?: string;
|
|
497
397
|
stores?: string;
|
|
498
398
|
salesChannels?: string;
|
|
@@ -524,16 +424,6 @@ declare class Order {
|
|
|
524
424
|
* @description: Get State Transition Map - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
|
|
525
425
|
*/
|
|
526
426
|
getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
|
|
527
|
-
/**
|
|
528
|
-
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
529
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
530
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
531
|
-
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
|
|
532
|
-
* @name getTemplate
|
|
533
|
-
* @summary:
|
|
534
|
-
* @description: Get the Excel file URL for the Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
|
|
535
|
-
*/
|
|
536
|
-
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
|
|
537
427
|
/**
|
|
538
428
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
539
429
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -555,16 +445,6 @@ declare class Order {
|
|
|
555
445
|
* @description: Invalidate shipment Cache - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
|
|
556
446
|
*/
|
|
557
447
|
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
|
|
558
|
-
/**
|
|
559
|
-
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
560
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
561
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
562
|
-
* @returns {Promise<OrderPlatformModel.JobDetailsResponse>} - Success response
|
|
563
|
-
* @name jobDetails
|
|
564
|
-
* @summary:
|
|
565
|
-
* @description: Fetches details for the job of the provided batch_id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/jobDetails/).
|
|
566
|
-
*/
|
|
567
|
-
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponse>;
|
|
568
448
|
/**
|
|
569
449
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
570
450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -586,16 +466,15 @@ declare class Order {
|
|
|
586
466
|
*/
|
|
587
467
|
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
588
468
|
/**
|
|
589
|
-
* @param {OrderPlatformValidator.
|
|
469
|
+
* @param {OrderPlatformValidator.ProcessManifestParam} arg - Arg object
|
|
590
470
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
591
471
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
592
|
-
* @returns {Promise<OrderPlatformModel.
|
|
593
|
-
*
|
|
594
|
-
* @name processManifests
|
|
472
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
|
|
473
|
+
* @name processManifest
|
|
595
474
|
* @summary:
|
|
596
|
-
* @description: Process Manifest
|
|
475
|
+
* @description: Process Manifest - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/processManifest/).
|
|
597
476
|
*/
|
|
598
|
-
|
|
477
|
+
processManifest({ body, requestHeaders }?: OrderPlatformValidator.ProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
|
|
599
478
|
/**
|
|
600
479
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
601
480
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -633,7 +512,7 @@ declare class Order {
|
|
|
633
512
|
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
|
|
634
513
|
* Success response
|
|
635
514
|
* @name trackShipment
|
|
636
|
-
* @summary:
|
|
515
|
+
* @summary: Get courier partner tracking details
|
|
637
516
|
* @description: This endpoint allows users to get courier partner tracking details for a given shipment id or awb no. The service will fetch courier partner statuses that are pushed to oms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
|
|
638
517
|
*/
|
|
639
518
|
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
|
|
@@ -694,15 +573,15 @@ declare class Order {
|
|
|
694
573
|
*/
|
|
695
574
|
updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
|
|
696
575
|
/**
|
|
697
|
-
* @param {OrderPlatformValidator.
|
|
576
|
+
* @param {OrderPlatformValidator.UploadConsentParam} arg - Arg object
|
|
698
577
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
699
578
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
700
579
|
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
701
|
-
* @name
|
|
580
|
+
* @name uploadConsent
|
|
702
581
|
* @summary:
|
|
703
|
-
* @description: Upload Consent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/
|
|
582
|
+
* @description: Upload Consent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsent/).
|
|
704
583
|
*/
|
|
705
|
-
|
|
584
|
+
uploadConsent({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
706
585
|
/**
|
|
707
586
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
708
587
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|