@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-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 +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +304 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +437 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +22 -1
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +157 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +297 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +50 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +74 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +159 -87
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +195 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +473 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +75 -7
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +66 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +418 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +16 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -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/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
- package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
- 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 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- 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 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- 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 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- 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 +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -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 +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -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 +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- 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 +13 -76
- package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
- 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 +21 -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 +20 -791
- 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/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -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 -105
|
@@ -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 `{}`
|
|
@@ -146,35 +129,33 @@ declare class Order {
|
|
|
146
129
|
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
147
130
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
148
131
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
149
|
-
* @returns {Promise<OrderPlatformModel.
|
|
150
|
-
* Success response
|
|
132
|
+
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponse>} - Success response
|
|
151
133
|
* @name generateInvoiceID
|
|
152
134
|
* @summary: Generate and attach invoice Id
|
|
153
135
|
* @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
154
136
|
*/
|
|
155
|
-
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
137
|
+
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponse>;
|
|
156
138
|
/**
|
|
157
139
|
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
158
140
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
159
141
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
160
|
-
* @returns {Promise<OrderPlatformModel.
|
|
161
|
-
*
|
|
162
|
-
*
|
|
142
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
|
|
143
|
+
* Success response
|
|
163
144
|
* @name generatePOSReceiptByOrderId
|
|
164
145
|
* @summary: Generate POS receipt by order Id
|
|
165
146
|
* @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/).
|
|
166
147
|
*/
|
|
167
|
-
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
148
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
|
|
168
149
|
/**
|
|
169
150
|
* @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
|
|
170
151
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
171
152
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
172
|
-
* @returns {Promise<OrderPlatformModel.
|
|
153
|
+
* @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
|
|
173
154
|
* @name generateProcessManifest
|
|
174
155
|
* @summary: Process Order Manifest
|
|
175
156
|
* @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
|
|
176
157
|
*/
|
|
177
|
-
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
158
|
+
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponse>;
|
|
178
159
|
/**
|
|
179
160
|
* @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
|
|
180
161
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -190,99 +171,84 @@ declare class Order {
|
|
|
190
171
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
191
172
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
192
173
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
193
|
-
* @returns {Promise<OrderPlatformModel.
|
|
194
|
-
* Success response
|
|
174
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponse>} - Success response
|
|
195
175
|
* @name getAllowedTemplatesForBulk
|
|
196
176
|
* @summary: List bulk operation templates
|
|
197
177
|
* @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
|
|
198
178
|
*/
|
|
199
|
-
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
179
|
+
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponse>;
|
|
200
180
|
/**
|
|
201
181
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
202
182
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
203
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
204
|
-
* @returns {Promise<OrderPlatformModel.
|
|
205
|
-
* Success response
|
|
184
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
|
|
206
185
|
* @name getAnnouncements
|
|
207
186
|
* @summary: List announcements
|
|
208
187
|
* @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/).
|
|
209
188
|
*/
|
|
210
|
-
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
189
|
+
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
|
|
211
190
|
/**
|
|
212
191
|
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
213
192
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
214
193
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
215
|
-
* @returns {Promise<OrderPlatformModel.
|
|
216
|
-
*
|
|
217
|
-
*
|
|
194
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
|
|
195
|
+
* Success response
|
|
218
196
|
* @name getBagById
|
|
219
197
|
* @summary: Get bag
|
|
220
198
|
* @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
221
199
|
*/
|
|
222
|
-
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
200
|
+
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
|
|
223
201
|
/**
|
|
224
202
|
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
225
203
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
226
204
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
|
-
* @returns {Promise<OrderPlatformModel.
|
|
228
|
-
* Success response
|
|
205
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
|
|
229
206
|
* @name getBags
|
|
230
207
|
* @summary: List bags
|
|
231
208
|
* @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
|
|
232
209
|
*/
|
|
233
|
-
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
210
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
|
|
234
211
|
/**
|
|
235
212
|
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
236
213
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
237
214
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
238
|
-
* @returns {Promise<OrderPlatformModel.
|
|
239
|
-
*
|
|
240
|
-
*
|
|
215
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
|
|
216
|
+
* Success response
|
|
241
217
|
* @name getBulkActionTemplate
|
|
242
218
|
* @summary: List supported templates
|
|
243
219
|
* @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/).
|
|
244
220
|
*/
|
|
245
|
-
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
221
|
+
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
|
|
246
222
|
/**
|
|
247
223
|
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
248
224
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
249
225
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
250
|
-
* @returns {Promise<OrderPlatformModel.
|
|
226
|
+
* @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
|
|
251
227
|
* @name getBulkShipmentExcelFile
|
|
252
228
|
* @summary: Generate the report
|
|
253
229
|
* @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/).
|
|
254
230
|
*/
|
|
255
|
-
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
256
|
-
/**
|
|
257
|
-
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
258
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
259
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
|
-
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
261
|
-
* @name getChannelConfig
|
|
262
|
-
* @summary: Get channel configuration
|
|
263
|
-
* @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
264
|
-
*/
|
|
265
|
-
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
231
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
266
232
|
/**
|
|
267
233
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
268
234
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
269
235
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
|
-
* @returns {Promise<OrderPlatformModel.
|
|
236
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
|
|
271
237
|
* @name getFileByStatus
|
|
272
238
|
* @summary: Download file used for Bulk operation
|
|
273
239
|
* @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/).
|
|
274
240
|
*/
|
|
275
|
-
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
241
|
+
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponse>;
|
|
276
242
|
/**
|
|
277
243
|
* @param {OrderPlatformValidator.GetLaneConfigParam} 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.LaneConfigResponse>} - Success response
|
|
281
247
|
* @name getLaneConfig
|
|
282
248
|
* @summary: Get lane configuration
|
|
283
249
|
* @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
284
250
|
*/
|
|
285
|
-
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.
|
|
251
|
+
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>;
|
|
286
252
|
/**
|
|
287
253
|
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
288
254
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -307,13 +273,12 @@ declare class Order {
|
|
|
307
273
|
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
308
274
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
309
275
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
310
|
-
* @returns {Promise<OrderPlatformModel.
|
|
311
|
-
* Success response
|
|
276
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponse>} - Success response
|
|
312
277
|
* @name getManifestfilters
|
|
313
278
|
* @summary: List filters
|
|
314
279
|
* @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
315
280
|
*/
|
|
316
|
-
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
281
|
+
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponse>;
|
|
317
282
|
/**
|
|
318
283
|
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
319
284
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -328,80 +293,75 @@ declare class Order {
|
|
|
328
293
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
329
294
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
295
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
331
|
-
* @returns {Promise<OrderPlatformModel.
|
|
332
|
-
* Success response
|
|
296
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
|
|
333
297
|
* @name getOrderById
|
|
334
298
|
* @summary: Get order
|
|
335
299
|
* @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
336
300
|
*/
|
|
337
|
-
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
301
|
+
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
338
302
|
/**
|
|
339
303
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
340
304
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
341
305
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
342
|
-
* @returns {Promise<OrderPlatformModel.
|
|
343
|
-
* Success response
|
|
306
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
|
|
344
307
|
* @name getOrders
|
|
345
308
|
* @summary: List orders
|
|
346
|
-
* @description: Get a list of orders based on the filters provided
|
|
309
|
+
* @description: Get a list of orders based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
347
310
|
*/
|
|
348
|
-
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive,
|
|
311
|
+
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>;
|
|
349
312
|
/**
|
|
350
313
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
351
314
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
352
315
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
353
|
-
* @returns {Promise<OrderPlatformModel.
|
|
316
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
|
|
354
317
|
* @name getRoleBasedActions
|
|
355
318
|
* @summary: Get role-based actions
|
|
356
319
|
* @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/).
|
|
357
320
|
*/
|
|
358
|
-
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
321
|
+
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
|
|
359
322
|
/**
|
|
360
323
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
361
324
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
362
325
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
363
|
-
* @returns {Promise<OrderPlatformModel.
|
|
364
|
-
* Success response
|
|
326
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
|
|
365
327
|
* @name getShipmentById
|
|
366
|
-
* @summary: Get shipment
|
|
328
|
+
* @summary: Get shipment
|
|
367
329
|
* @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
368
330
|
*/
|
|
369
|
-
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
331
|
+
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
|
|
370
332
|
/**
|
|
371
333
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
372
334
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
373
335
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
374
|
-
* @returns {Promise<OrderPlatformModel.
|
|
375
|
-
* Success response
|
|
336
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
376
337
|
* @name getShipmentHistory
|
|
377
338
|
* @summary: Get a shipment's history
|
|
378
339
|
* @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
379
340
|
*/
|
|
380
|
-
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
341
|
+
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
381
342
|
/**
|
|
382
343
|
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
383
344
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
384
345
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
385
|
-
* @returns {Promise<OrderPlatformModel.
|
|
386
|
-
*
|
|
387
|
-
*
|
|
346
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
|
|
347
|
+
* Success response
|
|
388
348
|
* @name getShipmentReasons
|
|
389
349
|
* @summary: List bag cancellation reasons
|
|
390
350
|
* @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/).
|
|
391
351
|
*/
|
|
392
|
-
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
352
|
+
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
|
|
393
353
|
/**
|
|
394
354
|
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
395
355
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
396
356
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
397
|
-
* @returns {Promise<OrderPlatformModel.
|
|
357
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
|
|
398
358
|
* - Success response
|
|
399
359
|
*
|
|
400
360
|
* @name getShipments
|
|
401
361
|
* @summary: List shipments
|
|
402
362
|
* @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
403
363
|
*/
|
|
404
|
-
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType,
|
|
364
|
+
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>;
|
|
405
365
|
/**
|
|
406
366
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
407
367
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -428,45 +388,43 @@ declare class Order {
|
|
|
428
388
|
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
429
389
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
430
390
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
431
|
-
* @returns {Promise<OrderPlatformModel.
|
|
432
|
-
* Success response
|
|
391
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
|
|
433
392
|
* @name getTemplate
|
|
434
393
|
* @summary: Download bulk operation templates
|
|
435
394
|
* @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/).
|
|
436
395
|
*/
|
|
437
|
-
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
396
|
+
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
|
|
438
397
|
/**
|
|
439
398
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
440
399
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
441
400
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
442
|
-
* @returns {Promise<OrderPlatformModel.
|
|
401
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
|
|
443
402
|
* @name getfilters
|
|
444
403
|
* @summary: List filters
|
|
445
404
|
* @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
446
405
|
*/
|
|
447
|
-
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
406
|
+
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
|
|
448
407
|
/**
|
|
449
408
|
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
450
409
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
410
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
452
|
-
* @returns {Promise<OrderPlatformModel.
|
|
453
|
-
*
|
|
454
|
-
*
|
|
411
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
|
|
412
|
+
* Success response
|
|
455
413
|
* @name invalidateShipmentCache
|
|
456
414
|
* @summary: Invalidate shipment cache
|
|
457
415
|
* @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/).
|
|
458
416
|
*/
|
|
459
|
-
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
417
|
+
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
|
|
460
418
|
/**
|
|
461
419
|
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
462
420
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
463
421
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
464
|
-
* @returns {Promise<OrderPlatformModel.
|
|
422
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponse>} - Success response
|
|
465
423
|
* @name jobDetails
|
|
466
424
|
* @summary: Get bulk operation details
|
|
467
425
|
* @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/).
|
|
468
426
|
*/
|
|
469
|
-
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
427
|
+
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponse>;
|
|
470
428
|
/**
|
|
471
429
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
472
430
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -481,101 +439,86 @@ declare class Order {
|
|
|
481
439
|
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
482
440
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
483
441
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
484
|
-
* @returns {Promise<OrderPlatformModel.
|
|
485
|
-
* Success response
|
|
442
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
486
443
|
* @name postShipmentHistory
|
|
487
444
|
* @summary: Create shipment history
|
|
488
445
|
* @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/).
|
|
489
446
|
*/
|
|
490
|
-
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
447
|
+
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
491
448
|
/**
|
|
492
449
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
493
450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
494
451
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
495
|
-
* @returns {Promise<OrderPlatformModel.
|
|
496
|
-
* Success response
|
|
452
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
|
|
497
453
|
* @name reassignLocation
|
|
498
454
|
* @summary: Reassign location
|
|
499
455
|
* @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/).
|
|
500
456
|
*/
|
|
501
|
-
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
457
|
+
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponse>;
|
|
502
458
|
/**
|
|
503
459
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
504
460
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
505
461
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
506
|
-
* @returns {Promise<OrderPlatformModel.
|
|
462
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
507
463
|
* @name sendSmsNinja
|
|
508
464
|
* @summary: Send SMS
|
|
509
465
|
* @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/).
|
|
510
466
|
*/
|
|
511
|
-
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
467
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
|
|
512
468
|
/**
|
|
513
469
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
514
470
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
515
471
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
516
|
-
* @returns {Promise<OrderPlatformModel.
|
|
517
|
-
* Success response
|
|
472
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
|
|
518
473
|
* @name sendUserMobileOTP
|
|
519
474
|
* @summary: Send user mobile OTP
|
|
520
475
|
* @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/).
|
|
521
476
|
*/
|
|
522
|
-
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
477
|
+
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
|
|
523
478
|
/**
|
|
524
479
|
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
525
480
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
526
481
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
527
|
-
* @returns {Promise<OrderPlatformModel.
|
|
528
|
-
*
|
|
529
|
-
*
|
|
482
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
|
|
483
|
+
* Success response
|
|
530
484
|
* @name trackShipment
|
|
531
485
|
* @summary: Track shipment
|
|
532
486
|
* @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/).
|
|
533
487
|
*/
|
|
534
|
-
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
488
|
+
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
|
|
535
489
|
/**
|
|
536
490
|
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
537
491
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
538
492
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
539
|
-
* @returns {Promise<OrderPlatformModel.
|
|
493
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
540
494
|
* @name updateAddress
|
|
541
495
|
* @summary: Update shipment address
|
|
542
|
-
* @description:
|
|
496
|
+
* @description: Modify the address details of an existing shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
543
497
|
*/
|
|
544
|
-
updateAddress({ shipmentId,
|
|
498
|
+
updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, requestHeaders, }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
|
|
545
499
|
/**
|
|
546
500
|
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} 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.UpdatePackagingDimensionsResponse>}
|
|
550
504
|
* - Success response
|
|
551
505
|
*
|
|
552
506
|
* @name updatePackagingDimensions
|
|
553
507
|
* @summary: Update packaging dimensions
|
|
554
508
|
* @description: Used to modify the packaging dimension of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePackagingDimensions/).
|
|
555
509
|
*/
|
|
556
|
-
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
557
|
-
/**
|
|
558
|
-
* @param {OrderPlatformValidator.UpdatePaymentInfoParam} arg - Arg object
|
|
559
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
560
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
561
|
-
* @returns {Promise<Object>} - Success response
|
|
562
|
-
* @name updatePaymentInfo
|
|
563
|
-
* @summary: Update payment details for an order, its shipments and its bags.
|
|
564
|
-
* @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/).
|
|
565
|
-
*/
|
|
566
|
-
updatePaymentInfo({ body, requestHeaders }?: OrderPlatformValidator.UpdatePaymentInfoParam, { responseHeaders }?: object): Promise<any>;
|
|
510
|
+
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
|
|
567
511
|
/**
|
|
568
512
|
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
569
513
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
570
514
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
571
|
-
* @returns {Promise<OrderPlatformModel.
|
|
572
|
-
*
|
|
573
|
-
*
|
|
515
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
|
|
516
|
+
* Success response
|
|
574
517
|
* @name updateShipmentLock
|
|
575
518
|
* @summary: Update a shipment lock
|
|
576
519
|
* @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/).
|
|
577
520
|
*/
|
|
578
|
-
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
521
|
+
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
|
|
579
522
|
/**
|
|
580
523
|
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
581
524
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -603,22 +546,22 @@ declare class Order {
|
|
|
603
546
|
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
604
547
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
605
548
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
606
|
-
* @returns {Promise<OrderPlatformModel.
|
|
549
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
607
550
|
* @name uploadConsents
|
|
608
551
|
* @summary: Upload consent
|
|
609
552
|
* @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/).
|
|
610
553
|
*/
|
|
611
|
-
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
554
|
+
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
612
555
|
/**
|
|
613
556
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} 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.VerifyOtpResponse>} - Success response
|
|
617
560
|
* @name verifyMobileOTP
|
|
618
561
|
* @summary: Verify mobile OTP
|
|
619
562
|
* @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/).
|
|
620
563
|
*/
|
|
621
|
-
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
564
|
+
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponse>;
|
|
622
565
|
}
|
|
623
566
|
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
624
567
|
import OrderPlatformModel = require("./OrderPlatformModel");
|