polar_accesslink 1.0.1

data/docs/DailyActivityApi.md

@@ -0,0 +1,339 @@
+# PolarAccesslink::DailyActivityApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**commit_activity_transaction**](DailyActivityApi.md#commit_activity_transaction) | **PUT** /v3/users/{user-id}/activity-transactions/{transaction-id} | Commit transaction
+[**create_activity_transaction**](DailyActivityApi.md#create_activity_transaction) | **POST** /v3/users/{user-id}/activity-transactions | Create transaction
+[**get_activity_summary**](DailyActivityApi.md#get_activity_summary) | **GET** /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id} | Get activity summary
+[**get_step_samples**](DailyActivityApi.md#get_step_samples) | **GET** /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}/step-samples | Get step samples
+[**get_zone_samples**](DailyActivityApi.md#get_zone_samples) | **GET** /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}/zone-samples | Get zone samples
+[**list_activities**](DailyActivityApi.md#list_activities) | **GET** /v3/users/{user-id}/activity-transactions/{transaction-id} | List activities
+
+
+
+## commit_activity_transaction
+
+> commit_activity_transaction(transaction_id, user_id)
+
+Commit transaction
+
+After successfully retrieving activity summary data within a transaction, partners are expected to commit the transaction.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::DailyActivityApi.new
+transaction_id = 56 # Integer | Transaction identifier
+user_id = 56 # Integer | User identifier
+
+begin
+  #Commit transaction
+  api_instance.commit_activity_transaction(transaction_id, user_id)
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling DailyActivityApi->commit_activity_transaction: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | **Integer**| Transaction identifier |
+ **user_id** | **Integer**| User identifier |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## create_activity_transaction
+
+> TransactionLocation create_activity_transaction(user_id)
+
+Create transaction
+
+Initiate activity transaction. Check for new activity summaries and create a new transaction if found.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::DailyActivityApi.new
+user_id = 56 # Integer | User identifier
+
+begin
+  #Create transaction
+  result = api_instance.create_activity_transaction(user_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling DailyActivityApi->create_activity_transaction: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**| User identifier |
+
+### Return type
+
+[**TransactionLocation**](TransactionLocation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## get_activity_summary
+
+> Activity get_activity_summary(user_id, transaction_id, activity_id)
+
+Get activity summary
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::DailyActivityApi.new
+user_id = 56 # Integer | User identifier
+transaction_id = 56 # Integer | Transaction identifier
+activity_id = 56 # Integer | Activity summary identifier
+
+begin
+  #Get activity summary
+  result = api_instance.get_activity_summary(user_id, transaction_id, activity_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling DailyActivityApi->get_activity_summary: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**| User identifier |
+ **transaction_id** | **Integer**| Transaction identifier |
+ **activity_id** | **Integer**| Activity summary identifier |
+
+### Return type
+
+[**Activity**](Activity.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## get_step_samples
+
+> ActivityStepSamples get_step_samples(user_id, transaction_id, activity_id)
+
+Get step samples
+
+Get activity step samples. Example data can be seen from [appendix](#activity-step-time-series).
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::DailyActivityApi.new
+user_id = 56 # Integer | User identifier
+transaction_id = 56 # Integer | Transaction identifier
+activity_id = 56 # Integer | Activity summary identifier
+
+begin
+  #Get step samples
+  result = api_instance.get_step_samples(user_id, transaction_id, activity_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling DailyActivityApi->get_step_samples: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**| User identifier |
+ **transaction_id** | **Integer**| Transaction identifier |
+ **activity_id** | **Integer**| Activity summary identifier |
+
+### Return type
+
+[**ActivityStepSamples**](ActivityStepSamples.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## get_zone_samples
+
+> ActivityZoneSamples get_zone_samples(user_id, transaction_id, activity_id)
+
+Get zone samples
+
+Get activity zone samples. Example data can be seen from [appendix](#activity-zone-time-series).
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::DailyActivityApi.new
+user_id = 56 # Integer | User identifier
+transaction_id = 56 # Integer | Transaction identifier
+activity_id = 56 # Integer | Activity summary identifier
+
+begin
+  #Get zone samples
+  result = api_instance.get_zone_samples(user_id, transaction_id, activity_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling DailyActivityApi->get_zone_samples: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**| User identifier |
+ **transaction_id** | **Integer**| Transaction identifier |
+ **activity_id** | **Integer**| Activity summary identifier |
+
+### Return type
+
+[**ActivityZoneSamples**](ActivityZoneSamples.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## list_activities
+
+> ActivityLog list_activities(transaction_id, user_id)
+
+List activities
+
+List new activity data. After successfully initiating a transaction, activity summaries included within it can be retrieved with the provided transactionId.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::DailyActivityApi.new
+transaction_id = 56 # Integer | Transaction identifier
+user_id = 56 # Integer | User identifier
+
+begin
+  #List activities
+  result = api_instance.list_activities(transaction_id, user_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling DailyActivityApi->list_activities: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | **Integer**| Transaction identifier |
+ **user_id** | **Integer**| User identifier |
+
+### Return type
+
+[**ActivityLog**](ActivityLog.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+

data/docs/DurationZone.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::DurationZone
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Integer** | Activity zone index | [optional]
+**inzone** | **String** | Time duration spent in the zone ISO 8601 | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::DurationZone.new(index: 1,
+                                 inzone: PT51M5S)
+```
+
+

data/docs/Error.md

@@ -0,0 +1,25 @@
+# PolarAccesslink::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]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::Error.new(timestamp: null,
+                                 status: null,
+                                 error_type: null,
+                                 message: null,
+                                 corr_id: null)
+```
+
+

data/docs/Exercise.md

@@ -0,0 +1,47 @@
+# PolarAccesslink::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]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::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)
+```
+
+

data/docs/ExerciseHashId.md

@@ -0,0 +1,45 @@
+# PolarAccesslink::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]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::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.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)
+```
+
+

data/docs/Exercises.md

@@ -0,0 +1,17 @@
+# PolarAccesslink::Exercises
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**exercises** | **Array<String>** | Absolute links to individual exercises within the transaction | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::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,163 @@
+# PolarAccesslink::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.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::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 PolarAccesslink::ApiError => e
+  puts "Exception when calling ExercisesApi->get_exercise_fit_without_transaction: #{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.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::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 PolarAccesslink::ApiError => e
+  puts "Exception when calling ExercisesApi->get_exercise_without_transaction: #{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.
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = PolarAccesslink::ExercisesApi.new
+
+begin
+  #List exercises
+  result = api_instance.list_exercises_without_transaction
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling ExercisesApi->list_exercises_without_transaction: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<ExerciseHashId>**](ExerciseHashId.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/HeartRate.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::HeartRate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**average** | **Integer** | Average heart-rate | [optional]
+**maximum** | **Integer** | Maximum heart-rate | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::HeartRate.new(average: 129,
+                                 maximum: 147)
+```
+
+