Class: ModernTreasury::Resources::ConnectionLegalEntities

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ConnectionLegalEntities

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 ConnectionLegalEntities.

Parameters:



105
106
107
 
# File 'lib/modern_treasury/resources/connection_legal_entities.rb', line 105

def initialize(client:)
  @client = client
end

Instance Method Details

#create(connection_id: , legal_entity: nil, legal_entity_id: nil, request_options: {}) ⇒ ModernTreasury::Models::ConnectionLegalEntity

Create a connection legal entity.

Parameters:

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/modern_treasury/resources/connection_legal_entities.rb', line 21

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

#list(after_cursor: nil, connection_id: nil, legal_entity_id: nil, per_page: nil, status: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::ConnectionLegalEntity>

Get a list of all connection legal entities.

Parameters:

Returns:

See Also:



90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/modern_treasury/resources/connection_legal_entities.rb', line 90

def list(params = {})
  parsed, options = ModernTreasury::ConnectionLegalEntityListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "api/connection_legal_entities",
    query: parsed,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::ConnectionLegalEntity,
    options: options
  )
end

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

Get details on a single connection legal entity.

Parameters:

Returns:

See Also:



43
44
45
46
47
48
49
50
 
# File 'lib/modern_treasury/resources/connection_legal_entities.rb', line 43

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

#update(id, status: nil, request_options: {}) ⇒ ModernTreasury::Models::ConnectionLegalEntity

Update a connection legal entity.

Parameters:

Returns:

See Also:



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/modern_treasury/resources/connection_legal_entities.rb', line 65

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