@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.0

package/sdk/platform/Share/SharePlatformApplicationClient.js

@@ -21,7 +21,7 @@ class Share {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
    * @name createShortLink
-   * @summary: Create short link.
+   * @summary: Create short link
    * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
    */
   async createShortLink(
@@ -61,7 +61,7 @@ class Share {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link`,
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
       query_params,
       body,
       requestHeaders,
@@ -100,7 +100,7 @@ class Share {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
    * @name getShortLinkByHash
-   * @summary: Get short link by hash.
+   * @summary: Get short link by hash
    * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
    */
   async getShortLinkByHash(
@@ -140,7 +140,7 @@ class Share {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}`,
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
       query_params,
       undefined,
       requestHeaders,
@@ -173,13 +173,91 @@ class Share {
     return response;
   }
 
+  /**
+   * @param {SharePlatformApplicationValidator.GetShortLinkClickStatsParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<SharePlatformModel.ClickStatsResult>} - Success response
+   * @name getShortLinkClickStats
+   * @summary: Get short link click statistics
+   * @description: Retrieve statistics and analytics for clicks on a short link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkClickStats/).
+   */
+  async getShortLinkClickStats(
+    { surlId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = SharePlatformApplicationValidator.getShortLinkClickStats().validate(
+      { surlId },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = SharePlatformApplicationValidator.getShortLinkClickStats().validate(
+      { surlId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Share > getShortLinkClickStats \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["surl_id"] = surlId;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/click-stats`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = SharePlatformModel.ClickStatsResult().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Share > getShortLinkClickStats \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {SharePlatformApplicationValidator.GetShortLinksParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<SharePlatformModel.ShortLinkList>} - Success response
    * @name getShortLinks
-   * @summary: Get short links.
+   * @summary: Get short links
    * @description: Retrieve a list of all generated short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
    */
   async getShortLinks(
@@ -247,7 +325,7 @@ class Share {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link`,
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
       query_params,
       undefined,
       requestHeaders,
@@ -288,7 +366,7 @@ class Share {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
    * @name updateShortLinkById
-   * @summary: Update short link by ID.
+   * @summary: Update short link
    * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
    */
   async updateShortLinkById(
@@ -330,7 +408,7 @@ class Share {
     const response = await PlatformAPIClient.execute(
       this.config,
       "patch",
-      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}`,
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
       query_params,
       body,
       requestHeaders,

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

@@ -5,12 +5,17 @@ export = SharePlatformApplicationValidator;
  */
 /**
  * @typedef GetShortLinkByHashParam
- * @property {string} hash
+ * @property {string} hash - Hash of short url
+ */
+/**
+ * @typedef GetShortLinkClickStatsParam
+ * @property {string} surlId - Short link ID for which click statistics are to
+ *   be retrieved.
  */
 /**
  * @typedef GetShortLinksParam
  * @property {number} [pageNo] - Current page number
- * @property {number} [pageSize] - Number of items displayed per page
+ * @property {number} [pageSize] - Current page size
  * @property {string} [createdBy] - Short link creator
  * @property {string} [active] - Short link active status
  * @property {string} [shortUrl] - Search for short url
@@ -19,7 +24,7 @@ export = SharePlatformApplicationValidator;
  */
 /**
  * @typedef UpdateShortLinkByIdParam
- * @property {string} id - Document Id
+ * @property {string} id - Short link document identifier
  * @property {SharePlatformModel.ShortLinkReq} body
  */
 declare class SharePlatformApplicationValidator {
@@ -27,27 +32,39 @@ declare class SharePlatformApplicationValidator {
     static createShortLink(): CreateShortLinkParam;
     /** @returns {GetShortLinkByHashParam} */
     static getShortLinkByHash(): GetShortLinkByHashParam;
+    /** @returns {GetShortLinkClickStatsParam} */
+    static getShortLinkClickStats(): GetShortLinkClickStatsParam;
     /** @returns {GetShortLinksParam} */
     static getShortLinks(): GetShortLinksParam;
     /** @returns {UpdateShortLinkByIdParam} */
     static updateShortLinkById(): UpdateShortLinkByIdParam;
 }
 declare namespace SharePlatformApplicationValidator {
-    export { CreateShortLinkParam, GetShortLinkByHashParam, GetShortLinksParam, UpdateShortLinkByIdParam };
+    export { CreateShortLinkParam, GetShortLinkByHashParam, GetShortLinkClickStatsParam, GetShortLinksParam, UpdateShortLinkByIdParam };
 }
 type CreateShortLinkParam = {
     body: SharePlatformModel.ShortLinkReq;
 };
 type GetShortLinkByHashParam = {
+    /**
+     * - Hash of short url
+     */
     hash: string;
 };
+type GetShortLinkClickStatsParam = {
+    /**
+     * - Short link ID for which click statistics are to
+     * be retrieved.
+     */
+    surlId: string;
+};
 type GetShortLinksParam = {
     /**
      * - Current page number
      */
     pageNo?: number;
     /**
-     * - Number of items displayed per page
+     * - Current page size
      */
     pageSize?: number;
     /**
@@ -73,7 +90,7 @@ type GetShortLinksParam = {
 };
 type UpdateShortLinkByIdParam = {
     /**
-     * - Document Id
+     * - Short link document identifier
      */
     id: string;
     body: SharePlatformModel.ShortLinkReq;

package/sdk/platform/Share/SharePlatformApplicationValidator.js

@@ -9,13 +9,19 @@ const SharePlatformModel = require("./SharePlatformModel");
 
 /**
  * @typedef GetShortLinkByHashParam
- * @property {string} hash
+ * @property {string} hash - Hash of short url
+ */
+
+/**
+ * @typedef GetShortLinkClickStatsParam
+ * @property {string} surlId - Short link ID for which click statistics are to
+ *   be retrieved.
  */
 
 /**
  * @typedef GetShortLinksParam
  * @property {number} [pageNo] - Current page number
- * @property {number} [pageSize] - Number of items displayed per page
+ * @property {number} [pageSize] - Current page size
  * @property {string} [createdBy] - Short link creator
  * @property {string} [active] - Short link active status
  * @property {string} [shortUrl] - Search for short url
@@ -25,7 +31,7 @@ const SharePlatformModel = require("./SharePlatformModel");
 
 /**
  * @typedef UpdateShortLinkByIdParam
- * @property {string} id - Document Id
+ * @property {string} id - Short link document identifier
  * @property {SharePlatformModel.ShortLinkReq} body
  */
 
@@ -44,6 +50,13 @@ class SharePlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetShortLinkClickStatsParam} */
+  static getShortLinkClickStats() {
+    return Joi.object({
+      surlId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetShortLinksParam} */
   static getShortLinks() {
     return Joi.object({

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

@@ -1,4 +1,9 @@
 export = SharePlatformModel;
+/**
+ * @typedef ClickStatsResult
+ * @property {ClickStatsItem[]} click_stats - An array of click statistics for
+ *   the short link.
+ */
 /**
  * @typedef ClickStatsItem
  * @property {string} display - The display name of the click statistic.
@@ -50,10 +55,24 @@ export = SharePlatformModel;
  * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
  * @property {number} [count]
+ * @property {shortLinkReqMeta} [meta]
+ */
+/**
+ * @typedef shortLinkReqMeta
+ * @property {boolean} [for_sms] - For_sms flag specifies that the short-link
+ *   will be used in SMS communication and based on TRAI (Indian) guidelines,
+ *   the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
+ * @property {string} [sms_header] - This field is used to override the sms
+ *   header to be used to generate a short-link for SMS communication in
+ *   compliance with TRAI guidelines, this should be used in conjunction with
+ *   for_sms flag set to true.
  */
 /**
  * @typedef UrlInfo
+ * @property {string} [original]
  * @property {string} [hash]
+ * @property {string} [short_url]
+ * @property {string} [alias]
  */
 /**
  * @typedef ShortLinkRes
@@ -87,7 +106,7 @@ export = SharePlatformModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
- * @property {number} [total] - Total number of items.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
  * @typedef ShortLinkList
@@ -101,8 +120,17 @@ export = SharePlatformModel;
 declare class SharePlatformModel {
 }
 declare namespace SharePlatformModel {
-    export { ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
+    export { ClickStatsResult, ClickStatsItem, RedirectDevice, WebRedirect, Redirects, CampaignShortLink, Attribution, SocialMediaTags, ShortLinkReq, shortLinkReqMeta, UrlInfo, ShortLinkRes, Page, ShortLinkList, ErrorRes };
 }
+/** @returns {ClickStatsResult} */
+declare function ClickStatsResult(): ClickStatsResult;
+type ClickStatsResult = {
+    /**
+     * - An array of click statistics for
+     * the short link.
+     */
+    click_stats: ClickStatsItem[];
+};
 /** @returns {ClickStatsItem} */
 declare function ClickStatsItem(): ClickStatsItem;
 type ClickStatsItem = {
@@ -177,11 +205,32 @@ type ShortLinkReq = {
     attribution?: Attribution;
     social_media_tags?: SocialMediaTags;
     count?: number;
+    meta?: shortLinkReqMeta;
+};
+/** @returns {shortLinkReqMeta} */
+declare function shortLinkReqMeta(): shortLinkReqMeta;
+type shortLinkReqMeta = {
+    /**
+     * - For_sms flag specifies that the short-link
+     * will be used in SMS communication and based on TRAI (Indian) guidelines,
+     * the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
+     */
+    for_sms?: boolean;
+    /**
+     * - This field is used to override the sms
+     * header to be used to generate a short-link for SMS communication in
+     * compliance with TRAI guidelines, this should be used in conjunction with
+     * for_sms flag set to true.
+     */
+    sms_header?: string;
 };
 /** @returns {UrlInfo} */
 declare function UrlInfo(): UrlInfo;
 type UrlInfo = {
+    original?: string;
     hash?: string;
+    short_url?: string;
+    alias?: string;
 };
 /** @returns {ShortLinkRes} */
 declare function ShortLinkRes(): ShortLinkRes;
@@ -242,9 +291,9 @@ type Page = {
      */
     size?: number;
     /**
-     * - Total number of items.
+     * - The number of items per page.
      */
-    total?: number;
+    page_size?: number;
 };
 /** @returns {ShortLinkList} */
 declare function ShortLinkList(): ShortLinkList;

package/sdk/platform/Share/SharePlatformModel.js

@@ -1,5 +1,11 @@
 const Joi = require("joi");
 
+/**
+ * @typedef ClickStatsResult
+ * @property {ClickStatsItem[]} click_stats - An array of click statistics for
+ *   the short link.
+ */
+
 /**
  * @typedef ClickStatsItem
  * @property {string} display - The display name of the click statistic.
@@ -58,11 +64,26 @@ const Joi = require("joi");
  * @property {Attribution} [attribution]
  * @property {SocialMediaTags} [social_media_tags]
  * @property {number} [count]
+ * @property {shortLinkReqMeta} [meta]
+ */
+
+/**
+ * @typedef shortLinkReqMeta
+ * @property {boolean} [for_sms] - For_sms flag specifies that the short-link
+ *   will be used in SMS communication and based on TRAI (Indian) guidelines,
+ *   the generated short-link must contain an active SMS HEADER; ex. DLFYND, GOFYND.
+ * @property {string} [sms_header] - This field is used to override the sms
+ *   header to be used to generate a short-link for SMS communication in
+ *   compliance with TRAI guidelines, this should be used in conjunction with
+ *   for_sms flag set to true.
  */
 
 /**
  * @typedef UrlInfo
+ * @property {string} [original]
  * @property {string} [hash]
+ * @property {string} [short_url]
+ * @property {string} [alias]
  */
 
 /**
@@ -98,7 +119,7 @@ const Joi = require("joi");
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
- * @property {number} [total] - Total number of items.
+ * @property {number} [page_size] - The number of items per page.
  */
 
 /**
@@ -113,6 +134,15 @@ const Joi = require("joi");
  */
 
 class SharePlatformModel {
+  /** @returns {ClickStatsResult} */
+  static ClickStatsResult() {
+    return Joi.object({
+      click_stats: Joi.array()
+        .items(SharePlatformModel.ClickStatsItem())
+        .required(),
+    });
+  }
+
   /** @returns {ClickStatsItem} */
   static ClickStatsItem() {
     return Joi.object({
@@ -186,13 +216,25 @@ class SharePlatformModel {
       attribution: SharePlatformModel.Attribution(),
       social_media_tags: SharePlatformModel.SocialMediaTags(),
       count: Joi.number(),
+      meta: SharePlatformModel.shortLinkReqMeta(),
+    });
+  }
+
+  /** @returns {shortLinkReqMeta} */
+  static shortLinkReqMeta() {
+    return Joi.object({
+      for_sms: Joi.boolean(),
+      sms_header: Joi.string().allow(""),
     });
   }
 
   /** @returns {UrlInfo} */
   static UrlInfo() {
     return Joi.object({
+      original: Joi.string().allow(""),
       hash: Joi.string().allow(""),
+      short_url: Joi.string().allow(""),
+      alias: Joi.string().allow(""),
     });
   }
 
@@ -211,7 +253,7 @@ class SharePlatformModel {
       application: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
-      meta: Joi.any(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
       updated_at: Joi.string().allow(""),
       personalized: Joi.boolean(),
       campaign: SharePlatformModel.CampaignShortLink(),
@@ -232,7 +274,7 @@ class SharePlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
-      total: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 

package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts

@@ -131,28 +131,6 @@ declare class Theme {
      * @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFonts/).
      */
     getFonts({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
-    /**
-     * @param {ThemePlatformApplicationValidator.GetFontsV2Param} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.FontsSchema>} - Success response
-     * @name getFontsV2
-     * @summary: List theme fonts
-     * @description: Retrieve a list of available fonts that can be used by themes in the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getFontsV2/).
-     */
-    getFontsV2({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ThemePlatformModel.FontsSchema>;
-    /**
-     * @param {ThemePlatformApplicationValidator.GetLatestVersionOfThemeBySlugParam} arg
-     *   - Arg object
-     *
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.MarketplaceTheme[]>} - Success response
-     * @name getLatestVersionOfThemeBySlug
-     * @summary: Get latest version of theme by slug.
-     * @description: Retrieve the most recent version of a theme using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getLatestVersionOfThemeBySlug/).
-     */
-    getLatestVersionOfThemeBySlug({ slugName, requestHeaders }?: ThemePlatformApplicationValidator.GetLatestVersionOfThemeBySlugParam, { responseHeaders }?: object): Promise<ThemePlatformModel.MarketplaceTheme[]>;
     /**
      * @param {ThemePlatformApplicationValidator.GetPageParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -199,12 +177,12 @@ declare class Theme {
      * @param {ThemePlatformApplicationValidator.IsUpgradableParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<ThemePlatformModel.ThemeUpgradableResponse>} - Success response
+     * @returns {Promise<ThemePlatformModel.ThemeUpgradable>} - Success response
      * @name isUpgradable
      * @summary: Check theme is upgradable
-     * @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
+     * @description: Determine if a public theme is eligible for an upgrade to a new version after any new version released in marketplace.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/isUpgradable/).
      */
-    isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradableResponse>;
+    isUpgradable({ themeId, requestHeaders }?: ThemePlatformApplicationValidator.IsUpgradableParam, { responseHeaders }?: object): Promise<ThemePlatformModel.ThemeUpgradable>;
     /**
      * @param {ThemePlatformApplicationValidator.UpdateMultiplePagesParam} arg
      *   - Arg object
@@ -226,7 +204,7 @@ declare class Theme {
      * @summary: Update a page
      * @description: Modify and update the content of a page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/updatePage/).
      */
-    updatePage({ themeId, pageValue, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
+    updatePage({ themeId, pageValue, socketId, body, requestHeaders }?: ThemePlatformApplicationValidator.UpdatePageParam, { responseHeaders }?: object): Promise<ThemePlatformModel.AvailablePageSchema>;
     /**
      * @param {ThemePlatformApplicationValidator.UpdateThemeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`