class PolarAccesslinkApiGem::ExerciseHashId

Training session summary data

Attributes

calories[RW]

Expended calories during training in kilocalories

carbohydrate_percentage[RW]

Carbohydrate percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed.

club_id[RW]

Has value if the exercise is from "Flow For Club", otherwise not printed. Value -1 indicates that there were errors finding the club

club_name[RW]

Has value if the exercise is from "Flow For Club", otherwise not printed. Value "Ambiguous club location. Please contact support." is printed in case of error (and the club-id is -1).

detailed_sport_info[RW]

String containing the name of a Polar Flow-compatible sport, if one is set for the exercise.

device[RW]

Polar product used in training

distance[RW]

Distance in meters travelled during training

duration[RW]

The duration of the training session as specified in ISO8601

fat_percentage[RW]

Fat percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed.

has_route[RW]

Boolean indicating if the exercise has route data

heart_rate[RW]
id[RW]

Hashed id of the trainining session

polar_user[RW]

Absolute link to Polar user owning the training

protein_percentage[RW]

Protein percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed.

sport[RW]

Sport name

start_time[RW]

Start time of the training session in local time

training_load[RW]

Training load effect to user

upload_time[RW]

Time of the transfer from wrist unit to Polar database

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 97
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 73
def self.attribute_map
  {
    :'id' => :'id',
    :'upload_time' => :'upload_time',
    :'polar_user' => :'polar_user',
    :'device' => :'device',
    :'start_time' => :'start_time',
    :'duration' => :'duration',
    :'calories' => :'calories',
    :'distance' => :'distance',
    :'heart_rate' => :'heart_rate',
    :'training_load' => :'training_load',
    :'sport' => :'sport',
    :'has_route' => :'has_route',
    :'club_id' => :'club_id',
    :'club_name' => :'club_name',
    :'detailed_sport_info' => :'detailed_sport_info',
    :'fat_percentage' => :'fat_percentage',
    :'carbohydrate_percentage' => :'carbohydrate_percentage',
    :'protein_percentage' => :'protein_percentage'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 272
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 133
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PolarAccesslinkApiGem::ExerciseHashId` 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::ExerciseHashId`. 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?(:'upload_time')
    self.upload_time = attributes[:'upload_time']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'protein_percentage')
    self.protein_percentage = attributes[:'protein_percentage']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 126
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 102
def self.openapi_types
  {
    :'id' => :'String',
    :'upload_time' => :'String',
    :'polar_user' => :'String',
    :'device' => :'String',
    :'start_time' => :'String',
    :'duration' => :'String',
    :'calories' => :'Integer',
    :'distance' => :'Float',
    :'heart_rate' => :'HeartRate',
    :'training_load' => :'Float',
    :'sport' => :'String',
    :'has_route' => :'Boolean',
    :'club_id' => :'Integer',
    :'club_name' => :'String',
    :'detailed_sport_info' => :'String',
    :'fat_percentage' => :'Integer',
    :'carbohydrate_percentage' => :'Integer',
    :'protein_percentage' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 234
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      upload_time == o.upload_time &&
      polar_user == o.polar_user &&
      device == o.device &&
      start_time == o.start_time &&
      duration == o.duration &&
      calories == o.calories &&
      distance == o.distance &&
      heart_rate == o.heart_rate &&
      training_load == o.training_load &&
      sport == o.sport &&
      has_route == o.has_route &&
      club_id == o.club_id &&
      club_name == o.club_name &&
      detailed_sport_info == o.detailed_sport_info &&
      fat_percentage == o.fat_percentage &&
      carbohydrate_percentage == o.carbohydrate_percentage &&
      protein_percentage == o.protein_percentage
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 302
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 373
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 279
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 259
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 265
def hash
  [id, upload_time, polar_user, device, start_time, duration, calories, distance, heart_rate, training_load, sport, has_route, club_id, club_name, detailed_sport_info, fat_percentage, carbohydrate_percentage, protein_percentage].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 221
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 349
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 355
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 343
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/polar-accesslink-api-gem/models/exercise_hash_id.rb, line 228
def valid?
  true
end