@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

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

@@ -1,44 +1,4 @@
 export = WebhookPlatformModel;
-/**
- * @typedef Event
- * @property {string} [event_name]
- * @property {string} [event_type]
- * @property {string} [event_category]
- * @property {string} [version]
- */
-/**
- * @typedef EventProcessRequest
- * @property {string} [search_text]
- * @property {string} end_date
- * @property {string} start_date
- * @property {number[]} [subscriber_ids]
- * @property {string} [status]
- * @property {Event[]} [event]
- */
-/**
- * @typedef DownloadReportResponse
- * @property {string} [file_name]
- */
-/**
- * @typedef EventProcessReports
- * @property {EventProcessReportObject[]} [rows]
- * @property {Page} [page]
- */
-/**
- * @typedef EventProcessReportObject
- * @property {string} [event_name] - The name of the processed event.
- * @property {number} [response_code] - The response code of the event.
- * @property {string} [response_message] - The response message of the event.
- * @property {string} [data] - The data associated with the event.
- * @property {number} [attempt] - The attempt number of the event.
- * @property {number} [last_attempted_on] - The timestamp of the last attempted event.
- * @property {string} [status] - The status of the event (e.g., "FAILED").
- * @property {string} [name] - The name of the event.
- * @property {string} [webhook_url] - The webhook URL associated with the event.
- * @property {number} [response_time] - The response time of the event.
- * @property {string} [message_id]
- * @property {string} [event_trace_id]
- */
 /**
  * @typedef Page
  * @property {number} [item_total] - The total number of items on the page.
@@ -48,312 +8,315 @@ export = WebhookPlatformModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
- * @property {number} [total] - Total number of items.
+ * @property {number} [page_size] - The number of items per page.
  */
 /**
- * @typedef PingWebhook
- * @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.
+ * @typedef BroadcasterConfig
+ * @property {string} [topic] - The name of the topic for the broadcaster configuration.
+ * @property {string} [queue] - The name of the queue for the broadcaster configuration.
+ * @property {string} [event_bridge_name] - The name of the event bridge
+ *   associated with the broadcaster.
+ * @property {string} [workflow_name] - The name of the workflow related to the
+ *   broadcaster.
+ * @property {string} [account_id] - The account ID associated with the broadcaster.
+ * @property {string} [detail_type] - The type of detail for the broadcaster
+ *   configuration.
  */
 /**
- * @typedef PingWebhookResponse
- * @property {string} [status] - The status of the ping (e.g., "SUCCESS").
- * @property {string} [message] - An optional message related to the ping.
- * @property {number} [code] - The HTTP status code of the ping response (e.g., 200).
+ * @typedef SubscriberEventMapping
+ * @property {number} [id] - The unique identifier for the subscriber event mapping.
+ * @property {number} [event_id] - The ID of the event associated with the subscriber.
+ * @property {number} [subscriber_id] - The ID of the subscriber.
+ * @property {FilterSchema} [filters]
+ * @property {Object} [reducer] - The reducer property allows users to customize
+ *   the JSON structure of the webhook payload using JSONPath queries. They can
+ *   also create new properties by mapping existing ones. Note that it overrides
+ *   the entire JSON structure of the webhook payload sent via the webhook. See
+ *   the partner documentation's filter and reducer section for details.
+ * @property {BroadcasterConfig} [broadcaster_config]
+ * @property {string} [created_on] - The date and time when the subscriber event
+ *   mapping was created.
  */
 /**
- * @typedef SubscriberEventMapping
- * @property {number} [id]
- * @property {number} [event_id]
- * @property {number} [subscriber_id]
- * @property {string} [topic]
- * @property {string} [created_on]
+ * @typedef FilterSchema
+ * @property {string} [query] - JSONPath expression that specifies the property
+ *   in the webhook payload to filter on. This enables targeting specific data
+ *   within the payload.
+ * @property {string} [condition] - JavaScript function used to evaluate the
+ *   specified property in the webhook payload against a condition. This
+ *   function determines whether the filter passes based on its return value.
+ * @property {string} [logic] - Logical operator used to combine multiple
+ *   conditions in the `conditions` array. Supported values are `AND` and `OR`.
+ * @property {Object[]} [conditions] - An array of filter objects to be
+ *   evaluated using the specified logical operator. This array will contain
+ *   more filters including a combination of single condition mode and logical
+ *   group mode filters.
  */
 /**
  * @typedef EventConfig
- * @property {number} [id]
- * @property {string} [event_name]
- * @property {string} [event_type]
- * @property {string} [event_category]
+ * @property {number} [id] - The unique identifier for the event configuration.
+ * @property {string} [type] - The type of event configuration, which may be null.
+ * @property {string} [event_name] - The name of the event.
+ * @property {string} [event_type] - The type of the event.
+ * @property {string} [event_category] - The category of the event.
+ * @property {string} [modified_by] - The identifier of the user who last
+ *   modified the event configuration.
  * @property {SubscriberEventMapping} [subscriber_event_mapping]
- * @property {Object} [event_schema]
- * @property {string} [group]
- * @property {string} [version]
- * @property {string} [display_name]
- * @property {string} [description]
- * @property {string} [created_on]
- * @property {string} [updated_on]
- */
-/**
- * @typedef EventConfigResponse
- * @property {EventConfig[]} [event_configs]
- */
-/**
- * @typedef ReportFiltersPayload
- * @property {number[]} subscriber_ids - An array of subscriber IDs for
- *   filtering filters (optional).
- */
-/**
- * @typedef ReportFilterResponse
- * @property {string} [filter_name] - The name of the filter.
- * @property {Object[]} [values]
- */
-/**
- * @typedef HistoryPayload
- * @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.
+ * @property {Object} [event_schema] - The schema for the event, allowing for
+ *   additional properties and may be null.
+ * @property {string} [group] - The group associated with the event
+ *   configuration, which may be null.
+ * @property {string} [version] - The version of the event configuration.
+ * @property {string} [display_name] - The display name of the event configuration.
+ * @property {string} [description] - A description of the event configuration,
+ *   which may be null.
+ * @property {string} [created_on] - The date and time when the event
+ *   configuration was created.
+ * @property {string} [updated_on] - The date and time when the event
+ *   configuration was last updated.
  */
 /**
- * @typedef HistoryFilters
- * @property {string[]} [events]
- * @property {string} [search_text]
- * @property {string} [status] - The status of the history report (e.g., "FAILED").
- * @property {string} [end_date] - The end date and time of the history report.
- * @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
- * @property {string} [url] - The URL of the uploaded report file.
- * @property {string} [name] - The name of the uploaded report file.
- */
-/**
- * @typedef CdnObject
- * @property {Url[]} [urls]
- */
-/**
- * @typedef UploadServiceObject
- * @property {CdnObject} [cdn]
- */
-/**
- * @typedef HistoryAssociation
- * @property {number} [company_id]
- * @property {number[]} [subscriber_ids]
- */
-/**
- * @typedef HistoryItems
- * @property {number} [id] - The ID of the history report.
- * @property {HistoryAssociation} [association]
- * @property {HistoryFilters} [filters]
- * @property {string} [filename] - The filename of the history report.
- * @property {string} [status] - The status of the history report (e.g., "COMPLETED").
- * @property {UploadServiceObject} [upload_service_response]
- * @property {string} [created_on] - The date and time when the history report
- *   was created.
- * @property {string} [updated_on] - The date and time when the history report
- *   was last updated.
- * @property {string} [message] - A message related to the history report.
- */
-/**
- * @typedef HistoryResponse
- * @property {HistoryItems[]} [items]
- * @property {Page} [page]
- */
-/**
- * @typedef CancelResponse
- * @property {string} [message] - The HTTP status code of the response (e.g., 200).
+ * @typedef EventConfigResult
+ * @property {EventConfig[]} [event_configs] - List of event configurations.
  */
 /**
  * @typedef Association
- * @property {string[]} [application_id]
- * @property {string} [extension_id]
- * @property {string} [criteria]
+ * @property {string[]} [application_id] - A list of application IDs associated
+ *   with the association.
+ * @property {string} [extension_id] - The extension ID associated with the association.
+ * @property {string} [criteria] - The criteria for the association, such as
+ *   "ALL", "EMPTY", or "SPECIFIC-EVENTS".
  */
 /**
  * @typedef AssociationResp
- * @property {number} [company_id]
- * @property {string[]} [application_id]
- * @property {string} [extension_id]
- * @property {string} [criteria]
+ * @property {number} [company_id] - The ID of the company associated with the response.
+ * @property {string[]} [application_id] - A list of application IDs associated
+ *   with the response.
+ * @property {string} [extension_id] - The extension ID associated with the response.
+ * @property {string} [criteria] - The criteria for the response, such as "ALL",
+ *   "EMPTY", or "SPECIFIC-EVENTS".
  */
 /**
  * @typedef AuthMeta
- * @property {string} [type]
- * @property {string} [secret]
+ * @property {string} [type] - The type of authentication method used.
+ * @property {string} [secret] - The secret key or token used for authentication.
  */
 /**
- * @typedef SubscriberResponse
- * @property {number} [id]
- * @property {string} [modified_by]
- * @property {string} [name]
- * @property {string} [provider]
- * @property {string} [webhook_url]
+ * @typedef SubscriberDetails
+ * @property {number} [id] - The unique identifier of the subscriber.
+ * @property {string} [modified_by] - The identifier of the user who last
+ *   modified the subscriber details.
+ * @property {string} [name] - The name of the subscriber.
+ * @property {string} [provider] - The provider of the subscriber.
+ * @property {string} [webhook_url] - The URL for the subscriber's webhook.
  * @property {AssociationResp} [association]
- * @property {Object} [custom_headers]
+ * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} [status]
- * @property {string} [email_id]
- * @property {string} [updated_on]
- * @property {string} [created_on]
- * @property {string} [type]
+ * @property {string} [email_id] - The email ID associated with the subscriber.
+ * @property {string} [updated_on] - The date and time when the subscriber
+ *   details were last updated.
+ * @property {string} [created_on] - The date and time when the subscriber was created.
+ * @property {string} [type] - The type of subscriber, which can either be passed as null.
  * @property {AuthMeta} [auth_meta]
- * @property {EventConfig[]} [event_configs]
+ * @property {EventConfig[]} [event_configs] - List of event configurations.
  */
 /**
  * @typedef Events
- * @property {string} [slug]
- * @property {string} [topic]
+ * @property {string} [slug] - The slug or identifier for the event.
+ * @property {string} [topic] - The topic associated with the event.
+ * @property {string} [queue] - The queue associated with the event in case of
+ *   provider as Pub/Sub.
+ * @property {string} [event_bridge_name] - The name of the event bridge
+ *   associated with the event in case of provider as AWS event bridge.
+ * @property {string} [workflow_name] - The name of the workflow related to the
+ *   event in case of provider as temporal.
+ * @property {string} [detail_type] - The type of detail for the event.
  */
 /**
  * @typedef SubscriberConfigPostRequestV2
- * @property {string} name
- * @property {string} [type]
- * @property {string} [webhook_url]
- * @property {string} provider
+ * @property {string} name - The name of the subscriber.
+ * @property {string} [type] - The type of the subscriber, which may be null.
+ * @property {string} [webhook_url] - The URL for the subscriber's webhook.
+ * @property {string} provider - The provider of the subscriber.
  * @property {Association} association
- * @property {Object} [custom_headers]
+ * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} status
- * @property {string} email_id
+ * @property {string} email_id - The email ID associated with the subscriber.
  * @property {AuthMeta} [auth_meta]
- * @property {Events[]} events
+ * @property {Events[]} events - The list of events associated with the subscriber.
  */
 /**
  * @typedef SubscriberConfigUpdateRequestV2
- * @property {number} id
- * @property {string} [name]
- * @property {string} [type]
- * @property {string} [webhook_url]
- * @property {string} provider
+ * @property {number} id - The unique identifier of the subscriber to be updated.
+ * @property {string} [name] - The name of the subscriber.
+ * @property {string} [type] - The type of the subscriber, which may be null.
+ * @property {string} [webhook_url] - The URL for the subscriber's webhook.
+ * @property {string} provider - The provider of the subscriber.
  * @property {Association} [association]
- * @property {Object} [custom_headers]
+ * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} status
- * @property {string} [email_id]
+ * @property {string} [email_id] - The email ID associated with the subscriber.
  * @property {AuthMeta} [auth_meta]
- * @property {Events[]} [events]
+ * @property {Events[]} [events] - The list of events associated with the subscriber.
  */
 /**
  * @typedef SubscriberConfigPost
- * @property {string} name
- * @property {string} [type]
- * @property {string} webhook_url
+ * @property {string} name - The name of the subscriber.
+ * @property {string} [type] - The type of the subscriber, which can be null.
+ * @property {string} webhook_url - The URL for the subscriber's webhook.
  * @property {Association} association
- * @property {Object} [custom_headers]
+ * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} status
- * @property {string} email_id
+ * @property {string} email_id - The email ID associated with the subscriber.
  * @property {AuthMeta} [auth_meta]
- * @property {number[]} event_id
+ * @property {number[]} event_id - The list of event IDs associated with the subscriber.
  */
 /**
  * @typedef SubscriberConfigUpdate
- * @property {number} id
- * @property {string} [name]
- * @property {string} [type]
- * @property {string} [webhook_url]
+ * @property {number} id - The unique identifier of the subscriber to be updated.
+ * @property {string} [name] - The name of the subscriber.
+ * @property {string} [type] - The type of the subscriber, which can be null.
+ * @property {string} [webhook_url] - The URL for the subscriber's webhook.
  * @property {Association} [association]
- * @property {Object} [custom_headers]
+ * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} [status]
- * @property {string} [email_id]
+ * @property {string} [email_id] - The email ID associated with the subscriber.
  * @property {AuthMeta} [auth_meta]
- * @property {number[]} event_id
+ * @property {number[]} event_id - The list of event IDs associated with the subscriber.
  */
 /**
- * @typedef SubscriberConfigResponse
- * @property {number} [id]
- * @property {string} [modified_by]
- * @property {string} [name]
- * @property {string} [webhook_url]
- * @property {string} [provider]
+ * @typedef SubscriberConfigResult
+ * @property {number} [id] - The unique identifier of the subscriber configuration.
+ * @property {string} [modified_by] - The identifier of the user who last
+ *   modified the subscriber configuration.
+ * @property {string} [name] - The name of the subscriber.
+ * @property {string} [webhook_url] - The URL for the subscriber's webhook.
+ * @property {string} [provider] - The provider of the subscriber.
  * @property {AssociationResp} [association]
- * @property {Object} [custom_headers]
+ * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} [status]
- * @property {string} [email_id]
- * @property {string} [updated_on]
- * @property {string} [created_on]
- * @property {string} [type]
+ * @property {string} [email_id] - The email ID associated with the subscriber.
+ * @property {string} [updated_on] - The date and time when the subscriber was
+ *   last updated.
+ * @property {string} [created_on] - The date and time when the subscriber was created.
+ * @property {string} [type] - The type of the subscriber, which can be null.
  * @property {AuthMeta} [auth_meta]
- * @property {number[]} [event_id]
+ * @property {number[]} [event_id] - The list of event IDs associated with the subscriber.
  */
 /**
  * @typedef SubscriberConfigList
- * @property {SubscriberResponse[]} [items]
+ * @property {SubscriberDetails[]} [items] - List of subscriber details.
  * @property {Page} [page]
  */
