@bitblit/ratchet-misc/lib/brevo/generated/apis/SMTPApi.d.ts

Ratchet miscellaneous tooling that requires smallish dependant libraries

import * as runtime from '../runtime.js';
import type { BlockDomain, CreateModel, CreateSmtpEmail, CreateSmtpTemplate, DeleteHardbounces, GetAggregatedReport, GetBlockedDomains, GetEmailEventReport, GetReports, GetSmtpTemplateOverview, GetSmtpTemplates, GetTransacBlockedContacts, GetTransacEmailContent, GetTransacEmailsList, SendEmail, SendSmtpEmail, SendTemplateEmail, SendTestEmail, UpdateSmtpTemplate } from '../models/index.js';
export interface BlockNewDomainRequest {
    blockDomain: BlockDomain;
}
export interface CreateSmtpTemplateRequest {
    smtpTemplate: CreateSmtpTemplate;
}
export interface DeleteBlockedDomainRequest {
    domain: string;
}
export interface DeleteHardbouncesRequest {
    deleteHardbounces?: DeleteHardbounces;
}
export interface DeleteSmtpTemplateRequest {
    templateId: number;
}
export interface GetAggregatedSmtpReportRequest {
    startDate?: string;
    endDate?: string;
    days?: number;
    tag?: string;
}
export interface GetEmailEventReportRequest {
    limit?: number;
    offset?: number;
    startDate?: string;
    endDate?: string;
    days?: number;
    email?: string;
    event?: GetEmailEventReportEventEnum;
    tags?: string;
    messageId?: string;
    templateId?: number;
}
export interface GetSmtpReportRequest {
    limit?: number;
    offset?: number;
    startDate?: string;
    endDate?: string;
    days?: number;
    tag?: string;
}
export interface GetSmtpTemplateRequest {
    templateId: number;
}
export interface GetSmtpTemplatesRequest {
    templateStatus?: boolean;
    limit?: number;
    offset?: number;
}
export interface GetTransacBlockedContactsRequest {
    startDate?: string;
    endDate?: string;
    limit?: number;
    offset?: number;
    senders?: Array<string>;
}
export interface GetTransacEmailContentRequest {
    uuid: string;
}
export interface GetTransacEmailsListRequest {
    email?: string;
    templateId?: number;
    messageId?: string;
    startDate?: Date;
    endDate?: Date;
}
export interface SendTemplateRequest {
    templateId: number;
    sendEmail: SendEmail;
}
export interface SendTestTemplateRequest {
    templateId: number;
    sendTestEmail: SendTestEmail;
}
export interface SendTransacEmailRequest {
    sendSmtpEmail: SendSmtpEmail;
}
export interface SmtpBlockedContactsEmailDeleteRequest {
    email: string;
}
export interface SmtpLogMessageIdDeleteRequest {
    messageId: string;
}
export interface UpdateSmtpTemplateRequest {
    templateId: number;
    smtpTemplate: UpdateSmtpTemplate;
}
export interface SMTPApiInterface {
    blockNewDomainRaw(requestParameters: BlockNewDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    blockNewDomain(requestParameters: BlockNewDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    createSmtpTemplateRaw(requestParameters: CreateSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
    createSmtpTemplate(requestParameters: CreateSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
    deleteBlockedDomainRaw(requestParameters: DeleteBlockedDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteBlockedDomain(requestParameters: DeleteBlockedDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    deleteHardbouncesRaw(requestParameters: DeleteHardbouncesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteHardbounces(requestParameters: DeleteHardbouncesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    deleteSmtpTemplateRaw(requestParameters: DeleteSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteSmtpTemplate(requestParameters: DeleteSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    getAggregatedSmtpReportRaw(requestParameters: GetAggregatedSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAggregatedReport>>;
    getAggregatedSmtpReport(requestParameters: GetAggregatedSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAggregatedReport>;
    getBlockedDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBlockedDomains>>;
    getBlockedDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBlockedDomains>;
    getEmailEventReportRaw(requestParameters: GetEmailEventReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailEventReport>>;
    getEmailEventReport(requestParameters: GetEmailEventReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailEventReport>;
    getSmtpReportRaw(requestParameters: GetSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReports>>;
    getSmtpReport(requestParameters: GetSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReports>;
    getSmtpTemplateRaw(requestParameters: GetSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmtpTemplateOverview>>;
    getSmtpTemplate(requestParameters: GetSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmtpTemplateOverview>;
    getSmtpTemplatesRaw(requestParameters: GetSmtpTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmtpTemplates>>;
    getSmtpTemplates(requestParameters: GetSmtpTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmtpTemplates>;
    getTransacBlockedContactsRaw(requestParameters: GetTransacBlockedContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacBlockedContacts>>;
    getTransacBlockedContacts(requestParameters: GetTransacBlockedContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacBlockedContacts>;
    getTransacEmailContentRaw(requestParameters: GetTransacEmailContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacEmailContent>>;
    getTransacEmailContent(requestParameters: GetTransacEmailContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacEmailContent>;
    getTransacEmailsListRaw(requestParameters: GetTransacEmailsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacEmailsList>>;
    getTransacEmailsList(requestParameters: GetTransacEmailsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacEmailsList>;
    sendTemplateRaw(requestParameters: SendTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendTemplateEmail>>;
    sendTemplate(requestParameters: SendTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendTemplateEmail>;
    sendTestTemplateRaw(requestParameters: SendTestTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendTestTemplate(requestParameters: SendTestTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendTransacEmailRaw(requestParameters: SendTransacEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSmtpEmail>>;
    sendTransacEmail(requestParameters: SendTransacEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSmtpEmail>;
    smtpBlockedContactsEmailDeleteRaw(requestParameters: SmtpBlockedContactsEmailDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    smtpBlockedContactsEmailDelete(requestParameters: SmtpBlockedContactsEmailDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    smtpLogMessageIdDeleteRaw(requestParameters: SmtpLogMessageIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    smtpLogMessageIdDelete(requestParameters: SmtpLogMessageIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateSmtpTemplateRaw(requestParameters: UpdateSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateSmtpTemplate(requestParameters: UpdateSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}
export declare class SMTPApi extends runtime.BaseAPI implements SMTPApiInterface {
    blockNewDomainRaw(requestParameters: BlockNewDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    blockNewDomain(requestParameters: BlockNewDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    createSmtpTemplateRaw(requestParameters: CreateSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
    createSmtpTemplate(requestParameters: CreateSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
    deleteBlockedDomainRaw(requestParameters: DeleteBlockedDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteBlockedDomain(requestParameters: DeleteBlockedDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    deleteHardbouncesRaw(requestParameters: DeleteHardbouncesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteHardbounces(requestParameters?: DeleteHardbouncesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    deleteSmtpTemplateRaw(requestParameters: DeleteSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteSmtpTemplate(requestParameters: DeleteSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    getAggregatedSmtpReportRaw(requestParameters: GetAggregatedSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAggregatedReport>>;
    getAggregatedSmtpReport(requestParameters?: GetAggregatedSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAggregatedReport>;
    getBlockedDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetBlockedDomains>>;
    getBlockedDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetBlockedDomains>;
    getEmailEventReportRaw(requestParameters: GetEmailEventReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailEventReport>>;
    getEmailEventReport(requestParameters?: GetEmailEventReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailEventReport>;
    getSmtpReportRaw(requestParameters: GetSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetReports>>;
    getSmtpReport(requestParameters?: GetSmtpReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetReports>;
    getSmtpTemplateRaw(requestParameters: GetSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmtpTemplateOverview>>;
    getSmtpTemplate(requestParameters: GetSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmtpTemplateOverview>;
    getSmtpTemplatesRaw(requestParameters: GetSmtpTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmtpTemplates>>;
    getSmtpTemplates(requestParameters?: GetSmtpTemplatesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmtpTemplates>;
    getTransacBlockedContactsRaw(requestParameters: GetTransacBlockedContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacBlockedContacts>>;
    getTransacBlockedContacts(requestParameters?: GetTransacBlockedContactsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacBlockedContacts>;
    getTransacEmailContentRaw(requestParameters: GetTransacEmailContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacEmailContent>>;
    getTransacEmailContent(requestParameters: GetTransacEmailContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacEmailContent>;
    getTransacEmailsListRaw(requestParameters: GetTransacEmailsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacEmailsList>>;
    getTransacEmailsList(requestParameters?: GetTransacEmailsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacEmailsList>;
    sendTemplateRaw(requestParameters: SendTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendTemplateEmail>>;
    sendTemplate(requestParameters: SendTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendTemplateEmail>;
    sendTestTemplateRaw(requestParameters: SendTestTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendTestTemplate(requestParameters: SendTestTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendTransacEmailRaw(requestParameters: SendTransacEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSmtpEmail>>;
    sendTransacEmail(requestParameters: SendTransacEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSmtpEmail>;
    smtpBlockedContactsEmailDeleteRaw(requestParameters: SmtpBlockedContactsEmailDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    smtpBlockedContactsEmailDelete(requestParameters: SmtpBlockedContactsEmailDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    smtpLogMessageIdDeleteRaw(requestParameters: SmtpLogMessageIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    smtpLogMessageIdDelete(requestParameters: SmtpLogMessageIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateSmtpTemplateRaw(requestParameters: UpdateSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateSmtpTemplate(requestParameters: UpdateSmtpTemplateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}
export declare enum GetEmailEventReportEventEnum {
    Bounces = "bounces",
    HardBounces = "hardBounces",
    SoftBounces = "softBounces",
    Delivered = "delivered",
    Spam = "spam",
    Requests = "requests",
    Opened = "opened",
    Clicks = "clicks",
    Invalid = "invalid",
    Deferred = "deferred",
    Blocked = "blocked",
    Unsubscribed = "unsubscribed"
}