polar_accesslink 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd6391b6907940b32ade23cfc390b06b37453648b4a18abc0f4cc39b192512f5
+  data.tar.gz: be6b7449726b285bc4f93af8a348aa5eb7b46d528d6bf62221377159868b8ffc
+SHA512:
+  metadata.gz: 2fed0f8cc95b68d86ec50202b197f37b4a1e51415bd7683b7cd38faf9e1ff1091a4b750bf27fa805591e0eba5ca14db93494dc6830b798329308fa2d69bb6e3f
+  data.tar.gz: 69be02d301db917563a85407cc89e0c4ee553f6e4a76874b888c12de8583539dcbfe877b036bcc6a275b6898134fe17d58a5b22162886a4078e02b36961d1eca

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    polar_accesslink (1.0.1)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (11.1.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.12.2)
+    jaro_winkler (1.5.4)
+    json (2.3.0)
+    method_source (1.0.0)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    pry (0.13.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.1)
+    typhoeus (1.3.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  polar_accesslink!
+  pry-byebug
+  rake (~> 13.0.1)
+  rspec (~> 3.6, >= 3.6.0)
+  rubocop (~> 0.66.0)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,170 @@
+# polar_accesslink
+PolarAccesslink - the Ruby gem for the Polar Accesslink API
+
+## Polar Accesslink API documentation
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 3.40.0
+- Package version: 1.0.0
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For more information, please visit [https://www.polar.com/accesslink](https://www.polar.com/accesslink)
+- License: [Polar Electro AccessLink Limited License Agreement](https://www.polar.com/sites/default/files/static/ACL_Ltd_License_Agreement.pdf)
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build polar_accesslink.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./polar_accesslink-1.0.0.gem
+```
+
+(for development, run `gem install --dev ./polar_accesslink-1.0.0.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'polar_accesslink', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'polar_accesslink', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# Load the gem
+require 'polar_accesslink'
+
+# Setup authorization
+PolarAccesslink.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
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*PolarAccesslink::DailyActivityApi* | [**commit_activity_transaction**](docs/DailyActivityApi.md#commit_activity_transaction) | **PUT** /v3/users/{user-id}/activity-transactions/{transaction-id} | Commit transaction
+*PolarAccesslink::DailyActivityApi* | [**create_activity_transaction**](docs/DailyActivityApi.md#create_activity_transaction) | **POST** /v3/users/{user-id}/activity-transactions | Create transaction
+*PolarAccesslink::DailyActivityApi* | [**get_activity_summary**](docs/DailyActivityApi.md#get_activity_summary) | **GET** /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id} | Get activity summary
+*PolarAccesslink::DailyActivityApi* | [**get_step_samples**](docs/DailyActivityApi.md#get_step_samples) | **GET** /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}/step-samples | Get step samples
+*PolarAccesslink::DailyActivityApi* | [**get_zone_samples**](docs/DailyActivityApi.md#get_zone_samples) | **GET** /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}/zone-samples | Get zone samples
+*PolarAccesslink::DailyActivityApi* | [**list_activities**](docs/DailyActivityApi.md#list_activities) | **GET** /v3/users/{user-id}/activity-transactions/{transaction-id} | List activities
+*PolarAccesslink::ExercisesApi* | [**get_exercise_fit_without_transaction**](docs/ExercisesApi.md#get_exercise_fit_without_transaction) | **GET** /v3/exercises/{exerciseId}/fit | Get exercise FIT
+*PolarAccesslink::ExercisesApi* | [**get_exercise_without_transaction**](docs/ExercisesApi.md#get_exercise_without_transaction) | **GET** /v3/exercises/{exerciseId} | Get exercise
+*PolarAccesslink::ExercisesApi* | [**list_exercises_without_transaction**](docs/ExercisesApi.md#list_exercises_without_transaction) | **GET** /v3/exercises | List exercises
+*PolarAccesslink::PhysicalInfoApi* | [**commit_physical_info_transaction**](docs/PhysicalInfoApi.md#commit_physical_info_transaction) | **PUT** /v3/users/{user-id}/physical-information-transactions/{transaction-id} | Commit transaction
+*PolarAccesslink::PhysicalInfoApi* | [**create_physical_info_transaction**](docs/PhysicalInfoApi.md#create_physical_info_transaction) | **POST** /v3/users/{user-id}/physical-information-transactions | Create transaction
+*PolarAccesslink::PhysicalInfoApi* | [**get_physical_info**](docs/PhysicalInfoApi.md#get_physical_info) | **GET** /v3/users/{user-id}/physical-information-transactions/{transaction-id}/physical-informations/{physical-info-id} | Get physical info
+*PolarAccesslink::PhysicalInfoApi* | [**list_physical_infos**](docs/PhysicalInfoApi.md#list_physical_infos) | **GET** /v3/users/{user-id}/physical-information-transactions/{transaction-id} | List physical infos
+*PolarAccesslink::PullNotificationsApi* | [**list**](docs/PullNotificationsApi.md#list) | **GET** /v3/notifications | List
+*PolarAccesslink::TrainingDataApi* | [**commit_exercise_transaction**](docs/TrainingDataApi.md#commit_exercise_transaction) | **PUT** /v3/users/{user-id}/exercise-transactions/{transaction-id} | Commit transaction
+*PolarAccesslink::TrainingDataApi* | [**create_exercise_transaction**](docs/TrainingDataApi.md#create_exercise_transaction) | **POST** /v3/users/{user-id}/exercise-transactions | Create transaction
+*PolarAccesslink::TrainingDataApi* | [**get_available_samples**](docs/TrainingDataApi.md#get_available_samples) | **GET** /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/samples | Get available samples
+*PolarAccesslink::TrainingDataApi* | [**get_exercise_summary**](docs/TrainingDataApi.md#get_exercise_summary) | **GET** /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id} | Get exercise summary
+*PolarAccesslink::TrainingDataApi* | [**get_fit**](docs/TrainingDataApi.md#get_fit) | **GET** /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/fit | Get FIT (beta)
+*PolarAccesslink::TrainingDataApi* | [**get_gpx**](docs/TrainingDataApi.md#get_gpx) | **GET** /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/gpx | Get GPX
+*PolarAccesslink::TrainingDataApi* | [**get_heart_rate_zones**](docs/TrainingDataApi.md#get_heart_rate_zones) | **GET** /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/heart-rate-zones | Get heart rate zones
+*PolarAccesslink::TrainingDataApi* | [**get_samples**](docs/TrainingDataApi.md#get_samples) | **GET** /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/samples/{type-id} | Get samples
+*PolarAccesslink::TrainingDataApi* | [**get_tcx**](docs/TrainingDataApi.md#get_tcx) | **GET** /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/tcx | Get TCX
+*PolarAccesslink::TrainingDataApi* | [**list_exercises**](docs/TrainingDataApi.md#list_exercises) | **GET** /v3/users/{user-id}/exercise-transactions/{transaction-id} | List exercises
+*PolarAccesslink::UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /v3/users/{user-id} | Delete user
+*PolarAccesslink::UsersApi* | [**get_user_information**](docs/UsersApi.md#get_user_information) | **GET** /v3/users/{user-id} | Get user information
+*PolarAccesslink::UsersApi* | [**register_user**](docs/UsersApi.md#register_user) | **POST** /v3/users | Register user
+*PolarAccesslink::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /v3/webhooks | Create webhook
+*PolarAccesslink::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /v3/webhooks/{webhook-id} | Delete webhook
+*PolarAccesslink::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /v3/webhooks | Get webhook
+*PolarAccesslink::WebhooksApi* | [**update_webhook**](docs/WebhooksApi.md#update_webhook) | **PATCH** /v3/webhooks/{webhook-id} | Update webhook
+
+
+## Documentation for Models
+
+ - [PolarAccesslink::Activity](docs/Activity.md)
+ - [PolarAccesslink::ActivityLog](docs/ActivityLog.md)
+ - [PolarAccesslink::ActivityStepSample](docs/ActivityStepSample.md)
+ - [PolarAccesslink::ActivityStepSamples](docs/ActivityStepSamples.md)
+ - [PolarAccesslink::ActivityZoneSample](docs/ActivityZoneSample.md)
+ - [PolarAccesslink::ActivityZoneSamples](docs/ActivityZoneSamples.md)
+ - [PolarAccesslink::AvailableUserData](docs/AvailableUserData.md)
+ - [PolarAccesslink::AvailableUserDatas](docs/AvailableUserDatas.md)
+ - [PolarAccesslink::CreatedWebhook](docs/CreatedWebhook.md)
+ - [PolarAccesslink::CreatedWebhookData](docs/CreatedWebhookData.md)
+ - [PolarAccesslink::DurationZone](docs/DurationZone.md)
+ - [PolarAccesslink::Error](docs/Error.md)
+ - [PolarAccesslink::Exercise](docs/Exercise.md)
+ - [PolarAccesslink::ExerciseHashId](docs/ExerciseHashId.md)
+ - [PolarAccesslink::Exercises](docs/Exercises.md)
+ - [PolarAccesslink::HeartRate](docs/HeartRate.md)
+ - [PolarAccesslink::PhysicalInformation](docs/PhysicalInformation.md)
+ - [PolarAccesslink::PhysicalInformations](docs/PhysicalInformations.md)
+ - [PolarAccesslink::Register](docs/Register.md)
+ - [PolarAccesslink::Sample](docs/Sample.md)
+ - [PolarAccesslink::Samples](docs/Samples.md)
+ - [PolarAccesslink::TransactionLocation](docs/TransactionLocation.md)
+ - [PolarAccesslink::User](docs/User.md)
+ - [PolarAccesslink::UserExtraInfo](docs/UserExtraInfo.md)
+ - [PolarAccesslink::WebhookInfo](docs/WebhookInfo.md)
+ - [PolarAccesslink::WebhookInfoData](docs/WebhookInfoData.md)
+ - [PolarAccesslink::WebhookPatch](docs/WebhookPatch.md)
+ - [PolarAccesslink::WebhookPayload](docs/WebhookPayload.md)
+ - [PolarAccesslink::WebhookPing](docs/WebhookPing.md)
+ - [PolarAccesslink::WebhookRequest](docs/WebhookRequest.md)
+ - [PolarAccesslink::WebhookType](docs/WebhookType.md)
+ - [PolarAccesslink::Zone](docs/Zone.md)
+ - [PolarAccesslink::Zones](docs/Zones.md)
+
+
+## Documentation for Authorization
+
+
+### Basic
+
+- **Type**: HTTP basic authentication
+
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://flow.polar.com/oauth2/authorization
+- **Scopes**:
+  - accesslink.read_all: Allows read access to user's data
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Activity.md

@@ -0,0 +1,33 @@
+# PolarAccesslink::Activity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Activity summary id | [optional]
+**polar_user** | **String** | Absolute link to user owning the activity | [optional]
+**transaction_id** | **Integer** | Id of the activity-transaction this training was transferred in | [optional]
+**date** | **String** | Date when activity summary was recorded, in format YYYY-MM-DD | [optional]
+**created** | **String** | The time activity summary was created in Accesslink, in format YYYY-MM-DDTHH:mm:ss.SSS | [optional]
+**calories** | **Integer** | Total daily calories in kilo calories including BMR | [optional]
+**active_calories** | **Integer** | Total daily calories not including BMR. Precise calculation requires that user's physical data is entered into Polar Flow | [optional]
+**duration** | **String** | The time interval as specified in ISO 8601 | [optional]
+**active_steps** | **Integer** | You could consider this as a kind of activity unit. If you take one step the active-steps should increase by one and any activity comparable to one physical step would also increase the number by one | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::Activity.new(id: 1234,
+                                 polar_user: https://www.polaraccesslink/v3/users/1,
+                                 transaction_id: 179879,
+                                 date: 2010-12-31,
+                                 created: 2016-04-27T20:11:33.000Z,
+                                 calories: 2329,
+                                 active_calories: 428,
+                                 duration: PT2H44M,
+                                 active_steps: 250)
+```
+
+

data/docs/ActivityLog.md

@@ -0,0 +1,17 @@
+# PolarAccesslink::ActivityLog
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**activity_log** | **Array<String>** | Absolute links to individual activity summaries within the transaction | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::ActivityLog.new(activity_log: ["https://www.polaraccesslink.com/v3/users/12/activity-transactions/34/activities/56","https://www.polaraccesslink.com/v3/users/12/activity-transactions/34/activities/120"])
+```
+
+

data/docs/ActivityStepSample.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::ActivityStepSample
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**steps** | **Integer** | Number of steps in sample segment. If element is null, step samples are not available for current segment. | [optional]
+**time** | **String** | Start time of sample segment. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::ActivityStepSample.new(steps: null,
+                                 time: 12:37:33.000)
+```
+
+

data/docs/ActivityStepSamples.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::ActivityStepSamples
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**interval** | **Integer** | Sample interval in minutes. | [optional]
+**samples** | [**Array<ActivityStepSample>**](ActivityStepSample.md) | List of individual step sample objects. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::ActivityStepSamples.new(interval: null,
+                                 samples: null)
+```
+
+

data/docs/ActivityZoneSample.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::ActivityZoneSample
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**activity_zones** | [**Array<DurationZone>**](DurationZone.md) | List of heart rate zones with duration. | [optional]
+**time** | **String** | Start time of sample segment. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::ActivityZoneSample.new(activity_zones: null,
+                                 time: null)
+```
+
+

data/docs/ActivityZoneSamples.md

@@ -0,0 +1,19 @@
+# PolarAccesslink::ActivityZoneSamples
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**interval** | **Integer** | Sample interval in minutes. | [optional]
+**samples** | [**Array<ActivityZoneSample>**](ActivityZoneSample.md) | List of individual zone sample objects. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::ActivityZoneSamples.new(interval: null,
+                                 samples: null)
+```
+
+

data/docs/AvailableUserData.md

@@ -0,0 +1,21 @@
+# PolarAccesslink::AvailableUserData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **Integer** | User identifier who has available data. | [optional]
+**data_type** | **String** | Type of available data. | [optional]
+**url** | **String** | URI pointing to transaction initiation endpoint for user | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::AvailableUserData.new(user_id: 475,
+                                 data_type: ACTIVITY_SUMMARY,
+                                 url: https://www.polaraccesslink.com/v3/users/475/activity-transactions)
+```
+
+

data/docs/AvailableUserDatas.md

@@ -0,0 +1,17 @@
+# PolarAccesslink::AvailableUserDatas
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**available_user_data** | [**Array<AvailableUserData>**](AvailableUserData.md) | List of available user datas. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::AvailableUserDatas.new(available_user_data: null)
+```
+
+

data/docs/CreatedWebhook.md

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

data/docs/CreatedWebhookData.md

@@ -0,0 +1,23 @@
+# PolarAccesslink::CreatedWebhookData
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Id of the new webhook. | [optional]
+**events** | [**WebhookType**](WebhookType.md) |  | [optional]
+**url** | **String** | Url where the webhook notification is sent. | [optional]
+**signature_secret_key** | **String** | Security key for verifying that sender is actually Polar. | [optional]
+
+## Code Sample
+
+```ruby
+require 'OpenapiClient'
+
+instance = PolarAccesslink::CreatedWebhookData.new(id: abdf33,
+                                 events: null,
+                                 url: https://myapp.example.com/acl_webhook,
+                                 signature_secret_key: abe1f3ae-fd33-11e8-8eb2-f2801f1b9fd1)
+```
+
+