@gofynd/fdk-client-javascript 1.4.2-beta.6 → 1.4.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 +1 -1
- package/package.json +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +13 -13
- package/sdk/application/Order/OrderApplicationClient.js +16 -12
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
- package/sdk/application/Order/OrderApplicationValidator.js +3 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +33 -19
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +43 -43
- package/sdk/platform/Order/OrderPlatformClient.js +55 -44
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -20,7 +20,7 @@ class Billing {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<BillingPlatformModel.SubscriptionActivateRes>} - Success response
|
|
22
22
|
* @name activateSubscriptionPlan
|
|
23
|
-
* @summary: Activate a subscription plan
|
|
23
|
+
* @summary: Activate a subscription plan
|
|
24
24
|
* @description: Activate a specific subscription plan for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/activateSubscriptionPlan/).
|
|
25
25
|
*/
|
|
26
26
|
async activateSubscriptionPlan(
|
|
@@ -101,7 +101,7 @@ class Billing {
|
|
|
101
101
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
102
102
|
* @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
|
|
103
103
|
* @name cancelSubscriptionCharge
|
|
104
|
-
* @summary: Cancel a subscription charge
|
|
104
|
+
* @summary: Cancel a subscription charge
|
|
105
105
|
* @description: Cancel an ongoing subscription charge for a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
|
|
106
106
|
*/
|
|
107
107
|
async cancelSubscriptionCharge(
|
|
@@ -184,7 +184,7 @@ class Billing {
|
|
|
184
184
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
185
185
|
* @returns {Promise<BillingPlatformModel.CancelSubscriptionRes>} - Success response
|
|
186
186
|
* @name cancelSubscriptionPlan
|
|
187
|
-
* @summary: Cancel a subscription plan
|
|
187
|
+
* @summary: Cancel a subscription plan
|
|
188
188
|
* @description: Cancel an active subscription plan for a customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionPlan/).
|
|
189
189
|
*/
|
|
190
190
|
async cancelSubscriptionPlan(
|
|
@@ -265,7 +265,7 @@ class Billing {
|
|
|
265
265
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
266
266
|
* @returns {Promise<BillingPlatformModel.CheckValidityResponse>} - Success response
|
|
267
267
|
* @name checkCouponValidity
|
|
268
|
-
* @summary: Verify coupon validity
|
|
268
|
+
* @summary: Verify coupon validity
|
|
269
269
|
* @description: Checks whether a coupon code is valid for discounts while billing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/checkCouponValidity/).
|
|
270
270
|
*/
|
|
271
271
|
async checkCouponValidity(
|
|
@@ -349,7 +349,7 @@ class Billing {
|
|
|
349
349
|
* @returns {Promise<BillingPlatformModel.CreateOneTimeChargeResponse>} -
|
|
350
350
|
* Success response
|
|
351
351
|
* @name createOneTimeCharge
|
|
352
|
-
* @summary: Generate a one-time charge
|
|
352
|
+
* @summary: Generate a one-time charge
|
|
353
353
|
* @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
|
|
354
354
|
*/
|
|
355
355
|
async createOneTimeCharge(
|
|
@@ -431,7 +431,7 @@ class Billing {
|
|
|
431
431
|
* @returns {Promise<BillingPlatformModel.CreateSubscriptionResponse>} -
|
|
432
432
|
* Success response
|
|
433
433
|
* @name createSubscriptionCharge
|
|
434
|
-
* @summary: Initiate subscription billing
|
|
434
|
+
* @summary: Initiate subscription billing
|
|
435
435
|
* @description: Register a subscription charge for a seller using your extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
|
|
436
436
|
*/
|
|
437
437
|
async createSubscriptionCharge(
|
|
@@ -514,7 +514,7 @@ class Billing {
|
|
|
514
514
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
515
515
|
* @returns {Promise<BillingPlatformModel.OneTimeChargeEntity>} - Success response
|
|
516
516
|
* @name getChargeDetails
|
|
517
|
-
* @summary: Obtain charge details
|
|
517
|
+
* @summary: Obtain charge details
|
|
518
518
|
* @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
|
|
519
519
|
*/
|
|
520
520
|
async getChargeDetails(
|
|
@@ -595,7 +595,7 @@ class Billing {
|
|
|
595
595
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
596
596
|
* @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
|
|
597
597
|
* @name getCustomerDetail
|
|
598
|
-
* @summary: Fetch customer details
|
|
598
|
+
* @summary: Fetch customer details
|
|
599
599
|
* @description: Obtain customer-related billing information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getCustomerDetail/).
|
|
600
600
|
*/
|
|
601
601
|
async getCustomerDetail(
|
|
@@ -670,7 +670,7 @@ class Billing {
|
|
|
670
670
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
671
671
|
* @returns {Promise<BillingPlatformModel.Plan[]>} - Success response
|
|
672
672
|
* @name getEnterprisePlans
|
|
673
|
-
* @summary: Retrieve enterprise-level plans
|
|
673
|
+
* @summary: Retrieve enterprise-level plans
|
|
674
674
|
* @description: Retrieve available enterprise-level subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getEnterprisePlans/).
|
|
675
675
|
*/
|
|
676
676
|
async getEnterprisePlans(
|
|
@@ -742,7 +742,7 @@ class Billing {
|
|
|
742
742
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
743
743
|
* @returns {Promise<BillingPlatformModel.SubscriptionLimit>} - Success response
|
|
744
744
|
* @name getFeatureLimitConfig
|
|
745
|
-
* @summary: Obtain feature limit configurations
|
|
745
|
+
* @summary: Obtain feature limit configurations
|
|
746
746
|
* @description: Retrieve configuration settings for feature limits in subscription plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getFeatureLimitConfig/).
|
|
747
747
|
*/
|
|
748
748
|
async getFeatureLimitConfig(
|
|
@@ -825,7 +825,7 @@ class Billing {
|
|
|
825
825
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
826
826
|
* @returns {Promise<BillingPlatformModel.Invoice>} - Success response
|
|
827
827
|
* @name getInvoiceById
|
|
828
|
-
* @summary: Get a specific invoice
|
|
828
|
+
* @summary: Get a specific invoice
|
|
829
829
|
* @description: Retrieve a particular invoice's details by providing its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoiceById/).
|
|
830
830
|
*/
|
|
831
831
|
async getInvoiceById(
|
|
@@ -904,7 +904,7 @@ class Billing {
|
|
|
904
904
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
905
905
|
* @returns {Promise<BillingPlatformModel.Invoices>} - Success response
|
|
906
906
|
* @name getInvoices
|
|
907
|
-
* @summary: Retrieve invoices
|
|
907
|
+
* @summary: Retrieve invoices
|
|
908
908
|
* @description: Retrieve invoices for billing and payment tracking. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getInvoices/).
|
|
909
909
|
*/
|
|
910
910
|
async getInvoices(
|
|
@@ -977,7 +977,7 @@ class Billing {
|
|
|
977
977
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
978
978
|
* @returns {Promise<BillingPlatformModel.SubscriptionStatus>} - Success response
|
|
979
979
|
* @name getSubscription
|
|
980
|
-
* @summary: Retrieve subscription details
|
|
980
|
+
* @summary: Retrieve subscription details
|
|
981
981
|
* @description: Retrieve details of a customer's subscription information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscription/).
|
|
982
982
|
*/
|
|
983
983
|
async getSubscription(
|
|
@@ -1052,7 +1052,7 @@ class Billing {
|
|
|
1052
1052
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1053
1053
|
* @returns {Promise<BillingPlatformModel.EntitySubscription>} - Success response
|
|
1054
1054
|
* @name getSubscriptionCharge
|
|
1055
|
-
* @summary: Retrieve subscription charge details
|
|
1055
|
+
* @summary: Retrieve subscription charge details
|
|
1056
1056
|
* @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
|
|
1057
1057
|
*/
|
|
1058
1058
|
async getSubscriptionCharge(
|
|
@@ -1232,7 +1232,7 @@ class Billing {
|
|
|
1232
1232
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1233
1233
|
* @returns {Promise<BillingPlatformModel.Plan>} - Success response
|
|
1234
1234
|
* @name planStatusUpdate
|
|
1235
|
-
* @summary: Update subscription plan status
|
|
1235
|
+
* @summary: Update subscription plan status
|
|
1236
1236
|
* @description: Modify the status of a subscription plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/planStatusUpdate/).
|
|
1237
1237
|
*/
|
|
1238
1238
|
async planStatusUpdate(
|
|
@@ -1311,7 +1311,7 @@ class Billing {
|
|
|
1311
1311
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1312
1312
|
* @returns {Promise<BillingPlatformModel.SubscribePlanRes>} - Success response
|
|
1313
1313
|
* @name subscripePlan
|
|
1314
|
-
* @summary: Subscribe to a plan
|
|
1314
|
+
* @summary: Subscribe to a plan
|
|
1315
1315
|
* @description: Subscribe to a specific billing plan. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/subscripePlan/).
|
|
1316
1316
|
*/
|
|
1317
1317
|
async subscripePlan(
|
|
@@ -1390,7 +1390,7 @@ class Billing {
|
|
|
1390
1390
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1391
1391
|
* @returns {Promise<BillingPlatformModel.SubscriptionCustomer>} - Success response
|
|
1392
1392
|
* @name upsertCustomerDetail
|
|
1393
|
-
* @summary: Update or insert customer details
|
|
1393
|
+
* @summary: Update or insert customer details
|
|
1394
1394
|
* @description: Allows you to modify or insert customer information in the billing system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/upsertCustomerDetail/).
|
|
1395
1395
|
*/
|
|
1396
1396
|
async upsertCustomerDetail(
|
|
@@ -9,7 +9,7 @@ declare class Cart {
|
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
10
|
* @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
|
|
11
11
|
* @name addAddress
|
|
12
|
-
* @summary: Add a new user address
|
|
12
|
+
* @summary: Add a new user address
|
|
13
13
|
* @description: Create and add a new user address for cart checkout. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addAddress/).
|
|
14
14
|
*/
|
|
15
15
|
addAddress({ body, requestHeaders }?: CartPlatformApplicationValidator.AddAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.SaveAddressResponse>;
|
|
@@ -19,7 +19,7 @@ declare class Cart {
|
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
21
21
|
* @name addItems
|
|
22
|
-
* @summary: Add items to the cart
|
|
22
|
+
* @summary: Add items to the cart
|
|
23
23
|
* @description: Add items to the shopping cart - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addItems/).
|
|
24
24
|
*/
|
|
25
25
|
addItems({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.AddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
@@ -29,7 +29,7 @@ declare class Cart {
|
|
|
29
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
31
31
|
* @name addPriceAdjustment
|
|
32
|
-
* @summary: Add price adjustments
|
|
32
|
+
* @summary: Add price adjustments
|
|
33
33
|
* @description: Apply price adjustments to items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addPriceAdjustment/).
|
|
34
34
|
*/
|
|
35
35
|
addPriceAdjustment({ body, requestHeaders }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
@@ -39,7 +39,7 @@ declare class Cart {
|
|
|
39
39
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
40
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
41
41
|
* @name applyCoupon
|
|
42
|
-
* @summary: Apply a coupon to the cart
|
|
42
|
+
* @summary: Apply a coupon to the cart
|
|
43
43
|
* @description: Apply a selected coupon to the items in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/applyCoupon/).
|
|
44
44
|
*/
|
|
45
45
|
applyCoupon({ body, i, b, p, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.ApplyCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
@@ -53,7 +53,7 @@ declare class Cart {
|
|
|
53
53
|
* - Success response
|
|
54
54
|
*
|
|
55
55
|
* @name checkCartServiceability
|
|
56
|
-
* @summary: Check cart serviceability
|
|
56
|
+
* @summary: Check cart serviceability
|
|
57
57
|
* @description: Verify if the items in the cart are serviceable. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
|
|
58
58
|
*/
|
|
59
59
|
checkCartServiceability({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>;
|
|
@@ -63,7 +63,7 @@ declare class Cart {
|
|
|
63
63
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
64
|
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
|
|
65
65
|
* @name checkoutCart
|
|
66
|
-
* @summary: Proceed to cart checkout
|
|
66
|
+
* @summary: Proceed to cart checkout
|
|
67
67
|
* @description: Initiate the checkout process for the items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkoutCart/).
|
|
68
68
|
*/
|
|
69
69
|
checkoutCart({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCheckoutResponse>;
|
|
@@ -85,7 +85,7 @@ declare class Cart {
|
|
|
85
85
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
86
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
87
87
|
* @name createCoupon
|
|
88
|
-
* @summary: Create a new coupon
|
|
88
|
+
* @summary: Create a new coupon
|
|
89
89
|
* @description: Generate and add a new coupon to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCoupon/).
|
|
90
90
|
*/
|
|
91
91
|
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
@@ -95,7 +95,7 @@ declare class Cart {
|
|
|
95
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
96
|
* @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
|
|
97
97
|
* @name createPromotion
|
|
98
|
-
* @summary: Create a new promotion
|
|
98
|
+
* @summary: Create a new promotion
|
|
99
99
|
* @description: Generate and add a new promotion to the cart system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createPromotion/).
|
|
100
100
|
*/
|
|
101
101
|
createPromotion({ body, requestHeaders }?: CartPlatformApplicationValidator.CreatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionAdd>;
|
|
@@ -105,7 +105,7 @@ declare class Cart {
|
|
|
105
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
106
106
|
* @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
|
|
107
107
|
* @name deleteCart
|
|
108
|
-
* @summary: Delete a cart
|
|
108
|
+
* @summary: Delete a cart
|
|
109
109
|
* @description: Delete a specific shopping cart from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
|
|
110
110
|
*/
|
|
111
111
|
deleteCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteCartDetailResponse>;
|
|
@@ -117,7 +117,7 @@ declare class Cart {
|
|
|
117
117
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
118
118
|
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
|
|
119
119
|
* @name fetchAndvalidateCartItems
|
|
120
|
-
* @summary: Fetch and validate cart items
|
|
120
|
+
* @summary: Fetch and validate cart items
|
|
121
121
|
* @description: Retrieve and validate items currently in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
|
|
122
122
|
*/
|
|
123
123
|
fetchAndvalidateCartItems({ body, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenapiCartDetailsResponse>;
|
|
@@ -137,7 +137,7 @@ declare class Cart {
|
|
|
137
137
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
138
|
* @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
|
|
139
139
|
* @name getAbandonedCart
|
|
140
|
-
* @summary: Retrieve abandoned carts
|
|
140
|
+
* @summary: Retrieve abandoned carts
|
|
141
141
|
* @description: Retrieve abandoned carts for analysis and potential recovery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCart/).
|
|
142
142
|
*/
|
|
143
143
|
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.AbandonedCartResponse>;
|
|
@@ -149,7 +149,7 @@ declare class Cart {
|
|
|
149
149
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
150
150
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
151
151
|
* @name getAbandonedCartDetails
|
|
152
|
-
* @summary: Get abandoned cart details
|
|
152
|
+
* @summary: Get abandoned cart details
|
|
153
153
|
* @description: Retrieve detailed information about a specific abandoned cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCartDetails/).
|
|
154
154
|
*/
|
|
155
155
|
getAbandonedCartDetails({ id, i, b, c, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
@@ -180,7 +180,7 @@ declare class Cart {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
|
|
182
182
|
* @name getAppCoupons
|
|
183
|
-
* @summary: Get app-specific coupons
|
|
183
|
+
* @summary: Get app-specific coupons
|
|
184
184
|
* @description: Retrieve coupons specific to the mobile app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
|
|
185
185
|
*/
|
|
186
186
|
getAppCoupons({ id, buyNow, slug, storeId, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResponse>;
|
|
@@ -192,7 +192,7 @@ declare class Cart {
|
|
|
192
192
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
193
193
|
* @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
|
|
194
194
|
* @name getAvailableDeliveryModes
|
|
195
|
-
* @summary: Get available delivery modes
|
|
195
|
+
* @summary: Get available delivery modes
|
|
196
196
|
* @description: Retrieve a list of available delivery modes for cart checkout. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAvailableDeliveryModes/).
|
|
197
197
|
*/
|
|
198
198
|
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDeliveryModesResponse>;
|
|
@@ -202,7 +202,7 @@ declare class Cart {
|
|
|
202
202
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
204
204
|
* @name getCart
|
|
205
|
-
* @summary: Get cart details
|
|
205
|
+
* @summary: Get cart details
|
|
206
206
|
* @description: Retrieve detailed information about a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
|
|
207
207
|
*/
|
|
208
208
|
getCart({ id, userId, i, b, assignCardId, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
@@ -212,7 +212,7 @@ declare class Cart {
|
|
|
212
212
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
213
213
|
* @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
|
|
214
214
|
* @name getCartList
|
|
215
|
-
* @summary: Retrieve a list of carts
|
|
215
|
+
* @summary: Retrieve a list of carts
|
|
216
216
|
* @description: Retrieve a list of saved shopping carts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
|
|
217
217
|
*/
|
|
218
218
|
getCartList({ fromDate, toDate, filterOn, requestHeaders }?: CartPlatformApplicationValidator.GetCartListParam, { responseHeaders }?: object): Promise<CartPlatformModel.MultiCartResponse>;
|
|
@@ -232,7 +232,7 @@ declare class Cart {
|
|
|
232
232
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
233
233
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
234
234
|
* @name getCartSharedItems
|
|
235
|
-
* @summary: Get items shared via a cart link
|
|
235
|
+
* @summary: Get items shared via a cart link
|
|
236
236
|
* @description: Retrieve the items shared with you via a cart link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartSharedItems/).
|
|
237
237
|
*/
|
|
238
238
|
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
@@ -242,7 +242,7 @@ declare class Cart {
|
|
|
242
242
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
243
243
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
244
244
|
* @name getCouponById
|
|
245
|
-
* @summary: Get coupon details by ID
|
|
245
|
+
* @summary: Get coupon details by ID
|
|
246
246
|
* @description: Retrieve detailed information about a specific coupon using its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponById/).
|
|
247
247
|
*/
|
|
248
248
|
getCouponById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetCouponByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponUpdate>;
|
|
@@ -252,7 +252,7 @@ declare class Cart {
|
|
|
252
252
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
253
253
|
* @returns {Promise<Object>} - Success response
|
|
254
254
|
* @name getCouponCodeExists
|
|
255
|
-
* @summary: Check if a coupon code exists
|
|
255
|
+
* @summary: Check if a coupon code exists
|
|
256
256
|
* @description: Verify the existence of a specific coupon code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
|
|
257
257
|
*/
|
|
258
258
|
getCouponCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -264,7 +264,7 @@ declare class Cart {
|
|
|
264
264
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
265
265
|
* @returns {Promise<Object>} - Success response
|
|
266
266
|
* @name getCouponOptionValues
|
|
267
|
-
* @summary: Get coupon option values
|
|
267
|
+
* @summary: Get coupon option values
|
|
268
268
|
* @description: Retrieve available values for coupon options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
|
|
269
269
|
*/
|
|
270
270
|
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
@@ -274,7 +274,7 @@ declare class Cart {
|
|
|
274
274
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
275
275
|
* @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
|
|
276
276
|
* @name getCoupons
|
|
277
|
-
* @summary: Retrieve available coupons
|
|
277
|
+
* @summary: Retrieve available coupons
|
|
278
278
|
* @description: Retrieve a list of available coupons for use in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCoupons/).
|
|
279
279
|
*/
|
|
280
280
|
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, requestHeaders, }?: CartPlatformApplicationValidator.GetCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponsResponse>;
|
|
@@ -284,7 +284,7 @@ declare class Cart {
|
|
|
284
284
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
285
285
|
* @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
|
|
286
286
|
* @name getItemCount
|
|
287
|
-
* @summary: Get the item count in a cart
|
|
287
|
+
* @summary: Get the item count in a cart
|
|
288
288
|
* @description: Retrieve the total number of items in a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getItemCount/).
|
|
289
289
|
*/
|
|
290
290
|
getItemCount({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartItemCountResponse>;
|
|
@@ -296,7 +296,7 @@ declare class Cart {
|
|
|
296
296
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
297
297
|
* @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
|
|
298
298
|
* @name getPromosCouponConfig
|
|
299
|
-
* @summary: Get promotion and coupon configuration
|
|
299
|
+
* @summary: Get promotion and coupon configuration
|
|
300
300
|
* @description: Retrieve configuration settings for promotions and coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromosCouponConfig/).
|
|
301
301
|
*/
|
|
302
302
|
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.ActivePromosResponse>;
|
|
@@ -306,7 +306,7 @@ declare class Cart {
|
|
|
306
306
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
307
307
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
308
308
|
* @name getPromotionById
|
|
309
|
-
* @summary: Get promotion details by ID
|
|
309
|
+
* @summary: Get promotion details by ID
|
|
310
310
|
* @description: Retrieve detailed information about a specific promotion using its unique ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionById/).
|
|
311
311
|
*/
|
|
312
312
|
getPromotionById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
@@ -318,7 +318,7 @@ declare class Cart {
|
|
|
318
318
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
319
319
|
* @returns {Promise<Object>} - Success response
|
|
320
320
|
* @name getPromotionCodeExists
|
|
321
|
-
* @summary: Check if a promotion code exists
|
|
321
|
+
* @summary: Check if a promotion code exists
|
|
322
322
|
* @description: Verify the existence of a specific promotion code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
|
|
323
323
|
*/
|
|
324
324
|
getPromotionCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -328,7 +328,7 @@ declare class Cart {
|
|
|
328
328
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
329
329
|
* @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
|
|
330
330
|
* @name getPromotions
|
|
331
|
-
* @summary: Retrieve available promotions
|
|
331
|
+
* @summary: Retrieve available promotions
|
|
332
332
|
* @description: Retrieve a list of available promotions to apply to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotions/).
|
|
333
333
|
*/
|
|
334
334
|
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionsResponse>;
|
|
@@ -351,7 +351,7 @@ declare class Cart {
|
|
|
351
351
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
352
352
|
* @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
|
|
353
353
|
* @name getStoreAddressByUid
|
|
354
|
-
* @summary: Get store address by UID
|
|
354
|
+
* @summary: Get store address by UID
|
|
355
355
|
* @description: Retrieve the store address using a unique identifier (UID). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getStoreAddressByUid/).
|
|
356
356
|
*/
|
|
357
357
|
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.StoreDetailsResponse>;
|
|
@@ -361,7 +361,7 @@ declare class Cart {
|
|
|
361
361
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
362
362
|
* @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
|
|
363
363
|
* @name overrideCart
|
|
364
|
-
* @summary: Override the cart
|
|
364
|
+
* @summary: Override the cart
|
|
365
365
|
* @description: Override the current cart with a new configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
|
|
366
366
|
*/
|
|
367
367
|
overrideCart({ body, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OverrideCheckoutResponse>;
|
|
@@ -371,7 +371,7 @@ declare class Cart {
|
|
|
371
371
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
372
372
|
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
373
373
|
* @name platformAddItems
|
|
374
|
-
* @summary: Add items via platform integration
|
|
374
|
+
* @summary: Add items via platform integration
|
|
375
375
|
* @description: Add items to the cart through platform integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
|
|
376
376
|
*/
|
|
377
377
|
platformAddItems({ body, i, b, buyNow, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
@@ -383,7 +383,7 @@ declare class Cart {
|
|
|
383
383
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
384
384
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
385
385
|
* @name platformCheckoutCart
|
|
386
|
-
* @summary: Platform-specific cart checkout
|
|
386
|
+
* @summary: Platform-specific cart checkout
|
|
387
387
|
* @description: Initiate cart checkout through platform-specific integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
|
|
388
388
|
*/
|
|
389
389
|
platformCheckoutCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
@@ -395,7 +395,7 @@ declare class Cart {
|
|
|
395
395
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
396
396
|
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
397
397
|
* @name platformCheckoutCartV2
|
|
398
|
-
* @summary: Platform-specific cart checkout v2
|
|
398
|
+
* @summary: Platform-specific cart checkout v2
|
|
399
399
|
* @description: Initiate cart checkout through an updated platform-specific integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
400
400
|
*/
|
|
401
401
|
platformCheckoutCartV2({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
@@ -415,7 +415,7 @@ declare class Cart {
|
|
|
415
415
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
416
416
|
* @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
|
|
417
417
|
* @name removeAddress
|
|
418
|
-
* @summary: Remove a user address
|
|
418
|
+
* @summary: Remove a user address
|
|
419
419
|
* @description: Delete an existing user address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
420
420
|
*/
|
|
421
421
|
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteAddressResponse>;
|
|
@@ -425,7 +425,7 @@ declare class Cart {
|
|
|
425
425
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
426
426
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
427
427
|
* @name removeCoupon
|
|
428
|
-
* @summary: Remove a coupon from the cart
|
|
428
|
+
* @summary: Remove a coupon from the cart
|
|
429
429
|
* @description: Remove a coupon from the items in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
|
|
430
430
|
*/
|
|
431
431
|
removeCoupon({ uid, buyNow, requestHeaders }?: CartPlatformApplicationValidator.RemoveCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
@@ -437,7 +437,7 @@ declare class Cart {
|
|
|
437
437
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
438
438
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
439
439
|
* @name removePriceAdjustment
|
|
440
|
-
* @summary: Remove price adjustments
|
|
440
|
+
* @summary: Remove price adjustments
|
|
441
441
|
* @description: Remove price adjustments applied to items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
|
|
442
442
|
*/
|
|
443
443
|
removePriceAdjustment({ id, requestHeaders }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
@@ -457,7 +457,7 @@ declare class Cart {
|
|
|
457
457
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
458
458
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
459
459
|
* @name selectPaymentMode
|
|
460
|
-
* @summary: Select a payment mode
|
|
460
|
+
* @summary: Select a payment mode
|
|
461
461
|
* @description: Choose a payment mode for cart checkout. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
|
|
462
462
|
*/
|
|
463
463
|
selectPaymentMode({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
@@ -467,7 +467,7 @@ declare class Cart {
|
|
|
467
467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
468
468
|
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
469
469
|
* @name selectPaymentModeV2
|
|
470
|
-
* @summary: Select a payment mode v2
|
|
470
|
+
* @summary: Select a payment mode v2
|
|
471
471
|
* @description: Choose a payment mode for cart checkout in the updated platform integration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentModeV2/).
|
|
472
472
|
*/
|
|
473
473
|
selectPaymentModeV2({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
@@ -477,7 +477,7 @@ declare class Cart {
|
|
|
477
477
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
478
478
|
* @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
|
|
479
479
|
* @name updateAddress
|
|
480
|
-
* @summary: Update address
|
|
480
|
+
* @summary: Update address
|
|
481
481
|
* @description: Modify the shipping address for an order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
482
482
|
*/
|
|
483
483
|
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateAddressResponse>;
|
|
@@ -487,7 +487,7 @@ declare class Cart {
|
|
|
487
487
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
488
488
|
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
489
489
|
* @name updateCart
|
|
490
|
-
* @summary: Update cart items
|
|
490
|
+
* @summary: Update cart items
|
|
491
491
|
* @description: Modify items and their quantities in the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCart/).
|
|
492
492
|
*/
|
|
493
493
|
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
@@ -497,7 +497,7 @@ declare class Cart {
|
|
|
497
497
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
498
498
|
* @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
|
|
499
499
|
* @name updateCartMeta
|
|
500
|
-
* @summary: Update cart metadata
|
|
500
|
+
* @summary: Update cart metadata
|
|
501
501
|
* @description: Modify the metadata associated with the shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMeta/).
|
|
502
502
|
*/
|
|
503
503
|
updateCartMeta({ body, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaResponse>;
|
|
@@ -509,7 +509,7 @@ declare class Cart {
|
|
|
509
509
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
510
510
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
511
511
|
* @name updateCartMetaConfig
|
|
512
|
-
* @summary: Update cart metadata configuration
|
|
512
|
+
* @summary: Update cart metadata configuration
|
|
513
513
|
* @description: Modify the configuration settings for cart metadata. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
514
514
|
*/
|
|
515
515
|
updateCartMetaConfig({ cartMetaId, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigUpdate>;
|
|
@@ -519,7 +519,7 @@ declare class Cart {
|
|
|
519
519
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
520
520
|
* @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
|
|
521
521
|
* @name updateCartUser
|
|
522
|
-
* @summary: Update cart user details
|
|
522
|
+
* @summary: Update cart user details
|
|
523
523
|
* @description: Modify user-related details for a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
|
|
524
524
|
*/
|
|
525
525
|
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.UserCartMappingResponse>;
|
|
@@ -531,7 +531,7 @@ declare class Cart {
|
|
|
531
531
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
532
532
|
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
533
533
|
* @name updateCartWithSharedItems
|
|
534
|
-
* @summary: Update cart with shared items
|
|
534
|
+
* @summary: Update cart with shared items
|
|
535
535
|
* @description: Modify your cart by adding shared items from a cart link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartWithSharedItems/).
|
|
536
536
|
*/
|
|
537
537
|
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
@@ -541,7 +541,7 @@ declare class Cart {
|
|
|
541
541
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
542
542
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
543
543
|
* @name updateCoupon
|
|
544
|
-
* @summary: Update a coupon
|
|
544
|
+
* @summary: Update a coupon
|
|
545
545
|
* @description: Modify the details and settings of an existing coupon in the cart system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCoupon/).
|
|
546
546
|
*/
|
|
547
547
|
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
@@ -553,7 +553,7 @@ declare class Cart {
|
|
|
553
553
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
554
554
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
555
555
|
* @name updateCouponPartially
|
|
556
|
-
* @summary: Partially update a coupon
|
|
556
|
+
* @summary: Partially update a coupon
|
|
557
557
|
* @description: Make partial modifications to the settings of an existing coupon in the cart system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCouponPartially/).
|
|
558
558
|
*/
|
|
559
559
|
updateCouponPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
@@ -565,7 +565,7 @@ declare class Cart {
|
|
|
565
565
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
566
566
|
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
567
567
|
* @name updatePriceAdjustment
|
|
568
|
-
* @summary: Update price adjustments
|
|
568
|
+
* @summary: Update price adjustments
|
|
569
569
|
* @description: Modify price adjustments for items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
570
570
|
*/
|
|
571
571
|
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
@@ -575,7 +575,7 @@ declare class Cart {
|
|
|
575
575
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
576
576
|
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
577
577
|
* @name updatePromotion
|
|
578
|
-
* @summary: Update a promotion
|
|
578
|
+
* @summary: Update a promotion
|
|
579
579
|
* @description: Modify the details and settings of an existing promotion in the cart system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotion/).
|
|
580
580
|
*/
|
|
581
581
|
updatePromotion({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
@@ -587,7 +587,7 @@ declare class Cart {
|
|
|
587
587
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
588
588
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
589
589
|
* @name updatePromotionPartially
|
|
590
|
-
* @summary: Partially update a promotion
|
|
590
|
+
* @summary: Partially update a promotion
|
|
591
591
|
* @description: Make partial modifications to the settings of an existing promotion in the cart system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotionPartially/).
|
|
592
592
|
*/
|
|
593
593
|
updatePromotionPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
@@ -598,7 +598,7 @@ declare class Cart {
|
|
|
598
598
|
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
599
599
|
* Success response
|
|
600
600
|
* @name updateShipments
|
|
601
|
-
* @summary: Update shipment details
|
|
601
|
+
* @summary: Update shipment details
|
|
602
602
|
* @description: Modify the details and settings of cart shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateShipments/).
|
|
603
603
|
*/
|
|
604
604
|
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
@@ -610,7 +610,7 @@ declare class Cart {
|
|
|
610
610
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
611
611
|
* @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
|
|
612
612
|
* @name validateCouponForPayment
|
|
613
|
-
* @summary: Validate a coupon for payment
|
|
613
|
+
* @summary: Validate a coupon for payment
|
|
614
614
|
* @description: Verify the validity of a coupon code for the payment process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/validateCouponForPayment/).
|
|
615
615
|
*/
|
|
616
616
|
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, requestHeaders, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PaymentCouponValidate>;
|