Class: Telnyx::Models::VerifyProfileCreateParams

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

Overview

See Also:

  • Telnyx::Resources::VerifyProfiles#create

Defined Under Namespace

Classes: Call, Flashcall, SMS, Whatsapp

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(alpha_sender: nil, app_name: nil, code_length: nil, default_verification_timeout_secs: nil, messaging_template_id: nil, whitelisted_destinations: nil) ⇒ Object

Some parameter documentations has been truncated, see SMS for more details.

Parameters:

  • alpha_sender (String, nil) (defaults to: nil) —

    The alphanumeric sender ID to use when sending to destinations that require an a

  • app_name (String) (defaults to: nil) —

    The name that identifies the application requesting 2fa in the verification mess

  • code_length (Integer) (defaults to: nil) —

    The length of the verify code to generate.

  • default_verification_timeout_secs (Integer) (defaults to: nil) —

    For every request that is initiated via this Verify profile, this sets the numbe

  • messaging_template_id (String) (defaults to: nil) —

    The message template identifier selected from /verify_profiles/templates

  • whitelisted_destinations (Array<String>) (defaults to: nil) —

    Enabled country destinations to send verification codes. The elements in the lis




# File 'lib/telnyx/models/verify_profile_create_params.rb', line 124

Instance Attribute Details

#call ⇒ Telnyx::Models::VerifyProfileCreateParams::Call?

Returns:



18
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 18

optional :call, -> { Telnyx::VerifyProfileCreateParams::Call }

#daily_spend_limit ⇒ Float?

The maximum daily spend allowed on this verify profile, in USD.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


24
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 24

optional :daily_spend_limit, Float

#daily_spend_limit_enabled ⇒ Boolean?

Whether the daily spend limit is enforced for this verify profile.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


30
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 30

optional :daily_spend_limit_enabled, Telnyx::Internal::Type::Boolean

#flashcall ⇒ Telnyx::Models::VerifyProfileCreateParams::Flashcall?

Returns:



35
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 35

optional :flashcall, -> { Telnyx::VerifyProfileCreateParams::Flashcall }

#language ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


40
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 40

optional :language, String

#name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 13

required :name, String

#sms ⇒ Telnyx::Models::VerifyProfileCreateParams::SMS?

Returns:



45
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 45

optional :sms, -> { Telnyx::VerifyProfileCreateParams::SMS }

#webhook_failover_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


50
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 50

optional :webhook_failover_url, String

#webhook_url ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


55
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 55

optional :webhook_url, String

#whatsapp ⇒ Telnyx::Models::VerifyProfileCreateParams::Whatsapp?

Returns:



60
 
# File 'lib/telnyx/models/verify_profile_create_params.rb', line 60

optional :whatsapp, -> { Telnyx::VerifyProfileCreateParams::Whatsapp }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


82
 
# File 'sig/telnyx/models/verify_profile_create_params.rbs', line 82

def to_hash: -> {