<?php
/**
 * Public functions for developers.
 *
 * @package VibrateSMS
 */

defined( 'ABSPATH' ) || exit;

if ( ! function_exists( 'vibrate_sms_send' ) ) {
	/**
	 * Send an SMS through Vibrate.
	 *
	 * Uses the access key and sender from the plugin settings and goes
	 * through the same validation, abuse limits and log as every other SMS.
	 * Vibrate delivers to Israeli numbers only; other numbers are refused and
	 * logged as not sent.
	 *
	 *     $result = vibrate_sms_send( '050-1234567', 'Your table is ready.' );
	 *     if ( is_wp_error( $result ) ) {
	 *         error_log( $result->get_error_message() );
	 *     }
	 *
	 * @param string|string[]      $to      Phone number(s): an array, or a string
	 *                                      separated by commas or new lines.
	 * @param string               $message Plain text message.
	 * @param array<string, mixed> $args {
	 *     Optional.
	 *
	 *     @type string $source    Label for the log, e.g. "my_plugin". Default "api".
	 *     @type int    $object_id Related object id. Default 0.
	 *     @type bool   $async     Queue in the background instead of waiting for
	 *                             the API. Default false.
	 * }
	 * @return array|WP_Error On success: status ("queued" when Vibrate accepted
	 *                        it, "pending" when queued in the background,
	 *                        "retrying" when Vibrate did not answer and a retry
	 *                        is scheduled), batch_key, run_id, recipients,
	 *                        blocked, units.
	 */
	function vibrate_sms_send( $to, $message, array $args = array() ) {
		return \VibrateSMS\Messenger::send( $to, $message, $args );
	}
}

if ( ! function_exists( 'vibrate_sms_is_configured' ) ) {
	/**
	 * Whether an access key and a sender are set.
	 */
	function vibrate_sms_is_configured(): bool {
		return \VibrateSMS\Settings::is_configured();
	}
}