@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.3.11-beta.8
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 +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +5 -3
- package/sdk/application/Cart/CartApplicationModel.d.ts +107 -1
- package/sdk/application/Cart/CartApplicationModel.js +74 -0
- package/sdk/application/Cart/CartApplicationValidator.d.ts +4 -0
- package/sdk/application/Cart/CartApplicationValidator.js +4 -0
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +3 -6
- package/sdk/application/Catalog/CatalogApplicationClient.js +7 -20
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +2 -2
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -14
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -6
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +183 -49
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +173 -31
- package/sdk/application/Content/ContentApplicationClient.d.ts +36 -0
- package/sdk/application/Content/ContentApplicationClient.js +246 -0
- package/sdk/application/Content/ContentApplicationModel.d.ts +208 -1
- package/sdk/application/Content/ContentApplicationModel.js +252 -0
- package/sdk/application/Content/ContentApplicationValidator.d.ts +40 -1
- package/sdk/application/Content/ContentApplicationValidator.js +41 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +67 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +547 -0
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +456 -1
- package/sdk/application/Logistic/LogisticApplicationModel.js +488 -0
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +211 -1
- package/sdk/application/Logistic/LogisticApplicationValidator.js +131 -0
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +32 -8
- package/sdk/application/Order/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Order/OrderApplicationValidator.d.ts +20 -0
- package/sdk/application/Order/OrderApplicationValidator.js +8 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -2
- package/sdk/application/Payment/PaymentApplicationClient.js +341 -10
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +493 -186
- package/sdk/application/Payment/PaymentApplicationModel.js +341 -70
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +59 -14
- package/sdk/application/Payment/PaymentApplicationValidator.js +64 -10
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +34 -1
- package/sdk/application/PosCart/PosCartApplicationModel.js +24 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +7 -3
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +222 -36
- package/sdk/application/Theme/ThemeApplicationModel.js +322 -26
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +10 -0
- package/sdk/application/Theme/ThemeApplicationValidator.js +4 -0
- package/sdk/application/User/UserApplicationClient.d.ts +33 -0
- package/sdk/application/User/UserApplicationClient.js +239 -0
- package/sdk/application/User/UserApplicationModel.d.ts +28 -13
- package/sdk/application/User/UserApplicationModel.js +36 -12
- package/sdk/application/User/UserApplicationValidator.d.ts +34 -1
- package/sdk/application/User/UserApplicationValidator.js +36 -0
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +125 -0
- package/sdk/partner/Lead/LeadPartnerClient.js +785 -0
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +1127 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +896 -0
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +12 -0
- package/sdk/partner/Lead/LeadPartnerValidator.js +67 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +155 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1195 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +372 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +442 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +16 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +123 -0
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +80 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +100 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +74 -30
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +9 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +99 -0
- package/sdk/partner/Webhook/WebhookPartnerClient.js +753 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +566 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +583 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +12 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +74 -0
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +11 -1
- package/sdk/platform/Billing/BillingPlatformClient.js +110 -3
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +67 -1
- package/sdk/platform/Billing/BillingPlatformModel.js +78 -0
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +43 -4
- package/sdk/platform/Billing/BillingPlatformValidator.js +29 -2
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +7 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +4 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +100 -5
- package/sdk/platform/Cart/CartPlatformModel.js +71 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +15 -11
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +52 -21
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +27 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +11 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +26 -4
- package/sdk/platform/Catalog/CatalogPlatformClient.js +173 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +304 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +335 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +27 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +138 -36
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +739 -57
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +128 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +111 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +150 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.js +172 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +8 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +38 -9
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +42 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +14 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +6 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +371 -132
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +288 -77
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +391 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +3630 -1059
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +342 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +401 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +277 -0
- package/sdk/platform/Content/ContentPlatformClient.js +2000 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1094 -1
- package/sdk/platform/Content/ContentPlatformModel.js +1356 -46
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +238 -0
- package/sdk/platform/Content/ContentPlatformValidator.js +310 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +96 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +104 -12
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +16 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +117 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +55 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +39 -2
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -5
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +18 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +33 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +240 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +151 -5
- package/sdk/platform/Finance/FinancePlatformModel.js +190 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +38 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +38 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +38 -28
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +137 -56
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +41 -29
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +33 -21
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +12 -3
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +23 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +178 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +39 -1
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +202 -31
- package/sdk/platform/Order/OrderPlatformClient.js +2010 -586
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1032 -470
- package/sdk/platform/Order/OrderPlatformModel.js +1187 -534
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +318 -35
- package/sdk/platform/Order/OrderPlatformValidator.js +292 -29
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +119 -13
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +749 -39
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +143 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +133 -6
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +996 -134
- package/sdk/platform/Payment/PaymentPlatformModel.js +721 -58
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +4 -2
- package/sdk/platform/PlatformClient.js +8 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +142 -66
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +645 -147
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +131 -63
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +126 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +217 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +1136 -347
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +912 -313
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1071 -355
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +382 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +266 -102
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +11 -1
- package/sdk/platform/Theme/ThemePlatformClient.js +87 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +333 -47
- package/sdk/platform/Theme/ThemePlatformModel.js +395 -35
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +28 -4
- package/sdk/platform/Theme/ThemePlatformValidator.js +21 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +116 -1
- package/sdk/platform/User/UserPlatformApplicationClient.js +931 -85
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +224 -7
- package/sdk/platform/User/UserPlatformApplicationValidator.js +173 -5
- package/sdk/platform/User/UserPlatformModel.d.ts +344 -7
- package/sdk/platform/User/UserPlatformModel.js +256 -5
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +47 -39
- package/sdk/platform/Webhook/WebhookPlatformClient.js +63 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +264 -156
- package/sdk/platform/Webhook/WebhookPlatformModel.js +276 -153
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +7 -10
- 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/Billing/BillingPublicClient.d.ts +23 -0
- package/sdk/public/Billing/BillingPublicClient.js +116 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +92 -0
- package/sdk/public/Billing/BillingPublicModel.js +96 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +18 -0
- package/sdk/public/Billing/BillingPublicValidator.js +19 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +114 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +53 -0
- package/sdk/public/Content/ContentPublicModel.js +60 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -0
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +4 -0
- package/sdk/public/PublicClient.js +8 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +33 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +242 -0
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +147 -1
- package/sdk/public/Webhook/WebhookPublicModel.js +177 -1
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +23 -1
- package/sdk/public/Webhook/WebhookPublicValidator.js +31 -0
- package/sdk/public/index.d.ts +2 -0
- package/sdk/public/index.js +4 -0
|
@@ -12,6 +12,28 @@ 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>;
|
|
15
37
|
/**
|
|
16
38
|
* @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
|
|
17
39
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -54,15 +76,15 @@ declare class Order {
|
|
|
54
76
|
*/
|
|
55
77
|
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
|
|
56
78
|
/**
|
|
57
|
-
* @param {OrderPlatformValidator.
|
|
79
|
+
* @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
|
|
58
80
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
81
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
82
|
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
61
|
-
* @name
|
|
83
|
+
* @name dispatchManifests
|
|
62
84
|
* @summary:
|
|
63
|
-
* @description: Dispatch Manifest - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/
|
|
85
|
+
* @description: Dispatch Manifest - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
|
|
64
86
|
*/
|
|
65
|
-
|
|
87
|
+
dispatchManifests({ manifestId, body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
66
88
|
/**
|
|
67
89
|
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
68
90
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -94,6 +116,16 @@ declare class Order {
|
|
|
94
116
|
* @description: Retry e-invoice after failure - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
|
|
95
117
|
*/
|
|
96
118
|
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>;
|
|
97
129
|
/**
|
|
98
130
|
* @param {OrderPlatformValidator.FetchCreditBalanceDetailParam} arg - Arg object
|
|
99
131
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -117,16 +149,6 @@ declare class Order {
|
|
|
117
149
|
* @description: Fetch Refund Mode Config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchRefundModeConfig/).
|
|
118
150
|
*/
|
|
119
151
|
fetchRefundModeConfig({ body, requestHeaders }?: OrderPlatformValidator.FetchRefundModeConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RefundModeConfigResponsePayload>;
|
|
120
|
-
/**
|
|
121
|
-
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
122
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
123
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
124
|
-
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponse>} - Success response
|
|
125
|
-
* @name generateInvoiceID
|
|
126
|
-
* @summary:
|
|
127
|
-
* @description: This API is used to manually generate Invoice ID against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
128
|
-
*/
|
|
129
|
-
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponse>;
|
|
130
152
|
/**
|
|
131
153
|
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
132
154
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -150,6 +172,16 @@ declare class Order {
|
|
|
150
172
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedStateTransition/).
|
|
151
173
|
*/
|
|
152
174
|
getAllowedStateTransition({ orderingChannel, status, requestHeaders }?: OrderPlatformValidator.GetAllowedStateTransitionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RoleBaseStateTransitionMapping>;
|
|
175
|
+
/**
|
|
176
|
+
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
177
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
178
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponse>} - Success response
|
|
180
|
+
* @name getAllowedTemplatesForBulk
|
|
181
|
+
* @summary:
|
|
182
|
+
* @description: Gets All the allowed Templates to perform Bulk Operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
|
|
183
|
+
*/
|
|
184
|
+
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponse>;
|
|
153
185
|
/**
|
|
154
186
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
155
187
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -201,7 +233,7 @@ declare class Order {
|
|
|
201
233
|
* @summary:
|
|
202
234
|
* @description: Generate Bulk Shipment Excel Report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
|
|
203
235
|
*/
|
|
204
|
-
getBulkShipmentExcelFile({ salesChannels, dpIds,
|
|
236
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
205
237
|
/**
|
|
206
238
|
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
207
239
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -212,6 +244,16 @@ declare class Order {
|
|
|
212
244
|
* @description: getChannelConfig - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
213
245
|
*/
|
|
214
246
|
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
247
|
+
/**
|
|
248
|
+
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
249
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
250
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
251
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
|
|
252
|
+
* @name getFileByStatus
|
|
253
|
+
* @summary:
|
|
254
|
+
* @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/).
|
|
255
|
+
*/
|
|
256
|
+
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponse>;
|
|
215
257
|
/**
|
|
216
258
|
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
217
259
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -221,7 +263,47 @@ declare class Order {
|
|
|
221
263
|
* @summary:
|
|
222
264
|
* @description: Get lane config for the order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
223
265
|
*/
|
|
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>;
|
|
266
|
+
getLaneConfig({ superLane, groupEntity, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponse>;
|
|
267
|
+
/**
|
|
268
|
+
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
269
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
270
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
271
|
+
* @returns {Promise<OrderPlatformModel.ManifestDetails>} - Success response
|
|
272
|
+
* @name getManifestDetails
|
|
273
|
+
* @summary:
|
|
274
|
+
* @description: get Manifest Details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
|
|
275
|
+
*/
|
|
276
|
+
getManifestDetails({ manifestId, requestHeaders }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
|
|
277
|
+
/**
|
|
278
|
+
* @param {OrderPlatformValidator.GetManifestShipmentsParam} arg - Arg object
|
|
279
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
280
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
281
|
+
* @returns {Promise<OrderPlatformModel.ManifestShipmentListing>} - Success response
|
|
282
|
+
* @name getManifestShipments
|
|
283
|
+
* @summary:
|
|
284
|
+
* @description: get Manifest Shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestShipments/).
|
|
285
|
+
*/
|
|
286
|
+
getManifestShipments({ dpIds, stores, toDate, fromDate, dpName, salesChannels, searchType, searchValue, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestShipmentListing>;
|
|
287
|
+
/**
|
|
288
|
+
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
289
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
290
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
291
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponse>} - Success response
|
|
292
|
+
* @name getManifestfilters
|
|
293
|
+
* @summary:
|
|
294
|
+
* @description: get Manifest Filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
295
|
+
*/
|
|
296
|
+
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponse>;
|
|
297
|
+
/**
|
|
298
|
+
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
299
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
300
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
301
|
+
* @returns {Promise<OrderPlatformModel.ManifestList>} - Success response
|
|
302
|
+
* @name getManifests
|
|
303
|
+
* @summary:
|
|
304
|
+
* @description: Fetch Manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifests/).
|
|
305
|
+
*/
|
|
306
|
+
getManifests({ status, startDate, endDate, searchType, storeId, searchValue, dpIds, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestList>;
|
|
225
307
|
/**
|
|
226
308
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
227
309
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -231,7 +313,7 @@ declare class Order {
|
|
|
231
313
|
* @summary:
|
|
232
314
|
* @description: Get Order Details by ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
233
315
|
*/
|
|
234
|
-
getOrderById({ orderId, myOrders, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
316
|
+
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
235
317
|
/**
|
|
236
318
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
237
319
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -241,7 +323,7 @@ declare class Order {
|
|
|
241
323
|
* @summary:
|
|
242
324
|
* @description: Get Orders Listing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
243
325
|
*/
|
|
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>;
|
|
326
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponse>;
|
|
245
327
|
/**
|
|
246
328
|
* @param {Object} arg - Arg object.
|
|
247
329
|
* @param {string} [arg.lane] - Lane refers to a section where orders are
|
|
@@ -259,6 +341,8 @@ declare class Order {
|
|
|
259
341
|
* field specified by the search_type
|
|
260
342
|
* @param {string} [arg.fromDate] -
|
|
261
343
|
* @param {string} [arg.toDate] -
|
|
344
|
+
* @param {string} [arg.startDate] -
|
|
345
|
+
* @param {string} [arg.endDate] -
|
|
262
346
|
* @param {string} [arg.dpIds] - Delivery Partner IDs to which shipments are assigned.
|
|
263
347
|
* @param {string} [arg.stores] -
|
|
264
348
|
* @param {string} [arg.salesChannels] -
|
|
@@ -274,7 +358,7 @@ declare class Order {
|
|
|
274
358
|
* @summary:
|
|
275
359
|
* @description: Get Orders Listing
|
|
276
360
|
*/
|
|
277
|
-
getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, }?: {
|
|
361
|
+
getOrdersPaginator({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, }?: {
|
|
278
362
|
lane?: string;
|
|
279
363
|
searchType?: string;
|
|
280
364
|
bagStatus?: string;
|
|
@@ -284,6 +368,8 @@ declare class Order {
|
|
|
284
368
|
searchValue?: string;
|
|
285
369
|
fromDate?: string;
|
|
286
370
|
toDate?: string;
|
|
371
|
+
startDate?: string;
|
|
372
|
+
endDate?: string;
|
|
287
373
|
dpIds?: string;
|
|
288
374
|
stores?: string;
|
|
289
375
|
salesChannels?: string;
|
|
@@ -347,7 +433,7 @@ declare class Order {
|
|
|
347
433
|
* @summary:
|
|
348
434
|
* @description: Get Shipments Listing for the company id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
349
435
|
*/
|
|
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>;
|
|
436
|
+
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, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
|
|
351
437
|
/**
|
|
352
438
|
* @param {Object} arg - Arg object.
|
|
353
439
|
* @param {string} [arg.lane] - Name of lane for which data is to be fetched
|
|
@@ -359,6 +445,8 @@ declare class Order {
|
|
|
359
445
|
* @param {string} [arg.searchValue] - Search type value
|
|
360
446
|
* @param {string} [arg.fromDate] - Start Date in DD-MM-YYYY format
|
|
361
447
|
* @param {string} [arg.toDate] - End Date in DD-MM-YYYY format
|
|
448
|
+
* @param {string} [arg.startDate] - UTC Start Date in ISO format
|
|
449
|
+
* @param {string} [arg.endDate] - UTC End Date in ISO format
|
|
362
450
|
* @param {string} [arg.dpIds] - Comma separated values of delivery partner ids
|
|
363
451
|
* @param {string} [arg.stores] - Comma separated values of store ids
|
|
364
452
|
* @param {string} [arg.salesChannels] - Comma separated values of sales channel ids
|
|
@@ -384,7 +472,7 @@ declare class Order {
|
|
|
384
472
|
* @summary:
|
|
385
473
|
* @description: Get Shipments Listing for the company id
|
|
386
474
|
*/
|
|
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, }?: {
|
|
475
|
+
getShipmentsPaginator({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, }?: {
|
|
388
476
|
lane?: string;
|
|
389
477
|
bagStatus?: string;
|
|
390
478
|
statusOverrideLane?: boolean;
|
|
@@ -393,6 +481,8 @@ declare class Order {
|
|
|
393
481
|
searchValue?: string;
|
|
394
482
|
fromDate?: string;
|
|
395
483
|
toDate?: string;
|
|
484
|
+
startDate?: string;
|
|
485
|
+
endDate?: string;
|
|
396
486
|
dpIds?: string;
|
|
397
487
|
stores?: string;
|
|
398
488
|
salesChannels?: string;
|
|
@@ -414,6 +504,66 @@ declare class Order {
|
|
|
414
504
|
customerId?: string;
|
|
415
505
|
orderType?: string;
|
|
416
506
|
}): Paginator<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
|
|
507
|
+
/**
|
|
508
|
+
* @param {OrderPlatformValidator.GetStateManagerTaskByIdParam} arg - Arg object
|
|
509
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
510
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
511
|
+
* @returns {Promise<Object>} - Success response
|
|
512
|
+
* @name getStateManagerTaskById
|
|
513
|
+
* @summary: Fetch a specific State Transition task
|
|
514
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerTaskById/).
|
|
515
|
+
*/
|
|
516
|
+
getStateManagerTaskById({ taskId, requestHeaders }?: OrderPlatformValidator.GetStateManagerTaskByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
517
|
+
/**
|
|
518
|
+
* @param {OrderPlatformValidator.GetStateManagerTasksParam} arg - Arg object
|
|
519
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
520
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
521
|
+
* @returns {Promise<Object>} - Success response
|
|
522
|
+
* @name getStateManagerTasks
|
|
523
|
+
* @summary: Fetch all State Transition tasks
|
|
524
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateManagerTasks/).
|
|
525
|
+
*/
|
|
526
|
+
getStateManagerTasks({ pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.GetStateManagerTasksParam, { responseHeaders }?: object): Promise<any>;
|
|
527
|
+
/**
|
|
528
|
+
* @param {OrderPlatformValidator.GetStateTransitionFiltersParam} arg - Arg object
|
|
529
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
530
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
531
|
+
* @returns {Promise<Object>} - Success response
|
|
532
|
+
* @name getStateTransitionFilters
|
|
533
|
+
* @summary: Fetch all State Transition filters
|
|
534
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFilters/).
|
|
535
|
+
*/
|
|
536
|
+
getStateTransitionFilters({ pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.GetStateTransitionFiltersParam, { responseHeaders }?: object): Promise<any>;
|
|
537
|
+
/**
|
|
538
|
+
* @param {OrderPlatformValidator.GetStateTransitionFiltersByIdParam} arg - Arg object
|
|
539
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
540
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
541
|
+
* @returns {Promise<Object>} - Success response
|
|
542
|
+
* @name getStateTransitionFiltersById
|
|
543
|
+
* @summary: Fetch a specific State Transition filter
|
|
544
|
+
* @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFiltersById/).
|
|
545
|
+
*/
|
|
546
|
+
getStateTransitionFiltersById({ filterId, requestHeaders }?: OrderPlatformValidator.GetStateTransitionFiltersByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
547
|
+
/**
|
|
548
|
+
* @param {OrderPlatformValidator.GetStateTransitionFlagsParam} arg - Arg object
|
|
549
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
550
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
551
|
+
* @returns {Promise<Object>} - Success response
|
|
552
|
+
* @name getStateTransitionFlags
|
|
553
|
+
* @summary:
|
|
554
|
+
* @description: Fetch all state transition flags for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFlags/).
|
|
555
|
+
*/
|
|
556
|
+
getStateTransitionFlags({ pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.GetStateTransitionFlagsParam, { responseHeaders }?: object): Promise<any>;
|
|
557
|
+
/**
|
|
558
|
+
* @param {OrderPlatformValidator.GetStateTransitionFlagsByIdParam} arg - Arg object
|
|
559
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
560
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
561
|
+
* @returns {Promise<Object>} - Success response
|
|
562
|
+
* @name getStateTransitionFlagsById
|
|
563
|
+
* @summary:
|
|
564
|
+
* @description: Fetch a specific state transition flag for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionFlagsById/).
|
|
565
|
+
*/
|
|
566
|
+
getStateTransitionFlagsById({ flagId, requestHeaders }?: OrderPlatformValidator.GetStateTransitionFlagsByIdParam, { responseHeaders }?: object): Promise<any>;
|
|
417
567
|
/**
|
|
418
568
|
* @param {OrderPlatformValidator.GetStateTransitionMapParam} arg - Arg object
|
|
419
569
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -424,6 +574,16 @@ declare class Order {
|
|
|
424
574
|
* @description: Get State Transition Map - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getStateTransitionMap/).
|
|
425
575
|
*/
|
|
426
576
|
getStateTransitionMap({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BagStateTransitionMap>;
|
|
577
|
+
/**
|
|
578
|
+
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
579
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
580
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
581
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
|
|
582
|
+
* @name getTemplate
|
|
583
|
+
* @summary:
|
|
584
|
+
* @description: Get the Excel file URL for the Template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
|
|
585
|
+
*/
|
|
586
|
+
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
|
|
427
587
|
/**
|
|
428
588
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
429
589
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -445,6 +605,16 @@ declare class Order {
|
|
|
445
605
|
* @description: Invalidate shipment Cache - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
|
|
446
606
|
*/
|
|
447
607
|
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
|
|
608
|
+
/**
|
|
609
|
+
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
610
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
611
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
612
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponse>} - Success response
|
|
613
|
+
* @name jobDetails
|
|
614
|
+
* @summary:
|
|
615
|
+
* @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/).
|
|
616
|
+
*/
|
|
617
|
+
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponse>;
|
|
448
618
|
/**
|
|
449
619
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
450
620
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -466,15 +636,16 @@ declare class Order {
|
|
|
466
636
|
*/
|
|
467
637
|
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
468
638
|
/**
|
|
469
|
-
* @param {OrderPlatformValidator.
|
|
639
|
+
* @param {OrderPlatformValidator.ProcessManifestsParam} arg - Arg object
|
|
470
640
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
471
641
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
|
-
* @returns {Promise<OrderPlatformModel.
|
|
473
|
-
*
|
|
642
|
+
* @returns {Promise<OrderPlatformModel.ProcessManifestItemResponse>} -
|
|
643
|
+
* Success response
|
|
644
|
+
* @name processManifests
|
|
474
645
|
* @summary:
|
|
475
|
-
* @description: Process Manifest - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/
|
|
646
|
+
* @description: Process Manifest. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/processManifests/).
|
|
476
647
|
*/
|
|
477
|
-
|
|
648
|
+
processManifests({ body, requestHeaders }?: OrderPlatformValidator.ProcessManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ProcessManifestItemResponse>;
|
|
478
649
|
/**
|
|
479
650
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
480
651
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -512,7 +683,7 @@ declare class Order {
|
|
|
512
683
|
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
|
|
513
684
|
* Success response
|
|
514
685
|
* @name trackShipment
|
|
515
|
-
* @summary:
|
|
686
|
+
* @summary:
|
|
516
687
|
* @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/).
|
|
517
688
|
*/
|
|
518
689
|
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
|
|
@@ -573,15 +744,15 @@ declare class Order {
|
|
|
573
744
|
*/
|
|
574
745
|
updateShipmentTracking({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentTrackingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingDetails>;
|
|
575
746
|
/**
|
|
576
|
-
* @param {OrderPlatformValidator.
|
|
747
|
+
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
577
748
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
578
749
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
579
750
|
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
580
|
-
* @name
|
|
751
|
+
* @name uploadConsents
|
|
581
752
|
* @summary:
|
|
582
|
-
* @description: Upload Consent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/
|
|
753
|
+
* @description: Upload Consent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
|
|
583
754
|
*/
|
|
584
|
-
|
|
755
|
+
uploadConsents({ manifestId, body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
585
756
|
/**
|
|
586
757
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
587
758
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|