@gofynd/fdk-client-javascript 1.4.16-beta.3 → 1.4.16-beta.4
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 +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -117
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- 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 +30 -51
- package/sdk/application/Content/ContentApplicationClient.js +56 -161
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -56
- 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 +2 -4
- 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/common/Utility.js +6 -3
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- 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 +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -204
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
- package/sdk/platform/Content/ContentPlatformModel.js +394 -631
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- 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 +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- 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 +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -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 +6 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
- package/sdk/platform/Share/SharePlatformModel.js +6 -31
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- 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 +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +6 -810
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- 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/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
|
@@ -6,46 +6,43 @@ 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.
|
|
10
|
-
* Success response
|
|
9
|
+
* @returns {Promise<OrderPlatformModel.ConfigUpdatedResponse>} - Success response
|
|
11
10
|
* @name addStateManagerConfig
|
|
12
11
|
* @summary: Allows esm config updation
|
|
13
12
|
* @description: Update ESM config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addStateManagerConfig/).
|
|
14
13
|
*/
|
|
15
|
-
addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
14
|
+
addStateManagerConfig({ body, requestHeaders }?: OrderPlatformValidator.AddStateManagerConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ConfigUpdatedResponse>;
|
|
16
15
|
/**
|
|
17
16
|
* @param {OrderPlatformValidator.AttachOrderUserParam} arg - Arg object
|
|
18
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
-
* @returns {Promise<OrderPlatformModel.
|
|
21
|
-
* Success response
|
|
19
|
+
* @returns {Promise<OrderPlatformModel.AttachOrderUserResponse>} - Success response
|
|
22
20
|
* @name attachOrderUser
|
|
23
21
|
* @summary: Attach order to a user
|
|
24
22
|
* @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/).
|
|
25
23
|
*/
|
|
26
|
-
attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
24
|
+
attachOrderUser({ body, requestHeaders }?: OrderPlatformValidator.AttachOrderUserParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AttachOrderUserResponse>;
|
|
27
25
|
/**
|
|
28
26
|
* @param {OrderPlatformValidator.BulkListingParam} arg - Arg object
|
|
29
27
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
30
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
31
|
-
* @returns {Promise<OrderPlatformModel.
|
|
29
|
+
* @returns {Promise<OrderPlatformModel.BulkListingResponse>} - Success response
|
|
32
30
|
* @name bulkListing
|
|
33
31
|
* @summary: Lists bulk operations
|
|
34
32
|
* @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/).
|
|
35
33
|
*/
|
|
36
|
-
bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
34
|
+
bulkListing({ pageSize, pageNo, startDate, endDate, status, bulkActionType, searchKey, requestHeaders, }?: OrderPlatformValidator.BulkListingParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkListingResponse>;
|
|
37
35
|
/**
|
|
38
36
|
* @param {OrderPlatformValidator.BulkStateTransistionParam} arg - Arg object
|
|
39
37
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
40
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
41
|
-
* @returns {Promise<OrderPlatformModel.
|
|
42
|
-
*
|
|
43
|
-
*
|
|
39
|
+
* @returns {Promise<OrderPlatformModel.BulkStateTransistionResponse>} -
|
|
40
|
+
* Success response
|
|
44
41
|
* @name bulkStateTransistion
|
|
45
42
|
* @summary: Upload bulk state transitions file
|
|
46
43
|
* @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/).
|
|
47
44
|
*/
|
|
48
|
-
bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
45
|
+
bulkStateTransistion({ body, requestHeaders }?: OrderPlatformValidator.BulkStateTransistionParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkStateTransistionResponse>;
|
|
49
46
|
/**
|
|
50
47
|
* @param {OrderPlatformValidator.CheckOrderStatusParam} arg - Arg object
|
|
51
48
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -56,71 +53,57 @@ declare class Order {
|
|
|
56
53
|
* @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
|
|
57
54
|
*/
|
|
58
55
|
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>;
|
|
71
56
|
/**
|
|
72
57
|
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
73
58
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
74
59
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
75
|
-
* @returns {Promise<OrderPlatformModel.
|
|
60
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponse>} - Success response
|
|
76
61
|
* @name createOrder
|
|
77
62
|
* @summary: Create order
|
|
78
63
|
* @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
79
64
|
*/
|
|
80
|
-
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
65
|
+
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponse>;
|
|
81
66
|
/**
|
|
82
67
|
* @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
|
|
83
68
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
84
69
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
85
|
-
* @returns {Promise<OrderPlatformModel.
|
|
70
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
86
71
|
* @name dispatchManifests
|
|
87
72
|
* @summary: Dispatch manifest
|
|
88
73
|
* @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/).
|
|
89
74
|
*/
|
|
90
|
-
dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
75
|
+
dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
91
76
|
/**
|
|
92
77
|
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
93
78
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
94
79
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
95
|
-
* @returns {Promise<OrderPlatformModel.
|
|
80
|
+
* @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
|
|
96
81
|
* @name downloadBulkActionTemplate
|
|
97
82
|
* @summary: Download bulk template
|
|
98
83
|
* @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/).
|
|
99
84
|
*/
|
|
100
|
-
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
85
|
+
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
101
86
|
/**
|
|
102
87
|
* @param {OrderPlatformValidator.DownloadLanesReportParam} arg - Arg object
|
|
103
88
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
104
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
105
|
-
* @returns {Promise<OrderPlatformModel.
|
|
106
|
-
*
|
|
107
|
-
*
|
|
90
|
+
* @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponse>} -
|
|
91
|
+
* Success response
|
|
108
92
|
* @name downloadLanesReport
|
|
109
93
|
* @summary: Download Lane report
|
|
110
94
|
* @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
|
|
111
95
|
*/
|
|
112
|
-
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
96
|
+
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponse>;
|
|
113
97
|
/**
|
|
114
98
|
* @param {OrderPlatformValidator.EInvoiceRetryParam} arg - Arg object
|
|
115
99
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
116
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
117
|
-
* @returns {Promise<OrderPlatformModel.
|
|
118
|
-
* Success response
|
|
101
|
+
* @returns {Promise<OrderPlatformModel.EInvoiceRetryResponse>} - Success response
|
|
119
102
|
* @name eInvoiceRetry
|
|
120
103
|
* @summary: Retry E-invoice
|
|
121
104
|
* @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
|
|
122
105
|
*/
|
|
123
|
-
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
106
|
+
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponse>;
|
|
124
107
|
/**
|
|
125
108
|
* @param {OrderPlatformValidator.FailedOrderLogDetailsParam} arg - Arg object
|
|
126
109
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -156,35 +139,33 @@ declare class Order {
|
|
|
156
139
|
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
157
140
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
158
141
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
159
|
-
* @returns {Promise<OrderPlatformModel.
|
|
160
|
-
* Success response
|
|
142
|
+
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponse>} - Success response
|
|
161
143
|
* @name generateInvoiceID
|
|
162
144
|
* @summary: Generate and attach invoice Id
|
|
163
145
|
* @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
164
146
|
*/
|
|
165
|
-
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
147
|
+
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponse>;
|
|
166
148
|
/**
|
|
167
149
|
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
168
150
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
169
151
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
170
|
-
* @returns {Promise<OrderPlatformModel.
|
|
171
|
-
*
|
|
172
|
-
*
|
|
152
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
|
|
153
|
+
* Success response
|
|
173
154
|
* @name generatePOSReceiptByOrderId
|
|
174
155
|
* @summary: Generate POS receipt by order Id
|
|
175
156
|
* @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/).
|
|
176
157
|
*/
|
|
177
|
-
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
158
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
|
|
178
159
|
/**
|
|
179
160
|
* @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
|
|
180
161
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
181
162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
182
|
-
* @returns {Promise<OrderPlatformModel.
|
|
163
|
+
* @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
|
|
183
164
|
* @name generateProcessManifest
|
|
184
165
|
* @summary: Process Order Manifest
|
|
185
166
|
* @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
|
|
186
167
|
*/
|
|
187
|
-
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
168
|
+
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponse>;
|
|
188
169
|
/**
|
|
189
170
|
* @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
|
|
190
171
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -200,99 +181,84 @@ declare class Order {
|
|
|
200
181
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
201
182
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
203
|
-
* @returns {Promise<OrderPlatformModel.
|
|
204
|
-
* Success response
|
|
184
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponse>} - Success response
|
|
205
185
|
* @name getAllowedTemplatesForBulk
|
|
206
186
|
* @summary: List bulk operation templates
|
|
207
187
|
* @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
|
|
208
188
|
*/
|
|
209
|
-
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
189
|
+
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponse>;
|
|
210
190
|
/**
|
|
211
191
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
212
192
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
213
193
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
214
|
-
* @returns {Promise<OrderPlatformModel.
|
|
215
|
-
* Success response
|
|
194
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
|
|
216
195
|
* @name getAnnouncements
|
|
217
196
|
* @summary: List announcements
|
|
218
197
|
* @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/).
|
|
219
198
|
*/
|
|
220
|
-
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
199
|
+
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
|
|
221
200
|
/**
|
|
222
201
|
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
223
202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
224
203
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
225
|
-
* @returns {Promise<OrderPlatformModel.
|
|
226
|
-
*
|
|
227
|
-
*
|
|
204
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
|
|
205
|
+
* Success response
|
|
228
206
|
* @name getBagById
|
|
229
207
|
* @summary: Get bag
|
|
230
208
|
* @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
231
209
|
*/
|
|
232
|
-
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
210
|
+
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
|
|
233
211
|
/**
|
|
234
212
|
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
235
213
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
236
214
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
237
|
-
* @returns {Promise<OrderPlatformModel.
|
|
238
|
-
* Success response
|
|
215
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
|
|
239
216
|
* @name getBags
|
|
240
217
|
* @summary: List bags
|
|
241
218
|
* @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
|
|
242
219
|
*/
|
|
243
|
-
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
220
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
|
|
244
221
|
/**
|
|
245
222
|
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
246
223
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
247
224
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
248
|
-
* @returns {Promise<OrderPlatformModel.
|
|
249
|
-
*
|
|
250
|
-
*
|
|
225
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
|
|
226
|
+
* Success response
|
|
251
227
|
* @name getBulkActionTemplate
|
|
252
228
|
* @summary: List supported templates
|
|
253
229
|
* @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/).
|
|
254
230
|
*/
|
|
255
|
-
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
231
|
+
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
|
|
256
232
|
/**
|
|
257
233
|
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
258
234
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
259
235
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
|
-
* @returns {Promise<OrderPlatformModel.
|
|
236
|
+
* @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
|
|
261
237
|
* @name getBulkShipmentExcelFile
|
|
262
238
|
* @summary: Generate the report
|
|
263
239
|
* @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/).
|
|
264
240
|
*/
|
|
265
|
-
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
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>;
|
|
241
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
276
242
|
/**
|
|
277
243
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
278
244
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
279
245
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
|
-
* @returns {Promise<OrderPlatformModel.
|
|
246
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
|
|
281
247
|
* @name getFileByStatus
|
|
282
248
|
* @summary: Download file used for Bulk operation
|
|
283
249
|
* @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/).
|
|
284
250
|
*/
|
|
285
|
-
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
251
|
+
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponse>;
|
|
286
252
|
/**
|
|
287
253
|
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
288
254
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
289
255
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
290
|
-
* @returns {Promise<OrderPlatformModel.
|
|
256
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
|
|
291
257
|
* @name getLaneConfig
|
|
292
258
|
* @summary: Get lane configuration
|
|
293
259
|
* @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
294
260
|
*/
|
|
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.
|
|
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.LaneConfigResponse>;
|
|
296
262
|
/**
|
|
297
263
|
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
298
264
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -317,13 +283,12 @@ declare class Order {
|
|
|
317
283
|
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
318
284
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
319
285
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
320
|
-
* @returns {Promise<OrderPlatformModel.
|
|
321
|
-
* Success response
|
|
286
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponse>} - Success response
|
|
322
287
|
* @name getManifestfilters
|
|
323
288
|
* @summary: List filters
|
|
324
289
|
* @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
325
290
|
*/
|
|
326
|
-
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
291
|
+
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponse>;
|
|
327
292
|
/**
|
|
328
293
|
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
329
294
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -338,80 +303,75 @@ declare class Order {
|
|
|
338
303
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
339
304
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
340
305
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
341
|
-
* @returns {Promise<OrderPlatformModel.
|
|
342
|
-
* Success response
|
|
306
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
|
|
343
307
|
* @name getOrderById
|
|
344
308
|
* @summary: Get order
|
|
345
309
|
* @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
346
310
|
*/
|
|
347
|
-
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
311
|
+
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
348
312
|
/**
|
|
349
313
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
350
314
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
351
315
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
352
|
-
* @returns {Promise<OrderPlatformModel.
|
|
353
|
-
* Success response
|
|
316
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
|
|
354
317
|
* @name getOrders
|
|
355
318
|
* @summary: List orders
|
|
356
|
-
* @description: Get a list of orders based on the filters provided
|
|
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/).
|
|
357
320
|
*/
|
|
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,
|
|
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.OrderListingResponse>;
|
|
359
322
|
/**
|
|
360
323
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
361
324
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
362
325
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
363
|
-
* @returns {Promise<OrderPlatformModel.
|
|
326
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
|
|
364
327
|
* @name getRoleBasedActions
|
|
365
328
|
* @summary: Get role-based actions
|
|
366
329
|
* @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/).
|
|
367
330
|
*/
|
|
368
|
-
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
331
|
+
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
|
|
369
332
|
/**
|
|
370
333
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
371
334
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
372
335
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
373
|
-
* @returns {Promise<OrderPlatformModel.
|
|
374
|
-
* Success response
|
|
336
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
|
|
375
337
|
* @name getShipmentById
|
|
376
|
-
* @summary: Get shipment
|
|
338
|
+
* @summary: Get shipment
|
|
377
339
|
* @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
378
340
|
*/
|
|
379
|
-
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
341
|
+
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
|
|
380
342
|
/**
|
|
381
343
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
382
344
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
383
345
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
384
|
-
* @returns {Promise<OrderPlatformModel.
|
|
385
|
-
* Success response
|
|
346
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
386
347
|
* @name getShipmentHistory
|
|
387
348
|
* @summary: Get a shipment's history
|
|
388
349
|
* @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
389
350
|
*/
|
|
390
|
-
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
351
|
+
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
391
352
|
/**
|
|
392
353
|
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
393
354
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
394
355
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
395
|
-
* @returns {Promise<OrderPlatformModel.
|
|
396
|
-
*
|
|
397
|
-
*
|
|
356
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
|
|
357
|
+
* Success response
|
|
398
358
|
* @name getShipmentReasons
|
|
399
359
|
* @summary: List bag cancellation reasons
|
|
400
360
|
* @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/).
|
|
401
361
|
*/
|
|
402
|
-
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
362
|
+
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
|
|
403
363
|
/**
|
|
404
364
|
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
405
365
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
406
366
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
407
|
-
* @returns {Promise<OrderPlatformModel.
|
|
367
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
|
|
408
368
|
* - Success response
|
|
409
369
|
*
|
|
410
370
|
* @name getShipments
|
|
411
371
|
* @summary: List shipments
|
|
412
372
|
* @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/).
|
|
413
373
|
*/
|
|
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,
|
|
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.ShipmentInternalPlatformViewResponse>;
|
|
415
375
|
/**
|
|
416
376
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
417
377
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -438,45 +398,43 @@ declare class Order {
|
|
|
438
398
|
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
439
399
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
440
400
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
441
|
-
* @returns {Promise<OrderPlatformModel.
|
|
442
|
-
* Success response
|
|
401
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
|
|
443
402
|
* @name getTemplate
|
|
444
403
|
* @summary: Download bulk operation templates
|
|
445
404
|
* @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/).
|
|
446
405
|
*/
|
|
447
|
-
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
406
|
+
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
|
|
448
407
|
/**
|
|
449
408
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
450
409
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
410
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
452
|
-
* @returns {Promise<OrderPlatformModel.
|
|
411
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
|
|
453
412
|
* @name getfilters
|
|
454
413
|
* @summary: List filters
|
|
455
414
|
* @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
456
415
|
*/
|
|
457
|
-
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
416
|
+
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
|
|
458
417
|
/**
|
|
459
418
|
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
460
419
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
461
420
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
462
|
-
* @returns {Promise<OrderPlatformModel.
|
|
463
|
-
*
|
|
464
|
-
*
|
|
421
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
|
|
422
|
+
* Success response
|
|
465
423
|
* @name invalidateShipmentCache
|
|
466
424
|
* @summary: Invalidate shipment cache
|
|
467
425
|
* @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/).
|
|
468
426
|
*/
|
|
469
|
-
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
427
|
+
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
|
|
470
428
|
/**
|
|
471
429
|
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
472
430
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
473
431
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
474
|
-
* @returns {Promise<OrderPlatformModel.
|
|
432
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponse>} - Success response
|
|
475
433
|
* @name jobDetails
|
|
476
434
|
* @summary: Get bulk operation details
|
|
477
435
|
* @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/).
|
|
478
436
|
*/
|
|
479
|
-
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
437
|
+
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponse>;
|
|
480
438
|
/**
|
|
481
439
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
482
440
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -491,101 +449,86 @@ declare class Order {
|
|
|
491
449
|
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
492
450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
493
451
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
494
|
-
* @returns {Promise<OrderPlatformModel.
|
|
495
|
-
* Success response
|
|
452
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
496
453
|
* @name postShipmentHistory
|
|
497
454
|
* @summary: Create shipment history
|
|
498
455
|
* @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/).
|
|
499
456
|
*/
|
|
500
|
-
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
457
|
+
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
501
458
|
/**
|
|
502
459
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
503
460
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
504
461
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
505
|
-
* @returns {Promise<OrderPlatformModel.
|
|
506
|
-
* Success response
|
|
462
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
|
|
507
463
|
* @name reassignLocation
|
|
508
464
|
* @summary: Reassign location
|
|
509
465
|
* @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/).
|
|
510
466
|
*/
|
|
511
|
-
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
467
|
+
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponse>;
|
|
512
468
|
/**
|
|
513
469
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
514
470
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
515
471
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
516
|
-
* @returns {Promise<OrderPlatformModel.
|
|
472
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
517
473
|
* @name sendSmsNinja
|
|
518
474
|
* @summary: Send SMS
|
|
519
475
|
* @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/).
|
|
520
476
|
*/
|
|
521
|
-
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
477
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
|
|
522
478
|
/**
|
|
523
479
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
524
480
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
525
481
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
526
|
-
* @returns {Promise<OrderPlatformModel.
|
|
527
|
-
* Success response
|
|
482
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
|
|
528
483
|
* @name sendUserMobileOTP
|
|
529
484
|
* @summary: Send user mobile OTP
|
|
530
485
|
* @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/).
|
|
531
486
|
*/
|
|
532
|
-
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
487
|
+
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
|
|
533
488
|
/**
|
|
534
489
|
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
535
490
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
536
491
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
537
|
-
* @returns {Promise<OrderPlatformModel.
|
|
538
|
-
*
|
|
539
|
-
*
|
|
492
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
|
|
493
|
+
* Success response
|
|
540
494
|
* @name trackShipment
|
|
541
495
|
* @summary: Track shipment
|
|
542
496
|
* @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/).
|
|
543
497
|
*/
|
|
544
|
-
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
498
|
+
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
|
|
545
499
|
/**
|
|
546
500
|
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
547
501
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
548
502
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
549
|
-
* @returns {Promise<OrderPlatformModel.
|
|
503
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
550
504
|
* @name updateAddress
|
|
551
505
|
* @summary: Update shipment address
|
|
552
|
-
* @description:
|
|
506
|
+
* @description: Modify the address details of an existing shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
553
507
|
*/
|
|
554
|
-
updateAddress({ shipmentId,
|
|
508
|
+
updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, requestHeaders, }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
|
|
555
509
|
/**
|
|
556
510
|
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
557
511
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
558
512
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
|
-
* @returns {Promise<OrderPlatformModel.
|
|
513
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>}
|
|
560
514
|
* - Success response
|
|
561
515
|
*
|
|
562
516
|
* @name updatePackagingDimensions
|
|
563
517
|
* @summary: Update packaging dimensions
|
|
564
518
|
* @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
|
|
565
519
|
*/
|
|
566
|
-
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
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>;
|
|
520
|
+
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
|
|
577
521
|
/**
|
|
578
522
|
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
579
523
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
580
524
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
581
|
-
* @returns {Promise<OrderPlatformModel.
|
|
582
|
-
*
|
|
583
|
-
*
|
|
525
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
|
|
526
|
+
* Success response
|
|
584
527
|
* @name updateShipmentLock
|
|
585
528
|
* @summary: Update a shipment lock
|
|
586
529
|
* @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/).
|
|
587
530
|
*/
|
|
588
|
-
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
531
|
+
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
|
|
589
532
|
/**
|
|
590
533
|
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
591
534
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -613,22 +556,22 @@ declare class Order {
|
|
|
613
556
|
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
614
557
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
615
558
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
616
|
-
* @returns {Promise<OrderPlatformModel.
|
|
559
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
617
560
|
* @name uploadConsents
|
|
618
561
|
* @summary: Upload consent
|
|
619
562
|
* @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/).
|
|
620
563
|
*/
|
|
621
|
-
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
564
|
+
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
622
565
|
/**
|
|
623
566
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
624
567
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
625
568
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
626
|
-
* @returns {Promise<OrderPlatformModel.
|
|
569
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
|
|
627
570
|
* @name verifyMobileOTP
|
|
628
571
|
* @summary: Verify mobile OTP
|
|
629
572
|
* @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/).
|
|
630
573
|
*/
|
|
631
|
-
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
574
|
+
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponse>;
|
|
632
575
|
}
|
|
633
576
|
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
634
577
|
import OrderPlatformModel = require("./OrderPlatformModel");
|