@gofynd/fdk-client-javascript 3.26.0 → 3.28.0

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js

@@ -1,263 +0,0 @@
-const PlatformAPIClient = require("../PlatformAPIClient");
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-const Paginator = require("../../common/Paginator");
-const AnalyticsPlatformApplicationValidator = require("./AnalyticsPlatformApplicationValidator");
-const AnalyticsPlatformModel = require("./AnalyticsPlatformModel");
-const { Logger } = require("./../../common/Logger");
-const Joi = require("joi");
-
-class Analytics {
-  constructor(config, applicationId) {
-    this.config = config;
-    this.applicationId = applicationId;
-  }
-
-  /**
-   * @param {AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param} arg
-   *   - Arg object
-   *
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AnalyticsPlatformModel.JobStatus>} - Success response
-   * @name checkJobStatusByNameV2
-   * @summary: Checks download job status
-   * @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/checkJobStatusByNameV2/).
-   */
-  async checkJobStatusByNameV2(
-    { fileName, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = AnalyticsPlatformApplicationValidator.checkJobStatusByNameV2().validate(
-      {
-        fileName,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = AnalyticsPlatformApplicationValidator.checkJobStatusByNameV2().validate(
-      {
-        fileName,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Analytics > checkJobStatusByNameV2 \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/insights/v2.0/company/${this.config.companyId}/application/${this.applicationId}/job/${fileName}/status`,
-      query_params,
-      undefined,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AnalyticsPlatformModel.JobStatus().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 > Analytics > checkJobStatusByNameV2 \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param} arg
-   *   - Arg object
-   *
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - Success response
-   * @name executeJobForProvidedParametersV2
-   * @summary: Executes given sql(Base64 Encoded) query
-   * @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
-   */
-  async executeJobForProvidedParametersV2(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = AnalyticsPlatformApplicationValidator.executeJobForProvidedParametersV2().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,
-    } = AnalyticsPlatformApplicationValidator.executeJobForProvidedParametersV2().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Analytics > executeJobForProvidedParametersV2 \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/insights/v2.0/company/${this.config.companyId}/application/${this.applicationId}/job/execute`,
-      query_params,
-      body,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = AnalyticsPlatformModel.JobExecutionResult().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 > Analytics > executeJobForProvidedParametersV2 \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param} arg
-   *   - Arg object
-   *
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<Object>} - Success response
-   * @name startDownloadForQueryV2
-   * @summary: Initiates download job
-   * @description: Initiates download job and returns job name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/startDownloadForQueryV2/).
-   */
-  async startDownloadForQueryV2(
-    { exportType, body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = AnalyticsPlatformApplicationValidator.startDownloadForQueryV2().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,
-    } = AnalyticsPlatformApplicationValidator.startDownloadForQueryV2().validate(
-      {
-        exportType,
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Analytics > startDownloadForQueryV2 \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["export_type"] = exportType;
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/insights/v2.0/company/${this.config.companyId}/application/${this.applicationId}/job/download`,
-      query_params,
-      body,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const { error: res_error } = Joi.any().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 > Analytics > startDownloadForQueryV2 \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-}
-
-module.exports = Analytics;

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

@@ -1,42 +0,0 @@
-export = AnalyticsPlatformApplicationValidator;
-/**
- * @typedef CheckJobStatusByNameV2Param
- * @property {string} fileName - Download job name
- */
-/**
- * @typedef ExecuteJobForProvidedParametersV2Param
- * @property {AnalyticsPlatformModel.JobExecute} body
- */
-/**
- * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
- * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
- */
-declare class AnalyticsPlatformApplicationValidator {
-    /** @returns {CheckJobStatusByNameV2Param} */
-    static checkJobStatusByNameV2(): CheckJobStatusByNameV2Param;
-    /** @returns {ExecuteJobForProvidedParametersV2Param} */
-    static executeJobForProvidedParametersV2(): ExecuteJobForProvidedParametersV2Param;
-    /** @returns {StartDownloadForQueryV2Param} */
-    static startDownloadForQueryV2(): StartDownloadForQueryV2Param;
-}
-declare namespace AnalyticsPlatformApplicationValidator {
-    export { CheckJobStatusByNameV2Param, ExecuteJobForProvidedParametersV2Param, StartDownloadForQueryV2Param };
-}
-type CheckJobStatusByNameV2Param = {
-    /**
-     * - Download job name
-     */
-    fileName: string;
-};
-type ExecuteJobForProvidedParametersV2Param = {
-    body: AnalyticsPlatformModel.JobExecute;
-};
-type StartDownloadForQueryV2Param = {
-    /**
-     * - Format in which to be exported(eg. CSV or excel).
-     */
-    exportType: string;
-    body: AnalyticsPlatformModel.FileDownloadRequestBody;
-};
-import AnalyticsPlatformModel = require("./AnalyticsPlatformModel");

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -1,45 +0,0 @@
-const Joi = require("joi");
-
-const AnalyticsPlatformModel = require("./AnalyticsPlatformModel");
-
-/**
- * @typedef CheckJobStatusByNameV2Param
- * @property {string} fileName - Download job name
- */
-
-/**
- * @typedef ExecuteJobForProvidedParametersV2Param
- * @property {AnalyticsPlatformModel.JobExecute} body
- */
-
-/**
- * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
- * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
- */
-
-class AnalyticsPlatformApplicationValidator {
-  /** @returns {CheckJobStatusByNameV2Param} */
-  static checkJobStatusByNameV2() {
-    return Joi.object({
-      fileName: Joi.string().allow("").required(),
-    }).required();
-  }
-
-  /** @returns {ExecuteJobForProvidedParametersV2Param} */
-  static executeJobForProvidedParametersV2() {
-    return Joi.object({
-      body: AnalyticsPlatformModel.JobExecute().required(),
-    }).required();
-  }
-
-  /** @returns {StartDownloadForQueryV2Param} */
-  static startDownloadForQueryV2() {
-    return Joi.object({
-      exportType: Joi.string().allow("").required(),
-      body: AnalyticsPlatformModel.FileDownloadRequestBody().required(),
-    }).required();
-  }
-}
-
-module.exports = AnalyticsPlatformApplicationValidator;

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

@@ -1,136 +0,0 @@
-export = AnalyticsPlatformModel;
-/**
- * @typedef Page
- * @property {number} [item_total] - The total number of all items across all pages.
- * @property {string} [next_id] - The identifier for the next page.
- * @property {boolean} [has_previous] - Indicates whether there is a previous page.
- * @property {boolean} [has_next] - Indicates whether there is a next page.
- * @property {number} [current] - The current page number.
- * @property {string} type - The type of the page, can be 'cursor' or 'number'.
- * @property {number} [size] - The number of items per page.
- * @property {number} [page_size] - The number of items per page.
- */
-/**
- * @typedef FileDownloadRequestBody
- * @property {string} query - Base64 encoded SQL query to execute on ClickHouse.
- * @property {boolean} [split_files] - Flag indicating whether to split the
- *   files for larger datasets.
- */
-/**
- * @typedef JobExecute
- * @property {string} query - Base64 encoded SQL query to execute on ClickHouse.
- * @property {Page} [page]
- */
-/**
- * @typedef JobExecutionResult
- * @property {Object[]} [rows] - Array of rows resulting from the job execution.
- * @property {Page} [page]
- */
-/**
- * @typedef JobStatus
- * @property {string} [start_date] - The start date and time of the job.
- * @property {string} [end_date] - The end date and time of the job.
- * @property {string} [status] - The current status of the job.
- * @property {string} [message] - Message providing additional details about the
- *   job status.
- * @property {Object[]} [file_metadata] - Metadata about files associated with
- *   the job, if any.
- */
-declare class AnalyticsPlatformModel {
-}
-declare namespace AnalyticsPlatformModel {
-    export { Page, FileDownloadRequestBody, JobExecute, JobExecutionResult, JobStatus };
-}
-/** @returns {Page} */
-declare function Page(): Page;
-type Page = {
-    /**
-     * - The total number of all items across all pages.
-     */
-    item_total?: number;
-    /**
-     * - The identifier for the next page.
-     */
-    next_id?: string;
-    /**
-     * - Indicates whether there is a previous page.
-     */
-    has_previous?: boolean;
-    /**
-     * - Indicates whether there is a next page.
-     */
-    has_next?: boolean;
-    /**
-     * - The current page number.
-     */
-    current?: number;
-    /**
-     * - The type of the page, can be 'cursor' or 'number'.
-     */
-    type: string;
-    /**
-     * - The number of items per page.
-     */
-    size?: number;
-    /**
-     * - The number of items per page.
-     */
-    page_size?: number;
-};
-/** @returns {FileDownloadRequestBody} */
-declare function FileDownloadRequestBody(): FileDownloadRequestBody;
-type FileDownloadRequestBody = {
-    /**
-     * - Base64 encoded SQL query to execute on ClickHouse.
-     */
-    query: string;
-    /**
-     * - Flag indicating whether to split the
-     * files for larger datasets.
-     */
-    split_files?: boolean;
-};
-/** @returns {JobExecute} */
-declare function JobExecute(): JobExecute;
-type JobExecute = {
-    /**
-     * - Base64 encoded SQL query to execute on ClickHouse.
-     */
-    query: string;
-    page?: Page;
-};
-/** @returns {JobExecutionResult} */
-declare function JobExecutionResult(): JobExecutionResult;
-type JobExecutionResult = {
-    /**
-     * - Array of rows resulting from the job execution.
-     */
-    rows?: any[];
-    page?: Page;
-};
-/** @returns {JobStatus} */
-declare function JobStatus(): JobStatus;
-type JobStatus = {
-    /**
-     * - The start date and time of the job.
-     */
-    start_date?: string;
-    /**
-     * - The end date and time of the job.
-     */
-    end_date?: string;
-    /**
-     * - The current status of the job.
-     */
-    status?: string;
-    /**
-     * - Message providing additional details about the
-     * job status.
-     */
-    message?: string;
-    /**
-     * - Metadata about files associated with
-     * the job, if any.
-     */
-    file_metadata?: any[];
-};

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -1,95 +0,0 @@
-const Joi = require("joi");
-
-/**
- * @typedef Page
- * @property {number} [item_total] - The total number of all items across all pages.
- * @property {string} [next_id] - The identifier for the next page.
- * @property {boolean} [has_previous] - Indicates whether there is a previous page.
- * @property {boolean} [has_next] - Indicates whether there is a next page.
- * @property {number} [current] - The current page number.
- * @property {string} type - The type of the page, can be 'cursor' or 'number'.
- * @property {number} [size] - The number of items per page.
- * @property {number} [page_size] - The number of items per page.
- */
-
-/**
- * @typedef FileDownloadRequestBody
- * @property {string} query - Base64 encoded SQL query to execute on ClickHouse.
- * @property {boolean} [split_files] - Flag indicating whether to split the
- *   files for larger datasets.
- */
-
-/**
- * @typedef JobExecute
- * @property {string} query - Base64 encoded SQL query to execute on ClickHouse.
- * @property {Page} [page]
- */
-
-/**
- * @typedef JobExecutionResult
- * @property {Object[]} [rows] - Array of rows resulting from the job execution.
- * @property {Page} [page]
- */
-
-/**
- * @typedef JobStatus
- * @property {string} [start_date] - The start date and time of the job.
- * @property {string} [end_date] - The end date and time of the job.
- * @property {string} [status] - The current status of the job.
- * @property {string} [message] - Message providing additional details about the
- *   job status.
- * @property {Object[]} [file_metadata] - Metadata about files associated with
- *   the job, if any.
- */
-
-class AnalyticsPlatformModel {
-  /** @returns {Page} */
-  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(),
-      page_size: Joi.number(),
-    });
-  }
-
-  /** @returns {FileDownloadRequestBody} */
-  static FileDownloadRequestBody() {
-    return Joi.object({
-      query: Joi.string().allow("").required(),
-      split_files: Joi.boolean(),
-    });
-  }
-
-  /** @returns {JobExecute} */
-  static JobExecute() {
-    return Joi.object({
-      query: Joi.string().allow("").required(),
-      page: AnalyticsPlatformModel.Page(),
-    });
-  }
-
-  /** @returns {JobExecutionResult} */
-  static JobExecutionResult() {
-    return Joi.object({
-      rows: Joi.array().items(Joi.any()),
-      page: AnalyticsPlatformModel.Page(),
-    });
-  }
-
-  /** @returns {JobStatus} */
-  static JobStatus() {
-    return Joi.object({
-      start_date: Joi.string().allow(""),
-      end_date: Joi.string().allow("").allow(null),
-      status: Joi.string().allow(""),
-      message: Joi.string().allow(""),
-      file_metadata: Joi.array().items(Joi.any()).allow(null, ""),
-    });
-  }
-}
-module.exports = AnalyticsPlatformModel;