Class: Phaxio::Resources::Account

Inherits:
Phaxio::Resource show all
Defined in:
lib/phaxio/resources/account.rb

Overview

Information about your Phaxio account.

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Phaxio::Resource

response_collection, response_record

Instance Attribute Details

#balance ⇒ Integer

Returns Your current account funds balance in cents.

Returns:

  • (Integer) —

    Your current account funds balance in cents.




# File 'lib/phaxio/resources/account.rb', line 8

#faxes_this_month ⇒ Hash<String: Integer>

Returns A hash of the number of faxes sent and received this month.

Returns:

  • (Hash<String: Integer>) —

    A hash of the number of faxes sent and received this month.



16
 
# File 'lib/phaxio/resources/account.rb', line 16

has_normal_attributes %w[balance faxes_today faxes_this_month]

#faxes_today ⇒ Hash<String: Integer>

Returns A hash of the number of faxes sent and received today.

Returns:

  • (Hash<String: Integer>) —

    A hash of the number of faxes sent and received today.




# File 'lib/phaxio/resources/account.rb', line 11

Class Method Details

.get(params = {}) ⇒ Phaxio::Resources::Acount Also known as: status, retrieve

Get information about your Phaxio account, including your balance, number of faxes sent today, and number of faxes sent this week.

Parameters:

  • params (Hash) (defaults to: {}) —

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

Returns:

  • (Phaxio::Resources::Acount) —

    Your account information.

Raises:

See Also:



26
27
28
29
 
# File 'lib/phaxio/resources/account.rb', line 26

def get params = {}
  response = Client.request :get, , params
  response_record response
end