Class: Brevo::CreateContact

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/models/create_contact.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateContact

Initializes the object

Parameters:

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

    Model attributes in the form of hash



71
72
73
74
75
76
77
78
79
80
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
 
# File 'lib/brevo/models/create_contact.rb', line 71

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

  if attributes.has_key?(:'attributes')
    self.attributes = attributes[:'attributes']
  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?(:'updateEnabled')
    self.update_enabled = attributes[:'updateEnabled']
  else
    self.update_enabled = false
  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 and their values. The attribute’s parameter should be passed in capital letter while creating a contact. Values that don’t match the attribute type (e.g. text or string in a date attribute) will be ignored.These attributes must be present in your Brevo account. For eg. "LNAME":"Roger"



24
25
26
 
# File 'lib/brevo/models/create_contact.rb', line 24

def attributes
  @attributes
end

#email ⇒ Object

Email address of the user. Mandatory if "SMS" field is not passed in "attributes" parameter. Mobile Number in "SMS" field should be passed with proper country code. For example "SMS":"+91xxxxxxxxxx" or "SMS":"0091xxxxxxxxxx"



18
19
20
 
# File 'lib/brevo/models/create_contact.rb', line 18

def email
  @email
end

#email_blacklisted ⇒ Object

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



27
28
29
 
# File 'lib/brevo/models/create_contact.rb', line 27

def email_blacklisted
  @email_blacklisted
end

#ext_id ⇒ Object

Pass your own Id to create a contact.



21
22
23
 
# File 'lib/brevo/models/create_contact.rb', line 21

def ext_id
  @ext_id
end

#list_ids ⇒ Object

Ids of the lists to add the contact to



33
34
35
 
# File 'lib/brevo/models/create_contact.rb', line 33

def list_ids
  @list_ids
end

#sms_blacklisted ⇒ Object

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



30
31
32
 
# File 'lib/brevo/models/create_contact.rb', line 30

def sms_blacklisted
  @sms_blacklisted
end

#smtp_blacklist_sender ⇒ Object

transactional email forbidden sender for contact. Use only for email Contact ( only available if updateEnabled = true )



39
40
41
 
# File 'lib/brevo/models/create_contact.rb', line 39

def smtp_blacklist_sender
  @smtp_blacklist_sender
end

#update_enabled ⇒ Object

Facilitate to update the existing contact in the same request (updateEnabled = true)



36
37
38
 
# File 'lib/brevo/models/create_contact.rb', line 36

def update_enabled
  @update_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/brevo/models/create_contact.rb', line 42

def self.attribute_map
  {
    :'email' => :'email',
    :'ext_id' => :'ext_id',
    :'attributes' => :'attributes',
    :'email_blacklisted' => :'emailBlacklisted',
    :'sms_blacklisted' => :'smsBlacklisted',
    :'list_ids' => :'listIds',
    :'update_enabled' => :'updateEnabled',
    :'smtp_blacklist_sender' => :'smtpBlacklistSender'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/brevo/models/create_contact.rb', line 131

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



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
 
# File 'lib/brevo/models/create_contact.rb', line 180

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



246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/brevo/models/create_contact.rb', line 246

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



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

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


146
147
148
 
# File 'lib/brevo/models/create_contact.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/brevo/models/create_contact.rb', line 152

def hash
  [email, ext_id, attributes, email_blacklisted, sms_blacklisted, list_ids, update_enabled, 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



118
119
120
121
 
# File 'lib/brevo/models/create_contact.rb', line 118

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



226
227
228
 
# File 'lib/brevo/models/create_contact.rb', line 226

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



232
233
234
235
236
237
238
239
240
 
# File 'lib/brevo/models/create_contact.rb', line 232

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



220
221
222
 
# File 'lib/brevo/models/create_contact.rb', line 220

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



125
126
127
 
# File 'lib/brevo/models/create_contact.rb', line 125

def valid?
  true
end