@gofynd/fdk-client-javascript 1.4.13 → 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 +1 -1
- 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 +93 -37
- package/sdk/application/Content/ContentApplicationModel.js +83 -32
- 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 +48 -17
- package/sdk/application/Theme/ThemeApplicationModel.js +42 -22
- 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/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 +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +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 +208 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +383 -358
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +122 -126
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +66 -68
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +141 -118
- package/sdk/platform/Catalog/CatalogPlatformClient.js +193 -170
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1516 -1766
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1393 -1224
- 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 +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- 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 +178 -97
- package/sdk/platform/Order/OrderPlatformClient.js +589 -229
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5447 -3071
- package/sdk/platform/Order/OrderPlatformModel.js +3496 -1653
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +241 -176
- package/sdk/platform/Order/OrderPlatformValidator.js +153 -97
- 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 +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +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 `{}`
|
|
@@ -53,57 +56,71 @@ declare class Order {
|
|
|
53
56
|
* @description: Used to verify the status of order. It queries error logs, resyncs the shipments if there was an issue with sync etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/checkOrderStatus/).
|
|
54
57
|
*/
|
|
55
58
|
checkOrderStatus({ body, requestHeaders }?: OrderPlatformValidator.CheckOrderStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderStatusResult>;
|
|
59
|
+
/**
|
|
60
|
+
* @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
|
|
61
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
62
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
63
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>}
|
|
64
|
+
* - Success response
|
|
65
|
+
*
|
|
66
|
+
* @name createChannelConfig
|
|
67
|
+
* @summary: Create channel configuration
|
|
68
|
+
* @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
|
|
69
|
+
*/
|
|
70
|
+
createChannelConfig({ body, requestHeaders }?: OrderPlatformValidator.CreateChannelConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>;
|
|
56
71
|
/**
|
|
57
72
|
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
58
73
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
74
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
|
-
* @returns {Promise<OrderPlatformModel.
|
|
75
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponseSchema>} - Success response
|
|
61
76
|
* @name createOrder
|
|
62
77
|
* @summary: Create order
|
|
63
78
|
* @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
64
79
|
*/
|
|
65
|
-
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
80
|
+
createOrder({ body, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponseSchema>;
|
|
66
81
|
/**
|
|
67
82
|
* @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
|
|
68
83
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
84
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
70
|
-
* @returns {Promise<OrderPlatformModel.
|
|
85
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
71
86
|
* @name dispatchManifests
|
|
72
87
|
* @summary: Dispatch manifest
|
|
73
88
|
* @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
|
|
74
89
|
*/
|
|
75
|
-
dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
90
|
+
dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
|
|
76
91
|
/**
|
|
77
92
|
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
78
93
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
94
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
-
* @returns {Promise<OrderPlatformModel.
|
|
95
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
81
96
|
* @name downloadBulkActionTemplate
|
|
82
97
|
* @summary: Download bulk template
|
|
83
98
|
* @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
|
|
84
99
|
*/
|
|
85
|
-
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
100
|
+
downloadBulkActionTemplate({ templateSlug, requestHeaders }?: OrderPlatformValidator.DownloadBulkActionTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
|
|
86
101
|
/**
|
|
87
102
|
* @param {OrderPlatformValidator.DownloadLanesReportParam} arg - Arg object
|
|
88
103
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
89
104
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
|
-
* @returns {Promise<OrderPlatformModel.
|
|
91
|
-
* Success response
|
|
105
|
+
* @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>}
|
|
106
|
+
* - Success response
|
|
107
|
+
*
|
|
92
108
|
* @name downloadLanesReport
|
|
93
109
|
* @summary: Download Lane report
|
|
94
110
|
* @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
|
|
95
111
|
*/
|
|
96
|
-
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
112
|
+
downloadLanesReport({ body, requestHeaders }?: OrderPlatformValidator.DownloadLanesReportParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>;
|
|
97
113
|
/**
|
|
98
114
|
* @param {OrderPlatformValidator.EInvoiceRetryParam} arg - Arg object
|
|
99
115
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
100
116
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
|
-
* @returns {Promise<OrderPlatformModel.
|
|
117
|
+
* @returns {Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>} -
|
|
118
|
+
* Success response
|
|
102
119
|
* @name eInvoiceRetry
|
|
103
120
|
* @summary: Retry E-invoice
|
|
104
121
|
* @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
|
|
105
122
|
*/
|
|
106
|
-
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
123
|
+
eInvoiceRetry({ body, requestHeaders }?: OrderPlatformValidator.EInvoiceRetryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>;
|
|
107
124
|
/**
|
|
108
125
|
* @param {OrderPlatformValidator.FailedOrderLogDetailsParam} arg - Arg object
|
|
109
126
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -114,6 +131,18 @@ declare class Order {
|
|
|
114
131
|
* @description: Get the exact error trace from the log Id provided in the failed order list API response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
|
|
115
132
|
*/
|
|
116
133
|
failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
|
|
134
|
+
/**
|
|
135
|
+
* @param {OrderPlatformValidator.FetchCreditBalanceDetailParam} arg - Arg object
|
|
136
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
137
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
|
+
* @returns {Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>}
|
|
139
|
+
* - Success response
|
|
140
|
+
*
|
|
141
|
+
* @name fetchCreditBalanceDetail
|
|
142
|
+
* @summary: Get credit balance detail
|
|
143
|
+
* @description: Retrieve details about credit balance on the basis of customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/fetchCreditBalanceDetail/).
|
|
144
|
+
*/
|
|
145
|
+
fetchCreditBalanceDetail({ body, requestHeaders }?: OrderPlatformValidator.FetchCreditBalanceDetailParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FetchCreditBalanceResponsePayload>;
|
|
117
146
|
/**
|
|
118
147
|
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
119
148
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -129,33 +158,35 @@ declare class Order {
|
|
|
129
158
|
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
130
159
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
131
160
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
132
|
-
* @returns {Promise<OrderPlatformModel.
|
|
161
|
+
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>} -
|
|
162
|
+
* Success response
|
|
133
163
|
* @name generateInvoiceID
|
|
134
164
|
* @summary: Generate and attach invoice Id
|
|
135
165
|
* @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
136
166
|
*/
|
|
137
|
-
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
167
|
+
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>;
|
|
138
168
|
/**
|
|
139
169
|
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
140
170
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
141
171
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
142
|
-
* @returns {Promise<OrderPlatformModel.
|
|
143
|
-
* Success response
|
|
172
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>}
|
|
173
|
+
* - Success response
|
|
174
|
+
*
|
|
144
175
|
* @name generatePOSReceiptByOrderId
|
|
145
176
|
* @summary: Generate POS receipt by order Id
|
|
146
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/).
|
|
147
178
|
*/
|
|
148
|
-
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
179
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>;
|
|
149
180
|
/**
|
|
150
181
|
* @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
|
|
151
182
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
152
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
153
|
-
* @returns {Promise<OrderPlatformModel.
|
|
184
|
+
* @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
|
|
154
185
|
* @name generateProcessManifest
|
|
155
186
|
* @summary: Process Order Manifest
|
|
156
187
|
* @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
|
|
157
188
|
*/
|
|
158
|
-
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
189
|
+
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponseSchema>;
|
|
159
190
|
/**
|
|
160
191
|
* @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
|
|
161
192
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -171,84 +202,99 @@ declare class Order {
|
|
|
171
202
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
172
203
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
173
204
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
174
|
-
* @returns {Promise<OrderPlatformModel.
|
|
205
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>} -
|
|
206
|
+
* Success response
|
|
175
207
|
* @name getAllowedTemplatesForBulk
|
|
176
208
|
* @summary: List bulk operation templates
|
|
177
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/).
|
|
178
210
|
*/
|
|
179
|
-
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
211
|
+
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>;
|
|
180
212
|
/**
|
|
181
213
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
182
214
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
215
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
-
* @returns {Promise<OrderPlatformModel.
|
|
216
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponseSchema>} -
|
|
217
|
+
* Success response
|
|
185
218
|
* @name getAnnouncements
|
|
186
219
|
* @summary: List announcements
|
|
187
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/).
|
|
188
221
|
*/
|
|
189
|
-
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
222
|
+
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponseSchema>;
|
|
190
223
|
/**
|
|
191
224
|
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
192
225
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
193
226
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
194
|
-
* @returns {Promise<OrderPlatformModel.
|
|
195
|
-
* Success response
|
|
227
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>}
|
|
228
|
+
* - Success response
|
|
229
|
+
*
|
|
196
230
|
* @name getBagById
|
|
197
231
|
* @summary: Get bag
|
|
198
232
|
* @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
199
233
|
*/
|
|
200
|
-
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
234
|
+
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>;
|
|
201
235
|
/**
|
|
202
236
|
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
203
237
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
204
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
205
|
-
* @returns {Promise<OrderPlatformModel.
|
|
239
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>} -
|
|
240
|
+
* Success response
|
|
206
241
|
* @name getBags
|
|
207
242
|
* @summary: List bags
|
|
208
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/).
|
|
209
244
|
*/
|
|
210
|
-
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>;
|
|
211
246
|
/**
|
|
212
247
|
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
213
248
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
214
249
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
215
|
-
* @returns {Promise<OrderPlatformModel.
|
|
216
|
-
* Success response
|
|
250
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>}
|
|
251
|
+
* - Success response
|
|
252
|
+
*
|
|
217
253
|
* @name getBulkActionTemplate
|
|
218
254
|
* @summary: List supported templates
|
|
219
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/).
|
|
220
256
|
*/
|
|
221
|
-
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
257
|
+
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>;
|
|
222
258
|
/**
|
|
223
259
|
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
224
260
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
225
261
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
226
|
-
* @returns {Promise<OrderPlatformModel.
|
|
262
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
227
263
|
* @name getBulkShipmentExcelFile
|
|
228
264
|
* @summary: Generate the report
|
|
229
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/).
|
|
230
266
|
*/
|
|
231
|
-
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>;
|
|
268
|
+
/**
|
|
269
|
+
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
270
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
271
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
272
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
273
|
+
* @name getChannelConfig
|
|
274
|
+
* @summary: Get channel configuration
|
|
275
|
+
* @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
276
|
+
*/
|
|
277
|
+
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
232
278
|
/**
|
|
233
279
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
234
280
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
235
281
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
236
|
-
* @returns {Promise<OrderPlatformModel.
|
|
282
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
|
|
237
283
|
* @name getFileByStatus
|
|
238
284
|
* @summary: Download file used for Bulk operation
|
|
239
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/).
|
|
240
286
|
*/
|
|
241
|
-
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>;
|
|
242
288
|
/**
|
|
243
289
|
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
244
290
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
245
291
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
246
|
-
* @returns {Promise<OrderPlatformModel.
|
|
292
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
|
|
247
293
|
* @name getLaneConfig
|
|
248
294
|
* @summary: Get lane configuration
|
|
249
295
|
* @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
250
296
|
*/
|
|
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.
|
|
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>;
|
|
252
298
|
/**
|
|
253
299
|
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
254
300
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -258,7 +304,7 @@ declare class Order {
|
|
|
258
304
|
* @summary: Get a manifest
|
|
259
305
|
* @description: Get details regarding a manifest which can be used to perform further actions on it - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestDetails/).
|
|
260
306
|
*/
|
|
261
|
-
getManifestDetails({ manifestId,
|
|
307
|
+
getManifestDetails({ manifestId, requestHeaders }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
|
|
262
308
|
/**
|
|
263
309
|
* @param {OrderPlatformValidator.GetManifestShipmentsParam} arg - Arg object
|
|
264
310
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -273,12 +319,13 @@ declare class Order {
|
|
|
273
319
|
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
274
320
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
275
321
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
276
|
-
* @returns {Promise<OrderPlatformModel.
|
|
322
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponseSchema>} -
|
|
323
|
+
* Success response
|
|
277
324
|
* @name getManifestfilters
|
|
278
325
|
* @summary: List filters
|
|
279
326
|
* @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
280
327
|
*/
|
|
281
|
-
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
328
|
+
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponseSchema>;
|
|
282
329
|
/**
|
|
283
330
|
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
284
331
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -293,75 +340,80 @@ declare class Order {
|
|
|
293
340
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
294
341
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
295
342
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
296
|
-
* @returns {Promise<OrderPlatformModel.
|
|
343
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponseSchema>} -
|
|
344
|
+
* Success response
|
|
297
345
|
* @name getOrderById
|
|
298
346
|
* @summary: Get order
|
|
299
347
|
* @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
300
348
|
*/
|
|
301
|
-
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
349
|
+
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponseSchema>;
|
|
302
350
|
/**
|
|
303
351
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
304
352
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
305
353
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
306
|
-
* @returns {Promise<OrderPlatformModel.
|
|
354
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponseSchema>} -
|
|
355
|
+
* Success response
|
|
307
356
|
* @name getOrders
|
|
308
357
|
* @summary: List orders
|
|
309
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/).
|
|
310
359
|
*/
|
|
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, 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>;
|
|
312
361
|
/**
|
|
313
362
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
314
363
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
364
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
316
|
-
* @returns {Promise<OrderPlatformModel.
|
|
365
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
|
|
317
366
|
* @name getRoleBasedActions
|
|
318
367
|
* @summary: Get role-based actions
|
|
319
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/).
|
|
320
369
|
*/
|
|
321
|
-
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
370
|
+
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponseSchema>;
|
|
322
371
|
/**
|
|
323
372
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
324
373
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
374
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
326
|
-
* @returns {Promise<OrderPlatformModel.
|
|
375
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponseSchema>} -
|
|
376
|
+
* Success response
|
|
327
377
|
* @name getShipmentById
|
|
328
378
|
* @summary: Get shipment
|
|
329
379
|
* @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
330
380
|
*/
|
|
331
|
-
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>;
|
|
332
382
|
/**
|
|
333
383
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
334
384
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
335
385
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
336
|
-
* @returns {Promise<OrderPlatformModel.
|
|
386
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
387
|
+
* Success response
|
|
337
388
|
* @name getShipmentHistory
|
|
338
389
|
* @summary: Get a shipment's history
|
|
339
390
|
* @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
340
391
|
*/
|
|
341
|
-
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
392
|
+
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
|
|
342
393
|
/**
|
|
343
394
|
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
344
395
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
345
396
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
|
-
* @returns {Promise<OrderPlatformModel.
|
|
347
|
-
* Success response
|
|
397
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>}
|
|
398
|
+
* - Success response
|
|
399
|
+
*
|
|
348
400
|
* @name getShipmentReasons
|
|
349
401
|
* @summary: List bag cancellation reasons
|
|
350
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/).
|
|
351
403
|
*/
|
|
352
|
-
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
404
|
+
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>;
|
|
353
405
|
/**
|
|
354
406
|
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
355
407
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
356
408
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
357
|
-
* @returns {Promise<OrderPlatformModel.
|
|
409
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
|
|
358
410
|
* - Success response
|
|
359
411
|
*
|
|
360
412
|
* @name getShipments
|
|
361
413
|
* @summary: List shipments
|
|
362
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/).
|
|
363
415
|
*/
|
|
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, 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>;
|
|
365
417
|
/**
|
|
366
418
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
367
419
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -388,43 +440,45 @@ declare class Order {
|
|
|
388
440
|
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
389
441
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
390
442
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
391
|
-
* @returns {Promise<OrderPlatformModel.
|
|
443
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponseSchema>} -
|
|
444
|
+
* Success response
|
|
392
445
|
* @name getTemplate
|
|
393
446
|
* @summary: Download bulk operation templates
|
|
394
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/).
|
|
395
448
|
*/
|
|
396
|
-
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
449
|
+
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponseSchema>;
|
|
397
450
|
/**
|
|
398
451
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
399
452
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
400
453
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
401
|
-
* @returns {Promise<OrderPlatformModel.
|
|
454
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
|
|
402
455
|
* @name getfilters
|
|
403
456
|
* @summary: List filters
|
|
404
457
|
* @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
405
458
|
*/
|
|
406
|
-
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
459
|
+
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponseSchema>;
|
|
407
460
|
/**
|
|
408
461
|
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
409
462
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
410
463
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
411
|
-
* @returns {Promise<OrderPlatformModel.
|
|
412
|
-
* Success response
|
|
464
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>}
|
|
465
|
+
* - Success response
|
|
466
|
+
*
|
|
413
467
|
* @name invalidateShipmentCache
|
|
414
468
|
* @summary: Invalidate shipment cache
|
|
415
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/).
|
|
416
470
|
*/
|
|
417
|
-
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
471
|
+
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>;
|
|
418
472
|
/**
|
|
419
473
|
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
420
474
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
421
475
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
422
|
-
* @returns {Promise<OrderPlatformModel.
|
|
476
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
|
|
423
477
|
* @name jobDetails
|
|
424
478
|
* @summary: Get bulk operation details
|
|
425
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/).
|
|
426
480
|
*/
|
|
427
|
-
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
481
|
+
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponseSchema>;
|
|
428
482
|
/**
|
|
429
483
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
430
484
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -439,86 +493,113 @@ declare class Order {
|
|
|
439
493
|
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
440
494
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
441
495
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
442
|
-
* @returns {Promise<OrderPlatformModel.
|
|
496
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
497
|
+
* Success response
|
|
443
498
|
* @name postShipmentHistory
|
|
444
499
|
* @summary: Create shipment history
|
|
445
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/).
|
|
446
501
|
*/
|
|
447
|
-
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
502
|
+
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
|
|
503
|
+
/**
|
|
504
|
+
* @param {OrderPlatformValidator.ProcessManifestsParam} arg - Arg object
|
|
505
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
506
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
507
|
+
* @returns {Promise<OrderPlatformModel.ProcessManifestItemResponseSchema>}
|
|
508
|
+
* - Success response
|
|
509
|
+
*
|
|
510
|
+
* @name processManifests
|
|
511
|
+
* @summary: Generate manifest
|
|
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/).
|
|
513
|
+
*/
|
|
514
|
+
processManifests({ body, requestHeaders }?: OrderPlatformValidator.ProcessManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ProcessManifestItemResponseSchema>;
|
|
448
515
|
/**
|
|
449
516
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
450
517
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
518
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
452
|
-
* @returns {Promise<OrderPlatformModel.
|
|
519
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponseSchema>} -
|
|
520
|
+
* Success response
|
|
453
521
|
* @name reassignLocation
|
|
454
522
|
* @summary: Reassign location
|
|
455
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/).
|
|
456
524
|
*/
|
|
457
|
-
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
525
|
+
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponseSchema>;
|
|
458
526
|
/**
|
|
459
527
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
460
528
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
461
529
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
462
|
-
* @returns {Promise<OrderPlatformModel.
|
|
530
|
+
* @returns {Promise<OrderPlatformModel.SendSmsResponseSchema>} - Success response
|
|
463
531
|
* @name sendSmsNinja
|
|
464
532
|
* @summary: Send SMS
|
|
465
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/).
|
|
466
534
|
*/
|
|
467
|
-
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
535
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendSmsResponseSchema>;
|
|
468
536
|
/**
|
|
469
537
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
470
538
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
471
539
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
|
-
* @returns {Promise<OrderPlatformModel.
|
|
540
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>} -
|
|
541
|
+
* Success response
|
|
473
542
|
* @name sendUserMobileOTP
|
|
474
543
|
* @summary: Send user mobile OTP
|
|
475
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/).
|
|
476
545
|
*/
|
|
477
|
-
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
546
|
+
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>;
|
|
478
547
|
/**
|
|
479
548
|
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
480
549
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
481
550
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
482
|
-
* @returns {Promise<OrderPlatformModel.
|
|
483
|
-
* Success response
|
|
551
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>}
|
|
552
|
+
* - Success response
|
|
553
|
+
*
|
|
484
554
|
* @name trackShipment
|
|
485
555
|
* @summary: Track shipment
|
|
486
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/).
|
|
487
557
|
*/
|
|
488
|
-
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>;
|
|
489
559
|
/**
|
|
490
560
|
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
491
561
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
492
562
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
493
|
-
* @returns {Promise<OrderPlatformModel.
|
|
563
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
494
564
|
* @name updateAddress
|
|
495
|
-
* @summary: Update shipment
|
|
496
|
-
* @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/).
|
|
497
567
|
*/
|
|
498
|
-
updateAddress({ shipmentId,
|
|
568
|
+
updateAddress({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
|
|
499
569
|
/**
|
|
500
570
|
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
501
571
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
502
572
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
503
|
-
* @returns {Promise<OrderPlatformModel.
|
|
573
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>}
|
|
504
574
|
* - Success response
|
|
505
575
|
*
|
|
506
576
|
* @name updatePackagingDimensions
|
|
507
577
|
* @summary: Update packaging dimensions
|
|
508
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/).
|
|
509
579
|
*/
|
|
510
|
-
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>;
|
|
511
591
|
/**
|
|
512
592
|
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
513
593
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
514
594
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
515
|
-
* @returns {Promise<OrderPlatformModel.
|
|
516
|
-
* Success response
|
|
595
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>}
|
|
596
|
+
* - Success response
|
|
597
|
+
*
|
|
517
598
|
* @name updateShipmentLock
|
|
518
599
|
* @summary: Update a shipment lock
|
|
519
|
-
* @description: Modify shipment/bag lock
|
|
600
|
+
* @description: Modify shipment/bag lock and check status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
|
|
520
601
|
*/
|
|
521
|
-
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
602
|
+
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>;
|
|
522
603
|
/**
|
|
523
604
|
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
524
605
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -546,22 +627,22 @@ declare class Order {
|
|
|
546
627
|
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
547
628
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
548
629
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
549
|
-
* @returns {Promise<OrderPlatformModel.
|
|
630
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
550
631
|
* @name uploadConsents
|
|
551
632
|
* @summary: Upload consent
|
|
552
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/).
|
|
553
634
|
*/
|
|
554
|
-
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
635
|
+
uploadConsents({ manifestId, body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
|
|
555
636
|
/**
|
|
556
637
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
557
638
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
558
639
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
|
-
* @returns {Promise<OrderPlatformModel.
|
|
640
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
|
|
560
641
|
* @name verifyMobileOTP
|
|
561
642
|
* @summary: Verify mobile OTP
|
|
562
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/).
|
|
563
644
|
*/
|
|
564
|
-
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
645
|
+
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponseSchema>;
|
|
565
646
|
}
|
|
566
647
|
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
567
648
|
import OrderPlatformModel = require("./OrderPlatformModel");
|