android-sms-gateway/dist/index.d.ts

A JS/TS client library for sending and managing SMS messages via the SMS Gateway for Android™

// Generated by dts-bundle-generator v9.5.1

export declare enum ProcessState {
	Pending = "Pending",
	Processed = "Processed",
	Sent = "Sent",
	Delivered = "Delivered",
	Failed = "Failed"
}
/**
 * Represents the state of a recipient of an SMS message.
 */
export interface RecipientState {
	/**
	 * The phone number of the recipient.
	 */
	phoneNumber: string;
	/**
	 * The state of the recipient.
	 */
	state: ProcessState;
	/**
	 * An optional error message, if the recipient failed to receive the message.
	 */
	error?: string | null;
}
/**
 * Represents the state of an SMS message.
 */
export interface MessageState {
	/**
	 * The ID of the message.
	 */
	id: string;
	/**
	 * The state of the message.
	 */
	state: ProcessState;
	/**
	 * The list of recipients' states for the message.
	 */
	recipients: RecipientState[];
}
/**
 * Represents an SMS message.
 */
export interface Message {
	/**
	 * The ID of the message, will be generated if not provided.
	 * @default null
	 */
	id?: string | null;
	/**
	 * The message content.
	 */
	message: string;
	/**
	 * The time-to-live (TTL) of the message in seconds.
	 * If set to null, the message will not expire.
	 * @default null
	 */
	ttl?: number | null;
	/**
	 * The phone numbers to send the message to.
	 */
	phoneNumbers: string[];
	/**
	 * The SIM number to send the message from.
	 * If not specified, the message will be sent from the default SIM.
	 * @default null
	 */
	simNumber?: number | null;
	/**
	 * Whether to include a delivery report for the message.
	 * @default true
	 */
	withDeliveryReport?: boolean | null;
}
/**
 * Represents the type of events that can trigger a webhook.
 */
export declare enum WebHookEventType {
	/**
	 * Indicates that a new SMS message has been received.
	 */
	SmsReceived = "sms:received",
	/**
	 * Indicates that a ping request has been sent.
	 */
	SystemPing = "system:ping",
	/**
	 * Indicates that an SMS message has been sent.
	 */
	SmsSent = "sms:sent",
	/**
	 * Indicates that an SMS message has been delivered.
	 */
	SmsDelivered = "sms:delivered",
	/**
	 * Indicates that an SMS message has failed to be sent.
	 */
	SmsFailed = "sms:failed"
}
/**
 * Represents a request to create or update a webhook.
 */
export interface RegisterWebHookRequest {
	/**
	 * The ID of the webhook.
	 * If not specified, a new ID will be generated.
	 * @default null
	 */
	id?: string | null;
	/**
	 * The event type that triggers the webhook.
	 */
	event: WebHookEventType;
	/**
	 * The URL to send the webhook request to.
	 */
	url: string;
	/**
	 * The device ID the webhook is associated with.
	 * @default null
	 */
	deviceId?: string | null;
}
/**
 * Represents a webhook configuration.
 * @see RegisterWebHookRequest
 */
export type WebHook = Required<RegisterWebHookRequest>;
/**
 * Represents a device.
 */
export interface Device {
	/**
	 * The unique identifier of the device.
	 */
	id: string;
	/**
	 * The name of the device.
	 */
	name: string;
	/**
	 * The timestamp when the device was created.
	 */
	createdAt: string;
	/**
	 * The timestamp when the device was last seen.
	 */
	lastSeen: string;
	/**
	 * The timestamp when the device was updated.
	 */
	updatedAt: string;
	/**
	 * The timestamp when the device was deleted (if applicable).
	 */
	deletedAt?: string | null;
}
/**
 * Represents the settings for a device.
 */
export interface DeviceSettings {
	/**
	 * Settings related to message handling.
	 */
	messages?: SettingsMessages;
	/**
	 * Settings related to webhook functionality.
	 */
	webhooks?: SettingsWebhooks;
	/**
	 * Settings related to the Cloud/Private server configuration.
	 */
	gateway?: SettingsGateway;
	/**
	 * Settings related to message encryption.
	 */
	encryption?: SettingsEncryption;
	/**
	 * Settings related to logging.
	 */
	logs?: SettingsLogs;
	/**
	 * Settings related to ping functionality.
	 */
	ping?: SettingsPing;
}
/**
 * Represents the settings for message handling.
 */
export interface SettingsMessages {
	/**
	 * The period for message sending limits.
	 */
	limitPeriod?: LimitPeriod;
	/**
	 * The maximum number of messages allowed per limit period.
	 */
	limitValue?: number;
	/**
	 * The number of days to retain message logs.
	 */
	logLifetimeDays?: number;
	/**
	 * The minimum interval between message sends (in seconds).
	 */
	sendIntervalMin?: number;
	/**
	 * The maximum interval between message sends (in seconds).
	 */
	sendIntervalMax?: number;
	/**
	 * The mode for SIM card selection.
	 */
	simSelectionMode?: SimSelectionMode;
}
/**
 * Represents the settings for webhook functionality.
 */
