Class: Telnyx::Models::RegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement

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

Defined Under Namespace

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(id: nil, acceptance_criteria: nil, description: nil, example: nil, field_type: nil, name: nil) ⇒ Object

Parameters:



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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/telnyx/models/regulatory_requirement_retrieve_response.rb', line 46

class RegulatoryRequirement < Telnyx::Internal::Type::BaseModel
  # @!attribute acceptance_criteria
  #
  #   @return [Telnyx::Models::RegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement::AcceptanceCriteria, nil]
  optional :acceptance_criteria,
           -> { Telnyx::Models::RegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement::AcceptanceCriteria }

  # @!attribute field_type
  #
  #   @return [String, nil]
  optional :field_type, String

  # @!attribute name
  #
  #   @return [String, nil]
  optional :name, String

  response_only do
    # @!attribute id
    #
    #   @return [String, nil]
    optional :id, String

    # @!attribute description
    #
    #   @return [String, nil]
    optional :description, String

    # @!attribute example
    #
    #   @return [String, nil]
    optional :example, String
  end

  # @!method initialize(id: nil, acceptance_criteria: nil, description: nil, example: nil, field_type: nil, name: nil)
  #   @param id [String]
  #   @param acceptance_criteria [Telnyx::Models::RegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement::AcceptanceCriteria]
  #   @param description [String]
  #   @param example [String]
  #   @param field_type [String]
  #   @param name [String]

  # @see Telnyx::Models::RegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement#acceptance_criteria
  class AcceptanceCriteria < Telnyx::Internal::Type::BaseModel
    # @!attribute acceptable_characters
    #
    #   @return [String, nil]
    optional :acceptable_characters, String

    # @!attribute acceptable_values
    #
    #   @return [Array<String>, nil]
    optional :acceptable_values, Telnyx::Internal::Type::ArrayOf[String]

    # @!attribute case_sensitive
    #
    #   @return [String, nil]
    optional :case_sensitive, String

    # @!attribute locality_limit
    #
    #   @return [String, nil]
    optional :locality_limit, String

    # @!attribute max_length
    #
    #   @return [String, nil]
    optional :max_length, String

    # @!attribute min_length
    #
    #   @return [String, nil]
    optional :min_length, String

    # @!attribute regex
    #
    #   @return [String, nil]
    optional :regex, String

    # @!attribute time_limit
    #
    #   @return [String, nil]
    optional :time_limit, String

    # @!method initialize(acceptable_characters: nil, acceptable_values: nil, case_sensitive: nil, locality_limit: nil, max_length: nil, min_length: nil, regex: nil, time_limit: nil)
    #   @param acceptable_characters [String]
    #   @param acceptable_values [Array<String>]
    #   @param case_sensitive [String]
    #   @param locality_limit [String]
    #   @param max_length [String]
    #   @param min_length [String]
    #   @param regex [String]
    #   @param time_limit [String]
  end
end

Instance Attribute Details

#acceptance_criteria ⇒ Telnyx::Models::RegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement::AcceptanceCriteria?

Returns:



50
51
 
# File 'lib/telnyx/models/regulatory_requirement_retrieve_response.rb', line 50

optional :acceptance_criteria,
-> { Telnyx::Models::RegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement::AcceptanceCriteria }

#description ⇒ String? (readonly)

Returns the value of attribute description.

Returns:

  • (String, nil) 


93
94
95
 
# File 'sig/telnyx/models/regulatory_requirement_retrieve_response.rbs', line 93

def description
  @description
end

#example ⇒ String? (readonly)

Returns the value of attribute example.

Returns:

  • (String, nil) 


97
98
99
 
# File 'sig/telnyx/models/regulatory_requirement_retrieve_response.rbs', line 97

def example
  @example
end

#field_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


56
 
# File 'lib/telnyx/models/regulatory_requirement_retrieve_response.rb', line 56

optional :field_type, String

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


89
90
91
 
# File 'sig/telnyx/models/regulatory_requirement_retrieve_response.rbs', line 89

def id
  @id
end

#name ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


61
 
# File 'lib/telnyx/models/regulatory_requirement_retrieve_response.rb', line 61

optional :name, String

Instance Method Details

#description= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


95
 
# File 'sig/telnyx/models/regulatory_requirement_retrieve_response.rbs', line 95

def description=: (String) -> String

#example= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


99
 
# File 'sig/telnyx/models/regulatory_requirement_retrieve_response.rbs', line 99

def example=: (String) -> String

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


91
 
# File 'sig/telnyx/models/regulatory_requirement_retrieve_response.rbs', line 91

def id=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


110
 
# File 'sig/telnyx/models/regulatory_requirement_retrieve_response.rbs', line 110

def to_hash: -> {