Class: Mailtrap::AccountsAPI

Inherits:

Object

Object
Mailtrap::AccountsAPI

show all

Includes:: BaseAPI

Defined in:: lib/mailtrap/accounts_api.rb

Instance Attribute Summary collapse

#client ⇒ Object readonly

Returns the value of attribute client.

Attributes included from BaseAPI

Instance Method Summary collapse

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

A new instance of AccountsAPI.
#list ⇒ Array<Account>

Lists all accounts.

Methods included from BaseAPI

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



16
17
18

# 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.



12
13
14

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

def 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



23
24
25

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

def list
  base_list
end