export interface SettingsWebhooks {
	/**
	 * Whether internet access is required for webhooks.
	 */
	internetRequired?: boolean;
	/**
	 * The number of times to retry failed webhook deliveries.
	 */
	retryCount?: number;
	/**
	 * The secret key used for signing webhook payloads.
	 */
	signingKey?: string;
}
/**
 * Represents the settings for the Cloud/Private server configuration.
 */
export interface SettingsGateway {
	/**
	 * The URL of the server.
	 */
	cloudUrl?: string;
	/**
	 * The private token for authenticating with the Private Server.
	 */
	privateToken?: string;
}
/**
 * Represents the settings for message encryption.
 */
export interface SettingsEncryption {
	/**
	 * The encryption passphrase.
	 */
	passphrase?: string;
}
/**
 * Represents the settings for logging.
 */
export interface SettingsLogs {
	/**
	 * The number of days to retain logs.
	 */
	lifetimeDays?: number;
}
/**
 * Represents the settings for ping functionality.
 */
export interface SettingsPing {
	/**
	 * The interval between ping requests (in seconds).
	 */
	intervalSeconds?: number;
}
/**
 * Represents the period for message sending limits.
 */
export declare enum LimitPeriod {
	Disabled = "Disabled",
	PerMinute = "PerMinute",
	PerHour = "PerHour",
	PerDay = "PerDay"
}
/**
 * Represents the mode for SIM card selection.
 */
export declare enum SimSelectionMode {
	OSDefault = "OSDefault",
	RoundRobin = "RoundRobin",
	Random = "Random"
}
/**
 * Represents the health status of the system.
 */
export declare enum HealthStatus {
	Pass = "pass",
	Warn = "warn",
	Fail = "fail"
}
/**
 * Represents the health response from the system.
 */
export interface HealthResponse {
	/**
	 * The overall status of the application.
	 */
	status: HealthStatus;
	/**
	 * The version of the application.
	 */
	version: string;
	/**
	 * The release ID of the application.
	 */
	releaseId: number;
	/**
	 * A map of check names to their respective details.
	 */
	checks: HealthChecks;
}
/**
 * Represents a map of health checks.
 */
export interface HealthChecks {
	[checkName: string]: HealthCheck;
}
/**
 * Represents a health check.
 */
export interface HealthCheck {
	/**
	 * The status of the check.
	 */
	status: HealthStatus;
	/**
	 * A human-readable description of the check.
	 */
	description: string;
	/**
	 * The observed value of the check.
	 */
	observedValue: number;
	/**
	 * The unit of measurement for the observed value.
	 */
	observedUnit: string;
}
/**
 * Represents a log entry.
 */
export interface LogEntry {
	/**
	 * The unique identifier of the log entry.
	 */
	id: number;
	/**
	 * The timestamp when the log entry was created.
	 */
	createdAt: string;
	/**
	 * The module or component that generated the log entry.
	 */
	module: string;
	/**
	 * The priority level of the log entry.
	 */
	priority: LogEntryPriority;
	/**
	 * A message describing the log event.
	 */
	message: string;
	/**
	 * Additional context information related to the log entry.
	 */
	context?: Record<string, string>;
}
/**
 * Represents the priority level of a log entry.
 */
export declare enum LogEntryPriority {
	Debug = "DEBUG",
	Info = "INFO",
	Warn = "WARN",
	Error = "ERROR"
}
/**
 * Represents a request to export inbox messages.
 */
export interface MessagesExportRequest {
	/**
	 * The ID of the device to export messages for.
	 */
	deviceId: string;
	/**
	 * The start of the time range to export.
	 */
	since: Date;
	/**
	 * The end of the time range to export.
	 */
	until: Date;
}
/**
 * Represents the payload of a webhook event.
 */
