@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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

@@ -5,234 +5,258 @@ declare class Theme {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.themeId - ID of the theme to be retrieved
-     * @summary: Get all pages of a theme
-     * @description: Use this API to retrieve all the available pages of a theme by its ID.
-     */
-    getAllPages({ themeId }?: {
-        themeId: string;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.themeId - ID of the theme
-     * @param {AvailablePageSchema} arg.body
-     * @summary: Create a page
-     * @description: Use this API to create a page for a theme by its ID.
+     * @param {AddThemeRequestSchema} arg.body
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Add a theme to the theme library
+     * @description: Theme library is a personalized collection of themes that are chosen and added from the available themes. Use this API to choose a theme and add it to the theme library.
      */
-    createPage({ themeId, body }?: {
-        themeId: string;
-        body: AvailablePageSchema;
-    }): Promise<any>;
+    addToThemeLibrary({ body }?: {
+        body: AddThemeRequestSchema;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.themeId - ID of the theme to be retrieved
-     * @param {AllAvailablePageSchema} arg.body
-     * @summary: Update multiple pages of a theme
-     * @description: Use this API to update multiple pages of a theme by its ID.
+     * @param {AddThemeRequestSchema} arg.body
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Apply a theme
+     * @description: Use this API to apply a theme to the website.
      */
-    updateMultiplePages({ themeId, body }?: {
-        themeId: string;
-        body: AllAvailablePageSchema;
-    }): Promise<any>;
+    applyTheme({ body }?: {
+        body: AddThemeRequestSchema;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.themeId - ID of the theme to be retrieved
-     * @param {string} arg.pageValue - Value of the page to be retrieved
-     * @summary: Get page of a theme
-     * @description: Use this API to retrieve a page of a theme.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Archive a theme
+     * @description: Use this API to store an existing theme but not delete it so that it can be used in future if required.
      */
-    getPage({ themeId, pageValue }?: {
+    archiveTheme({ themeId }?: {
         themeId: string;
-        pageValue: string;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID of the theme
-     * @param {string} arg.pageValue - Value of the page to be updated
      * @param {AvailablePageSchema} arg.body
-     * @summary: Updates a page
-     * @description: Use this API to update a page for a theme by its ID.
+     * @returns {Promise<AvailablePageSchema>} - Success response
+     * @summary: Create a page
+     * @description: Use this API to create a page for a theme by its ID.
      */
-    updatePage({ themeId, pageValue, body }?: {
+    createPage({ themeId, body }?: {
         themeId: string;
-        pageValue: string;
         body: AvailablePageSchema;
-    }): Promise<any>;
+    }): Promise<AvailablePageSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {ThemesSchema} arg.body
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Create a new theme
+     * @description: Themes improve the look and appearance of a website. Use this API to create a theme.
+     */
+    createTheme({ body }?: {
+        body: ThemesSchema;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID of the theme
      * @param {string} arg.pageValue - Value of the page to be updated
+     * @returns {Promise<AvailablePageSchema>} - Success response
      * @summary: Deletes a page
      * @description: Use this API to delete a page for a theme by its ID and page_value.
      */
     deletePage({ themeId, pageValue }?: {
         themeId: string;
         pageValue: string;
-    }): Promise<any>;
+    }): Promise<AvailablePageSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @param {number} [arg.pageNo] - The page number to navigate through the
-     *   given set of results. Default value is 1.
-     * @summary: Get a list of themes from the theme library
-     * @description: Theme library is a personalized collection of themes that are chosen and added from the available themes. Use this API to fetch a list of themes from the library along with their configuration details.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Delete a theme
+     * @description: Use this API to delete a theme from the theme library.
      */
-    getThemeLibrary({ pageSize, pageNo }?: {
-        pageSize?: number;
-        pageNo?: number;
-    }): Promise<any>;
+    deleteTheme({ themeId }?: {
+        themeId: string;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {AddThemeRequestSchema} arg.body
-     * @summary: Add a theme to the theme library
-     * @description: Theme library is a personalized collection of themes that are chosen and added from the available themes. Use this API to choose a theme and add it to the theme library.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @returns {Promise<AllAvailablePageSchema>} - Success response
+     * @summary: Get all pages of a theme
+     * @description: Use this API to retrieve all the available pages of a theme by its ID.
      */
-    addToThemeLibrary({ body }?: {
-        body: AddThemeRequestSchema;
-    }): Promise<any>;
+    getAllPages({ themeId }?: {
+        themeId: string;
+    }): Promise<AllAvailablePageSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {AddThemeRequestSchema} arg.body
-     * @summary: Apply a theme
-     * @description: Use this API to apply a theme to the website.
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Get the applied theme
+     * @description: Use this API to retrieve the theme that is currently applied to the website along with its details.
      */
-    applyTheme({ body }?: {
-        body: AddThemeRequestSchema;
-    }): Promise<any>;
+    getAppliedTheme({}?: any): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.themeId - Theme ID
-     * @summary: Checks if theme is upgradable
-     * @description: There's always a possibility that new features get added to a theme. Use this API to check if the applied theme has an upgrade available.
+     * @returns {Promise<FontsSchema>} - Success response
+     * @summary: Get all the supported fonts in a theme
+     * @description: Font is a collection of characters with a similar design. Use this API to retrieve a list of website fonts.
      */
-    isUpgradable({ themeId }?: {
-        themeId: string;
-    }): Promise<any>;
+    getFonts({}?: any): Promise<FontsSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.themeId - ID allotted to the theme.
-     * @summary: Upgrade a theme
-     * @description: Use this API to upgrade the current theme to its latest version.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @param {string} arg.pageValue - Value of the page to be retrieved
+     * @returns {Promise<AvailablePageSchema>} - Success response
+     * @summary: Get page of a theme
+     * @description: Use this API to retrieve a page of a theme.
      */
-    upgradeTheme({ themeId }?: {
+    getPage({ themeId, pageValue }?: {
         themeId: string;
-    }): Promise<any>;
+        pageValue: string;
+    }): Promise<AvailablePageSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each
      *   page. Default value is 10.
      * @param {number} [arg.pageNo] - The page number to navigate through the
      *   given set of results. Default value is 1.
+     * @returns {Promise<ThemesListingResponseSchema>} - Success response
      * @summary: Get all public themes
      * @description: Use this API to get a list of free themes that you can apply to your website.
      */
     getPublicThemes({ pageSize, pageNo }?: {
         pageSize?: number;
         pageNo?: number;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {ThemesSchema} arg.body
-     * @summary: Create a new theme
-     * @description: Themes improve the look and appearance of a website. Use this API to create a theme.
-     */
-    createTheme({ body }?: {
-        body: ThemesSchema;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get the applied theme
-     * @description: Use this API to retrieve the theme that is currently applied to the website along with its details.
-     */
-    getAppliedTheme({}?: any): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @summary: Get all the supported fonts in a theme
-     * @description: Font is a collection of characters with a similar design. Use this API to retrieve a list of website fonts.
-     */
-    getFonts({}?: any): Promise<any>;
+    }): Promise<ThemesListingResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID allotted to the theme.
+     * @returns {Promise<ThemesSchema>} - Success response
      * @summary: Gets theme by id
      * @description: Use this API to retrieve the details of a specific theme by using its ID.
      */
     getThemeById({ themeId }?: {
         themeId: string;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID allotted to the theme.
-     * @param {ThemesSchema} arg.body
-     * @summary: Update a theme
-     * @description: Use this API to edit an existing theme. You can customize the website font, sections, images, styles, and many more.
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Get a theme preview
+     * @description: A theme can be previewed before applying it. Use this API to retrieve the theme preview by using its ID.
      */
-    updateTheme({ themeId, body }?: {
+    getThemeForPreview({ themeId }?: {
         themeId: string;
-        body: ThemesSchema;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID allotted to the theme.
-     * @summary: Delete a theme
-     * @description: Use this API to delete a theme from the theme library.
+     * @returns {Promise<any>} - Success response
+     * @summary: Fetch last modified timestamp
+     * @description: Use this API to fetch Last-Modified timestamp in header metadata.
      */
-    deleteTheme({ themeId }?: {
+    getThemeLastModified({ themeId }?: {
         themeId: string;
     }): Promise<any>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.themeId - ID allotted to the theme.
-     * @summary: Get a theme preview
-     * @description: A theme can be previewed before applying it. Use this API to retrieve the theme preview by using its ID.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 10.
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results. Default value is 1.
+     * @returns {Promise<ThemesListingResponseSchema>} - Success response
+     * @summary: Get a list of themes from the theme library
+     * @description: Theme library is a personalized collection of themes that are chosen and added from the available themes. Use this API to fetch a list of themes from the library along with their configuration details.
      */
-    getThemeForPreview({ themeId }?: {
+    getThemeLibrary({ pageSize, pageNo }?: {
+        pageSize?: number;
+        pageNo?: number;
+    }): Promise<ThemesListingResponseSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - Theme ID
+     * @returns {Promise<UpgradableThemeSchema>} - Success response
+     * @summary: Checks if theme is upgradable
+     * @description: There's always a possibility that new features get added to a theme. Use this API to check if the applied theme has an upgrade available.
+     */
+    isUpgradable({ themeId }?: {
         themeId: string;
-    }): Promise<any>;
+    }): Promise<UpgradableThemeSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID allotted to the theme.
+     * @returns {Promise<ThemesSchema>} - Success response
      * @summary: Publish a theme
      * @description: Use this API to publish a theme that is either newly created or edited.
      */
     publishTheme({ themeId }?: {
         themeId: string;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Unarchive a theme
+     * @description: Use this API to restore an archived theme and bring it back for editing or publishing.
+     */
+    unarchiveTheme({ themeId }?: {
+        themeId: string;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID allotted to the theme.
+     * @returns {Promise<ThemesSchema>} - Success response
      * @summary: Unpublish a theme
      * @description: Use this API to remove an existing theme from the list of available themes.
      */
     unpublishTheme({ themeId }?: {
         themeId: string;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.themeId - ID allotted to the theme.
-     * @summary: Archive a theme
-     * @description: Use this API to store an existing theme but not delete it so that it can be used in future if required.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @param {AllAvailablePageSchema} arg.body
+     * @returns {Promise<AllAvailablePageSchema>} - Success response
+     * @summary: Update multiple pages of a theme
+     * @description: Use this API to update multiple pages of a theme by its ID.
      */
-    archiveTheme({ themeId }?: {
+    updateMultiplePages({ themeId, body }?: {
         themeId: string;
-    }): Promise<any>;
+        body: AllAvailablePageSchema;
+    }): Promise<AllAvailablePageSchema>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme
+     * @param {string} arg.pageValue - Value of the page to be updated
+     * @param {AvailablePageSchema} arg.body
+     * @returns {Promise<AvailablePageSchema>} - Success response
+     * @summary: Updates a page
+     * @description: Use this API to update a page for a theme by its ID.
+     */
+    updatePage({ themeId, pageValue, body }?: {
+        themeId: string;
+        pageValue: string;
+        body: AvailablePageSchema;
+    }): Promise<AvailablePageSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID allotted to the theme.
-     * @summary: Unarchive a theme
-     * @description: Use this API to restore an archived theme and bring it back for editing or publishing.
+     * @param {ThemesSchema} arg.body
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Update a theme
+     * @description: Use this API to edit an existing theme. You can customize the website font, sections, images, styles, and many more.
      */
-    unarchiveTheme({ themeId }?: {
+    updateTheme({ themeId, body }?: {
         themeId: string;
-    }): Promise<any>;
+        body: ThemesSchema;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID allotted to the theme.
-     * @summary: Fetch last modified timestamp
-     * @description: Use this API to fetch Last-Modified timestamp in header metadata.
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Upgrade a theme
+     * @description: Use this API to upgrade the current theme to its latest version.
      */
-    getThemeLastModified({ themeId }?: {
+    upgradeTheme({ themeId }?: {
         themeId: string;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
 }