@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
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/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +118 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +810 -6
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -6,43 +6,46 @@ declare class Order {
|
|
|
6
6
|
* @param {OrderPlatformValidator.AddStateManagerConfigParam} arg - Arg object
|
|
7
7
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<OrderPlatformModel.
|
|
9
|
+
* @returns {Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>} -
|
|
10
|
+
* Success response
|
|
10
11
|
* @name addStateManagerConfig
|
|
11
12
|
* @summary: Allows esm config updation
|
|
12
13
|
* @description: Update ESM config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addStateManagerConfig/).
|
|
13
14
|
*/
|
|
14
|
-
addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
15
|
+
addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>;
|
|
15
16
|
/**
|
|
16
17
|
* @param {OrderPlatformValidator.AttachOrderUserParam} arg - Arg object
|
|
17
18
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
-
* @returns {Promise<OrderPlatformModel.
|
|
20
|
+
* @returns {Promise<OrderPlatformModel.AttachOrderUserResponseSchema>} -
|
|
21
|
+
* Success response
|
|
20
22
|
* @name attachOrderUser
|
|
21
23
|
* @summary: Attach order to a user
|
|
22
24
|
* @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
|
|
23
25
|
*/
|
|
24
|
-
attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
26
|
+
attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponseSchema>;
|
|
25
27
|
/**
|
|
26
28
|
* @param {OrderPlatformValidator.BulkListingParam} arg - Arg object
|
|
27
29
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
30
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
-
* @returns {Promise<OrderPlatformModel.
|
|
31
|
+
* @returns {Promise<OrderPlatformModel.BulkListingResponseSchema>} - Success response
|
|
30
32
|
* @name bulkListing
|
|
31
33
|
* @summary: Lists bulk operations
|
|
32
34
|
* @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
|
|
33
35
|
*/
|
|
34
|
-
bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
36
|
+
bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponseSchema>;
|
|
35
37
|
/**
|
|
36
38
|
* @param {OrderPlatformValidator.BulkStateTransistionParam} arg - Arg object
|
|
37
39
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
40
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
-
* @returns {Promise<OrderPlatformModel.
|
|
40
|
-
* Success response
|
|
41
|
+
* @returns {Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>}
|
|
42
|
+
* - Success response
|
|
43
|
+
*
|
|
41
44
|
* @name bulkStateTransistion
|
|
42
45
|
* @summary: Upload bulk state transitions file
|
|
43
46
|
* @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
|
|
44
47
|
*/
|
|
45
|
-
bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
48
|
+
bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>;
|
|
46
49
|
/**
|
|
47
50
|
* @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
|
|
48
51
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -53,57 +56,71 @@ declare class Order {
|
|
|
53
56
|
* @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
|
|
54
57
|
*/
|
|
55
58
|
checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
|
|
59
|
+
/**
|
|
60
|
+
* @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
|
|
61
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
62
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
63
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>}
|
|
64
|
+
* - Success response
|
|
65
|
+
*
|
|
66
|
+
* @name createChannelConfig
|
|
67
|
+
* @summary: Create channel configuration
|
|
68
|
+
* @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
|
|
69
|
+
*/
|
|
70
|
+
createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>;
|
|
56
71
|
/**
|
|
57
72
|
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
58
73
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
74
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
|
-
* @returns {Promise<OrderPlatformModel.
|
|
75
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponseSchema>} - Success response
|
|
61
76
|
* @name createOrder
|
|
62
77
|
* @summary: Create order
|
|
63
78
|
* @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
64
79
|
*/
|
|
65
|
-
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
80
|
+
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponseSchema>;
|
|
66
81
|
/**
|
|
67
82
|
* @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
|
|
68
83
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
84
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
70
|
-
* @returns {Promise<OrderPlatformModel.
|
|
85
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
71
86
|
* @name dispatchManifests
|
|
72
87
|
* @summary: Dispatch manifest
|
|
73
88
|
* @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
|
|
74
89
|
*/
|
|
75
|
-
dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
90
|
+
dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
|
|
76
91
|
/**
|
|
77
92
|
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
78
93
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
94
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
-
* @returns {Promise<OrderPlatformModel.
|
|
95
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
81
96
|
* @name downloadBulkActionTemplate
|
|
82
97
|
* @summary: Download bulk template
|
|
83
98
|
* @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
|
|
84
99
|
*/
|
|
85
|
-
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
100
|
+
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
|
|
86
101
|
/**
|
|
87
102
|
* @param {OrderPlatformValidator.DownloadLanesReportParam} arg - Arg object
|
|
88
103
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
89
104
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
|
-
* @returns {Promise<OrderPlatformModel.
|
|
91
|
-
* Success response
|
|
105
|
+
* @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>}
|
|
106
|
+
* - Success response
|
|
107
|
+
*
|
|
92
108
|
* @name downloadLanesReport
|
|
93
109
|
* @summary: Download Lane report
|
|
94
110
|
* @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
|
|
95
111
|
*/
|
|
96
|
-
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
112
|
+
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>;
|
|
97
113
|
/**
|
|
98
114
|
* @param {OrderPlatformValidator.EInvoiceRetryParam} arg - Arg object
|
|
99
115
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
100
116
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
|
-
* @returns {Promise<OrderPlatformModel.
|
|
117
|
+
* @returns {Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>} -
|
|
118
|
+
* Success response
|
|
102
119
|
* @name eInvoiceRetry
|
|
103
120
|
* @summary: Retry E-invoice
|
|
104
121
|
* @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
|
|
105
122
|
*/
|
|
106
|
-
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
123
|
+
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>;
|
|
107
124
|
/**
|
|
108
125
|
* @param {OrderPlatformValidator.FailedOrderLogDetailsParam} arg - Arg object
|
|
109
126
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -139,33 +156,35 @@ declare class Order {
|
|
|
139
156
|
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
140
157
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
141
158
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
142
|
-
* @returns {Promise<OrderPlatformModel.
|
|
159
|
+
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>} -
|
|
160
|
+
* Success response
|
|
143
161
|
* @name generateInvoiceID
|
|
144
162
|
* @summary: Generate and attach invoice Id
|
|
145
163
|
* @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
146
164
|
*/
|
|
147
|
-
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
165
|
+
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>;
|
|
148
166
|
/**
|
|
149
167
|
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
150
168
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
151
169
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
152
|
-
* @returns {Promise<OrderPlatformModel.
|
|
153
|
-
* Success response
|
|
170
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>}
|
|
171
|
+
* - Success response
|
|
172
|
+
*
|
|
154
173
|
* @name generatePOSReceiptByOrderId
|
|
155
174
|
* @summary: Generate POS receipt by order Id
|
|
156
175
|
* @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
|
|
157
176
|
*/
|
|
158
|
-
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
177
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>;
|
|
159
178
|
/**
|
|
160
179
|
* @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
|
|
161
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
163
|
-
* @returns {Promise<OrderPlatformModel.
|
|
182
|
+
* @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
|
|
164
183
|
* @name generateProcessManifest
|
|
165
184
|
* @summary: Process Order Manifest
|
|
166
185
|
* @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
|
|
167
186
|
*/
|
|
168
|
-
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
187
|
+
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponseSchema>;
|
|
169
188
|
/**
|
|
170
189
|
* @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
|
|
171
190
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -181,84 +200,99 @@ declare class Order {
|
|
|
181
200
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
182
201
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
-
* @returns {Promise<OrderPlatformModel.
|
|
203
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>} -
|
|
204
|
+
* Success response
|
|
185
205
|
* @name getAllowedTemplatesForBulk
|
|
186
206
|
* @summary: List bulk operation templates
|
|
187
207
|
* @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
|
|
188
208
|
*/
|
|
189
|
-
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
209
|
+
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>;
|
|
190
210
|
/**
|
|
191
211
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
192
212
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
193
213
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
194
|
-
* @returns {Promise<OrderPlatformModel.
|
|
214
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponseSchema>} -
|
|
215
|
+
* Success response
|
|
195
216
|
* @name getAnnouncements
|
|
196
217
|
* @summary: List announcements
|
|
197
218
|
* @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
|
|
198
219
|
*/
|
|
199
|
-
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
220
|
+
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponseSchema>;
|
|
200
221
|
/**
|
|
201
222
|
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
202
223
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
203
224
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
204
|
-
* @returns {Promise<OrderPlatformModel.
|
|
205
|
-
* Success response
|
|
225
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>}
|
|
226
|
+
* - Success response
|
|
227
|
+
*
|
|
206
228
|
* @name getBagById
|
|
207
229
|
* @summary: Get bag
|
|
208
230
|
* @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
209
231
|
*/
|
|
210
|
-
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
232
|
+
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>;
|
|
211
233
|
/**
|
|
212
234
|
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
213
235
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
214
236
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
215
|
-
* @returns {Promise<OrderPlatformModel.
|
|
237
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>} -
|
|
238
|
+
* Success response
|
|
216
239
|
* @name getBags
|
|
217
240
|
* @summary: List bags
|
|
218
241
|
* @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
|
|
219
242
|
*/
|
|
220
|
-
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
243
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>;
|
|
221
244
|
/**
|
|
222
245
|
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
223
246
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
224
247
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
225
|
-
* @returns {Promise<OrderPlatformModel.
|
|
226
|
-
* Success response
|
|
248
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>}
|
|
249
|
+
* - Success response
|
|
250
|
+
*
|
|
227
251
|
* @name getBulkActionTemplate
|
|
228
252
|
* @summary: List supported templates
|
|
229
253
|
* @description: Get list of templates so that users can download the required template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
|
|
230
254
|
*/
|
|
231
|
-
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
255
|
+
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>;
|
|
232
256
|
/**
|
|
233
257
|
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
234
258
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
235
259
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
236
|
-
* @returns {Promise<OrderPlatformModel.
|
|
260
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
237
261
|
* @name getBulkShipmentExcelFile
|
|
238
262
|
* @summary: Generate the report
|
|
239
263
|
* @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
|
|
240
264
|
*/
|
|
241
|
-
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
265
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
|
|
266
|
+
/**
|
|
267
|
+
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
268
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
269
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
271
|
+
* @name getChannelConfig
|
|
272
|
+
* @summary: Get channel configuration
|
|
273
|
+
* @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
274
|
+
*/
|
|
275
|
+
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
242
276
|
/**
|
|
243
277
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
244
278
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
245
279
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
246
|
-
* @returns {Promise<OrderPlatformModel.
|
|
280
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
|
|
247
281
|
* @name getFileByStatus
|
|
248
282
|
* @summary: Download file used for Bulk operation
|
|
249
283
|
* @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
|
|
250
284
|
*/
|
|
251
|
-
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
285
|
+
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponseSchema>;
|
|
252
286
|
/**
|
|
253
287
|
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
254
288
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
255
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
256
|
-
* @returns {Promise<OrderPlatformModel.
|
|
290
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
|
|
257
291
|
* @name getLaneConfig
|
|
258
292
|
* @summary: Get lane configuration
|
|
259
293
|
* @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
260
294
|
*/
|
|
261
|
-
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.
|
|
295
|
+
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.LaneConfigResponseSchema>;
|
|
262
296
|
/**
|
|
263
297
|
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
264
298
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -283,12 +317,13 @@ declare class Order {
|
|
|
283
317
|
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
284
318
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
285
319
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
286
|
-
* @returns {Promise<OrderPlatformModel.
|
|
320
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponseSchema>} -
|
|
321
|
+
* Success response
|
|
287
322
|
* @name getManifestfilters
|
|
288
323
|
* @summary: List filters
|
|
289
324
|
* @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
290
325
|
*/
|
|
291
|
-
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
326
|
+
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponseSchema>;
|
|
292
327
|
/**
|
|
293
328
|
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
294
329
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -303,75 +338,80 @@ declare class Order {
|
|
|
303
338
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
304
339
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
305
340
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
306
|
-
* @returns {Promise<OrderPlatformModel.
|
|
341
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponseSchema>} -
|
|
342
|
+
* Success response
|
|
307
343
|
* @name getOrderById
|
|
308
344
|
* @summary: Get order
|
|
309
345
|
* @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
310
346
|
*/
|
|
311
|
-
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
347
|
+
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponseSchema>;
|
|
312
348
|
/**
|
|
313
349
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
314
350
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
351
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
316
|
-
* @returns {Promise<OrderPlatformModel.
|
|
352
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponseSchema>} -
|
|
353
|
+
* Success response
|
|
317
354
|
* @name getOrders
|
|
318
355
|
* @summary: List orders
|
|
319
|
-
* @description: Get a list of orders based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
356
|
+
* @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
320
357
|
*/
|
|
321
|
-
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
358
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
|
|
322
359
|
/**
|
|
323
360
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
324
361
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
362
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
326
|
-
* @returns {Promise<OrderPlatformModel.
|
|
363
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
|
|
327
364
|
* @name getRoleBasedActions
|
|
328
365
|
* @summary: Get role-based actions
|
|
329
366
|
* @description: Retrieve permissible actions based on user roles such as company_admin, company_operation, customer_care, and read_only. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
|
|
330
367
|
*/
|
|
331
|
-
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
368
|
+
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponseSchema>;
|
|
332
369
|
/**
|
|
333
370
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
334
371
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
335
372
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
336
|
-
* @returns {Promise<OrderPlatformModel.
|
|
373
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponseSchema>} -
|
|
374
|
+
* Success response
|
|
337
375
|
* @name getShipmentById
|
|
338
|
-
* @summary: Get shipment
|
|
376
|
+
* @summary: Get shipment details
|
|
339
377
|
* @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
340
378
|
*/
|
|
341
|
-
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
379
|
+
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponseSchema>;
|
|
342
380
|
/**
|
|
343
381
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
344
382
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
345
383
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
|
-
* @returns {Promise<OrderPlatformModel.
|
|
384
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
385
|
+
* Success response
|
|
347
386
|
* @name getShipmentHistory
|
|
348
387
|
* @summary: Get a shipment's history
|
|
349
388
|
* @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
350
389
|
*/
|
|
351
|
-
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
390
|
+
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
|
|
352
391
|
/**
|
|
353
392
|
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
354
393
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
355
394
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
356
|
-
* @returns {Promise<OrderPlatformModel.
|
|
357
|
-
* Success response
|
|
395
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>}
|
|
396
|
+
* - Success response
|
|
397
|
+
*
|
|
358
398
|
* @name getShipmentReasons
|
|
359
399
|
* @summary: List bag cancellation reasons
|
|
360
400
|
* @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
|
|
361
401
|
*/
|
|
362
|
-
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
402
|
+
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>;
|
|
363
403
|
/**
|
|
364
404
|
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
365
405
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
366
406
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
367
|
-
* @returns {Promise<OrderPlatformModel.
|
|
407
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
|
|
368
408
|
* - Success response
|
|
369
409
|
*
|
|
370
410
|
* @name getShipments
|
|
371
411
|
* @summary: List shipments
|
|
372
412
|
* @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
373
413
|
*/
|
|
374
|
-
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, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
414
|
+
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
375
415
|
/**
|
|
376
416
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
377
417
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -398,43 +438,45 @@ declare class Order {
|
|
|
398
438
|
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
399
439
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
400
440
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
401
|
-
* @returns {Promise<OrderPlatformModel.
|
|
441
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponseSchema>} -
|
|
442
|
+
* Success response
|
|
402
443
|
* @name getTemplate
|
|
403
444
|
* @summary: Download bulk operation templates
|
|
404
445
|
* @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
|
|
405
446
|
*/
|
|
406
|
-
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
447
|
+
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponseSchema>;
|
|
407
448
|
/**
|
|
408
449
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
409
450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
410
451
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
411
|
-
* @returns {Promise<OrderPlatformModel.
|
|
452
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
|
|
412
453
|
* @name getfilters
|
|
413
454
|
* @summary: List filters
|
|
414
455
|
* @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
415
456
|
*/
|
|
416
|
-
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
457
|
+
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponseSchema>;
|
|
417
458
|
/**
|
|
418
459
|
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
419
460
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
420
461
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
421
|
-
* @returns {Promise<OrderPlatformModel.
|
|
422
|
-
* Success response
|
|
462
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>}
|
|
463
|
+
* - Success response
|
|
464
|
+
*
|
|
423
465
|
* @name invalidateShipmentCache
|
|
424
466
|
* @summary: Invalidate shipment cache
|
|
425
467
|
* @description: Clear the existing shipment cache data stored in Redis and serialize the updated data for subsequent use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
|
|
426
468
|
*/
|
|
427
|
-
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
469
|
+
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>;
|
|
428
470
|
/**
|
|
429
471
|
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
430
472
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
431
473
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
432
|
-
* @returns {Promise<OrderPlatformModel.
|
|
474
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
|
|
433
475
|
* @name jobDetails
|
|
434
476
|
* @summary: Get bulk operation details
|
|
435
477
|
* @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/jobDetails/).
|
|
436
478
|
*/
|
|
437
|
-
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
479
|
+
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponseSchema>;
|
|
438
480
|
/**
|
|
439
481
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
440
482
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -449,86 +491,101 @@ declare class Order {
|
|
|
449
491
|
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
450
492
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
493
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
452
|
-
* @returns {Promise<OrderPlatformModel.
|
|
494
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
495
|
+
* Success response
|
|
453
496
|
* @name postShipmentHistory
|
|
454
497
|
* @summary: Create shipment history
|
|
455
498
|
* @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
|
|
456
499
|
*/
|
|
457
|
-
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
500
|
+
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
|
|
458
501
|
/**
|
|
459
502
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
460
503
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
461
504
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
462
|
-
* @returns {Promise<OrderPlatformModel.
|
|
505
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponseSchema>} -
|
|
506
|
+
* Success response
|
|
463
507
|
* @name reassignLocation
|
|
464
508
|
* @summary: Reassign location
|
|
465
509
|
* @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
|
|
466
510
|
*/
|
|
467
|
-
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
511
|
+
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponseSchema>;
|
|
468
512
|
/**
|
|
469
513
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
470
514
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
471
515
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
|
-
* @returns {Promise<OrderPlatformModel.
|
|
516
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
473
517
|
* @name sendSmsNinja
|
|
474
518
|
* @summary: Send SMS
|
|
475
519
|
* @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
|
|
476
520
|
*/
|
|
477
|
-
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
521
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
|
|
478
522
|
/**
|
|
479
523
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
480
524
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
481
525
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
482
|
-
* @returns {Promise<OrderPlatformModel.
|
|
526
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>} -
|
|
527
|
+
* Success response
|
|
483
528
|
* @name sendUserMobileOTP
|
|
484
529
|
* @summary: Send user mobile OTP
|
|
485
530
|
* @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
|
|
486
531
|
*/
|
|
487
|
-
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
532
|
+
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>;
|
|
488
533
|
/**
|
|
489
534
|
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
490
535
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
491
536
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
492
|
-
* @returns {Promise<OrderPlatformModel.
|
|
493
|
-
* Success response
|
|
537
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>}
|
|
538
|
+
* - Success response
|
|
539
|
+
*
|
|
494
540
|
* @name trackShipment
|
|
495
541
|
* @summary: Track shipment
|
|
496
542
|
* @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
|
|
497
543
|
*/
|
|
498
|
-
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
544
|
+
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>;
|
|
499
545
|
/**
|
|
500
546
|
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
501
547
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
502
548
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
503
|
-
* @returns {Promise<OrderPlatformModel.
|
|
549
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
504
550
|
* @name updateAddress
|
|
505
551
|
* @summary: Update shipment address
|
|
506
|
-
* @description:
|
|
552
|
+
* @description: Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
507
553
|
*/
|
|
508
|
-
updateAddress({ shipmentId,
|
|
554
|
+
updateAddress({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
|
|
509
555
|
/**
|
|
510
556
|
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
511
557
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
512
558
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
513
|
-
* @returns {Promise<OrderPlatformModel.
|
|
559
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>}
|
|
514
560
|
* - Success response
|
|
515
561
|
*
|
|
516
562
|
* @name updatePackagingDimensions
|
|
517
563
|
* @summary: Update packaging dimensions
|
|
518
564
|
* @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
|
|
519
565
|
*/
|
|
520
|
-
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
566
|
+
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>;
|
|
567
|
+
/**
|
|
568
|
+
* @param {OrderPlatformValidator.UpdatePaymentInfoParam} arg - Arg object
|
|
569
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
570
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
571
|
+
* @returns {Promise<Object>} - Success response
|
|
572
|
+
* @name updatePaymentInfo
|
|
573
|
+
* @summary: Update payment details for an order, its shipments and its bags.
|
|
574
|
+
* @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePaymentInfo/).
|
|
575
|
+
*/
|
|
576
|
+
updatePaymentInfo({ body, requestHeaders }?: OrderPlatformValidator.UpdatePaymentInfoParam, { responseHeaders }?: object): Promise<any>;
|
|
521
577
|
/**
|
|
522
578
|
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
523
579
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
524
580
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
525
|
-
* @returns {Promise<OrderPlatformModel.
|
|
526
|
-
* Success response
|
|
581
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>}
|
|
582
|
+
* - Success response
|
|
583
|
+
*
|
|
527
584
|
* @name updateShipmentLock
|
|
528
585
|
* @summary: Update a shipment lock
|
|
529
586
|
* @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
|
|
530
587
|
*/
|
|
531
|
-
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
588
|
+
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>;
|
|
532
589
|
/**
|
|
533
590
|
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
534
591
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -556,22 +613,22 @@ declare class Order {
|
|
|
556
613
|
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
557
614
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
558
615
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
|
-
* @returns {Promise<OrderPlatformModel.
|
|
616
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
560
617
|
* @name uploadConsents
|
|
561
618
|
* @summary: Upload consent
|
|
562
619
|
* @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
|
|
563
620
|
*/
|
|
564
|
-
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
621
|
+
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
|
|
565
622
|
/**
|
|
566
623
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
567
624
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
568
625
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
569
|
-
* @returns {Promise<OrderPlatformModel.
|
|
626
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
|
|
570
627
|
* @name verifyMobileOTP
|
|
571
628
|
* @summary: Verify mobile OTP
|
|
572
629
|
* @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
|
|
573
630
|
*/
|
|
574
|
-
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
631
|
+
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponseSchema>;
|
|
575
632
|
}
|
|
576
633
|
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
577
634
|
import OrderPlatformModel = require("./OrderPlatformModel");
|