class Freshdesk::Api::Client::User

Constants

AGENTS
USERS

Public Class Methods

new(base_url, api_key) click to toggle source

Initialize with your freshdesk account url and api key.

# File lib/freshdesk/api/client/user.rb, line 9
def initialize base_url, api_key
        @connection = Freshdesk::Api::Client::Request.new base_url, api_key
end

Public Instance Methods

create_user(payload) click to toggle source

Create an user with payload. Please refer freshdesk.com/api#user

# File lib/freshdesk/api/client/user.rb, line 14
def create_user payload
        Freshdesk::Api::Client.convert_to_hash( @connection.post USERS, payload )
end
delete_agent(id) click to toggle source

Delete agent by its id.

# File lib/freshdesk/api/client/user.rb, line 66
def delete_agent id
        begin
                ( @connection.delete AGENTS, id ).code
        rescue Freshdesk::Api::ServerError
                200
        end
end
delete_user(id) click to toggle source

Delete user by its id.

# File lib/freshdesk/api/client/user.rb, line 59
def delete_user id
        Freshdesk::Api::Client.delete_status_wrapper do
                ( @connection.delete USERS, id ).code
        end
end
get_agent_by_email(email) click to toggle source

Get agent by passing an email.

# File lib/freshdesk/api/client/user.rb, line 39
def get_agent_by_email email
        Freshdesk::Api::Client.convert_to_hash( @connection.get AGENTS, nil, "query="+URI.encode("email is #{email}") )
end
get_agent_by_id(id) click to toggle source

Get agent by passing a valid agent id.

# File lib/freshdesk/api/client/user.rb, line 34
def get_agent_by_id id
        Freshdesk::Api::Client.convert_to_hash( @connection.get AGENTS, id)
end
get_agent_or_user_by_email(email) click to toggle source

Get a user or an agent by simply passing the email.

# File lib/freshdesk/api/client/user.rb, line 44
def get_agent_or_user_by_email email
        user = get_user_by_email email
        unless user.nil? or user.empty?
                { type: :user, response: user[0] }
        else
                agent = get_agent_by_email email
                unless agent.nil? or agent.empty?
                        { type: :agent, response: agent[0] }
                else
                        []
                end
        end
end
get_user_by_email(email) click to toggle source

Get user by passing an email.

# File lib/freshdesk/api/client/user.rb, line 24
def get_user_by_email email
        Freshdesk::Api::Client.convert_to_hash( @connection.get USERS, nil, "query="+URI.encode("email is #{email}") )
end
get_user_by_id(id) click to toggle source

Get user by passing a valid user id.

# File lib/freshdesk/api/client/user.rb, line 29
def get_user_by_id id
        Freshdesk::Api::Client.convert_to_hash( @connection.get USERS, id )
end
list_agents() click to toggle source

List all agents.

# File lib/freshdesk/api/client/user.rb, line 80
def list_agents
        Freshdesk::Api::Client.convert_to_hash( @connection.get AGENTS )
end
list_users() click to toggle source

List all users.

# File lib/freshdesk/api/client/user.rb, line 75
def list_users
        Freshdesk::Api::Client.convert_to_hash( @connection.get USERS )
end
update_user(id, payload) click to toggle source

Update an user by passing its id and payload. Please refer freshdesk.com/api#user

# File lib/freshdesk/api/client/user.rb, line 19
def update_user id, payload
        (@connection.put USERS, id, payload).code
end