Class: Klaviyo::IdentifyPayloadProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo_sdk/models/identify_payload_properties.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IdentifyPayloadProperties

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Klaviyo::IdentifyPayloadProperties` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Klaviyo::IdentifyPayloadProperties`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'_email')
    self. = attributes[:'_email']
  end

  if attributes.key?(:'_first_name')
    self._first_name = attributes[:'_first_name']
  end

  if attributes.key?(:'_last_name')
    self._last_name = attributes[:'_last_name']
  end

  if attributes.key?(:'_phone_number')
    self._phone_number = attributes[:'_phone_number']
  end

  if attributes.key?(:'_title')
    self._title = attributes[:'_title']
  end

  if attributes.key?(:'_organization')
    self._organization = attributes[:'_organization']
  end

  if attributes.key?(:'_city')
    self._city = attributes[:'_city']
  end

  if attributes.key?(:'_region')
    self._region = attributes[:'_region']
  end

  if attributes.key?(:'_country')
    self._country = attributes[:'_country']
  end

  if attributes.key?(:'_zip')
    self._zip = attributes[:'_zip']
  end

  if attributes.key?(:'image')
    self.image = attributes[:'image']
  end

  if attributes.key?(:'consent')
    self.consent = attributes[:'consent']
  end

  if attributes.key?(:'your_custom_field')
    self.your_custom_field = attributes[:'your_custom_field']
  end
end

Instance Attribute Details

#_city ⇒ Object

Returns the value of attribute _city.



30
31
32
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 30

def _city
  @_city
end

#_country ⇒ Object

Returns the value of attribute _country.



34
35
36
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 34

def _country
  @_country
end

#_email ⇒ Object

Returns the value of attribute _email.



18
19
20
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 18

def 
  @_email
end

#_first_name ⇒ Object

Returns the value of attribute _first_name.



20
21
22
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 20

def _first_name
  @_first_name
end

#_last_name ⇒ Object

Returns the value of attribute _last_name.



22
23
24
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 22

def _last_name
  @_last_name
end

#_organization ⇒ Object

Returns the value of attribute _organization.



28
29
30
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 28

def _organization
  @_organization
end

#_phone_number ⇒ Object

Returns the value of attribute _phone_number.



24
25
26
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 24

def _phone_number
  @_phone_number
end

#_region ⇒ Object

Returns the value of attribute _region.



32
33
34
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 32

def _region
  @_region
end

#_title ⇒ Object

Returns the value of attribute _title.



26
27
28
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 26

def _title
  @_title
end

#_zip ⇒ Object

Returns the value of attribute _zip.



36
37
38
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 36

def _zip
  @_zip
end

#consent ⇒ Object

Returns the value of attribute consent.



40
41
42
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 40

def consent
  @consent
end

#image ⇒ Object

Returns the value of attribute image.



38
39
40
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 38

def image
  @image
end

#your_custom_field ⇒ Object

Returns the value of attribute your_custom_field.



42
43
44
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 42

def your_custom_field
  @your_custom_field
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 45

def self.attribute_map
  {
    :'_email' => :'_$email',
    :'_first_name' => :'_$first_name',
    :'_last_name' => :'_$last_name',
    :'_phone_number' => :'_$phone_number',
    :'_title' => :'_$title',
    :'_organization' => :'_$organization',
    :'_city' => :'_$city',
    :'_region' => :'_$region',
    :'_country' => :'_$country',
    :'_zip' => :'_$zip',
    :'image' => :'$image',
    :'consent' => :'$consent',
    :'your_custom_field' => :'YOUR_CUSTOM_FIELD'
  }
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



210
211
212
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 210

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
92
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 88

def self.openapi_nullable
  Set.new([
    :'your_custom_field'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 69

def self.openapi_types
  {
    :'_email' => :'String',
    :'_first_name' => :'String',
    :'_last_name' => :'String',
    :'_phone_number' => :'String',
    :'_title' => :'String',
    :'_organization' => :'String',
    :'_city' => :'String',
    :'_region' => :'String',
    :'_country' => :'String',
    :'_zip' => :'String',
    :'image' => :'String',
    :'consent' => :'String',
    :'your_custom_field' => :'OneOfstringintegernumberbooleanarray'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      _first_name == o._first_name &&
      _last_name == o._last_name &&
      _phone_number == o._phone_number &&
      _title == o._title &&
      _organization == o._organization &&
      _city == o._city &&
      _region == o._region &&
      _country == o._country &&
      _zip == o._zip &&
      image == o.image &&
      consent == o.consent &&
      your_custom_field == o.your_custom_field
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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 240

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Klaviyo.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 311

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 217

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


197
198
199
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 197

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 203

def hash
  [, _first_name, _last_name, _phone_number, _title, _organization, _city, _region, _country, _zip, image, consent, your_custom_field].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



164
165
166
167
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 164

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



287
288
289
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 287

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 293

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



281
282
283
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 281

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



171
172
173
 
# File 'lib/klaviyo_sdk/models/identify_payload_properties.rb', line 171

def valid?
  true
end