PolarClient - the Ruby gem for the Polar Accesslink API
Polar Accesslink API documentation
This SDK is automatically generated by the OpenAPI Generator project:
- API version: 3
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.polar.com/accesslink
To build the Ruby code into a gem:
gem build polar_client.gemspec
Then either install the gem locally:
gem install ./polar_client-1.0.0.gem
(for development, run gem install --dev ./polar_client-1.0.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'polar_client', '~> 1.0.0'
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_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Please follow the installation procedure and then run the following code:
# Load the gem
require 'polar_client'
# Setup authorization
PolarClient.configure do |config|
# Configure OAuth2 access token for authorization: OAuth2
config.access_token = 'YOUR ACCESS TOKEN'
# Configure a proc to get access tokens in lieu of the static access_token configuration
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
end
api_instance = PolarClient::CardioLoadBetaApi.new
date = Date.parse('2013-10-20') # Date | Inclusive start date of range as ISO-8601 date string, example: \"2022-01-01\"
begin
#Get cardio load by date
result = api_instance.v3_users_cardio_load_date_get(date)
p result
rescue PolarClient::ApiError => e
puts "Exception when calling CardioLoadBetaApi->v3_users_cardio_load_date_get: #{e}"
end
All URIs are relative to https://www.polaraccesslink.com
Class | Method | HTTP request | Description |
---|---|---|---|
PolarClient::CardioLoadBetaApi | v3_users_cardio_load_date_get | GET /v3/users/cardio-load/{date} | Get cardio load by date |
PolarClient::CardioLoadBetaApi | v3_users_cardio_load_date_get_0 | GET /v3/users/cardio-load/date | Get cardio load by date range |
PolarClient::CardioLoadBetaApi | v3_users_cardio_load_get | GET /v3/users/cardio-load/ | List cardio loads |
PolarClient::CardioLoadBetaApi | v3_users_cardio_load_period_days_days_get | GET /v3/users/cardio-load/period/days/{days} | Get historical data by days |
PolarClient::CardioLoadBetaApi | v3_users_cardio_load_period_months_months_get | GET /v3/users/cardio-load/period/months/{months} | Get historical data by months |
PolarClient::ContinuousHeartRateBetaApi | v3_users_continuous_heart_rate_date_get | GET /v3/users/continuous-heart-rate/{date} | Get Continuous Heart rate samples |
PolarClient::ContinuousHeartRateBetaApi | v3_users_continuous_heart_rate_get | GET /v3/users/continuous-heart-rate | Get Continuous Heart rate samples with range |
PolarClient::DailyActivityApi | commit_activity_transaction | PUT /v3/users/{user-id}/activity-transactions/{transaction-id} | Commit transaction |
PolarClient::DailyActivityApi | create_activity_transaction | POST /v3/users/{user-id}/activity-transactions | Create transaction |
PolarClient::DailyActivityApi | get_activity_summary | GET /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id} | Get activity summary |
PolarClient::DailyActivityApi | get_step_samples | GET /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}/step-samples | Get step samples |
PolarClient::DailyActivityApi | get_zone_samples | GET /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}/zone-samples | Get zone samples |
PolarClient::DailyActivityApi | list_activities | GET /v3/users/{user-id}/activity-transactions/{transaction-id} | List activities |
PolarClient::ExercisesApi | get_exercise_fit_without_transaction | GET /v3/exercises/{exerciseId}/fit | Get exercise FIT |
PolarClient::ExercisesApi | get_exercise_gpx_without_transaction | GET /v3/exercises/{exerciseId}/gpx | Get exercise GPX |
PolarClient::ExercisesApi | get_exercise_tcx_without_transaction | GET /v3/exercises/{exerciseId}/tcx | Get exercise TCX |
PolarClient::ExercisesApi | get_exercise_without_transaction | GET /v3/exercises/{exerciseId} | Get exercise |
PolarClient::ExercisesApi | list_exercises_without_transaction | GET /v3/exercises | List exercises |
PolarClient::NightlyRechargeApi | list_nightly_recharge | GET /v3/users/nightly-recharge | List Nightly Recharges |
PolarClient::NightlyRechargeApi | v3_users_nightly_recharge_date_get | GET /v3/users/nightly-recharge/{date} | Get Nightly Recharge |
PolarClient::PhysicalInfoApi | commit_physical_info_transaction | PUT /v3/users/{user-id}/physical-information-transactions/{transaction-id} | Commit transaction |
PolarClient::PhysicalInfoApi | create_physical_info_transaction | POST /v3/users/{user-id}/physical-information-transactions | Create transaction |
PolarClient::PhysicalInfoApi | get_physical_info | GET /v3/users/{user-id}/physical-information-transactions/{transaction-id}/physical-informations/{physical-info-id} | Get physical info |
PolarClient::PhysicalInfoApi | list_physical_infos | GET /v3/users/{user-id}/physical-information-transactions/{transaction-id} | List physical infos |
PolarClient::PullNotificationsApi | list | GET /v3/notifications | List |
PolarClient::SleepApi | list_nights | GET /v3/users/sleep | List nights |
PolarClient::SleepApi | v3_users_sleep_available_get | GET /v3/users/sleep/available | Get available sleep times |
PolarClient::SleepApi | v3_users_sleep_date_get | GET /v3/users/sleep/{date} | Get Sleep |
PolarClient::SleepWisetradeBetaApi | v3_users_sleepwise_alertness_date_get | GET /v3/users/sleepwise/alertness/date | Alertness period data (date range) |
PolarClient::SleepWisetradeBetaApi | v3_users_sleepwise_alertness_get | GET /v3/users/sleepwise/alertness | Alertness period data (last 28 days) |
PolarClient::SleepWisetradeBetaApi | v3_users_sleepwise_circadian_bedtime_date_get | GET /v3/users/sleepwise/circadian-bedtime/date | Circadian bedtime period data (date range) |
PolarClient::SleepWisetradeBetaApi | v3_users_sleepwise_circadian_bedtime_get | GET /v3/users/sleepwise/circadian-bedtime | Circadian bedtime period data (last 28 days) |
PolarClient::TrainingDataApi | commit_exercise_transaction | PUT /v3/users/{user-id}/exercise-transactions/{transaction-id} | Commit transaction |
PolarClient::TrainingDataApi | create_exercise_transaction | POST /v3/users/{user-id}/exercise-transactions | Create transaction |
PolarClient::TrainingDataApi | get_available_samples | GET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/samples | Get available samples |
PolarClient::TrainingDataApi | get_exercise_summary | GET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id} | Get exercise summary |
PolarClient::TrainingDataApi | get_fit | GET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/fit | Get FIT |
PolarClient::TrainingDataApi | get_gpx | GET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/gpx | Get GPX |
PolarClient::TrainingDataApi | get_heart_rate_zones | GET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/heart-rate-zones | Get heart rate zones |
PolarClient::TrainingDataApi | get_samples | GET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/samples/{type-id} | Get samples |
PolarClient::TrainingDataApi | get_tcx | GET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/tcx | Get TCX |
PolarClient::TrainingDataApi | list_exercises | GET /v3/users/{user-id}/exercise-transactions/{transaction-id} | List exercises |
PolarClient::UsersApi | delete_user | DELETE /v3/users/{user-id} | Delete user |
PolarClient::UsersApi | get_user_information | GET /v3/users/{user-id} | Get user information |
PolarClient::UsersApi | register_user | POST /v3/users | Register user |
PolarClient::WebhooksApi | create_webhook | POST /v3/webhooks | Create webhook |
PolarClient::WebhooksApi | delete_webhook | DELETE /v3/webhooks/{webhook-id} | Delete webhook |
PolarClient::WebhooksApi | get_webhook | GET /v3/webhooks | Get webhook |
PolarClient::WebhooksApi | update_webhook | PATCH /v3/webhooks/{webhook-id} | Update webhook |
PolarClient::WebhooksApi | v3_webhooks_activate_get | GET /v3/webhooks/activate | Activate webhook |
PolarClient::WebhooksApi | v3_webhooks_deactivate_get | GET /v3/webhooks/deactivate | Deactivate webhook |
- PolarClient::Activity
- PolarClient::ActivityLog
- PolarClient::ActivityStepSample
- PolarClient::ActivityStepSamples
- PolarClient::ActivityZoneSample
- PolarClient::ActivityZoneSamples
- PolarClient::Alertness
- PolarClient::AlertnessHourlyData
- PolarClient::AvailableSleep
- PolarClient::AvailableSleeps
- PolarClient::AvailableUserData
- PolarClient::AvailableUserDatas
- PolarClient::CardioLoad
- PolarClient::CardioLoadLevels
- PolarClient::CardioLoadStatusEnum
- PolarClient::CircadianBedtime
- PolarClient::ContinuousHeartrate
- PolarClient::ContinuousHeartrateHeartRateSamples
- PolarClient::CreatedWebhook
- PolarClient::CreatedWebhookData
- PolarClient::DurationZone
- PolarClient::Error
- PolarClient::Exercise
- PolarClient::ExerciseHashId
- PolarClient::Exercises
- PolarClient::HeartRate
- PolarClient::NightlyRecharge
- PolarClient::Nights
- PolarClient::PhysicalInformation
- PolarClient::PhysicalInformations
- PolarClient::Recharges
- PolarClient::Register
- PolarClient::Sample
- PolarClient::Samples
- PolarClient::Sleep
- PolarClient::TrainingLoadProLoadEnum
- PolarClient::TrainingLoadProRpeEnum
- PolarClient::TrainingLoadProSample
- PolarClient::TransactionLocation
- PolarClient::User
- PolarClient::UserExtraInfo
- PolarClient::WebhookInfo
- PolarClient::WebhookInfoData
- PolarClient::WebhookPatch
- PolarClient::WebhookPayloadAlertness
- PolarClient::WebhookPayloadCircadianBedtime
- PolarClient::WebhookPayloadContinuousHeartRate
- PolarClient::WebhookPayloadExercise
- PolarClient::WebhookPayloadSleep
- PolarClient::WebhookPing
- PolarClient::WebhookRequest
- PolarClient::WebhookType
- PolarClient::Zone
- PolarClient::Zones
Authentication schemes defined for the API:
- Type: HTTP basic authentication
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://flow.polar.com/oauth2/authorization
- Scopes:
- accesslink.read_all: Allows read access to user's data