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

Ratchet miscellaneous tooling that requires smallish dependant libraries

import * as runtime from '../runtime.js';
import type { GetSmsEventReport, GetTransacAggregatedSmsReport, GetTransacSmsReport, SendSms, SendTransacSms } from '../models/index.js';
export interface GetSmsEventsRequest {
    limit?: number;
    startDate?: string;
    endDate?: string;
    offset?: number;
    days?: number;
    phoneNumber?: string;
    event?: GetSmsEventsEventEnum;
    tags?: string;
    sort?: GetSmsEventsSortEnum;
}
export interface GetTransacAggregatedSmsReportRequest {
    startDate?: string;
    endDate?: string;
    days?: number;
    tag?: string;
}
export interface GetTransacSmsReportRequest {
    startDate?: string;
    endDate?: string;
    days?: number;
    tag?: string;
    sort?: GetTransacSmsReportSortEnum;
}
export interface SendTransacSmsRequest {
    sendTransacSms: SendTransacSms;
}
export interface TransactionalSMSApiInterface {
    getSmsEventsRaw(requestParameters: GetSmsEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmsEventReport>>;
    getSmsEvents(requestParameters: GetSmsEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmsEventReport>;
    getTransacAggregatedSmsReportRaw(requestParameters: GetTransacAggregatedSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacAggregatedSmsReport>>;
    getTransacAggregatedSmsReport(requestParameters: GetTransacAggregatedSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacAggregatedSmsReport>;
    getTransacSmsReportRaw(requestParameters: GetTransacSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacSmsReport>>;
    getTransacSmsReport(requestParameters: GetTransacSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacSmsReport>;
    sendTransacSmsRaw(requestParameters: SendTransacSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendSms>>;
    sendTransacSms(requestParameters: SendTransacSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendSms>;
}
export declare class TransactionalSMSApi extends runtime.BaseAPI implements TransactionalSMSApiInterface {
    getSmsEventsRaw(requestParameters: GetSmsEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSmsEventReport>>;
    getSmsEvents(requestParameters?: GetSmsEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSmsEventReport>;
    getTransacAggregatedSmsReportRaw(requestParameters: GetTransacAggregatedSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacAggregatedSmsReport>>;
    getTransacAggregatedSmsReport(requestParameters?: GetTransacAggregatedSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacAggregatedSmsReport>;
    getTransacSmsReportRaw(requestParameters: GetTransacSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetTransacSmsReport>>;
    getTransacSmsReport(requestParameters?: GetTransacSmsReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetTransacSmsReport>;
    sendTransacSmsRaw(requestParameters: SendTransacSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SendSms>>;
    sendTransacSms(requestParameters: SendTransacSmsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SendSms>;
}
export declare enum GetSmsEventsEventEnum {
    Bounces = "bounces",
    HardBounces = "hardBounces",
    SoftBounces = "softBounces",
    Delivered = "delivered",
    Sent = "sent",
    Accepted = "accepted",
    Unsubscription = "unsubscription",
    Replies = "replies",
    Blocked = "blocked",
    Rejected = "rejected"
}
export declare enum GetSmsEventsSortEnum {
    Asc = "asc",
    Desc = "desc"
}
export declare enum GetTransacSmsReportSortEnum {
    Asc = "asc",
    Desc = "desc"
}