Class: ElasticEmail::Contact

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/models/contact.rb

Overview

Contact

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Contact

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/ElasticEmail/models/contact.rb', line 97

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

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

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

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

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

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

  if attributes.key?(:'source')
    self.source = attributes[:'source']
  else
    self.source = 'DeliveryApi'
  end

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

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

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

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

Instance Attribute Details

#activity ⇒ Object

Returns the value of attribute activity.



46
47
48
 
# File 'lib/ElasticEmail/models/contact.rb', line 46

def activity
  @activity
end

#consent ⇒ Object

Returns the value of attribute consent.



33
34
35
 
# File 'lib/ElasticEmail/models/contact.rb', line 33

def consent
  @consent
end

#custom_fields ⇒ Object

A key-value collection of custom contact fields which can be used in the system.



31
32
33
 
# File 'lib/ElasticEmail/models/contact.rb', line 31

def custom_fields
  @custom_fields
end

#date_added ⇒ Object

Date of creation in YYYY-MM-DDThh:ii:ss format



38
39
40
 
# File 'lib/ElasticEmail/models/contact.rb', line 38

def date_added
  @date_added
end

#date_updated ⇒ Object

Last change date



41
42
43
 
# File 'lib/ElasticEmail/models/contact.rb', line 41

def date_updated
  @date_updated
end

#email ⇒ Object

Proper email address.



20
21
22
 
# File 'lib/ElasticEmail/models/contact.rb', line 20

def email
  @email
end

#first_name ⇒ Object

First name.



25
26
27
 
# File 'lib/ElasticEmail/models/contact.rb', line 25

def first_name
  @first_name
end

#last_name ⇒ Object

Last name.



28
29
30
 
# File 'lib/ElasticEmail/models/contact.rb', line 28

def last_name
  @last_name
end

#source ⇒ Object

Returns the value of attribute source.



35
36
37
 
# File 'lib/ElasticEmail/models/contact.rb', line 35

def source
  @source
end

#status ⇒ Object

Returns the value of attribute status.



22
23
24
 
# File 'lib/ElasticEmail/models/contact.rb', line 22

def status
  @status
end

#status_change_date ⇒ Object

Date of last status change.



44
45
46
 
# File 'lib/ElasticEmail/models/contact.rb', line 44

def status_change_date
  @status_change_date
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/ElasticEmail/models/contact.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/ElasticEmail/models/contact.rb', line 49

def self.attribute_map
  {
    :'email' => :'Email',
    :'status' => :'Status',
    :'first_name' => :'FirstName',
    :'last_name' => :'LastName',
    :'custom_fields' => :'CustomFields',
    :'consent' => :'Consent',
    :'source' => :'Source',
    :'date_added' => :'DateAdded',
    :'date_updated' => :'DateUpdated',
    :'status_change_date' => :'StatusChangeDate',
    :'activity' => :'Activity'
  }
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



207
208
209
 
# File 'lib/ElasticEmail/models/contact.rb', line 207

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
92
93
 
# File 'lib/ElasticEmail/models/contact.rb', line 88

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

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/ElasticEmail/models/contact.rb', line 71

def self.openapi_types
  {
    :'email' => :'String',
    :'status' => :'ContactStatus',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'custom_fields' => :'Hash<String, String>',
    :'consent' => :'ConsentData',
    :'source' => :'ContactSource',
    :'date_added' => :'Time',
    :'date_updated' => :'Time',
    :'status_change_date' => :'Time',
    :'activity' => :'ContactActivity'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/ElasticEmail/models/contact.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      status == o.status &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      custom_fields == o.custom_fields &&
      consent == o.consent &&
      source == o.source &&
      date_added == o.date_added &&
      date_updated == o.date_updated &&
      status_change_date == o.status_change_date &&
      activity == o.activity
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



238
239
240
241
242
243
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
 
# File 'lib/ElasticEmail/models/contact.rb', line 238

def _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 = ElasticEmail.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/ElasticEmail/models/contact.rb', line 309

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/ElasticEmail/models/contact.rb', line 214

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


194
195
196
 
# File 'lib/ElasticEmail/models/contact.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/ElasticEmail/models/contact.rb', line 200

def hash
  [email, status, first_name, last_name, custom_fields, consent, source, date_added, date_updated, status_change_date, activity].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



163
164
165
166
 
# File 'lib/ElasticEmail/models/contact.rb', line 163

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



285
286
287
 
# File 'lib/ElasticEmail/models/contact.rb', line 285

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/ElasticEmail/models/contact.rb', line 291

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



279
280
281
 
# File 'lib/ElasticEmail/models/contact.rb', line 279

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



170
171
172
 
# File 'lib/ElasticEmail/models/contact.rb', line 170

def valid?
  true
end