apptise-core
Version:
Core library for Apptise unified notification system
44 lines • 1.52 kB
TypeScript
import { NotificationPlugin } from '../base/plugin.js';
import type { NotificationMessage, NotificationResult, PluginConfig, PluginRegistration } from '../base/types.js';
/**
* HttpSMS notification plugin
* Sends notifications via HttpSMS service
*/
export declare class HttpSmsPlugin extends NotificationPlugin {
readonly registration: PluginRegistration;
/**
* Parse HttpSMS URL
* Format: httpsms://apikey@from_phone/target_phones
* @param url - The HttpSMS URL to parse
* @returns Parsed plugin configuration
*/
parseUrl(url: string): PluginConfig;
/**
* Validate phone number format
* @param phone - Phone number to validate
* @returns Whether the phone number is valid
*/
private isValidPhoneNumber;
/**
* Normalize phone number by removing non-digit characters except +
* @param phone - Phone number to normalize
* @returns Normalized phone number
*/
private normalizePhoneNumber;
/**
* Send notification via HttpSMS
* @param config - Plugin configuration
* @param message - Notification message
* @returns Notification result
*/
send(config: PluginConfig, message: NotificationMessage): Promise<NotificationResult>;
}
/**
* Create a new HttpSMS plugin instance
*
* @returns HttpSMS plugin instance
*/
export declare function createHttpSmsPlugin(): HttpSmsPlugin;
export declare const httpSmsPlugin: HttpSmsPlugin;
export default httpSmsPlugin;
//# sourceMappingURL=httpsms.d.ts.map