@gofynd/fdk-client-javascript 0.1.37 → 1.0.1

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

@@ -0,0 +1,24 @@
+export = RewardsModel;
+declare class RewardsModel {
+    static E(): any;
+    static GiveawayResponse(): any;
+    static Giveaway(): any;
+    static Schedule(): any;
+    static RewardsAudience(): any;
+    static Asset(): any;
+    static RewardsRule(): any;
+    static Page(): any;
+    static Offer(): any;
+    static ShareMessages(): any;
+    static UserRes(): any;
+    static Points(): any;
+    static RewardUser(): any;
+    static Referral(): any;
+    static AppUser(): any;
+    static GiveawayAudience(): any;
+    static HistoryRes(): any;
+    static PointsHistory(): any;
+    static ConfigurationRes(): any;
+    static SetConfigurationRes(): any;
+    static ConfigurationRequest(): any;
+}

package/sdk/platform/Rewards/RewardsPlatformModel.js

@@ -0,0 +1,294 @@
+const Joi = require("joi");
+
+class RewardsModel {
+  static E() {
+    return Joi.object({
+      code: Joi.number(),
+
+      exception: Joi.string().allow(""),
+
+      info: Joi.string().allow(""),
+
+      message: Joi.string().allow(""),
+    });
+  }
+
+  static GiveawayResponse() {
+    return Joi.object({
+      items: Joi.array().items(RewardsModel.Giveaway()),
+
+      page: RewardsModel.Page(),
+    });
+  }
+
+  static Giveaway() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      _schedule: RewardsModel.Schedule(),
+
+      active: Joi.boolean(),
+
+      application_id: Joi.string().allow(""),
+
+      audience: RewardsModel.RewardsAudience(),
+
+      banner_image: RewardsModel.Asset(),
+
+      created_at: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      rule: RewardsModel.RewardsRule(),
+
+      title: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+    });
+  }
+
+  static Schedule() {
+    return Joi.object({
+      duration: Joi.number(),
+
+      end: Joi.string().allow(""),
+
+      start: Joi.string().allow(""),
+
+      cron: Joi.string().allow(""),
+    });
+  }
+
+  static RewardsAudience() {
+    return Joi.object({
+      header_user_id: Joi.string().allow(""),
+
+      id: Joi.string().allow(""),
+    });
+  }
+
+  static Asset() {
+    return Joi.object({
+      aspect_ratio: Joi.string().allow(""),
+
+      id: Joi.string().allow(""),
+
+      secure_url: Joi.string().allow(""),
+    });
+  }
+
+  static RewardsRule() {
+    return Joi.object({
+      amount: Joi.number(),
+    });
+  }
+
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+
+      has_next: Joi.boolean(),
+
+      current: Joi.number(),
+
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+    });
+  }
+
+  static Offer() {
+    return Joi.object({
+      _schedule: RewardsModel.Schedule(),
+
+      active: Joi.boolean(),
+
+      application_id: Joi.string().allow(""),
+
+      banner_image: RewardsModel.Asset(),
+
+      created_at: Joi.string().allow(""),
+
+      name: Joi.string().allow(""),
+
+      rule: Joi.any(),
+
+      share: RewardsModel.ShareMessages(),
+
+      sub_text: Joi.string().allow(""),
+
+      text: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+
+      updated_by: Joi.string().allow(""),
+
+      url: Joi.string().allow(""),
+    });
+  }
+
+  static ShareMessages() {
+    return Joi.object({
+      email: Joi.number(),
+
+      facebook: Joi.string().allow(""),
+
+      fallback: Joi.string().allow(""),
+
+      message: Joi.string().allow(""),
+
+      messenger: Joi.string().allow(""),
+
+      sms: Joi.string().allow(""),
+
+      text: Joi.string().allow(""),
+
+      twitter: Joi.string().allow(""),
+
+      whatsapp: Joi.string().allow(""),
+    });
+  }
+
+  static UserRes() {
+    return Joi.object({
+      points: RewardsModel.Points(),
+
+      user: RewardsModel.RewardUser(),
+    });
+  }
+
+  static Points() {
+    return Joi.object({
+      available: Joi.number(),
+    });
+  }
+
+  static RewardUser() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      active: Joi.boolean(),
+
+      created_at: Joi.string().allow(""),
+
+      referral: RewardsModel.Referral(),
+
+      uid: Joi.number(),
+
+      updated_at: Joi.string().allow(""),
+
+      user_block_reason: Joi.string().allow(""),
+
+      user_id: Joi.string().allow(""),
+    });
+  }
+
+  static Referral() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+    });
+  }
+
+  static AppUser() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      active: Joi.boolean(),
+
+      application_id: Joi.string().allow(""),
+
+      block_reason: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+
+      updated_by: Joi.string().allow(""),
+
+      user_id: Joi.string().allow(""),
+    });
+  }
+
+  static GiveawayAudience() {
+    return Joi.object({
+      audience_id: Joi.string().allow(""),
+
+      current_count: Joi.number(),
+    });
+  }
+
+  static HistoryRes() {
+    return Joi.object({
+      items: Joi.array().items(RewardsModel.PointsHistory()),
+
+      page: RewardsModel.Page(),
+
+      points: Joi.number(),
+    });
+  }
+
+  static PointsHistory() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+
+      application_id: Joi.string().allow(""),
+
+      claimed: Joi.boolean(),
+
+      created_at: Joi.string().allow(""),
+
+      expires_on: Joi.string().allow(""),
+
+      meta: Joi.any(),
+
+      points: Joi.number(),
+
+      remaining_points: Joi.number(),
+
+      text_1: Joi.string().allow(""),
+
+      text_2: Joi.string().allow(""),
+
+      text_3: Joi.string().allow(""),
+
+      txn_name: Joi.string().allow(""),
+
+      updated_at: Joi.string().allow(""),
+
+      user_id: Joi.string().allow(""),
+    });
+  }
+
+  static ConfigurationRes() {
+    return Joi.object({
+      valid_android_packages: Joi.array().items(Joi.string().allow("")),
+
+      terms_conditions_link: Joi.string().allow(""),
+
+      application_id: Joi.string().allow(""),
+
+      success: Joi.boolean(),
+    });
+  }
+
+  static SetConfigurationRes() {
+    return Joi.object({
+      success: Joi.boolean(),
+    });
+  }
+
+  static ConfigurationRequest() {
+    return Joi.object({
+      valid_android_packages: Joi.array().items(Joi.string().allow("")),
+
+      terms_conditions_link: Joi.string().allow(""),
+    });
+  }
+}
+module.exports = RewardsModel;

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

