Class: UltracartClient::EmailDomain

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/email_domain.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailDomain

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ultracart_api/models/email_domain.rb', line 83

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'comment')
    self.comment = attributes[:'comment']
  end

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

  if attributes.has_key?(:'dkim_status')
    self.dkim_status = attributes[:'dkim_status']
  end

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

  if attributes.has_key?(:'esp_domain_uuid')
    self.esp_domain_uuid = attributes[:'esp_domain_uuid']
  end

  if attributes.has_key?(:'identity_status')
    self.identity_status = attributes[:'identity_status']
  end

  if attributes.has_key?(:'mailgun')
    self.mailgun = attributes[:'mailgun']
  end

  if attributes.has_key?(:'merchant_id')
    self.merchant_id = attributes[:'merchant_id']
  end

  if attributes.has_key?(:'provider')
    self.provider = attributes[:'provider']
  end

  if attributes.has_key?(:'spf')
    self.spf = attributes[:'spf']
  end

  if attributes.has_key?(:'start_dkim_dts')
    self.start_dkim_dts = attributes[:'start_dkim_dts']
  end

  if attributes.has_key?(:'start_identity_dts')
    self.start_identity_dts = attributes[:'start_identity_dts']
  end

  if attributes.has_key?(:'verification')
    self.verification = attributes[:'verification']
  end
end

Instance Attribute Details

#comment ⇒ Object

Returns the value of attribute comment.



17
18
19
 
# File 'lib/ultracart_api/models/email_domain.rb', line 17

def comment
  @comment
end

#dkim ⇒ Object

Returns the value of attribute dkim.



19
20
21
 
# File 'lib/ultracart_api/models/email_domain.rb', line 19

def dkim
  @dkim
end

#dkim_status ⇒ Object

Returns the value of attribute dkim_status.



21
22
23
 
# File 'lib/ultracart_api/models/email_domain.rb', line 21

def dkim_status
  @dkim_status
end

#domain ⇒ Object

Returns the value of attribute domain.



23
24
25
 
# File 'lib/ultracart_api/models/email_domain.rb', line 23

def domain
  @domain
end

#esp_domain_uuid ⇒ Object

Returns the value of attribute esp_domain_uuid.



25
26
27
 
# File 'lib/ultracart_api/models/email_domain.rb', line 25

def esp_domain_uuid
  @esp_domain_uuid
end

#identity_status ⇒ Object

Returns the value of attribute identity_status.



27
28
29
 
# File 'lib/ultracart_api/models/email_domain.rb', line 27

def identity_status
  @identity_status
end

#mailgun ⇒ Object

Returns the value of attribute mailgun.



29
30
31
 
# File 'lib/ultracart_api/models/email_domain.rb', line 29

def mailgun
  @mailgun
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



31
32
33
 
# File 'lib/ultracart_api/models/email_domain.rb', line 31

def merchant_id
  @merchant_id
end

#provider ⇒ Object

Returns the value of attribute provider.



33
34
35
 
# File 'lib/ultracart_api/models/email_domain.rb', line 33

def provider
  @provider
end

#spf ⇒ Object

Returns the value of attribute spf.



35
36
37
 
# File 'lib/ultracart_api/models/email_domain.rb', line 35

def spf
  @spf
end

#start_dkim_dts ⇒ Object

Returns the value of attribute start_dkim_dts.



37
38
39
 
# File 'lib/ultracart_api/models/email_domain.rb', line 37

def start_dkim_dts
  @start_dkim_dts
end

#start_identity_dts ⇒ Object

Returns the value of attribute start_identity_dts.



39
40
41
 
# File 'lib/ultracart_api/models/email_domain.rb', line 39

def start_identity_dts
  @start_identity_dts
end

#verification ⇒ Object

Returns the value of attribute verification.



41
42
43
 
# File 'lib/ultracart_api/models/email_domain.rb', line 41

def verification
  @verification
end

Class Method Details

.attribute_map ⇒ Object

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



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/ultracart_api/models/email_domain.rb', line 44

def self.attribute_map
  {
    :'comment' => :'comment',
    :'dkim' => :'dkim',
    :'dkim_status' => :'dkim_status',
    :'domain' => :'domain',
    :'esp_domain_uuid' => :'esp_domain_uuid',
    :'identity_status' => :'identity_status',
    :'mailgun' => :'mailgun',
    :'merchant_id' => :'merchant_id',
    :'provider' => :'provider',
    :'spf' => :'spf',
    :'start_dkim_dts' => :'start_dkim_dts',
    :'start_identity_dts' => :'start_identity_dts',
    :'verification' => :'verification'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/ultracart_api/models/email_domain.rb', line 63

def self.swagger_types
  {
    :'comment' => :'String',
    :'dkim' => :'Array<VerificationRecord>',
    :'dkim_status' => :'String',
    :'domain' => :'String',
    :'esp_domain_uuid' => :'String',
    :'identity_status' => :'String',
    :'mailgun' => :'Mailgun',
    :'merchant_id' => :'String',
    :'provider' => :'String',
    :'spf' => :'VerificationRecord',
    :'start_dkim_dts' => :'String',
    :'start_identity_dts' => :'String',
    :'verification' => :'VerificationRecord'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/ultracart_api/models/email_domain.rb', line 159

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comment == o.comment &&
      dkim == o.dkim &&
      dkim_status == o.dkim_status &&
      domain == o.domain &&
      esp_domain_uuid == o.esp_domain_uuid &&
      identity_status == o.identity_status &&
      mailgun == o.mailgun &&
      merchant_id == o.merchant_id &&
      provider == o.provider &&
      spf == o.spf &&
      start_dkim_dts == o.start_dkim_dts &&
      start_identity_dts == o.start_identity_dts &&
      verification == o.verification
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



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
243
244
245
246
247
248
249
 
# File 'lib/ultracart_api/models/email_domain.rb', line 213

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
    temp_model = UltracartClient.const_get(type).new
    temp_model.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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/ultracart_api/models/email_domain.rb', line 279

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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/ultracart_api/models/email_domain.rb', line 192

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_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


179
180
181
 
# File 'lib/ultracart_api/models/email_domain.rb', line 179

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



185
186
187
 
# File 'lib/ultracart_api/models/email_domain.rb', line 185

def hash
  [comment, dkim, dkim_status, domain, esp_domain_uuid, identity_status, mailgun, merchant_id, provider, spf, start_dkim_dts, start_identity_dts, verification].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



146
147
148
149
 
# File 'lib/ultracart_api/models/email_domain.rb', line 146

def list_invalid_properties
  invalid_properties = Array.new
  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



259
260
261
 
# File 'lib/ultracart_api/models/email_domain.rb', line 259

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



265
266
267
268
269
270
271
272
273
 
# File 'lib/ultracart_api/models/email_domain.rb', line 265

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



253
254
255
 
# File 'lib/ultracart_api/models/email_domain.rb', line 253

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



153
154
155
 
# File 'lib/ultracart_api/models/email_domain.rb', line 153

def valid?
  true
end