Contents

module FitbitAPI
  class Client
    # Retrieves a list of subscriptions created by your application for a specific user.
    # You can either fetch subscriptions for a specific collection or the entire list
    # of subscriptions for the user.
    #
    # @param collection_path [String] Collection of data to retrieve notifications

    def subscriptions(collection_path=nil)
      get("#{subscriptions_path(collection_path)}.json")
    end

    # Creates a subscription to notify the application when a user has new data available.
    #
    # @param collection_path [String] Collection of data to retrieve notifications
    # @param subscription_id [Integer] The unique ID of the subscription created by the API client application

    def create_subscription(collection_path=nil, subscription_id)
      post("#{subscriptions_path(collection_path)}/#{subscription_id}.json")
    end

    # Deletes a subscription for a specific user.
    #
    # @param collection_path [String] Collection of data to retrieve notifications
    # @param subscription_id [Integer] The unique ID of the subscription created by the API client application

    def delete_subscription(collection_path=nil, subscription_id)
      delete("#{subscriptions_path(collection_path)}/#{subscription_id}.json")
    end

    private

    def subscriptions_path(collection_path=nil)
      collection_path = "#{collection_path}/" if collection_path
      "user/#{user_id}/#{collection_path}apiSubscriptions"
    end
  end
end

Version data entries

8 entries across 8 versions & 1 rubygems

Version	Path
fitbit_api-0.14.2	lib/fitbit_api/subscriptions.rb
fitbit_api-0.14.1	lib/fitbit_api/subscriptions.rb
fitbit_api-0.14.0	lib/fitbit_api/subscriptions.rb
fitbit_api-0.13.0	lib/fitbit_api/subscriptions.rb
fitbit_api-0.12.2	lib/fitbit_api/subscriptions.rb
fitbit_api-0.12.1	lib/fitbit_api/subscriptions.rb
fitbit_api-0.12.0	lib/fitbit_api/subscriptions.rb
fitbit_api-0.11.0	lib/fitbit_api/subscriptions.rb