@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/platform/Share/SharePlatformApplicationClient.js

@@ -1,8 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
-const ShareValidator = require("./SharePlatformApplicationValidator");
-const ShareModel = require("./SharePlatformModel");
+const SharePlatformApplicationValidator = require("./SharePlatformApplicationValidator");
+const SharePlatformModel = require("./SharePlatformModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -13,14 +13,17 @@ class Share {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {ShortLinkReq} arg.body
-   * @returns {Promise<ShortLinkRes>} - Success response
+   * @param {SharePlatformApplicationValidator.CreateShortLinkParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
+   * @name createShortLink
    * @summary: Create short link
-   * @description: Create short link
+   * @description: Create short link - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
    */
-  async createShortLink({ body } = {}) {
-    const { error } = ShareValidator.createShortLink().validate(
+  async createShortLink({ body } = {}, { headers } = { headers: false }) {
+    const {
+      error,
+    } = SharePlatformApplicationValidator.createShortLink().validate(
       {
         body,
       },
@@ -31,7 +34,9 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.createShortLink().validate(
+    const {
+      error: warrning,
+    } = SharePlatformApplicationValidator.createShortLink().validate(
       {
         body,
       },
@@ -40,9 +45,8 @@ class Share {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createShortLink",
+        message: `Parameter Validation warrnings for platform > Share > createShortLink \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -52,10 +56,19 @@ class Share {
       "post",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
       query_params,
-      body
+      body,
+      undefined,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = SharePlatformModel.ShortLinkRes().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -63,23 +76,25 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createShortLink",
+        message: `Response Validation Warnnings for platform > Share > createShortLink \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.hash - Hash of short url
-   * @returns {Promise<ShortLinkRes>} - Success response
+   * @param {SharePlatformApplicationValidator.GetShortLinkByHashParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
+   * @name getShortLinkByHash
    * @summary: Get short link by hash
-   * @description: Get short link by hash
+   * @description: Get short link by hash - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
    */
-  async getShortLinkByHash({ hash } = {}) {
-    const { error } = ShareValidator.getShortLinkByHash().validate(
+  async getShortLinkByHash({ hash } = {}, { headers } = { headers: false }) {
+    const {
+      error,
+    } = SharePlatformApplicationValidator.getShortLinkByHash().validate(
       {
         hash,
       },
@@ -90,7 +105,9 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.getShortLinkByHash().validate(
+    const {
+      error: warrning,
+    } = SharePlatformApplicationValidator.getShortLinkByHash().validate(
       {
         hash,
       },
@@ -99,9 +116,8 @@ class Share {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getShortLinkByHash",
+        message: `Parameter Validation warrnings for platform > Share > getShortLinkByHash \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -111,10 +127,19 @@ class Share {
       "get",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
       query_params,
-      undefined
+      undefined,
+      undefined,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = SharePlatformModel.ShortLinkRes().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -122,24 +147,30 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getShortLinkByHash",
+        message: `Response Validation Warnnings for platform > Share > getShortLinkByHash \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.surlId - Short link ID for which click statistics are
-   *   to be retrieved.
-   * @returns {Promise<ClickStatsResponse>} - Success response
+   * @param {SharePlatformApplicationValidator.GetShortLinkClickStatsParam} arg
+   *   - Arg object
+   *
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<SharePlatformModel.ClickStatsResponse>} - Success response
+   * @name getShortLinkClickStats
    * @summary: Get click statistics for a short link
-   * @description: Retrieve click statistics for a given short link ID.
+   * @description: Retrieve click statistics for a given short link ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
    */
-  async getShortLinkClickStats({ surlId } = {}) {
-    const { error } = ShareValidator.getShortLinkClickStats().validate(
+  async getShortLinkClickStats(
+    { surlId } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = SharePlatformApplicationValidator.getShortLinkClickStats().validate(
       { surlId },
       { abortEarly: false, allowUnknown: true }
     );
@@ -150,16 +181,15 @@ class Share {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = ShareValidator.getShortLinkClickStats().validate(
+    } = SharePlatformApplicationValidator.getShortLinkClickStats().validate(
       { surlId },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getShortLinkClickStats",
+        message: `Parameter Validation warrnings for platform > Share > getShortLinkClickStats \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -170,12 +200,19 @@ class Share {
       "get",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/click-stats`,
       query_params,
-      undefined
+      undefined,
+      undefined,
+      { headers }
     );
 
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = ShareModel.ClickStatsResponse().validate(response, {
+    } = SharePlatformModel.ClickStatsResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -183,27 +220,28 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getShortLinkClickStats",
+        message: `Response Validation Warnnings for platform > Share > getShortLinkClickStats \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {number} [arg.pageNo] - Current page number
-   * @param {number} [arg.pageSize] - Current page size
-   * @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
+   * @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
+   * @name getShortLinks
    * @summary: Get short links
-   * @description: Get short links
+   * @description: Get short links - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
    */
-  async getShortLinks({ pageNo, pageSize, createdBy, active, q } = {}) {
-    const { error } = ShareValidator.getShortLinks().validate(
+  async getShortLinks(
+    { pageNo, pageSize, createdBy, active, q } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = SharePlatformApplicationValidator.getShortLinks().validate(
       {
         pageNo,
         pageSize,
@@ -218,7 +256,9 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.getShortLinks().validate(
+    const {
+      error: warrning,
+    } = SharePlatformApplicationValidator.getShortLinks().validate(
       {
         pageNo,
         pageSize,
@@ -231,9 +271,8 @@ class Share {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getShortLinks",
+        message: `Parameter Validation warrnings for platform > Share > getShortLinks \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -248,10 +287,19 @@ class Share {
       "get",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
       query_params,
-      undefined
+      undefined,
+      undefined,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.ShortLinkList().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = SharePlatformModel.ShortLinkList().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -259,9 +307,8 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getShortLinks",
+        message: `Response Validation Warnnings for platform > Share > getShortLinks \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
@@ -275,6 +322,7 @@ 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 {Paginator<SharePlatformModel.ShortLinkList>}
    * @summary: Get short links
    * @description: Get short links
    */
@@ -311,15 +359,22 @@ class Share {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.id - Short link document identifier
-   * @param {ShortLinkReq} arg.body
-   * @returns {Promise<ShortLinkRes>} - Success response
+   * @param {SharePlatformApplicationValidator.UpdateShortLinkByIdParam} arg
+   *   - Arg object
+   *
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
+   * @name updateShortLinkById
    * @summary: Update short link by id
-   * @description: Update short link by id
+   * @description: Update short link by id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
    */
-  async updateShortLinkById({ id, body } = {}) {
-    const { error } = ShareValidator.updateShortLinkById().validate(
+  async updateShortLinkById(
+    { id, body } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = SharePlatformApplicationValidator.updateShortLinkById().validate(
       {
         id,
         body,
@@ -331,7 +386,9 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.updateShortLinkById().validate(
+    const {
+      error: warrning,
+    } = SharePlatformApplicationValidator.updateShortLinkById().validate(
       {
         id,
         body,
@@ -341,9 +398,8 @@ class Share {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for updateShortLinkById",
+        message: `Parameter Validation warrnings for platform > Share > updateShortLinkById \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -353,10 +409,19 @@ class Share {
       "patch",
       `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
       query_params,
-      body
+      body,
+      undefined,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = SharePlatformModel.ShortLinkRes().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -364,9 +429,8 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for updateShortLinkById",
+        message: `Response Validation Warnnings for platform > Share > updateShortLinkById \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;

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

@@ -1,8 +1,88 @@
-export = ShareValidator;
-declare class ShareValidator {
-    static createShortLink(): any;
-    static getShortLinkByHash(): any;
-    static getShortLinkClickStats(): any;
-    static getShortLinks(): any;
-    static updateShortLinkById(): any;
+export = SharePlatformApplicationValidator;
+/**
+ * @typedef CreateShortLinkParam
+ * @property {SharePlatformModel.ShortLinkReq} body
+ */
+/**
+ * @typedef GetShortLinkByHashParam
+ * @property {string} hash - Hash of short url
+ */
+/**
+ * @typedef GetShortLinkClickStatsParam
+ * @property {string} surlId - Short link ID for which click statistics are to
+ *   be retrieved.
+ */
+/**
+ * @typedef GetShortLinksParam
+ * @property {number} [pageNo] - Current page number
+ * @property {number} [pageSize] - Current page size
+ * @property {string} [createdBy] - Short link creator
+ * @property {string} [active] - Short link active status
+ * @property {string} [q] - Search text for original and short url
+ */
+/**
+ * @typedef UpdateShortLinkByIdParam
+ * @property {string} id - Short link document identifier
+ * @property {SharePlatformModel.ShortLinkReq} body
+ */
+declare class SharePlatformApplicationValidator {
+    /** @returns {CreateShortLinkParam} */
+    static createShortLink(): CreateShortLinkParam;
+    /** @returns {GetShortLinkByHashParam} */
+    static getShortLinkByHash(): GetShortLinkByHashParam;
+    /** @returns {GetShortLinkClickStatsParam} */
+    static getShortLinkClickStats(): GetShortLinkClickStatsParam;
+    /** @returns {GetShortLinksParam} */
+    static getShortLinks(): GetShortLinksParam;
+    /** @returns {UpdateShortLinkByIdParam} */
+    static updateShortLinkById(): UpdateShortLinkByIdParam;
 }
+declare namespace SharePlatformApplicationValidator {
+    export { CreateShortLinkParam, GetShortLinkByHashParam, GetShortLinkClickStatsParam, GetShortLinksParam, UpdateShortLinkByIdParam };
+}
+type CreateShortLinkParam = {
+    body: SharePlatformModel.ShortLinkReq;
+};
+type GetShortLinkByHashParam = {
+    /**
+     * - Hash of short url
+     */
+    hash: string;
+};
+type GetShortLinkClickStatsParam = {
+    /**
+     * - Short link ID for which click statistics are to
+     * be retrieved.
+     */
+    surlId: string;
+};
+type GetShortLinksParam = {
+    /**
+     * - Current page number
+     */
+    pageNo?: number;
+    /**
+     * - Current page size
+     */
+    pageSize?: number;
+    /**
+     * - Short link creator
+     */
+    createdBy?: string;
+    /**
+     * - Short link active status
+     */
+    active?: string;
+    /**
+     * - Search text for original and short url
+     */
+    q?: string;
+};
+type UpdateShortLinkByIdParam = {
+    /**
+     * - Short link document identifier
+     */
+    id: string;
+    body: SharePlatformModel.ShortLinkReq;
+};
+import SharePlatformModel = require("./SharePlatformModel");

package/sdk/platform/Share/SharePlatformApplicationValidator.js

@@ -1,25 +1,61 @@
 const Joi = require("joi");
 
-const ShareModel = require("./SharePlatformModel");
-class ShareValidator {
+const SharePlatformModel = require("./SharePlatformModel");
+
+/**
+ * @typedef CreateShortLinkParam
+ * @property {SharePlatformModel.ShortLinkReq} body
+ */
+
+/**
+ * @typedef GetShortLinkByHashParam
+ * @property {string} hash - Hash of short url
+ */
+
+/**
+ * @typedef GetShortLinkClickStatsParam
+ * @property {string} surlId - Short link ID for which click statistics are to
+ *   be retrieved.
+ */
+
+/**
+ * @typedef GetShortLinksParam
+ * @property {number} [pageNo] - Current page number
+ * @property {number} [pageSize] - Current page size
+ * @property {string} [createdBy] - Short link creator
+ * @property {string} [active] - Short link active status
+ * @property {string} [q] - Search text for original and short url
+ */
+
+/**
+ * @typedef UpdateShortLinkByIdParam
+ * @property {string} id - Short link document identifier
+ * @property {SharePlatformModel.ShortLinkReq} body
+ */
+
+class SharePlatformApplicationValidator {
+  /** @returns {CreateShortLinkParam} */
   static createShortLink() {
     return Joi.object({
-      body: ShareModel.ShortLinkReq().required(),
+      body: SharePlatformModel.ShortLinkReq().required(),
     }).required();
   }
 
+  /** @returns {GetShortLinkByHashParam} */
   static getShortLinkByHash() {
     return Joi.object({
       hash: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetShortLinkClickStatsParam} */
   static getShortLinkClickStats() {
     return Joi.object({
       surlId: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetShortLinksParam} */
   static getShortLinks() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -30,12 +66,13 @@ class ShareValidator {
     }).required();
   }
 
+  /** @returns {UpdateShortLinkByIdParam} */
   static updateShortLinkById() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: ShareModel.ShortLinkReq().required(),
+      body: SharePlatformModel.ShortLinkReq().required(),
     }).required();
   }
 }
 
-module.exports = ShareValidator;
+module.exports = SharePlatformApplicationValidator;