Class: Sendpost::Domain

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/models/domain.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Domain

Initializes the object



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
192
193
194
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
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 143

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

UNIX epoch timestamp in nanoseconds.



54
55
56
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 54

def created
  @created
end

#dkim ⇒ Object

Returns the value of attribute dkim.



24
25
26
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 24

def dkim
  @dkim
end

#dkim_config ⇒ Object

DKIM configuration



33
34
35
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 33

def dkim_config
  @dkim_config
end

#dkim_failure_reason ⇒ Object

Reason for DKIM verification failure



65
66
67
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 65

def dkim_failure_reason
  @dkim_failure_reason
end

#dkim_verified ⇒ Object

Status of DKIM verification ( true or false )



36
37
38
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 36

def dkim_verified
  @dkim_verified
end

#dmarc ⇒ Object

Returns the value of attribute dmarc.



30
31
32
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 30

def dmarc
  @dmarc
end

#dmarc_failure_reason ⇒ Object

Reason for DMARC verification failure



62
63
64
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 62

def dmarc_failure_reason
  @dmarc_failure_reason
end

#dmarc_verified ⇒ Object

Status of DMARC verification ( true or false)



39
40
41
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 39

def dmarc_verified
  @dmarc_verified
end

#domain_registered_date ⇒ Object

Date when the domain was registered



51
52
53
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 51

def domain_registered_date
  @domain_registered_date
end

#gpt ⇒ Object

Returns the value of attribute gpt.



59
60
61
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 59

def gpt
  @gpt
end

#gpt_verified ⇒ Object

Status of GPT verification ( true or false )



57
58
59
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 57

def gpt_verified
  @gpt_verified
end

#id ⇒ Object

Unique ID for the domain.



19
20
21
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 19

def id
  @id
end

#name ⇒ Object

Name of the domain.



22
23
24
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 22

def name
  @name
end

#return_path ⇒ Object

Returns the value of attribute return_path.



26
27
28
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 26

def return_path
  @return_path
end

#return_path_failure_reason ⇒ Object

Reason for ReturnPath verification failure



71
72
73
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 71

def return_path_failure_reason
  @return_path_failure_reason
end

#return_path_verified ⇒ Object

Status of ReturnPath verification ( true or false )



42
43
44
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 42

def return_path_verified
  @return_path_verified
end

#track ⇒ Object

Returns the value of attribute track.



28
29
30
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 28

def track
  @track
end

#track_failure_reason ⇒ Object

Reason for Track verification failure



68
69
70
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 68

def track_failure_reason
  @track_failure_reason
end

#track_verified ⇒ Object

Status of Track verification ( true or false )



45
46
47
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 45

def track_verified
  @track_verified
end

#verified ⇒ Object

Overall verification status of the domain



48
49
50
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 48

def verified
  @verified
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 319

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Sendpost.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



100
101
102
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 100

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



105
106
107
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 105

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 74

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'dkim' => :'dkim',
    :'return_path' => :'returnPath',
    :'track' => :'track',
    :'dmarc' => :'dmarc',
    :'dkim_config' => :'dkimConfig',
    :'dkim_verified' => :'dkimVerified',
    :'dmarc_verified' => :'dmarcVerified',
    :'return_path_verified' => :'returnPathVerified',
    :'track_verified' => :'trackVerified',
    :'verified' => :'verified',
    :'domain_registered_date' => :'domainRegisteredDate',
    :'created' => :'created',
    :'gpt_verified' => :'gptVerified',
    :'gpt' => :'gpt',
    :'dmarc_failure_reason' => :'dmarcFailureReason',
    :'dkim_failure_reason' => :'dkimFailureReason',
    :'track_failure_reason' => :'trackFailureReason',
    :'return_path_failure_reason' => :'returnPathFailureReason'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 295

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



136
137
138
139
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 136

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

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 110

def self.openapi_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'dkim' => :'DomainDkim',
    :'return_path' => :'DomainReturnPath',
    :'track' => :'DomainTrack',
    :'dmarc' => :'DomainDmarc',
    :'dkim_config' => :'String',
    :'dkim_verified' => :'Boolean',
    :'dmarc_verified' => :'Boolean',
    :'return_path_verified' => :'Boolean',
    :'track_verified' => :'Boolean',
    :'verified' => :'Boolean',
    :'domain_registered_date' => :'String',
    :'created' => :'Integer',
    :'gpt_verified' => :'Boolean',
    :'gpt' => :'DomainGpt',
    :'dmarc_failure_reason' => :'String',
    :'dkim_failure_reason' => :'String',
    :'track_failure_reason' => :'String',
    :'return_path_failure_reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      dkim == o.dkim &&
      return_path == o.return_path &&
      track == o.track &&
      dmarc == o.dmarc &&
      dkim_config == o.dkim_config &&
      dkim_verified == o.dkim_verified &&
      dmarc_verified == o.dmarc_verified &&
      return_path_verified == o.return_path_verified &&
      track_verified == o.track_verified &&
      verified == o.verified &&
      domain_registered_date == o.domain_registered_date &&
      created == o.created &&
      gpt_verified == o.gpt_verified &&
      gpt == o.gpt &&
      dmarc_failure_reason == o.dmarc_failure_reason &&
      dkim_failure_reason == o.dkim_failure_reason &&
      track_failure_reason == o.track_failure_reason &&
      return_path_failure_reason == o.return_path_failure_reason
end

#_to_hash(value) ⇒ Hash

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



390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 390

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


282
283
284
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



288
289
290
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 288

def hash
  [id, name, dkim, return_path, track, dmarc, dkim_config, dkim_verified, dmarc_verified, return_path_verified, track_verified, verified, domain_registered_date, created, gpt_verified, gpt, dmarc_failure_reason, dkim_failure_reason, track_failure_reason, return_path_failure_reason].hash
end

#list_invalid_properties ⇒ Object

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



240
241
242
243
244
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 240

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



366
367
368
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 366

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 372

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



360
361
362
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 360

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



248
249
250
251
 
# File 'lib/sendpost_ruby_sdk/models/domain.rb', line 248

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end