Class: KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ProfileUpsertQueryResourceObjectAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 119

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes` 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 `KlaviyoAPI::ProfileUpsertQueryResourceObjectAttributes`. 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.email = attributes[:'email']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#_kx ⇒ Object

Also known as the ‘exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo’s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.



31
32
33
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 31

def _kx
  @_kx
end

#anonymous_id ⇒ Object

Id that can be used to identify a profile when other identifiers are not available



28
29
30
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 28

def anonymous_id
  @anonymous_id
end

#email ⇒ Object

Individual’s email address



19
20
21
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 19

def email
  @email
end

#external_id ⇒ Object

A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.



25
26
27
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 25

def external_id
  @external_id
end

#first_name ⇒ Object

Individual’s first name



34
35
36
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 34

def first_name
  @first_name
end

#image ⇒ Object

URL pointing to the location of a profile image



49
50
51
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 49

def image
  @image
end

#last_name ⇒ Object

Individual’s last name



37
38
39
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 37

def last_name
  @last_name
end

#locale ⇒ Object

The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)



43
44
45
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 43

def locale
  @locale
end

#location ⇒ Object

Returns the value of attribute location.



51
52
53
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 51

def location
  @location
end

#organization ⇒ Object

Name of the company or organization within the company for whom the individual works



40
41
42
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 40

def organization
  @organization
end

#phone_number ⇒ Object

Individual’s phone number in E.164 format



22
23
24
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 22

def phone_number
  @phone_number
end

#properties ⇒ Object

An object containing key/value pairs for any custom properties assigned to this profile



54
55
56
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 54

def properties
  @properties
end

#title ⇒ Object

Individual’s job title



46
47
48
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 46

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 57

def self.attribute_map
  {
    :'email' => :'email',
    :'phone_number' => :'phone_number',
    :'external_id' => :'external_id',
    :'anonymous_id' => :'anonymous_id',
    :'_kx' => :'_kx',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'organization' => :'organization',
    :'locale' => :'locale',
    :'title' => :'title',
    :'image' => :'image',
    :'location' => :'location',
    :'properties' => :'properties'
  }
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



233
234
235
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 233

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 100

def self.openapi_nullable
  Set.new([
    :'email',
    :'phone_number',
    :'external_id',
    :'anonymous_id',
    :'_kx',
    :'first_name',
    :'last_name',
    :'organization',
    :'locale',
    :'title',
    :'image',
    :'properties'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 81

def self.openapi_types
  {
    :'email' => :'String',
    :'phone_number' => :'String',
    :'external_id' => :'String',
    :'anonymous_id' => :'String',
    :'_kx' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'organization' => :'String',
    :'locale' => :'String',
    :'title' => :'String',
    :'image' => :'String',
    :'location' => :'ProfileLocation',
    :'properties' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      email == o.email &&
      phone_number == o.phone_number &&
      external_id == o.external_id &&
      anonymous_id == o.anonymous_id &&
      _kx == o._kx &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      organization == o.organization &&
      locale == o.locale &&
      title == o.title &&
      image == o.image &&
      location == o.location &&
      properties == o.properties
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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 264

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 335

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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 240

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


220
221
222
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 220

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



226
227
228
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 226

def hash
  [email, phone_number, external_id, anonymous_id, _kx, first_name, last_name, organization, locale, title, image, location, properties].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



187
188
189
190
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 187

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



311
312
313
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 317

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



305
306
307
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 305

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



194
195
196
 
# File 'lib/klaviyo-api-sdk/models/profile_upsert_query_resource_object_attributes.rb', line 194

def valid?
  true
end