java.lang.Object
- com.bandwidth.sdk.model.VerifyCodeRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-08-29T14:24:34.966664-04:00[America/New_York]")
public class VerifyCodeRequest
extends Object

VerifyCodeRequest

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VerifyCodeRequest.CustomTypeAdapterFactory

Field Summary

Fields
Modifier and Type	Field	Description
`static HashSet<String>`	`openapiFields`
`static HashSet<String>`	`openapiRequiredFields`
`static String`	`SERIALIZED_NAME_CODE`
`static String`	`SERIALIZED_NAME_EXPIRATION_TIME_IN_MINUTES`
`static String`	`SERIALIZED_NAME_SCOPE`
`static String`	`SERIALIZED_NAME_TO`

Constructor Summary

Constructors
Constructor Description

VerifyCodeRequest()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`VerifyCodeRequest`	`code(String code)`
`boolean`	`equals(Object o)`
`VerifyCodeRequest`	`expirationTimeInMinutes(BigDecimal expirationTimeInMinutes)`
`static VerifyCodeRequest`	`fromJson(String jsonString)`	Create an instance of VerifyCodeRequest given an JSON string
`Map<String,Object>`	`getAdditionalProperties()`	Return the additional (undeclared) property.
`Object`	`getAdditionalProperty(String key)`	Return the additional (undeclared) property with the specified name.
`String`	`getCode()`	The generated mfa code to check if valid.
`BigDecimal`	`getExpirationTimeInMinutes()`	The time period, in minutes, to validate the mfa code.
`String`	`getScope()`	An optional field to denote what scope or action the mfa code is addressing.
`String`	`getTo()`	The phone number to send the mfa code to.
`int`	`hashCode()`
`VerifyCodeRequest`	`putAdditionalProperty(String key, Object value)`	Set the additional (undeclared) property with the specified name and value.
`VerifyCodeRequest`	`scope(String scope)`
`void`	`setCode(String code)`
`void`	`setExpirationTimeInMinutes(BigDecimal expirationTimeInMinutes)`
`void`	`setScope(String scope)`
`void`	`setTo(String to)`
`VerifyCodeRequest`	`to(String to)`
`String`	`toJson()`	Convert an instance of VerifyCodeRequest to an JSON string
`String`	`toString()`
`static void`	`validateJsonElement(com.google.gson.JsonElement jsonElement)`	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERIALIZED_NAME_TO
```
public static final String SERIALIZED_NAME_TO
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_SCOPE
```
public static final String SERIALIZED_NAME_SCOPE
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_EXPIRATION_TIME_IN_MINUTES
```
public static final String SERIALIZED_NAME_EXPIRATION_TIME_IN_MINUTES
```
    See Also:
    
    Constant Field Values
  - SERIALIZED_NAME_CODE
```
public static final String SERIALIZED_NAME_CODE
```
    See Also:
    
    Constant Field Values
  - openapiFields
```
public static HashSet<String> openapiFields
```
  - openapiRequiredFields
```
public static HashSet<String> openapiRequiredFields
```
- Constructor Detail
  - VerifyCodeRequest
```
public VerifyCodeRequest()
```
- Method Detail
  - to
```
public VerifyCodeRequest to(String to)
```
  - getTo
```
@Nonnull
public String getTo()
```
    The phone number to send the mfa code to.
    
    Returns:
    
    to
  - setTo
```
public void setTo(String to)
```
  - scope
```
public VerifyCodeRequest scope(String scope)
```
  - getScope
```
@Nullable
public String getScope()
```
    An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\".
    
    Returns:
    
    scope
  - setScope
```
public void setScope(String scope)
```
  - expirationTimeInMinutes
```
public VerifyCodeRequest expirationTimeInMinutes(BigDecimal expirationTimeInMinutes)
```
  - getExpirationTimeInMinutes
```
@Nonnull
public BigDecimal getExpirationTimeInMinutes()
```
    The time period, in minutes, to validate the mfa code. By setting this to 3 minutes, it will mean any code generated within the last 3 minutes are still valid. The valid range for expiration time is between 0 and 15 minutes, exclusively and inclusively, respectively. minimum: 1 maximum: 15
    
    Returns:
    
    expirationTimeInMinutes
  - setExpirationTimeInMinutes
```
public void setExpirationTimeInMinutes(BigDecimal expirationTimeInMinutes)
```
  - code
```
public VerifyCodeRequest code(String code)
```
  - getCode
```
@Nonnull
public String getCode()
```
    The generated mfa code to check if valid.
    
    Returns:
    
    code
  - setCode
```
public void setCode(String code)
```
  - putAdditionalProperty
```
public VerifyCodeRequest putAdditionalProperty(String key,
                                               Object value)
```
    Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
    
    Parameters:
    
    key - name of the property
    
    value - value of the property
    
    Returns:
    
    the VerifyCodeRequest instance itself
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
    Return the additional (undeclared) property.
    
    Returns:
    
    a map of objects
  - getAdditionalProperty
```
public Object getAdditionalProperty(String key)
```
    Return the additional (undeclared) property with the specified name.
    
    Parameters:
    
    key - name of the property
    
    Returns:
    
    an object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validateJsonElement
```
public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException
```
    Validates the JSON Element and throws an exception if issues found
    
    Parameters:
    
    jsonElement - JSON Element
    
    Throws:
    
    IOException - if the JSON Element is invalid with respect to VerifyCodeRequest
  - fromJson
```
public static VerifyCodeRequest fromJson(String jsonString)
                                  throws IOException
```
    Create an instance of VerifyCodeRequest given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of VerifyCodeRequest
    
    Throws:
    
    IOException - if the JSON string is invalid with respect to VerifyCodeRequest
  - toJson
```
public String toJson()
```
    Convert an instance of VerifyCodeRequest to an JSON string
    
    Returns:
    
    JSON string

Class VerifyCodeRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERIALIZED_NAME_TO

SERIALIZED_NAME_SCOPE

SERIALIZED_NAME_EXPIRATION_TIME_IN_MINUTES

SERIALIZED_NAME_CODE

openapiFields

openapiRequiredFields

Constructor Detail

VerifyCodeRequest

Method Detail

to

getTo

setTo

scope

getScope

setScope

expirationTimeInMinutes

getExpirationTimeInMinutes

setExpirationTimeInMinutes

code

getCode

setCode

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString

validateJsonElement

fromJson

toJson