Class: ModernTreasury::Resources::LegalEntities

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

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:



211
212
213
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 211

def initialize(client:)
  @client = client
end

Instance Method Details

#create(legal_entity_type: , addresses: nil, bank_settings: nil, business_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_entity_associations: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: 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 legal_entity

Parameters:

Returns:

See Also:



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 70

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, legal_entity_type: nil, metadata: nil, per_page: nil, show_deleted: 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:



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 196

def list(params = {})
  parsed, options = ModernTreasury::LegalEntityListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "api/legal_entities",
    query: parsed,
    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:



92
93
94
95
96
97
98
99
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 92

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_name: nil, citizenship_country: nil, compliance_details: nil, date_formed: nil, date_of_birth: nil, doing_business_as_names: nil, email: nil, first_name: nil, identifications: nil, industry_classifications: nil, last_name: nil, legal_structure: nil, metadata: nil, middle_name: nil, phone_numbers: nil, politically_exposed_person: nil, preferred_name: nil, prefix: nil, risk_rating: nil, suffix: 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:



163
164
165
166
167
168
169
170
171
172
 
# File 'lib/modern_treasury/resources/legal_entities.rb', line 163

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