Module: Paperdrive::Client::PermissionSets

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

Overview

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

See Also:

Instance Method Summary collapse

Instance Method Details

#all_permission_set_assignments(id:, **args) ⇒ Paperdrive::Response

GET

List permission set assignments

Parameters:

  • id: (integer)

Returns:

See Also:



42
43
44
45
46
47
 
# File 'lib/paperdrive/client/permission_sets.rb', line 42

def all_permission_set_assignments(id:, **args)
  params = parameters(args) do
    optional_params :start, :limit
  end
  request(:get, "permissionSets/#{id}/assignments", params)
end

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

GET

Get all permission sets

Returns:

See Also:



18
19
20
21
22
23
 
# File 'lib/paperdrive/client/permission_sets.rb', line 18

def all_permission_sets(**args)
  params = parameters(args) do
    optional_params
  end
  request(:get, 'permissionSets', params)
end

#create_permission_set_assignment(id:, **args) ⇒ Paperdrive::Response

POST

Add permission set assignment

Parameters:

  • id: (integer)

Returns:

See Also:



54
55
56
57
58
59
60
 
# File 'lib/paperdrive/client/permission_sets.rb', line 54

def create_permission_set_assignment(id:, **args)
  params = parameters(args) do
    required_params :user_id
    optional_params :user_id
  end
  request(:post, "permissionSets/#{id}/assignments", params)
end

#delete_permission_set_assignment(id:, **args) ⇒ Paperdrive::Response

DELETE

Delete a permission set assignment

Parameters:

  • id: (integer)

Returns:

See Also:



80
81
82
83
84
85
86
 
# File 'lib/paperdrive/client/permission_sets.rb', line 80

def delete_permission_set_assignment(id:, **args)
  params = parameters(args) do
    required_params :user_id
    optional_params :user_id
  end
  request(:delete, "permissionSets/#{id}/assignments", params)
end

#permission_set(id:, **args) ⇒ Paperdrive::Response

GET

Get one permission set

Parameters:

  • id: (integer)

Returns:

See Also:



30
31
32
33
34
35
 
# File 'lib/paperdrive/client/permission_sets.rb', line 30

def permission_set(id:, **args)
  params = parameters(args) do
    optional_params
  end
  request(:get, "permissionSets/#{id}", params)
end

#update_permission_set(id:, **args) ⇒ Paperdrive::Response

PUT

Update permission set details

Parameters:

  • id: (integer)

Returns:

See Also:



67
68
69
70
71
72
73
 
# File 'lib/paperdrive/client/permission_sets.rb', line 67

def update_permission_set(id:, **args)
  params = parameters(args) do
    required_params :contents
    optional_params :contents
  end
  request(:put, "permissionSets/#{id}", params)
end