@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.4.0-beta.1

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

@@ -6,10 +6,6 @@ export = WebhookPlatformModel;
  * @property {string} [criteria]
  * @property {string} [extension_id]
  */
-/**
- * @typedef AssociationDetails
- * @property {number} [company_id]
- */
 /**
  * @typedef AuthMeta
  * @property {string} [secret]
@@ -17,12 +13,22 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef CancelResponse
- * @property {number} [code] - The HTTP status code of the response (e.g., 200).
+ * @property {string} [message] - The HTTP status code of the response (e.g., 200).
  */
 /**
  * @typedef CdnObject
  * @property {Url[]} [urls]
  */
+/**
+ * @typedef DownloadReportResponse
+ * @property {string} [file_name]
+ */
+/**
+ * @typedef Err
+ * @property {string} [location]
+ * @property {string} [msg]
+ * @property {string} [param]
+ */
 /**
  * @typedef Error
  * @property {string} [error] - Error message describing the reason for the failure.
@@ -47,24 +53,39 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef EventConfigResponse
- * @property {EventConfig[]} [event_configs]
- */
-/**
- * @typedef EventCountItem
- * @property {number} [count] - The count of events with the specified status
- * @property {string} [status] - The status of the event (e.g., "FAILED").
+ * @property {string} [created_on]
+ * @property {string} [description]
+ * @property {string} [display_name]
+ * @property {string} [event_category]
+ * @property {string} [event_name]
+ * @property {Object} [event_schema]
+ * @property {string} [event_type]
+ * @property {number} [id]
+ * @property {string} [updated_on]
+ * @property {string} [version]
  */
 /**
- * @typedef EventProcessedSuccessResponse
- * @property {string} [message]
- * @property {boolean} [success]
+ * @typedef EventConfigs
+ * @property {string} [created_on]
+ * @property {string} [description]
+ * @property {string} [display_name]
+ * @property {string} [event_category]
+ * @property {string} [event_name]
+ * @property {Object} [event_schema]
+ * @property {string} [event_type]
+ * @property {number} [id]
+ * @property {SubscriberEventMapping} [subscriber_event_mapping]
+ * @property {string} [updated_on]
+ * @property {string} [version]
  */
 /**
  * @typedef EventProcessReportObject
  * @property {number} [attempt] - The attempt number of the event.
- * @property {string} [data] - The data associated with the event.
+ * @property {Object} [data] - The data associated with the event.
  * @property {string} [event_name] - The name of the processed event.
+ * @property {string} [event_trace_id]
  * @property {number} [last_attempted_on] - The timestamp of the last attempted event.
+ * @property {string} [message_id]
  * @property {string} [name] - The name of the event.
  * @property {number} [response_code] - The response code of the event.
  * @property {string} [response_message] - The response message of the event.
@@ -83,48 +104,27 @@ export = WebhookPlatformModel;
  * @property {Event[]} [event]
  * @property {string} [search_text]
  * @property {string} [start_date]
+ * @property {string} [status]
  * @property {number[]} [subscriber_ids]
  */
 /**
- * @typedef EventSuccessResponse
- * @property {string} [message]
- * @property {boolean} [success]
- */
-/**
- * @typedef FailedEventsCountSuccessResponse
- * @property {EventCountItem[]} [items]
- */
-/**
- * @typedef FilterResponseObject
- * @property {string} [filter_name] - The name of the filter.
- * @property {FilterValues[]} [values]
- */
-/**
- * @typedef FilterValues
- * @property {string} [text] - The display text for the filter value.
- * @property {Object} [value] - The value associated with the filter value.
+ * @typedef HistoryAssociation
+ * @property {number} [company_id]
+ * @property {number[]} [subscriber_ids]
  */
 /**
  * @typedef HistoryFilters
  * @property {string} [end_date] - The end date and time of the history report.
+ * @property {string[]} [events]
+ * @property {string} [search_text]
  * @property {string} [start_date] - The start date and time of the history report.
  * @property {string} [status] - The status of the history report (e.g., "FAILED").
  * @property {number[]} [subscribers] - An array of subscriber IDs associated
  *   with the history report.
  */
 /**
- * @typedef HistoryPayload
- * @property {number} [page_no] - The page number of the history report.
- * @property {number} [page_size] - The number of records per page.
- * @property {string} [type] - The type of history report (e.g., "platform").
- */
-/**
- * @typedef HistoryResponse
- * @property {HistoryResponseObject[]} [items]
- */
-/**
- * @typedef HistoryResponseObject
- * @property {AssociationDetails} [association]
+ * @typedef HistoryItems
+ * @property {HistoryAssociation} [association]
  * @property {string} [created_on] - The date and time when the history report
  *   was created.
  * @property {string} [filename] - The filename of the history report.
@@ -137,12 +137,20 @@ export = WebhookPlatformModel;
  * @property {UploadServiceObject} [upload_service_response]
  */
 /**
- * @typedef ManualRetryFailedResponse
- * @property {string} [message]
- * @property {Object} [meta]
- * @property {string} [request_id]
- * @property {string} [stack_trace]
- * @property {boolean} [success]
+ * @typedef HistoryPayload
+ * @property {number} [page_no] - The page number of the history report.
+ * @property {number} [page_size] - The number of records per page.
+ * @property {string} [type] - The type of history report (e.g., "platform").
+ */
+/**
+ * @typedef HistoryResponse
+ * @property {HistoryItems[]} [items]
+ * @property {Page} [page]
+ */
+/**
+ * @typedef Item
+ * @property {number} [count]
+ * @property {string} [status]
  */
 /**
  * @typedef Page
@@ -169,13 +177,31 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef ReportFilterResponse
- * @property {FilterResponseObject[]} [items]
+ * @property {string} [filter_name] - The name of the filter.
+ * @property {Object[]} [values]
  */
 /**
  * @typedef ReportFiltersPayload
  * @property {number[]} [subscriber_ids] - An array of subscriber IDs for
  *   filtering filters (optional).
  */
