@gofynd/fdk-client-javascript 1.1.0 → 1.1.1

package/sdk/platform/Analytics/AnalyticsPlatformClient.js

@@ -1,361 +0,0 @@
-const PlatformAPIClient = require("../PlatformAPIClient");
-const { FDKClientValidationError } = require("../../common/FDKError");
-const Paginator = require("../../common/Paginator");
-const AnalyticsValidator = require("./AnalyticsPlatformValidator");
-const AnalyticsModel = require("./AnalyticsPlatformModel");
-const { Logger } = require("./../../common/Logger");
-const Joi = require("joi");
-
-class Analytics {
-  constructor(config) {
-    this.config = config;
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.exportType - Export type / format
-   * @param {ExportJobReq} arg.body
-   * @returns {Promise<ExportJobRes>} - Success response
-   * @summary: Create data export job in required format
-   * @description: Create data export job in required format
-   */
-  async createExportJob({ exportType, body } = {}) {
-    const { error } = AnalyticsValidator.createExportJob().validate(
-      {
-        exportType,
-        body,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AnalyticsValidator.createExportJob().validate(
-      {
-        exportType,
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for createExportJob",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/analytics/v1.0/company/${this.config.companyId}/export/${exportType}`,
-      query_params,
-      body,
-      xHeaders
-    );
-
-    const {
-      error: res_error,
-    } = AnalyticsModel.ExportJobRes().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for createExportJob",
-      });
-      Logger({ level: "WARN", message: res_error });
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.exportType - Export type / format
-   * @param {string} arg.jobId - Export job id
-   * @returns {Promise<ExportJobStatusRes>} - Success response
-   * @summary: Get data export job status
-   * @description: Get data export job status
-   */
-  async getExportJobStatus({ exportType, jobId } = {}) {
-    const { error } = AnalyticsValidator.getExportJobStatus().validate(
-      {
-        exportType,
-        jobId,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AnalyticsValidator.getExportJobStatus().validate(
-      {
-        exportType,
-        jobId,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for getExportJobStatus",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/analytics/v1.0/company/${this.config.companyId}/export/${exportType}/job/${jobId}`,
-      query_params,
-      undefined,
-      xHeaders
-    );
-
-    const {
-      error: res_error,
-    } = AnalyticsModel.ExportJobStatusRes().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for getExportJobStatus",
-      });
-      Logger({ level: "WARN", message: res_error });
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.logType - Log type
-   * @param {number} [arg.pageNo] - Current page number
-   * @param {number} [arg.pageSize] - Current page size
-   * @param {GetLogsListReq} arg.body
-   * @returns {Promise<GetLogsListRes>} - Success response
-   * @summary: Get logs list
-   * @description: Get logs list
-   */
-  async getLogsList({ logType, body, pageNo, pageSize } = {}) {
-    const { error } = AnalyticsValidator.getLogsList().validate(
-      {
-        logType,
-        body,
-        pageNo,
-        pageSize,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AnalyticsValidator.getLogsList().validate(
-      {
-        logType,
-        body,
-        pageNo,
-        pageSize,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for getLogsList",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-    query_params["page_no"] = pageNo;
-    query_params["page_size"] = pageSize;
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/analytics/v1.0/company/${this.config.companyId}/logs/${logType}`,
-      query_params,
-      body,
-      xHeaders
-    );
-
-    const {
-      error: res_error,
-    } = AnalyticsModel.GetLogsListRes().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for getLogsList",
-      });
-      Logger({ level: "WARN", message: res_error });
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.logType - Log type
-   * @param {number} [arg.pageSize] - Current page size
-   * @param {GetLogsListReq} arg.body
-   * @summary: Get logs list
-   * @description: Get logs list
-   */
-  getLogsListPaginator({ logType, pageSize, body } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "number";
-      const data = await this.getLogsList({
-        logType: logType,
-        body: body,
-        pageNo: pageNo,
-        pageSize: pageSize,
-      });
-      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 {number} [arg.pageNo] - Current page number
-   * @param {number} [arg.pageSize] - Current page size
-   * @param {string} arg.logType - Log type
-   * @param {SearchLogReq} arg.body
-   * @returns {Promise<SearchLogRes>} - Success response
-   * @summary: Search logs
-   * @description: Search logs
-   */
-  async searchLogs({ logType, body, pageNo, pageSize } = {}) {
-    const { error } = AnalyticsValidator.searchLogs().validate(
-      {
-        logType,
-        body,
-        pageNo,
-        pageSize,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = AnalyticsValidator.searchLogs().validate(
-      {
-        logType,
-        body,
-        pageNo,
-        pageSize,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: "Parameter Validation warrnings for searchLogs",
-      });
-      Logger({ level: "WARN", message: warrning });
-    }
-
-    const query_params = {};
-    query_params["page_no"] = pageNo;
-    query_params["page_size"] = pageSize;
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/analytics/v1.0/company/${this.config.companyId}/logs/${logType}/search`,
-      query_params,
-      body,
-      xHeaders
-    );
-
-    const {
-      error: res_error,
-    } = AnalyticsModel.SearchLogRes().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
-
-    if (res_error) {
-      Logger({
-        level: "WARN",
-        message: "Response Validation Warnnings for searchLogs",
-      });
-      Logger({ level: "WARN", message: res_error });
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {number} [arg.pageSize] - Current page size
-   * @param {string} arg.logType - Log type
-   * @param {SearchLogReq} arg.body
-   * @summary: Search logs
-   * @description: Search logs
-   */
-  searchLogsPaginator({ pageSize, logType, body } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "number";
-      const data = await this.searchLogs({
-        logType: logType,
-        body: body,
-        pageNo: pageNo,
-        pageSize: pageSize,
-      });
-      paginator.setPaginator({
-        hasNext: data.page.has_next ? true : false,
-        nextId: data.page.next_id,
-      });
-      return data;
-    };
-    paginator.setCallback(callback.bind(this));
-    return paginator;
-  }
-}
-
-module.exports = Analytics;

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

@@ -1,23 +0,0 @@
-export = AnalyticsModel;
-declare class AnalyticsModel {
-    static AbandonCartDetail(): any;
-    static AbandonCartsDetail(): any;
-    static AbandonCartsList(): any;
-    static ErrorRes(): any;
-    static ExportJobReq(): any;
-    static ExportJobRes(): any;
-    static ExportJobStatusRes(): any;
-    static GetLogsListReq(): any;
-    static GetLogsListRes(): any;
-    static LogInfo(): any;
-    static MkpLogsResp(): any;
-    static Page(): any;
-    static ReceivedAt(): any;
-    static SearchLogReq(): any;
-    static SearchLogRes(): any;
-    static StatGroup(): any;
-    static StatsGroupComponent(): any;
-    static StatsGroupComponents(): any;
-    static StatsGroups(): any;
-    static StatsRes(): any;
-}

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -1,169 +0,0 @@
-const Joi = require("joi");
-
-class AnalyticsModel {
-  static AbandonCartDetail() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      address: Joi.any(),
-      articles: Joi.array().items(Joi.any()),
-      breakup: Joi.any(),
-      cart_value: Joi.string().allow(""),
-      user_id: Joi.string().allow(""),
-    });
-  }
-  static AbandonCartsDetail() {
-    return Joi.object({
-      context_app_application_id: Joi.string().allow(""),
-      context_traits_email: Joi.string().allow(""),
-      context_traits_first_name: Joi.string().allow(""),
-      context_traits_last_name: Joi.string().allow(""),
-      context_traits_phone_number: Joi.string().allow(""),
-      properties_breakup_values_raw_total: Joi.string().allow(""),
-      properties_cart_id: Joi.string().allow(""),
-      received_at: AnalyticsModel.ReceivedAt(),
-    });
-  }
-  static AbandonCartsList() {
-    return Joi.object({
-      cart_total: Joi.string().allow(""),
-      items: Joi.array().items(AnalyticsModel.AbandonCartsDetail()),
-      page: AnalyticsModel.Page(),
-    });
-  }
-  static ErrorRes() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-  static ExportJobReq() {
-    return Joi.object({
-      end_time: Joi.string().allow(""),
-      event_type: Joi.string().allow(""),
-      marketplace_name: Joi.string().allow(""),
-      start_time: Joi.string().allow(""),
-      trace_id: Joi.string().allow(""),
-    });
-  }
-  static ExportJobRes() {
-    return Joi.object({
-      job_id: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-    });
-  }
-  static ExportJobStatusRes() {
-    return Joi.object({
-      download_url: Joi.string().allow(""),
-      job_id: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-    });
-  }
-  static GetLogsListReq() {
-    return Joi.object({
-      company_id: Joi.string().allow(""),
-      end_date: Joi.string().allow(""),
-      marketplace_name: Joi.string().allow(""),
-      start_date: Joi.string().allow(""),
-    });
-  }
-  static GetLogsListRes() {
-    return Joi.object({
-      items: Joi.array().items(AnalyticsModel.MkpLogsResp()),
-      page: AnalyticsModel.Page(),
-    });
-  }
-  static LogInfo() {
-    return Joi.object({
-      _id: Joi.string().allow(""),
-      article_id: Joi.string().allow(""),
-      brand_id: Joi.number(),
-      company_id: Joi.number(),
-      event: Joi.string().allow(""),
-      event_type: Joi.string().allow(""),
-      item_id: Joi.number(),
-      marketplace_name: Joi.string().allow(""),
-      seller_identifier: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      store_code: Joi.string().allow(""),
-      store_id: Joi.number(),
-      trace_id: Joi.string().allow(""),
-    });
-  }
-  static MkpLogsResp() {
-    return Joi.object({
-      count: Joi.string().allow(""),
-      end_time_iso: Joi.string().allow(""),
-      event_type: Joi.string().allow(""),
-      start_time_iso: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      trace_id: Joi.string().allow(""),
-    });
-  }
-  static Page() {
-    return Joi.object({
-      current: Joi.number(),
-      has_next: Joi.boolean(),
-      has_previous: Joi.boolean(),
-      item_total: Joi.number(),
-      next_id: Joi.string().allow(""),
-      size: Joi.number(),
-      type: Joi.string().allow("").required(),
-    });
-  }
-  static ReceivedAt() {
-    return Joi.object({
-      value: Joi.string().allow(""),
-    });
-  }
-  static SearchLogReq() {
-    return Joi.object({
-      company_id: Joi.string().allow(""),
-      end_date: Joi.string().allow(""),
-      identifier: Joi.string().allow(""),
-      identifier_value: Joi.string().allow(""),
-      marketplace_name: Joi.string().allow(""),
-      start_date: Joi.string().allow(""),
-    });
-  }
-  static SearchLogRes() {
-    return Joi.object({
-      items: Joi.array().items(AnalyticsModel.LogInfo()),
-      page: AnalyticsModel.Page(),
-    });
-  }
-  static StatGroup() {
-    return Joi.object({
-      key: Joi.string().allow(""),
-      title: Joi.string().allow(""),
-      url: Joi.string().allow(""),
-    });
-  }
-  static StatsGroupComponent() {
-    return Joi.object({
-      filters: Joi.any(),
-      key: Joi.string().allow(""),
-      title: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      url: Joi.string().allow(""),
-    });
-  }
-  static StatsGroupComponents() {
-    return Joi.object({
-      components: Joi.array().items(AnalyticsModel.StatsGroupComponent()),
-      title: Joi.string().allow(""),
-    });
-  }
-  static StatsGroups() {
-    return Joi.object({
-      groups: Joi.array().items(AnalyticsModel.StatGroup()),
-    });
-  }
-  static StatsRes() {
-    return Joi.object({
-      data: Joi.any(),
-      key: Joi.string().allow(""),
-      title: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-    });
-  }
-}
-module.exports = AnalyticsModel;

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

@@ -1,7 +0,0 @@
-export = AnalyticsValidator;
-declare class AnalyticsValidator {
-    static createExportJob(): any;
-    static getExportJobStatus(): any;
-    static getLogsList(): any;
-    static searchLogs(): any;
-}

package/sdk/platform/Analytics/AnalyticsPlatformValidator.js

@@ -1,38 +0,0 @@
-const Joi = require("joi");
-
-const AnalyticsModel = require("./AnalyticsPlatformModel");
-class AnalyticsValidator {
-  static createExportJob() {
-    return Joi.object({
-      exportType: Joi.string().allow("").required(),
-      body: AnalyticsModel.ExportJobReq().required(),
-    }).required();
-  }
-
-  static getExportJobStatus() {
-    return Joi.object({
-      exportType: Joi.string().allow("").required(),
-      jobId: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  static getLogsList() {
-    return Joi.object({
-      logType: Joi.string().allow("").required(),
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      body: AnalyticsModel.GetLogsListReq().required(),
-    }).required();
-  }
-
-  static searchLogs() {
-    return Joi.object({
-      pageNo: Joi.number(),
-      pageSize: Joi.number(),
-      logType: Joi.string().allow("").required(),
-      body: AnalyticsModel.SearchLogReq().required(),
-    }).required();
-  }
-}
-
-module.exports = AnalyticsValidator;