polar_accesslink 1.0.1

data/docs/PhysicalInfoApi.md

@@ -0,0 +1,227 @@
+# PolarAccesslink::PhysicalInfoApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**commit_physical_info_transaction**](PhysicalInfoApi.md#commit_physical_info_transaction) | **PUT** /v3/users/{user-id}/physical-information-transactions/{transaction-id} | Commit transaction
+[**create_physical_info_transaction**](PhysicalInfoApi.md#create_physical_info_transaction) | **POST** /v3/users/{user-id}/physical-information-transactions | Create transaction
+[**get_physical_info**](PhysicalInfoApi.md#get_physical_info) | **GET** /v3/users/{user-id}/physical-information-transactions/{transaction-id}/physical-informations/{physical-info-id} | Get physical info
+[**list_physical_infos**](PhysicalInfoApi.md#list_physical_infos) | **GET** /v3/users/{user-id}/physical-information-transactions/{transaction-id} | List physical infos
+
+
+
+## commit_physical_info_transaction
+
+> commit_physical_info_transaction(transaction_id, user_id)
+
+Commit transaction
+
+After successfully retrieving physical information 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::PhysicalInfoApi.new
+transaction_id = 56 # Integer | Transaction identifier
+user_id = 56 # Integer | User identifier
+
+begin
+  #Commit transaction
+  api_instance.commit_physical_info_transaction(transaction_id, user_id)
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling PhysicalInfoApi->commit_physical_info_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_physical_info_transaction
+
+> TransactionLocation create_physical_info_transaction(user_id)
+
+Create transaction
+
+Initiate physical info transaction. Check for new physical info 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::PhysicalInfoApi.new
+user_id = 56 # Integer | User identifier
+
+begin
+  #Create transaction
+  result = api_instance.create_physical_info_transaction(user_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling PhysicalInfoApi->create_physical_info_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_physical_info
+
+> PhysicalInformation get_physical_info(user_id, transaction_id, physical_info_id)
+
+Get physical info
+
+Get physical info entity data
+
+### 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::PhysicalInfoApi.new
+user_id = 56 # Integer | User identifier
+transaction_id = 56 # Integer | Transaction identifier
+physical_info_id = 56 # Integer | Physical information identifier
+
+begin
+  #Get physical info
+  result = api_instance.get_physical_info(user_id, transaction_id, physical_info_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling PhysicalInfoApi->get_physical_info: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**| User identifier |
+ **transaction_id** | **Integer**| Transaction identifier |
+ **physical_info_id** | **Integer**| Physical information identifier |
+
+### Return type
+
+[**PhysicalInformation**](PhysicalInformation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## list_physical_infos
+
+> PhysicalInformations list_physical_infos(transaction_id, user_id)
+
+List physical infos
+
+List new physical info data. After successfully initiating a transaction, physical infos 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::PhysicalInfoApi.new
+transaction_id = 56 # Integer | Transaction identifier
+user_id = 56 # Integer | User identifier
+
+begin
+  #List physical infos
+  result = api_instance.list_physical_infos(transaction_id, user_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling PhysicalInfoApi->list_physical_infos: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **transaction_id** | **Integer**| Transaction identifier |
+ **user_id** | **Integer**| User identifier |
+
+### Return type
+
+[**PhysicalInformations**](PhysicalInformations.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+

data/docs/PhysicalInformation.md

@@ -0,0 +1,39 @@
+# PolarAccesslink::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.SSS | [optional]
+**polar_user** | **String** | Absolute link to user owning the activity | [optional]
+**weight** | **Float** | Height | [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]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::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,17 @@
+# PolarAccesslink::PhysicalInformations
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**physical_informations** | **Array<String>** | Absolute links to individual physical informations within the transaction | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::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,58 @@
+# PolarAccesslink::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
+
+### Example
+
+```ruby
+# load the gem
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = PolarAccesslink::PullNotificationsApi.new
+
+begin
+  #List
+  result = api_instance.list
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling PullNotificationsApi->list: #{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/Register.md

@@ -0,0 +1,17 @@
+# PolarAccesslink::Register
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**member_id** | **String** | Partner's custom identifier for user. |
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::Register.new(member_id: User_id_999)
+```
+
+

data/docs/Sample.md

@@ -0,0 +1,21 @@
+# PolarAccesslink::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]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::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,17 @@
+# PolarAccesslink::Samples
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sample** | **Array<String>** | List of URIs pointing to single sample type data. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::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"])
+```
+
+