@gofynd/fdk-client-javascript 1.1.6 → 1.3.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 +52 -3
- package/index.js +0 -3
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +12 -3
- package/sdk/application/ApplicationClient.d.ts +36 -6
- package/sdk/application/ApplicationClient.js +30 -43
- package/sdk/application/ApplicationConfig.d.ts +92 -12
- package/sdk/application/ApplicationConfig.js +48 -14
- package/sdk/application/Cart/CartApplicationClient.d.ts +200 -357
- package/sdk/application/Cart/CartApplicationClient.js +711 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +274 -422
- package/sdk/application/Catalog/CatalogApplicationClient.js +865 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2320 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1566 -172
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +16 -21
- package/sdk/application/Common/CommonApplicationClient.js +52 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +368 -19
- package/sdk/application/Common/CommonApplicationModel.js +192 -40
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +31 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +86 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +157 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +104 -23
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +149 -118
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +457 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2235 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1113 -193
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +149 -139
- package/sdk/application/Content/ContentApplicationClient.js +489 -278
- package/sdk/application/Content/ContentApplicationModel.d.ts +1010 -105
- package/sdk/application/Content/ContentApplicationModel.js +737 -396
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +23 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +74 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +148 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +100 -87
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +57 -53
- package/sdk/application/Lead/LeadApplicationClient.js +188 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +686 -54
- package/sdk/application/Lead/LeadApplicationModel.js +330 -244
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +40 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +131 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +93 -133
- package/sdk/application/Order/OrderApplicationClient.js +329 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +400 -366
- package/sdk/application/Payment/PaymentApplicationClient.js +1176 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +205 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +720 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +58 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +187 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +52 -50
- package/sdk/application/Share/ShareApplicationClient.js +185 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +198 -15
- package/sdk/application/Share/ShareApplicationModel.js +131 -31
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +30 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +102 -56
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +1291 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +895 -134
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +260 -305
- package/sdk/application/User/UserApplicationClient.js +910 -522
- package/sdk/application/User/UserApplicationModel.d.ts +992 -101
- package/sdk/application/User/UserApplicationModel.js +699 -248
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +7 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +16 -1
- package/sdk/partner/PartnerAPIClient.js +12 -2
- package/sdk/partner/PartnerClient.d.ts +22 -3
- package/sdk/partner/PartnerClient.js +20 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +30 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +104 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +190 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +132 -15
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +52 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +30 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +133 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +561 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1071 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +762 -151
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +175 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +118 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +454 -635
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1646 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3839 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2423 -217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +528 -638
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1600 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +652 -826
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1979 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6869 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -351
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1361 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +624 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +16 -21
- package/sdk/platform/Common/CommonPlatformClient.js +50 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +423 -19
- package/sdk/platform/Common/CommonPlatformModel.js +214 -40
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +37 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +20 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +731 -303
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +3095 -785
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +699 -41
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +463 -27
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +19 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +59 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1708 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1360 -235
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +127 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +435 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +882 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +666 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +184 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +105 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +327 -240
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +922 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +297 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +191 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +184 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +555 -311
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4337 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2178 -248
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +605 -578
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1996 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1472 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1085 -204
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +85 -82
- package/sdk/platform/Discount/DiscountPlatformClient.js +333 -175
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +281 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +189 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +109 -52
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +570 -105
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +141 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +118 -7
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +43 -63
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +153 -135
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +426 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +379 -40
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +106 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +60 -8
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +260 -129
- package/sdk/platform/Finance/FinancePlatformClient.js +1182 -194
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1267 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +1252 -38
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +233 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +229 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +111 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +330 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +100 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +372 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +89 -104
- package/sdk/platform/Lead/LeadPlatformClient.js +305 -180
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1045 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +504 -142
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +92 -15
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +20 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +58 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +437 -556
- package/sdk/platform/Order/OrderPlatformClient.js +1500 -760
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5225 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3473 -260
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +859 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +435 -23
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +16 -42
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +52 -155
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +37 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +19 -17
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +78 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +43 -369
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +418 -288
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +1509 -505
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +438 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +312 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +83 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +259 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3200 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1334 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +31 -12581
- package/sdk/platform/PlatformClient.js +30 -15089
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +96 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +344 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +360 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +238 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +159 -92
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +473 -208
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +138 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +100 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +166 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +518 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1408 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1034 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +41 -66
- package/sdk/platform/Share/SharePlatformApplicationClient.js +149 -116
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +167 -19
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +229 -193
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +976 -352
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +345 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +206 -14
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1527 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +1099 -118
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +138 -152
- package/sdk/platform/User/UserPlatformApplicationClient.js +470 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +242 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +129 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +653 -101
- package/sdk/platform/User/UserPlatformModel.js +467 -424
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +153 -49
- package/sdk/platform/Webhook/WebhookPlatformClient.js +896 -88
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +632 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +502 -54
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +170 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +157 -7
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +16 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +48 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +370 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +191 -40
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +54 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +161 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +21 -3
- package/sdk/public/PublicClient.js +20 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +16 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +52 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +33 -113
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -3
- package/sdk/application/ApplicationModels.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -145
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -799
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -14
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -87
|
@@ -4,160 +4,143 @@ declare class Cart {
|
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
|
-
* @param {
|
|
8
|
-
* @param {
|
|
9
|
-
* @
|
|
7
|
+
* @param {CartPlatformApplicationValidator.AddAddressParam} arg - Arg object
|
|
8
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
9
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
|
+
* @returns {Promise<CartPlatformModel.SaveAddressResponse>} - Success response
|
|
11
|
+
* @name addAddress
|
|
10
12
|
* @summary: Add address to an account
|
|
11
|
-
* @description: Use this API to add an address to an account.
|
|
13
|
+
* @description: Use this API to add an address to an account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addAddress/).
|
|
12
14
|
*/
|
|
13
|
-
addAddress({ body }?: {
|
|
14
|
-
body: PlatformAddress;
|
|
15
|
-
}): Promise<SaveAddressResponse>;
|
|
15
|
+
addAddress({ body, requestHeaders }?: CartPlatformApplicationValidator.AddAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.SaveAddressResponse>;
|
|
16
16
|
/**
|
|
17
|
-
* @param {
|
|
18
|
-
* @param {
|
|
19
|
-
* @param {
|
|
20
|
-
* @
|
|
21
|
-
* @
|
|
17
|
+
* @param {CartPlatformApplicationValidator.AddItemsParam} arg - Arg object
|
|
18
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
+
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
21
|
+
* @name addItems
|
|
22
22
|
* @summary: Add items to abandoned cart
|
|
23
|
-
* @description: Use this API to add items to the abandoned cart.
|
|
23
|
+
* @description: Use this API to add items to the abandoned cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addItems/).
|
|
24
24
|
*/
|
|
25
|
-
addItems({ cartId, body, b }?: {
|
|
26
|
-
cartId: string;
|
|
27
|
-
b?: boolean;
|
|
28
|
-
body: AddCartRequest;
|
|
29
|
-
}): Promise<AddCartDetailResponse>;
|
|
25
|
+
addItems({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.AddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
30
26
|
/**
|
|
31
|
-
* @param {
|
|
32
|
-
* @param {
|
|
33
|
-
* @
|
|
27
|
+
* @param {CartPlatformApplicationValidator.AddPriceAdjustmentParam} arg - Arg object
|
|
28
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
29
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
30
|
+
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
31
|
+
* @name addPriceAdjustment
|
|
34
32
|
* @summary: Create new price adjustment
|
|
35
|
-
* @description: Create new price adjustment
|
|
33
|
+
* @description: Create new price adjustment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/addPriceAdjustment/).
|
|
36
34
|
*/
|
|
37
|
-
addPriceAdjustment({ body }?: {
|
|
38
|
-
body: PriceAdjustmentAdd;
|
|
39
|
-
}): Promise<PriceAdjustmentResponse>;
|
|
35
|
+
addPriceAdjustment({ body, requestHeaders }?: CartPlatformApplicationValidator.AddPriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
40
36
|
/**
|
|
41
|
-
* @param {
|
|
42
|
-
* @param {
|
|
43
|
-
* @param {
|
|
44
|
-
* @
|
|
45
|
-
* @
|
|
46
|
-
* @param {boolean} [arg.buyNow] -
|
|
47
|
-
* @param {ApplyCouponRequest} arg.body
|
|
48
|
-
* @returns {Promise<CartDetailResponse>} - Success response
|
|
37
|
+
* @param {CartPlatformApplicationValidator.ApplyCouponParam} arg - Arg object
|
|
38
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
39
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
41
|
+
* @name applyCoupon
|
|
49
42
|
* @summary: Apply Coupon for platform pos user
|
|
50
|
-
* @description: Use this API to apply coupons on items in the cart.
|
|
51
|
-
*/
|
|
52
|
-
applyCoupon({ body, i, b, p, id, buyNow }?: {
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
*
|
|
62
|
-
* @
|
|
63
|
-
* @returns {Promise<OpenApiCartServiceabilityResponse>} - Success response
|
|
43
|
+
* @description: Use this API to apply coupons on items in the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/applyCoupon/).
|
|
44
|
+
*/
|
|
45
|
+
applyCoupon({ body, i, b, p, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.ApplyCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
46
|
+
/**
|
|
47
|
+
* @param {CartPlatformApplicationValidator.CheckCartServiceabilityParam} arg
|
|
48
|
+
* - Arg object
|
|
49
|
+
*
|
|
50
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
52
|
+
* @returns {Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>}
|
|
53
|
+
* - Success response
|
|
54
|
+
*
|
|
55
|
+
* @name checkCartServiceability
|
|
64
56
|
* @summary: Check Pincode Serviceability
|
|
65
|
-
* @description: Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address`
|
|
57
|
+
* @description: Check Pincode serviceability for cart items provided in `cart_items` and address pincode in `shipping_address` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkCartServiceability/).
|
|
66
58
|
*/
|
|
67
|
-
checkCartServiceability({ body }?: {
|
|
68
|
-
body: OpenApiCartServiceabilityRequest;
|
|
69
|
-
}): Promise<OpenApiCartServiceabilityResponse>;
|
|
59
|
+
checkCartServiceability({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckCartServiceabilityParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCartServiceabilityResponse>;
|
|
70
60
|
/**
|
|
71
|
-
* @param {
|
|
72
|
-
* @param {
|
|
73
|
-
* @
|
|
61
|
+
* @param {CartPlatformApplicationValidator.CheckoutCartParam} arg - Arg object
|
|
62
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
63
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
|
+
* @returns {Promise<CartPlatformModel.OpenApiCheckoutResponse>} - Success response
|
|
65
|
+
* @name checkoutCart
|
|
74
66
|
* @summary: Create Fynd order with cart details
|
|
75
|
-
* @description: Generate Fynd order for cart details send with provided `cart_items`
|
|
67
|
+
* @description: Generate Fynd order for cart details send with provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/checkoutCart/).
|
|
76
68
|
*/
|
|
77
|
-
checkoutCart({ body }?: {
|
|
78
|
-
body: OpenApiPlatformCheckoutReq;
|
|
79
|
-
}): Promise<OpenApiCheckoutResponse>;
|
|
69
|
+
checkoutCart({ body, requestHeaders }?: CartPlatformApplicationValidator.CheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenApiCheckoutResponse>;
|
|
80
70
|
/**
|
|
81
|
-
* @param {
|
|
82
|
-
*
|
|
83
|
-
*
|
|
71
|
+
* @param {CartPlatformApplicationValidator.CreateCartMetaConfigParam} arg
|
|
72
|
+
* - Arg object
|
|
73
|
+
*
|
|
74
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
75
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
76
|
+
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
77
|
+
* @name createCartMetaConfig
|
|
84
78
|
* @summary: Create new cart meta configuration
|
|
85
|
-
* @description: Create new cart meta configuration
|
|
79
|
+
* @description: Create new cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCartMetaConfig/).
|
|
86
80
|
*/
|
|
87
|
-
createCartMetaConfig({ body }?: {
|
|
88
|
-
body: CartMetaConfigAdd;
|
|
89
|
-
}): Promise<CartMetaConfigAdd>;
|
|
81
|
+
createCartMetaConfig({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAdd>;
|
|
90
82
|
/**
|
|
91
|
-
* @param {
|
|
92
|
-
* @param {
|
|
93
|
-
* @
|
|
83
|
+
* @param {CartPlatformApplicationValidator.CreateCouponParam} arg - Arg object
|
|
84
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
|
+
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
87
|
+
* @name createCoupon
|
|
94
88
|
* @summary: Create new coupon
|
|
95
|
-
* @description: Create new coupon
|
|
89
|
+
* @description: Create new coupon - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createCoupon/).
|
|
96
90
|
*/
|
|
97
|
-
createCoupon({ body }?: {
|
|
98
|
-
body: CouponAdd;
|
|
99
|
-
}): Promise<SuccessMessage>;
|
|
91
|
+
createCoupon({ body, requestHeaders }?: CartPlatformApplicationValidator.CreateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
100
92
|
/**
|
|
101
|
-
* @param {
|
|
102
|
-
* @param {
|
|
103
|
-
* @
|
|
93
|
+
* @param {CartPlatformApplicationValidator.CreatePromotionParam} arg - Arg object
|
|
94
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
95
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
96
|
+
* @returns {Promise<CartPlatformModel.PromotionAdd>} - Success response
|
|
97
|
+
* @name createPromotion
|
|
104
98
|
* @summary: Create new promotion
|
|
105
|
-
* @description: Create new promotion
|
|
99
|
+
* @description: Create new promotion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/createPromotion/).
|
|
106
100
|
*/
|
|
107
|
-
createPromotion({ body }?: {
|
|
108
|
-
body: PromotionAdd;
|
|
109
|
-
}): Promise<PromotionAdd>;
|
|
101
|
+
createPromotion({ body, requestHeaders }?: CartPlatformApplicationValidator.CreatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionAdd>;
|
|
110
102
|
/**
|
|
111
|
-
* @param {
|
|
112
|
-
* @param {
|
|
113
|
-
* @param {
|
|
114
|
-
* @returns {Promise<DeleteCartDetailResponse>} - Success response
|
|
103
|
+
* @param {CartPlatformApplicationValidator.DeleteCartParam} arg - Arg object
|
|
104
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
105
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
106
|
+
* @returns {Promise<CartPlatformModel.DeleteCartDetailResponse>} - Success response
|
|
107
|
+
* @name deleteCart
|
|
115
108
|
* @summary: Delete cart once user made successful checkout
|
|
116
|
-
* @description: Use this API to delete the cart.
|
|
109
|
+
* @description: Use this API to delete the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/deleteCart/).
|
|
117
110
|
*/
|
|
118
|
-
deleteCart({ body, id }?: {
|
|
119
|
-
id?: string;
|
|
120
|
-
body: DeleteCartRequest;
|
|
121
|
-
}): Promise<DeleteCartDetailResponse>;
|
|
111
|
+
deleteCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.DeleteCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteCartDetailResponse>;
|
|
122
112
|
/**
|
|
123
|
-
* @param {
|
|
124
|
-
*
|
|
125
|
-
*
|
|
113
|
+
* @param {CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam} arg
|
|
114
|
+
* - Arg object
|
|
115
|
+
*
|
|
116
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
117
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
118
|
+
* @returns {Promise<CartPlatformModel.OpenapiCartDetailsResponse>} - Success response
|
|
119
|
+
* @name fetchAndvalidateCartItems
|
|
126
120
|
* @summary: Fetch Cart Details
|
|
127
|
-
* @description: Get all the details of cart for a list of provided `cart_items`
|
|
121
|
+
* @description: Get all the details of cart for a list of provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchAndvalidateCartItems/).
|
|
128
122
|
*/
|
|
129
|
-
fetchAndvalidateCartItems({ body }?: {
|
|
130
|
-
body: OpenapiCartDetailsRequest;
|
|
131
|
-
}): Promise<OpenapiCartDetailsResponse>;
|
|
123
|
+
fetchAndvalidateCartItems({ body, requestHeaders }?: CartPlatformApplicationValidator.FetchAndvalidateCartItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.OpenapiCartDetailsResponse>;
|
|
132
124
|
/**
|
|
133
|
-
* @param {
|
|
134
|
-
* @
|
|
125
|
+
* @param {CartPlatformApplicationValidator.FetchCartMetaConfigParam} arg - Arg object
|
|
126
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
127
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
128
|
+
* @returns {Promise<CartPlatformModel.CartMetaConfigAdd>} - Success response
|
|
129
|
+
* @name fetchCartMetaConfig
|
|
135
130
|
* @summary: Fetch cart meta configuration
|
|
136
|
-
* @description: Fetch cart meta configuration
|
|
131
|
+
* @description: Fetch cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/fetchCartMetaConfig/).
|
|
137
132
|
*/
|
|
138
|
-
fetchCartMetaConfig({}?: any): Promise<CartMetaConfigAdd>;
|
|
133
|
+
fetchCartMetaConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigAdd>;
|
|
139
134
|
/**
|
|
140
|
-
* @param {
|
|
141
|
-
* @param {
|
|
142
|
-
* @param {
|
|
143
|
-
* @
|
|
144
|
-
* @
|
|
145
|
-
* @param {boolean} [arg.anonymousCart] -
|
|
146
|
-
* @param {string} [arg.lastId] -
|
|
147
|
-
* @param {string} [arg.sortOn] -
|
|
148
|
-
* @returns {Promise<AbandonedCartResponse>} - Success response
|
|
135
|
+
* @param {CartPlatformApplicationValidator.GetAbandonedCartParam} arg - Arg object
|
|
136
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
137
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
138
|
+
* @returns {Promise<CartPlatformModel.AbandonedCartResponse>} - Success response
|
|
139
|
+
* @name getAbandonedCart
|
|
149
140
|
* @summary: Get with abandoned cart list
|
|
150
|
-
* @description: Get abandoned cart list with pagination
|
|
141
|
+
* @description: Get abandoned cart list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCart/).
|
|
151
142
|
*/
|
|
152
|
-
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, }?: {
|
|
153
|
-
pageNo?: number;
|
|
154
|
-
pageSize?: number;
|
|
155
|
-
fromDate?: string;
|
|
156
|
-
toDate?: string;
|
|
157
|
-
anonymousCart?: boolean;
|
|
158
|
-
lastId?: string;
|
|
159
|
-
sortOn?: string;
|
|
160
|
-
}): Promise<AbandonedCartResponse>;
|
|
143
|
+
getAbandonedCart({ pageNo, pageSize, fromDate, toDate, anonymousCart, lastId, sortOn, requestHeaders, }?: CartPlatformApplicationValidator.GetAbandonedCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.AbandonedCartResponse>;
|
|
161
144
|
/**
|
|
162
145
|
* @param {Object} arg - Arg object.
|
|
163
146
|
* @param {string} arg.companyId - Current company id
|
|
@@ -168,6 +151,7 @@ declare class Cart {
|
|
|
168
151
|
* @param {boolean} [arg.anonymousCart] -
|
|
169
152
|
* @param {string} [arg.lastId] -
|
|
170
153
|
* @param {string} [arg.sortOn] -
|
|
154
|
+
* @returns {Paginator<CartPlatformModel.AbandonedCartResponse>}
|
|
171
155
|
* @summary: Get with abandoned cart list
|
|
172
156
|
* @description: Get abandoned cart list with pagination
|
|
173
157
|
*/
|
|
@@ -180,196 +164,144 @@ declare class Cart {
|
|
|
180
164
|
anonymousCart?: boolean;
|
|
181
165
|
lastId?: string;
|
|
182
166
|
sortOn?: string;
|
|
183
|
-
}): Paginator
|
|
184
|
-
/**
|
|
185
|
-
* @param {
|
|
186
|
-
*
|
|
187
|
-
*
|
|
188
|
-
* @param {
|
|
189
|
-
* @
|
|
167
|
+
}): Paginator<CartPlatformModel.AbandonedCartResponse>;
|
|
168
|
+
/**
|
|
169
|
+
* @param {CartPlatformApplicationValidator.GetAbandonedCartDetailsParam} arg
|
|
170
|
+
* - Arg object
|
|
171
|
+
*
|
|
172
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
173
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
174
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
175
|
+
* @name getAbandonedCartDetails
|
|
190
176
|
* @summary: Fetch all items added to the cart
|
|
191
|
-
* @description: Use this API to get details of all the items added to a cart.
|
|
177
|
+
* @description: Use this API to get details of all the items added to a cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAbandonedCartDetails/).
|
|
192
178
|
*/
|
|
193
|
-
getAbandonedCartDetails({ id, i, b }?: {
|
|
194
|
-
id?: string;
|
|
195
|
-
i?: boolean;
|
|
196
|
-
b?: boolean;
|
|
197
|
-
}): Promise<CartDetailResponse>;
|
|
179
|
+
getAbandonedCartDetails({ id, i, b, requestHeaders }?: CartPlatformApplicationValidator.GetAbandonedCartDetailsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
198
180
|
/**
|
|
199
|
-
* @param {
|
|
200
|
-
* @param {
|
|
201
|
-
* @param {
|
|
202
|
-
* @
|
|
203
|
-
* @
|
|
204
|
-
* @param {string} [arg.checkoutMode] -
|
|
205
|
-
* @param {string} [arg.tags] -
|
|
206
|
-
* @param {boolean} [arg.isDefault] -
|
|
207
|
-
* @param {string} [arg.userId] -
|
|
208
|
-
* @returns {Promise<PlatformAddress>} - Success response
|
|
181
|
+
* @param {CartPlatformApplicationValidator.GetAddressByIdParam} arg - Arg object
|
|
182
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
183
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
184
|
+
* @returns {Promise<CartPlatformModel.PlatformAddress>} - Success response
|
|
185
|
+
* @name getAddressById
|
|
209
186
|
* @summary: Fetch a single address by its ID
|
|
210
|
-
* @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `PlatformAddress`. Attibutes listed below are optional
|
|
211
|
-
*/
|
|
212
|
-
getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, }?: {
|
|
213
|
-
id: string;
|
|
214
|
-
cartId?: string;
|
|
215
|
-
buyNow?: boolean;
|
|
216
|
-
mobileNo?: string;
|
|
217
|
-
checkoutMode?: string;
|
|
218
|
-
tags?: string;
|
|
219
|
-
isDefault?: boolean;
|
|
220
|
-
userId?: string;
|
|
221
|
-
}): Promise<PlatformAddress>;
|
|
187
|
+
* @description: Use this API to get an addresses using its ID. If successful, returns a Address resource in the response body specified in `PlatformAddress`. Attibutes listed below are optional mobile_no checkout_mode tags default - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddressById/).
|
|
188
|
+
*/
|
|
189
|
+
getAddressById({ id, cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformAddress>;
|
|
222
190
|
/**
|
|
223
|
-
* @param {
|
|
224
|
-
* @param {
|
|
225
|
-
* @param {
|
|
226
|
-
* @
|
|
227
|
-
*
|
|
228
|
-
* @
|
|
229
|
-
* @param {boolean} [arg.isDefault] -
|
|
230
|
-
* @param {string} [arg.userId] -
|
|
231
|
-
* @returns {Promise<PlatformGetAddressesResponse>} - Success response
|
|
191
|
+
* @param {CartPlatformApplicationValidator.GetAddressesParam} arg - Arg object
|
|
192
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
193
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
194
|
+
* @returns {Promise<CartPlatformModel.PlatformGetAddressesResponse>} -
|
|
195
|
+
* Success response
|
|
196
|
+
* @name getAddresses
|
|
232
197
|
* @summary: Fetch address
|
|
233
|
-
* @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional
|
|
234
|
-
*/
|
|
235
|
-
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, }?: {
|
|
236
|
-
cartId?: string;
|
|
237
|
-
buyNow?: boolean;
|
|
238
|
-
mobileNo?: string;
|
|
239
|
-
checkoutMode?: string;
|
|
240
|
-
tags?: string;
|
|
241
|
-
isDefault?: boolean;
|
|
242
|
-
userId?: string;
|
|
243
|
-
}): Promise<PlatformGetAddressesResponse>;
|
|
198
|
+
* @description: Use this API to get all the addresses associated with an account. If successful, returns a Address resource in the response body specified in GetAddressesResponse.attibutes listed below are optional uid address_id mobile_no checkout_mode tags default - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAddresses/).
|
|
199
|
+
*/
|
|
200
|
+
getAddresses({ cartId, buyNow, mobileNo, checkoutMode, tags, isDefault, userId, requestHeaders, }?: CartPlatformApplicationValidator.GetAddressesParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformGetAddressesResponse>;
|
|
244
201
|
/**
|
|
245
|
-
* @param {
|
|
246
|
-
* @param {
|
|
247
|
-
* @param {
|
|
248
|
-
* @returns {Promise<GetCouponResponse>} - Success response
|
|
202
|
+
* @param {CartPlatformApplicationValidator.GetAppCouponsParam} arg - Arg object
|
|
203
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
204
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
205
|
+
* @returns {Promise<CartPlatformModel.GetCouponResponse>} - Success response
|
|
206
|
+
* @name getAppCoupons
|
|
249
207
|
* @summary: Fetch Coupon
|
|
250
|
-
* @description: Use this API to get a list of available coupons along with their details.
|
|
208
|
+
* @description: Use this API to get a list of available coupons along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAppCoupons/).
|
|
251
209
|
*/
|
|
252
|
-
getAppCoupons({ id, buyNow }?: {
|
|
253
|
-
id?: string;
|
|
254
|
-
buyNow?: boolean;
|
|
255
|
-
}): Promise<GetCouponResponse>;
|
|
210
|
+
getAppCoupons({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetAppCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetCouponResponse>;
|
|
256
211
|
/**
|
|
257
|
-
* @param {
|
|
258
|
-
*
|
|
259
|
-
*
|
|
260
|
-
* @
|
|
212
|
+
* @param {CartPlatformApplicationValidator.GetAvailableDeliveryModesParam} arg
|
|
213
|
+
* - Arg object
|
|
214
|
+
*
|
|
215
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
216
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
217
|
+
* @returns {Promise<CartPlatformModel.CartDeliveryModesResponse>} - Success response
|
|
218
|
+
* @name getAvailableDeliveryModes
|
|
261
219
|
* @summary: Get available delivery modes for cart
|
|
262
|
-
* @description: Use this API to get the delivery modes (home-delivery/store-pickup) along with a list of pickup stores available for a given cart at a given PIN Code. User can then view the address of a pickup store with the help of store-address API.
|
|
220
|
+
* @description: Use this API to get the delivery modes (home-delivery/store-pickup) along with a list of pickup stores available for a given cart at a given PIN Code. User can then view the address of a pickup store with the help of store-address API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getAvailableDeliveryModes/).
|
|
263
221
|
*/
|
|
264
|
-
getAvailableDeliveryModes({ areaCode, id }?: {
|
|
265
|
-
areaCode: string;
|
|
266
|
-
id?: string;
|
|
267
|
-
}): Promise<CartDeliveryModesResponse>;
|
|
222
|
+
getAvailableDeliveryModes({ areaCode, id, requestHeaders }?: CartPlatformApplicationValidator.GetAvailableDeliveryModesParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDeliveryModesResponse>;
|
|
268
223
|
/**
|
|
269
|
-
* @param {
|
|
270
|
-
* @param {
|
|
271
|
-
* @param {
|
|
272
|
-
* @
|
|
273
|
-
* @
|
|
274
|
-
* @param {number} [arg.assignCardId] -
|
|
275
|
-
* @param {boolean} [arg.buyNow] -
|
|
276
|
-
* @returns {Promise<CartDetailResponse>} - Success response
|
|
224
|
+
* @param {CartPlatformApplicationValidator.GetCartParam} arg - Arg object
|
|
225
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
226
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
227
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
228
|
+
* @name getCart
|
|
277
229
|
* @summary: Fetch all items added to the customer cart using cart id
|
|
278
|
-
* @description: Use this API to get details of all the items added to a cart.
|
|
230
|
+
* @description: Use this API to get details of all the items added to a cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCart/).
|
|
279
231
|
*/
|
|
280
|
-
getCart({ id, userId, i, b, assignCardId, buyNow }?: {
|
|
281
|
-
id?: string;
|
|
282
|
-
userId?: string;
|
|
283
|
-
i?: boolean;
|
|
284
|
-
b?: boolean;
|
|
285
|
-
assignCardId?: number;
|
|
286
|
-
buyNow?: boolean;
|
|
287
|
-
}): Promise<CartDetailResponse>;
|
|
232
|
+
getCart({ id, userId, i, b, assignCardId, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
288
233
|
/**
|
|
289
|
-
* @param {
|
|
290
|
-
* @param {
|
|
291
|
-
* @param {
|
|
292
|
-
* @
|
|
293
|
-
* @
|
|
234
|
+
* @param {CartPlatformApplicationValidator.GetCartListParam} arg - Arg object
|
|
235
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
236
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
237
|
+
* @returns {Promise<CartPlatformModel.MultiCartResponse>} - Success response
|
|
238
|
+
* @name getCartList
|
|
294
239
|
* @summary: Get cart list for store os user
|
|
295
|
-
* @description: Get all carts for the store os user which is created for customer
|
|
240
|
+
* @description: Get all carts for the store os user which is created for customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartList/).
|
|
296
241
|
*/
|
|
297
|
-
getCartList({ fromDate, toDate, filterOn }?: {
|
|
298
|
-
fromDate?: string;
|
|
299
|
-
toDate?: string;
|
|
300
|
-
filterOn?: string;
|
|
301
|
-
}): Promise<MultiCartResponse>;
|
|
242
|
+
getCartList({ fromDate, toDate, filterOn, requestHeaders }?: CartPlatformApplicationValidator.GetCartListParam, { responseHeaders }?: object): Promise<CartPlatformModel.MultiCartResponse>;
|
|
302
243
|
/**
|
|
303
|
-
* @param {
|
|
304
|
-
* @param {
|
|
305
|
-
* @
|
|
244
|
+
* @param {CartPlatformApplicationValidator.GetCartShareLinkParam} arg - Arg object
|
|
245
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
246
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
247
|
+
* @returns {Promise<CartPlatformModel.GetShareCartLinkResponse>} - Success response
|
|
248
|
+
* @name getCartShareLink
|
|
306
249
|
* @summary: Generate token for sharing the cart
|
|
307
|
-
* @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart.
|
|
250
|
+
* @description: Use this API to generate a shared cart snapshot and return a shortlink token. The link can be shared with other users for getting the same items in their cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartShareLink/).
|
|
308
251
|
*/
|
|
309
|
-
getCartShareLink({ body }?: {
|
|
310
|
-
body: GetShareCartLinkRequest;
|
|
311
|
-
}): Promise<GetShareCartLinkResponse>;
|
|
252
|
+
getCartShareLink({ body, requestHeaders }?: CartPlatformApplicationValidator.GetCartShareLinkParam, { responseHeaders }?: object): Promise<CartPlatformModel.GetShareCartLinkResponse>;
|
|
312
253
|
/**
|
|
313
|
-
* @param {
|
|
314
|
-
* @param {
|
|
315
|
-
* @
|
|
254
|
+
* @param {CartPlatformApplicationValidator.GetCartSharedItemsParam} arg - Arg object
|
|
255
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
256
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
257
|
+
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
258
|
+
* @name getCartSharedItems
|
|
316
259
|
* @summary: Get details of a shared cart
|
|
317
|
-
* @description: Use this API to get the shared cart details as per the token generated using the share-cart API.
|
|
260
|
+
* @description: Use this API to get the shared cart details as per the token generated using the share-cart API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCartSharedItems/).
|
|
318
261
|
*/
|
|
319
|
-
getCartSharedItems({ token }?: {
|
|
320
|
-
token: string;
|
|
321
|
-
}): Promise<SharedCartResponse>;
|
|
262
|
+
getCartSharedItems({ token, requestHeaders }?: CartPlatformApplicationValidator.GetCartSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
322
263
|
/**
|
|
323
|
-
* @param {
|
|
324
|
-
* @param {
|
|
325
|
-
* @
|
|
264
|
+
* @param {CartPlatformApplicationValidator.GetCouponByIdParam} arg - Arg object
|
|
265
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
266
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
267
|
+
* @returns {Promise<CartPlatformModel.CouponUpdate>} - Success response
|
|
268
|
+
* @name getCouponById
|
|
326
269
|
* @summary: Get with single coupon details or coupon list
|
|
327
|
-
* @description: Get single coupon details with `id` in path param
|
|
270
|
+
* @description: Get single coupon details with `id` in path param - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponById/).
|
|
328
271
|
*/
|
|
329
|
-
getCouponById({ id }?: {
|
|
330
|
-
id: string;
|
|
331
|
-
}): Promise<CouponUpdate>;
|
|
272
|
+
getCouponById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetCouponByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponUpdate>;
|
|
332
273
|
/**
|
|
333
|
-
* @param {
|
|
334
|
-
* @param {
|
|
274
|
+
* @param {CartPlatformApplicationValidator.GetCouponCodeExistsParam} arg - Arg object
|
|
275
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
276
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
335
277
|
* @returns {Promise<Object>} - Success response
|
|
278
|
+
* @name getCouponCodeExists
|
|
336
279
|
* @summary: Check if coupon is already created with coupon code
|
|
337
|
-
* @description: Check if sent coupon code is already existing coupon code. As coupon code is to be unique.
|
|
280
|
+
* @description: Check if sent coupon code is already existing coupon code. As coupon code is to be unique. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponCodeExists/).
|
|
338
281
|
*/
|
|
339
|
-
getCouponCodeExists({ code }?: {
|
|
340
|
-
code?: string;
|
|
341
|
-
}): Promise<any>;
|
|
282
|
+
getCouponCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetCouponCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
342
283
|
/**
|
|
343
|
-
* @param {
|
|
284
|
+
* @param {CartPlatformApplicationValidator.GetCouponOptionValuesParam} arg
|
|
285
|
+
* - Arg object
|
|
286
|
+
*
|
|
287
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
288
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
344
289
|
* @returns {Promise<Object>} - Success response
|
|
290
|
+
* @name getCouponOptionValues
|
|
345
291
|
* @summary: Get coupon options enums with display values
|
|
346
|
-
* @description: Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields
|
|
292
|
+
* @description: Get coupon enum values for fields in valid coupon object. Used for front end to create, update and filter coupon lists via fields - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCouponOptionValues/).
|
|
347
293
|
*/
|
|
348
|
-
getCouponOptionValues({}?: any): Promise<any>;
|
|
294
|
+
getCouponOptionValues({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
|
|
349
295
|
/**
|
|
350
|
-
* @param {
|
|
351
|
-
* @param {
|
|
352
|
-
* @param {
|
|
353
|
-
* @
|
|
354
|
-
* @
|
|
355
|
-
* @param {boolean} [arg.isPublic] -
|
|
356
|
-
* @param {boolean} [arg.isDisplay] -
|
|
357
|
-
* @param {string} [arg.typeSlug] -
|
|
358
|
-
* @param {string} [arg.code] -
|
|
359
|
-
* @returns {Promise<CouponsResponse>} - Success response
|
|
296
|
+
* @param {CartPlatformApplicationValidator.GetCouponsParam} arg - Arg object
|
|
297
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
298
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
299
|
+
* @returns {Promise<CartPlatformModel.CouponsResponse>} - Success response
|
|
300
|
+
* @name getCoupons
|
|
360
301
|
* @summary: Get with single coupon details or coupon list
|
|
361
|
-
* @description: Get coupon list with pagination
|
|
302
|
+
* @description: Get coupon list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getCoupons/).
|
|
362
303
|
*/
|
|
363
|
-
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, }?: {
|
|
364
|
-
pageNo?: number;
|
|
365
|
-
pageSize?: number;
|
|
366
|
-
isArchived?: boolean;
|
|
367
|
-
title?: string;
|
|
368
|
-
isPublic?: boolean;
|
|
369
|
-
isDisplay?: boolean;
|
|
370
|
-
typeSlug?: string;
|
|
371
|
-
code?: string;
|
|
372
|
-
}): Promise<CouponsResponse>;
|
|
304
|
+
getCoupons({ pageNo, pageSize, isArchived, title, isPublic, isDisplay, typeSlug, code, requestHeaders, }?: CartPlatformApplicationValidator.GetCouponsParam, { responseHeaders }?: object): Promise<CartPlatformModel.CouponsResponse>;
|
|
373
305
|
/**
|
|
374
306
|
* @param {Object} arg - Arg object.
|
|
375
307
|
* @param {string} arg.companyId - Current company id
|
|
@@ -381,6 +313,7 @@ declare class Cart {
|
|
|
381
313
|
* @param {boolean} [arg.isDisplay] -
|
|
382
314
|
* @param {string} [arg.typeSlug] -
|
|
383
315
|
* @param {string} [arg.code] -
|
|
316
|
+
* @returns {Paginator<CartPlatformModel.CouponsResponse>}
|
|
384
317
|
* @summary: Get with single coupon details or coupon list
|
|
385
318
|
* @description: Get coupon list with pagination
|
|
386
319
|
*/
|
|
@@ -394,75 +327,61 @@ declare class Cart {
|
|
|
394
327
|
isDisplay?: boolean;
|
|
395
328
|
typeSlug?: string;
|
|
396
329
|
code?: string;
|
|
397
|
-
}): Paginator
|
|
330
|
+
}): Paginator<CartPlatformModel.CouponsResponse>;
|
|
398
331
|
/**
|
|
399
|
-
* @param {
|
|
400
|
-
* @param {
|
|
401
|
-
* @param {
|
|
402
|
-
* @returns {Promise<CartItemCountResponse>} - Success response
|
|
332
|
+
* @param {CartPlatformApplicationValidator.GetItemCountParam} arg - Arg object
|
|
333
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
334
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
335
|
+
* @returns {Promise<CartPlatformModel.CartItemCountResponse>} - Success response
|
|
336
|
+
* @name getItemCount
|
|
403
337
|
* @summary: Count items in the customer's cart
|
|
404
|
-
* @description: Use this API to get the total number of items present in cart.
|
|
338
|
+
* @description: Use this API to get the total number of items present in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getItemCount/).
|
|
405
339
|
*/
|
|
406
|
-
getItemCount({ id, buyNow }?: {
|
|
407
|
-
id?: string;
|
|
408
|
-
buyNow?: boolean;
|
|
409
|
-
}): Promise<CartItemCountResponse>;
|
|
340
|
+
getItemCount({ id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.GetItemCountParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartItemCountResponse>;
|
|
410
341
|
/**
|
|
411
|
-
* @param {
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
* @
|
|
342
|
+
* @param {CartPlatformApplicationValidator.GetPromosCouponConfigParam} arg
|
|
343
|
+
* - Arg object
|
|
344
|
+
*
|
|
345
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
346
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
347
|
+
* @returns {Promise<CartPlatformModel.ActivePromosResponse>} - Success response
|
|
348
|
+
* @name getPromosCouponConfig
|
|
415
349
|
* @summary: Fetch all promos that are set as active
|
|
416
|
-
* @description: Use this API to get list of all the active promos/coupons.
|
|
350
|
+
* @description: Use this API to get list of all the active promos/coupons. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromosCouponConfig/).
|
|
417
351
|
*/
|
|
418
|
-
getPromosCouponConfig({ entityType, isHidden }?: {
|
|
419
|
-
entityType?: string;
|
|
420
|
-
isHidden?: boolean;
|
|
421
|
-
}): Promise<ActivePromosResponse>;
|
|
352
|
+
getPromosCouponConfig({ entityType, isHidden, requestHeaders }?: CartPlatformApplicationValidator.GetPromosCouponConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.ActivePromosResponse>;
|
|
422
353
|
/**
|
|
423
|
-
* @param {
|
|
424
|
-
* @param {
|
|
425
|
-
* @
|
|
354
|
+
* @param {CartPlatformApplicationValidator.GetPromotionByIdParam} arg - Arg object
|
|
355
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
356
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
357
|
+
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
358
|
+
* @name getPromotionById
|
|
426
359
|
* @summary: Get with single promotion details or promotion list
|
|
427
|
-
* @description: Get single promotion details with `id` in path param
|
|
360
|
+
* @description: Get single promotion details with `id` in path param - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionById/).
|
|
428
361
|
*/
|
|
429
|
-
getPromotionById({ id }?: {
|
|
430
|
-
id: string;
|
|
431
|
-
}): Promise<PromotionUpdate>;
|
|
362
|
+
getPromotionById({ id, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionByIdParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
432
363
|
/**
|
|
433
|
-
* @param {
|
|
434
|
-
*
|
|
364
|
+
* @param {CartPlatformApplicationValidator.GetPromotionCodeExistsParam} arg
|
|
365
|
+
* - Arg object
|
|
366
|
+
*
|
|
367
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
368
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
435
369
|
* @returns {Promise<Object>} - Success response
|
|
370
|
+
* @name getPromotionCodeExists
|
|
436
371
|
* @summary: Check if promotion is already created with promotion code
|
|
437
|
-
* @description: Check if sent promotion code is already existing promotion code. As promotion code is to be unique.
|
|
372
|
+
* @description: Check if sent promotion code is already existing promotion code. As promotion code is to be unique. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotionCodeExists/).
|
|
438
373
|
*/
|
|
439
|
-
getPromotionCodeExists({ code }?: {
|
|
440
|
-
code?: string;
|
|
441
|
-
}): Promise<any>;
|
|
374
|
+
getPromotionCodeExists({ code, requestHeaders }?: CartPlatformApplicationValidator.GetPromotionCodeExistsParam, { responseHeaders }?: object): Promise<any>;
|
|
442
375
|
/**
|
|
443
|
-
* @param {
|
|
444
|
-
* @param {
|
|
445
|
-
* @param {
|
|
446
|
-
* @
|
|
447
|
-
* @
|
|
448
|
-
* @param {string} [arg.promoGroup] -
|
|
449
|
-
* @param {string} [arg.promotionType] -
|
|
450
|
-
* @param {string} [arg.fpPanel] -
|
|
451
|
-
* @param {string} [arg.promotionId] -
|
|
452
|
-
* @returns {Promise<PromotionsResponse>} - Success response
|
|
376
|
+
* @param {CartPlatformApplicationValidator.GetPromotionsParam} arg - Arg object
|
|
377
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
378
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
379
|
+
* @returns {Promise<CartPlatformModel.PromotionsResponse>} - Success response
|
|
380
|
+
* @name getPromotions
|
|
453
381
|
* @summary: Get promotion list
|
|
454
|
-
* @description: Get promotion list with pagination
|
|
382
|
+
* @description: Get promotion list with pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getPromotions/).
|
|
455
383
|
*/
|
|
456
|
-
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, }?: {
|
|
457
|
-
pageNo?: number;
|
|
458
|
-
pageSize?: number;
|
|
459
|
-
q?: string;
|
|
460
|
-
isActive?: boolean;
|
|
461
|
-
promoGroup?: string;
|
|
462
|
-
promotionType?: string;
|
|
463
|
-
fpPanel?: string;
|
|
464
|
-
promotionId?: string;
|
|
465
|
-
}): Promise<PromotionsResponse>;
|
|
384
|
+
getPromotions({ pageNo, pageSize, q, isActive, promoGroup, promotionType, fpPanel, promotionId, requestHeaders, }?: CartPlatformApplicationValidator.GetPromotionsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionsResponse>;
|
|
466
385
|
/**
|
|
467
386
|
* @param {Object} arg - Arg object.
|
|
468
387
|
* @param {string} arg.companyId - Current company id
|
|
@@ -474,6 +393,7 @@ declare class Cart {
|
|
|
474
393
|
* @param {string} [arg.promotionType] -
|
|
475
394
|
* @param {string} [arg.fpPanel] -
|
|
476
395
|
* @param {string} [arg.promotionId] -
|
|
396
|
+
* @returns {Paginator<CartPlatformModel.PromotionsResponse>}
|
|
477
397
|
* @summary: Get promotion list
|
|
478
398
|
* @description: Get promotion list with pagination
|
|
479
399
|
*/
|
|
@@ -487,391 +407,290 @@ declare class Cart {
|
|
|
487
407
|
promotionType?: string;
|
|
488
408
|
fpPanel?: string;
|
|
489
409
|
promotionId?: string;
|
|
490
|
-
}): Paginator
|
|
491
|
-
/**
|
|
492
|
-
* @param {
|
|
493
|
-
* @param {
|
|
494
|
-
* @param {
|
|
495
|
-
* @
|
|
496
|
-
*
|
|
497
|
-
* @
|
|
498
|
-
* getting a payment option in response.
|
|
499
|
-
* @param {string} [arg.id] - The unique identifier of the cart
|
|
500
|
-
* @param {string} [arg.addressId] - ID allotted to the selected address
|
|
501
|
-
* @param {string} [arg.areaCode] - The PIN Code of the destination address,
|
|
502
|
-
* e.g. 400059
|
|
503
|
-
* @param {string} [arg.orderType] - The order type of shipment HomeDelivery
|
|
504
|
-
* - If the customer wants the order home-delivered PickAtStore - If the
|
|
505
|
-
* customer wants the handover of an order at the store itself.
|
|
506
|
-
* @returns {Promise<PlatformCartShipmentsResponse>} - Success response
|
|
410
|
+
}): Paginator<CartPlatformModel.PromotionsResponse>;
|
|
411
|
+
/**
|
|
412
|
+
* @param {CartPlatformApplicationValidator.GetShipmentsParam} arg - Arg object
|
|
413
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
414
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
415
|
+
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
416
|
+
* Success response
|
|
417
|
+
* @name getShipments
|
|
507
418
|
* @summary: Get delivery date and options before checkout
|
|
508
|
-
* @description: Use this API to get shipment details, expected delivery date, items and price breakup of the shipment.
|
|
509
|
-
*/
|
|
510
|
-
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, }?: {
|
|
511
|
-
pickAtStoreUid?: number;
|
|
512
|
-
orderingStoreId?: number;
|
|
513
|
-
i?: boolean;
|
|
514
|
-
p?: boolean;
|
|
515
|
-
id?: string;
|
|
516
|
-
addressId?: string;
|
|
517
|
-
areaCode?: string;
|
|
518
|
-
orderType?: string;
|
|
519
|
-
}): Promise<PlatformCartShipmentsResponse>;
|
|
419
|
+
* @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/).
|
|
420
|
+
*/
|
|
421
|
+
getShipments({ pickAtStoreUid, orderingStoreId, i, p, id, addressId, areaCode, orderType, requestHeaders, }?: CartPlatformApplicationValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
520
422
|
/**
|
|
521
|
-
* @param {
|
|
522
|
-
*
|
|
523
|
-
*
|
|
423
|
+
* @param {CartPlatformApplicationValidator.GetStoreAddressByUidParam} arg
|
|
424
|
+
* - Arg object
|
|
425
|
+
*
|
|
426
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
427
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
428
|
+
* @returns {Promise<CartPlatformModel.StoreDetailsResponse>} - Success response
|
|
429
|
+
* @name getStoreAddressByUid
|
|
524
430
|
* @summary: Get list of stores for give uids
|
|
525
|
-
* @description: Use this API to get the store details by entering the unique identifier of the pickup stores shown in the response of available-delivery-mode API.
|
|
431
|
+
* @description: Use this API to get the store details by entering the unique identifier of the pickup stores shown in the response of available-delivery-mode API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/getStoreAddressByUid/).
|
|
526
432
|
*/
|
|
527
|
-
getStoreAddressByUid({ storeUid }?: {
|
|
528
|
-
storeUid: number;
|
|
529
|
-
}): Promise<StoreDetailsResponse>;
|
|
433
|
+
getStoreAddressByUid({ storeUid, requestHeaders }?: CartPlatformApplicationValidator.GetStoreAddressByUidParam, { responseHeaders }?: object): Promise<CartPlatformModel.StoreDetailsResponse>;
|
|
530
434
|
/**
|
|
531
|
-
* @param {
|
|
532
|
-
* @param {
|
|
533
|
-
* @
|
|
435
|
+
* @param {CartPlatformApplicationValidator.OverrideCartParam} arg - Arg object
|
|
436
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
437
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
438
|
+
* @returns {Promise<CartPlatformModel.OverrideCheckoutResponse>} - Success response
|
|
439
|
+
* @name overrideCart
|
|
534
440
|
* @summary: Create Fynd order with overriding cart details
|
|
535
|
-
* @description: Generate Fynd order while overriding cart details sent with provided `cart_items`
|
|
441
|
+
* @description: Generate Fynd order while overriding cart details sent with provided `cart_items` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/overrideCart/).
|
|
536
442
|
*/
|
|
537
|
-
overrideCart({ body }?: {
|
|
538
|
-
body: OverrideCheckoutReq;
|
|
539
|
-
}): Promise<OverrideCheckoutResponse>;
|
|
443
|
+
overrideCart({ body, requestHeaders }?: CartPlatformApplicationValidator.OverrideCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.OverrideCheckoutResponse>;
|
|
540
444
|
/**
|
|
541
|
-
* @param {
|
|
542
|
-
* @param {
|
|
543
|
-
* @param {
|
|
544
|
-
* @
|
|
545
|
-
* @
|
|
546
|
-
* @param {PlatformAddCartRequest} arg.body
|
|
547
|
-
* @returns {Promise<AddCartDetailResponse>} - Success response
|
|
445
|
+
* @param {CartPlatformApplicationValidator.PlatformAddItemsParam} arg - Arg object
|
|
446
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
447
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
448
|
+
* @returns {Promise<CartPlatformModel.AddCartDetailResponse>} - Success response
|
|
449
|
+
* @name platformAddItems
|
|
548
450
|
* @summary: Add items to cart
|
|
549
|
-
* @description: Use this API to add items to the cart.
|
|
451
|
+
* @description: Use this API to add items to the cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformAddItems/).
|
|
550
452
|
*/
|
|
551
|
-
platformAddItems({ body, i, b, buyNow, id }?: {
|
|
552
|
-
i?: boolean;
|
|
553
|
-
b?: boolean;
|
|
554
|
-
buyNow?: boolean;
|
|
555
|
-
id?: string;
|
|
556
|
-
body: PlatformAddCartRequest;
|
|
557
|
-
}): Promise<AddCartDetailResponse>;
|
|
453
|
+
platformAddItems({ body, i, b, buyNow, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformAddItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.AddCartDetailResponse>;
|
|
558
454
|
/**
|
|
559
|
-
* @param {
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
* @
|
|
455
|
+
* @param {CartPlatformApplicationValidator.PlatformCheckoutCartParam} arg
|
|
456
|
+
* - Arg object
|
|
457
|
+
*
|
|
458
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
459
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
460
|
+
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
461
|
+
* @name platformCheckoutCart
|
|
563
462
|
* @summary: Checkout all items in the cart
|
|
564
|
-
* @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be generated directly, whereas for other checkout modes, user will be redirected to a payment gateway.
|
|
463
|
+
* @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be generated directly, whereas for other checkout modes, user will be redirected to a payment gateway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCart/).
|
|
565
464
|
*/
|
|
566
|
-
platformCheckoutCart({ body, id }?: {
|
|
567
|
-
id?: string;
|
|
568
|
-
body: PlatformCartCheckoutDetailRequest;
|
|
569
|
-
}): Promise<CartCheckoutResponse>;
|
|
465
|
+
platformCheckoutCart({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
570
466
|
/**
|
|
571
|
-
* @param {
|
|
572
|
-
*
|
|
573
|
-
*
|
|
574
|
-
* @
|
|
467
|
+
* @param {CartPlatformApplicationValidator.PlatformCheckoutCartV2Param} arg
|
|
468
|
+
* - Arg object
|
|
469
|
+
*
|
|
470
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
471
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
472
|
+
* @returns {Promise<CartPlatformModel.CartCheckoutResponse>} - Success response
|
|
473
|
+
* @name platformCheckoutCartV2
|
|
575
474
|
* @summary: Checkout all items in the cart
|
|
576
|
-
* @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway.
|
|
475
|
+
* @description: Use this API to checkout all items in the cart for payment and order generation. For COD, order will be directly generated, whereas for other checkout modes, user will be redirected to a payment gateway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformCheckoutCartV2/).
|
|
577
476
|
*/
|
|
578
|
-
platformCheckoutCartV2({ body, id }?: {
|
|
579
|
-
id?: string;
|
|
580
|
-
body: PlatformCartCheckoutDetailV2Request;
|
|
581
|
-
}): Promise<CartCheckoutResponse>;
|
|
477
|
+
platformCheckoutCartV2({ body, id, requestHeaders }?: CartPlatformApplicationValidator.PlatformCheckoutCartV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartCheckoutResponse>;
|
|
582
478
|
/**
|
|
583
|
-
* @param {
|
|
584
|
-
* @param {
|
|
585
|
-
* @param {
|
|
586
|
-
* @
|
|
587
|
-
* @
|
|
588
|
-
* @param {PlatformUpdateCartRequest} arg.body
|
|
589
|
-
* @returns {Promise<UpdateCartDetailResponse>} - Success response
|
|
479
|
+
* @param {CartPlatformApplicationValidator.PlatformUpdateCartParam} arg - Arg object
|
|
480
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
481
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
482
|
+
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
483
|
+
* @name platformUpdateCart
|
|
590
484
|
* @summary: Update items in the customer 's cart using cart id
|
|
591
|
-
* @description:
|
|
485
|
+
* @description: Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs operation Operation for current api call. update_item for update items. remove_item for removing items.item_id "/platform/content/v1/products/" item_size "/platform/content/v1/products/:slug/sizes/" quantity item quantity (must be greater than or equal to 1) article_id "/content/v1/products/:identifier/sizes/price/" item_index item position in the cart (must be greater than or equal to 0) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/platformUpdateCart/).
|
|
592
486
|
*/
|
|
593
|
-
platformUpdateCart({ body, id, i, b, buyNow }?: {
|
|
594
|
-
id?: string;
|
|
595
|
-
i?: boolean;
|
|
596
|
-
b?: boolean;
|
|
597
|
-
buyNow?: boolean;
|
|
598
|
-
body: PlatformUpdateCartRequest;
|
|
599
|
-
}): Promise<UpdateCartDetailResponse>;
|
|
487
|
+
platformUpdateCart({ body, id, i, b, buyNow, requestHeaders }?: CartPlatformApplicationValidator.PlatformUpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
600
488
|
/**
|
|
601
|
-
* @param {
|
|
602
|
-
* @param {
|
|
603
|
-
* @param {
|
|
604
|
-
* @returns {Promise<DeleteAddressResponse>} - Success response
|
|
489
|
+
* @param {CartPlatformApplicationValidator.RemoveAddressParam} arg - Arg object
|
|
490
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
491
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
492
|
+
* @returns {Promise<CartPlatformModel.DeleteAddressResponse>} - Success response
|
|
493
|
+
* @name removeAddress
|
|
605
494
|
* @summary: Remove address associated with an account
|
|
606
|
-
* @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not.
|
|
495
|
+
* @description: Use this API to delete an address by its ID. This will returns an object that will indicate whether the address was deleted successfully or not. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeAddress/).
|
|
607
496
|
*/
|
|
608
|
-
removeAddress({ id, userId }?: {
|
|
609
|
-
id: string;
|
|
610
|
-
userId?: string;
|
|
611
|
-
}): Promise<DeleteAddressResponse>;
|
|
497
|
+
removeAddress({ id, userId, requestHeaders }?: CartPlatformApplicationValidator.RemoveAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.DeleteAddressResponse>;
|
|
612
498
|
/**
|
|
613
|
-
* @param {
|
|
614
|
-
* @param {
|
|
615
|
-
* @param {
|
|
616
|
-
* @returns {Promise<CartDetailResponse>} - Success response
|
|
499
|
+
* @param {CartPlatformApplicationValidator.RemoveCouponParam} arg - Arg object
|
|
500
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
501
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
502
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
503
|
+
* @name removeCoupon
|
|
617
504
|
* @summary: Remove Applied Coupon for platform pos user
|
|
618
|
-
* @description: Remove Coupon applied on the cart by passing uid in request body.
|
|
505
|
+
* @description: Remove Coupon applied on the cart by passing uid in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removeCoupon/).
|
|
619
506
|
*/
|
|
620
|
-
removeCoupon({ uid, buyNow }?: {
|
|
621
|
-
uid?: string;
|
|
622
|
-
buyNow?: boolean;
|
|
623
|
-
}): Promise<CartDetailResponse>;
|
|
507
|
+
removeCoupon({ uid, buyNow, requestHeaders }?: CartPlatformApplicationValidator.RemoveCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
624
508
|
/**
|
|
625
|
-
* @param {
|
|
626
|
-
*
|
|
627
|
-
*
|
|
509
|
+
* @param {CartPlatformApplicationValidator.RemovePriceAdjustmentParam} arg
|
|
510
|
+
* - Arg object
|
|
511
|
+
*
|
|
512
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
513
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
514
|
+
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
515
|
+
* @name removePriceAdjustment
|
|
628
516
|
* @summary: Remove price adjustment
|
|
629
|
-
* @description: Remove price adjustment
|
|
517
|
+
* @description: Remove price adjustment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/removePriceAdjustment/).
|
|
630
518
|
*/
|
|
631
|
-
removePriceAdjustment({ id }?: {
|
|
632
|
-
id: string;
|
|
633
|
-
}): Promise<SuccessMessage>;
|
|
519
|
+
removePriceAdjustment({ id, requestHeaders }?: CartPlatformApplicationValidator.RemovePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
634
520
|
/**
|
|
635
|
-
* @param {
|
|
636
|
-
* @param {
|
|
637
|
-
* @param {
|
|
638
|
-
* @
|
|
639
|
-
* @
|
|
640
|
-
* @param {PlatformSelectCartAddressRequest} arg.body
|
|
641
|
-
* @returns {Promise<CartDetailResponse>} - Success response
|
|
521
|
+
* @param {CartPlatformApplicationValidator.SelectAddressParam} arg - Arg object
|
|
522
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
523
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
524
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
525
|
+
* @name selectAddress
|
|
642
526
|
* @summary: Select an address from available addresses
|
|
643
|
-
* @description:
|
|
527
|
+
* @description: Select Address from all addresses associated with the account in order to ship the cart items to that address, otherwise default address will be selected implicitly. See `PlatformSelectCartAddressRequest` in schema of request body for the list of attributes needed to select Address from account. On successful request, this API returns a Cart object. Below address attributes are required. address_id billing_address_id uid - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectAddress/).
|
|
644
528
|
*/
|
|
645
|
-
selectAddress({ body, cartId, buyNow, i, b }?: {
|
|
646
|
-
cartId?: string;
|
|
647
|
-
buyNow?: boolean;
|
|
648
|
-
i?: boolean;
|
|
649
|
-
b?: boolean;
|
|
650
|
-
body: PlatformSelectCartAddressRequest;
|
|
651
|
-
}): Promise<CartDetailResponse>;
|
|
529
|
+
selectAddress({ body, cartId, buyNow, i, b, requestHeaders }?: CartPlatformApplicationValidator.SelectAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
652
530
|
/**
|
|
653
|
-
* @param {
|
|
654
|
-
* @param {
|
|
655
|
-
* @param {
|
|
656
|
-
* @
|
|
657
|
-
*
|
|
658
|
-
* customer wants the handover of an order at the store itself.
|
|
659
|
-
* @param {UpdateCartPaymentRequest} arg.body
|
|
660
|
-
* @returns {Promise<CartDetailResponse>} - Success response
|
|
531
|
+
* @param {CartPlatformApplicationValidator.SelectPaymentModeParam} arg - Arg object
|
|
532
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
533
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
534
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
535
|
+
* @name selectPaymentMode
|
|
661
536
|
* @summary: Update cart payment
|
|
662
|
-
* @description: Use this API to update cart payment.
|
|
537
|
+
* @description: Use this API to update cart payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentMode/).
|
|
663
538
|
*/
|
|
664
|
-
selectPaymentMode({ body, id, buyNow, orderType }?: {
|
|
665
|
-
id?: string;
|
|
666
|
-
buyNow?: boolean;
|
|
667
|
-
orderType?: string;
|
|
668
|
-
body: UpdateCartPaymentRequest;
|
|
669
|
-
}): Promise<CartDetailResponse>;
|
|
539
|
+
selectPaymentMode({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
670
540
|
/**
|
|
671
|
-
* @param {
|
|
672
|
-
* @param {
|
|
673
|
-
* @param {
|
|
674
|
-
* @
|
|
675
|
-
*
|
|
676
|
-
* customer wants the handover of an order at the store itself.
|
|
677
|
-
* @param {UpdateCartPaymentRequestV2} arg.body
|
|
678
|
-
* @returns {Promise<CartDetailResponse>} - Success response
|
|
541
|
+
* @param {CartPlatformApplicationValidator.SelectPaymentModeV2Param} arg - Arg object
|
|
542
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
543
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
544
|
+
* @returns {Promise<CartPlatformModel.CartDetailResponse>} - Success response
|
|
545
|
+
* @name selectPaymentModeV2
|
|
679
546
|
* @summary: Update cart payment
|
|
680
|
-
* @description: Use this API to update cart payment.
|
|
547
|
+
* @description: Use this API to update cart payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/selectPaymentModeV2/).
|
|
681
548
|
*/
|
|
682
|
-
selectPaymentModeV2({ body, id, buyNow, orderType }?: {
|
|
683
|
-
id?: string;
|
|
684
|
-
buyNow?: boolean;
|
|
685
|
-
orderType?: string;
|
|
686
|
-
body: UpdateCartPaymentRequestV2;
|
|
687
|
-
}): Promise<CartDetailResponse>;
|
|
549
|
+
selectPaymentModeV2({ body, id, buyNow, orderType, requestHeaders }?: CartPlatformApplicationValidator.SelectPaymentModeV2Param, { responseHeaders }?: object): Promise<CartPlatformModel.CartDetailResponse>;
|
|
688
550
|
/**
|
|
689
|
-
* @param {
|
|
690
|
-
* @param {
|
|
691
|
-
* @param {
|
|
692
|
-
* @returns {Promise<UpdateAddressResponse>} - Success response
|
|
551
|
+
* @param {CartPlatformApplicationValidator.UpdateAddressParam} arg - Arg object
|
|
552
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
553
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
554
|
+
* @returns {Promise<CartPlatformModel.UpdateAddressResponse>} - Success response
|
|
555
|
+
* @name updateAddress
|
|
693
556
|
* @summary: Update address added to an account
|
|
694
|
-
* @description:
|
|
557
|
+
* @description: Use this API to update an existing address in the account. Request object should contain attributes mentioned in Address can be updated. These attributes are:is_default_address landmark area pincode email address_type name address_id address - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateAddress/).
|
|
695
558
|
*/
|
|
696
|
-
updateAddress({ id, body }?: {
|
|
697
|
-
id: string;
|
|
698
|
-
body: PlatformAddress;
|
|
699
|
-
}): Promise<UpdateAddressResponse>;
|
|
559
|
+
updateAddress({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateAddressParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateAddressResponse>;
|
|
700
560
|
/**
|
|
701
|
-
* @param {
|
|
702
|
-
* @param {
|
|
703
|
-
* @param {
|
|
704
|
-
* @
|
|
705
|
-
* @
|
|
561
|
+
* @param {CartPlatformApplicationValidator.UpdateCartParam} arg - Arg object
|
|
562
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
563
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
564
|
+
* @returns {Promise<CartPlatformModel.UpdateCartDetailResponse>} - Success response
|
|
565
|
+
* @name updateCart
|
|
706
566
|
* @summary: Update items in the abandoned cart
|
|
707
|
-
* @description:
|
|
567
|
+
* @description: Use this API to update items added to the cart with the help of a request object containing attributes like item_quantity and item_size. These attributes will be fetched from the following APIs operation Operation for current api call.update_item for update items. remove_item for removing items. item_id "/platform/content/v1/products/" "/platform/content/v1/products/:slug/sizes/" quantity item quantity (must be greater than or equal to 1) article_id "/content/v1/products/:identifier/sizes/price/" item position in the cart (must be greater than or equal to 0) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCart/).
|
|
708
568
|
*/
|
|
709
|
-
updateCart({ cartId, body, b }?: {
|
|
710
|
-
cartId: string;
|
|
711
|
-
b?: boolean;
|
|
712
|
-
body: UpdateCartRequest;
|
|
713
|
-
}): Promise<UpdateCartDetailResponse>;
|
|
569
|
+
updateCart({ cartId, body, b, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartParam, { responseHeaders }?: object): Promise<CartPlatformModel.UpdateCartDetailResponse>;
|
|
714
570
|
/**
|
|
715
|
-
* @param {
|
|
716
|
-
* @param {
|
|
717
|
-
* @param {
|
|
718
|
-
* @
|
|
719
|
-
* @
|
|
571
|
+
* @param {CartPlatformApplicationValidator.UpdateCartMetaParam} arg - Arg object
|
|
572
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
573
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
574
|
+
* @returns {Promise<CartPlatformModel.CartMetaResponse>} - Success response
|
|
575
|
+
* @name updateCartMeta
|
|
720
576
|
* @summary: Update the cart meta for platform pos user
|
|
721
|
-
* @description: Use this API to update cart meta like checkout_mode and gstin.
|
|
577
|
+
* @description: Use this API to update cart meta like checkout_mode and gstin. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMeta/).
|
|
722
578
|
*/
|
|
723
|
-
updateCartMeta({ body, id, buyNow }?: {
|
|
724
|
-
id?: string;
|
|
725
|
-
buyNow?: boolean;
|
|
726
|
-
body: PlatformCartMetaRequest;
|
|
727
|
-
}): Promise<CartMetaResponse>;
|
|
579
|
+
updateCartMeta({ body, id, buyNow, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaResponse>;
|
|
728
580
|
/**
|
|
729
|
-
* @param {
|
|
730
|
-
*
|
|
731
|
-
*
|
|
732
|
-
* @
|
|
581
|
+
* @param {CartPlatformApplicationValidator.UpdateCartMetaConfigParam} arg
|
|
582
|
+
* - Arg object
|
|
583
|
+
*
|
|
584
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
585
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
586
|
+
* @returns {Promise<CartPlatformModel.CartMetaConfigUpdate>} - Success response
|
|
587
|
+
* @name updateCartMetaConfig
|
|
733
588
|
* @summary: Update cart meta configuration
|
|
734
|
-
* @description: Update cart meta configuration
|
|
589
|
+
* @description: Update cart meta configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartMetaConfig/).
|
|
735
590
|
*/
|
|
736
|
-
updateCartMetaConfig({ cartMetaId, body }?: {
|
|
737
|
-
cartMetaId: string;
|
|
738
|
-
body: CartMetaConfigUpdate;
|
|
739
|
-
}): Promise<CartMetaConfigUpdate>;
|
|
591
|
+
updateCartMetaConfig({ cartMetaId, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartMetaConfigParam, { responseHeaders }?: object): Promise<CartPlatformModel.CartMetaConfigUpdate>;
|
|
740
592
|
/**
|
|
741
|
-
* @param {
|
|
742
|
-
* @param {
|
|
743
|
-
* @param {
|
|
744
|
-
* @returns {Promise<UserCartMappingResponse>} - Success response
|
|
593
|
+
* @param {CartPlatformApplicationValidator.UpdateCartUserParam} arg - Arg object
|
|
594
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
595
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
596
|
+
* @returns {Promise<CartPlatformModel.UserCartMappingResponse>} - Success response
|
|
597
|
+
* @name updateCartUser
|
|
745
598
|
* @summary: Update user id for store os customer
|
|
746
|
-
* @description: Update user id for store os customer after creating customer
|
|
599
|
+
* @description: Update user id for store os customer after creating customer - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartUser/).
|
|
747
600
|
*/
|
|
748
|
-
updateCartUser({ body, id }?: {
|
|
749
|
-
id?: string;
|
|
750
|
-
body: UpdateUserCartMapping;
|
|
751
|
-
}): Promise<UserCartMappingResponse>;
|
|
601
|
+
updateCartUser({ body, id, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartUserParam, { responseHeaders }?: object): Promise<CartPlatformModel.UserCartMappingResponse>;
|
|
752
602
|
/**
|
|
753
|
-
* @param {
|
|
754
|
-
*
|
|
755
|
-
*
|
|
756
|
-
*
|
|
757
|
-
* @param {
|
|
758
|
-
* @returns {Promise<SharedCartResponse>} - Success response
|
|
603
|
+
* @param {CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam} arg
|
|
604
|
+
* - Arg object
|
|
605
|
+
*
|
|
606
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
607
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
608
|
+
* @returns {Promise<CartPlatformModel.SharedCartResponse>} - Success response
|
|
609
|
+
* @name updateCartWithSharedItems
|
|
759
610
|
* @summary: Merge or replace existing cart
|
|
760
|
-
* @description: Use this API to merge the shared cart with existing cart, or replace the existing cart with the shared cart. The `action` parameter is used to indicate the operation Merge or Replace.
|
|
611
|
+
* @description: Use this API to merge the shared cart with existing cart, or replace the existing cart with the shared cart. The `action` parameter is used to indicate the operation Merge or Replace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCartWithSharedItems/).
|
|
761
612
|
*/
|
|
762
|
-
updateCartWithSharedItems({ token, action, cartId }?: {
|
|
763
|
-
token: string;
|
|
764
|
-
action: string;
|
|
765
|
-
cartId?: string;
|
|
766
|
-
}): Promise<SharedCartResponse>;
|
|
613
|
+
updateCartWithSharedItems({ token, action, cartId, requestHeaders }?: CartPlatformApplicationValidator.UpdateCartWithSharedItemsParam, { responseHeaders }?: object): Promise<CartPlatformModel.SharedCartResponse>;
|
|
767
614
|
/**
|
|
768
|
-
* @param {
|
|
769
|
-
* @param {
|
|
770
|
-
* @param {
|
|
771
|
-
* @returns {Promise<SuccessMessage>} - Success response
|
|
615
|
+
* @param {CartPlatformApplicationValidator.UpdateCouponParam} arg - Arg object
|
|
616
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
617
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
618
|
+
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
619
|
+
* @name updateCoupon
|
|
772
620
|
* @summary: Update existing coupon configuration
|
|
773
|
-
* @description: Update coupon with id sent in `id`
|
|
621
|
+
* @description: Update coupon with id sent in `id` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCoupon/).
|
|
774
622
|
*/
|
|
775
|
-
updateCoupon({ id, body }?: {
|
|
776
|
-
id: string;
|
|
777
|
-
body: CouponUpdate;
|
|
778
|
-
}): Promise<SuccessMessage>;
|
|
623
|
+
updateCoupon({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
779
624
|
/**
|
|
780
|
-
* @param {
|
|
781
|
-
*
|
|
782
|
-
*
|
|
783
|
-
* @
|
|
625
|
+
* @param {CartPlatformApplicationValidator.UpdateCouponPartiallyParam} arg
|
|
626
|
+
* - Arg object
|
|
627
|
+
*
|
|
628
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
629
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
630
|
+
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
631
|
+
* @name updateCouponPartially
|
|
784
632
|
* @summary: Update coupon archive state and schedule
|
|
785
|
-
* @description: Update archive/unarchive and change schedule for coupon
|
|
633
|
+
* @description: Update archive/unarchive and change schedule for coupon - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateCouponPartially/).
|
|
786
634
|
*/
|
|
787
|
-
updateCouponPartially({ id, body }?: {
|
|
788
|
-
id: string;
|
|
789
|
-
body: CouponPartialUpdate;
|
|
790
|
-
}): Promise<SuccessMessage>;
|
|
635
|
+
updateCouponPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdateCouponPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
791
636
|
/**
|
|
792
|
-
* @param {
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
* @
|
|
637
|
+
* @param {CartPlatformApplicationValidator.UpdatePriceAdjustmentParam} arg
|
|
638
|
+
* - Arg object
|
|
639
|
+
*
|
|
640
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
641
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
642
|
+
* @returns {Promise<CartPlatformModel.PriceAdjustmentResponse>} - Success response
|
|
643
|
+
* @name updatePriceAdjustment
|
|
796
644
|
* @summary: Update price adjustment configuration
|
|
797
|
-
* @description: Update price adjustment configuration
|
|
645
|
+
* @description: Update price adjustment configuration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePriceAdjustment/).
|
|
798
646
|
*/
|
|
799
|
-
updatePriceAdjustment({ id, body }?: {
|
|
800
|
-
id: string;
|
|
801
|
-
body: PriceAdjustmentUpdate;
|
|
802
|
-
}): Promise<PriceAdjustmentResponse>;
|
|
647
|
+
updatePriceAdjustment({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePriceAdjustmentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PriceAdjustmentResponse>;
|
|
803
648
|
/**
|
|
804
|
-
* @param {
|
|
805
|
-
* @param {
|
|
806
|
-
* @param {
|
|
807
|
-
* @returns {Promise<PromotionUpdate>} - Success response
|
|
649
|
+
* @param {CartPlatformApplicationValidator.UpdatePromotionParam} arg - Arg object
|
|
650
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
651
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
652
|
+
* @returns {Promise<CartPlatformModel.PromotionUpdate>} - Success response
|
|
653
|
+
* @name updatePromotion
|
|
808
654
|
* @summary: Update existing promotion configuration
|
|
809
|
-
* @description: Update promotion with id sent in `id`
|
|
655
|
+
* @description: Update promotion with id sent in `id` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotion/).
|
|
810
656
|
*/
|
|
811
|
-
updatePromotion({ id, body }?: {
|
|
812
|
-
id: string;
|
|
813
|
-
body: PromotionUpdate;
|
|
814
|
-
}): Promise<PromotionUpdate>;
|
|
657
|
+
updatePromotion({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionParam, { responseHeaders }?: object): Promise<CartPlatformModel.PromotionUpdate>;
|
|
815
658
|
/**
|
|
816
|
-
* @param {
|
|
817
|
-
*
|
|
818
|
-
*
|
|
819
|
-
* @
|
|
659
|
+
* @param {CartPlatformApplicationValidator.UpdatePromotionPartiallyParam} arg
|
|
660
|
+
* - Arg object
|
|
661
|
+
*
|
|
662
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
663
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
664
|
+
* @returns {Promise<CartPlatformModel.SuccessMessage>} - Success response
|
|
665
|
+
* @name updatePromotionPartially
|
|
820
666
|
* @summary: Update promotion publish state and schedule
|
|
821
|
-
* @description: Update publish/unpublish and change schedule for promotion
|
|
667
|
+
* @description: Update publish/unpublish and change schedule for promotion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updatePromotionPartially/).
|
|
822
668
|
*/
|
|
823
|
-
updatePromotionPartially({ id, body }?: {
|
|
824
|
-
id: string;
|
|
825
|
-
body: PromotionPartialUpdate;
|
|
826
|
-
}): Promise<SuccessMessage>;
|
|
669
|
+
updatePromotionPartially({ id, body, requestHeaders }?: CartPlatformApplicationValidator.UpdatePromotionPartiallyParam, { responseHeaders }?: object): Promise<CartPlatformModel.SuccessMessage>;
|
|
827
670
|
/**
|
|
828
|
-
* @param {
|
|
829
|
-
* @param {
|
|
830
|
-
*
|
|
831
|
-
* @
|
|
832
|
-
*
|
|
833
|
-
* @
|
|
834
|
-
* @param {string} [arg.addressId] - ID allotted to an address
|
|
835
|
-
* @param {string} [arg.areaCode] - The PIN Code of the destination address,
|
|
836
|
-
* e.g. 400059
|
|
837
|
-
* @param {string} [arg.orderType] - The order type of shipment HomeDelivery
|
|
838
|
-
* - If the customer wants the order home-delivered PickAtStore - If the
|
|
839
|
-
* customer wants the handover of an order at the store itself.
|
|
840
|
-
* @param {UpdateCartShipmentRequest} arg.body
|
|
841
|
-
* @returns {Promise<PlatformCartShipmentsResponse>} - Success response
|
|
671
|
+
* @param {CartPlatformApplicationValidator.UpdateShipmentsParam} arg - Arg object
|
|
672
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
673
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
674
|
+
* @returns {Promise<CartPlatformModel.PlatformCartShipmentsResponse>} -
|
|
675
|
+
* Success response
|
|
676
|
+
* @name updateShipments
|
|
842
677
|
* @summary: Update shipment delivery type and quantity before checkout
|
|
843
|
-
* @description: Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery.
|
|
844
|
-
*/
|
|
845
|
-
updateShipments({ body, i, p, id, addressId, areaCode, orderType, }?: {
|
|
846
|
-
i?: boolean;
|
|
847
|
-
p?: boolean;
|
|
848
|
-
id?: string;
|
|
849
|
-
addressId?: string;
|
|
850
|
-
areaCode?: string;
|
|
851
|
-
orderType?: string;
|
|
852
|
-
body: UpdateCartShipmentRequest;
|
|
853
|
-
}): Promise<PlatformCartShipmentsResponse>;
|
|
678
|
+
* @description: Use this API to update the delivery type and quantity as per customer's preference for either store pick-up or home-delivery. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/updateShipments/).
|
|
679
|
+
*/
|
|
680
|
+
updateShipments({ body, i, p, id, addressId, areaCode, orderType, requestHeaders }?: CartPlatformApplicationValidator.UpdateShipmentsParam, { responseHeaders }?: object): Promise<CartPlatformModel.PlatformCartShipmentsResponse>;
|
|
854
681
|
/**
|
|
855
|
-
* @param {
|
|
856
|
-
*
|
|
857
|
-
*
|
|
858
|
-
* @param {
|
|
859
|
-
* @param {
|
|
860
|
-
* @
|
|
861
|
-
* @
|
|
862
|
-
* @param {string} [arg.merchantCode] -
|
|
863
|
-
* @returns {Promise<PaymentCouponValidate>} - Success response
|
|
682
|
+
* @param {CartPlatformApplicationValidator.ValidateCouponForPaymentParam} arg
|
|
683
|
+
* - Arg object
|
|
684
|
+
*
|
|
685
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
686
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
687
|
+
* @returns {Promise<CartPlatformModel.PaymentCouponValidate>} - Success response
|
|
688
|
+
* @name validateCouponForPayment
|
|
864
689
|
* @summary: Verify the coupon eligibility against the payment mode
|
|
865
|
-
* @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc.
|
|
866
|
-
*/
|
|
867
|
-
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, }?: {
|
|
868
|
-
id?: string;
|
|
869
|
-
buyNow?: boolean;
|
|
870
|
-
addressId?: string;
|
|
871
|
-
paymentMode?: string;
|
|
872
|
-
paymentIdentifier?: string;
|
|
873
|
-
aggregatorName?: string;
|
|
874
|
-
merchantCode?: string;
|
|
875
|
-
}): Promise<PaymentCouponValidate>;
|
|
690
|
+
* @description: Use this API to validate a coupon against the payment mode such as NetBanking, Wallet, UPI etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/cart/validateCouponForPayment/).
|
|
691
|
+
*/
|
|
692
|
+
validateCouponForPayment({ id, buyNow, addressId, paymentMode, paymentIdentifier, aggregatorName, merchantCode, requestHeaders, }?: CartPlatformApplicationValidator.ValidateCouponForPaymentParam, { responseHeaders }?: object): Promise<CartPlatformModel.PaymentCouponValidate>;
|
|
876
693
|
}
|
|
694
|
+
import CartPlatformApplicationValidator = require("./CartPlatformApplicationValidator");
|
|
695
|
+
import CartPlatformModel = require("./CartPlatformModel");
|
|
877
696
|
import Paginator = require("../../common/Paginator");
|