@gofynd/fdk-client-javascript 1.4.6 → 1.4.7

package/sdk/application/Webhook/WebhookApplicationClient.js

@@ -0,0 +1,115 @@
+const ApplicationAPIClient = require("../ApplicationAPIClient");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
+const WebhookApplicationValidator = require("./WebhookApplicationValidator");
+const WebhookApplicationModel = require("./WebhookApplicationModel");
+const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
+
+class Webhook {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      saveClickEvent:
+        "/service/application/webhook/v1.0/click-analytics/events",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {WebhookApplicationValidator.SaveClickEventParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../ApplicationAPIClient").Options} - Options
+   * @returns {Promise<WebhookApplicationModel.ClickEventResponse>} - Success response
+   * @name saveClickEvent
+   * @summary: Endpoint to capture click events from sales channels and persist them in database.
+   * @description: Endpoint to capture click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
+   */
+  async saveClickEvent(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = WebhookApplicationValidator.saveClickEvent().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,
+    } = WebhookApplicationValidator.saveClickEvent().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for application > Webhook > saveClickEvent \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await ApplicationAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["saveClickEvent"],
+        params: {},
+      }),
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = WebhookApplicationModel.ClickEventResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for application > Webhook > saveClickEvent \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+}
+
+module.exports = Webhook;

package/sdk/application/Webhook/WebhookApplicationModel.d.ts

@@ -0,0 +1,37 @@
+export = WebhookApplicationModel;
+/**
+ * @typedef ClickEventBatch
+ * @property {string} [event_name]
+ */
+/**
+ * @typedef ClickEventRequest
+ * @property {ClickEventBatch[]} [batch]
+ */
+/**
+ * @typedef ClickEventResponse
+ * @property {number} [success_count]
+ * @property {number} [failed_count]
+ * @property {ClickEventBatch[]} [failed_events]
+ */
+declare class WebhookApplicationModel {
+}
+declare namespace WebhookApplicationModel {
+    export { ClickEventBatch, ClickEventRequest, ClickEventResponse };
+}
+/** @returns {ClickEventBatch} */
+declare function ClickEventBatch(): ClickEventBatch;
+type ClickEventBatch = {
+    event_name?: string;
+};
+/** @returns {ClickEventRequest} */
+declare function ClickEventRequest(): ClickEventRequest;
+type ClickEventRequest = {
+    batch?: ClickEventBatch[];
+};
+/** @returns {ClickEventResponse} */
+declare function ClickEventResponse(): ClickEventResponse;
+type ClickEventResponse = {
+    success_count?: number;
+    failed_count?: number;
+    failed_events?: ClickEventBatch[];
+};

package/sdk/application/Webhook/WebhookApplicationModel.js

