Class: Brevo::RequestContactImport

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestContactImport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
 
# File 'lib/brevo/models/request_contact_import.rb', line 85

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

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

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

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

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

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

  if attributes.has_key?(:'emailBlacklist')
    self.email_blacklist = attributes[:'emailBlacklist']
  else
    self.email_blacklist = false
  end

  if attributes.has_key?(:'disableNotification')
    self.disable_notification = attributes[:'disableNotification']
  else
    self.disable_notification = false
  end

  if attributes.has_key?(:'smsBlacklist')
    self.sms_blacklist = attributes[:'smsBlacklist']
  else
    self.sms_blacklist = false
  end

  if attributes.has_key?(:'updateExistingContacts')
    self.update_existing_contacts = attributes[:'updateExistingContacts']
  else
    self.update_existing_contacts = true
  end

  if attributes.has_key?(:'emptyContactsAttributes')
    self.empty_contacts_attributes = attributes[:'emptyContactsAttributes']
  else
    self.empty_contacts_attributes = false
  end
end

Instance Attribute Details

#disable_notification ⇒ Object

To disable email notification



38
39
40
 
# File 'lib/brevo/models/request_contact_import.rb', line 38

def disable_notification
  @disable_notification
end

#email_blacklist ⇒ Object

To blacklist all the contacts for email



35
36
37
 
# File 'lib/brevo/models/request_contact_import.rb', line 35

def email_blacklist
  @email_blacklist
end

#empty_contacts_attributes ⇒ Object

To facilitate the choice to erase any attribute of the existing contacts with empty value. emptyContactsAttributes = true means the empty fields in your import will erase any attribute that currently contain data in Brevo, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if ‘updateExistingContacts` set to true )



47
48
49
 
# File 'lib/brevo/models/request_contact_import.rb', line 47

def empty_contacts_attributes
  @empty_contacts_attributes
end

#file_body ⇒ Object

Mandatory if fileUrl and jsonBody is not defined. CSV content to be imported. Use semicolon to separate multiple attributes. Maximum allowed file body size is 10MB . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of file body size while parsing. Please use fileUrl instead to import bigger files.



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

def file_body
  @file_body
end

#file_url ⇒ Object

Mandatory if fileBody or jsonBody is not defined. URL of the file to be imported (no local file). Possible file formats: .txt, .csv, .json



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

def file_url
  @file_url
end

#json_body ⇒ Object

**Mandatory if fileUrl and fileBody is not defined.** JSON content to be imported. **Maximum allowed json body size is 10MB** . However we recommend a safe limit of around 8 MB to avoid the issues caused due to increase of json body size while parsing. Please use fileUrl instead to import bigger files.



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

def json_body
  @json_body
end

#list_ids ⇒ Object

Mandatory if newList is not defined. Ids of the lists in which the contacts shall be imported. For example, [2, 4, 7].



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

def list_ids
  @list_ids
end

#new_list ⇒ Object

Returns the value of attribute new_list.



32
33
34
 
# File 'lib/brevo/models/request_contact_import.rb', line 32

def new_list
  @new_list
end

#notify_url ⇒ Object

URL that will be called once the import process is finished. For reference, help.brevo.com/hc/en-us/articles/360007666479



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

def notify_url
  @notify_url
end

#sms_blacklist ⇒ Object

To blacklist all the contacts for sms



41
42
43
 
# File 'lib/brevo/models/request_contact_import.rb', line 41

def sms_blacklist
  @sms_blacklist
end

#update_existing_contacts ⇒ Object

To facilitate the choice to update the existing contacts



44
45
46
 
# File 'lib/brevo/models/request_contact_import.rb', line 44

def update_existing_contacts
  @update_existing_contacts
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'file_url' => :'fileUrl',
    :'file_body' => :'fileBody',
    :'json_body' => :'jsonBody',
    :'list_ids' => :'listIds',
    :'notify_url' => :'notifyUrl',
    :'new_list' => :'newList',
    :'email_blacklist' => :'emailBlacklist',
    :'disable_notification' => :'disableNotification',
    :'sms_blacklist' => :'smsBlacklist',
    :'update_existing_contacts' => :'updateExistingContacts',
    :'empty_contacts_attributes' => :'emptyContactsAttributes'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/brevo/models/request_contact_import.rb', line 67

def self.swagger_types
  {
    :'file_url' => :'String',
    :'file_body' => :'String',
    :'json_body' => :'Array<RequestContactImportJsonBody>',
    :'list_ids' => :'Array<Integer>',
    :'notify_url' => :'String',
    :'new_list' => :'RequestContactImportNewList',
    :'email_blacklist' => :'BOOLEAN',
    :'disable_notification' => :'BOOLEAN',
    :'sms_blacklist' => :'BOOLEAN',
    :'update_existing_contacts' => :'BOOLEAN',
    :'empty_contacts_attributes' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/brevo/models/request_contact_import.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_url == o.file_url &&
      file_body == o.file_body &&
      json_body == o.json_body &&
      list_ids == o.list_ids &&
      notify_url == o.notify_url &&
      new_list == o.new_list &&
      email_blacklist == o.email_blacklist &&
      disable_notification == o.disable_notification &&
      sms_blacklist == o.sms_blacklist &&
      update_existing_contacts == o.update_existing_contacts &&
      empty_contacts_attributes == o.empty_contacts_attributes
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



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
250
251
252
253
 
# File 'lib/brevo/models/request_contact_import.rb', line 217

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/brevo/models/request_contact_import.rb', line 283

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/brevo/models/request_contact_import.rb', line 196

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


183
184
185
 
# File 'lib/brevo/models/request_contact_import.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/brevo/models/request_contact_import.rb', line 189

def hash
  [file_url, file_body, json_body, list_ids, notify_url, new_list, email_blacklist, disable_notification, sms_blacklist, update_existing_contacts, empty_contacts_attributes].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



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

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



263
264
265
 
# File 'lib/brevo/models/request_contact_import.rb', line 263

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



269
270
271
272
273
274
275
276
277
 
# File 'lib/brevo/models/request_contact_import.rb', line 269

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



257
258
259
 
# File 'lib/brevo/models/request_contact_import.rb', line 257

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



159
160
161
 
# File 'lib/brevo/models/request_contact_import.rb', line 159

def valid?
  true
end