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