Class: Mailtrap::AccountsAPI

Inherits:

Object

• Object
• Mailtrap::AccountsAPI

Includes:

BaseAPI

Defined in:

lib/mailtrap/accounts_api.rb

Instance Attribute Summary

• #client ⇒ Object readonly

  Returns the value of attribute client.

Attributes included from BaseAPI

#account_id

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.

Raises:

• If account_id is nil

Parameters:

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

  The client instance

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

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

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.

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

def client
  @client
end

Instance Method Details

#list ⇒ Array<Account>

Lists all accounts

Raises:

• If the API request fails with a client or server error

• If the API key is invalid

• If the server refuses to process the request

• If too many requests are made

Returns:

• Array of accounts

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

def list
  base_list
end