Class: MailSlurpClient::DomainPreview

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

Overview

Preview object for domain entity

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DomainPreview

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 90

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::DomainPreview` 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::DomainPreview`. 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?(:'domain')
    self.domain = attributes[:'domain']
  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?(:'domain_type')
    self.domain_type = attributes[:'domain_type']
  end

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

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

Instance Attribute Details

#catch_all_inbox_id ⇒ Object

Returns the value of attribute catch_all_inbox_id.



22
23
24
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 22

def catch_all_inbox_id
  @catch_all_inbox_id
end

#created_at ⇒ Object

Returns the value of attribute created_at.



24
25
26
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 24

def created_at
  @created_at
end

#domain ⇒ Object

Returns the value of attribute domain.



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

def domain
  @domain
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.



27
28
29
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 27

def domain_type
  @domain_type
end

#has_missing_records ⇒ Object

Returns the value of attribute has_missing_records.



31
32
33
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 31

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_preview.rb', line 18

def id
  @id
end

#is_verified ⇒ Object

Returns the value of attribute is_verified.



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

def is_verified
  @is_verified
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 56

def self.attribute_map
  {
    :'id' => :'id',
    :'domain' => :'domain',
    :'catch_all_inbox_id' => :'catchAllInboxId',
    :'created_at' => :'createdAt',
    :'domain_type' => :'domainType',
    :'is_verified' => :'isVerified',
    :'has_missing_records' => :'hasMissingRecords'
  }
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



216
217
218
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 216

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



82
83
84
85
86
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 82

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 69

def self.openapi_types
  {
    :'id' => :'String',
    :'domain' => :'String',
    :'catch_all_inbox_id' => :'String',
    :'created_at' => :'DateTime',
    :'domain_type' => :'String',
    :'is_verified' => :'Boolean',
    :'has_missing_records' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 189

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      domain == o.domain &&
      catch_all_inbox_id == o.catch_all_inbox_id &&
      created_at == o.created_at &&
      domain_type == o.domain_type &&
      is_verified == o.is_verified &&
      has_missing_records == o.has_missing_records
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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 244

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



313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 313

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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 223

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


203
204
205
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 203

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



209
210
211
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 209

def hash
  [id, domain, catch_all_inbox_id, created_at, domain_type, is_verified, has_missing_records].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



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
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 134

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

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

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

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

  if @is_verified.nil?
    invalid_properties.push('invalid value for "is_verified", is_verified 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

  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



289
290
291
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 295

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



283
284
285
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 283

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



165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/mailslurp_client/models/domain_preview.rb', line 165

def valid?
  return false if @id.nil?
  return false if @domain.nil?
  return false if @created_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)
  return false if @is_verified.nil?
  return false if @has_missing_records.nil?
  true
end