+/**
+ * @typedef RestEventData
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_name - The name of the event.
+ * @property {string} event_type - The type of the event.
+ * @property {number} version - The version number of the event.
+ */
+/**
+ * @typedef RestConfig
+ * @property {string} webhook_url - The URL for the webhook.
+ * @property {string} type - The type of the configuration.
+ * @property {Object} [custom_headers] - Custom headers for the configuration.
+ * @property {AuthMeta} [auth_meta]
+ * @property {RestEventData[]} events - List of event data for configuration.
+ */
+/**
+ * @typedef QueueEventData
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_name - The name of the event.
+ * @property {string} event_type - The type of the event.
+ * @property {number} version - The version number of the event.
+ * @property {string} topic - The topic associated with the event.
+ */
+/**
+ * @typedef KafkaConfig
+ * @property {string} [type] - Type of Kafka configuration (optional).
+ * @property {QueueEventData[]} events - List of event data for configuration.
+ */
+/**
+ * @typedef PubSubConfig
+ * @property {string} [type] - Type of Pub/Sub configuration (optional).
+ * @property {QueueEventData[]} events - List of event data for configuration.
+ */
+/**
+ * @typedef TemporalEventData
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_name - The name of the event.
+ * @property {string} event_type - The type of the event.
+ * @property {number} version - The version number of the event.
+ * @property {string} [queue] - The queue associated with the event.
+ * @property {string} [workflow_name] - The workflow name related to the event.
+ */
+/**
+ * @typedef TemporalConfig
+ * @property {string} [type] - Type of Temporal configuration (optional).
+ * @property {TemporalEventData[]} events - List of event data for configuration.
+ */
+/**
+ * @typedef SqsEventData
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_name - The name of the event.
+ * @property {string} event_type - The type of the event.
+ * @property {number} version - The version number of the event.
+ * @property {string} [queue] - The queue name associated with the event in SQS.
+ */
+/**
+ * @typedef SqsConfig
+ * @property {string} [type] - Type of SQS configuration (optional).
+ * @property {SqsEventData[]} events - List of event data for configuration.
+ */
+/**
+ * @typedef EventBridgeData
+ * @property {string} event_category - The category of the event.
+ * @property {string} event_name - The name of the event.
+ * @property {string} event_type - The type of the event.
+ * @property {number} version - The version number of the event.
+ * @property {string} [event_bridge_name] - The name of the event bridge related
+ *   to the event.
+ */
+/**
+ * @typedef EventBridgeConfig
+ * @property {string} [type] - Type of event configuration (optional).
+ * @property {EventBridgeData[]} events - List of event data for EventBridge
+ *   configuration.
+ */
+/**
+ * @typedef EventMapBody
+ * @property {RestConfig} [rest]
+ * @property {KafkaConfig} [kafka]
+ * @property {PubSubConfig} [pub_sub]
+ * @property {TemporalConfig} [temporal]
+ * @property {SqsConfig} [sqs]
+ * @property {EventBridgeConfig} [event_bridge]
+ */
+/**
+ * @typedef WebhookConfig
+ * @property {string} [notification_email] - The email address for notifications.
+ * @property {string} [name] - The name of the webhook configuration.
+ * @property {string} [status] - The status of the webhook (e.g., active or inactive).
+ * @property {Association} [association]
+ * @property {EventMapBody} [event_map]
+ */
+/**
+ * @typedef UpsertSubscriberConfig
+ * @property {WebhookConfig} webhook_config
+ */
+/**
+ * @typedef UpsertSubscriberConfigResult
+ * @property {boolean} [status] - The status of the upsert operation (e.g.,
+ *   success or failure).
+ * @property {string} [message] - A message providing details about the upsert
+ *   operation result.
+ */
 /** @typedef {"active" | "inactive"} SubscriberStatus */
 declare class WebhookPlatformModel {
 }
 declare namespace WebhookPlatformModel {
-    export { Event, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, SubscriberEventMapping, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AssociationResp, AuthMeta, SubscriberResponse, Events, SubscriberConfigPostRequestV2, SubscriberConfigUpdateRequestV2, SubscriberConfigPost, SubscriberConfigUpdate, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
+    export { Page, BroadcasterConfig, SubscriberEventMapping, FilterSchema, EventConfig, EventConfigResult, Association, AssociationResp, AuthMeta, SubscriberDetails, Events, SubscriberConfigPostRequestV2, SubscriberConfigUpdateRequestV2, SubscriberConfigPost, SubscriberConfigUpdate, SubscriberConfigResult, SubscriberConfigList, RestEventData, RestConfig, QueueEventData, KafkaConfig, PubSubConfig, TemporalEventData, TemporalConfig, SqsEventData, SqsConfig, EventBridgeData, EventBridgeConfig, EventMapBody, WebhookConfig, UpsertSubscriberConfig, UpsertSubscriberConfigResult, SubscriberStatus };
 }
-/** @returns {Event} */
-declare function Event(): Event;
-type Event = {
-    event_name?: string;
-    event_type?: string;
-    event_category?: string;
-    version?: string;
-};
-/** @returns {EventProcessRequest} */
-declare function EventProcessRequest(): EventProcessRequest;
-type EventProcessRequest = {
-    search_text?: string;
-    end_date: string;
-    start_date: string;
-    subscriber_ids?: number[];
-    status?: string;
-    event?: Event[];
-};
-/** @returns {DownloadReportResponse} */
-declare function DownloadReportResponse(): DownloadReportResponse;
-type DownloadReportResponse = {
-    file_name?: string;
-};
-/** @returns {EventProcessReports} */
-declare function EventProcessReports(): EventProcessReports;
-type EventProcessReports = {
-    rows?: EventProcessReportObject[];
-    page?: Page;
-};
-/** @returns {EventProcessReportObject} */
-declare function EventProcessReportObject(): EventProcessReportObject;
-type EventProcessReportObject = {
-    /**
-     * - The name of the processed event.
-     */
-    event_name?: string;
-    /**
-     * - The response code of the event.
-     */
-    response_code?: number;
-    /**
-     * - The response message of the event.
-     */
-    response_message?: string;
-    /**
-     * - The data associated with the event.
-     */
-    data?: string;
-    /**
-     * - The attempt number of the event.
-     */
-    attempt?: number;
-    /**
-     * - The timestamp of the last attempted event.
-     */
-    last_attempted_on?: number;
-    /**
-     * - The status of the event (e.g., "FAILED").
-     */
-    status?: string;
-    /**
-     * - The name of the event.
-     */
-    name?: string;
-    /**
-     * - The webhook URL associated with the event.
-     */
-    webhook_url?: string;
-    /**
-     * - The response time of the event.
-     */
-    response_time?: number;
-    message_id?: string;
-    event_trace_id?: string;
-};
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
@@ -386,335 +349,759 @@ type Page = {
      */
     size?: number;
     /**
-     * - Total number of items.
+     * - The number of items per page.
      */
-    total?: number;
+    page_size?: number;
 };
-/** @returns {PingWebhook} */
-declare function PingWebhook(): PingWebhook;
-type PingWebhook = {
+/** @returns {BroadcasterConfig} */
+declare function BroadcasterConfig(): BroadcasterConfig;
+type BroadcasterConfig = {
     /**
-     * - The URL of the subscriber's webhook to ping.
+     * - The name of the topic for the broadcaster configuration.
      */
-    webhook_url: string;
+    topic?: string;
     /**
-     * - Authentication metadata (if required by the
-     * subscriber).
+     * - The name of the queue for the broadcaster configuration.
      */
-    auth_meta?: any;
+    queue?: string;
     /**
-     * - Custom headers to include in the ping request.
+     * - The name of the event bridge
+     * associated with the broadcaster.
      */
-    custom_headers?: any;
-};
-/** @returns {PingWebhookResponse} */
-declare function PingWebhookResponse(): PingWebhookResponse;
-type PingWebhookResponse = {
+    event_bridge_name?: string;
     /**
-     * - The status of the ping (e.g., "SUCCESS").
+     * - The name of the workflow related to the
+     * broadcaster.
      */
-    status?: string;
+    workflow_name?: string;
     /**
-     * - An optional message related to the ping.
+     * - The account ID associated with the broadcaster.
      */
-    message?: string;
+    account_id?: string;
     /**
-     * - The HTTP status code of the ping response (e.g., 200).
+     * - The type of detail for the broadcaster
+     * configuration.
      */
-    code?: number;
+    detail_type?: string;
 };
 /** @returns {SubscriberEventMapping} */
 declare function SubscriberEventMapping(): SubscriberEventMapping;
 type SubscriberEventMapping = {
+    /**
+     * - The unique identifier for the subscriber event mapping.
+     */
     id?: number;
+    /**
+     * - The ID of the event associated with the subscriber.
+     */
     event_id?: number;
+    /**
+     * - The ID of the subscriber.
+     */
     subscriber_id?: number;
-    topic?: string;
-    created_on?: string;
-};
-/** @returns {EventConfig} */
-declare function EventConfig(): EventConfig;
-type EventConfig = {
-    id?: number;
-    event_name?: string;
-    event_type?: string;
-    event_category?: string;
-    subscriber_event_mapping?: SubscriberEventMapping;
-    event_schema?: any;
-    group?: string;
-    version?: string;
-    display_name?: string;
-    description?: string;
-    created_on?: string;
-    updated_on?: string;
-};
-/** @returns {EventConfigResponse} */
-declare function EventConfigResponse(): EventConfigResponse;
-type EventConfigResponse = {
-    event_configs?: EventConfig[];
-};
-/** @returns {ReportFiltersPayload} */
-declare function ReportFiltersPayload(): ReportFiltersPayload;
-type ReportFiltersPayload = {
+    filters?: FilterSchema;
     /**
-     * - An array of subscriber IDs for
-     * filtering filters (optional).
+     * - The reducer property allows users to customize
+     * the JSON structure of the webhook payload using JSONPath queries. They can
+     * also create new properties by mapping existing ones. Note that it overrides
+     * the entire JSON structure of the webhook payload sent via the webhook. See
+     * the partner documentation's filter and reducer section for details.
      */
-    subscriber_ids: number[];
-};
-/** @returns {ReportFilterResponse} */
-declare function ReportFilterResponse(): ReportFilterResponse;
-type ReportFilterResponse = {
+    reducer?: any;
+    broadcaster_config?: BroadcasterConfig;
     /**
-     * - The name of the filter.
+     * - The date and time when the subscriber event
+     * mapping was created.
      */
-    filter_name?: string;
-    values?: any[];
+    created_on?: string;
 };
-/** @returns {HistoryPayload} */
-declare function HistoryPayload(): HistoryPayload;
-type HistoryPayload = {
+/** @returns {FilterSchema} */
+declare function FilterSchema(): FilterSchema;
+type FilterSchema = {
     /**
-     * - The type of history report (e.g., "platform").
+     * - JSONPath expression that specifies the property
+     * in the webhook payload to filter on. This enables targeting specific data
+     * within the payload.
      */
-    type: string;
+    query?: string;
     /**
-     * - The page number of the history report.
+     * - JavaScript function used to evaluate the
+     * specified property in the webhook payload against a condition. This
+     * function determines whether the filter passes based on its return value.
      */
-    page_no?: number;
+    condition?: string;
     /**
-     * - The number of records per page.
+     * - Logical operator used to combine multiple
+     * conditions in the `conditions` array. Supported values are `AND` and `OR`.
      */
-    page_size?: number;
+    logic?: string;
+    /**
+     * - An array of filter objects to be
+     * evaluated using the specified logical operator. This array will contain
+     * more filters including a combination of single condition mode and logical
+     * group mode filters.
+     */
+    conditions?: any[];
 };
-/** @returns {HistoryFilters} */
-declare function HistoryFilters(): HistoryFilters;
-type HistoryFilters = {
-    events?: string[];
-    search_text?: string;
+/** @returns {EventConfig} */
+declare function EventConfig(): EventConfig;
+type EventConfig = {
     /**
-     * - The status of the history report (e.g., "FAILED").
+     * - The unique identifier for the event configuration.
      */
-    status?: string;
+    id?: number;
     /**
-     * - The end date and time of the history report.
+     * - The type of event configuration, which may be null.
      */
-    end_date?: string;
+    type?: string;
     /**
-     * - The start date and time of the history report.
+     * - The name of the event.
      */
-    start_date?: string;
+    event_name?: string;
     /**
-     * - An array of subscriber IDs associated
-     * with the history report.
+     * - The type of the event.
      */
-    subscribers?: number[];
+    event_type?: string;
     /**
-     * - An array of webhook type to identify
-     * thetype of subscriber i.e (KAFKA or REST).
+     * - The category of the event.
      */
-    webhook_type?: string[];
-};
-/** @returns {Url} */
-declare function Url(): Url;
-type Url = {
+    event_category?: string;
     /**
-     * - The URL of the uploaded report file.
+     * - The identifier of the user who last
+     * modified the event configuration.
      */
-    url?: string;
+    modified_by?: string;
+    subscriber_event_mapping?: SubscriberEventMapping;
     /**
-     * - The name of the uploaded report file.
+     * - The schema for the event, allowing for
+     * additional properties and may be null.
      */
-    name?: string;
-};
-/** @returns {CdnObject} */
-declare function CdnObject(): CdnObject;
-type CdnObject = {
-    urls?: Url[];
-};
-/** @returns {UploadServiceObject} */
-declare function UploadServiceObject(): UploadServiceObject;
-type UploadServiceObject = {
-    cdn?: CdnObject;
-};
-/** @returns {HistoryAssociation} */
-declare function HistoryAssociation(): HistoryAssociation;
-type HistoryAssociation = {
-    company_id?: number;
-    subscriber_ids?: number[];
-};
-/** @returns {HistoryItems} */
-declare function HistoryItems(): HistoryItems;
-type HistoryItems = {
+    event_schema?: any;
     /**
-     * - The ID of the history report.
+     * - The group associated with the event
+     * configuration, which may be null.
      */
-    id?: number;
-    association?: HistoryAssociation;
-    filters?: HistoryFilters;
+    group?: string;
     /**
-     * - The filename of the history report.
+     * - The version of the event configuration.
      */
-    filename?: string;
+    version?: string;
     /**
-     * - The status of the history report (e.g., "COMPLETED").
+     * - The display name of the event configuration.
      */
-    status?: string;
-    upload_service_response?: UploadServiceObject;
+    display_name?: string;
     /**
-     * - The date and time when the history report
-     * was created.
+     * - A description of the event configuration,
+     * which may be null.
      */
-    created_on?: string;
+    description?: string;
     /**
-     * - The date and time when the history report
-     * was last updated.
+     * - The date and time when the event
+     * configuration was created.
      */
-    updated_on?: string;
+    created_on?: string;
     /**
-     * - A message related to the history report.
+     * - The date and time when the event
+     * configuration was last updated.
      */
-    message?: string;
-};
-/** @returns {HistoryResponse} */
-declare function HistoryResponse(): HistoryResponse;
-type HistoryResponse = {
-    items?: HistoryItems[];
-    page?: Page;
+    updated_on?: string;
 };
-/** @returns {CancelResponse} */
-declare function CancelResponse(): CancelResponse;
-type CancelResponse = {
+/** @returns {EventConfigResult} */
+declare function EventConfigResult(): EventConfigResult;
+type EventConfigResult = {
     /**
-     * - The HTTP status code of the response (e.g., 200).
+     * - List of event configurations.
      */
-    message?: string;
+    event_configs?: EventConfig[];
 };
 /** @returns {Association} */
 declare function Association(): Association;
 type Association = {
+    /**
+     * - A list of application IDs associated
+     * with the association.
+     */
     application_id?: string[];
+    /**
+     * - The extension ID associated with the association.
+     */
     extension_id?: string;
+    /**
+     * - The criteria for the association, such as
+     * "ALL", "EMPTY", or "SPECIFIC-EVENTS".
+     */
     criteria?: string;
 };
 /** @returns {AssociationResp} */
 declare function AssociationResp(): AssociationResp;
 type AssociationResp = {
+    /**
+     * - The ID of the company associated with the response.
+     */
     company_id?: number;
+    /**
+     * - A list of application IDs associated
+     * with the response.
+     */
     application_id?: string[];
+    /**
+     * - The extension ID associated with the response.
+     */
     extension_id?: string;
+    /**
+     * - The criteria for the response, such as "ALL",
+     * "EMPTY", or "SPECIFIC-EVENTS".
+     */
     criteria?: string;
 };
 /** @returns {AuthMeta} */
 declare function AuthMeta(): AuthMeta;
 type AuthMeta = {
+    /**
+     * - The type of authentication method used.
+     */
     type?: string;
+    /**
+     * - The secret key or token used for authentication.
+     */
     secret?: string;
 };
-/** @returns {SubscriberResponse} */
-declare function SubscriberResponse(): SubscriberResponse;
-type SubscriberResponse = {
+/** @returns {SubscriberDetails} */
+declare function SubscriberDetails(): SubscriberDetails;
+type SubscriberDetails = {
+    /**
+     * - The unique identifier of the subscriber.
+     */
     id?: number;
+    /**
+     * - The identifier of the user who last
+     * modified the subscriber details.
+     */
     modified_by?: string;
+    /**
+     * - The name of the subscriber.
+     */
     name?: string;
+    /**
+     * - The provider of the subscriber.
+     */
     provider?: string;
+    /**
+     * - The URL for the subscriber's webhook.
+     */
     webhook_url?: string;
     association?: AssociationResp;
+    /**
+     * - Custom headers for the subscriber.
+     */
     custom_headers?: any;
     status?: SubscriberStatus;
+    /**
+     * - The email ID associated with the subscriber.
+     */
     email_id?: string;
+    /**
+     * - The date and time when the subscriber
+     * details were last updated.
+     */
     updated_on?: string;
+    /**
+     * - The date and time when the subscriber was created.
+     */
     created_on?: string;
+    /**
+     * - The type of subscriber, which can either be passed as null.
+     */
     type?: string;
     auth_meta?: AuthMeta;
+    /**
+     * - List of event configurations.
+     */
     event_configs?: EventConfig[];
 };
 /** @returns {Events} */
 declare function Events(): Events;
 type Events = {
+    /**
+     * - The slug or identifier for the event.
+     */
     slug?: string;
+    /**
+     * - The topic associated with the event.
+     */
     topic?: string;
+    /**
+     * - The queue associated with the event in case of
+     * provider as Pub/Sub.
+     */
+    queue?: string;
+    /**
+     * - The name of the event bridge
+     * associated with the event in case of provider as AWS event bridge.
+     */
+    event_bridge_name?: string;
+    /**
+     * - The name of the workflow related to the
+     * event in case of provider as temporal.
+     */
+    workflow_name?: string;
+    /**
+     * - The type of detail for the event.
+     */
+    detail_type?: string;
 };
 /** @returns {SubscriberConfigPostRequestV2} */
 declare function SubscriberConfigPostRequestV2(): SubscriberConfigPostRequestV2;
 type SubscriberConfigPostRequestV2 = {
+    /**
+     * - The name of the subscriber.
+     */
     name: string;
+    /**
+     * - The type of the subscriber, which may be null.
+     */
     type?: string;
+    /**
+     * - The URL for the subscriber's webhook.
+     */
     webhook_url?: string;
+    /**
+     * - The provider of the subscriber.
+     */
     provider: string;
     association: Association;
+    /**
+     * - Custom headers for the subscriber.
+     */
     custom_headers?: any;
     status: SubscriberStatus;
+    /**
+     * - The email ID associated with the subscriber.
+     */
     email_id: string;
     auth_meta?: AuthMeta;
+    /**
+     * - The list of events associated with the subscriber.
+     */
     events: Events[];
 };
 /** @returns {SubscriberConfigUpdateRequestV2} */
 declare function SubscriberConfigUpdateRequestV2(): SubscriberConfigUpdateRequestV2;
 type SubscriberConfigUpdateRequestV2 = {
+    /**
+     * - The unique identifier of the subscriber to be updated.
+     */
     id: number;
+    /**
+     * - The name of the subscriber.
+     */
     name?: string;
+    /**
+     * - The type of the subscriber, which may be null.
+     */
     type?: string;
+    /**
+     * - The URL for the subscriber's webhook.
+     */
     webhook_url?: string;
+    /**
+     * - The provider of the subscriber.
+     */
     provider: string;
     association?: Association;
+    /**
+     * - Custom headers for the subscriber.
+     */
     custom_headers?: any;
     status: SubscriberStatus;
+    /**
+     * - The email ID associated with the subscriber.
+     */
     email_id?: string;
     auth_meta?: AuthMeta;
+    /**
+     * - The list of events associated with the subscriber.
+     */
     events?: Events[];
 };
 /** @returns {SubscriberConfigPost} */
 declare function SubscriberConfigPost(): SubscriberConfigPost;
 type SubscriberConfigPost = {
+    /**
+     * - The name of the subscriber.
+     */
     name: string;
+    /**
+     * - The type of the subscriber, which can be null.
+     */
     type?: string;
+    /**
+     * - The URL for the subscriber's webhook.
+     */
     webhook_url: string;
     association: Association;
+    /**
+     * - Custom headers for the subscriber.
+     */
     custom_headers?: any;
     status: SubscriberStatus;
+    /**
+     * - The email ID associated with the subscriber.
+     */
     email_id: string;
     auth_meta?: AuthMeta;
+    /**
+     * - The list of event IDs associated with the subscriber.
+     */
     event_id: number[];
 };
 /** @returns {SubscriberConfigUpdate} */
 declare function SubscriberConfigUpdate(): SubscriberConfigUpdate;
 type SubscriberConfigUpdate = {
+    /**
+     * - The unique identifier of the subscriber to be updated.
+     */
     id: number;
+    /**
+     * - The name of the subscriber.
+     */
     name?: string;
+    /**
+     * - The type of the subscriber, which can be null.
+     */
     type?: string;
+    /**
+     * - The URL for the subscriber's webhook.
+     */
     webhook_url?: string;
     association?: Association;
+    /**
+     * - Custom headers for the subscriber.
+     */
     custom_headers?: any;
     status?: SubscriberStatus;
+    /**
+     * - The email ID associated with the subscriber.
+     */
     email_id?: string;
     auth_meta?: AuthMeta;
+    /**
+     * - The list of event IDs associated with the subscriber.
+     */
     event_id: number[];
 };
-/** @returns {SubscriberConfigResponse} */
-declare function SubscriberConfigResponse(): SubscriberConfigResponse;
-type SubscriberConfigResponse = {
+/** @returns {SubscriberConfigResult} */
+declare function SubscriberConfigResult(): SubscriberConfigResult;
+type SubscriberConfigResult = {
+    /**
+     * - The unique identifier of the subscriber configuration.
+     */
     id?: number;
+    /**
+     * - The identifier of the user who last
+     * modified the subscriber configuration.
+     */
     modified_by?: string;
+    /**
+     * - The name of the subscriber.
+     */
     name?: string;
+    /**
+     * - The URL for the subscriber's webhook.
+     */
     webhook_url?: string;
+    /**
+     * - The provider of the subscriber.
+     */
     provider?: string;
     association?: AssociationResp;
+    /**
+     * - Custom headers for the subscriber.
+     */
     custom_headers?: any;
     status?: SubscriberStatus;
+    /**
+     * - The email ID associated with the subscriber.
+     */
     email_id?: string;
+    /**
+     * - The date and time when the subscriber was
+     * last updated.
+     */
     updated_on?: string;
+    /**
+     * - The date and time when the subscriber was created.
+     */
     created_on?: string;
+    /**
+     * - The type of the subscriber, which can be null.
+     */
     type?: string;
     auth_meta?: AuthMeta;
+    /**
+     * - The list of event IDs associated with the subscriber.
+     */
     event_id?: number[];
 };
 /** @returns {SubscriberConfigList} */
 declare function SubscriberConfigList(): SubscriberConfigList;
 type SubscriberConfigList = {
-    items?: SubscriberResponse[];
+    /**
+     * - List of subscriber details.
+     */
+    items?: SubscriberDetails[];
     page?: Page;
 };
+/** @returns {RestEventData} */
+declare function RestEventData(): RestEventData;
+type RestEventData = {
+    /**
+     * - The category of the event.
+     */
+    event_category: string;
+    /**
+     * - The name of the event.
+     */
+    event_name: string;
+    /**
+     * - The type of the event.
+     */
+    event_type: string;
+    /**
+     * - The version number of the event.
+     */
+    version: number;
+};
+/** @returns {RestConfig} */
+declare function RestConfig(): RestConfig;
+type RestConfig = {
+    /**
+     * - The URL for the webhook.
+     */
+    webhook_url: string;
+    /**
+     * - The type of the configuration.
+     */
+    type: string;
+    /**
+     * - Custom headers for the configuration.
+     */
+    custom_headers?: any;
+    auth_meta?: AuthMeta;
+    /**
+     * - List of event data for configuration.
+     */
+    events: RestEventData[];
+};
+/** @returns {QueueEventData} */
+declare function QueueEventData(): QueueEventData;
+type QueueEventData = {
+    /**
+     * - The category of the event.
+     */
+    event_category: string;
+    /**
+     * - The name of the event.
+     */
+    event_name: string;
+    /**
+     * - The type of the event.
+     */
+    event_type: string;
+    /**
+     * - The version number of the event.
+     */
+    version: number;
+    /**
+     * - The topic associated with the event.
+     */
+    topic: string;
+};
+/** @returns {KafkaConfig} */
+declare function KafkaConfig(): KafkaConfig;
+type KafkaConfig = {
+    /**
+     * - Type of Kafka configuration (optional).
+     */
+    type?: string;
+    /**
+     * - List of event data for configuration.
+     */
+    events: QueueEventData[];
+};
+/** @returns {PubSubConfig} */
+declare function PubSubConfig(): PubSubConfig;
+type PubSubConfig = {
+    /**
+     * - Type of Pub/Sub configuration (optional).
+     */
+    type?: string;
+    /**
+     * - List of event data for configuration.
+     */
+    events: QueueEventData[];
+};
+/** @returns {TemporalEventData} */
+declare function TemporalEventData(): TemporalEventData;
+type TemporalEventData = {
+    /**
+     * - The category of the event.
+     */
+    event_category: string;
+    /**
+     * - The name of the event.
+     */
+    event_name: string;
+    /**
+     * - The type of the event.
+     */
+    event_type: string;
+    /**
+     * - The version number of the event.
+     */
+    version: number;
+    /**
+     * - The queue associated with the event.
+     */
+    queue?: string;
+    /**
+     * - The workflow name related to the event.
+     */
+    workflow_name?: string;
+};
+/** @returns {TemporalConfig} */
+declare function TemporalConfig(): TemporalConfig;
+type TemporalConfig = {
+    /**
+     * - Type of Temporal configuration (optional).
+     */
+    type?: string;
+    /**
+     * - List of event data for configuration.
+     */
+    events: TemporalEventData[];
+};
+/** @returns {SqsEventData} */
+declare function SqsEventData(): SqsEventData;
+type SqsEventData = {
+    /**
+     * - The category of the event.
+     */
+    event_category: string;
+    /**
+     * - The name of the event.
+     */
+    event_name: string;
+    /**
+     * - The type of the event.
+     */
+    event_type: string;
+    /**
+     * - The version number of the event.
+     */
+    version: number;
+    /**
+     * - The queue name associated with the event in SQS.
+     */
+    queue?: string;
+};
+/** @returns {SqsConfig} */
+declare function SqsConfig(): SqsConfig;
+type SqsConfig = {
+    /**
+     * - Type of SQS configuration (optional).
+     */
+    type?: string;
+    /**
+     * - List of event data for configuration.
+     */
+    events: SqsEventData[];
+};
+/** @returns {EventBridgeData} */
+declare function EventBridgeData(): EventBridgeData;
+type EventBridgeData = {
+    /**
+     * - The category of the event.
+     */
+    event_category: string;
+    /**
+     * - The name of the event.
+     */
+    event_name: string;
+    /**
+     * - The type of the event.
+     */
+    event_type: string;
+    /**
+     * - The version number of the event.
+     */
+    version: number;
+    /**
+     * - The name of the event bridge related
+     * to the event.
+     */
+    event_bridge_name?: string;
+};
+/** @returns {EventBridgeConfig} */
+declare function EventBridgeConfig(): EventBridgeConfig;
+type EventBridgeConfig = {
+    /**
+     * - Type of event configuration (optional).
+     */
+    type?: string;
+    /**
+     * - List of event data for EventBridge
+     * configuration.
+     */
+    events: EventBridgeData[];
+};
+/** @returns {EventMapBody} */
+declare function EventMapBody(): EventMapBody;
+type EventMapBody = {
+    rest?: RestConfig;
+    kafka?: KafkaConfig;
+    pub_sub?: PubSubConfig;
+    temporal?: TemporalConfig;
+    sqs?: SqsConfig;
+    event_bridge?: EventBridgeConfig;
+};
+/** @returns {WebhookConfig} */
+declare function WebhookConfig(): WebhookConfig;
+type WebhookConfig = {
+    /**
+     * - The email address for notifications.
+     */
+    notification_email?: string;
+    /**
+     * - The name of the webhook configuration.
+     */
+    name?: string;
+    /**
+     * - The status of the webhook (e.g., active or inactive).
+     */
+    status?: string;
+    association?: Association;
+    event_map?: EventMapBody;
+};
+/** @returns {UpsertSubscriberConfig} */
+declare function UpsertSubscriberConfig(): UpsertSubscriberConfig;
+type UpsertSubscriberConfig = {
+    webhook_config: WebhookConfig;
+};
+/** @returns {UpsertSubscriberConfigResult} */
+declare function UpsertSubscriberConfigResult(): UpsertSubscriberConfigResult;
+type UpsertSubscriberConfigResult = {
+    /**
+     * - The status of the upsert operation (e.g.,
+     * success or failure).
+     */
+    status?: boolean;
+    /**
+     * - A message providing details about the upsert
+     * operation result.
+     */
+    message?: string;
+};
 /**
  * Enum: SubscriberStatus Used By: Webhook
  *