fitbit_api 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 303b1eda2135541723313d505d4c34292e94b473c2a87cff32119bd8de97b0ea
-  data.tar.gz: c526445b8815cbe19ce92f6b762036aae9bbf57cfccea2cba9131ed63788307e
+  metadata.gz: 767484bcfc76da3df543118553915957931085d397929a10a4ab044aa2a0ccf8
+  data.tar.gz: 58c722470d69043d9bed70e0234471d76f1156612c7222d1a2725a73b2acdb4e
 SHA512:
-  metadata.gz: d7cc3ae62f509e40a0c58bc31f5ffc75865909d482e862401afa0737fc6138ea226c3a9909721903b86f00febd1a8eea46ac01b1d93d2c9dbd0d706b6c201938
-  data.tar.gz: d0d6328a931c8d3fe931f6e31b283681092b31d4b50d5186aeb1a7b8efe885dbf828d0c058a5296c4a4abe9b7e8b13b183482d1f6dc6102aac38a98284d9f3ec
+  metadata.gz: febd698371e86ef605756827d51cd5d2fd669df5ac0737254b842cb15ec6912f3675578479596f0fac7eed6e02cf1fce85336b83777d01e108700763559086de
+  data.tar.gz: 170fc85f95423adbf6179087a9912c40ed5d830bc333a6a897f40ca808188721e314f44a241811644c30243421c388af64b780fcfb9b18bd20e117ce5ac9d89d

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.10.1
+------
+- Fix docs for listed options
+
 0.10.0
 ------
 - Add `auto_refresh_token` config to make token auto-refreshing configurable (defaults to true).

data/lib/fitbit_api/activities.rb

@@ -54,11 +54,11 @@ module FitbitAPI
     #
     #   activity_logs_list(before_date: Date.parse('2021-05-24'), limit: 5)
     #
-    # @option before_date [Date] Specify when filtering entries that occured before the given date
-    # @option after_date [Date] Specify when filtering entries that occured after the given date
-    # @option sort [String] the Sort order of entries by date (asc or desc)
-    # @option offset [Integer] The offset number of entries. Must always be 0
-    # @option limit [Integer] The max of the number of entries returned (max: 20)
+    # @param before_date [Date] Specify when filtering entries that occured before the given date
+    # @param after_date [Date] Specify when filtering entries that occured after the given date
+    # @param sort [String] the Sort order of entries by date (asc or desc)
+    # @param offset [Integer] The offset number of entries. Must always be 0
+    # @param limit [Integer] The max of the number of entries returned (max: 20)
 
     def activity_logs_list(opts={})
       opts[:params] = {}
@@ -153,14 +153,14 @@ module FitbitAPI
     #
     #   log_activity(body: { activity_id: 90013, manual_calories: 300, duration_millis: 6000000 })
     #
-    # @option activity_id [Integer, String] The activity ID
-    # @option activity_name [String] Custom activity name. Either activity ID or activity_name must be provided
-    # @option manual_calories [Integer] Calories burned, specified manually. Required with activity_name, otherwise optional
-    # @option start_time [String] Activity start time; formatted in HH:mm:ss
-    # @option duration_millis [Integer] Duration in milliseconds
-    # @option date [String] Log entry date; formatted in yyyy-MM-dd
-    # @option distance [Integer] Distance; required for logging directory activity
-    # @option distance_unit [String] Distance measurement unit
+    # @param activity_id [Integer, String] The activity ID
+    # @param activity_name [String] Custom activity name. Either activity ID or activity_name must be provided
+    # @param manual_calories [Integer] Calories burned, specified manually. Required with activity_name, otherwise optional
+    # @param start_time [String] Activity start time; formatted in HH:mm:ss
+    # @param duration_millis [Integer] Duration in milliseconds
+    # @param date [String] Log entry date; formatted in yyyy-MM-dd
+    # @param distance [Integer] Distance; required for logging directory activity
+    # @param distance_unit [String] Distance measurement unit
 
     def log_activity(opts)
       post("user/#{user_id}/activities.json", opts)

