polar-accesslink-api-gem 0.1.0

data/docs/NightlyRechargeApi.md

@@ -0,0 +1,144 @@
+# PolarAccesslinkApiGem::NightlyRechargeApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_nightly_recharge**](NightlyRechargeApi.md#list_nightly_recharge) | **GET** /v3/users/nightly-recharge | List Nightly Recharges |
+| [**v3_users_nightly_recharge_date_get**](NightlyRechargeApi.md#v3_users_nightly_recharge_date_get) | **GET** /v3/users/nightly-recharge/{date} | Get Nightly Recharge |
+
+
+## list_nightly_recharge
+
+> <Recharges> list_nightly_recharge
+
+List Nightly Recharges
+
+List Nightly Recharge data of user for the last 28 days.
+
+### 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::NightlyRechargeApi.new
+
+begin
+  # List Nightly Recharges
+  result = api_instance.list_nightly_recharge
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling NightlyRechargeApi->list_nightly_recharge: #{e}"
+end
+```
+
+#### Using the list_nightly_recharge_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Recharges>, Integer, Hash)> list_nightly_recharge_with_http_info
+
+```ruby
+begin
+  # List Nightly Recharges
+  data, status_code, headers = api_instance.list_nightly_recharge_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Recharges>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling NightlyRechargeApi->list_nightly_recharge_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Recharges**](Recharges.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v3_users_nightly_recharge_date_get
+
+> <NightlyRecharge> v3_users_nightly_recharge_date_get(date)
+
+Get Nightly Recharge
+
+Get Users Nightly Recharge data for given date.
+
+### 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::NightlyRechargeApi.new
+date = 'date_example' # String | Date of Nightly Recharge as ISO-8601 date string, example: \"2020-01-01\"
+
+begin
+  # Get Nightly Recharge
+  result = api_instance.v3_users_nightly_recharge_date_get(date)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling NightlyRechargeApi->v3_users_nightly_recharge_date_get: #{e}"
+end
+```
+
+#### Using the v3_users_nightly_recharge_date_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<NightlyRecharge>, Integer, Hash)> v3_users_nightly_recharge_date_get_with_http_info(date)
+
+```ruby
+begin
+  # Get Nightly Recharge
+  data, status_code, headers = api_instance.v3_users_nightly_recharge_date_get_with_http_info(date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <NightlyRecharge>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling NightlyRechargeApi->v3_users_nightly_recharge_date_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **String** | Date of Nightly Recharge as ISO-8601 date string, example: \&quot;2020-01-01\&quot; |  |
+
+### Return type
+
+[**NightlyRecharge**](NightlyRecharge.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Nights.md

@@ -0,0 +1,18 @@
+# PolarAccesslinkApiGem::Nights
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nights** | [**Array<Sleep>**](Sleep.md) | List of sleep objects | [optional] |
+
+## Example
+
+```ruby
+require 'polar-accesslink-api-gem'
+
+instance = PolarAccesslinkApiGem::Nights.new(
+  nights: null
+)
+```
+

data/docs/PhysicalInfoApi.md

@@ -0,0 +1,294 @@
+# PolarAccesslinkApiGem::PhysicalInfoApi
+
+All URIs are relative to *https://www.polaraccesslink.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**commit_physical_info_transaction**](PhysicalInfoApi.md#commit_physical_info_transaction) | **PUT** /v3/users/{user-id}/physical-information-transactions/{transaction-id} | Commit transaction |
+| [**create_physical_info_transaction**](PhysicalInfoApi.md#create_physical_info_transaction) | **POST** /v3/users/{user-id}/physical-information-transactions | Create transaction |
+| [**get_physical_info**](PhysicalInfoApi.md#get_physical_info) | **GET** /v3/users/{user-id}/physical-information-transactions/{transaction-id}/physical-informations/{physical-info-id} | Get physical info |
+| [**list_physical_infos**](PhysicalInfoApi.md#list_physical_infos) | **GET** /v3/users/{user-id}/physical-information-transactions/{transaction-id} | List physical infos |
+
+
+## commit_physical_info_transaction
+
+> commit_physical_info_transaction(transaction_id, user_id)
+
+Commit transaction
+
+After successfully retrieving physical information within a transaction, partners are expected to commit the transaction.
+
+### 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::PhysicalInfoApi.new
+transaction_id = 789 # Integer | Transaction identifier
+user_id = 56 # Integer | User identifier
+
+begin
+  # Commit transaction
+  api_instance.commit_physical_info_transaction(transaction_id, user_id)
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PhysicalInfoApi->commit_physical_info_transaction: #{e}"
+end
+```
+
+#### Using the commit_physical_info_transaction_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)> commit_physical_info_transaction_with_http_info(transaction_id, user_id)
+
+```ruby
+begin
+  # Commit transaction
+  data, status_code, headers = api_instance.commit_physical_info_transaction_with_http_info(transaction_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PhysicalInfoApi->commit_physical_info_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **Integer** | Transaction identifier |  |
+| **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
+
+
+## create_physical_info_transaction
+
+> <TransactionLocation> create_physical_info_transaction(user_id)
+
+Create transaction
+
+Initiate physical info transaction. Check for new physical info and create a new transaction if found.
+
+### 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::PhysicalInfoApi.new
+user_id = 56 # Integer | User identifier
+
+begin
+  # Create transaction
+  result = api_instance.create_physical_info_transaction(user_id)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PhysicalInfoApi->create_physical_info_transaction: #{e}"
+end
+```
+
+#### Using the create_physical_info_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionLocation>, Integer, Hash)> create_physical_info_transaction_with_http_info(user_id)
+
+```ruby
+begin
+  # Create transaction
+  data, status_code, headers = api_instance.create_physical_info_transaction_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionLocation>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PhysicalInfoApi->create_physical_info_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **Integer** | User identifier |  |
+
+### Return type
+
+[**TransactionLocation**](TransactionLocation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## get_physical_info
+
+> <PhysicalInformation> get_physical_info(user_id, transaction_id, physical_info_id)
+
+Get physical info
+
+Get physical info entity data
+
+### 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::PhysicalInfoApi.new
+user_id = 56 # Integer | User identifier
+transaction_id = 56 # Integer | Transaction identifier
+physical_info_id = 56 # Integer | Physical information identifier
+
+begin
+  # Get physical info
+  result = api_instance.get_physical_info(user_id, transaction_id, physical_info_id)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PhysicalInfoApi->get_physical_info: #{e}"
+end
+```
+
+#### Using the get_physical_info_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhysicalInformation>, Integer, Hash)> get_physical_info_with_http_info(user_id, transaction_id, physical_info_id)
+
+```ruby
+begin
+  # Get physical info
+  data, status_code, headers = api_instance.get_physical_info_with_http_info(user_id, transaction_id, physical_info_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhysicalInformation>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PhysicalInfoApi->get_physical_info_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **Integer** | User identifier |  |
+| **transaction_id** | **Integer** | Transaction identifier |  |
+| **physical_info_id** | **Integer** | Physical information identifier |  |
+
+### Return type
+
+[**PhysicalInformation**](PhysicalInformation.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+
+
+## list_physical_infos
+
+> <PhysicalInformations> list_physical_infos(transaction_id, user_id)
+
+List physical infos
+
+List new physical info data. After successfully initiating a transaction, physical infos included within it can be retrieved with the provided transactionId.
+
+### 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::PhysicalInfoApi.new
+transaction_id = 789 # Integer | Transaction identifier
+user_id = 56 # Integer | User identifier
+
+begin
+  # List physical infos
+  result = api_instance.list_physical_infos(transaction_id, user_id)
+  p result
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PhysicalInfoApi->list_physical_infos: #{e}"
+end
+```
+
+#### Using the list_physical_infos_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhysicalInformations>, Integer, Hash)> list_physical_infos_with_http_info(transaction_id, user_id)
+
+```ruby
+begin
+  # List physical infos
+  data, status_code, headers = api_instance.list_physical_infos_with_http_info(transaction_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhysicalInformations>
+rescue PolarAccesslinkApiGem::ApiError => e
+  puts "Error when calling PhysicalInfoApi->list_physical_infos_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **Integer** | Transaction identifier |  |
+| **user_id** | **Integer** | User identifier |  |
+
+### Return type
+
+[**PhysicalInformations**](PhysicalInformations.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/xml
+