Class: PolarAccesslink::Activity

Inherits:
Object
  • Object
show all
Defined in:
lib/polar_accesslink/models/activity.rb

Overview

Summary of user’s daily activity

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Activity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/polar_accesslink/models/activity.rb', line 83

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_calories ⇒ Object

Total daily calories not including BMR. Precise calculation requires that user’s physical data is entered into Polar Flow



37
38
39
 
# File 'lib/polar_accesslink/models/activity.rb', line 37

def active_calories
  @active_calories
end

#active_steps ⇒ Object

You could consider this as a kind of activity unit. If you take one step the active-steps should increase by one and any activity comparable to one physical step would also increase the number by one



43
44
45
 
# File 'lib/polar_accesslink/models/activity.rb', line 43

def active_steps
  @active_steps
end

#calories ⇒ Object

Total daily calories in kilo calories including BMR



34
35
36
 
# File 'lib/polar_accesslink/models/activity.rb', line 34

def calories
  @calories
end

#created ⇒ Object

The time activity summary was created in Accesslink, in format YYYY-MM-DDTHH:mm:ss.SSS



31
32
33
 
# File 'lib/polar_accesslink/models/activity.rb', line 31

def created
  @created
end

#date ⇒ Object

Date when activity summary was recorded, in format YYYY-MM-DD



28
29
30
 
# File 'lib/polar_accesslink/models/activity.rb', line 28

def date
  @date
end

#duration ⇒ Object

The time interval as specified in ISO 8601



40
41
42
 
# File 'lib/polar_accesslink/models/activity.rb', line 40

def duration
  @duration
end

#id ⇒ Object

Activity summary id



19
20
21
 
# File 'lib/polar_accesslink/models/activity.rb', line 19

def id
  @id
end

#polar_user ⇒ Object

Absolute link to user owning the activity



22
23
24
 
# File 'lib/polar_accesslink/models/activity.rb', line 22

def polar_user
  @polar_user
end

#transaction_id ⇒ Object

Id of the activity-transaction this training was transferred in



25
26
27
 
# File 'lib/polar_accesslink/models/activity.rb', line 25

def transaction_id
  @transaction_id
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/polar_accesslink/models/activity.rb', line 46

def self.attribute_map
  {
    :'id' => :'id',
    :'polar_user' => :'polar-user',
    :'transaction_id' => :'transaction-id',
    :'date' => :'date',
    :'created' => :'created',
    :'calories' => :'calories',
    :'active_calories' => :'active-calories',
    :'duration' => :'duration',
    :'active_steps' => :'active-steps'
  }
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



177
178
179
 
# File 'lib/polar_accesslink/models/activity.rb', line 177

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



76
77
78
79
 
# File 'lib/polar_accesslink/models/activity.rb', line 76

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

.openapi_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/polar_accesslink/models/activity.rb', line 61

def self.openapi_types
  {
    :'id' => :'Integer',
    :'polar_user' => :'String',
    :'transaction_id' => :'Integer',
    :'date' => :'String',
    :'created' => :'String',
    :'calories' => :'Integer',
    :'active_calories' => :'Integer',
    :'duration' => :'String',
    :'active_steps' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/polar_accesslink/models/activity.rb', line 148

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      polar_user == o.polar_user &&
      transaction_id == o.transaction_id &&
      date == o.date &&
      created == o.created &&
      calories == o.calories &&
      active_calories == o.active_calories &&
      duration == o.duration &&
      active_steps == o.active_steps
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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/polar_accesslink/models/activity.rb', line 205

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
    PolarAccesslink.const_get(type).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



274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/polar_accesslink/models/activity.rb', line 274

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


164
165
166
 
# File 'lib/polar_accesslink/models/activity.rb', line 164

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



170
171
172
 
# File 'lib/polar_accesslink/models/activity.rb', line 170

def hash
  [id, polar_user, transaction_id, date, created, calories, active_calories, duration, active_steps].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



135
136
137
138
 
# File 'lib/polar_accesslink/models/activity.rb', line 135

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



250
251
252
 
# File 'lib/polar_accesslink/models/activity.rb', line 250

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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/polar_accesslink/models/activity.rb', line 256

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



244
245
246
 
# File 'lib/polar_accesslink/models/activity.rb', line 244

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



142
143
144
 
# File 'lib/polar_accesslink/models/activity.rb', line 142

def valid?
  true
end