@enbbox/api 1.0.0

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

@@ -0,0 +1,171 @@
+/**
+ * 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 { JobLog } from '../models';
+import type { NotificationLog } from '../models';
+/**
+ * NotificationsApi - axios parameter creator
+ */
+export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary GET /v1/notifications/:id
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/notifications/:id/jobs
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationJobs: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary GET /v1/notifications
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications: (limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * NotificationsApi - functional programming interface
+ */
+export declare const NotificationsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary GET /v1/notifications/:id
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NotificationLog>>;
+    /**
+     *
+     * @summary GET /v1/notifications/:id/jobs
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationJobs(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<JobLog>>>;
+    /**
+     *
+     * @summary GET /v1/notifications
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<NotificationLog>>>;
+};
+/**
+ * NotificationsApi - factory interface
+ */
+export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary GET /v1/notifications/:id
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification(id: string, options?: RawAxiosRequestConfig): AxiosPromise<NotificationLog>;
+    /**
+     *
+     * @summary GET /v1/notifications/:id/jobs
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationJobs(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<JobLog>>;
+    /**
+     *
+     * @summary GET /v1/notifications
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<NotificationLog>>;
+};
+/**
+ * NotificationsApi - interface
+ */
+export interface NotificationsApiInterface {
+    /**
+     *
+     * @summary GET /v1/notifications/:id
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification(id: string, options?: RawAxiosRequestConfig): AxiosPromise<NotificationLog>;
+    /**
+     *
+     * @summary GET /v1/notifications/:id/jobs
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationJobs(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<JobLog>>;
+    /**
+     *
+     * @summary GET /v1/notifications
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): AxiosPromise<Array<NotificationLog>>;
+}
+/**
+ * NotificationsApi - object-oriented interface
+ */
+export declare class NotificationsApi extends BaseAPI implements NotificationsApiInterface {
+    /**
+     *
+     * @summary GET /v1/notifications/:id
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NotificationLog, any, {}>>;
+    /**
+     *
+     * @summary GET /v1/notifications/:id/jobs
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationJobs(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<JobLog[], any, {}>>;
+    /**
+     *
+     * @summary GET /v1/notifications
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(limit?: number | null, page?: number | null, q?: string | null, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NotificationLog[], any, {}>>;
+}

package/dist/api/notifications-api.js

@@ -0,0 +1,284 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationsApi = exports.NotificationsApiFactory = exports.NotificationsApiFp = exports.NotificationsApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * NotificationsApi - axios parameter creator
+ */
+const NotificationsApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         *
+         * @summary GET /v1/notifications/:id
+         * @param {string} id Notification ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNotification: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('getNotification', 'id', id);
+            const localVarPath = `/v1/notifications/{id}/`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication bearer_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary GET /v1/notifications/:id/jobs
+         * @param {string} id Notification ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNotificationJobs: (id_1, ...args_1) => __awaiter(this, [id_1, ...args_1], void 0, function* (id, options = {}) {
+            // verify required parameter 'id' is not null or undefined
+            (0, common_1.assertParamExists)('getNotificationJobs', 'id', id);
+            const localVarPath = `/v1/notifications/{id}/jobs/`
+                .replace(`{${"id"}}`, encodeURIComponent(String(id)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication bearer_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         *
+         * @summary GET /v1/notifications
+         * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+         * @param {number | null} [page] Zero-based page index (default: 0).
+         * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listNotifications: (limit_1, page_1, q_1, ...args_1) => __awaiter(this, [limit_1, page_1, q_1, ...args_1], void 0, function* (limit, page, q, options = {}) {
+            const localVarPath = `/v1/notifications/`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication bearer_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            if (limit !== undefined) {
+                localVarQueryParameter['limit'] = limit;
+            }
+            if (page !== undefined) {
+                localVarQueryParameter['page'] = page;
+            }
+            if (q !== undefined) {
+                localVarQueryParameter['q'] = q;
+            }
+            localVarHeaderParameter['Accept'] = 'application/json';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.NotificationsApiAxiosParamCreator = NotificationsApiAxiosParamCreator;
+/**
+ * NotificationsApi - functional programming interface
+ */
+const NotificationsApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.NotificationsApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         *
+         * @summary GET /v1/notifications/:id
+         * @param {string} id Notification ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNotification(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotification(id, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NotificationsApi.getNotification']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         *
+         * @summary GET /v1/notifications/:id/jobs
+         * @param {string} id Notification ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNotificationJobs(id, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getNotificationJobs(id, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NotificationsApi.getNotificationJobs']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+        /**
+         *
+         * @summary GET /v1/notifications
+         * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+         * @param {number | null} [page] Zero-based page index (default: 0).
+         * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listNotifications(limit, page, q, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listNotifications(limit, page, q, options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['NotificationsApi.listNotifications']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+exports.NotificationsApiFp = NotificationsApiFp;
+/**
+ * NotificationsApi - factory interface
+ */
+const NotificationsApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.NotificationsApiFp)(configuration);
+    return {
+        /**
+         *
+         * @summary GET /v1/notifications/:id
+         * @param {string} id Notification ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNotification(id, options) {
+            return localVarFp.getNotification(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary GET /v1/notifications/:id/jobs
+         * @param {string} id Notification ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getNotificationJobs(id, options) {
+            return localVarFp.getNotificationJobs(id, options).then((request) => request(axios, basePath));
+        },
+        /**
+         *
+         * @summary GET /v1/notifications
+         * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+         * @param {number | null} [page] Zero-based page index (default: 0).
+         * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listNotifications(limit, page, q, options) {
+            return localVarFp.listNotifications(limit, page, q, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.NotificationsApiFactory = NotificationsApiFactory;
+/**
+ * NotificationsApi - object-oriented interface
+ */
+class NotificationsApi extends base_1.BaseAPI {
+    /**
+     *
+     * @summary GET /v1/notifications/:id
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification(id, options) {
+        return (0, exports.NotificationsApiFp)(this.configuration).getNotification(id, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary GET /v1/notifications/:id/jobs
+     * @param {string} id Notification ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotificationJobs(id, options) {
+        return (0, exports.NotificationsApiFp)(this.configuration).getNotificationJobs(id, options).then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     *
+     * @summary GET /v1/notifications
+     * @param {number | null} [limit] Maximum number of items per page (1–100, default: 10).
+     * @param {number | null} [page] Zero-based page index (default: 0).
+     * @param {string | null} [q] Optional full-text search query (e.g. subscriber_id, transaction_id).
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(limit, page, q, options) {
+        return (0, exports.NotificationsApiFp)(this.configuration).listNotifications(limit, page, q, options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.NotificationsApi = NotificationsApi;

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

@@ -0,0 +1,176 @@
+/**
+ * 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 { PreferenceRecord } from '../models';
+import type { UpdatePreference } from '../models';
+/**
+ * PreferencesApi - axios parameter creator
+ */
+export declare const PreferencesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPreferences: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateGlobalPreference: (id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
+     * @param {string} id Subscriber ID
+     * @param {string} workflowId Workflow ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowPreference: (id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * PreferencesApi - functional programming interface
+ */
+export declare const PreferencesApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPreferences(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PreferenceRecord>>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateGlobalPreference(id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferenceRecord>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
+     * @param {string} id Subscriber ID
+     * @param {string} workflowId Workflow ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowPreference(id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PreferenceRecord>>;
+};
+/**
+ * PreferencesApi - factory interface
+ */
+export declare const PreferencesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPreferences(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PreferenceRecord>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateGlobalPreference(id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): AxiosPromise<PreferenceRecord>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
+     * @param {string} id Subscriber ID
+     * @param {string} workflowId Workflow ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowPreference(id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): AxiosPromise<PreferenceRecord>;
+};
+/**
+ * PreferencesApi - interface
+ */
+export interface PreferencesApiInterface {
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPreferences(id: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<PreferenceRecord>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateGlobalPreference(id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): AxiosPromise<PreferenceRecord>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
+     * @param {string} id Subscriber ID
+     * @param {string} workflowId Workflow ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowPreference(id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): AxiosPromise<PreferenceRecord>;
+}
+/**
+ * PreferencesApi - object-oriented interface
+ */
+export declare class PreferencesApi extends BaseAPI implements PreferencesApiInterface {
+    /**
+     *
+     * @summary GET /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listPreferences(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferenceRecord[], any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences
+     * @param {string} id Subscriber ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateGlobalPreference(id: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferenceRecord, any, {}>>;
+    /**
+     *
+     * @summary PATCH /v1/subscribers/:id/preferences/:workflowId
+     * @param {string} id Subscriber ID
+     * @param {string} workflowId Workflow ID
+     * @param {UpdatePreference} updatePreference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateWorkflowPreference(id: string, workflowId: string, updatePreference: UpdatePreference, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PreferenceRecord, any, {}>>;
+}