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