+/**
+ * @typedef RetryCountResponse
+ * @property {Item[]} [items]
+ */
+/**
+ * @typedef RetryEventRequest
+ * @property {string} [end_date]
+ * @property {Event[]} [event]
+ * @property {string} [search_text]
+ * @property {string} [start_date]
+ * @property {string} [status]
+ * @property {number[]} [subscriber_ids]
+ */
+/**
+ * @typedef RetryFailureResponse
+ * @property {Err[]} [err]
+ */
 /**
  * @typedef RetryStatusResponse
  * @property {number} [failure_count] - The count of failed retry attempts.
@@ -184,6 +210,11 @@ export = WebhookPlatformModel;
  * @property {number} [success_count] - The count of successfully retried events.
  * @property {number} [total_event] - The total number of events that require retry.
  */
+/**
+ * @typedef RetrySuccessResponse
+ * @property {string} [message]
+ * @property {boolean} [success]
+ */
 /**
  * @typedef SubscriberConfig
  * @property {Association} [association]
@@ -193,7 +224,7 @@ export = WebhookPlatformModel;
  * @property {number[]} [event_id]
  * @property {number} [id]
  * @property {string} [name]
- * @property {SubscriberStatus} [status]
+ * @property {string} [status]
  * @property {string} [webhook_url]
  */
 /**
@@ -201,6 +232,35 @@ export = WebhookPlatformModel;
  * @property {SubscriberResponse[]} [items]
  * @property {Page} [page]
  */
+/**
+ * @typedef SubscriberConfigResponse
+ * @property {Association} [association]
+ * @property {AuthMeta} [auth_meta]
+ * @property {string} [created_on]
+ * @property {Object} [custom_headers]
+ * @property {string} [email_id]
+ * @property {number[]} [event_id]
+ * @property {number} [id]
+ * @property {string} [modified_by]
+ * @property {string} [name]
+ * @property {string} [status]
+ * @property {string} [type]
+ * @property {string} [updated_on]
+ * @property {string} [webhook_url]
+ */
+/**
+ * @typedef SubscriberEventMapping
+ * @property {string} [created_on]
+ * @property {number} [event_id]
+ * @property {number} [id]
+ * @property {number} [subscriber_id]
+ */
+/**
+ * @typedef SubscriberFailureResponse
+ * @property {string} [code]
+ * @property {string} [message]
+ * @property {string} [stack]
+ */
 /**
  * @typedef SubscriberResponse
  * @property {Association} [association]
@@ -208,10 +268,12 @@ export = WebhookPlatformModel;
  * @property {string} [created_on]
  * @property {Object} [custom_headers]
  * @property {string} [email_id]
- * @property {EventConfig[]} [event_configs]
+ * @property {EventConfigs[]} [event_configs]
  * @property {number} [id]
+ * @property {string} [modified_by]
  * @property {string} [name]
- * @property {SubscriberStatus} [status]
+ * @property {string} [status]
+ * @property {string} [type]
  * @property {string} [updated_on]
  * @property {string} [webhook_url]
  */
