polar-accesslink-api-gem 0.1.0

data/docs/PhysicalInformation.md

@@ -0,0 +1,40 @@
+# PolarAccesslinkApiGem::PhysicalInformation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Physical information id | [optional] |
+| **transaction_id** | **Integer** | Id of the physical-information-transaction this training was transferred in | [optional] |
+| **created** | **String** | The time physical information was created in Accesslink, in format YYYY-MM-DDTHH:mm:ss.SSSZ | [optional] |
+| **polar_user** | **String** | Absolute link to user owning the activity | [optional] |
+| **weight** | **Float** | Weight | [optional] |
+| **height** | **Float** | Height | [optional] |
+| **maximum_heart_rate** | **Integer** | Maximum heart rate | [optional] |
+| **resting_heart_rate** | **Integer** | Resting hear rate | [optional] |
+| **aerobic_threshold** | **Integer** | Aerobic threshold | [optional] |
+| **anaerobic_threshold** | **Integer** | Anaerobic threshold | [optional] |
+| **vo2_max** | **Integer** | VO2 max | [optional] |
+| **weight_source** | **String** | Weight source | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::PhysicalInformation.new(
+  id: 123,
+  transaction_id: 179879,
+  created: 2016-04-27T20:11:33.000Z,
+  polar_user: https://www.polaraccesslink/v3/users/1,
+  weight: 80,
+  height: 180,
+  maximum_heart_rate: 160,
+  resting_heart_rate: 60,
+  aerobic_threshold: 123,
+  anaerobic_threshold: 123,
+  vo2_max: 12,
+  weight_source: SOURCE_MEASURED
+)
+```
+

data/docs/PhysicalInformations.md

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

data/docs/PullNotificationsApi.md

@@ -0,0 +1,75 @@
+# PolarAccesslinkApiGem::PullNotificationsApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list**](PullNotificationsApi.md#list) | **GET** /v3/notifications | List |
+
+
+## list
+
+> <AvailableUserDatas> list
+
+List
+
+Get list of available exercises and activities for users
+
+### Examples
+
+```ruby
+require 'time'
+require 'polar-accesslink-api-gem'
+# setup authorization
+PolarAccesslinkApiGem.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PolarAccesslinkApiGem::PullNotificationsApi.new
+
+begin
+  # List
+  result = api_instance.list
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PullNotificationsApi->list: #{e}"
+end
+```
+
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AvailableUserDatas>, Integer, Hash)> list_with_http_info
+
+```ruby
+begin
+  # List
+  data, status_code, headers = api_instance.list_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AvailableUserDatas>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PullNotificationsApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AvailableUserDatas**](AvailableUserDatas.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+

data/docs/Recharges.md

@@ -0,0 +1,18 @@
+# PolarAccesslinkApiGem::Recharges
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recharges** | [**Array<NightlyRecharge>**](NightlyRecharge.md) | List of Nightly Recharge objects | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::Recharges.new(
+  recharges: null
+)
+```
+

data/docs/Register.md

@@ -0,0 +1,18 @@
+# PolarAccesslinkApiGem::Register
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member_id** | **String** | Partner's custom identifier for user. |  |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::Register.new(
+  member_id: User_id_999
+)
+```
+

data/docs/Sample.md

@@ -0,0 +1,22 @@
+# PolarAccesslinkApiGem::Sample
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recording_rate** | **Integer** | Sample recording rate in seconds. Null when recording rate is not applicable - currently only with RR-data. | [optional] |
+| **sample_type** | **String** | Sample type | [optional] |
+| **data** | **String** | Sample values as a comma-separated list of strings. Can contain null -values which indicate a situtation where sensor was offline. | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::Sample.new(
+  recording_rate: 5,
+  sample_type: null,
+  data: 0,100,102,97,97,101,103,106,96,89,88,87,98,108,113,112,114,115,118,121,121,121,121,123,117,119,122
+)
+```
+

data/docs/Samples.md

@@ -0,0 +1,18 @@
+# PolarAccesslinkApiGem::Samples
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sample** | **Array<String>** | List of URIs pointing to single sample type data. | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::Samples.new(
+  sample: ["https://www.polaraccesslink.com/v3/users/12/exercise-transactions/34/exercises/56/samples/0","https://www.polaraccesslink.com/v3/users/12/exercise-transactions/34/exercises/56/samples/3"]
+)
+```
+

data/docs/Sleep.md

@@ -0,0 +1,64 @@
+# PolarAccesslinkApiGem::Sleep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **polar_user** | **String** | Absolute link to user owning the sleep | [optional] |
+| **date** | **Date** | Result date of the sleep | [optional] |
+| **sleep_start_time** | **Time** | Start timestamp of the sleep as ISO-8601 datetime string | [optional] |
+| **sleep_end_time** | **Time** | End timestamp of the sleep as ISO-8601 datetime string | [optional] |
+| **device_id** | **String** | Id of the device the sleep was measured with | [optional] |
+| **continuity** | **Float** | Continuity is an estimate of how continuous the sleep was on a scale of 1.0 – 5.0, where 5.0 reflects uninterrupted sleep. The lower the value the more fragmented the sleep was. | [optional] |
+| **continuity_class** | **Integer** | Verbal assessments of sleep continuity Very continuous sleep (5) Continuous sleep (4) Fairly continuous sleep (3) Fairly fragmented sleep (2) Fragmented sleep (1) | [optional] |
+| **light_sleep** | **Integer** | Total time in seconds spent in light sleep stage between when you fell asleep and when you woke up. Corresponds to N1+ N2 according to AASM classification. | [optional] |
+| **deep_sleep** | **Integer** | Total time in seconds spent in the deep sleep stage between when you fell asleep and when you woke up. Corresponds to N3 according to AASM classification. | [optional] |
+| **rem_sleep** | **Integer** | Total time in seconds spent in REM sleep stage between when you fell asleep and when you woke up. REM stands for rapid eye movement. | [optional] |
+| **unrecognized_sleep_stage** | **Integer** | Total time in seconds spent in unrecognised sleep stage. Sometimes it's impossible to recognize sleep stages. This might happen when, for example, the wrist strap is not tight enough, or if you sleep on your hand. | [optional] |
+| **sleep_score** | **Integer** | Sleep score summarizes the amount and quality of your sleep into a single number on a scale of 1 – 100. Sleep score tells you how well you slept compared to the indicators of a good night's sleep based on the current sleep science. It consists of six components; sleep time, long interruptions, continuity, actual sleep, REM sleep, and deep sleep. | [optional] |
+| **total_interruption_duration** | **Integer** | The total time in seconds you spent awake between when you fell asleep and when you woke up. | [optional] |
+| **sleep_charge** | **Integer** | Sleep score compared to your usual level from the past 28 days.Scale: much below usual (1) – below usual (2) – usual (3) – above usual (4) – much above usual(5). | [optional] |
+| **sleep_goal** | **Integer** | Time goal in seconds for sleep selectedby user. A default value of the setting is based on age-related sleep duration recommendations. | [optional] |
+| **sleep_rating** | **Integer** | Numeric value given by user for representing the quality of sleep. Selection scale: Very poorly(1), poorly(2), ok(3), well(4), very well(5). 0 means no value is given. | [optional] |
+| **short_interruption_duration** | **Integer** | Total time in seconds of short interruptions. Short interruption is interruption in sleep of less than 90 seconds. | [optional] |
+| **long_interruption_duration** | **Integer** | Total time in seconds of long interruptions. Long interruption is interruption in sleep of 90 seconds or more. | [optional] |
+| **sleep_cycles** | **Integer** | Number of sleep cycles. | [optional] |
+| **group_duration_score** | **Float** | Sleep score consists of six components that are grouped under three themes. Score for sleep duration theme looks at your sleep time compared to your ‘preferred sleep time’ setting and the age-related duration recommendations. Group duration score ranges from 1.0 to 100.0. It is interpreted as textual feedback: poor, moderate or good amount. | [optional] |
+| **group_solidity_score** | **Float** | Sleep score consists of six components that are grouped under three themes. Score for sleep solidity theme is the average of the component scores of long interruptions, continuity and actual sleep. Group solidity score ranges from 1.0 to 100.0. It is interpreted as textual feedback: poor, moderate or good solidity. | [optional] |
+| **group_regeneration_score** | **Float** | Sleep score consists of six components that are grouped under three themes. Score for regeneration theme is the average of the scores of REM sleep and deep sleep. Group regeneration score ranges from 1.0 to 100.0. It is interpreted as textual feedback: poor, moderate or good regeneration | [optional] |
+| **hypnogram** | **Object** | The time span between when you fell asleep and when you woke up is classified into light, deep or REM sleep, or unrecognised or wake in 30-s epochs.  0 = WAKE, 1 = REM, 2 = LIGHTER NON-REM, 3 = LIGHT NON-REM, 4 = DEEP NON-REM, 5 = UNKNOWN (eg. due to bad skin contact). You can request access to this data at https://www.polar.com/en/science/polar-accesslink-api-extended-content | [optional] |
+| **heart_rate_samples** | **Object** | 5 min average samples of heart rate from the duration of the sleep. Default time between samples is 5 minutes. There may be periods with samples more often than every 5 minutes. Unit of samples is beats 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::Sleep.new(
+  polar_user: https://www.polaraccesslink/v3/users/1,
+  date: Wed Jan 01 01:00:00 CET 2020,
+  sleep_start_time: 2020-01-01T00:39:07+03:00,
+  sleep_end_time: 2020-01-01T09:19:37+03:00,
+  device_id: 1111AAAA,
+  continuity: 2.1,
+  continuity_class: 2,
+  light_sleep: 1000,
+  deep_sleep: 1000,
+  rem_sleep: 1000,
+  unrecognized_sleep_stage: 1000,
+  sleep_score: 80,
+  total_interruption_duration: 1000,
+  sleep_charge: 3,
+  sleep_goal: 28800,
+  sleep_rating: 3,
+  short_interruption_duration: 500,
+  long_interruption_duration: 300,
+  sleep_cycles: 6,
+  group_duration_score: 100.0,
+  group_solidity_score: 75.0,
+  group_regeneration_score: 54.2,
+  hypnogram: {"00:39":2,"00:50":3,"01:23":6},
+  heart_rate_samples: {"00:41":76,"00:46":77,"00:51":76}
+)
+```
+

data/docs/SleepApi.md

@@ -0,0 +1,211 @@
+# PolarAccesslinkApiGem::SleepApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_nights**](SleepApi.md#list_nights) | **GET** /v3/users/sleep | List nights |
+| [**v3_users_sleep_available_get**](SleepApi.md#v3_users_sleep_available_get) | **GET** /v3/users/sleep/available | Get available sleep times |
+| [**v3_users_sleep_date_get**](SleepApi.md#v3_users_sleep_date_get) | **GET** /v3/users/sleep/{date} | Get Sleep |
+
+
+## list_nights
+
+> <Nights> list_nights
+
+List nights
+
+List sleep data of user for the last 28 days.
+
+### 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::SleepApi.new
+
+begin
+  # List nights
+  result = api_instance.list_nights
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling SleepApi->list_nights: #{e}"
+end
+```
+
+#### Using the list_nights_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Nights>, Integer, Hash)> list_nights_with_http_info
+
+```ruby
+begin
+  # List nights
+  data, status_code, headers = api_instance.list_nights_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Nights>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling SleepApi->list_nights_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Nights**](Nights.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v3_users_sleep_available_get
+
+> <AvailableSleeps> v3_users_sleep_available_get
+
+Get available sleep times
+
+Get the dates with sleep start and end times, where user has sleep data available in the last 28 days.
+
+### 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::SleepApi.new
+
+begin
+  # Get available sleep times
+  result = api_instance.v3_users_sleep_available_get
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling SleepApi->v3_users_sleep_available_get: #{e}"
+end
+```
+
+#### Using the v3_users_sleep_available_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AvailableSleeps>, Integer, Hash)> v3_users_sleep_available_get_with_http_info
+
+```ruby
+begin
+  # Get available sleep times
+  data, status_code, headers = api_instance.v3_users_sleep_available_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AvailableSleeps>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling SleepApi->v3_users_sleep_available_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AvailableSleeps**](AvailableSleeps.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v3_users_sleep_date_get
+
+> <Sleep> v3_users_sleep_date_get(date)
+
+Get Sleep
+
+Get Users sleep data for given date.
+
+### 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::SleepApi.new
+date = 'date_example' # String | Date of sleep as ISO-8601 date string, example: \"2020-01-01\"
+
+begin
+  # Get Sleep
+  result = api_instance.v3_users_sleep_date_get(date)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling SleepApi->v3_users_sleep_date_get: #{e}"
+end
+```
+
+#### Using the v3_users_sleep_date_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Sleep>, Integer, Hash)> v3_users_sleep_date_get_with_http_info(date)
+
+```ruby
+begin
+  # Get Sleep
+  data, status_code, headers = api_instance.v3_users_sleep_date_get_with_http_info(date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Sleep>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling SleepApi->v3_users_sleep_date_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **String** | Date of sleep as ISO-8601 date string, example: \&quot;2020-01-01\&quot; |  |
+
+### Return type
+
+[**Sleep**](Sleep.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+