@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4
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/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +5 -3
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
- package/sdk/application/Cart/CartApplicationClient.js +56 -56
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
- package/sdk/application/Lead/LeadApplicationClient.js +10 -10
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
- package/sdk/application/Order/OrderApplicationClient.js +17 -97
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +22 -16
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
- package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
- package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
- package/sdk/platform/Content/ContentPlatformClient.js +37 -37
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
- package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
- package/sdk/platform/Order/OrderPlatformClient.js +109 -204
- package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
- package/sdk/platform/Order/OrderPlatformModel.js +12 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
- package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
- package/sdk/platform/Share/SharePlatformModel.js +4 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
- package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- 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
|
@@ -22,7 +22,7 @@ class Content {
|
|
|
22
22
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
23
23
|
* Success response
|
|
24
24
|
* @name addDataLoader
|
|
25
|
-
* @summary:
|
|
25
|
+
* @summary: Create data loader
|
|
26
26
|
* @description: Create and add a new data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addDataLoader/).
|
|
27
27
|
*/
|
|
28
28
|
async addDataLoader(
|
|
@@ -101,7 +101,7 @@ class Content {
|
|
|
101
101
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
102
102
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
103
103
|
* @name addFaq
|
|
104
|
-
* @summary:
|
|
104
|
+
* @summary: Create FAQ
|
|
105
105
|
* @description: Create and add a new FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addFaq/).
|
|
106
106
|
*/
|
|
107
107
|
async addFaq(
|
|
@@ -180,7 +180,7 @@ class Content {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<ContentPlatformModel.TagsSchema>} - Success response
|
|
182
182
|
* @name addInjectableTag
|
|
183
|
-
* @summary: Create HTML tag
|
|
183
|
+
* @summary: Create HTML tag
|
|
184
184
|
* @description: Create and add a new injectable tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addInjectableTag/).
|
|
185
185
|
*/
|
|
186
186
|
async addInjectableTag(
|
|
@@ -261,7 +261,7 @@ class Content {
|
|
|
261
261
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
262
262
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
263
263
|
* @name addPathRedirectionRules
|
|
264
|
-
* @summary:
|
|
264
|
+
* @summary: Create path redirection rules
|
|
265
265
|
* @description: Create and add rules for path redirection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/addPathRedirectionRules/).
|
|
266
266
|
*/
|
|
267
267
|
async addPathRedirectionRules(
|
|
@@ -343,7 +343,7 @@ class Content {
|
|
|
343
343
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
344
344
|
* Success response
|
|
345
345
|
* @name createAnnouncement
|
|
346
|
-
* @summary: Create announcement
|
|
346
|
+
* @summary: Create announcement
|
|
347
347
|
* @description: Generate and add a new announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAnnouncement/).
|
|
348
348
|
*/
|
|
349
349
|
async createAnnouncement(
|
|
@@ -427,7 +427,7 @@ class Content {
|
|
|
427
427
|
*
|
|
428
428
|
* @name createAppCustomFieldByResourceId
|
|
429
429
|
* @summary: Create custom field entries for gives resource and resource_id
|
|
430
|
-
* @description:
|
|
430
|
+
* @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/).
|
|
431
431
|
*/
|
|
432
432
|
async createAppCustomFieldByResourceId(
|
|
433
433
|
{ resource, resourceId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -514,7 +514,7 @@ class Content {
|
|
|
514
514
|
*
|
|
515
515
|
* @name createAppCustomFieldDefinition
|
|
516
516
|
* @summary: Create custom field definition
|
|
517
|
-
* @description:
|
|
517
|
+
* @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/).
|
|
518
518
|
*/
|
|
519
519
|
async createAppCustomFieldDefinition(
|
|
520
520
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -595,7 +595,7 @@ class Content {
|
|
|
595
595
|
* @returns {Promise<ContentPlatformModel.CustomObjectSchema>} - Success response
|
|
596
596
|
* @name createAppCustomObject
|
|
597
597
|
* @summary: Create custom object entries
|
|
598
|
-
* @description:
|
|
598
|
+
* @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/).
|
|
599
599
|
*/
|
|
600
600
|
async createAppCustomObject(
|
|
601
601
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -677,7 +677,7 @@ class Content {
|
|
|
677
677
|
* Success response
|
|
678
678
|
* @name createAppCustomObjectDefinition
|
|
679
679
|
* @summary: Create custom object definition
|
|
680
|
-
* @description:
|
|
680
|
+
* @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/).
|
|
681
681
|
*/
|
|
682
682
|
async createAppCustomObjectDefinition(
|
|
683
683
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -755,7 +755,7 @@ class Content {
|
|
|
755
755
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
756
756
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
757
757
|
* @name createBlog
|
|
758
|
-
* @summary: Create blog
|
|
758
|
+
* @summary: Create blog
|
|
759
759
|
* @description: Generate and add a new blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createBlog/).
|
|
760
760
|
*/
|
|
761
761
|
async createBlog(
|
|
@@ -834,7 +834,7 @@ class Content {
|
|
|
834
834
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
835
835
|
* @returns {Promise<ContentPlatformModel.CreateFaqCategorySchema>} - Success response
|
|
836
836
|
* @name createFaqCategory
|
|
837
|
-
* @summary: Create FAQ
|
|
837
|
+
* @summary: Create FAQ Category
|
|
838
838
|
* @description: Generate and add a new FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createFaqCategory/).
|
|
839
839
|
*/
|
|
840
840
|
async createFaqCategory(
|
|
@@ -915,7 +915,7 @@ class Content {
|
|
|
915
915
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
916
916
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
917
917
|
* @name createLandingPage
|
|
918
|
-
* @summary: Create landing page
|
|
918
|
+
* @summary: Create landing page
|
|
919
919
|
* @description: Generate and add a new landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createLandingPage/).
|
|
920
920
|
*/
|
|
921
921
|
async createLandingPage(
|
|
@@ -1073,7 +1073,7 @@ class Content {
|
|
|
1073
1073
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1074
1074
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
1075
1075
|
* @name createPage
|
|
1076
|
-
* @summary: Create page
|
|
1076
|
+
* @summary: Create page
|
|
1077
1077
|
* @description: Generate and add a new page to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createPage/).
|
|
1078
1078
|
*/
|
|
1079
1079
|
async createPage(
|
|
@@ -1152,7 +1152,7 @@ class Content {
|
|
|
1152
1152
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1153
1153
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
1154
1154
|
* @name createPagePreview
|
|
1155
|
-
* @summary: Create page preview
|
|
1155
|
+
* @summary: Create page preview
|
|
1156
1156
|
* @description: Generate and add a new page preview. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createPagePreview/).
|
|
1157
1157
|
*/
|
|
1158
1158
|
async createPagePreview(
|
|
@@ -1233,8 +1233,8 @@ class Content {
|
|
|
1233
1233
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1234
1234
|
* @returns {Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>} - Success response
|
|
1235
1235
|
* @name createSEOMarkupSchema
|
|
1236
|
-
* @summary: Create
|
|
1237
|
-
* @description: Use this API to
|
|
1236
|
+
* @summary: Create SEO Markup Schema
|
|
1237
|
+
* @description: Use this API to Create SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSEOMarkupSchema/).
|
|
1238
1238
|
*/
|
|
1239
1239
|
async createSEOMarkupSchema(
|
|
1240
1240
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1313,7 +1313,7 @@ class Content {
|
|
|
1313
1313
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
1314
1314
|
* @name createSlideshow
|
|
1315
1315
|
* @summary: Create a slideshow
|
|
1316
|
-
* @description:
|
|
1316
|
+
* @description: Use this API to create a slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSlideshow/).
|
|
1317
1317
|
*/
|
|
1318
1318
|
async createSlideshow(
|
|
1319
1319
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1394,7 +1394,7 @@ class Content {
|
|
|
1394
1394
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
1395
1395
|
* Success response
|
|
1396
1396
|
* @name deleteAnnouncement
|
|
1397
|
-
* @summary: Delete announcement
|
|
1397
|
+
* @summary: Delete an announcement
|
|
1398
1398
|
* @description: Remove a specific announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAnnouncement/).
|
|
1399
1399
|
*/
|
|
1400
1400
|
async deleteAnnouncement(
|
|
@@ -1475,8 +1475,8 @@ class Content {
|
|
|
1475
1475
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1476
1476
|
* @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
|
|
1477
1477
|
* @name deleteAppCustomFieldDefinition
|
|
1478
|
-
* @summary: Delete custom fields definition
|
|
1479
|
-
* @description:
|
|
1478
|
+
* @summary: Delete custom fields definition
|
|
1479
|
+
* @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/).
|
|
1480
1480
|
*/
|
|
1481
1481
|
async deleteAppCustomFieldDefinition(
|
|
1482
1482
|
{ definitionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1557,7 +1557,7 @@ class Content {
|
|
|
1557
1557
|
* @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
|
|
1558
1558
|
* @name deleteAppCustomObject
|
|
1559
1559
|
* @summary: Delete custom object
|
|
1560
|
-
* @description:
|
|
1560
|
+
* @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/).
|
|
1561
1561
|
*/
|
|
1562
1562
|
async deleteAppCustomObject(
|
|
1563
1563
|
{ metaobjectId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1639,8 +1639,8 @@ class Content {
|
|
|
1639
1639
|
* - Success response
|
|
1640
1640
|
*
|
|
1641
1641
|
* @name deleteAppCustomObjectDefinition
|
|
1642
|
-
* @summary:
|
|
1643
|
-
* @description:
|
|
1642
|
+
* @summary: Delete custom object definition
|
|
1643
|
+
* @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/).
|
|
1644
1644
|
*/
|
|
1645
1645
|
async deleteAppCustomObjectDefinition(
|
|
1646
1646
|
{ definitionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1718,7 +1718,7 @@ class Content {
|
|
|
1718
1718
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1719
1719
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
1720
1720
|
* @name deleteBlog
|
|
1721
|
-
* @summary: Delete blog
|
|
1721
|
+
* @summary: Delete a blog
|
|
1722
1722
|
* @description: Remove a specific blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteBlog/).
|
|
1723
1723
|
*/
|
|
1724
1724
|
async deleteBlog(
|
|
@@ -1796,7 +1796,7 @@ class Content {
|
|
|
1796
1796
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
1797
1797
|
* Success response
|
|
1798
1798
|
* @name deleteDataLoader
|
|
1799
|
-
* @summary: Delete data loader
|
|
1799
|
+
* @summary: Delete a data loader
|
|
1800
1800
|
* @description: Remove a specific data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteDataLoader/).
|
|
1801
1801
|
*/
|
|
1802
1802
|
async deleteDataLoader(
|
|
@@ -1875,7 +1875,7 @@ class Content {
|
|
|
1875
1875
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1876
1876
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
1877
1877
|
* @name deleteFaq
|
|
1878
|
-
* @summary: Delete FAQ
|
|
1878
|
+
* @summary: Delete FAQ
|
|
1879
1879
|
* @description: Remove a specific FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteFaq/).
|
|
1880
1880
|
*/
|
|
1881
1881
|
async deleteFaq(
|
|
@@ -1956,7 +1956,7 @@ class Content {
|
|
|
1956
1956
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1957
1957
|
* @returns {Promise<ContentPlatformModel.FaqSchema>} - Success response
|
|
1958
1958
|
* @name deleteFaqCategory
|
|
1959
|
-
* @summary: Delete FAQ category
|
|
1959
|
+
* @summary: Delete FAQ category
|
|
1960
1960
|
* @description: Remove a specific FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteFaqCategory/).
|
|
1961
1961
|
*/
|
|
1962
1962
|
async deleteFaqCategory(
|
|
@@ -2037,7 +2037,7 @@ class Content {
|
|
|
2037
2037
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2038
2038
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
2039
2039
|
* @name deleteLandingPage
|
|
2040
|
-
* @summary: Delete landing page
|
|
2040
|
+
* @summary: Delete landing page
|
|
2041
2041
|
* @description: Remove a specific landing page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteLandingPage/).
|
|
2042
2042
|
*/
|
|
2043
2043
|
async deleteLandingPage(
|
|
@@ -2116,7 +2116,7 @@ class Content {
|
|
|
2116
2116
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2117
2117
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
2118
2118
|
* @name deleteNavigation
|
|
2119
|
-
* @summary: Delete navigation
|
|
2119
|
+
* @summary: Delete navigation
|
|
2120
2120
|
* @description: Remove a specific navigation element. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteNavigation/).
|
|
2121
2121
|
*/
|
|
2122
2122
|
async deleteNavigation(
|
|
@@ -2195,7 +2195,7 @@ class Content {
|
|
|
2195
2195
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2196
2196
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
2197
2197
|
* @name deletePage
|
|
2198
|
-
* @summary: Delete page
|
|
2198
|
+
* @summary: Delete page
|
|
2199
2199
|
* @description: Remove a page from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deletePage/).
|
|
2200
2200
|
*/
|
|
2201
2201
|
async deletePage(
|
|
@@ -2274,7 +2274,7 @@ class Content {
|
|
|
2274
2274
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2275
2275
|
* @returns {Promise<Object>} - Success response
|
|
2276
2276
|
* @name deletePathRedirectionRules
|
|
2277
|
-
* @summary: Delete path redirection
|
|
2277
|
+
* @summary: Delete path redirection rule
|
|
2278
2278
|
* @description: Remove specific path redirection rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deletePathRedirectionRules/).
|
|
2279
2279
|
*/
|
|
2280
2280
|
async deletePathRedirectionRules(
|
|
@@ -2353,8 +2353,8 @@ class Content {
|
|
|
2353
2353
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2354
2354
|
* @returns {Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>} - Success response
|
|
2355
2355
|
* @name deleteSEOMarkupSchema
|
|
2356
|
-
* @summary:
|
|
2357
|
-
* @description: Use this API to
|
|
2356
|
+
* @summary: Delete SEO Markup Schema
|
|
2357
|
+
* @description: Use this API to Delete SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSEOMarkupSchema/).
|
|
2358
2358
|
*/
|
|
2359
2359
|
async deleteSEOMarkupSchema(
|
|
2360
2360
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2512,7 +2512,7 @@ class Content {
|
|
|
2512
2512
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
2513
2513
|
* Success response
|
|
2514
2514
|
* @name editDataLoader
|
|
2515
|
-
* @summary:
|
|
2515
|
+
* @summary: Update a data loader
|
|
2516
2516
|
* @description: Modify the settings of a specific data loader. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/editDataLoader/).
|
|
2517
2517
|
*/
|
|
2518
2518
|
async editDataLoader(
|
|
@@ -2678,8 +2678,8 @@ class Content {
|
|
|
2678
2678
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2679
2679
|
* @returns {Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>} - Success response
|
|
2680
2680
|
* @name editSEOMarkupSchema
|
|
2681
|
-
* @summary: Get
|
|
2682
|
-
* @description: Use this API to
|
|
2681
|
+
* @summary: Get SEO Markup Schema
|
|
2682
|
+
* @description: Use this API to Get SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/editSEOMarkupSchema/).
|
|
2683
2683
|
*/
|
|
2684
2684
|
async editSEOMarkupSchema(
|
|
2685
2685
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2764,7 +2764,7 @@ class Content {
|
|
|
2764
2764
|
*
|
|
2765
2765
|
* @name exportAppCustomObjectEntries
|
|
2766
2766
|
* @summary: Initiate download for bulk custom object entries
|
|
2767
|
-
* @description:
|
|
2767
|
+
* @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/).
|
|
2768
2768
|
*/
|
|
2769
2769
|
async exportAppCustomObjectEntries(
|
|
2770
2770
|
{ definitionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -2842,7 +2842,7 @@ class Content {
|
|
|
2842
2842
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2843
2843
|
* @returns {Promise<ContentPlatformModel.GeneratedSEOContent>} - Success response
|
|
2844
2844
|
* @name generateSEOTitle
|
|
2845
|
-
* @summary: Generate SEO title
|
|
2845
|
+
* @summary: Generate SEO title
|
|
2846
2846
|
* @description: Create an SEO-friendly title for content. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/generateSEOTitle/).
|
|
2847
2847
|
*/
|
|
2848
2848
|
async generateSEOTitle(
|
|
@@ -2925,8 +2925,8 @@ class Content {
|
|
|
2925
2925
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2926
2926
|
* @returns {Promise<ContentPlatformModel.AdminAnnouncementSchema>} - Success response
|
|
2927
2927
|
* @name getAnnouncementById
|
|
2928
|
-
* @summary: Get announcement
|
|
2929
|
-
* @description:
|
|
2928
|
+
* @summary: Get announcement
|
|
2929
|
+
* @description: Get detailed information about a specific announcement - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAnnouncementById/).
|
|
2930
2930
|
*/
|
|
2931
2931
|
async getAnnouncementById(
|
|
2932
2932
|
{ announcementId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3007,8 +3007,8 @@ class Content {
|
|
|
3007
3007
|
* @returns {Promise<ContentPlatformModel.GetAnnouncementListSchema>} -
|
|
3008
3008
|
* Success response
|
|
3009
3009
|
* @name getAnnouncementsList
|
|
3010
|
-
* @summary:
|
|
3011
|
-
* @description:
|
|
3010
|
+
* @summary: List announcements
|
|
3011
|
+
* @description: Lists all announcements - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAnnouncementsList/).
|
|
3012
3012
|
*/
|
|
3013
3013
|
async getAnnouncementsList(
|
|
3014
3014
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3094,8 +3094,8 @@ class Content {
|
|
|
3094
3094
|
* - Success response
|
|
3095
3095
|
*
|
|
3096
3096
|
* @name getAppCustomFieldDefinition
|
|
3097
|
-
* @summary: Get custom fields definition
|
|
3098
|
-
* @description:
|
|
3097
|
+
* @summary: Get custom fields definition
|
|
3098
|
+
* @description: Custom field definitions can be fetch using definition id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinition/).
|
|
3099
3099
|
*/
|
|
3100
3100
|
async getAppCustomFieldDefinition(
|
|
3101
3101
|
{ definitionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3177,10 +3177,10 @@ class Content {
|
|
|
3177
3177
|
* Success response
|
|
3178
3178
|
* @name getAppCustomFieldDefinitions
|
|
3179
3179
|
* @summary: Get custom fields definitions
|
|
3180
|
-
* @description:
|
|
3180
|
+
* @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/).
|
|
3181
3181
|
*/
|
|
3182
3182
|
async getAppCustomFieldDefinitions(
|
|
3183
|
-
{ pageNo, pageSize,
|
|
3183
|
+
{ pageNo, pageSize, resource, type, search, requestHeaders } = {
|
|
3184
3184
|
requestHeaders: {},
|
|
3185
3185
|
},
|
|
3186
3186
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -3191,8 +3191,8 @@ class Content {
|
|
|
3191
3191
|
{
|
|
3192
3192
|
pageNo,
|
|
3193
3193
|
pageSize,
|
|
3194
|
-
|
|
3195
|
-
|
|
3194
|
+
resource,
|
|
3195
|
+
type,
|
|
3196
3196
|
search,
|
|
3197
3197
|
},
|
|
3198
3198
|
{ abortEarly: false, allowUnknown: true }
|
|
@@ -3208,8 +3208,8 @@ class Content {
|
|
|
3208
3208
|
{
|
|
3209
3209
|
pageNo,
|
|
3210
3210
|
pageSize,
|
|
3211
|
-
|
|
3212
|
-
|
|
3211
|
+
resource,
|
|
3212
|
+
type,
|
|
3213
3213
|
search,
|
|
3214
3214
|
},
|
|
3215
3215
|
{ abortEarly: false, allowUnknown: false }
|
|
@@ -3224,8 +3224,8 @@ class Content {
|
|
|
3224
3224
|
const query_params = {};
|
|
3225
3225
|
query_params["page_no"] = pageNo;
|
|
3226
3226
|
query_params["page_size"] = pageSize;
|
|
3227
|
-
query_params["
|
|
3228
|
-
query_params["
|
|
3227
|
+
query_params["resource"] = resource;
|
|
3228
|
+
query_params["type"] = type;
|
|
3229
3229
|
query_params["search"] = search;
|
|
3230
3230
|
|
|
3231
3231
|
const response = await PlatformAPIClient.execute(
|
|
@@ -3273,7 +3273,7 @@ class Content {
|
|
|
3273
3273
|
* @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
|
|
3274
3274
|
* @name getAppCustomFieldTypes
|
|
3275
3275
|
* @summary: Get custom field types
|
|
3276
|
-
* @description:
|
|
3276
|
+
* @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/).
|
|
3277
3277
|
*/
|
|
3278
3278
|
async getAppCustomFieldTypes(
|
|
3279
3279
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -3351,7 +3351,7 @@ class Content {
|
|
|
3351
3351
|
* Success response
|
|
3352
3352
|
* @name getAppCustomFields
|
|
3353
3353
|
* @summary: Get list of custom fields of gives resource
|
|
3354
|
-
* @description:
|
|
3354
|
+
* @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/).
|
|
3355
3355
|
*/
|
|
3356
3356
|
async getAppCustomFields(
|
|
3357
3357
|
{ resource, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3434,7 +3434,7 @@ class Content {
|
|
|
3434
3434
|
*
|
|
3435
3435
|
* @name getAppCustomFieldsByResourceId
|
|
3436
3436
|
* @summary: Get list of custom fields of given resource and resource id
|
|
3437
|
-
* @description:
|
|
3437
|
+
* @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/).
|
|
3438
3438
|
*/
|
|
3439
3439
|
async getAppCustomFieldsByResourceId(
|
|
3440
3440
|
{ resource, resourceId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3517,7 +3517,7 @@ class Content {
|
|
|
3517
3517
|
* @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
|
|
3518
3518
|
* @name getAppCustomObject
|
|
3519
3519
|
* @summary: Get custom object details
|
|
3520
|
-
* @description:
|
|
3520
|
+
* @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/).
|
|
3521
3521
|
*/
|
|
3522
3522
|
async getAppCustomObject(
|
|
3523
3523
|
{ metaobjectId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3598,8 +3598,8 @@ class Content {
|
|
|
3598
3598
|
* @returns {Promise<ContentPlatformModel.CustomObjectDefinitionSchema>} -
|
|
3599
3599
|
* Success response
|
|
3600
3600
|
* @name getAppCustomObjectDefinition
|
|
3601
|
-
* @summary:
|
|
3602
|
-
* @description:
|
|
3601
|
+
* @summary: Get custom object definition
|
|
3602
|
+
* @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/).
|
|
3603
3603
|
*/
|
|
3604
3604
|
async getAppCustomObjectDefinition(
|
|
3605
3605
|
{ definitionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3681,7 +3681,7 @@ class Content {
|
|
|
3681
3681
|
* Success response
|
|
3682
3682
|
* @name getAppCustomObjectDefinitions
|
|
3683
3683
|
* @summary: Get custom object definitions
|
|
3684
|
-
* @description:
|
|
3684
|
+
* @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/).
|
|
3685
3685
|
*/
|
|
3686
3686
|
async getAppCustomObjectDefinitions(
|
|
3687
3687
|
{ pageNo, pageSize, search, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3769,7 +3769,7 @@ class Content {
|
|
|
3769
3769
|
* @returns {Promise<ContentPlatformModel.CustomObjectsSchema>} - Success response
|
|
3770
3770
|
* @name getAppCustomObjects
|
|
3771
3771
|
* @summary: Get list of custom objects
|
|
3772
|
-
* @description:
|
|
3772
|
+
* @description: Custom object entries can fetch using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjects/).
|
|
3773
3773
|
*/
|
|
3774
3774
|
async getAppCustomObjects(
|
|
3775
3775
|
{ pageNo, pageSize, definitionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3854,8 +3854,8 @@ class Content {
|
|
|
3854
3854
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3855
3855
|
* @returns {Promise<ContentPlatformModel.CustomObjectBulkEntry>} - Success response
|
|
3856
3856
|
* @name getAppJobs
|
|
3857
|
-
* @summary:
|
|
3858
|
-
* @description:
|
|
3857
|
+
* @summary: Get bulk import and export job list
|
|
3858
|
+
* @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/).
|
|
3859
3859
|
*/
|
|
3860
3860
|
async getAppJobs(
|
|
3861
3861
|
{ page, pageSize, actionType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -3939,7 +3939,7 @@ class Content {
|
|
|
3939
3939
|
* @returns {Promise<ContentPlatformModel.ResourcesSchema>} - Success response
|
|
3940
3940
|
* @name getAppResources
|
|
3941
3941
|
* @summary: Get resources
|
|
3942
|
-
* @description:
|
|
3942
|
+
* @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/).
|
|
3943
3943
|
*/
|
|
3944
3944
|
async getAppResources(
|
|
3945
3945
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4013,7 +4013,7 @@ class Content {
|
|
|
4013
4013
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4014
4014
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
4015
4015
|
* @name getBlogBySlug
|
|
4016
|
-
* @summary: Get blog by slug
|
|
4016
|
+
* @summary: Get blog by slug
|
|
4017
4017
|
* @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/).
|
|
4018
4018
|
*/
|
|
4019
4019
|
async getBlogBySlug(
|
|
@@ -4092,8 +4092,8 @@ class Content {
|
|
|
4092
4092
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4093
4093
|
* @returns {Promise<ContentPlatformModel.BlogGetResponse>} - Success response
|
|
4094
4094
|
* @name getBlogs
|
|
4095
|
-
* @summary:
|
|
4096
|
-
* @description:
|
|
4095
|
+
* @summary: List blogs
|
|
4096
|
+
* @description: List all blogs - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
|
|
4097
4097
|
*/
|
|
4098
4098
|
async getBlogs(
|
|
4099
4099
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4173,7 +4173,7 @@ class Content {
|
|
|
4173
4173
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4174
4174
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
4175
4175
|
* @name getComponentById
|
|
4176
|
-
* @summary: Get component
|
|
4176
|
+
* @summary: Get component
|
|
4177
4177
|
* @description: Retrieve detailed information about a specific component. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getComponentById/).
|
|
4178
4178
|
*/
|
|
4179
4179
|
async getComponentById(
|
|
@@ -4252,8 +4252,8 @@ class Content {
|
|
|
4252
4252
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4253
4253
|
* @returns {Promise<ContentPlatformModel.DataLoadersSchema>} - Success response
|
|
4254
4254
|
* @name getDataLoaders
|
|
4255
|
-
* @summary:
|
|
4256
|
-
* @description:
|
|
4255
|
+
* @summary: List data loaders
|
|
4256
|
+
* @description: List all Dataloaders - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDataLoaders/).
|
|
4257
4257
|
*/
|
|
4258
4258
|
async getDataLoaders(
|
|
4259
4259
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4330,7 +4330,7 @@ class Content {
|
|
|
4330
4330
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
4331
4331
|
* Success response
|
|
4332
4332
|
* @name getDataLoadersByService
|
|
4333
|
-
* @summary:
|
|
4333
|
+
* @summary: List all data loaders
|
|
4334
4334
|
* @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/).
|
|
4335
4335
|
*/
|
|
4336
4336
|
async getDataLoadersByService(
|
|
@@ -4412,7 +4412,7 @@ class Content {
|
|
|
4412
4412
|
* @returns {Promise<ContentPlatformModel.DefaultNavigationResponse>} -
|
|
4413
4413
|
* Success response
|
|
4414
4414
|
* @name getDefaultNavigations
|
|
4415
|
-
* @summary: Get default navigations
|
|
4415
|
+
* @summary: Get default navigations
|
|
4416
4416
|
* @description: Retrieve default navigation elements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultNavigations/).
|
|
4417
4417
|
*/
|
|
4418
4418
|
async getDefaultNavigations(
|
|
@@ -4489,8 +4489,8 @@ class Content {
|
|
|
4489
4489
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4490
4490
|
* @returns {Promise<ContentPlatformModel.DefaultSchemaComponent>} - Success response
|
|
4491
4491
|
* @name getDefaultSEOMarkupSchema
|
|
4492
|
-
* @summary:
|
|
4493
|
-
* @description: Use this API to
|
|
4492
|
+
* @summary: List default SEO Markup Schemas
|
|
4493
|
+
* @description: Use this API to List default SEO Markup Schemas - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultSEOMarkupSchema/).
|
|
4494
4494
|
*/
|
|
4495
4495
|
async getDefaultSEOMarkupSchema(
|
|
4496
4496
|
{ pageType, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4569,8 +4569,8 @@ class Content {
|
|
|
4569
4569
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4570
4570
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
4571
4571
|
* @name getFaqByIdOrSlug
|
|
4572
|
-
* @summary: Get FAQ
|
|
4573
|
-
* @description:
|
|
4572
|
+
* @summary: Get FAQ or slug
|
|
4573
|
+
* @description: Get detailed information about a specific FAQ - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqByIdOrSlug/).
|
|
4574
4574
|
*/
|
|
4575
4575
|
async getFaqByIdOrSlug(
|
|
4576
4576
|
{ idOrSlug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4648,8 +4648,8 @@ class Content {
|
|
|
4648
4648
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4649
4649
|
* @returns {Promise<ContentPlatformModel.GetFaqCategoriesSchema>} - Success response
|
|
4650
4650
|
* @name getFaqCategories
|
|
4651
|
-
* @summary:
|
|
4652
|
-
* @description:
|
|
4651
|
+
* @summary: List FAQ Categories
|
|
4652
|
+
* @description: List all FAQ Categories - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategories/).
|
|
4653
4653
|
*/
|
|
4654
4654
|
async getFaqCategories(
|
|
4655
4655
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -4726,8 +4726,8 @@ class Content {
|
|
|
4726
4726
|
* @returns {Promise<ContentPlatformModel.GetFaqCategoryBySlugSchema>} -
|
|
4727
4727
|
* Success response
|
|
4728
4728
|
* @name getFaqCategoryBySlugOrId
|
|
4729
|
-
* @summary: Get FAQ category
|
|
4730
|
-
* @description:
|
|
4729
|
+
* @summary: Get FAQ category
|
|
4730
|
+
* @description: Get detailed information about a specific FAQ category - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategoryBySlugOrId/).
|
|
4731
4731
|
*/
|
|
4732
4732
|
async getFaqCategoryBySlugOrId(
|
|
4733
4733
|
{ idOrSlug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -4807,7 +4807,7 @@ class Content {
|
|
|
4807
4807
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4808
4808
|
* @returns {Promise<ContentPlatformModel.GetFaqSchema>} - Success response
|
|
4809
4809
|
* @name getFaqsByCategoryIdOrSlug
|
|
4810
|
-
* @summary:
|
|
4810
|
+
* @summary: List FAQs
|
|
4811
4811
|
* @description: Retrieve a list of FAQs within a specific category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqsByCategoryIdOrSlug/).
|
|
4812
4812
|
*/
|
|
4813
4813
|
async getFaqsByCategoryIdOrSlug(
|
|
@@ -4968,8 +4968,8 @@ class Content {
|
|
|
4968
4968
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4969
4969
|
* @returns {Promise<ContentPlatformModel.LandingPageGetResponse>} - Success response
|
|
4970
4970
|
* @name getLandingPages
|
|
4971
|
-
* @summary: Get landing pages
|
|
4972
|
-
* @description:
|
|
4971
|
+
* @summary: Get landing pages
|
|
4972
|
+
* @description: Lists a list landing pages as per device types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLandingPages/).
|
|
4973
4973
|
*/
|
|
4974
4974
|
async getLandingPages(
|
|
4975
4975
|
{ pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5053,8 +5053,8 @@ class Content {
|
|
|
5053
5053
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5054
5054
|
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
5055
5055
|
* @name getLegalInformation
|
|
5056
|
-
* @summary: Get
|
|
5057
|
-
* @description:
|
|
5056
|
+
* @summary: Get Legal Pages
|
|
5057
|
+
* @description: Get legal information and terms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLegalInformation/).
|
|
5058
5058
|
*/
|
|
5059
5059
|
async getLegalInformation(
|
|
5060
5060
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -5130,7 +5130,7 @@ class Content {
|
|
|
5130
5130
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5131
5131
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
5132
5132
|
* @name getNavigationBySlug
|
|
5133
|
-
* @summary: Get navigation by slug
|
|
5133
|
+
* @summary: Get navigation by slug
|
|
5134
5134
|
* @description: Retrieve detailed information about a specific navigation element. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getNavigationBySlug/).
|
|
5135
5135
|
*/
|
|
5136
5136
|
async getNavigationBySlug(
|
|
@@ -5300,8 +5300,8 @@ class Content {
|
|
|
5300
5300
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5301
5301
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
5302
5302
|
* @name getPageBySlug
|
|
5303
|
-
* @summary: Get page by slug
|
|
5304
|
-
* @description:
|
|
5303
|
+
* @summary: Get page by slug
|
|
5304
|
+
* @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/).
|
|
5305
5305
|
*/
|
|
5306
5306
|
async getPageBySlug(
|
|
5307
5307
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5379,8 +5379,8 @@ class Content {
|
|
|
5379
5379
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5380
5380
|
* @returns {Promise<ContentPlatformModel.PageMetaSchema>} - Success response
|
|
5381
5381
|
* @name getPageMeta
|
|
5382
|
-
* @summary: Get page meta
|
|
5383
|
-
* @description:
|
|
5382
|
+
* @summary: Get page meta
|
|
5383
|
+
* @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/).
|
|
5384
5384
|
*/
|
|
5385
5385
|
async getPageMeta(
|
|
5386
5386
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -5454,8 +5454,8 @@ class Content {
|
|
|
5454
5454
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5455
5455
|
* @returns {Promise<ContentPlatformModel.PageSpec>} - Success response
|
|
5456
5456
|
* @name getPageSpec
|
|
5457
|
-
* @summary: Get page specification
|
|
5458
|
-
* @description:
|
|
5457
|
+
* @summary: Get page specification
|
|
5458
|
+
* @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/).
|
|
5459
5459
|
*/
|
|
5460
5460
|
async getPageSpec(
|
|
5461
5461
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -5529,7 +5529,7 @@ class Content {
|
|
|
5529
5529
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5530
5530
|
* @returns {Promise<ContentPlatformModel.PageGetResponse>} - Success response
|
|
5531
5531
|
* @name getPages
|
|
5532
|
-
* @summary: Get pages
|
|
5532
|
+
* @summary: Get pages
|
|
5533
5533
|
* @description: Retrieve a list of available pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPages/).
|
|
5534
5534
|
*/
|
|
5535
5535
|
async getPages(
|
|
@@ -5612,8 +5612,8 @@ class Content {
|
|
|
5612
5612
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5613
5613
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
5614
5614
|
* @name getPathRedirectionRule
|
|
5615
|
-
* @summary: Get
|
|
5616
|
-
* @description:
|
|
5615
|
+
* @summary: Get Path Redirection Rule
|
|
5616
|
+
* @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/).
|
|
5617
5617
|
*/
|
|
5618
5618
|
async getPathRedirectionRule(
|
|
5619
5619
|
{ pathId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5693,8 +5693,8 @@ class Content {
|
|
|
5693
5693
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5694
5694
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
5695
5695
|
* @name getPathRedirectionRules
|
|
5696
|
-
* @summary:
|
|
5697
|
-
* @description:
|
|
5696
|
+
* @summary: List Path Redirection Rules
|
|
5697
|
+
* @description: Use this API to List Path Redirection Rules - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRules/).
|
|
5698
5698
|
*/
|
|
5699
5699
|
async getPathRedirectionRules(
|
|
5700
5700
|
{ pageSize, pageNo, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5778,7 +5778,7 @@ class Content {
|
|
|
5778
5778
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5779
5779
|
* @returns {Promise<ContentPlatformModel.SeoComponent>} - Success response
|
|
5780
5780
|
* @name getSEOConfiguration
|
|
5781
|
-
* @summary: Get
|
|
5781
|
+
* @summary: Get sales channel SEO
|
|
5782
5782
|
* @description: Retrieve configuration settings for SEO. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOConfiguration/).
|
|
5783
5783
|
*/
|
|
5784
5784
|
async getSEOConfiguration(
|
|
@@ -5855,8 +5855,8 @@ class Content {
|
|
|
5855
5855
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5856
5856
|
* @returns {Promise<ContentPlatformModel.SEOSchemaMarkupTemplate>} - Success response
|
|
5857
5857
|
* @name getSEOMarkupSchema
|
|
5858
|
-
* @summary: Get
|
|
5859
|
-
* @description: Use this API to
|
|
5858
|
+
* @summary: Get SEO Markup Schema
|
|
5859
|
+
* @description: Use this API to Get SEO Markup Schema - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOMarkupSchema/).
|
|
5860
5860
|
*/
|
|
5861
5861
|
async getSEOMarkupSchema(
|
|
5862
5862
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -5936,8 +5936,8 @@ class Content {
|
|
|
5936
5936
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
5937
5937
|
* @returns {Promise<ContentPlatformModel.SeoSchemaComponent>} - Success response
|
|
5938
5938
|
* @name getSEOMarkupSchemas
|
|
5939
|
-
* @summary:
|
|
5940
|
-
* @description: Use this API to
|
|
5939
|
+
* @summary: List default SEO Markup Schemas
|
|
5940
|
+
* @description: Use this API to List default SEO Markup Schemas - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOMarkupSchemas/).
|
|
5941
5941
|
*/
|
|
5942
5942
|
async getSEOMarkupSchemas(
|
|
5943
5943
|
{ title, active, pageNo, pageSize, requestHeaders } = {
|
|
@@ -6029,8 +6029,8 @@ class Content {
|
|
|
6029
6029
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
6030
6030
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
6031
6031
|
* @name getSlideshowBySlug
|
|
6032
|
-
* @summary: Get
|
|
6033
|
-
* @description: Use this API to
|
|
6032
|
+
* @summary: Get Slideshow
|
|
6033
|
+
* @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/).
|
|
6034
6034
|
*/
|
|
6035
6035
|
async getSlideshowBySlug(
|
|
6036
6036
|
{ slug, devicePlatform, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6111,8 +6111,8 @@ class Content {
|
|
|
6111
6111
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
6112
6112
|
* @returns {Promise<ContentPlatformModel.SlideshowGetResponse>} - Success response
|
|
6113
6113
|
* @name getSlideshows
|
|
6114
|
-
* @summary:
|
|
6115
|
-
* @description:
|
|
6114
|
+
* @summary: List Slideshows
|
|
6115
|
+
* @description: Use this API to list all Slideshows - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSlideshows/).
|
|
6116
6116
|
*/
|
|
6117
6117
|
async getSlideshows(
|
|
6118
6118
|
{ devicePlatform, pageNo, pageSize, requestHeaders } = {
|
|
@@ -6204,8 +6204,8 @@ class Content {
|
|
|
6204
6204
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each
|
|
6205
6205
|
* page. Default value is 10.
|
|
6206
6206
|
* @returns {Paginator<ContentPlatformModel.SlideshowGetResponse>}
|
|
6207
|
-
* @summary:
|
|
6208
|
-
* @description:
|
|
6207
|
+
* @summary: List Slideshows
|
|
6208
|
+
* @description: Use this API to list all Slideshows
|
|
6209
6209
|
*/
|
|
6210
6210
|
getSlideshowsPaginator({
|
|
6211
6211
|
companyId,
|
|
@@ -6243,7 +6243,7 @@ class Content {
|
|
|
6243
6243
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
6244
6244
|
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
6245
6245
|
* @name getSupportInformation
|
|
6246
|
-
* @summary: Get support information
|
|
6246
|
+
* @summary: Get support information
|
|
6247
6247
|
* @description: Retrieve information related to customer support. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSupportInformation/).
|
|
6248
6248
|
*/
|
|
6249
6249
|
async getSupportInformation(
|
|
@@ -6323,7 +6323,7 @@ class Content {
|
|
|
6323
6323
|
*
|
|
6324
6324
|
* @name importAppCustomObjectEntries
|
|
6325
6325
|
* @summary: Bulk custom object entries upload
|
|
6326
|
-
* @description:
|
|
6326
|
+
* @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/).
|
|
6327
6327
|
*/
|
|
6328
6328
|
async importAppCustomObjectEntries(
|
|
6329
6329
|
{ definitionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6406,7 +6406,7 @@ class Content {
|
|
|
6406
6406
|
* @returns {Promise<ContentPlatformModel.TagDeleteSuccessResponse>} -
|
|
6407
6407
|
* Success response
|
|
6408
6408
|
* @name removeInjectableTag
|
|
6409
|
-
* @summary: Remove HTML tag
|
|
6409
|
+
* @summary: Remove HTML tag
|
|
6410
6410
|
* @description: Delete a specific injectable tag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/removeInjectableTag/).
|
|
6411
6411
|
*/
|
|
6412
6412
|
async removeInjectableTag(
|
|
@@ -6486,7 +6486,7 @@ class Content {
|
|
|
6486
6486
|
* @returns {Promise<ContentPlatformModel.DataLoaderResetResponseSchema>} -
|
|
6487
6487
|
* Success response
|
|
6488
6488
|
* @name resetDataLoader
|
|
6489
|
-
* @summary: Reset data loader
|
|
6489
|
+
* @summary: Reset a data loader
|
|
6490
6490
|
* @description: Clear and reset data loader settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/resetDataLoader/).
|
|
6491
6491
|
*/
|
|
6492
6492
|
async resetDataLoader(
|
|
@@ -6569,8 +6569,8 @@ class Content {
|
|
|
6569
6569
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
6570
6570
|
* @returns {Promise<string>} - Success response
|
|
6571
6571
|
* @name sampleAppCustomObjectBulkEntry
|
|
6572
|
-
* @summary:
|
|
6573
|
-
* @description:
|
|
6572
|
+
* @summary: Download sample for custom object bulk entry
|
|
6573
|
+
* @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/).
|
|
6574
6574
|
*/
|
|
6575
6575
|
async sampleAppCustomObjectBulkEntry(
|
|
6576
6576
|
{ definitionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6646,7 +6646,7 @@ class Content {
|
|
|
6646
6646
|
* @returns {Promise<ContentPlatformModel.DataLoaderResponseSchema>} -
|
|
6647
6647
|
* Success response
|
|
6648
6648
|
* @name selectDataLoader
|
|
6649
|
-
* @summary: Select data loader
|
|
6649
|
+
* @summary: Select a data loader
|
|
6650
6650
|
* @description: Choose and set a data loader for use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/selectDataLoader/).
|
|
6651
6651
|
*/
|
|
6652
6652
|
async selectDataLoader(
|
|
@@ -6728,7 +6728,7 @@ class Content {
|
|
|
6728
6728
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
6729
6729
|
* Success response
|
|
6730
6730
|
* @name updateAnnouncement
|
|
6731
|
-
* @summary: Update announcement
|
|
6731
|
+
* @summary: Update announcement
|
|
6732
6732
|
* @description: Modify the content and settings of a specific announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAnnouncement/).
|
|
6733
6733
|
*/
|
|
6734
6734
|
async updateAnnouncement(
|
|
@@ -6812,7 +6812,7 @@ class Content {
|
|
|
6812
6812
|
* @returns {Promise<ContentPlatformModel.CreateAnnouncementSchema>} -
|
|
6813
6813
|
* Success response
|
|
6814
6814
|
* @name updateAnnouncementSchedule
|
|
6815
|
-
* @summary: Update announcement schedule
|
|
6815
|
+
* @summary: Update announcement schedule
|
|
6816
6816
|
* @description: Modify the scheduling of a specific announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAnnouncementSchedule/).
|
|
6817
6817
|
*/
|
|
6818
6818
|
async updateAnnouncementSchedule(
|
|
@@ -6898,7 +6898,7 @@ class Content {
|
|
|
6898
6898
|
*
|
|
6899
6899
|
* @name updateAppCustomFieldDefinition
|
|
6900
6900
|
* @summary: Update custom field definition
|
|
6901
|
-
* @description:
|
|
6901
|
+
* @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/).
|
|
6902
6902
|
*/
|
|
6903
6903
|
async updateAppCustomFieldDefinition(
|
|
6904
6904
|
{ definitionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -6981,7 +6981,7 @@ class Content {
|
|
|
6981
6981
|
* @returns {Promise<ContentPlatformModel.CustomObjectByIdSchema>} - Success response
|
|
6982
6982
|
* @name updateAppCustomObject
|
|
6983
6983
|
* @summary: Update custom object details
|
|
6984
|
-
* @description:
|
|
6984
|
+
* @description: Custom object entries can be updated using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObject/).
|
|
6985
6985
|
*/
|
|
6986
6986
|
async updateAppCustomObject(
|
|
6987
6987
|
{ metaobjectId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -7065,7 +7065,7 @@ class Content {
|
|
|
7065
7065
|
* Success response
|
|
7066
7066
|
* @name updateAppCustomObjectDefinition
|
|
7067
7067
|
* @summary: Update custom object definition
|
|
7068
|
-
* @description:
|
|
7068
|
+
* @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/).
|
|
7069
7069
|
*/
|
|
7070
7070
|
async updateAppCustomObjectDefinition(
|
|
7071
7071
|
{ definitionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -7145,7 +7145,7 @@ class Content {
|
|
|
7145
7145
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7146
7146
|
* @returns {Promise<ContentPlatformModel.BlogSchema>} - Success response
|
|
7147
7147
|
* @name updateBlog
|
|
7148
|
-
* @summary: Update blog
|
|
7148
|
+
* @summary: Update a blog
|
|
7149
7149
|
* @description: Modify the content and settings of a specific blog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateBlog/).
|
|
7150
7150
|
*/
|
|
7151
7151
|
async updateBlog(
|
|
@@ -7224,7 +7224,7 @@ class Content {
|
|
|
7224
7224
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7225
7225
|
* @returns {Promise<ContentPlatformModel.CreateFaqResponseSchema>} - Success response
|
|
7226
7226
|
* @name updateFaq
|
|
7227
|
-
* @summary: Update FAQ
|
|
7227
|
+
* @summary: Update FAQ
|
|
7228
7228
|
* @description: Modify the content and settings of a specific FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateFaq/).
|
|
7229
7229
|
*/
|
|
7230
7230
|
async updateFaq(
|
|
@@ -7307,7 +7307,7 @@ class Content {
|
|
|
7307
7307
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7308
7308
|
* @returns {Promise<ContentPlatformModel.CreateFaqCategorySchema>} - Success response
|
|
7309
7309
|
* @name updateFaqCategory
|
|
7310
|
-
* @summary: Update FAQ category
|
|
7310
|
+
* @summary: Update FAQ category
|
|
7311
7311
|
* @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/).
|
|
7312
7312
|
*/
|
|
7313
7313
|
async updateFaqCategory(
|
|
@@ -7471,7 +7471,7 @@ class Content {
|
|
|
7471
7471
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7472
7472
|
* @returns {Promise<ContentPlatformModel.LandingPageSchema>} - Success response
|
|
7473
7473
|
* @name updateLandingPage
|
|
7474
|
-
* @summary: Update landing page
|
|
7474
|
+
* @summary: Update landing page
|
|
7475
7475
|
* @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/).
|
|
7476
7476
|
*/
|
|
7477
7477
|
async updateLandingPage(
|
|
@@ -7554,7 +7554,7 @@ class Content {
|
|
|
7554
7554
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7555
7555
|
* @returns {Promise<ContentPlatformModel.ApplicationLegal>} - Success response
|
|
7556
7556
|
* @name updateLegalInformation
|
|
7557
|
-
* @summary: Update
|
|
7557
|
+
* @summary: Update Legal Pages
|
|
7558
7558
|
* @description: Modify legal information and terms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateLegalInformation/).
|
|
7559
7559
|
*/
|
|
7560
7560
|
async updateLegalInformation(
|
|
@@ -7633,7 +7633,7 @@ class Content {
|
|
|
7633
7633
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7634
7634
|
* @returns {Promise<ContentPlatformModel.NavigationSchema>} - Success response
|
|
7635
7635
|
* @name updateNavigation
|
|
7636
|
-
* @summary: Update navigation
|
|
7636
|
+
* @summary: Update navigation
|
|
7637
7637
|
* @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/).
|
|
7638
7638
|
*/
|
|
7639
7639
|
async updateNavigation(
|
|
@@ -7714,7 +7714,7 @@ class Content {
|
|
|
7714
7714
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7715
7715
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
7716
7716
|
* @name updatePage
|
|
7717
|
-
* @summary: Update page
|
|
7717
|
+
* @summary: Update page
|
|
7718
7718
|
* @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePage/).
|
|
7719
7719
|
*/
|
|
7720
7720
|
async updatePage(
|
|
@@ -7795,7 +7795,7 @@ class Content {
|
|
|
7795
7795
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7796
7796
|
* @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
|
|
7797
7797
|
* @name updatePagePreview
|
|
7798
|
-
* @summary: Update page preview
|
|
7798
|
+
* @summary: Update page preview
|
|
7799
7799
|
* @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/).
|
|
7800
7800
|
*/
|
|
7801
7801
|
async updatePagePreview(
|
|
@@ -7878,7 +7878,7 @@ class Content {
|
|
|
7878
7878
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7879
7879
|
* @returns {Promise<ContentPlatformModel.PathMappingSchema>} - Success response
|
|
7880
7880
|
* @name updatePathRedirectionRules
|
|
7881
|
-
* @summary: Update path redirection
|
|
7881
|
+
* @summary: Update path redirection rule
|
|
7882
7882
|
* @description: Modify settings for path redirection rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updatePathRedirectionRules/).
|
|
7883
7883
|
*/
|
|
7884
7884
|
async updatePathRedirectionRules(
|
|
@@ -7961,7 +7961,7 @@ class Content {
|
|
|
7961
7961
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
7962
7962
|
* @returns {Promise<ContentPlatformModel.SeoSchema>} - Success response
|
|
7963
7963
|
* @name updateSEOConfiguration
|
|
7964
|
-
* @summary: Update
|
|
7964
|
+
* @summary: Update sales channel SEO information
|
|
7965
7965
|
* @description: Modify configuration settings for SEO. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSEOConfiguration/).
|
|
7966
7966
|
*/
|
|
7967
7967
|
async updateSEOConfiguration(
|
|
@@ -8041,7 +8041,7 @@ class Content {
|
|
|
8041
8041
|
* @returns {Promise<ContentPlatformModel.SlideshowSchema>} - Success response
|
|
8042
8042
|
* @name updateSlideshow
|
|
8043
8043
|
* @summary: Update a slideshow
|
|
8044
|
-
* @description: Use this API to
|
|
8044
|
+
* @description: Use this API to Update Slideshow - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSlideshow/).
|
|
8045
8045
|
*/
|
|
8046
8046
|
async updateSlideshow(
|
|
8047
8047
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -8123,7 +8123,7 @@ class Content {
|
|
|
8123
8123
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
8124
8124
|
* @returns {Promise<ContentPlatformModel.Support>} - Success response
|
|
8125
8125
|
* @name updateSupportInformation
|
|
8126
|
-
* @summary: Update
|
|
8126
|
+
* @summary: Update Customer Support Information
|
|
8127
8127
|
* @description: Modify information related to customer support. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSupportInformation/).
|
|
8128
8128
|
*/
|
|
8129
8129
|
async updateSupportInformation(
|