Module: Paperdrive::Client::Users

Includes:
Parameters
Included in:
Paperdrive::Client
Defined in:
lib/paperdrive/client/users.rb

Overview

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

See Also:

Instance Method Summary collapse

Instance Method Details

#all_users(**args) ⇒ Paperdrive::Response

GET

Get all users

Returns:

See Also:



18
19
20
21
22
23
 
# 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) ⇒ Paperdrive::Response

POST

Add a new user

Returns:

See Also:



148
149
150
151
152
153
154
 
# 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) ⇒ Paperdrive::Response

POST

Add blacklisted email address for a user

Parameters:

  • id: (integer)

Returns:

See Also:



161
162
163
164
165
166
167
 
# 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) ⇒ Paperdrive::Response

POST

Add permission set assignment

Parameters:

  • id: (integer)

Returns:

See Also:



174
175
176
177
178
179
180
 
# 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) ⇒ Paperdrive::Response

POST

Add role assignment

Parameters:

  • id: (integer)

Returns:

See Also:



187
188
189
190
191
192
193
 
# 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) ⇒ Paperdrive::Response

GET

Get current user data

Returns:

See Also:



41
42
43
44
45
46
 
# 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) ⇒ Paperdrive::Response

DELETE

Delete a permission set assignment

Parameters:

  • id: (integer)

Returns:

See Also:



213
214
215
216
217
218
219
 
# 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) ⇒ Paperdrive::Response

DELETE

Delete a role assignment

Parameters:

  • id: (integer)

Returns:

See Also:



226
227
228
229
230
231
232
 
# 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) ⇒ Paperdrive::Response

GET

Find users by name

Returns:

See Also:



29
30
31
32
33
34
35
 
# 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) ⇒ Paperdrive::Response

PUT

Update user details

Parameters:

  • id: (integer)

Returns:

See Also:



200
201
202
203
204
205
206
 
# 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) ⇒ Paperdrive::Response

GET

Get one user

Parameters:

  • id: (integer)

Returns:

See Also:



53
54
55
56
57
58
 
# 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) ⇒ Paperdrive::Response

GET

List and filter activities assigned to a specific user

Parameters:

  • id: (integer)

Returns:

See Also:



65
66
67
68
69
70
 
# 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) ⇒ Paperdrive::Response

GET

List blacklisted email addresses of a user

Parameters:

  • id: (integer)

Returns:

See Also:



77
78
79
80
81
82
 
# 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) ⇒ Paperdrive::Response

GET

List followers of a user

Parameters:

  • id: (integer)

Returns:

See Also:



89
90
91
92
93
94
 
# 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) ⇒ Paperdrive::Response

GET

List permission set assignments

Parameters:

  • id: (integer)

Returns:

See Also:



101
102
103
104
105
106
 
# 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) ⇒ Paperdrive::Response

GET

List user permissions

Parameters:

  • id: (integer)

Returns:

See Also:



113
114
115
116
117
118
 
# 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) ⇒ Paperdrive::Response

GET

List role assignments

Parameters:

  • id: (integer)

Returns:

See Also:



125
126
127
128
129
130
 
# 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) ⇒ Paperdrive::Response

GET

List user role settings

Parameters:

  • id: (integer)

Returns:

See Also:



137
138
139
140
141
142
 
# 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