@enbbox/api 1.0.0

package/dist/esm/api/subscribers-api.d.ts

@@ -0,0 +1,780 @@
+/**
+ * enbbox API
+ * Notification infrastructure API — open-source alternative to Novu/Courier
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { BulkCreateSubscribers } from '../models';
+import type { BulkPreferences } from '../models';
+import type { BulkResult } from '../models';
+import type { CreateSubscriber } from '../models';
+import type { CursorPaginatedFeedItem } from '../models';
+import type { MarkAll } from '../models';
+import type { MarkMessages } from '../models';
+import type { MarkResult } from '../models';
+import type { OnlineStatus } from '../models';
+import type { PaginatedSubscriberRecord } from '../models';
+import type { PatchCredentials } from '../models';
+import type { SetCredentials } from '../models';
+import type { SubscriberRecord } from '../models';
+import type { TopicSubscription } from '../models';
+import type { UnseenCount } from '../models';
+import type { UpdateSubscriber } from '../models';
+/**
+ * SubscribersApi - axios parameter creator
+ */
+export declare const SubscribersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/subscribers/bulk — create multiple subscribers at once
+     * @param {BulkCreateSubscribers} bulkCreateSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkCreate: (bulkCreateSubscribers: BulkCreateSubscribers, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once
+     * @param {string} id Subscriber ID
+     * @param {BulkPreferences} bulkPreferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdatePreferences: (id: string, bulkPreferences: BulkPreferences, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/subscribers
+     * @param {CreateSubscriber} createSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriber: (createSubscriber: CreateSubscriber, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:id/credentials/:provider_id — remove creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {string} providerId Provider ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCredentials: (id: string, providerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriber: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscriber: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriberSubscriptions: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists subscribers for the current project. When the optional `q` query parameter is provided, the list is powered by Typesense full-text search (searching across email, name, phone, subscriber_id). Without `q`, a standard paginated listing from the primary store is returned.
+     * @summary GET /v1/subscribers
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default 10).
+     * @param {number | null} [offset] Number of items to skip (default 0).
+     * @param {string | null} [q] Optional full-text search query (e.g., an email, name, or phone number). When present, search is powered by Typesense.
+     * @param {string | null} [filterBy] Optional filter expression for narrowing results. Example: &#x60;is_online:&#x3D;true&#x60; or &#x60;locale:&#x3D;en-US&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscribers: (limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-all — mark all messages
+     * @param {string} id Subscriber ID
+     * @param {MarkAll} markAll
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAllMessages: (id: string, markAll: MarkAll, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen
+     * @param {string} id Subscriber ID
+     * @param {MarkMessages} markMessages
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markMessages: (id: string, markMessages: MarkMessages, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PUT /v1/subscribers/:id/credentials — replace all creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {SetCredentials} setCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCredentials: (id: string, setCredentials: SetCredentials, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list
+     * @param {string} id Subscriber ID
+     * @param {number | null} [limit]
+     * @param {string | null} [after]
+     * @param {string | null} [before]
+     * @param {string | null} [channel]
+     * @param {boolean | null} [read]
+     * @param {boolean | null} [seen]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    subscriberFeed: (id: string, limit?: number | null, after?: string | null, before?: string | null, channel?: string | null, read?: boolean | null, seen?: boolean | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/unseen — unseen count
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unseenCount: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/online-status — set online/offline
+     * @param {string} id Subscriber ID
+     * @param {OnlineStatus} onlineStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateOnlineStatus: (id: string, onlineStatus: OnlineStatus, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {UpdateSubscriber} updateSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscriber: (id: string, updateSubscriber: UpdateSubscriber, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/credentials — upsert/merge creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {PatchCredentials} patchCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upsertCredentials: (id: string, patchCredentials: PatchCredentials, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * SubscribersApi - functional programming interface
+ */
+export declare const SubscribersApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/subscribers/bulk — create multiple subscribers at once
+     * @param {BulkCreateSubscribers} bulkCreateSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkCreate(bulkCreateSubscribers: BulkCreateSubscribers, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<BulkResult>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once
+     * @param {string} id Subscriber ID
+     * @param {BulkPreferences} bulkPreferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdatePreferences(id: string, bulkPreferences: BulkPreferences, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary POST /v1/subscribers
+     * @param {CreateSubscriber} createSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriber(createSubscriber: CreateSubscriber, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriberRecord>>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:id/credentials/:provider_id — remove creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {string} providerId Provider ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCredentials(id: string, providerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriber(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscriber(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriberRecord>>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriberSubscriptions(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TopicSubscription>>>;
+    /**
+     * Lists subscribers for the current project. When the optional `q` query parameter is provided, the list is powered by Typesense full-text search (searching across email, name, phone, subscriber_id). Without `q`, a standard paginated listing from the primary store is returned.
+     * @summary GET /v1/subscribers
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default 10).
+     * @param {number | null} [offset] Number of items to skip (default 0).
+     * @param {string | null} [q] Optional full-text search query (e.g., an email, name, or phone number). When present, search is powered by Typesense.
+     * @param {string | null} [filterBy] Optional filter expression for narrowing results. Example: &#x60;is_online:&#x3D;true&#x60; or &#x60;locale:&#x3D;en-US&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscribers(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedSubscriberRecord>>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-all — mark all messages
+     * @param {string} id Subscriber ID
+     * @param {MarkAll} markAll
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAllMessages(id: string, markAll: MarkAll, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarkResult>>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen
+     * @param {string} id Subscriber ID
+     * @param {MarkMessages} markMessages
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markMessages(id: string, markMessages: MarkMessages, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MarkResult>>;
+    /**
+     *
+     * @summary PUT /v1/subscribers/:id/credentials — replace all creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {SetCredentials} setCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCredentials(id: string, setCredentials: SetCredentials, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriberRecord>>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list
+     * @param {string} id Subscriber ID
+     * @param {number | null} [limit]
+     * @param {string | null} [after]
+     * @param {string | null} [before]
+     * @param {string | null} [channel]
+     * @param {boolean | null} [read]
+     * @param {boolean | null} [seen]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    subscriberFeed(id: string, limit?: number | null, after?: string | null, before?: string | null, channel?: string | null, read?: boolean | null, seen?: boolean | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CursorPaginatedFeedItem>>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/unseen — unseen count
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unseenCount(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UnseenCount>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/online-status — set online/offline
+     * @param {string} id Subscriber ID
+     * @param {OnlineStatus} onlineStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateOnlineStatus(id: string, onlineStatus: OnlineStatus, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriberRecord>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {UpdateSubscriber} updateSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscriber(id: string, updateSubscriber: UpdateSubscriber, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriberRecord>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/credentials — upsert/merge creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {PatchCredentials} patchCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upsertCredentials(id: string, patchCredentials: PatchCredentials, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SubscriberRecord>>;
+};
+/**
+ * SubscribersApi - factory interface
+ */
+export declare const SubscribersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary POST /v1/subscribers/bulk — create multiple subscribers at once
+     * @param {BulkCreateSubscribers} bulkCreateSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkCreate(bulkCreateSubscribers: BulkCreateSubscribers, options?: RawAxiosRequestConfig): AxiosPromise<BulkResult>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once
+     * @param {string} id Subscriber ID
+     * @param {BulkPreferences} bulkPreferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdatePreferences(id: string, bulkPreferences: BulkPreferences, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary POST /v1/subscribers
+     * @param {CreateSubscriber} createSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriber(createSubscriber: CreateSubscriber, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:id/credentials/:provider_id — remove creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {string} providerId Provider ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCredentials(id: string, providerId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriber(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscriber(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriberSubscriptions(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<TopicSubscription>>;
+    /**
+     * Lists subscribers for the current project. When the optional `q` query parameter is provided, the list is powered by Typesense full-text search (searching across email, name, phone, subscriber_id). Without `q`, a standard paginated listing from the primary store is returned.
+     * @summary GET /v1/subscribers
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default 10).
+     * @param {number | null} [offset] Number of items to skip (default 0).
+     * @param {string | null} [q] Optional full-text search query (e.g., an email, name, or phone number). When present, search is powered by Typesense.
+     * @param {string | null} [filterBy] Optional filter expression for narrowing results. Example: &#x60;is_online:&#x3D;true&#x60; or &#x60;locale:&#x3D;en-US&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscribers(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedSubscriberRecord>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-all — mark all messages
+     * @param {string} id Subscriber ID
+     * @param {MarkAll} markAll
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAllMessages(id: string, markAll: MarkAll, options?: RawAxiosRequestConfig): AxiosPromise<MarkResult>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen
+     * @param {string} id Subscriber ID
+     * @param {MarkMessages} markMessages
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markMessages(id: string, markMessages: MarkMessages, options?: RawAxiosRequestConfig): AxiosPromise<MarkResult>;
+    /**
+     *
+     * @summary PUT /v1/subscribers/:id/credentials — replace all creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {SetCredentials} setCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCredentials(id: string, setCredentials: SetCredentials, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list
+     * @param {string} id Subscriber ID
+     * @param {number | null} [limit]
+     * @param {string | null} [after]
+     * @param {string | null} [before]
+     * @param {string | null} [channel]
+     * @param {boolean | null} [read]
+     * @param {boolean | null} [seen]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    subscriberFeed(id: string, limit?: number | null, after?: string | null, before?: string | null, channel?: string | null, read?: boolean | null, seen?: boolean | null, options?: RawAxiosRequestConfig): AxiosPromise<CursorPaginatedFeedItem>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/unseen — unseen count
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unseenCount(id: string, options?: RawAxiosRequestConfig): AxiosPromise<UnseenCount>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/online-status — set online/offline
+     * @param {string} id Subscriber ID
+     * @param {OnlineStatus} onlineStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateOnlineStatus(id: string, onlineStatus: OnlineStatus, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {UpdateSubscriber} updateSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscriber(id: string, updateSubscriber: UpdateSubscriber, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/credentials — upsert/merge creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {PatchCredentials} patchCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upsertCredentials(id: string, patchCredentials: PatchCredentials, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+};
+/**
+ * SubscribersApi - interface
+ */
+export interface SubscribersApiInterface {
+    /**
+     *
+     * @summary POST /v1/subscribers/bulk — create multiple subscribers at once
+     * @param {BulkCreateSubscribers} bulkCreateSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkCreate(bulkCreateSubscribers: BulkCreateSubscribers, options?: RawAxiosRequestConfig): AxiosPromise<BulkResult>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once
+     * @param {string} id Subscriber ID
+     * @param {BulkPreferences} bulkPreferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdatePreferences(id: string, bulkPreferences: BulkPreferences, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary POST /v1/subscribers
+     * @param {CreateSubscriber} createSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriber(createSubscriber: CreateSubscriber, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:id/credentials/:provider_id — remove creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {string} providerId Provider ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCredentials(id: string, providerId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriber(id: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscriber(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriberSubscriptions(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<TopicSubscription>>;
+    /**
+     * Lists subscribers for the current project. When the optional `q` query parameter is provided, the list is powered by Typesense full-text search (searching across email, name, phone, subscriber_id). Without `q`, a standard paginated listing from the primary store is returned.
+     * @summary GET /v1/subscribers
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default 10).
+     * @param {number | null} [offset] Number of items to skip (default 0).
+     * @param {string | null} [q] Optional full-text search query (e.g., an email, name, or phone number). When present, search is powered by Typesense.
+     * @param {string | null} [filterBy] Optional filter expression for narrowing results. Example: &#x60;is_online:&#x3D;true&#x60; or &#x60;locale:&#x3D;en-US&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscribers(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedSubscriberRecord>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-all — mark all messages
+     * @param {string} id Subscriber ID
+     * @param {MarkAll} markAll
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAllMessages(id: string, markAll: MarkAll, options?: RawAxiosRequestConfig): AxiosPromise<MarkResult>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen
+     * @param {string} id Subscriber ID
+     * @param {MarkMessages} markMessages
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markMessages(id: string, markMessages: MarkMessages, options?: RawAxiosRequestConfig): AxiosPromise<MarkResult>;
+    /**
+     *
+     * @summary PUT /v1/subscribers/:id/credentials — replace all creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {SetCredentials} setCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCredentials(id: string, setCredentials: SetCredentials, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list
+     * @param {string} id Subscriber ID
+     * @param {number | null} [limit]
+     * @param {string | null} [after]
+     * @param {string | null} [before]
+     * @param {string | null} [channel]
+     * @param {boolean | null} [read]
+     * @param {boolean | null} [seen]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    subscriberFeed(id: string, limit?: number | null, after?: string | null, before?: string | null, channel?: string | null, read?: boolean | null, seen?: boolean | null, options?: RawAxiosRequestConfig): AxiosPromise<CursorPaginatedFeedItem>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/unseen — unseen count
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unseenCount(id: string, options?: RawAxiosRequestConfig): AxiosPromise<UnseenCount>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/online-status — set online/offline
+     * @param {string} id Subscriber ID
+     * @param {OnlineStatus} onlineStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateOnlineStatus(id: string, onlineStatus: OnlineStatus, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {UpdateSubscriber} updateSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscriber(id: string, updateSubscriber: UpdateSubscriber, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/credentials — upsert/merge creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {PatchCredentials} patchCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upsertCredentials(id: string, patchCredentials: PatchCredentials, options?: RawAxiosRequestConfig): AxiosPromise<SubscriberRecord>;
+}
+/**
+ * SubscribersApi - object-oriented interface
+ */
+export declare class SubscribersApi extends BaseAPI implements SubscribersApiInterface {
+    /**
+     *
+     * @summary POST /v1/subscribers/bulk — create multiple subscribers at once
+     * @param {BulkCreateSubscribers} bulkCreateSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkCreate(bulkCreateSubscribers: BulkCreateSubscribers, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<BulkResult, any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/bulk — update multiple workflow preferences at once
+     * @param {string} id Subscriber ID
+     * @param {BulkPreferences} bulkPreferences
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    bulkUpdatePreferences(id: string, bulkPreferences: BulkPreferences, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/subscribers
+     * @param {CreateSubscriber} createSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriber(createSubscriber: CreateSubscriber, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriberRecord, any, {}>>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:id/credentials/:provider_id — remove creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {string} providerId Provider ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteCredentials(id: string, providerId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary DELETE /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriber(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscriber(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriberRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/subscriptions — list topic subscriptions for a subscriber
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriberSubscriptions(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TopicSubscription[], any, {}>>;
+    /**
+     * Lists subscribers for the current project. When the optional `q` query parameter is provided, the list is powered by Typesense full-text search (searching across email, name, phone, subscriber_id). Without `q`, a standard paginated listing from the primary store is returned.
+     * @summary GET /v1/subscribers
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default 10).
+     * @param {number | null} [offset] Number of items to skip (default 0).
+     * @param {string | null} [q] Optional full-text search query (e.g., an email, name, or phone number). When present, search is powered by Typesense.
+     * @param {string | null} [filterBy] Optional filter expression for narrowing results. Example: &#x60;is_online:&#x3D;true&#x60; or &#x60;locale:&#x3D;en-US&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscribers(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedSubscriberRecord, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-all — mark all messages
+     * @param {string} id Subscriber ID
+     * @param {MarkAll} markAll
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAllMessages(id: string, markAll: MarkAll, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MarkResult, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/subscribers/:id/messages/mark-as — mark messages as read/seen/unseen
+     * @param {string} id Subscriber ID
+     * @param {MarkMessages} markMessages
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markMessages(id: string, markMessages: MarkMessages, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MarkResult, any, {}>>;
+    /**
+     *
+     * @summary PUT /v1/subscribers/:id/credentials — replace all creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {SetCredentials} setCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    setCredentials(id: string, setCredentials: SetCredentials, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriberRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/feed — cursor-paginated message list
+     * @param {string} id Subscriber ID
+     * @param {number | null} [limit]
+     * @param {string | null} [after]
+     * @param {string | null} [before]
+     * @param {string | null} [channel]
+     * @param {boolean | null} [read]
+     * @param {boolean | null} [seen]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    subscriberFeed(id: string, limit?: number | null, after?: string | null, before?: string | null, channel?: string | null, read?: boolean | null, seen?: boolean | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CursorPaginatedFeedItem, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/notifications/unseen — unseen count
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    unseenCount(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UnseenCount, any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/online-status — set online/offline
+     * @param {string} id Subscriber ID
+     * @param {OnlineStatus} onlineStatus
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateOnlineStatus(id: string, onlineStatus: OnlineStatus, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriberRecord, any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:subscriber_id
+     * @param {string} id Subscriber ID
+     * @param {UpdateSubscriber} updateSubscriber
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscriber(id: string, updateSubscriber: UpdateSubscriber, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriberRecord, any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/credentials — upsert/merge creds for a provider
+     * @param {string} id Subscriber ID
+     * @param {PatchCredentials} patchCredentials
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    upsertCredentials(id: string, patchCredentials: PatchCredentials, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SubscriberRecord, any, {}>>;
+}