@gofynd/fdk-client-javascript 1.4.3 → 1.4.5

package/sdk/platform/Share/SharePlatformModel.js

@@ -70,6 +70,7 @@ const Joi = require("joi");
  * @typedef UrlInfo
  * @property {string} [original]
  * @property {string} [hash]
+ * @property {string} [short_url]
  */
 
 /**
@@ -209,6 +210,7 @@ class SharePlatformModel {
     return Joi.object({
       original: Joi.string().allow(""),
       hash: Joi.string().allow(""),
+      short_url: Joi.string().allow(""),
     });
   }
 

package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts

@@ -11,48 +11,28 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name addThemeToApplication
-     * @summary: Add theme to application
-     * @description: Include a theme in an application's design. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addThemeToApplication/).
+     * @summary: Create theme in sales channel
+     * @description: Include a theme in an application drafts from theme collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addThemeToApplication/).
      */
     addThemeToApplication({ body, requestHeaders }?: ThemePlatformApplicationValidator.AddThemeToApplicationParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
-    /**
-     * @param {ThemePlatformApplicationValidator.AddToThemeLibraryParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
-     * @name addToThemeLibrary
-     * @summary: Add to theme library
-     * @description: Store and add a theme to the platform's library. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/addToThemeLibrary/).
-     */
-    addToThemeLibrary({ body, requestHeaders }?: ThemePlatformApplicationValidator.AddToThemeLibraryParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
     /**
      * @param {ThemePlatformApplicationValidator.ApplyThemeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name applyTheme
-     * @summary: Apply theme
-     * @description: Set and apply a theme to an application or page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/applyTheme/).
+     * @summary: Apply a theme
+     * @description: Change current applied theme with new draft theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/applyTheme/).
      */
     applyTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.ApplyThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
-    /**
-     * @param {ThemePlatformApplicationValidator.ArchiveThemeParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
-     * @name archiveTheme
-     * @summary: Archive theme
-     * @description: Store a theme in an archive. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/archiveTheme/).
-     */
-    archiveTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.ArchiveThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
     /**
      * @param {ThemePlatformApplicationValidator.CreatePageParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
      * @name createPage
-     * @summary: Create page
-     * @description: Generate and add a new page to the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/createPage/).
+     * @summary: Create theme page
+     * @description: Generate and add a new page to the selected theme of the Platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/createPage/).
      */
     createPage({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.CreatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
     /**
@@ -61,8 +41,8 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
      * @name deletePage
-     * @summary: Delete page
-     * @description: Remove a page from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deletePage/).
+     * @summary: Delete a page
+     * @description: Remove a page from a theme of the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deletePage/).
      */
     deletePage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.DeletePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
     /**
@@ -72,7 +52,7 @@ declare class Theme {
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name deleteTheme
      * @summary: Delete theme
-     * @description: Remove a theme from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteTheme/).
+     * @description: Remove a theme from theme drafts of a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/deleteTheme/).
      */
     deleteTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DeleteThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
     /**
@@ -81,8 +61,8 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name duplicateTheme
-     * @summary: Duplicate theme
-     * @description: Create a copy of an existing theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/duplicateTheme/).
+     * @summary: Duplicate a theme
+     * @description: Create a new copy of an existing theme by theme Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/duplicateTheme/).
      */
     duplicateTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.DuplicateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
     /**
@@ -91,7 +71,7 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
      * @name getAllPages
-     * @summary: Get all pages
+     * @summary: List pages of a theme
      * @description: Retrieve a list of all available pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAllPages/).
      */
     getAllPages({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetAllPagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
@@ -103,8 +83,8 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.ThemesSchema[]>} - Success response
      * @name getApplicationThemes
-     * @summary: Get application themes
-     * @description: Retrieve themes available for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemes/).
+     * @summary: List sales channel themes
+     * @description: Retrieve all draft themes added to sales channel from theme collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemes/).
      */
     getApplicationThemes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema[]>;
     /**
@@ -115,8 +95,8 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<Object>} - Success response
      * @name getApplicationThemesCount
-     * @summary: Get application themes count
-     * @description: Count the number of themes available for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemesCount/).
+     * @summary: Get sales channel themes count
+     * @description: Retrieve count of all draft themes added to sales channel from theme collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getApplicationThemesCount/).
      */
     getApplicationThemesCount({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
     /**
@@ -126,7 +106,7 @@ declare class Theme {
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name getAppliedTheme
      * @summary: Get applied theme
-     * @description: Retrieve the currently applied theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAppliedTheme/).
+     * @description: Retrieve the currently applied theme of a sales channel using application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getAppliedTheme/).
      */
     getAppliedTheme({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
     /**
@@ -135,8 +115,8 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
      * @name getFonts
-     * @summary: Get fonts
-     * @description: Retrieve a list of available fonts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
+     * @summary: List theme fonts
+     * @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
      */
     getFonts({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
     /**
@@ -145,28 +125,18 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
      * @name getPage
-     * @summary: Get page
-     * @description: Retrieve detailed information about a specific page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getPage/).
+     * @summary: Get a page
+     * @description: Retrieve detailed information about a specific page of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getPage/).
      */
     getPage({ themeId, pageValue, requestHeaders }?: ThemePlatformApplicationValidator.GetPageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
-    /**
-     * @param {ThemePlatformApplicationValidator.GetPublicThemesParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
-     * @name getPublicThemes
-     * @summary: Get public themes
-     * @description: Retrieve themes that are publicly accessible. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getPublicThemes/).
-     */
-    getPublicThemes({ pageSize, pageNo, requestHeaders }?: ThemePlatformApplicationValidator.GetPublicThemesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
     /**
      * @param {ThemePlatformApplicationValidator.GetThemeByIdParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name getThemeById
-     * @summary: Get theme by ID
-     * @description: Retrieve a theme by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeById/).
+     * @summary: Get theme
+     * @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeById/).
      */
     getThemeById({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeByIdParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
     /**
@@ -176,7 +146,7 @@ declare class Theme {
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name getThemeForPreview
      * @summary: Get theme for preview
-     * @description: Retrieve a theme for previewing before application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeForPreview/).
+     * @description: Retrieve a theme by its unique identifier. Response contains theme template data and data stored in theme editor. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeForPreview/).
      */
     getThemeForPreview({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeForPreviewParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
     /**
@@ -187,60 +157,20 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<any>} - Success response
      * @name getThemeLastModified
-     * @summary: Get theme last modified
-     * @description: Retrieve the last modification of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeLastModified/).
+     * @summary: Get theme last modified date
+     * @description: Retrieve the last modification of a theme used for polling and identifing cross user changes in a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeLastModified/).
      */
     getThemeLastModified({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeLastModifiedParam, { responseHeaders }?: object): Promise<any>;
-    /**
-     * @param {ThemePlatformApplicationValidator.GetThemeLibraryParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
-     * @name getThemeLibrary
-     * @summary: Get theme library
-     * @description: Retrieve themes available in the platform's library. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getThemeLibrary/).
-     */
-    getThemeLibrary({ pageSize, pageNo, requestHeaders }?: ThemePlatformApplicationValidator.GetThemeLibraryParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
     /**
      * @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.ThemeUpgradableResponse>} - Success response
      * @name isUpgradable
-     * @summary: Is upgradable
-     * @description: Determine if a theme is eligible for an upgrade. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
+     * @summary: Check theme is upgradable
+     * @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
      */
     isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradableResponse>;
-    /**
-     * @param {ThemePlatformApplicationValidator.PublishThemeParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
-     * @name publishTheme
-     * @summary: Publish theme
-     * @description: Make a theme accessible for use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/publishTheme/).
-     */
-    publishTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.PublishThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
-    /**
-     * @param {ThemePlatformApplicationValidator.UnarchiveThemeParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
-     * @name unarchiveTheme
-     * @summary: Unarchive theme
-     * @description: Retrieve a theme from the archive. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/unarchiveTheme/).
-     */
-    unarchiveTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UnarchiveThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
-    /**
-     * @param {ThemePlatformApplicationValidator.UnpublishThemeParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.DummyResponse>} - Success response
-     * @name unpublishTheme
-     * @summary: Unpublish theme
-     * @description: Remove a published theme from public access. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/unpublishTheme/).
-     */
-    unpublishTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UnpublishThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.DummyResponse>;
     /**
      * @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
      *   - Arg object
@@ -249,8 +179,8 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.AllAvailablePageSchema>} - Success response
      * @name updateMultiplePages
-     * @summary: Update multiple pages
-     * @description: Modify multiple pages simultaneously. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateMultiplePages/).
+     * @summary: Update theme pages
+     * @description: Modify multiple pages simultaneously of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateMultiplePages/).
      */
     updateMultiplePages({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateMultiplePagesParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AllAvailablePageSchema>;
     /**
@@ -259,7 +189,7 @@ declare class Theme {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ThemePlatformModel.AvailablePageSchema>} - Success response
      * @name updatePage
-     * @summary: Update page
+     * @summary: Update a page
      * @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
      */
     updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
@@ -270,7 +200,7 @@ declare class Theme {
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name updateTheme
      * @summary: Update theme
-     * @description: Modify and update the content and settings of a theme - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateTheme/).
+     * @description: Modify and update the content and settings of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateTheme/).
      */
     updateTheme({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
     /**
@@ -280,7 +210,7 @@ declare class Theme {
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name updateThemeName
      * @summary: Update theme name
-     * @description: Modify the name of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateThemeName/).
+     * @description: Modify the name of the draft theme by theme Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updateThemeName/).
      */
     updateThemeName({ themeId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdateThemeNameParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
     /**
@@ -290,7 +220,7 @@ declare class Theme {
      * @returns {Promise<ThemePlatformModel.ThemesSchema>} - Success response
      * @name upgradeTheme
      * @summary: Upgrade theme
-     * @description: Enhance and update a theme to a new version. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/upgradeTheme/).
+     * @description: Update a draft theme to a new version of the marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/upgradeTheme/).
      */
     upgradeTheme({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.UpgradeThemeParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemesSchema>;
 }