module Paperdrive::Client::Users

Instance methods related to Users to embed into Paperdrive::Client
arguments are compatible with the Pipedribe API.

@see developers.pipedrive.com/docs/api/v1/#!/Users

Public Instance Methods

all_users(**args) click to toggle source
GET

Get all users

@see developers.pipedrive.com/docs/api/v1/#!/Users/get_users @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 18
def all_users(**args)
  params = parameters(args) do
    optional_params
  end
  request(:get, 'users', params)
end
create_user(**args) click to toggle source
POST

Add a new user

@see developers.pipedrive.com/docs/api/v1/#!/Users/post_users @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 148
def create_user(**args)
  params = parameters(args) do
    required_params :name, :email, :active_flag
    optional_params :name, :email, :active_flag
  end
  request(:post, 'users', params)
end
create_user_blacklisted_email(id:, **args) click to toggle source
POST

Add blacklisted email address for a user

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/post_users_id_blacklistedEmails @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 161
def create_user_blacklisted_email(id:, **args)
  params = parameters(args) do
    required_params :address
    optional_params :address
  end
  request(:post, "users/#{id}/blacklistedEmails", params)
end
create_user_permission_set_assignment(id:, **args) click to toggle source
POST

Add permission set assignment

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/post_users_id_permissionSetAssignments @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 174
def create_user_permission_set_assignment(id:, **args)
  params = parameters(args) do
    required_params :permission_set_id
    optional_params :permission_set_id
  end
  request(:post, "users/#{id}/permissionSetAssignments", params)
end
create_user_role_assignment(id:, **args) click to toggle source
POST

Add role assignment

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/post_users_id_roleAssignments @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 187
def create_user_role_assignment(id:, **args)
  params = parameters(args) do
    required_params :role_id
    optional_params :role_id
  end
  request(:post, "users/#{id}/roleAssignments", params)
end
current_user(**args) click to toggle source
GET

Get current user data

@see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_me @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 41
def current_user(**args)
  params = parameters(args) do
    optional_params
  end
  request(:get, 'users/me', params)
end
delete_user_permission_set_assignment(id:, **args) click to toggle source
DELETE

Delete a permission set assignment

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/delete_users_id_permissionSetAssignments @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 213
def delete_user_permission_set_assignment(id:, **args)
  params = parameters(args) do
    required_params :permission_set_id
    optional_params :permission_set_id
  end
  request(:delete, "users/#{id}/permissionSetAssignments", params)
end
delete_user_role_assignment(id:, **args) click to toggle source
DELETE

Delete a role assignment

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/delete_users_id_roleAssignments @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 226
def delete_user_role_assignment(id:, **args)
  params = parameters(args) do
    required_params :role_id
    optional_params :role_id
  end
  request(:delete, "users/#{id}/roleAssignments", params)
end
find_users_by_name(**args) click to toggle source
GET

Find users by name

@see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_find @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 29
def find_users_by_name(**args)
  params = parameters(args) do
    required_params :term
    optional_params :term, :search_by_email
  end
  request(:get, 'users/find', params)
end
update_user(id:, **args) click to toggle source
PUT

Update user details

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/put_users_id @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 200
def update_user(id:, **args)
  params = parameters(args) do
    required_params :active_flag
    optional_params :active_flag
  end
  request(:put, "users/#{id}", params)
end
user(id:, **args) click to toggle source
GET

Get one user

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 53
def user(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "users/#{id}", params)
end
user_activities(id:, **args) click to toggle source
GET

List and filter activities assigned to a specific user

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_activities @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 65
def user_activities(id:, **args)
  params = parameters(args) do
    optional_params :due_date, :type, :start, :limit, :done
  end
  request(:get, "users/#{id}/activities", params)
end
user_blacklisted_emails(id:, **args) click to toggle source
GET

List blacklisted email addresses of a user

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_blacklistedEmails @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 77
def user_blacklisted_emails(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "users/#{id}/blacklistedEmails", params)
end
user_followers(id:, **args) click to toggle source
GET

List followers of a user

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_followers @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 89
def user_followers(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "users/#{id}/followers", params)
end
user_permission_set_assignments(id:, **args) click to toggle source
GET

List permission set assignments

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_permissionSetAssignments @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 101
def user_permission_set_assignments(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit
  end
  request(:get, "users/#{id}/permissionSetAssignments", params)
end
user_permissions(id:, **args) click to toggle source
GET

List user permissions

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_permissions @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 113
def user_permissions(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "users/#{id}/permissions", params)
end
user_role_assignments(id:, **args) click to toggle source
GET

List role assignments

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_roleAssignments @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 125
def user_role_assignments(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit
  end
  request(:get, "users/#{id}/roleAssignments", params)
end
user_role_settings(id:, **args) click to toggle source
GET

List user role settings

@param [integer] id: @see developers.pipedrive.com/docs/api/v1/#!/Users/get_users_id_roleSettings @return [Paperdrive::Response]

# File lib/paperdrive/client/users.rb, line 137
def user_role_settings(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "users/#{id}/roleSettings", params)
end