@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,297 +4,317 @@ declare class Content {
|
|
|
4
4
|
config: any;
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
|
-
* @param {
|
|
8
|
-
* @param {
|
|
9
|
-
* @
|
|
7
|
+
* @param {ContentPlatformApplicationValidator.AddDataLoaderParam} arg - Arg object
|
|
8
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
9
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
10
|
+
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
11
|
+
* Success response
|
|
12
|
+
* @name addDataLoader
|
|
10
13
|
* @summary: Adds a data loader
|
|
11
|
-
* @description: Use this API to add data loader. This includes the data loader name, operationId, service name and its type (url/function) with corresponding value.
|
|
14
|
+
* @description: Use this API to add data loader. This includes the data loader name, operationId, service name and its type (url/function) with corresponding value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addDataLoader/).
|
|
12
15
|
*/
|
|
13
|
-
addDataLoader({ body }?: {
|
|
14
|
-
body: DataLoaderSchema;
|
|
15
|
-
}): Promise<DataLoaderResponseSchema>;
|
|
16
|
+
addDataLoader({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
16
17
|
/**
|
|
17
|
-
* @param {
|
|
18
|
-
* @param {
|
|
19
|
-
* @param {
|
|
20
|
-
* @returns {Promise<CreateFaqResponseSchema>} - Success response
|
|
18
|
+
* @param {ContentPlatformApplicationValidator.AddFaqParam} arg - Arg object
|
|
19
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
20
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
|
+
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
22
|
+
* @name addFaq
|
|
21
23
|
* @summary: Create an FAQ
|
|
22
|
-
* @description: FAQs help users to solve an issue or know more about a process. Use this API to create an FAQ for a given FAQ category.
|
|
24
|
+
* @description: FAQs help users to solve an issue or know more about a process. Use this API to create an FAQ for a given FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addFaq/).
|
|
23
25
|
*/
|
|
24
|
-
addFaq({ categoryId, body }?: {
|
|
25
|
-
categoryId: string;
|
|
26
|
-
body: CreateFaqSchema;
|
|
27
|
-
}): Promise<CreateFaqResponseSchema>;
|
|
26
|
+
addFaq({ categoryId, body, requestHeaders }?: ContentPlatformApplicationValidator.AddFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
28
27
|
/**
|
|
29
|
-
* @param {
|
|
30
|
-
* @param {
|
|
31
|
-
* @
|
|
28
|
+
* @param {ContentPlatformApplicationValidator.AddInjectableTagParam} arg - Arg object
|
|
29
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
30
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
31
|
+
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
32
|
+
* @name addInjectableTag
|
|
32
33
|
* @summary: Add a tag
|
|
33
|
-
* @description: CSS and JS can be injected in the application (website) with the help of tags. Use this API to create such tags by entering the tag name, tag type (css/js), url and position of the tag.
|
|
34
|
+
* @description: CSS and JS can be injected in the application (website) with the help of tags. Use this API to create such tags by entering the tag name, tag type (css/js), url and position of the tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addInjectableTag/).
|
|
34
35
|
*/
|
|
35
|
-
addInjectableTag({ body }?: {
|
|
36
|
-
body: CreateTagRequestSchema;
|
|
37
|
-
}): Promise<TagsSchema>;
|
|
36
|
+
addInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
38
37
|
/**
|
|
39
|
-
* @param {
|
|
40
|
-
*
|
|
41
|
-
*
|
|
38
|
+
* @param {ContentPlatformApplicationValidator.AddPathRedirectionRulesParam} arg
|
|
39
|
+
* - Arg object
|
|
40
|
+
*
|
|
41
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
43
|
+
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
44
|
+
* @name addPathRedirectionRules
|
|
42
45
|
* @summary: Save path based redirection rules
|
|
43
|
-
* @description: Use this API to add redirection rules
|
|
44
|
-
*/
|
|
45
|
-
addPathRedirectionRules({ body }?: {
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
*
|
|
50
|
-
* @param {
|
|
51
|
-
* @
|
|
46
|
+
* @description: Use this API to add redirection rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addPathRedirectionRules/).
|
|
47
|
+
*/
|
|
48
|
+
addPathRedirectionRules({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddPathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
49
|
+
/**
|
|
50
|
+
* @param {ContentPlatformApplicationValidator.CreateAnnouncementParam} arg
|
|
51
|
+
* - Arg object
|
|
52
|
+
*
|
|
53
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
54
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
55
|
+
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
56
|
+
* Success response
|
|
57
|
+
* @name createAnnouncement
|
|
52
58
|
* @summary: Create an announcement
|
|
53
|
-
* @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to create an announcement.
|
|
59
|
+
* @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to create an announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAnnouncement/).
|
|
54
60
|
*/
|
|
55
|
-
createAnnouncement({ body }?: {
|
|
56
|
-
body: AdminAnnouncementSchema;
|
|
57
|
-
}): Promise<CreateAnnouncementSchema>;
|
|
61
|
+
createAnnouncement({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
58
62
|
/**
|
|
59
|
-
* @param {
|
|
60
|
-
* @param {
|
|
61
|
-
* @
|
|
63
|
+
* @param {ContentPlatformApplicationValidator.CreateBlogParam} arg - Arg object
|
|
64
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
65
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
66
|
+
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
67
|
+
* @name createBlog
|
|
62
68
|
* @summary: Create a blog
|
|
63
|
-
* @description: Use this API to create a blog.
|
|
69
|
+
* @description: Use this API to create a blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createBlog/).
|
|
64
70
|
*/
|
|
65
|
-
createBlog({ body }?: {
|
|
66
|
-
body: BlogRequest;
|
|
67
|
-
}): Promise<BlogSchema>;
|
|
71
|
+
createBlog({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
68
72
|
/**
|
|
69
|
-
* @param {
|
|
70
|
-
*
|
|
71
|
-
*
|
|
73
|
+
* @param {ContentPlatformApplicationValidator.CreateFaqCategoryParam} arg
|
|
74
|
+
* - Arg object
|
|
75
|
+
*
|
|
76
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
77
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
78
|
+
* @returns {Promise<ContentPlatformModel.CreateFaqCategorySchema>} - Success response
|
|
79
|
+
* @name createFaqCategory
|
|
72
80
|
* @summary: Create an FAQ category
|
|
73
|
-
* @description: FAQs help users to solve an issue or know more about a process. FAQs can be categorized separately, for e.g. some questions can be related to payment, some could be related to purchase, shipping, navigating, etc. Use this API to create an FAQ category.
|
|
81
|
+
* @description: FAQs help users to solve an issue or know more about a process. FAQs can be categorized separately, for e.g. some questions can be related to payment, some could be related to purchase, shipping, navigating, etc. Use this API to create an FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createFaqCategory/).
|
|
74
82
|
*/
|
|
75
|
-
createFaqCategory({ body }?: {
|
|
76
|
-
body: CreateFaqCategoryRequestSchema;
|
|
77
|
-
}): Promise<CreateFaqCategorySchema>;
|
|
83
|
+
createFaqCategory({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqCategorySchema>;
|
|
78
84
|
/**
|
|
79
|
-
* @param {
|
|
80
|
-
*
|
|
81
|
-
*
|
|
85
|
+
* @param {ContentPlatformApplicationValidator.CreateLandingPageParam} arg
|
|
86
|
+
* - Arg object
|
|
87
|
+
*
|
|
88
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
89
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
90
|
+
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
91
|
+
* @name createLandingPage
|
|
82
92
|
* @summary: Create a landing page
|
|
83
|
-
* @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to create a landing page.
|
|
93
|
+
* @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to create a landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createLandingPage/).
|
|
84
94
|
*/
|
|
85
|
-
createLandingPage({ body }?: {
|
|
86
|
-
body: LandingPageSchema;
|
|
87
|
-
}): Promise<LandingPageSchema>;
|
|
95
|
+
createLandingPage({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
88
96
|
/**
|
|
89
|
-
* @param {
|
|
90
|
-
* @param {
|
|
91
|
-
* @
|
|
97
|
+
* @param {ContentPlatformApplicationValidator.CreateNavigationParam} arg - Arg object
|
|
98
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
|
+
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
101
|
+
* @name createNavigation
|
|
92
102
|
* @summary: Create a navigation
|
|
93
|
-
* @description: Navigation is the arrangement of navigational items to ease the accessibility of resources for users on a website. Use this API to create a navigation.
|
|
103
|
+
* @description: Navigation is the arrangement of navigational items to ease the accessibility of resources for users on a website. Use this API to create a navigation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createNavigation/).
|
|
94
104
|
*/
|
|
95
|
-
createNavigation({ body }?: {
|
|
96
|
-
body: NavigationRequest;
|
|
97
|
-
}): Promise<NavigationSchema>;
|
|
105
|
+
createNavigation({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
98
106
|
/**
|
|
99
|
-
* @param {
|
|
100
|
-
* @param {
|
|
101
|
-
* @
|
|
107
|
+
* @param {ContentPlatformApplicationValidator.CreatePageParam} arg - Arg object
|
|
108
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
109
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
110
|
+
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
111
|
+
* @name createPage
|
|
102
112
|
* @summary: Create a page
|
|
103
|
-
* @description: Use this API to create a custom page using a title, seo, publish status, feature image, tags, meta, etc.
|
|
113
|
+
* @description: Use this API to create a custom page using a title, seo, publish status, feature image, tags, meta, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createPage/).
|
|
104
114
|
*/
|
|
105
|
-
createPage({ body }?: {
|
|
106
|
-
body: PageRequest;
|
|
107
|
-
}): Promise<PageSchema>;
|
|
115
|
+
createPage({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
108
116
|
/**
|
|
109
|
-
* @param {
|
|
110
|
-
*
|
|
111
|
-
*
|
|
117
|
+
* @param {ContentPlatformApplicationValidator.CreatePagePreviewParam} arg
|
|
118
|
+
* - Arg object
|
|
119
|
+
*
|
|
120
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
121
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
122
|
+
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
123
|
+
* @name createPagePreview
|
|
112
124
|
* @summary: Create a page preview
|
|
113
|
-
* @description: Use this API to create a page preview to check the appearance of a custom page.
|
|
125
|
+
* @description: Use this API to create a page preview to check the appearance of a custom page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createPagePreview/).
|
|
114
126
|
*/
|
|
115
|
-
createPagePreview({ body }?: {
|
|
116
|
-
body: PageRequest;
|
|
117
|
-
}): Promise<PageSchema>;
|
|
127
|
+
createPagePreview({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreatePagePreviewParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
118
128
|
/**
|
|
119
|
-
* @param {
|
|
120
|
-
* @param {
|
|
121
|
-
* @
|
|
129
|
+
* @param {ContentPlatformApplicationValidator.CreateSlideshowParam} arg - Arg object
|
|
130
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
131
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
132
|
+
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
133
|
+
* @name createSlideshow
|
|
122
134
|
* @summary: Create a slideshow
|
|
123
|
-
* @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to create a slideshow.
|
|
135
|
+
* @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to create a slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSlideshow/).
|
|
124
136
|
*/
|
|
125
|
-
createSlideshow({ body }?: {
|
|
126
|
-
body: SlideshowRequest;
|
|
127
|
-
}): Promise<SlideshowSchema>;
|
|
137
|
+
createSlideshow({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
128
138
|
/**
|
|
129
|
-
* @param {
|
|
130
|
-
*
|
|
139
|
+
* @param {ContentPlatformApplicationValidator.DeleteAllInjectableTagsParam} arg
|
|
140
|
+
* - Arg object
|
|
141
|
+
*
|
|
142
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
143
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
144
|
+
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
145
|
+
* @name deleteAllInjectableTags
|
|
131
146
|
* @summary: Delete tags in application
|
|
132
|
-
* @description: Use this API to delete all the existing tags at once.
|
|
133
|
-
*/
|
|
134
|
-
deleteAllInjectableTags({}?: any): Promise<TagsSchema>;
|
|
135
|
-
/**
|
|
136
|
-
* @param {
|
|
137
|
-
*
|
|
138
|
-
*
|
|
147
|
+
* @description: Use this API to delete all the existing tags at once. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAllInjectableTags/).
|
|
148
|
+
*/
|
|
149
|
+
deleteAllInjectableTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
150
|
+
/**
|
|
151
|
+
* @param {ContentPlatformApplicationValidator.DeleteAnnouncementParam} arg
|
|
152
|
+
* - Arg object
|
|
153
|
+
*
|
|
154
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
|
+
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
157
|
+
* Success response
|
|
158
|
+
* @name deleteAnnouncement
|
|
139
159
|
* @summary: Delete announcement by id
|
|
140
|
-
* @description: Use this API to delete an existing announcement.
|
|
160
|
+
* @description: Use this API to delete an existing announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAnnouncement/).
|
|
141
161
|
*/
|
|
142
|
-
deleteAnnouncement({ announcementId }?: {
|
|
143
|
-
announcementId: string;
|
|
144
|
-
}): Promise<CreateAnnouncementSchema>;
|
|
162
|
+
deleteAnnouncement({ announcementId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
145
163
|
/**
|
|
146
|
-
* @param {
|
|
147
|
-
* @param {
|
|
148
|
-
* @
|
|
164
|
+
* @param {ContentPlatformApplicationValidator.DeleteBlogParam} arg - Arg object
|
|
165
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
166
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
167
|
+
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
168
|
+
* @name deleteBlog
|
|
149
169
|
* @summary: Delete blogs
|
|
150
|
-
* @description: Use this API to delete a blog.
|
|
170
|
+
* @description: Use this API to delete a blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteBlog/).
|
|
151
171
|
*/
|
|
152
|
-
deleteBlog({ id }?: {
|
|
153
|
-
id: string;
|
|
154
|
-
}): Promise<BlogSchema>;
|
|
172
|
+
deleteBlog({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
155
173
|
/**
|
|
156
|
-
* @param {
|
|
157
|
-
* @param {
|
|
158
|
-
* @
|
|
174
|
+
* @param {ContentPlatformApplicationValidator.DeleteDataLoaderParam} arg - Arg object
|
|
175
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
176
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
177
|
+
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
178
|
+
* Success response
|
|
179
|
+
* @name deleteDataLoader
|
|
159
180
|
* @summary: Delete data loader in application
|
|
160
|
-
* @description: Use this API to delete data loader.
|
|
181
|
+
* @description: Use this API to delete data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteDataLoader/).
|
|
161
182
|
*/
|
|
162
|
-
deleteDataLoader({ dataLoaderId }?: {
|
|
163
|
-
dataLoaderId: string;
|
|
164
|
-
}): Promise<DataLoaderResponseSchema>;
|
|
183
|
+
deleteDataLoader({ dataLoaderId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
165
184
|
/**
|
|
166
|
-
* @param {
|
|
167
|
-
* @param {
|
|
168
|
-
* @param {
|
|
169
|
-
* @returns {Promise<CreateFaqResponseSchema>} - Success response
|
|
185
|
+
* @param {ContentPlatformApplicationValidator.DeleteFaqParam} arg - Arg object
|
|
186
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
187
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
188
|
+
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
189
|
+
* @name deleteFaq
|
|
170
190
|
* @summary: Delete an FAQ
|
|
171
|
-
* @description: Use this API to delete an existing FAQ.
|
|
191
|
+
* @description: Use this API to delete an existing FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteFaq/).
|
|
172
192
|
*/
|
|
173
|
-
deleteFaq({ categoryId, faqId }?: {
|
|
174
|
-
categoryId: string;
|
|
175
|
-
faqId: string;
|
|
176
|
-
}): Promise<CreateFaqResponseSchema>;
|
|
193
|
+
deleteFaq({ categoryId, faqId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
177
194
|
/**
|
|
178
|
-
* @param {
|
|
179
|
-
*
|
|
180
|
-
*
|
|
195
|
+
* @param {ContentPlatformApplicationValidator.DeleteFaqCategoryParam} arg
|
|
196
|
+
* - Arg object
|
|
197
|
+
*
|
|
198
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
199
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
200
|
+
* @returns {Promise<ContentPlatformModel.FaqSchema>} - Success response
|
|
201
|
+
* @name deleteFaqCategory
|
|
181
202
|
* @summary: Delete an FAQ category
|
|
182
|
-
* @description: Use this API to delete an FAQ category.
|
|
203
|
+
* @description: Use this API to delete an FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteFaqCategory/).
|
|
183
204
|
*/
|
|
184
|
-
deleteFaqCategory({ id }?: {
|
|
185
|
-
id: string;
|
|
186
|
-
}): Promise<FaqSchema>;
|
|
205
|
+
deleteFaqCategory({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.FaqSchema>;
|
|
187
206
|
/**
|
|
188
|
-
* @param {
|
|
189
|
-
*
|
|
190
|
-
*
|
|
207
|
+
* @param {ContentPlatformApplicationValidator.DeleteLandingPageParam} arg
|
|
208
|
+
* - Arg object
|
|
209
|
+
*
|
|
210
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
211
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
212
|
+
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
213
|
+
* @name deleteLandingPage
|
|
191
214
|
* @summary: Delete a landing page
|
|
192
|
-
* @description: Use this API to delete an existing landing page.
|
|
215
|
+
* @description: Use this API to delete an existing landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteLandingPage/).
|
|
193
216
|
*/
|
|
194
|
-
deleteLandingPage({ id }?: {
|
|
195
|
-
id: string;
|
|
196
|
-
}): Promise<LandingPageSchema>;
|
|
217
|
+
deleteLandingPage({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
197
218
|
/**
|
|
198
|
-
* @param {
|
|
199
|
-
* @param {
|
|
200
|
-
* @
|
|
219
|
+
* @param {ContentPlatformApplicationValidator.DeleteNavigationParam} arg - Arg object
|
|
220
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
221
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
222
|
+
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
223
|
+
* @name deleteNavigation
|
|
201
224
|
* @summary: Delete a navigation
|
|
202
|
-
* @description: Use this API to delete an existing navigation.
|
|
225
|
+
* @description: Use this API to delete an existing navigation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteNavigation/).
|
|
203
226
|
*/
|
|
204
|
-
deleteNavigation({ id }?: {
|
|
205
|
-
id: string;
|
|
206
|
-
}): Promise<NavigationSchema>;
|
|
227
|
+
deleteNavigation({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
207
228
|
/**
|
|
208
|
-
* @param {
|
|
209
|
-
* @param {
|
|
210
|
-
* @
|
|
229
|
+
* @param {ContentPlatformApplicationValidator.DeletePageParam} arg - Arg object
|
|
230
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
231
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
232
|
+
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
233
|
+
* @name deletePage
|
|
211
234
|
* @summary: Delete a page
|
|
212
|
-
* @description: Use this API to delete an existing page.
|
|
235
|
+
* @description: Use this API to delete an existing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deletePage/).
|
|
213
236
|
*/
|
|
214
|
-
deletePage({ id }?: {
|
|
215
|
-
id: string;
|
|
216
|
-
}): Promise<PageSchema>;
|
|
237
|
+
deletePage({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeletePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
217
238
|
/**
|
|
218
|
-
* @param {
|
|
219
|
-
*
|
|
239
|
+
* @param {ContentPlatformApplicationValidator.DeletePathRedirectionRulesParam} arg
|
|
240
|
+
* - Arg object
|
|
241
|
+
*
|
|
242
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
243
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
220
244
|
* @returns {Promise<Object>} - Success response
|
|
245
|
+
* @name deletePathRedirectionRules
|
|
221
246
|
* @summary: Delete path based redirection rules
|
|
222
|
-
* @description: Use this API to delete redirection rules
|
|
247
|
+
* @description: Use this API to delete redirection rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deletePathRedirectionRules/).
|
|
223
248
|
*/
|
|
224
|
-
deletePathRedirectionRules({ pathId }?: {
|
|
225
|
-
pathId: string;
|
|
226
|
-
}): Promise<any>;
|
|
249
|
+
deletePathRedirectionRules({ pathId, requestHeaders }?: ContentPlatformApplicationValidator.DeletePathRedirectionRulesParam, { responseHeaders }?: object): Promise<any>;
|
|
227
250
|
/**
|
|
228
|
-
* @param {
|
|
229
|
-
* @param {
|
|
230
|
-
* @
|
|
251
|
+
* @param {ContentPlatformApplicationValidator.DeleteSlideshowParam} arg - Arg object
|
|
252
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
253
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
254
|
+
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
255
|
+
* @name deleteSlideshow
|
|
231
256
|
* @summary: Delete a slideshow
|
|
232
|
-
* @description: Use this API to delete an existing slideshow.
|
|
257
|
+
* @description: Use this API to delete an existing slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSlideshow/).
|
|
233
258
|
*/
|
|
234
|
-
deleteSlideshow({ id }?: {
|
|
235
|
-
id: string;
|
|
236
|
-
}): Promise<SlideshowSchema>;
|
|
259
|
+
deleteSlideshow({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
237
260
|
/**
|
|
238
|
-
* @param {
|
|
239
|
-
* @param {
|
|
240
|
-
* @param {
|
|
241
|
-
* @returns {Promise<DataLoaderResponseSchema>} -
|
|
261
|
+
* @param {ContentPlatformApplicationValidator.EditDataLoaderParam} arg - Arg object
|
|
262
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
263
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
264
|
+
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
265
|
+
* Success response
|
|
266
|
+
* @name editDataLoader
|
|
242
267
|
* @summary: Edit a data loader by id
|
|
243
|
-
* @description: Use this API to edit the details of an existing data loader by its ID.
|
|
268
|
+
* @description: Use this API to edit the details of an existing data loader by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/editDataLoader/).
|
|
244
269
|
*/
|
|
245
|
-
editDataLoader({ dataLoaderId, body }?: {
|
|
246
|
-
dataLoaderId: string;
|
|
247
|
-
body: DataLoaderSchema;
|
|
248
|
-
}): Promise<DataLoaderResponseSchema>;
|
|
270
|
+
editDataLoader({ dataLoaderId, body, requestHeaders }?: ContentPlatformApplicationValidator.EditDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
249
271
|
/**
|
|
250
|
-
* @param {
|
|
251
|
-
*
|
|
252
|
-
*
|
|
253
|
-
* @
|
|
272
|
+
* @param {ContentPlatformApplicationValidator.EditInjectableTagParam} arg
|
|
273
|
+
* - Arg object
|
|
274
|
+
*
|
|
275
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
276
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
277
|
+
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
278
|
+
* @name editInjectableTag
|
|
254
279
|
* @summary: Edit a tag by id
|
|
255
|
-
* @description: Use this API to edit the details of an existing tag by its ID.
|
|
280
|
+
* @description: Use this API to edit the details of an existing tag by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/editInjectableTag/).
|
|
256
281
|
*/
|
|
257
|
-
editInjectableTag({ tagId, body }?: {
|
|
258
|
-
tagId: string;
|
|
259
|
-
body: UpdateHandpickedSchema;
|
|
260
|
-
}): Promise<TagsSchema>;
|
|
282
|
+
editInjectableTag({ tagId, body, requestHeaders }?: ContentPlatformApplicationValidator.EditInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
261
283
|
/**
|
|
262
|
-
* @param {
|
|
263
|
-
* @param {
|
|
264
|
-
*
|
|
265
|
-
* @
|
|
266
|
-
* @
|
|
284
|
+
* @param {ContentPlatformApplicationValidator.GenerateSEOTitleParam} arg - Arg object
|
|
285
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
286
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
287
|
+
* @returns {Promise<ContentPlatformModel.GeneratedSEOContent>} - Success response
|
|
288
|
+
* @name generateSEOTitle
|
|
267
289
|
* @summary: Get SEO meta tag title for content
|
|
268
|
-
* @description: Use this API to get GPT3 generated SEO meta tag title for content
|
|
290
|
+
* @description: Use this API to get GPT3 generated SEO meta tag title for content - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/generateSEOTitle/).
|
|
269
291
|
*/
|
|
270
|
-
generateSEOTitle({ type, body }?: {
|
|
271
|
-
type: GenerationEntityType;
|
|
272
|
-
body: GenerateSEOContent;
|
|
273
|
-
}): Promise<GeneratedSEOContent>;
|
|
292
|
+
generateSEOTitle({ type, body, requestHeaders }?: ContentPlatformApplicationValidator.GenerateSEOTitleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GeneratedSEOContent>;
|
|
274
293
|
/**
|
|
275
|
-
* @param {
|
|
276
|
-
*
|
|
277
|
-
*
|
|
294
|
+
* @param {ContentPlatformApplicationValidator.GetAnnouncementByIdParam} arg
|
|
295
|
+
* - Arg object
|
|
296
|
+
*
|
|
297
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
298
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
299
|
+
* @returns {Promise<ContentPlatformModel.AdminAnnouncementSchema>} - Success response
|
|
300
|
+
* @name getAnnouncementById
|
|
278
301
|
* @summary: Get announcement by ID
|
|
279
|
-
* @description: Use this API to retrieve an announcement and its details such as the target platform and pages on which it's applicable
|
|
280
|
-
*/
|
|
281
|
-
getAnnouncementById({ announcementId }?: {
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
*
|
|
286
|
-
* @param {
|
|
287
|
-
*
|
|
288
|
-
* @
|
|
289
|
-
*
|
|
290
|
-
* @
|
|
302
|
+
* @description: Use this API to retrieve an announcement and its details such as the target platform and pages on which it's applicable - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAnnouncementById/).
|
|
303
|
+
*/
|
|
304
|
+
getAnnouncementById({ announcementId, requestHeaders }?: ContentPlatformApplicationValidator.GetAnnouncementByIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.AdminAnnouncementSchema>;
|
|
305
|
+
/**
|
|
306
|
+
* @param {ContentPlatformApplicationValidator.GetAnnouncementsListParam} arg
|
|
307
|
+
* - Arg object
|
|
308
|
+
*
|
|
309
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
310
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
311
|
+
* @returns {Promise<ContentPlatformModel.GetAnnouncementListSchema>} -
|
|
312
|
+
* Success response
|
|
313
|
+
* @name getAnnouncementsList
|
|
291
314
|
* @summary: Get a list of announcements
|
|
292
|
-
* @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.
|
|
315
|
+
* @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAnnouncementsList/).
|
|
293
316
|
*/
|
|
294
|
-
getAnnouncementsList({ pageNo, pageSize }?: {
|
|
295
|
-
pageNo?: number;
|
|
296
|
-
pageSize?: number;
|
|
297
|
-
}): Promise<GetAnnouncementListSchema>;
|
|
317
|
+
getAnnouncementsList({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetAnnouncementsListParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetAnnouncementListSchema>;
|
|
298
318
|
/**
|
|
299
319
|
* @param {Object} arg - Arg object.
|
|
300
320
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -303,6 +323,7 @@ declare class Content {
|
|
|
303
323
|
* created within a business account.
|
|
304
324
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
305
325
|
* page. Default value is 10.
|
|
326
|
+
* @returns {Paginator<ContentPlatformModel.GetAnnouncementListSchema>}
|
|
306
327
|
* @summary: Get a list of announcements
|
|
307
328
|
* @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.
|
|
308
329
|
*/
|
|
@@ -310,32 +331,27 @@ declare class Content {
|
|
|
310
331
|
companyId: string;
|
|
311
332
|
applicationId: string;
|
|
312
333
|
pageSize?: number;
|
|
313
|
-
}): Paginator
|
|
334
|
+
}): Paginator<ContentPlatformModel.GetAnnouncementListSchema>;
|
|
314
335
|
/**
|
|
315
|
-
* @param {
|
|
316
|
-
* @param {
|
|
317
|
-
*
|
|
318
|
-
* @returns {Promise<BlogSchema>} - Success response
|
|
336
|
+
* @param {ContentPlatformApplicationValidator.GetBlogBySlugParam} arg - Arg object
|
|
337
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
338
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
339
|
+
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
340
|
+
* @name getBlogBySlug
|
|
319
341
|
* @summary: Get blog by slug
|
|
320
|
-
* @description: Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc.
|
|
342
|
+
* @description: Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogBySlug/).
|
|
321
343
|
*/
|
|
322
|
-
getBlogBySlug({ slug }?: {
|
|
323
|
-
slug: string;
|
|
324
|
-
}): Promise<BlogSchema>;
|
|
344
|
+
getBlogBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
325
345
|
/**
|
|
326
|
-
* @param {
|
|
327
|
-
* @param {
|
|
328
|
-
*
|
|
329
|
-
* @
|
|
330
|
-
*
|
|
331
|
-
* @returns {Promise<BlogGetResponse>} - Success response
|
|
346
|
+
* @param {ContentPlatformApplicationValidator.GetBlogsParam} arg - Arg object
|
|
347
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
348
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
349
|
+
* @returns {Promise<ContentPlatformModel.BlogGetResponse>} - Success response
|
|
350
|
+
* @name getBlogs
|
|
332
351
|
* @summary: Get blogs
|
|
333
|
-
* @description: Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc.
|
|
352
|
+
* @description: Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
|
|
334
353
|
*/
|
|
335
|
-
getBlogs({ pageNo, pageSize }?: {
|
|
336
|
-
pageNo?: number;
|
|
337
|
-
pageSize?: number;
|
|
338
|
-
}): Promise<BlogGetResponse>;
|
|
354
|
+
getBlogs({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetResponse>;
|
|
339
355
|
/**
|
|
340
356
|
* @param {Object} arg - Arg object.
|
|
341
357
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -344,6 +360,7 @@ declare class Content {
|
|
|
344
360
|
* created within a business account.
|
|
345
361
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
346
362
|
* page. Default value is 10.
|
|
363
|
+
* @returns {Paginator<ContentPlatformModel.BlogGetResponse>}
|
|
347
364
|
* @summary: Get blogs
|
|
348
365
|
* @description: Use this API to get a list of blogs along with their details, such as the title, reading time, publish status, feature image, tags, author, etc.
|
|
349
366
|
*/
|
|
@@ -351,99 +368,107 @@ declare class Content {
|
|
|
351
368
|
companyId: string;
|
|
352
369
|
applicationId: string;
|
|
353
370
|
pageSize?: number;
|
|
354
|
-
}): Paginator
|
|
371
|
+
}): Paginator<ContentPlatformModel.BlogGetResponse>;
|
|
355
372
|
/**
|
|
356
|
-
* @param {
|
|
357
|
-
* @param {
|
|
358
|
-
*
|
|
359
|
-
* @returns {Promise<BlogSchema>} - Success response
|
|
373
|
+
* @param {ContentPlatformApplicationValidator.GetComponentByIdParam} arg - Arg object
|
|
374
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
375
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
376
|
+
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
377
|
+
* @name getComponentById
|
|
360
378
|
* @summary: Get components of a blog
|
|
361
|
-
* @description: Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc.
|
|
379
|
+
* @description: Use this API to retrieve the components of a blog, such as title, slug, feature image, content, schedule, publish status, author, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getComponentById/).
|
|
362
380
|
*/
|
|
363
|
-
getComponentById({ slug }?: {
|
|
364
|
-
slug: string;
|
|
365
|
-
}): Promise<BlogSchema>;
|
|
381
|
+
getComponentById({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetComponentByIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
366
382
|
/**
|
|
367
|
-
* @param {
|
|
368
|
-
* @
|
|
383
|
+
* @param {ContentPlatformApplicationValidator.GetDataLoadersParam} arg - Arg object
|
|
384
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
385
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
386
|
+
* @returns {Promise<ContentPlatformModel.DataLoadersSchema>} - Success response
|
|
387
|
+
* @name getDataLoaders
|
|
369
388
|
* @summary: Get all the data loaders in an application
|
|
370
|
-
* @description: Use this to get all data loaders of an application
|
|
371
|
-
*/
|
|
372
|
-
getDataLoaders({}?: any): Promise<DataLoadersSchema>;
|
|
373
|
-
/**
|
|
374
|
-
* @param {
|
|
375
|
-
*
|
|
389
|
+
* @description: Use this to get all data loaders of an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDataLoaders/).
|
|
390
|
+
*/
|
|
391
|
+
getDataLoaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoadersSchema>;
|
|
392
|
+
/**
|
|
393
|
+
* @param {ContentPlatformApplicationValidator.GetDefaultNavigationsParam} arg
|
|
394
|
+
* - Arg object
|
|
395
|
+
*
|
|
396
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
397
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
398
|
+
* @returns {Promise<ContentPlatformModel.DefaultNavigationResponse>} -
|
|
399
|
+
* Success response
|
|
400
|
+
* @name getDefaultNavigations
|
|
376
401
|
* @summary: Get default navigations
|
|
377
|
-
* @description: On any website (application), there are navigations that are present by default. Use this API to retrieve those default navigations.
|
|
402
|
+
* @description: On any website (application), there are navigations that are present by default. Use this API to retrieve those default navigations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultNavigations/).
|
|
378
403
|
*/
|
|
379
|
-
getDefaultNavigations({}?: any): Promise<DefaultNavigationResponse>;
|
|
404
|
+
getDefaultNavigations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultNavigationResponse>;
|
|
380
405
|
/**
|
|
381
|
-
* @param {
|
|
382
|
-
* @param {
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
* @returns {Promise<CreateFaqResponseSchema>} - Success response
|
|
406
|
+
* @param {ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam} arg - Arg object
|
|
407
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
408
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
409
|
+
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
410
|
+
* @name getFaqByIdOrSlug
|
|
387
411
|
* @summary: Get an FAQ
|
|
388
|
-
* @description: Use this API to retrieve a specific FAQ. You will get the question and answer of that FAQ.
|
|
412
|
+
* @description: Use this API to retrieve a specific FAQ. You will get the question and answer of that FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqByIdOrSlug/).
|
|
389
413
|
*/
|
|
390
|
-
getFaqByIdOrSlug({ idOrSlug }?: {
|
|
391
|
-
idOrSlug: string;
|
|
392
|
-
}): Promise<CreateFaqResponseSchema>;
|
|
414
|
+
getFaqByIdOrSlug({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
393
415
|
/**
|
|
394
|
-
* @param {
|
|
395
|
-
* @
|
|
416
|
+
* @param {ContentPlatformApplicationValidator.GetFaqCategoriesParam} arg - Arg object
|
|
417
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
418
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
419
|
+
* @returns {Promise<ContentPlatformModel.GetFaqCategoriesSchema>} - Success response
|
|
420
|
+
* @name getFaqCategories
|
|
396
421
|
* @summary: Get a list of FAQ categories
|
|
397
|
-
* @description: FAQs can be divided into categories. Use this API to get a list of FAQ categories.
|
|
398
|
-
*/
|
|
399
|
-
getFaqCategories({}?: any): Promise<GetFaqCategoriesSchema>;
|
|
400
|
-
/**
|
|
401
|
-
* @param {
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
* @returns {Promise<GetFaqCategoryBySlugSchema>} -
|
|
422
|
+
* @description: FAQs can be divided into categories. Use this API to get a list of FAQ categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategories/).
|
|
423
|
+
*/
|
|
424
|
+
getFaqCategories({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqCategoriesSchema>;
|
|
425
|
+
/**
|
|
426
|
+
* @param {ContentPlatformApplicationValidator.GetFaqCategoryBySlugOrIdParam} arg
|
|
427
|
+
* - Arg object
|
|
428
|
+
*
|
|
429
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
430
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
431
|
+
* @returns {Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>} -
|
|
432
|
+
* Success response
|
|
433
|
+
* @name getFaqCategoryBySlugOrId
|
|
407
434
|
* @summary: Get an FAQ category by slug or id
|
|
408
|
-
* @description: FAQs can be divided into categories. Use this API to get an FAQ categories using its slug or ID.
|
|
435
|
+
* @description: FAQs can be divided into categories. Use this API to get an FAQ categories using its slug or ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategoryBySlugOrId/).
|
|
409
436
|
*/
|
|
410
|
-
getFaqCategoryBySlugOrId({ idOrSlug }?: {
|
|
411
|
-
idOrSlug: string;
|
|
412
|
-
}): Promise<GetFaqCategoryBySlugSchema>;
|
|
437
|
+
getFaqCategoryBySlugOrId({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqCategoryBySlugOrIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>;
|
|
413
438
|
/**
|
|
414
|
-
* @param {
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
* @returns {Promise<GetFaqSchema>} - Success response
|
|
439
|
+
* @param {ContentPlatformApplicationValidator.GetFaqsByCategoryIdOrSlugParam} arg
|
|
440
|
+
* - Arg object
|
|
441
|
+
*
|
|
442
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
443
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
444
|
+
* @returns {Promise<ContentPlatformModel.GetFaqSchema>} - Success response
|
|
445
|
+
* @name getFaqsByCategoryIdOrSlug
|
|
420
446
|
* @summary: Get question and answers within an FAQ category
|
|
421
|
-
* @description: Use this API to retrieve all the commonly asked question and answers belonging to an FAQ category.
|
|
447
|
+
* @description: Use this API to retrieve all the commonly asked question and answers belonging to an FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqsByCategoryIdOrSlug/).
|
|
422
448
|
*/
|
|
423
|
-
getFaqsByCategoryIdOrSlug({ idOrSlug }?: {
|
|
424
|
-
idOrSlug: string;
|
|
425
|
-
}): Promise<GetFaqSchema>;
|
|
449
|
+
getFaqsByCategoryIdOrSlug({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqsByCategoryIdOrSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqSchema>;
|
|
426
450
|
/**
|
|
427
|
-
* @param {
|
|
428
|
-
*
|
|
451
|
+
* @param {ContentPlatformApplicationValidator.GetInjectableTagsParam} arg
|
|
452
|
+
* - Arg object
|
|
453
|
+
*
|
|
454
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
455
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
456
|
+
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
457
|
+
* @name getInjectableTags
|
|
429
458
|
* @summary: Get all the tags in an application
|
|
430
|
-
* @description: Use this API to get all the CSS and JS injected in the application in the form of tags.
|
|
459
|
+
* @description: Use this API to get all the CSS and JS injected in the application in the form of tags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getInjectableTags/).
|
|
431
460
|
*/
|
|
432
|
-
getInjectableTags({}?: any): Promise<TagsSchema>;
|
|
461
|
+
getInjectableTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
433
462
|
/**
|
|
434
|
-
* @param {
|
|
435
|
-
* @param {
|
|
436
|
-
*
|
|
437
|
-
* @
|
|
438
|
-
*
|
|
439
|
-
* @returns {Promise<LandingPageGetResponse>} - Success response
|
|
463
|
+
* @param {ContentPlatformApplicationValidator.GetLandingPagesParam} arg - Arg object
|
|
464
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
465
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
466
|
+
* @returns {Promise<ContentPlatformModel.LandingPageGetResponse>} - Success response
|
|
467
|
+
* @name getLandingPages
|
|
440
468
|
* @summary: Get landing pages
|
|
441
|
-
* @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch a list of landing pages.
|
|
469
|
+
* @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch a list of landing pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLandingPages/).
|
|
442
470
|
*/
|
|
443
|
-
getLandingPages({ pageNo, pageSize }?: {
|
|
444
|
-
pageNo?: number;
|
|
445
|
-
pageSize?: number;
|
|
446
|
-
}): Promise<LandingPageGetResponse>;
|
|
471
|
+
getLandingPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetLandingPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageGetResponse>;
|
|
447
472
|
/**
|
|
448
473
|
* @param {Object} arg - Arg object.
|
|
449
474
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -452,6 +477,7 @@ declare class Content {
|
|
|
452
477
|
* created within a business account.
|
|
453
478
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
454
479
|
* page. Default value is 10.
|
|
480
|
+
* @returns {Paginator<ContentPlatformModel.LandingPageGetResponse>}
|
|
455
481
|
* @summary: Get landing pages
|
|
456
482
|
* @description: Landing page is the first page that a prospect lands upon while visiting a website. Use this API to fetch a list of landing pages.
|
|
457
483
|
*/
|
|
@@ -459,46 +485,41 @@ declare class Content {
|
|
|
459
485
|
companyId: string;
|
|
460
486
|
applicationId: string;
|
|
461
487
|
pageSize?: number;
|
|
462
|
-
}): Paginator
|
|
463
|
-
/**
|
|
464
|
-
* @param {
|
|
465
|
-
*
|
|
488
|
+
}): Paginator<ContentPlatformModel.LandingPageGetResponse>;
|
|
489
|
+
/**
|
|
490
|
+
* @param {ContentPlatformApplicationValidator.GetLegalInformationParam} arg
|
|
491
|
+
* - Arg object
|
|
492
|
+
*
|
|
493
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
494
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
495
|
+
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
496
|
+
* @name getLegalInformation
|
|
466
497
|
* @summary: Get legal information
|
|
467
|
-
* @description: Use this API to get the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.
|
|
498
|
+
* @description: Use this API to get the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLegalInformation/).
|
|
468
499
|
*/
|
|
469
|
-
getLegalInformation({}?: any): Promise<ApplicationLegal>;
|
|
500
|
+
getLegalInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.ApplicationLegal>;
|
|
470
501
|
/**
|
|
471
|
-
* @param {
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
* @param {
|
|
476
|
-
*
|
|
477
|
-
* @
|
|
502
|
+
* @param {ContentPlatformApplicationValidator.GetNavigationBySlugParam} arg
|
|
503
|
+
* - Arg object
|
|
504
|
+
*
|
|
505
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
506
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
507
|
+
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
508
|
+
* @name getNavigationBySlug
|
|
478
509
|
* @summary: Get a navigation by slug
|
|
479
|
-
* @description: Use this API to retrieve a navigation by its slug.
|
|
510
|
+
* @description: Use this API to retrieve a navigation by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getNavigationBySlug/).
|
|
480
511
|
*/
|
|
481
|
-
getNavigationBySlug({ slug, devicePlatform }?: {
|
|
482
|
-
slug: string;
|
|
483
|
-
devicePlatform: string;
|
|
484
|
-
}): Promise<NavigationSchema>;
|
|
512
|
+
getNavigationBySlug({ slug, devicePlatform, requestHeaders }?: ContentPlatformApplicationValidator.GetNavigationBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
485
513
|
/**
|
|
486
|
-
* @param {
|
|
487
|
-
* @param {
|
|
488
|
-
*
|
|
489
|
-
* @
|
|
490
|
-
*
|
|
491
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
492
|
-
* page. Default value is 10.
|
|
493
|
-
* @returns {Promise<NavigationGetResponse>} - Success response
|
|
514
|
+
* @param {ContentPlatformApplicationValidator.GetNavigationsParam} arg - Arg object
|
|
515
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
516
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
517
|
+
* @returns {Promise<ContentPlatformModel.NavigationGetResponse>} - Success response
|
|
518
|
+
* @name getNavigations
|
|
494
519
|
* @summary: Get navigations
|
|
495
|
-
* @description: Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the orientation, links, sub-navigations, etc.
|
|
520
|
+
* @description: Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the orientation, links, sub-navigations, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getNavigations/).
|
|
496
521
|
*/
|
|
497
|
-
getNavigations({ devicePlatform, pageNo, pageSize }?: {
|
|
498
|
-
devicePlatform: string;
|
|
499
|
-
pageNo?: number;
|
|
500
|
-
pageSize?: number;
|
|
501
|
-
}): Promise<NavigationGetResponse>;
|
|
522
|
+
getNavigations({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetNavigationsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationGetResponse>;
|
|
502
523
|
/**
|
|
503
524
|
* @param {Object} arg - Arg object.
|
|
504
525
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -509,6 +530,7 @@ declare class Content {
|
|
|
509
530
|
* Acceptable values are: web, android, ios, all
|
|
510
531
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
511
532
|
* page. Default value is 10.
|
|
533
|
+
* @returns {Paginator<ContentPlatformModel.NavigationGetResponse>}
|
|
512
534
|
* @summary: Get navigations
|
|
513
535
|
* @description: Use this API to fetch the navigations details which includes the items of the navigation pane. It also shows the orientation, links, sub-navigations, etc.
|
|
514
536
|
*/
|
|
@@ -517,46 +539,47 @@ declare class Content {
|
|
|
517
539
|
applicationId: string;
|
|
518
540
|
devicePlatform: string;
|
|
519
541
|
pageSize?: number;
|
|
520
|
-
}): Paginator
|
|
542
|
+
}): Paginator<ContentPlatformModel.NavigationGetResponse>;
|
|
521
543
|
/**
|
|
522
|
-
* @param {
|
|
523
|
-
* @param {
|
|
524
|
-
*
|
|
525
|
-
* @returns {Promise<PageSchema>} - Success response
|
|
544
|
+
* @param {ContentPlatformApplicationValidator.GetPageBySlugParam} arg - Arg object
|
|
545
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
546
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
547
|
+
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
548
|
+
* @name getPageBySlug
|
|
526
549
|
* @summary: Get page by slug
|
|
527
|
-
* @description: Use this API to retrieve the components of a page, such as its title, seo, publish status, feature image, tags, schedule, etc.
|
|
550
|
+
* @description: Use this API to retrieve the components of a page, such as its title, seo, publish status, feature image, tags, schedule, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageBySlug/).
|
|
528
551
|
*/
|
|
529
|
-
getPageBySlug({ slug }?: {
|
|
530
|
-
slug: string;
|
|
531
|
-
}): Promise<PageSchema>;
|
|
552
|
+
getPageBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetPageBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
532
553
|
/**
|
|
533
|
-
* @param {
|
|
534
|
-
* @
|
|
554
|
+
* @param {ContentPlatformApplicationValidator.GetPageMetaParam} arg - Arg object
|
|
555
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
556
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
557
|
+
* @returns {Promise<ContentPlatformModel.PageMetaSchema>} - Success response
|
|
558
|
+
* @name getPageMeta
|
|
535
559
|
* @summary: Get page meta
|
|
536
|
-
* @description: Use this API to get the meta of custom pages (blog, page) and default system pages (e.g. home/brand/category/collection).
|
|
560
|
+
* @description: Use this API to get the meta of custom pages (blog, page) and default system pages (e.g. home/brand/category/collection). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageMeta/).
|
|
537
561
|
*/
|
|
538
|
-
getPageMeta({}?: any): Promise<PageMetaSchema>;
|
|
562
|
+
getPageMeta({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.PageMetaSchema>;
|
|
539
563
|
/**
|
|
540
|
-
* @param {
|
|
541
|
-
* @
|
|
564
|
+
* @param {ContentPlatformApplicationValidator.GetPageSpecParam} arg - Arg object
|
|
565
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
566
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
567
|
+
* @returns {Promise<ContentPlatformModel.PageSpec>} - Success response
|
|
568
|
+
* @name getPageSpec
|
|
542
569
|
* @summary: Get page spec
|
|
543
|
-
* @description: Use this API to get the specifications of a page, such as page type, display name, params and query.
|
|
570
|
+
* @description: Use this API to get the specifications of a page, such as page type, display name, params and query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageSpec/).
|
|
544
571
|
*/
|
|
545
|
-
getPageSpec({}?: any): Promise<PageSpec>;
|
|
572
|
+
getPageSpec({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSpec>;
|
|
546
573
|
/**
|
|
547
|
-
* @param {
|
|
548
|
-
* @param {
|
|
549
|
-
*
|
|
550
|
-
* @
|
|
551
|
-
*
|
|
552
|
-
* @returns {Promise<PageGetResponse>} - Success response
|
|
574
|
+
* @param {ContentPlatformApplicationValidator.GetPagesParam} arg - Arg object
|
|
575
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
576
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
577
|
+
* @returns {Promise<ContentPlatformModel.PageGetResponse>} - Success response
|
|
578
|
+
* @name getPages
|
|
553
579
|
* @summary: Get a list of pages
|
|
554
|
-
* @description: Use this API to retrieve a list of pages.
|
|
580
|
+
* @description: Use this API to retrieve a list of pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPages/).
|
|
555
581
|
*/
|
|
556
|
-
getPages({ pageNo, pageSize }?: {
|
|
557
|
-
pageNo?: number;
|
|
558
|
-
pageSize?: number;
|
|
559
|
-
}): Promise<PageGetResponse>;
|
|
582
|
+
getPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageGetResponse>;
|
|
560
583
|
/**
|
|
561
584
|
* @param {Object} arg - Arg object.
|
|
562
585
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -565,6 +588,7 @@ declare class Content {
|
|
|
565
588
|
* created within a business account.
|
|
566
589
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
567
590
|
* page. Default value is 10.
|
|
591
|
+
* @returns {Paginator<ContentPlatformModel.PageGetResponse>}
|
|
568
592
|
* @summary: Get a list of pages
|
|
569
593
|
* @description: Use this API to retrieve a list of pages.
|
|
570
594
|
*/
|
|
@@ -572,70 +596,65 @@ declare class Content {
|
|
|
572
596
|
companyId: string;
|
|
573
597
|
applicationId: string;
|
|
574
598
|
pageSize?: number;
|
|
575
|
-
}): Paginator
|
|
576
|
-
/**
|
|
577
|
-
* @param {
|
|
578
|
-
*
|
|
579
|
-
*
|
|
599
|
+
}): Paginator<ContentPlatformModel.PageGetResponse>;
|
|
600
|
+
/**
|
|
601
|
+
* @param {ContentPlatformApplicationValidator.GetPathRedirectionRuleParam} arg
|
|
602
|
+
* - Arg object
|
|
603
|
+
*
|
|
604
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
605
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
606
|
+
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
607
|
+
* @name getPathRedirectionRule
|
|
580
608
|
* @summary: Get path based redirection rule
|
|
581
|
-
* @description: Use this API to get path based redirection rule.
|
|
609
|
+
* @description: Use this API to get path based redirection rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRule/).
|
|
582
610
|
*/
|
|
583
|
-
getPathRedirectionRule({ pathId }?: {
|
|
584
|
-
pathId: string;
|
|
585
|
-
}): Promise<PathMappingSchema>;
|
|
611
|
+
getPathRedirectionRule({ pathId, requestHeaders }?: ContentPlatformApplicationValidator.GetPathRedirectionRuleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
586
612
|
/**
|
|
587
|
-
* @param {
|
|
588
|
-
*
|
|
589
|
-
*
|
|
590
|
-
* @param {
|
|
591
|
-
*
|
|
592
|
-
* @returns {Promise<PathMappingSchema>} - Success response
|
|
613
|
+
* @param {ContentPlatformApplicationValidator.GetPathRedirectionRulesParam} arg
|
|
614
|
+
* - Arg object
|
|
615
|
+
*
|
|
616
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
617
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
618
|
+
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
619
|
+
* @name getPathRedirectionRules
|
|
593
620
|
* @summary: Get path based redirection rules
|
|
594
|
-
* @description: Use this API to get path based redirection rules.
|
|
621
|
+
* @description: Use this API to get path based redirection rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRules/).
|
|
595
622
|
*/
|
|
596
|
-
getPathRedirectionRules({ pageSize, pageNo }?: {
|
|
597
|
-
pageSize?: number;
|
|
598
|
-
pageNo?: number;
|
|
599
|
-
}): Promise<PathMappingSchema>;
|
|
623
|
+
getPathRedirectionRules({ pageSize, pageNo, requestHeaders }?: ContentPlatformApplicationValidator.GetPathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
600
624
|
/**
|
|
601
|
-
* @param {
|
|
602
|
-
*
|
|
625
|
+
* @param {ContentPlatformApplicationValidator.GetSEOConfigurationParam} arg
|
|
626
|
+
* - Arg object
|
|
627
|
+
*
|
|
628
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
629
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
630
|
+
* @returns {Promise<ContentPlatformModel.SeoComponent>} - Success response
|
|
631
|
+
* @name getSEOConfiguration
|
|
603
632
|
* @summary: Get SEO configuration of an application
|
|
604
|
-
* @description: Use this API to know how the SEO is configured in the application. This includes the sitemap, robot.txt, custom meta tags, etc.
|
|
633
|
+
* @description: Use this API to know how the SEO is configured in the application. This includes the sitemap, robot.txt, custom meta tags, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOConfiguration/).
|
|
605
634
|
*/
|
|
606
|
-
getSEOConfiguration({}?: any): Promise<SeoComponent>;
|
|
635
|
+
getSEOConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoComponent>;
|
|
607
636
|
/**
|
|
608
|
-
* @param {
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
* @param {
|
|
613
|
-
*
|
|
614
|
-
* @
|
|
637
|
+
* @param {ContentPlatformApplicationValidator.GetSlideshowBySlugParam} arg
|
|
638
|
+
* - Arg object
|
|
639
|
+
*
|
|
640
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
641
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
642
|
+
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
643
|
+
* @name getSlideshowBySlug
|
|
615
644
|
* @summary: Get slideshow by slug
|
|
616
|
-
* @description: Use this API to retrieve the details of a slideshow by its slug.
|
|
645
|
+
* @description: Use this API to retrieve the details of a slideshow by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSlideshowBySlug/).
|
|
617
646
|
*/
|
|
618
|
-
getSlideshowBySlug({ slug, devicePlatform }?: {
|
|
619
|
-
slug: string;
|
|
620
|
-
devicePlatform: string;
|
|
621
|
-
}): Promise<SlideshowSchema>;
|
|
647
|
+
getSlideshowBySlug({ slug, devicePlatform, requestHeaders }?: ContentPlatformApplicationValidator.GetSlideshowBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
622
648
|
/**
|
|
623
|
-
* @param {
|
|
624
|
-
* @param {
|
|
625
|
-
*
|
|
626
|
-
* @
|
|
627
|
-
*
|
|
628
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
629
|
-
* page. Default value is 10.
|
|
630
|
-
* @returns {Promise<SlideshowGetResponse>} - Success response
|
|
649
|
+
* @param {ContentPlatformApplicationValidator.GetSlideshowsParam} arg - Arg object
|
|
650
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
651
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
652
|
+
* @returns {Promise<ContentPlatformModel.SlideshowGetResponse>} - Success response
|
|
653
|
+
* @name getSlideshows
|
|
631
654
|
* @summary: Get slideshows
|
|
632
|
-
* @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a list of slideshows.
|
|
655
|
+
* @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a list of slideshows. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSlideshows/).
|
|
633
656
|
*/
|
|
634
|
-
getSlideshows({ devicePlatform, pageNo, pageSize }?: {
|
|
635
|
-
devicePlatform: string;
|
|
636
|
-
pageNo?: number;
|
|
637
|
-
pageSize?: number;
|
|
638
|
-
}): Promise<SlideshowGetResponse>;
|
|
657
|
+
getSlideshows({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetSlideshowsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowGetResponse>;
|
|
639
658
|
/**
|
|
640
659
|
* @param {Object} arg - Arg object.
|
|
641
660
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -646,6 +665,7 @@ declare class Content {
|
|
|
646
665
|
* Acceptable values are: web, android, ios and all
|
|
647
666
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
648
667
|
* page. Default value is 10.
|
|
668
|
+
* @returns {Paginator<ContentPlatformModel.SlideshowGetResponse>}
|
|
649
669
|
* @summary: Get slideshows
|
|
650
670
|
* @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a list of slideshows.
|
|
651
671
|
*/
|
|
@@ -654,220 +674,227 @@ declare class Content {
|
|
|
654
674
|
applicationId: string;
|
|
655
675
|
devicePlatform: string;
|
|
656
676
|
pageSize?: number;
|
|
657
|
-
}): Paginator
|
|
658
|
-
/**
|
|
659
|
-
* @param {
|
|
660
|
-
*
|
|
677
|
+
}): Paginator<ContentPlatformModel.SlideshowGetResponse>;
|
|
678
|
+
/**
|
|
679
|
+
* @param {ContentPlatformApplicationValidator.GetSupportInformationParam} arg
|
|
680
|
+
* - Arg object
|
|
681
|
+
*
|
|
682
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
683
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
684
|
+
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
685
|
+
* @name getSupportInformation
|
|
661
686
|
* @summary: Get support information
|
|
662
|
-
* @description: Use this API to get the contact details for customer support, including emails and phone numbers.
|
|
663
|
-
*/
|
|
664
|
-
getSupportInformation({}?: any): Promise<Support>;
|
|
665
|
-
/**
|
|
666
|
-
* @param {
|
|
667
|
-
*
|
|
668
|
-
*
|
|
687
|
+
* @description: Use this API to get the contact details for customer support, including emails and phone numbers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSupportInformation/).
|
|
688
|
+
*/
|
|
689
|
+
getSupportInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
|
|
690
|
+
/**
|
|
691
|
+
* @param {ContentPlatformApplicationValidator.RemoveInjectableTagParam} arg
|
|
692
|
+
* - Arg object
|
|
693
|
+
*
|
|
694
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
695
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
696
|
+
* @returns {Promise<ContentPlatformModel.TagDeleteSuccessResponse>} -
|
|
697
|
+
* Success response
|
|
698
|
+
* @name removeInjectableTag
|
|
669
699
|
* @summary: Remove a tag
|
|
670
|
-
* @description: Use this API to delete an existing tag.
|
|
700
|
+
* @description: Use this API to delete an existing tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/removeInjectableTag/).
|
|
671
701
|
*/
|
|
672
|
-
removeInjectableTag({ body }?: {
|
|
673
|
-
body: RemoveHandpickedSchema;
|
|
674
|
-
}): Promise<TagDeleteSuccessResponse>;
|
|
702
|
+
removeInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.RemoveInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagDeleteSuccessResponse>;
|
|
675
703
|
/**
|
|
676
|
-
* @param {
|
|
677
|
-
* @param {
|
|
678
|
-
* @param {
|
|
679
|
-
* @returns {Promise<DataLoaderResetResponseSchema>} -
|
|
704
|
+
* @param {ContentPlatformApplicationValidator.ResetDataLoaderParam} arg - Arg object
|
|
705
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
706
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
707
|
+
* @returns {Promise<ContentPlatformModel.DataLoaderResetResponseSchema>} -
|
|
708
|
+
* Success response
|
|
709
|
+
* @name resetDataLoader
|
|
680
710
|
* @summary: Reset a data loader by serive name and operation Id
|
|
681
|
-
* @description: Use this API to reselect a data loader.
|
|
711
|
+
* @description: Use this API to reselect a data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/resetDataLoader/).
|
|
682
712
|
*/
|
|
683
|
-
resetDataLoader({ service, operationId }?: {
|
|
684
|
-
service: string;
|
|
685
|
-
operationId: string;
|
|
686
|
-
}): Promise<DataLoaderResetResponseSchema>;
|
|
713
|
+
resetDataLoader({ service, operationId, requestHeaders }?: ContentPlatformApplicationValidator.ResetDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResetResponseSchema>;
|
|
687
714
|
/**
|
|
688
|
-
* @param {
|
|
689
|
-
* @param {
|
|
690
|
-
* @
|
|
715
|
+
* @param {ContentPlatformApplicationValidator.SelectDataLoaderParam} arg - Arg object
|
|
716
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
717
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
718
|
+
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
719
|
+
* Success response
|
|
720
|
+
* @name selectDataLoader
|
|
691
721
|
* @summary: Select a data loader by id
|
|
692
|
-
* @description: Use this API to select a data loader to be used in applications.
|
|
693
|
-
*/
|
|
694
|
-
selectDataLoader({ dataLoaderId }?: {
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
*
|
|
699
|
-
* @param {
|
|
700
|
-
* @param {
|
|
701
|
-
* @returns {Promise<CreateAnnouncementSchema>} -
|
|
722
|
+
* @description: Use this API to select a data loader to be used in applications. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/selectDataLoader/).
|
|
723
|
+
*/
|
|
724
|
+
selectDataLoader({ dataLoaderId, requestHeaders }?: ContentPlatformApplicationValidator.SelectDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
725
|
+
/**
|
|
726
|
+
* @param {ContentPlatformApplicationValidator.UpdateAnnouncementParam} arg
|
|
727
|
+
* - Arg object
|
|
728
|
+
*
|
|
729
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
730
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
731
|
+
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
732
|
+
* Success response
|
|
733
|
+
* @name updateAnnouncement
|
|
702
734
|
* @summary: Update an announcement
|
|
703
|
-
* @description: Use this API to edit an existing announcement and its details such as the target platform and pages on which it's applicable
|
|
704
|
-
*/
|
|
705
|
-
updateAnnouncement({ announcementId, body }?: {
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
* @param {
|
|
711
|
-
* @param {
|
|
712
|
-
* @
|
|
713
|
-
*
|
|
735
|
+
* @description: Use this API to edit an existing announcement and its details such as the target platform and pages on which it's applicable - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAnnouncement/).
|
|
736
|
+
*/
|
|
737
|
+
updateAnnouncement({ announcementId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
738
|
+
/**
|
|
739
|
+
* @param {ContentPlatformApplicationValidator.UpdateAnnouncementScheduleParam} arg
|
|
740
|
+
* - Arg object
|
|
741
|
+
*
|
|
742
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
743
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
744
|
+
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
745
|
+
* Success response
|
|
746
|
+
* @name updateAnnouncementSchedule
|
|
714
747
|
* @summary: Update the schedule and the publish status of an announcement
|
|
715
|
-
* @description: Use this API to edit the duration, i.e. start date-time and end date-time of an announcement. Moreover, you can enable/disable an announcement using this API.
|
|
748
|
+
* @description: Use this API to edit the duration, i.e. start date-time and end date-time of an announcement. Moreover, you can enable/disable an announcement using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAnnouncementSchedule/).
|
|
716
749
|
*/
|
|
717
|
-
updateAnnouncementSchedule({ announcementId, body }?: {
|
|
718
|
-
announcementId: string;
|
|
719
|
-
body: ScheduleSchema;
|
|
720
|
-
}): Promise<CreateAnnouncementSchema>;
|
|
750
|
+
updateAnnouncementSchedule({ announcementId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAnnouncementScheduleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
721
751
|
/**
|
|
722
|
-
* @param {
|
|
723
|
-
* @param {
|
|
724
|
-
* @param {
|
|
725
|
-
* @returns {Promise<BlogSchema>} - Success response
|
|
752
|
+
* @param {ContentPlatformApplicationValidator.UpdateBlogParam} arg - Arg object
|
|
753
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
754
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
755
|
+
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
756
|
+
* @name updateBlog
|
|
726
757
|
* @summary: Update a blog
|
|
727
|
-
* @description: Use this API to update the details of an existing blog which includes title, feature image, content, SEO details, expiry, etc.
|
|
758
|
+
* @description: Use this API to update the details of an existing blog which includes title, feature image, content, SEO details, expiry, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateBlog/).
|
|
728
759
|
*/
|
|
729
|
-
updateBlog({ id, body }?: {
|
|
730
|
-
id: string;
|
|
731
|
-
body: BlogRequest;
|
|
732
|
-
}): Promise<BlogSchema>;
|
|
760
|
+
updateBlog({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
733
761
|
/**
|
|
734
|
-
* @param {
|
|
735
|
-
* @param {
|
|
736
|
-
* @param {
|
|
737
|
-
* @
|
|
738
|
-
* @
|
|
762
|
+
* @param {ContentPlatformApplicationValidator.UpdateFaqParam} arg - Arg object
|
|
763
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
764
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
765
|
+
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
766
|
+
* @name updateFaq
|
|
739
767
|
* @summary: Update an FAQ
|
|
740
|
-
* @description: Use this API to edit an existing FAQ.
|
|
768
|
+
* @description: Use this API to edit an existing FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateFaq/).
|
|
741
769
|
*/
|
|
742
|
-
updateFaq({ categoryId, faqId, body }?: {
|
|
743
|
-
categoryId: string;
|
|
744
|
-
faqId: string;
|
|
745
|
-
body: CreateFaqSchema;
|
|
746
|
-
}): Promise<CreateFaqResponseSchema>;
|
|
770
|
+
updateFaq({ categoryId, faqId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
747
771
|
/**
|
|
748
|
-
* @param {
|
|
749
|
-
*
|
|
750
|
-
*
|
|
751
|
-
* @
|
|
772
|
+
* @param {ContentPlatformApplicationValidator.UpdateFaqCategoryParam} arg
|
|
773
|
+
* - Arg object
|
|
774
|
+
*
|
|
775
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
776
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
777
|
+
* @returns {Promise<ContentPlatformModel.CreateFaqCategorySchema>} - Success response
|
|
778
|
+
* @name updateFaqCategory
|
|
752
779
|
* @summary: Update an FAQ category
|
|
753
|
-
* @description: Use this API to edit an existing FAQ category.
|
|
780
|
+
* @description: Use this API to edit an existing FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateFaqCategory/).
|
|
754
781
|
*/
|
|
755
|
-
updateFaqCategory({ id, body }?: {
|
|
756
|
-
id: string;
|
|
757
|
-
body: UpdateFaqCategoryRequestSchema;
|
|
758
|
-
}): Promise<CreateFaqCategorySchema>;
|
|
782
|
+
updateFaqCategory({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqCategorySchema>;
|
|
759
783
|
/**
|
|
760
|
-
* @param {
|
|
761
|
-
*
|
|
762
|
-
*
|
|
784
|
+
* @param {ContentPlatformApplicationValidator.UpdateInjectableTagParam} arg
|
|
785
|
+
* - Arg object
|
|
786
|
+
*
|
|
787
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
788
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
789
|
+
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
790
|
+
* @name updateInjectableTag
|
|
763
791
|
* @summary: Update a tag
|
|
764
|
-
* @description: Use this API to edit the details of an existing tag. This includes the tag name, tag type (css/js), url and position of the tag.
|
|
792
|
+
* @description: Use this API to edit the details of an existing tag. This includes the tag name, tag type (css/js), url and position of the tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateInjectableTag/).
|
|
765
793
|
*/
|
|
766
|
-
updateInjectableTag({ body }?: {
|
|
767
|
-
body: CreateTagRequestSchema;
|
|
768
|
-
}): Promise<TagsSchema>;
|
|
794
|
+
updateInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
769
795
|
/**
|
|
770
|
-
* @param {
|
|
771
|
-
*
|
|
772
|
-
*
|
|
773
|
-
* @
|
|
796
|
+
* @param {ContentPlatformApplicationValidator.UpdateLandingPageParam} arg
|
|
797
|
+
* - Arg object
|
|
798
|
+
*
|
|
799
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
800
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
801
|
+
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
802
|
+
* @name updateLandingPage
|
|
774
803
|
* @summary: Update a landing page
|
|
775
|
-
* @description: Use this API to edit the details of an existing landing page.
|
|
804
|
+
* @description: Use this API to edit the details of an existing landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateLandingPage/).
|
|
776
805
|
*/
|
|
777
|
-
updateLandingPage({ id, body }?: {
|
|
778
|
-
id: string;
|
|
779
|
-
body: LandingPageSchema;
|
|
780
|
-
}): Promise<LandingPageSchema>;
|
|
806
|
+
updateLandingPage({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
781
807
|
/**
|
|
782
|
-
* @param {
|
|
783
|
-
*
|
|
784
|
-
*
|
|
808
|
+
* @param {ContentPlatformApplicationValidator.UpdateLegalInformationParam} arg
|
|
809
|
+
* - Arg object
|
|
810
|
+
*
|
|
811
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
812
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
813
|
+
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
814
|
+
* @name updateLegalInformation
|
|
785
815
|
* @summary: Save legal information
|
|
786
|
-
* @description: Use this API to edit, update and save the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application.
|
|
816
|
+
* @description: Use this API to edit, update and save the legal information of an application, which includes Policy, Terms and Conditions, Shipping Policy and FAQ regarding the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateLegalInformation/).
|
|
787
817
|
*/
|
|
788
|
-
updateLegalInformation({ body }?: {
|
|
789
|
-
body: ApplicationLegal;
|
|
790
|
-
}): Promise<ApplicationLegal>;
|
|
818
|
+
updateLegalInformation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateLegalInformationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.ApplicationLegal>;
|
|
791
819
|
/**
|
|
792
|
-
* @param {
|
|
793
|
-
* @param {
|
|
794
|
-
* @param {
|
|
795
|
-
* @returns {Promise<NavigationSchema>} - Success response
|
|
820
|
+
* @param {ContentPlatformApplicationValidator.UpdateNavigationParam} arg - Arg object
|
|
821
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
822
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
823
|
+
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
824
|
+
* @name updateNavigation
|
|
796
825
|
* @summary: Update a navigation
|
|
797
|
-
* @description: Use this API to edit the details of an existing navigation.
|
|
826
|
+
* @description: Use this API to edit the details of an existing navigation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateNavigation/).
|
|
798
827
|
*/
|
|
799
|
-
updateNavigation({ id, body }?: {
|
|
800
|
-
id: string;
|
|
801
|
-
body: NavigationRequest;
|
|
802
|
-
}): Promise<NavigationSchema>;
|
|
828
|
+
updateNavigation({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
803
829
|
/**
|
|
804
|
-
* @param {
|
|
805
|
-
* @param {
|
|
806
|
-
* @param {
|
|
807
|
-
* @returns {Promise<PageSchema>} - Success response
|
|
830
|
+
* @param {ContentPlatformApplicationValidator.UpdatePageParam} arg - Arg object
|
|
831
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
832
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
833
|
+
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
834
|
+
* @name updatePage
|
|
808
835
|
* @summary: Update a page
|
|
809
|
-
* @description: Use this API to edit the details of an existing page, such as its title, seo, publish status, feature image, tags, schedule, etc.
|
|
836
|
+
* @description: Use this API to edit the details of an existing page, such as its title, seo, publish status, feature image, tags, schedule, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePage/).
|
|
810
837
|
*/
|
|
811
|
-
updatePage({ id, body }?: {
|
|
812
|
-
id: string;
|
|
813
|
-
body: PageSchema;
|
|
814
|
-
}): Promise<PageSchema>;
|
|
838
|
+
updatePage({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
815
839
|
/**
|
|
816
|
-
* @param {
|
|
817
|
-
*
|
|
818
|
-
*
|
|
819
|
-
* @param {
|
|
820
|
-
* @
|
|
840
|
+
* @param {ContentPlatformApplicationValidator.UpdatePagePreviewParam} arg
|
|
841
|
+
* - Arg object
|
|
842
|
+
*
|
|
843
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
844
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
845
|
+
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
846
|
+
* @name updatePagePreview
|
|
821
847
|
* @summary: Change the publish status of a page
|
|
822
|
-
* @description: Use this API to change the publish status of an existing page. Allows you to publish and unpublish the page.
|
|
848
|
+
* @description: Use this API to change the publish status of an existing page. Allows you to publish and unpublish the page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePagePreview/).
|
|
823
849
|
*/
|
|
824
|
-
updatePagePreview({ slug, body }?: {
|
|
825
|
-
slug: string;
|
|
826
|
-
body: PagePublishRequest;
|
|
827
|
-
}): Promise<PageSchema>;
|
|
850
|
+
updatePagePreview({ slug, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePagePreviewParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
828
851
|
/**
|
|
829
|
-
* @param {
|
|
830
|
-
*
|
|
831
|
-
*
|
|
832
|
-
* @
|
|
852
|
+
* @param {ContentPlatformApplicationValidator.UpdatePathRedirectionRulesParam} arg
|
|
853
|
+
* - Arg object
|
|
854
|
+
*
|
|
855
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
856
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
857
|
+
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
858
|
+
* @name updatePathRedirectionRules
|
|
833
859
|
* @summary: Update path based redirection rules
|
|
834
|
-
* @description: Use this API to update redirection rules
|
|
860
|
+
* @description: Use this API to update redirection rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePathRedirectionRules/).
|
|
835
861
|
*/
|
|
836
|
-
updatePathRedirectionRules({ pathId, body }?: {
|
|
837
|
-
pathId: string;
|
|
838
|
-
body: PathMappingSchema;
|
|
839
|
-
}): Promise<PathMappingSchema>;
|
|
862
|
+
updatePathRedirectionRules({ pathId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
840
863
|
/**
|
|
841
|
-
* @param {
|
|
842
|
-
*
|
|
843
|
-
*
|
|
864
|
+
* @param {ContentPlatformApplicationValidator.UpdateSEOConfigurationParam} arg
|
|
865
|
+
* - Arg object
|
|
866
|
+
*
|
|
867
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
868
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
869
|
+
* @returns {Promise<ContentPlatformModel.SeoSchema>} - Success response
|
|
870
|
+
* @name updateSEOConfiguration
|
|
844
871
|
* @summary: Update SEO of application
|
|
845
|
-
* @description: Use this API to edit the SEO details of an application. This includes the sitemap, robot.txt, custom meta tags, etc.
|
|
872
|
+
* @description: Use this API to edit the SEO details of an application. This includes the sitemap, robot.txt, custom meta tags, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSEOConfiguration/).
|
|
846
873
|
*/
|
|
847
|
-
updateSEOConfiguration({ body }?: {
|
|
848
|
-
body: SeoComponent;
|
|
849
|
-
}): Promise<SeoSchema>;
|
|
874
|
+
updateSEOConfiguration({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSEOConfigurationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchema>;
|
|
850
875
|
/**
|
|
851
|
-
* @param {
|
|
852
|
-
* @param {
|
|
853
|
-
* @param {
|
|
854
|
-
* @returns {Promise<SlideshowSchema>} - Success response
|
|
876
|
+
* @param {ContentPlatformApplicationValidator.UpdateSlideshowParam} arg - Arg object
|
|
877
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
878
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
879
|
+
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
880
|
+
* @name updateSlideshow
|
|
855
881
|
* @summary: Update a slideshow
|
|
856
|
-
* @description: Use this API to edit the details of an existing slideshow.
|
|
882
|
+
* @description: Use this API to edit the details of an existing slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSlideshow/).
|
|
857
883
|
*/
|
|
858
|
-
updateSlideshow({ id, body }?: {
|
|
859
|
-
id: string;
|
|
860
|
-
body: SlideshowRequest;
|
|
861
|
-
}): Promise<SlideshowSchema>;
|
|
884
|
+
updateSlideshow({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
862
885
|
/**
|
|
863
|
-
* @param {
|
|
864
|
-
*
|
|
865
|
-
*
|
|
886
|
+
* @param {ContentPlatformApplicationValidator.UpdateSupportInformationParam} arg
|
|
887
|
+
* - Arg object
|
|
888
|
+
*
|
|
889
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
890
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
891
|
+
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
892
|
+
* @name updateSupportInformation
|
|
866
893
|
* @summary: Update the support data of an application
|
|
867
|
-
* @description: Use this API to edit the existing contact details for customer support, including emails and phone numbers.
|
|
894
|
+
* @description: Use this API to edit the existing contact details for customer support, including emails and phone numbers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSupportInformation/).
|
|
868
895
|
*/
|
|
869
|
-
updateSupportInformation({ body }?: {
|
|
870
|
-
body: Support;
|
|
871
|
-
}): Promise<Support>;
|
|
896
|
+
updateSupportInformation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSupportInformationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
|
|
872
897
|
}
|
|
898
|
+
import ContentPlatformApplicationValidator = require("./ContentPlatformApplicationValidator");
|
|
899
|
+
import ContentPlatformModel = require("./ContentPlatformModel");
|
|
873
900
|
import Paginator = require("../../common/Paginator");
|