/** * 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 { BouncedEmailDto, BouncedRecipientDto, PageBouncedEmail, PageBouncedRecipients } from '../models'; export interface GetBouncedEmailRequest { id: string; } export interface GetBouncedEmailsRequest { page?: number; size?: number; sort?: GetBouncedEmailsSortEnum; since?: Date; before?: Date; } export interface GetBouncedRecipientRequest { id: string; } export interface GetBouncedRecipientsRequest { page?: number; size?: number; sort?: GetBouncedRecipientsSortEnum; since?: Date; before?: Date; } /** * BounceControllerApi - interface * * @export * @interface BounceControllerApiInterface */ export interface BounceControllerApiInterface { /** * Bounced emails are email you have sent that were rejected by a recipient * @summary Get a bounced email. * @param {string} id ID of the bounced email to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BounceControllerApiInterface */ getBouncedEmailRaw(requestParameters: GetBouncedEmailRequest): Promise>; /** * Bounced emails are email you have sent that were rejected by a recipient * Get a bounced email. */ getBouncedEmail(requestParameters: GetBouncedEmailRequest): Promise; /** * Bounced emails are email you have sent that were rejected by a recipient * @summary Get paginated list of bounced emails. * @param {number} [page] Optional page index * @param {number} [size] Optional page size * @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 BounceControllerApiInterface */ getBouncedEmailsRaw(requestParameters: GetBouncedEmailsRequest): Promise>; /** * Bounced emails are email you have sent that were rejected by a recipient * Get paginated list of bounced emails. */ getBouncedEmails(requestParameters: GetBouncedEmailsRequest): Promise; /** * Bounced emails are email you have sent that were rejected by a recipient * @summary Get a bounced email. * @param {string} id ID of the bounced recipient * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BounceControllerApiInterface */ getBouncedRecipientRaw(requestParameters: GetBouncedRecipientRequest): Promise>; /** * Bounced emails are email you have sent that were rejected by a recipient * Get a bounced email. */ getBouncedRecipient(requestParameters: GetBouncedRecipientRequest): Promise; /** * Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address. * @summary Get paginated list of bounced recipients. * @param {number} [page] Optional page index * @param {number} [size] Optional page size * @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 BounceControllerApiInterface */ getBouncedRecipientsRaw(requestParameters: GetBouncedRecipientsRequest): Promise>; /** * Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address. * Get paginated list of bounced recipients. */ getBouncedRecipients(requestParameters: GetBouncedRecipientsRequest): Promise; } /** * */ export declare class BounceControllerApi extends runtime.BaseAPI implements BounceControllerApiInterface { /** * Bounced emails are email you have sent that were rejected by a recipient * Get a bounced email. */ getBouncedEmailRaw(requestParameters: GetBouncedEmailRequest): Promise>; /** * Bounced emails are email you have sent that were rejected by a recipient * Get a bounced email. */ getBouncedEmail(requestParameters: GetBouncedEmailRequest): Promise; /** * Bounced emails are email you have sent that were rejected by a recipient * Get paginated list of bounced emails. */ getBouncedEmailsRaw(requestParameters: GetBouncedEmailsRequest): Promise>; /** * Bounced emails are email you have sent that were rejected by a recipient * Get paginated list of bounced emails. */ getBouncedEmails(requestParameters: GetBouncedEmailsRequest): Promise; /** * Bounced emails are email you have sent that were rejected by a recipient * Get a bounced email. */ getBouncedRecipientRaw(requestParameters: GetBouncedRecipientRequest): Promise>; /** * Bounced emails are email you have sent that were rejected by a recipient * Get a bounced email. */ getBouncedRecipient(requestParameters: GetBouncedRecipientRequest): Promise; /** * Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address. * Get paginated list of bounced recipients. */ getBouncedRecipientsRaw(requestParameters: GetBouncedRecipientsRequest): Promise>; /** * Bounced recipients are email addresses that you have sent emails to that did not accept the sent email. Once a recipient is bounced you cannot send emails to that address. * Get paginated list of bounced recipients. */ getBouncedRecipients(requestParameters: GetBouncedRecipientsRequest): Promise; } /** * @export * @enum {string} */ export declare enum GetBouncedEmailsSortEnum { ASC = "ASC", DESC = "DESC" } /** * @export * @enum {string} */ export declare enum GetBouncedRecipientsSortEnum { ASC = "ASC", DESC = "DESC" }