class PolarAccesslink::UsersApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/polar_accesslink/api/users_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

delete_user(user_id, opts = {}) click to toggle source

Delete user When partner wishes no longer to receive user data, user can be de-registered.This will revoke the access token authorized by user. @param user_id User identifier @param [Hash] opts the optional parameters @return [nil]

# File lib/polar_accesslink/api/users_api.rb, line 27
def delete_user(user_id, opts = {})
  delete_user_with_http_info(user_id, opts)
  nil
end
delete_user_with_http_info(user_id, opts = {}) click to toggle source

Delete user When partner wishes no longer to receive user data, user can be de-registered.This will revoke the access token authorized by user. @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/users_api.rb, line 37
def delete_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.delete_user ...'
  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 UsersApi.delete_user"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}'.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(:DELETE, 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: UsersApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_user_information(user_id, opts = {}) click to toggle source

Get user information List user basic information. Note: Although it is possible to get users weight and height from this resource, the [get physical info](get-physical-info) should be used instead. @param user_id User identifier @param [Hash] opts the optional parameters @return [nil]

# File lib/polar_accesslink/api/users_api.rb, line 76
def get_user_information(user_id, opts = {})
  get_user_information_with_http_info(user_id, opts)
  nil
end
get_user_information_with_http_info(user_id, opts = {}) click to toggle source

Get user information List user basic information. Note: Although it is possible to get users weight and height from this resource, the [get physical info](get-physical-info) should be used instead. @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/users_api.rb, line 86
def get_user_information_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.get_user_information ...'
  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 UsersApi.get_user_information"
  end
  # resource path
  local_var_path = '/v3/users/{user-id}'.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: UsersApi#get_user_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
register_user(opts = {}) click to toggle source

Register user Once partner has been authorized by user, partner must register user before being able to access her data. @param [Hash] opts the optional parameters @return [nil]

# File lib/polar_accesslink/api/users_api.rb, line 124
def register_user(opts = {})
  register_user_with_http_info(opts)
  nil
end
register_user_with_http_info(opts = {}) click to toggle source

Register user Once partner has been authorized by user, partner must register user before being able to access her data. @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers

# File lib/polar_accesslink/api/users_api.rb, line 133
def register_user_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UsersApi.register_user ...'
  end
  # resource path
  local_var_path = '/v3/users'

  # 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: UsersApi#register_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end