@stacksjs/sms
Version:
The Stacks SMS integration. Painlessly create & manage your inboxes, templates, and send sms.
18 lines (17 loc) • 1.23 kB
TypeScript
import type { SmsDriver, SmsMessage, SmsSendResult, SmsStatusUpdate, SmsVerificationDriver, VerificationCheckRequest, VerificationRequest, VerificationResult, VonageConfig } from '@stacksjs/types';
// =============================================================================
// Factory Function
// =============================================================================
export declare function createVonageDriver(config: VonageConfig, useMessagesApi?: boolean): VonageDriver;
export declare class VonageDriver implements SmsDriver, SmsVerificationDriver {
constructor(config: VonageConfig, useMessagesApi?: boolean);
send(message: SmsMessage): Promise<SmsSendResult>;
sendBulk(messages: SmsMessage[]): Promise<SmsSendResult[]>;
getStatus(messageId: string): Promise<SmsStatusUpdate>;
verify(phoneNumber: string): Promise<{ valid: boolean, carrier?: string, type?: string }>;
getBalance(): Promise<{ balance: number, currency: string }>;
startVerification(request: VerificationRequest): Promise<VerificationResult>;
checkVerification(request: VerificationCheckRequest): Promise<VerificationResult>;
cancelVerification(verificationId: string): Promise<boolean>;
}
export { VonageDriver as default };