polar_accesslink 1.0.1

data/docs/UsersApi.md

@@ -0,0 +1,166 @@
+# PolarAccesslink::UsersApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_user**](UsersApi.md#delete_user) | **DELETE** /v3/users/{user-id} | Delete user
+[**get_user_information**](UsersApi.md#get_user_information) | **GET** /v3/users/{user-id} | Get user information
+[**register_user**](UsersApi.md#register_user) | **POST** /v3/users | Register user
+
+
+
+## delete_user
+
+> delete_user(user_id)
+
+Delete user
+
+When partner wishes no longer to receive user data, user can be de-registered.This will revoke the access token authorized by user.
+
+### 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::UsersApi.new
+user_id = 56 # Integer | User identifier
+
+begin
+  #Delete user
+  api_instance.delete_user(user_id)
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling UsersApi->delete_user: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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
+
+
+## get_user_information
+
+> User get_user_information(user_id)
+
+Get user information
+
+List user basic information. Note: Although it is possible to get users weight and height from this resource, the [get physical info](#get-physical-info) should be used instead.
+
+### 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::UsersApi.new
+user_id = 475 # Integer | User identifier
+
+begin
+  #Get user information
+  result = api_instance.get_user_information(user_id)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling UsersApi->get_user_information: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **Integer**| User identifier |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## register_user
+
+> User register_user(register)
+
+Register user
+
+Once partner has been authorized by user, partner must register user before being able to access her 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::UsersApi.new
+register = PolarAccesslink::Register.new # Register |
+
+begin
+  #Register user
+  result = api_instance.register_user(register)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling UsersApi->register_user: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **register** | [**Register**](Register.md)|  |
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/xml, application/json
+- **Accept**: application/json, application/xml
+

data/docs/WebhookInfo.md

@@ -0,0 +1,17 @@
+# PolarAccesslink::WebhookInfo
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**WebhookInfoData**](WebhookInfoData.md) |  | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::WebhookInfo.new(data: null)
+```
+
+

data/docs/WebhookInfoData.md

@@ -0,0 +1,21 @@
+# PolarAccesslink::WebhookInfoData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of the webhook. | [optional]
+**events** | [**WebhookType**](WebhookType.md) |  | [optional]
+**url** | **String** | Url where the webhook notification is sent. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::WebhookInfoData.new(id: abdf33,
+                                 events: null,
+                                 url: https://myapp.example.com/acl_webhook)
+```
+
+

data/docs/WebhookPatch.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::WebhookPatch
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<WebhookType>**](WebhookType.md) | Type of events to subscribe. | [optional]
+**url** | **String** | Url where the webhook notification is sent. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::WebhookPatch.new(events: ["EXERCISE","ACTIVITY_SUMMARY"],
+                                 url: https://myapp.example.com/acl_webhook)
+```
+
+

data/docs/WebhookPayload.md

@@ -0,0 +1,25 @@
+# PolarAccesslink::WebhookPayload
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event** | [**WebhookType**](WebhookType.md) |  | [optional]
+**user_id** | **Integer** | Id of the user who has new data. | [optional]
+**entity_id** | **String** | Id of the available data. | [optional]
+**timestamp** | **DateTime** | Time when webhook notification is sent. | [optional]
+**url** | **String** | Url to the new available data. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::WebhookPayload.new(event: null,
+                                 user_id: 475,
+                                 entity_id: aQlC83,
+                                 timestamp: 2018-05-15T14:22:24Z,
+                                 url: https://www.polaraccesslink.com/v3/exercises/aQlC83)
+```
+
+

data/docs/WebhookPing.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::WebhookPing
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **DateTime** | Time when webhook ping is sent. | [optional]
+**event** | **String** | Only possible value is PING for ping message. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::WebhookPing.new(timestamp: 2018-05-15T14:22:24Z,
+                                 event: null)
+```
+
+

data/docs/WebhookRequest.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::WebhookRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**events** | [**Array<WebhookType>**](WebhookType.md) | Type of events to subscribe. |
+**url** | **String** | Url where the webhook notification is sent. |
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::WebhookRequest.new(events: ["EXERCISE","ACTIVITY_SUMMARY"],
+                                 url: https://myapp.example.com/acl_webhook)
+```
+
+

data/docs/WebhookType.md

@@ -0,0 +1,16 @@
+# PolarAccesslink::WebhookType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::WebhookType.new()
+```
+
+

data/docs/WebhooksApi.md

@@ -0,0 +1,221 @@
+# PolarAccesslink::WebhooksApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /v3/webhooks | Create webhook
+[**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /v3/webhooks/{webhook-id} | Delete webhook
+[**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /v3/webhooks | Get webhook
+[**update_webhook**](WebhooksApi.md#update_webhook) | **PATCH** /v3/webhooks/{webhook-id} | Update webhook
+
+
+
+## create_webhook
+
+> CreatedWebhook create_webhook(webhook_request)
+
+Create webhook
+
+Create new webhook.  When creating webhook the Accesslink sends a ping message to the url in request body. The ping message must be answered with 200 OK or otherwise the webhook is not created.  **Note!** Save the *signature_secret_key* from response since this is the only chance to get it.
+
+### 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::WebhooksApi.new
+webhook_request = PolarAccesslink::WebhookRequest.new # WebhookRequest | Webhook to create.
+
+begin
+  #Create webhook
+  result = api_instance.create_webhook(webhook_request)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling WebhooksApi->create_webhook: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_request** | [**WebhookRequest**](WebhookRequest.md)| Webhook to create. |
+
+### Return type
+
+[**CreatedWebhook**](CreatedWebhook.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_webhook
+
+> delete_webhook(webhook_id)
+
+Delete webhook
+
+Delete webhook by id.
+
+### 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::WebhooksApi.new
+webhook_id = 56 # Integer | Webhook id to delete
+
+begin
+  #Delete webhook
+  api_instance.delete_webhook(webhook_id)
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling WebhooksApi->delete_webhook: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **Integer**| Webhook id to delete |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_webhook
+
+> WebhookInfo get_webhook
+
+Get webhook
+
+Returns created webhook if exists.
+
+### 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::WebhooksApi.new
+
+begin
+  #Get webhook
+  result = api_instance.get_webhook
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling WebhooksApi->get_webhook: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WebhookInfo**](WebhookInfo.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_webhook
+
+> WebhookInfo update_webhook(webhook_id, webhook_patch)
+
+Update webhook
+
+Edit webhook event types and/or url.  When updating webhook url the Accesslink sends a ping message to the new address. The ping message must be answered with 200 OK or otherwise the webhook is not updated.
+
+### 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::WebhooksApi.new
+webhook_id = 56 # Integer | Webhook id to update
+webhook_patch = PolarAccesslink::WebhookPatch.new # WebhookPatch | New value(s) for events and/or url.
+
+begin
+  #Update webhook
+  result = api_instance.update_webhook(webhook_id, webhook_patch)
+  p result
+rescue PolarAccesslink::ApiError => e
+  puts "Exception when calling WebhooksApi->update_webhook: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **Integer**| Webhook id to update |
+ **webhook_patch** | [**WebhookPatch**](WebhookPatch.md)| New value(s) for events and/or url. |
+
+### Return type
+
+[**WebhookInfo**](WebhookInfo.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Zone.md

@@ -0,0 +1,23 @@
+# PolarAccesslink::Zone
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**index** | **Integer** | Zone list index | [optional]
+**lower_limit** | **Integer** | Lower heart-rate boundary of the zone | [optional]
+**upper_limit** | **Integer** | Upper heart-rate boundary of the zone | [optional]
+**in_zone** | **String** | Time duration spent in the zone ISO 8601 | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::Zone.new(index: 1,
+                                 lower_limit: 110,
+                                 upper_limit: 130,
+                                 in_zone: PT4S)
+```
+
+

data/docs/Zones.md

@@ -0,0 +1,17 @@
+# PolarAccesslink::Zones
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**zone** | [**Array<Zone>**](Zone.md) | List of heart rate zones. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::Zones.new(zone: null)
+```
+
+