class ZendeskAPI::User

Public Class Methods

cbp_path_regexes() click to toggle source
# File lib/zendesk_api/resources.rb, line 803
def self.cbp_path_regexes
  [/^users$/, %r{^organizations/\d+/users$}]
end
incremental_export(client, start_time) click to toggle source

Gets a incremental export of users from the start_time until now. @param [Client] client The {Client} object to be used @param [Integer] start_time The start_time parameter @return [Collection] Collection of {User}

# File lib/zendesk_api/resources.rb, line 833
def self.incremental_export(client, start_time)
  ZendeskAPI::Collection.new(client, self, :path => "incremental/users?start_time=#{start_time.to_i}")
end

Public Instance Methods

attributes_for_save() click to toggle source
# File lib/zendesk_api/resources.rb, line 892
def attributes_for_save
  # Don't send role_id, it's necessary
  # for side-loading, but causes problems on save
  # see #initialize
  attrs = attributes.changes.delete_if do |k, _|
    k == "role_id"
  end

  { self.class.singular_resource_name => attrs }
end
change_password(opts = {}) click to toggle source

Change a user’s password

# File lib/zendesk_api/resources.rb, line 815
def change_password(opts = {})
  password(opts.merge(:verb => :put))
end
change_password!(opts = {}) click to toggle source

Change a user’s password

# File lib/zendesk_api/resources.rb, line 825
def change_password!(opts = {})
  password!(opts.merge(:verb => :put))
end
clear_sessions() click to toggle source
# File lib/zendesk_api/resources.rb, line 864
def clear_sessions
  clear_sessions!
rescue ZendeskAPI::Error::ClientError
  false
end
clear_sessions!() click to toggle source
# File lib/zendesk_api/resources.rb, line 860
def clear_sessions!
  @client.connection.delete(path + '/sessions')
end
current_session() click to toggle source
# File lib/zendesk_api/resources.rb, line 854
def current_session
  ZendeskAPI::User::CurrentSession.find(@client, :user_id => 'me')
end
handle_response(*) click to toggle source
Calls superclass method
# File lib/zendesk_api/resources.rb, line 903
def handle_response(*)
  super

  # Needed for proper Role sideloading
  self.role_id = role.name if key?(:role)
end
set_password(opts = {}) click to toggle source

Set a user’s password

# File lib/zendesk_api/resources.rb, line 810
def set_password(opts = {})
  password(opts.merge(:verb => :post))
end
set_password!(opts = {}) click to toggle source

Set a user’s password

# File lib/zendesk_api/resources.rb, line 820
def set_password!(opts = {})
  password!(opts.merge(:verb => :post))
end