@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,16 +1,199 @@
-export = ShareModel;
-declare class ShareModel {
-    static Attribution(): any;
-    static CampaignShortLink(): any;
-    static ErrorRes(): any;
-    static Page(): any;
-    static QRCodeResp(): any;
-    static RedirectDevice(): any;
-    static Redirects(): any;
-    static ShortLinkList(): any;
-    static ShortLinkReq(): any;
-    static ShortLinkRes(): any;
-    static SocialMediaTags(): any;
-    static UrlInfo(): any;
-    static WebRedirect(): any;
+export = ShareApplicationModel;
+/**
+ * @typedef Attribution
+ * @property {string} [campaign_cookie_expiry]
+ */
+/**
+ * @typedef CampaignShortLink
+ * @property {string} [medium]
+ * @property {string} [source]
+ */
+/**
+ * @typedef ErrorRes
+ * @property {string} [message]
+ */
+/**
+ * @typedef QRCodeResp
+ * @property {string} [link]
+ * @property {string} [svg]
+ */
+/**
+ * @typedef RedirectDevice
+ * @property {string} [link]
+ * @property {string} [type]
+ */
+/**
+ * @typedef Redirects
+ * @property {RedirectDevice} [android]
+ * @property {boolean} [force_web]
+ * @property {RedirectDevice} [ios]
+ * @property {WebRedirect} [web]
+ */
+/**
+ * @typedef ShortLinkReq
+ * @property {boolean} [active]
+ * @property {Attribution} [attribution]
+ * @property {CampaignShortLink} [campaign]
+ * @property {number} [count]
+ * @property {boolean} [enable_tracking]
+ * @property {string} [expire_at]
+ * @property {string} [hash]
+ * @property {boolean} [personalized] - To create personalized short links.
+ * @property {Redirects} [redirects]
+ * @property {SocialMediaTags} [social_media_tags]
+ * @property {string} title - Give a name to the link.
+ * @property {string} url - The web address to shorten.
+ */
+/**
+ * @typedef ShortLinkRes
+ * @property {string} [_id]
+ * @property {boolean} [active]
+ * @property {boolean} [app_redirect]
+ * @property {string} [application]
+ * @property {Attribution} [attribution]
+ * @property {CampaignShortLink} [campaign]
+ * @property {number} [count]
+ * @property {string} [created_at]
+ * @property {string} [created_by]
+ * @property {boolean} [enable_tracking]
+ * @property {string} [expire_at]
+ * @property {string} [fallback]
+ * @property {Object} [meta]
+ * @property {boolean} [personalized] - To create personalized short links
+ * @property {Redirects} [redirects]
+ * @property {SocialMediaTags} [social_media_tags]
+ * @property {string} [title]
+ * @property {string} [updated_at]
+ * @property {UrlInfo} [url]
+ * @property {string} [user_id]
+ */
+/**
+ * @typedef SocialMediaTags
+ * @property {string} [description]
+ * @property {string} [image]
+ * @property {string} [title]
+ */
+/**
+ * @typedef UrlInfo
+ * @property {string} [hash]
+ * @property {string} [original]
+ * @property {string} [short]
+ */
+/**
+ * @typedef WebRedirect
+ * @property {string} [link]
+ * @property {string} [type]
+ */
+declare class ShareApplicationModel {
 }
+declare namespace ShareApplicationModel {
+    export { Attribution, CampaignShortLink, ErrorRes, QRCodeResp, RedirectDevice, Redirects, ShortLinkReq, ShortLinkRes, SocialMediaTags, UrlInfo, WebRedirect };
+}
+/** @returns {Attribution} */
+declare function Attribution(): Attribution;
+type Attribution = {
+    campaign_cookie_expiry?: string;
+};
+/** @returns {CampaignShortLink} */
+declare function CampaignShortLink(): CampaignShortLink;
+type CampaignShortLink = {
+    medium?: string;
+    source?: string;
+};
+/** @returns {ErrorRes} */
+declare function ErrorRes(): ErrorRes;
+type ErrorRes = {
+    message?: string;
+};
+/** @returns {QRCodeResp} */
+declare function QRCodeResp(): QRCodeResp;
+type QRCodeResp = {
+    link?: string;
+    svg?: string;
+};
+/** @returns {RedirectDevice} */
+declare function RedirectDevice(): RedirectDevice;
+type RedirectDevice = {
+    link?: string;
+    type?: string;
+};
+/** @returns {Redirects} */
+declare function Redirects(): Redirects;
+type Redirects = {
+    android?: RedirectDevice;
+    force_web?: boolean;
+    ios?: RedirectDevice;
+    web?: WebRedirect;
+};
+/** @returns {ShortLinkReq} */
+declare function ShortLinkReq(): ShortLinkReq;
+type ShortLinkReq = {
+    active?: boolean;
+    attribution?: Attribution;
+    campaign?: CampaignShortLink;
+    count?: number;
+    enable_tracking?: boolean;
+    expire_at?: string;
+    hash?: string;
+    /**
+     * - To create personalized short links.
+     */
+    personalized?: boolean;
+    redirects?: Redirects;
+    social_media_tags?: SocialMediaTags;
+    /**
+     * - Give a name to the link.
+     */
+    title: string;
+    /**
+     * - The web address to shorten.
+     */
+    url: string;
+};
+/** @returns {ShortLinkRes} */
+declare function ShortLinkRes(): ShortLinkRes;
+type ShortLinkRes = {
+    _id?: string;
+    active?: boolean;
+    app_redirect?: boolean;
+    application?: string;
+    attribution?: Attribution;
+    campaign?: CampaignShortLink;
+    count?: number;
+    created_at?: string;
+    created_by?: string;
+    enable_tracking?: boolean;
+    expire_at?: string;
+    fallback?: string;
+    meta?: any;
+    /**
+     * - To create personalized short links
+     */
+    personalized?: boolean;
+    redirects?: Redirects;
+    social_media_tags?: SocialMediaTags;
+    title?: string;
+    updated_at?: string;
+    url?: UrlInfo;
+    user_id?: string;
+};
+/** @returns {SocialMediaTags} */
+declare function SocialMediaTags(): SocialMediaTags;
+type SocialMediaTags = {
+    description?: string;
+    image?: string;
+    title?: string;
+};
+/** @returns {UrlInfo} */
+declare function UrlInfo(): UrlInfo;
+type UrlInfo = {
+    hash?: string;
+    original?: string;
+    short?: string;
+};
+/** @returns {WebRedirect} */
+declare function WebRedirect(): WebRedirect;
+type WebRedirect = {
+    link?: string;
+    type?: string;
+};

package/sdk/application/Share/ShareApplicationModel.js

@@ -1,83 +1,177 @@
 const Joi = require("joi");
 
-class ShareModel {
+/**
+ * @typedef Attribution
+ * @property {string} [campaign_cookie_expiry]
+ */
+
+/**
+ * @typedef CampaignShortLink
+ * @property {string} [medium]
+ * @property {string} [source]
+ */
+
+/**
+ * @typedef ErrorRes
+ * @property {string} [message]
+ */
+
+/**
+ * @typedef QRCodeResp
+ * @property {string} [link]
+ * @property {string} [svg]
+ */
+
+/**
+ * @typedef RedirectDevice
+ * @property {string} [link]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef Redirects
+ * @property {RedirectDevice} [android]
+ * @property {boolean} [force_web]
+ * @property {RedirectDevice} [ios]
+ * @property {WebRedirect} [web]
+ */
+
+/**
+ * @typedef ShortLinkReq
+ * @property {boolean} [active]
+ * @property {Attribution} [attribution]
+ * @property {CampaignShortLink} [campaign]
+ * @property {number} [count]
+ * @property {boolean} [enable_tracking]
+ * @property {string} [expire_at]
+ * @property {string} [hash]
+ * @property {boolean} [personalized] - To create personalized short links.
+ * @property {Redirects} [redirects]
+ * @property {SocialMediaTags} [social_media_tags]
+ * @property {string} title - Give a name to the link.
+ * @property {string} url - The web address to shorten.
+ */
+
+/**
+ * @typedef ShortLinkRes
+ * @property {string} [_id]
+ * @property {boolean} [active]
+ * @property {boolean} [app_redirect]
+ * @property {string} [application]
+ * @property {Attribution} [attribution]
+ * @property {CampaignShortLink} [campaign]
+ * @property {number} [count]
+ * @property {string} [created_at]
+ * @property {string} [created_by]
+ * @property {boolean} [enable_tracking]
+ * @property {string} [expire_at]
+ * @property {string} [fallback]
+ * @property {Object} [meta]
+ * @property {boolean} [personalized] - To create personalized short links
+ * @property {Redirects} [redirects]
+ * @property {SocialMediaTags} [social_media_tags]
+ * @property {string} [title]
+ * @property {string} [updated_at]
+ * @property {UrlInfo} [url]
+ * @property {string} [user_id]
+ */
+
+/**
+ * @typedef SocialMediaTags
+ * @property {string} [description]
+ * @property {string} [image]
+ * @property {string} [title]
+ */
+
+/**
+ * @typedef UrlInfo
+ * @property {string} [hash]
+ * @property {string} [original]
+ * @property {string} [short]
+ */
+
+/**
+ * @typedef WebRedirect
+ * @property {string} [link]
+ * @property {string} [type]
+ */
+
+class ShareApplicationModel {
+  /** @returns {Attribution} */
   static Attribution() {
     return Joi.object({
       campaign_cookie_expiry: Joi.string().allow(""),
     });
   }
+
+  /** @returns {CampaignShortLink} */
   static CampaignShortLink() {
     return Joi.object({
       medium: Joi.string().allow(""),
       source: Joi.string().allow(""),
     });
   }
+
+  /** @returns {ErrorRes} */
   static ErrorRes() {
     return Joi.object({
       message: Joi.string().allow(""),
     });
   }
-  static Page() {
-    return Joi.object({
-      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(),
-    });
-  }
+
+  /** @returns {QRCodeResp} */
   static QRCodeResp() {
     return Joi.object({
       link: Joi.string().allow(""),
       svg: Joi.string().allow(""),
     });
   }
+
+  /** @returns {RedirectDevice} */
   static RedirectDevice() {
     return Joi.object({
       link: Joi.string().allow(""),
       type: Joi.string().allow(""),
     });
   }
+
+  /** @returns {Redirects} */
   static Redirects() {
     return Joi.object({
-      android: ShareModel.RedirectDevice(),
+      android: ShareApplicationModel.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(),
+      ios: ShareApplicationModel.RedirectDevice(),
+      web: ShareApplicationModel.WebRedirect(),
     });
   }
+
+  /** @returns {ShortLinkReq} */
   static ShortLinkReq() {
     return Joi.object({
       active: Joi.boolean(),
-      attribution: ShareModel.Attribution(),
-      campaign: ShareModel.CampaignShortLink(),
+      attribution: ShareApplicationModel.Attribution(),
+      campaign: ShareApplicationModel.CampaignShortLink(),
       count: Joi.number(),
       enable_tracking: Joi.boolean(),
       expire_at: Joi.string().allow(""),
       hash: Joi.string().allow(""),
       personalized: Joi.boolean(),
-      redirects: ShareModel.Redirects(),
-      social_media_tags: ShareModel.SocialMediaTags(),
+      redirects: ShareApplicationModel.Redirects(),
+      social_media_tags: ShareApplicationModel.SocialMediaTags(),
       title: Joi.string().allow("").required(),
       url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ShortLinkRes} */
   static ShortLinkRes() {
     return Joi.object({
       _id: Joi.string().allow(""),
       active: Joi.boolean(),
       app_redirect: Joi.boolean(),
       application: Joi.string().allow(""),
-      attribution: ShareModel.Attribution(),
-      campaign: ShareModel.CampaignShortLink(),
+      attribution: ShareApplicationModel.Attribution(),
+      campaign: ShareApplicationModel.CampaignShortLink(),
       count: Joi.number(),
       created_at: Joi.string().allow(""),
       created_by: Joi.string().allow(""),
@@ -86,14 +180,16 @@ class ShareModel {
       fallback: Joi.string().allow(""),
       meta: Joi.any(),
       personalized: Joi.boolean(),
-      redirects: ShareModel.Redirects(),
-      social_media_tags: ShareModel.SocialMediaTags(),
+      redirects: ShareApplicationModel.Redirects(),
+      social_media_tags: ShareApplicationModel.SocialMediaTags(),
       title: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
-      url: ShareModel.UrlInfo(),
+      url: ShareApplicationModel.UrlInfo(),
       user_id: Joi.string().allow(""),
     });
   }
+
+  /** @returns {SocialMediaTags} */
   static SocialMediaTags() {
     return Joi.object({
       description: Joi.string().allow(""),
@@ -101,6 +197,8 @@ class ShareModel {
       title: Joi.string().allow(""),
     });
   }
+
+  /** @returns {UrlInfo} */
   static UrlInfo() {
     return Joi.object({
       hash: Joi.string().allow(""),
@@ -108,6 +206,8 @@ class ShareModel {
       short: Joi.string().allow(""),
     });
   }
+
+  /** @returns {WebRedirect} */
   static WebRedirect() {
     return Joi.object({
       link: Joi.string().allow(""),
@@ -115,4 +215,4 @@ class ShareModel {
     });
   }
 }
-module.exports = ShareModel;
+module.exports = ShareApplicationModel;

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

@@ -1,10 +1,88 @@
-export = ShareValidator;
-declare class ShareValidator {
-    static createShortLink(): any;
+export = ShareApplicationValidator;
+/**
+ * @typedef CreateShortLinkParam
+ * @property {ShareApplicationModel.ShortLinkReq} body
+ */
+/** @typedef GetApplicationQRCodeParam */
+/**
+ * @typedef GetCollectionQRCodeBySlugParam
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
+ *   a collection. You can get slug value from the endpoint.
+ */
+/**
+ * @typedef GetOriginalShortLinkByHashParam
+ * @property {string} hash - A string value used for converting long URL to
+ *   short URL and vice-versa.
+ */
+/**
+ * @typedef GetProductQRCodeBySlugParam
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
+ *   a product. You can get slug value from the endpoint.
+ */
+/**
+ * @typedef GetShortLinkByHashParam
+ * @property {string} hash - A string value used for converting long URL to
+ *   short URL and vice-versa.
+ */
+/**
+ * @typedef GetUrlQRCodeParam
+ * @property {string} url - A link or a web address
+ */
+declare class ShareApplicationValidator {
+    /** @returns {CreateShortLinkParam} */
+    static createShortLink(): CreateShortLinkParam;
+    /** @returns {GetApplicationQRCodeParam} */
     static getApplicationQRCode(): any;
-    static getCollectionQRCodeBySlug(): any;
-    static getOriginalShortLinkByHash(): any;
-    static getProductQRCodeBySlug(): any;
-    static getShortLinkByHash(): any;
-    static getUrlQRCode(): any;
+    /** @returns {GetCollectionQRCodeBySlugParam} */
+    static getCollectionQRCodeBySlug(): GetCollectionQRCodeBySlugParam;
+    /** @returns {GetOriginalShortLinkByHashParam} */
+    static getOriginalShortLinkByHash(): GetOriginalShortLinkByHashParam;
+    /** @returns {GetProductQRCodeBySlugParam} */
+    static getProductQRCodeBySlug(): GetProductQRCodeBySlugParam;
+    /** @returns {GetShortLinkByHashParam} */
+    static getShortLinkByHash(): GetShortLinkByHashParam;
+    /** @returns {GetUrlQRCodeParam} */
+    static getUrlQRCode(): GetUrlQRCodeParam;
 }
+declare namespace ShareApplicationValidator {
+    export { CreateShortLinkParam, GetApplicationQRCodeParam, GetCollectionQRCodeBySlugParam, GetOriginalShortLinkByHashParam, GetProductQRCodeBySlugParam, GetShortLinkByHashParam, GetUrlQRCodeParam };
+}
+type CreateShortLinkParam = {
+    body: ShareApplicationModel.ShortLinkReq;
+};
+type GetCollectionQRCodeBySlugParam = {
+    /**
+     * - A short, human-readable, URL-friendly identifier of
+     * a collection. You can get slug value from the endpoint.
+     */
+    slug: string;
+};
+type GetOriginalShortLinkByHashParam = {
+    /**
+     * - A string value used for converting long URL to
+     * short URL and vice-versa.
+     */
+    hash: string;
+};
+type GetProductQRCodeBySlugParam = {
+    /**
+     * - A short, human-readable, URL-friendly identifier of
+     * a product. You can get slug value from the endpoint.
+     */
+    slug: string;
+};
+type GetShortLinkByHashParam = {
+    /**
+     * - A string value used for converting long URL to
+     * short URL and vice-versa.
+     */
+    hash: string;
+};
+type GetUrlQRCodeParam = {
+    /**
+     * - A link or a web address
+     */
+    url: string;
+};
+type GetApplicationQRCodeParam = any;
+import ShareApplicationModel = require("./ShareApplicationModel");

package/sdk/application/Share/ShareApplicationValidator.js

@@ -1,41 +1,85 @@
 const Joi = require("joi");
 
-const ShareModel = require("./ShareApplicationModel");
-class ShareValidator {
+const ShareApplicationModel = require("./ShareApplicationModel");
+
+/**
+ * @typedef CreateShortLinkParam
+ * @property {ShareApplicationModel.ShortLinkReq} body
+ */
+
+/** @typedef GetApplicationQRCodeParam */
+
+/**
+ * @typedef GetCollectionQRCodeBySlugParam
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
+ *   a collection. You can get slug value from the endpoint.
+ */
+
+/**
+ * @typedef GetOriginalShortLinkByHashParam
+ * @property {string} hash - A string value used for converting long URL to
+ *   short URL and vice-versa.
+ */
+
+/**
+ * @typedef GetProductQRCodeBySlugParam
+ * @property {string} slug - A short, human-readable, URL-friendly identifier of
+ *   a product. You can get slug value from the endpoint.
+ */
+
+/**
+ * @typedef GetShortLinkByHashParam
+ * @property {string} hash - A string value used for converting long URL to
+ *   short URL and vice-versa.
+ */
+
+/**
+ * @typedef GetUrlQRCodeParam
+ * @property {string} url - A link or a web address
+ */
+
+class ShareApplicationValidator {
+  /** @returns {CreateShortLinkParam} */
   static createShortLink() {
     return Joi.object({
-      body: ShareModel.ShortLinkReq().required(),
+      body: ShareApplicationModel.ShortLinkReq().required(),
     }).required();
   }
 
+  /** @returns {GetApplicationQRCodeParam} */
   static getApplicationQRCode() {
     return Joi.object({});
   }
 
+  /** @returns {GetCollectionQRCodeBySlugParam} */
   static getCollectionQRCodeBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetOriginalShortLinkByHashParam} */
   static getOriginalShortLinkByHash() {
     return Joi.object({
       hash: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetProductQRCodeBySlugParam} */
   static getProductQRCodeBySlug() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetShortLinkByHashParam} */
   static getShortLinkByHash() {
     return Joi.object({
       hash: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetUrlQRCodeParam} */
   static getUrlQRCode() {
     return Joi.object({
       url: Joi.string().allow("").required(),
@@ -43,4 +87,4 @@ class ShareValidator {
   }
 }
 
-module.exports = ShareValidator;
+module.exports = ShareApplicationValidator;