Class: UltracartClient::ReportPageVisualization

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportPageVisualization

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 99

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'config')
    self.config = attributes[:'config']
  end

  if attributes.has_key?(:'data_source_name')
    self.data_source_name = attributes[:'data_source_name']
  end

  if attributes.has_key?(:'data_source_uuid')
    self.data_source_uuid = attributes[:'data_source_uuid']
  end

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

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

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'show_comparison')
    self.show_comparison = attributes[:'show_comparison']
  end

  if attributes.has_key?(:'styles')
    self.styles = attributes[:'styles']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'visualization_uuid')
    self.visualization_uuid = attributes[:'visualization_uuid']
  end
end

Instance Attribute Details

#config ⇒ Object

A JSON representation of the configuration for this visualization



18
19
20
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 18

def config
  @config
end

#data_source_name ⇒ Object

Returns the value of attribute data_source_name.



20
21
22
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 20

def data_source_name
  @data_source_name
end

#data_source_uuid ⇒ Object

A unique identifier assigned to the data source.



23
24
25
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 23

def data_source_uuid
  @data_source_uuid
end

#dimensions ⇒ Object

Returns the value of attribute dimensions.



25
26
27
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 25

def dimensions
  @dimensions
end

#metrics ⇒ Object

Returns the value of attribute metrics.



27
28
29
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 27

def metrics
  @metrics
end

#name ⇒ Object

Returns the value of attribute name.



29
30
31
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 29

def name
  @name
end

#show_comparison ⇒ Object

True if the visualization should show a comparison based upon the date range



32
33
34
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 32

def show_comparison
  @show_comparison
end

#styles ⇒ Object

A JSON representation of the style configuration for this visualization



35
36
37
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 35

def styles
  @styles
end

#type ⇒ Object

Type of visualization



38
39
40
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 38

def type
  @type
end

#visualization_uuid ⇒ Object

A UUID for the visualization



41
42
43
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 41

def visualization_uuid
  @visualization_uuid
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 66

def self.attribute_map
  {
    :'config' => :'config',
    :'data_source_name' => :'data_source_name',
    :'data_source_uuid' => :'data_source_uuid',
    :'dimensions' => :'dimensions',
    :'metrics' => :'metrics',
    :'name' => :'name',
    :'show_comparison' => :'show_comparison',
    :'styles' => :'styles',
    :'type' => :'type',
    :'visualization_uuid' => :'visualization_uuid'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 82

def self.swagger_types
  {
    :'config' => :'String',
    :'data_source_name' => :'String',
    :'data_source_uuid' => :'String',
    :'dimensions' => :'Array<ReportPageVisualizationDimension>',
    :'metrics' => :'Array<ReportPageVisualizationMetric>',
    :'name' => :'String',
    :'show_comparison' => :'BOOLEAN',
    :'styles' => :'String',
    :'type' => :'String',
    :'visualization_uuid' => :'String'
  }
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
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      config == o.config &&
      data_source_name == o.data_source_name &&
      data_source_uuid == o.data_source_uuid &&
      dimensions == o.dimensions &&
      metrics == o.metrics &&
      name == o.name &&
      show_comparison == o.show_comparison &&
      styles == o.styles &&
      type == o.type &&
      visualization_uuid == o.visualization_uuid
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



228
229
230
231
232
233
234
235
236
237
238
239
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
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 228

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = UltracartClient.const_get(type).new
    temp_model.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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 294

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 207

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


194
195
196
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 200

def hash
  [config, data_source_name, data_source_uuid, dimensions, metrics, name, show_comparison, styles, type, visualization_uuid].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



152
153
154
155
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 152

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



274
275
276
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 274

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



280
281
282
283
284
285
286
287
288
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 280

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



268
269
270
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 268

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



159
160
161
162
163
 
# File 'lib/ultracart_api/models/report_page_visualization.rb', line 159

def valid?
  type_validator = EnumAttributeValidator.new('String', ['score card', 'line chart', 'bar chart', 'text', 'table', 'gauge', 'pie chart'])
  return false unless type_validator.valid?(@type)
  true
end