@gofynd/fdk-client-javascript 1.2.0 → 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 +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +4 -4
- package/sdk/application/Cart/CartApplicationModel.js +4 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- 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 +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +96 -9
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +117 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- 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 +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -5,6 +5,7 @@ declare class Content {
|
|
|
5
5
|
applicationId: any;
|
|
6
6
|
/**
|
|
7
7
|
* @param {ContentPlatformApplicationValidator.AddDataLoaderParam} arg - Arg object
|
|
8
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
9
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
10
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
10
11
|
* Success response
|
|
@@ -12,40 +13,44 @@ declare class Content {
|
|
|
12
13
|
* @summary: Adds a data loader
|
|
13
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/).
|
|
14
15
|
*/
|
|
15
|
-
addDataLoader({ body }?: ContentPlatformApplicationValidator.AddDataLoaderParam, {
|
|
16
|
+
addDataLoader({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
16
17
|
/**
|
|
17
18
|
* @param {ContentPlatformApplicationValidator.AddFaqParam} arg - Arg object
|
|
19
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
21
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
20
22
|
* @name addFaq
|
|
21
23
|
* @summary: Create an FAQ
|
|
22
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 }?: ContentPlatformApplicationValidator.AddFaqParam, {
|
|
26
|
+
addFaq({ categoryId, body, requestHeaders }?: ContentPlatformApplicationValidator.AddFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
25
27
|
/**
|
|
26
28
|
* @param {ContentPlatformApplicationValidator.AddInjectableTagParam} arg - Arg object
|
|
29
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
27
30
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
28
31
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
29
32
|
* @name addInjectableTag
|
|
30
33
|
* @summary: Add a tag
|
|
31
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/).
|
|
32
35
|
*/
|
|
33
|
-
addInjectableTag({ body }?: ContentPlatformApplicationValidator.AddInjectableTagParam, {
|
|
36
|
+
addInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
34
37
|
/**
|
|
35
38
|
* @param {ContentPlatformApplicationValidator.AddPathRedirectionRulesParam} arg
|
|
36
39
|
* - Arg object
|
|
37
40
|
*
|
|
41
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
42
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
43
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
40
44
|
* @name addPathRedirectionRules
|
|
41
45
|
* @summary: Save path based redirection rules
|
|
42
46
|
* @description: Use this API to add redirection rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addPathRedirectionRules/).
|
|
43
47
|
*/
|
|
44
|
-
addPathRedirectionRules({ body }?: ContentPlatformApplicationValidator.AddPathRedirectionRulesParam, {
|
|
48
|
+
addPathRedirectionRules({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddPathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
45
49
|
/**
|
|
46
50
|
* @param {ContentPlatformApplicationValidator.CreateAnnouncementParam} arg
|
|
47
51
|
* - Arg object
|
|
48
52
|
*
|
|
53
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
49
54
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
50
55
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
51
56
|
* Success response
|
|
@@ -53,88 +58,100 @@ declare class Content {
|
|
|
53
58
|
* @summary: Create an announcement
|
|
54
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/).
|
|
55
60
|
*/
|
|
56
|
-
createAnnouncement({ body }?: ContentPlatformApplicationValidator.CreateAnnouncementParam, {
|
|
61
|
+
createAnnouncement({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
57
62
|
/**
|
|
58
63
|
* @param {ContentPlatformApplicationValidator.CreateBlogParam} arg - Arg object
|
|
64
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
65
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
66
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
61
67
|
* @name createBlog
|
|
62
68
|
* @summary: Create a blog
|
|
63
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 }?: ContentPlatformApplicationValidator.CreateBlogParam, {
|
|
71
|
+
createBlog({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
66
72
|
/**
|
|
67
73
|
* @param {ContentPlatformApplicationValidator.CreateFaqCategoryParam} arg
|
|
68
74
|
* - Arg object
|
|
69
75
|
*
|
|
76
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
70
77
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
71
78
|
* @returns {Promise<ContentPlatformModel.CreateFaqCategorySchema>} - Success response
|
|
72
79
|
* @name createFaqCategory
|
|
73
80
|
* @summary: Create an FAQ category
|
|
74
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/).
|
|
75
82
|
*/
|
|
76
|
-
createFaqCategory({ body }?: ContentPlatformApplicationValidator.CreateFaqCategoryParam, {
|
|
83
|
+
createFaqCategory({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqCategorySchema>;
|
|
77
84
|
/**
|
|
78
85
|
* @param {ContentPlatformApplicationValidator.CreateLandingPageParam} arg
|
|
79
86
|
* - Arg object
|
|
80
87
|
*
|
|
88
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
81
89
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
82
90
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
83
91
|
* @name createLandingPage
|
|
84
92
|
* @summary: Create a landing page
|
|
85
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/).
|
|
86
94
|
*/
|
|
87
|
-
createLandingPage({ body }?: ContentPlatformApplicationValidator.CreateLandingPageParam, {
|
|
95
|
+
createLandingPage({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
88
96
|
/**
|
|
89
97
|
* @param {ContentPlatformApplicationValidator.CreateNavigationParam} arg - Arg object
|
|
98
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
100
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
92
101
|
* @name createNavigation
|
|
93
102
|
* @summary: Create a navigation
|
|
94
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/).
|
|
95
104
|
*/
|
|
96
|
-
createNavigation({ body }?: ContentPlatformApplicationValidator.CreateNavigationParam, {
|
|
105
|
+
createNavigation({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
97
106
|
/**
|
|
98
107
|
* @param {ContentPlatformApplicationValidator.CreatePageParam} arg - Arg object
|
|
108
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
110
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
101
111
|
* @name createPage
|
|
102
112
|
* @summary: Create a page
|
|
103
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 }?: ContentPlatformApplicationValidator.CreatePageParam, {
|
|
115
|
+
createPage({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
106
116
|
/**
|
|
107
117
|
* @param {ContentPlatformApplicationValidator.CreatePagePreviewParam} arg
|
|
108
118
|
* - Arg object
|
|
109
119
|
*
|
|
120
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
121
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
111
122
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
112
123
|
* @name createPagePreview
|
|
113
124
|
* @summary: Create a page preview
|
|
114
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/).
|
|
115
126
|
*/
|
|
116
|
-
createPagePreview({ body }?: ContentPlatformApplicationValidator.CreatePagePreviewParam, {
|
|
127
|
+
createPagePreview({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreatePagePreviewParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
117
128
|
/**
|
|
118
129
|
* @param {ContentPlatformApplicationValidator.CreateSlideshowParam} arg - Arg object
|
|
130
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
119
131
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
120
132
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
121
133
|
* @name createSlideshow
|
|
122
134
|
* @summary: Create a slideshow
|
|
123
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 }?: ContentPlatformApplicationValidator.CreateSlideshowParam, {
|
|
137
|
+
createSlideshow({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
126
138
|
/**
|
|
139
|
+
* @param {ContentPlatformApplicationValidator.DeleteAllInjectableTagsParam} arg
|
|
140
|
+
* - Arg object
|
|
141
|
+
*
|
|
142
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
127
143
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
128
144
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
129
145
|
* @name deleteAllInjectableTags
|
|
130
146
|
* @summary: Delete tags in application
|
|
131
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/).
|
|
132
148
|
*/
|
|
133
|
-
deleteAllInjectableTags({
|
|
149
|
+
deleteAllInjectableTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
134
150
|
/**
|
|
135
151
|
* @param {ContentPlatformApplicationValidator.DeleteAnnouncementParam} arg
|
|
136
152
|
* - Arg object
|
|
137
153
|
*
|
|
154
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
138
155
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
139
156
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
140
157
|
* Success response
|
|
@@ -142,18 +159,20 @@ declare class Content {
|
|
|
142
159
|
* @summary: Delete announcement by id
|
|
143
160
|
* @description: Use this API to delete an existing announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAnnouncement/).
|
|
144
161
|
*/
|
|
145
|
-
deleteAnnouncement({ announcementId }?: ContentPlatformApplicationValidator.DeleteAnnouncementParam, {
|
|
162
|
+
deleteAnnouncement({ announcementId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
146
163
|
/**
|
|
147
164
|
* @param {ContentPlatformApplicationValidator.DeleteBlogParam} arg - Arg object
|
|
165
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
148
166
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
149
167
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
150
168
|
* @name deleteBlog
|
|
151
169
|
* @summary: Delete blogs
|
|
152
170
|
* @description: Use this API to delete a blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteBlog/).
|
|
153
171
|
*/
|
|
154
|
-
deleteBlog({ id }?: ContentPlatformApplicationValidator.DeleteBlogParam, {
|
|
172
|
+
deleteBlog({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
155
173
|
/**
|
|
156
174
|
* @param {ContentPlatformApplicationValidator.DeleteDataLoaderParam} arg - Arg object
|
|
175
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
157
176
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
158
177
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
159
178
|
* Success response
|
|
@@ -161,78 +180,86 @@ declare class Content {
|
|
|
161
180
|
* @summary: Delete data loader in application
|
|
162
181
|
* @description: Use this API to delete data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteDataLoader/).
|
|
163
182
|
*/
|
|
164
|
-
deleteDataLoader({ dataLoaderId }?: ContentPlatformApplicationValidator.DeleteDataLoaderParam, {
|
|
183
|
+
deleteDataLoader({ dataLoaderId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
165
184
|
/**
|
|
166
185
|
* @param {ContentPlatformApplicationValidator.DeleteFaqParam} arg - Arg object
|
|
186
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
167
187
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
168
188
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
169
189
|
* @name deleteFaq
|
|
170
190
|
* @summary: Delete an FAQ
|
|
171
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 }?: ContentPlatformApplicationValidator.DeleteFaqParam, {
|
|
193
|
+
deleteFaq({ categoryId, faqId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
174
194
|
/**
|
|
175
195
|
* @param {ContentPlatformApplicationValidator.DeleteFaqCategoryParam} arg
|
|
176
196
|
* - Arg object
|
|
177
197
|
*
|
|
198
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
178
199
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
200
|
* @returns {Promise<ContentPlatformModel.FaqSchema>} - Success response
|
|
180
201
|
* @name deleteFaqCategory
|
|
181
202
|
* @summary: Delete an FAQ category
|
|
182
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 }?: ContentPlatformApplicationValidator.DeleteFaqCategoryParam, {
|
|
205
|
+
deleteFaqCategory({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.FaqSchema>;
|
|
185
206
|
/**
|
|
186
207
|
* @param {ContentPlatformApplicationValidator.DeleteLandingPageParam} arg
|
|
187
208
|
* - Arg object
|
|
188
209
|
*
|
|
210
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
189
211
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
190
212
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
191
213
|
* @name deleteLandingPage
|
|
192
214
|
* @summary: Delete a landing page
|
|
193
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/).
|
|
194
216
|
*/
|
|
195
|
-
deleteLandingPage({ id }?: ContentPlatformApplicationValidator.DeleteLandingPageParam, {
|
|
217
|
+
deleteLandingPage({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
196
218
|
/**
|
|
197
219
|
* @param {ContentPlatformApplicationValidator.DeleteNavigationParam} arg - Arg object
|
|
220
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
198
221
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
199
222
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
200
223
|
* @name deleteNavigation
|
|
201
224
|
* @summary: Delete a navigation
|
|
202
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 }?: ContentPlatformApplicationValidator.DeleteNavigationParam, {
|
|
227
|
+
deleteNavigation({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
205
228
|
/**
|
|
206
229
|
* @param {ContentPlatformApplicationValidator.DeletePageParam} arg - Arg object
|
|
230
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
207
231
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
208
232
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
209
233
|
* @name deletePage
|
|
210
234
|
* @summary: Delete a page
|
|
211
235
|
* @description: Use this API to delete an existing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deletePage/).
|
|
212
236
|
*/
|
|
213
|
-
deletePage({ id }?: ContentPlatformApplicationValidator.DeletePageParam, {
|
|
237
|
+
deletePage({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeletePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
214
238
|
/**
|
|
215
239
|
* @param {ContentPlatformApplicationValidator.DeletePathRedirectionRulesParam} arg
|
|
216
240
|
* - Arg object
|
|
217
241
|
*
|
|
242
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
218
243
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
219
244
|
* @returns {Promise<Object>} - Success response
|
|
220
245
|
* @name deletePathRedirectionRules
|
|
221
246
|
* @summary: Delete path based redirection rules
|
|
222
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 }?: ContentPlatformApplicationValidator.DeletePathRedirectionRulesParam, {
|
|
249
|
+
deletePathRedirectionRules({ pathId, requestHeaders }?: ContentPlatformApplicationValidator.DeletePathRedirectionRulesParam, { responseHeaders }?: object): Promise<any>;
|
|
225
250
|
/**
|
|
226
251
|
* @param {ContentPlatformApplicationValidator.DeleteSlideshowParam} arg - Arg object
|
|
252
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
227
253
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
228
254
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
229
255
|
* @name deleteSlideshow
|
|
230
256
|
* @summary: Delete a slideshow
|
|
231
257
|
* @description: Use this API to delete an existing slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSlideshow/).
|
|
232
258
|
*/
|
|
233
|
-
deleteSlideshow({ id }?: ContentPlatformApplicationValidator.DeleteSlideshowParam, {
|
|
259
|
+
deleteSlideshow({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
234
260
|
/**
|
|
235
261
|
* @param {ContentPlatformApplicationValidator.EditDataLoaderParam} arg - Arg object
|
|
262
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
236
263
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
237
264
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
238
265
|
* Success response
|
|
@@ -240,42 +267,46 @@ declare class Content {
|
|
|
240
267
|
* @summary: Edit a data loader by id
|
|
241
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/).
|
|
242
269
|
*/
|
|
243
|
-
editDataLoader({ dataLoaderId, body }?: ContentPlatformApplicationValidator.EditDataLoaderParam, {
|
|
270
|
+
editDataLoader({ dataLoaderId, body, requestHeaders }?: ContentPlatformApplicationValidator.EditDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
244
271
|
/**
|
|
245
272
|
* @param {ContentPlatformApplicationValidator.EditInjectableTagParam} arg
|
|
246
273
|
* - Arg object
|
|
247
274
|
*
|
|
275
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
248
276
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
249
277
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
250
278
|
* @name editInjectableTag
|
|
251
279
|
* @summary: Edit a tag by id
|
|
252
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/).
|
|
253
281
|
*/
|
|
254
|
-
editInjectableTag({ tagId, body }?: ContentPlatformApplicationValidator.EditInjectableTagParam, {
|
|
282
|
+
editInjectableTag({ tagId, body, requestHeaders }?: ContentPlatformApplicationValidator.EditInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
255
283
|
/**
|
|
256
284
|
* @param {ContentPlatformApplicationValidator.GenerateSEOTitleParam} arg - Arg object
|
|
285
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
286
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
287
|
* @returns {Promise<ContentPlatformModel.GeneratedSEOContent>} - Success response
|
|
259
288
|
* @name generateSEOTitle
|
|
260
289
|
* @summary: Get SEO meta tag title for content
|
|
261
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/).
|
|
262
291
|
*/
|
|
263
|
-
generateSEOTitle({ type, body }?: ContentPlatformApplicationValidator.GenerateSEOTitleParam, {
|
|
292
|
+
generateSEOTitle({ type, body, requestHeaders }?: ContentPlatformApplicationValidator.GenerateSEOTitleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GeneratedSEOContent>;
|
|
264
293
|
/**
|
|
265
294
|
* @param {ContentPlatformApplicationValidator.GetAnnouncementByIdParam} arg
|
|
266
295
|
* - Arg object
|
|
267
296
|
*
|
|
297
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
268
298
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
269
299
|
* @returns {Promise<ContentPlatformModel.AdminAnnouncementSchema>} - Success response
|
|
270
300
|
* @name getAnnouncementById
|
|
271
301
|
* @summary: Get announcement by ID
|
|
272
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/).
|
|
273
303
|
*/
|
|
274
|
-
getAnnouncementById({ announcementId }?: ContentPlatformApplicationValidator.GetAnnouncementByIdParam, {
|
|
304
|
+
getAnnouncementById({ announcementId, requestHeaders }?: ContentPlatformApplicationValidator.GetAnnouncementByIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.AdminAnnouncementSchema>;
|
|
275
305
|
/**
|
|
276
306
|
* @param {ContentPlatformApplicationValidator.GetAnnouncementsListParam} arg
|
|
277
307
|
* - Arg object
|
|
278
308
|
*
|
|
309
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
279
310
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
280
311
|
* @returns {Promise<ContentPlatformModel.GetAnnouncementListSchema>} -
|
|
281
312
|
* Success response
|
|
@@ -283,7 +314,7 @@ declare class Content {
|
|
|
283
314
|
* @summary: Get a list of announcements
|
|
284
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/).
|
|
285
316
|
*/
|
|
286
|
-
getAnnouncementsList({ pageNo, pageSize }?: ContentPlatformApplicationValidator.GetAnnouncementsListParam, {
|
|
317
|
+
getAnnouncementsList({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetAnnouncementsListParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetAnnouncementListSchema>;
|
|
287
318
|
/**
|
|
288
319
|
* @param {Object} arg - Arg object.
|
|
289
320
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -303,22 +334,24 @@ declare class Content {
|
|
|
303
334
|
}): Paginator<ContentPlatformModel.GetAnnouncementListSchema>;
|
|
304
335
|
/**
|
|
305
336
|
* @param {ContentPlatformApplicationValidator.GetBlogBySlugParam} arg - Arg object
|
|
337
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
306
338
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
307
339
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
308
340
|
* @name getBlogBySlug
|
|
309
341
|
* @summary: Get blog by slug
|
|
310
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/).
|
|
311
343
|
*/
|
|
312
|
-
getBlogBySlug({ slug }?: ContentPlatformApplicationValidator.GetBlogBySlugParam, {
|
|
344
|
+
getBlogBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
313
345
|
/**
|
|
314
346
|
* @param {ContentPlatformApplicationValidator.GetBlogsParam} arg - Arg object
|
|
347
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
348
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
316
349
|
* @returns {Promise<ContentPlatformModel.BlogGetResponse>} - Success response
|
|
317
350
|
* @name getBlogs
|
|
318
351
|
* @summary: Get blogs
|
|
319
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/).
|
|
320
353
|
*/
|
|
321
|
-
getBlogs({ pageNo, pageSize }?: ContentPlatformApplicationValidator.GetBlogsParam, {
|
|
354
|
+
getBlogs({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetResponse>;
|
|
322
355
|
/**
|
|
323
356
|
* @param {Object} arg - Arg object.
|
|
324
357
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -338,22 +371,29 @@ declare class Content {
|
|
|
338
371
|
}): Paginator<ContentPlatformModel.BlogGetResponse>;
|
|
339
372
|
/**
|
|
340
373
|
* @param {ContentPlatformApplicationValidator.GetComponentByIdParam} arg - Arg object
|
|
374
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
341
375
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
342
376
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
343
377
|
* @name getComponentById
|
|
344
378
|
* @summary: Get components of a blog
|
|
345
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/).
|
|
346
380
|
*/
|
|
347
|
-
getComponentById({ slug }?: ContentPlatformApplicationValidator.GetComponentByIdParam, {
|
|
381
|
+
getComponentById({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetComponentByIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
348
382
|
/**
|
|
383
|
+
* @param {ContentPlatformApplicationValidator.GetDataLoadersParam} arg - Arg object
|
|
384
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
349
385
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
350
386
|
* @returns {Promise<ContentPlatformModel.DataLoadersSchema>} - Success response
|
|
351
387
|
* @name getDataLoaders
|
|
352
388
|
* @summary: Get all the data loaders in an application
|
|
353
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/).
|
|
354
390
|
*/
|
|
355
|
-
getDataLoaders({
|
|
391
|
+
getDataLoaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoadersSchema>;
|
|
356
392
|
/**
|
|
393
|
+
* @param {ContentPlatformApplicationValidator.GetDefaultNavigationsParam} arg
|
|
394
|
+
* - Arg object
|
|
395
|
+
*
|
|
396
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
357
397
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
358
398
|
* @returns {Promise<ContentPlatformModel.DefaultNavigationResponse>} -
|
|
359
399
|
* Success response
|
|
@@ -361,28 +401,32 @@ declare class Content {
|
|
|
361
401
|
* @summary: Get default navigations
|
|
362
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/).
|
|
363
403
|
*/
|
|
364
|
-
getDefaultNavigations({
|
|
404
|
+
getDefaultNavigations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultNavigationResponse>;
|
|
365
405
|
/**
|
|
366
406
|
* @param {ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam} arg - Arg object
|
|
407
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
367
408
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
368
409
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
369
410
|
* @name getFaqByIdOrSlug
|
|
370
411
|
* @summary: Get an FAQ
|
|
371
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/).
|
|
372
413
|
*/
|
|
373
|
-
getFaqByIdOrSlug({ idOrSlug }?: ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam, {
|
|
414
|
+
getFaqByIdOrSlug({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
374
415
|
/**
|
|
416
|
+
* @param {ContentPlatformApplicationValidator.GetFaqCategoriesParam} arg - Arg object
|
|
417
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
375
418
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
376
419
|
* @returns {Promise<ContentPlatformModel.GetFaqCategoriesSchema>} - Success response
|
|
377
420
|
* @name getFaqCategories
|
|
378
421
|
* @summary: Get a list of FAQ categories
|
|
379
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/).
|
|
380
423
|
*/
|
|
381
|
-
getFaqCategories({
|
|
424
|
+
getFaqCategories({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqCategoriesSchema>;
|
|
382
425
|
/**
|
|
383
426
|
* @param {ContentPlatformApplicationValidator.GetFaqCategoryBySlugOrIdParam} arg
|
|
384
427
|
* - Arg object
|
|
385
428
|
*
|
|
429
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
386
430
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
387
431
|
* @returns {Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>} -
|
|
388
432
|
* Success response
|
|
@@ -390,35 +434,41 @@ declare class Content {
|
|
|
390
434
|
* @summary: Get an FAQ category by slug or id
|
|
391
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/).
|
|
392
436
|
*/
|
|
393
|
-
getFaqCategoryBySlugOrId({ idOrSlug }?: ContentPlatformApplicationValidator.GetFaqCategoryBySlugOrIdParam, {
|
|
437
|
+
getFaqCategoryBySlugOrId({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqCategoryBySlugOrIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>;
|
|
394
438
|
/**
|
|
395
439
|
* @param {ContentPlatformApplicationValidator.GetFaqsByCategoryIdOrSlugParam} arg
|
|
396
440
|
* - Arg object
|
|
397
441
|
*
|
|
442
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
398
443
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
399
444
|
* @returns {Promise<ContentPlatformModel.GetFaqSchema>} - Success response
|
|
400
445
|
* @name getFaqsByCategoryIdOrSlug
|
|
401
446
|
* @summary: Get question and answers within an FAQ category
|
|
402
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/).
|
|
403
448
|
*/
|
|
404
|
-
getFaqsByCategoryIdOrSlug({ idOrSlug }?: ContentPlatformApplicationValidator.GetFaqsByCategoryIdOrSlugParam, {
|
|
449
|
+
getFaqsByCategoryIdOrSlug({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqsByCategoryIdOrSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqSchema>;
|
|
405
450
|
/**
|
|
451
|
+
* @param {ContentPlatformApplicationValidator.GetInjectableTagsParam} arg
|
|
452
|
+
* - Arg object
|
|
453
|
+
*
|
|
454
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
406
455
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
407
456
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
408
457
|
* @name getInjectableTags
|
|
409
458
|
* @summary: Get all the tags in an application
|
|
410
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/).
|
|
411
460
|
*/
|
|
412
|
-
getInjectableTags({
|
|
461
|
+
getInjectableTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
413
462
|
/**
|
|
414
463
|
* @param {ContentPlatformApplicationValidator.GetLandingPagesParam} arg - Arg object
|
|
464
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
415
465
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
416
466
|
* @returns {Promise<ContentPlatformModel.LandingPageGetResponse>} - Success response
|
|
417
467
|
* @name getLandingPages
|
|
418
468
|
* @summary: Get landing pages
|
|
419
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/).
|
|
420
470
|
*/
|
|
421
|
-
getLandingPages({ pageNo, pageSize }?: ContentPlatformApplicationValidator.GetLandingPagesParam, {
|
|
471
|
+
getLandingPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetLandingPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageGetResponse>;
|
|
422
472
|
/**
|
|
423
473
|
* @param {Object} arg - Arg object.
|
|
424
474
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -437,33 +487,39 @@ declare class Content {
|
|
|
437
487
|
pageSize?: number;
|
|
438
488
|
}): Paginator<ContentPlatformModel.LandingPageGetResponse>;
|
|
439
489
|
/**
|
|
490
|
+
* @param {ContentPlatformApplicationValidator.GetLegalInformationParam} arg
|
|
491
|
+
* - Arg object
|
|
492
|
+
*
|
|
493
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
440
494
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
441
495
|
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
442
496
|
* @name getLegalInformation
|
|
443
497
|
* @summary: Get legal information
|
|
444
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/).
|
|
445
499
|
*/
|
|
446
|
-
getLegalInformation({
|
|
500
|
+
getLegalInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.ApplicationLegal>;
|
|
447
501
|
/**
|
|
448
502
|
* @param {ContentPlatformApplicationValidator.GetNavigationBySlugParam} arg
|
|
449
503
|
* - Arg object
|
|
450
504
|
*
|
|
505
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
506
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
452
507
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
453
508
|
* @name getNavigationBySlug
|
|
454
509
|
* @summary: Get a navigation by slug
|
|
455
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/).
|
|
456
511
|
*/
|
|
457
|
-
getNavigationBySlug({ slug, devicePlatform }?: ContentPlatformApplicationValidator.GetNavigationBySlugParam, {
|
|
512
|
+
getNavigationBySlug({ slug, devicePlatform, requestHeaders }?: ContentPlatformApplicationValidator.GetNavigationBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
458
513
|
/**
|
|
459
514
|
* @param {ContentPlatformApplicationValidator.GetNavigationsParam} arg - Arg object
|
|
515
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
460
516
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
461
517
|
* @returns {Promise<ContentPlatformModel.NavigationGetResponse>} - Success response
|
|
462
518
|
* @name getNavigations
|
|
463
519
|
* @summary: Get navigations
|
|
464
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/).
|
|
465
521
|
*/
|
|
466
|
-
getNavigations({ devicePlatform, pageNo, pageSize }?: ContentPlatformApplicationValidator.GetNavigationsParam, {
|
|
522
|
+
getNavigations({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetNavigationsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationGetResponse>;
|
|
467
523
|
/**
|
|
468
524
|
* @param {Object} arg - Arg object.
|
|
469
525
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -486,38 +542,44 @@ declare class Content {
|
|
|
486
542
|
}): Paginator<ContentPlatformModel.NavigationGetResponse>;
|
|
487
543
|
/**
|
|
488
544
|
* @param {ContentPlatformApplicationValidator.GetPageBySlugParam} arg - Arg object
|
|
545
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
489
546
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
490
547
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
491
548
|
* @name getPageBySlug
|
|
492
549
|
* @summary: Get page by slug
|
|
493
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/).
|
|
494
551
|
*/
|
|
495
|
-
getPageBySlug({ slug }?: ContentPlatformApplicationValidator.GetPageBySlugParam, {
|
|
552
|
+
getPageBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetPageBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
496
553
|
/**
|
|
554
|
+
* @param {ContentPlatformApplicationValidator.GetPageMetaParam} arg - Arg object
|
|
555
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
497
556
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
498
557
|
* @returns {Promise<ContentPlatformModel.PageMetaSchema>} - Success response
|
|
499
558
|
* @name getPageMeta
|
|
500
559
|
* @summary: Get page meta
|
|
501
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/).
|
|
502
561
|
*/
|
|
503
|
-
getPageMeta({
|
|
562
|
+
getPageMeta({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.PageMetaSchema>;
|
|
504
563
|
/**
|
|
564
|
+
* @param {ContentPlatformApplicationValidator.GetPageSpecParam} arg - Arg object
|
|
565
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
505
566
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
506
567
|
* @returns {Promise<ContentPlatformModel.PageSpec>} - Success response
|
|
507
568
|
* @name getPageSpec
|
|
508
569
|
* @summary: Get page spec
|
|
509
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/).
|
|
510
571
|
*/
|
|
511
|
-
getPageSpec({
|
|
572
|
+
getPageSpec({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSpec>;
|
|
512
573
|
/**
|
|
513
574
|
* @param {ContentPlatformApplicationValidator.GetPagesParam} arg - Arg object
|
|
575
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
514
576
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
515
577
|
* @returns {Promise<ContentPlatformModel.PageGetResponse>} - Success response
|
|
516
578
|
* @name getPages
|
|
517
579
|
* @summary: Get a list of pages
|
|
518
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/).
|
|
519
581
|
*/
|
|
520
|
-
getPages({ pageNo, pageSize }?: ContentPlatformApplicationValidator.GetPagesParam, {
|
|
582
|
+
getPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageGetResponse>;
|
|
521
583
|
/**
|
|
522
584
|
* @param {Object} arg - Arg object.
|
|
523
585
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -539,52 +601,60 @@ declare class Content {
|
|
|
539
601
|
* @param {ContentPlatformApplicationValidator.GetPathRedirectionRuleParam} arg
|
|
540
602
|
* - Arg object
|
|
541
603
|
*
|
|
604
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
542
605
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
543
606
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
544
607
|
* @name getPathRedirectionRule
|
|
545
608
|
* @summary: Get path based redirection rule
|
|
546
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/).
|
|
547
610
|
*/
|
|
548
|
-
getPathRedirectionRule({ pathId }?: ContentPlatformApplicationValidator.GetPathRedirectionRuleParam, {
|
|
611
|
+
getPathRedirectionRule({ pathId, requestHeaders }?: ContentPlatformApplicationValidator.GetPathRedirectionRuleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
549
612
|
/**
|
|
550
613
|
* @param {ContentPlatformApplicationValidator.GetPathRedirectionRulesParam} arg
|
|
551
614
|
* - Arg object
|
|
552
615
|
*
|
|
616
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
553
617
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
554
618
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
555
619
|
* @name getPathRedirectionRules
|
|
556
620
|
* @summary: Get path based redirection rules
|
|
557
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/).
|
|
558
622
|
*/
|
|
559
|
-
getPathRedirectionRules({ pageSize, pageNo }?: ContentPlatformApplicationValidator.GetPathRedirectionRulesParam, {
|
|
623
|
+
getPathRedirectionRules({ pageSize, pageNo, requestHeaders }?: ContentPlatformApplicationValidator.GetPathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
560
624
|
/**
|
|
625
|
+
* @param {ContentPlatformApplicationValidator.GetSEOConfigurationParam} arg
|
|
626
|
+
* - Arg object
|
|
627
|
+
*
|
|
628
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
561
629
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
562
630
|
* @returns {Promise<ContentPlatformModel.SeoComponent>} - Success response
|
|
563
631
|
* @name getSEOConfiguration
|
|
564
632
|
* @summary: Get SEO configuration of an application
|
|
565
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/).
|
|
566
634
|
*/
|
|
567
|
-
getSEOConfiguration({
|
|
635
|
+
getSEOConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoComponent>;
|
|
568
636
|
/**
|
|
569
637
|
* @param {ContentPlatformApplicationValidator.GetSlideshowBySlugParam} arg
|
|
570
638
|
* - Arg object
|
|
571
639
|
*
|
|
640
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
572
641
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
573
642
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
574
643
|
* @name getSlideshowBySlug
|
|
575
644
|
* @summary: Get slideshow by slug
|
|
576
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/).
|
|
577
646
|
*/
|
|
578
|
-
getSlideshowBySlug({ slug, devicePlatform }?: ContentPlatformApplicationValidator.GetSlideshowBySlugParam, {
|
|
647
|
+
getSlideshowBySlug({ slug, devicePlatform, requestHeaders }?: ContentPlatformApplicationValidator.GetSlideshowBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
579
648
|
/**
|
|
580
649
|
* @param {ContentPlatformApplicationValidator.GetSlideshowsParam} arg - Arg object
|
|
650
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
581
651
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
582
652
|
* @returns {Promise<ContentPlatformModel.SlideshowGetResponse>} - Success response
|
|
583
653
|
* @name getSlideshows
|
|
584
654
|
* @summary: Get slideshows
|
|
585
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/).
|
|
586
656
|
*/
|
|
587
|
-
getSlideshows({ devicePlatform, pageNo, pageSize }?: ContentPlatformApplicationValidator.GetSlideshowsParam, {
|
|
657
|
+
getSlideshows({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetSlideshowsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowGetResponse>;
|
|
588
658
|
/**
|
|
589
659
|
* @param {Object} arg - Arg object.
|
|
590
660
|
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
@@ -606,17 +676,22 @@ declare class Content {
|
|
|
606
676
|
pageSize?: number;
|
|
607
677
|
}): Paginator<ContentPlatformModel.SlideshowGetResponse>;
|
|
608
678
|
/**
|
|
679
|
+
* @param {ContentPlatformApplicationValidator.GetSupportInformationParam} arg
|
|
680
|
+
* - Arg object
|
|
681
|
+
*
|
|
682
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
609
683
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
610
684
|
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
611
685
|
* @name getSupportInformation
|
|
612
686
|
* @summary: Get support information
|
|
613
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/).
|
|
614
688
|
*/
|
|
615
|
-
getSupportInformation({
|
|
689
|
+
getSupportInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
|
|
616
690
|
/**
|
|
617
691
|
* @param {ContentPlatformApplicationValidator.RemoveInjectableTagParam} arg
|
|
618
692
|
* - Arg object
|
|
619
693
|
*
|
|
694
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
620
695
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
621
696
|
* @returns {Promise<ContentPlatformModel.TagDeleteSuccessResponse>} -
|
|
622
697
|
* Success response
|
|
@@ -624,9 +699,10 @@ declare class Content {
|
|
|
624
699
|
* @summary: Remove a tag
|
|
625
700
|
* @description: Use this API to delete an existing tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/removeInjectableTag/).
|
|
626
701
|
*/
|
|
627
|
-
removeInjectableTag({ body }?: ContentPlatformApplicationValidator.RemoveInjectableTagParam, {
|
|
702
|
+
removeInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.RemoveInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagDeleteSuccessResponse>;
|
|
628
703
|
/**
|
|
629
704
|
* @param {ContentPlatformApplicationValidator.ResetDataLoaderParam} arg - Arg object
|
|
705
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
630
706
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
631
707
|
* @returns {Promise<ContentPlatformModel.DataLoaderResetResponseSchema>} -
|
|
632
708
|
* Success response
|
|
@@ -634,9 +710,10 @@ declare class Content {
|
|
|
634
710
|
* @summary: Reset a data loader by serive name and operation Id
|
|
635
711
|
* @description: Use this API to reselect a data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/resetDataLoader/).
|
|
636
712
|
*/
|
|
637
|
-
resetDataLoader({ service, operationId }?: ContentPlatformApplicationValidator.ResetDataLoaderParam, {
|
|
713
|
+
resetDataLoader({ service, operationId, requestHeaders }?: ContentPlatformApplicationValidator.ResetDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResetResponseSchema>;
|
|
638
714
|
/**
|
|
639
715
|
* @param {ContentPlatformApplicationValidator.SelectDataLoaderParam} arg - Arg object
|
|
716
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
640
717
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
641
718
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
642
719
|
* Success response
|
|
@@ -644,11 +721,12 @@ declare class Content {
|
|
|
644
721
|
* @summary: Select a data loader by id
|
|
645
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/).
|
|
646
723
|
*/
|
|
647
|
-
selectDataLoader({ dataLoaderId }?: ContentPlatformApplicationValidator.SelectDataLoaderParam, {
|
|
724
|
+
selectDataLoader({ dataLoaderId, requestHeaders }?: ContentPlatformApplicationValidator.SelectDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
648
725
|
/**
|
|
649
726
|
* @param {ContentPlatformApplicationValidator.UpdateAnnouncementParam} arg
|
|
650
727
|
* - Arg object
|
|
651
728
|
*
|
|
729
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
652
730
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
653
731
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
654
732
|
* Success response
|
|
@@ -656,11 +734,12 @@ declare class Content {
|
|
|
656
734
|
* @summary: Update an announcement
|
|
657
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/).
|
|
658
736
|
*/
|
|
659
|
-
updateAnnouncement({ announcementId, body }?: ContentPlatformApplicationValidator.UpdateAnnouncementParam, {
|
|
737
|
+
updateAnnouncement({ announcementId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
660
738
|
/**
|
|
661
739
|
* @param {ContentPlatformApplicationValidator.UpdateAnnouncementScheduleParam} arg
|
|
662
740
|
* - Arg object
|
|
663
741
|
*
|
|
742
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
664
743
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
665
744
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
666
745
|
* Success response
|
|
@@ -668,140 +747,153 @@ declare class Content {
|
|
|
668
747
|
* @summary: Update the schedule and the publish status of an announcement
|
|
669
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/).
|
|
670
749
|
*/
|
|
671
|
-
updateAnnouncementSchedule({ announcementId, body }?: ContentPlatformApplicationValidator.UpdateAnnouncementScheduleParam, {
|
|
750
|
+
updateAnnouncementSchedule({ announcementId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAnnouncementScheduleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
672
751
|
/**
|
|
673
752
|
* @param {ContentPlatformApplicationValidator.UpdateBlogParam} arg - Arg object
|
|
753
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
674
754
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
675
755
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
676
756
|
* @name updateBlog
|
|
677
757
|
* @summary: Update a blog
|
|
678
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/).
|
|
679
759
|
*/
|
|
680
|
-
updateBlog({ id, body }?: ContentPlatformApplicationValidator.UpdateBlogParam, {
|
|
760
|
+
updateBlog({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
681
761
|
/**
|
|
682
762
|
* @param {ContentPlatformApplicationValidator.UpdateFaqParam} arg - Arg object
|
|
763
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
683
764
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
684
765
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
685
766
|
* @name updateFaq
|
|
686
767
|
* @summary: Update an FAQ
|
|
687
768
|
* @description: Use this API to edit an existing FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateFaq/).
|
|
688
769
|
*/
|
|
689
|
-
updateFaq({ categoryId, faqId, body }?: ContentPlatformApplicationValidator.UpdateFaqParam, {
|
|
770
|
+
updateFaq({ categoryId, faqId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
690
771
|
/**
|
|
691
772
|
* @param {ContentPlatformApplicationValidator.UpdateFaqCategoryParam} arg
|
|
692
773
|
* - Arg object
|
|
693
774
|
*
|
|
775
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
694
776
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
695
777
|
* @returns {Promise<ContentPlatformModel.CreateFaqCategorySchema>} - Success response
|
|
696
778
|
* @name updateFaqCategory
|
|
697
779
|
* @summary: Update an FAQ category
|
|
698
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/).
|
|
699
781
|
*/
|
|
700
|
-
updateFaqCategory({ id, body }?: ContentPlatformApplicationValidator.UpdateFaqCategoryParam, {
|
|
782
|
+
updateFaqCategory({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqCategorySchema>;
|
|
701
783
|
/**
|
|
702
784
|
* @param {ContentPlatformApplicationValidator.UpdateInjectableTagParam} arg
|
|
703
785
|
* - Arg object
|
|
704
786
|
*
|
|
787
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
705
788
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
706
789
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
707
790
|
* @name updateInjectableTag
|
|
708
791
|
* @summary: Update a tag
|
|
709
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/).
|
|
710
793
|
*/
|
|
711
|
-
updateInjectableTag({ body }?: ContentPlatformApplicationValidator.UpdateInjectableTagParam, {
|
|
794
|
+
updateInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
712
795
|
/**
|
|
713
796
|
* @param {ContentPlatformApplicationValidator.UpdateLandingPageParam} arg
|
|
714
797
|
* - Arg object
|
|
715
798
|
*
|
|
799
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
716
800
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
717
801
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
718
802
|
* @name updateLandingPage
|
|
719
803
|
* @summary: Update a landing page
|
|
720
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/).
|
|
721
805
|
*/
|
|
722
|
-
updateLandingPage({ id, body }?: ContentPlatformApplicationValidator.UpdateLandingPageParam, {
|
|
806
|
+
updateLandingPage({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
723
807
|
/**
|
|
724
808
|
* @param {ContentPlatformApplicationValidator.UpdateLegalInformationParam} arg
|
|
725
809
|
* - Arg object
|
|
726
810
|
*
|
|
811
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
727
812
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
728
813
|
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
729
814
|
* @name updateLegalInformation
|
|
730
815
|
* @summary: Save legal information
|
|
731
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/).
|
|
732
817
|
*/
|
|
733
|
-
updateLegalInformation({ body }?: ContentPlatformApplicationValidator.UpdateLegalInformationParam, {
|
|
818
|
+
updateLegalInformation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateLegalInformationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.ApplicationLegal>;
|
|
734
819
|
/**
|
|
735
820
|
* @param {ContentPlatformApplicationValidator.UpdateNavigationParam} arg - Arg object
|
|
821
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
736
822
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
737
823
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
738
824
|
* @name updateNavigation
|
|
739
825
|
* @summary: Update a navigation
|
|
740
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/).
|
|
741
827
|
*/
|
|
742
|
-
updateNavigation({ id, body }?: ContentPlatformApplicationValidator.UpdateNavigationParam, {
|
|
828
|
+
updateNavigation({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
743
829
|
/**
|
|
744
830
|
* @param {ContentPlatformApplicationValidator.UpdatePageParam} arg - Arg object
|
|
831
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
745
832
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
746
833
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
747
834
|
* @name updatePage
|
|
748
835
|
* @summary: Update a page
|
|
749
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/).
|
|
750
837
|
*/
|
|
751
|
-
updatePage({ id, body }?: ContentPlatformApplicationValidator.UpdatePageParam, {
|
|
838
|
+
updatePage({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
752
839
|
/**
|
|
753
840
|
* @param {ContentPlatformApplicationValidator.UpdatePagePreviewParam} arg
|
|
754
841
|
* - Arg object
|
|
755
842
|
*
|
|
843
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
756
844
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
757
845
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
758
846
|
* @name updatePagePreview
|
|
759
847
|
* @summary: Change the publish status of a page
|
|
760
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/).
|
|
761
849
|
*/
|
|
762
|
-
updatePagePreview({ slug, body }?: ContentPlatformApplicationValidator.UpdatePagePreviewParam, {
|
|
850
|
+
updatePagePreview({ slug, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePagePreviewParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
763
851
|
/**
|
|
764
852
|
* @param {ContentPlatformApplicationValidator.UpdatePathRedirectionRulesParam} arg
|
|
765
853
|
* - Arg object
|
|
766
854
|
*
|
|
855
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
767
856
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
768
857
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
769
858
|
* @name updatePathRedirectionRules
|
|
770
859
|
* @summary: Update path based redirection rules
|
|
771
860
|
* @description: Use this API to update redirection rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePathRedirectionRules/).
|
|
772
861
|
*/
|
|
773
|
-
updatePathRedirectionRules({ pathId, body }?: ContentPlatformApplicationValidator.UpdatePathRedirectionRulesParam, {
|
|
862
|
+
updatePathRedirectionRules({ pathId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
774
863
|
/**
|
|
775
864
|
* @param {ContentPlatformApplicationValidator.UpdateSEOConfigurationParam} arg
|
|
776
865
|
* - Arg object
|
|
777
866
|
*
|
|
867
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
778
868
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
779
869
|
* @returns {Promise<ContentPlatformModel.SeoSchema>} - Success response
|
|
780
870
|
* @name updateSEOConfiguration
|
|
781
871
|
* @summary: Update SEO of application
|
|
782
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/).
|
|
783
873
|
*/
|
|
784
|
-
updateSEOConfiguration({ body }?: ContentPlatformApplicationValidator.UpdateSEOConfigurationParam, {
|
|
874
|
+
updateSEOConfiguration({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSEOConfigurationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchema>;
|
|
785
875
|
/**
|
|
786
876
|
* @param {ContentPlatformApplicationValidator.UpdateSlideshowParam} arg - Arg object
|
|
877
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
787
878
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
788
879
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
789
880
|
* @name updateSlideshow
|
|
790
881
|
* @summary: Update a slideshow
|
|
791
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/).
|
|
792
883
|
*/
|
|
793
|
-
updateSlideshow({ id, body }?: ContentPlatformApplicationValidator.UpdateSlideshowParam, {
|
|
884
|
+
updateSlideshow({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
794
885
|
/**
|
|
795
886
|
* @param {ContentPlatformApplicationValidator.UpdateSupportInformationParam} arg
|
|
796
887
|
* - Arg object
|
|
797
888
|
*
|
|
889
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
798
890
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
799
891
|
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
800
892
|
* @name updateSupportInformation
|
|
801
893
|
* @summary: Update the support data of an application
|
|
802
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/).
|
|
803
895
|
*/
|
|
804
|
-
updateSupportInformation({ body }?: ContentPlatformApplicationValidator.UpdateSupportInformationParam, {
|
|
896
|
+
updateSupportInformation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSupportInformationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
|
|
805
897
|
}
|
|
806
898
|
import ContentPlatformApplicationValidator = require("./ContentPlatformApplicationValidator");
|
|
807
899
|
import ContentPlatformModel = require("./ContentPlatformModel");
|