@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.10
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 +0 -2
- package/sdk/application/ApplicationClient.js +0 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +55 -97
- package/sdk/application/Cart/CartApplicationClient.js +60 -1262
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -162
- package/sdk/application/Catalog/CatalogApplicationClient.js +148 -1313
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -9
- package/sdk/application/Common/CommonApplicationClient.js +5 -90
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -80
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -725
- package/sdk/application/Content/ContentApplicationClient.d.ts +63 -85
- package/sdk/application/Content/ContentApplicationClient.js +126 -942
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -15
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +26 -130
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -17
- package/sdk/application/Lead/LeadApplicationClient.js +32 -201
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -62
- package/sdk/application/Logistic/LogisticApplicationClient.js +51 -647
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -56
- package/sdk/application/Order/OrderApplicationClient.js +86 -555
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -209
- package/sdk/application/Payment/PaymentApplicationClient.js +57 -2099
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -26
- package/sdk/application/Rewards/RewardsApplicationClient.js +17 -303
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +34 -294
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +30 -166
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +47 -1817
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +6 -49
- package/sdk/application/index.d.ts +0 -19
- package/sdk/application/index.js +0 -35
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -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/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
- package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +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 +1328 -4975
- package/sdk/platform/Cart/CartPlatformModel.js +1229 -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 +1744 -1501
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1211 -1383
- 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 +138 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +100 -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 +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -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 +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -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 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -175
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -52
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -34
- package/sdk/platform/Order/OrderPlatformClient.d.ts +103 -174
- package/sdk/platform/Order/OrderPlatformClient.js +275 -528
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3078 -5449
- package/sdk/platform/Order/OrderPlatformModel.js +1659 -3501
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +219 -234
- package/sdk/platform/Order/OrderPlatformValidator.js +118 -146
- 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 +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +396 -620
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +326 -501
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +11 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
- package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -8
- 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 +19 -793
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +14 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -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 -4340
- package/sdk/application/Cart/CartApplicationModel.js +0 -2718
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -788
- package/sdk/application/Cart/CartApplicationValidator.js +0 -546
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3909
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2667
- 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 -2544
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1875
- 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 -2189
- package/sdk/application/Content/ContentApplicationModel.js +0 -1640
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -290
- package/sdk/application/Content/ContentApplicationValidator.js +0 -269
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -270
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -188
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- 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
- 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 -2034
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1391
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -299
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -224
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2612
- package/sdk/application/Order/OrderApplicationModel.js +0 -1669
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -279
- package/sdk/application/Order/OrderApplicationValidator.js +0 -210
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4062
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2632
- 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 -1744
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1446
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -79
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -65
- 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 -54
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -48
- 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
|
@@ -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 `{}`
|
|
@@ -132,17 +115,15 @@ declare class Order {
|
|
|
132
115
|
*/
|
|
133
116
|
failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
|
|
134
117
|
/**
|
|
135
|
-
* @param {OrderPlatformValidator.
|
|
118
|
+
* @param {OrderPlatformValidator.FailedOrderLogsParam} arg - Arg object
|
|
136
119
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
137
120
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
|
-
* @returns {Promise<OrderPlatformModel.
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* @
|
|
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/).
|
|
121
|
+
* @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
|
|
122
|
+
* @name failedOrderLogs
|
|
123
|
+
* @summary: List failed order logs
|
|
124
|
+
* @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
|
|
144
125
|
*/
|
|
145
|
-
|
|
126
|
+
failedOrderLogs({ applicationId, pageNo, pageSize, searchType, searchValue, requestHeaders, }?: OrderPlatformValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
|
|
146
127
|
/**
|
|
147
128
|
* @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
|
|
148
129
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -158,35 +139,33 @@ declare class Order {
|
|
|
158
139
|
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
159
140
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
160
141
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
161
|
-
* @returns {Promise<OrderPlatformModel.
|
|
162
|
-
* Success response
|
|
142
|
+
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponse>} - Success response
|
|
163
143
|
* @name generateInvoiceID
|
|
164
144
|
* @summary: Generate and attach invoice Id
|
|
165
145
|
* @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
166
146
|
*/
|
|
167
|
-
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
147
|
+
generateInvoiceID({ invoiceType, body, requestHeaders }?: OrderPlatformValidator.GenerateInvoiceIDParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GenerateInvoiceIDResponse>;
|
|
168
148
|
/**
|
|
169
149
|
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
170
150
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
171
151
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
172
|
-
* @returns {Promise<OrderPlatformModel.
|
|
173
|
-
*
|
|
174
|
-
*
|
|
152
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>} -
|
|
153
|
+
* Success response
|
|
175
154
|
* @name generatePOSReceiptByOrderId
|
|
176
155
|
* @summary: Generate POS receipt by order Id
|
|
177
156
|
* @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
157
|
*/
|
|
179
|
-
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
158
|
+
generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
|
|
180
159
|
/**
|
|
181
160
|
* @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
|
|
182
161
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
-
* @returns {Promise<OrderPlatformModel.
|
|
163
|
+
* @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
|
|
185
164
|
* @name generateProcessManifest
|
|
186
165
|
* @summary: Process Order Manifest
|
|
187
166
|
* @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
|
|
188
167
|
*/
|
|
189
|
-
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
168
|
+
generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponse>;
|
|
190
169
|
/**
|
|
191
170
|
* @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
|
|
192
171
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -202,99 +181,84 @@ declare class Order {
|
|
|
202
181
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
203
182
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
204
183
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
205
|
-
* @returns {Promise<OrderPlatformModel.
|
|
206
|
-
* Success response
|
|
184
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponse>} - Success response
|
|
207
185
|
* @name getAllowedTemplatesForBulk
|
|
208
186
|
* @summary: List bulk operation templates
|
|
209
187
|
* @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
188
|
*/
|
|
211
|
-
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
189
|
+
getAllowedTemplatesForBulk({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.AllowedTemplatesResponse>;
|
|
212
190
|
/**
|
|
213
191
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
214
192
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
215
193
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
216
|
-
* @returns {Promise<OrderPlatformModel.
|
|
217
|
-
* Success response
|
|
194
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponse>} - Success response
|
|
218
195
|
* @name getAnnouncements
|
|
219
196
|
* @summary: List announcements
|
|
220
197
|
* @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
198
|
*/
|
|
222
|
-
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
199
|
+
getAnnouncements({ date, requestHeaders }?: OrderPlatformValidator.GetAnnouncementsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.AnnouncementsResponse>;
|
|
223
200
|
/**
|
|
224
201
|
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
225
202
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
226
203
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
|
-
* @returns {Promise<OrderPlatformModel.
|
|
228
|
-
*
|
|
229
|
-
*
|
|
204
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponse>} -
|
|
205
|
+
* Success response
|
|
230
206
|
* @name getBagById
|
|
231
207
|
* @summary: Get bag
|
|
232
208
|
* @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
233
209
|
*/
|
|
234
|
-
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
210
|
+
getBagById({ bagId, channelBagId, channelId, requestHeaders }?: OrderPlatformValidator.GetBagByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BagDetailsPlatformResponse>;
|
|
235
211
|
/**
|
|
236
212
|
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
237
213
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
238
214
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
239
|
-
* @returns {Promise<OrderPlatformModel.
|
|
240
|
-
* Success response
|
|
215
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponse>} - Success response
|
|
241
216
|
* @name getBags
|
|
242
217
|
* @summary: List bags
|
|
243
218
|
* @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
219
|
*/
|
|
245
|
-
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
220
|
+
getBags({ bagIds, shipmentIds, orderIds, channelBagIds, channelShipmentIds, channelOrderIds, channelId, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBagsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GetBagsPlatformResponse>;
|
|
246
221
|
/**
|
|
247
222
|
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
248
223
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
249
224
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
250
|
-
* @returns {Promise<OrderPlatformModel.
|
|
251
|
-
*
|
|
252
|
-
*
|
|
225
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponse>} -
|
|
226
|
+
* Success response
|
|
253
227
|
* @name getBulkActionTemplate
|
|
254
228
|
* @summary: List supported templates
|
|
255
229
|
* @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
230
|
*/
|
|
257
|
-
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
231
|
+
getBulkActionTemplate({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.BulkActionTemplateResponse>;
|
|
258
232
|
/**
|
|
259
233
|
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
260
234
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
261
235
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
|
-
* @returns {Promise<OrderPlatformModel.
|
|
236
|
+
* @returns {Promise<OrderPlatformModel.FileResponse>} - Success response
|
|
263
237
|
* @name getBulkShipmentExcelFile
|
|
264
238
|
* @summary: Generate the report
|
|
265
239
|
* @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
240
|
*/
|
|
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>;
|
|
241
|
+
getBulkShipmentExcelFile({ salesChannels, dpIds, startDate, endDate, stores, tags, bagStatus, paymentMethods, fileType, timeToDispatch, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetBulkShipmentExcelFileParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FileResponse>;
|
|
278
242
|
/**
|
|
279
243
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
280
244
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
281
245
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
282
|
-
* @returns {Promise<OrderPlatformModel.
|
|
246
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponse>} - Success response
|
|
283
247
|
* @name getFileByStatus
|
|
284
248
|
* @summary: Download file used for Bulk operation
|
|
285
249
|
* @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
250
|
*/
|
|
287
|
-
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
251
|
+
getFileByStatus({ batchId, status, fileType, reportType, requestHeaders }?: OrderPlatformValidator.GetFileByStatusParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobFailedResponse>;
|
|
288
252
|
/**
|
|
289
253
|
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
290
254
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
291
255
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
292
|
-
* @returns {Promise<OrderPlatformModel.
|
|
256
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponse>} - Success response
|
|
293
257
|
* @name getLaneConfig
|
|
294
258
|
* @summary: Get lane configuration
|
|
295
259
|
* @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
296
260
|
*/
|
|
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.
|
|
261
|
+
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
262
|
/**
|
|
299
263
|
* @param {OrderPlatformValidator.GetManifestDetailsParam} arg - Arg object
|
|
300
264
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -304,7 +268,7 @@ declare class Order {
|
|
|
304
268
|
* @summary: Get a manifest
|
|
305
269
|
* @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
270
|
*/
|
|
307
|
-
getManifestDetails({ manifestId, requestHeaders }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
|
|
271
|
+
getManifestDetails({ manifestId, dpIds, endDate, startDate, pageNo, pageSize, requestHeaders, }?: OrderPlatformValidator.GetManifestDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestDetails>;
|
|
308
272
|
/**
|
|
309
273
|
* @param {OrderPlatformValidator.GetManifestShipmentsParam} arg - Arg object
|
|
310
274
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -319,13 +283,12 @@ declare class Order {
|
|
|
319
283
|
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
320
284
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
321
285
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
322
|
-
* @returns {Promise<OrderPlatformModel.
|
|
323
|
-
* Success response
|
|
286
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponse>} - Success response
|
|
324
287
|
* @name getManifestfilters
|
|
325
288
|
* @summary: List filters
|
|
326
289
|
* @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
327
290
|
*/
|
|
328
|
-
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
291
|
+
getManifestfilters({ view, requestHeaders }?: OrderPlatformValidator.GetManifestfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestFiltersResponse>;
|
|
329
292
|
/**
|
|
330
293
|
* @param {OrderPlatformValidator.GetManifestsParam} arg - Arg object
|
|
331
294
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -340,80 +303,75 @@ declare class Order {
|
|
|
340
303
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
341
304
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
342
305
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
343
|
-
* @returns {Promise<OrderPlatformModel.
|
|
344
|
-
* Success response
|
|
306
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponse>} - Success response
|
|
345
307
|
* @name getOrderById
|
|
346
308
|
* @summary: Get order
|
|
347
309
|
* @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
348
310
|
*/
|
|
349
|
-
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
311
|
+
getOrderById({ orderId, myOrders, allowInactive, requestHeaders }?: OrderPlatformValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderDetailsResponse>;
|
|
350
312
|
/**
|
|
351
313
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
352
314
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
353
315
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
354
|
-
* @returns {Promise<OrderPlatformModel.
|
|
355
|
-
* Success response
|
|
316
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponse>} - Success response
|
|
356
317
|
* @name getOrders
|
|
357
318
|
* @summary: List orders
|
|
358
319
|
* @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
320
|
*/
|
|
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,
|
|
321
|
+
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
322
|
/**
|
|
362
323
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
363
324
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
364
325
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
365
|
-
* @returns {Promise<OrderPlatformModel.
|
|
326
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponse>} - Success response
|
|
366
327
|
* @name getRoleBasedActions
|
|
367
328
|
* @summary: Get role-based actions
|
|
368
329
|
* @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
330
|
*/
|
|
370
|
-
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
331
|
+
getRoleBasedActions({ requestHeaders }?: any, { responseHeaders }?: object): Promise<OrderPlatformModel.GetActionsResponse>;
|
|
371
332
|
/**
|
|
372
333
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
373
334
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
374
335
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
375
|
-
* @returns {Promise<OrderPlatformModel.
|
|
376
|
-
* Success response
|
|
336
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponse>} - Success response
|
|
377
337
|
* @name getShipmentById
|
|
378
338
|
* @summary: Get shipment
|
|
379
339
|
* @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
380
340
|
*/
|
|
381
|
-
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
341
|
+
getShipmentById({ channelShipmentId, shipmentId, fetchActiveShipment, allowInactive, requestHeaders, }?: OrderPlatformValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInfoResponse>;
|
|
382
342
|
/**
|
|
383
343
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
384
344
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
385
345
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
386
|
-
* @returns {Promise<OrderPlatformModel.
|
|
387
|
-
* Success response
|
|
346
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
388
347
|
* @name getShipmentHistory
|
|
389
348
|
* @summary: Get a shipment's history
|
|
390
349
|
* @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
391
350
|
*/
|
|
392
|
-
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
351
|
+
getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
393
352
|
/**
|
|
394
353
|
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
395
354
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
396
355
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
397
|
-
* @returns {Promise<OrderPlatformModel.
|
|
398
|
-
*
|
|
399
|
-
*
|
|
356
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>} -
|
|
357
|
+
* Success response
|
|
400
358
|
* @name getShipmentReasons
|
|
401
359
|
* @summary: List bag cancellation reasons
|
|
402
360
|
* @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
361
|
*/
|
|
404
|
-
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
362
|
+
getShipmentReasons({ shipmentId, bagId, state, requestHeaders }?: OrderPlatformValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentReasonsResponse>;
|
|
405
363
|
/**
|
|
406
364
|
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
407
365
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
408
366
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
409
|
-
* @returns {Promise<OrderPlatformModel.
|
|
367
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>}
|
|
410
368
|
* - Success response
|
|
411
369
|
*
|
|
412
370
|
* @name getShipments
|
|
413
371
|
* @summary: List shipments
|
|
414
372
|
* @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
373
|
*/
|
|
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,
|
|
374
|
+
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
375
|
/**
|
|
418
376
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
419
377
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -440,45 +398,43 @@ declare class Order {
|
|
|
440
398
|
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
441
399
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
442
400
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
443
|
-
* @returns {Promise<OrderPlatformModel.
|
|
444
|
-
* Success response
|
|
401
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponse>} - Success response
|
|
445
402
|
* @name getTemplate
|
|
446
403
|
* @summary: Download bulk operation templates
|
|
447
404
|
* @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
405
|
*/
|
|
449
|
-
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
406
|
+
getTemplate({ templateName, requestHeaders }?: OrderPlatformValidator.GetTemplateParam, { responseHeaders }?: object): Promise<OrderPlatformModel.TemplateDownloadResponse>;
|
|
450
407
|
/**
|
|
451
408
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
452
409
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
453
410
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
454
|
-
* @returns {Promise<OrderPlatformModel.
|
|
411
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponse>} - Success response
|
|
455
412
|
* @name getfilters
|
|
456
413
|
* @summary: List filters
|
|
457
414
|
* @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
458
415
|
*/
|
|
459
|
-
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
416
|
+
getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponse>;
|
|
460
417
|
/**
|
|
461
418
|
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
462
419
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
463
420
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
464
|
-
* @returns {Promise<OrderPlatformModel.
|
|
465
|
-
*
|
|
466
|
-
*
|
|
421
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>} -
|
|
422
|
+
* Success response
|
|
467
423
|
* @name invalidateShipmentCache
|
|
468
424
|
* @summary: Invalidate shipment cache
|
|
469
425
|
* @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
426
|
*/
|
|
471
|
-
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
427
|
+
invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponse>;
|
|
472
428
|
/**
|
|
473
429
|
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
474
430
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
475
431
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
476
|
-
* @returns {Promise<OrderPlatformModel.
|
|
432
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponse>} - Success response
|
|
477
433
|
* @name jobDetails
|
|
478
434
|
* @summary: Get bulk operation details
|
|
479
435
|
* @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
436
|
*/
|
|
481
|
-
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
437
|
+
jobDetails({ batchId, requestHeaders }?: OrderPlatformValidator.JobDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.JobDetailsResponse>;
|
|
482
438
|
/**
|
|
483
439
|
* @param {OrderPlatformValidator.OrderUpdateParam} arg - Arg object
|
|
484
440
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -493,113 +449,86 @@ declare class Order {
|
|
|
493
449
|
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
494
450
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
495
451
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
496
|
-
* @returns {Promise<OrderPlatformModel.
|
|
497
|
-
* Success response
|
|
452
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponse>} - Success response
|
|
498
453
|
* @name postShipmentHistory
|
|
499
454
|
* @summary: Create shipment history
|
|
500
455
|
* @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
456
|
*/
|
|
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>;
|
|
457
|
+
postShipmentHistory({ body, requestHeaders }?: OrderPlatformValidator.PostShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponse>;
|
|
515
458
|
/**
|
|
516
459
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
517
460
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
518
461
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
519
|
-
* @returns {Promise<OrderPlatformModel.
|
|
520
|
-
* Success response
|
|
462
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponse>} - Success response
|
|
521
463
|
* @name reassignLocation
|
|
522
464
|
* @summary: Reassign location
|
|
523
465
|
* @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
466
|
*/
|
|
525
|
-
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
467
|
+
reassignLocation({ body, requestHeaders }?: OrderPlatformValidator.ReassignLocationParam, { responseHeaders }?: object): Promise<OrderPlatformModel.StoreReassignResponse>;
|
|
526
468
|
/**
|
|
527
469
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
528
470
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
529
471
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
530
|
-
* @returns {Promise<OrderPlatformModel.
|
|
472
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
531
473
|
* @name sendSmsNinja
|
|
532
474
|
* @summary: Send SMS
|
|
533
475
|
* @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
476
|
*/
|
|
535
|
-
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
477
|
+
sendSmsNinja({ body, requestHeaders }?: OrderPlatformValidator.SendSmsNinjaParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
|
|
536
478
|
/**
|
|
537
479
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
538
480
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
539
481
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
540
|
-
* @returns {Promise<OrderPlatformModel.
|
|
541
|
-
* Success response
|
|
482
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponse>} - Success response
|
|
542
483
|
* @name sendUserMobileOTP
|
|
543
484
|
* @summary: Send user mobile OTP
|
|
544
485
|
* @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
486
|
*/
|
|
546
|
-
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
487
|
+
sendUserMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.SendUserMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SendUserMobileOtpResponse>;
|
|
547
488
|
/**
|
|
548
489
|
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
549
490
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
550
491
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
551
|
-
* @returns {Promise<OrderPlatformModel.
|
|
552
|
-
*
|
|
553
|
-
*
|
|
492
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponse>} -
|
|
493
|
+
* Success response
|
|
554
494
|
* @name trackShipment
|
|
555
495
|
* @summary: Track shipment
|
|
556
496
|
* @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
497
|
*/
|
|
558
|
-
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
498
|
+
trackShipment({ shipmentId, awb, pageNo, pageSize, requestHeaders }?: OrderPlatformValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CourierPartnerTrackingResponse>;
|
|
559
499
|
/**
|
|
560
500
|
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
561
501
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
562
502
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
563
|
-
* @returns {Promise<OrderPlatformModel.
|
|
503
|
+
* @returns {Promise<OrderPlatformModel.BaseResponse>} - Success response
|
|
564
504
|
* @name updateAddress
|
|
565
|
-
* @summary: Update
|
|
566
|
-
* @description:
|
|
505
|
+
* @summary: Update shipment address
|
|
506
|
+
* @description: Modify the address details of an existing shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
567
507
|
*/
|
|
568
|
-
updateAddress({ shipmentId,
|
|
508
|
+
updateAddress({ shipmentId, addressCategory, name, address, addressType, pincode, phone, email, landmark, city, state, country, requestHeaders, }?: OrderPlatformValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponse>;
|
|
569
509
|
/**
|
|
570
510
|
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
571
511
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
572
512
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
573
|
-
* @returns {Promise<OrderPlatformModel.
|
|
513
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>}
|
|
574
514
|
* - Success response
|
|
575
515
|
*
|
|
576
516
|
* @name updatePackagingDimensions
|
|
577
517
|
* @summary: Update packaging dimensions
|
|
578
518
|
* @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
519
|
*/
|
|
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>;
|
|
520
|
+
updatePackagingDimensions({ body, requestHeaders }?: OrderPlatformValidator.UpdatePackagingDimensionsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdatePackagingDimensionsResponse>;
|
|
591
521
|
/**
|
|
592
522
|
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
593
523
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
594
524
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
595
|
-
* @returns {Promise<OrderPlatformModel.
|
|
596
|
-
*
|
|
597
|
-
*
|
|
525
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponse>} -
|
|
526
|
+
* Success response
|
|
598
527
|
* @name updateShipmentLock
|
|
599
528
|
* @summary: Update a shipment lock
|
|
600
|
-
* @description: Modify shipment/bag lock and
|
|
529
|
+
* @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
530
|
*/
|
|
602
|
-
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
531
|
+
updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponse>;
|
|
603
532
|
/**
|
|
604
533
|
* @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
|
|
605
534
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -627,22 +556,22 @@ declare class Order {
|
|
|
627
556
|
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
628
557
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
629
558
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
630
|
-
* @returns {Promise<OrderPlatformModel.
|
|
559
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponse>} - Success response
|
|
631
560
|
* @name uploadConsents
|
|
632
561
|
* @summary: Upload consent
|
|
633
562
|
* @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
563
|
*/
|
|
635
|
-
uploadConsents({
|
|
564
|
+
uploadConsents({ body, requestHeaders }?: OrderPlatformValidator.UploadConsentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
|
|
636
565
|
/**
|
|
637
566
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
638
567
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
639
568
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
640
|
-
* @returns {Promise<OrderPlatformModel.
|
|
569
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponse>} - Success response
|
|
641
570
|
* @name verifyMobileOTP
|
|
642
571
|
* @summary: Verify mobile OTP
|
|
643
572
|
* @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
573
|
*/
|
|
645
|
-
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
574
|
+
verifyMobileOTP({ body, requestHeaders }?: OrderPlatformValidator.VerifyMobileOTPParam, { responseHeaders }?: object): Promise<OrderPlatformModel.VerifyOtpResponse>;
|
|
646
575
|
}
|
|
647
576
|
import OrderPlatformValidator = require("./OrderPlatformValidator");
|
|
648
577
|
import OrderPlatformModel = require("./OrderPlatformModel");
|