@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

package/sdk/platform/Share/SharePlatformApplicationClient.d.ts

@@ -6,12 +6,13 @@ declare class Share {
     /**
      * @param {Object} arg - Arg object.
      * @param {ShortLinkReq} arg.body
+     * @returns {Promise<ShortLinkRes>} - Success response
      * @summary: Create short link
      * @description: Create short link
      */
     createShortLink({ body }?: {
         body: ShortLinkReq;
-    }): Promise<any>;
+    }): Promise<ShortLinkRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page number
@@ -19,6 +20,7 @@ declare class Share {
      * @param {string} [arg.createdBy] - Short link creator
      * @param {string} [arg.active] - Short link active status
      * @param {string} [arg.q] - Search text for original and short url
+     * @returns {Promise<ShortLinkList>} - Success response
      * @summary: Get short links
      * @description: Get short links
      */
@@ -28,7 +30,7 @@ declare class Share {
         createdBy?: string;
         active?: string;
         q?: string;
-    }): Promise<any>;
+    }): Promise<ShortLinkList>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Company Id
@@ -51,22 +53,24 @@ declare class Share {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.hash - Hash of short url
+     * @returns {Promise<ShortLinkRes>} - Success response
      * @summary: Get short link by hash
      * @description: Get short link by hash
      */
     getShortLinkByHash({ hash }?: {
         hash: string;
-    }): Promise<any>;
+    }): Promise<ShortLinkRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.id - Short link document identifier
      * @param {ShortLinkReq} arg.body
+     * @returns {Promise<ShortLinkRes>} - Success response
      * @summary: Update short link by id
      * @description: Update short link by id
      */
     updateShortLinkById({ id, body }?: {
         id: string;
         body: ShortLinkReq;
-    }): Promise<any>;
+    }): Promise<ShortLinkRes>;
 }
 import Paginator = require("../../common/Paginator");

package/sdk/platform/Share/SharePlatformApplicationClient.js

