@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
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 +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -7,88 +7,87 @@ 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.SaveAddressDetails>} - Success response
|
|
11
11
|
* @name addAddress
|
|
12
|
-
* @summary:
|
|
13
|
-
* @description:
|
|
12
|
+
* @summary: Creates a new address for a customer
|
|
13
|
+
* @description: Customers can add a new address to their cart to save details such as name, email, contact information, and address. - 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.SaveAddressDetails>;
|
|
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.AddCartDetailResult>} - Success response
|
|
21
21
|
* @name addItems
|
|
22
|
-
* @summary: Add items to
|
|
22
|
+
* @summary: Add items to cart
|
|
23
23
|
* @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/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.AddCartDetailResult>;
|
|
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.GetPriceAdjustmentResult>} - Success response
|
|
31
31
|
* @name addPriceAdjustment
|
|
32
|
-
* @summary: Create
|
|
33
|
-
* @description: Create
|
|
32
|
+
* @summary: Create price adjustments
|
|
33
|
+
* @description: Create custom price adjustments for items in the cart, facilitating the application of discounts or promotions. Price adjustments can be tailored based on specific sales channel contexts, enhancing flexibility in pricing strategies. - 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.GetPriceAdjustmentResult>;
|
|
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.CartDetailResult>} - Success response
|
|
41
41
|
* @name applyCoupon
|
|
42
|
-
* @summary: Apply
|
|
42
|
+
* @summary: Apply coupon
|
|
43
43
|
* @description: Apply a coupon code to the customer's cart to trigger discounts on eligible items - 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, xOrderingSource, i, b, p, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.ApplyCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResult>;
|
|
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
|
-
*
|
|
54
|
-
*
|
|
52
|
+
* @returns {Promise<CartPlatformModel.OpenApiCartServiceabilityResult>} -
|
|
53
|
+
* Success response
|
|
55
54
|
* @name checkCartServiceability
|
|
56
55
|
* @summary: Check cart serviceability
|
|
57
56
|
* @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/).
|
|
58
57
|
*/
|
|
59
|
-
checkCartServiceability({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
58
|
+
checkCartServiceability({ body, xOrderingSource, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCartServiceabilityResult>;
|
|
60
59
|
/**
|
|
61
60
|
* @param {CartPlatformApplicationValidator.CheckoutCartParam} arg - Arg object
|
|
62
61
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
63
62
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
|
-
* @returns {Promise<CartPlatformModel.
|
|
63
|
+
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResult>} - Success response
|
|
65
64
|
* @name checkoutCart
|
|
66
65
|
* @summary: Checkout cart
|
|
67
66
|
* @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/).
|
|
68
67
|
*/
|
|
69
|
-
checkoutCart({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
68
|
+
checkoutCart({ body, xOrderingSource, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCheckoutResult>;
|
|
70
69
|
/**
|
|
71
70
|
* @param {CartPlatformApplicationValidator.CreateCartMetaConfigParam} arg
|
|
72
71
|
* - Arg object
|
|
73
72
|
*
|
|
74
73
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
75
74
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
76
|
-
* @returns {Promise<CartPlatformModel.
|
|
75
|
+
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
77
76
|
* @name createCartMetaConfig
|
|
78
|
-
* @summary: Create new cart meta
|
|
77
|
+
* @summary: Create a new cart meta
|
|
79
78
|
* @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/).
|
|
80
79
|
*/
|
|
81
|
-
createCartMetaConfig({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
80
|
+
createCartMetaConfig({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAdd>;
|
|
82
81
|
/**
|
|
83
82
|
* @param {CartPlatformApplicationValidator.CreateCouponParam} arg - Arg object
|
|
84
83
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
84
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
|
-
* @returns {Promise<CartPlatformModel.
|
|
85
|
+
* @returns {Promise<CartPlatformModel.CouponCreateResult>} - Success response
|
|
87
86
|
* @name createCoupon
|
|
88
|
-
* @summary: Create a
|
|
89
|
-
* @description:
|
|
87
|
+
* @summary: Create a coupon
|
|
88
|
+
* @description: Creates a new coupon based on the selected coupon type. Sellers can choose from multiple supported coupon types, including percentage value, fixed amount value, bundled discount, buy X get Y items, and more, along with customizable coupon criteria to meet specific business requirements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCoupon/).
|
|
90
89
|
*/
|
|
91
|
-
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
90
|
+
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponCreateResult>;
|
|
92
91
|
/**
|
|
93
92
|
* @param {CartPlatformApplicationValidator.CreatePromotionParam} arg - Arg object
|
|
94
93
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -103,82 +102,76 @@ declare class Cart {
|
|
|
103
102
|
* @param {CartPlatformApplicationValidator.DeleteCartParam} arg - Arg object
|
|
104
103
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
105
104
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
106
|
-
* @returns {Promise<CartPlatformModel.
|
|
105
|
+
* @returns {Promise<CartPlatformModel.DeleteCartDetailResult>} - Success response
|
|
107
106
|
* @name deleteCart
|
|
108
107
|
* @summary: Delete a cart
|
|
109
108
|
* @description: Delete all items from the user's cart and resets it to its initial state, providing a clean slate for new selections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
|
|
110
109
|
*/
|
|
111
|
-
deleteCart({ body, id,
|
|
110
|
+
deleteCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteCartDetailResult>;
|
|
112
111
|
/**
|
|
113
|
-
* @param {CartPlatformApplicationValidator.
|
|
114
|
-
*
|
|
115
|
-
*
|
|
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/).
|
|
119
|
+
*/
|
|
120
|
+
deleteCoupon({ id, requestHeaders }?: CartPlatformApplicationValidator.DeleteCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
121
|
+
/**
|
|
122
|
+
* @param {CartPlatformApplicationValidator.DeletePromotionParam} arg - Arg object
|
|
116
123
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
117
124
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
118
125
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
119
|
-
* @name
|
|
120
|
-
* @summary: Delete
|
|
121
|
-
* @description: Delete
|
|
126
|
+
* @name deletePromotion
|
|
127
|
+
* @summary: Delete a promotion which is in draft state
|
|
128
|
+
* @description: Delete details of a draft promotion by providing its unique identifier to delete 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/deletePromotion/).
|
|
122
129
|
*/
|
|
123
|
-
|
|
130
|
+
deletePromotion({ id, requestHeaders }?: CartPlatformApplicationValidator.DeletePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
124
131
|
/**
|
|
125
132
|
* @param {CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam} arg
|
|
126
133
|
* - Arg object
|
|
127
134
|
*
|
|
128
135
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
129
136
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
130
|
-
* @returns {Promise<CartPlatformModel.
|
|
137
|
+
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResult>} - Success response
|
|
131
138
|
* @name fetchAndvalidateCartItems
|
|
132
139
|
* @summary: Get and validate cart items
|
|
133
140
|
* @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/).
|
|
134
141
|
*/
|
|
135
|
-
fetchAndvalidateCartItems({ body, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
142
|
+
fetchAndvalidateCartItems({ body, xOrderingSource, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenapiCartDetailsResult>;
|
|
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>;
|
|
136
153
|
/**
|
|
137
154
|
* @param {CartPlatformApplicationValidator.GetAbandonedCartParam} arg - Arg object
|
|
138
155
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
139
156
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
140
|
-
* @returns {Promise<CartPlatformModel.
|
|
157
|
+
* @returns {Promise<CartPlatformModel.AbandonedCartResult>} - Success response
|
|
141
158
|
* @name getAbandonedCart
|
|
142
159
|
* @summary: Get abandoned carts
|
|
143
160
|
* @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/).
|
|
144
161
|
*/
|
|
145
|
-
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
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>;
|
|
162
|
+
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.AbandonedCartResult>;
|
|
170
163
|
/**
|
|
171
164
|
* @param {CartPlatformApplicationValidator.GetAbandonedCartDetailsParam} arg
|
|
172
165
|
* - Arg object
|
|
173
166
|
*
|
|
174
167
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
175
168
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
176
|
-
* @returns {Promise<CartPlatformModel.
|
|
169
|
+
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
177
170
|
* @name getAbandonedCartDetails
|
|
178
171
|
* @summary: Get abandoned cart details
|
|
179
172
|
* @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/).
|
|
180
173
|
*/
|
|
181
|
-
getAbandonedCartDetails({ id, i, b, c, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
174
|
+
getAbandonedCartDetails({ id, i, b, c, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResult>;
|
|
182
175
|
/**
|
|
183
176
|
* @param {CartPlatformApplicationValidator.GetAddressByIdParam} arg - Arg object
|
|
184
177
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -193,103 +186,82 @@ declare class Cart {
|
|
|
193
186
|
* @param {CartPlatformApplicationValidator.GetAddressesParam} arg - Arg object
|
|
194
187
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
195
188
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
196
|
-
* @returns {Promise<CartPlatformModel.
|
|
189
|
+
* @returns {Promise<CartPlatformModel.PlatformGetAddressesDetails>} -
|
|
197
190
|
* Success response
|
|
198
191
|
* @name getAddresses
|
|
199
192
|
* @summary: Get a list of addresses for a customer
|
|
200
193
|
* @description: Retrieves a list of all addresses saved by the customer, simplifying the checkout process by offering pre-saved address options for delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddresses/).
|
|
201
194
|
*/
|
|
202
|
-
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressesParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
195
|
+
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressesParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformGetAddressesDetails>;
|
|
203
196
|
/**
|
|
204
197
|
* @param {CartPlatformApplicationValidator.GetAppCouponsParam} arg - Arg object
|
|
205
198
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
206
199
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
207
|
-
* @returns {Promise<CartPlatformModel.
|
|
200
|
+
* @returns {Promise<CartPlatformModel.GetCouponResult>} - Success response
|
|
208
201
|
* @name getAppCoupons
|
|
209
|
-
* @summary: List coupons
|
|
202
|
+
* @summary: List of coupons
|
|
210
203
|
* @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/).
|
|
211
204
|
*/
|
|
212
|
-
getAppCoupons({ id, buyNow, slug, storeId, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
205
|
+
getAppCoupons({ id, buyNow, slug, storeId, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResult>;
|
|
213
206
|
/**
|
|
214
207
|
* @param {CartPlatformApplicationValidator.GetAvailableDeliveryModesParam} arg
|
|
215
208
|
* - Arg object
|
|
216
209
|
*
|
|
217
210
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
218
211
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
219
|
-
* @returns {Promise<CartPlatformModel.
|
|
212
|
+
* @returns {Promise<CartPlatformModel.CartDeliveryModesDetails>} - Success response
|
|
220
213
|
* @name getAvailableDeliveryModes
|
|
221
214
|
* @summary: Get delivery modes
|
|
222
215
|
* @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/).
|
|
223
216
|
*/
|
|
224
|
-
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
217
|
+
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDeliveryModesDetails>;
|
|
225
218
|
/**
|
|
226
219
|
* @param {CartPlatformApplicationValidator.GetCartParam} arg - Arg object
|
|
227
220
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
228
221
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
229
|
-
* @returns {Promise<CartPlatformModel.
|
|
222
|
+
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
230
223
|
* @name getCart
|
|
231
|
-
* @summary:
|
|
232
|
-
* @description:
|
|
224
|
+
* @summary: Get a cart
|
|
225
|
+
* @description: Retrieve details of a cart linked to a specific customer using either the customer's ID or 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/getCart/).
|
|
233
226
|
*/
|
|
234
|
-
getCart({ id, userId, i, b, assignCardId, buyNow,
|
|
227
|
+
getCart({ xOrderingSource, id, userId, orderType, i, b, assignCardId, buyNow, requestHeaders, }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResult>;
|
|
235
228
|
/**
|
|
236
229
|
* @param {CartPlatformApplicationValidator.GetCartListParam} arg - Arg object
|
|
237
230
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
238
231
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
239
|
-
* @returns {Promise<CartPlatformModel.
|
|
232
|
+
* @returns {Promise<CartPlatformModel.MultiCartResult>} - Success response
|
|
240
233
|
* @name getCartList
|
|
241
|
-
* @summary:
|
|
242
|
-
* @description: Retrieve the list of active carts associated with a specific 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/).
|
|
254
|
-
*/
|
|
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/).
|
|
234
|
+
* @summary: List of carts
|
|
235
|
+
* @description: Retrieve the list of active carts associated with a specific customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
|
|
264
236
|
*/
|
|
265
|
-
|
|
237
|
+
getCartList({ fromDate, toDate, filterOn, requestHeaders }?: CartPlatformApplicationValidator.GetCartListParam, { responseHeaders }?: object): Promise<CartPlatformModel.MultiCartResult>;
|
|
266
238
|
/**
|
|
267
239
|
* @param {CartPlatformApplicationValidator.GetCartShareLinkParam} arg - Arg object
|
|
268
240
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
269
241
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
|
-
* @returns {Promise<CartPlatformModel.
|
|
242
|
+
* @returns {Promise<CartPlatformModel.GetShareCartLinkResult>} - Success response
|
|
271
243
|
* @name getCartShareLink
|
|
272
244
|
* @summary: Share cart link
|
|
273
245
|
* @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/).
|
|
274
246
|
*/
|
|
275
|
-
getCartShareLink({ body, requestHeaders }?: CartPlatformApplicationValidator.GetCartShareLinkParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
247
|
+
getCartShareLink({ body, requestHeaders }?: CartPlatformApplicationValidator.GetCartShareLinkParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetShareCartLinkResult>;
|
|
276
248
|
/**
|
|
277
249
|
* @param {CartPlatformApplicationValidator.GetCartSharedItemsParam} arg - Arg object
|
|
278
250
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
279
251
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
|
-
* @returns {Promise<CartPlatformModel.
|
|
252
|
+
* @returns {Promise<CartPlatformModel.SharedCartResult>} - Success response
|
|
281
253
|
* @name getCartSharedItems
|
|
282
|
-
* @summary:
|
|
283
|
-
* @description:
|
|
254
|
+
* @summary: List shared cart items
|
|
255
|
+
* @description: Retrieve the cart items from the shared cart link based on unique token. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartSharedItems/).
|
|
284
256
|
*/
|
|
285
|
-
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
257
|
+
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResult>;
|
|
286
258
|
/**
|
|
287
259
|
* @param {CartPlatformApplicationValidator.GetCouponByIdParam} arg - Arg object
|
|
288
260
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
289
261
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
290
262
|
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
291
263
|
* @name getCouponById
|
|
292
|
-
* @summary: Get coupon
|
|
264
|
+
* @summary: Get a coupon
|
|
293
265
|
* @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/).
|
|
294
266
|
*/
|
|
295
267
|
getCouponById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetCouponByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponUpdate>;
|
|
@@ -299,7 +271,7 @@ declare class Cart {
|
|
|
299
271
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
300
272
|
* @returns {Promise<Object>} - Success response
|
|
301
273
|
* @name getCouponCodeExists
|
|
302
|
-
* @summary: Check
|
|
274
|
+
* @summary: Check coupon code exists
|
|
303
275
|
* @description: Validates the presence of a coupon code for the specified sales channel to verify whether the provided code already exists or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
|
|
304
276
|
*/
|
|
305
277
|
getCouponCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
@@ -309,97 +281,61 @@ declare class Cart {
|
|
|
309
281
|
*
|
|
310
282
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
311
283
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
312
|
-
* @returns {Promise<
|
|
284
|
+
* @returns {Promise<Object>} - Success response
|
|
313
285
|
* @name getCouponOptionValues
|
|
314
286
|
* @summary: Get coupon option values
|
|
315
287
|
* @description: Retrieves the available values for coupon options used to create and update coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
|
|
316
288
|
*/
|
|
317
|
-
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<
|
|
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>;
|
|
289
|
+
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
328
290
|
/**
|
|
329
291
|
* @param {CartPlatformApplicationValidator.GetCouponsParam} arg - Arg object
|
|
330
292
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
331
293
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
332
|
-
* @returns {Promise<CartPlatformModel.
|
|
294
|
+
* @returns {Promise<CartPlatformModel.CouponsResult>} - Success response
|
|
333
295
|
* @name getCoupons
|
|
334
|
-
* @summary:
|
|
296
|
+
* @summary: List of coupons
|
|
335
297
|
* @description: Retrieve a list of all created coupons for specific sales channel. It also supports searching based on text search, pagination and other flags to filter coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCoupons/).
|
|
336
298
|
*/
|
|
337
|
-
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, requestHeaders, }?: CartPlatformApplicationValidator.GetCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
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 all created coupons for specific sales channel. It also supports searching based on text search, pagination and other flags to filter coupons.
|
|
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>;
|
|
299
|
+
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, createdBy, reviewedBy, approvedStartTime, approvedEndTime, reviewStartTime, reviewEndTime, status, requestHeaders, }?: CartPlatformApplicationValidator.GetCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponsResult>;
|
|
364
300
|
/**
|
|
365
301
|
* @param {CartPlatformApplicationValidator.GetItemCountParam} arg - Arg object
|
|
366
302
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
367
303
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
368
|
-
* @returns {Promise<CartPlatformModel.
|
|
304
|
+
* @returns {Promise<CartPlatformModel.CartItemCountResult>} - Success response
|
|
369
305
|
* @name getItemCount
|
|
370
|
-
* @summary:
|
|
371
|
-
* @description:
|
|
306
|
+
* @summary: Get a cart items count
|
|
307
|
+
* @description: Retrieve the total count of items currently present in the customer's cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getItemCount/).
|
|
372
308
|
*/
|
|
373
|
-
getItemCount({ id, buyNow,
|
|
309
|
+
getItemCount({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartItemCountResult>;
|
|
374
310
|
/**
|
|
375
311
|
* @param {CartPlatformApplicationValidator.GetPriceAdjustmentsParam} arg - Arg object
|
|
376
312
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
377
313
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
378
|
-
* @returns {Promise<CartPlatformModel.
|
|
314
|
+
* @returns {Promise<CartPlatformModel.GetPriceAdjustmentResult>} - Success response
|
|
379
315
|
* @name getPriceAdjustments
|
|
380
316
|
* @summary: Get a list of all price adjustments associated with a cart
|
|
381
317
|
* @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/).
|
|
382
318
|
*/
|
|
383
|
-
getPriceAdjustments({ cartId, requestHeaders }?: CartPlatformApplicationValidator.GetPriceAdjustmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
319
|
+
getPriceAdjustments({ cartId, requestHeaders }?: CartPlatformApplicationValidator.GetPriceAdjustmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetPriceAdjustmentResult>;
|
|
384
320
|
/**
|
|
385
321
|
* @param {CartPlatformApplicationValidator.GetPromosCouponConfigParam} arg
|
|
386
322
|
* - Arg object
|
|
387
323
|
*
|
|
388
324
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
389
325
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
390
|
-
* @returns {Promise<CartPlatformModel.
|
|
326
|
+
* @returns {Promise<CartPlatformModel.ActivePromosResult>} - Success response
|
|
391
327
|
* @name getPromosCouponConfig
|
|
392
328
|
* @summary: Get promotion and coupon type
|
|
393
329
|
* @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/).
|
|
394
330
|
*/
|
|
395
|
-
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
331
|
+
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.ActivePromosResult>;
|
|
396
332
|
/**
|
|
397
333
|
* @param {CartPlatformApplicationValidator.GetPromotionByIdParam} arg - Arg object
|
|
398
334
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
399
335
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
400
336
|
* @returns {Promise<CartPlatformModel.PromotionUpdateResult>} - Success response
|
|
401
337
|
* @name getPromotionById
|
|
402
|
-
* @summary: Get a promotion
|
|
338
|
+
* @summary: Get a specific promotion
|
|
403
339
|
* @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/).
|
|
404
340
|
*/
|
|
405
341
|
getPromotionById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdateResult>;
|
|
@@ -411,153 +347,140 @@ declare class Cart {
|
|
|
411
347
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
412
348
|
* @returns {Promise<Object>} - Success response
|
|
413
349
|
* @name getPromotionCodeExists
|
|
414
|
-
* @summary: Check
|
|
350
|
+
* @summary: Check promotion code exists
|
|
415
351
|
* @description: Validates the presence of a promotion code for the specified sales channel to verify whether the provided code already exists or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
|
|
416
352
|
*/
|
|
417
353
|
getPromotionCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
418
354
|
/**
|
|
419
|
-
* @param {CartPlatformApplicationValidator.
|
|
355
|
+
* @param {CartPlatformApplicationValidator.GetPromotionOffersParam} arg - Arg object
|
|
420
356
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
421
357
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
422
|
-
* @returns {Promise<CartPlatformModel.
|
|
423
|
-
* @name
|
|
424
|
-
* @summary:
|
|
425
|
-
* @description:
|
|
358
|
+
* @returns {Promise<CartPlatformModel.PromotionOffersDetails>} - Success response
|
|
359
|
+
* @name getPromotionOffers
|
|
360
|
+
* @summary: List of all available promotion offers
|
|
361
|
+
* @description: Retrieve a list of all promotional offers available for the items in the cart, including details such as offer text, unique promotion ID, and validity period. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionOffers/).
|
|
426
362
|
*/
|
|
427
|
-
|
|
363
|
+
getPromotionOffers({ slug, pageSize, promotionGroup, storeId, cartType, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionOffersParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionOffersDetails>;
|
|
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>;
|
|
428
377
|
/**
|
|
429
378
|
* @param {CartPlatformApplicationValidator.GetPromotionsParam} arg - Arg object
|
|
430
379
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
431
380
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
432
|
-
* @returns {Promise<CartPlatformModel.
|
|
381
|
+
* @returns {Promise<CartPlatformModel.PromotionsResult>} - Success response
|
|
433
382
|
* @name getPromotions
|
|
434
|
-
* @summary: List promotions
|
|
383
|
+
* @summary: List of promotions
|
|
435
384
|
* @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/).
|
|
436
385
|
*/
|
|
437
|
-
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
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>;
|
|
386
|
+
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, createdBy, reviewedBy, approvedStartTime, approvedEndTime, reviewStartTime, reviewEndTime, status, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionsResult>;
|
|
464
387
|
/**
|
|
465
388
|
* @param {CartPlatformApplicationValidator.GetShipmentsParam} arg - Arg object
|
|
466
389
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
467
390
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
468
|
-
* @returns {Promise<CartPlatformModel.
|
|
391
|
+
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResult>} -
|
|
469
392
|
* Success response
|
|
470
393
|
* @name getShipments
|
|
471
394
|
* @summary: Get shipments details
|
|
472
395
|
* @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/).
|
|
473
396
|
*/
|
|
474
|
-
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, requestHeaders, }?: CartPlatformApplicationValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
397
|
+
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, requestHeaders, }?: CartPlatformApplicationValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResult>;
|
|
475
398
|
/**
|
|
476
399
|
* @param {CartPlatformApplicationValidator.GetStoreAddressByUidParam} arg
|
|
477
400
|
* - Arg object
|
|
478
401
|
*
|
|
479
402
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
480
403
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
481
|
-
* @returns {Promise<CartPlatformModel.
|
|
404
|
+
* @returns {Promise<CartPlatformModel.StoreDetails>} - Success response
|
|
482
405
|
* @name getStoreAddressByUid
|
|
483
406
|
* @summary: Get Store Address
|
|
484
407
|
* @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/).
|
|
485
408
|
*/
|
|
486
|
-
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
409
|
+
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.StoreDetails>;
|
|
487
410
|
/**
|
|
488
411
|
* @param {CartPlatformApplicationValidator.OverrideCartParam} arg - Arg object
|
|
489
412
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
490
413
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
491
|
-
* @returns {Promise<CartPlatformModel.
|
|
414
|
+
* @returns {Promise<CartPlatformModel.OverrideCheckoutResult>} - Success response
|
|
492
415
|
* @name overrideCart
|
|
493
|
-
* @summary:
|
|
416
|
+
* @summary: Update cart checkout
|
|
494
417
|
* @description: Overrides the cart's checkout process with a new provided cart items. It provides flexibility in customizing checkout flows to meet specific business requirements, enhancing the user experience and optimizing order processing workflows. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
|
|
495
418
|
*/
|
|
496
|
-
overrideCart({ body, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
419
|
+
overrideCart({ body, xOrderingSource, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OverrideCheckoutResult>;
|
|
497
420
|
/**
|
|
498
421
|
* @param {CartPlatformApplicationValidator.PlatformAddItemsParam} arg - Arg object
|
|
499
422
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
500
423
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
501
|
-
* @returns {Promise<CartPlatformModel.
|
|
424
|
+
* @returns {Promise<CartPlatformModel.AddCartDetailResult>} - Success response
|
|
502
425
|
* @name platformAddItems
|
|
503
426
|
* @summary: Add items to cart
|
|
504
427
|
* @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/).
|
|
505
428
|
*/
|
|
506
|
-
platformAddItems({ body, i, b, buyNow,
|
|
429
|
+
platformAddItems({ body, xOrderingSource, i, b, buyNow, orderType, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResult>;
|
|
507
430
|
/**
|
|
508
431
|
* @param {CartPlatformApplicationValidator.PlatformCheckoutCartParam} arg
|
|
509
432
|
* - Arg object
|
|
510
433
|
*
|
|
511
434
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
512
435
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
513
|
-
* @returns {Promise<CartPlatformModel.
|
|
436
|
+
* @returns {Promise<CartPlatformModel.CartCheckoutResult>} - Success response
|
|
514
437
|
* @name platformCheckoutCart
|
|
515
438
|
* @summary: Checkout cart
|
|
516
439
|
* @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/).
|
|
517
440
|
*/
|
|
518
|
-
platformCheckoutCart({ body,
|
|
441
|
+
platformCheckoutCart({ body, xOrderingSource, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResult>;
|
|
519
442
|
/**
|
|
520
443
|
* @param {CartPlatformApplicationValidator.PlatformCheckoutCartV2Param} arg
|
|
521
444
|
* - Arg object
|
|
522
445
|
*
|
|
523
446
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
524
447
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
525
|
-
* @returns {Promise<CartPlatformModel.
|
|
448
|
+
* @returns {Promise<CartPlatformModel.CartCheckoutDetails>} - Success response
|
|
526
449
|
* @name platformCheckoutCartV2
|
|
527
|
-
* @summary:
|
|
450
|
+
* @summary: Checkout cart
|
|
528
451
|
* @description: The checkout cart initiates the order creation process based on the items in the user’s cart, their selected address, and chosen payment methods. It also supports multiple payment method options and revalidates the cart details to ensure a secure and seamless order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
529
452
|
*/
|
|
530
|
-
platformCheckoutCartV2({ body,
|
|
453
|
+
platformCheckoutCartV2({ body, xOrderingSource, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutDetails>;
|
|
531
454
|
/**
|
|
532
455
|
* @param {CartPlatformApplicationValidator.PlatformUpdateCartParam} arg - Arg object
|
|
533
456
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
534
457
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
535
|
-
* @returns {Promise<CartPlatformModel.
|
|
458
|
+
* @returns {Promise<CartPlatformModel.UpdateCartDetailResult>} - Success response
|
|
536
459
|
* @name platformUpdateCart
|
|
537
460
|
* @summary: Update cart items
|
|
538
461
|
* @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/).
|
|
539
462
|
*/
|
|
540
|
-
platformUpdateCart({ body, id, i, orderType, b, buyNow,
|
|
463
|
+
platformUpdateCart({ body, xOrderingSource, id, i, orderType, b, buyNow, requestHeaders }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResult>;
|
|
541
464
|
/**
|
|
542
465
|
* @param {CartPlatformApplicationValidator.RemoveAddressParam} arg - Arg object
|
|
543
466
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
544
467
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
545
|
-
* @returns {Promise<CartPlatformModel.
|
|
468
|
+
* @returns {Promise<CartPlatformModel.DeleteAddressResult>} - Success response
|
|
546
469
|
* @name removeAddress
|
|
547
470
|
* @summary: Removes an address from a customer's address list
|
|
548
471
|
* @description: Remove an existing customer address from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
549
472
|
*/
|
|
550
|
-
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
473
|
+
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteAddressResult>;
|
|
551
474
|
/**
|
|
552
475
|
* @param {CartPlatformApplicationValidator.RemoveCouponParam} arg - Arg object
|
|
553
476
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
554
477
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
555
|
-
* @returns {Promise<CartPlatformModel.
|
|
478
|
+
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
556
479
|
* @name removeCoupon
|
|
557
|
-
* @summary: Remove
|
|
480
|
+
* @summary: Remove coupon
|
|
558
481
|
* @description: Remove an applied coupon from the customer's cart, thereby removing the associated discount from the cart total. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
|
|
559
482
|
*/
|
|
560
|
-
removeCoupon({ uid, buyNow,
|
|
483
|
+
removeCoupon({ xOrderingSource, uid, buyNow, requestHeaders }?: CartPlatformApplicationValidator.RemoveCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResult>;
|
|
561
484
|
/**
|
|
562
485
|
* @param {CartPlatformApplicationValidator.RemovePriceAdjustmentParam} arg
|
|
563
486
|
* - Arg object
|
|
@@ -566,70 +489,70 @@ declare class Cart {
|
|
|
566
489
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
567
490
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
568
491
|
* @name removePriceAdjustment
|
|
569
|
-
* @summary: Remove price adjustments
|
|
570
|
-
* @description: Remove price adjustments
|
|
492
|
+
* @summary: Remove price adjustments
|
|
493
|
+
* @description: Remove the applied price adjustments for specific items within the cart based on unique price adjustment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
|
|
571
494
|
*/
|
|
572
495
|
removePriceAdjustment({ id, requestHeaders }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
573
496
|
/**
|
|
574
497
|
* @param {CartPlatformApplicationValidator.SelectAddressParam} arg - Arg object
|
|
575
498
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
576
499
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
577
|
-
* @returns {Promise<CartPlatformModel.
|
|
500
|
+
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
578
501
|
* @name selectAddress
|
|
579
502
|
* @summary: Select customer address for order processing
|
|
580
503
|
* @description: Select an address from the saved customer addresses and validates the availability of items in the cart. Additionally, it verifies and updates the delivery promise based on the selected address. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectAddress/).
|
|
581
504
|
*/
|
|
582
|
-
selectAddress({ body, cartId, buyNow, i, b, requestHeaders }?: CartPlatformApplicationValidator.SelectAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
505
|
+
selectAddress({ body, xOrderingSource, cartId, buyNow, i, b, requestHeaders }?: CartPlatformApplicationValidator.SelectAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResult>;
|
|
583
506
|
/**
|
|
584
507
|
* @param {CartPlatformApplicationValidator.SelectPaymentModeParam} arg - Arg object
|
|
585
508
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
586
509
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
587
|
-
* @returns {Promise<CartPlatformModel.
|
|
510
|
+
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
588
511
|
* @name selectPaymentMode
|
|
589
512
|
* @summary: Select payment mode
|
|
590
513
|
* @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/).
|
|
591
514
|
*/
|
|
592
|
-
selectPaymentMode({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
515
|
+
selectPaymentMode({ body, xOrderingSource, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResult>;
|
|
593
516
|
/**
|
|
594
517
|
* @param {CartPlatformApplicationValidator.SelectPaymentModeV2Param} arg - Arg object
|
|
595
518
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
596
519
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
597
|
-
* @returns {Promise<CartPlatformModel.
|
|
520
|
+
* @returns {Promise<CartPlatformModel.CartDetailResult>} - Success response
|
|
598
521
|
* @name selectPaymentModeV2
|
|
599
522
|
* @summary: Select payment mode (latest)
|
|
600
523
|
* @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/).
|
|
601
524
|
*/
|
|
602
|
-
selectPaymentModeV2({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
525
|
+
selectPaymentModeV2({ body, xOrderingSource, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResult>;
|
|
603
526
|
/**
|
|
604
527
|
* @param {CartPlatformApplicationValidator.UpdateAddressParam} arg - Arg object
|
|
605
528
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
606
529
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
607
|
-
* @returns {Promise<CartPlatformModel.
|
|
530
|
+
* @returns {Promise<CartPlatformModel.UpdateAddressDetails>} - Success response
|
|
608
531
|
* @name updateAddress
|
|
609
532
|
* @summary: Updates an existing customer address
|
|
610
533
|
* @description: Update the user address - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
611
534
|
*/
|
|
612
|
-
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
535
|
+
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateAddressDetails>;
|
|
613
536
|
/**
|
|
614
537
|
* @param {CartPlatformApplicationValidator.UpdateCartParam} arg - Arg object
|
|
615
538
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
616
539
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
617
|
-
* @returns {Promise<CartPlatformModel.
|
|
540
|
+
* @returns {Promise<CartPlatformModel.UpdateCartDetailResult>} - Success response
|
|
618
541
|
* @name updateCart
|
|
619
542
|
* @summary: Update cart items
|
|
620
543
|
* @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/).
|
|
621
544
|
*/
|
|
622
|
-
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
545
|
+
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResult>;
|
|
623
546
|
/**
|
|
624
547
|
* @param {CartPlatformApplicationValidator.UpdateCartMetaParam} arg - Arg object
|
|
625
548
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
626
549
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
627
|
-
* @returns {Promise<CartPlatformModel.
|
|
550
|
+
* @returns {Promise<CartPlatformModel.CartMetaDetails>} - Success response
|
|
628
551
|
* @name updateCartMeta
|
|
629
552
|
* @summary: Update cart metadata
|
|
630
553
|
* @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/).
|
|
631
554
|
*/
|
|
632
|
-
updateCartMeta({ body, id, buyNow,
|
|
555
|
+
updateCartMeta({ body, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaDetails>;
|
|
633
556
|
/**
|
|
634
557
|
* @param {CartPlatformApplicationValidator.UpdateCartMetaConfigParam} arg
|
|
635
558
|
* - Arg object
|
|
@@ -638,42 +561,42 @@ declare class Cart {
|
|
|
638
561
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
639
562
|
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
640
563
|
* @name updateCartMetaConfig
|
|
641
|
-
* @summary: Update cart
|
|
642
|
-
* @description: Modify the configuration settings for cart metadata. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
564
|
+
* @summary: Update cart meta
|
|
565
|
+
* @description: Modify the configuration settings for cart metadata associated with 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/updateCartMetaConfig/).
|
|
643
566
|
*/
|
|
644
567
|
updateCartMetaConfig({ cartMetaId, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigUpdate>;
|
|
645
568
|
/**
|
|
646
569
|
* @param {CartPlatformApplicationValidator.UpdateCartUserParam} arg - Arg object
|
|
647
570
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
648
571
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
649
|
-
* @returns {Promise<CartPlatformModel.
|
|
572
|
+
* @returns {Promise<CartPlatformModel.UserCartMappingResult>} - Success response
|
|
650
573
|
* @name updateCartUser
|
|
651
|
-
* @summary: Update
|
|
574
|
+
* @summary: Update user of a cart
|
|
652
575
|
* @description: Modify the cart user to a new valid customer for the provided customer ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
|
|
653
576
|
*/
|
|
654
|
-
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
577
|
+
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.UserCartMappingResult>;
|
|
655
578
|
/**
|
|
656
579
|
* @param {CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam} arg
|
|
657
580
|
* - Arg object
|
|
658
581
|
*
|
|
659
582
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
660
583
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
661
|
-
* @returns {Promise<CartPlatformModel.
|
|
584
|
+
* @returns {Promise<CartPlatformModel.SharedCartResult>} - Success response
|
|
662
585
|
* @name updateCartWithSharedItems
|
|
663
586
|
* @summary: Update shared cart items
|
|
664
587
|
* @description: Customer can either merge or replace shared cart items with existing cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartWithSharedItems/).
|
|
665
588
|
*/
|
|
666
|
-
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
589
|
+
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResult>;
|
|
667
590
|
/**
|
|
668
591
|
* @param {CartPlatformApplicationValidator.UpdateCouponParam} arg - Arg object
|
|
669
592
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
670
593
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
671
|
-
* @returns {Promise<CartPlatformModel.
|
|
594
|
+
* @returns {Promise<CartPlatformModel.CouponCreateResult>} - Success response
|
|
672
595
|
* @name updateCoupon
|
|
673
596
|
* @summary: Update a coupon
|
|
674
597
|
* @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/).
|
|
675
598
|
*/
|
|
676
|
-
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
599
|
+
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponCreateResult>;
|
|
677
600
|
/**
|
|
678
601
|
* @param {CartPlatformApplicationValidator.UpdateCouponPartiallyParam} arg
|
|
679
602
|
* - Arg object
|
|
@@ -682,7 +605,7 @@ declare class Cart {
|
|
|
682
605
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
683
606
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
684
607
|
* @name updateCouponPartially
|
|
685
|
-
* @summary: Update coupon
|
|
608
|
+
* @summary: Update a coupon partially
|
|
686
609
|
* @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/).
|
|
687
610
|
*/
|
|
688
611
|
updateCouponPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
@@ -692,13 +615,12 @@ declare class Cart {
|
|
|
692
615
|
*
|
|
693
616
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
694
617
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
695
|
-
* @returns {Promise<CartPlatformModel.
|
|
696
|
-
* Success response
|
|
618
|
+
* @returns {Promise<CartPlatformModel.GetPriceAdjustmentResult>} - Success response
|
|
697
619
|
* @name updatePriceAdjustment
|
|
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/).
|
|
620
|
+
* @summary: Update price adjustments
|
|
621
|
+
* @description: Modify price adjustments for specific items in the cart. By providing the seller ID, sales channel ID, and price adjustment ID, seller can apply discounts or other adjustments to the prices of cart items, facilitating dynamic pricing strategies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
700
622
|
*/
|
|
701
|
-
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
623
|
+
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetPriceAdjustmentResult>;
|
|
702
624
|
/**
|
|
703
625
|
* @param {CartPlatformApplicationValidator.UpdatePromotionParam} arg - Arg object
|
|
704
626
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -717,7 +639,7 @@ declare class Cart {
|
|
|
717
639
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
718
640
|
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
719
641
|
* @name updatePromotionPartially
|
|
720
|
-
* @summary:
|
|
642
|
+
* @summary: Update a promotion partially
|
|
721
643
|
* @description: Seller can make partial adjustments of an existing promotion by specifying its unique identifier. It enables businesses to modify specific attributes of the promotion while preserving other details intact. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotionPartially/).
|
|
722
644
|
*/
|
|
723
645
|
updatePromotionPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
@@ -725,13 +647,13 @@ declare class Cart {
|
|
|
725
647
|
* @param {CartPlatformApplicationValidator.UpdateShipmentsParam} arg - Arg object
|
|
726
648
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
727
649
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
728
|
-
* @returns {Promise<CartPlatformModel.
|
|
650
|
+
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResult>} -
|
|
729
651
|
* Success response
|
|
730
652
|
* @name updateShipments
|
|
731
653
|
* @summary: Update shipments
|
|
732
654
|
* @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/).
|
|
733
655
|
*/
|
|
734
|
-
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.
|
|
656
|
+
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResult>;
|
|
735
657
|
/**
|
|
736
658
|
* @param {CartPlatformApplicationValidator.ValidateCouponForPaymentParam} arg
|
|
737
659
|
* - Arg object
|
|
@@ -743,8 +665,7 @@ declare class Cart {
|
|
|
743
665
|
* @summary: Validate applied coupon
|
|
744
666
|
* @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/).
|
|
745
667
|
*/
|
|
746
|
-
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode,
|
|
668
|
+
validateCouponForPayment({ xOrderingSource, id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, requestHeaders, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PaymentCouponValidate>;
|
|
747
669
|
}
|
|
748
670
|
import CartPlatformApplicationValidator = require("./CartPlatformApplicationValidator");
|
|
749
671
|
import CartPlatformModel = require("./CartPlatformModel");
|
|
750
|
-
import Paginator = require("../../common/Paginator");
|