Class: OryClient::DomainVerificationStatus

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/domain_verification_status.rb

Overview

DomainVerificationStatus reports the verification state of a single organization domain and the DNS TXT record needed to prove control of it.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ DomainVerificationStatus

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::DomainVerificationStatus` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::DomainVerificationStatus`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'domain')
    self.domain = attributes[:'domain']
  else
    self.domain = nil
  end

  if attributes.key?(:'exempt')
    self.exempt = attributes[:'exempt']
  else
    self.exempt = nil
  end

  if attributes.key?(:'method')
    self.method = attributes[:'method']
  end

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'txt_record_name')
    self.txt_record_name = attributes[:'txt_record_name']
  else
    self.txt_record_name = nil
  end

  if attributes.key?(:'txt_record_value')
    self.txt_record_value = attributes[:'txt_record_value']
  end
end

Instance Attribute Details

#domain ⇒ Object

The domain being verified.



20
21
22
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 20

def domain
  @domain
end

#exempt ⇒ Object

Whether the domain predates domain verification and is trusted for SSO without a published DNS TXT record. Such a domain keeps routing sign-ins while its owner publishes the record; the exemption is temporary, so the Console asks the owner to verify.



23
24
25
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 23

def exempt
  @exempt
end

#method ⇒ Object

The verification method. Currently always "dns-txt". Empty when no verification has been started for the domain yet. DomainVerificationMethodNone dns-txt DomainVerificationMethodDNSTXT



26
27
28
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 26

def method
  @method
end

#status ⇒ Object

The verification status: one of "pending", "verified", or "failed". Empty when no verification has been started for the domain yet. DomainVerificationStateNone pending DomainVerificationStatePending verified DomainVerificationStateVerified failed DomainVerificationStateFailed



29
30
31
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 29

def status
  @status
end

#txt_record_name ⇒ Object

The name of the DNS TXT record the customer must publish, for example "_ory-domain-verification.example.com".



32
33
34
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 32

def txt_record_name
  @txt_record_name
end

#txt_record_value ⇒ Object

The value of the DNS TXT record the customer must publish. Empty when no verification has been started for the domain yet.



35
36
37
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 35

def txt_record_value
  @txt_record_value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



72
73
74
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 72

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



77
78
79
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 77

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 60

def self.attribute_map
  {
    :'domain' => :'domain',
    :'exempt' => :'exempt',
    :'method' => :'method',
    :'status' => :'status',
    :'txt_record_name' => :'txt_record_name',
    :'txt_record_value' => :'txt_record_value'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 258

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



94
95
96
97
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 94

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 82

def self.openapi_types
  {
    :'domain' => :'String',
    :'exempt' => :'Boolean',
    :'method' => :'String',
    :'status' => :'String',
    :'txt_record_name' => :'String',
    :'txt_record_value' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 232

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      domain == o.domain &&
      exempt == o.exempt &&
      method == o.method &&
      status == o.status &&
      txt_record_name == o.txt_record_name &&
      txt_record_value == o.txt_record_value
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 251

def hash
  [domain, exempt, method, status, txt_record_name, txt_record_value].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 148

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @domain.nil?
    invalid_properties.push('invalid value for "domain", domain cannot be nil.')
  end

  if @exempt.nil?
    invalid_properties.push('invalid value for "exempt", exempt cannot be nil.')
  end

  if @txt_record_name.nil?
    invalid_properties.push('invalid value for "txt_record_name", txt_record_name cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 280

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/ory-client/models/domain_verification_status.rb', line 168

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @domain.nil?
  return false if @exempt.nil?
  method_validator = EnumAttributeValidator.new('String', ["", "dns-txt"])
  return false unless method_validator.valid?(@method)
  status_validator = EnumAttributeValidator.new('String', ["", "pending", "verified", "failed"])
  return false unless status_validator.valid?(@status)
  return false if @txt_record_name.nil?
  true
end