class Mailosaur::Usage

Attributes

conn[R]

@return [Connection] the client connection.

Public Class Methods

new(conn, handle_http_error) click to toggle source

Creates and initializes a new instance of the Usage class. @param client connection.

# File lib/Mailosaur/usage.rb, line 7
def initialize(conn, handle_http_error)
  @conn = conn
  @handle_http_error = handle_http_error
end

Public Instance Methods

limits() click to toggle source

Retrieve account usage limits.

Details the current limits and usage for your account.

@return [UsageAccountLimits] operation results.

# 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.load(response.body)
  Mailosaur::Models::UsageAccountLimits.new(model)
end
transactions() click to toggle source

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

@return [UsageTransactionListResult] operation results.

# 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.load(response.body)
  Mailosaur::Models::UsageTransactionListResult.new(model)
end