Class: Mailosaur::Usage

Inherits:
Object
  • Object
show all
Defined in:
lib/Mailosaur/usage.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(conn, handle_http_error) ⇒ Usage

Creates and initializes a new instance of the Usage class.

Parameters:

  • client —

    connection.



7
8
9
10
 
# File 'lib/Mailosaur/usage.rb', line 7

def initialize(conn, handle_http_error)
  @conn = conn
  @handle_http_error = handle_http_error
end

Instance Attribute Details

#conn ⇒ Connection (readonly)

Returns the client connection.

Returns:

  • (Connection) —

    the client connection.



13
14
15
 
# File 'lib/Mailosaur/usage.rb', line 13

def conn
  @conn
end

Instance Method Details

#limits ⇒ UsageAccountLimits

Retrieve account usage limits.

Details the current limits and usage for your account.

Returns:

  • (UsageAccountLimits) —

    operation results.



22
23
24
25
26
27
 
# File 'lib/Mailosaur/usage.rb', line 22

def limits
  response = conn.get 'api/usage/limits'
  @handle_http_error.call(response) unless response.status == 200
  model = JSON.parse(response.body)
  Mailosaur::Models::UsageAccountLimits.new(model)
end

#transactions ⇒ UsageTransactionListResult

List account transactions. Retrieves the last 31 days of transactional usage.

Returns:

  • (UsageTransactionListResult) —

    operation results.



34
35
36
37
38
39
 
# File 'lib/Mailosaur/usage.rb', line 34

def transactions
  response = conn.get 'api/usage/transactions'
  @handle_http_error.call(response) unless response.status == 200
  model = JSON.parse(response.body)
  Mailosaur::Models::UsageTransactionListResult.new(model)
end