@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/application/Share/ShareApplicationClient.js

@@ -3,22 +3,24 @@ const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const ShareValidator = require("./ShareApplicationValidator");
+const ShareModel = require("./ShareApplicationModel");
+const { Logger } = require("./../../common/Logger");
 
 class Share {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
+      createShortLink: "/service/application/share/v1.0/links/short-link/",
       getApplicationQRCode: "/service/application/share/v1.0/qr/",
-      getProductQRCodeBySlug:
-        "/service/application/share/v1.0/qr/products/{slug}/",
       getCollectionQRCodeBySlug:
         "/service/application/share/v1.0/qr/collection/{slug}/",
-      getUrlQRCode: "/service/application/share/v1.0/qr/url/",
-      createShortLink: "/service/application/share/v1.0/links/short-link/",
-      getShortLinkByHash:
-        "/service/application/share/v1.0/links/short-link/{hash}/",
       getOriginalShortLinkByHash:
         "/service/application/share/v1.0/links/short-link/{hash}/original/",
+      getProductQRCodeBySlug:
+        "/service/application/share/v1.0/qr/products/{slug}/",
+      getShortLinkByHash:
+        "/service/application/share/v1.0/links/short-link/{hash}/",
+      getUrlQRCode: "/service/application/share/v1.0/qr/url/",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -38,13 +40,14 @@ class Share {
 
   /**
    * @param {Object} arg - Arg object.
-   * @returns {Promise<QRCodeResp>} - Success response
-   * @summary: Create QR Code of an app
-   * @description: Use this API to create a QR code of an app for sharing it with users who want to use the app.
+   * @param {ShortLinkReq} arg.body
+   * @returns {Promise<ShortLinkRes>} - Success response
+   * @summary: Create a short link
+   * @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs.
    */
-  getApplicationQRCode({} = {}) {
-    const { error } = ShareValidator.getApplicationQRCode().validate(
-      {},
+  async createShortLink({ body } = {}) {
+    const { error } = ShareValidator.createShortLink().validate(
+      { body },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -52,43 +55,59 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.getApplicationQRCode().validate(
-      {},
+    const { error: warrning } = ShareValidator.createShortLink().validate(
+      { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getApplicationQRCode");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for createShortLink",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
-        url: this._urls["getApplicationQRCode"],
+        url: this._urls["createShortLink"],
         params: {},
       }),
       query_params,
-      undefined,
+      body,
       xHeaders
     );
+
+    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.slug - A short, human-readable, URL-friendly
-   *   identifier of a product. You can get slug value from the endpoint.
    * @returns {Promise<QRCodeResp>} - Success response
-   * @summary: Create QR Code of a product
-   * @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
+   * @summary: Create QR Code of an app
+   * @description: Use this API to create a QR code of an app for sharing it with users who want to use the app.
    */
-  getProductQRCodeBySlug({ slug } = {}) {
-    const { error } = ShareValidator.getProductQRCodeBySlug().validate(
-      { slug },
+  async getApplicationQRCode({} = {}) {
+    const { error } = ShareValidator.getApplicationQRCode().validate(
+      {},
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -96,32 +115,48 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = ShareValidator.getProductQRCodeBySlug().validate(
-      { slug },
+    const { error: warrning } = ShareValidator.getApplicationQRCode().validate(
+      {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getProductQRCodeBySlug");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getApplicationQRCode",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
-        url: this._urls["getProductQRCodeBySlug"],
-        params: { slug },
+        url: this._urls["getApplicationQRCode"],
+        params: {},
       }),
       query_params,
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getApplicationQRCode",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -132,7 +167,7 @@ class Share {
    * @summary: Create QR Code of a collection
    * @description: Use this API to create a QR code of a collection of products for sharing it with users who want to view/purchase the collection.
    */
-  getCollectionQRCodeBySlug({ slug } = {}) {
+  async getCollectionQRCodeBySlug({ slug } = {}) {
     const { error } = ShareValidator.getCollectionQRCodeBySlug().validate(
       { slug },
       { abortEarly: false, allowUnknown: true }
@@ -149,17 +184,18 @@ class Share {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log(
-        "Parameter Validation warrnings for getCollectionQRCodeBySlug"
-      );
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getCollectionQRCodeBySlug",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -170,18 +206,34 @@ class Share {
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getCollectionQRCodeBySlug",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.url - A link or a web address
-   * @returns {Promise<QRCodeResp>} - Success response
-   * @summary: Create QR Code of a URL
-   * @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link.
+   * @param {string} arg.hash - A string value used for converting long URL to
+   *   short URL and vice-versa.
+   * @returns {Promise<ShortLinkRes>} - Success response
+   * @summary: Get original link by hash
+   * @description: Use this API to retrieve the original link from a short-link by using a hash value.
    */
-  getUrlQRCode({ url } = {}) {
-    const { error } = ShareValidator.getUrlQRCode().validate(
-      { url },
+  async getOriginalShortLinkByHash({ hash } = {}) {
+    const { error } = ShareValidator.getOriginalShortLinkByHash().validate(
+      { hash },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -189,43 +241,64 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.getUrlQRCode().validate(
-      { url },
+    const {
+      error: warrning,
+    } = ShareValidator.getOriginalShortLinkByHash().validate(
+      { hash },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getUrlQRCode");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message:
+          "Parameter Validation warrnings for getOriginalShortLinkByHash",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["url"] = url;
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
-      "post",
+      "get",
       constructUrl({
-        url: this._urls["getUrlQRCode"],
-        params: {},
+        url: this._urls["getOriginalShortLinkByHash"],
+        params: { hash },
       }),
       query_params,
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getOriginalShortLinkByHash",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {ShortLinkReq} arg.body
-   * @returns {Promise<ShortLinkRes>} - Success response
-   * @summary: Create a short link
-   * @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs.
+   * @param {string} arg.slug - A short, human-readable, URL-friendly
+   *   identifier of a product. You can get slug value from the endpoint.
+   * @returns {Promise<QRCodeResp>} - Success response
+   * @summary: Create QR Code of a product
+   * @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
    */
-  createShortLink({ body } = {}) {
-    const { error } = ShareValidator.createShortLink().validate(
-      { body },
+  async getProductQRCodeBySlug({ slug } = {}) {
+    const { error } = ShareValidator.getProductQRCodeBySlug().validate(
+      { slug },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -233,30 +306,50 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.createShortLink().validate(
-      { body },
+    const {
+      error: warrning,
+    } = ShareValidator.getProductQRCodeBySlug().validate(
+      { slug },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for createShortLink");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getProductQRCodeBySlug",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "post",
       constructUrl({
-        url: this._urls["createShortLink"],
-        params: {},
+        url: this._urls["getProductQRCodeBySlug"],
+        params: { slug },
       }),
       query_params,
-      body,
+      undefined,
       xHeaders
     );
+
+    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getProductQRCodeBySlug",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
@@ -267,7 +360,7 @@ class Share {
    * @summary: Get short link by hash
    * @description: Use this API to get a short link by using a hash value.
    */
-  getShortLinkByHash({ hash } = {}) {
+  async getShortLinkByHash({ hash } = {}) {
     const { error } = ShareValidator.getShortLinkByHash().validate(
       { hash },
       { abortEarly: false, allowUnknown: true }
@@ -282,15 +375,18 @@ class Share {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for getShortLinkByHash");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getShortLinkByHash",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -301,19 +397,33 @@ class Share {
       undefined,
       xHeaders
     );
+
+    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.hash - A string value used for converting long URL to
-   *   short URL and vice-versa.
-   * @returns {Promise<ShortLinkRes>} - Success response
-   * @summary: Get original link by hash
-   * @description: Use this API to retrieve the original link from a short-link by using a hash value.
+   * @param {string} arg.url - A link or a web address
+   * @returns {Promise<QRCodeResp>} - Success response
+   * @summary: Create QR Code of a URL
+   * @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link.
    */
-  getOriginalShortLinkByHash({ hash } = {}) {
-    const { error } = ShareValidator.getOriginalShortLinkByHash().validate(
-      { hash },
+  async getUrlQRCode({ url } = {}) {
+    const { error } = ShareValidator.getUrlQRCode().validate(
+      { url },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -321,34 +431,49 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = ShareValidator.getOriginalShortLinkByHash().validate(
-      { hash },
+    const { error: warrning } = ShareValidator.getUrlQRCode().validate(
+      { url },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log(
-        "Parameter Validation warrnings for getOriginalShortLinkByHash"
-      );
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getUrlQRCode",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["url"] = url;
 
     const xHeaders = {};
 
-    return APIClient.execute(
+    const response = await APIClient.execute(
       this._conf,
-      "get",
+      "post",
       constructUrl({
-        url: this._urls["getOriginalShortLinkByHash"],
-        params: { hash },
+        url: this._urls["getUrlQRCode"],
+        params: {},
       }),
       query_params,
       undefined,
       xHeaders
     );
+
+    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getUrlQRCode",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 }
 

package/sdk/application/Share/ShareApplicationModel.d.ts

@@ -1,16 +1,16 @@
 export = ShareModel;
 declare class ShareModel {
+    static Attribution(): any;
+    static CampaignShortLink(): any;
+    static ErrorRes(): any;
+    static Page(): any;
     static QRCodeResp(): 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;
 }