class PolarAccesslink::TrainingDataApi
Attributes
Public Class Methods
# File lib/polar_accesslink/api/training_data_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Commit transaction After successfully retrieving training session data within a transaction, partners are expected to commit the transaction. @param transaction_id Transaction identifier @param user_id User identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 28 def commit_exercise_transaction(transaction_id, user_id, opts = {}) commit_exercise_transaction_with_http_info(transaction_id, user_id, opts) nil end
Commit transaction After successfully retrieving training session data within a transaction, partners are expected to commit the transaction. @param transaction_id Transaction identifier @param user_id User identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 39 def commit_exercise_transaction_with_http_info(transaction_id, user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.commit_exercise_transaction ...' end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.commit_exercise_transaction" end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.commit_exercise_transaction" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}'.sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'user-id' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#commit_exercise_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create transaction Check for new training data and create a new transaction if found. @param user_id User identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 82 def create_exercise_transaction(user_id, opts = {}) create_exercise_transaction_with_http_info(user_id, opts) nil end
Create transaction Check for new training data and create a new transaction if found. @param user_id User identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 92 def create_exercise_transaction_with_http_info(user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.create_exercise_transaction ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.create_exercise_transaction" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions'.sub('{' + 'user-id' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#create_exercise_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get available samples Retrieve list of links to available samples in training session @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 133 def get_available_samples(user_id, transaction_id, exercise_id, opts = {}) get_available_samples_with_http_info(user_id, transaction_id, exercise_id, opts) nil end
Get available samples Retrieve list of links to available samples in training session @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 145 def get_available_samples_with_http_info(user_id, transaction_id, exercise_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.get_available_samples ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.get_available_samples" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.get_available_samples" end # verify the required parameter 'exercise_id' is set if @api_client.config.client_side_validation && exercise_id.nil? fail ArgumentError, "Missing the required parameter 'exercise_id' when calling TrainingDataApi.get_available_samples" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/samples'.sub('{' + 'user-id' + '}', user_id.to_s).sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'exercise-id' + '}', exercise_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#get_available_samples\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get exercise summary Retrieve training session summary data @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 194 def get_exercise_summary(user_id, transaction_id, exercise_id, opts = {}) get_exercise_summary_with_http_info(user_id, transaction_id, exercise_id, opts) nil end
Get exercise summary Retrieve training session summary data @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 206 def get_exercise_summary_with_http_info(user_id, transaction_id, exercise_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.get_exercise_summary ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.get_exercise_summary" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.get_exercise_summary" end # verify the required parameter 'exercise_id' is set if @api_client.config.client_side_validation && exercise_id.nil? fail ArgumentError, "Missing the required parameter 'exercise_id' when calling TrainingDataApi.get_exercise_summary" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}'.sub('{' + 'user-id' + '}', user_id.to_s).sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'exercise-id' + '}', exercise_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#get_exercise_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get FIT (beta) Retrieve exercise in FIT format. **Note!** This interface is in beta phase. If there is anything we can help you with or you want to give us feedback, please contact [Support](support). @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 255 def get_fit(user_id, transaction_id, exercise_id, opts = {}) get_fit_with_http_info(user_id, transaction_id, exercise_id, opts) nil end
Get FIT (beta) Retrieve exercise in FIT format. **Note!** This interface is in beta phase. If there is anything we can help you with or you want to give us feedback, please contact [Support](support). @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 267 def get_fit_with_http_info(user_id, transaction_id, exercise_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.get_fit ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.get_fit" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.get_fit" end # verify the required parameter 'exercise_id' is set if @api_client.config.client_side_validation && exercise_id.nil? fail ArgumentError, "Missing the required parameter 'exercise_id' when calling TrainingDataApi.get_fit" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/fit'.sub('{' + 'user-id' + '}', user_id.to_s).sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'exercise-id' + '}', exercise_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#get_fit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get GPX Retrieve training session summary data in GPX format @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @option opts [Object] :include_pause_times Whether to add pauses as part of the route. Default is false. @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 317 def get_gpx(user_id, transaction_id, exercise_id, opts = {}) get_gpx_with_http_info(user_id, transaction_id, exercise_id, opts) nil end
Get GPX Retrieve training session summary data in GPX format @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @option opts [Object] :include_pause_times Whether to add pauses as part of the route. Default is false. @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 330 def get_gpx_with_http_info(user_id, transaction_id, exercise_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.get_gpx ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.get_gpx" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.get_gpx" end # verify the required parameter 'exercise_id' is set if @api_client.config.client_side_validation && exercise_id.nil? fail ArgumentError, "Missing the required parameter 'exercise_id' when calling TrainingDataApi.get_gpx" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/gpx'.sub('{' + 'user-id' + '}', user_id.to_s).sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'exercise-id' + '}', exercise_id.to_s) # query parameters query_params = {} query_params[:'includePauseTimes'] = opts[:'include_pause_times'] if !opts[:'include_pause_times'].nil? # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#get_gpx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get heart rate zones Retrieve heart rate zones in training session @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 380 def get_heart_rate_zones(user_id, transaction_id, exercise_id, opts = {}) get_heart_rate_zones_with_http_info(user_id, transaction_id, exercise_id, opts) nil end
Get heart rate zones Retrieve heart rate zones in training session @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 392 def get_heart_rate_zones_with_http_info(user_id, transaction_id, exercise_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.get_heart_rate_zones ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.get_heart_rate_zones" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.get_heart_rate_zones" end # verify the required parameter 'exercise_id' is set if @api_client.config.client_side_validation && exercise_id.nil? fail ArgumentError, "Missing the required parameter 'exercise_id' when calling TrainingDataApi.get_heart_rate_zones" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/heart-rate-zones'.sub('{' + 'user-id' + '}', user_id.to_s).sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'exercise-id' + '}', exercise_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#get_heart_rate_zones\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get samples Retrieve sample data of given type @param type_id Sample type id @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 442 def get_samples(type_id, user_id, transaction_id, exercise_id, opts = {}) get_samples_with_http_info(type_id, user_id, transaction_id, exercise_id, opts) nil end
Get samples Retrieve sample data of given type @param type_id Sample type id @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 455 def get_samples_with_http_info(type_id, user_id, transaction_id, exercise_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.get_samples ...' end # verify the required parameter 'type_id' is set if @api_client.config.client_side_validation && type_id.nil? fail ArgumentError, "Missing the required parameter 'type_id' when calling TrainingDataApi.get_samples" end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.get_samples" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.get_samples" end # verify the required parameter 'exercise_id' is set if @api_client.config.client_side_validation && exercise_id.nil? fail ArgumentError, "Missing the required parameter 'exercise_id' when calling TrainingDataApi.get_samples" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/samples/{type-id}'.sub('{' + 'type-id' + '}', type_id.to_s).sub('{' + 'user-id' + '}', user_id.to_s).sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'exercise-id' + '}', exercise_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#get_samples\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get TCX Retrieve exercise in TCX format @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 508 def get_tcx(user_id, transaction_id, exercise_id, opts = {}) get_tcx_with_http_info(user_id, transaction_id, exercise_id, opts) nil end
Get TCX Retrieve exercise in TCX format @param user_id User identifier @param transaction_id Transaction identifier @param exercise_id Exercise identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 520 def get_tcx_with_http_info(user_id, transaction_id, exercise_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.get_tcx ...' end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.get_tcx" end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.get_tcx" end # verify the required parameter 'exercise_id' is set if @api_client.config.client_side_validation && exercise_id.nil? fail ArgumentError, "Missing the required parameter 'exercise_id' when calling TrainingDataApi.get_tcx" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}/exercises/{exercise-id}/tcx'.sub('{' + 'user-id' + '}', user_id.to_s).sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'exercise-id' + '}', exercise_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#get_tcx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List exercises After successfully initiating a transaction, training sessions included within it can be retrieved with the provided transactionId. @param transaction_id Transaction identifier @param user_id User identifier @param [Hash] opts the optional parameters @return [nil]
# File lib/polar_accesslink/api/training_data_api.rb, line 568 def list_exercises(transaction_id, user_id, opts = {}) list_exercises_with_http_info(transaction_id, user_id, opts) nil end
List exercises After successfully initiating a transaction, training sessions included within it can be retrieved with the provided transactionId. @param transaction_id Transaction identifier @param user_id User identifier @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/polar_accesslink/api/training_data_api.rb, line 579 def list_exercises_with_http_info(transaction_id, user_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrainingDataApi.list_exercises ...' end # verify the required parameter 'transaction_id' is set if @api_client.config.client_side_validation && transaction_id.nil? fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TrainingDataApi.list_exercises" end # verify the required parameter 'user_id' is set if @api_client.config.client_side_validation && user_id.nil? fail ArgumentError, "Missing the required parameter 'user_id' when calling TrainingDataApi.list_exercises" end # resource path local_var_path = '/v3/users/{user-id}/exercise-transactions/{transaction-id}'.sub('{' + 'transaction-id' + '}', transaction_id.to_s).sub('{' + 'user-id' + '}', user_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrainingDataApi#list_exercises\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end