@gofynd/fdk-client-javascript 1.4.6 → 1.4.8-beta.2

package/sdk/partner/Webhook/WebhookPartnerModel.js

@@ -1,13 +1,13 @@
 const Joi = require("joi");
 
 /**
- * @typedef UpdateSubscriberResponse
- * @property {string} [message]
+ * @typedef UpdateSubscriberRequest
+ * @property {string} [status]
  */
 
 /**
- * @typedef UpdateSubscriberRequest
- * @property {string} [status]
+ * @typedef UpdateSubscriberResponse
+ * @property {string} [message]
  */
 
 /**
@@ -29,6 +29,7 @@ const Joi = require("joi");
  * @property {number} [id]
  * @property {number} [event_id]
  * @property {number} [subscriber_id]
+ * @property {string} [topic]
  * @property {string} [created_on]
  */
 
@@ -44,6 +45,7 @@ const Joi = require("joi");
  * @property {string} [description]
  * @property {string} [created_on]
  * @property {string} [updated_on]
+ * @property {string} [group]
  * @property {SubscriberEventMapping} [subscriber_event_mapping]
  */
 
@@ -71,11 +73,6 @@ const Joi = require("joi");
  * @property {number} [count]
  */
 
-/**
- * @typedef DownloadReponse
- * @property {string} [file_name]
- */
-
 /**
  * @typedef HistoryFilters
  * @property {string[]} [events]
@@ -85,6 +82,8 @@ const Joi = require("joi");
  * @property {string} [start_date] - The start date and time of the history report.
  * @property {number[]} [subscribers] - An array of subscriber IDs associated
  *   with the history report.
+ * @property {string[]} [webhook_type] - An array of webhook type to identify
+ *   thetype of subscriber i.e (KAFKA or REST).
  */
 
 /**
@@ -246,6 +245,7 @@ const Joi = require("joi");
  * @property {string} [modified_by]
  * @property {string} [name]
  * @property {string} [webhook_url]
+ * @property {string} [provider]
  * @property {Association} [association]
  * @property {Object} [custom_headers]
  * @property {string} [status]
@@ -259,17 +259,17 @@ const Joi = require("joi");
  */
 
 class WebhookPartnerModel {
-  /** @returns {UpdateSubscriberResponse} */
-  static UpdateSubscriberResponse() {
+  /** @returns {UpdateSubscriberRequest} */
+  static UpdateSubscriberRequest() {
     return Joi.object({
-      message: Joi.string().allow(""),
+      status: Joi.string().allow(""),
     });
   }
 
-  /** @returns {UpdateSubscriberRequest} */
-  static UpdateSubscriberRequest() {
+  /** @returns {UpdateSubscriberResponse} */
+  static UpdateSubscriberResponse() {
     return Joi.object({
-      status: Joi.string().allow(""),
+      message: Joi.string().allow(""),
     });
   }
 
@@ -297,6 +297,7 @@ class WebhookPartnerModel {
       id: Joi.number(),
       event_id: Joi.number(),
       subscriber_id: Joi.number(),
+      topic: Joi.string().allow("").allow(null),
       created_on: Joi.string().allow(""),
     });
   }
@@ -314,6 +315,7 @@ class WebhookPartnerModel {
       description: Joi.string().allow("").allow(null),
       created_on: Joi.string().allow(""),
       updated_on: Joi.string().allow(""),
+      group: Joi.string().allow("").allow(null),
       subscriber_event_mapping: WebhookPartnerModel.SubscriberEventMapping(),
     });
   }
@@ -348,13 +350,6 @@ class WebhookPartnerModel {
     });
   }
 
