Class: FundAmerica::Distribution

Inherits:
Object
  • Object
show all
Defined in:
lib/fund_america/distribution.rb

Class Method Summary collapse

Class Method Details

.details(distribution_id) ⇒ Object

End point: apps.fundamerica.com/api/investment_payments/:id (GET) Usage: FundAmerica::Distribution.details(distribution_id) Output: Returns the details of a distribution with matching id



15
16
17
# File 'lib/fund_america/distribution.rb', line 15

def details(distribution_id)
  API::request(:get, "distributions/#{distribution_id}")
end

.investor_payments(distribution_id, page, per) ⇒ Object

End point: apps/fundamerica.com/api/distributions/:id/investor_payments Usage: FundAmerica::Distribution.investor_payments(distribution_id) Output: Returns the investor_payments associated with distribution



22
23
24
# File 'lib/fund_america/distribution.rb', line 22

def investor_payments(distribution_id, page, per)
  API::request(:get, "distributions/#{distribution_id}/investor_payments?page=#{page}&per=#{per}")
end

.listObject

End point: apps.fundamerica.com/api/distributions (GET) Usage: FundAmerica::Distribution.list Output: Returns list of distributions



8
9
10
# File 'lib/fund_america/distribution.rb', line 8

def list
  API::request(:get, 'distributions')
end

.non_investor_payments(distribution_id, page, per) ⇒ Object

End point: apps/fundamerica.com/api/distributions/:id/non_investor_payments Usage: FundAmerica::Distribution.non_investor_payments(distribution_id) Output: Returns the non_investor_payments associated with distribution



29
30
31
# File 'lib/fund_america/distribution.rb', line 29

def non_investor_payments(distribution_id, page, per)
  API::request(:get, "distributions/#{distribution_id}/non_investor_payments?page=#{page}&per=#{per}")
end