Class: KlaviyoAPI::BaseEventCreateQueryBulkEntryResourceObjectAttributes

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BaseEventCreateQueryBulkEntryResourceObjectAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



75
76
77
78
79
80
81
82
83
84
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
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 75

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

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

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

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

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

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

Instance Attribute Details

#metric ⇒ Object

Returns the value of attribute metric.



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

def metric
  @metric
end

#properties ⇒ Object

Properties of this event. Any top level property (that are not objects) can be used to create segments. The $extra property is a special property. This records any non-segmentable values that can be referenced later. For example, HTML templates are useful on a segment but are not used to create a segment. There are limits placed onto the size of the data present. This must not exceed 5 MB. This must not exceed 300 event properties. A single string cannot be larger than 100 KB. The maximum allowed sum of profile strings is 100KB. Each array must not exceed 4000 elements. The properties cannot contain more than 10 nested levels.



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

def properties
  @properties
end

#time ⇒ Object

When this event occurred. By default, the time the request was received will be used. The time is truncated to the second. The time must be after the year 2000 and can only be up to 1 year in the future.



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

def time
  @time
end

#unique_id ⇒ Object

A unique identifier for an event. If a unique_id is repeated for the same profile and metric, the request will fail and no events will be processed. If this field is not present, this field will use the time to the second. Using the default, this limits only one event per profile per second.



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

def unique_id
  @unique_id
end

#value ⇒ Object

A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.



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

def value
  @value
end

#value_currency ⇒ Object

The ISO 4217 currency code of the value associated with the event.



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

def value_currency
  @value_currency
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 35

def self.attribute_map
  {
    :'properties' => :'properties',
    :'time' => :'time',
    :'value' => :'value',
    :'value_currency' => :'value_currency',
    :'metric' => :'metric',
    :'unique_id' => :'unique_id'
  }
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



164
165
166
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 164

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
68
69
70
71
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 64

def self.openapi_nullable
  Set.new([
    :'time',
    :'value',
    :'value_currency',
    :'unique_id'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 52

def self.openapi_types
  {
    :'properties' => :'Object',
    :'time' => :'Time',
    :'value' => :'Float',
    :'value_currency' => :'String',
    :'metric' => :'EventCreateQueryV2ResourceObjectAttributesMetric',
    :'unique_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      properties == o.properties &&
      time == o.time &&
      value == o.value &&
      value_currency == o.value_currency &&
      metric == o.metric &&
      unique_id == o.unique_id
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



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 195

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 266

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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 171

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


151
152
153
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 151

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



157
158
159
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 157

def hash
  [properties, time, value, value_currency, metric, unique_id].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



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 115

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

  if @metric.nil?
    invalid_properties.push('invalid value for "metric", metric 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



242
243
244
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 242

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



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 248

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



236
237
238
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 236

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



130
131
132
133
134
 
# File 'lib/klaviyo-api-sdk/models/base_event_create_query_bulk_entry_resource_object_attributes.rb', line 130

def valid?
  return false if @properties.nil?
  return false if @metric.nil?
  true
end