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

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -1,10 +1,5 @@
 const Joi = require("joi");
 
-/**
- * @typedef Error
- * @property {string} [error] - Error message describing the reason for the failure.
- */
-
 /**
  * @typedef Event
  * @property {string} [event_name]
@@ -13,62 +8,14 @@ const Joi = require("joi");
  * @property {string} [version]
  */
 
-/**
- * @typedef RetryEventRequest
- * @property {string} [search_text]
- * @property {string} [end_date]
- * @property {string} [start_date]
- * @property {number[]} [subscriber_ids]
- * @property {Event[]} [event]
- * @property {string} [status]
- */
-
-/**
- * @typedef Item
- * @property {string} [status]
- * @property {number} [count]
- */
-
-/**
- * @typedef RetryCountResponse
- * @property {Item[]} [items]
- */
-
-/**
- * @typedef RetrySuccessResponse
- * @property {boolean} [success]
- * @property {string} [message]
- */
-
-/**
- * @typedef Err
- * @property {string} [msg]
- * @property {string} [param]
- * @property {string} [location]
- */
-
-/**
- * @typedef RetryFailureResponse
- * @property {Err[]} [err]
- */
-
-/**
- * @typedef RetryStatusResponse
- * @property {number} [total_event] - The total number of events that require retry.
- * @property {number} [success_count] - The count of successfully retried events.
- * @property {number} [failure_count] - The count of failed retry attempts.
- * @property {string} [status] - The overall status of the retry process (e.g.,
- *   "completed").
- */
-
 /**
  * @typedef EventProcessRequest
- * @property {string} [search_text]
- * @property {string} [end_date]
- * @property {string} [start_date]
- * @property {number[]} [subscriber_ids]
- * @property {string} [status]
- * @property {Event[]} [event]
+ * @property {string} search_text
+ * @property {string} end_date
+ * @property {string} start_date
+ * @property {number[]} subscriber_ids
+ * @property {string} status
+ * @property {Event[]} event
  */
 
 /**
@@ -111,7 +58,7 @@ const Joi = require("joi");
 
 /**
  * @typedef PingWebhook
- * @property {string} [webhook_url] - The URL of the subscriber's webhook to ping.
+ * @property {string} webhook_url - The URL of the subscriber's webhook to ping.
  * @property {Object} [auth_meta] - Authentication metadata (if required by the
  *   subscriber).
  * @property {Object} [custom_headers] - Custom headers to include in the ping request.
@@ -124,6 +71,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 +88,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]
@@ -146,7 +103,7 @@ const Joi = require("joi");
 
 /**
  * @typedef ReportFiltersPayload
- * @property {number[]} [subscriber_ids] - An array of subscriber IDs for
+ * @property {number[]} subscriber_ids - An array of subscriber IDs for
  *   filtering filters (optional).
  */
 
@@ -158,7 +115,7 @@ const Joi = require("joi");
 
 /**
  * @typedef HistoryPayload
- * @property {string} [type] - The type of history report (e.g., "platform").
+ * @property {string} type - The type of history report (e.g., "platform").
  * @property {number} [page_no] - The page number of the history report.
  * @property {number} [page_size] - The number of records per page.
  */
