polar-accesslink-api-gem 0.1.0

data/docs/DurationZone.md

@@ -0,0 +1,20 @@
+# PolarAccesslinkApiGem::DurationZone
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **index** | **Integer** | Activity zone index | [optional] |
+| **inzone** | **String** | Time duration spent in the zone ISO 8601 | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::DurationZone.new(
+  index: 1,
+  inzone: PT51M5S
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,26 @@
+# PolarAccesslinkApiGem::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **timestamp** | [**Timestamp**](Timestamp.md) | Timestamp of the error. | [optional] |
+| **status** | **Integer** | Http status code | [optional] |
+| **error_type** | **String** | Error type. | [optional] |
+| **message** | **String** | Human readable error message. | [optional] |
+| **corr_id** | **String** | Correlation id of the response for problem solving and debugging use. | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::Error.new(
+  timestamp: null,
+  status: null,
+  error_type: null,
+  message: null,
+  corr_id: null
+)
+```
+

data/docs/Exercise.md

@@ -0,0 +1,54 @@
+# PolarAccesslinkApiGem::Exercise
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Id of the trainining session | [optional] |
+| **upload_time** | **String** | Time of the transfer from wrist unit to Polar database | [optional] |
+| **polar_user** | **String** | Absolute link to Polar user owning the training | [optional] |
+| **transaction_id** | **Integer** | Id of the exercise-transaction this training was transferred in | [optional] |
+| **device** | **String** | Polar product used in training | [optional] |
+| **start_time** | **String** | Start time of the training session in local time | [optional] |
+| **duration** | **String** | The duration of the training session as specified in ISO8601 | [optional] |
+| **calories** | **Integer** | Expended calories during training in kilocalories | [optional] |
+| **distance** | **Float** | Distance in meters travelled during training | [optional] |
+| **heart_rate** | [**HeartRate**](HeartRate.md) |  | [optional] |
+| **training_load** | **Float** | Training load effect to user | [optional] |
+| **sport** | **String** | Sport name | [optional] |
+| **has_route** | **Boolean** | Boolean indicating if the exercise has route data | [optional] |
+| **club_id** | **Integer** | Has value if the exercise is from \"Flow For Club\", otherwise not printed. Value -1 indicates that there were errors finding the club | [optional] |
+| **club_name** | **String** | 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). | [optional] |
+| **detailed_sport_info** | **String** | String containing the name of a Polar Flow-compatible sport, if one is set for the exercise. | [optional] |
+| **fat_percentage** | **Integer** | Fat percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed. | [optional] |
+| **carbohydrate_percentage** | **Integer** | Carbohydrate percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed. | [optional] |
+| **protein_percentage** | **Integer** | Protein percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed. | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::Exercise.new(
+  id: 1937529874,
+  upload_time: 2008-10-13T10:40:02.000Z,
+  polar_user: https://www.polaraccesslink/v3/users/1,
+  transaction_id: 179879,
+  device: Polar M400,
+  start_time: 2008-10-13T10:40:02.000Z,
+  duration: PT2H44M,
+  calories: 530,
+  distance: 1600,
+  heart_rate: null,
+  training_load: 143.22,
+  sport: OTHER,
+  has_route: true,
+  club_id: 999,
+  club_name: Polar Club,
+  detailed_sport_info: WATERSPORTS_WATERSKI,
+  fat_percentage: 60,
+  carbohydrate_percentage: 38,
+  protein_percentage: 2
+)
+```
+

data/docs/ExerciseHashId.md

@@ -0,0 +1,52 @@
+# PolarAccesslinkApiGem::ExerciseHashId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Hashed id of the trainining session | [optional] |
+| **upload_time** | **String** | Time of the transfer from wrist unit to Polar database | [optional] |
+| **polar_user** | **String** | Absolute link to Polar user owning the training | [optional] |
+| **device** | **String** | Polar product used in training | [optional] |
+| **start_time** | **String** | Start time of the training session in local time | [optional] |
+| **duration** | **String** | The duration of the training session as specified in ISO8601 | [optional] |
+| **calories** | **Integer** | Expended calories during training in kilocalories | [optional] |
+| **distance** | **Float** | Distance in meters travelled during training | [optional] |
+| **heart_rate** | [**HeartRate**](HeartRate.md) |  | [optional] |
+| **training_load** | **Float** | Training load effect to user | [optional] |
+| **sport** | **String** | Sport name | [optional] |
+| **has_route** | **Boolean** | Boolean indicating if the exercise has route data | [optional] |
+| **club_id** | **Integer** | Has value if the exercise is from \"Flow For Club\", otherwise not printed. Value -1 indicates that there were errors finding the club | [optional] |
+| **club_name** | **String** | 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). | [optional] |
+| **detailed_sport_info** | **String** | String containing the name of a Polar Flow-compatible sport, if one is set for the exercise. | [optional] |
+| **fat_percentage** | **Integer** | Fat percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed. | [optional] |
+| **carbohydrate_percentage** | **Integer** | Carbohydrate percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed. | [optional] |
+| **protein_percentage** | **Integer** | Protein percentage of exercise calories. Has value if the exercise is from training device supporting Energy sources, otherwise not printed. | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::ExerciseHashId.new(
+  id: 2AC312F,
+  upload_time: 2008-10-13T10:40:02.000Z,
+  polar_user: https://www.polaraccesslink/v3/users/1,
+  device: Polar M400,
+  start_time: 2008-10-13T10:40:02.000,
+  duration: PT2H44M,
+  calories: 530,
+  distance: 1600,
+  heart_rate: null,
+  training_load: 143.22,
+  sport: OTHER,
+  has_route: true,
+  club_id: 999,
+  club_name: Polar Club,
+  detailed_sport_info: WATERSPORTS_WATERSKI,
+  fat_percentage: 60,
+  carbohydrate_percentage: 38,
+  protein_percentage: 2
+)
+```
+

data/docs/Exercises.md

@@ -0,0 +1,18 @@
+# PolarAccesslinkApiGem::Exercises
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exercises** | **Array<String>** | Absolute links to individual exercises within the transaction | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::Exercises.new(
+  exercises: ["https://www.polaraccesslink.com/v3/users/12/exercise-transactions/34/exercises/56","https://www.polaraccesslink.com/v3/users/12/exercise-transactions/34/exercises/120"]
+)
+```
+

