Class: MailSlurpClient::DomainDto

Inherits:
Object
  • Object
show all
Defined in:
lib/mailslurp_client/models/domain_dto.rb

Overview

Domain plus verification records and status

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainDto

Initializes the object

Parameters:

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

    Model attributes in the form of hash



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 123

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

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

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

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

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

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

  if attributes.key?(:'dkim_tokens')
    if (value = attributes[:'dkim_tokens']).is_a?(Array)
      self.dkim_tokens = value
    end
  end

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

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

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

  if attributes.key?(:'domain_name_records')
    if (value = attributes[:'domain_name_records']).is_a?(Array)
      self.domain_name_records = value
    end
  end

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

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

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

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

Instance Attribute Details

#catch_all_inbox_id ⇒ Object

The optional catch all inbox that will receive emails sent to the domain that cannot be matched.



44
45
46
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 44

def catch_all_inbox_id
  @catch_all_inbox_id
end

#created_at ⇒ Object

Returns the value of attribute created_at.



46
47
48
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 46

def created_at
  @created_at
end

#dkim_tokens ⇒ Object

Unique token DKIM tokens



29
30
31
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 29

def dkim_tokens
  @dkim_tokens
end

#domain ⇒ Object

Custom domain name



23
24
25
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 23

def domain
  @domain
end

#domain_name_records ⇒ Object

List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.



41
42
43
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 41

def domain_name_records
  @domain_name_records
end

#domain_type ⇒ Object

Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.



51
52
53
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 51

def domain_type
  @domain_type
end

#has_missing_records ⇒ Object

Whether the domain has missing required records. If true then see the domain in the dashboard app.



35
36
37
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 35

def has_missing_records
  @has_missing_records
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 18

def id
  @id
end

#is_verified ⇒ Object

Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.



38
39
40
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 38

def is_verified
  @is_verified
end

#missing_records_message ⇒ Object

If the domain is missing records then show which pairs are missing.



32
33
34
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 32

def missing_records_message
  @missing_records_message
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



48
49
50
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 48

def updated_at
  @updated_at
end

#user_id ⇒ Object

Returns the value of attribute user_id.



20
21
22
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 20

def user_id
  @user_id
end

#verification_token ⇒ Object

Verification tokens



26
27
28
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 26

def verification_token
  @verification_token
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 76

def self.attribute_map
  {
    :'id' => :'id',
    :'user_id' => :'userId',
    :'domain' => :'domain',
    :'verification_token' => :'verificationToken',
    :'dkim_tokens' => :'dkimTokens',
    :'missing_records_message' => :'missingRecordsMessage',
    :'has_missing_records' => :'hasMissingRecords',
    :'is_verified' => :'isVerified',
    :'domain_name_records' => :'domainNameRecords',
    :'catch_all_inbox_id' => :'catchAllInboxId',
    :'created_at' => :'createdAt',
    :'updated_at' => :'updatedAt',
    :'domain_type' => :'domainType'
  }
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



308
309
310
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 308

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
118
119
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 114

def self.openapi_nullable
  Set.new([
    :'missing_records_message',
    :'catch_all_inbox_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 95

def self.openapi_types
  {
    :'id' => :'String',
    :'user_id' => :'String',
    :'domain' => :'String',
    :'verification_token' => :'String',
    :'dkim_tokens' => :'Array<String>',
    :'missing_records_message' => :'String',
    :'has_missing_records' => :'Boolean',
    :'is_verified' => :'Boolean',
    :'domain_name_records' => :'Array<DomainNameRecord>',
    :'catch_all_inbox_id' => :'String',
    :'created_at' => :'DateTime',
    :'updated_at' => :'DateTime',
    :'domain_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      user_id == o.user_id &&
      domain == o.domain &&
      verification_token == o.verification_token &&
      dkim_tokens == o.dkim_tokens &&
      missing_records_message == o.missing_records_message &&
      has_missing_records == o.has_missing_records &&
      is_verified == o.is_verified &&
      domain_name_records == o.domain_name_records &&
      catch_all_inbox_id == o.catch_all_inbox_id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      domain_type == o.domain_type
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 336

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    MailSlurpClient.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 405

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 315

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


295
296
297
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 295

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



301
302
303
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 301

def hash
  [id, user_id, domain, verification_token, dkim_tokens, missing_records_message, has_missing_records, is_verified, domain_name_records, catch_all_inbox_id, created_at, updated_at, domain_type].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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 195

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



381
382
383
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 381

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 387

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



375
376
377
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 375

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/mailslurp_client/models/domain_dto.rb', line 246

def valid?
  return false if @id.nil?
  return false if @user_id.nil?
  return false if @domain.nil?
  return false if @verification_token.nil?
  return false if @dkim_tokens.nil?
  return false if @has_missing_records.nil?
  return false if @is_verified.nil?
  return false if @domain_name_records.nil?
  return false if @created_at.nil?
  return false if @updated_at.nil?
  return false if @domain_type.nil?
  domain_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
  return false unless domain_type_validator.valid?(@domain_type)
  true
end