export type WebHookPayload = 
/**
 * Represents the payload of a webhook event of type `SmsReceived`.
 */
{
	/**
	 * The event type.
	 */
	event: WebHookEventType.SmsReceived;
	/**
	 * The payload of the event.
	 */
	payload: {
		/**
		 * The received message.
		 */
		message: string;
		/**
		 * The phone number of the sender.
		 */
		phoneNumber: string;
		/**
		 * The date and time of when the message was received.
		 */
		receivedAt: string;
	};
} | 
/**
 * Represents the payload of a webhook event of type `SystemPing`.
 */
{
	/**
	 * The event type.
	 */
	event: WebHookEventType.SystemPing;
	/**
	 * The payload of the event.
	 * This is an empty object.
	 */
	payload: EmptyObject;
} | 
/**
 * Represents the payload of a webhook event of type `SmsSent`.
 */
{
	/**
	 * The event type.
	 */
	event: WebHookEventType.SmsSent;
	/**
	 * The payload of the event.
	 */
	payload: {
		/**
		 * The message ID.
		 */
		messageId: string;
		/**
		 * The date and time of when the message was sent.
		 */
		sentAt: string;
	};
} | 
/**
 * Represents the payload of a webhook event of type `SmsDelivered`.
 */
{
	/**
	 * The event type.
	 */
	event: WebHookEventType.SmsDelivered;
	/**
	 * The payload of the event.
	 */
	payload: {
		/**
		 * The message ID.
		 */
		messageId: string;
		/**
		 * The date and time of when the message was delivered.
		 */
		deliveredAt: string;
	};
} | 
/**
 * Represents the payload of a webhook event of type `SmsFailed`.
 */
{
	/**
	 * The event type.
	 */
	event: WebHookEventType.SmsFailed;
	/**
	 * The payload of the event.
	 */
	payload: {
		/**
		 * The message ID.
		 */
		messageId: string;
		/**
		 * The date and time of when the message failed.
		 */
		failedAt: string;
		/**
		 * The error message.
		 */
		error: string;
	};
};
export type EmptyObject = {
	[K in any]: never;
};
export interface HttpClient {
	get<T>(url: string, headers?: Record<string, string>): Promise<T>;
	post<T>(url: string, body: any, headers?: Record<string, string>): Promise<T>;
	put<T>(url: string, body: any, headers?: Record<string, string>): Promise<T>;
	patch<T>(url: string, body: any, headers?: Record<string, string>): Promise<T>;
	delete<T>(url: string, headers?: Record<string, string>): Promise<T>;
}
declare class Client {
	private baseUrl;
	private httpClient;
	private defaultHeaders;
	/**
	 * @param login The login to use for authentication
	 * @param password The password to use for authentication
	 * @param httpClient The HTTP client to use for requests
	 * @param baseUrl The base URL to use for requests. Defaults to {@link BASE_URL}.
	 */
	constructor(login: string, password: string, httpClient: HttpClient, baseUrl?: string);
	/**
	 * Sends a new message to the API
	 * @param request - The message to send
	 * @param options - Optional parameters
	 * @param options.skipPhoneValidation - Whether to skip phone number validation
	 * @returns The state of the message after sending
	 */
	send(request: Message, options?: {
		skipPhoneValidation?: boolean;
	}): Promise<MessageState>;
	/**
	 * Retrieves the state of an SMS message from the API
	 * @param messageId - The ID of the message to retrieve the state for
	 * @returns The state of the message
	 */
	getState(messageId: string): Promise<MessageState>;
	/**
	 * Retrieves a list of registered webhooks from the API
	 * @returns An array of webhooks
	 */
	getWebhooks(): Promise<WebHook[]>;
	/**
	 * Registers a new webhook
	 * @param request - The webhook to register
	 * @returns The registered webhook
	 */
	registerWebhook(request: RegisterWebHookRequest): Promise<WebHook>;
	/**
	 * Removes a webhook by its ID
	 * @param webhookId - The ID of the webhook to remove
	 */
	deleteWebhook(webhookId: string): Promise<void>;
	/**
	 * Get a list of registered devices
	 * @returns An array of registered devices
	 */
	getDevices(): Promise<Device[]>;
	/**
	 * Remove a device by ID
	 * @param deviceId - The ID of the device to remove
	 */
	deleteDevice(deviceId: string): Promise<void>;
	/**
	 * Check if the service is healthy
	 * @returns A promise that resolves to the health response
	 */
	getHealth(): Promise<HealthResponse>;
	/**
	 * Request inbox messages export
	 * @param request - The export request parameters
	 */
	exportInbox(request: MessagesExportRequest): Promise<void>;
	/**
	 * Get logs within a specified time range
	 * @param from - The start of the time range (optional)
	 * @param to - The end of the time range (optional)
	 * @returns An array of log entries
	 */
	getLogs(from?: Date, to?: Date): Promise<LogEntry[]>;
	/**
	 * Get settings for the user
	 * @returns The user's settings
	 */
	getSettings(): Promise<DeviceSettings>;
	/**
	 * Update settings for the user
	 * @param settings - The new settings to apply
	 */
	updateSettings(settings: DeviceSettings): Promise<void>;
	/**
	 * Partially update settings for the user
	 * @param settings - The partial settings to update
	 */
	patchSettings(settings: Partial<DeviceSettings>): Promise<void>;
}

export {
	Client as default,
};

export {};