@gofynd/fdk-client-javascript 1.4.5 → 1.4.7

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -124,6 +124,15 @@ const Joi = require("joi");
  * @property {number} [code] - The HTTP status code of the ping response (e.g., 200).
  */
 
+/**
+ * @typedef SubscriberEventMapping
+ * @property {number} [id]
+ * @property {number} [event_id]
+ * @property {number} [subscriber_id]
+ * @property {string} [topic]
+ * @property {string} [created_on]
+ */
+
 /**
  * @typedef EventConfig
  * @property {number} [id]
@@ -132,6 +141,7 @@ const Joi = require("joi");
  * @property {string} [event_category]
  * @property {SubscriberEventMapping} [subscriber_event_mapping]
  * @property {Object} [event_schema]
+ * @property {string} [group]
  * @property {string} [version]
  * @property {string} [display_name]
  * @property {string} [description]
@@ -172,6 +182,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).
  */
 
 /**
@@ -236,19 +248,12 @@ const Joi = require("joi");
  * @property {string} [secret]
  */
 
-/**
- * @typedef SubscriberEventMapping
- * @property {number} [id]
- * @property {number} [event_id]
- * @property {number} [subscriber_id]
- * @property {string} [created_on]
- */
-
 /**
  * @typedef SubscriberResponse
  * @property {number} [id]
  * @property {string} [modified_by]
  * @property {string} [name]
+ * @property {string} [provider]
  * @property {string} [webhook_url]
  * @property {Association} [association]
  * @property {Object} [custom_headers]
@@ -261,6 +266,26 @@ const Joi = require("joi");
  * @property {EventConfig[]} [event_configs]
  */
 
+/**
+ * @typedef Events
+ * @property {string} [slug]
+ * @property {string} [topic]
+ */
+
+/**
+ * @typedef SubscriberConfigRequestV2
+ * @property {number} [id]
+ * @property {string} [name]
+ * @property {string} [webhook_url]
+ * @property {string} [provider]
+ * @property {Association} [association]
+ * @property {Object} [custom_headers]
+ * @property {SubscriberStatus} [status]
+ * @property {string} [email_id]
+ * @property {AuthMeta} [auth_meta]
+ * @property {Events[]} [events]
+ */
+
 /**
  * @typedef SubscriberConfig
  * @property {number} [id]
@@ -280,6 +305,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 {SubscriberStatus} [status]
@@ -297,7 +323,7 @@ const Joi = require("joi");
  * @property {Page} [page]
  */
 
-/** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
+/** @typedef {"active" | "inactive"} SubscriberStatus */
 
 class WebhookPlatformModel {
   /** @returns {Error} */
@@ -454,6 +480,17 @@ class WebhookPlatformModel {
     });
   }
 
