polar-accesslink-api-gem 0.1.0

data/docs/TransactionLocation.md

@@ -0,0 +1,20 @@
+# PolarAccesslinkApiGem::TransactionLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **Integer** | Id of the created transaction | [optional] |
+| **resource_uri** | **String** | Absolute links to the created transaction | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::TransactionLocation.new(
+  transaction_id: 122,
+  resource_uri: https://polaraccesslink.com/v3/users/21/physical-information-transactions/32
+)
+```
+

data/docs/User.md

@@ -0,0 +1,36 @@
+# PolarAccesslinkApiGem::User
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **polar_user_id** | **Integer** | User's id in Polar database | [optional] |
+| **member_id** | **String** | User's identifier in partner's database | [optional] |
+| **registration_date** | **Time** | Timestamp marked when ACCEPTED | [optional] |
+| **first_name** | **String** | User's first name | [optional] |
+| **last_name** | **String** | User's surname | [optional] |
+| **birthdate** | **String** | User's birthdate as YYYY-MM-DD | [optional] |
+| **gender** | **String** | User's sex | [optional] |
+| **weight** | **Float** | User's weight in kg | [optional] |
+| **height** | **Float** | Users height in centimeters | [optional] |
+| **field** | [**Array<UserExtraInfo>**](UserExtraInfo.md) | List containing answers given by the user to a number of partner-specific questions. Extra-info is null if there are no required fields defined by the partner. | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::User.new(
+  polar_user_id: 2278512,
+  member_id: i09u9ujj,
+  registration_date: 2011-10-14T12:50:37Z,
+  first_name: Eka,
+  last_name: Toka,
+  birthdate: 1985-09-06,
+  gender: MALE,
+  weight: 66,
+  height: 170,
+  field: null
+)
+```
+

data/docs/UserExtraInfo.md

@@ -0,0 +1,22 @@
+# PolarAccesslinkApiGem::UserExtraInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **value** | **String** | Value provided by the customer | [optional] |
+| **index** | **Integer** | Item index | [optional] |
+| **name** | **String** | Name of the extra info asked from customer | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::UserExtraInfo.new(
+  value: 2,
+  index: 0,
+  name: number-of-children
+)
+```
+

data/docs/UsersApi.md

@@ -0,0 +1,216 @@
+# PolarAccesslinkApiGem::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.
+
+### 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::UsersApi.new
+user_id = 789 # Integer | User identifier
+
+begin
+  # Delete user
+  api_instance.delete_user(user_id)
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling UsersApi->delete_user: #{e}"
+end
+```
+
+#### Using the delete_user_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_user_with_http_info(user_id)
+
+```ruby
+begin
+  # Delete user
+  data, status_code, headers = api_instance.delete_user_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling UsersApi->delete_user_with_http_info: #{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.
+
+### 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::UsersApi.new
+user_id = 475 # Integer | User identifier
+
+begin
+  # Get user information
+  result = api_instance.get_user_information(user_id)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling UsersApi->get_user_information: #{e}"
+end
+```
+
+#### Using the get_user_information_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> get_user_information_with_http_info(user_id)
+
+```ruby
+begin
+  # Get user information
+  data, status_code, headers = api_instance.get_user_information_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling UsersApi->get_user_information_with_http_info: #{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 the user before being able to access its data. API user-id and Polar User Id (polar-user-id) are interchangeable terms.
+
+### 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::UsersApi.new
+register = PolarAccesslinkApiGem::Register.new({member_id: 'User_id_999'}) # Register | 
+
+begin
+  # Register user
+  result = api_instance.register_user(register)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling UsersApi->register_user: #{e}"
+end
+```
+
+#### Using the register_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<User>, Integer, Hash)> register_user_with_http_info(register)
+
+```ruby
+begin
+  # Register user
+  data, status_code, headers = api_instance.register_user_with_http_info(register)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <User>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling UsersApi->register_user_with_http_info: #{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,18 @@
+# PolarAccesslinkApiGem::WebhookInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**WebhookInfoData**](WebhookInfoData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::WebhookInfo.new(
+  data: null
+)
+```
+

data/docs/WebhookInfoData.md

@@ -0,0 +1,22 @@
+# PolarAccesslinkApiGem::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] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::WebhookInfoData.new(
+  id: abdf33,
+  events: null,
+  url: https://myapp.example.com/acl_webhook
+)
+```
+

data/docs/WebhookPatch.md

@@ -0,0 +1,20 @@
+# PolarAccesslinkApiGem::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] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::WebhookPatch.new(
+  events: ["EXERCISE"],
+  url: https://myapp.example.com/acl_webhook
+)
+```
+

data/docs/WebhookPayloadExercise.md

@@ -0,0 +1,26 @@
+# PolarAccesslinkApiGem::WebhookPayloadExercise
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** | Type of available data. | [optional] |
+| **user_id** | **Integer** | Id of the user who has new data. | [optional] |
+| **entity_id** | **String** | Id of the available data. | [optional] |
+| **timestamp** | **Time** | Time when webhook notification is sent. | [optional] |
+| **url** | **String** | Url to the new available data. | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::WebhookPayloadExercise.new(
+  event: EXERCISE,
+  user_id: 475,
+  entity_id: aQlC83,
+  timestamp: 2018-05-15T14:22:24Z,
+  url: https://www.polaraccesslink.com/v3/exercises/aQlC83
+)
+```
+

data/docs/WebhookPayloadSleep.md

@@ -0,0 +1,26 @@
+# PolarAccesslinkApiGem::WebhookPayloadSleep
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** | Type of available data. | [optional] |
+| **user_id** | **Integer** | Id of the user who has new data. | [optional] |
+| **date** | **String** | Date of the available sleep data. | [optional] |
+| **timestamp** | **Time** | Time when webhook notification is sent. | [optional] |
+| **url** | **String** | Url to the new available data. | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::WebhookPayloadSleep.new(
+  event: SLEEP,
+  user_id: 475,
+  date: 2019-12-31,
+  timestamp: 2018-05-15T14:22:24Z,
+  url: https://www.polaraccesslink.com/v3/users/sleep/getSleepByDate/2019-12-31
+)
+```
+

data/docs/WebhookPing.md

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

data/docs/WebhookRequest.md

@@ -0,0 +1,20 @@
+# PolarAccesslinkApiGem::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. |  |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::WebhookRequest.new(
+  events: ["EXERCISE"],
+  url: https://myapp.example.com/acl_webhook
+)
+```
+