@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.
Files changed (125) hide show
  1. package/README.md +1 -10
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
  4. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  7. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  8. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  9. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  10. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
  14. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
  18. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
  22. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  23. package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
  24. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
  26. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
  30. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  31. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  32. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  33. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  34. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  35. package/sdk/application/User/UserApplicationClient.d.ts +74 -74
  36. package/sdk/application/User/UserApplicationClient.js +74 -74
  37. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
  38. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  39. package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
  40. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  41. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
  42. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  43. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
  44. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  45. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
  46. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  47. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  48. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  49. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
  50. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  51. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  52. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  53. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
  54. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  55. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
  56. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
  57. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
  58. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
  59. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
  60. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  61. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
  62. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  63. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
  64. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  65. package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
  66. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  67. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
  68. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  69. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
  70. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  71. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
  72. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  73. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  74. package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
  75. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  76. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  78. package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
  79. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  80. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  81. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  82. package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
  83. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  84. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  85. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  86. package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
  87. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  88. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  89. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  90. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
  91. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  92. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
  93. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  94. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  95. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  96. package/sdk/platform/PlatformClient.d.ts +0 -2
  97. package/sdk/platform/PlatformClient.js +0 -4
  98. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
  99. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  100. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
  101. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  102. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
  103. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  104. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
  105. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  106. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  107. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  108. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
  109. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  110. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
  111. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  112. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  113. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  114. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
  115. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  116. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
  117. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  118. package/sdk/platform/index.d.ts +0 -1
  119. package/sdk/platform/index.js +0 -2
  120. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  121. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  122. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  123. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  124. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  125. 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: Add data loader
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: Add FAQ
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(
@@ -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: Add path redirection rules
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(
@@ -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: Use this API to create the custom field entry for given resource and resource_id in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomFieldByResourceId/).
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: Use this API to create a custom field definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomFieldDefinition/).
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: Use this API to create the custom object entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomObject/).
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: Use this API to create custom object defintion - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createAppCustomObjectDefinition/).
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: {} },
@@ -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 category
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(
@@ -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 a SEO Markup schema Template of a page type for an application
1237
- * @description: Use this API to create a SEO Markup schema Template inside an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSEOMarkupSchema/).
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: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to create a slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/createSlideshow/).
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(
@@ -1476,7 +1476,7 @@ class Content {
1476
1476
  * @returns {Promise<ContentPlatformModel.CustomDataDeleteSchema>} - Success response
1477
1477
  * @name deleteAppCustomFieldDefinition
1478
1478
  * @summary: Delete custom fields definition
1479
- * @description: Use this API to delete the definitions of custom fields using definition_id. This will also delete related custom fields entries related to this definition. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomFieldDefinition/).
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: Use this API to delete the custom object entry by id. This will also delete related custom fields entries related to this custom object. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomObject/).
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: delete custom object definition by id
1643
- * @description: Use this API to delete a custom object definition and related data for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteAppCustomObjectDefinition/).
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(
@@ -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 rules
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: delete a particular SEO Markup schema of an application using its id
2357
- * @description: Use this API to delete an existing SEO Markup schema an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/deleteSEOMarkupSchema/).
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: Edit data loader
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 a particular SEO Markup schema of an application using its id
2682
- * @description: Use this API to edit an existing SEO Markup schema an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/editSEOMarkupSchema/).
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: Use this api to initiate download of bulk entries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/exportAppCustomObjectEntries/).
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: {} },
@@ -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 by ID
2929
- * @description: Retrieve detailed information about a specific announcement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAnnouncementById/).
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: Get announcements list
3011
- * @description: Retrieve a list of announcements. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAnnouncementsList/).
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 by id
3098
- * @description: Use this API to retrieve the definitions of custom fields using definition_id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinition/).
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,7 +3177,7 @@ class Content {
3177
3177
  * Success response
3178
3178
  * @name getAppCustomFieldDefinitions
3179
3179
  * @summary: Get custom fields definitions
3180
- * @description: Use this API to retrieve the definitions of custom fields. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldDefinitions/).
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
3183
  { pageNo, pageSize, resource, type, search, requestHeaders } = {
@@ -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: Use this API to retrieve the custom field types - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldTypes/).
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: Use this API to retrieve the custom fields for given resource in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFields/).
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: Use this API to retrieve the custom fields for given resource in param. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomFieldsByResourceId/).
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: Use this API to retrieve the custom object details and their fields details and definitions and references. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObject/).
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: get custom object definition by id
3602
- * @description: Use this API to update a custom object definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjectDefinition/).
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: Use this API to retrieve the custom object definitions - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjectDefinitions/).
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: Use this API to retrieve the custom objects. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppCustomObjects/).
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: Fetch bulk import and export job list
3858
- * @description: Use this api to get list of jobs of bulk import and exports - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppJobs/).
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: Use this API to retrieve the resources, such as products, collections, customers, selling locations, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getAppResources/).
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: {} },
@@ -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: Get blogs
4096
- * @description: Retrieve a list of available blogs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getBlogs/).
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 by ID
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: Get data loaders
4256
- * @description: Retrieve a list of data loaders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDataLoaders/).
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: Get all the data loaders in an application by service name
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(
@@ -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: Get Default SEO Markup schemas of an application
4493
- * @description: Use this API to get the Default SEO Markup schema Templates setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getDefaultSEOMarkupSchema/).
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 by ID or slug
4573
- * @description: Retrieve detailed information about a specific FAQ. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqByIdOrSlug/).
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: Get FAQ categories
4652
- * @description: Retrieve a list of FAQ categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategories/).
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 by slug or ID
4730
- * @description: Retrieve detailed information about a specific FAQ category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getFaqCategoryBySlugOrId/).
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: Get FAQs by category ID or slug
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(
@@ -4969,7 +4969,7 @@ class Content {
4969
4969
  * @returns {Promise<ContentPlatformModel.LandingPageGetResponse>} - Success response
4970
4970
  * @name getLandingPages
4971
4971
  * @summary: Get landing pages
4972
- * @description: Retrieve a list of landing pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLandingPages/).
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 legal related information for applicaiton
5057
- * @description: Retrieve legal information and terms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getLegalInformation/).
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: {} },
@@ -5301,7 +5301,7 @@ class Content {
5301
5301
  * @returns {Promise<ContentPlatformModel.PageSchema>} - Success response
5302
5302
  * @name getPageBySlug
5303
5303
  * @summary: Get page by slug
5304
- * @description: Retrieve detailed information about a specific page using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageBySlug/).
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: {} },
@@ -5380,7 +5380,7 @@ class Content {
5380
5380
  * @returns {Promise<ContentPlatformModel.PageMetaSchema>} - Success response
5381
5381
  * @name getPageMeta
5382
5382
  * @summary: Get page meta
5383
- * @description: Retrieve metadata for a specific page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageMeta/).
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: {} },
@@ -5455,7 +5455,7 @@ class Content {
5455
5455
  * @returns {Promise<ContentPlatformModel.PageSpec>} - Success response
5456
5456
  * @name getPageSpec
5457
5457
  * @summary: Get page specification
5458
- * @description: Retrieve specifications and details for a specific page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPageSpec/).
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: {} },
@@ -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 path redirection rule
5616
- * @description: Retrieve detailed information about a specific path redirection rule. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRule/).
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: Get path redirection rules
5697
- * @description: Retrieve a list of path redirection rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getPathRedirectionRules/).
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 SEO configuration for an application
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 a particular SEO Markup schema of an application using its id
5859
- * @description: Use this API to get a existing SEO Markup schema an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOMarkupSchema/).
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: Get SEO Markup schemas of an application
5940
- * @description: Use this API to get all SEO Markup schema Templates setup for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSEOMarkupSchemas/).
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 slideshow by slug
6033
- * @description: Use this API to retrieve the details of a slideshow by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSlideshowBySlug/).
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: Get slideshows
6115
- * @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a list of slideshows. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/getSlideshows/).
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: Get slideshows
6208
- * @description: A slideshow is a group of images, videos or a combination of both that are shown on the website in the form of slides. Use this API to fetch a list of slideshows.
6207
+ * @summary: List Slideshows
6208
+ * @description: Use this API to list all Slideshows
6209
6209
  */
6210
6210
  getSlideshowsPaginator({
6211
6211
  companyId,
@@ -6323,7 +6323,7 @@ class Content {
6323
6323
  *
6324
6324
  * @name importAppCustomObjectEntries
6325
6325
  * @summary: Bulk custom object entries upload
6326
- * @description: Use this API to upload custom object entries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/importAppCustomObjectEntries/).
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: {} },
@@ -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: download sample for custom object bulk entry
6573
- * @description: Use this api to get sample csv file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/sampleAppCustomObjectBulkEntry/).
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(
@@ -6898,7 +6898,7 @@ class Content {
6898
6898
  *
6899
6899
  * @name updateAppCustomFieldDefinition
6900
6900
  * @summary: Update custom field definition
6901
- * @description: Use this API to update a custom field definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomFieldDefinition/).
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: Use this API to update a custom object detail for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObject/).
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: Use this API to update a custom object definition for your application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateAppCustomObjectDefinition/).
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(
@@ -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 legal related information for application
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(
@@ -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 rules
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 SEO configuration for an application
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 edit the details of an existing slideshow. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/content/updateSlideshow/).
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 support related info for an application
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(