otpiq/dist/types.d.ts

TypeScript client for the OTPiq SMS verification service

export interface OTPiqConfig {
    apiKey: string;
}
export type SMSProvider = "auto" | "sms" | "whatsapp" | "telegram";
export type SMSType = "verification" | "custom";
export type SMSStatus = "pending" | "delivered" | "failed";
export interface SendSMSOptions {
    phoneNumber: string;
    smsType: SMSType;
    verificationCode?: string | number;
    customMessage?: string;
    senderId?: string;
    provider?: SMSProvider;
    digitCount?: number;
}
export interface ProjectInfo {
    projectName: string;
    credit: number;
}
export interface SMSResponse {
    message: string;
    smsId: string;
    remainingCredit: number;
}
export interface SMSTrackingResponse {
    status: SMSStatus;
    phoneNumber: string;
    smsId: string;
    cost: number;
}
export interface SenderId {
    id: string;
    senderId: string;
    status: "accepted" | "pending";
    createdAt: string;
}
export interface SenderIdsResponse {
    senderIds: SenderId[];
}
export interface APIInsufficientCreditError {
    error: string;
    yourCredit: number;
    requiredCredit: number;
}
export interface APIRateLimitError {
    message: string;
    waitMinutes: number;
    maxRequests: number;
    timeWindowMinutes: number;
}