Class: FundAmerica::CancelOfferingRequest

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

Class Method Summary collapse

Class Method Details

.create(options) ⇒ Object

End point: apps.fundamerica.com/api/cancel_offering_requests (POST) Usage: FundAmerica::CancelOfferingRequest.create(options) Output: Creates a new cancel_offering_request



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

def create(options)
  API::request(:post, 'cancel_offering_requests', options)
end

.details(cancel_offering_request_id) ⇒ Object

End point: apps.fundamerica.com/api/cancel_offering_requests/:id (GET) Usage: FundAmerica::CancelOfferingRequest.details(cancel_offering_request_id) Output: Returns the details of an cancel_offering_request with matching id



31
32
33
 
# File 'lib/fund_america/cancel_offering_request.rb', line 31

def details(cancel_offering_request_id)
  API::request(:get, "cancel_offering_requests/#{cancel_offering_request_id}")
end

.list ⇒ Object

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



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

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

.update(cancel_offering_request_id, options) ⇒ Object

End point: sandbox.fundamerica.com/api/test_mode/cancel_offering_requests/:id (PATCH) Usage: FundAmerica::CancelOfferingRequest.update(cancel_offering_request_id, options) Output: Updates a cancel_offering_request Important: This works only for Sandbox mode



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

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