@@ -224,11 +286,10 @@ export = WebhookPlatformModel;
  * @property {string} [name] - The name of the uploaded report file.
  * @property {string} [url] - The URL of the uploaded report file.
  */
-/** @typedef {"active" | "inactive" | "blocked"} SubscriberStatus */
 declare class WebhookPlatformModel {
 }
 declare namespace WebhookPlatformModel {
-    export { Association, AssociationDetails, AuthMeta, CancelResponse, CdnObject, Error, Event, EventConfig, EventConfigResponse, EventCountItem, EventProcessedSuccessResponse, EventProcessReportObject, EventProcessReports, EventProcessRequest, EventSuccessResponse, FailedEventsCountSuccessResponse, FilterResponseObject, FilterValues, HistoryFilters, HistoryPayload, HistoryResponse, HistoryResponseObject, ManualRetryFailedResponse, Page, PingWebhook, PingWebhookResponse, ReportFilterResponse, ReportFiltersPayload, RetryStatusResponse, SubscriberConfig, SubscriberConfigList, SubscriberResponse, UploadServiceObject, Url, SubscriberStatus };
+    export { Association, AuthMeta, CancelResponse, CdnObject, DownloadReportResponse, Err, Error, Event, EventConfig, EventConfigResponse, EventConfigs, EventProcessReportObject, EventProcessReports, EventProcessRequest, HistoryAssociation, HistoryFilters, HistoryItems, HistoryPayload, HistoryResponse, Item, Page, PingWebhook, PingWebhookResponse, ReportFilterResponse, ReportFiltersPayload, RetryCountResponse, RetryEventRequest, RetryFailureResponse, RetryStatusResponse, RetrySuccessResponse, SubscriberConfig, SubscriberConfigList, SubscriberConfigResponse, SubscriberEventMapping, SubscriberFailureResponse, SubscriberResponse, UploadServiceObject, Url };
 }
 /** @returns {Association} */
 declare function Association(): Association;
@@ -238,11 +299,6 @@ type Association = {
     criteria?: string;
     extension_id?: string;
 };