data/docs/ExercisesApi.md

@@ -0,0 +1,214 @@
+# PolarAccesslinkApiGem::ExercisesApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_exercise_fit_without_transaction**](ExercisesApi.md#get_exercise_fit_without_transaction) | **GET** /v3/exercises/{exerciseId}/fit | Get exercise FIT |
+| [**get_exercise_without_transaction**](ExercisesApi.md#get_exercise_without_transaction) | **GET** /v3/exercises/{exerciseId} | Get exercise |
+| [**list_exercises_without_transaction**](ExercisesApi.md#list_exercises_without_transaction) | **GET** /v3/exercises | List exercises |
+
+
+## get_exercise_fit_without_transaction
+
+> String get_exercise_fit_without_transaction(exercise_id)
+
+Get exercise FIT
+
+FIT file for users exercise.
+
+### Examples
+
+```ruby
+require 'time'
+require 'polar-accesslink-api-gem'
+# setup authorization
+PolarAccesslinkApiGem.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslinkApiGem::ExercisesApi.new
+exercise_id = 'exercise_id_example' # String | Hashed exercise id.
+
+begin
+  # Get exercise FIT
+  result = api_instance.get_exercise_fit_without_transaction(exercise_id)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling ExercisesApi->get_exercise_fit_without_transaction: #{e}"
+end
+```
+
+#### Using the get_exercise_fit_without_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_exercise_fit_without_transaction_with_http_info(exercise_id)
+
+```ruby
+begin
+  # Get exercise FIT
+  data, status_code, headers = api_instance.get_exercise_fit_without_transaction_with_http_info(exercise_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling ExercisesApi->get_exercise_fit_without_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exercise_id** | **String** | Hashed exercise id. |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: */*
+
+
+## get_exercise_without_transaction
+
+> <ExerciseHashId> get_exercise_without_transaction(exercise_id)
+
+Get exercise
+
+Get users exercise using hashed id.
+
+### Examples
+
+```ruby
+require 'time'
+require 'polar-accesslink-api-gem'
+# setup authorization
+PolarAccesslinkApiGem.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslinkApiGem::ExercisesApi.new
+exercise_id = 'exercise_id_example' # String | Hashed exercise id.
+
+begin
+  # Get exercise
+  result = api_instance.get_exercise_without_transaction(exercise_id)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling ExercisesApi->get_exercise_without_transaction: #{e}"
+end
+```
+
+#### Using the get_exercise_without_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExerciseHashId>, Integer, Hash)> get_exercise_without_transaction_with_http_info(exercise_id)
+
+```ruby
+begin
+  # Get exercise
+  data, status_code, headers = api_instance.get_exercise_without_transaction_with_http_info(exercise_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExerciseHashId>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling ExercisesApi->get_exercise_without_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **exercise_id** | **String** | Hashed exercise id. |  |
+
+### Return type
+
+[**ExerciseHashId**](ExerciseHashId.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_exercises_without_transaction
+
+> <Array<ExerciseHashId>> list_exercises_without_transaction
+
+List exercises
+
+List users exercises available in Accesslink.
+
+### Examples
+
+```ruby
+require 'time'
+require 'polar-accesslink-api-gem'
+# setup authorization
+PolarAccesslinkApiGem.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslinkApiGem::ExercisesApi.new
+
+begin
+  # List exercises
+  result = api_instance.list_exercises_without_transaction
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling ExercisesApi->list_exercises_without_transaction: #{e}"
+end
+```
+
+#### Using the list_exercises_without_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<ExerciseHashId>>, Integer, Hash)> list_exercises_without_transaction_with_http_info
+
+```ruby
+begin
+  # List exercises
+  data, status_code, headers = api_instance.list_exercises_without_transaction_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<ExerciseHashId>>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling ExercisesApi->list_exercises_without_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;ExerciseHashId&gt;**](ExerciseHashId.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/HeartRate.md

@@ -0,0 +1,20 @@
+# PolarAccesslinkApiGem::HeartRate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **average** | **Integer** | Average heart-rate | [optional] |
+| **maximum** | **Integer** | Maximum heart-rate | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::HeartRate.new(
+  average: 129,
+  maximum: 147
+)
+```
+

data/docs/NightlyRecharge.md

@@ -0,0 +1,38 @@
+# PolarAccesslinkApiGem::NightlyRecharge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **polar_user** | **String** | Absolute link to user owning the sleep | [optional] |
+| **date** | **Date** | Result date of the Nightly Recharge | [optional] |
+| **heart_rate_avg** | **Integer** | Average heart rate as beats per minute (bpm) during a 4-hour period starting at 30 minutes after falling asleep. | [optional] |
+| **beat_to_beat_avg** | **Integer** | Average time in milliseconds (ms) between successive heart beats during a 4-hour period starting at 30 minutes after falling asleep. | [optional] |
+| **heart_rate_variability_avg** | **Integer** | 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. | [optional] |
+| **breathing_rate_avg** | **Float** | Average breathing rate as breaths per minute (bpm) during a 4-hour period starting at 30 minutes after falling asleep. | [optional] |
+| **nightly_recharge_status** | **Integer** | 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). | [optional] |
+| **ans_charge** | **Float** | 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. | [optional] |
+| **ans_charge_status** | **Integer** | ANS charge status = much below usual (1) - below usual (2) - usual (3) - above usual (4) - much above usual (5) | [optional] |
+| **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 https://www.polar.com/en/science/polar-accesslink-api-extended-content | [optional] |
+| **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 https://www.polar.com/en/science/polar-accesslink-api-extended-content | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::NightlyRecharge.new(
+  polar_user: https://www.polaraccesslink/v3/users/1,
+  date: Wed Jan 01 01:00:00 CET 2020,
+  heart_rate_avg: 70,
+  beat_to_beat_avg: 816,
+  heart_rate_variability_avg: 28,
+  breathing_rate_avg: 14.1,
+  nightly_recharge_status: 3,
+  ans_charge: 0.0,
+  ans_charge_status: 3,
+  hrv_samples: {"00:41":14,"00:46":14,"00:51":15},
+  breathing_samples: {"00:39":13.4,"00:44":13.5,"00:49":13.5}
+)
+```
+