Class: ModernTreasury::Resources::LegalEntities

Inherits:
Object
  • Object
show all
Defined in:
lib/modern_treasury/resources/legal_entities.rb,
sig/modern_treasury/resources/legal_entities.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ LegalEntities

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of LegalEntities.

Parameters:



305
306
307
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 305

def initialize(client:)
  @client = client
end

Instance Method Details

#create(legal_entity_type:, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, connection_id: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, documents: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {}) ⇒ ModernTreasury::Models::LegalEntity

Some parameter documentations has been truncated, see Models::LegalEntityCreateParams for more details.

Create a legal entity. All country fields use ISO 3166-1 alpha-2 (e.g. US).

Parameters:

Returns:

See Also:



104
105
106
107
108
109
110
111
112
113
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 104

def create(params)
  parsed, options = ModernTreasury::LegalEntityCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/legal_entities",
    body: parsed,
    model: ModernTreasury::LegalEntity,
    options: options
  )
end

#list(after_cursor: nil, external_id: nil, legal_entity_type: nil, metadata: nil, per_page: nil, show_deleted: nil, status: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::LegalEntity>

Some parameter documentations has been truncated, see Models::LegalEntityListParams for more details.

Get a list of all legal entities.

Parameters:

Returns:

See Also:



262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 262

def list(params = {})
  parsed, options = ModernTreasury::LegalEntityListParams.dump_request(params)
  query = ModernTreasury::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "api/legal_entities",
    query: query,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::LegalEntity,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ ModernTreasury::Models::LegalEntity

Get details on a single legal entity.

Parameters:

Returns:

See Also:



126
127
128
129
130
131
132
133
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 126

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["api/legal_entities/%1$s", id],
    model: ModernTreasury::LegalEntity,
    options: params[:request_options]
  )
end

#update(id, addresses: nil, bank_settings: nil, business_description: nil, business_designation: nil, business_name: nil, citizenship_country: nil, country_of_incorporation: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, expected_activity_volume: nil, external_id: nil, first_name: nil, identifications: nil, industry_classifications: nil, intended_use: nil, last_name: nil, legal_structure: nil, listed_exchange: nil, metadata: nil, middle_name: nil, operating_jurisdictions: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, primary_social_media_sites: nil, regulators: nil, risk_rating: nil, service_provider_legal_entity_id: nil, suffix: nil, terms_of_use: nil, third_party_verification: nil, third_party_verifications: nil, ticker_symbol: nil, wealth_and_employment_details: nil, website: nil, request_options: {}) ⇒ ModernTreasury::Models::LegalEntity

Some parameter documentations has been truncated, see Models::LegalEntityUpdateParams for more details.

Update a legal entity.

Parameters:

Returns:

See Also:



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 225

def update(id, params = {})
  parsed, options = ModernTreasury::LegalEntityUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/legal_entities/%1$s", id],
    body: parsed,
    model: ModernTreasury::LegalEntity,
    options: options
  )
end

#update_status(id, status:, request_options: {}) ⇒ ModernTreasury::Models::LegalEntity

Some parameter documentations has been truncated, see Models::LegalEntityUpdateStatusParams for more details.

Update Legal Entity Status (sandbox only)

Parameters:

Returns:

See Also:



291
292
293
294
295
296
297
298
299
300
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 291

def update_status(id, params)
  parsed, options = ModernTreasury::LegalEntityUpdateStatusParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/simulations/legal_entities/%1$s/update_status", id],
    body: parsed,
    model: ModernTreasury::LegalEntity,
    options: options
  )
end