Module: FitbitClient::Resources::BodyAndWeight

Included in:
FitbitClient::Resources
Defined in:
lib/fitbit_client/resources/body_and_weight.rb

Instance Method Summary collapse

Instance Method Details

#body_fat_logs(date, period_or_end_date = nil, options = {}) ⇒ Object

The Get Body Fat Logs API retrieves a list of all user’s body fat log entries for a given day in the format requested. Body fat log entries are available only to authorized user.

If you need to fetch only the most recent entry, you can use the Get Body Measurements endpoint.

date               : base or start date
period_or_end_date : One of 1d, 7d, 1w, 1m or a Date object

Note: The range should not be longer than 31 days.



101
102
103
104
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 101

def body_fat_logs(date, period_or_end_date = nil, options = {})
  path = body_and_weight_path_for_period('fat', date, period_or_end_date)
  get_json(path_user_version(path, options))
end

#body_goals(goal_type, options = {}) ⇒ Object

Retrieves a user’s current body fat percentage or weight goal using units in the unit systems that corresponds to the Accept-Language header provided in the format requested.

goal_type : can be weight or fat



46
47
48
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 46

def body_goals(goal_type, options = {})
  get_json(path_user_version("/body/log/#{goal_type}/goal", options))
end

#body_time_series(resource, date, period_or_end_date, options = {}) ⇒ Object

The Get Body Time Series API returns time series data in the specified range for a given resource in the format requested using units in the unit systems that corresponds to the Accept-Language header provided.

Note: If you provide earlier dates in the request, the response retrieves only data since the user’s join date or the first log entry date for the requested collection.

resource           : Can be "bmi", "fat", or "weight".
date               : The range start date or end date of the period specified
period_or_end_date : One of  1d, 7d, 30d, 1w, 1m, 3m, 6m, 1y, max or the end date of the range



84
85
86
87
88
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 84

def body_time_series(resource, date, period_or_end_date, options = {})
  end_limit = period_or_date_param(period_or_end_date)
  path = time_series_path('body', resource, date, end_limit)
  get_json(path_user_version(path, options))
end

#delete_body_fat_log(body_fat_log_id, options = {}) ⇒ Object

The Delete Body Fat Log API deletes a user’s body fat log entry with the given ID.



122
123
124
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 122

def delete_body_fat_log(body_fat_log_id, options = {})
  successful_delete?(delete(path_user_version("/body/log/fat/#{body_fat_log_id}", options)))
end

#delete_weight_log(body_weight_log_id, options = {}) ⇒ Object

The Delete Weight Log API deletes a user’s body weight log entry with the given ID.



36
37
38
39
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 36

def delete_weight_log(body_weight_log_id, options = {})
  path = "/body/log/weight/#{body_weight_log_id}"
  successful_delete?(delete(path_user_version(path, options)))
end

#log_body_fat(fat, date, time = nil, options = {}) ⇒ Object

The Log Body Fat API creates a log entry for body fat and returns a response in the format requested.

Note: The returned Body Fat Log IDs are unique to the user, but not globally unique.

fat  : Body fat; in the format X.XX
date : Log entry date
time : Time of the measurement



115
116
117
118
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 115

def log_body_fat(fat, date, time = nil, options = {})
  params = key_value_date_time_params('fat', fat, date, time)
  post_json(path_user_version('/body/log/fat', options), params)
end

#log_weight(weight, date, time = nil, options = {}) ⇒ Object

The Log Weight API creates log entry for a body weight using units in the unit systems that corresponds to the Accept-Language header provided and get a response in the format requested.

Note: The returned Weight Log IDs are unique to the user, but not globally unique.

weight : Weight in the format X.XX
date   : Date of the measurement
time   : Time of the measurement



29
30
31
32
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 29

def log_weight(weight, date, time = nil, options = {})
  params = key_value_date_time_params('weight', weight, date, time)
  post_json(path_user_version('/body/log/weight', options), params)
end

#update_body_fat_goal(fat, options = {}) ⇒ Object

The Update Body Fat Goal API creates or updates user’s fat percentage goal.

fat : Target body fat percentage in the format X.XX



54
55
56
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 54

def update_body_fat_goal(fat, options = {})
  post_json(path_user_version('/body/log/fat/goal', options), 'fat' => fat)
end

#update_body_weight_goal(start_date, start_weight, weight = nil, options = {}) ⇒ Object

The Update Weight Goal API creates or updates user’s fat or weight goal using units in the unit systems that corresponds to the Accept-Language header provided in the format requested.

startDate   : Weight goal start date
startWeight : Weight goal start weight; in the format X.XX
weight      : Weight goal target weight; in the format X.XX, in the
              unit systems that corresponds to the Accept-Language
              header provided; required if user doesn't have an existing
              weight goal.



68
69
70
71
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 68

def update_body_weight_goal(start_date, start_weight, weight = nil, options = {})
  params = update_body_weight_goal_params(start_date, start_weight, weight)
  post_json(path_user_version('/body/log/weight/goal', options), params)
end

#weight_logs(date, period_or_end_date = nil, options = {}) ⇒ Object

The Get Weight Logs API retrieves a list of all user’s body weight log entries for a given day using units in the unit systems which corresponds to the Accept-Language header provided.

Body weight log entries are available only to authorized user.

Body weight log entries in response are sorted exactly the same as they are presented on the Fitbit website.



14
15
16
17
 
# File 'lib/fitbit_client/resources/body_and_weight.rb', line 14

def weight_logs(date, period_or_end_date = nil, options = {})
  path = body_and_weight_path_for_period('weight', date, period_or_end_date)
  get_json(path_user_version(path, options))
end