Class: PolarAccesslinkApiGem::NightlyRecharge

Inherits:
Object
  • Object
show all
Defined in:
lib/polar-accesslink-api-gem/models/nightly_recharge.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NightlyRecharge

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 98

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#ans_charge ⇒ Object

ANS stands for autonomic nervous system. ANS charge is formed by measuring heart rate, heart rate variability and breathing rate during roughly the first four hours of your sleep. It is formed comparing your last night to your usual levels from the past 28 days. The scale is from -10.0 to +10.0. Around zero is your usual level.



40
41
42
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 40

def ans_charge
  @ans_charge
end

#ans_charge_status ⇒ Object

ANS charge status = much below usual (1) - below usual (2) - usual (3) - above usual (4) - much above usual (5)



43
44
45
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 43

def ans_charge_status
  @ans_charge_status
end

#beat_to_beat_avg ⇒ Object

Average time in milliseconds (ms) between successive heart beats during a 4-hour period starting at 30 minutes after falling asleep.



28
29
30
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 28

def beat_to_beat_avg
  @beat_to_beat_avg
end

#breathing_rate_avg ⇒ Object

Average breathing rate as breaths per minute (bpm) during a 4-hour period starting at 30 minutes after falling asleep.



34
35
36
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 34

def breathing_rate_avg
  @breathing_rate_avg
end

#breathing_samples ⇒ Object

5-minute average samples of breathing rate. Unit of samples is breaths per minute (bpm). You can request access to this data at www.polar.com/en/science/polar-accesslink-api-extended-content



49
50
51
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 49

def breathing_samples
  @breathing_samples
end

#date ⇒ Object

Result date of the Nightly Recharge



22
23
24
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 22

def date
  @date
end

#heart_rate_avg ⇒ Object

Average heart rate as beats per minute (bpm) during a 4-hour period starting at 30 minutes after falling asleep.



25
26
27
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 25

def heart_rate_avg
  @heart_rate_avg
end

#heart_rate_variability_avg ⇒ Object

Average variation in the time in milliseconds (ms) between successive heart beats during a 4-hour period starting at 30 minutes after falling asleep. The Heart rate variability is Root Mean Square of Successive Differences (RMSSD) in beat-to-beat intervals.



31
32
33
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 31

def heart_rate_variability_avg
  @heart_rate_variability_avg
end

#hrv_samples ⇒ Object

5-minute average samples of heart rate variability. Unit of samples is milliseconds(ms). You can request access to this data at www.polar.com/en/science/polar-accesslink-api-extended-content



46
47
48
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 46

def hrv_samples
  @hrv_samples
end

#nightly_recharge_status ⇒ Object

The Nightly Recharge status shows how your body was able to recover from training and stress during the night. Scores for both ANS charge and sleep charge are taken into account. Nightly Recharge status has the following (6-item) scale: very poor (1) – poor (2) – compromised (3) – OK (4) – good (5) – very good (6).



37
38
39
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 37

def nightly_recharge_status
  @nightly_recharge_status
end

#polar_user ⇒ Object

Absolute link to user owning the sleep



19
20
21
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 19

def polar_user
  @polar_user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 69

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 52

def self.attribute_map
  {
    :'polar_user' => :'polar_user',
    :'date' => :'date',
    :'heart_rate_avg' => :'heart_rate_avg',
    :'beat_to_beat_avg' => :'beat_to_beat_avg',
    :'heart_rate_variability_avg' => :'heart_rate_variability_avg',
    :'breathing_rate_avg' => :'breathing_rate_avg',
    :'nightly_recharge_status' => :'nightly_recharge_status',
    :'ans_charge' => :'ans_charge',
    :'ans_charge_status' => :'ans_charge_status',
    :'hrv_samples' => :'hrv_samples',
    :'breathing_samples' => :'breathing_samples'
  }
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



202
203
204
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 202

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



91
92
93
94
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 91

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

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 74

def self.openapi_types
  {
    :'polar_user' => :'String',
    :'date' => :'Date',
    :'heart_rate_avg' => :'Integer',
    :'beat_to_beat_avg' => :'Integer',
    :'heart_rate_variability_avg' => :'Integer',
    :'breathing_rate_avg' => :'Float',
    :'nightly_recharge_status' => :'Integer',
    :'ans_charge' => :'Float',
    :'ans_charge_status' => :'Integer',
    :'hrv_samples' => :'Object',
    :'breathing_samples' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 171

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      polar_user == o.polar_user &&
      date == o.date &&
      heart_rate_avg == o.heart_rate_avg &&
      beat_to_beat_avg == o.beat_to_beat_avg &&
      heart_rate_variability_avg == o.heart_rate_variability_avg &&
      breathing_rate_avg == o.breathing_rate_avg &&
      nightly_recharge_status == o.nightly_recharge_status &&
      ans_charge == o.ans_charge &&
      ans_charge_status == o.ans_charge_status &&
      hrv_samples == o.hrv_samples &&
      breathing_samples == o.breathing_samples
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



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
265
266
267
268
269
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 232

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 303

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 209

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


189
190
191
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 195

def hash
  [polar_user, date, heart_rate_avg, beat_to_beat_avg, heart_rate_variability_avg, breathing_rate_avg, nightly_recharge_status, ans_charge, ans_charge_status, hrv_samples, breathing_samples].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



158
159
160
161
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 158

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



279
280
281
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 279

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 285

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



273
274
275
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 273

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



165
166
167
 
# File 'lib/polar-accesslink-api-gem/models/nightly_recharge.rb', line 165

def valid?
  true
end