Class: PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/prelude_sdk/models/verification_management_list_sender_ids_response.rb

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

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

Parameters:



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/prelude_sdk/models/verification_management_list_sender_ids_response.rb', line 18

class SenderID < PreludeSDK::Internal::Type::BaseModel
  # @!attribute sender_id
  #   Value that will be presented as Sender ID
  #
  #   @return [String, nil]
  optional :sender_id, String

  # @!attribute 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.
  #
  #   @return [Symbol, PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status, nil]
  optional :status,
           enum: -> { PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status }

  # @!method initialize(sender_id: nil, status: nil)
  #   Some parameter documentations has been truncated, see
  #   {PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID} for
  #   more details.
  #
  #   @param sender_id [String] Value that will be presented as Sender ID
  #
  #   @param status [Symbol, PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status] It indicates the status of the Sender ID. Possible values are:

  # 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.
  #
  # @see PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID#status
  module Status
    extend PreludeSDK::Internal::Type::Enum

    APPROVED = :approved
    PENDING = :pending
    REJECTED = :rejected

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#sender_id ⇒ String?

Value that will be presented as Sender ID

Returns:

  • (String, nil) 


23
 
# File 'lib/prelude_sdk/models/verification_management_list_sender_ids_response.rb', line 23

optional :sender_id, String

#status ⇒ Symbol, ...

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.

Returns:



33
34
 
# File 'lib/prelude_sdk/models/verification_management_list_sender_ids_response.rb', line 33

optional :status,
enum: -> { PreludeSDK::Models::VerificationManagementListSenderIDsResponse::SenderID::Status }