@datatr-ux/ovhcloud-types/dist/sms/Batch.d.ts

TypeScript types for OVHCloud projects

import { BatchError } from './BatchError';
import { PhoneNumber } from '../PhoneNumber';
import { BatchStatusEnum } from './BatchStatusEnum';
/** Batch of SMS to send */
export interface Batch {
    /** SMS account ID */
    accountID: number;
    /** Creation datetime */
    createdAt: string;
    /** Details on error(s) on the batch, if any */
    errors: BatchError[];
    /** The estimated cost of the batch in credits */
    estimatedCredits: number;
    /** Datetime when the batch finished processing SMSs */
    finishedAt?: string;
    /** SMS sender */
    from?: string;
    /** Batch ID */
    id: string;
    /** SMS message */
    message: string;
    /** Batch name */
    name: string;
    /** Number of processed records in this batch */
    processedRecords: number;
    /** SMS receivers list */
    receivers?: PhoneNumber[];
    /** Datetime when the SMSs of the batch are sent (based on deferred time if exists) */
    sentAt?: string;
    /** Slot ID */
    slotID?: string;
    /** Datetime when the batch started processing SMSs */
    startedAt?: string;
    /** Batch status */
    status: BatchStatusEnum;
    /** Total number of records in this batch */
    totalRecords: number;
    /** Last update datetime */
    updatedAt: string;
}
//# sourceMappingURL=Batch.d.ts.map