@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15

package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts

@@ -1,12 +1,17 @@
 export = WebhookValidator;
 declare class WebhookValidator {
+    static responseTimeSummary(): any;
     static fetchDeliverySummary(): any;
     static getDeliveryDetailInsights(): any;
     static fetchDeliveryTs(): any;
     static fetchReportFilters(): any;
+    static downloadDeliveryReport(): any;
     static cancelReportDownload(): any;
     static getHistoricalReports(): any;
     static getInvalidEventList(): any;
     static fetchSubscribers(): any;
     static updateSubscriber(): any;
+    static validateFilterConfiguration(): any;
+    static validateReducerConfiguration(): any;
+    static saveFilterReducerConfiguration(): any;
 }

package/sdk/partner/Webhook/WebhookPartnerValidator.js

@@ -2,6 +2,14 @@ const Joi = require("joi");
 
 const WebhookModel = require("./WebhookPartnerModel");
 class WebhookValidator {
+  static responseTimeSummary() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      startDate: Joi.string().allow("").required(),
+      endDate: Joi.string().allow("").required(),
+    }).required();
+  }
+
   static fetchDeliverySummary() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
@@ -13,7 +21,7 @@ class WebhookValidator {
   static getDeliveryDetailInsights() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: WebhookModel.DeliveryDetailsRequest().required(),
+      body: WebhookModel.DeliveryDetailsPayload().required(),
     }).required();
   }
 
@@ -35,6 +43,13 @@ class WebhookValidator {
     }).required();
   }
 
+  static downloadDeliveryReport() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      body: WebhookModel.ReportDownloadPayload().required(),
+    }).required();
+  }
+
   static cancelReportDownload() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
@@ -52,7 +67,7 @@ class WebhookValidator {
   static getInvalidEventList() {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
-      body: WebhookModel.InvalidEventsRequest().required(),
+      body: WebhookModel.InvalidEventsPayload().required(),
     }).required();
   }
 
@@ -66,7 +81,30 @@ class WebhookValidator {
     return Joi.object({
       extensionId: Joi.string().allow("").required(),
       subscriberId: Joi.number().required(),
-      body: WebhookModel.UpdateSubscriberRequest().required(),
+      body: WebhookModel.SubscriberUpdate().required(),
+    }).required();
+  }
+
+  static validateFilterConfiguration() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      body: WebhookModel.FilterValidationPayload().required(),
+    }).required();
+  }
+
+  static validateReducerConfiguration() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      body: WebhookModel.ReducerValidationPayload().required(),
+    }).required();
+  }
+
+  static saveFilterReducerConfiguration() {
+    return Joi.object({
+      extensionId: Joi.string().allow("").required(),
+      companyId: Joi.number().required(),
+      subscriberId: Joi.number().required(),
+      body: WebhookModel.FilterReducerSave().required(),
     }).required();
   }
 }

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

@@ -9,24 +9,24 @@ declare class Analytics {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
+     * @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://partners.fynd.com/help/docs/sdk/platform/analytics/checkJobStatusByNameV2/).
+     * @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/).
      */
-    checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<any>;
+    checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobStatus>;
     /**
      * @param {AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param} arg
      *   - Arg object
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<Object>} - Success response
+     * @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://partners.fynd.com/help/docs/sdk/platform/analytics/executeJobForProvidedParametersV2/).
+     * @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
      */
-    executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<any>;
+    executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobExecutionResult>;
     /**
      * @param {AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param} arg
      *   - Arg object
@@ -36,8 +36,9 @@ declare class Analytics {
      * @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/).
+     * @description: Initiates download job and returns job name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/startDownloadForQueryV2/).
      */
     startDownloadForQueryV2({ exportType, body, requestHeaders }?: AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param, { responseHeaders }?: object): Promise<any>;
 }
 import AnalyticsPlatformApplicationValidator = require("./AnalyticsPlatformApplicationValidator");
+import AnalyticsPlatformModel = require("./AnalyticsPlatformModel");

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js

@@ -21,10 +21,10 @@ class Analytics {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<Object>} - Success response
+   * @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://partners.fynd.com/help/docs/sdk/platform/analytics/checkJobStatusByNameV2/).
+   * @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: {} },
@@ -75,9 +75,12 @@ class Analytics {
       responseData = response[0];
     }
 