@@ -2,6 +2,8 @@ const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const ShareValidator = require("./SharePlatformApplicationValidator");
+const ShareModel = require("./SharePlatformModel");
+const { Logger } = require("./../../common/Logger");
 
 class Share {
   constructor(config, applicationId) {
@@ -12,10 +14,11 @@ class Share {
   /**
    * @param {Object} arg - Arg object.
    * @param {ShortLinkReq} arg.body
+   * @returns {Promise<ShortLinkRes>} - Success response
    * @summary: Create short link
    * @description: Create short link
    */
-  createShortLink({ body } = {}) {
+  async createShortLink({ body } = {}) {
     const { error } = ShareValidator.createShortLink().validate(
       {
         body,
@@ -26,15 +29,45 @@ class Share {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ShareValidator.createShortLink().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createShortLink",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
       query_params,
       body
     );
+
+    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for createShortLink",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -44,10 +77,11 @@ class Share {
    * @param {string} [arg.createdBy] - Short link creator
    * @param {string} [arg.active] - Short link active status
    * @param {string} [arg.q] - Search text for original and short url
+   * @returns {Promise<ShortLinkList>} - Success response
    * @summary: Get short links
    * @description: Get short links
    */
-  getShortLinks({ pageNo, pageSize, createdBy, active, q } = {}) {
+  async getShortLinks({ pageNo, pageSize, createdBy, active, q } = {}) {
     const { error } = ShareValidator.getShortLinks().validate(
       {
         pageNo,
@@ -62,6 +96,25 @@ class Share {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ShareValidator.getShortLinks().validate(
+      {
+        pageNo,
+        pageSize,
+        createdBy,
+        active,
+        q,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getShortLinks",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
@@ -69,13 +122,28 @@ class Share {
     query_params["active"] = active;
     query_params["q"] = q;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
       query_params,
       undefined
     );
+
+    const { error: res_error } = ShareModel.ShortLinkList().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getShortLinks",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -124,10 +192,11 @@ class Share {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.hash - Hash of short url
+   * @returns {Promise<ShortLinkRes>} - Success response
    * @summary: Get short link by hash
    * @description: Get short link by hash
    */
-  getShortLinkByHash({ hash } = {}) {
+  async getShortLinkByHash({ hash } = {}) {
     const { error } = ShareValidator.getShortLinkByHash().validate(
       {
         hash,
@@ -138,25 +207,56 @@ class Share {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ShareValidator.getShortLinkByHash().validate(
+      {
+        hash,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getShortLinkByHash",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
       query_params,
       undefined
     );
+
+    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getShortLinkByHash",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.id - Short link document identifier
    * @param {ShortLinkReq} arg.body
+   * @returns {Promise<ShortLinkRes>} - Success response
    * @summary: Update short link by id
    * @description: Update short link by id
    */
-  updateShortLinkById({ id, body } = {}) {
+  async updateShortLinkById({ id, body } = {}) {
     const { error } = ShareValidator.updateShortLinkById().validate(
       {
         id,
@@ -168,15 +268,46 @@ class Share {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ShareValidator.updateShortLinkById().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for updateShortLinkById",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "patch",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
       query_params,
       body
     );
+
+    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for updateShortLinkById",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 module.exports = Share;

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

@@ -6,50 +6,55 @@ declare class Theme {
     /**
      * @param {Object} arg - Arg object.
      * @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.
      */
     getAllPages({ themeId }?: {
         themeId: string;
-    }): Promise<any>;
+    }): Promise<AllAvailablePageSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID of the theme
      * @param {AvailablePageSchema} arg.body
+     * @returns {Promise<AvailablePageSchema>} - Success response
      * @summary: Create a page
      * @description: Use this API to create a page for a theme by its ID.
      */
     createPage({ themeId, body }?: {
         themeId: string;
         body: AvailablePageSchema;
-    }): Promise<any>;
+    }): Promise<AvailablePageSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @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.
      */
     updateMultiplePages({ themeId, body }?: {
         themeId: string;
         body: AllAvailablePageSchema;
-    }): Promise<any>;
+    }): Promise<AllAvailablePageSchema>;
     /**
      * @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
+     * @returns {Promise<AvailablePageSchema>} - Success response
      * @summary: Get page of a theme
      * @description: Use this API to retrieve a page of a theme.
      */
     getPage({ themeId, pageValue }?: {
         themeId: string;
         pageValue: string;
-    }): Promise<any>;
+    }): Promise<AvailablePageSchema>;
     /**
      * @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.
      */
@@ -57,178 +62,197 @@ declare class Theme {
         themeId: string;
         pageValue: string;
         body: AvailablePageSchema;
-    }): Promise<any>;
+    }): Promise<AvailablePageSchema>;
     /**
      * @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.
+     * @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.
      */
     getThemeLibrary({ pageSize, pageNo }?: {
         pageSize?: number;
         pageNo?: number;
-    }): Promise<any>;
+    }): Promise<ThemesListingResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @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.
      */
     addToThemeLibrary({ body }?: {
         body: AddThemeRequestSchema;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {AddThemeRequestSchema} arg.body
+     * @returns {Promise<ThemesSchema>} - Success response
      * @summary: Apply a theme
      * @description: Use this API to apply a theme to the website.
      */
     applyTheme({ body }?: {
         body: AddThemeRequestSchema;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @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: Upgrade a theme
      * @description: Use this API to upgrade the current theme to its latest version.
      */
     upgradeTheme({ themeId }?: {
         themeId: string;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @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>;
+    }): Promise<ThemesListingResponseSchema>;
     /**
      * @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<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
+     * @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.
      */
-    getAppliedTheme({}?: any): Promise<any>;
+    getAppliedTheme({}?: any): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
+     * @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.
      */
-    getFonts({}?: any): Promise<any>;
+    getFonts({}?: any): Promise<FontsSchema>;
     /**
      * @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
+     * @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.
      */
     updateTheme({ themeId, body }?: {
         themeId: string;
         body: ThemesSchema;
-    }): Promise<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @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.
      */
     deleteTheme({ 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: 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.
      */
     getThemeForPreview({ 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: 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: 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.
+     * @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.
      */
     archiveTheme({ 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<any>;
+    }): Promise<ThemesSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.themeId - ID allotted to the theme.
+     * @returns {Promise<any>} - Success response
      * @summary: Fetch last modified timestamp
      * @description: Use this API to fetch Last-Modified timestamp in header metadata.
      */