Class: SibApiV3Sdk::RequestContactExport

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/request_contact_export.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestContactExport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 45

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?(:'exportAttributes')
    if (value = attributes[:'exportAttributes']).is_a?(Array)
      self.export_attributes = value
    end
  end

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

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

Instance Attribute Details

#custom_contact_filter ⇒ Object

Returns the value of attribute custom_contact_filter.



20
21
22
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 20

def custom_contact_filter
  @custom_contact_filter
end

#export_attributes ⇒ Object

List of all the attributes that you want to export. These attributes must be present in your contact database. For example, [‘fname’, ‘lname’, ‘email’].



18
19
20
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 18

def export_attributes
  @export_attributes
end

#notify_url ⇒ Object

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



23
24
25
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 23

def notify_url
  @notify_url
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 26

def self.attribute_map
  {
    :'export_attributes' => :'exportAttributes',
    :'custom_contact_filter' => :'customContactFilter',
    :'notify_url' => :'notifyUrl'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 35

def self.swagger_types
  {
    :'export_attributes' => :'Array<String>',
    :'custom_contact_filter' => :'RequestContactExportCustomContactFilter',
    :'notify_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



86
87
88
89
90
91
92
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 86

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      export_attributes == o.export_attributes &&
      custom_contact_filter == o.custom_contact_filter &&
      notify_url == o.notify_url
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



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
160
161
162
163
164
165
166
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 130

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) ⇒ 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



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 196

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 109

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


96
97
98
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 96

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



102
103
104
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 102

def hash
  [export_attributes, custom_contact_filter, notify_url].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



68
69
70
71
72
73
74
75
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 68

def list_invalid_properties
  invalid_properties = Array.new
  if @custom_contact_filter.nil?
    invalid_properties.push('invalid value for "custom_contact_filter", custom_contact_filter cannot be nil.')
  end

  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



176
177
178
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 176

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



182
183
184
185
186
187
188
189
190
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 182

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



170
171
172
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 170

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



79
80
81
82
 
# File 'lib/sib-api-v3-sdk/models/request_contact_export.rb', line 79

def valid?
  return false if @custom_contact_filter.nil?
  true
end