Class: Increase::Resources::Entities
- Inherits:
-
Object
- Object
- Increase::Resources::Entities
- Defined in:
- lib/increase/resources/entities.rb
Instance Method Summary collapse
-
#archive(entity_id, opts = {}) ⇒ Increase::Models::Entity
Archive an Entity.
-
#archive_beneficial_owner(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Archive a beneficial owner for a corporate Entity.
-
#confirm(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Depending on your program, you may be required to re-confirm an Entity's details on a recurring basis.
-
#create(params = {}, opts = {}) ⇒ Increase::Models::Entity
Create an Entity.
-
#create_beneficial_owner(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Create a beneficial owner for a corporate Entity.
-
#initialize(client:) ⇒ Entities
constructor
A new instance of Entities.
-
#list(params = {}, opts = {}) ⇒ Increase::Page<Increase::Models::Entity>
List Entities.
-
#retrieve(entity_id, opts = {}) ⇒ Increase::Models::Entity
Retrieve an Entity.
-
#update_address(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Update a Natural Person or Corporation's address.
-
#update_beneficial_owner_address(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Update the address for a beneficial owner belonging to a corporate Entity.
-
#update_industry_code(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Update the industry code for a corporate Entity.
Constructor Details
#initialize(client:) ⇒ Entities
Returns a new instance of Entities.
6 7 8 |
# File 'lib/increase/resources/entities.rb', line 6 def initialize(client:) @client = client end |
Instance Method Details
#archive(entity_id, opts = {}) ⇒ Increase::Models::Entity
Archive an Entity
88 89 90 91 92 93 94 |
# File 'lib/increase/resources/entities.rb', line 88 def archive(entity_id, opts = {}) req = {} req[:method] = :post req[:path] = "/entities/#{entity_id}/archive" req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#archive_beneficial_owner(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Archive a beneficial owner for a corporate Entity
108 109 110 111 112 113 114 115 |
# File 'lib/increase/resources/entities.rb', line 108 def archive_beneficial_owner(entity_id, params = {}, opts = {}) req = {} req[:method] = :post req[:path] = "/entities/#{entity_id}/archive_beneficial_owner" req[:body] = params req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#confirm(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Depending on your program, you may be required to re-confirm an Entity's details on a recurring basis. After making any required updates, call this endpoint to record that your user confirmed their details.
130 131 132 133 134 135 136 137 |
# File 'lib/increase/resources/entities.rb', line 130 def confirm(entity_id, params = {}, opts = {}) req = {} req[:method] = :post req[:path] = "/entities/#{entity_id}/confirm" req[:body] = params req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#create(params = {}, opts = {}) ⇒ Increase::Models::Entity
Create an Entity
32 33 34 35 36 37 38 39 |
# File 'lib/increase/resources/entities.rb', line 32 def create(params = {}, opts = {}) req = {} req[:method] = :post req[:path] = "/entities" req[:body] = params req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#create_beneficial_owner(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Create a beneficial owner for a corporate Entity
150 151 152 153 154 155 156 157 |
# File 'lib/increase/resources/entities.rb', line 150 def create_beneficial_owner(entity_id, params = {}, opts = {}) req = {} req[:method] = :post req[:path] = "/entities/#{entity_id}/create_beneficial_owner" req[:body] = params req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#list(params = {}, opts = {}) ⇒ Increase::Page<Increase::Models::Entity>
List Entities
71 72 73 74 75 76 77 78 79 |
# File 'lib/increase/resources/entities.rb', line 71 def list(params = {}, opts = {}) req = {} req[:method] = :get req[:path] = "/entities" req[:query] = params req[:page] = Increase::Page req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#retrieve(entity_id, opts = {}) ⇒ Increase::Models::Entity
Retrieve an Entity
47 48 49 50 51 52 53 |
# File 'lib/increase/resources/entities.rb', line 47 def retrieve(entity_id, opts = {}) req = {} req[:method] = :get req[:path] = "/entities/#{entity_id}" req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#update_address(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Update a Natural Person or Corporation's address
170 171 172 173 174 175 176 177 |
# File 'lib/increase/resources/entities.rb', line 170 def update_address(entity_id, params = {}, opts = {}) req = {} req[:method] = :post req[:path] = "/entities/#{entity_id}/update_address" req[:body] = params req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#update_beneficial_owner_address(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Update the address for a beneficial owner belonging to a corporate Entity
193 194 195 196 197 198 199 200 |
# File 'lib/increase/resources/entities.rb', line 193 def update_beneficial_owner_address(entity_id, params = {}, opts = {}) req = {} req[:method] = :post req[:path] = "/entities/#{entity_id}/update_beneficial_owner_address" req[:body] = params req[:model] = Increase::Models::Entity @client.request(req, opts) end |
#update_industry_code(entity_id, params = {}, opts = {}) ⇒ Increase::Models::Entity
Update the industry code for a corporate Entity
216 217 218 219 220 221 222 223 |
# File 'lib/increase/resources/entities.rb', line 216 def update_industry_code(entity_id, params = {}, opts = {}) req = {} req[:method] = :post req[:path] = "/entities/#{entity_id}/update_industry_code" req[:body] = params req[:model] = Increase::Models::Entity @client.request(req, opts) end |