Class: Telnyx::Models::Portouts::SupportingDocumentCreateParams::Document

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/portouts/supporting_document_create_params.rb

Defined Under Namespace

Modules: Type

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(document_id:, type:) ⇒ Object

Parameters:



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
 
# File 'lib/telnyx/models/portouts/supporting_document_create_params.rb', line 30

class Document < Telnyx::Internal::Type::BaseModel
  # @!attribute document_id
  #   Identifies the associated document
  #
  #   @return [String]
  required :document_id, String

  # @!attribute type
  #   Identifies the type of the document
  #
  #   @return [Symbol, Telnyx::Models::Portouts::SupportingDocumentCreateParams::Document::Type]
  required :type, enum: -> { Telnyx::Portouts::SupportingDocumentCreateParams::Document::Type }

  # @!method initialize(document_id:, type:)
  #   @param document_id [String] Identifies the associated document
  #
  #   @param type [Symbol, Telnyx::Models::Portouts::SupportingDocumentCreateParams::Document::Type] Identifies the type of the document

  # Identifies the type of the document
  #
  # @see Telnyx::Models::Portouts::SupportingDocumentCreateParams::Document#type
  module Type
    extend Telnyx::Internal::Type::Enum

    LOA = :loa
    INVOICE = :invoice

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

Instance Attribute Details

#document_id ⇒ String

Identifies the associated document

Returns:

  • (String) 


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

required :document_id, String

#type ⇒ Symbol, Telnyx::Models::Portouts::SupportingDocumentCreateParams::Document::Type

Identifies the type of the document

Returns:



41
 
# File 'lib/telnyx/models/portouts/supporting_document_create_params.rb', line 41

required :type, enum: -> { Telnyx::Portouts::SupportingDocumentCreateParams::Document::Type }