Class: Telnyx::Models::DocReqsRequirementType

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

Defined Under Namespace

Modules: Type Classes: AcceptanceCriteria

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(acceptable_characters: nil, acceptable_values: nil, locality_limit: nil, max_length: nil, min_length: nil, time_limit: nil) ⇒ Object

Some parameter documentations has been truncated, see AcceptanceCriteria for more details.

Specifies objective criteria for acceptance

Parameters:

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

    Specifies the allowed characters as a string

  • acceptable_values (Array<String>) (defaults to: nil) —

    Specifies the list of strictly possible values for the requirement. Ignored when

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

    Specifies geography-based acceptance criteria

  • max_length (Integer) (defaults to: nil) —

    Maximum length allowed for the value

  • min_length (Integer) (defaults to: nil) —

    Minimum length allowed for the value

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

    Specifies time-based acceptance criteria




# File 'lib/telnyx/models/doc_reqs_requirement_type.rb', line 62

Instance Attribute Details

#acceptance_criteria ⇒ Telnyx::Models::DocReqsRequirementType::AcceptanceCriteria?

Specifies objective criteria for acceptance

Returns:



10
 
# File 'lib/telnyx/models/doc_reqs_requirement_type.rb', line 10

optional :acceptance_criteria, -> { Telnyx::DocReqsRequirementType::AcceptanceCriteria }

#created_at ⇒ String? (readonly)

Returns the value of attribute created_at.

Returns:

  • (String, nil) 


41
42
43
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 41

def created_at
  @created_at
end

#description ⇒ String?

Describes the requirement type

Parameters:

  • (String)

Returns:

  • (String, nil) 


16
 
# File 'lib/telnyx/models/doc_reqs_requirement_type.rb', line 16

optional :description, String

#example ⇒ String?

Provides one or more examples of acceptable documents

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :example, String

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


37
38
39
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 37

def id
  @id
end

#name ⇒ String? (readonly)

Returns the value of attribute name.

Returns:

  • (String, nil) 


45
46
47
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 45

def name
  @name
end

#record_type ⇒ String? (readonly)

Returns the value of attribute record_type.

Returns:

  • (String, nil) 


49
50
51
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 49

def record_type
  @record_type
end

#type ⇒ Symbol, ...

Defines the type of this requirement type

Returns:



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

optional :type, enum: -> { Telnyx::DocReqsRequirementType::Type }

#updated_at ⇒ String? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (String, nil) 


53
54
55
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 53

def updated_at
  @updated_at
end

Instance Method Details

#created_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


43
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 43

def created_at=: (String) -> String

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


39
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 39

def id=: (String) -> String

#name= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


47
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 47

def name=: (String) -> String

#record_type= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


51
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 51

def record_type=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


69
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 69

def to_hash: -> {

#updated_at= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


55
 
# File 'sig/telnyx/models/doc_reqs_requirement_type.rbs', line 55

def updated_at=: (String) -> String