Class: Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data

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

Defined Under Namespace

Classes: RegionInformation, RegulatoryRequirement

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(region_name: nil, region_type: nil) ⇒ Object

Parameters:

  • region_name (String) (defaults to: nil)
  • region_type (String) (defaults to: nil) 


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
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
141
142
143
144
145
146
 
# File 'lib/telnyx/models/phone_numbers_regulatory_requirement_retrieve_response.rb', line 22

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute region_information
  #
  #   @return [Array<Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegionInformation>, nil]
  optional :region_information,
           -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegionInformation] }

  # @!attribute regulatory_requirements
  #
  #   @return [Array<Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement>, nil]
  optional :regulatory_requirements,
           -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement] }

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

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

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

  # @!method initialize(phone_number: nil, phone_number_type: nil, record_type: nil, region_information: nil, regulatory_requirements: nil)
  #   @param phone_number [String]
  #   @param phone_number_type [String]
  #   @param record_type [String]
  #   @param region_information [Array<Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegionInformation>]
  #   @param regulatory_requirements [Array<Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement>]

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

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

    # @!method initialize(region_name: nil, region_type: nil)
    #   @param region_name [String]
    #   @param region_type [String]
  end

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

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

    # @!attribute label
    #
    #   @return [String, nil]
    optional :label, 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

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

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

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

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

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

      # @!method initialize(field_type: nil, field_value: nil, locality_limit: nil)
      #   @param field_type [String]
      #   @param field_value [String]
      #   @param locality_limit [String]
    end
  end
end

Instance Attribute Details

#region_information ⇒ Array<Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegionInformation>?

Returns:



26
27
 
# File 'lib/telnyx/models/phone_numbers_regulatory_requirement_retrieve_response.rb', line 26

optional :region_information,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegionInformation] }

#regulatory_requirements ⇒ Array<Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement>?

Returns:



32
33
 
# File 'lib/telnyx/models/phone_numbers_regulatory_requirement_retrieve_response.rb', line 32

optional :regulatory_requirements,
-> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::PhoneNumbersRegulatoryRequirementRetrieveResponse::Data::RegulatoryRequirement] }