Class: UltracartClient::ReportDataSetQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/report_data_set_query.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportDataSetQuery

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#comparison_results ⇒ Object

True if a date range filter is provided with comparison date ranges and two results should be returned for the query.



19
20
21
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 19

def comparison_results
  @comparison_results
end

#data_set_query_uuid ⇒ Object

A unique identifier assigned to the data set query that is returned.



22
23
24
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 22

def data_set_query_uuid
  @data_set_query_uuid
end

#data_source ⇒ Object

Returns the value of attribute data_source.



24
25
26
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 24

def data_source
  @data_source
end

#dimensions ⇒ Object

Returns the value of attribute dimensions.



26
27
28
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 26

def dimensions
  @dimensions
end

#filter ⇒ Object

Returns the value of attribute filter.



28
29
30
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 28

def filter
  @filter
end

#for_object_id ⇒ Object

An identifier that can be used to help match up the returned data set



31
32
33
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 31

def for_object_id
  @for_object_id
end

#for_object_type ⇒ Object

The type of object this data set is for



34
35
36
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 34

def for_object_type
  @for_object_type
end

#metrics ⇒ Object

Returns the value of attribute metrics.



36
37
38
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 36

def metrics
  @metrics
end

#order_by_columns ⇒ Object

The columns to order by in the final result. If not specified the dimensions will be used



39
40
41
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 39

def order_by_columns
  @order_by_columns
end

#page_size ⇒ Object

Result set page size. The default value is 200 records. Max is 10000.



42
43
44
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 42

def page_size
  @page_size
end

#selected_filters ⇒ Object

Returns the value of attribute selected_filters.



44
45
46
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 44

def selected_filters
  @selected_filters
end

#skip_cache ⇒ Object

True if the 15 minute cache should be skipped.



47
48
49
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 47

def skip_cache
  @skip_cache
end

#user_data ⇒ Object

Any other data that needs to be returned with the response to help the UI



50
51
52
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 50

def user_data
  @user_data
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



94
95
96
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 94

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 75

def self.attribute_map
  {
    :'comparison_results' => :'comparison_results',
    :'data_set_query_uuid' => :'data_set_query_uuid',
    :'data_source' => :'data_source',
    :'dimensions' => :'dimensions',
    :'filter' => :'filter',
    :'for_object_id' => :'for_object_id',
    :'for_object_type' => :'for_object_type',
    :'metrics' => :'metrics',
    :'order_by_columns' => :'order_by_columns',
    :'page_size' => :'page_size',
    :'selected_filters' => :'selected_filters',
    :'skip_cache' => :'skip_cache',
    :'user_data' => :'user_data'
  }
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



259
260
261
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 259

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 118

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 99

def self.openapi_types
  {
    :'comparison_results' => :'Boolean',
    :'data_set_query_uuid' => :'String',
    :'data_source' => :'ReportDataSource',
    :'dimensions' => :'Array<ReportPageVisualizationDimension>',
    :'filter' => :'ReportFilter',
    :'for_object_id' => :'String',
    :'for_object_type' => :'String',
    :'metrics' => :'Array<ReportPageVisualizationMetric>',
    :'order_by_columns' => :'Array<ReportDataSetQueryOrderByColumn>',
    :'page_size' => :'Integer',
    :'selected_filters' => :'Array<ReportFilter>',
    :'skip_cache' => :'Boolean',
    :'user_data' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 226

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      comparison_results == o.comparison_results &&
      data_set_query_uuid == o.data_set_query_uuid &&
      data_source == o.data_source &&
      dimensions == o.dimensions &&
      filter == o.filter &&
      for_object_id == o.for_object_id &&
      for_object_type == o.for_object_type &&
      metrics == o.metrics &&
      order_by_columns == o.order_by_columns &&
      page_size == o.page_size &&
      selected_filters == o.selected_filters &&
      skip_cache == o.skip_cache &&
      user_data == o.user_data
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



290
291
292
293
294
295
296
297
298
299
300
301
302
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
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 290

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 361

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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 266

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


246
247
248
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



252
253
254
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 252

def hash
  [comparison_results, data_set_query_uuid, data_source, dimensions, filter, for_object_id, for_object_type, metrics, order_by_columns, page_size, selected_filters, skip_cache, user_data].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



201
202
203
204
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 201

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



337
338
339
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 337

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



343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 343

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



331
332
333
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 331

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



208
209
210
211
212
 
# File 'lib/ultracart_api/models/report_data_set_query.rb', line 208

def valid?
  for_object_type_validator = EnumAttributeValidator.new('String', ["schema", "filter", "visualization"])
  return false unless for_object_type_validator.valid?(@for_object_type)
  true
end