Class: Telnyx::Models::Messaging10dlc::BrandTriggerSMSOtpParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/messaging_10dlc/brand_trigger_sms_otp_params.rb

Overview

See Also:

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(brand_id:, pin_sms:, success_sms:, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Messaging10dlc::BrandTriggerSMSOtpParams for more details.

Parameters:

  • brand_id (String)
  • pin_sms (String) —

    SMS message template to send the OTP. Must include ‘@OTP_PIN@` placeholder which

  • success_sms (String) —

    SMS message to send upon successful OTP verification

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



# File 'lib/telnyx/models/messaging_10dlc/brand_trigger_sms_otp_params.rb', line 29

Instance Attribute Details

#brand_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/telnyx/models/messaging_10dlc/brand_trigger_sms_otp_params.rb', line 14

required :brand_id, String

#pin_sms ⇒ String

SMS message template to send the OTP. Must include ‘@OTP_PIN@` placeholder which will be replaced with the actual PIN

Returns:

  • (String) 


21
 
# File 'lib/telnyx/models/messaging_10dlc/brand_trigger_sms_otp_params.rb', line 21

required :pin_sms, String, api_name: :pinSms

#success_sms ⇒ String

SMS message to send upon successful OTP verification

Returns:

  • (String) 


27
 
# File 'lib/telnyx/models/messaging_10dlc/brand_trigger_sms_otp_params.rb', line 27

required :success_sms, String, api_name: :successSms