/** * MailSlurp API * MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It\'s designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository * * The version of the OpenAPI document: 6.5.2 * Contact: contact@mailslurp.dev * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { ExpirationDefaults, ExpiredInboxDto, PageExpiredInboxRecordProjection } from '../models'; export interface GetExpiredInboxByInboxIdRequest { inboxId: string; } export interface GetExpiredInboxRecordRequest { expiredId: string; } export interface GetExpiredInboxesRequest { page?: number; size?: number; sort?: GetExpiredInboxesSortEnum; since?: Date; before?: Date; } /** * ExpiredControllerApi - interface * * @export * @interface ExpiredControllerApiInterface */ export interface ExpiredControllerApiInterface { /** * Return default times used for inbox expiration * @summary Get default expiration settings * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExpiredControllerApiInterface */ getExpirationDefaultsRaw(): Promise>; /** * Return default times used for inbox expiration * Get default expiration settings */ getExpirationDefaults(): Promise; /** * Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId * @summary Get expired inbox record for a previously existing inbox * @param {string} inboxId ID of inbox you want to retrieve (not the inbox ID) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExpiredControllerApiInterface */ getExpiredInboxByInboxIdRaw(requestParameters: GetExpiredInboxByInboxIdRequest): Promise>; /** * Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId * Get expired inbox record for a previously existing inbox */ getExpiredInboxByInboxId(requestParameters: GetExpiredInboxByInboxIdRequest): Promise; /** * Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties * @summary Get an expired inbox record * @param {string} expiredId ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExpiredControllerApiInterface */ getExpiredInboxRecordRaw(requestParameters: GetExpiredInboxRecordRequest): Promise>; /** * Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties * Get an expired inbox record */ getExpiredInboxRecord(requestParameters: GetExpiredInboxRecordRequest): Promise; /** * Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties * @summary List records of expired inboxes * @param {number} [page] Optional page index in inbox sent email list pagination * @param {number} [size] Optional page size in inbox sent email list pagination * @param {'ASC' | 'DESC'} [sort] Optional createdAt sort direction ASC or DESC * @param {Date} [since] Filter by created at after the given timestamp * @param {Date} [before] Filter by created at before the given timestamp * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ExpiredControllerApiInterface */ getExpiredInboxesRaw(requestParameters: GetExpiredInboxesRequest): Promise>; /** * Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties * List records of expired inboxes */ getExpiredInboxes(requestParameters: GetExpiredInboxesRequest): Promise; } /** * */ export declare class ExpiredControllerApi extends runtime.BaseAPI implements ExpiredControllerApiInterface { /** * Return default times used for inbox expiration * Get default expiration settings */ getExpirationDefaultsRaw(): Promise>; /** * Return default times used for inbox expiration * Get default expiration settings */ getExpirationDefaults(): Promise; /** * Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId * Get expired inbox record for a previously existing inbox */ getExpiredInboxByInboxIdRaw(requestParameters: GetExpiredInboxByInboxIdRequest): Promise>; /** * Use the inboxId to return an ExpiredInboxRecord if an inbox has expired. Inboxes expire and are disabled if an expiration date is set or plan requires. Returns 404 if no expired inbox is found for the inboxId * Get expired inbox record for a previously existing inbox */ getExpiredInboxByInboxId(requestParameters: GetExpiredInboxByInboxIdRequest): Promise; /** * Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties * Get an expired inbox record */ getExpiredInboxRecordRaw(requestParameters: GetExpiredInboxRecordRequest): Promise>; /** * Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties * Get an expired inbox record */ getExpiredInboxRecord(requestParameters: GetExpiredInboxRecordRequest): Promise; /** * Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties * List records of expired inboxes */ getExpiredInboxesRaw(requestParameters: GetExpiredInboxesRequest): Promise>; /** * Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties * List records of expired inboxes */ getExpiredInboxes(requestParameters: GetExpiredInboxesRequest): Promise; } /** * @export * @enum {string} */ export declare enum GetExpiredInboxesSortEnum { ASC = "ASC", DESC = "DESC" }