@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

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,
@@ -34,19 +37,96 @@ class Share {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for createShortLink");
-      console.log(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;
+  }
+
+  /**
+   * @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
+   */
+  async getShortLinkByHash({ hash } = {}) {
+    const { error } = ShareValidator.getShortLinkByHash().validate(
+      {
+        hash,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      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 = {};
+
+    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;
   }
 
   /**
@@ -56,10 +136,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,
@@ -86,8 +167,11 @@ class Share {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getShortLinks");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getShortLinks",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -97,13 +181,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;
   }
 
   /**
@@ -149,54 +248,15 @@ class Share {
     return paginator;
   }
 
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.hash - Hash of short url
-   * @summary: Get short link by hash
-   * @description: Get short link by hash
-   */
-  getShortLinkByHash({ hash } = {}) {
-    const { error } = ShareValidator.getShortLinkByHash().validate(
-      {
-        hash,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      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) {
-      console.log("Parameter Validation warrnings for getShortLinkByHash");
-      console.log(warrning);
-    }
-
-    const query_params = {};
-
-    return PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
-      query_params,
-      undefined
-    );
-  }
-
   /**
    * @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,
@@ -217,19 +277,37 @@ class Share {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for updateShortLinkById");
-      console.log(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/Share/SharePlatformApplicationValidator.d.ts

@@ -1,7 +1,7 @@
 export = ShareValidator;
 declare class ShareValidator {
     static createShortLink(): any;
-    static getShortLinks(): any;
     static getShortLinkByHash(): any;
+    static getShortLinks(): any;
     static updateShortLinkById(): any;
 }

package/sdk/platform/Share/SharePlatformApplicationValidator.js

@@ -8,6 +8,12 @@ class ShareValidator {
     }).required();
   }
 
+  static getShortLinkByHash() {
+    return Joi.object({
+      hash: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static getShortLinks() {
     return Joi.object({
       pageNo: Joi.number(),
@@ -18,12 +24,6 @@ class ShareValidator {
     }).required();
   }
 
-  static getShortLinkByHash() {
-    return Joi.object({
-      hash: Joi.string().allow("").required(),
-    }).required();
-  }
-
   static updateShortLinkById() {
     return Joi.object({
       id: Joi.string().allow("").required(),

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

@@ -1,15 +1,15 @@
 export = ShareModel;
 declare class ShareModel {
+    static Attribution(): any;
+    static CampaignShortLink(): any;
+    static ErrorRes(): any;
+    static Page(): any;
     static RedirectDevice(): any;
-    static WebRedirect(): any;
     static Redirects(): any;
-    static CampaignShortLink(): any;
-    static Attribution(): any;
-    static SocialMediaTags(): any;
+    static ShortLinkList(): any;
     static ShortLinkReq(): any;
-    static UrlInfo(): any;
     static ShortLinkRes(): any;
-    static Page(): any;
-    static ShortLinkList(): any;
-    static ErrorRes(): any;
+    static SocialMediaTags(): any;
+    static UrlInfo(): any;
+    static WebRedirect(): any;
 }

package/sdk/platform/Share/SharePlatformModel.js

@@ -1,169 +1,111 @@
 const Joi = require("joi");
 
 class ShareModel {
-  static RedirectDevice() {
+  static Attribution() {
     return Joi.object({
-      link: Joi.string().allow(""),
-
-      type: Joi.string().allow(""),
+      campaign_cookie_expiry: Joi.string().allow(""),
     });
   }
-
-  static WebRedirect() {
+  static CampaignShortLink() {
     return Joi.object({
-      link: Joi.string().allow(""),
-
-      type: Joi.string().allow(""),
+      medium: Joi.string().allow(""),
+      source: Joi.string().allow(""),
     });
   }
-
-  static Redirects() {
+  static ErrorRes() {
     return Joi.object({
-      ios: ShareModel.RedirectDevice(),
-
-      android: ShareModel.RedirectDevice(),
-
-      web: ShareModel.WebRedirect(),
-
-      force_web: Joi.boolean(),
+      message: Joi.string().allow(""),
     });
   }
-
-  static CampaignShortLink() {
+  static Page() {
     return Joi.object({
-      source: Joi.string().allow(""),
-
-      medium: Joi.string().allow(""),
+      current: Joi.number(),
+      has_next: Joi.boolean(),
+      has_previous: Joi.boolean(),
+      item_total: Joi.number(),
+      next_id: Joi.string().allow(""),
+      size: Joi.number(),
+      type: Joi.string().allow("").required(),
     });
   }
-
-  static Attribution() {
+  static RedirectDevice() {
     return Joi.object({
-      campaign_cookie_expiry: Joi.string().allow(""),
+      link: Joi.string().allow(""),
+      type: Joi.string().allow(""),
     });
   }
-
-  static SocialMediaTags() {
+  static Redirects() {
     return Joi.object({
-      title: Joi.string().allow(""),
-
-      description: Joi.string().allow(""),
-
-      image: Joi.string().allow(""),
+      android: ShareModel.RedirectDevice(),
+      force_web: Joi.boolean(),
+      ios: ShareModel.RedirectDevice(),
+      web: ShareModel.WebRedirect(),
+    });
+  }
+  static ShortLinkList() {
+    return Joi.object({
+      items: Joi.array().items(ShareModel.ShortLinkRes()),
+      page: ShareModel.Page(),
     });
   }
-
   static ShortLinkReq() {
     return Joi.object({
-      title: Joi.string().allow("").required(),
-
-      url: Joi.string().allow("").required(),
-
-      hash: Joi.string().allow(""),
-
       active: Joi.boolean(),
-
-      expire_at: Joi.string().allow(""),
-
+      attribution: ShareModel.Attribution(),
+      campaign: ShareModel.CampaignShortLink(),
+      count: Joi.number(),
       enable_tracking: Joi.boolean(),
-
+      expire_at: Joi.string().allow(""),
+      hash: Joi.string().allow(""),
       personalized: Joi.boolean(),
-
-      campaign: ShareModel.CampaignShortLink(),
-
       redirects: ShareModel.Redirects(),
-
-      attribution: ShareModel.Attribution(),
-
       social_media_tags: ShareModel.SocialMediaTags(),
-
-      count: Joi.number(),
-    });
-  }
-
-  static UrlInfo() {
-    return Joi.object({
-      original: Joi.string().allow(""),
-
-      short: Joi.string().allow(""),
-
-      hash: Joi.string().allow(""),
+      title: Joi.string().allow("").required(),
+      url: Joi.string().allow("").required(),
     });
   }
-
   static ShortLinkRes() {
     return Joi.object({
-      title: Joi.string().allow(""),
-
-      url: ShareModel.UrlInfo(),
-
-      created_by: Joi.string().allow(""),
-
-      app_redirect: Joi.boolean(),
-
-      fallback: Joi.string().allow(""),
-
-      active: Joi.boolean(),
-
       _id: Joi.string().allow(""),
-
-      enable_tracking: Joi.boolean(),
-
-      expire_at: Joi.string().allow(""),
-
+      active: Joi.boolean(),
+      app_redirect: Joi.boolean(),
       application: Joi.string().allow(""),
-
-      user_id: Joi.string().allow(""),
-
+      attribution: ShareModel.Attribution(),
+      campaign: ShareModel.CampaignShortLink(),
+      count: Joi.number(),
       created_at: Joi.string().allow(""),
-
+      created_by: Joi.string().allow(""),
+      enable_tracking: Joi.boolean(),
+      expire_at: Joi.string().allow(""),
+      fallback: Joi.string().allow(""),
       meta: Joi.any(),
-
-      updated_at: Joi.string().allow(""),
-
       personalized: Joi.boolean(),
-
-      campaign: ShareModel.CampaignShortLink(),
-
       redirects: ShareModel.Redirects(),
-
-      attribution: ShareModel.Attribution(),
-
       social_media_tags: ShareModel.SocialMediaTags(),
-
-      count: Joi.number(),
+      title: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+      url: ShareModel.UrlInfo(),
+      user_id: Joi.string().allow(""),
     });
   }
-
-  static Page() {
+  static SocialMediaTags() {
     return Joi.object({
-      item_total: Joi.number(),
-
-      next_id: Joi.string().allow(""),
-
-      has_previous: Joi.boolean(),
-
-      has_next: Joi.boolean(),
-
-      current: Joi.number(),
-
-      type: Joi.string().allow("").required(),
-
-      size: Joi.number(),
+      description: Joi.string().allow(""),
+      image: Joi.string().allow(""),
+      title: Joi.string().allow(""),
     });
   }
-
-  static ShortLinkList() {
+  static UrlInfo() {
     return Joi.object({
-      items: Joi.array().items(ShareModel.ShortLinkRes()),
-
-      page: ShareModel.Page(),
+      hash: Joi.string().allow(""),
+      original: Joi.string().allow(""),
+      short: Joi.string().allow(""),
     });
   }
-
-  static ErrorRes() {
+  static WebRedirect() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      link: Joi.string().allow(""),
+      type: Joi.string().allow(""),
     });
   }
 }