-    const { error: res_error } = Joi.object()
-      .pattern(/\S/, Joi.any())
-      .validate(responseData, { abortEarly: false, allowUnknown: true });
+    const {
+      error: res_error,
+    } = AnalyticsPlatformModel.JobStatus().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -99,10 +102,10 @@ class Analytics {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<Object>} - Success response
+   * @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://partners.fynd.com/help/docs/sdk/platform/analytics/executeJobForProvidedParametersV2/).
+   * @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
    */
   async executeJobForProvidedParametersV2(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -153,9 +156,12 @@ class Analytics {
       responseData = response[0];
     }
 
-    const { error: res_error } = Joi.object()
-      .pattern(/\S/, Joi.any())
-      .validate(responseData, { abortEarly: false, allowUnknown: true });
+    const {
+      error: res_error,
+    } = AnalyticsPlatformModel.JobExecutionResult().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -180,7 +186,7 @@ class Analytics {
    * @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/).
+   * @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: {} },

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

@@ -9,7 +9,7 @@ export = AnalyticsPlatformApplicationValidator;
  */
 /**
  * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType
+ * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
  * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
  */
 declare class AnalyticsPlatformApplicationValidator {
@@ -33,6 +33,9 @@ type ExecuteJobForProvidedParametersV2Param = {
     body: AnalyticsPlatformModel.JobExecute;
 };
 type StartDownloadForQueryV2Param = {
+    /**
+     * - Format in which to be exported(eg. CSV or excel).
+     */
     exportType: string;
     body: AnalyticsPlatformModel.FileDownloadRequestBody;
 };

package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js

@@ -14,7 +14,7 @@ const AnalyticsPlatformModel = require("./AnalyticsPlatformModel");
 
 /**
  * @typedef StartDownloadForQueryV2Param
- * @property {string} exportType
+ * @property {string} exportType - Format in which to be exported(eg. CSV or excel).
  * @property {AnalyticsPlatformModel.FileDownloadRequestBody} body
  */
 

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

@@ -1,35 +1,51 @@
 export = AnalyticsPlatformModel;
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the 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, such as 'PageType'.
+ * @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 query to execute on clickhouse.
- * @property {boolean} [split_files] - Flag to indicate whether to split files
- *   for larger data.
+ * @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 query to execute on clickhouse.
+ * @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 };
+    export { Page, FileDownloadRequestBody, JobExecute, JobExecutionResult, JobStatus };
 }
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**
@@ -49,24 +65,28 @@ type Page = {
      */
     current?: number;
     /**
-     * - The type of the page, such as 'PageType'.
+     * - 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 query to execute on clickhouse.
+     * - Base64 encoded SQL query to execute on ClickHouse.
      */
     query: string;
     /**
-     * - Flag to indicate whether to split files
-     * for larger data.
+     * - Flag indicating whether to split the
+     * files for larger datasets.
      */
     split_files?: boolean;
 };
@@ -74,8 +94,43 @@ type FileDownloadRequestBody = {
 declare function JobExecute(): JobExecute;
 type JobExecute = {
     /**
-     * - Base64 encoded query to execute on clickhouse.
+     * - 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

@@ -2,28 +2,46 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the 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, such as 'PageType'.
+ * @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 query to execute on clickhouse.
- * @property {boolean} [split_files] - Flag to indicate whether to split files
- *   for larger data.
+ * @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 query to execute on clickhouse.
+ * @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() {
@@ -35,6 +53,7 @@ class AnalyticsPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 
@@ -53,5 +72,24 @@ class AnalyticsPlatformModel {
       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;

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts

@@ -6,42 +6,12 @@ declare class AuditTrail {
      * @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
+     * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
      * @name createAuditLog
      * @summary: Create an audit log
-     * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
+     * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/audittrail/createAuditLog/).
      */
-    createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResponse>;
-    /**
-     * @param {AuditTrailPlatformValidator.GetAuditLogParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
-     * @name getAuditLog
-     * @summary: Get an audit log
-     * @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
-     */
-    getAuditLog({ id, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
-    /**
-     * @param {AuditTrailPlatformValidator.GetAuditLogsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
-     * @name getAuditLogs
-     * @summary: Get audit logs
-     * @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
-     */
-    getAuditLogs({ qs, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
-    /**
-     * @param {AuditTrailPlatformValidator.GetEntityTypesParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
-     * @name getEntityTypes
-     * @summary: List entity types
-     * @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
-     */
-    getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
+    createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResp>;
 }
 import AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
 import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");