class Phaxio::Resources::Account

Information about your Phaxio account.

Constants

ACCOUNT_PATH

Public Class Methods

get(params = {}) click to toggle source

Get information about your Phaxio account, including your balance, number of faxes sent today, and number of faxes sent this week. @param params [Hash]

Any parameters to send to Phaxio. This action does not have any unique parameters.

@return [Phaxio::Resources::Acount] Your account information. @raise [Phaxio::Error::PhaxioError] @see www.phaxio.com/docs/api/v2/account/status

# File lib/phaxio/resources/account.rb, line 26
def get params = {}
  response = Client.request :get, account_status_endpoint, params
  response_record response
end
Also aliased as: status, retrieve
retrieve(params = {})
Alias for: get
status(params = {})
Alias for: get

Private Class Methods

account_status_endpoint() click to toggle source
# File lib/phaxio/resources/account.rb, line 35
def account_status_endpoint
  "#{ACCOUNT_PATH}/status"
end