@@ -172,6 +129,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).
  */
 
 /**
@@ -224,6 +183,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Association
+ * @property {string[]} [application_id]
+ * @property {string} [extension_id]
+ * @property {string} [criteria]
+ */
+
+/**
+ * @typedef AssociationResp
  * @property {number} [company_id]
  * @property {string[]} [application_id]
  * @property {string} [extension_id]
@@ -236,21 +202,14 @@ 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 {AssociationResp} [association]
  * @property {Object} [custom_headers]
  * @property {SubscriberStatus} [status]
  * @property {string} [email_id]
@@ -262,16 +221,61 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef SubscriberConfig
- * @property {number} [id]
+ * @typedef Events
+ * @property {string} [slug]
+ * @property {string} [topic]
+ */
+
+/**
+ * @typedef SubscriberConfigPostRequestV2
  * @property {string} [name]
  * @property {string} [webhook_url]
- * @property {Association} [association]
+ * @property {string} provider
+ * @property {Association} association
  * @property {Object} [custom_headers]
- * @property {SubscriberStatus} [status]
- * @property {string} [email_id]
+ * @property {SubscriberStatus} status
+ * @property {string} email_id
  * @property {AuthMeta} [auth_meta]
- * @property {number[]} [event_id]
+ * @property {Events[]} [events]
+ */
+
+/**
+ * @typedef SubscriberConfigUpdateRequestV2
+ * @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 SubscriberConfigPost
+ * @property {string} [name]
+ * @property {string} webhook_url
+ * @property {Association} association
+ * @property {Object} [custom_headers]
+ * @property {SubscriberStatus} status
+ * @property {string} email_id
+ * @property {AuthMeta} [auth_meta]
+ * @property {number[]} event_id
+ */
+
+/**
+ * @typedef SubscriberConfigUpdate
+ * @property {number} id
+ * @property {string} [name]
+ * @property {string} webhook_url
+ * @property {Association} association
+ * @property {Object} [custom_headers]
+ * @property {SubscriberStatus} status
+ * @property {string} email_id
+ * @property {AuthMeta} [auth_meta]
+ * @property {number[]} event_id
  */
 
 /**
@@ -280,7 +284,8 @@ const Joi = require("joi");
  * @property {string} [modified_by]
  * @property {string} [name]
  * @property {string} [webhook_url]
- * @property {Association} [association]
+ * @property {string} [provider]
+ * @property {AssociationResp} [association]
  * @property {Object} [custom_headers]
  * @property {SubscriberStatus} [status]
  * @property {string} [email_id]
@@ -297,16 +302,9 @@ const Joi = require("joi");
  * @property {Page} [page]
  */
 
