Class: Telnyx::Models::PortingOrders::AdditionalDocumentCreateParams::AdditionalDocument

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/porting_orders/additional_document_create_params.rb

Defined Under Namespace

Modules: DocumentType

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

Parameters:



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
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_params.rb', line 27

class AdditionalDocument < Telnyx::Internal::Type::BaseModel
  # @!attribute document_id
  #   The document identification
  #
  #   @return [String, nil]
  optional :document_id, String

  # @!attribute document_type
  #   The type of document being created.
  #
  #   @return [Symbol, Telnyx::Models::PortingOrders::AdditionalDocumentCreateParams::AdditionalDocument::DocumentType, nil]
  optional :document_type,
           enum: -> { Telnyx::PortingOrders::AdditionalDocumentCreateParams::AdditionalDocument::DocumentType }

  # @!method initialize(document_id: nil, document_type: nil)
  #   @param document_id [String] The document identification
  #
  #   @param document_type [Symbol, Telnyx::Models::PortingOrders::AdditionalDocumentCreateParams::AdditionalDocument::DocumentType] The type of document being created.

  # The type of document being created.
  #
  # @see Telnyx::Models::PortingOrders::AdditionalDocumentCreateParams::AdditionalDocument#document_type
  module DocumentType
    extend Telnyx::Internal::Type::Enum

    LOA = :loa
    INVOICE = :invoice
    CSR = :csr
    OTHER = :other

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

Instance Attribute Details

#document_id ⇒ String?

The document identification

Returns:

  • (String, nil) 


32
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_params.rb', line 32

optional :document_id, String

#document_type ⇒ Symbol, ...

The type of document being created.

Returns:



38
39
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_params.rb', line 38

optional :document_type,
enum: -> { Telnyx::PortingOrders::AdditionalDocumentCreateParams::AdditionalDocument::DocumentType }