mixpeek 0.81.1

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

@@ -0,0 +1,735 @@
+/**
+ * Mixpeek API
+ * This is the Mixpeek API, providing access to various endpoints for data processing and retrieval.
+ *
+ * The version of the OpenAPI document: 0.81.1
+ * Contact: info@mixpeek.com
+ *
+ * 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 { BodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost } from '../models';
+import type { ListNotificationsRequest } from '../models';
+import type { ListNotificationsResponse } from '../models';
+import type { MarkAsReadRequest } from '../models';
+import type { Notification } from '../models';
+import type { ReminderPreferencesResponse } from '../models';
+import type { UpdatePreferencesRequest } from '../models';
+import type { UpdateReminderPreferencesRequest } from '../models';
+/**
+ * NotificationsApi - axios parameter creator
+ * @export
+ */
+export declare const NotificationsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Advance the funnel stage from the client side.  Studio calls this when key milestones happen in-browser that the server cannot observe directly (e.g. first_search executed in the test tab). Only a restricted set of stages can be advanced this way.
+     * @summary Advance Funnel Stage
+     * @param {BodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost} bodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \'Bearer sk_xxxxxxxxxxxxx\'. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    advanceFunnelStageNotifications: (bodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost: BodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost, authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Delete a notification (idempotent - succeeds even if already deleted).
+     * @summary Delete Notification
+     * @param {string} notificationId
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotification: (notificationId: string, authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get the current funnel state for the organization.  Returns the user\'s position in the onboarding funnel, including: - Current stage - When each stage was reached - Nudges that have been sent - Last activity timestamp
+     * @summary Get Funnel State
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFunnelStateNotifications: (authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a single notification by its ID.
+     * @summary Get Notification
+     * @param {string} notificationId
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification: (notificationId: string, authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get notification preferences for the organization.
+     * @summary Get Preferences
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPreferencesNotifications: (authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get reminder/nudge email preferences for the organization.  These preferences control funnel-based onboarding nudges, re-engagement emails, and feature tips.
+     * @summary Get Reminder Preferences
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReminderPreferencesNotifications: (authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get count of unread notifications.
+     * @summary Get Unread Count
+     * @param {string} [userId]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUnreadCountNotifications: (userId?: string, authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all notifications for the user\'s organization.
+     * @summary List Notifications
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {boolean} [includeTotal]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {ListNotificationsRequest} [listNotificationsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications: (limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, listNotificationsRequest?: ListNotificationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Mark all notifications as read for a user.
+     * @summary Mark All As Read
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {MarkAsReadRequest} [markAsReadRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAllAsReadNotifications: (authorization?: string, markAsReadRequest?: MarkAsReadRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Mark a notification as read.
+     * @summary Mark As Read
+     * @param {string} notificationId
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAsReadNotifications: (notificationId: string, authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update notification preferences for the organization.
+     * @summary Update Preferences
+     * @param {UpdatePreferencesRequest} updatePreferencesRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePreferencesNotifications: (updatePreferencesRequest: UpdatePreferencesRequest, authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update reminder/nudge email preferences for the organization.  You can update individual preferences without affecting others: - enabled: Master toggle for all reminder emails - onboarding_nudges: Funnel progression nudges - engagement_reminders: Re-engagement emails for inactivity - feature_tips: Helpful tips and inspiration - quiet_hours_start/end: Hours (0-23 UTC) when no emails are sent
+     * @summary Update Reminder Preferences
+     * @param {UpdateReminderPreferencesRequest} updateReminderPreferencesRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateReminderPreferencesNotifications: (updateReminderPreferencesRequest: UpdateReminderPreferencesRequest, authorization?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * NotificationsApi - functional programming interface
+ * @export
+ */
+export declare const NotificationsApiFp: (configuration?: Configuration) => {
+    /**
+     * Advance the funnel stage from the client side.  Studio calls this when key milestones happen in-browser that the server cannot observe directly (e.g. first_search executed in the test tab). Only a restricted set of stages can be advanced this way.
+     * @summary Advance Funnel Stage
+     * @param {BodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost} bodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    advanceFunnelStageNotifications(bodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost: BodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Delete a notification (idempotent - succeeds even if already deleted).
+     * @summary Delete Notification
+     * @param {string} notificationId
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotification(notificationId: string, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Get the current funnel state for the organization.  Returns the user\'s position in the onboarding funnel, including: - Current stage - When each stage was reached - Nudges that have been sent - Last activity timestamp
+     * @summary Get Funnel State
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFunnelStateNotifications(authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get a single notification by its ID.
+     * @summary Get Notification
+     * @param {string} notificationId
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification(notificationId: string, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
+    /**
+     * Get notification preferences for the organization.
+     * @summary Get Preferences
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPreferencesNotifications(authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Get reminder/nudge email preferences for the organization.  These preferences control funnel-based onboarding nudges, re-engagement emails, and feature tips.
+     * @summary Get Reminder Preferences
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReminderPreferencesNotifications(authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReminderPreferencesResponse>>;
+    /**
+     * Get count of unread notifications.
+     * @summary Get Unread Count
+     * @param {string} [userId]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUnreadCountNotifications(userId?: string, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * List all notifications for the user\'s organization.
+     * @summary List Notifications
+     * @param {number} [limit]
+     * @param {number} [offset]
+     * @param {string} [cursor]
+     * @param {boolean} [includeTotal]
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {ListNotificationsRequest} [listNotificationsRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(limit?: number, offset?: number, cursor?: string, includeTotal?: boolean, authorization?: string, listNotificationsRequest?: ListNotificationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListNotificationsResponse>>;
+    /**
+     * Mark all notifications as read for a user.
+     * @summary Mark All As Read
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {MarkAsReadRequest} [markAsReadRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAllAsReadNotifications(authorization?: string, markAsReadRequest?: MarkAsReadRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<any>>;
+    /**
+     * Mark a notification as read.
+     * @summary Mark As Read
+     * @param {string} notificationId
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAsReadNotifications(notificationId: string, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Notification>>;
+    /**
+     * Update notification preferences for the organization.
+     * @summary Update Preferences
+     * @param {UpdatePreferencesRequest} updatePreferencesRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePreferencesNotifications(updatePreferencesRequest: UpdatePreferencesRequest, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
+        [key: string]: any;
+    }>>;
+    /**
+     * Update reminder/nudge email preferences for the organization.  You can update individual preferences without affecting others: - enabled: Master toggle for all reminder emails - onboarding_nudges: Funnel progression nudges - engagement_reminders: Re-engagement emails for inactivity - feature_tips: Helpful tips and inspiration - quiet_hours_start/end: Hours (0-23 UTC) when no emails are sent
+     * @summary Update Reminder Preferences
+     * @param {UpdateReminderPreferencesRequest} updateReminderPreferencesRequest
+     * @param {string} [authorization] REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateReminderPreferencesNotifications(updateReminderPreferencesRequest: UpdateReminderPreferencesRequest, authorization?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReminderPreferencesResponse>>;
+};
+/**
+ * NotificationsApi - factory interface
+ * @export
+ */
+export declare const NotificationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Advance the funnel stage from the client side.  Studio calls this when key milestones happen in-browser that the server cannot observe directly (e.g. first_search executed in the test tab). Only a restricted set of stages can be advanced this way.
+     * @summary Advance Funnel Stage
+     * @param {NotificationsApiAdvanceFunnelStageNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    advanceFunnelStageNotifications(requestParameters: NotificationsApiAdvanceFunnelStageNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Delete a notification (idempotent - succeeds even if already deleted).
+     * @summary Delete Notification
+     * @param {NotificationsApiDeleteNotificationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteNotification(requestParameters: NotificationsApiDeleteNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Get the current funnel state for the organization.  Returns the user\'s position in the onboarding funnel, including: - Current stage - When each stage was reached - Nudges that have been sent - Last activity timestamp
+     * @summary Get Funnel State
+     * @param {NotificationsApiGetFunnelStateNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFunnelStateNotifications(requestParameters?: NotificationsApiGetFunnelStateNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get a single notification by its ID.
+     * @summary Get Notification
+     * @param {NotificationsApiGetNotificationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getNotification(requestParameters: NotificationsApiGetNotificationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Notification>;
+    /**
+     * Get notification preferences for the organization.
+     * @summary Get Preferences
+     * @param {NotificationsApiGetPreferencesNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPreferencesNotifications(requestParameters?: NotificationsApiGetPreferencesNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Get reminder/nudge email preferences for the organization.  These preferences control funnel-based onboarding nudges, re-engagement emails, and feature tips.
+     * @summary Get Reminder Preferences
+     * @param {NotificationsApiGetReminderPreferencesNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getReminderPreferencesNotifications(requestParameters?: NotificationsApiGetReminderPreferencesNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReminderPreferencesResponse>;
+    /**
+     * Get count of unread notifications.
+     * @summary Get Unread Count
+     * @param {NotificationsApiGetUnreadCountNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getUnreadCountNotifications(requestParameters?: NotificationsApiGetUnreadCountNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
+        [key: string]: any;
+    }>;
+    /**
+     * List all notifications for the user\'s organization.
+     * @summary List Notifications
+     * @param {NotificationsApiListNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listNotifications(requestParameters?: NotificationsApiListNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListNotificationsResponse>;
+    /**
+     * Mark all notifications as read for a user.
+     * @summary Mark All As Read
+     * @param {NotificationsApiMarkAllAsReadNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAllAsReadNotifications(requestParameters?: NotificationsApiMarkAllAsReadNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<any>;
+    /**
+     * Mark a notification as read.
+     * @summary Mark As Read
+     * @param {NotificationsApiMarkAsReadNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    markAsReadNotifications(requestParameters: NotificationsApiMarkAsReadNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<Notification>;
+    /**
+     * Update notification preferences for the organization.
+     * @summary Update Preferences
+     * @param {NotificationsApiUpdatePreferencesNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updatePreferencesNotifications(requestParameters: NotificationsApiUpdatePreferencesNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<{
+        [key: string]: any;
+    }>;
+    /**
+     * Update reminder/nudge email preferences for the organization.  You can update individual preferences without affecting others: - enabled: Master toggle for all reminder emails - onboarding_nudges: Funnel progression nudges - engagement_reminders: Re-engagement emails for inactivity - feature_tips: Helpful tips and inspiration - quiet_hours_start/end: Hours (0-23 UTC) when no emails are sent
+     * @summary Update Reminder Preferences
+     * @param {NotificationsApiUpdateReminderPreferencesNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateReminderPreferencesNotifications(requestParameters: NotificationsApiUpdateReminderPreferencesNotificationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReminderPreferencesResponse>;
+};
+/**
+ * Request parameters for advanceFunnelStageNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiAdvanceFunnelStageNotificationsRequest
+ */
+export interface NotificationsApiAdvanceFunnelStageNotificationsRequest {
+    /**
+     *
+     * @type {BodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost}
+     * @memberof NotificationsApiAdvanceFunnelStageNotifications
+     */
+    readonly bodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost: BodyAdvanceFunnelStageV1NotificationsFunnelAdvancePost;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiAdvanceFunnelStageNotifications
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteNotification operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiDeleteNotificationRequest
+ */
+export interface NotificationsApiDeleteNotificationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof NotificationsApiDeleteNotification
+     */
+    readonly notificationId: string;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiDeleteNotification
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getFunnelStateNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiGetFunnelStateNotificationsRequest
+ */
+export interface NotificationsApiGetFunnelStateNotificationsRequest {
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiGetFunnelStateNotifications
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getNotification operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiGetNotificationRequest
+ */
+export interface NotificationsApiGetNotificationRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof NotificationsApiGetNotification
+     */
+    readonly notificationId: string;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiGetNotification
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getPreferencesNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiGetPreferencesNotificationsRequest
+ */
+export interface NotificationsApiGetPreferencesNotificationsRequest {
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiGetPreferencesNotifications
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getReminderPreferencesNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiGetReminderPreferencesNotificationsRequest
+ */
+export interface NotificationsApiGetReminderPreferencesNotificationsRequest {
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiGetReminderPreferencesNotifications
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getUnreadCountNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiGetUnreadCountNotificationsRequest
+ */
+export interface NotificationsApiGetUnreadCountNotificationsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof NotificationsApiGetUnreadCountNotifications
+     */
+    readonly userId?: string;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiGetUnreadCountNotifications
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiListNotificationsRequest
+ */
+export interface NotificationsApiListNotificationsRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof NotificationsApiListNotifications
+     */
+    readonly limit?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof NotificationsApiListNotifications
+     */
+    readonly offset?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof NotificationsApiListNotifications
+     */
+    readonly cursor?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof NotificationsApiListNotifications
+     */
+    readonly includeTotal?: boolean;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiListNotifications
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {ListNotificationsRequest}
+     * @memberof NotificationsApiListNotifications
+     */
+    readonly listNotificationsRequest?: ListNotificationsRequest;
+}
+/**
+ * Request parameters for markAllAsReadNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiMarkAllAsReadNotificationsRequest
+ */
+export interface NotificationsApiMarkAllAsReadNotificationsRequest {
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiMarkAllAsReadNotifications
+     */
+    readonly authorization?: string;
+    /**
+     *
+     * @type {MarkAsReadRequest}
+     * @memberof NotificationsApiMarkAllAsReadNotifications
+     */
+    readonly markAsReadRequest?: MarkAsReadRequest;
+}
+/**
+ * Request parameters for markAsReadNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiMarkAsReadNotificationsRequest
+ */
+export interface NotificationsApiMarkAsReadNotificationsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof NotificationsApiMarkAsReadNotifications
+     */
+    readonly notificationId: string;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiMarkAsReadNotifications
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updatePreferencesNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiUpdatePreferencesNotificationsRequest
+ */
+export interface NotificationsApiUpdatePreferencesNotificationsRequest {
+    /**
+     *
+     * @type {UpdatePreferencesRequest}
+     * @memberof NotificationsApiUpdatePreferencesNotifications
+     */
+    readonly updatePreferencesRequest: UpdatePreferencesRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiUpdatePreferencesNotifications
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for updateReminderPreferencesNotifications operation in NotificationsApi.
+ * @export
+ * @interface NotificationsApiUpdateReminderPreferencesNotificationsRequest
+ */
+export interface NotificationsApiUpdateReminderPreferencesNotificationsRequest {
+    /**
+     *
+     * @type {UpdateReminderPreferencesRequest}
+     * @memberof NotificationsApiUpdateReminderPreferencesNotifications
+     */
+    readonly updateReminderPreferencesRequest: UpdateReminderPreferencesRequest;
+    /**
+     * REQUIRED: Bearer token authentication using your API key. Format: \&#39;Bearer sk_xxxxxxxxxxxxx\&#39;. You can create API keys in the Mixpeek dashboard under Organization Settings.
+     * @type {string}
+     * @memberof NotificationsApiUpdateReminderPreferencesNotifications
+     */
+    readonly authorization?: string;
+}
+/**
+ * NotificationsApi - object-oriented interface
+ * @export
+ * @class NotificationsApi
+ * @extends {BaseAPI}
+ */
+export declare class NotificationsApi extends BaseAPI {
+    /**
+     * Advance the funnel stage from the client side.  Studio calls this when key milestones happen in-browser that the server cannot observe directly (e.g. first_search executed in the test tab). Only a restricted set of stages can be advanced this way.
+     * @summary Advance Funnel Stage
+     * @param {NotificationsApiAdvanceFunnelStageNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    advanceFunnelStageNotifications(requestParameters: NotificationsApiAdvanceFunnelStageNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}>>;
+    /**
+     * Delete a notification (idempotent - succeeds even if already deleted).
+     * @summary Delete Notification
+     * @param {NotificationsApiDeleteNotificationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    deleteNotification(requestParameters: NotificationsApiDeleteNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Get the current funnel state for the organization.  Returns the user\'s position in the onboarding funnel, including: - Current stage - When each stage was reached - Nudges that have been sent - Last activity timestamp
+     * @summary Get Funnel State
+     * @param {NotificationsApiGetFunnelStateNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    getFunnelStateNotifications(requestParameters?: NotificationsApiGetFunnelStateNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}>>;
+    /**
+     * Get a single notification by its ID.
+     * @summary Get Notification
+     * @param {NotificationsApiGetNotificationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    getNotification(requestParameters: NotificationsApiGetNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any, {}>>;
+    /**
+     * Get notification preferences for the organization.
+     * @summary Get Preferences
+     * @param {NotificationsApiGetPreferencesNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    getPreferencesNotifications(requestParameters?: NotificationsApiGetPreferencesNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}>>;
+    /**
+     * Get reminder/nudge email preferences for the organization.  These preferences control funnel-based onboarding nudges, re-engagement emails, and feature tips.
+     * @summary Get Reminder Preferences
+     * @param {NotificationsApiGetReminderPreferencesNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    getReminderPreferencesNotifications(requestParameters?: NotificationsApiGetReminderPreferencesNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReminderPreferencesResponse, any, {}>>;
+    /**
+     * Get count of unread notifications.
+     * @summary Get Unread Count
+     * @param {NotificationsApiGetUnreadCountNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    getUnreadCountNotifications(requestParameters?: NotificationsApiGetUnreadCountNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}>>;
+    /**
+     * List all notifications for the user\'s organization.
+     * @summary List Notifications
+     * @param {NotificationsApiListNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    listNotifications(requestParameters?: NotificationsApiListNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ListNotificationsResponse, any, {}>>;
+    /**
+     * Mark all notifications as read for a user.
+     * @summary Mark All As Read
+     * @param {NotificationsApiMarkAllAsReadNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    markAllAsReadNotifications(requestParameters?: NotificationsApiMarkAllAsReadNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    /**
+     * Mark a notification as read.
+     * @summary Mark As Read
+     * @param {NotificationsApiMarkAsReadNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    markAsReadNotifications(requestParameters: NotificationsApiMarkAsReadNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Notification, any, {}>>;
+    /**
+     * Update notification preferences for the organization.
+     * @summary Update Preferences
+     * @param {NotificationsApiUpdatePreferencesNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    updatePreferencesNotifications(requestParameters: NotificationsApiUpdatePreferencesNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
+        [key: string]: any;
+    }, any, {}>>;
+    /**
+     * Update reminder/nudge email preferences for the organization.  You can update individual preferences without affecting others: - enabled: Master toggle for all reminder emails - onboarding_nudges: Funnel progression nudges - engagement_reminders: Re-engagement emails for inactivity - feature_tips: Helpful tips and inspiration - quiet_hours_start/end: Hours (0-23 UTC) when no emails are sent
+     * @summary Update Reminder Preferences
+     * @param {NotificationsApiUpdateReminderPreferencesNotificationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof NotificationsApi
+     */
+    updateReminderPreferencesNotifications(requestParameters: NotificationsApiUpdateReminderPreferencesNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReminderPreferencesResponse, any, {}>>;
+}
+//# sourceMappingURL=notifications-api.d.ts.map