@gofynd/fdk-client-javascript 1.4.3 → 1.4.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 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- 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 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -10,7 +10,7 @@ declare class Content {
|
|
|
10
10
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
11
11
|
* Success response
|
|
12
12
|
* @name addDataLoader
|
|
13
|
-
* @summary:
|
|
13
|
+
* @summary: Create data loader
|
|
14
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>;
|
|
@@ -20,7 +20,7 @@ declare class Content {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
22
22
|
* @name addFaq
|
|
23
|
-
* @summary:
|
|
23
|
+
* @summary: Create FAQ
|
|
24
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>;
|
|
@@ -42,7 +42,7 @@ declare class Content {
|
|
|
42
42
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
43
43
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
44
44
|
* @name addPathRedirectionRules
|
|
45
|
-
* @summary:
|
|
45
|
+
* @summary: Create path redirection rules
|
|
46
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>;
|
|
@@ -70,7 +70,7 @@ declare class Content {
|
|
|
70
70
|
*
|
|
71
71
|
* @name createAppCustomFieldByResourceId
|
|
72
72
|
* @summary: Create custom field entries for gives resource and resource_id
|
|
73
|
-
* @description:
|
|
73
|
+
* @description: You can add a custom field using this endpoint to any resource by providing the resource ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomFieldByResourceId/).
|
|
74
74
|
*/
|
|
75
75
|
createAppCustomFieldByResourceId({ resource, resourceId, body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomFieldByResourceIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>;
|
|
76
76
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Content {
|
|
|
84
84
|
*
|
|
85
85
|
* @name createAppCustomFieldDefinition
|
|
86
86
|
* @summary: Create custom field definition
|
|
87
|
-
* @description:
|
|
87
|
+
* @description: You can create custom fields definition to any resource so you can extend property of resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomFieldDefinition/).
|
|
88
88
|
*/
|
|
89
89
|
createAppCustomFieldDefinition({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
|
|
90
90
|
/**
|
|
@@ -96,7 +96,7 @@ declare class Content {
|
|
|
96
96
|
* @returns {Promise<ContentPlatformModel.CustomObjectSchema>} - Success response
|
|
97
97
|
* @name createAppCustomObject
|
|
98
98
|
* @summary: Create custom object entries
|
|
99
|
-
* @description:
|
|
99
|
+
* @description: Custom object entries against the custom object definition can be added using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomObject/).
|
|
100
100
|
*/
|
|
101
101
|
createAppCustomObject({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectSchema>;
|
|
102
102
|
/**
|
|
@@ -109,7 +109,7 @@ declare class Content {
|
|
|
109
109
|
* Success response
|
|
110
110
|
* @name createAppCustomObjectDefinition
|
|
111
111
|
* @summary: Create custom object definition
|
|
112
|
-
* @description:
|
|
112
|
+
* @description: Create a custom object that will have a collection of custom fields and can be used anywhere in the custom field for any resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomObjectDefinition/).
|
|
113
113
|
*/
|
|
114
114
|
createAppCustomObjectDefinition({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateAppCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSchema>;
|
|
115
115
|
/**
|
|
@@ -130,7 +130,7 @@ 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 FAQ
|
|
133
|
+
* @summary: Create FAQ Category
|
|
134
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>;
|
|
@@ -186,8 +186,8 @@ declare class Content {
|
|
|
186
186
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
187
187
|
* @returns {Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>} - Success response
|
|
188
188
|
* @name createSEOMarkupSchema
|
|
189
|
-
* @summary: Create
|
|
190
|
-
* @description: Use this API to
|
|
189
|
+
* @summary: Create SEO Markup Schema
|
|
190
|
+
* @description: Use this API to Create SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSEOMarkupSchema/).
|
|
191
191
|
*/
|
|
192
192
|
createSEOMarkupSchema({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
|
|
193
193
|
/**
|
|
@@ -197,7 +197,7 @@ declare class Content {
|
|
|
197
197
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
198
198
|
* @name createSlideshow
|
|
199
199
|
* @summary: Create a slideshow
|
|
200
|
-
* @description:
|
|
200
|
+
* @description: Use this API to create a slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSlideshow/).
|
|
201
201
|
*/
|
|
202
202
|
createSlideshow({ body, requestHeaders }?: ContentPlatformApplicationValidator.CreateSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
203
203
|
/**
|
|
@@ -209,7 +209,7 @@ declare class Content {
|
|
|
209
209
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
210
210
|
* Success response
|
|
211
211
|
* @name deleteAnnouncement
|
|
212
|
-
* @summary: Delete announcement
|
|
212
|
+
* @summary: Delete an announcement
|
|
213
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>;
|
|
@@ -222,7 +222,7 @@ declare class Content {
|
|
|
222
222
|
* @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
|
|
223
223
|
* @name deleteAppCustomFieldDefinition
|
|
224
224
|
* @summary: Delete custom fields definition
|
|
225
|
-
* @description:
|
|
225
|
+
* @description: Custom field definition and its assosiated custom fields value can be deleted using this api on the basis of definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomFieldDefinition/).
|
|
226
226
|
*/
|
|
227
227
|
deleteAppCustomFieldDefinition({ definitionId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAppCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomDataDeleteSchema>;
|
|
228
228
|
/**
|
|
@@ -234,7 +234,7 @@ declare class Content {
|
|
|
234
234
|
* @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
|
|
235
235
|
* @name deleteAppCustomObject
|
|
236
236
|
* @summary: Delete custom object
|
|
237
|
-
* @description:
|
|
237
|
+
* @description: Custom object entries can be deleted by providing the delete ID using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomObject/).
|
|
238
238
|
*/
|
|
239
239
|
deleteAppCustomObject({ metaobjectId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAppCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomDataDeleteSchema>;
|
|
240
240
|
/**
|
|
@@ -247,8 +247,8 @@ declare class Content {
|
|
|
247
247
|
* - Success response
|
|
248
248
|
*
|
|
249
249
|
* @name deleteAppCustomObjectDefinition
|
|
250
|
-
* @summary:
|
|
251
|
-
* @description:
|
|
250
|
+
* @summary: Delete custom object definition
|
|
251
|
+
* @description: Custom object definitions can be deleted using this endpoint by providing the definition ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomObjectDefinition/).
|
|
252
252
|
*/
|
|
253
253
|
deleteAppCustomObjectDefinition({ definitionId, requestHeaders }?: ContentPlatformApplicationValidator.DeleteAppCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionDeleteResponseSchema>;
|
|
254
254
|
/**
|
|
@@ -257,7 +257,7 @@ 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 blog
|
|
260
|
+
* @summary: Delete a blog
|
|
261
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>;
|
|
@@ -268,7 +268,7 @@ declare class Content {
|
|
|
268
268
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
269
269
|
* Success response
|
|
270
270
|
* @name deleteDataLoader
|
|
271
|
-
* @summary: Delete data loader
|
|
271
|
+
* @summary: Delete a data loader
|
|
272
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>;
|
|
@@ -334,7 +334,7 @@ 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 redirection
|
|
337
|
+
* @summary: Delete path redirection rule
|
|
338
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>;
|
|
@@ -346,8 +346,8 @@ declare class Content {
|
|
|
346
346
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
347
347
|
* @returns {Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>} - Success response
|
|
348
348
|
* @name deleteSEOMarkupSchema
|
|
349
|
-
* @summary:
|
|
350
|
-
* @description: Use this API to
|
|
349
|
+
* @summary: Delete SEO Markup Schema
|
|
350
|
+
* @description: Use this API to Delete SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSEOMarkupSchema/).
|
|
351
351
|
*/
|
|
352
352
|
deleteSEOMarkupSchema({ id, requestHeaders }?: ContentPlatformApplicationValidator.DeleteSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
|
|
353
353
|
/**
|
|
@@ -367,7 +367,7 @@ declare class Content {
|
|
|
367
367
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
368
368
|
* Success response
|
|
369
369
|
* @name editDataLoader
|
|
370
|
-
* @summary:
|
|
370
|
+
* @summary: Update a data loader
|
|
371
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>;
|
|
@@ -391,8 +391,8 @@ declare class Content {
|
|
|
391
391
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
392
392
|
* @returns {Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>} - Success response
|
|
393
393
|
* @name editSEOMarkupSchema
|
|
394
|
-
* @summary: Get
|
|
395
|
-
* @description: Use this API to
|
|
394
|
+
* @summary: Get SEO Markup Schema
|
|
395
|
+
* @description: Use this API to Get SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/editSEOMarkupSchema/).
|
|
396
396
|
*/
|
|
397
397
|
editSEOMarkupSchema({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.EditSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
|
|
398
398
|
/**
|
|
@@ -406,7 +406,7 @@ declare class Content {
|
|
|
406
406
|
*
|
|
407
407
|
* @name exportAppCustomObjectEntries
|
|
408
408
|
* @summary: Initiate download for bulk custom object entries
|
|
409
|
-
* @description:
|
|
409
|
+
* @description: Custom object bulk export of bulk entries can be perform using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/exportAppCustomObjectEntries/).
|
|
410
410
|
*/
|
|
411
411
|
exportAppCustomObjectEntries({ definitionId, requestHeaders }?: ContentPlatformApplicationValidator.ExportAppCustomObjectEntriesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectBulkEntryInitiateDownload>;
|
|
412
412
|
/**
|
|
@@ -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
|
|
431
|
-
* @description:
|
|
430
|
+
* @summary: Get announcement
|
|
431
|
+
* @description: Get 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,8 +440,8 @@ declare class Content {
|
|
|
440
440
|
* @returns {Promise<ContentPlatformModel.GetAnnouncementListSchema>} -
|
|
441
441
|
* Success response
|
|
442
442
|
* @name getAnnouncementsList
|
|
443
|
-
* @summary:
|
|
444
|
-
* @description:
|
|
443
|
+
* @summary: List announcements
|
|
444
|
+
* @description: Lists all 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
447
|
/**
|
|
@@ -454,8 +454,8 @@ declare class Content {
|
|
|
454
454
|
* - Success response
|
|
455
455
|
*
|
|
456
456
|
* @name getAppCustomFieldDefinition
|
|
457
|
-
* @summary: Get custom fields definition
|
|
458
|
-
* @description:
|
|
457
|
+
* @summary: Get custom fields definition
|
|
458
|
+
* @description: Custom field definitions can be fetch using definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinition/).
|
|
459
459
|
*/
|
|
460
460
|
getAppCustomFieldDefinition({ definitionId, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
|
|
461
461
|
/**
|
|
@@ -468,7 +468,7 @@ declare class Content {
|
|
|
468
468
|
* Success response
|
|
469
469
|
* @name getAppCustomFieldDefinitions
|
|
470
470
|
* @summary: Get custom fields definitions
|
|
471
|
-
* @description:
|
|
471
|
+
* @description: Custom field definitions enable you to include data validation for custom fields, and enable sellers to add custom fields values for resources. With the help of this seller can retrive list of custom field definitions list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinitions/).
|
|
472
472
|
*/
|
|
473
473
|
getAppCustomFieldDefinitions({ pageNo, pageSize, resource, type, search, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionsSchema>;
|
|
474
474
|
/**
|
|
@@ -480,7 +480,7 @@ declare class Content {
|
|
|
480
480
|
* @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
|
|
481
481
|
* @name getAppCustomFieldTypes
|
|
482
482
|
* @summary: Get custom field types
|
|
483
|
-
* @description:
|
|
483
|
+
* @description: Each custom field and custom field definition has a type, which defines the type of information that it can store. The custom field types have built-in validation. This api will give list of supported custom fields types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldTypes/).
|
|
484
484
|
*/
|
|
485
485
|
getAppCustomFieldTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectByIdSchema>;
|
|
486
486
|
/**
|
|
@@ -493,7 +493,7 @@ declare class Content {
|
|
|
493
493
|
* Success response
|
|
494
494
|
* @name getAppCustomFields
|
|
495
495
|
* @summary: Get list of custom fields of gives resource
|
|
496
|
-
* @description:
|
|
496
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFields/).
|
|
497
497
|
*/
|
|
498
498
|
getAppCustomFields({ resource, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseSchema>;
|
|
499
499
|
/**
|
|
@@ -507,7 +507,7 @@ declare class Content {
|
|
|
507
507
|
*
|
|
508
508
|
* @name getAppCustomFieldsByResourceId
|
|
509
509
|
* @summary: Get list of custom fields of given resource and resource id
|
|
510
|
-
* @description:
|
|
510
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldsByResourceId/).
|
|
511
511
|
*/
|
|
512
512
|
getAppCustomFieldsByResourceId({ resource, resourceId, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomFieldsByResourceIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldsResponseByResourceIdSchema>;
|
|
513
513
|
/**
|
|
@@ -519,7 +519,7 @@ declare class Content {
|
|
|
519
519
|
* @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
|
|
520
520
|
* @name getAppCustomObject
|
|
521
521
|
* @summary: Get custom object details
|
|
522
|
-
* @description:
|
|
522
|
+
* @description: Details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObject/).
|
|
523
523
|
*/
|
|
524
524
|
getAppCustomObject({ metaobjectId, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectByIdSchema>;
|
|
525
525
|
/**
|
|
@@ -531,8 +531,8 @@ declare class Content {
|
|
|
531
531
|
* @returns {Promise<ContentPlatformModel.CustomObjectDefinitionSchema>} -
|
|
532
532
|
* Success response
|
|
533
533
|
* @name getAppCustomObjectDefinition
|
|
534
|
-
* @summary:
|
|
535
|
-
* @description:
|
|
534
|
+
* @summary: Get custom object definition
|
|
535
|
+
* @description: Custom object definitions can be fetched using their definition ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjectDefinition/).
|
|
536
536
|
*/
|
|
537
537
|
getAppCustomObjectDefinition({ definitionId, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSchema>;
|
|
538
538
|
/**
|
|
@@ -545,7 +545,7 @@ declare class Content {
|
|
|
545
545
|
* Success response
|
|
546
546
|
* @name getAppCustomObjectDefinitions
|
|
547
547
|
* @summary: Get custom object definitions
|
|
548
|
-
* @description:
|
|
548
|
+
* @description: Custom object definition lists can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjectDefinitions/).
|
|
549
549
|
*/
|
|
550
550
|
getAppCustomObjectDefinitions({ pageNo, pageSize, search, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectDefinitionsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionsSchema>;
|
|
551
551
|
/**
|
|
@@ -557,7 +557,7 @@ declare class Content {
|
|
|
557
557
|
* @returns {Promise<ContentPlatformModel.CustomObjectsSchema>} - Success response
|
|
558
558
|
* @name getAppCustomObjects
|
|
559
559
|
* @summary: Get list of custom objects
|
|
560
|
-
* @description:
|
|
560
|
+
* @description: Custom object entries can fetch using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjects/).
|
|
561
561
|
*/
|
|
562
562
|
getAppCustomObjects({ pageNo, pageSize, definitionId, requestHeaders }?: ContentPlatformApplicationValidator.GetAppCustomObjectsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectsSchema>;
|
|
563
563
|
/**
|
|
@@ -566,8 +566,8 @@ declare class Content {
|
|
|
566
566
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
567
567
|
* @returns {Promise<ContentPlatformModel.CustomObjectBulkEntry>} - Success response
|
|
568
568
|
* @name getAppJobs
|
|
569
|
-
* @summary:
|
|
570
|
-
* @description:
|
|
569
|
+
* @summary: Get bulk import and export job list
|
|
570
|
+
* @description: Custom object bulk import and export jobs status and details can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppJobs/).
|
|
571
571
|
*/
|
|
572
572
|
getAppJobs({ page, pageSize, actionType, requestHeaders }?: ContentPlatformApplicationValidator.GetAppJobsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectBulkEntry>;
|
|
573
573
|
/**
|
|
@@ -577,7 +577,7 @@ declare class Content {
|
|
|
577
577
|
* @returns {Promise<ContentPlatformModel.ResourcesSchema>} - Success response
|
|
578
578
|
* @name getAppResources
|
|
579
579
|
* @summary: Get resources
|
|
580
|
-
* @description:
|
|
580
|
+
* @description: Each custom fields is assosiated with a resource such as product, promotion, coupon, selling location etc, This will gives list of supported resource list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppResources/).
|
|
581
581
|
*/
|
|
582
582
|
getAppResources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.ResourcesSchema>;
|
|
583
583
|
/**
|
|
@@ -596,8 +596,8 @@ declare class Content {
|
|
|
596
596
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
597
597
|
* @returns {Promise<ContentPlatformModel.BlogGetResponse>} - Success response
|
|
598
598
|
* @name getBlogs
|
|
599
|
-
* @summary:
|
|
600
|
-
* @description:
|
|
599
|
+
* @summary: List blogs
|
|
600
|
+
* @description: List all blogs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
|
|
601
601
|
*/
|
|
602
602
|
getBlogs({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetBlogsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogGetResponse>;
|
|
603
603
|
/**
|
|
@@ -606,7 +606,7 @@ declare class Content {
|
|
|
606
606
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
607
607
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
608
608
|
* @name getComponentById
|
|
609
|
-
* @summary: Get component
|
|
609
|
+
* @summary: Get component
|
|
610
610
|
* @description: Retrieve detailed information about a specific component. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getComponentById/).
|
|
611
611
|
*/
|
|
612
612
|
getComponentById({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetComponentByIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
@@ -616,8 +616,8 @@ declare class Content {
|
|
|
616
616
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
617
617
|
* @returns {Promise<ContentPlatformModel.DataLoadersSchema>} - Success response
|
|
618
618
|
* @name getDataLoaders
|
|
619
|
-
* @summary:
|
|
620
|
-
* @description:
|
|
619
|
+
* @summary: List data loaders
|
|
620
|
+
* @description: List all Dataloaders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDataLoaders/).
|
|
621
621
|
*/
|
|
622
622
|
getDataLoaders({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoadersSchema>;
|
|
623
623
|
/**
|
|
@@ -629,7 +629,7 @@ declare class Content {
|
|
|
629
629
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
630
630
|
* Success response
|
|
631
631
|
* @name getDataLoadersByService
|
|
632
|
-
* @summary:
|
|
632
|
+
* @summary: List all data loaders
|
|
633
633
|
* @description: Use this to get all data loaders of an application by service name - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDataLoadersByService/).
|
|
634
634
|
*/
|
|
635
635
|
getDataLoadersByService({ serviceName, requestHeaders }?: ContentPlatformApplicationValidator.GetDataLoadersByServiceParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
@@ -654,8 +654,8 @@ declare class Content {
|
|
|
654
654
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
655
655
|
* @returns {Promise<ContentPlatformModel.DefaultSchemaComponent>} - Success response
|
|
656
656
|
* @name getDefaultSEOMarkupSchema
|
|
657
|
-
* @summary:
|
|
658
|
-
* @description: Use this API to
|
|
657
|
+
* @summary: List default SEO Markup Schemas
|
|
658
|
+
* @description: Use this API to List default SEO Markup Schemas - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultSEOMarkupSchema/).
|
|
659
659
|
*/
|
|
660
660
|
getDefaultSEOMarkupSchema({ pageType, requestHeaders }?: ContentPlatformApplicationValidator.GetDefaultSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DefaultSchemaComponent>;
|
|
661
661
|
/**
|
|
@@ -664,8 +664,8 @@ declare class Content {
|
|
|
664
664
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
665
665
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
666
666
|
* @name getFaqByIdOrSlug
|
|
667
|
-
* @summary: Get FAQ
|
|
668
|
-
* @description:
|
|
667
|
+
* @summary: Get FAQ or slug
|
|
668
|
+
* @description: Get detailed information about a specific FAQ - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqByIdOrSlug/).
|
|
669
669
|
*/
|
|
670
670
|
getFaqByIdOrSlug({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqByIdOrSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CreateFaqResponseSchema>;
|
|
671
671
|
/**
|
|
@@ -674,8 +674,8 @@ declare class Content {
|
|
|
674
674
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
675
675
|
* @returns {Promise<ContentPlatformModel.GetFaqCategoriesSchema>} - Success response
|
|
676
676
|
* @name getFaqCategories
|
|
677
|
-
* @summary:
|
|
678
|
-
* @description:
|
|
677
|
+
* @summary: List FAQ Categories
|
|
678
|
+
* @description: List all FAQ Categories - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategories/).
|
|
679
679
|
*/
|
|
680
680
|
getFaqCategories({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqCategoriesSchema>;
|
|
681
681
|
/**
|
|
@@ -687,8 +687,8 @@ declare class Content {
|
|
|
687
687
|
* @returns {Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>} -
|
|
688
688
|
* Success response
|
|
689
689
|
* @name getFaqCategoryBySlugOrId
|
|
690
|
-
* @summary: Get FAQ category
|
|
691
|
-
* @description:
|
|
690
|
+
* @summary: Get FAQ category
|
|
691
|
+
* @description: Get detailed information about a specific FAQ category - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategoryBySlugOrId/).
|
|
692
692
|
*/
|
|
693
693
|
getFaqCategoryBySlugOrId({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqCategoryBySlugOrIdParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>;
|
|
694
694
|
/**
|
|
@@ -699,7 +699,7 @@ declare class Content {
|
|
|
699
699
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
700
700
|
* @returns {Promise<ContentPlatformModel.GetFaqSchema>} - Success response
|
|
701
701
|
* @name getFaqsByCategoryIdOrSlug
|
|
702
|
-
* @summary:
|
|
702
|
+
* @summary: List FAQs
|
|
703
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/).
|
|
704
704
|
*/
|
|
705
705
|
getFaqsByCategoryIdOrSlug({ idOrSlug, requestHeaders }?: ContentPlatformApplicationValidator.GetFaqsByCategoryIdOrSlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.GetFaqSchema>;
|
|
@@ -722,7 +722,7 @@ declare class Content {
|
|
|
722
722
|
* @returns {Promise<ContentPlatformModel.LandingPageGetResponse>} - Success response
|
|
723
723
|
* @name getLandingPages
|
|
724
724
|
* @summary: Get landing pages
|
|
725
|
-
* @description:
|
|
725
|
+
* @description: Lists a list landing pages as per device types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLandingPages/).
|
|
726
726
|
*/
|
|
727
727
|
getLandingPages({ pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetLandingPagesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.LandingPageGetResponse>;
|
|
728
728
|
/**
|
|
@@ -733,8 +733,8 @@ declare class Content {
|
|
|
733
733
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
734
734
|
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
735
735
|
* @name getLegalInformation
|
|
736
|
-
* @summary: Get
|
|
737
|
-
* @description:
|
|
736
|
+
* @summary: Get Legal Pages
|
|
737
|
+
* @description: Get legal information and terms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLegalInformation/).
|
|
738
738
|
*/
|
|
739
739
|
getLegalInformation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.ApplicationLegal>;
|
|
740
740
|
/**
|
|
@@ -766,7 +766,7 @@ declare class Content {
|
|
|
766
766
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
767
767
|
* @name getPageBySlug
|
|
768
768
|
* @summary: Get page by slug
|
|
769
|
-
* @description:
|
|
769
|
+
* @description: Get detailed information about a specific page using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageBySlug/).
|
|
770
770
|
*/
|
|
771
771
|
getPageBySlug({ slug, requestHeaders }?: ContentPlatformApplicationValidator.GetPageBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSchema>;
|
|
772
772
|
/**
|
|
@@ -776,7 +776,7 @@ declare class Content {
|
|
|
776
776
|
* @returns {Promise<ContentPlatformModel.PageMetaSchema>} - Success response
|
|
777
777
|
* @name getPageMeta
|
|
778
778
|
* @summary: Get page meta
|
|
779
|
-
* @description:
|
|
779
|
+
* @description: Use this API to Get metadata for a specific page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageMeta/).
|
|
780
780
|
*/
|
|
781
781
|
getPageMeta({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.PageMetaSchema>;
|
|
782
782
|
/**
|
|
@@ -786,7 +786,7 @@ declare class Content {
|
|
|
786
786
|
* @returns {Promise<ContentPlatformModel.PageSpec>} - Success response
|
|
787
787
|
* @name getPageSpec
|
|
788
788
|
* @summary: Get page specification
|
|
789
|
-
* @description:
|
|
789
|
+
* @description: Use this API to Get specifications and details for a specific page - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageSpec/).
|
|
790
790
|
*/
|
|
791
791
|
getPageSpec({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.PageSpec>;
|
|
792
792
|
/**
|
|
@@ -807,8 +807,8 @@ declare class Content {
|
|
|
807
807
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
808
808
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
809
809
|
* @name getPathRedirectionRule
|
|
810
|
-
* @summary: Get
|
|
811
|
-
* @description:
|
|
810
|
+
* @summary: Get Path Redirection Rule
|
|
811
|
+
* @description: Use this API to Get detailed information about a specific path redirection rule - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRule/).
|
|
812
812
|
*/
|
|
813
813
|
getPathRedirectionRule({ pathId, requestHeaders }?: ContentPlatformApplicationValidator.GetPathRedirectionRuleParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
814
814
|
/**
|
|
@@ -819,8 +819,8 @@ declare class Content {
|
|
|
819
819
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
820
820
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
821
821
|
* @name getPathRedirectionRules
|
|
822
|
-
* @summary:
|
|
823
|
-
* @description:
|
|
822
|
+
* @summary: List Path Redirection Rules
|
|
823
|
+
* @description: Use this API to List Path Redirection Rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRules/).
|
|
824
824
|
*/
|
|
825
825
|
getPathRedirectionRules({ pageSize, pageNo, requestHeaders }?: ContentPlatformApplicationValidator.GetPathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
826
826
|
/**
|
|
@@ -831,7 +831,7 @@ declare class Content {
|
|
|
831
831
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
832
832
|
* @returns {Promise<ContentPlatformModel.SeoComponent>} - Success response
|
|
833
833
|
* @name getSEOConfiguration
|
|
834
|
-
* @summary: Get
|
|
834
|
+
* @summary: Get sales channel SEO
|
|
835
835
|
* @description: Retrieve configuration settings for SEO. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOConfiguration/).
|
|
836
836
|
*/
|
|
837
837
|
getSEOConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoComponent>;
|
|
@@ -843,8 +843,8 @@ declare class Content {
|
|
|
843
843
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
844
844
|
* @returns {Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>} - Success response
|
|
845
845
|
* @name getSEOMarkupSchema
|
|
846
|
-
* @summary: Get
|
|
847
|
-
* @description: Use this API to
|
|
846
|
+
* @summary: Get SEO Markup Schema
|
|
847
|
+
* @description: Use this API to Get SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOMarkupSchema/).
|
|
848
848
|
*/
|
|
849
849
|
getSEOMarkupSchema({ id, requestHeaders }?: ContentPlatformApplicationValidator.GetSEOMarkupSchemaParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>;
|
|
850
850
|
/**
|
|
@@ -855,8 +855,8 @@ declare class Content {
|
|
|
855
855
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
856
856
|
* @returns {Promise<ContentPlatformModel.SeoSchemaComponent>} - Success response
|
|
857
857
|
* @name getSEOMarkupSchemas
|
|
858
|
-
* @summary:
|
|
859
|
-
* @description: Use this API to
|
|
858
|
+
* @summary: List default SEO Markup Schemas
|
|
859
|
+
* @description: Use this API to List default SEO Markup Schemas - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOMarkupSchemas/).
|
|
860
860
|
*/
|
|
861
861
|
getSEOMarkupSchemas({ title, active, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetSEOMarkupSchemasParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchemaComponent>;
|
|
862
862
|
/**
|
|
@@ -867,8 +867,8 @@ declare class Content {
|
|
|
867
867
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
868
868
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
869
869
|
* @name getSlideshowBySlug
|
|
870
|
-
* @summary: Get
|
|
871
|
-
* @description: Use this API to
|
|
870
|
+
* @summary: Get Slideshow
|
|
871
|
+
* @description: Use this API to get the details of a slideshow by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSlideshowBySlug/).
|
|
872
872
|
*/
|
|
873
873
|
getSlideshowBySlug({ slug, devicePlatform, requestHeaders }?: ContentPlatformApplicationValidator.GetSlideshowBySlugParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
874
874
|
/**
|
|
@@ -877,8 +877,8 @@ declare class Content {
|
|
|
877
877
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
878
878
|
* @returns {Promise<ContentPlatformModel.SlideshowGetResponse>} - Success response
|
|
879
879
|
* @name getSlideshows
|
|
880
|
-
* @summary:
|
|
881
|
-
* @description:
|
|
880
|
+
* @summary: List Slideshows
|
|
881
|
+
* @description: Use this API to list all Slideshows - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSlideshows/).
|
|
882
882
|
*/
|
|
883
883
|
getSlideshows({ devicePlatform, pageNo, pageSize, requestHeaders }?: ContentPlatformApplicationValidator.GetSlideshowsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowGetResponse>;
|
|
884
884
|
/**
|
|
@@ -892,8 +892,8 @@ declare class Content {
|
|
|
892
892
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
893
893
|
* page. Default value is 10.
|
|
894
894
|
* @returns {Paginator<ContentPlatformModel.SlideshowGetResponse>}
|
|
895
|
-
* @summary:
|
|
896
|
-
* @description:
|
|
895
|
+
* @summary: List Slideshows
|
|
896
|
+
* @description: Use this API to list all Slideshows
|
|
897
897
|
*/
|
|
898
898
|
getSlideshowsPaginator({ companyId, applicationId, devicePlatform, pageSize, }?: {
|
|
899
899
|
companyId: string;
|
|
@@ -924,7 +924,7 @@ declare class Content {
|
|
|
924
924
|
*
|
|
925
925
|
* @name importAppCustomObjectEntries
|
|
926
926
|
* @summary: Bulk custom object entries upload
|
|
927
|
-
* @description:
|
|
927
|
+
* @description: Custom object bulk import of bulk entries can be performed using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/importAppCustomObjectEntries/).
|
|
928
928
|
*/
|
|
929
929
|
importAppCustomObjectEntries({ definitionId, body, requestHeaders }?: ContentPlatformApplicationValidator.ImportAppCustomObjectEntriesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectEntryBulkUploadResponse>;
|
|
930
930
|
/**
|
|
@@ -947,7 +947,7 @@ declare class Content {
|
|
|
947
947
|
* @returns {Promise<ContentPlatformModel.DataLoaderResetResponseSchema>} -
|
|
948
948
|
* Success response
|
|
949
949
|
* @name resetDataLoader
|
|
950
|
-
* @summary: Reset data loader
|
|
950
|
+
* @summary: Reset a data loader
|
|
951
951
|
* @description: Clear and reset data loader settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/resetDataLoader/).
|
|
952
952
|
*/
|
|
953
953
|
resetDataLoader({ service, operationId, requestHeaders }?: ContentPlatformApplicationValidator.ResetDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResetResponseSchema>;
|
|
@@ -959,8 +959,8 @@ declare class Content {
|
|
|
959
959
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
960
960
|
* @returns {Promise<string>} - Success response
|
|
961
961
|
* @name sampleAppCustomObjectBulkEntry
|
|
962
|
-
* @summary:
|
|
963
|
-
* @description:
|
|
962
|
+
* @summary: Download sample for custom object bulk entry
|
|
963
|
+
* @description: Sample files for custom object bulk import can be obtained from this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/sampleAppCustomObjectBulkEntry/).
|
|
964
964
|
*/
|
|
965
965
|
sampleAppCustomObjectBulkEntry({ definitionId, requestHeaders }?: ContentPlatformApplicationValidator.SampleAppCustomObjectBulkEntryParam, { responseHeaders }?: object): Promise<string>;
|
|
966
966
|
/**
|
|
@@ -970,7 +970,7 @@ declare class Content {
|
|
|
970
970
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
971
971
|
* Success response
|
|
972
972
|
* @name selectDataLoader
|
|
973
|
-
* @summary: Select data loader
|
|
973
|
+
* @summary: Select a data loader
|
|
974
974
|
* @description: Choose and set a data loader for use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/selectDataLoader/).
|
|
975
975
|
*/
|
|
976
976
|
selectDataLoader({ dataLoaderId, requestHeaders }?: ContentPlatformApplicationValidator.SelectDataLoaderParam, { responseHeaders }?: object): Promise<ContentPlatformModel.DataLoaderResponseSchema>;
|
|
@@ -1011,7 +1011,7 @@ declare class Content {
|
|
|
1011
1011
|
*
|
|
1012
1012
|
* @name updateAppCustomFieldDefinition
|
|
1013
1013
|
* @summary: Update custom field definition
|
|
1014
|
-
* @description:
|
|
1014
|
+
* @description: Custom fields definition can be update using this api, You can update custom field definition name and description. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomFieldDefinition/).
|
|
1015
1015
|
*/
|
|
1016
1016
|
updateAppCustomFieldDefinition({ definitionId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomFieldDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomFieldDefinitionDetailResSchema>;
|
|
1017
1017
|
/**
|
|
@@ -1023,7 +1023,7 @@ declare class Content {
|
|
|
1023
1023
|
* @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
|
|
1024
1024
|
* @name updateAppCustomObject
|
|
1025
1025
|
* @summary: Update custom object details
|
|
1026
|
-
* @description:
|
|
1026
|
+
* @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObject/).
|
|
1027
1027
|
*/
|
|
1028
1028
|
updateAppCustomObject({ metaobjectId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomObjectParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectByIdSchema>;
|
|
1029
1029
|
/**
|
|
@@ -1036,7 +1036,7 @@ declare class Content {
|
|
|
1036
1036
|
* Success response
|
|
1037
1037
|
* @name updateAppCustomObjectDefinition
|
|
1038
1038
|
* @summary: Update custom object definition
|
|
1039
|
-
* @description:
|
|
1039
|
+
* @description: Custom object definitions can be updated using this endpoint. You can update the name and description of the custom object and add more custom field definitions to the existing custom object. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObjectDefinition/).
|
|
1040
1040
|
*/
|
|
1041
1041
|
updateAppCustomObjectDefinition({ definitionId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateAppCustomObjectDefinitionParam, { responseHeaders }?: object): Promise<ContentPlatformModel.CustomObjectDefinitionSchema>;
|
|
1042
1042
|
/**
|
|
@@ -1045,7 +1045,7 @@ declare class Content {
|
|
|
1045
1045
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1046
1046
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
1047
1047
|
* @name updateBlog
|
|
1048
|
-
* @summary: Update blog
|
|
1048
|
+
* @summary: Update a blog
|
|
1049
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/).
|
|
1050
1050
|
*/
|
|
1051
1051
|
updateBlog({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateBlogParam, { responseHeaders }?: object): Promise<ContentPlatformModel.BlogSchema>;
|
|
@@ -1103,7 +1103,7 @@ declare class Content {
|
|
|
1103
1103
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1104
1104
|
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
1105
1105
|
* @name updateLegalInformation
|
|
1106
|
-
* @summary: Update
|
|
1106
|
+
* @summary: Update Legal Pages
|
|
1107
1107
|
* @description: Modify legal information and terms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateLegalInformation/).
|
|
1108
1108
|
*/
|
|
1109
1109
|
updateLegalInformation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateLegalInformationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.ApplicationLegal>;
|
|
@@ -1147,7 +1147,7 @@ declare class Content {
|
|
|
1147
1147
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1148
1148
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
1149
1149
|
* @name updatePathRedirectionRules
|
|
1150
|
-
* @summary: Update path redirection
|
|
1150
|
+
* @summary: Update path redirection rule
|
|
1151
1151
|
* @description: Modify settings for path redirection rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePathRedirectionRules/).
|
|
1152
1152
|
*/
|
|
1153
1153
|
updatePathRedirectionRules({ pathId, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdatePathRedirectionRulesParam, { responseHeaders }?: object): Promise<ContentPlatformModel.PathMappingSchema>;
|
|
@@ -1159,7 +1159,7 @@ declare class Content {
|
|
|
1159
1159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1160
1160
|
* @returns {Promise<ContentPlatformModel.SeoSchema>} - Success response
|
|
1161
1161
|
* @name updateSEOConfiguration
|
|
1162
|
-
* @summary: Update
|
|
1162
|
+
* @summary: Update sales channel SEO information
|
|
1163
1163
|
* @description: Modify configuration settings for SEO. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSEOConfiguration/).
|
|
1164
1164
|
*/
|
|
1165
1165
|
updateSEOConfiguration({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSEOConfigurationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SeoSchema>;
|
|
@@ -1170,7 +1170,7 @@ declare class Content {
|
|
|
1170
1170
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
1171
1171
|
* @name updateSlideshow
|
|
1172
1172
|
* @summary: Update a slideshow
|
|
1173
|
-
* @description: Use this API to
|
|
1173
|
+
* @description: Use this API to Update Slideshow - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSlideshow/).
|
|
1174
1174
|
*/
|
|
1175
1175
|
updateSlideshow({ id, body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSlideshowParam, { responseHeaders }?: object): Promise<ContentPlatformModel.SlideshowSchema>;
|
|
1176
1176
|
/**
|
|
@@ -1181,7 +1181,7 @@ declare class Content {
|
|
|
1181
1181
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1182
1182
|
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
1183
1183
|
* @name updateSupportInformation
|
|
1184
|
-
* @summary: Update
|
|
1184
|
+
* @summary: Update Customer Support Information
|
|
1185
1185
|
* @description: Modify information related to customer support. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSupportInformation/).
|
|
1186
1186
|
*/
|
|
1187
1187
|
updateSupportInformation({ body, requestHeaders }?: ContentPlatformApplicationValidator.UpdateSupportInformationParam, { responseHeaders }?: object): Promise<ContentPlatformModel.Support>;
|