@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

package/sdk/application/Share/ShareApplicationClient.js

@@ -10,17 +10,17 @@ 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]) => {
@@ -40,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.
    */
-  async getApplicationQRCode({} = {}) {
-    const { error } = ShareValidator.getApplicationQRCode().validate(
-      {},
+  async createShortLink({ body } = {}) {
+    const { error } = ShareValidator.createShortLink().validate(
+      { body },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -54,14 +55,14 @@ 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) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getApplicationQRCode",
+        message: "Parameter Validation warrnings for createShortLink",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -74,15 +75,15 @@ class Share {
       this._conf,
       "post",
       constructUrl({
-        url: this._urls["getApplicationQRCode"],
+        url: this._urls["createShortLink"],
         params: {},
       }),
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
-    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
+    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -90,7 +91,7 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getApplicationQRCode",
+        message: "Response Validation Warnnings for createShortLink",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -100,15 +101,13 @@ class Share {
 
   /**
    * @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.
    */
-  async getProductQRCodeBySlug({ slug } = {}) {
-    const { error } = ShareValidator.getProductQRCodeBySlug().validate(
-      { slug },
+  async getApplicationQRCode({} = {}) {
+    const { error } = ShareValidator.getApplicationQRCode().validate(
+      {},
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -116,16 +115,14 @@ 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) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getProductQRCodeBySlug",
+        message: "Parameter Validation warrnings for getApplicationQRCode",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -138,8 +135,8 @@ class Share {
       this._conf,
       "post",
       constructUrl({
-        url: this._urls["getProductQRCodeBySlug"],
-        params: { slug },
+        url: this._urls["getApplicationQRCode"],
+        params: {},
       }),
       query_params,
       undefined,
@@ -154,7 +151,7 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getProductQRCodeBySlug",
+        message: "Response Validation Warnnings for getApplicationQRCode",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -228,14 +225,15 @@ class Share {
 
   /**
    * @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.
    */
-  async getUrlQRCode({ url } = {}) {
-    const { error } = ShareValidator.getUrlQRCode().validate(
-      { url },
+  async getOriginalShortLinkByHash({ hash } = {}) {
+    const { error } = ShareValidator.getOriginalShortLinkByHash().validate(
+      { hash },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -243,36 +241,38 @@ 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) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getUrlQRCode",
+        message:
+          "Parameter Validation warrnings for getOriginalShortLinkByHash",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["url"] = url;
 
     const xHeaders = {};
 
     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.QRCodeResp().validate(response, {
+    const { error: res_error } = ShareModel.ShortLinkRes().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -280,7 +280,7 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getUrlQRCode",
+        message: "Response Validation Warnnings for getOriginalShortLinkByHash",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -290,14 +290,15 @@ class Share {
 
   /**
    * @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.
    */
-  async createShortLink({ body } = {}) {
-    const { error } = ShareValidator.createShortLink().validate(
-      { body },
+  async getProductQRCodeBySlug({ slug } = {}) {
+    const { error } = ShareValidator.getProductQRCodeBySlug().validate(
+      { slug },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -305,14 +306,16 @@ 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) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for createShortLink",
+        message: "Parameter Validation warrnings for getProductQRCodeBySlug",
       });
       Logger({ level: "WARN", message: warrning });
     }
@@ -325,15 +328,15 @@ class Share {
       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.ShortLinkRes().validate(response, {
+    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -341,7 +344,7 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for createShortLink",
+        message: "Response Validation Warnnings for getProductQRCodeBySlug",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -413,15 +416,14 @@ class Share {
 
   /**
    * @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.
    */
-  async getOriginalShortLinkByHash({ hash } = {}) {
-    const { error } = ShareValidator.getOriginalShortLinkByHash().validate(
-      { hash },
+  async getUrlQRCode({ url } = {}) {
+    const { error } = ShareValidator.getUrlQRCode().validate(
+      { url },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -429,38 +431,36 @@ 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) {
       Logger({
         level: "WARN",
-        message:
-          "Parameter Validation warrnings for getOriginalShortLinkByHash",
+        message: "Parameter Validation warrnings for getUrlQRCode",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["url"] = url;
 
     const xHeaders = {};
 
     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.ShortLinkRes().validate(response, {
+    const { error: res_error } = ShareModel.QRCodeResp().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -468,7 +468,7 @@ class Share {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getOriginalShortLinkByHash",
+        message: "Response Validation Warnnings for getUrlQRCode",
       });
       Logger({ level: "WARN", message: res_error });
     }

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;
 }

package/sdk/application/Share/ShareApplicationModel.js

@@ -1,177 +1,117 @@
 const Joi = require("joi");
 
 class ShareModel {
-  static QRCodeResp() {
+  static Attribution() {
     return Joi.object({
-      link: Joi.string().allow(""),
-
-      svg: Joi.string().allow(""),
+      campaign_cookie_expiry: Joi.string().allow(""),
     });
   }
-
-  static RedirectDevice() {
+  static CampaignShortLink() {
     return Joi.object({
-      link: Joi.string().allow(""),
-
-      type: Joi.string().allow(""),
+      medium: Joi.string().allow(""),
+      source: Joi.string().allow(""),
     });
   }
-
-  static WebRedirect() {
+  static ErrorRes() {
     return Joi.object({
-      link: Joi.string().allow(""),
-
-      type: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
-
-  static Redirects() {
+  static Page() {
     return Joi.object({
-      ios: ShareModel.RedirectDevice(),
-
-      android: ShareModel.RedirectDevice(),
-
-      web: ShareModel.WebRedirect(),
-
-      force_web: Joi.boolean(),
+      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 CampaignShortLink() {
+  static QRCodeResp() {
     return Joi.object({
-      source: Joi.string().allow(""),
-
-      medium: Joi.string().allow(""),
+      link: Joi.string().allow(""),
+      svg: Joi.string().allow(""),
     });
   }
-
-  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(""),
     });
   }
 }

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

@@ -1,10 +1,10 @@
 export = ShareValidator;
 declare class ShareValidator {
+    static createShortLink(): any;
     static getApplicationQRCode(): any;
-    static getProductQRCodeBySlug(): any;
     static getCollectionQRCodeBySlug(): any;
-    static getUrlQRCode(): any;
-    static createShortLink(): any;
-    static getShortLinkByHash(): any;
     static getOriginalShortLinkByHash(): any;
+    static getProductQRCodeBySlug(): any;
+    static getShortLinkByHash(): any;
+    static getUrlQRCode(): any;
 }