@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

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

@@ -1,124 +1,122 @@
 export = SharePlatformModel;
-/**
- * @typedef Attribution
- * @property {string} [campaign_cookie_expiry]
- */
-/**
- * @typedef CampaignShortLink
- * @property {string} [medium]
- * @property {string} [source]
- */
-/**
- * @typedef ClickStatsItem
- * @property {string} display - The display name of the click statistic.
- * @property {number} total - The total number of clicks for the statistic.
- */
 /**
  * @typedef ClickStatsResponse
  * @property {ClickStatsItem[]} click_stats - An array of click statistics for
  *   the short link.
  */
 /**
- * @typedef ErrorRes
- * @property {string} [message]
+ * @typedef ClickStatsItem
+ * @property {string} display - The display name of the click statistic.
+ * @property {number} total - The total number of clicks for the statistic.
  */
 /**
- * @typedef Page
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {boolean} [has_previous]
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {number} [size]
- * @property {string} type
+ * @typedef RedirectDevice
+ * @property {string} [link]
+ * @property {string} [type]
  */
 /**
- * @typedef RedirectDevice
+ * @typedef WebRedirect
  * @property {string} [link]
  * @property {string} [type]
  */
 /**
  * @typedef Redirects
- * @property {RedirectDevice} [android]
- * @property {boolean} [force_web]
  * @property {RedirectDevice} [ios]
+ * @property {RedirectDevice} [android]
  * @property {WebRedirect} [web]
+ * @property {boolean} [force_web]
  */
 /**
- * @typedef ShortLinkList
- * @property {ShortLinkRes[]} [items]
- * @property {Page} [page]
+ * @typedef CampaignShortLink
+ * @property {string} [source]
+ * @property {string} [medium]
+ */
+/**
+ * @typedef Attribution
+ * @property {string} [campaign_cookie_expiry]
+ */
+/**
+ * @typedef SocialMediaTags
+ * @property {string} [title]
+ * @property {string} [description]
+ * @property {string} [image]
  */
 /**
  * @typedef ShortLinkReq
+ * @property {string} title - Give a name to the link.
+ * @property {string} url - The web address to shorten.
+ * @property {string} [hash]
  * @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} [enable_tracking]
  * @property {boolean} [personalized] - To create personalized short links.
+ * @property {CampaignShortLink} [campaign]
  * @property {Redirects} [redirects]
+ * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
- * @property {string} title - Give a name to the link.
- * @property {string} url - The web address to shorten.
+ * @property {number} [count]
+ */
+/**
+ * @typedef UrlInfo
+ * @property {string} [original]
+ * @property {string} [short]
+ * @property {string} [hash]
  */
 /**
  * @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} [title]
+ * @property {UrlInfo} [url]
  * @property {string} [created_by]
+ * @property {boolean} [app_redirect]
+ * @property {string} [fallback]
+ * @property {boolean} [active]
+ * @property {string} [_id]
  * @property {boolean} [enable_tracking]
  * @property {string} [expire_at]
- * @property {string} [fallback]
+ * @property {string} [application]
+ * @property {string} [user_id]
+ * @property {string} [created_at]
  * @property {Object} [meta]
+ * @property {string} [updated_at]
  * @property {boolean} [personalized] - To create personalized short links
+ * @property {CampaignShortLink} [campaign]
  * @property {Redirects} [redirects]
+ * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
- * @property {string} [title]
- * @property {string} [updated_at]
- * @property {UrlInfo} [url]
- * @property {string} [user_id]
+ * @property {number} [count]
  */
 /**
- * @typedef SocialMediaTags
- * @property {string} [description]
- * @property {string} [image]
- * @property {string} [title]
+ * @typedef Page
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {boolean} [has_previous]
+ * @property {boolean} [has_next]
+ * @property {number} [current]
+ * @property {string} type
+ * @property {number} [size]
  */
 /**
- * @typedef UrlInfo
- * @property {string} [hash]
- * @property {string} [original]
- * @property {string} [short]
+ * @typedef ShortLinkList
+ * @property {ShortLinkRes[]} [items]
+ * @property {Page} [page]
  */
 /**
- * @typedef WebRedirect
- * @property {string} [link]
- * @property {string} [type]
+ * @typedef ErrorRes
+ * @property {string} [message]
  */
 declare class SharePlatformModel {
 }
 declare namespace SharePlatformModel {
-    export { Attribution, CampaignShortLink, ClickStatsItem, ClickStatsResponse, ErrorRes, Page, RedirectDevice, Redirects, ShortLinkList, ShortLinkReq, ShortLinkRes, SocialMediaTags, UrlInfo, WebRedirect };
+    export { ClickStatsResponse, ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
 }
-/** @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 {ClickStatsResponse} */
+declare function ClickStatsResponse(): ClickStatsResponse;
+type ClickStatsResponse = {
+    /**
+     * - An array of click statistics for
+     * the short link.
+     */
+    click_stats: ClickStatsItem[];
 };
 /** @returns {ClickStatsItem} */
 declare function ClickStatsItem(): ClickStatsItem;
@@ -132,67 +130,47 @@ type ClickStatsItem = {
      */
     total: number;
 };
-/** @returns {ClickStatsResponse} */
-declare function ClickStatsResponse(): ClickStatsResponse;
-type ClickStatsResponse = {
-    /**
-     * - An array of click statistics for
-     * the short link.
-     */
-    click_stats: ClickStatsItem[];
-};
-/** @returns {ErrorRes} */
-declare function ErrorRes(): ErrorRes;
-type ErrorRes = {
-    message?: string;
-};
-/** @returns {Page} */
-declare function Page(): Page;
-type Page = {
-    current?: number;
-    has_next?: boolean;
-    has_previous?: boolean;
-    item_total?: number;
-    next_id?: string;
-    size?: number;
-    type: string;
-};
 /** @returns {RedirectDevice} */
 declare function RedirectDevice(): RedirectDevice;
 type RedirectDevice = {
     link?: string;
     type?: string;
 };
+/** @returns {WebRedirect} */
+declare function WebRedirect(): WebRedirect;
+type WebRedirect = {
+    link?: string;
+    type?: string;
+};
 /** @returns {Redirects} */
 declare function Redirects(): Redirects;
 type Redirects = {
-    android?: RedirectDevice;
-    force_web?: boolean;
     ios?: RedirectDevice;
+    android?: RedirectDevice;
     web?: WebRedirect;
+    force_web?: boolean;
 };
-/** @returns {ShortLinkList} */
-declare function ShortLinkList(): ShortLinkList;
-type ShortLinkList = {
-    items?: ShortLinkRes[];
-    page?: Page;
+/** @returns {CampaignShortLink} */
+declare function CampaignShortLink(): CampaignShortLink;
+type CampaignShortLink = {
+    source?: string;
+    medium?: string;
+};
+/** @returns {Attribution} */
+declare function Attribution(): Attribution;
+type Attribution = {
+    campaign_cookie_expiry?: string;
+};
+/** @returns {SocialMediaTags} */
+declare function SocialMediaTags(): SocialMediaTags;
+type SocialMediaTags = {
+    title?: string;
+    description?: string;
+    image?: string;
 };
 /** @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.
      */
@@ -201,51 +179,73 @@ type ShortLinkReq = {
      * - The web address to shorten.
      */
     url: string;
+    hash?: string;
+    active?: boolean;
+    expire_at?: string;
+    enable_tracking?: boolean;
+    /**
+     * - To create personalized short links.
+     */
+    personalized?: boolean;
+    campaign?: CampaignShortLink;
+    redirects?: Redirects;
+    attribution?: Attribution;
+    social_media_tags?: SocialMediaTags;
+    count?: number;
+};
+/** @returns {UrlInfo} */
+declare function UrlInfo(): UrlInfo;
+type UrlInfo = {
+    original?: string;
+    short?: string;
+    hash?: 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;
+    title?: string;
+    url?: UrlInfo;
     created_by?: string;
+    app_redirect?: boolean;
+    fallback?: string;
+    active?: boolean;
+    _id?: string;
     enable_tracking?: boolean;
     expire_at?: string;
-    fallback?: string;
+    application?: string;
+    user_id?: string;
+    created_at?: string;
     meta?: any;
+    updated_at?: string;
     /**
      * - To create personalized short links
      */
     personalized?: boolean;
+    campaign?: CampaignShortLink;
     redirects?: Redirects;
+    attribution?: Attribution;
     social_media_tags?: SocialMediaTags;
-    title?: string;
-    updated_at?: string;
-    url?: UrlInfo;
-    user_id?: string;
+    count?: number;
 };
-/** @returns {SocialMediaTags} */
-declare function SocialMediaTags(): SocialMediaTags;
-type SocialMediaTags = {
-    description?: string;
-    image?: string;
-    title?: string;
+/** @returns {Page} */
+declare function Page(): Page;
+type Page = {
+    item_total?: number;
+    next_id?: string;
+    has_previous?: boolean;
+    has_next?: boolean;
+    current?: number;
+    type: string;
+    size?: number;
 };
-/** @returns {UrlInfo} */
-declare function UrlInfo(): UrlInfo;
-type UrlInfo = {
-    hash?: string;
-    original?: string;
-    short?: string;
+/** @returns {ShortLinkList} */
+declare function ShortLinkList(): ShortLinkList;
+type ShortLinkList = {
+    items?: ShortLinkRes[];
+    page?: Page;
 };
-/** @returns {WebRedirect} */
-declare function WebRedirect(): WebRedirect;
-type WebRedirect = {
-    link?: string;
-    type?: string;
+/** @returns {ErrorRes} */
+declare function ErrorRes(): ErrorRes;
+type ErrorRes = {
+    message?: string;
 };