@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
- package/sdk/platform/User/UserPlatformModel.js +2 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -10,8 +10,8 @@ declare class Content {
|
|
|
10
10
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
11
11
|
* Success response
|
|
12
12
|
* @name addDataLoader
|
|
13
|
-
* @summary:
|
|
14
|
-
* @description:
|
|
13
|
+
* @summary: Add data loader.
|
|
14
|
+
* @description: Create and add a new data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addDataLoader/).
|
|
15
15
|
*/
|
|
16
16
|
addDataLoader({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
17
17
|
/**
|
|
@@ -20,8 +20,8 @@ declare class Content {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
22
22
|
* @name addFaq
|
|
23
|
-
* @summary:
|
|
24
|
-
* @description:
|
|
23
|
+
* @summary: Add FAQ.
|
|
24
|
+
* @description: Create and add a new FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addFaq/).
|
|
25
25
|
*/
|
|
26
26
|
addFaq({ categoryId, body, requestHeaders }?: ContentPlatformApplicationValidator.AddFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
27
27
|
/**
|
|
@@ -30,8 +30,8 @@ declare class Content {
|
|
|
30
30
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
31
31
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
32
32
|
* @name addInjectableTag
|
|
33
|
-
* @summary:
|
|
34
|
-
* @description:
|
|
33
|
+
* @summary: Create HTML tag.
|
|
34
|
+
* @description: Create and add a new injectable tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addInjectableTag/).
|
|
35
35
|
*/
|
|
36
36
|
addInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
37
37
|
/**
|
|
@@ -42,8 +42,8 @@ declare class Content {
|
|
|
42
42
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
43
43
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
44
44
|
* @name addPathRedirectionRules
|
|
45
|
-
* @summary:
|
|
46
|
-
* @description:
|
|
45
|
+
* @summary: Add path redirection rules.
|
|
46
|
+
* @description: Create and add rules for path redirection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addPathRedirectionRules/).
|
|
47
47
|
*/
|
|
48
48
|
addPathRedirectionRules({ body, requestHeaders }?: ContentPlatformApplicationValidator.AddPathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
49
49
|
/**
|
|
@@ -55,8 +55,8 @@ declare class Content {
|
|
|
55
55
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
56
56
|
* Success response
|
|
57
57
|
* @name createAnnouncement
|
|
58
|
-
* @summary: Create
|
|
59
|
-
* @description:
|
|
58
|
+
* @summary: Create announcement.
|
|
59
|
+
* @description: Generate and add a new announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAnnouncement/).
|
|
60
60
|
*/
|
|
61
61
|
createAnnouncement({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
62
62
|
/**
|
|
@@ -118,8 +118,8 @@ declare class Content {
|
|
|
118
118
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
119
119
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
120
120
|
* @name createBlog
|
|
121
|
-
* @summary: Create
|
|
122
|
-
* @description:
|
|
121
|
+
* @summary: Create blog.
|
|
122
|
+
* @description: Generate and add a new blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createBlog/).
|
|
123
123
|
*/
|
|
124
124
|
createBlog({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
125
125
|
/**
|
|
@@ -130,8 +130,8 @@ declare class Content {
|
|
|
130
130
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
131
131
|
* @returns {Promise<ContentPlatformModel.CreateFaqCategorySchema>} - Success response
|
|
132
132
|
* @name createFaqCategory
|
|
133
|
-
* @summary: Create
|
|
134
|
-
* @description:
|
|
133
|
+
* @summary: Create FAQ category.
|
|
134
|
+
* @description: Generate and add a new FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createFaqCategory/).
|
|
135
135
|
*/
|
|
136
136
|
createFaqCategory({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqCategorySchema>;
|
|
137
137
|
/**
|
|
@@ -142,8 +142,8 @@ declare class Content {
|
|
|
142
142
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
143
143
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
144
144
|
* @name createLandingPage
|
|
145
|
-
* @summary: Create
|
|
146
|
-
* @description:
|
|
145
|
+
* @summary: Create landing page.
|
|
146
|
+
* @description: Generate and add a new landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createLandingPage/).
|
|
147
147
|
*/
|
|
148
148
|
createLandingPage({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
149
149
|
/**
|
|
@@ -152,8 +152,8 @@ declare class Content {
|
|
|
152
152
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
153
153
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
154
154
|
* @name createNavigation
|
|
155
|
-
* @summary: Create
|
|
156
|
-
* @description:
|
|
155
|
+
* @summary: Create navigation items
|
|
156
|
+
* @description: Generate and add a new navigation element. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createNavigation/).
|
|
157
157
|
*/
|
|
158
158
|
createNavigation({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
159
159
|
/**
|
|
@@ -162,8 +162,8 @@ declare class Content {
|
|
|
162
162
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
163
163
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
164
164
|
* @name createPage
|
|
165
|
-
* @summary: Create
|
|
166
|
-
* @description:
|
|
165
|
+
* @summary: Create page.
|
|
166
|
+
* @description: Generate and add a new page to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createPage/).
|
|
167
167
|
*/
|
|
168
168
|
createPage({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
169
169
|
/**
|
|
@@ -174,8 +174,8 @@ declare class Content {
|
|
|
174
174
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
175
175
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
176
176
|
* @name createPagePreview
|
|
177
|
-
* @summary: Create
|
|
178
|
-
* @description:
|
|
177
|
+
* @summary: Create page preview.
|
|
178
|
+
* @description: Generate and add a new page preview. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createPagePreview/).
|
|
179
179
|
*/
|
|
180
180
|
createPagePreview({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreatePagePreviewParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
181
181
|
/**
|
|
@@ -209,8 +209,8 @@ declare class Content {
|
|
|
209
209
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
210
210
|
* Success response
|
|
211
211
|
* @name deleteAnnouncement
|
|
212
|
-
* @summary: Delete announcement
|
|
213
|
-
* @description:
|
|
212
|
+
* @summary: Delete announcement.
|
|
213
|
+
* @description: Remove a specific announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAnnouncement/).
|
|
214
214
|
*/
|
|
215
215
|
deleteAnnouncement({ announcementId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
216
216
|
/**
|
|
@@ -257,8 +257,8 @@ declare class Content {
|
|
|
257
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
258
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
259
259
|
* @name deleteBlog
|
|
260
|
-
* @summary: Delete
|
|
261
|
-
* @description:
|
|
260
|
+
* @summary: Delete blog.
|
|
261
|
+
* @description: Remove a specific blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteBlog/).
|
|
262
262
|
*/
|
|
263
263
|
deleteBlog({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
264
264
|
/**
|
|
@@ -268,8 +268,8 @@ declare class Content {
|
|
|
268
268
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
269
269
|
* Success response
|
|
270
270
|
* @name deleteDataLoader
|
|
271
|
-
* @summary: Delete data loader
|
|
272
|
-
* @description:
|
|
271
|
+
* @summary: Delete data loader.
|
|
272
|
+
* @description: Remove a specific data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteDataLoader/).
|
|
273
273
|
*/
|
|
274
274
|
deleteDataLoader({ dataLoaderId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
275
275
|
/**
|
|
@@ -278,8 +278,8 @@ declare class Content {
|
|
|
278
278
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
279
279
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
280
280
|
* @name deleteFaq
|
|
281
|
-
* @summary: Delete
|
|
282
|
-
* @description:
|
|
281
|
+
* @summary: Delete FAQ.
|
|
282
|
+
* @description: Remove a specific FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteFaq/).
|
|
283
283
|
*/
|
|
284
284
|
deleteFaq({ categoryId, faqId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
285
285
|
/**
|
|
@@ -290,8 +290,8 @@ declare class Content {
|
|
|
290
290
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
291
291
|
* @returns {Promise<ContentPlatformModel.FaqSchema>} - Success response
|
|
292
292
|
* @name deleteFaqCategory
|
|
293
|
-
* @summary: Delete
|
|
294
|
-
* @description:
|
|
293
|
+
* @summary: Delete FAQ category.
|
|
294
|
+
* @description: Remove a specific FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteFaqCategory/).
|
|
295
295
|
*/
|
|
296
296
|
deleteFaqCategory({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.FaqSchema>;
|
|
297
297
|
/**
|
|
@@ -302,8 +302,8 @@ declare class Content {
|
|
|
302
302
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
303
303
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
304
304
|
* @name deleteLandingPage
|
|
305
|
-
* @summary: Delete
|
|
306
|
-
* @description:
|
|
305
|
+
* @summary: Delete landing page.
|
|
306
|
+
* @description: Remove a specific landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteLandingPage/).
|
|
307
307
|
*/
|
|
308
308
|
deleteLandingPage({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
309
309
|
/**
|
|
@@ -312,8 +312,8 @@ declare class Content {
|
|
|
312
312
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
313
313
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
314
314
|
* @name deleteNavigation
|
|
315
|
-
* @summary: Delete
|
|
316
|
-
* @description:
|
|
315
|
+
* @summary: Delete navigation.
|
|
316
|
+
* @description: Remove a specific navigation element. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteNavigation/).
|
|
317
317
|
*/
|
|
318
318
|
deleteNavigation({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
319
319
|
/**
|
|
@@ -322,8 +322,8 @@ declare class Content {
|
|
|
322
322
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
323
323
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
324
324
|
* @name deletePage
|
|
325
|
-
* @summary: Delete
|
|
326
|
-
* @description:
|
|
325
|
+
* @summary: Delete page.
|
|
326
|
+
* @description: Remove a page from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deletePage/).
|
|
327
327
|
*/
|
|
328
328
|
deletePage({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeletePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
329
329
|
/**
|
|
@@ -334,8 +334,8 @@ declare class Content {
|
|
|
334
334
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
335
335
|
* @returns {Promise<Object>} - Success response
|
|
336
336
|
* @name deletePathRedirectionRules
|
|
337
|
-
* @summary: Delete path
|
|
338
|
-
* @description:
|
|
337
|
+
* @summary: Delete path redirection rules.
|
|
338
|
+
* @description: Remove specific path redirection rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deletePathRedirectionRules/).
|
|
339
339
|
*/
|
|
340
340
|
deletePathRedirectionRules({ pathId, requestHeaders }?: ContentPlatformApplicationValidator.DeletePathRedirectionRulesParam, { responseHeaders }?: object): Promise<any>;
|
|
341
341
|
/**
|
|
@@ -367,8 +367,8 @@ declare class Content {
|
|
|
367
367
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
368
368
|
* Success response
|
|
369
369
|
* @name editDataLoader
|
|
370
|
-
* @summary: Edit
|
|
371
|
-
* @description:
|
|
370
|
+
* @summary: Edit data loader.
|
|
371
|
+
* @description: Modify the settings of a specific data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/editDataLoader/).
|
|
372
372
|
*/
|
|
373
373
|
editDataLoader({ dataLoaderId, body, requestHeaders }?: ContentPlatformApplicationValidator.EditDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
374
374
|
/**
|
|
@@ -379,8 +379,8 @@ declare class Content {
|
|
|
379
379
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
380
380
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
381
381
|
* @name editInjectableTag
|
|
382
|
-
* @summary:
|
|
383
|
-
* @description:
|
|
382
|
+
* @summary: Update HTML tag
|
|
383
|
+
* @description: Modify settings for an injectable tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/editInjectableTag/).
|
|
384
384
|
*/
|
|
385
385
|
editInjectableTag({ tagId, body, requestHeaders }?: ContentPlatformApplicationValidator.EditInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
386
386
|
/**
|
|
@@ -415,8 +415,8 @@ declare class Content {
|
|
|
415
415
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
416
416
|
* @returns {Promise<ContentPlatformModel.GeneratedSEOContent>} - Success response
|
|
417
417
|
* @name generateSEOTitle
|
|
418
|
-
* @summary:
|
|
419
|
-
* @description:
|
|
418
|
+
* @summary: Generate SEO title.
|
|
419
|
+
* @description: Create an SEO-friendly title for content. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/generateSEOTitle/).
|
|
420
420
|
*/
|
|
421
421
|
generateSEOTitle({ type, body, requestHeaders }?: ContentPlatformApplicationValidator.GenerateSEOTitleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GeneratedSEOContent>;
|
|
422
422
|
/**
|
|
@@ -427,8 +427,8 @@ declare class Content {
|
|
|
427
427
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
428
428
|
* @returns {Promise<ContentPlatformModel.AdminAnnouncementSchema>} - Success response
|
|
429
429
|
* @name getAnnouncementById
|
|
430
|
-
* @summary: Get announcement by ID
|
|
431
|
-
* @description:
|
|
430
|
+
* @summary: Get announcement by ID.
|
|
431
|
+
* @description: Retrieve detailed information about a specific announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAnnouncementById/).
|
|
432
432
|
*/
|
|
433
433
|
getAnnouncementById({ announcementId, requestHeaders }?: ContentPlatformApplicationValidator.GetAnnouncementByIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.AdminAnnouncementSchema>;
|
|
434
434
|
/**
|
|
@@ -440,27 +440,10 @@ declare class Content {
|
|
|
440
440
|
* @returns {Promise<ContentPlatformModel.GetAnnouncementListSchema>} -
|
|
441
441
|
* Success response
|
|
442
442
|
* @name getAnnouncementsList
|
|
443
|
-
* @summary: Get
|
|
444
|
-
* @description:
|
|
443
|
+
* @summary: Get announcements list.
|
|
444
|
+
* @description: Retrieve a list of announcements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAnnouncementsList/).
|
|
445
445
|
*/
|
|
446
446
|
getAnnouncementsList({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetAnnouncementsListParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetAnnouncementListSchema>;
|
|
447
|
-
/**
|
|
448
|
-
* @param {Object} arg - Arg object.
|
|
449
|
-
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
450
|
-
* on Fynd Platform
|
|
451
|
-
* @param {string} arg.applicationId - Numeric ID allotted to an application
|
|
452
|
-
* created within a business account.
|
|
453
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
454
|
-
* page. Default value is 10.
|
|
455
|
-
* @returns {Paginator<ContentPlatformModel.GetAnnouncementListSchema>}
|
|
456
|
-
* @summary: Get a list of announcements
|
|
457
|
-
* @description: Announcements are useful to highlight a message or information on top of a webpage. Use this API to retrieve a list of announcements.
|
|
458
|
-
*/
|
|
459
|
-
getAnnouncementsListPaginator({ companyId, applicationId, pageSize }?: {
|
|
460
|
-
companyId: string;
|
|
461
|
-
applicationId: string;
|
|
462
|
-
pageSize?: number;
|
|
463
|
-
}): Paginator<ContentPlatformModel.GetAnnouncementListSchema>;
|
|
464
447
|
/**
|
|
465
448
|
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionParam} arg
|
|
466
449
|
* - Arg object
|
|
@@ -487,7 +470,7 @@ declare class Content {
|
|
|
487
470
|
* @summary: Get custom fields definitions
|
|
488
471
|
* @description: Use this API to retrieve the definitions of custom fields. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinitions/).
|
|
489
472
|
*/
|
|
490
|
-
getAppCustomFieldDefinitions({ pageNo, pageSize,
|
|
473
|
+
getAppCustomFieldDefinitions({ pageNo, pageSize, resources, types, search, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionsSchema>;
|
|
491
474
|
/**
|
|
492
475
|
* @param {ContentPlatformApplicationValidator.GetAppCustomFieldTypesParam} arg
|
|
493
476
|
* - Arg object
|
|
@@ -509,7 +492,7 @@ declare class Content {
|
|
|
509
492
|
* @returns {Promise<ContentPlatformModel.CustomFieldsResponseSchema>} -
|
|
510
493
|
* Success response
|
|
511
494
|
* @name getAppCustomFields
|
|
512
|
-
* @summary: Get list of custom fields of
|
|
495
|
+
* @summary: Get list of custom fields of gives resource
|
|
513
496
|
* @description: Use this API to retrieve the custom fields for given resource in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFields/).
|
|
514
497
|
*/
|
|
515
498
|
getAppCustomFields({ resource, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseSchema>;
|
|
@@ -603,8 +586,8 @@ declare class Content {
|
|
|
603
586
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
604
587
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
605
588
|
* @name getBlogBySlug
|
|
606
|
-
* @summary: Get blog by slug
|
|
607
|
-
* @description:
|
|
589
|
+
* @summary: Get blog by slug.
|
|
590
|
+
* @description: Retrieve detailed information about a specific blog using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogBySlug/).
|
|
608
591
|
*/
|
|
609
592
|
getBlogBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
610
593
|
/**
|
|
@@ -613,35 +596,18 @@ declare class Content {
|
|
|
613
596
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
614
597
|
* @returns {Promise<ContentPlatformModel.BlogGetResponse>} - Success response
|
|
615
598
|
* @name getBlogs
|
|
616
|
-
* @summary: Get blogs
|
|
617
|
-
* @description:
|
|
599
|
+
* @summary: Get blogs.
|
|
600
|
+
* @description: Retrieve a list of available blogs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
|
|
618
601
|
*/
|
|
619
602
|
getBlogs({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetResponse>;
|
|
620
|
-
/**
|
|
621
|
-
* @param {Object} arg - Arg object.
|
|
622
|
-
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
623
|
-
* on Fynd Platform
|
|
624
|
-
* @param {string} arg.applicationId - Numeric ID allotted to an application
|
|
625
|
-
* created within a business account.
|
|
626
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
627
|
-
* page. Default value is 10.
|
|
628
|
-
* @returns {Paginator<ContentPlatformModel.BlogGetResponse>}
|
|
629
|
-
* @summary: Get blogs
|
|
630
|
-
* @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.
|
|
631
|
-
*/
|
|
632
|
-
getBlogsPaginator({ companyId, applicationId, pageSize }?: {
|
|
633
|
-
companyId: string;
|
|
634
|
-
applicationId: string;
|
|
635
|
-
pageSize?: number;
|
|
636
|
-
}): Paginator<ContentPlatformModel.BlogGetResponse>;
|
|
637
603
|
/**
|
|
638
604
|
* @param {ContentPlatformApplicationValidator.GetComponentByIdParam} arg - Arg object
|
|
639
605
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
640
606
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
641
607
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
642
608
|
* @name getComponentById
|
|
643
|
-
* @summary: Get
|
|
644
|
-
* @description:
|
|
609
|
+
* @summary: Get component by ID.
|
|
610
|
+
* @description: Retrieve detailed information about a specific component. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getComponentById/).
|
|
645
611
|
*/
|
|
646
612
|
getComponentById({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetComponentByIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
647
613
|
/**
|
|
@@ -650,8 +616,8 @@ declare class Content {
|
|
|
650
616
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
651
617
|
* @returns {Promise<ContentPlatformModel.DataLoadersSchema>} - Success response
|
|
652
618
|
* @name getDataLoaders
|
|
653
|
-
* @summary: Get
|
|
654
|
-
* @description:
|
|
619
|
+
* @summary: Get data loaders.
|
|
620
|
+
* @description: Retrieve a list of data loaders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDataLoaders/).
|
|
655
621
|
*/
|
|
656
622
|
getDataLoaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoadersSchema>;
|
|
657
623
|
/**
|
|
@@ -676,8 +642,8 @@ declare class Content {
|
|
|
676
642
|
* @returns {Promise<ContentPlatformModel.DefaultNavigationResponse>} -
|
|
677
643
|
* Success response
|
|
678
644
|
* @name getDefaultNavigations
|
|
679
|
-
* @summary: Get default navigations
|
|
680
|
-
* @description:
|
|
645
|
+
* @summary: Get default navigations.
|
|
646
|
+
* @description: Retrieve default navigation elements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultNavigations/).
|
|
681
647
|
*/
|
|
682
648
|
getDefaultNavigations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultNavigationResponse>;
|
|
683
649
|
/**
|
|
@@ -698,8 +664,8 @@ declare class Content {
|
|
|
698
664
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
699
665
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
700
666
|
* @name getFaqByIdOrSlug
|
|
701
|
-
* @summary: Get
|
|
702
|
-
* @description:
|
|
667
|
+
* @summary: Get FAQ by ID or slug.
|
|
668
|
+
* @description: Retrieve detailed information about a specific FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqByIdOrSlug/).
|
|
703
669
|
*/
|
|
704
670
|
getFaqByIdOrSlug({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
705
671
|
/**
|
|
@@ -708,8 +674,8 @@ declare class Content {
|
|
|
708
674
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
709
675
|
* @returns {Promise<ContentPlatformModel.GetFaqCategoriesSchema>} - Success response
|
|
710
676
|
* @name getFaqCategories
|
|
711
|
-
* @summary: Get
|
|
712
|
-
* @description:
|
|
677
|
+
* @summary: Get FAQ categories.
|
|
678
|
+
* @description: Retrieve a list of FAQ categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategories/).
|
|
713
679
|
*/
|
|
714
680
|
getFaqCategories({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqCategoriesSchema>;
|
|
715
681
|
/**
|
|
@@ -721,8 +687,8 @@ declare class Content {
|
|
|
721
687
|
* @returns {Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>} -
|
|
722
688
|
* Success response
|
|
723
689
|
* @name getFaqCategoryBySlugOrId
|
|
724
|
-
* @summary: Get
|
|
725
|
-
* @description:
|
|
690
|
+
* @summary: Get FAQ category by slug or ID.
|
|
691
|
+
* @description: Retrieve detailed information about a specific FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategoryBySlugOrId/).
|
|
726
692
|
*/
|
|
727
693
|
getFaqCategoryBySlugOrId({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqCategoryBySlugOrIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>;
|
|
728
694
|
/**
|
|
@@ -733,8 +699,8 @@ declare class Content {
|
|
|
733
699
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
734
700
|
* @returns {Promise<ContentPlatformModel.GetFaqSchema>} - Success response
|
|
735
701
|
* @name getFaqsByCategoryIdOrSlug
|
|
736
|
-
* @summary: Get
|
|
737
|
-
* @description:
|
|
702
|
+
* @summary: Get FAQs by category ID or slug.
|
|
703
|
+
* @description: Retrieve a list of FAQs within a specific category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqsByCategoryIdOrSlug/).
|
|
738
704
|
*/
|
|
739
705
|
getFaqsByCategoryIdOrSlug({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqsByCategoryIdOrSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqSchema>;
|
|
740
706
|
/**
|
|
@@ -745,8 +711,8 @@ declare class Content {
|
|
|
745
711
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
746
712
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
747
713
|
* @name getInjectableTags
|
|
748
|
-
* @summary: Get all
|
|
749
|
-
* @description:
|
|
714
|
+
* @summary: Get all HTML tags
|
|
715
|
+
* @description: Retrieve a list of injectable tags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getInjectableTags/).
|
|
750
716
|
*/
|
|
751
717
|
getInjectableTags({ all, requestHeaders }?: ContentPlatformApplicationValidator.GetInjectableTagsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
752
718
|
/**
|
|
@@ -755,27 +721,10 @@ declare class Content {
|
|
|
755
721
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
756
722
|
* @returns {Promise<ContentPlatformModel.LandingPageGetResponse>} - Success response
|
|
757
723
|
* @name getLandingPages
|
|
758
|
-
* @summary: Get landing pages
|
|
759
|
-
* @description:
|
|
724
|
+
* @summary: Get landing pages.
|
|
725
|
+
* @description: Retrieve a list of landing pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLandingPages/).
|
|
760
726
|
*/
|
|
761
727
|
getLandingPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetLandingPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageGetResponse>;
|
|
762
|
-
/**
|
|
763
|
-
* @param {Object} arg - Arg object.
|
|
764
|
-
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
765
|
-
* on Fynd Platform
|
|
766
|
-
* @param {string} arg.applicationId - Numeric ID allotted to an application
|
|
767
|
-
* created within a business account.
|
|
768
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
769
|
-
* page. Default value is 10.
|
|
770
|
-
* @returns {Paginator<ContentPlatformModel.LandingPageGetResponse>}
|
|
771
|
-
* @summary: Get landing pages
|
|
772
|
-
* @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.
|
|
773
|
-
*/
|
|
774
|
-
getLandingPagesPaginator({ companyId, applicationId, pageSize }?: {
|
|
775
|
-
companyId: string;
|
|
776
|
-
applicationId: string;
|
|
777
|
-
pageSize?: number;
|
|
778
|
-
}): Paginator<ContentPlatformModel.LandingPageGetResponse>;
|
|
779
728
|
/**
|
|
780
729
|
* @param {ContentPlatformApplicationValidator.GetLegalInformationParam} arg
|
|
781
730
|
* - Arg object
|
|
@@ -784,8 +733,8 @@ declare class Content {
|
|
|
784
733
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
785
734
|
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
786
735
|
* @name getLegalInformation
|
|
787
|
-
* @summary: Get legal information
|
|
788
|
-
* @description:
|
|
736
|
+
* @summary: Get legal related information for applicaiton
|
|
737
|
+
* @description: Retrieve legal information and terms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLegalInformation/).
|
|
789
738
|
*/
|
|
790
739
|
getLegalInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.ApplicationLegal>;
|
|
791
740
|
/**
|
|
@@ -796,8 +745,8 @@ declare class Content {
|
|
|
796
745
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
797
746
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
798
747
|
* @name getNavigationBySlug
|
|
799
|
-
* @summary: Get
|
|
800
|
-
* @description:
|
|
748
|
+
* @summary: Get navigation by slug.
|
|
749
|
+
* @description: Retrieve detailed information about a specific navigation element. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getNavigationBySlug/).
|
|
801
750
|
*/
|
|
802
751
|
getNavigationBySlug({ slug, devicePlatform, requestHeaders }?: ContentPlatformApplicationValidator.GetNavigationBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
803
752
|
/**
|
|
@@ -806,38 +755,18 @@ declare class Content {
|
|
|
806
755
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
807
756
|
* @returns {Promise<ContentPlatformModel.NavigationGetResponse>} - Success response
|
|
808
757
|
* @name getNavigations
|
|
809
|
-
* @summary: Get
|
|
810
|
-
* @description:
|
|
758
|
+
* @summary: Get navigation items
|
|
759
|
+
* @description: Retrieve a list of navigational elements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getNavigations/).
|
|
811
760
|
*/
|
|
812
761
|
getNavigations({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetNavigationsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationGetResponse>;
|
|
813
|
-
/**
|
|
814
|
-
* @param {Object} arg - Arg object.
|
|
815
|
-
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
816
|
-
* on Fynd Platform
|
|
817
|
-
* @param {string} arg.applicationId - Numeric ID allotted to an application
|
|
818
|
-
* created within a business account.
|
|
819
|
-
* @param {string} arg.devicePlatform - Filter navigations by platform.
|
|
820
|
-
* Acceptable values are: web, android, ios, all
|
|
821
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
822
|
-
* page. Default value is 10.
|
|
823
|
-
* @returns {Paginator<ContentPlatformModel.NavigationGetResponse>}
|
|
824
|
-
* @summary: Get navigations
|
|
825
|
-
* @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.
|
|
826
|
-
*/
|
|
827
|
-
getNavigationsPaginator({ companyId, applicationId, devicePlatform, pageSize, }?: {
|
|
828
|
-
companyId: string;
|
|
829
|
-
applicationId: string;
|
|
830
|
-
devicePlatform: string;
|
|
831
|
-
pageSize?: number;
|
|
832
|
-
}): Paginator<ContentPlatformModel.NavigationGetResponse>;
|
|
833
762
|
/**
|
|
834
763
|
* @param {ContentPlatformApplicationValidator.GetPageBySlugParam} arg - Arg object
|
|
835
764
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
836
765
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
837
766
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
838
767
|
* @name getPageBySlug
|
|
839
|
-
* @summary: Get page by slug
|
|
840
|
-
* @description:
|
|
768
|
+
* @summary: Get page by slug.
|
|
769
|
+
* @description: Retrieve detailed information about a specific page using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageBySlug/).
|
|
841
770
|
*/
|
|
842
771
|
getPageBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetPageBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
843
772
|
/**
|
|
@@ -846,8 +775,8 @@ declare class Content {
|
|
|
846
775
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
847
776
|
* @returns {Promise<ContentPlatformModel.PageMetaSchema>} - Success response
|
|
848
777
|
* @name getPageMeta
|
|
849
|
-
* @summary: Get page meta
|
|
850
|
-
* @description:
|
|
778
|
+
* @summary: Get page meta.
|
|
779
|
+
* @description: Retrieve metadata for a specific page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageMeta/).
|
|
851
780
|
*/
|
|
852
781
|
getPageMeta({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.PageMetaSchema>;
|
|
853
782
|
/**
|
|
@@ -856,8 +785,8 @@ declare class Content {
|
|
|
856
785
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
857
786
|
* @returns {Promise<ContentPlatformModel.PageSpec>} - Success response
|
|
858
787
|
* @name getPageSpec
|
|
859
|
-
* @summary: Get page
|
|
860
|
-
* @description:
|
|
788
|
+
* @summary: Get page specification.
|
|
789
|
+
* @description: Retrieve specifications and details for a specific page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageSpec/).
|
|
861
790
|
*/
|
|
862
791
|
getPageSpec({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSpec>;
|
|
863
792
|
/**
|
|
@@ -866,27 +795,10 @@ declare class Content {
|
|
|
866
795
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
867
796
|
* @returns {Promise<ContentPlatformModel.PageGetResponse>} - Success response
|
|
868
797
|
* @name getPages
|
|
869
|
-
* @summary: Get
|
|
870
|
-
* @description:
|
|
798
|
+
* @summary: Get pages.
|
|
799
|
+
* @description: Retrieve a list of available pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPages/).
|
|
871
800
|
*/
|
|
872
801
|
getPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageGetResponse>;
|
|
873
|
-
/**
|
|
874
|
-
* @param {Object} arg - Arg object.
|
|
875
|
-
* @param {string} arg.companyId - Numeric ID allotted to a business account
|
|
876
|
-
* on Fynd Platform
|
|
877
|
-
* @param {string} arg.applicationId - Numeric ID allotted to an application
|
|
878
|
-
* created within a business account.
|
|
879
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
880
|
-
* page. Default value is 10.
|
|
881
|
-
* @returns {Paginator<ContentPlatformModel.PageGetResponse>}
|
|
882
|
-
* @summary: Get a list of pages
|
|
883
|
-
* @description: Use this API to retrieve a list of pages.
|
|
884
|
-
*/
|
|
885
|
-
getPagesPaginator({ companyId, applicationId, pageSize }?: {
|
|
886
|
-
companyId: string;
|
|
887
|
-
applicationId: string;
|
|
888
|
-
pageSize?: number;
|
|
889
|
-
}): Paginator<ContentPlatformModel.PageGetResponse>;
|
|
890
802
|
/**
|
|
891
803
|
* @param {ContentPlatformApplicationValidator.GetPathRedirectionRuleParam} arg
|
|
892
804
|
* - Arg object
|
|
@@ -895,8 +807,8 @@ declare class Content {
|
|
|
895
807
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
896
808
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
897
809
|
* @name getPathRedirectionRule
|
|
898
|
-
* @summary: Get path
|
|
899
|
-
* @description:
|
|
810
|
+
* @summary: Get path redirection rule.
|
|
811
|
+
* @description: Retrieve detailed information about a specific path redirection rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRule/).
|
|
900
812
|
*/
|
|
901
813
|
getPathRedirectionRule({ pathId, requestHeaders }?: ContentPlatformApplicationValidator.GetPathRedirectionRuleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
902
814
|
/**
|
|
@@ -907,8 +819,8 @@ declare class Content {
|
|
|
907
819
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
908
820
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
909
821
|
* @name getPathRedirectionRules
|
|
910
|
-
* @summary: Get path
|
|
911
|
-
* @description:
|
|
822
|
+
* @summary: Get path redirection rules.
|
|
823
|
+
* @description: Retrieve a list of path redirection rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRules/).
|
|
912
824
|
*/
|
|
913
825
|
getPathRedirectionRules({ pageSize, pageNo, requestHeaders }?: ContentPlatformApplicationValidator.GetPathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
914
826
|
/**
|
|
@@ -919,8 +831,8 @@ declare class Content {
|
|
|
919
831
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
920
832
|
* @returns {Promise<ContentPlatformModel.SeoComponent>} - Success response
|
|
921
833
|
* @name getSEOConfiguration
|
|
922
|
-
* @summary: Get SEO configuration
|
|
923
|
-
* @description:
|
|
834
|
+
* @summary: Get SEO configuration for an application
|
|
835
|
+
* @description: Retrieve configuration settings for SEO. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOConfiguration/).
|
|
924
836
|
*/
|
|
925
837
|
getSEOConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoComponent>;
|
|
926
838
|
/**
|
|
@@ -997,8 +909,8 @@ declare class Content {
|
|
|
997
909
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
998
910
|
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
999
911
|
* @name getSupportInformation
|
|
1000
|
-
* @summary: Get support information
|
|
1001
|
-
* @description:
|
|
912
|
+
* @summary: Get support information.
|
|
913
|
+
* @description: Retrieve information related to customer support. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSupportInformation/).
|
|
1002
914
|
*/
|
|
1003
915
|
getSupportInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
|
|
1004
916
|
/**
|
|
@@ -1024,8 +936,8 @@ declare class Content {
|
|
|
1024
936
|
* @returns {Promise<ContentPlatformModel.TagDeleteSuccessResponse>} -
|
|
1025
937
|
* Success response
|
|
1026
938
|
* @name removeInjectableTag
|
|
1027
|
-
* @summary: Remove
|
|
1028
|
-
* @description:
|
|
939
|
+
* @summary: Remove HTML tag.
|
|
940
|
+
* @description: Delete a specific injectable tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/removeInjectableTag/).
|
|
1029
941
|
*/
|
|
1030
942
|
removeInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.RemoveInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagDeleteSuccessResponse>;
|
|
1031
943
|
/**
|
|
@@ -1035,8 +947,8 @@ declare class Content {
|
|
|
1035
947
|
* @returns {Promise<ContentPlatformModel.DataLoaderResetResponseSchema>} -
|
|
1036
948
|
* Success response
|
|
1037
949
|
* @name resetDataLoader
|
|
1038
|
-
* @summary: Reset
|
|
1039
|
-
* @description:
|
|
950
|
+
* @summary: Reset data loader.
|
|
951
|
+
* @description: Clear and reset data loader settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/resetDataLoader/).
|
|
1040
952
|
*/
|
|
1041
953
|
resetDataLoader({ service, operationId, requestHeaders }?: ContentPlatformApplicationValidator.ResetDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResetResponseSchema>;
|
|
1042
954
|
/**
|
|
@@ -1058,8 +970,8 @@ declare class Content {
|
|
|
1058
970
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
1059
971
|
* Success response
|
|
1060
972
|
* @name selectDataLoader
|
|
1061
|
-
* @summary: Select
|
|
1062
|
-
* @description:
|
|
973
|
+
* @summary: Select data loader.
|
|
974
|
+
* @description: Choose and set a data loader for use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/selectDataLoader/).
|
|
1063
975
|
*/
|
|
1064
976
|
selectDataLoader({ dataLoaderId, requestHeaders }?: ContentPlatformApplicationValidator.SelectDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
1065
977
|
/**
|
|
@@ -1071,8 +983,8 @@ declare class Content {
|
|
|
1071
983
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
1072
984
|
* Success response
|
|
1073
985
|
* @name updateAnnouncement
|
|
1074
|
-
* @summary: Update
|
|
1075
|
-
* @description:
|
|
986
|
+
* @summary: Update announcement.
|
|
987
|
+
* @description: Modify the content and settings of a specific announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAnnouncement/).
|
|
1076
988
|
*/
|
|
1077
989
|
updateAnnouncement({ announcementId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAnnouncementParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
1078
990
|
/**
|
|
@@ -1084,8 +996,8 @@ declare class Content {
|
|
|
1084
996
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
1085
997
|
* Success response
|
|
1086
998
|
* @name updateAnnouncementSchedule
|
|
1087
|
-
* @summary: Update
|
|
1088
|
-
* @description:
|
|
999
|
+
* @summary: Update announcement schedule.
|
|
1000
|
+
* @description: Modify the scheduling of a specific announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAnnouncementSchedule/).
|
|
1089
1001
|
*/
|
|
1090
1002
|
updateAnnouncementSchedule({ announcementId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAnnouncementScheduleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateAnnouncementSchema>;
|
|
1091
1003
|
/**
|
|
@@ -1133,8 +1045,8 @@ declare class Content {
|
|
|
1133
1045
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1134
1046
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
1135
1047
|
* @name updateBlog
|
|
1136
|
-
* @summary: Update
|
|
1137
|
-
* @description:
|
|
1048
|
+
* @summary: Update blog.
|
|
1049
|
+
* @description: Modify the content and settings of a specific blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateBlog/).
|
|
1138
1050
|
*/
|
|
1139
1051
|
updateBlog({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
1140
1052
|
/**
|
|
@@ -1143,8 +1055,8 @@ declare class Content {
|
|
|
1143
1055
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1144
1056
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
1145
1057
|
* @name updateFaq
|
|
1146
|
-
* @summary: Update
|
|
1147
|
-
* @description:
|
|
1058
|
+
* @summary: Update FAQ.
|
|
1059
|
+
* @description: Modify the content and settings of a specific FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateFaq/).
|
|
1148
1060
|
*/
|
|
1149
1061
|
updateFaq({ categoryId, faqId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateFaqParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
1150
1062
|
/**
|
|
@@ -1155,8 +1067,8 @@ declare class Content {
|
|
|
1155
1067
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1156
1068
|
* @returns {Promise<ContentPlatformModel.CreateFaqCategorySchema>} - Success response
|
|
1157
1069
|
* @name updateFaqCategory
|
|
1158
|
-
* @summary: Update
|
|
1159
|
-
* @description:
|
|
1070
|
+
* @summary: Update FAQ category.
|
|
1071
|
+
* @description: Modify the content and settings of a specific FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateFaqCategory/).
|
|
1160
1072
|
*/
|
|
1161
1073
|
updateFaqCategory({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateFaqCategoryParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqCategorySchema>;
|
|
1162
1074
|
/**
|
|
@@ -1167,8 +1079,8 @@ declare class Content {
|
|
|
1167
1079
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1168
1080
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
1169
1081
|
* @name updateInjectableTag
|
|
1170
|
-
* @summary: Update
|
|
1171
|
-
* @description:
|
|
1082
|
+
* @summary: Update HTML tag
|
|
1083
|
+
* @description: Modify settings for an injectable tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateInjectableTag/).
|
|
1172
1084
|
*/
|
|
1173
1085
|
updateInjectableTag({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateInjectableTagParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
|
|
1174
1086
|
/**
|
|
@@ -1179,8 +1091,8 @@ declare class Content {
|
|
|
1179
1091
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1180
1092
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
1181
1093
|
* @name updateLandingPage
|
|
1182
|
-
* @summary: Update
|
|
1183
|
-
* @description:
|
|
1094
|
+
* @summary: Update landing page.
|
|
1095
|
+
* @description: Modify the content and settings of a specific landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateLandingPage/).
|
|
1184
1096
|
*/
|
|
1185
1097
|
updateLandingPage({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateLandingPageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageSchema>;
|
|
1186
1098
|
/**
|
|
@@ -1191,8 +1103,8 @@ declare class Content {
|
|
|
1191
1103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1192
1104
|
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
1193
1105
|
* @name updateLegalInformation
|
|
1194
|
-
* @summary:
|
|
1195
|
-
* @description:
|
|
1106
|
+
* @summary: Update legal related information for application
|
|
1107
|
+
* @description: Modify legal information and terms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateLegalInformation/).
|
|
1196
1108
|
*/
|
|
1197
1109
|
updateLegalInformation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateLegalInformationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.ApplicationLegal>;
|
|
1198
1110
|
/**
|
|
@@ -1201,8 +1113,8 @@ declare class Content {
|
|
|
1201
1113
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1202
1114
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
1203
1115
|
* @name updateNavigation
|
|
1204
|
-
* @summary: Update
|
|
1205
|
-
* @description:
|
|
1116
|
+
* @summary: Update navigation.
|
|
1117
|
+
* @description: Modify the content and settings of a specific navigation element. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateNavigation/).
|
|
1206
1118
|
*/
|
|
1207
1119
|
updateNavigation({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateNavigationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.NavigationSchema>;
|
|
1208
1120
|
/**
|
|
@@ -1211,8 +1123,8 @@ declare class Content {
|
|
|
1211
1123
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1212
1124
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
1213
1125
|
* @name updatePage
|
|
1214
|
-
* @summary: Update
|
|
1215
|
-
* @description:
|
|
1126
|
+
* @summary: Update page.
|
|
1127
|
+
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePage/).
|
|
1216
1128
|
*/
|
|
1217
1129
|
updatePage({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
1218
1130
|
/**
|
|
@@ -1223,8 +1135,8 @@ declare class Content {
|
|
|
1223
1135
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1224
1136
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
1225
1137
|
* @name updatePagePreview
|
|
1226
|
-
* @summary:
|
|
1227
|
-
* @description:
|
|
1138
|
+
* @summary: Update page preview.
|
|
1139
|
+
* @description: Modify the content and settings of a specific page preview. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePagePreview/).
|
|
1228
1140
|
*/
|
|
1229
1141
|
updatePagePreview({ slug, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePagePreviewParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
1230
1142
|
/**
|
|
@@ -1235,8 +1147,8 @@ declare class Content {
|
|
|
1235
1147
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1236
1148
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
1237
1149
|
* @name updatePathRedirectionRules
|
|
1238
|
-
* @summary: Update path
|
|
1239
|
-
* @description:
|
|
1150
|
+
* @summary: Update path redirection rules.
|
|
1151
|
+
* @description: Modify settings for path redirection rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePathRedirectionRules/).
|
|
1240
1152
|
*/
|
|
1241
1153
|
updatePathRedirectionRules({ pathId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
1242
1154
|
/**
|
|
@@ -1247,8 +1159,8 @@ declare class Content {
|
|
|
1247
1159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1248
1160
|
* @returns {Promise<ContentPlatformModel.SeoSchema>} - Success response
|
|
1249
1161
|
* @name updateSEOConfiguration
|
|
1250
|
-
* @summary: Update SEO
|
|
1251
|
-
* @description:
|
|
1162
|
+
* @summary: Update SEO configuration for an application
|
|
1163
|
+
* @description: Modify configuration settings for SEO. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSEOConfiguration/).
|
|
1252
1164
|
*/
|
|
1253
1165
|
updateSEOConfiguration({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSEOConfigurationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchema>;
|
|
1254
1166
|
/**
|
|
@@ -1269,8 +1181,8 @@ declare class Content {
|
|
|
1269
1181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1270
1182
|
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
1271
1183
|
* @name updateSupportInformation
|
|
1272
|
-
* @summary: Update
|
|
1273
|
-
* @description:
|
|
1184
|
+
* @summary: Update support related info for an application
|
|
1185
|
+
* @description: Modify information related to customer support. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSupportInformation/).
|
|
1274
1186
|
*/
|
|
1275
1187
|
updateSupportInformation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSupportInformationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
|
|
1276
1188
|
}
|