-/** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
+/** @typedef {"active" | "inactive"} SubscriberStatus */
 
 class WebhookPlatformModel {
-  /** @returns {Error} */
-  static Error() {
-    return Joi.object({
-      error: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {Event} */
   static Event() {
     return Joi.object({
@@ -317,76 +315,15 @@ class WebhookPlatformModel {
     });
   }
 
-  /** @returns {RetryEventRequest} */
-  static RetryEventRequest() {
-    return Joi.object({
-      search_text: Joi.string().allow(""),
-      end_date: Joi.string().allow(""),
-      start_date: Joi.string().allow(""),
-      subscriber_ids: Joi.array().items(Joi.number()),
-      event: Joi.array().items(WebhookPlatformModel.Event()),
-      status: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Item} */
-  static Item() {
-    return Joi.object({
-      status: Joi.string().allow(""),
-      count: Joi.number(),
-    });
-  }
-
-  /** @returns {RetryCountResponse} */
-  static RetryCountResponse() {
-    return Joi.object({
-      items: Joi.array().items(WebhookPlatformModel.Item()),
-    });
-  }
-
-  /** @returns {RetrySuccessResponse} */
-  static RetrySuccessResponse() {
-    return Joi.object({
-      success: Joi.boolean(),
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {Err} */
-  static Err() {
-    return Joi.object({
-      msg: Joi.string().allow(""),
-      param: Joi.string().allow(""),
-      location: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {RetryFailureResponse} */
-  static RetryFailureResponse() {
-    return Joi.object({
-      err: Joi.array().items(WebhookPlatformModel.Err()),
-    });
-  }
-
-  /** @returns {RetryStatusResponse} */
-  static RetryStatusResponse() {
-    return Joi.object({
-      total_event: Joi.number(),
-      success_count: Joi.number(),
-      failure_count: Joi.number(),
-      status: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {EventProcessRequest} */
   static EventProcessRequest() {
     return Joi.object({
-      search_text: Joi.string().allow(""),
-      end_date: Joi.string().allow(""),
-      start_date: Joi.string().allow(""),
-      subscriber_ids: Joi.array().items(Joi.number()),
-      status: Joi.string().allow(""),
-      event: Joi.array().items(WebhookPlatformModel.Event()),
+      search_text: Joi.string().allow("").required(),
+      end_date: Joi.string().allow("").required(),
+      start_date: Joi.string().allow("").required(),
+      subscriber_ids: Joi.array().items(Joi.number()).required(),
+      status: Joi.string().allow("").required(),
+      event: Joi.array().items(WebhookPlatformModel.Event()).required(),
     });
   }
 
@@ -439,7 +376,7 @@ class WebhookPlatformModel {
   /** @returns {PingWebhook} */
   static PingWebhook() {
     return Joi.object({
-      webhook_url: Joi.string().allow(""),
+      webhook_url: Joi.string().allow("").required(),
       auth_meta: Joi.any(),
       custom_headers: Joi.any(),
     });
@@ -454,6 +391,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({
@@ -463,6 +411,7 @@ class WebhookPlatformModel {
       event_category: Joi.string().allow(""),
       subscriber_event_mapping: WebhookPlatformModel.SubscriberEventMapping(),
       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),
@@ -481,7 +430,7 @@ class WebhookPlatformModel {
   /** @returns {ReportFiltersPayload} */
   static ReportFiltersPayload() {
     return Joi.object({
-      subscriber_ids: Joi.array().items(Joi.number()),
+      subscriber_ids: Joi.array().items(Joi.number()).required(),
     });
   }
 
@@ -496,7 +445,7 @@ class WebhookPlatformModel {
   /** @returns {HistoryPayload} */
   static HistoryPayload() {
     return Joi.object({
-      type: Joi.string().allow(""),
+      type: Joi.string().allow("").required(),
       page_no: Joi.number(),
       page_size: Joi.number(),
     });
@@ -511,6 +460,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("")),
     });
   }
 
@@ -576,6 +526,15 @@ class WebhookPlatformModel {
 
   /** @returns {Association} */
   static Association() {
+    return Joi.object({
+      application_id: Joi.array().items(Joi.string().allow("")),
+      extension_id: Joi.string().allow(""),
+      criteria: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {AssociationResp} */
+  static AssociationResp() {
     return Joi.object({
       company_id: Joi.number(),
       application_id: Joi.array().items(Joi.string().allow("")),
@@ -592,24 +551,15 @@ 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(),
+      association: WebhookPlatformModel.AssociationResp(),
       custom_headers: Joi.any(),
       status: WebhookPlatformModel.SubscriberStatus(),
       email_id: Joi.string().allow(""),
@@ -621,18 +571,71 @@ class WebhookPlatformModel {
     });
   }
 
-  /** @returns {SubscriberConfig} */
-  static SubscriberConfig() {
+  /** @returns {Events} */
+  static Events() {
+    return Joi.object({
+      slug: Joi.string().allow(""),
+      topic: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {SubscriberConfigPostRequestV2} */
+  static SubscriberConfigPostRequestV2() {
     return Joi.object({
-      id: Joi.number(),
       name: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
-      association: WebhookPlatformModel.Association(),
+      provider: Joi.string().allow("").required(),
+      association: WebhookPlatformModel.Association().required(),
       custom_headers: Joi.any(),
-      status: WebhookPlatformModel.SubscriberStatus(),
-      email_id: Joi.string().allow(""),
+      status: WebhookPlatformModel.SubscriberStatus().required(),
+      email_id: Joi.string().allow("").required(),
       auth_meta: WebhookPlatformModel.AuthMeta(),
-      event_id: Joi.array().items(Joi.number()),
+      events: Joi.array().items(WebhookPlatformModel.Events()),
+    });
+  }
+
+  /** @returns {SubscriberConfigUpdateRequestV2} */
+  static SubscriberConfigUpdateRequestV2() {
+    return Joi.object({
+      id: Joi.number().required(),
+      name: Joi.string().allow(""),
+      webhook_url: Joi.string().allow(""),
+      provider: Joi.string().allow("").required(),
+      association: WebhookPlatformModel.Association().required(),
+      custom_headers: Joi.any(),
+      status: WebhookPlatformModel.SubscriberStatus().required(),
+      email_id: Joi.string().allow("").required(),
+      auth_meta: WebhookPlatformModel.AuthMeta(),
+      events: Joi.array().items(WebhookPlatformModel.Events()),
+    });
+  }
+
+  /** @returns {SubscriberConfigPost} */
+  static SubscriberConfigPost() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+      webhook_url: Joi.string().allow("").required(),
+      association: WebhookPlatformModel.Association().required(),
+      custom_headers: Joi.any(),
+      status: WebhookPlatformModel.SubscriberStatus().required(),
+      email_id: Joi.string().allow("").required(),
+      auth_meta: WebhookPlatformModel.AuthMeta(),
+      event_id: Joi.array().items(Joi.number()).required(),
+    });
+  }
+
+  /** @returns {SubscriberConfigUpdate} */
+  static SubscriberConfigUpdate() {
+    return Joi.object({
+      id: Joi.number().required(),
+      name: Joi.string().allow(""),
+      webhook_url: Joi.string().allow("").required(),
+      association: WebhookPlatformModel.Association().required(),
+      custom_headers: Joi.any(),
+      status: WebhookPlatformModel.SubscriberStatus().required(),
+      email_id: Joi.string().allow("").required(),
+      auth_meta: WebhookPlatformModel.AuthMeta(),
+      event_id: Joi.array().items(Joi.number()).required(),
     });
   }
 
@@ -643,7 +646,8 @@ class WebhookPlatformModel {
       modified_by: Joi.string().allow(""),
       name: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
-      association: WebhookPlatformModel.Association(),
+      provider: Joi.string().allow(""),
+      association: WebhookPlatformModel.AssociationResp(),
       custom_headers: Joi.any(),
       status: WebhookPlatformModel.SubscriberStatus(),
       email_id: Joi.string().allow(""),
@@ -672,9 +676,7 @@ class WebhookPlatformModel {
     return Joi.string().valid(
       "active",
 
-      "inactive",
-
-      "blocked"
+      "inactive"
     );
   }
 }

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

@@ -12,15 +12,10 @@ export = WebhookPlatformValidator;
  * @typedef GetDeliveryReportsParam
  * @property {WebhookPlatformModel.EventProcessRequest} body
  */
-/**
- * @typedef GetEventCountsParam
- * @property {WebhookPlatformModel.RetryEventRequest} body
- */
 /**
  * @typedef GetHistoricalReportsParam
  * @property {WebhookPlatformModel.HistoryPayload} body
  */
-/** @typedef GetManualRetryStatusParam */
 /**
  * @typedef GetReportFiltersParam
  * @property {WebhookPlatformModel.ReportFiltersPayload} body
@@ -41,22 +36,25 @@ export = WebhookPlatformValidator;
  * @property {number} [pageSize] - Page Size
  * @property {string} extensionId - Extension_id
  */
-/** @typedef ManualRetryCancelParam */
-/**
- * @typedef ManualRetryOfFailedEventParam
- * @property {WebhookPlatformModel.RetryEventRequest} body
- */
 /**
  * @typedef PingWebhookParam
  * @property {WebhookPlatformModel.PingWebhook} body
  */
 /**
  * @typedef RegisterSubscriberToEventParam
- * @property {WebhookPlatformModel.SubscriberConfig} body
+ * @property {WebhookPlatformModel.SubscriberConfigPost} body
+ */
+/**
+ * @typedef RegisterSubscriberToEventV2Param
+ * @property {WebhookPlatformModel.SubscriberConfigPostRequestV2} body
  */
 /**
  * @typedef UpdateSubscriberConfigParam
- * @property {WebhookPlatformModel.SubscriberConfig} body
+ * @property {WebhookPlatformModel.SubscriberConfigUpdate} body
+ */
+/**
+ * @typedef UpdateSubscriberV2Param
+ * @property {WebhookPlatformModel.SubscriberConfigUpdateRequestV2} body
  */
 declare class WebhookPlatformValidator {
     /** @returns {CancelJobByNameParam} */
@@ -67,12 +65,8 @@ declare class WebhookPlatformValidator {
     static fetchAllEventConfigurations(): any;
     /** @returns {GetDeliveryReportsParam} */
     static getDeliveryReports(): GetDeliveryReportsParam;
-    /** @returns {GetEventCountsParam} */
-    static getEventCounts(): GetEventCountsParam;
     /** @returns {GetHistoricalReportsParam} */
     static getHistoricalReports(): GetHistoricalReportsParam;
-    /** @returns {GetManualRetryStatusParam} */
-    static getManualRetryStatus(): any;
     /** @returns {GetReportFiltersParam} */
     static getReportFilters(): GetReportFiltersParam;
     /** @returns {GetSubscriberByIdParam} */
@@ -81,19 +75,19 @@ declare class WebhookPlatformValidator {
     static getSubscribersByCompany(): GetSubscribersByCompanyParam;
     /** @returns {GetSubscribersByExtensionIdParam} */
     static getSubscribersByExtensionId(): GetSubscribersByExtensionIdParam;
-    /** @returns {ManualRetryCancelParam} */
-    static manualRetryCancel(): any;
-    /** @returns {ManualRetryOfFailedEventParam} */
-    static manualRetryOfFailedEvent(): ManualRetryOfFailedEventParam;
     /** @returns {PingWebhookParam} */
     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, GetHistoricalReportsParam, GetReportFiltersParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, PingWebhookParam, RegisterSubscriberToEventParam, RegisterSubscriberToEventV2Param, UpdateSubscriberConfigParam, UpdateSubscriberV2Param };
 }
 type CancelJobByNameParam = {
     filename: string;
@@ -104,9 +98,6 @@ type DownloadDeliveryReportParam = {
 type GetDeliveryReportsParam = {
     body: WebhookPlatformModel.EventProcessRequest;
 };
-type GetEventCountsParam = {
-    body: WebhookPlatformModel.RetryEventRequest;
-};
 type GetHistoricalReportsParam = {
     body: WebhookPlatformModel.HistoryPayload;
 };
@@ -147,19 +138,20 @@ type GetSubscribersByExtensionIdParam = {
      */
     extensionId: string;
 };
-type ManualRetryOfFailedEventParam = {
-    body: WebhookPlatformModel.RetryEventRequest;
-};
 type PingWebhookParam = {
     body: WebhookPlatformModel.PingWebhook;
 };
 type RegisterSubscriberToEventParam = {
-    body: WebhookPlatformModel.SubscriberConfig;
+    body: WebhookPlatformModel.SubscriberConfigPost;
+};
+type RegisterSubscriberToEventV2Param = {
+    body: WebhookPlatformModel.SubscriberConfigPostRequestV2;
 };
 type UpdateSubscriberConfigParam = {
-    body: WebhookPlatformModel.SubscriberConfig;
+    body: WebhookPlatformModel.SubscriberConfigUpdate;
+};
+type UpdateSubscriberV2Param = {
+    body: WebhookPlatformModel.SubscriberConfigUpdateRequestV2;
 };
 type FetchAllEventConfigurationsParam = any;
-type GetManualRetryStatusParam = any;
-type ManualRetryCancelParam = any;
 import WebhookPlatformModel = require("./WebhookPlatformModel");