Class: Telnyx::Models::DirRetrieveDocumentTypesResponse::Data

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

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(description: nil, short_name: nil) ⇒ Data

Single supported document type.

Parameters:

  • description (String) (defaults to: nil)
  • short_name (String) (defaults to: nil) —

    Stable identifier passed to Document.document_type.

  • description: (String) (defaults to: nil)
  • short_name: (String) (defaults to: nil) 


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/telnyx/models/dir_retrieve_document_types_response.rb', line 30

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute description
  #
  #   @return [String, nil]
  optional :description, String

  # @!attribute short_name
  #   Stable identifier passed to `Document.document_type`.
  #
  #   @return [String, nil]
  optional :short_name, String

  # @!method initialize(description: nil, short_name: nil)
  #   Single supported document type.
  #
  #   @param description [String]
  #
  #   @param short_name [String] Stable identifier passed to `Document.document_type`.
end

Instance Attribute Details

#description ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :description, String

#short_name ⇒ String?

Stable identifier passed to Document.document_type.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :short_name, String

Instance Method Details

#to_hash ⇒ { description: String, short_name: String }

Returns:

  • ({ description: String, short_name: String }) 


37
 
# File 'sig/telnyx/models/dir_retrieve_document_types_response.rbs', line 37

def to_hash: -> { description: String, short_name: String }