Class: FundAmerica::EntityRelationship

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

Class Method Summary collapse

Class Method Details

.create(options) ⇒ Object

End point: apps.fundamerica.com/api/entity_relationships (POST) Usage: FundAmerica::EntityRelationship.create(options) Output: Creates a new entity_relationship



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

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

.delete(entity_relationship_id) ⇒ Object

End point: apps.fundamerica.com/api/entity_relationships/:id (DELETE) Usage: FundAmerica::EntityRelationship.delete(entity_relationship_id) Output: Deletes an entity_relationship with matching id



37
38
39
 
# File 'lib/fund_america/entity_relationship.rb', line 37

def delete(entity_relationship_id)
  API::request(:delete, "entity_relationships/#{entity_relationship_id}")
end

.details(entity_relationship_id) ⇒ Object

End point: apps.fundamerica.com/api/entity_relationships/:id (GET) Usage: FundAmerica::EntityRelationship.details(entity_relationship_id) Output: Returns the details of an entity_relationship with matching id



30
31
32
 
# File 'lib/fund_america/entity_relationship.rb', line 30

def details(entity_relationship_id)
  API::request(:get, "entity_relationships/#{entity_relationship_id}")
end

.list ⇒ Object

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



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

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

.update(entity_relationship_id, options) ⇒ Object

End point: apps.fundamerica.com/api/entity_relationships/:id (PATCH) Usage: FundAmerica::EntityRelationship.update(entity_relationship_id, options) Output: Updates an entity_relationship



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

def update(entity_relationship_id, options)
  end_point_url = "entity_relationships/#{entity_relationship_id}"
  API::request(:patch, end_point_url, options)
end