class SibApiV3Sdk::RequestContactImport

Attributes

email_blacklist[RW]

To blacklist all the contacts for email

empty_contacts_attributes[RW]

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 SendinBlue, & emptyContactsAttributes = false means the empty fields will not affect your existing data ( only available if `updateExistingContacts` set to true )

file_body[RW]

Mandatory if fileUrl 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.

file_url[RW]

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

list_ids[RW]

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

new_list[RW]
notify_url[RW]

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

sms_blacklist[RW]

To blacklist all the contacts for sms

update_existing_contacts[RW]

To facilitate the choice to update the existing contacts

Public Class Methods

attribute_map() click to toggle source

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

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 44
def self.attribute_map
  {
    :'file_url' => :'fileUrl',
    :'file_body' => :'fileBody',
    :'list_ids' => :'listIds',
    :'notify_url' => :'notifyUrl',
    :'new_list' => :'newList',
    :'email_blacklist' => :'emailBlacklist',
    :'sms_blacklist' => :'smsBlacklist',
    :'update_existing_contacts' => :'updateExistingContacts',
    :'empty_contacts_attributes' => :'emptyContactsAttributes'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 75
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?(:'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?(:'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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 59
def self.swagger_types
  {
    :'file_url' => :'String',
    :'file_body' => :'String',
    :'list_ids' => :'Array<Integer>',
    :'notify_url' => :'String',
    :'new_list' => :'RequestContactImportNewList',
    :'email_blacklist' => :'BOOLEAN',
    :'sms_blacklist' => :'BOOLEAN',
    :'update_existing_contacts' => :'BOOLEAN',
    :'empty_contacts_attributes' => :'BOOLEAN'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 143
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      file_url == o.file_url &&
      file_body == o.file_body &&
      list_ids == o.list_ids &&
      notify_url == o.notify_url &&
      new_list == o.new_list &&
      email_blacklist == o.email_blacklist &&
      sms_blacklist == o.sms_blacklist &&
      update_existing_contacts == o.update_existing_contacts &&
      empty_contacts_attributes == o.empty_contacts_attributes
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 193
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 = SibApiV3Sdk.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 259
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 172
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 159
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 165
def hash
  [file_url, file_body, list_ids, notify_url, new_list, email_blacklist, sms_blacklist, update_existing_contacts, empty_contacts_attributes].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 130
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 239
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 245
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 233
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/sib-api-v3-sdk/models/request_contact_import.rb, line 137
def valid?
  true
end