Class: Mailtrap::AccountAccessesAPI

Inherits:

Object

• Object
• Mailtrap::AccountAccessesAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/account_accesses_api.rb

Instance Attribute Summary

• #account_id ⇒ Object readonly

  Returns the value of attribute account_id.

Attributes included from BaseAPI

#client

Instance Method Summary

• #delete(account_access_id) ⇒ Hash

  Deletes an account access.

• #list(domain_ids: [], inbox_ids: [], project_ids: []) ⇒ Array<AccountAccess>

  Retrieves a list of account accesses with optional filtering by domain, inbox, or project IDs.

Methods included from BaseAPI

included, #initialize

Instance Attribute Details

#account_id ⇒ Object (readonly)

Returns the value of attribute account_id.

# File 'lib/mailtrap/account_accesses_api.rb', line 10

def account_id
  @account_id
end

Instance Method Details

#delete(account_access_id) ⇒ Hash

Deletes an account access

Parameters:

• account_access_id (Integer) —

  The account access ID

Returns:

• (Hash)

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/account_accesses_api.rb', line 33

def delete(account_access_id)
  base_delete(account_access_id)
end

#list(domain_ids: [], inbox_ids: [], project_ids: []) ⇒ Array<AccountAccess>

Retrieves a list of account accesses with optional filtering by domain, inbox, or project IDs

Parameters:

• domain_ids (Array<Integer>) (defaults to: []) —

  Optional array of domain IDs to filter by

• inbox_ids (Array<Integer>) (defaults to: []) —

  Optional array of inbox IDs to filter by

• project_ids (Array<Integer>) (defaults to: []) —

  Optional array of project IDs to filter by

Returns:

• (Array<AccountAccess>) —

  List of account access objects

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/account_accesses_api.rb', line 20

def list(domain_ids: [], inbox_ids: [], project_ids: [])
  query_params = {}
  query_params[:domain_ids] = domain_ids unless domain_ids.empty?
  query_params[:inbox_ids] = inbox_ids unless inbox_ids.empty?
  query_params[:project_ids] = project_ids unless project_ids.empty?

  base_list(query_params)
end