+  /** @returns {SubscriberEventMapping} */
+  static SubscriberEventMapping() {
+    return Joi.object({
+      id: Joi.number(),
+      event_id: Joi.number(),
+      subscriber_id: Joi.number(),
+      topic: Joi.string().allow("").allow(null),
+      created_on: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {EventConfig} */
   static EventConfig() {
     return Joi.object({
@@ -462,7 +499,8 @@ class WebhookPlatformModel {
       event_type: Joi.string().allow(""),
       event_category: Joi.string().allow(""),
       subscriber_event_mapping: WebhookPlatformModel.SubscriberEventMapping(),
-      event_schema: Joi.object().pattern(/\S/, Joi.any()),
+      event_schema: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
+      group: Joi.string().allow("").allow(null),
       version: Joi.string().allow(""),
       display_name: Joi.string().allow(""),
       description: Joi.string().allow("").allow(null),
@@ -511,6 +549,7 @@ class WebhookPlatformModel {
       end_date: Joi.string().allow(""),
       start_date: Joi.string().allow(""),
       subscribers: Joi.array().items(Joi.number()),
+      webhook_type: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -592,22 +631,13 @@ class WebhookPlatformModel {
     });
   }
 
-  /** @returns {SubscriberEventMapping} */
-  static SubscriberEventMapping() {
-    return Joi.object({
-      id: Joi.number(),
-      event_id: Joi.number(),
-      subscriber_id: Joi.number(),
-      created_on: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {SubscriberResponse} */
   static SubscriberResponse() {
     return Joi.object({
       id: Joi.number(),
       modified_by: Joi.string().allow(""),
       name: Joi.string().allow(""),
+      provider: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
       association: WebhookPlatformModel.Association(),
       custom_headers: Joi.any(),
@@ -621,6 +651,30 @@ class WebhookPlatformModel {
     });
   }
 
+  /** @returns {Events} */
+  static Events() {
+    return Joi.object({
+      slug: Joi.string().allow(""),
+      topic: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {SubscriberConfigRequestV2} */
+  static SubscriberConfigRequestV2() {
+    return Joi.object({
+      id: Joi.number(),
+      name: Joi.string().allow(""),
+      webhook_url: Joi.string().allow(""),
+      provider: Joi.string().allow(""),
+      association: WebhookPlatformModel.Association(),
+      custom_headers: Joi.any(),
+      status: WebhookPlatformModel.SubscriberStatus(),
+      email_id: Joi.string().allow(""),
+      auth_meta: WebhookPlatformModel.AuthMeta(),
+      events: Joi.array().items(WebhookPlatformModel.Events()),
+    });
+  }
+
   /** @returns {SubscriberConfig} */
   static SubscriberConfig() {
     return Joi.object({
@@ -643,6 +697,7 @@ class WebhookPlatformModel {
       modified_by: Joi.string().allow(""),
       name: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
+      provider: Joi.string().allow(""),
       association: WebhookPlatformModel.Association(),
       custom_headers: Joi.any(),
       status: WebhookPlatformModel.SubscriberStatus(),
@@ -672,9 +727,7 @@ class WebhookPlatformModel {
     return Joi.string().valid(
       "active",
 
-      "inactive",
-
-      "blocked"
+      "inactive"
     );
   }
 }

package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts

@@ -54,10 +54,18 @@ export = WebhookPlatformValidator;
  * @typedef RegisterSubscriberToEventParam
  * @property {WebhookPlatformModel.SubscriberConfig} body
  */
+/**
+ * @typedef RegisterSubscriberToEventV2Param
+ * @property {WebhookPlatformModel.SubscriberConfigRequestV2} body
+ */
 /**
  * @typedef UpdateSubscriberConfigParam
  * @property {WebhookPlatformModel.SubscriberConfig} body
  */
+/**
+ * @typedef UpdateSubscriberV2Param
+ * @property {WebhookPlatformModel.SubscriberConfigRequestV2} body
+ */
 declare class WebhookPlatformValidator {
     /** @returns {CancelJobByNameParam} */
     static cancelJobByName(): CancelJobByNameParam;
@@ -89,11 +97,15 @@ declare class WebhookPlatformValidator {
     static pingWebhook(): PingWebhookParam;
     /** @returns {RegisterSubscriberToEventParam} */
     static registerSubscriberToEvent(): RegisterSubscriberToEventParam;
+    /** @returns {RegisterSubscriberToEventV2Param} */
+    static registerSubscriberToEventV2(): RegisterSubscriberToEventV2Param;
     /** @returns {UpdateSubscriberConfigParam} */
     static updateSubscriberConfig(): UpdateSubscriberConfigParam;
+    /** @returns {UpdateSubscriberV2Param} */
+    static updateSubscriberV2(): UpdateSubscriberV2Param;
 }
 declare namespace WebhookPlatformValidator {
-    export { CancelJobByNameParam, DownloadDeliveryReportParam, FetchAllEventConfigurationsParam, GetDeliveryReportsParam, GetEventCountsParam, GetHistoricalReportsParam, GetManualRetryStatusParam, GetReportFiltersParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, ManualRetryCancelParam, ManualRetryOfFailedEventParam, PingWebhookParam, RegisterSubscriberToEventParam, UpdateSubscriberConfigParam };
+    export { CancelJobByNameParam, DownloadDeliveryReportParam, FetchAllEventConfigurationsParam, GetDeliveryReportsParam, GetEventCountsParam, GetHistoricalReportsParam, GetManualRetryStatusParam, GetReportFiltersParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, ManualRetryCancelParam, ManualRetryOfFailedEventParam, PingWebhookParam, RegisterSubscriberToEventParam, RegisterSubscriberToEventV2Param, UpdateSubscriberConfigParam, UpdateSubscriberV2Param };
 }
 type CancelJobByNameParam = {
     filename: string;
@@ -156,9 +168,15 @@ type PingWebhookParam = {
 type RegisterSubscriberToEventParam = {
     body: WebhookPlatformModel.SubscriberConfig;
 };
+type RegisterSubscriberToEventV2Param = {
+    body: WebhookPlatformModel.SubscriberConfigRequestV2;
+};
 type UpdateSubscriberConfigParam = {
     body: WebhookPlatformModel.SubscriberConfig;
 };
+type UpdateSubscriberV2Param = {
+    body: WebhookPlatformModel.SubscriberConfigRequestV2;
+};
 type FetchAllEventConfigurationsParam = any;
 type GetManualRetryStatusParam = any;
 type ManualRetryCancelParam = any;

package/sdk/platform/Webhook/WebhookPlatformValidator.js

@@ -72,11 +72,21 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
  * @property {WebhookPlatformModel.SubscriberConfig} body
  */
 
+/**
+ * @typedef RegisterSubscriberToEventV2Param
+ * @property {WebhookPlatformModel.SubscriberConfigRequestV2} body
+ */
+
 /**
  * @typedef UpdateSubscriberConfigParam
  * @property {WebhookPlatformModel.SubscriberConfig} body
  */
 
+/**
+ * @typedef UpdateSubscriberV2Param
+ * @property {WebhookPlatformModel.SubscriberConfigRequestV2} body
+ */
+
 class WebhookPlatformValidator {
   /** @returns {CancelJobByNameParam} */
   static cancelJobByName() {
@@ -181,12 +191,26 @@ class WebhookPlatformValidator {
     }).required();
   }
 
+  /** @returns {RegisterSubscriberToEventV2Param} */
+  static registerSubscriberToEventV2() {
+    return Joi.object({
+      body: WebhookPlatformModel.SubscriberConfigRequestV2().required(),
+    }).required();
+  }
+
   /** @returns {UpdateSubscriberConfigParam} */
   static updateSubscriberConfig() {
     return Joi.object({
       body: WebhookPlatformModel.SubscriberConfig().required(),
     }).required();
   }
+
+  /** @returns {UpdateSubscriberV2Param} */
+  static updateSubscriberV2() {
+    return Joi.object({
+      body: WebhookPlatformModel.SubscriberConfigRequestV2().required(),
+    }).required();
+  }
 }
 
 module.exports = WebhookPlatformValidator;

package/sdk/platform/index.d.ts

@@ -1,6 +1,7 @@
 export const PlatformConfig: typeof import("./PlatformConfig");
 export const PlatformClient: typeof import("./PlatformClient");
 export namespace PlatformModel {
+    const AnalyticsPlatformModel: typeof import("./Analytics/AnalyticsPlatformModel");
     const AuditTrailPlatformModel: typeof import("./AuditTrail/AuditTrailPlatformModel");
     const BillingPlatformModel: typeof import("./Billing/BillingPlatformModel");
     const CartPlatformModel: typeof import("./Cart/CartPlatformModel");

package/sdk/platform/index.js

@@ -2,6 +2,8 @@ module.exports = {
   PlatformConfig: require("./PlatformConfig"),
   PlatformClient: require("./PlatformClient"),
   PlatformModel: {
+    AnalyticsPlatformModel: require("./Analytics/AnalyticsPlatformModel"),
+
     AuditTrailPlatformModel: require("./AuditTrail/AuditTrailPlatformModel"),
 
     BillingPlatformModel: require("./Billing/BillingPlatformModel"),

package/sdk/public/Webhook/WebhookPublicClient.d.ts

@@ -17,7 +17,7 @@ declare class Webhook {
      * @param {import("../PublicAPIClient").Options} - Options
      * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
      * @name fetchAllWebhookEvents
-     * @summary: Fetch all webhook events
+     * @summary: Fetch all webhook events.
      * @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
      */
     fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
@@ -37,7 +37,7 @@ declare class Webhook {
      * @param {import("../PublicAPIClient").Options} - Options
      * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
      * @name queryWebhookEventDetails
-     * @summary: Query webhook event details
+     * @summary: Query webhook event details.
      * @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
      */
     queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;

package/sdk/public/Webhook/WebhookPublicClient.js

@@ -46,7 +46,7 @@ class Webhook {
    * @param {import("../PublicAPIClient").Options} - Options
    * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
    * @name fetchAllWebhookEvents
-   * @summary: Fetch all webhook events
+   * @summary: Fetch all webhook events.
    * @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
    */
   async fetchAllWebhookEvents(
@@ -202,7 +202,7 @@ class Webhook {
    * @param {import("../PublicAPIClient").Options} - Options
    * @returns {Promise<WebhookPublicModel.EventConfigResponse>} - Success response
    * @name queryWebhookEventDetails
-   * @summary: Query webhook event details
+   * @summary: Query webhook event details.
    * @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
    */
   async queryWebhookEventDetails(

package/sdk/public/Webhook/WebhookPublicModel.d.ts

@@ -11,6 +11,7 @@ export = WebhookPublicModel;
  * @property {string} [description]
  * @property {string} [created_on]
  * @property {string} [updated_on]
+ * @property {string} [group]
  */
 /**
  * @typedef EventConfigResponse
@@ -107,6 +108,7 @@ type EventConfig = {
     description?: string;
     created_on?: string;
     updated_on?: string;
+    group?: string;
 };
 /** @returns {EventConfigResponse} */
 declare function EventConfigResponse(): EventConfigResponse;

package/sdk/public/Webhook/WebhookPublicModel.js

@@ -12,6 +12,7 @@ const Joi = require("joi");
  * @property {string} [description]
  * @property {string} [created_on]
  * @property {string} [updated_on]
+ * @property {string} [group]
  */
 
 /**
@@ -111,12 +112,13 @@ class WebhookPublicModel {
       event_name: Joi.string().allow(""),
       event_type: Joi.string().allow(""),
       event_category: Joi.string().allow(""),
-      event_schema: Joi.object().pattern(/\S/, Joi.any()),
+      event_schema: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       version: Joi.string().allow(""),
       display_name: Joi.string().allow(""),
       description: Joi.string().allow("").allow(null),
       created_on: Joi.string().allow(""),
       updated_on: Joi.string().allow(""),
+      group: Joi.string().allow("").allow(null),
     });
   }