@@ -0,0 +1,46 @@
+const Joi = require("joi");
+
+/**
+ * @typedef ClickEventBatch
+ * @property {string} [event_name]
+ */
+
+/**
+ * @typedef ClickEventRequest
+ * @property {ClickEventBatch[]} [batch]
+ */
+
+/**
+ * @typedef ClickEventResponse
+ * @property {number} [success_count]
+ * @property {number} [failed_count]
+ * @property {ClickEventBatch[]} [failed_events]
+ */
+
+class WebhookApplicationModel {
+  /** @returns {ClickEventBatch} */
+  static ClickEventBatch() {
+    return Joi.object({
+      event_name: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ClickEventRequest} */
+  static ClickEventRequest() {
+    return Joi.object({
+      batch: Joi.array().items(WebhookApplicationModel.ClickEventBatch()),
+    });
+  }
+
+  /** @returns {ClickEventResponse} */
+  static ClickEventResponse() {
+    return Joi.object({
+      success_count: Joi.number(),
+      failed_count: Joi.number(),
+      failed_events: Joi.array().items(
+        WebhookApplicationModel.ClickEventBatch()
+      ),
+    });
+  }
+}
+module.exports = WebhookApplicationModel;

package/sdk/application/Webhook/WebhookApplicationValidator.d.ts

@@ -0,0 +1,16 @@
+export = WebhookApplicationValidator;
+/**
+ * @typedef SaveClickEventParam
+ * @property {WebhookApplicationModel.ClickEventRequest} body
+ */
+declare class WebhookApplicationValidator {
+    /** @returns {SaveClickEventParam} */
+    static saveClickEvent(): SaveClickEventParam;
+}
+declare namespace WebhookApplicationValidator {
+    export { SaveClickEventParam };
+}
+type SaveClickEventParam = {
+    body: WebhookApplicationModel.ClickEventRequest;
+};
+import WebhookApplicationModel = require("./WebhookApplicationModel");

package/sdk/application/Webhook/WebhookApplicationValidator.js

@@ -0,0 +1,19 @@
+const Joi = require("joi");
+
+const WebhookApplicationModel = require("./WebhookApplicationModel");
+
+/**
+ * @typedef SaveClickEventParam
+ * @property {WebhookApplicationModel.ClickEventRequest} body
+ */
+
+class WebhookApplicationValidator {
+  /** @returns {SaveClickEventParam} */
+  static saveClickEvent() {
+    return Joi.object({
+      body: WebhookApplicationModel.ClickEventRequest().required(),
+    }).required();
+  }
+}
+
+module.exports = WebhookApplicationValidator;

package/sdk/application/index.d.ts

@@ -16,4 +16,5 @@ export namespace ApplicationModel {
     const ShareApplicationModel: typeof import("./Share/ShareApplicationModel");
     const ThemeApplicationModel: typeof import("./Theme/ThemeApplicationModel");
     const UserApplicationModel: typeof import("./User/UserApplicationModel");
+    const WebhookApplicationModel: typeof import("./Webhook/WebhookApplicationModel");
 }

package/sdk/application/index.js

@@ -31,5 +31,7 @@ module.exports = {
     ThemeApplicationModel: require("./Theme/ThemeApplicationModel"),
 
     UserApplicationModel: require("./User/UserApplicationModel"),
+
+    WebhookApplicationModel: require("./Webhook/WebhookApplicationModel"),
   },
 };

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

@@ -58,7 +58,7 @@ declare class Webhook {
      * @param {import("../PartnerAPIClient").Options} - Options
      * @returns {Promise<WebhookPartnerModel.HistoryResponse>} - Success response
      * @name getHistoricalReports
-     * @summary: Get report download history
+     * @summary: Get report download history.
      * @description: Retrieve history reports for a specific company based on the provided filters.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/getHistoricalReports/).
      */
@@ -90,7 +90,7 @@ declare class Webhook {
      * @param {import("../PartnerAPIClient").Options} - Options
      * @returns {Promise<WebhookPartnerModel.UpdateSubscriberResponse>} - Success response
      * @name updateSubscriber
-     * @summary: Update subscriber status by id
+     * @summary: Update subscriber status by id.
      * @description: Update subscriber status by id.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/updateSubscriber/).
      */

package/sdk/partner/Webhook/WebhookPartnerClient.js

@@ -438,7 +438,7 @@ class Webhook {
    * @param {import("../PartnerAPIClient").Options} - Options
    * @returns {Promise<WebhookPartnerModel.HistoryResponse>} - Success response
    * @name getHistoricalReports
-   * @summary: Get report download history
+   * @summary: Get report download history.
    * @description: Retrieve history reports for a specific company based on the provided filters.
    *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/getHistoricalReports/).
    */
@@ -672,7 +672,7 @@ class Webhook {
    * @param {import("../PartnerAPIClient").Options} - Options
    * @returns {Promise<WebhookPartnerModel.UpdateSubscriberResponse>} - Success response
    * @name updateSubscriber
-   * @summary: Update subscriber status by id
+   * @summary: Update subscriber status by id.
    * @description: Update subscriber status by id.
    *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/webhook/updateSubscriber/).
    */

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

@@ -1,12 +1,12 @@
 export = WebhookPartnerModel;
-/**
- * @typedef UpdateSubscriberResponse
- * @property {string} [message]
- */
 /**
  * @typedef UpdateSubscriberRequest
  * @property {string} [status]
  */
+/**
+ * @typedef UpdateSubscriberResponse
+ * @property {string} [message]
+ */
 /**
  * @typedef Association
  * @property {number} [company_id]
@@ -24,6 +24,7 @@ export = WebhookPartnerModel;
  * @property {number} [id]
  * @property {number} [event_id]
  * @property {number} [subscriber_id]
+ * @property {string} [topic]
  * @property {string} [created_on]
  */
 /**
@@ -38,6 +39,7 @@ export = WebhookPartnerModel;
  * @property {string} [description]
  * @property {string} [created_on]
  * @property {string} [updated_on]
+ * @property {string} [group]
  * @property {SubscriberEventMapping} [subscriber_event_mapping]
  */
 /**
@@ -61,10 +63,6 @@ export = WebhookPartnerModel;
  * @property {string} [category]
  * @property {number} [count]
  */
-/**
- * @typedef DownloadReponse
- * @property {string} [file_name]
- */
 /**
  * @typedef HistoryFilters
  * @property {string[]} [events]
@@ -74,6 +72,8 @@ export = WebhookPartnerModel;
  * @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).
  */
 /**
  * @typedef Url
@@ -215,6 +215,7 @@ export = WebhookPartnerModel;
  * @property {string} [modified_by]
  * @property {string} [name]
  * @property {string} [webhook_url]
+ * @property {string} [provider]
  * @property {Association} [association]
  * @property {Object} [custom_headers]
  * @property {string} [status]
@@ -229,18 +230,18 @@ export = WebhookPartnerModel;
 declare class WebhookPartnerModel {
 }
 declare namespace WebhookPartnerModel {
-    export { UpdateSubscriberResponse, UpdateSubscriberRequest, Association, AuthMeta, SubscriberEventMapping, EventConfigResponse, SubscriberConfigResponse, InvalidEventsRequest, InvalidEventsResponse, DownloadReponse, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, HistoryPayload, CancelDownloadResponse, FilterReportResponse, DeliveryTsResponse, DeliveryTsSchema, DeliveryDetailsRequest, EventDeliveryDetailSchema, DeliveryDetailsResponse, EventProcessReportObject, Page, DeliveryEventLevelSchema, DeliverySummaryResponse, DeliverySummarySchema, ItemSchema };
+    export { UpdateSubscriberRequest, UpdateSubscriberResponse, Association, AuthMeta, SubscriberEventMapping, EventConfigResponse, SubscriberConfigResponse, InvalidEventsRequest, InvalidEventsResponse, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, HistoryPayload, CancelDownloadResponse, FilterReportResponse, DeliveryTsResponse, DeliveryTsSchema, DeliveryDetailsRequest, EventDeliveryDetailSchema, DeliveryDetailsResponse, EventProcessReportObject, Page, DeliveryEventLevelSchema, DeliverySummaryResponse, DeliverySummarySchema, ItemSchema };
 }
-/** @returns {UpdateSubscriberResponse} */
-declare function UpdateSubscriberResponse(): UpdateSubscriberResponse;
-type UpdateSubscriberResponse = {
-    message?: string;
-};
 /** @returns {UpdateSubscriberRequest} */
 declare function UpdateSubscriberRequest(): UpdateSubscriberRequest;
 type UpdateSubscriberRequest = {
     status?: string;
 };
+/** @returns {UpdateSubscriberResponse} */
+declare function UpdateSubscriberResponse(): UpdateSubscriberResponse;
+type UpdateSubscriberResponse = {
+    message?: string;
+};
 /** @returns {Association} */
 declare function Association(): Association;
 type Association = {
@@ -261,6 +262,7 @@ type SubscriberEventMapping = {
     id?: number;
     event_id?: number;
     subscriber_id?: number;
+    topic?: string;
     created_on?: string;
 };
 /** @returns {EventConfigResponse} */
@@ -276,6 +278,7 @@ type EventConfigResponse = {
     description?: string;
     created_on?: string;
     updated_on?: string;
+    group?: string;
     subscriber_event_mapping?: SubscriberEventMapping;
 };
 /** @returns {SubscriberConfigResponse} */
@@ -302,11 +305,6 @@ type InvalidEventsResponse = {
     category?: string;
     count?: number;
 };
-/** @returns {DownloadReponse} */
-declare function DownloadReponse(): DownloadReponse;
-type DownloadReponse = {
-    file_name?: string;
-};
 /** @returns {HistoryFilters} */
 declare function HistoryFilters(): HistoryFilters;
 type HistoryFilters = {
@@ -329,6 +327,11 @@ type HistoryFilters = {
      * with the history report.
      */
     subscribers?: number[];
+    /**
+     * - An array of webhook type to identify
+     * thetype of subscriber i.e (KAFKA or REST).
+     */
+    webhook_type?: string[];
 };
 /** @returns {Url} */
 declare function Url(): Url;
@@ -553,6 +556,7 @@ type ItemSchema = {
     modified_by?: string;
     name?: string;
     webhook_url?: string;
+    provider?: string;
     association?: Association;
     custom_headers?: any;
     status?: string;

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");