Class: PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rb,
sig/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rbs

Overview

See Also:

  • PreludeSDK::Resources::VerificationManagement::Sandbox#add_phone_number

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::PreludeSDK

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(attempt_code:, phone_number:, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see PreludeSDK::Models::VerificationManagement::SandboxAddPhoneNumberParams for more details.

Parameters:

  • attempt_code (String) —

    The fixed attempt code that will validate verification attempts for this phone n

  • phone_number (String) —

    An E.164 formatted phone number to add to the sandbox list.

  • request_options (PreludeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rb', line 24

Instance Attribute Details

#attempt_code ⇒ String

The fixed attempt code that will validate verification attempts for this phone number.

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rb', line 16

required :attempt_code, String

#phone_number ⇒ String

An E.164 formatted phone number to add to the sandbox list.

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rb', line 22

required :phone_number, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


22
 
# File 'sig/prelude_sdk/models/verification_management/sandbox_add_phone_number_params.rbs', line 22

def to_hash: -> {