Class: PolarAccesslink::SleepApi

Inherits:
Object
  • Object
show all
Defined in:
lib/polar_accesslink/api/sleep_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SleepApi

Returns a new instance of SleepApi.



19
20
21
 
# File 'lib/polar_accesslink/api/sleep_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/polar_accesslink/api/sleep_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_nights(opts = {}) ⇒ nil

List nights List sleep data of user for the last 28 days.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/polar_accesslink/api/sleep_api.rb', line 26

def list_nights(opts = {})
  list_nights_with_http_info(opts)
  nil
end

#list_nights_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

List nights List sleep data of user for the last 28 days.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/polar_accesslink/api/sleep_api.rb', line 35

def list_nights_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SleepApi.list_nights ...'
  end
  # resource path
  local_var_path = '/v3/users/sleep'

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

#v3_users_sleep_available_get(opts = {}) ⇒ nil

Get available sleep times Get the dates with sleep start and end times, where user has sleep data available in the last 28 days.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


69
70
71
72
 
# File 'lib/polar_accesslink/api/sleep_api.rb', line 69

def v3_users_sleep_available_get(opts = {})
  v3_users_sleep_available_get_with_http_info(opts)
  nil
end

#v3_users_sleep_available_get_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get available sleep times Get the dates with sleep start and end times, where user has sleep data available in the last 28 days.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/polar_accesslink/api/sleep_api.rb', line 78

def v3_users_sleep_available_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SleepApi.v3_users_sleep_available_get ...'
  end
  # resource path
  local_var_path = '/v3/users/sleep/available'

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

#v3_users_sleep_date_get(date, opts = {}) ⇒ nil

Get Sleep Get Users sleep data for given date.

Parameters:

  • date —

    Date of sleep as ISO-8601 date string, example: &quot;2020-01-01&quot;

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


113
114
115
116
 
# File 'lib/polar_accesslink/api/sleep_api.rb', line 113

def v3_users_sleep_date_get(date, opts = {})
  v3_users_sleep_date_get_with_http_info(date, opts)
  nil
end

#v3_users_sleep_date_get_with_http_info(date, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get Sleep Get Users sleep data for given date.

Parameters:

  • date —

    Date of sleep as ISO-8601 date string, example: &quot;2020-01-01&quot;

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/polar_accesslink/api/sleep_api.rb', line 123

def v3_users_sleep_date_get_with_http_info(date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SleepApi.v3_users_sleep_date_get ...'
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling SleepApi.v3_users_sleep_date_get"
  end
  # resource path
  local_var_path = '/v3/users/sleep/{date}'.sub('{' + 'date' + '}', date.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: SleepApi#v3_users_sleep_date_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end