Class: Mailtrap::PermissionsAPI

Inherits:

Object

• Object
• Mailtrap::PermissionsAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/permissions_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary

• #bulk_update(account_access_id, permissions) ⇒ Hash

  Bulk-updates user or token permissions on an account access.

• #resources ⇒ Array<PermissionResource>

  Returns the recursive tree of resources the current token can access.

Methods included from BaseAPI

included, #initialize

Instance Method Details

#bulk_update(account_access_id, permissions) ⇒ Hash

Bulk-updates user or token permissions on an account access

Parameters:

• account_access_id (Integer) —

  The account access ID

• permissions (Array<Hash>) —

  Array of permission entries

  • ‘{ resource_id:, resource_type:, access_level: }` to create or update

  • ‘{ resource_id:, resource_type:, _destroy: true }` to remove

Returns:

• (Hash) —

  API response (e.g. ‘{ message: ’Permissions have been updated!‘ }`)

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/permissions_api.rb', line 17

def bulk_update(account_access_id, permissions)
  client.put(
    "#{base_path}/account_accesses/#{account_access_id}/permissions/bulk",
    { permissions: permissions }
  )
end

#resources ⇒ Array<PermissionResource>

Returns the recursive tree of resources the current token can access. Each node carries the token’s access_level and any nested child resources.

Returns:

• (Array<PermissionResource>) —

  Top-level resources, each with nested children

Raises:

• (Mailtrap::Error) —

  If the API request fails with a client or server error

• (Mailtrap::AuthorizationError) —

  If the API key is invalid

• (Mailtrap::RejectionError) —

  If the server refuses to process the request

• (Mailtrap::RateLimitError) —

  If too many requests are made

# File 'lib/mailtrap/permissions_api.rb', line 28

def resources
  response = client.get("#{base_path}/permissions/resources")
  build_resource_tree(response)
end