Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

polar-accesslink-api-gem

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

polar-accesslink-api-gem

  • 0.1.0
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

PolarAccesslinkApiGem - 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.78.0
  • Package version: 0.1.0
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://www.polar.com/accesslink

Installation

Build a gem

To build the Ruby code into a gem:

gem build polar-accesslink-api-gem.gemspec

Then either install the gem locally:

gem install ./polar-accesslink-api-gem-0.1.0.gem

(for development, run gem install --dev ./polar-accesslink-api-gem-0.1.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-accesslink-api-gem', '~> 0.1.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-api-gem', :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:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
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::DailyActivityApi.new
transaction_id = 789 # Integer | Transaction identifier
user_id = 56 # Integer | User identifier

begin
  #Commit transaction
  api_instance.commit_activity_transaction(transaction_id, user_id)
rescue PolarAccesslinkApiGem::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

ClassMethodHTTP requestDescription
PolarAccesslinkApiGem::DailyActivityApicommit_activity_transactionPUT /v3/users/{user-id}/activity-transactions/{transaction-id}Commit transaction
PolarAccesslinkApiGem::DailyActivityApicreate_activity_transactionPOST /v3/users/{user-id}/activity-transactionsCreate transaction
PolarAccesslinkApiGem::DailyActivityApiget_activity_summaryGET /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}Get activity summary
PolarAccesslinkApiGem::DailyActivityApiget_step_samplesGET /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}/step-samplesGet step samples
PolarAccesslinkApiGem::DailyActivityApiget_zone_samplesGET /v3/users/{user-id}/activity-transactions/{transaction-id}/activities/{activity-id}/zone-samplesGet zone samples
PolarAccesslinkApiGem::DailyActivityApilist_activitiesGET /v3/users/{user-id}/activity-transactions/{transaction-id}List activities
PolarAccesslinkApiGem::ExercisesApiget_exercise_fit_without_transactionGET /v3/exercises/{exerciseId}/fitGet exercise FIT
PolarAccesslinkApiGem::ExercisesApiget_exercise_without_transactionGET /v3/exercises/{exerciseId}Get exercise
PolarAccesslinkApiGem::ExercisesApilist_exercises_without_transactionGET /v3/exercisesList exercises
PolarAccesslinkApiGem::NightlyRechargeApilist_nightly_rechargeGET /v3/users/nightly-rechargeList Nightly Recharges
PolarAccesslinkApiGem::NightlyRechargeApiv3_users_nightly_recharge_date_getGET /v3/users/nightly-recharge/{date}Get Nightly Recharge
PolarAccesslinkApiGem::PhysicalInfoApicommit_physical_info_transactionPUT /v3/users/{user-id}/physical-information-transactions/{transaction-id}Commit transaction
PolarAccesslinkApiGem::PhysicalInfoApicreate_physical_info_transactionPOST /v3/users/{user-id}/physical-information-transactionsCreate transaction
PolarAccesslinkApiGem::PhysicalInfoApiget_physical_infoGET /v3/users/{user-id}/physical-information-transactions/{transaction-id}/physical-informations/{physical-info-id}Get physical info
PolarAccesslinkApiGem::PhysicalInfoApilist_physical_infosGET /v3/users/{user-id}/physical-information-transactions/{transaction-id}List physical infos
PolarAccesslinkApiGem::PullNotificationsApilistGET /v3/notificationsList
PolarAccesslinkApiGem::SleepApilist_nightsGET /v3/users/sleepList nights
PolarAccesslinkApiGem::SleepApiv3_users_sleep_available_getGET /v3/users/sleep/availableGet available sleep times
PolarAccesslinkApiGem::SleepApiv3_users_sleep_date_getGET /v3/users/sleep/{date}Get Sleep
PolarAccesslinkApiGem::TrainingDataApicommit_exercise_transactionPUT /v3/users/{user-id}/exercise-transactions/{transaction-id}Commit transaction
PolarAccesslinkApiGem::TrainingDataApicreate_exercise_transactionPOST /v3/users/{user-id}/exercise-transactionsCreate transaction
PolarAccesslinkApiGem::TrainingDataApiget_available_samplesGET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/samplesGet available samples
PolarAccesslinkApiGem::TrainingDataApiget_exercise_summaryGET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}Get exercise summary
PolarAccesslinkApiGem::TrainingDataApiget_fitGET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/fitGet FIT (beta)
PolarAccesslinkApiGem::TrainingDataApiget_gpxGET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/gpxGet GPX
PolarAccesslinkApiGem::TrainingDataApiget_heart_rate_zonesGET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/heart-rate-zonesGet heart rate zones
PolarAccesslinkApiGem::TrainingDataApiget_samplesGET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/samples/{type-id}Get samples
PolarAccesslinkApiGem::TrainingDataApiget_tcxGET /v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/tcxGet TCX
PolarAccesslinkApiGem::TrainingDataApilist_exercisesGET /v3/users/{user-id}/exercise-transactions/{transaction-id}List exercises
PolarAccesslinkApiGem::UsersApidelete_userDELETE /v3/users/{user-id}Delete user
PolarAccesslinkApiGem::UsersApiget_user_informationGET /v3/users/{user-id}Get user information
PolarAccesslinkApiGem::UsersApiregister_userPOST /v3/usersRegister user
PolarAccesslinkApiGem::WebhooksApicreate_webhookPOST /v3/webhooksCreate webhook
PolarAccesslinkApiGem::WebhooksApidelete_webhookDELETE /v3/webhooks/{webhook-id}Delete webhook
PolarAccesslinkApiGem::WebhooksApiget_webhookGET /v3/webhooksGet webhook
PolarAccesslinkApiGem::WebhooksApiupdate_webhookPATCH /v3/webhooks/{webhook-id}Update webhook

Documentation for Models

Documentation for Authorization

Basic

  • Type: HTTP basic authentication

OAuth2

FAQs

Package last updated on 02 Sep 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc