Class: BrevoRuby::UpdateBatchContactsContacts

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/update_batch_contacts_contacts.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateBatchContactsContacts

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
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
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 81

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?(:'email')
    self.email = attributes[:'email']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#attributes ⇒ Object

Pass the set of attributes to be updated. **These attributes must be present in your account**. To update existing email address of a contact with the new one please pass EMAIL in attribtes. For example, **{ "EMAIL":"[email protected]", "FNAME":"Ellie", "LNAME":"Roger"}**. Keep in mind transactional attributes can be updated the same way as normal attributes. Mobile Number in SMS field should be passed with proper country code. For example: **"SMS":"+91xxxxxxxxxx" or "SMS":"0091xxxxxxxxxx"**



30
31
32
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 30

def attributes
  @attributes
end

#email ⇒ Object

Email address of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)



18
19
20
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 18

def email
  @email
end

#email_blacklisted ⇒ Object

Set/unset this field to blacklist/allow the contact for emails (emailBlacklisted = true)



33
34
35
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 33

def email_blacklisted
  @email_blacklisted
end

#ext_id ⇒ Object

Pass your own Id to update ext_id of a contact.



27
28
29
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 27

def ext_id
  @ext_id
end

#id ⇒ Object

id of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)



21
22
23
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 21

def id
  @id
end

#list_ids ⇒ Object

Ids of the lists to add the contact to



39
40
41
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 39

def list_ids
  @list_ids
end

#sms ⇒ Object

SMS of the user to be updated (For each operation only pass one of the supported contact identifiers. Email, id or sms)



24
25
26
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 24

def sms
  @sms
end

#sms_blacklisted ⇒ Object

Set/unset this field to blacklist/allow the contact for SMS (smsBlacklisted = true)



36
37
38
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 36

def sms_blacklisted
  @sms_blacklisted
end

#smtp_blacklist_sender ⇒ Object

transactional email forbidden sender for contact. Use only for email Contact



45
46
47
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 45

def smtp_blacklist_sender
  @smtp_blacklist_sender
end

#unlink_list_ids ⇒ Object

Ids of the lists to remove the contact from



42
43
44
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 42

def unlink_list_ids
  @unlink_list_ids
end

Class Method Details

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 48

def self.attribute_map
  {
    :'email' => :'email',
    :'id' => :'id',
    :'sms' => :'sms',
    :'ext_id' => :'ext_id',
    :'attributes' => :'attributes',
    :'email_blacklisted' => :'emailBlacklisted',
    :'sms_blacklisted' => :'smsBlacklisted',
    :'list_ids' => :'listIds',
    :'unlink_list_ids' => :'unlinkListIds',
    :'smtp_blacklist_sender' => :'smtpBlacklistSender'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 64

def self.swagger_types
  {
    :'email' => :'String',
    :'id' => :'Integer',
    :'sms' => :'String',
    :'ext_id' => :'String',
    :'attributes' => :'Hash<String, Object>',
    :'email_blacklisted' => :'BOOLEAN',
    :'sms_blacklisted' => :'BOOLEAN',
    :'list_ids' => :'Array<Integer>',
    :'unlink_list_ids' => :'Array<Integer>',
    :'smtp_blacklist_sender' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 151

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      id == o.id &&
      sms == o.sms &&
      ext_id == o.ext_id &&
      attributes == o.attributes &&
      email_blacklisted == o.email_blacklisted &&
      sms_blacklisted == o.sms_blacklisted &&
      list_ids == o.list_ids &&
      unlink_list_ids == o.unlink_list_ids &&
      smtp_blacklist_sender == o.smtp_blacklist_sender
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



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
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 202

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 = BrevoRuby.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



268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 268

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



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 181

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


168
169
170
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



174
175
176
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 174

def hash
  [email, id, sms, ext_id, attributes, email_blacklisted, sms_blacklisted, list_ids, unlink_list_ids, smtp_blacklist_sender].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



138
139
140
141
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 138

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



248
249
250
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 248

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



254
255
256
257
258
259
260
261
262
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 254

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



242
243
244
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 242

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



145
146
147
 
# File 'lib/brevo-ruby/models/update_batch_contacts_contacts.rb', line 145

def valid?
  true
end