fitbit_api 0.14.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32eab4ca789fa776fe5d1ddacf58dd51f43d01d12c049b2b4c5080c5969f902d
-  data.tar.gz: 4f83878440ed7f152f5a5eb3d101447972847c578adaf05b704d201565513189
+  metadata.gz: 35736e8dc53586ada210b2dc0431c619eed07d79001e5211283561f3922a2a2d
+  data.tar.gz: 36001c0eceb88dac465f1eabe2af276b009e504eef1ad39cdbcb105077b51df0
 SHA512:
-  metadata.gz: de894373c47758b4c7530ce3a4559a8284f3c2e2390f3925841015bced821a2c9370657199c527ac9a5416a597019c3bcf1d3a8dcb135fc0bda875aae4baea77
-  data.tar.gz: 3c03846f5f25e1117a88acbfb09e78903ec425deb663e7371154cbc3e57b8a70d43f17c5171bf41ee9c19a584fa932ad009a2171c1a2458637f01893c7b7e013
+  metadata.gz: 114303eb86c474c7e5e8c7338d5ff40e0febfb2c56fd85988cadd1a87c26babb535fa0829692f2582505f99e0a5434dae557f91b5a2a09f0be5ef06495db520d
+  data.tar.gz: 67594641c25ca473c4aa0edb6f96a84616805a0b1fbd4272483645d3e0f167d05be2412ae4b0fa996a1ceab88387b8701d1466bef554226ca3ee0d3fa134e1f5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.14.1
+------
+- Add documentation for several methods
+
 0.14.0
 ------
 - Add support for the following endpoints:

data/lib/fitbit_api/breathing_rate.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the average breathing rate data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   breathing_rate_summary(date: Date.parse('2021-04-16'))
+    #   breathing_rate_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def breathing_rate_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]
@@ -23,6 +35,18 @@ module FitbitAPI
       result.values[0]
     end
 
+    # Returns the intraday breathing rate data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   breathing_rate_intraday(date: Date.parse('2021-04-16'))
+    #   breathing_rate_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def breathing_rate_intraday(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/cardio_score.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the cardio fitness score data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   cardio_score_summary(date: Date.parse('2021-04-16'))
+    #   cardio_score_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def cardio_score_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/heart_rate_variability.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the heart rate variability data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   heart_rate_variability_summary(date: Date.parse('2021-04-16'))
+    #   heart_rate_variability_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def heart_rate_variability_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]
@@ -23,6 +35,18 @@ module FitbitAPI
       result.values[0]
     end
 
+    # Returns the heart rate variability intraday data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   heart_rate_variability_intraday(date: Date.parse('2021-04-16'))
+    #   heart_rate_variability_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def heart_rate_variability_intraday(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/oxygen_saturation.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the oxygen saturation summary data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   oxygen_saturation_summary(date: Date.parse('2021-04-16'))
+    #   oxygen_saturation_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def oxygen_saturation_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]
@@ -20,6 +32,18 @@ module FitbitAPI
       end
     end
 
+    # Returns the oxygen saturation intraday data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   oxygen_saturation_intraday(date: Date.parse('2021-04-16'))
+    #   oxygen_saturation_intraday(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def oxygen_saturation_intraday(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/temperature.rb

@@ -1,5 +1,17 @@
 module FitbitAPI
   class Client
+    # Returns the core temperature data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   core_temperature_summary(date: Date.parse('2021-04-16'))
+    #   core_temperature_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def core_temperature_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]
@@ -23,6 +35,18 @@ module FitbitAPI
       result.values[0]
     end
 
+    # Returns the skin temperature data for a given date or date range.
+    # If both a date and a date range are given, the date range takes precedence.
+    #
+    #   skin_temperature_summary(date: Date.parse('2021-04-16'))
+    #   skin_temperature_summary(start_date: Date.parse('2021-05-18'), end_date: Date.parse('2021-05-24'))
+    #
+    # @param params [Hash] The request parameters
+    #
+    # @option params :date [Date] The target date
+    # @option params :start_date [Date] The start of the date range
+    # @option params :end_date [Date] The end of the date range
+
     def skin_temperature_summary(opts={})
       date       = opts[:date] || Date.today
       start_date = opts[:start_date]

data/lib/fitbit_api/version.rb

@@ -1,3 +1,3 @@
 module FitbitAPI
-  VERSION = '0.14.0'
+  VERSION = '0.14.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fitbit_api
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Zoran
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-05 00:00:00.000000000 Z
+date: 2022-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth2