Class: PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/prelude_sdk/models/verification_management_submit_sender_id_response.rb,
sig/prelude_sdk/models/verification_management_submit_sender_id_response.rbs

Overview

See Also:

  • PreludeSDK::Resources::VerificationManagement#submit_sender_id

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Instance Method Summary collapse

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(sender_id:, status:, reason: nil) ⇒ Object

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

Parameters:




# File 'lib/prelude_sdk/models/verification_management_submit_sender_id_response.rb', line 29

Instance Attribute Details

#reason ⇒ String?

The reason why the sender ID was rejected.

Parameters:

  • (String)

Returns:

  • (String, nil) 


27
 
# File 'lib/prelude_sdk/models/verification_management_submit_sender_id_response.rb', line 27

optional :reason, String

#sender_id ⇒ String

The sender ID that was added.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/prelude_sdk/models/verification_management_submit_sender_id_response.rb', line 11

required :sender_id, String

#status ⇒ Symbol, PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status

It indicates the status of the sender ID. Possible values are:

  • approved - The sender ID is approved.
  • pending - The sender ID is pending.
  • rejected - The sender ID is rejected.

Parameters:

  • value (PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::status)

Returns:



21
 
# File 'lib/prelude_sdk/models/verification_management_submit_sender_id_response.rb', line 21

required :status, enum: -> { PreludeSDK::Models::VerificationManagementSubmitSenderIDResponse::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


25
 
# File 'sig/prelude_sdk/models/verification_management_submit_sender_id_response.rbs', line 25

def to_hash: -> {