Class: Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/porting_orders/additional_document_create_response.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(id: nil, content_type: nil, created_at: nil, document_id: nil, document_type: nil, filename: nil, porting_order_id: nil, record_type: nil, updated_at: nil) ⇒ Object

Parameters:

  • id (String) (defaults to: nil) —

    Uniquely identifies this additional document

  • content_type (String) (defaults to: nil) —

    The content type of the related document.

  • created_at (Time) (defaults to: nil) —

    ISO 8601 formatted date indicating when the resource was created.

  • document_id (String) (defaults to: nil) —

    Identifies the associated document

  • document_type (Symbol, Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse::Data::DocumentType) (defaults to: nil) —

    Identifies the type of additional document

  • filename (String) (defaults to: nil) —

    The filename of the related document.

  • porting_order_id (String) (defaults to: nil) —

    Identifies the associated porting order

  • record_type (String) (defaults to: nil) —

    Identifies the type of the resource.

  • updated_at (Time) (defaults to: nil) —

    ISO 8601 formatted date indicating when the resource was updated.



17
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 17

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute id
  #   Uniquely identifies this additional document
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute content_type
  #   The content type of the related document.
  #
  #   @return [String, nil]
  optional :content_type, String

  # @!attribute created_at
  #   ISO 8601 formatted date indicating when the resource was created.
  #
  #   @return [Time, nil]
  optional :created_at, Time

  # @!attribute document_id
  #   Identifies the associated document
  #
  #   @return [String, nil]
  optional :document_id, String

  # @!attribute document_type
  #   Identifies the type of additional document
  #
  #   @return [Symbol, Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse::Data::DocumentType, nil]
  optional :document_type,
           enum: -> { Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse::Data::DocumentType }

  # @!attribute filename
  #   The filename of the related document.
  #
  #   @return [String, nil]
  optional :filename, String

  # @!attribute porting_order_id
  #   Identifies the associated porting order
  #
  #   @return [String, nil]
  optional :porting_order_id, String

  # @!attribute updated_at
  #   ISO 8601 formatted date indicating when the resource was updated.
  #
  #   @return [Time, nil]
  optional :updated_at, Time

  response_only do
    # @!attribute record_type
    #   Identifies the type of the resource.
    #
    #   @return [String, nil]
    optional :record_type, String
  end

  # @!method initialize(id: nil, content_type: nil, created_at: nil, document_id: nil, document_type: nil, filename: nil, porting_order_id: nil, record_type: nil, updated_at: nil)
  #   @param id [String] Uniquely identifies this additional document
  #
  #   @param content_type [String] The content type of the related document.
  #
  #   @param created_at [Time] ISO 8601 formatted date indicating when the resource was created.
  #
  #   @param document_id [String] Identifies the associated document
  #
  #   @param document_type [Symbol, Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse::Data::DocumentType] Identifies the type of additional document
  #
  #   @param filename [String] The filename of the related document.
  #
  #   @param porting_order_id [String] Identifies the associated porting order
  #
  #   @param record_type [String] Identifies the type of the resource.
  #
  #   @param updated_at [Time] ISO 8601 formatted date indicating when the resource was updated.

  # Identifies the type of additional document
  #
  # @see Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse::Data#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

#content_type ⇒ String?

The content type of the related document.

Returns:

  • (String, nil) 


28
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 28

optional :content_type, String

#created_at ⇒ Time?

ISO 8601 formatted date indicating when the resource was created.

Returns:

  • (Time, nil) 


34
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 34

optional :created_at, Time

#document_id ⇒ String?

Identifies the associated document

Returns:

  • (String, nil) 


40
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 40

optional :document_id, String

#document_type ⇒ Symbol, ...

Identifies the type of additional document

Returns:



46
47
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 46

optional :document_type,
enum: -> { Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse::Data::DocumentType }

#filename ⇒ String?

The filename of the related document.

Returns:

  • (String, nil) 


53
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 53

optional :filename, String

#id ⇒ String?

Uniquely identifies this additional document

Returns:

  • (String, nil) 


22
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 22

optional :id, String

#porting_order_id ⇒ String?

Identifies the associated porting order

Returns:

  • (String, nil) 


59
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 59

optional :porting_order_id, String

#updated_at ⇒ Time?

ISO 8601 formatted date indicating when the resource was updated.

Returns:

  • (Time, nil) 


65
 
# File 'lib/telnyx/models/porting_orders/additional_document_create_response.rb', line 65

optional :updated_at, Time