/** * Hostinger Mail API * * API Version: 1.1.0 * * NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY! * If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api */ import type { Configuration } from './configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * Standard error envelope. Frontend translations key off `code`, never off `error`. * @export * @interface ModelError */ export interface ModelError { /** * Human-readable error message. * @type {string} * @memberof ModelError */ 'error': string; /** * Machine-readable error code in SCREAMING_SNAKE_CASE. * @type {string} * @memberof ModelError */ 'code': string; /** * Additional structured context for the error. May be omitted. * @type {{ [key: string]: any; }} * @memberof ModelError */ 'params': { [key: string]: any; }; } /** * Pagination metadata for paginated collections. * @export * @interface Pagination */ export interface Pagination { /** * Current page number (1-based). * @type {number} * @memberof Pagination */ 'page': number; /** * Items per page. * @type {number} * @memberof Pagination */ 'perPage': number; /** * Total number of items across all pages. * @type {number} * @memberof Pagination */ 'total': number; /** * Total number of pages. * @type {number} * @memberof Pagination */ 'totalPages': number; } /** * Paginated list of messages. * @export * @interface V1FolderMessagesCollection */ export interface V1FolderMessagesCollection { /** * * @type {Array} * @memberof V1FolderMessagesCollection */ 'data': Array; /** * * @type {Pagination} * @memberof V1FolderMessagesCollection */ 'pagination': Pagination; } /** * Body for permanently deleting multiple messages. * @export * @interface V1FolderMessagesDeleteBulkRequest */ export interface V1FolderMessagesDeleteBulkRequest { /** * Message UIDs to delete. 1-100 entries, each > 0. * @type {Array} * @memberof V1FolderMessagesDeleteBulkRequest */ 'uids': Array; } /** * Add and/or remove flags on multiple messages. At least one of addFlags or removeFlags must be set. * @export * @interface V1FolderMessagesFlagsBulkRequest */ export interface V1FolderMessagesFlagsBulkRequest { /** * Message UIDs to update. 1-100 entries, each > 0. * @type {Array} * @memberof V1FolderMessagesFlagsBulkRequest */ 'uids': Array; /** * * @type {Array} * @memberof V1FolderMessagesFlagsBulkRequest */ 'addFlags': Array; /** * * @type {Array} * @memberof V1FolderMessagesFlagsBulkRequest */ 'removeFlags': Array; } /** * Add and/or remove flags on a message. At least one of addFlags or removeFlags must be set. * @export * @interface V1FolderMessagesFlagsRequest */ export interface V1FolderMessagesFlagsRequest { /** * * @type {Array} * @memberof V1FolderMessagesFlagsRequest */ 'addFlags': Array; /** * * @type {Array} * @memberof V1FolderMessagesFlagsRequest */ 'removeFlags': Array; } /** * A message in a folder of the managed mailbox. * @export * @interface V1FolderMessagesMessage */ export interface V1FolderMessagesMessage { /** * * @type {number} * @memberof V1FolderMessagesMessage */ 'uid': number; /** * * @type {string} * @memberof V1FolderMessagesMessage */ 'path': string; /** * * @type {string} * @memberof V1FolderMessagesMessage */ 'date': string; /** * * @type {Array} * @memberof V1FolderMessagesMessage */ 'flags': Array; /** * * @type {boolean} * @memberof V1FolderMessagesMessage */ 'unseen': boolean; /** * * @type {number} * @memberof V1FolderMessagesMessage */ 'size': number; /** * * @type {string} * @memberof V1FolderMessagesMessage */ 'subject': string | null; /** * * @type {V1FolderMessagesMessageAddress} * @memberof V1FolderMessagesMessage */ 'from': V1FolderMessagesMessageAddress | null; /** * * @type {Array} * @memberof V1FolderMessagesMessage */ 'to': Array; /** * * @type {Array} * @memberof V1FolderMessagesMessage */ 'cc': Array; /** * * @type {Array} * @memberof V1FolderMessagesMessage */ 'bcc': Array; /** * * @type {string} * @memberof V1FolderMessagesMessage */ 'messageId': string | null; /** * * @type {string} * @memberof V1FolderMessagesMessage */ 'inReplyTo': string | null; /** * * @type {Array} * @memberof V1FolderMessagesMessage */ 'attachments': Array; } /** * A single email address with optional display name. * @export * @interface V1FolderMessagesMessageAddress */ export interface V1FolderMessagesMessageAddress { /** * * @type {string} * @memberof V1FolderMessagesMessageAddress */ 'name': string; /** * * @type {string} * @memberof V1FolderMessagesMessageAddress */ 'address': string; } /** * Attachment metadata attached to a message. * @export * @interface V1FolderMessagesMessageAttachment */ export interface V1FolderMessagesMessageAttachment { /** * Opaque attachment identifier. Use as the {attachmentId} path parameter on the download endpoint. * @type {string} * @memberof V1FolderMessagesMessageAttachment */ 'id': string; /** * * @type {string} * @memberof V1FolderMessagesMessageAttachment */ 'contentType': string; /** * * @type {number} * @memberof V1FolderMessagesMessageAttachment */ 'sizeBytes': number; /** * * @type {boolean} * @memberof V1FolderMessagesMessageAttachment */ 'inline': boolean; /** * * @type {string} * @memberof V1FolderMessagesMessageAttachment */ 'filename': string | null; /** * * @type {string} * @memberof V1FolderMessagesMessageAttachment */ 'contentId': string | null; } /** * Rendered text and HTML parts of a message. * @export * @interface V1FolderMessagesMessageText */ export interface V1FolderMessagesMessageText { /** * * @type {string} * @memberof V1FolderMessagesMessageText */ 'text': string; /** * * @type {string} * @memberof V1FolderMessagesMessageText */ 'html': string; } /** * Single message text payload. * @export * @interface V1FolderMessagesMessageTextResource */ export interface V1FolderMessagesMessageTextResource { /** * * @type {V1FolderMessagesMessageText} * @memberof V1FolderMessagesMessageTextResource */ 'data': V1FolderMessagesMessageText; } /** * Body for moving multiple messages to a target folder. * @export * @interface V1FolderMessagesMoveBulkRequest */ export interface V1FolderMessagesMoveBulkRequest { /** * Message UIDs to move. 1-100 entries, each > 0. * @type {Array} * @memberof V1FolderMessagesMoveBulkRequest */ 'uids': Array; /** * Destination folder path. * @type {string} * @memberof V1FolderMessagesMoveBulkRequest */ 'targetFolder': string; } /** * Body for moving a single message to a target folder. * @export * @interface V1FolderMessagesMoveRequest */ export interface V1FolderMessagesMoveRequest { /** * Destination folder path. * @type {string} * @memberof V1FolderMessagesMoveRequest */ 'targetFolder': string; } /** * Single message payload. * @export * @interface V1FolderMessagesResource */ export interface V1FolderMessagesResource { /** * * @type {V1FolderMessagesMessage} * @memberof V1FolderMessagesResource */ 'data': V1FolderMessagesMessage; } /** * Search criteria. All fields optional; combine to narrow results. * @export * @interface V1FolderMessagesSearchRequest */ export interface V1FolderMessagesSearchRequest { /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'since': string; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'before': string; /** * * @type {Array} * @memberof V1FolderMessagesSearchRequest */ 'flags': Array; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'uid': string; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'subject': string; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'from': string; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'to': string; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'cc': string; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'body': string; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'header': string; /** * * @type {number} * @memberof V1FolderMessagesSearchRequest */ 'larger': number; /** * * @type {number} * @memberof V1FolderMessagesSearchRequest */ 'smaller': number; /** * * @type {string} * @memberof V1FolderMessagesSearchRequest */ 'text': string; } /** * Per-UID outcome of a bulk flag update. 200 when every UID succeeded, 207 when at least one failed. * @export * @interface V1FolderMessagesUpdateFlagsResult */ export interface V1FolderMessagesUpdateFlagsResult { /** * * @type {V1FolderMessagesUpdateFlagsResultData} * @memberof V1FolderMessagesUpdateFlagsResult */ 'data': V1FolderMessagesUpdateFlagsResultData; } /** * * @export * @interface V1FolderMessagesUpdateFlagsResultData */ export interface V1FolderMessagesUpdateFlagsResultData { /** * * @type {Array} * @memberof V1FolderMessagesUpdateFlagsResultData */ 'successful': Array; /** * * @type {Array} * @memberof V1FolderMessagesUpdateFlagsResultData */ 'failed': Array; } /** * * @export * @interface V1FolderMessagesUpdateFlagsResultDataFailedInner */ export interface V1FolderMessagesUpdateFlagsResultDataFailedInner { /** * * @type {number} * @memberof V1FolderMessagesUpdateFlagsResultDataFailedInner */ 'uid': number; /** * * @type {string} * @memberof V1FolderMessagesUpdateFlagsResultDataFailedInner */ 'reason': string; } /** * Paginated list of folders. * @export * @interface V1FoldersCollection */ export interface V1FoldersCollection { /** * * @type {Array} * @memberof V1FoldersCollection */ 'data': Array; /** * * @type {Pagination} * @memberof V1FoldersCollection */ 'pagination': Pagination; } /** * Body for creating a folder. * @export * @interface V1FoldersCreateRequest */ export interface V1FoldersCreateRequest { /** * Folder name. Length 1-100 after trimming. * @type {string} * @memberof V1FoldersCreateRequest */ 'name': string; } /** * A folder (IMAP mailbox) in the managed mailbox. * @export * @interface V1FoldersFolder */ export interface V1FoldersFolder { /** * Full hierarchical folder path including the delimiter. * @type {string} * @memberof V1FoldersFolder */ 'path': string; /** * Leaf name of the folder. * @type {string} * @memberof V1FoldersFolder */ 'name': string; /** * Hierarchy delimiter used by the IMAP server. * @type {string} * @memberof V1FoldersFolder */ 'delimiter': string; /** * IMAP SPECIAL-USE attribute (RFC 6154). `null` for regular folders. * @type {string} * @memberof V1FoldersFolder */ 'specialUse': string | null; /** * Total number of messages in the folder. * @type {number} * @memberof V1FoldersFolder */ 'messageCount': number; /** * Number of unread messages in the folder. * @type {number} * @memberof V1FoldersFolder */ 'unreadCount': number; } /** * Single folder payload. * @export * @interface V1FoldersResource */ export interface V1FoldersResource { /** * * @type {V1FoldersFolder} * @memberof V1FoldersResource */ 'data': V1FoldersFolder; } /** * Body for renaming a folder. * @export * @interface V1FoldersUpdateRequest */ export interface V1FoldersUpdateRequest { /** * New folder name. Length 1-100 after trimming. * @type {string} * @memberof V1FoldersUpdateRequest */ 'name': string; } /** * A mailbox the authenticated API token can manage. * @export * @interface V1MeMailbox */ export interface V1MeMailbox { /** * Unique identifier of the mailbox. * @type {string} * @memberof V1MeMailbox */ 'resourceId': string; /** * Email address of the mailbox. * @type {string} * @memberof V1MeMailbox */ 'address': string; } /** * Authenticated account payload. * @export * @interface V1MeResource */ export interface V1MeResource { /** * * @type {V1MeResourceData} * @memberof V1MeResource */ 'data': V1MeResourceData; } /** * * @export * @interface V1MeResourceData */ export interface V1MeResourceData { /** * Identifier of the order this API token is scoped to. * @type {string} * @memberof V1MeResourceData */ 'orderResourceId': string; /** * Mailboxes that the authenticated API token can manage. * @type {Array} * @memberof V1MeResourceData */ 'mailboxes': Array; } /** * Storage and message quota usage for the managed mailbox. * @export * @interface V1QuotaQuota */ export interface V1QuotaQuota { /** * Per-resource quota breakdown reported by the IMAP server. * @type {Array} * @memberof V1QuotaQuota */ 'quotas': Array; /** * Aggregate storage usage across all resources, in bytes. * @type {number} * @memberof V1QuotaQuota */ 'totalUsage': number; /** * Aggregate storage limit across all resources, in bytes. * @type {number} * @memberof V1QuotaQuota */ 'totalLimit': number; /** * Aggregate storage usage as a percentage of the total limit. * @type {number} * @memberof V1QuotaQuota */ 'totalPercentage': number; /** * Whether the IMAP server reports quota information for this mailbox. * @type {boolean} * @memberof V1QuotaQuota */ 'supported': boolean; } /** * Usage and limit for a single IMAP quota resource. * @export * @interface V1QuotaQuotaResource */ export interface V1QuotaQuotaResource { /** * Name of the quota resource as reported by the IMAP server. * @type {string} * @memberof V1QuotaQuotaResource */ 'resourceName': string; /** * Current usage of the resource (bytes for STORAGE, count for MESSAGE). * @type {number} * @memberof V1QuotaQuotaResource */ 'usage': number; /** * Maximum allowed value for the resource (bytes for STORAGE, count for MESSAGE). * @type {number} * @memberof V1QuotaQuotaResource */ 'limit': number; /** * Usage as a percentage of the limit. * @type {number} * @memberof V1QuotaQuotaResource */ 'percentage': number; } /** * Mailbox quota payload. * @export * @interface V1QuotaResource */ export interface V1QuotaResource { /** * * @type {V1QuotaQuota} * @memberof V1QuotaResource */ 'data': V1QuotaQuota; } /** * Attachment payload for outgoing mail. Supports regular attachments and inline images linked via Content-ID. * @export * @interface V1SendAttachment */ export interface V1SendAttachment { /** * * @type {string} * @memberof V1SendAttachment */ 'filename': string; /** * Attachment body. Base64-encoded by default; set encoding to switch. * @type {string} * @memberof V1SendAttachment */ 'content': string; /** * * @type {string} * @memberof V1SendAttachment */ 'contentType': string; /** * Content-ID for inline images. Reference from HTML as . * @type {string} * @memberof V1SendAttachment */ 'cid': string; /** * Encoding of content. Defaults to base64. * @type {string} * @memberof V1SendAttachment */ 'encoding': string; } /** * Reference to a source message by UID within a folder, used for reply/forward threading. Both fields are required. * @export * @interface V1SendMessageRef */ export interface V1SendMessageRef { /** * UID of the source message. * @type {number} * @memberof V1SendMessageRef */ 'uid': number; /** * Folder containing the source message. * @type {string} * @memberof V1SendMessageRef */ 'folder': string; } /** * Outgoing message payload. At least one of to, cc, or bcc must be present. * @export * @interface V1SendRequest */ export interface V1SendRequest { /** * * @type {Array} * @memberof V1SendRequest */ 'to': Array; /** * * @type {string} * @memberof V1SendRequest */ 'displayName': string; /** * * @type {Array} * @memberof V1SendRequest */ 'cc': Array; /** * * @type {Array} * @memberof V1SendRequest */ 'bcc': Array; /** * * @type {string} * @memberof V1SendRequest */ 'subject': string; /** * * @type {string} * @memberof V1SendRequest */ 'text': string; /** * * @type {string} * @memberof V1SendRequest */ 'html': string; /** * * @type {Array} * @memberof V1SendRequest */ 'attachments': Array; /** * Source message this is a reply to. Copies its Message-Id/References into In-Reply-To/References and flags it \\Answered. Mutually exclusive with forwardOf. * @type {V1SendMessageRef} * @memberof V1SendRequest */ 'inReplyTo': V1SendMessageRef; /** * Source message this forwards. Copies its Message-Id/References into In-Reply-To/References and flags it $forwarded. Mutually exclusive with inReplyTo. * @type {V1SendMessageRef} * @memberof V1SendRequest */ 'forwardOf': V1SendMessageRef; } /** * Paginated list of webhooks. * @export * @interface V1WebhooksCollection */ export interface V1WebhooksCollection { /** * * @type {Array} * @memberof V1WebhooksCollection */ 'data': Array; /** * * @type {Pagination} * @memberof V1WebhooksCollection */ 'pagination': Pagination; } /** * Body for creating a webhook. * @export * @interface V1WebhooksCreateRequest */ export interface V1WebhooksCreateRequest { /** * * @type {string} * @memberof V1WebhooksCreateRequest */ 'name': string; /** * * @type {string} * @memberof V1WebhooksCreateRequest */ 'description': string | null; /** * * @type {Array} * @memberof V1WebhooksCreateRequest */ 'events': Array; /** * * @type {string} * @memberof V1WebhooksCreateRequest */ 'status': V1WebhooksCreateRequestStatusEnum; /** * * @type {string} * @memberof V1WebhooksCreateRequest */ 'url': string; } export declare const V1WebhooksCreateRequestEventsEnum: { readonly MessageReceived: "message.received"; }; export type V1WebhooksCreateRequestEventsEnum = typeof V1WebhooksCreateRequestEventsEnum[keyof typeof V1WebhooksCreateRequestEventsEnum]; export declare const V1WebhooksCreateRequestStatusEnum: { readonly Active: "active"; readonly Paused: "paused"; readonly Disabled: "disabled"; }; export type V1WebhooksCreateRequestStatusEnum = typeof V1WebhooksCreateRequestStatusEnum[keyof typeof V1WebhooksCreateRequestStatusEnum]; /** * Single webhook payload. * @export * @interface V1WebhooksResource */ export interface V1WebhooksResource { /** * * @type {V1WebhooksWebhook} * @memberof V1WebhooksResource */ 'data': V1WebhooksWebhook; } /** * Single webhook payload including the one-time secret. * @export * @interface V1WebhooksResourceWithSecret */ export interface V1WebhooksResourceWithSecret { /** * * @type {V1WebhooksWebhookWithSecret} * @memberof V1WebhooksResourceWithSecret */ 'data': V1WebhooksWebhookWithSecret; } /** * Result of a webhook test delivery. * @export * @interface V1WebhooksTestResult */ export interface V1WebhooksTestResult { /** * * @type {V1WebhooksTestResultData} * @memberof V1WebhooksTestResult */ 'data': V1WebhooksTestResultData; } /** * * @export * @interface V1WebhooksTestResultData */ export interface V1WebhooksTestResultData { /** * * @type {number} * @memberof V1WebhooksTestResultData */ 'httpStatus': number; /** * * @type {boolean} * @memberof V1WebhooksTestResultData */ 'success': boolean; /** * * @type {string} * @memberof V1WebhooksTestResultData */ 'error': string | null; } /** * Body for partially updating a webhook. All fields optional; only present fields are applied. * @export * @interface V1WebhooksUpdateRequest */ export interface V1WebhooksUpdateRequest { /** * * @type {string} * @memberof V1WebhooksUpdateRequest */ 'name': string; /** * * @type {string} * @memberof V1WebhooksUpdateRequest */ 'description': string | null; /** * * @type {Array} * @memberof V1WebhooksUpdateRequest */ 'events': Array; /** * * @type {string} * @memberof V1WebhooksUpdateRequest */ 'status': V1WebhooksUpdateRequestStatusEnum; /** * * @type {string} * @memberof V1WebhooksUpdateRequest */ 'url': string; } export declare const V1WebhooksUpdateRequestEventsEnum: { readonly MessageReceived: "message.received"; }; export type V1WebhooksUpdateRequestEventsEnum = typeof V1WebhooksUpdateRequestEventsEnum[keyof typeof V1WebhooksUpdateRequestEventsEnum]; export declare const V1WebhooksUpdateRequestStatusEnum: { readonly Active: "active"; readonly Paused: "paused"; readonly Disabled: "disabled"; }; export type V1WebhooksUpdateRequestStatusEnum = typeof V1WebhooksUpdateRequestStatusEnum[keyof typeof V1WebhooksUpdateRequestStatusEnum]; /** * Webhook configured for a managed mailbox. * @export * @interface V1WebhooksWebhook */ export interface V1WebhooksWebhook { /** * Unique webhook identifier (UUID v7). * @type {string} * @memberof V1WebhooksWebhook */ 'id': string; /** * Resource ID of the mailbox this webhook is attached to. * @type {string} * @memberof V1WebhooksWebhook */ 'accountResourceId': string; /** * Email address of the mailbox. * @type {string} * @memberof V1WebhooksWebhook */ 'mailbox': string; /** * * @type {string} * @memberof V1WebhooksWebhook */ 'name': string; /** * * @type {string} * @memberof V1WebhooksWebhook */ 'description': string | null; /** * * @type {Array} * @memberof V1WebhooksWebhook */ 'events': Array; /** * * @type {string} * @memberof V1WebhooksWebhook */ 'status': V1WebhooksWebhookStatusEnum; /** * * @type {string} * @memberof V1WebhooksWebhook */ 'url': string; /** * * @type {string} * @memberof V1WebhooksWebhook */ 'createdAt': string; /** * * @type {string} * @memberof V1WebhooksWebhook */ 'updatedAt': string; } export declare const V1WebhooksWebhookEventsEnum: { readonly MessageReceived: "message.received"; }; export type V1WebhooksWebhookEventsEnum = typeof V1WebhooksWebhookEventsEnum[keyof typeof V1WebhooksWebhookEventsEnum]; export declare const V1WebhooksWebhookStatusEnum: { readonly Active: "active"; readonly Paused: "paused"; readonly Disabled: "disabled"; }; export type V1WebhooksWebhookStatusEnum = typeof V1WebhooksWebhookStatusEnum[keyof typeof V1WebhooksWebhookStatusEnum]; /** * Webhook payload that includes the one-time `secret`. Returned at creation and after secret regeneration. The secret is delivered as a bearer token on every webhook request (`Authorization: Bearer `); store it securely as it is not returned again. * @export * @interface V1WebhooksWebhookWithSecret */ export interface V1WebhooksWebhookWithSecret { /** * Unique webhook identifier (UUID v7). * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'id': string; /** * Resource ID of the mailbox this webhook is attached to. * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'accountResourceId': string; /** * Email address of the mailbox. * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'mailbox': string; /** * * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'name': string; /** * * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'description': string | null; /** * * @type {Array} * @memberof V1WebhooksWebhookWithSecret */ 'events': Array; /** * * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'status': V1WebhooksWebhookWithSecretStatusEnum; /** * * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'url': string; /** * * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'createdAt': string; /** * * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'updatedAt': string; /** * * @type {string} * @memberof V1WebhooksWebhookWithSecret */ 'secret': string; } export declare const V1WebhooksWebhookWithSecretEventsEnum: { readonly MessageReceived: "message.received"; }; export type V1WebhooksWebhookWithSecretEventsEnum = typeof V1WebhooksWebhookWithSecretEventsEnum[keyof typeof V1WebhooksWebhookWithSecretEventsEnum]; export declare const V1WebhooksWebhookWithSecretStatusEnum: { readonly Active: "active"; readonly Paused: "paused"; readonly Disabled: "disabled"; }; export type V1WebhooksWebhookWithSecretStatusEnum = typeof V1WebhooksWebhookWithSecretStatusEnum[keyof typeof V1WebhooksWebhookWithSecretStatusEnum]; /** * AccountApi - axios parameter creator * @export */ export declare const AccountApiAxiosParamCreator: (configuration?: Configuration) => { /** * Returns the authenticated account and the mailboxes it can manage. * @summary Get the authenticated account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCurrentAccount: (options?: RawAxiosRequestConfig) => Promise; }; /** * AccountApi - functional programming interface * @export */ export declare const AccountApiFp: (configuration?: Configuration) => { /** * Returns the authenticated account and the mailboxes it can manage. * @summary Get the authenticated account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCurrentAccount(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * AccountApi - factory interface * @export */ export declare const AccountApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Returns the authenticated account and the mailboxes it can manage. * @summary Get the authenticated account * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCurrentAccount(options?: RawAxiosRequestConfig): AxiosPromise; }; /** * AccountApi - object-oriented interface * @export * @class AccountApi * @extends {BaseAPI} */ export declare class AccountApi extends BaseAPI { /** * Returns the authenticated account and the mailboxes it can manage. * @summary Get the authenticated account * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AccountApi */ getCurrentAccount(options?: RawAxiosRequestConfig): Promise>; } /** * FoldersApi - axios parameter creator * @export */ export declare const FoldersApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a new folder in the managed mailbox. * @summary Create folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1FoldersCreateRequest} v1FoldersCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder: (mailboxResourceId: string, v1FoldersCreateRequest: V1FoldersCreateRequest, options?: RawAxiosRequestConfig) => Promise; /** * Delete a folder and all of its subfolders. * @summary Delete folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path to delete (URL-encoded). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFolder: (mailboxResourceId: string, folder: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a paginated list of folders in the managed mailbox. * @summary List folders * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {number} [page] Page number (1-based). * @param {number} [perPage] Items per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFolders: (mailboxResourceId: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise; /** * Rename an existing folder. * @summary Update folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Current folder path (URL-encoded). * @param {V1FoldersUpdateRequest} v1FoldersUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFolder: (mailboxResourceId: string, folder: string, v1FoldersUpdateRequest: V1FoldersUpdateRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * FoldersApi - functional programming interface * @export */ export declare const FoldersApiFp: (configuration?: Configuration) => { /** * Create a new folder in the managed mailbox. * @summary Create folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1FoldersCreateRequest} v1FoldersCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder(mailboxResourceId: string, v1FoldersCreateRequest: V1FoldersCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a folder and all of its subfolders. * @summary Delete folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path to delete (URL-encoded). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFolder(mailboxResourceId: string, folder: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a paginated list of folders in the managed mailbox. * @summary List folders * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {number} [page] Page number (1-based). * @param {number} [perPage] Items per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFolders(mailboxResourceId: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Rename an existing folder. * @summary Update folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Current folder path (URL-encoded). * @param {V1FoldersUpdateRequest} v1FoldersUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFolder(mailboxResourceId: string, folder: string, v1FoldersUpdateRequest: V1FoldersUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * FoldersApi - factory interface * @export */ export declare const FoldersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a new folder in the managed mailbox. * @summary Create folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1FoldersCreateRequest} v1FoldersCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createFolder(mailboxResourceId: string, v1FoldersCreateRequest: V1FoldersCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a folder and all of its subfolders. * @summary Delete folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path to delete (URL-encoded). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteFolder(mailboxResourceId: string, folder: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a paginated list of folders in the managed mailbox. * @summary List folders * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {number} [page] Page number (1-based). * @param {number} [perPage] Items per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} */ listFolders(mailboxResourceId: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Rename an existing folder. * @summary Update folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Current folder path (URL-encoded). * @param {V1FoldersUpdateRequest} v1FoldersUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateFolder(mailboxResourceId: string, folder: string, v1FoldersUpdateRequest: V1FoldersUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * FoldersApi - object-oriented interface * @export * @class FoldersApi * @extends {BaseAPI} */ export declare class FoldersApi extends BaseAPI { /** * Create a new folder in the managed mailbox. * @summary Create folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1FoldersCreateRequest} v1FoldersCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ createFolder(mailboxResourceId: string, v1FoldersCreateRequest: V1FoldersCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Delete a folder and all of its subfolders. * @summary Delete folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path to delete (URL-encoded). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ deleteFolder(mailboxResourceId: string, folder: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a paginated list of folders in the managed mailbox. * @summary List folders * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {number} [page] Page number (1-based). * @param {number} [perPage] Items per page (max 100). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ listFolders(mailboxResourceId: string, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise>; /** * Rename an existing folder. * @summary Update folder * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Current folder path (URL-encoded). * @param {V1FoldersUpdateRequest} v1FoldersUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FoldersApi */ updateFolder(mailboxResourceId: string, folder: string, v1FoldersUpdateRequest: V1FoldersUpdateRequest, options?: RawAxiosRequestConfig): Promise>; } /** * MessagesApi - axios parameter creator * @export */ export declare const MessagesApiAxiosParamCreator: (configuration?: Configuration) => { /** * Permanently delete every message in a folder (empty the folder). * @summary Delete all messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAllMessages: (mailboxResourceId: string, folder: string, options?: RawAxiosRequestConfig) => Promise; /** * Permanently delete a single message. * @summary Delete message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessage: (mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig) => Promise; /** * Permanently delete multiple messages from a folder. * @summary Delete messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {V1FolderMessagesDeleteBulkRequest} v1FolderMessagesDeleteBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessages: (mailboxResourceId: string, folder: string, v1FolderMessagesDeleteBulkRequest: V1FolderMessagesDeleteBulkRequest, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single message by UID. * @summary Get message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessage: (mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig) => Promise; /** * Download a message attachment as `application/octet-stream`. * @summary Download message attachment * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {string} attachmentId Attachment ID (opaque, returned by GET message). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageAttachment: (mailboxResourceId: string, folder: string, uid: number, attachmentId: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve raw RFC822 source of a message as `message/rfc822` attachment. * @summary Get message source * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageSource: (mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve rendered text (plain + HTML) of a message. Marks message as `\\Seen`. * @summary Get message text content * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageText: (mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig) => Promise; /** * List messages in a folder. Use POST /search for filtering. Sort fields: uid, date, size (prefix with `-` for descending). Default `-uid`. * @summary List messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} [page] Page number (1-based). * @param {number} [perPage] Items per page (max 100). * @param {string} [sort] Sort field with optional `-` prefix for descending. Allowed: uid, date, size. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMessages: (mailboxResourceId: string, folder: string, page?: number, perPage?: number, sort?: string, options?: RawAxiosRequestConfig) => Promise; /** * Move a single message to a target folder. * @summary Move message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Source folder path (URL-encoded). * @param {number} uid Message UID. * @param {V1FolderMessagesMoveRequest} v1FolderMessagesMoveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveMessage: (mailboxResourceId: string, folder: string, uid: number, v1FolderMessagesMoveRequest: V1FolderMessagesMoveRequest, options?: RawAxiosRequestConfig) => Promise; /** * Move multiple messages from a source folder to a target folder. * @summary Move messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Source folder path (URL-encoded). * @param {V1FolderMessagesMoveBulkRequest} v1FolderMessagesMoveBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveMessages: (mailboxResourceId: string, folder: string, v1FolderMessagesMoveBulkRequest: V1FolderMessagesMoveBulkRequest, options?: RawAxiosRequestConfig) => Promise; /** * Add and/or remove flags on a single message. Returns the updated message. * @summary Update message flags * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {V1FolderMessagesFlagsRequest} v1FolderMessagesFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMessage: (mailboxResourceId: string, folder: string, uid: number, v1FolderMessagesFlagsRequest: V1FolderMessagesFlagsRequest, options?: RawAxiosRequestConfig) => Promise; /** * Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`). * @summary Search messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} [page] * @param {number} [perPage] * @param {string} [sort] * @param {V1FolderMessagesSearchRequest} [v1FolderMessagesSearchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMessages: (mailboxResourceId: string, folder: string, page?: number, perPage?: number, sort?: string, v1FolderMessagesSearchRequest?: V1FolderMessagesSearchRequest, options?: RawAxiosRequestConfig) => Promise; /** * Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail. * @summary Update message flags * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {V1FolderMessagesFlagsBulkRequest} v1FolderMessagesFlagsBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMessageFlags: (mailboxResourceId: string, folder: string, v1FolderMessagesFlagsBulkRequest: V1FolderMessagesFlagsBulkRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * MessagesApi - functional programming interface * @export */ export declare const MessagesApiFp: (configuration?: Configuration) => { /** * Permanently delete every message in a folder (empty the folder). * @summary Delete all messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAllMessages(mailboxResourceId: string, folder: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Permanently delete a single message. * @summary Delete message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessage(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Permanently delete multiple messages from a folder. * @summary Delete messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {V1FolderMessagesDeleteBulkRequest} v1FolderMessagesDeleteBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessages(mailboxResourceId: string, folder: string, v1FolderMessagesDeleteBulkRequest: V1FolderMessagesDeleteBulkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single message by UID. * @summary Get message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessage(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Download a message attachment as `application/octet-stream`. * @summary Download message attachment * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {string} attachmentId Attachment ID (opaque, returned by GET message). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageAttachment(mailboxResourceId: string, folder: string, uid: number, attachmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve raw RFC822 source of a message as `message/rfc822` attachment. * @summary Get message source * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageSource(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve rendered text (plain + HTML) of a message. Marks message as `\\Seen`. * @summary Get message text content * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageText(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List messages in a folder. Use POST /search for filtering. Sort fields: uid, date, size (prefix with `-` for descending). Default `-uid`. * @summary List messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} [page] Page number (1-based). * @param {number} [perPage] Items per page (max 100). * @param {string} [sort] Sort field with optional `-` prefix for descending. Allowed: uid, date, size. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMessages(mailboxResourceId: string, folder: string, page?: number, perPage?: number, sort?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Move a single message to a target folder. * @summary Move message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Source folder path (URL-encoded). * @param {number} uid Message UID. * @param {V1FolderMessagesMoveRequest} v1FolderMessagesMoveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveMessage(mailboxResourceId: string, folder: string, uid: number, v1FolderMessagesMoveRequest: V1FolderMessagesMoveRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Move multiple messages from a source folder to a target folder. * @summary Move messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Source folder path (URL-encoded). * @param {V1FolderMessagesMoveBulkRequest} v1FolderMessagesMoveBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveMessages(mailboxResourceId: string, folder: string, v1FolderMessagesMoveBulkRequest: V1FolderMessagesMoveBulkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Add and/or remove flags on a single message. Returns the updated message. * @summary Update message flags * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {V1FolderMessagesFlagsRequest} v1FolderMessagesFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMessage(mailboxResourceId: string, folder: string, uid: number, v1FolderMessagesFlagsRequest: V1FolderMessagesFlagsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`). * @summary Search messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} [page] * @param {number} [perPage] * @param {string} [sort] * @param {V1FolderMessagesSearchRequest} [v1FolderMessagesSearchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMessages(mailboxResourceId: string, folder: string, page?: number, perPage?: number, sort?: string, v1FolderMessagesSearchRequest?: V1FolderMessagesSearchRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail. * @summary Update message flags * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {V1FolderMessagesFlagsBulkRequest} v1FolderMessagesFlagsBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMessageFlags(mailboxResourceId: string, folder: string, v1FolderMessagesFlagsBulkRequest: V1FolderMessagesFlagsBulkRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * MessagesApi - factory interface * @export */ export declare const MessagesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Permanently delete every message in a folder (empty the folder). * @summary Delete all messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteAllMessages(mailboxResourceId: string, folder: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Permanently delete a single message. * @summary Delete message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessage(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Permanently delete multiple messages from a folder. * @summary Delete messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {V1FolderMessagesDeleteBulkRequest} v1FolderMessagesDeleteBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteMessages(mailboxResourceId: string, folder: string, v1FolderMessagesDeleteBulkRequest: V1FolderMessagesDeleteBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single message by UID. * @summary Get message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessage(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Download a message attachment as `application/octet-stream`. * @summary Download message attachment * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {string} attachmentId Attachment ID (opaque, returned by GET message). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageAttachment(mailboxResourceId: string, folder: string, uid: number, attachmentId: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve raw RFC822 source of a message as `message/rfc822` attachment. * @summary Get message source * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageSource(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve rendered text (plain + HTML) of a message. Marks message as `\\Seen`. * @summary Get message text content * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getMessageText(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * List messages in a folder. Use POST /search for filtering. Sort fields: uid, date, size (prefix with `-` for descending). Default `-uid`. * @summary List messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} [page] Page number (1-based). * @param {number} [perPage] Items per page (max 100). * @param {string} [sort] Sort field with optional `-` prefix for descending. Allowed: uid, date, size. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listMessages(mailboxResourceId: string, folder: string, page?: number, perPage?: number, sort?: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Move a single message to a target folder. * @summary Move message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Source folder path (URL-encoded). * @param {number} uid Message UID. * @param {V1FolderMessagesMoveRequest} v1FolderMessagesMoveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveMessage(mailboxResourceId: string, folder: string, uid: number, v1FolderMessagesMoveRequest: V1FolderMessagesMoveRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Move multiple messages from a source folder to a target folder. * @summary Move messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Source folder path (URL-encoded). * @param {V1FolderMessagesMoveBulkRequest} v1FolderMessagesMoveBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ moveMessages(mailboxResourceId: string, folder: string, v1FolderMessagesMoveBulkRequest: V1FolderMessagesMoveBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Add and/or remove flags on a single message. Returns the updated message. * @summary Update message flags * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {V1FolderMessagesFlagsRequest} v1FolderMessagesFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ patchMessage(mailboxResourceId: string, folder: string, uid: number, v1FolderMessagesFlagsRequest: V1FolderMessagesFlagsRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`). * @summary Search messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} [page] * @param {number} [perPage] * @param {string} [sort] * @param {V1FolderMessagesSearchRequest} [v1FolderMessagesSearchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ searchMessages(mailboxResourceId: string, folder: string, page?: number, perPage?: number, sort?: string, v1FolderMessagesSearchRequest?: V1FolderMessagesSearchRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail. * @summary Update message flags * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {V1FolderMessagesFlagsBulkRequest} v1FolderMessagesFlagsBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateMessageFlags(mailboxResourceId: string, folder: string, v1FolderMessagesFlagsBulkRequest: V1FolderMessagesFlagsBulkRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * MessagesApi - object-oriented interface * @export * @class MessagesApi * @extends {BaseAPI} */ export declare class MessagesApi extends BaseAPI { /** * Permanently delete every message in a folder (empty the folder). * @summary Delete all messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ deleteAllMessages(mailboxResourceId: string, folder: string, options?: RawAxiosRequestConfig): Promise>; /** * Permanently delete a single message. * @summary Delete message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ deleteMessage(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): Promise>; /** * Permanently delete multiple messages from a folder. * @summary Delete messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {V1FolderMessagesDeleteBulkRequest} v1FolderMessagesDeleteBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ deleteMessages(mailboxResourceId: string, folder: string, v1FolderMessagesDeleteBulkRequest: V1FolderMessagesDeleteBulkRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single message by UID. * @summary Get message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ getMessage(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): Promise>; /** * Download a message attachment as `application/octet-stream`. * @summary Download message attachment * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {string} attachmentId Attachment ID (opaque, returned by GET message). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ getMessageAttachment(mailboxResourceId: string, folder: string, uid: number, attachmentId: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve raw RFC822 source of a message as `message/rfc822` attachment. * @summary Get message source * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ getMessageSource(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve rendered text (plain + HTML) of a message. Marks message as `\\Seen`. * @summary Get message text content * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ getMessageText(mailboxResourceId: string, folder: string, uid: number, options?: RawAxiosRequestConfig): Promise>; /** * List messages in a folder. Use POST /search for filtering. Sort fields: uid, date, size (prefix with `-` for descending). Default `-uid`. * @summary List messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} [page] Page number (1-based). * @param {number} [perPage] Items per page (max 100). * @param {string} [sort] Sort field with optional `-` prefix for descending. Allowed: uid, date, size. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ listMessages(mailboxResourceId: string, folder: string, page?: number, perPage?: number, sort?: string, options?: RawAxiosRequestConfig): Promise>; /** * Move a single message to a target folder. * @summary Move message * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Source folder path (URL-encoded). * @param {number} uid Message UID. * @param {V1FolderMessagesMoveRequest} v1FolderMessagesMoveRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ moveMessage(mailboxResourceId: string, folder: string, uid: number, v1FolderMessagesMoveRequest: V1FolderMessagesMoveRequest, options?: RawAxiosRequestConfig): Promise>; /** * Move multiple messages from a source folder to a target folder. * @summary Move messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Source folder path (URL-encoded). * @param {V1FolderMessagesMoveBulkRequest} v1FolderMessagesMoveBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ moveMessages(mailboxResourceId: string, folder: string, v1FolderMessagesMoveBulkRequest: V1FolderMessagesMoveBulkRequest, options?: RawAxiosRequestConfig): Promise>; /** * Add and/or remove flags on a single message. Returns the updated message. * @summary Update message flags * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} uid Message UID. * @param {V1FolderMessagesFlagsRequest} v1FolderMessagesFlagsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ patchMessage(mailboxResourceId: string, folder: string, uid: number, v1FolderMessagesFlagsRequest: V1FolderMessagesFlagsRequest, options?: RawAxiosRequestConfig): Promise>; /** * Search messages in a folder. Filters in body; pagination and sort via query (`page`, `perPage`, `sort`). * @summary Search messages * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {number} [page] * @param {number} [perPage] * @param {string} [sort] * @param {V1FolderMessagesSearchRequest} [v1FolderMessagesSearchRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ searchMessages(mailboxResourceId: string, folder: string, page?: number, perPage?: number, sort?: string, v1FolderMessagesSearchRequest?: V1FolderMessagesSearchRequest, options?: RawAxiosRequestConfig): Promise>; /** * Add and/or remove flags on multiple messages. Returns 200 when all UIDs succeed, 207 with per-UID outcome when some fail. * @summary Update message flags * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {string} folder Folder path (URL-encoded). * @param {V1FolderMessagesFlagsBulkRequest} v1FolderMessagesFlagsBulkRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MessagesApi */ updateMessageFlags(mailboxResourceId: string, folder: string, v1FolderMessagesFlagsBulkRequest: V1FolderMessagesFlagsBulkRequest, options?: RawAxiosRequestConfig): Promise>; } /** * QuotaApi - axios parameter creator * @export */ export declare const QuotaApiAxiosParamCreator: (configuration?: Configuration) => { /** * Retrieve storage and message quota usage for the managed mailbox. * @summary Get mailbox quota * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getQuota: (mailboxResourceId: string, options?: RawAxiosRequestConfig) => Promise; }; /** * QuotaApi - functional programming interface * @export */ export declare const QuotaApiFp: (configuration?: Configuration) => { /** * Retrieve storage and message quota usage for the managed mailbox. * @summary Get mailbox quota * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getQuota(mailboxResourceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * QuotaApi - factory interface * @export */ export declare const QuotaApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Retrieve storage and message quota usage for the managed mailbox. * @summary Get mailbox quota * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getQuota(mailboxResourceId: string, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * QuotaApi - object-oriented interface * @export * @class QuotaApi * @extends {BaseAPI} */ export declare class QuotaApi extends BaseAPI { /** * Retrieve storage and message quota usage for the managed mailbox. * @summary Get mailbox quota * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof QuotaApi */ getQuota(mailboxResourceId: string, options?: RawAxiosRequestConfig): Promise>; } /** * SendApi - axios parameter creator * @export */ export declare const SendApiAxiosParamCreator: (configuration?: Configuration) => { /** * Send a message from the managed mailbox. Saves a copy to INBOX.Sent. * @summary Send email * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1SendRequest | null} v1SendRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEmail: (mailboxResourceId: string, v1SendRequest: V1SendRequest | null, options?: RawAxiosRequestConfig) => Promise; }; /** * SendApi - functional programming interface * @export */ export declare const SendApiFp: (configuration?: Configuration) => { /** * Send a message from the managed mailbox. Saves a copy to INBOX.Sent. * @summary Send email * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1SendRequest | null} v1SendRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEmail(mailboxResourceId: string, v1SendRequest: V1SendRequest | null, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SendApi - factory interface * @export */ export declare const SendApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Send a message from the managed mailbox. Saves a copy to INBOX.Sent. * @summary Send email * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1SendRequest | null} v1SendRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEmail(mailboxResourceId: string, v1SendRequest: V1SendRequest | null, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * SendApi - object-oriented interface * @export * @class SendApi * @extends {BaseAPI} */ export declare class SendApi extends BaseAPI { /** * Send a message from the managed mailbox. Saves a copy to INBOX.Sent. * @summary Send email * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1SendRequest | null} v1SendRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SendApi */ sendEmail(mailboxResourceId: string, v1SendRequest: V1SendRequest | null, options?: RawAxiosRequestConfig): Promise>; } /** * WebhooksApi - axios parameter creator * @export */ export declare const WebhooksApiAxiosParamCreator: (configuration?: Configuration) => { /** * Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again. * @summary Create webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1WebhooksCreateRequest} v1WebhooksCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook: (mailboxResourceId: string, v1WebhooksCreateRequest: V1WebhooksCreateRequest, options?: RawAxiosRequestConfig) => Promise; /** * Delete a webhook. * @summary Delete webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook: (mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a single webhook by id. * @summary Get webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook: (mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig) => Promise; /** * List webhooks for a mailbox. * @summary List webhooks * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {ListWebhooksStatusEnum} [status] * @param {number} [page] * @param {number} [perPage] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhooks: (mailboxResourceId: string, status?: ListWebhooksStatusEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig) => Promise; /** * Regenerate the webhook secret. The previous secret is immediately invalidated. The new secret is returned once. * @summary Regenerate webhook secret * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ regenerateWebhookSecret: (mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig) => Promise; /** * Send a test delivery to the webhook URL and return the upstream response. * @summary Test webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ testWebhook: (mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig) => Promise; /** * Partially update a webhook. * @summary Update webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {V1WebhooksUpdateRequest} v1WebhooksUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhook: (mailboxResourceId: string, webhook: string, v1WebhooksUpdateRequest: V1WebhooksUpdateRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * WebhooksApi - functional programming interface * @export */ export declare const WebhooksApiFp: (configuration?: Configuration) => { /** * Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again. * @summary Create webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1WebhooksCreateRequest} v1WebhooksCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook(mailboxResourceId: string, v1WebhooksCreateRequest: V1WebhooksCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a webhook. * @summary Delete webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a single webhook by id. * @summary Get webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List webhooks for a mailbox. * @summary List webhooks * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {ListWebhooksStatusEnum} [status] * @param {number} [page] * @param {number} [perPage] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhooks(mailboxResourceId: string, status?: ListWebhooksStatusEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Regenerate the webhook secret. The previous secret is immediately invalidated. The new secret is returned once. * @summary Regenerate webhook secret * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ regenerateWebhookSecret(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Send a test delivery to the webhook URL and return the upstream response. * @summary Test webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ testWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Partially update a webhook. * @summary Update webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {V1WebhooksUpdateRequest} v1WebhooksUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhook(mailboxResourceId: string, webhook: string, v1WebhooksUpdateRequest: V1WebhooksUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * WebhooksApi - factory interface * @export */ export declare const WebhooksApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again. * @summary Create webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1WebhooksCreateRequest} v1WebhooksCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ createWebhook(mailboxResourceId: string, v1WebhooksCreateRequest: V1WebhooksCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Delete a webhook. * @summary Delete webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a single webhook by id. * @summary Get webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * List webhooks for a mailbox. * @summary List webhooks * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {ListWebhooksStatusEnum} [status] * @param {number} [page] * @param {number} [perPage] * @param {*} [options] Override http request option. * @throws {RequiredError} */ listWebhooks(mailboxResourceId: string, status?: ListWebhooksStatusEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): AxiosPromise; /** * Regenerate the webhook secret. The previous secret is immediately invalidated. The new secret is returned once. * @summary Regenerate webhook secret * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ regenerateWebhookSecret(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Send a test delivery to the webhook URL and return the upstream response. * @summary Test webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} */ testWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): AxiosPromise; /** * Partially update a webhook. * @summary Update webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {V1WebhooksUpdateRequest} v1WebhooksUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateWebhook(mailboxResourceId: string, webhook: string, v1WebhooksUpdateRequest: V1WebhooksUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * WebhooksApi - object-oriented interface * @export * @class WebhooksApi * @extends {BaseAPI} */ export declare class WebhooksApi extends BaseAPI { /** * Create a webhook. The response includes the one-time `secret` — store it securely as it is never returned again. * @summary Create webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {V1WebhooksCreateRequest} v1WebhooksCreateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ createWebhook(mailboxResourceId: string, v1WebhooksCreateRequest: V1WebhooksCreateRequest, options?: RawAxiosRequestConfig): Promise>; /** * Delete a webhook. * @summary Delete webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ deleteWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a single webhook by id. * @summary Get webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ getWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): Promise>; /** * List webhooks for a mailbox. * @summary List webhooks * @param {string} mailboxResourceId Resource ID of the managed mailbox the bearer token is authorized for. * @param {ListWebhooksStatusEnum} [status] * @param {number} [page] * @param {number} [perPage] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ listWebhooks(mailboxResourceId: string, status?: ListWebhooksStatusEnum, page?: number, perPage?: number, options?: RawAxiosRequestConfig): Promise>; /** * Regenerate the webhook secret. The previous secret is immediately invalidated. The new secret is returned once. * @summary Regenerate webhook secret * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ regenerateWebhookSecret(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): Promise>; /** * Send a test delivery to the webhook URL and return the upstream response. * @summary Test webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ testWebhook(mailboxResourceId: string, webhook: string, options?: RawAxiosRequestConfig): Promise>; /** * Partially update a webhook. * @summary Update webhook * @param {string} mailboxResourceId Resource ID of the managed mailbox. * @param {string} webhook Webhook identifier (UUID v7). * @param {V1WebhooksUpdateRequest} v1WebhooksUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhooksApi */ updateWebhook(mailboxResourceId: string, webhook: string, v1WebhooksUpdateRequest: V1WebhooksUpdateRequest, options?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const ListWebhooksStatusEnum: { readonly Active: "active"; readonly Paused: "paused"; readonly Disabled: "disabled"; }; export type ListWebhooksStatusEnum = typeof ListWebhooksStatusEnum[keyof typeof ListWebhooksStatusEnum];