@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- 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 +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
- package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- 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 +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- 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 +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- 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/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -7,261 +7,289 @@ declare class Cart {
|
|
|
7
7
|
* @param {CartPlatformApplicationValidator.AddAddressParam} arg - Arg object
|
|
8
8
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
9
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
|
-
* @returns {Promise<CartPlatformModel.
|
|
10
|
+
* @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
|
|
11
11
|
* @name addAddress
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Add address to an account
|
|
13
|
+
* @description: Use this API to add an address to an account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addAddress/).
|
|
14
14
|
*/
|
|
15
|
-
addAddress({ body, requestHeaders }?: CartPlatformApplicationValidator.AddAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
15
|
+
addAddress({ body, requestHeaders }?: CartPlatformApplicationValidator.AddAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.SaveAddressResponse>;
|
|
16
16
|
/**
|
|
17
17
|
* @param {CartPlatformApplicationValidator.AddItemsParam} arg - Arg object
|
|
18
18
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
19
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
-
* @returns {Promise<CartPlatformModel.
|
|
20
|
+
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
21
21
|
* @name addItems
|
|
22
|
-
* @summary: Add items to cart
|
|
23
|
-
* @description:
|
|
22
|
+
* @summary: Add items to abandoned cart
|
|
23
|
+
* @description: Use this API to add items to the abandoned cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addItems/).
|
|
24
24
|
*/
|
|
25
|
-
addItems({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.AddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
25
|
+
addItems({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.AddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
26
26
|
/**
|
|
27
27
|
* @param {CartPlatformApplicationValidator.AddPriceAdjustmentParam} arg - Arg object
|
|
28
28
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
29
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
|
-
* @returns {Promise<CartPlatformModel.
|
|
30
|
+
* @returns {Promise<CartPlatformModel.AddPriceAdjustmentResponse>} - Success response
|
|
31
31
|
* @name addPriceAdjustment
|
|
32
|
-
* @summary: Create price
|
|
33
|
-
* @description: Create
|
|
32
|
+
* @summary: Create new price adjustment
|
|
33
|
+
* @description: Create new price adjustment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addPriceAdjustment/).
|
|
34
34
|
*/
|
|
35
|
-
addPriceAdjustment({ body, requestHeaders }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
35
|
+
addPriceAdjustment({ body, requestHeaders }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddPriceAdjustmentResponse>;
|
|
36
36
|
/**
|
|
37
37
|
* @param {CartPlatformApplicationValidator.ApplyCouponParam} arg - Arg object
|
|
38
38
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
39
39
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
|
-
* @returns {Promise<CartPlatformModel.
|
|
40
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
41
41
|
* @name applyCoupon
|
|
42
|
-
* @summary: Apply coupon
|
|
43
|
-
* @description: Apply a coupon
|
|
42
|
+
* @summary: Apply a coupon to the cart.
|
|
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
|
-
applyCoupon({ body, i, b, p, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.ApplyCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
45
|
+
applyCoupon({ body, i, b, p, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.ApplyCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
46
46
|
/**
|
|
47
47
|
* @param {CartPlatformApplicationValidator.CheckCartServiceabilityParam} arg
|
|
48
48
|
* - Arg object
|
|
49
49
|
*
|
|
50
50
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
51
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
52
|
-
* @returns {Promise<CartPlatformModel.
|
|
53
|
-
* Success response
|
|
52
|
+
* @returns {Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>}
|
|
53
|
+
* - Success response
|
|
54
|
+
*
|
|
54
55
|
* @name checkCartServiceability
|
|
55
56
|
* @summary: Check cart serviceability
|
|
56
57
|
* @description: Verify the serviceability of items in the cart at a specific pin code and ensure accurate delivery promises. System checks each item's availability and delivery feasibility, providing real-time information on serviceability and estimated delivery times. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
|
|
57
58
|
*/
|
|
58
|
-
checkCartServiceability({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
59
|
+
checkCartServiceability({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>;
|
|
59
60
|
/**
|
|
60
61
|
* @param {CartPlatformApplicationValidator.CheckoutCartParam} arg - Arg object
|
|
61
62
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
62
63
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
63
|
-
* @returns {Promise<CartPlatformModel.
|
|
64
|
+
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
|
|
64
65
|
* @name checkoutCart
|
|
65
66
|
* @summary: Checkout cart
|
|
66
67
|
* @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkoutCart/).
|
|
67
68
|
*/
|
|
68
|
-
checkoutCart({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
69
|
+
checkoutCart({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCheckoutResponse>;
|
|
69
70
|
/**
|
|
70
71
|
* @param {CartPlatformApplicationValidator.CreateCartMetaConfigParam} arg
|
|
71
72
|
* - Arg object
|
|
72
73
|
*
|
|
73
74
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
74
75
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
75
|
-
* @returns {Promise<CartPlatformModel.
|
|
76
|
+
* @returns {Promise<CartPlatformModel.CartMetaConfigAddResponse>} - Success response
|
|
76
77
|
* @name createCartMetaConfig
|
|
77
|
-
* @summary: Create
|
|
78
|
+
* @summary: Create new cart meta configuration
|
|
78
79
|
* @description: Create custom meta configurations for carts associated with a specific sales channel. By specifying the company ID and application ID, seller can define unique cart settings, including preferences, rules, and constraints, tailored to their business needs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCartMetaConfig/).
|
|
79
80
|
*/
|
|
80
|
-
createCartMetaConfig({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
81
|
+
createCartMetaConfig({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAddResponse>;
|
|
81
82
|
/**
|
|
82
83
|
* @param {CartPlatformApplicationValidator.CreateCouponParam} arg - Arg object
|
|
83
84
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
84
85
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
85
|
-
* @returns {Promise<CartPlatformModel.
|
|
86
|
+
* @returns {Promise<CartPlatformModel.CouponDetailResponse>} - Success response
|
|
86
87
|
* @name createCoupon
|
|
87
|
-
* @summary: Create a coupon
|
|
88
|
-
* @description:
|
|
88
|
+
* @summary: Create a new coupon.
|
|
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/).
|
|
89
90
|
*/
|
|
90
|
-
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
91
|
+
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponDetailResponse>;
|
|
91
92
|
/**
|
|
92
93
|
* @param {CartPlatformApplicationValidator.CreatePromotionParam} arg - Arg object
|
|
93
94
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
94
95
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
95
|
-
* @returns {Promise<CartPlatformModel.
|
|
96
|
+
* @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
|
|
96
97
|
* @name createPromotion
|
|
97
98
|
* @summary: Create a promotion
|
|
98
99
|
* @description: Creates a new promotion based on the selected promotion type. Sellers can choose from multiple supported promotion types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable promotion criteria to meet specific business requirements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createPromotion/).
|
|
99
100
|
*/
|
|
100
|
-
createPromotion({ body, requestHeaders }?: CartPlatformApplicationValidator.CreatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
101
|
+
createPromotion({ body, requestHeaders }?: CartPlatformApplicationValidator.CreatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionAdd>;
|
|
101
102
|
/**
|
|
102
103
|
* @param {CartPlatformApplicationValidator.DeleteCartParam} arg - Arg object
|
|
103
104
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
104
105
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
105
|
-
* @returns {Promise<CartPlatformModel.
|
|
106
|
+
* @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
|
|
106
107
|
* @name deleteCart
|
|
107
|
-
* @summary: Delete
|
|
108
|
-
* @description:
|
|
109
|
-
*/
|
|
110
|
-
deleteCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteCartDetailResult>;
|
|
111
|
-
/**
|
|
112
|
-
* @param {CartPlatformApplicationValidator.DeleteCouponParam} arg - Arg object
|
|
113
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
114
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
115
|
-
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
116
|
-
* @name deleteCoupon
|
|
117
|
-
* @summary: Delete a coupon which is in draft state
|
|
118
|
-
* @description: Delete details of a draft coupon by providing its unique identifier to delete information such as coupon type, rules, validity period and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCoupon/).
|
|
108
|
+
* @summary: Delete cart once user made successful checkout
|
|
109
|
+
* @description: Use this API to delete the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
|
|
119
110
|
*/
|
|
120
|
-
|
|
111
|
+
deleteCart({ body, id, cartType, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteCartDetailResponse>;
|
|
121
112
|
/**
|
|
122
|
-
* @param {CartPlatformApplicationValidator.
|
|
113
|
+
* @param {CartPlatformApplicationValidator.DeleteCartMetaConfigParam} arg
|
|
114
|
+
* - Arg object
|
|
115
|
+
*
|
|
123
116
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
124
117
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
125
118
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
126
|
-
* @name
|
|
127
|
-
* @summary: Delete
|
|
128
|
-
* @description: Delete
|
|
119
|
+
* @name deleteCartMetaConfig
|
|
120
|
+
* @summary: Delete cart meta configuration
|
|
121
|
+
* @description: Delete cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCartMetaConfig/).
|
|
129
122
|
*/
|
|
130
|
-
|
|
123
|
+
deleteCartMetaConfig({ cartMetaId, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
131
124
|
/**
|
|
132
125
|
* @param {CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam} arg
|
|
133
126
|
* - Arg object
|
|
134
127
|
*
|
|
135
128
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
136
129
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
137
|
-
* @returns {Promise<CartPlatformModel.
|
|
130
|
+
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
|
|
138
131
|
* @name fetchAndvalidateCartItems
|
|
139
132
|
* @summary: Get and validate cart items
|
|
140
133
|
* @description: Retrieve cart details for a provided list of cart items and validate its contents. This ensures accuracy and completeness in cart information, including item quantities, prices, discounts, and applicable taxes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
|
|
141
134
|
*/
|
|
142
|
-
fetchAndvalidateCartItems({ body, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
143
|
-
/**
|
|
144
|
-
* @param {CartPlatformApplicationValidator.FetchCartMetaConfigParam} arg - Arg object
|
|
145
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
146
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
147
|
-
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
148
|
-
* @name fetchCartMetaConfig
|
|
149
|
-
* @summary: Get cart meta
|
|
150
|
-
* @description: Retrieve meta configuration settings tailored for customizing the cart experience within a specific sales channel. Cart meta includes configuration settings such as allowed maximum cart value, allowed minimum cart value, maximum allowed cart items, delivery charges, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchCartMetaConfig/).
|
|
151
|
-
*/
|
|
152
|
-
fetchCartMetaConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAdd>;
|
|
135
|
+
fetchAndvalidateCartItems({ body, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenapiCartDetailsResponse>;
|
|
153
136
|
/**
|
|
154
137
|
* @param {CartPlatformApplicationValidator.GetAbandonedCartParam} arg - Arg object
|
|
155
138
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
156
139
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
157
|
-
* @returns {Promise<CartPlatformModel.
|
|
140
|
+
* @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
|
|
158
141
|
* @name getAbandonedCart
|
|
159
142
|
* @summary: Get abandoned carts
|
|
160
143
|
* @description: Retrieve the list of abandoned carts that have been active for the specified period of time and have not yet been archived for the specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCart/).
|
|
161
144
|
*/
|
|
162
|
-
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
145
|
+
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.AbandonedCartResponse>;
|
|
146
|
+
/**
|
|
147
|
+
* @param {Object} arg - Arg object.
|
|
148
|
+
* @param {string} arg.companyId - Current company id
|
|
149
|
+
* @param {string} arg.applicationId - Current Application _id
|
|
150
|
+
* @param {number} [arg.pageSize] -
|
|
151
|
+
* @param {string} [arg.fromDate] -
|
|
152
|
+
* @param {string} [arg.toDate] -
|
|
153
|
+
* @param {boolean} [arg.anonymousCart] -
|
|
154
|
+
* @param {string} [arg.lastId] -
|
|
155
|
+
* @param {string} [arg.sortOn] -
|
|
156
|
+
* @returns {Paginator<CartPlatformModel.AbandonedCartResponse>}
|
|
157
|
+
* @summary: Get abandoned carts
|
|
158
|
+
* @description: Retrieve the list of abandoned carts that have been active for the specified period of time and have not yet been archived for the specific sales channel.
|
|
159
|
+
*/
|
|
160
|
+
getAbandonedCartPaginator({ companyId, applicationId, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, }?: {
|
|
161
|
+
companyId: string;
|
|
162
|
+
applicationId: string;
|
|
163
|
+
pageSize?: number;
|
|
164
|
+
fromDate?: string;
|
|
165
|
+
toDate?: string;
|
|
166
|
+
anonymousCart?: boolean;
|
|
167
|
+
lastId?: string;
|
|
168
|
+
sortOn?: string;
|
|
169
|
+
}): Paginator<CartPlatformModel.AbandonedCartResponse>;
|
|
163
170
|
/**
|
|
164
171
|
* @param {CartPlatformApplicationValidator.GetAbandonedCartDetailsParam} arg
|
|
165
172
|
* - Arg object
|
|
166
173
|
*
|
|
167
174
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
168
175
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
169
|
-
* @returns {Promise<CartPlatformModel.
|
|
176
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
170
177
|
* @name getAbandonedCartDetails
|
|
171
178
|
* @summary: Get abandoned cart details
|
|
172
179
|
* @description: Retrieves abandoned cart details linked to a specific customer using a unique cart ID. It offers an overview of the items, quantities, prices, and other relevant information associated with the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCartDetails/).
|
|
173
180
|
*/
|
|
174
|
-
getAbandonedCartDetails({ id, i, b, c, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
181
|
+
getAbandonedCartDetails({ id, i, b, c, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
175
182
|
/**
|
|
176
183
|
* @param {CartPlatformApplicationValidator.GetAddressByIdParam} arg - Arg object
|
|
177
184
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
178
185
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
186
|
* @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
|
|
180
187
|
* @name getAddressById
|
|
181
|
-
* @summary:
|
|
182
|
-
* @description:
|
|
188
|
+
* @summary: Fetch a single address by its ID
|
|
189
|
+
* @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `PlatformAddress`. Attibutes listed below are optional mobile_no checkout_mode tags default - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddressById/).
|
|
183
190
|
*/
|
|
184
191
|
getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformAddress>;
|
|
185
192
|
/**
|
|
186
193
|
* @param {CartPlatformApplicationValidator.GetAddressesParam} arg - Arg object
|
|
187
194
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
188
195
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
189
|
-
* @returns {Promise<CartPlatformModel.
|
|
196
|
+
* @returns {Promise<CartPlatformModel.PlatformGetAddressesResponse>} -
|
|
190
197
|
* Success response
|
|
191
198
|
* @name getAddresses
|
|
192
|
-
* @summary:
|
|
193
|
-
* @description:
|
|
199
|
+
* @summary: Fetch address
|
|
200
|
+
* @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional uid address_id mobile_no checkout_mode tags default - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddresses/).
|
|
194
201
|
*/
|
|
195
|
-
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressesParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
202
|
+
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressesParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformGetAddressesResponse>;
|
|
196
203
|
/**
|
|
197
204
|
* @param {CartPlatformApplicationValidator.GetAppCouponsParam} arg - Arg object
|
|
198
205
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
199
206
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
200
|
-
* @returns {Promise<CartPlatformModel.
|
|
207
|
+
* @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
|
|
201
208
|
* @name getAppCoupons
|
|
202
|
-
* @summary: List
|
|
209
|
+
* @summary: List coupons
|
|
203
210
|
* @description: Retrieve a list of all available coupons that customer can apply to their carts. It provides details about each coupon, including its code, discount amount, and applicable conditions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
|
|
204
211
|
*/
|
|
205
|
-
getAppCoupons({ id, buyNow, slug, storeId, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
212
|
+
getAppCoupons({ id, buyNow, slug, storeId, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResponse>;
|
|
206
213
|
/**
|
|
207
214
|
* @param {CartPlatformApplicationValidator.GetAvailableDeliveryModesParam} arg
|
|
208
215
|
* - Arg object
|
|
209
216
|
*
|
|
210
217
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
211
218
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
212
|
-
* @returns {Promise<CartPlatformModel.
|
|
219
|
+
* @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
|
|
213
220
|
* @name getAvailableDeliveryModes
|
|
214
221
|
* @summary: Get delivery modes
|
|
215
222
|
* @description: Retrieve a list of delivery modes (home delivery/store pickup) along with a list of available pickup stores for a given cart at a specified PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAvailableDeliveryModes/).
|
|
216
223
|
*/
|
|
217
|
-
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
224
|
+
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDeliveryModesResponse>;
|
|
218
225
|
/**
|
|
219
226
|
* @param {CartPlatformApplicationValidator.GetCartParam} arg - Arg object
|
|
220
227
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
221
228
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
222
|
-
* @returns {Promise<CartPlatformModel.
|
|
229
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
223
230
|
* @name getCart
|
|
224
|
-
* @summary:
|
|
225
|
-
* @description:
|
|
231
|
+
* @summary: Fetch all items added to the customer cart using cart id
|
|
232
|
+
* @description: Use this API to get details of all the items added to a cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
|
|
226
233
|
*/
|
|
227
|
-
getCart({ id, userId,
|
|
234
|
+
getCart({ id, userId, i, b, assignCardId, buyNow, cartType, requestHeaders }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
228
235
|
/**
|
|
229
236
|
* @param {CartPlatformApplicationValidator.GetCartListParam} arg - Arg object
|
|
230
237
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
231
238
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
232
|
-
* @returns {Promise<CartPlatformModel.
|
|
239
|
+
* @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
|
|
233
240
|
* @name getCartList
|
|
234
|
-
* @summary:
|
|
235
|
-
* @description:
|
|
241
|
+
* @summary: Get cart list for store os user
|
|
242
|
+
* @description: Get all carts for the store os user which is created for customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
|
|
243
|
+
*/
|
|
244
|
+
getCartList({ fromDate, toDate, filterOn, requestHeaders }?: CartPlatformApplicationValidator.GetCartListParam, { responseHeaders }?: object): Promise<CartPlatformModel.MultiCartResponse>;
|
|
245
|
+
/**
|
|
246
|
+
* @param {CartPlatformApplicationValidator.GetCartMetaConfigParam} arg - Arg object
|
|
247
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
248
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
249
|
+
* @returns {Promise<CartPlatformModel.CartMetaConfigDetailResponse>} -
|
|
250
|
+
* Success response
|
|
251
|
+
* @name getCartMetaConfig
|
|
252
|
+
* @summary: Get cart meta configuration by id
|
|
253
|
+
* @description: Get cart meta configuration by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartMetaConfig/).
|
|
236
254
|
*/
|
|
237
|
-
|
|
255
|
+
getCartMetaConfig({ cartMetaId, requestHeaders }?: CartPlatformApplicationValidator.GetCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigDetailResponse>;
|
|
256
|
+
/**
|
|
257
|
+
* @param {CartPlatformApplicationValidator.GetCartMetaConfigsParam} arg - Arg object
|
|
258
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
259
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
260
|
+
* @returns {Promise<CartPlatformModel.CartMetaConfigListResponse>} - Success response
|
|
261
|
+
* @name getCartMetaConfigs
|
|
262
|
+
* @summary: Fetch cart meta configuration
|
|
263
|
+
* @description: Fetch cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartMetaConfigs/).
|
|
264
|
+
*/
|
|
265
|
+
getCartMetaConfigs({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigListResponse>;
|
|
238
266
|
/**
|
|
239
267
|
* @param {CartPlatformApplicationValidator.GetCartShareLinkParam} arg - Arg object
|
|
240
268
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
241
269
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
242
|
-
* @returns {Promise<CartPlatformModel.
|
|
270
|
+
* @returns {Promise<CartPlatformModel.GetShareCartLinkResponse>} - Success response
|
|
243
271
|
* @name getCartShareLink
|
|
244
272
|
* @summary: Share cart link
|
|
245
273
|
* @description: Generate a unique shareable link for the customer's cart for a specific sales channel. This link enables easy sharing of the cart contents with other users, facilitating collaborative shopping experiences. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartShareLink/).
|
|
246
274
|
*/
|
|
247
|
-
getCartShareLink({ body, requestHeaders }?: CartPlatformApplicationValidator.GetCartShareLinkParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
275
|
+
getCartShareLink({ body, requestHeaders }?: CartPlatformApplicationValidator.GetCartShareLinkParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetShareCartLinkResponse>;
|
|
248
276
|
/**
|
|
249
277
|
* @param {CartPlatformApplicationValidator.GetCartSharedItemsParam} arg - Arg object
|
|
250
278
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
251
279
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
252
|
-
* @returns {Promise<CartPlatformModel.
|
|
280
|
+
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
253
281
|
* @name getCartSharedItems
|
|
254
|
-
* @summary:
|
|
255
|
-
* @description:
|
|
282
|
+
* @summary: Get details of a shared cart
|
|
283
|
+
* @description: Use this API to get the shared cart details as per the token generated using the share-cart API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartSharedItems/).
|
|
256
284
|
*/
|
|
257
|
-
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
285
|
+
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
258
286
|
/**
|
|
259
287
|
* @param {CartPlatformApplicationValidator.GetCouponByIdParam} arg - Arg object
|
|
260
288
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
261
289
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
290
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
263
291
|
* @name getCouponById
|
|
264
|
-
* @summary: Get
|
|
292
|
+
* @summary: Get coupon details by ID
|
|
265
293
|
* @description: Retrieve details of a specific coupon by providing its unique identifier to obtain information such as coupon type, rules, validity period and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponById/).
|
|
266
294
|
*/
|
|
267
295
|
getCouponById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetCouponByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponUpdate>;
|
|
@@ -271,8 +299,8 @@ declare class Cart {
|
|
|
271
299
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
272
300
|
* @returns {Promise<Object>} - Success response
|
|
273
301
|
* @name getCouponCodeExists
|
|
274
|
-
* @summary: Check coupon code
|
|
275
|
-
* @description:
|
|
302
|
+
* @summary: Check if coupon is already created with coupon code
|
|
303
|
+
* @description: Check if sent coupon code is already existing coupon code. As coupon code is to be unique. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
|
|
276
304
|
*/
|
|
277
305
|
getCouponCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
278
306
|
/**
|
|
@@ -281,64 +309,100 @@ declare class Cart {
|
|
|
281
309
|
*
|
|
282
310
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
283
311
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
284
|
-
* @returns {Promise<
|
|
312
|
+
* @returns {Promise<CartPlatformModel.CouponOptions>} - Success response
|
|
285
313
|
* @name getCouponOptionValues
|
|
286
|
-
* @summary: Get coupon
|
|
287
|
-
* @description:
|
|
314
|
+
* @summary: Get coupon options enums with display values
|
|
315
|
+
* @description: Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
|
|
288
316
|
*/
|
|
289
|
-
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<
|
|
317
|
+
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CartPlatformModel.CouponOptions>;
|
|
318
|
+
/**
|
|
319
|
+
* @param {CartPlatformApplicationValidator.GetCouponTagsParam} arg - Arg object
|
|
320
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
321
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
322
|
+
* @returns {Promise<CartPlatformModel.TagsViewResponse>} - Success response
|
|
323
|
+
* @name getCouponTags
|
|
324
|
+
* @summary: Get a list of all coupon tags associated with a application.
|
|
325
|
+
* @description: This API helps to get coupon tags data associated to a particular application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponTags/).
|
|
326
|
+
*/
|
|
327
|
+
getCouponTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CartPlatformModel.TagsViewResponse>;
|
|
290
328
|
/**
|
|
291
329
|
* @param {CartPlatformApplicationValidator.GetCouponsParam} arg - Arg object
|
|
292
330
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
293
331
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
294
|
-
* @returns {Promise<CartPlatformModel.
|
|
332
|
+
* @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
|
|
295
333
|
* @name getCoupons
|
|
296
|
-
* @summary:
|
|
297
|
-
* @description: Retrieve a list of
|
|
298
|
-
*/
|
|
299
|
-
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code,
|
|
334
|
+
* @summary: Retrieve available coupons.
|
|
335
|
+
* @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/).
|
|
336
|
+
*/
|
|
337
|
+
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, requestHeaders, }?: CartPlatformApplicationValidator.GetCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponsResponse>;
|
|
338
|
+
/**
|
|
339
|
+
* @param {Object} arg - Arg object.
|
|
340
|
+
* @param {string} arg.companyId - Current company id
|
|
341
|
+
* @param {string} arg.applicationId - Current Application _id
|
|
342
|
+
* @param {number} [arg.pageSize] -
|
|
343
|
+
* @param {boolean} [arg.isArchived] -
|
|
344
|
+
* @param {string} [arg.title] -
|
|
345
|
+
* @param {boolean} [arg.isPublic] -
|
|
346
|
+
* @param {boolean} [arg.isDisplay] -
|
|
347
|
+
* @param {string} [arg.typeSlug] -
|
|
348
|
+
* @param {string} [arg.code] -
|
|
349
|
+
* @returns {Paginator<CartPlatformModel.CouponsResponse>}
|
|
350
|
+
* @summary: Retrieve available coupons.
|
|
351
|
+
* @description: Retrieve a list of available coupons for use in the shopping cart.
|
|
352
|
+
*/
|
|
353
|
+
getCouponsPaginator({ companyId, applicationId, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, }?: {
|
|
354
|
+
companyId: string;
|
|
355
|
+
applicationId: string;
|
|
356
|
+
pageSize?: number;
|
|
357
|
+
isArchived?: boolean;
|
|
358
|
+
title?: string;
|
|
359
|
+
isPublic?: boolean;
|
|
360
|
+
isDisplay?: boolean;
|
|
361
|
+
typeSlug?: string;
|
|
362
|
+
code?: string;
|
|
363
|
+
}): Paginator<CartPlatformModel.CouponsResponse>;
|
|
300
364
|
/**
|
|
301
365
|
* @param {CartPlatformApplicationValidator.GetItemCountParam} arg - Arg object
|
|
302
366
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
367
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
304
|
-
* @returns {Promise<CartPlatformModel.
|
|
368
|
+
* @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
|
|
305
369
|
* @name getItemCount
|
|
306
|
-
* @summary:
|
|
307
|
-
* @description:
|
|
370
|
+
* @summary: Count items in the customer's cart
|
|
371
|
+
* @description: Use this API to get the total number of items present in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getItemCount/).
|
|
308
372
|
*/
|
|
309
|
-
getItemCount({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
373
|
+
getItemCount({ id, buyNow, cartType, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartItemCountResponse>;
|
|
310
374
|
/**
|
|
311
375
|
* @param {CartPlatformApplicationValidator.GetPriceAdjustmentsParam} arg - Arg object
|
|
312
376
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
313
377
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
314
|
-
* @returns {Promise<CartPlatformModel.
|
|
378
|
+
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
315
379
|
* @name getPriceAdjustments
|
|
316
380
|
* @summary: Get a list of all price adjustments associated with a cart
|
|
317
381
|
* @description: This API helps to get price adjustments data associated to a particular cart - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPriceAdjustments/).
|
|
318
382
|
*/
|
|
319
|
-
getPriceAdjustments({ cartId, requestHeaders }?: CartPlatformApplicationValidator.GetPriceAdjustmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
383
|
+
getPriceAdjustments({ cartId, requestHeaders }?: CartPlatformApplicationValidator.GetPriceAdjustmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
320
384
|
/**
|
|
321
385
|
* @param {CartPlatformApplicationValidator.GetPromosCouponConfigParam} arg
|
|
322
386
|
* - Arg object
|
|
323
387
|
*
|
|
324
388
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
389
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
326
|
-
* @returns {Promise<CartPlatformModel.
|
|
390
|
+
* @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
|
|
327
391
|
* @name getPromosCouponConfig
|
|
328
392
|
* @summary: Get promotion and coupon type
|
|
329
393
|
* @description: Retrieve the configuration settings related to promotions and coupons for a specific seller. It provides details of the supported types of coupons and promotions along with their descriptions, examples, and related attributes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromosCouponConfig/).
|
|
330
394
|
*/
|
|
331
|
-
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
395
|
+
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.ActivePromosResponse>;
|
|
332
396
|
/**
|
|
333
397
|
* @param {CartPlatformApplicationValidator.GetPromotionByIdParam} arg - Arg object
|
|
334
398
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
335
399
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
336
|
-
* @returns {Promise<CartPlatformModel.
|
|
400
|
+
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
337
401
|
* @name getPromotionById
|
|
338
|
-
* @summary: Get a
|
|
402
|
+
* @summary: Get a promotion
|
|
339
403
|
* @description: Retrieve details of a specific promotion by providing its unique identifier to obtain information such as promotion type, rules, validity period and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionById/).
|
|
340
404
|
*/
|
|
341
|
-
getPromotionById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
405
|
+
getPromotionById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
342
406
|
/**
|
|
343
407
|
* @param {CartPlatformApplicationValidator.GetPromotionCodeExistsParam} arg
|
|
344
408
|
* - Arg object
|
|
@@ -347,140 +411,153 @@ declare class Cart {
|
|
|
347
411
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
348
412
|
* @returns {Promise<Object>} - Success response
|
|
349
413
|
* @name getPromotionCodeExists
|
|
350
|
-
* @summary: Check promotion code
|
|
351
|
-
* @description:
|
|
414
|
+
* @summary: Check if promotion is already created with promotion code
|
|
415
|
+
* @description: Check if sent promotion code is already existing promotion code. As promotion code is to be unique. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
|
|
352
416
|
*/
|
|
353
417
|
getPromotionCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
354
418
|
/**
|
|
355
|
-
* @param {CartPlatformApplicationValidator.
|
|
419
|
+
* @param {CartPlatformApplicationValidator.GetPromotionTagsParam} arg - Arg object
|
|
356
420
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
357
421
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
358
|
-
* @returns {Promise<CartPlatformModel.
|
|
359
|
-
* @name
|
|
360
|
-
* @summary:
|
|
361
|
-
* @description:
|
|
422
|
+
* @returns {Promise<CartPlatformModel.TagsViewResponse>} - Success response
|
|
423
|
+
* @name getPromotionTags
|
|
424
|
+
* @summary: Get a list of all Promotion tags associated with a application.
|
|
425
|
+
* @description: This API helps to get Promotion tags data associated to a particular application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionTags/).
|
|
362
426
|
*/
|
|
363
|
-
|
|
364
|
-
/**
|
|
365
|
-
* @param {CartPlatformApplicationValidator.GetPromotionPaymentOffersParam} arg
|
|
366
|
-
* - Arg object
|
|
367
|
-
*
|
|
368
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
369
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
370
|
-
* @returns {Promise<CartPlatformModel.PromotionPaymentOffersDetails>} -
|
|
371
|
-
* Success response
|
|
372
|
-
* @name getPromotionPaymentOffers
|
|
373
|
-
* @summary: Fetch available promotions payment offers
|
|
374
|
-
* @description: Use this API to get top 5 payment offers available for current product - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionPaymentOffers/).
|
|
375
|
-
*/
|
|
376
|
-
getPromotionPaymentOffers({ id, uid, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionPaymentOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionPaymentOffersDetails>;
|
|
427
|
+
getPromotionTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CartPlatformModel.TagsViewResponse>;
|
|
377
428
|
/**
|
|
378
429
|
* @param {CartPlatformApplicationValidator.GetPromotionsParam} arg - Arg object
|
|
379
430
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
380
431
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
381
|
-
* @returns {Promise<CartPlatformModel.
|
|
432
|
+
* @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
|
|
382
433
|
* @name getPromotions
|
|
383
|
-
* @summary: List
|
|
434
|
+
* @summary: List promotions
|
|
384
435
|
* @description: Retrieve a list of all created promotions for specific sales channel. It also supports efficient text search and pagination functionalities, ensuring optimized promotion listing for streamlined navigation and management. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotions/).
|
|
385
436
|
*/
|
|
386
|
-
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId,
|
|
437
|
+
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionsResponse>;
|
|
438
|
+
/**
|
|
439
|
+
* @param {Object} arg - Arg object.
|
|
440
|
+
* @param {string} arg.companyId - Current company id
|
|
441
|
+
* @param {string} arg.applicationId - Current Application _id
|
|
442
|
+
* @param {number} [arg.pageSize] -
|
|
443
|
+
* @param {string} [arg.q] -
|
|
444
|
+
* @param {boolean} [arg.isActive] -
|
|
445
|
+
* @param {string} [arg.promoGroup] -
|
|
446
|
+
* @param {string} [arg.promotionType] -
|
|
447
|
+
* @param {string} [arg.fpPanel] -
|
|
448
|
+
* @param {string} [arg.promotionId] -
|
|
449
|
+
* @returns {Paginator<CartPlatformModel.PromotionsResponse>}
|
|
450
|
+
* @summary: List promotions
|
|
451
|
+
* @description: Retrieve a list of all created promotions for specific sales channel. It also supports efficient text search and pagination functionalities, ensuring optimized promotion listing for streamlined navigation and management.
|
|
452
|
+
*/
|
|
453
|
+
getPromotionsPaginator({ companyId, applicationId, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, }?: {
|
|
454
|
+
companyId: string;
|
|
455
|
+
applicationId: string;
|
|
456
|
+
pageSize?: number;
|
|
457
|
+
q?: string;
|
|
458
|
+
isActive?: boolean;
|
|
459
|
+
promoGroup?: string;
|
|
460
|
+
promotionType?: string;
|
|
461
|
+
fpPanel?: string;
|
|
462
|
+
promotionId?: string;
|
|
463
|
+
}): Paginator<CartPlatformModel.PromotionsResponse>;
|
|
387
464
|
/**
|
|
388
465
|
* @param {CartPlatformApplicationValidator.GetShipmentsParam} arg - Arg object
|
|
389
466
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
390
467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
391
|
-
* @returns {Promise<CartPlatformModel.
|
|
468
|
+
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
392
469
|
* Success response
|
|
393
470
|
* @name getShipments
|
|
394
471
|
* @summary: Get shipments details
|
|
395
472
|
* @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getShipments/).
|
|
396
473
|
*/
|
|
397
|
-
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, requestHeaders, }?: CartPlatformApplicationValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
474
|
+
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, requestHeaders, }?: CartPlatformApplicationValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
398
475
|
/**
|
|
399
476
|
* @param {CartPlatformApplicationValidator.GetStoreAddressByUidParam} arg
|
|
400
477
|
* - Arg object
|
|
401
478
|
*
|
|
402
479
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
403
480
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
404
|
-
* @returns {Promise<CartPlatformModel.
|
|
481
|
+
* @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
|
|
405
482
|
* @name getStoreAddressByUid
|
|
406
483
|
* @summary: Get Store Address
|
|
407
484
|
* @description: Retrieve store details by entering the unique identifier of the pickup stores. Store details include the seller's name, contact information such as email address or phone number and business address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getStoreAddressByUid/).
|
|
408
485
|
*/
|
|
409
|
-
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
486
|
+
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.StoreDetailsResponse>;
|
|
410
487
|
/**
|
|
411
488
|
* @param {CartPlatformApplicationValidator.OverrideCartParam} arg - Arg object
|
|
412
489
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
413
490
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
414
|
-
* @returns {Promise<CartPlatformModel.
|
|
491
|
+
* @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
|
|
415
492
|
* @name overrideCart
|
|
416
|
-
* @summary:
|
|
417
|
-
* @description:
|
|
493
|
+
* @summary: Create Fynd order with overriding cart details
|
|
494
|
+
* @description: Generate Fynd order while overriding cart details sent with provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
|
|
418
495
|
*/
|
|
419
|
-
overrideCart({ body, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
496
|
+
overrideCart({ body, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OverrideCheckoutResponse>;
|
|
420
497
|
/**
|
|
421
498
|
* @param {CartPlatformApplicationValidator.PlatformAddItemsParam} arg - Arg object
|
|
422
499
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
423
500
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
424
|
-
* @returns {Promise<CartPlatformModel.
|
|
501
|
+
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
425
502
|
* @name platformAddItems
|
|
426
503
|
* @summary: Add items to cart
|
|
427
504
|
* @description: Add product items to the customer's existing shopping cart. If there is no existing cart associated with the customer, it creates a new one and adds the items to it. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
|
|
428
505
|
*/
|
|
429
|
-
platformAddItems({ body, i, b, buyNow,
|
|
506
|
+
platformAddItems({ body, i, b, buyNow, id, cartType, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
430
507
|
/**
|
|
431
508
|
* @param {CartPlatformApplicationValidator.PlatformCheckoutCartParam} arg
|
|
432
509
|
* - Arg object
|
|
433
510
|
*
|
|
434
511
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
435
512
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
436
|
-
* @returns {Promise<CartPlatformModel.
|
|
513
|
+
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
437
514
|
* @name platformCheckoutCart
|
|
438
515
|
* @summary: Checkout cart
|
|
439
516
|
* @description: The checkout cart initiates the order creation process based on the selected address and payment method. It revalidates the cart details to ensure safe and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
|
|
440
517
|
*/
|
|
441
|
-
platformCheckoutCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
518
|
+
platformCheckoutCart({ body, id, cartType, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
442
519
|
/**
|
|
443
520
|
* @param {CartPlatformApplicationValidator.PlatformCheckoutCartV2Param} arg
|
|
444
521
|
* - Arg object
|
|
445
522
|
*
|
|
446
523
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
447
524
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
|
-
* @returns {Promise<CartPlatformModel.
|
|
525
|
+
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
449
526
|
* @name platformCheckoutCartV2
|
|
450
|
-
* @summary:
|
|
451
|
-
* @description:
|
|
527
|
+
* @summary: Cart checkout (latest)
|
|
528
|
+
* @description: Checkout process that supports multiple MOP(mode of payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
452
529
|
*/
|
|
453
|
-
platformCheckoutCartV2({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
530
|
+
platformCheckoutCartV2({ body, id, cartType, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
454
531
|
/**
|
|
455
532
|
* @param {CartPlatformApplicationValidator.PlatformUpdateCartParam} arg - Arg object
|
|
456
533
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
457
534
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
458
|
-
* @returns {Promise<CartPlatformModel.
|
|
535
|
+
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
459
536
|
* @name platformUpdateCart
|
|
460
537
|
* @summary: Update cart items
|
|
461
538
|
* @description: Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformUpdateCart/).
|
|
462
539
|
*/
|
|
463
|
-
platformUpdateCart({ body, id, i, orderType, b, buyNow, requestHeaders }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
540
|
+
platformUpdateCart({ body, id, i, orderType, b, buyNow, cartType, requestHeaders }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
464
541
|
/**
|
|
465
542
|
* @param {CartPlatformApplicationValidator.RemoveAddressParam} arg - Arg object
|
|
466
543
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
467
544
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
468
|
-
* @returns {Promise<CartPlatformModel.
|
|
545
|
+
* @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
|
|
469
546
|
* @name removeAddress
|
|
470
|
-
* @summary:
|
|
471
|
-
* @description:
|
|
547
|
+
* @summary: Remove address associated with an account
|
|
548
|
+
* @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
472
549
|
*/
|
|
473
|
-
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
550
|
+
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteAddressResponse>;
|
|
474
551
|
/**
|
|
475
552
|
* @param {CartPlatformApplicationValidator.RemoveCouponParam} arg - Arg object
|
|
476
553
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
477
554
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
478
|
-
* @returns {Promise<CartPlatformModel.
|
|
555
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
479
556
|
* @name removeCoupon
|
|
480
|
-
* @summary: Remove
|
|
481
|
-
* @description: Remove
|
|
557
|
+
* @summary: Remove Applied Coupon for platform pos user
|
|
558
|
+
* @description: Remove Coupon applied on the cart by passing uid in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
|
|
482
559
|
*/
|
|
483
|
-
removeCoupon({ uid, buyNow, requestHeaders }?: CartPlatformApplicationValidator.RemoveCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
560
|
+
removeCoupon({ uid, buyNow, cartType, requestHeaders }?: CartPlatformApplicationValidator.RemoveCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
484
561
|
/**
|
|
485
562
|
* @param {CartPlatformApplicationValidator.RemovePriceAdjustmentParam} arg
|
|
486
563
|
* - Arg object
|
|
@@ -489,70 +566,70 @@ declare class Cart {
|
|
|
489
566
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
490
567
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
491
568
|
* @name removePriceAdjustment
|
|
492
|
-
* @summary: Remove price adjustments
|
|
493
|
-
* @description: Remove
|
|
569
|
+
* @summary: Remove price adjustments.
|
|
570
|
+
* @description: Remove price adjustments applied to items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
|
|
494
571
|
*/
|
|
495
572
|
removePriceAdjustment({ id, requestHeaders }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
496
573
|
/**
|
|
497
574
|
* @param {CartPlatformApplicationValidator.SelectAddressParam} arg - Arg object
|
|
498
575
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
499
576
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
500
|
-
* @returns {Promise<CartPlatformModel.
|
|
577
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
501
578
|
* @name selectAddress
|
|
502
|
-
* @summary: Select
|
|
503
|
-
* @description: Select
|
|
579
|
+
* @summary: Select an address from available addresses
|
|
580
|
+
* @description: Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `PlatformSelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. address_id billing_address_id uid - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectAddress/).
|
|
504
581
|
*/
|
|
505
|
-
selectAddress({ body, cartId, buyNow, i, b, requestHeaders }?: CartPlatformApplicationValidator.SelectAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
582
|
+
selectAddress({ body, cartId, buyNow, i, b, requestHeaders }?: CartPlatformApplicationValidator.SelectAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
506
583
|
/**
|
|
507
584
|
* @param {CartPlatformApplicationValidator.SelectPaymentModeParam} arg - Arg object
|
|
508
585
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
509
586
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
510
|
-
* @returns {Promise<CartPlatformModel.
|
|
587
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
511
588
|
* @name selectPaymentMode
|
|
512
589
|
* @summary: Select payment mode
|
|
513
590
|
* @description: Customers can select a preferred payment mode from available options during the cart checkout process to securely and efficiently complete their transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
|
|
514
591
|
*/
|
|
515
|
-
selectPaymentMode({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
592
|
+
selectPaymentMode({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
516
593
|
/**
|
|
517
594
|
* @param {CartPlatformApplicationValidator.SelectPaymentModeV2Param} arg - Arg object
|
|
518
595
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
519
596
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
520
|
-
* @returns {Promise<CartPlatformModel.
|
|
597
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
521
598
|
* @name selectPaymentModeV2
|
|
522
599
|
* @summary: Select payment mode (latest)
|
|
523
600
|
* @description: Selection of payment mode that supports multiple MOP(mode of payment). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentModeV2/).
|
|
524
601
|
*/
|
|
525
|
-
selectPaymentModeV2({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
602
|
+
selectPaymentModeV2({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
526
603
|
/**
|
|
527
604
|
* @param {CartPlatformApplicationValidator.UpdateAddressParam} arg - Arg object
|
|
528
605
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
529
606
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
530
|
-
* @returns {Promise<CartPlatformModel.
|
|
607
|
+
* @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
|
|
531
608
|
* @name updateAddress
|
|
532
|
-
* @summary:
|
|
533
|
-
* @description:
|
|
609
|
+
* @summary: Update address added to an account
|
|
610
|
+
* @description: Use this API to update an existing address in the account. Request object should contain attributes mentioned in Address can be updated. These attributes are:is_default_address landmark area pincode email address_type name address_id address - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
534
611
|
*/
|
|
535
|
-
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
612
|
+
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateAddressResponse>;
|
|
536
613
|
/**
|
|
537
614
|
* @param {CartPlatformApplicationValidator.UpdateCartParam} arg - Arg object
|
|
538
615
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
539
616
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
540
|
-
* @returns {Promise<CartPlatformModel.
|
|
617
|
+
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
541
618
|
* @name updateCart
|
|
542
619
|
* @summary: Update cart items
|
|
543
620
|
* @description: Customers can modify added product attributes such as quantity and size, as well as remove items from the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCart/).
|
|
544
621
|
*/
|
|
545
|
-
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
622
|
+
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
546
623
|
/**
|
|
547
624
|
* @param {CartPlatformApplicationValidator.UpdateCartMetaParam} arg - Arg object
|
|
548
625
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
549
626
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
550
|
-
* @returns {Promise<CartPlatformModel.
|
|
627
|
+
* @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
|
|
551
628
|
* @name updateCartMeta
|
|
552
629
|
* @summary: Update cart metadata
|
|
553
630
|
* @description: Add or modify metadata associated with a cart, which includes customer preferences, delivery instructions, or any special requirements related to the cart items. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMeta/).
|
|
554
631
|
*/
|
|
555
|
-
updateCartMeta({ body, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
632
|
+
updateCartMeta({ body, id, buyNow, userId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaResponse>;
|
|
556
633
|
/**
|
|
557
634
|
* @param {CartPlatformApplicationValidator.UpdateCartMetaConfigParam} arg
|
|
558
635
|
* - Arg object
|
|
@@ -561,42 +638,42 @@ declare class Cart {
|
|
|
561
638
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
562
639
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
563
640
|
* @name updateCartMetaConfig
|
|
564
|
-
* @summary: Update cart
|
|
565
|
-
* @description: Modify the configuration settings for cart metadata
|
|
641
|
+
* @summary: Update cart metadata configuration.
|
|
642
|
+
* @description: Modify the configuration settings for cart metadata. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
566
643
|
*/
|
|
567
644
|
updateCartMetaConfig({ cartMetaId, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigUpdate>;
|
|
568
645
|
/**
|
|
569
646
|
* @param {CartPlatformApplicationValidator.UpdateCartUserParam} arg - Arg object
|
|
570
647
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
571
648
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
572
|
-
* @returns {Promise<CartPlatformModel.
|
|
649
|
+
* @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
|
|
573
650
|
* @name updateCartUser
|
|
574
|
-
* @summary: Update user
|
|
575
|
-
* @description: Modify
|
|
651
|
+
* @summary: Update cart user details.
|
|
652
|
+
* @description: Modify user-related details for a shopping cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
|
|
576
653
|
*/
|
|
577
|
-
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
654
|
+
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.UserCartMappingResponse>;
|
|
578
655
|
/**
|
|
579
656
|
* @param {CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam} arg
|
|
580
657
|
* - Arg object
|
|
581
658
|
*
|
|
582
659
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
583
660
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
584
|
-
* @returns {Promise<CartPlatformModel.
|
|
661
|
+
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
585
662
|
* @name updateCartWithSharedItems
|
|
586
|
-
* @summary:
|
|
587
|
-
* @description:
|
|
663
|
+
* @summary: Merge or replace existing cart
|
|
664
|
+
* @description: Use this API to merge the shared cart with existing cart, or replace the existing cart with the shared cart. The `action` parameter is used to indicate the operation Merge or Replace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartWithSharedItems/).
|
|
588
665
|
*/
|
|
589
|
-
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
666
|
+
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
590
667
|
/**
|
|
591
668
|
* @param {CartPlatformApplicationValidator.UpdateCouponParam} arg - Arg object
|
|
592
669
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
593
670
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
594
|
-
* @returns {Promise<CartPlatformModel.
|
|
671
|
+
* @returns {Promise<CartPlatformModel.CouponDetailResponse>} - Success response
|
|
595
672
|
* @name updateCoupon
|
|
596
673
|
* @summary: Update a coupon
|
|
597
674
|
* @description: Update the details of an existing coupon by specifying its unique identifier. This includes modifying coupon attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCoupon/).
|
|
598
675
|
*/
|
|
599
|
-
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
676
|
+
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponDetailResponse>;
|
|
600
677
|
/**
|
|
601
678
|
* @param {CartPlatformApplicationValidator.UpdateCouponPartiallyParam} arg
|
|
602
679
|
* - Arg object
|
|
@@ -605,7 +682,7 @@ declare class Cart {
|
|
|
605
682
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
606
683
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
607
684
|
* @name updateCouponPartially
|
|
608
|
-
* @summary: Update
|
|
685
|
+
* @summary: Update coupon archive state and schedule
|
|
609
686
|
* @description: Seller can make partial adjustments of an existing coupon by specifying its unique identifier. It enables businesses to modify specific attributes of the coupon while preserving other details intact. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCouponPartially/).
|
|
610
687
|
*/
|
|
611
688
|
updateCouponPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
@@ -615,22 +692,23 @@ declare class Cart {
|
|
|
615
692
|
*
|
|
616
693
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
617
694
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
618
|
-
* @returns {Promise<CartPlatformModel.
|
|
695
|
+
* @returns {Promise<CartPlatformModel.UpdatePriceAdjustmentResponse>} -
|
|
696
|
+
* Success response
|
|
619
697
|
* @name updatePriceAdjustment
|
|
620
|
-
* @summary: Update price adjustments
|
|
621
|
-
* @description: Modify price adjustments for
|
|
698
|
+
* @summary: Update price adjustments.
|
|
699
|
+
* @description: Modify price adjustments for items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
622
700
|
*/
|
|
623
|
-
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
701
|
+
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdatePriceAdjustmentResponse>;
|
|
624
702
|
/**
|
|
625
703
|
* @param {CartPlatformApplicationValidator.UpdatePromotionParam} arg - Arg object
|
|
626
704
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
627
705
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
628
|
-
* @returns {Promise<CartPlatformModel.
|
|
706
|
+
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
629
707
|
* @name updatePromotion
|
|
630
708
|
* @summary: Update a promotion
|
|
631
709
|
* @description: Update the details of an existing promotion by specifying its unique identifier. This includes modifying promotion attributes such as discount percentage, validity period, and associated conditions. Leveraging this functionality allows businesses to quickly adapt their promotional strategies to changing market dynamics. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotion/).
|
|
632
710
|
*/
|
|
633
|
-
updatePromotion({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
711
|
+
updatePromotion({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
634
712
|
/**
|
|
635
713
|
* @param {CartPlatformApplicationValidator.UpdatePromotionPartiallyParam} arg
|
|
636
714
|
* - Arg object
|
|
@@ -639,21 +717,21 @@ declare class Cart {
|
|
|
639
717
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
640
718
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
641
719
|
* @name updatePromotionPartially
|
|
642
|
-
* @summary:
|
|
643
|
-
* @description:
|
|
720
|
+
* @summary: Partially update a promotion.
|
|
721
|
+
* @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/).
|
|
644
722
|
*/
|
|
645
723
|
updatePromotionPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
646
724
|
/**
|
|
647
725
|
* @param {CartPlatformApplicationValidator.UpdateShipmentsParam} arg - Arg object
|
|
648
726
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
649
727
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
650
|
-
* @returns {Promise<CartPlatformModel.
|
|
728
|
+
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
651
729
|
* Success response
|
|
652
730
|
* @name updateShipments
|
|
653
731
|
* @summary: Update shipments
|
|
654
732
|
* @description: Update the quantity or delivery type of the shipments. Customers can switch the order type from Home Delivery to Pick At Store and vice versa. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateShipments/).
|
|
655
733
|
*/
|
|
656
|
-
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
734
|
+
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
657
735
|
/**
|
|
658
736
|
* @param {CartPlatformApplicationValidator.ValidateCouponForPaymentParam} arg
|
|
659
737
|
* - Arg object
|
|
@@ -665,7 +743,8 @@ declare class Cart {
|
|
|
665
743
|
* @summary: Validate applied coupon
|
|
666
744
|
* @description: Validates the applicability of a coupon code for the selected payment mode for the existing cart. This ensures the coupon's validity before proceeding with the payment process, enhancing user experience and preventing potential errors during transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/validateCouponForPayment/).
|
|
667
745
|
*/
|
|
668
|
-
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, requestHeaders, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PaymentCouponValidate>;
|
|
746
|
+
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, iin, network, type, cardId, cartType, requestHeaders, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PaymentCouponValidate>;
|
|
669
747
|
}
|
|
670
748
|
import CartPlatformApplicationValidator = require("./CartPlatformApplicationValidator");
|
|
671
749
|
import CartPlatformModel = require("./CartPlatformModel");
|
|
750
|
+
import Paginator = require("../../common/Paginator");
|