@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.3
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +111 -1200
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +52 -95
- package/sdk/application/Content/ContentApplicationClient.js +46 -990
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +89 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +93 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +49 -2109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- 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 +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- 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 +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +118 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5067 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1988 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6506 -1775
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- 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 +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
- package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- 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 +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- 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 +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1893 -623
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +924 -568
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- 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 +10 -7
- 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 +795 -7
- 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/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- 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/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- 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 `{}`
|
|
@@ -129,33 +146,35 @@ declare class Order {
|
|
|
129
146
|
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
130
147
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
131
148
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
132
|
-
* @returns {Promise<OrderPlatformModel.
|
|
149
|
+
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>} -
|
|
150
|
+
* Success response
|
|
133
151
|
* @name generateInvoiceID
|
|
134
152
|
* @summary: Generate and attach invoice Id
|
|
135
153
|
* @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
136
154
|
*/
|
|
137
|
-
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
155
|
+
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>;
|
|
138
156
|
/**
|
|
139
157
|
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
140
158
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
141
159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
142
|
-
* @returns {Promise<OrderPlatformModel.
|
|
143
|
-
* Success response
|
|
160
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>}
|
|
161
|
+
* - Success response
|
|
162
|
+
*
|
|
144
163
|
* @name generatePOSReceiptByOrderId
|
|
145
164
|
* @summary: Generate POS receipt by order Id
|
|
146
165
|
* @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
166
|
*/
|
|
148
|
-
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
167
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>;
|
|
149
168
|
/**
|
|
150
169
|
* @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
|
|
151
170
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
152
171
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
153
|
-
* @returns {Promise<OrderPlatformModel.
|
|
172
|
+
* @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
|
|
154
173
|
* @name generateProcessManifest
|
|
155
174
|
* @summary: Process Order Manifest
|
|
156
175
|
* @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
|
|
157
176
|
*/
|
|
158
|
-
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
177
|
+
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponseSchema>;
|
|
159
178
|
/**
|
|
160
179
|
* @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
|
|
161
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -171,84 +190,99 @@ declare class Order {
|
|
|
171
190
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
172
191
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
173
192
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
174
|
-
* @returns {Promise<OrderPlatformModel.
|
|
193
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>} -
|
|
194
|
+
* Success response
|
|
175
195
|
* @name getAllowedTemplatesForBulk
|
|
176
196
|
* @summary: List bulk operation templates
|
|
177
197
|
* @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
198
|
*/
|
|
179
|
-
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
199
|
+
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>;
|
|
180
200
|
/**
|
|
181
201
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
182
202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
203
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
-
* @returns {Promise<OrderPlatformModel.
|
|
204
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponseSchema>} -
|
|
205
|
+
* Success response
|
|
185
206
|
* @name getAnnouncements
|
|
186
207
|
* @summary: List announcements
|
|
187
208
|
* @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
209
|
*/
|
|
189
|
-
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
210
|
+
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponseSchema>;
|
|
190
211
|
/**
|
|
191
212
|
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
192
213
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
193
214
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
194
|
-
* @returns {Promise<OrderPlatformModel.
|
|
195
|
-
* Success response
|
|
215
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>}
|
|
216
|
+
* - Success response
|
|
217
|
+
*
|
|
196
218
|
* @name getBagById
|
|
197
219
|
* @summary: Get bag
|
|
198
220
|
* @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
199
221
|
*/
|
|
200
|
-
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
222
|
+
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>;
|
|
201
223
|
/**
|
|
202
224
|
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
203
225
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
204
226
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
205
|
-
* @returns {Promise<OrderPlatformModel.
|
|
227
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>} -
|
|
228
|
+
* Success response
|
|
206
229
|
* @name getBags
|
|
207
230
|
* @summary: List bags
|
|
208
231
|
* @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
232
|
*/
|
|
210
|
-
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
233
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>;
|
|
211
234
|
/**
|
|
212
235
|
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
213
236
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
214
237
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
215
|
-
* @returns {Promise<OrderPlatformModel.
|
|
216
|
-
* Success response
|
|
238
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>}
|
|
239
|
+
* - Success response
|
|
240
|
+
*
|
|
217
241
|
* @name getBulkActionTemplate
|
|
218
242
|
* @summary: List supported templates
|
|
219
243
|
* @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
244
|
*/
|
|
221
|
-
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
245
|
+
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>;
|
|
222
246
|
/**
|
|
223
247
|
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
224
248
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
225
249
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
226
|
-
* @returns {Promise<OrderPlatformModel.
|
|
250
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
227
251
|
* @name getBulkShipmentExcelFile
|
|
228
252
|
* @summary: Generate the report
|
|
229
253
|
* @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
254
|
*/
|
|
231
|
-
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
255
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponseSchema>;
|
|
256
|
+
/**
|
|
257
|
+
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
258
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
259
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
261
|
+
* @name getChannelConfig
|
|
262
|
+
* @summary: Get channel configuration
|
|
263
|
+
* @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
264
|
+
*/
|
|
265
|
+
getChannelConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateChannelConfigData>;
|
|
232
266
|
/**
|
|
233
267
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
234
268
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
235
269
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
236
|
-
* @returns {Promise<OrderPlatformModel.
|
|
270
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
|
|
237
271
|
* @name getFileByStatus
|
|
238
272
|
* @summary: Download file used for Bulk operation
|
|
239
273
|
* @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
274
|
*/
|
|
241
|
-
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
275
|
+
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponseSchema>;
|
|
242
276
|
/**
|
|
243
277
|
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
244
278
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
245
279
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
246
|
-
* @returns {Promise<OrderPlatformModel.
|
|
280
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
|
|
247
281
|
* @name getLaneConfig
|
|
248
282
|
* @summary: Get lane configuration
|
|
249
283
|
* @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
250
284
|
*/
|
|
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.
|
|
285
|
+
getLaneConfig({ superLane, groupEntity, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, paymentMode, bagStatus, searchType, searchValue, tags, timeToDispatch, paymentMethods, myOrders, showCrossCompanyData, orderType, requestHeaders, }?: OrderPlatformValidator.GetLaneConfigParam, { responseHeaders }?: object): Promise<OrderPlatformModel.LaneConfigResponseSchema>;
|
|
252
286
|
/**
|
|
253
287
|
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
254
288
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -273,12 +307,13 @@ declare class Order {
|
|
|
273
307
|
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
274
308
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
275
309
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
276
|
-
* @returns {Promise<OrderPlatformModel.
|
|
310
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponseSchema>} -
|
|
311
|
+
* Success response
|
|
277
312
|
* @name getManifestfilters
|
|
278
313
|
* @summary: List filters
|
|
279
314
|
* @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
280
315
|
*/
|
|
281
|
-
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
316
|
+
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponseSchema>;
|
|
282
317
|
/**
|
|
283
318
|
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
284
319
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -293,75 +328,80 @@ declare class Order {
|
|
|
293
328
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
294
329
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
295
330
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
296
|
-
* @returns {Promise<OrderPlatformModel.
|
|
331
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponseSchema>} -
|
|
332
|
+
* Success response
|
|
297
333
|
* @name getOrderById
|
|
298
334
|
* @summary: Get order
|
|
299
335
|
* @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
300
336
|
*/
|
|
301
|
-
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
337
|
+
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponseSchema>;
|
|
302
338
|
/**
|
|
303
339
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
304
340
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
305
341
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
306
|
-
* @returns {Promise<OrderPlatformModel.
|
|
342
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponseSchema>} -
|
|
343
|
+
* Success response
|
|
307
344
|
* @name getOrders
|
|
308
345
|
* @summary: List orders
|
|
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/).
|
|
346
|
+
* @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
347
|
*/
|
|
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.
|
|
348
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
|
|
312
349
|
/**
|
|
313
350
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
314
351
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
352
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
316
|
-
* @returns {Promise<OrderPlatformModel.
|
|
353
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
|
|
317
354
|
* @name getRoleBasedActions
|
|
318
355
|
* @summary: Get role-based actions
|
|
319
356
|
* @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
357
|
*/
|
|
321
|
-
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
358
|
+
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponseSchema>;
|
|
322
359
|
/**
|
|
323
360
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
324
361
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
362
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
326
|
-
* @returns {Promise<OrderPlatformModel.
|
|
363
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponseSchema>} -
|
|
364
|
+
* Success response
|
|
327
365
|
* @name getShipmentById
|
|
328
|
-
* @summary: Get shipment
|
|
366
|
+
* @summary: Get shipment details
|
|
329
367
|
* @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
330
368
|
*/
|
|
331
|
-
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
369
|
+
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponseSchema>;
|
|
332
370
|
/**
|
|
333
371
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
334
372
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
335
373
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
336
|
-
* @returns {Promise<OrderPlatformModel.
|
|
374
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
375
|
+
* Success response
|
|
337
376
|
* @name getShipmentHistory
|
|
338
377
|
* @summary: Get a shipment's history
|
|
339
378
|
* @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
340
379
|
*/
|
|
341
|
-
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
380
|
+
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
|
|
342
381
|
/**
|
|
343
382
|
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
344
383
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
345
384
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
346
|
-
* @returns {Promise<OrderPlatformModel.
|
|
347
|
-
* Success response
|
|
385
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>}
|
|
386
|
+
* - Success response
|
|
387
|
+
*
|
|
348
388
|
* @name getShipmentReasons
|
|
349
389
|
* @summary: List bag cancellation reasons
|
|
350
390
|
* @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
391
|
*/
|
|
352
|
-
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
392
|
+
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>;
|
|
353
393
|
/**
|
|
354
394
|
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
355
395
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
356
396
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
357
|
-
* @returns {Promise<OrderPlatformModel.
|
|
397
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
|
|
358
398
|
* - Success response
|
|
359
399
|
*
|
|
360
400
|
* @name getShipments
|
|
361
401
|
* @summary: List shipments
|
|
362
402
|
* @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
403
|
*/
|
|
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.
|
|
404
|
+
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
365
405
|
/**
|
|
366
406
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
367
407
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -388,43 +428,45 @@ declare class Order {
|
|
|
388
428
|
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
389
429
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
390
430
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
391
|
-
* @returns {Promise<OrderPlatformModel.
|
|
431
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponseSchema>} -
|
|
432
|
+
* Success response
|
|
392
433
|
* @name getTemplate
|
|
393
434
|
* @summary: Download bulk operation templates
|
|
394
435
|
* @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
436
|
*/
|
|
396
|
-
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
437
|
+
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponseSchema>;
|
|
397
438
|
/**
|
|
398
439
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
399
440
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
400
441
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
401
|
-
* @returns {Promise<OrderPlatformModel.
|
|
442
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
|
|
402
443
|
* @name getfilters
|
|
403
444
|
* @summary: List filters
|
|
404
445
|
* @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
405
446
|
*/
|
|
406
|
-
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
447
|
+
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponseSchema>;
|
|
407
448
|
/**
|
|
408
449
|
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
409
450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
410
451
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
411
|
-
* @returns {Promise<OrderPlatformModel.
|
|
412
|
-
* Success response
|
|
452
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>}
|
|
453
|
+
* - Success response
|
|
454
|
+
*
|
|
413
455
|
* @name invalidateShipmentCache
|
|
414
456
|
* @summary: Invalidate shipment cache
|
|
415
457
|
* @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
458
|
*/
|
|
417
|
-
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
459
|
+
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>;
|
|
418
460
|
/**
|
|
419
461
|
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
420
462
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
421
463
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
422
|
-
* @returns {Promise<OrderPlatformModel.
|
|
464
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
|
|
423
465
|
* @name jobDetails
|
|
424
466
|
* @summary: Get bulk operation details
|
|
425
467
|
* @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
468
|
*/
|
|
427
|
-
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
469
|
+
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponseSchema>;
|
|
428
470
|
/**
|
|
429
471
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
430
472
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -439,86 +481,101 @@ declare class Order {
|
|
|
439
481
|
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
440
482
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
441
483
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
442
|
-
* @returns {Promise<OrderPlatformModel.
|
|
484
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
485
|
+
* Success response
|
|
443
486
|
* @name postShipmentHistory
|
|
444
487
|
* @summary: Create shipment history
|
|
445
488
|
* @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
489
|
*/
|
|
447
|
-
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
490
|
+
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
|
|
448
491
|
/**
|
|
449
492
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
450
493
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
494
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
452
|
-
* @returns {Promise<OrderPlatformModel.
|
|
495
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponseSchema>} -
|
|
496
|
+
* Success response
|
|
453
497
|
* @name reassignLocation
|
|
454
498
|
* @summary: Reassign location
|
|
455
499
|
* @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
500
|
*/
|
|
457
|
-
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
501
|
+
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponseSchema>;
|
|
458
502
|
/**
|
|
459
503
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
460
504
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
461
505
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
462
|
-
* @returns {Promise<OrderPlatformModel.
|
|
506
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
463
507
|
* @name sendSmsNinja
|
|
464
508
|
* @summary: Send SMS
|
|
465
509
|
* @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
510
|
*/
|
|
467
|
-
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
511
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
|
|
468
512
|
/**
|
|
469
513
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
470
514
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
471
515
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
|
-
* @returns {Promise<OrderPlatformModel.
|
|
516
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>} -
|
|
517
|
+
* Success response
|
|
473
518
|
* @name sendUserMobileOTP
|
|
474
519
|
* @summary: Send user mobile OTP
|
|
475
520
|
* @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
521
|
*/
|
|
477
|
-
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
522
|
+
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>;
|
|
478
523
|
/**
|
|
479
524
|
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
480
525
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
481
526
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
482
|
-
* @returns {Promise<OrderPlatformModel.
|
|
483
|
-
* Success response
|
|
527
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>}
|
|
528
|
+
* - Success response
|
|
529
|
+
*
|
|
484
530
|
* @name trackShipment
|
|
485
531
|
* @summary: Track shipment
|
|
486
532
|
* @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
533
|
*/
|
|
488
|
-
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
534
|
+
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>;
|
|
489
535
|
/**
|
|
490
536
|
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
491
537
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
492
538
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
493
|
-
* @returns {Promise<OrderPlatformModel.
|
|
539
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
494
540
|
* @name updateAddress
|
|
495
541
|
* @summary: Update shipment address
|
|
496
|
-
* @description:
|
|
542
|
+
* @description: 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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
497
543
|
*/
|
|
498
|
-
updateAddress({ shipmentId,
|
|
544
|
+
updateAddress({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
|
|
499
545
|
/**
|
|
500
546
|
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
501
547
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
502
548
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
503
|
-
* @returns {Promise<OrderPlatformModel.
|
|
549
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>}
|
|
504
550
|
* - Success response
|
|
505
551
|
*
|
|
506
552
|
* @name updatePackagingDimensions
|
|
507
553
|
* @summary: Update packaging dimensions
|
|
508
554
|
* @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
555
|
*/
|
|
510
|
-
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
556
|
+
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>;
|
|
557
|
+
/**
|
|
558
|
+
* @param {OrderPlatformValidator.UpdatePaymentInfoParam} arg - Arg object
|
|
559
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
560
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
561
|
+
* @returns {Promise<Object>} - Success response
|
|
562
|
+
* @name updatePaymentInfo
|
|
563
|
+
* @summary: Update payment details for an order, its shipments and its bags.
|
|
564
|
+
* @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePaymentInfo/).
|
|
565
|
+
*/
|
|
566
|
+
updatePaymentInfo({ body, requestHeaders }?: OrderPlatformValidator.UpdatePaymentInfoParam, { responseHeaders }?: object): Promise<any>;
|
|
511
567
|
/**
|
|
512
568
|
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
513
569
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
514
570
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
515
|
-
* @returns {Promise<OrderPlatformModel.
|
|
516
|
-
* Success response
|
|
571
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>}
|
|
572
|
+
* - Success response
|
|
573
|
+
*
|
|
517
574
|
* @name updateShipmentLock
|
|
518
575
|
* @summary: Update a shipment lock
|
|
519
576
|
* @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/).
|
|
520
577
|
*/
|
|
521
|
-
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
578
|
+
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>;
|
|
522
579
|
/**
|
|
523
580
|
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
524
581
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -546,22 +603,22 @@ declare class Order {
|
|
|
546
603
|
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
547
604
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
548
605
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
549
|
-
* @returns {Promise<OrderPlatformModel.
|
|
606
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
550
607
|
* @name uploadConsents
|
|
551
608
|
* @summary: Upload consent
|
|
552
609
|
* @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
610
|
*/
|
|
554
|
-
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
611
|
+
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponseSchema>;
|
|
555
612
|
/**
|
|
556
613
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
557
614
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
558
615
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
559
|
-
* @returns {Promise<OrderPlatformModel.
|
|
616
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
|
|
560
617
|
* @name verifyMobileOTP
|
|
561
618
|
* @summary: Verify mobile OTP
|
|
562
619
|
* @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
620
|
*/
|
|
564
|
-
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
621
|
+
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponseSchema>;
|
|
565
622
|
}
|
|
566
623
|
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
567
624
|
import OrderPlatformModel = require("./OrderPlatformModel");
|