-  /** @returns {DownloadReponse} */
-  static DownloadReponse() {
-    return Joi.object({
-      file_name: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {HistoryFilters} */
   static HistoryFilters() {
     return Joi.object({
@@ -364,6 +359,7 @@ class WebhookPartnerModel {
       end_date: Joi.string().allow(""),
       start_date: Joi.string().allow(""),
       subscribers: Joi.array().items(Joi.number()),
+      webhook_type: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -565,6 +561,7 @@ class WebhookPartnerModel {
       modified_by: Joi.string().allow(""),
       name: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
+      provider: Joi.string().allow(""),
       association: WebhookPartnerModel.Association(),
       custom_headers: Joi.any(),
       status: Joi.string().allow(""),

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

@@ -0,0 +1,43 @@
+export = Analytics;
+declare class Analytics {
+    constructor(config: any, applicationId: any);
+    config: any;
+    applicationId: any;
+    /**
+     * @param {AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<Object>} - 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://partners.fynd.com/help/docs/sdk/platform/analytics/checkJobStatusByNameV2/).
+     */
+    checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<any>;
+    /**
+     * @param {AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<Object>} - Success response
+     * @name executeJobForProvidedParametersV2
+     * @summary: Executes given sql(Base64 Encoded) query
+     * @description: Query click events data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/executeJobForProvidedParametersV2/).
+     */
+    executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<any>;
+    /**
+     * @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://partners.fynd.com/help/docs/sdk/platform/analytics/startDownloadForQueryV2/).
+     */
+    startDownloadForQueryV2({ exportType, body, requestHeaders }?: AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param, { responseHeaders }?: object): Promise<any>;
+}
+import AnalyticsPlatformApplicationValidator = require("./AnalyticsPlatformApplicationValidator");

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js

@@ -0,0 +1,257 @@
+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<Object>} - 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://partners.fynd.com/help/docs/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 } = Joi.object()
+      .pattern(/\S/, 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 > 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<Object>} - Success response
+   * @name executeJobForProvidedParametersV2
+   * @summary: Executes given sql(Base64 Encoded) query
+   * @description: Query click events data - Check out [method documentation](https://partners.fynd.com/help/docs/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 } = Joi.object()
+      .pattern(/\S/, 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 > 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://partners.fynd.com/help/docs/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

@@ -0,0 +1,39 @@
+export = AnalyticsPlatformApplicationValidator;
+/**
+ * @typedef CheckJobStatusByNameV2Param
+ * @property {string} fileName - Download job name
+ */
+/**
+ * @typedef ExecuteJobForProvidedParametersV2Param
+ * @property {AnalyticsPlatformModel.JobExecute} body
+ */
+/**
+ * @typedef StartDownloadForQueryV2Param
+ * @property {string} exportType
+ * @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 = {
+    exportType: string;
+    body: AnalyticsPlatformModel.FileDownloadRequestBody;
+};
+import AnalyticsPlatformModel = require("./AnalyticsPlatformModel");

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -0,0 +1,45 @@
+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
+ * @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

@@ -0,0 +1,60 @@
+export = AnalyticsPlatformModel;
+/**
+ * @typedef Page
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {boolean} [has_previous]
+ * @property {boolean} [has_next]
+ * @property {number} [current]
+ * @property {string} type
+ * @property {number} [size]
+ */
+/**
+ * @typedef FileDownloadRequestBody
+ * @property {string} query - Base64 encoded query to execute on clickhouse.
+ * @property {boolean} [split_files] - Flag to indicate whether to split files
+ *   for larger data.
+ */
+/**
+ * @typedef JobExecute
+ * @property {string} query - Base64 encoded query to execute on clickhouse.
+ * @property {Page} [page]
+ */
+declare class AnalyticsPlatformModel {
+}
+declare namespace AnalyticsPlatformModel {
+    export { Page, FileDownloadRequestBody, JobExecute };
+}
+/** @returns {Page} */
+declare function Page(): Page;
+type Page = {
+    item_total?: number;
+    next_id?: string;
+    has_previous?: boolean;
+    has_next?: boolean;
+    current?: number;
+    type: string;
+    size?: number;
+};
+/** @returns {FileDownloadRequestBody} */
+declare function FileDownloadRequestBody(): FileDownloadRequestBody;
+type FileDownloadRequestBody = {
+    /**
+     * - Base64 encoded query to execute on clickhouse.
+     */
+    query: string;
+    /**
+     * - Flag to indicate whether to split files
+     * for larger data.
+     */
+    split_files?: boolean;
+};
+/** @returns {JobExecute} */
+declare function JobExecute(): JobExecute;
+type JobExecute = {
+    /**
+     * - Base64 encoded query to execute on clickhouse.
+     */
+    query: string;
+    page?: Page;
+};

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -0,0 +1,57 @@
+const Joi = require("joi");
+
+/**
+ * @typedef Page
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {boolean} [has_previous]
+ * @property {boolean} [has_next]
+ * @property {number} [current]
+ * @property {string} type
+ * @property {number} [size]
+ */
+
+/**
+ * @typedef FileDownloadRequestBody
+ * @property {string} query - Base64 encoded query to execute on clickhouse.
+ * @property {boolean} [split_files] - Flag to indicate whether to split files
+ *   for larger data.
+ */
+
+/**
+ * @typedef JobExecute
+ * @property {string} query - Base64 encoded query to execute on clickhouse.
+ * @property {Page} [page]
+ */
+
+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(),
+    });
+  }
+
+  /** @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(),
+    });
+  }
+}
+module.exports = AnalyticsPlatformModel;