Class: FundAmerica::TradeReview

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

Class Method Summary collapse

Class Method Details

.details(trade_review_id) ⇒ Object

End point: apps.fundamerica.com/api/trade_reviews/:id (GET) Usage: FundAmerica::TradeReview.details(trade_review_id) Output: Returns the details of an trade_review with matching id



24
25
26
# File 'lib/fund_america/trade_review.rb', line 24

def details(trade_review_id)
  API::request(:get, "trade_reviews/#{trade_review_id}")
end

.listObject

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



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

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

.update(trade_review_id, options) ⇒ Object

End point: sandbox.fundamerica.com/api/test_mode/trade_reviews/:id (PATCH) Usage: FundAmerica::TradeReview.update(trade_review_id, options) Output: Updates a trade_review Important: This works only for Sandbox mode



16
17
18
19
# File 'lib/fund_america/trade_review.rb', line 16

def update(trade_review_id, options)
  end_point_url = 'https://sandbox.fundamerica.com/api/test_mode/trade_reviews/' + trade_review_id
  API::request(:patch, end_point_url, options)
end