-/** @returns {AssociationDetails} */
-declare function AssociationDetails(): AssociationDetails;
-type AssociationDetails = {
-    company_id?: number;
-};
 /** @returns {AuthMeta} */
 declare function AuthMeta(): AuthMeta;
 type AuthMeta = {
@@ -255,13 +311,25 @@ type CancelResponse = {
     /**
      * - The HTTP status code of the response (e.g., 200).
      */
-    code?: number;
+    message?: string;
 };
 /** @returns {CdnObject} */
 declare function CdnObject(): CdnObject;
 type CdnObject = {
     urls?: Url[];
 };
+/** @returns {DownloadReportResponse} */
+declare function DownloadReportResponse(): DownloadReportResponse;
+type DownloadReportResponse = {
+    file_name?: string;
+};
+/** @returns {Err} */
+declare function Err(): Err;
+type Err = {
+    location?: string;
+    msg?: string;
+    param?: string;
+};
 /** @returns {Error} */
 declare function Error(): Error;
 type Error = {
@@ -293,25 +361,31 @@ type EventConfig = {
 /** @returns {EventConfigResponse} */
 declare function EventConfigResponse(): EventConfigResponse;
 type EventConfigResponse = {
-    event_configs?: EventConfig[];
-};
-/** @returns {EventCountItem} */
-declare function EventCountItem(): EventCountItem;
-type EventCountItem = {
-    /**
-     * - The count of events with the specified status
-     */
-    count?: number;
-    /**
-     * - The status of the event (e.g., "FAILED").
-     */
-    status?: string;
+    created_on?: string;
+    description?: string;
+    display_name?: string;
+    event_category?: string;
+    event_name?: string;
+    event_schema?: any;
+    event_type?: string;
+    id?: number;
+    updated_on?: string;
+    version?: string;
 };
-/** @returns {EventProcessedSuccessResponse} */
-declare function EventProcessedSuccessResponse(): EventProcessedSuccessResponse;
-type EventProcessedSuccessResponse = {
-    message?: string;
-    success?: boolean;
+/** @returns {EventConfigs} */
+declare function EventConfigs(): EventConfigs;
+type EventConfigs = {
+    created_on?: string;
+    description?: string;
+    display_name?: string;
+    event_category?: string;
+    event_name?: string;
+    event_schema?: any;
+    event_type?: string;
+    id?: number;
+    subscriber_event_mapping?: SubscriberEventMapping;
+    updated_on?: string;
+    version?: string;
 };
 /** @returns {EventProcessReportObject} */
 declare function EventProcessReportObject(): EventProcessReportObject;
@@ -323,15 +397,17 @@ type EventProcessReportObject = {
     /**
      * - The data associated with the event.
      */
-    data?: string;
+    data?: any;
     /**
      * - The name of the processed event.
      */
     event_name?: string;
+    event_trace_id?: string;
     /**
      * - The timestamp of the last attempted event.
      */
     last_attempted_on?: number;
+    message_id?: string;
     /**
      * - The name of the event.
      */
@@ -370,39 +446,14 @@ type EventProcessRequest = {
     event?: Event[];
     search_text?: string;
     start_date?: string;
+    status?: string;
     subscriber_ids?: number[];
 };
-/** @returns {EventSuccessResponse} */
-declare function EventSuccessResponse(): EventSuccessResponse;
-type EventSuccessResponse = {
-    message?: string;
-    success?: boolean;
-};
-/** @returns {FailedEventsCountSuccessResponse} */
-declare function FailedEventsCountSuccessResponse(): FailedEventsCountSuccessResponse;
-type FailedEventsCountSuccessResponse = {
-    items?: EventCountItem[];
-};
-/** @returns {FilterResponseObject} */
-declare function FilterResponseObject(): FilterResponseObject;
-type FilterResponseObject = {
-    /**
-     * - The name of the filter.
-     */
-    filter_name?: string;
-    values?: FilterValues[];
-};
-/** @returns {FilterValues} */
-declare function FilterValues(): FilterValues;
-type FilterValues = {
-    /**
-     * - The display text for the filter value.
-     */
-    text?: string;
-    /**
-     * - The value associated with the filter value.
-     */
-    value?: any;
+/** @returns {HistoryAssociation} */
+declare function HistoryAssociation(): HistoryAssociation;
+type HistoryAssociation = {
+    company_id?: number;
+    subscriber_ids?: number[];
 };
 /** @returns {HistoryFilters} */
 declare function HistoryFilters(): HistoryFilters;
@@ -411,6 +462,8 @@ type HistoryFilters = {
      * - The end date and time of the history report.
      */
     end_date?: string;
+    events?: string[];
+    search_text?: string;
     /**
      * - The start date and time of the history report.
      */
@@ -425,31 +478,10 @@ type HistoryFilters = {
      */
     subscribers?: number[];
 };
-/** @returns {HistoryPayload} */
-declare function HistoryPayload(): HistoryPayload;
-type HistoryPayload = {
-    /**
-     * - The page number of the history report.
-     */
-    page_no?: number;
-    /**
-     * - The number of records per page.
-     */
-    page_size?: number;
-    /**
-     * - The type of history report (e.g., "platform").
-     */
-    type?: string;
-};
-/** @returns {HistoryResponse} */
-declare function HistoryResponse(): HistoryResponse;
-type HistoryResponse = {
-    items?: HistoryResponseObject[];
-};
-/** @returns {HistoryResponseObject} */
-declare function HistoryResponseObject(): HistoryResponseObject;
-type HistoryResponseObject = {
-    association?: AssociationDetails;
+/** @returns {HistoryItems} */
+declare function HistoryItems(): HistoryItems;
+type HistoryItems = {
+    association?: HistoryAssociation;
     /**
      * - The date and time when the history report
      * was created.
@@ -479,14 +511,33 @@ type HistoryResponseObject = {
     updated_on?: string;
     upload_service_response?: UploadServiceObject;
 };
-/** @returns {ManualRetryFailedResponse} */
-declare function ManualRetryFailedResponse(): ManualRetryFailedResponse;
-type ManualRetryFailedResponse = {
-    message?: string;
-    meta?: any;
-    request_id?: string;
-    stack_trace?: string;
-    success?: boolean;
+/** @returns {HistoryPayload} */
+declare function HistoryPayload(): HistoryPayload;
+type HistoryPayload = {
+    /**
+     * - The page number of the history report.
+     */
+    page_no?: number;
+    /**
+     * - The number of records per page.
+     */
+    page_size?: number;
+    /**
+     * - The type of history report (e.g., "platform").
+     */
+    type?: string;
+};
+/** @returns {HistoryResponse} */
+declare function HistoryResponse(): HistoryResponse;
+type HistoryResponse = {
+    items?: HistoryItems[];
+    page?: Page;
+};
+/** @returns {Item} */
+declare function Item(): Item;
+type Item = {
+    count?: number;
+    status?: string;
 };
 /** @returns {Page} */
 declare function Page(): Page;
@@ -535,7 +586,11 @@ type PingWebhookResponse = {
 /** @returns {ReportFilterResponse} */
 declare function ReportFilterResponse(): ReportFilterResponse;
 type ReportFilterResponse = {
-    items?: FilterResponseObject[];
+    /**
+     * - The name of the filter.
+     */
+    filter_name?: string;
+    values?: any[];
 };
 /** @returns {ReportFiltersPayload} */
 declare function ReportFiltersPayload(): ReportFiltersPayload;
@@ -546,6 +601,26 @@ type ReportFiltersPayload = {
      */
     subscriber_ids?: number[];
 };
+/** @returns {RetryCountResponse} */
+declare function RetryCountResponse(): RetryCountResponse;
+type RetryCountResponse = {
+    items?: Item[];
+};
+/** @returns {RetryEventRequest} */
+declare function RetryEventRequest(): RetryEventRequest;
+type RetryEventRequest = {
+    end_date?: string;
+    event?: Event[];
+    search_text?: string;
+    start_date?: string;
+    status?: string;
+    subscriber_ids?: number[];
+};
+/** @returns {RetryFailureResponse} */
+declare function RetryFailureResponse(): RetryFailureResponse;
+type RetryFailureResponse = {
+    err?: Err[];
+};
 /** @returns {RetryStatusResponse} */
 declare function RetryStatusResponse(): RetryStatusResponse;
 type RetryStatusResponse = {
@@ -567,6 +642,12 @@ type RetryStatusResponse = {
      */
     total_event?: number;
 };
+/** @returns {RetrySuccessResponse} */
+declare function RetrySuccessResponse(): RetrySuccessResponse;
+type RetrySuccessResponse = {
+    message?: string;
+    success?: boolean;
+};
 /** @returns {SubscriberConfig} */
 declare function SubscriberConfig(): SubscriberConfig;
 type SubscriberConfig = {
@@ -577,7 +658,7 @@ type SubscriberConfig = {
     event_id?: number[];
     id?: number;
     name?: string;
-    status?: SubscriberStatus;
+    status?: string;
     webhook_url?: string;
 };
 /** @returns {SubscriberConfigList} */
@@ -586,6 +667,38 @@ type SubscriberConfigList = {
     items?: SubscriberResponse[];
     page?: Page;
 };
+/** @returns {SubscriberConfigResponse} */
+declare function SubscriberConfigResponse(): SubscriberConfigResponse;
+type SubscriberConfigResponse = {
+    association?: Association;
+    auth_meta?: AuthMeta;
+    created_on?: string;
+    custom_headers?: any;
+    email_id?: string;
+    event_id?: number[];
+    id?: number;
+    modified_by?: string;
+    name?: string;
+    status?: string;
+    type?: string;
+    updated_on?: string;
+    webhook_url?: string;
+};
+/** @returns {SubscriberEventMapping} */
+declare function SubscriberEventMapping(): SubscriberEventMapping;
+type SubscriberEventMapping = {
+    created_on?: string;
+    event_id?: number;
+    id?: number;
+    subscriber_id?: number;
+};
+/** @returns {SubscriberFailureResponse} */
+declare function SubscriberFailureResponse(): SubscriberFailureResponse;
+type SubscriberFailureResponse = {
+    code?: string;
+    message?: string;
+    stack?: string;
+};
 /** @returns {SubscriberResponse} */
 declare function SubscriberResponse(): SubscriberResponse;
 type SubscriberResponse = {
@@ -594,10 +707,12 @@ type SubscriberResponse = {
     created_on?: string;
     custom_headers?: any;
     email_id?: string;
-    event_configs?: EventConfig[];
+    event_configs?: EventConfigs[];
     id?: number;
+    modified_by?: string;
     name?: string;
-    status?: SubscriberStatus;
+    status?: string;
+    type?: string;
     updated_on?: string;
     webhook_url?: string;
 };
@@ -618,10 +733,3 @@ type Url = {
      */
     url?: string;
 };
-/**
- * Enum: SubscriberStatus Used By: Webhook
- *
- * @returns {SubscriberStatus}
- */
-declare function SubscriberStatus(): SubscriberStatus;
-type SubscriberStatus = "active" | "inactive" | "blocked";