@gofynd/fdk-client-javascript 1.0.4 → 1.1.1

package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts

@@ -5,12 +5,14 @@ declare class Rewards {
     applicationId: any;
     /**
      * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Giveaway ID
      * @param {string} arg.audienceId - Audience id
      * @returns {Promise<GiveawayAudience>} - Success response
      * @summary: Get the Giveaway audience status
      * @description: Get giveaway audience status
      */
-    getGiveawayAudienceStatus({ audienceId }?: {
+    getGiveawayAudienceStatus({ id, audienceId }?: {
+        id: string;
         audienceId: string;
     }): Promise<GiveawayAudience>;
     /**
@@ -26,16 +28,12 @@ declare class Rewards {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.name - The name given to the offer.
-     * @param {string} arg.cookie - User's session cookie. This cookie is set in
-     *   browser cookie when logged-in to fynd's authentication system i.e.
-     *   `Grimlock` or by using grimlock-backend SDK for backend implementation.
      * @returns {Promise<Offer>} - Success response
      * @summary: Get offer by name
      * @description: Use this API to get the offer details and configuration by entering the name of the offer.
      */
-    getOfferByName({ name, cookie, }?: {
+    getOfferByName({ name }?: {
         name: string;
-        cookie: string;
     }): Promise<Offer>;
     /**
      * @param {Object} arg - Arg object.
@@ -44,6 +42,16 @@ declare class Rewards {
      * @description: Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fradualent device.
      */
     getRewardsConfiguration({}?: any): Promise<ConfigurationRes>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.userId - User id
+     * @returns {Promise<UserRes>} - Success response
+     * @summary: Get user reward details
+     * @description: Use this API to get the user reward details
+     */
+    getUserDetails({ userId }?: {
+        userId: string;
+    }): Promise<UserRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.userId - User id
@@ -149,15 +157,5 @@ declare class Rewards {
         userId: string;
         body: AppUser;
     }): Promise<AppUser>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.userId - User id
-     * @returns {Promise<UserRes>} - Success response
-     * @summary: Get user reward details
-     * @description: Use this API to get the user reward details
-     */
-    user({ userId }?: {
-        userId: string;
-    }): Promise<UserRes>;
 }
 import Paginator = require("../../common/Paginator");

package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js

@@ -14,14 +14,15 @@ class Rewards {
 
   /**
    * @param {Object} arg - Arg object.
+   * @param {string} arg.id - Giveaway ID
    * @param {string} arg.audienceId - Audience id
    * @returns {Promise<GiveawayAudience>} - Success response
    * @summary: Get the Giveaway audience status
    * @description: Get giveaway audience status
    */
-  async getGiveawayAudienceStatus({ audienceId } = {}) {
+  async getGiveawayAudienceStatus({ id, audienceId } = {}) {
     const { error } = RewardsValidator.getGiveawayAudienceStatus().validate(
-      { audienceId },
+      { id, audienceId },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -32,7 +33,7 @@ class Rewards {
     const {
       error: warrning,
     } = RewardsValidator.getGiveawayAudienceStatus().validate(
-      { audienceId },
+      { id, audienceId },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -48,7 +49,7 @@ class Rewards {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/rewards/v1.0/company/${this.config.companyId}/application/${this.applicationId}/giveaways/audience/${audienceId}/status`,
+      `/service/platform/rewards/v1.0/company/${this.config.companyId}/application/${this.applicationId}/giveaways/:id/audience/${audienceId}/status`,
       query_params,
       undefined
     );
@@ -133,24 +134,13 @@ class Rewards {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.name - The name given to the offer.
-   * @param {string} arg.cookie - User's session cookie. This cookie is set in
-   *   browser cookie when logged-in to fynd's authentication system i.e.
-   *   `Grimlock` or by using grimlock-backend SDK for backend implementation.
    * @returns {Promise<Offer>} - Success response
    * @summary: Get offer by name
    * @description: Use this API to get the offer details and configuration by entering the name of the offer.
    */
-  async getOfferByName({
-    name,
-
-    cookie,
-  } = {}) {
+  async getOfferByName({ name } = {}) {
     const { error } = RewardsValidator.getOfferByName().validate(
-      {
-        name,
-
-        cookie,
-      },
+      { name },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -159,11 +149,7 @@ class Rewards {
 
     // Showing warrnings if extra unknown parameters are found
     const { error: warrning } = RewardsValidator.getOfferByName().validate(
-      {
-        name,
-
-        cookie,
-      },
+      { name },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -258,6 +244,61 @@ class Rewards {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.userId - User id
+   * @returns {Promise<UserRes>} - Success response
+   * @summary: Get user reward details
+   * @description: Use this API to get the user reward details
+   */
+  async getUserDetails({ userId } = {}) {
+    const { error } = RewardsValidator.getUserDetails().validate(
+      { userId },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = RewardsValidator.getUserDetails().validate(
+      { userId },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for getUserDetails",
+      });
+      Logger({ level: "WARN", message: warrning });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/rewards/v1.0/company/${this.config.companyId}/application/${this.applicationId}/users/${userId}/`,
+      query_params,
+      undefined
+    );
+
+    const { error: res_error } = RewardsModel.UserRes().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for getUserDetails",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.userId - User id
@@ -810,61 +851,6 @@ class Rewards {
 
     return response;
   }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.userId - User id
-   * @returns {Promise<UserRes>} - Success response
-   * @summary: Get user reward details
-   * @description: Use this API to get the user reward details
-   */
-  async user({ userId } = {}) {
-    const { error } = RewardsValidator.user().validate(
-      { userId },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = RewardsValidator.user().validate(
-      { userId },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for user",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/rewards/v1.0/company/${this.config.companyId}/application/${this.applicationId}/users/${userId}/`,
-      query_params,
-      undefined
-    );
-
-    const { error: res_error } = RewardsModel.UserRes().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for user",
-      });
-      Logger({ level: "WARN", message: res_error });
-    }
-
-    return response;
-  }
 }
 
 module.exports = Rewards;

package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts

@@ -4,6 +4,7 @@ declare class RewardsValidator {
     static getGiveawayById(): any;
     static getOfferByName(): any;
     static getRewardsConfiguration(): any;
+    static getUserDetails(): any;
     static getUserPointsHistory(): any;
     static saveGiveAway(): any;
     static setRewardsConfiguration(): any;
@@ -12,5 +13,4 @@ declare class RewardsValidator {
     static updateGiveAway(): any;
     static updateOfferByName(): any;
     static updateUserStatus(): any;
-    static user(): any;
 }

package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js

@@ -4,6 +4,7 @@ const RewardsModel = require("./RewardsPlatformModel");
 class RewardsValidator {
   static getGiveawayAudienceStatus() {
     return Joi.object({
+      id: Joi.string().allow("").required(),
       audienceId: Joi.string().allow("").required(),
     }).required();
   }
@@ -17,8 +18,6 @@ class RewardsValidator {
   static getOfferByName() {
     return Joi.object({
       name: Joi.string().allow("").required(),
-
-      cookie: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -26,6 +25,12 @@ class RewardsValidator {
     return Joi.object({}).required();
   }
 
+  static getUserDetails() {
+    return Joi.object({
+      userId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static getUserPointsHistory() {
     return Joi.object({
       userId: Joi.string().allow("").required(),
@@ -80,12 +85,6 @@ class RewardsValidator {
       body: RewardsModel.AppUser().required(),
     }).required();
   }
-
-  static user() {
-    return Joi.object({
-      userId: Joi.string().allow("").required(),
-    }).required();
-  }
 }
 
 module.exports = RewardsValidator;

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

@@ -23,6 +23,17 @@ declare class Share {
     getShortLinkByHash({ hash }?: {
         hash: string;
     }): Promise<ShortLinkRes>;
+    /**
+     * @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.
+     */
+    getShortLinkClickStats({ surlId }?: {
+        surlId: string;
+    }): Promise<ClickStatsResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageNo] - Current page number

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/Config.d.ts

@@ -1,9 +0,0 @@
-export = Config;
-declare class Config {
-    /** @param {object} _conf */
-    constructor(_conf: object);
-    domain: any;
-    extraHeaders: any[];
-    logLevel: any;
-    setLogLevel(level: any): void;
-}

package/sdk/Config.js

@@ -1,17 +0,0 @@
-const { Logger, setLoggerLevel } = require("../common/Logger");
-
-class Config {
-  /** @param {object} _conf */
-  constructor(_conf) {
-    this.domain = _conf.domain || "https://api.fynd.com";
-    this.extraHeaders = [];
-    this.logLevel = _conf.logLevel || "ERROR";
-    this.setLogLevel(this.logLevel);
-  }
-
-  setLogLevel(level) {
-    setLoggerLevel(level);
-  }
-}
-
-module.exports = Config;

package/sdk/constructUrl.d.ts

@@ -1,5 +0,0 @@
-export = constructUrl;
-declare function constructUrl({ url, params }: {
-    url: any;
-    params: any;
-}): any;

package/sdk/constructUrl.js

@@ -1,13 +0,0 @@
-const camelCase = require("camelcase");
-const constructUrl = ({ url, params }) => {
-  return url
-    .split("/")
-    .map((word) => {
-      if (word[0] === "{" && word[word.length - 1] === "}") {
-        word = params[camelCase(word.slice(1, word.length - 1))];
-      }
-      return word;
-    })
-    .join("/");
-};
-module.exports = constructUrl;

package/sdk/index.d.ts

@@ -1,3 +0,0 @@
-export const Config: typeof import("./Config");
-export const Client: typeof import("./Client");
-export const Model: {};

package/sdk/index.js

@@ -1,5 +0,0 @@
-module.exports = {
-  Config: require("./Config"),
-  Client: require("./Client"),
-  Model: {},
-};

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");