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

Ratchet miscellaneous tooling that requires smallish dependant libraries

import * as runtime from '../runtime.js';
import type { CreatedProcessId, CreateModel, CreateSmsCampaign, GetSmsCampaign, GetSmsCampaigns, RequestSmsRecipientExport, SendReport, SendTestSms, UpdateCampaignStatus, UpdateSmsCampaign } from '../models/index.js';
export interface CreateSmsCampaignRequest {
    createSmsCampaign: CreateSmsCampaign;
}
export interface DeleteSmsCampaignRequest {
    campaignId: number;
}
export interface GetSmsCampaignRequest {
    campaignId: number;
}
export interface GetSmsCampaignsRequest {
    status?: GetSmsCampaignsStatusEnum;
    startDate?: Date;
    endDate?: Date;
    limit?: number;
    offset?: number;
}
export interface RequestSmsRecipientExportRequest {
    campaignId: number;
    recipientExport?: RequestSmsRecipientExport;
}
export interface SendSmsCampaignNowRequest {
    campaignId: number;
}
export interface SendSmsReportRequest {
    campaignId: number;
    sendReport: SendReport;
}
export interface SendTestSmsRequest {
    campaignId: number;
    phoneNumber: SendTestSms;
}
export interface UpdateSmsCampaignRequest {
    campaignId: number;
    updateSmsCampaign: UpdateSmsCampaign;
}
export interface UpdateSmsCampaignStatusRequest {
    campaignId: number;
    status: UpdateCampaignStatus;
}
export interface SMSCampaignsApiInterface {
    createSmsCampaignRaw(requestParameters: CreateSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
    createSmsCampaign(requestParameters: CreateSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
    deleteSmsCampaignRaw(requestParameters: DeleteSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteSmsCampaign(requestParameters: DeleteSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    getSmsCampaignRaw(requestParameters: GetSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmsCampaign>>;
    getSmsCampaign(requestParameters: GetSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmsCampaign>;
    getSmsCampaignsRaw(requestParameters: GetSmsCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmsCampaigns>>;
    getSmsCampaigns(requestParameters: GetSmsCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmsCampaigns>;
    requestSmsRecipientExportRaw(requestParameters: RequestSmsRecipientExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedProcessId>>;
    requestSmsRecipientExport(requestParameters: RequestSmsRecipientExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedProcessId>;
    sendSmsCampaignNowRaw(requestParameters: SendSmsCampaignNowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendSmsCampaignNow(requestParameters: SendSmsCampaignNowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendSmsReportRaw(requestParameters: SendSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendSmsReport(requestParameters: SendSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendTestSmsRaw(requestParameters: SendTestSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendTestSms(requestParameters: SendTestSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateSmsCampaignRaw(requestParameters: UpdateSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateSmsCampaign(requestParameters: UpdateSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateSmsCampaignStatusRaw(requestParameters: UpdateSmsCampaignStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateSmsCampaignStatus(requestParameters: UpdateSmsCampaignStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}
export declare class SMSCampaignsApi extends runtime.BaseAPI implements SMSCampaignsApiInterface {
    createSmsCampaignRaw(requestParameters: CreateSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateModel>>;
    createSmsCampaign(requestParameters: CreateSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateModel>;
    deleteSmsCampaignRaw(requestParameters: DeleteSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    deleteSmsCampaign(requestParameters: DeleteSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    getSmsCampaignRaw(requestParameters: GetSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmsCampaign>>;
    getSmsCampaign(requestParameters: GetSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmsCampaign>;
    getSmsCampaignsRaw(requestParameters: GetSmsCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmsCampaigns>>;
    getSmsCampaigns(requestParameters?: GetSmsCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmsCampaigns>;
    requestSmsRecipientExportRaw(requestParameters: RequestSmsRecipientExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedProcessId>>;
    requestSmsRecipientExport(requestParameters: RequestSmsRecipientExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedProcessId>;
    sendSmsCampaignNowRaw(requestParameters: SendSmsCampaignNowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendSmsCampaignNow(requestParameters: SendSmsCampaignNowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendSmsReportRaw(requestParameters: SendSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendSmsReport(requestParameters: SendSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    sendTestSmsRaw(requestParameters: SendTestSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    sendTestSms(requestParameters: SendTestSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateSmsCampaignRaw(requestParameters: UpdateSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateSmsCampaign(requestParameters: UpdateSmsCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    updateSmsCampaignStatusRaw(requestParameters: UpdateSmsCampaignStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    updateSmsCampaignStatus(requestParameters: UpdateSmsCampaignStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}
export declare enum GetSmsCampaignsStatusEnum {
    Suspended = "suspended",
    Archive = "archive",
    Sent = "sent",
    Queued = "queued",
    Draft = "draft",
    InProcess = "inProcess"
}