data/lib/fitbit_api/alarms.rb

@@ -20,10 +20,10 @@ module FitbitAPI
     #
     # @param tracker_id [Integer] The ID of the tracker for which the alarm is created
     #
-    # @option time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
-    # @option enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
-    # @option recurring [Boolean] If false, the alarm is a single event
-    # @option week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
+    # @param time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
+    # @param enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
+    # @param recurring [Boolean] If false, the alarm is a single event
+    # @param week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
 
     def add_alarm(tracker_id, opts={})
       post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms.json", opts)
@@ -34,14 +34,14 @@ module FitbitAPI
     # @param tracker_id [Integer] The ID of the tracker for which the alarm is created
     # @param alarm_id [Integer] The ID of the alarm to be updated
     #
-    # @option time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
-    # @option enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
-    # @option recurring [Boolean] If false, the alarm is a single event
-    # @option week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
-    # @option snooze_length [Integer] Minutes between alarms
-    # @option snooze_count [Integer] Maximum snooze count
-    # @option label [String] Label for alarm
-    # @option vibe [String] Vibe pattern; only one value for now (DEFAULT)
+    # @param time [String] Time of day that the alarm vibrates with a UTC timezone offset, e.g. 07:15-08:00
+    # @param enabled [Boolean] If false, alarm does not vibrate until enabled is set to true
+    # @param recurring [Boolean] If false, the alarm is a single event
+    # @param week_days [String] Comma separated list of days of the week on which the alarm vibrates (MONDAY,TUESDAY)
+    # @param snooze_length [Integer] Minutes between alarms
+    # @param snooze_count [Integer] Maximum snooze count
+    # @param label [String] Label for alarm
+    # @param vibe [String] Vibe pattern; only one value for now (DEFAULT)
 
     def update_alarm(tracker_id, alarm_id, opts={})
       post("user/#{user_id}/devices/tracker/#{tracker_id}/alarms/#{alarm_id}.json", opts)

data/lib/fitbit_api/goals.rb

@@ -35,11 +35,11 @@ module FitbitAPI
     #
     #   create_or_update_daily_goals(body: {calories_out: 2000, active_minutes: 90, floors: 5})
     #
-    # @option calories_out [Integer] Calories output goal value
-    # @option active_minutes [Integer] Active minutes goal value
-    # @option floors [Integer] Floor goal value
-    # @option distance [Integer, Float] Distance goal value
-    # @option steps [Integer] Steps goal value
+    # @param calories_out [Integer] Calories output goal value
+    # @param active_minutes [Integer] Active minutes goal value
+    # @param floors [Integer] Floor goal value
+    # @param distance [Integer, Float] Distance goal value
+    # @param steps [Integer] Steps goal value
 
     def create_or_update_daily_goals(opts={})
       post("user/#{user_id}/activities/goals/daily.json", opts)
@@ -50,11 +50,11 @@ module FitbitAPI
     #
     #   create_or_update_weekly_goals(body: { active_minutes: 300, floors: 20 })
     #
-    # @option calories_out [Integer] Calories output goal value
-    # @option active_minutes [Integer] Active minutes goal value
-    # @option floors [Integer] Floor goal value
-    # @option distance [Integer, Float] Distance goal value
-    # @option steps [Integer] Steps goal value
+    # @param calories_out [Integer] Calories output goal value
+    # @param active_minutes [Integer] Active minutes goal value
+    # @param floors [Integer] Floor goal value
+    # @param distance [Integer, Float] Distance goal value
+    # @param steps [Integer] Steps goal value
 
     def create_or_update_weekly_goals(opts={})
       post("user/#{user_id}/activities/goals/weekly.json", opts)

data/lib/fitbit_api/version.rb

@@ -1,3 +1,3 @@
 module FitbitAPI
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Zoran