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

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

@@ -1,8 +1,4 @@
 export = WebhookPlatformModel;
-/**
- * @typedef Error
- * @property {string} [error] - Error message describing the reason for the failure.
- */
 /**
  * @typedef Event
  * @property {string} [event_name]
@@ -10,55 +6,14 @@ export = WebhookPlatformModel;
  * @property {string} [event_category]
  * @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
  */
 /**
  * @typedef DownloadReportResponse
@@ -96,7 +51,7 @@ export = WebhookPlatformModel;
  */
 /**
  * @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.
@@ -107,6 +62,14 @@ export = WebhookPlatformModel;
  * @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]
+ * @property {number} [event_id]
+ * @property {number} [subscriber_id]
+ * @property {string} [topic]
+ * @property {string} [created_on]
+ */
 /**
  * @typedef EventConfig
  * @property {number} [id]
@@ -115,6 +78,7 @@ export = WebhookPlatformModel;
  * @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]
@@ -127,7 +91,7 @@ export = WebhookPlatformModel;
  */
 /**
  * @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).
  */
 /**
@@ -137,7 +101,7 @@ export = WebhookPlatformModel;
  */
 /**
  * @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.
  */
@@ -150,6 +114,8 @@ export = WebhookPlatformModel;
  * @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
@@ -194,6 +160,12 @@ export = WebhookPlatformModel;
  */
 /**
  * @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]
@@ -204,20 +176,14 @@ export = WebhookPlatformModel;
  * @property {string} [type]
  * @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]
@@ -228,16 +194,57 @@ export = WebhookPlatformModel;
  * @property {EventConfig[]} [event_configs]
  */
 /**
- * @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
  */
 /**
  * @typedef SubscriberConfigResponse
@@ -245,7 +252,8 @@ export = WebhookPlatformModel;
  * @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]
@@ -260,20 +268,12 @@ export = WebhookPlatformModel;
  * @property {SubscriberResponse[]} [items]
  * @property {Page} [page]
  */
-/** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
+/** @typedef {"active" | "inactive"} SubscriberStatus */
 declare class WebhookPlatformModel {
 }
 declare namespace WebhookPlatformModel {
-    export { Error, Event, RetryEventRequest, Item, RetryCountResponse, RetrySuccessResponse, Err, RetryFailureResponse, RetryStatusResponse, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AuthMeta, SubscriberEventMapping, SubscriberResponse, SubscriberConfig, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
+    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 };
 }
