Struct SmsAuthentication 

pub struct SmsAuthentication {
    pub phone_number: SmsAuthenticationPhoneNumber,
    pub type_: SmsAuthenticationType,
}

Information about an end user who authenticates using a one-time password sent to their phone number via SMS.

JSON schema

{
 "title": "SmsAuthentication",
 "description": "Information about an end user who authenticates using a one-time password sent to their phone number via SMS.",
 "type": "object",
 "required": [
   "phoneNumber",
   "type"
 ],
 "properties": {
   "phoneNumber": {
     "description": "The phone number of the end user in E.164 format.",
     "examples": [
       "+12055555555"
     ],
     "type": "string",
     "pattern": "^\\+[1-9]\\d{1,14}$"
   },
   "type": {
     "description": "The type of authentication information.",
     "examples": [
       "sms"
     ],
     "type": "string",
     "enum": [
       "sms"
     ]
   }
 }
}

Fields

phone_number: SmsAuthenticationPhoneNumber

The phone number of the end user in E.164 format.

type_: SmsAuthenticationType

The type of authentication information.

Implementations

impl SmsAuthentication

pub fn builder() -> SmsAuthentication

Trait Implementations

impl Clone for SmsAuthentication

fn clone(&self) -> SmsAuthentication

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SmsAuthentication

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SmsAuthentication

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SmsAuthentication> for SmsAuthentication

fn from(value: &SmsAuthentication) -> Self

Converts to this type from the input type.

impl From<SmsAuthentication> for AuthenticationMethod

fn from(value: SmsAuthentication) -> Self

Converts to this type from the input type.

impl From<SmsAuthentication> for SmsAuthentication

fn from(value: SmsAuthentication) -> Self

Converts to this type from the input type.

impl Serialize for SmsAuthentication

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SmsAuthentication> for SmsAuthentication

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: SmsAuthentication) -> Result<Self, ConversionError>

Performs the conversion.