Class: KlaviyoAPI::MetricAggregateQueryResourceObjectAttributes

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricAggregateQueryResourceObjectAttributes

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
184
185
186
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 120

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

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

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

  if attributes.key?(:'interval')
    self.interval = attributes[:'interval']
  else
    self.interval = 'day'
  end

  if attributes.key?(:'page_size')
    self.page_size = attributes[:'page_size']
  else
    self.page_size = 500
  end

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

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

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

  if attributes.key?(:'timezone')
    self.timezone = attributes[:'timezone']
  else
    self.timezone = 'UTC'
  end

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

Instance Attribute Details

#by ⇒ Object

Optional attribute(s) used for partitioning by the aggregation function



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

def by
  @by
end

#filter ⇒ Object

List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). These filters follow a similar format to those in ‘GET` requests, the primary difference is that this endpoint asks for a list. The time range can be filtered by providing a `greater-or-equal` and a `less-than` filter on the `datetime` field.



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

def filter
  @filter
end

#interval ⇒ Object

Aggregation interval, e.g. "hour", "day", "week", "month"



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

def interval
  @interval
end

#measurements ⇒ Object

Measurement key, e.g. ‘unique`, `sum_value`, `count`



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

def measurements
  @measurements
end

#metric_id ⇒ Object

The metric ID used in the aggregation.



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

def metric_id
  @metric_id
end

#page_cursor ⇒ Object

Optional pagination cursor to iterate over large result sets



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

def page_cursor
  @page_cursor
end

#page_size ⇒ Object

Alter the maximum number of returned rows in a single page of aggregation results



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

def page_size
  @page_size
end

#return_fields ⇒ Object

Provide fields to limit the returned data



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

def return_fields
  @return_fields
end

#sort ⇒ Object

Provide a sort key (e.g. -$message)



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

def sort
  @sort
end

#timezone ⇒ Object

The timezone used for processing the query, e.g. ‘’America/New_York’‘. This field is validated against a list of common timezones from the [IANA Time Zone Database](www.iana.org/time-zones). While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive.



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

def timezone
  @timezone
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 71

def self.attribute_map
  {
    :'metric_id' => :'metric_id',
    :'page_cursor' => :'page_cursor',
    :'measurements' => :'measurements',
    :'interval' => :'interval',
    :'page_size' => :'page_size',
    :'by' => :'by',
    :'return_fields' => :'return_fields',
    :'filter' => :'filter',
    :'timezone' => :'timezone',
    :'sort' => :'sort'
  }
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



272
273
274
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 272

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
113
114
115
116
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 108

def self.openapi_nullable
  Set.new([
    :'interval',
    :'page_size',
    :'by',
    :'return_fields',
    :'timezone',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 92

def self.openapi_types
  {
    :'metric_id' => :'String',
    :'page_cursor' => :'String',
    :'measurements' => :'Array<String>',
    :'interval' => :'String',
    :'page_size' => :'Integer',
    :'by' => :'Array<String>',
    :'return_fields' => :'Array<String>',
    :'filter' => :'Array<String>',
    :'timezone' => :'String',
    :'sort' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      metric_id == o.metric_id &&
      page_cursor == o.page_cursor &&
      measurements == o.measurements &&
      interval == o.interval &&
      page_size == o.page_size &&
      by == o.by &&
      return_fields == o.return_fields &&
      filter == o.filter &&
      timezone == o.timezone &&
      sort == o.sort
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



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 303

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



374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 374

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 279

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


259
260
261
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 259

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



265
266
267
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 265

def hash
  [metric_id, page_cursor, measurements, interval, page_size, by, return_fields, filter, timezone, sort].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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 190

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

  if @measurements.nil?
    invalid_properties.push('invalid value for "measurements", measurements cannot be nil.')
  end

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



350
351
352
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 350

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



356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 356

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



344
345
346
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 344

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



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/klaviyo-api-sdk/models/metric_aggregate_query_resource_object_attributes.rb', line 209

def valid?
  return false if @metric_id.nil?
  return false if @measurements.nil?
  interval_validator = EnumAttributeValidator.new('String', ["day", "hour", "month", "week"])
  return false unless interval_validator.valid?(@interval)
  return false if @filter.nil?
  sort_validator = EnumAttributeValidator.new('String', ["$attributed_channel", "-$attributed_channel", "$attributed_flow", "-$attributed_flow", "$attributed_message", "-$attributed_message", "$attributed_variation", "-$attributed_variation", "$campaign_channel", "-$campaign_channel", "$flow", "-$flow", "$flow_channel", "-$flow_channel", "$message", "-$message", "$message_send_cohort", "-$message_send_cohort", "$variation", "-$variation", "$variation_send_cohort", "-$variation_send_cohort", "Bot Click", "-Bot Click", "Bounce Type", "-Bounce Type", "Campaign Name", "-Campaign Name", "Client Canonical", "-Client Canonical", "Client Name", "-Client Name", "Client Type", "-Client Type", "Email Domain", "-Email Domain", "Failure Source", "-Failure Source", "Failure Type", "-Failure Type", "From Number", "-From Number", "From Phone Region", "-From Phone Region", "Inbox Provider", "-Inbox Provider", "List", "-List", "Message Name", "-Message Name", "Message Type", "-Message Type", "Method", "-Method", "Subject", "-Subject", "To Number", "-To Number", "To Phone Region", "-To Phone Region", "URL", "-URL", "count", "-count", "form_id", "-form_id", "sum_value", "-sum_value", "unique", "-unique"])
  return false unless sort_validator.valid?(@sort)
  true
end