Class: PBShipping::Account

Inherits:
ShippingApiResource show all
Defined in:
lib/pbshipping/account.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiObject

#[], #[]=, #add_accessors, #as_json, convert_to_api_object, #create_accessor, #each, #initialize, #inspect, #key?, #keys, #metaclass, #respond_to?, #to_hash, #to_json, #to_s, #update, #values

Constructor Details

This class inherits a constructor from PBShipping::ApiObject

Class Method Details

.getBalanceByAccountNumber(auth_obj, accountNumber) ⇒ Object 



41
42
43
 
# File 'lib/pbshipping/account.rb', line 41

def self.getBalanceByAccountNumber(auth_obj, accountNumber)
  return Account.new({:accountNumber => accountNumber}).getBalance(auth_obj)
end

Instance Method Details

#getBalance(auth_obj) ⇒ Object

MANAGING MERCHANTS API: GET /ledger/accounts/accountNumber/balance API signature: get/ledger/accounts/…/balance

Retrieve the account balance of a merchant account.



29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/pbshipping/account.rb', line 29

def getBalance(auth_obj)
  if self.key?(:accountNumber) == false
    raise MissingResourceAttribute.new(:accountNumber)
  end
  api_sig = "get/ledger/accounts/.../balance"
  api_version = PBShipping::get_api_version(api_sig)
  api_path = "/ledger/accounts/" + self[:accountNumber] + "/balance"
  json_resp = PBShipping.api_request(auth_obj, :get, api_version, api_path, 
                                     {}, {}, {})
  return ApiObject.new(json_resp)
end