module Toggl::Api::User

Public Instance Methods

me(related_data=false) click to toggle source

pass related_data as true to all related data

# File lib/toggl_api/api/user.rb, line 6
def me(related_data=false)
  get "/me",{:with_related_data => related_data }
end
reset_token() click to toggle source
# File lib/toggl_api/api/user.rb, line 40
def reset_token
  post "/reset_token"
end
signup(email, password, timezone, created_with="Toggl Api Ruby Gem click to toggle source

email: a valid email for the user whose account is created (string, required) password: password at least 6 characters long (string, required) timezone: for example “Etc/UTC” (string, required) created_with: in free form, name of the app that signed the user app (string, required)

# File lib/toggl_api/api/user.rb, line 36
def signup(email, password, timezone, created_with="Toggl Api Ruby Gem #{Toggl::VERSION}")
  post "/signups",{"user" => {"email" => email,"password" => "password","timezone" => timezone,"created_with" => created_with}}
end
update_me(options={}) click to toggle source

You can update the following user fields: fullname: string email: string, valid email send_product_emails: boolean send_weekly_report: boolean send_timer_notifications: boolean store_start_and_stop_time: boolean beginning_of_week: integer, in the range of 0-6 timezone: string, IANA TZ timezones timeofday_format: string, two formats are supported: “H:mm” for 24-hour format “h:mm A” for 12-hour format (AM/PM) date_format: string, possible values: “YYYY-MM-DD”, “DD.MM.YYYY”, “DD-MM-YYYY”, “MM/DD/YYYY”, “DD/MM/YYYY”, “MM-DD-YYYY”

To change password you have to have the following fields: current_password: string password: string

# File lib/toggl_api/api/user.rb, line 27
def update_me(options={})
  options = Hashie::Mash.new options
  put "/me", (options.key?(:user) ? options : {:user => options})
end