Class: UltracartClient::Report

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Report

Initializes the object



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
149
150
151
152
153
154
155
 
# File 'lib/ultracart_api/models/report.rb', line 100

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

Returns the value of attribute active.



17
18
19
 
# File 'lib/ultracart_api/models/report.rb', line 17

def active
  @active
end

#data_sources ⇒ Object

Returns the value of attribute data_sources.



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

def data_sources
  @data_sources
end

#default_dataset_id ⇒ Object

Returns the value of attribute default_dataset_id.



21
22
23
 
# File 'lib/ultracart_api/models/report.rb', line 21

def default_dataset_id
  @default_dataset_id
end

#default_project_id ⇒ Object

Returns the value of attribute default_project_id.



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

def default_project_id
  @default_project_id
end

#filters ⇒ Object

Returns the value of attribute filters.



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

def filters
  @filters
end

#merchant_id ⇒ Object

Returns the value of attribute merchant_id.



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

def merchant_id
  @merchant_id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#pages ⇒ Object

Returns the value of attribute pages.



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

def pages
  @pages
end

#report_oid ⇒ Object

Object identifier for this report.



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

def report_oid
  @report_oid
end

#security_level ⇒ Object

Security level to execute report under



37
38
39
 
# File 'lib/ultracart_api/models/report.rb', line 37

def security_level
  @security_level
end

#settings ⇒ Object

A JSON representation of the settings for this report



40
41
42
 
# File 'lib/ultracart_api/models/report.rb', line 40

def settings
  @settings
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'active' => :'active',
    :'data_sources' => :'data_sources',
    :'default_dataset_id' => :'default_dataset_id',
    :'default_project_id' => :'default_project_id',
    :'filters' => :'filters',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'pages' => :'pages',
    :'report_oid' => :'report_oid',
    :'security_level' => :'security_level',
    :'settings' => :'settings'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'active' => :'BOOLEAN',
    :'data_sources' => :'Array<ReportDataSource>',
    :'default_dataset_id' => :'String',
    :'default_project_id' => :'String',
    :'filters' => :'Array<ReportFilter>',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'pages' => :'Array<ReportPage>',
    :'report_oid' => :'Integer',
    :'security_level' => :'String',
    :'settings' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/ultracart_api/models/report.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active == o.active &&
      data_sources == o.data_sources &&
      default_dataset_id == o.default_dataset_id &&
      default_project_id == o.default_project_id &&
      filters == o.filters &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      pages == o.pages &&
      report_oid == o.report_oid &&
      security_level == o.security_level &&
      settings == o.settings
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
265
266
267
268
269
270
271
272
 
# File 'lib/ultracart_api/models/report.rb', line 236

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/ultracart_api/models/report.rb', line 302

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/ultracart_api/models/report.rb', line 215

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

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



208
209
210
 
# File 'lib/ultracart_api/models/report.rb', line 208

def hash
  [active, data_sources, default_dataset_id, default_project_id, filters, merchant_id, name, pages, report_oid, security_level, settings].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



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

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



282
283
284
 
# File 'lib/ultracart_api/models/report.rb', line 282

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



288
289
290
291
292
293
294
295
296
 
# File 'lib/ultracart_api/models/report.rb', line 288

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



276
277
278
 
# File 'lib/ultracart_api/models/report.rb', line 276

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



166
167
168
169
170
 
# File 'lib/ultracart_api/models/report.rb', line 166

def valid?
  security_level_validator = EnumAttributeValidator.new('String', ['standard', 'low', 'medium', 'high'])
  return false unless security_level_validator.valid?(@security_level)
  true
end