-/** @returns {Error} */
-declare function Error(): Error;
-type Error = {
-    /**
-     * - Error message describing the reason for the failure.
-     */
-    error?: string;
-};
 /** @returns {Event} */
 declare function Event(): Event;
 type Event = {
@@ -282,75 +282,15 @@ type Event = {
     event_category?: string;
     version?: string;
 };
-/** @returns {RetryEventRequest} */
-declare function RetryEventRequest(): RetryEventRequest;
-type RetryEventRequest = {
-    search_text?: string;
-    end_date?: string;
-    start_date?: string;
-    subscriber_ids?: number[];
-    event?: Event[];
-    status?: string;
-};
-/** @returns {Item} */
-declare function Item(): Item;
-type Item = {
-    status?: string;
-    count?: number;
-};
-/** @returns {RetryCountResponse} */
-declare function RetryCountResponse(): RetryCountResponse;
-type RetryCountResponse = {
-    items?: Item[];
-};
-/** @returns {RetrySuccessResponse} */
-declare function RetrySuccessResponse(): RetrySuccessResponse;
-type RetrySuccessResponse = {
-    success?: boolean;
-    message?: string;
-};
-/** @returns {Err} */
-declare function Err(): Err;
-type Err = {
-    msg?: string;
-    param?: string;
-    location?: string;
-};
-/** @returns {RetryFailureResponse} */
-declare function RetryFailureResponse(): RetryFailureResponse;
-type RetryFailureResponse = {
-    err?: Err[];
-};
-/** @returns {RetryStatusResponse} */
-declare function RetryStatusResponse(): RetryStatusResponse;
-type RetryStatusResponse = {
-    /**
-     * - The total number of events that require retry.
-     */
-    total_event?: number;
-    /**
-     * - The count of successfully retried events.
-     */
-    success_count?: number;
-    /**
-     * - The count of failed retry attempts.
-     */
-    failure_count?: number;
-    /**
-     * - The overall status of the retry process (e.g.,
-     * "completed").
-     */
-    status?: 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[];
+    search_text: string;
+    end_date: string;
+    start_date: string;
+    subscriber_ids: number[];
+    status: string;
+    event: Event[];
 };
 /** @returns {DownloadReportResponse} */
 declare function DownloadReportResponse(): DownloadReportResponse;
@@ -426,7 +366,7 @@ type PingWebhook = {
     /**
      * - The URL of the subscriber's webhook to ping.
      */
-    webhook_url?: string;
+    webhook_url: string;
     /**
      * - Authentication metadata (if required by the
      * subscriber).
@@ -453,6 +393,15 @@ type PingWebhookResponse = {
      */
     code?: number;
 };
+/** @returns {SubscriberEventMapping} */
+declare function SubscriberEventMapping(): SubscriberEventMapping;
+type SubscriberEventMapping = {
+    id?: number;
+    event_id?: number;
+    subscriber_id?: number;
+    topic?: string;
+    created_on?: string;
+};
 /** @returns {EventConfig} */
 declare function EventConfig(): EventConfig;
 type EventConfig = {
@@ -462,6 +411,7 @@ type EventConfig = {
     event_category?: string;
     subscriber_event_mapping?: SubscriberEventMapping;
     event_schema?: any;
+    group?: string;
     version?: string;
     display_name?: string;
     description?: string;
@@ -480,7 +430,7 @@ type ReportFiltersPayload = {
      * - An array of subscriber IDs for
      * filtering filters (optional).
      */
-    subscriber_ids?: number[];
+    subscriber_ids: number[];
 };
 /** @returns {ReportFilterResponse} */
 declare function ReportFilterResponse(): ReportFilterResponse;
@@ -497,7 +447,7 @@ type HistoryPayload = {
     /**
      * - The type of history report (e.g., "platform").
      */
-    type?: string;
+    type: string;
     /**
      * - The page number of the history report.
      */
@@ -529,6 +479,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;
@@ -608,6 +563,13 @@ type CancelResponse = {
 /** @returns {Association} */
 declare function Association(): Association;
 type Association = {
+    application_id?: string[];
+    extension_id?: string;
+    criteria?: string;
+};
+/** @returns {AssociationResp} */
+declare function AssociationResp(): AssociationResp;
+type AssociationResp = {
     company_id?: number;
     application_id?: string[];
     extension_id?: string;
@@ -619,22 +581,15 @@ type AuthMeta = {
     type?: string;
     secret?: string;
 };
-/** @returns {SubscriberEventMapping} */
-declare function SubscriberEventMapping(): SubscriberEventMapping;
-type SubscriberEventMapping = {
-    id?: number;
-    event_id?: number;
-    subscriber_id?: number;
-    created_on?: string;
-};
 /** @returns {SubscriberResponse} */
 declare function SubscriberResponse(): SubscriberResponse;
 type SubscriberResponse = {
     id?: number;
     modified_by?: string;
     name?: string;
+    provider?: string;
     webhook_url?: string;
-    association?: Association;
+    association?: AssociationResp;
     custom_headers?: any;
     status?: SubscriberStatus;
     email_id?: string;
@@ -644,18 +599,63 @@ type SubscriberResponse = {
     auth_meta?: AuthMeta;
     event_configs?: EventConfig[];
 };
-/** @returns {SubscriberConfig} */
-declare function SubscriberConfig(): SubscriberConfig;
-type SubscriberConfig = {
-    id?: number;
+/** @returns {Events} */
+declare function Events(): Events;
+type Events = {
+    slug?: string;
+    topic?: string;
+};
+/** @returns {SubscriberConfigPostRequestV2} */
+declare function SubscriberConfigPostRequestV2(): SubscriberConfigPostRequestV2;
+type SubscriberConfigPostRequestV2 = {
     name?: string;
     webhook_url?: string;
-    association?: Association;
+    provider: string;
+    association: Association;
     custom_headers?: any;
-    status?: SubscriberStatus;
-    email_id?: string;
+    status: SubscriberStatus;
+    email_id: string;
     auth_meta?: AuthMeta;
-    event_id?: number[];
+    events?: Events[];
+};
+/** @returns {SubscriberConfigUpdateRequestV2} */
+declare function SubscriberConfigUpdateRequestV2(): SubscriberConfigUpdateRequestV2;
+type SubscriberConfigUpdateRequestV2 = {
+    id: number;
+    name?: string;
+    webhook_url?: string;
+    provider: string;
+    association: Association;
+    custom_headers?: any;
+    status: SubscriberStatus;
+    email_id: string;
+    auth_meta?: AuthMeta;
+    events?: Events[];
+};
+/** @returns {SubscriberConfigPost} */
+declare function SubscriberConfigPost(): SubscriberConfigPost;
+type SubscriberConfigPost = {
+    name?: string;
+    webhook_url: string;
+    association: Association;
+    custom_headers?: any;
+    status: SubscriberStatus;
+    email_id: string;
+    auth_meta?: AuthMeta;
+    event_id: number[];
+};
+/** @returns {SubscriberConfigUpdate} */
+declare function SubscriberConfigUpdate(): SubscriberConfigUpdate;
+type SubscriberConfigUpdate = {
+    id: number;
+    name?: string;
+    webhook_url: string;
+    association: Association;
+    custom_headers?: any;
+    status: SubscriberStatus;
+    email_id: string;
+    auth_meta?: AuthMeta;
+    event_id: number[];
 };
 /** @returns {SubscriberConfigResponse} */
 declare function SubscriberConfigResponse(): SubscriberConfigResponse;
@@ -664,7 +664,8 @@ type SubscriberConfigResponse = {
     modified_by?: string;
     name?: string;
     webhook_url?: string;
-    association?: Association;
+    provider?: string;
+    association?: AssociationResp;
     custom_headers?: any;
     status?: SubscriberStatus;
     email_id?: string;
@@ -686,4 +687,4 @@ type SubscriberConfigList = {
  * @returns {SubscriberStatus}
  */
 declare function SubscriberStatus(): SubscriberStatus;
-type SubscriberStatus = "active" | "inactive" | "blocked";
+type SubscriberStatus = "active" | "inactive";