Class: UltracartClient::ScreenRecordingQueryResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScreenRecordingQueryResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
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
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 72

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#error ⇒ Object

Returns the value of attribute error.



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

def error
  @error
end

#filter ⇒ Object

Returns the value of attribute filter.



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

def filter
  @filter
end

#filter_values ⇒ Object

Returns the value of attribute filter_values.



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

def filter_values
  @filter_values
end

#histogram_data ⇒ Object

Returns the value of attribute histogram_data.



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

def histogram_data
  @histogram_data
end

#histogram_interval ⇒ Object

Returns the value of attribute histogram_interval.



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

def histogram_interval
  @histogram_interval
end

#histogram_start_dts ⇒ Object

Returns the value of attribute histogram_start_dts.



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

def histogram_start_dts
  @histogram_start_dts
end

#metadata ⇒ Object

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#screen_recordings ⇒ Object

Returns the value of attribute screen_recordings.



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

def screen_recordings
  @screen_recordings
end

#success ⇒ Object

Indicates if API call was successful



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

def success
  @success
end

#warning ⇒ Object

Returns the value of attribute warning.



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

def warning
  @warning
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 39

def self.attribute_map
  {
    :'error' => :'error',
    :'filter' => :'filter',
    :'filter_values' => :'filter_values',
    :'histogram_data' => :'histogram_data',
    :'histogram_interval' => :'histogram_interval',
    :'histogram_start_dts' => :'histogram_start_dts',
    :'metadata' => :'metadata',
    :'screen_recordings' => :'screen_recordings',
    :'success' => :'success',
    :'warning' => :'warning'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 55

def self.swagger_types
  {
    :'error' => :'Error',
    :'filter' => :'ScreenRecordingFilter',
    :'filter_values' => :'ScreenRecordingFilterValues',
    :'histogram_data' => :'Array<Integer>',
    :'histogram_interval' => :'String',
    :'histogram_start_dts' => :'String',
    :'metadata' => :'ResponseMetadata',
    :'screen_recordings' => :'Array<ScreenRecording>',
    :'success' => :'BOOLEAN',
    :'warning' => :'Warning'
  }
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
148
149
150
151
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error == o.error &&
      filter == o.filter &&
      filter_values == o.filter_values &&
      histogram_data == o.histogram_data &&
      histogram_interval == o.histogram_interval &&
      histogram_start_dts == o.histogram_start_dts &&
      metadata == o.metadata &&
      screen_recordings == o.screen_recordings &&
      success == o.success &&
      warning == o.warning
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



189
190
191
192
193
194
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
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 189

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 255

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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 168

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


155
156
157
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 155

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 161

def hash
  [error, filter, filter_values, histogram_data, histogram_interval, histogram_start_dts, metadata, screen_recordings, success, warning].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



125
126
127
128
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 125

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



235
236
237
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 235

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



241
242
243
244
245
246
247
248
249
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 241

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



229
230
231
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 229

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



132
133
134
 
# File 'lib/ultracart_api/models/screen_recording_query_response.rb', line 132

def valid?
  true
end