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

Ratchet miscellaneous tooling that requires smallish dependant libraries

import * as runtime from '../runtime.js';
import type { AbTestCampaignResult, CreatedProcessId, CreateEmailCampaign, CreateModel, EmailExportRecipients, GetEmailCampaign, GetEmailCampaigns, GetSharedTemplateUrl, SendReport, SendTestEmail, UpdateCampaignStatus, UpdateEmailCampaign, UploadImageToGallery } from '../models/index.js';
export interface CreateEmailCampaignRequest {
    emailCampaigns: CreateEmailCampaign;
}
export interface DeleteEmailCampaignRequest {
    campaignId: number;
}
export interface EmailExportRecipientsRequest {
    campaignId: number;
    recipientExport?: EmailExportRecipients;
}
export interface GetAbTestCampaignResultRequest {
    campaignId: number;
}
export interface GetEmailCampaignRequest {
    campaignId: number;
    statistics?: GetEmailCampaignStatisticsEnum;
}
export interface GetEmailCampaignsRequest {
    type?: GetEmailCampaignsTypeEnum;
    status?: GetEmailCampaignsStatusEnum;
    statistics?: GetEmailCampaignsStatisticsEnum;
    startDate?: Date;
    endDate?: Date;
    limit?: number;
    offset?: number;
    excludeHtmlContent?: boolean;
}
export interface GetSharedTemplateUrlRequest {
    campaignId: number;
}
export interface SendEmailCampaignNowRequest {
    campaignId: number;
}
export interface SendReportRequest {
    campaignId: number;
    sendReport: SendReport;
}
export interface SendTestEmailRequest {
    campaignId: number;
    emailTo: SendTestEmail;
}
export interface UpdateCampaignStatusRequest {
    campaignId: number;
    status: UpdateCampaignStatus;
}
export interface UpdateEmailCampaignRequest {
    campaignId: number;
    emailCampaign: UpdateEmailCampaign;
}
export interface UploadImageToGalleryRequest {
    uploadImage: UploadImageToGallery;
}
export interface EmailCampaignsApiInterface {
    createEmailCampaignRaw(requestParameters: CreateEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
    createEmailCampaign(requestParameters: CreateEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
    deleteEmailCampaignRaw(requestParameters: DeleteEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteEmailCampaign(requestParameters: DeleteEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    emailExportRecipientsRaw(requestParameters: EmailExportRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedProcessId>>;
    emailExportRecipients(requestParameters: EmailExportRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedProcessId>;
    getAbTestCampaignResultRaw(requestParameters: GetAbTestCampaignResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AbTestCampaignResult>>;
    getAbTestCampaignResult(requestParameters: GetAbTestCampaignResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AbTestCampaignResult>;
    getEmailCampaignRaw(requestParameters: GetEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailCampaign>>;
    getEmailCampaign(requestParameters: GetEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailCampaign>;
    getEmailCampaignsRaw(requestParameters: GetEmailCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailCampaigns>>;
    getEmailCampaigns(requestParameters: GetEmailCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailCampaigns>;
    getSharedTemplateUrlRaw(requestParameters: GetSharedTemplateUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSharedTemplateUrl>>;
    getSharedTemplateUrl(requestParameters: GetSharedTemplateUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSharedTemplateUrl>;
    sendEmailCampaignNowRaw(requestParameters: SendEmailCampaignNowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendEmailCampaignNow(requestParameters: SendEmailCampaignNowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendReportRaw(requestParameters: SendReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendReport(requestParameters: SendReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendTestEmailRaw(requestParameters: SendTestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendTestEmail(requestParameters: SendTestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateCampaignStatusRaw(requestParameters: UpdateCampaignStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateCampaignStatus(requestParameters: UpdateCampaignStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateEmailCampaignRaw(requestParameters: UpdateEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateEmailCampaign(requestParameters: UpdateEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    uploadImageToGalleryRaw(requestParameters: UploadImageToGalleryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    uploadImageToGallery(requestParameters: UploadImageToGalleryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}
export declare class EmailCampaignsApi extends runtime.BaseAPI implements EmailCampaignsApiInterface {
    createEmailCampaignRaw(requestParameters: CreateEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
    createEmailCampaign(requestParameters: CreateEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
    deleteEmailCampaignRaw(requestParameters: DeleteEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteEmailCampaign(requestParameters: DeleteEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    emailExportRecipientsRaw(requestParameters: EmailExportRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedProcessId>>;
    emailExportRecipients(requestParameters: EmailExportRecipientsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedProcessId>;
    getAbTestCampaignResultRaw(requestParameters: GetAbTestCampaignResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AbTestCampaignResult>>;
    getAbTestCampaignResult(requestParameters: GetAbTestCampaignResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AbTestCampaignResult>;
    getEmailCampaignRaw(requestParameters: GetEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailCampaign>>;
    getEmailCampaign(requestParameters: GetEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailCampaign>;
    getEmailCampaignsRaw(requestParameters: GetEmailCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailCampaigns>>;
    getEmailCampaigns(requestParameters?: GetEmailCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailCampaigns>;
    getSharedTemplateUrlRaw(requestParameters: GetSharedTemplateUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSharedTemplateUrl>>;
    getSharedTemplateUrl(requestParameters: GetSharedTemplateUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSharedTemplateUrl>;
    sendEmailCampaignNowRaw(requestParameters: SendEmailCampaignNowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendEmailCampaignNow(requestParameters: SendEmailCampaignNowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendReportRaw(requestParameters: SendReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendReport(requestParameters: SendReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendTestEmailRaw(requestParameters: SendTestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendTestEmail(requestParameters: SendTestEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateCampaignStatusRaw(requestParameters: UpdateCampaignStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateCampaignStatus(requestParameters: UpdateCampaignStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateEmailCampaignRaw(requestParameters: UpdateEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateEmailCampaign(requestParameters: UpdateEmailCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    uploadImageToGalleryRaw(requestParameters: UploadImageToGalleryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    uploadImageToGallery(requestParameters: UploadImageToGalleryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}
export declare enum GetEmailCampaignStatisticsEnum {
    GlobalStats = "globalStats",
    LinksStats = "linksStats",
    StatsByDomain = "statsByDomain",
    StatsByDevice = "statsByDevice",
    StatsByBrowser = "statsByBrowser"
}
export declare enum GetEmailCampaignsTypeEnum {
    Classic = "classic",
    Trigger = "trigger"
}
export declare enum GetEmailCampaignsStatusEnum {
    Suspended = "suspended",
    Archive = "archive",
    Sent = "sent",
    Queued = "queued",
    Draft = "draft",
    InProcess = "inProcess"
}
export declare enum GetEmailCampaignsStatisticsEnum {
    GlobalStats = "globalStats",
    LinksStats = "linksStats",
    StatsByDomain = "statsByDomain"
}