@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/Share/ShareApplicationClient.js

@@ -2,8 +2,8 @@ const ApplicationAPIClient = require("../ApplicationAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const ShareValidator = require("./ShareApplicationValidator");
-const ShareModel = require("./ShareApplicationModel");
+const ShareApplicationValidator = require("./ShareApplicationValidator");
+const ShareApplicationModel = require("./ShareApplicationModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -40,14 +40,15 @@ class Share {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {ShortLinkReq} arg.body
-   * @returns {Promise<ShortLinkRes>} - Success response
+   * @param {ShareApplicationValidator.CreateShortLinkParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
+   * @name createShortLink
    * @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.
+   * @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/createShortLink/).
    */
-  async createShortLink({ body } = {}) {
-    const { error } = ShareValidator.createShortLink().validate(
+  async createShortLink({ body } = {}, { headers } = { headers: false }) {
+    const { error } = ShareApplicationValidator.createShortLink().validate(
       { body },
       { abortEarly: false, allowUnknown: true }
     );
@@ -56,16 +57,17 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.createShortLink().validate(
+    const {
+      error: warrning,
+    } = ShareApplicationValidator.createShortLink().validate(
       { body },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createShortLink",
+        message: `Parameter Validation warrnings for application > Share > createShortLink \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -81,10 +83,18 @@ class Share {
       }),
       query_params,
       body,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ShareApplicationModel.ShortLinkRes().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -92,22 +102,22 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createShortLink",
+        message: `Response Validation Warnnings for application > Share > createShortLink \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @returns {Promise<QRCodeResp>} - Success response
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
+   * @name getApplicationQRCode
    * @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.
+   * @description: Use this API to create a QR code of an app for sharing it with users who want to use the app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getApplicationQRCode/).
    */
-  async getApplicationQRCode({} = {}) {
-    const { error } = ShareValidator.getApplicationQRCode().validate(
+  async getApplicationQRCode({ headers } = { headers: false }) {
+    const { error } = ShareApplicationValidator.getApplicationQRCode().validate(
       {},
       { abortEarly: false, allowUnknown: true }
     );
@@ -116,16 +126,17 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.getApplicationQRCode().validate(
+    const {
+      error: warrning,
+    } = ShareApplicationValidator.getApplicationQRCode().validate(
       {},
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getApplicationQRCode",
+        message: `Parameter Validation warrnings for application > Share > getApplicationQRCode \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -141,10 +152,18 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ShareApplicationModel.QRCodeResp().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -152,24 +171,28 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getApplicationQRCode",
+        message: `Response Validation Warnnings for application > Share > getApplicationQRCode \n ${res_error}`,
       });
-      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 collection. You can get slug value from the endpoint.
-   * @returns {Promise<QRCodeResp>} - Success response
+   * @param {ShareApplicationValidator.GetCollectionQRCodeBySlugParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
+   * @name getCollectionQRCodeBySlug
    * @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.
+   * @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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getCollectionQRCodeBySlug/).
    */
-  async getCollectionQRCodeBySlug({ slug } = {}) {
-    const { error } = ShareValidator.getCollectionQRCodeBySlug().validate(
+  async getCollectionQRCodeBySlug(
+    { slug } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = ShareApplicationValidator.getCollectionQRCodeBySlug().validate(
       { slug },
       { abortEarly: false, allowUnknown: true }
     );
@@ -180,16 +203,15 @@ class Share {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = ShareValidator.getCollectionQRCodeBySlug().validate(
+    } = ShareApplicationValidator.getCollectionQRCodeBySlug().validate(
       { slug },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getCollectionQRCodeBySlug",
+        message: `Parameter Validation warrnings for application > Share > getCollectionQRCodeBySlug \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -205,10 +227,18 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ShareApplicationModel.QRCodeResp().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -216,24 +246,29 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getCollectionQRCodeBySlug",
+        message: `Response Validation Warnnings for application > Share > getCollectionQRCodeBySlug \n ${res_error}`,
       });
-      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
+   * @param {ShareApplicationValidator.GetOriginalShortLinkByHashParam} arg -
+   *   Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
+   * @name getOriginalShortLinkByHash
    * @summary: Get original link by hash
-   * @description: Use this API to retrieve the original link from a short-link by using a hash value.
+   * @description: Use this API to retrieve the original link from a short-link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getOriginalShortLinkByHash/).
    */
-  async getOriginalShortLinkByHash({ hash } = {}) {
-    const { error } = ShareValidator.getOriginalShortLinkByHash().validate(
+  async getOriginalShortLinkByHash(
+    { hash } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = ShareApplicationValidator.getOriginalShortLinkByHash().validate(
       { hash },
       { abortEarly: false, allowUnknown: true }
     );
@@ -244,17 +279,15 @@ class Share {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = ShareValidator.getOriginalShortLinkByHash().validate(
+    } = ShareApplicationValidator.getOriginalShortLinkByHash().validate(
       { hash },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for getOriginalShortLinkByHash",
+        message: `Parameter Validation warrnings for application > Share > getOriginalShortLinkByHash \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -270,10 +303,18 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ShareApplicationModel.ShortLinkRes().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -281,24 +322,28 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getOriginalShortLinkByHash",
+        message: `Response Validation Warnnings for application > Share > getOriginalShortLinkByHash \n ${res_error}`,
       });
-      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
+   * @param {ShareApplicationValidator.GetProductQRCodeBySlugParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
+   * @name getProductQRCodeBySlug
    * @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.
+   * @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getProductQRCodeBySlug/).
    */
-  async getProductQRCodeBySlug({ slug } = {}) {
-    const { error } = ShareValidator.getProductQRCodeBySlug().validate(
+  async getProductQRCodeBySlug(
+    { slug } = {},
+    { headers } = { headers: false }
+  ) {
+    const {
+      error,
+    } = ShareApplicationValidator.getProductQRCodeBySlug().validate(
       { slug },
       { abortEarly: false, allowUnknown: true }
     );
@@ -309,16 +354,15 @@ class Share {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = ShareValidator.getProductQRCodeBySlug().validate(
+    } = ShareApplicationValidator.getProductQRCodeBySlug().validate(
       { slug },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getProductQRCodeBySlug",
+        message: `Parameter Validation warrnings for application > Share > getProductQRCodeBySlug \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -334,10 +378,18 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ShareApplicationModel.QRCodeResp().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -345,24 +397,23 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getProductQRCodeBySlug",
+        message: `Response Validation Warnnings for application > Share > getProductQRCodeBySlug \n ${res_error}`,
       });
-      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
+   * @param {ShareApplicationValidator.GetShortLinkByHashParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ShareApplicationModel.ShortLinkRes>} - Success response
+   * @name getShortLinkByHash
    * @summary: Get short link by hash
-   * @description: Use this API to get a short link by using a hash value.
+   * @description: Use this API to get a short link by using a hash value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getShortLinkByHash/).
    */
-  async getShortLinkByHash({ hash } = {}) {
-    const { error } = ShareValidator.getShortLinkByHash().validate(
+  async getShortLinkByHash({ hash } = {}, { headers } = { headers: false }) {
+    const { error } = ShareApplicationValidator.getShortLinkByHash().validate(
       { hash },
       { abortEarly: false, allowUnknown: true }
     );
@@ -371,16 +422,17 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.getShortLinkByHash().validate(
+    const {
+      error: warrning,
+    } = ShareApplicationValidator.getShortLinkByHash().validate(
       { hash },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getShortLinkByHash",
+        message: `Parameter Validation warrnings for application > Share > getShortLinkByHash \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -396,10 +448,18 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ShareApplicationModel.ShortLinkRes().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -407,23 +467,23 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getShortLinkByHash",
+        message: `Response Validation Warnnings for application > Share > getShortLinkByHash \n ${res_error}`,
       });
-      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
+   * @param {ShareApplicationValidator.GetUrlQRCodeParam} arg - Arg object.
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<ShareApplicationModel.QRCodeResp>} - Success response
+   * @name getUrlQRCode
    * @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.
+   * @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/share/getUrlQRCode/).
    */
-  async getUrlQRCode({ url } = {}) {
-    const { error } = ShareValidator.getUrlQRCode().validate(
+  async getUrlQRCode({ url } = {}, { headers } = { headers: false }) {
+    const { error } = ShareApplicationValidator.getUrlQRCode().validate(
       { url },
       { abortEarly: false, allowUnknown: true }
     );
@@ -432,16 +492,17 @@ class Share {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = ShareValidator.getUrlQRCode().validate(
+    const {
+      error: warrning,
+    } = ShareApplicationValidator.getUrlQRCode().validate(
       { url },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getUrlQRCode",
+        message: `Parameter Validation warrnings for application > Share > getUrlQRCode \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -458,10 +519,18 @@ class Share {
       }),
       query_params,
       undefined,
-      xHeaders
+      xHeaders,
+      { headers }
     );
 
-    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+    let responseData = response;
+    if (headers) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ShareApplicationModel.QRCodeResp().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -469,9 +538,8 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getUrlQRCode",
+        message: `Response Validation Warnnings for application > Share > getUrlQRCode \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;