@gofynd/fdk-client-javascript 1.1.0 → 1.1.1

package/sdk/platform/Share/SharePlatformApplicationClient.js

@@ -130,6 +130,67 @@ class Share {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.surlId - Short link ID for which click statistics are
+   *   to be retrieved.
+   * @returns {Promise<ClickStatsResponse>} - Success response
+   * @summary: Get click statistics for a short link
+   * @description: Retrieve click statistics for a given short link ID.
+   */
+  async getShortLinkClickStats({ surlId } = {}) {
+    const { error } = ShareValidator.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,
+    } = ShareValidator.getShortLinkClickStats().validate(
+      { surlId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getShortLinkClickStats",
+      });
+      Logger({ level: "WARN", message: 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
+    );
+
+    const {
+      error: res_error,
+    } = ShareModel.ClickStatsResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getShortLinkClickStats",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {number} [arg.pageNo] - Current page number

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

@@ -2,6 +2,7 @@ export = ShareValidator;
 declare class ShareValidator {
     static createShortLink(): any;
     static getShortLinkByHash(): any;
+    static getShortLinkClickStats(): any;
     static getShortLinks(): any;
     static updateShortLinkById(): any;
 }

package/sdk/platform/Share/SharePlatformApplicationValidator.js

@@ -14,6 +14,12 @@ class ShareValidator {
     }).required();
   }
 
+  static getShortLinkClickStats() {
+    return Joi.object({
+      surlId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static getShortLinks() {
     return Joi.object({
       pageNo: Joi.number(),

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

@@ -2,6 +2,8 @@ export = ShareModel;
 declare class ShareModel {
     static Attribution(): any;
     static CampaignShortLink(): any;
+    static ClickStatsItem(): any;
+    static ClickStatsResponse(): any;
     static ErrorRes(): any;
     static Page(): any;
     static RedirectDevice(): any;

package/sdk/platform/Share/SharePlatformModel.js

@@ -12,6 +12,17 @@ class ShareModel {
       source: Joi.string().allow(""),
     });
   }
+  static ClickStatsItem() {
+    return Joi.object({
+      display: Joi.string().allow(""),
+      total: Joi.number(),
+    });
+  }
+  static ClickStatsResponse() {
+    return Joi.object({
+      click_stats: Joi.array().items(ShareModel.ClickStatsItem()).required(),
+    });
+  }
   static ErrorRes() {
     return Joi.object({
       message: Joi.string().allow(""),

package/sdk/platform/index.d.ts

@@ -18,7 +18,6 @@ export namespace PlatformModel {
     const ConfigurationPlatformModel: typeof import("./Configuration/ConfigurationPlatformModel");
     const CartPlatformModel: typeof import("./Cart/CartPlatformModel");
     const RewardsPlatformModel: typeof import("./Rewards/RewardsPlatformModel");
-    const AnalyticsPlatformModel: typeof import("./Analytics/AnalyticsPlatformModel");
     const DiscountPlatformModel: typeof import("./Discount/DiscountPlatformModel");
     const PartnerPlatformModel: typeof import("./Partner/PartnerPlatformModel");
     const WebhookPlatformModel: typeof import("./Webhook/WebhookPlatformModel");

package/sdk/platform/index.js

@@ -36,8 +36,6 @@ module.exports = {
 
     RewardsPlatformModel: require("./Rewards/RewardsPlatformModel"),
 
-    AnalyticsPlatformModel: require("./Analytics/AnalyticsPlatformModel"),
-
     DiscountPlatformModel: require("./Discount/DiscountPlatformModel"),
 
     PartnerPlatformModel: require("./Partner/PartnerPlatformModel"),

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts

@@ -1,109 +0,0 @@
-export = Analytics;
-declare class Analytics {
-    constructor(config: any, applicationId: any);
-    config: any;
-    applicationId: any;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.cartId - Cart Id
-     * @returns {Promise<AbandonCartDetail>} - Success response
-     * @summary: Get abandon carts details
-     * @description: Get abandon cart details
-     */
-    getAbandonCartDetail({ cartId }?: {
-        cartId: string;
-    }): Promise<AbandonCartDetail>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.fromDate - From date
-     * @param {string} arg.toDate - To date
-     * @param {number} [arg.pageNo] - Current page number
-     * @param {number} [arg.pageSize] - Current page size
-     * @returns {Promise<AbandonCartsList>} - Success response
-     * @summary: Get abandon carts list
-     * @description: Get abandon carts list
-     */
-    getAbandonCartList({ fromDate, toDate, pageNo, pageSize }?: {
-        fromDate: string;
-        toDate: string;
-        pageNo?: number;
-        pageSize?: number;
-    }): Promise<AbandonCartsList>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.companyId - Company Id
-     * @param {string} arg.applicationId - Application Id
-     * @param {string} arg.fromDate - From date
-     * @param {string} arg.toDate - To date
-     * @param {number} [arg.pageSize] - Current page size
-     * @summary: Get abandon carts list
-     * @description: Get abandon carts list
-     */
-    getAbandonCartListPaginator({ companyId, applicationId, fromDate, toDate, pageSize, }?: {
-        companyId: string;
-        applicationId: string;
-        fromDate: string;
-        toDate: string;
-        pageSize?: number;
-    }): Paginator;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.fromDate - From date
-     * @param {string} arg.toDate - To date
-     * @returns {Promise<string>} - Success response
-     * @summary: Get abandon carts csv
-     * @description: Get abandon carts csv
-     */
-    getAbandonCartsCSV({ fromDate, toDate }?: {
-        fromDate: string;
-        toDate: string;
-    }): Promise<string>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.componentName - Component name
-     * @returns {Promise<StatsRes>} - Success response
-     * @summary: Get component statistics
-     * @description: Get component statistics
-     */
-    getComponentStats({ componentName }?: {
-        componentName: string;
-    }): Promise<StatsRes>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.componentName - Component name
-     * @returns {Promise<string>} - Success response
-     * @summary: Get component statistics csv
-     * @description: Get component statistics csv
-     */
-    getComponentStatsCSV({ componentName }?: {
-        componentName: string;
-    }): Promise<string>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.componentName - Component name
-     * @returns {Promise<string>} - Success response
-     * @summary: Get component statistics pdf
-     * @description: Get component statistics pdf
-     */
-    getComponentStatsPDF({ componentName }?: {
-        componentName: string;
-    }): Promise<string>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.groupName - Group name
-     * @returns {Promise<StatsGroupComponents>} - Success response
-     * @summary: Get statistics group components
-     * @description: Get statistics group components
-     */
-    getStatiscticsGroupComponents({ groupName }?: {
-        groupName: string;
-    }): Promise<StatsGroupComponents>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<StatsGroups>} - Success response
-     * @summary: Get statistics groups
-     * @description: Get statistics groups
-     */
-    getStatiscticsGroups({}?: any): Promise<StatsGroups>;
-}
-import Paginator = require("../../common/Paginator");