Class: Mailtrap::AccountsAPI

Inherits:

Object

• Object
• Mailtrap::AccountsAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/accounts_api.rb

Instance Attribute Summary

Attributes included from BaseAPI

#account_id, #client

Instance Method Summary

• #initialize(client = Mailtrap::Client.new) ⇒ AccountsAPI constructor

  A new instance of AccountsAPI.

• #list ⇒ Array<Account>

  Lists all accounts.

Methods included from BaseAPI

included

Constructor Details

#initialize(client = Mailtrap::Client.new) ⇒ AccountsAPI

Returns a new instance of AccountsAPI.

Parameters:

• client (Mailtrap::Client) (defaults to: Mailtrap::Client.new) —

  The client instance

Raises:

• (ArgumentError) —

  If account_id is nil

# File 'lib/mailtrap/accounts_api.rb', line 14

def initialize(client = Mailtrap::Client.new)
  @client = client
end

Instance Method Details

#list ⇒ Array<Account>

Lists all accounts

Returns:

• (Array<Account>) —

  Array of accounts

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/accounts_api.rb', line 21

def list
  base_list
end