@enbbox/api 1.0.0

package/dist/api/topics-api.d.ts

@@ -0,0 +1,689 @@
+/**
+ * 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 { CreateSubscription } from '../models';
+import type { CreateTopic } from '../models';
+import type { DeleteSubscription } from '../models';
+import type { PaginatedTopicRecord } from '../models';
+import type { PaginatedTopicSubscriptionRecord } from '../models';
+import type { TopicRecord } from '../models';
+import type { TopicSubscribers } from '../models';
+import type { TopicSubscriptionRecord } from '../models';
+import type { UpdateSubscriptionMeta } from '../models';
+import type { UpdateTopic } from '../models';
+/**
+ * TopicsApi - axios parameter creator
+ */
+export declare const TopicsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addSubscribers: (key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscribers/:subscriber_id — membership check
+     * @param {string} key
+     * @param {string} subscriberId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkSubscriber: (key: string, subscriberId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/topics/:key/subscriptions — create subscriptions
+     * @param {string} key
+     * @param {CreateSubscription} createSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriptions: (key: string, createSubscription: CreateSubscription, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/topics
+     * @param {CreateTopic} createTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTopic: (createTopic: CreateTopic, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:key/subscriptions — bulk delete
+     * @param {string} key
+     * @param {DeleteSubscription} deleteSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriptions: (key: string, deleteSubscription: DeleteSubscription, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTopic: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions/:id — get single subscription
+     * @param {string} key
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscription: (key: string, id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTopic: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions — list subscriptions
+     * @param {string} key
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriptions: (key: string, limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopicSubscribers: (key: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/topics
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopics: (limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers/removal
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSubscribers: (key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata
+     * @param {string} key
+     * @param {string} id
+     * @param {UpdateSubscriptionMeta} updateSubscriptionMeta
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscription: (key: string, id: string, updateSubscriptionMeta: UpdateSubscriptionMeta, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {UpdateTopic} updateTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTopic: (key: string, updateTopic: UpdateTopic, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TopicsApi - functional programming interface
+ */
+export declare const TopicsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addSubscribers(key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscribers/:subscriber_id — membership check
+     * @param {string} key
+     * @param {string} subscriberId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkSubscriber(key: string, subscriberId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary POST /v1/topics/:key/subscriptions — create subscriptions
+     * @param {string} key
+     * @param {CreateSubscription} createSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriptions(key: string, createSubscription: CreateSubscription, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<TopicSubscriptionRecord>>>;
+    /**
+     *
+     * @summary POST /v1/topics
+     * @param {CreateTopic} createTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTopic(createTopic: CreateTopic, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicRecord>>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:key/subscriptions — bulk delete
+     * @param {string} key
+     * @param {DeleteSubscription} deleteSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriptions(key: string, deleteSubscription: DeleteSubscription, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTopic(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions/:id — get single subscription
+     * @param {string} key
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscription(key: string, id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicSubscriptionRecord>>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTopic(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicRecord>>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions — list subscriptions
+     * @param {string} key
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriptions(key: string, limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTopicSubscriptionRecord>>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopicSubscribers(key: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    /**
+     *
+     * @summary GET /v1/topics
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopics(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaginatedTopicRecord>>;
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers/removal
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSubscribers(key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata
+     * @param {string} key
+     * @param {string} id
+     * @param {UpdateSubscriptionMeta} updateSubscriptionMeta
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscription(key: string, id: string, updateSubscriptionMeta: UpdateSubscriptionMeta, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicSubscriptionRecord>>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {UpdateTopic} updateTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTopic(key: string, updateTopic: UpdateTopic, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicRecord>>;
+};
+/**
+ * TopicsApi - factory interface
+ */
+export declare const TopicsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addSubscribers(key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscribers/:subscriber_id — membership check
+     * @param {string} key
+     * @param {string} subscriberId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkSubscriber(key: string, subscriberId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary POST /v1/topics/:key/subscriptions — create subscriptions
+     * @param {string} key
+     * @param {CreateSubscription} createSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriptions(key: string, createSubscription: CreateSubscription, options?: RawAxiosRequestConfig): AxiosPromise<Array<TopicSubscriptionRecord>>;
+    /**
+     *
+     * @summary POST /v1/topics
+     * @param {CreateTopic} createTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTopic(createTopic: CreateTopic, options?: RawAxiosRequestConfig): AxiosPromise<TopicRecord>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:key/subscriptions — bulk delete
+     * @param {string} key
+     * @param {DeleteSubscription} deleteSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriptions(key: string, deleteSubscription: DeleteSubscription, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTopic(key: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions/:id — get single subscription
+     * @param {string} key
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscription(key: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<TopicSubscriptionRecord>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTopic(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TopicRecord>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions — list subscriptions
+     * @param {string} key
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriptions(key: string, limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTopicSubscriptionRecord>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopicSubscribers(key: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    /**
+     *
+     * @summary GET /v1/topics
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopics(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTopicRecord>;
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers/removal
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSubscribers(key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata
+     * @param {string} key
+     * @param {string} id
+     * @param {UpdateSubscriptionMeta} updateSubscriptionMeta
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscription(key: string, id: string, updateSubscriptionMeta: UpdateSubscriptionMeta, options?: RawAxiosRequestConfig): AxiosPromise<TopicSubscriptionRecord>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {UpdateTopic} updateTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTopic(key: string, updateTopic: UpdateTopic, options?: RawAxiosRequestConfig): AxiosPromise<TopicRecord>;
+};
+/**
+ * TopicsApi - interface
+ */
+export interface TopicsApiInterface {
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addSubscribers(key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscribers/:subscriber_id — membership check
+     * @param {string} key
+     * @param {string} subscriberId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkSubscriber(key: string, subscriberId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary POST /v1/topics/:key/subscriptions — create subscriptions
+     * @param {string} key
+     * @param {CreateSubscription} createSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriptions(key: string, createSubscription: CreateSubscription, options?: RawAxiosRequestConfig): AxiosPromise<Array<TopicSubscriptionRecord>>;
+    /**
+     *
+     * @summary POST /v1/topics
+     * @param {CreateTopic} createTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTopic(createTopic: CreateTopic, options?: RawAxiosRequestConfig): AxiosPromise<TopicRecord>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:key/subscriptions — bulk delete
+     * @param {string} key
+     * @param {DeleteSubscription} deleteSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriptions(key: string, deleteSubscription: DeleteSubscription, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTopic(key: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions/:id — get single subscription
+     * @param {string} key
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscription(key: string, id: string, options?: RawAxiosRequestConfig): AxiosPromise<TopicSubscriptionRecord>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTopic(key: string, options?: RawAxiosRequestConfig): AxiosPromise<TopicRecord>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions — list subscriptions
+     * @param {string} key
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriptions(key: string, limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTopicSubscriptionRecord>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopicSubscribers(key: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    /**
+     *
+     * @summary GET /v1/topics
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopics(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<PaginatedTopicRecord>;
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers/removal
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSubscribers(key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata
+     * @param {string} key
+     * @param {string} id
+     * @param {UpdateSubscriptionMeta} updateSubscriptionMeta
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscription(key: string, id: string, updateSubscriptionMeta: UpdateSubscriptionMeta, options?: RawAxiosRequestConfig): AxiosPromise<TopicSubscriptionRecord>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {UpdateTopic} updateTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTopic(key: string, updateTopic: UpdateTopic, options?: RawAxiosRequestConfig): AxiosPromise<TopicRecord>;
+}
+/**
+ * TopicsApi - object-oriented interface
+ */
+export declare class TopicsApi extends BaseAPI implements TopicsApiInterface {
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addSubscribers(key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscribers/:subscriber_id — membership check
+     * @param {string} key
+     * @param {string} subscriberId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    checkSubscriber(key: string, subscriberId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/topics/:key/subscriptions — create subscriptions
+     * @param {string} key
+     * @param {CreateSubscription} createSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createSubscriptions(key: string, createSubscription: CreateSubscription, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TopicSubscriptionRecord[], any, {}>>;
+    /**
+     *
+     * @summary POST /v1/topics
+     * @param {CreateTopic} createTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createTopic(createTopic: CreateTopic, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TopicRecord, any, {}>>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:key/subscriptions — bulk delete
+     * @param {string} key
+     * @param {DeleteSubscription} deleteSubscription
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteSubscriptions(key: string, deleteSubscription: DeleteSubscription, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary DELETE /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteTopic(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions/:id — get single subscription
+     * @param {string} key
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubscription(key: string, id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TopicSubscriptionRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTopic(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TopicRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/topics/:key/subscriptions — list subscriptions
+     * @param {string} key
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listSubscriptions(key: string, limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTopicSubscriptionRecord, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/topics/:topicKey/subscribers
+     * @param {string} key Topic key
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopicSubscribers(key: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
+    /**
+     *
+     * @summary GET /v1/topics
+     * @param {number | null} [limit] Maximum number of items to return (1–100, default: 10).
+     * @param {number | null} [offset] Number of items to skip before returning results (default: 0).
+     * @param {string | null} [q] Optional full-text search query. When present, listing is powered by Typesense full-text search.
+     * @param {string | null} [filterBy] Optional Typesense filter expression for narrowing results. Example: &#x60;identifier:&#x3D;acme-corp&#x60; or &#x60;name:&#x3D;General&#x60;.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listTopics(limit?: number | null, offset?: number | null, q?: string | null, filterBy?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PaginatedTopicRecord, any, {}>>;
+    /**
+     *
+     * @summary POST /v1/topics/:topicKey/subscribers/removal
+     * @param {string} key Topic key
+     * @param {TopicSubscribers} topicSubscribers
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeSubscribers(key: string, topicSubscribers: TopicSubscribers, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:key/subscriptions/:id — update subscription metadata
+     * @param {string} key
+     * @param {string} id
+     * @param {UpdateSubscriptionMeta} updateSubscriptionMeta
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateSubscription(key: string, id: string, updateSubscriptionMeta: UpdateSubscriptionMeta, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TopicSubscriptionRecord, any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/topics/:topicKey
+     * @param {string} key Topic key
+     * @param {UpdateTopic} updateTopic
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateTopic(key: string, updateTopic: UpdateTopic, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TopicRecord, any, {}>>;
+}