Struct SendOtpRequest 

pub struct SendOtpRequest {
    pub to: String,
    pub code: Option<String>,
    pub ttl: Option<u32>,
    pub digits: Option<u8>,
    pub intent: Option<String>,
    pub channel: Option<OtpChannel>,
    pub signature: Option<String>,
    pub template_id: Option<String>,
}

Parameters accepted by otp.send.

Fields

to: String

Destination phone number in E.164 format.

code: Option<String>

Caller-provided code. When omitted, Unimatrix generates one.

ttl: Option<u32>

Code lifetime in seconds.

digits: Option<u8>

Number of digits in an automatically generated code.

intent: Option<String>

Application-defined verification intent.

channel: Option<OtpChannel>

Preferred delivery channel.

signature: Option<String>

Message signature used by an SMS template.

template_id: Option<String>

Message template ID used to deliver the code.

Implementations

impl SendOtpRequest

pub fn new(to: impl Into<String>) -> Self

Creates a request that lets Unimatrix generate and deliver the code.

pub fn with_code(self, code: impl Into<String>) -> Self

Uses a caller-provided verification code.

pub fn with_ttl(self, ttl: u32) -> Self

Sets the code lifetime in seconds.

pub fn with_digits(self, digits: u8) -> Self

Sets the number of digits in an automatically generated code.

pub fn with_intent(self, intent: impl Into<String>) -> Self

Associates an application-defined intent with the verification.

pub fn with_channel(self, channel: OtpChannel) -> Self

Selects the preferred delivery channel.

pub fn with_template( self, signature: impl Into<String>, template_id: impl Into<String>, ) -> Self

Selects an SMS template and its signature.

Trait Implementations

impl Clone for SendOtpRequest

fn clone(&self) -> SendOtpRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendOtpRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for SendOtpRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.