module Paperdrive::Client::PermissionSets

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

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

Public Instance Methods

all_permission_set_assignments(id:, **args) click to toggle source
GET

List permission set assignments

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

# 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) click to toggle source
GET

Get all permission sets

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

# 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) click to toggle source
POST

Add permission set assignment

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

# 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) click to toggle source
DELETE

Delete a permission set assignment

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

# 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) click to toggle source
GET

Get one permission set

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

# 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) click to toggle source
PUT

Update permission set details

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

# 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