@@ -0,0 +1,72 @@
+export = Share;
+declare class Share {
+    constructor(config: any, applicationId: any);
+    config: any;
+    applicationId: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {ShortLinkReq} arg.body
+     * @summary: Create short link
+     * @description: Create short link
+     */
+    createShortLink({ body }?: {
+        body: ShortLinkReq;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageNo] - Current page number
+     * @param {number} [arg.pageSize] - Current page size
+     * @param {string} [arg.createdBy] - Short link creator
+     * @param {string} [arg.active] - Short link active status
+     * @param {string} [arg.q] - Search text for original and short url
+     * @summary: Get short links
+     * @description: Get short links
+     */
+    getShortLinks({ pageNo, pageSize, createdBy, active, q }?: {
+        pageNo?: number;
+        pageSize?: number;
+        createdBy?: string;
+        active?: string;
+        q?: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.companyId - Company Id
+     * @param {string} arg.applicationId - Application Id
+     * @param {number} [arg.pageSize] - Current page size
+     * @param {string} [arg.createdBy] - Short link creator
+     * @param {string} [arg.active] - Short link active status
+     * @param {string} [arg.q] - Search text for original and short url
+     * @summary: Get short links
+     * @description: Get short links
+     */
+    getShortLinksPaginator({ companyId, applicationId, pageSize, createdBy, active, q, }?: {
+        companyId: string;
+        applicationId: string;
+        pageSize?: number;
+        createdBy?: string;
+        active?: string;
+        q?: string;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.hash - Hash of short url
+     * @summary: Get short link by hash
+     * @description: Get short link by hash
+     */
+    getShortLinkByHash({ hash }?: {
+        hash: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.id - Short link document identifier
+     * @param {ShortLinkReq} arg.body
+     * @summary: Update short link by id
+     * @description: Update short link by id
+     */
+    updateShortLinkById({ id, body }?: {
+        id: string;
+        body: ShortLinkReq;
+    }): Promise<any>;
+}
+import Paginator = require("../../common/Paginator");

package/sdk/platform/Share/SharePlatformApplicationClient.js

@@ -0,0 +1,235 @@
+const Paginator = require("../../common/Paginator");
+const PlatformAPIClient = require("../PlatformAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const ShareValidator = require("./SharePlatformApplicationValidator");
+
+class Share {
+  constructor(config, applicationId) {
+    this.config = config;
+    this.applicationId = applicationId;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {ShortLinkReq} arg.body
+   * @summary: Create short link
+   * @description: Create short link
+   */
+  createShortLink({ body } = {}) {
+    const { error } = ShareValidator.createShortLink().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ShareValidator.createShortLink().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for createShortLink");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
+      query_params,
+      body
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageNo] - Current page number
+   * @param {number} [arg.pageSize] - Current page size
+   * @param {string} [arg.createdBy] - Short link creator
+   * @param {string} [arg.active] - Short link active status
+   * @param {string} [arg.q] - Search text for original and short url
+   * @summary: Get short links
+   * @description: Get short links
+   */
+  getShortLinks({ pageNo, pageSize, createdBy, active, q } = {}) {
+    const { error } = ShareValidator.getShortLinks().validate(
+      {
+        pageNo,
+        pageSize,
+        createdBy,
+        active,
+        q,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ShareValidator.getShortLinks().validate(
+      {
+        pageNo,
+        pageSize,
+        createdBy,
+        active,
+        q,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getShortLinks");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["created_by"] = createdBy;
+    query_params["active"] = active;
+    query_params["q"] = q;
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.companyId - Company Id
+   * @param {string} arg.applicationId - Application Id
+   * @param {number} [arg.pageSize] - Current page size
+   * @param {string} [arg.createdBy] - Short link creator
+   * @param {string} [arg.active] - Short link active status
+   * @param {string} [arg.q] - Search text for original and short url
+   * @summary: Get short links
+   * @description: Get short links
+   */
+  getShortLinksPaginator({
+    companyId,
+    applicationId,
+    pageSize,
+    createdBy,
+    active,
+    q,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getShortLinks({
+        companyId: companyId,
+        applicationId: applicationId,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        createdBy: createdBy,
+        active: active,
+        q: q,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.hash - Hash of short url
+   * @summary: Get short link by hash
+   * @description: Get short link by hash
+   */
+  getShortLinkByHash({ hash } = {}) {
+    const { error } = ShareValidator.getShortLinkByHash().validate(
+      {
+        hash,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ShareValidator.getShortLinkByHash().validate(
+      {
+        hash,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for getShortLinkByHash");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
+      query_params,
+      undefined
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.id - Short link document identifier
+   * @param {ShortLinkReq} arg.body
+   * @summary: Update short link by id
+   * @description: Update short link by id
+   */
+  updateShortLinkById({ id, body } = {}) {
+    const { error } = ShareValidator.updateShortLinkById().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = ShareValidator.updateShortLinkById().validate(
+      {
+        id,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      console.log("Parameter Validation warrnings for updateShortLinkById");
+      console.log(warrning);
+    }
+
+    const query_params = {};
+
+    return PlatformAPIClient.execute(
+      this.config,
+      "patch",
+      `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
+      query_params,
+      body
+    );
+  }
+}
+module.exports = Share;

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

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

package/sdk/platform/Share/SharePlatformApplicationValidator.js

@@ -0,0 +1,35 @@
+const Joi = require("joi");
+const ShareModel = require("./SharePlatformModel");
+
+class ShareValidator {
+  static createShortLink() {
+    return Joi.object({
+      body: ShareModel.ShortLinkReq().required(),
+    }).required();
+  }
+
+  static getShortLinks() {
+    return Joi.object({
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      createdBy: Joi.string().allow(""),
+      active: Joi.string().allow(""),
+      q: Joi.string().allow(""),
+    }).required();
+  }
+
+  static getShortLinkByHash() {
+    return Joi.object({
+      hash: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  static updateShortLinkById() {
+    return Joi.object({
+      id: Joi.string().allow("").required(),
+      body: ShareModel.ShortLinkReq().required(),
+    }).required();
+  }
+}
+
+module.exports = ShareValidator;

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

@@ -0,0 +1,15 @@
+export = ShareModel;
+declare class ShareModel {
+    static RedirectDevice(): any;
+    static WebRedirect(): any;
+    static Redirects(): any;
+    static CampaignShortLink(): any;
+    static Attribution(): any;
+    static SocialMediaTags(): any;
+    static ShortLinkReq(): any;
+    static UrlInfo(): any;
+    static ShortLinkRes(): any;
+    static Page(): any;
+    static ShortLinkList(): any;
+    static ErrorRes(): any;
+}