fuse_client 0.3.2 → 0.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +70 -0
- data/LICENSE +21 -0
- data/README.md +1 -258
- data/docs/Aggregator.md +15 -0
- data/docs/CreateAssetReportRequest.md +3 -1
- data/docs/CreateEntityRequest.md +24 -0
- data/docs/CreateEntityResponse.md +24 -0
- data/docs/CreateLinkTokenRequest.md +5 -5
- data/docs/CreateLinkTokenRequestMx.md +1 -1
- data/docs/CreateLinkTokenRequestPlaid.md +1 -1
- data/docs/CreateSessionRequest.md +3 -5
- data/docs/FinancialConnectionsAccountDetails.md +1 -3
- data/docs/FinancialConnectionsHolding.md +2 -0
- data/docs/FuseApi.md +307 -1
- data/docs/GetEntityResponse.md +24 -0
- data/docs/GetInvestmentHoldingsRequest.md +3 -1
- data/docs/GetInvestmentHoldingsResponse.md +1 -3
- data/docs/GetInvestmentTransactionsResponse.md +1 -3
- data/docs/GetLiabilitiesResponse.md +1 -3
- data/docs/GetTransactionsResponseDataInner.md +1 -3
- data/docs/Product.md +15 -0
- data/docs/RefreshAssetReportRequest.md +22 -0
- data/docs/UpdateEntityRequest.md +22 -0
- data/docs/UpdateEntityResponse.md +24 -0
- data/lib/fuse_client/api/fuse_api.rb +261 -0
- data/lib/fuse_client/configuration.rb +2 -2
- data/lib/fuse_client/models/aggregator.rb +42 -0
- data/lib/fuse_client/models/create_asset_report_request.rb +16 -4
- data/lib/fuse_client/models/{create_session_request_mx.rb → create_entity_request.rb} +50 -29
- data/lib/fuse_client/models/create_entity_response.rb +268 -0
- data/lib/fuse_client/models/create_link_token_request.rb +21 -20
- data/lib/fuse_client/models/create_link_token_request_mx.rb +1 -1
- data/lib/fuse_client/models/create_link_token_request_plaid.rb +3 -2
- data/lib/fuse_client/models/create_session_request.rb +36 -39
- data/lib/fuse_client/models/financial_connections_account_details.rb +4 -14
- data/lib/fuse_client/models/financial_connections_holding.rb +11 -1
- data/lib/fuse_client/models/{create_link_token_request_plaid_config.rb → get_entity_response.rb} +57 -14
- data/lib/fuse_client/models/get_investment_holdings_request.rb +14 -4
- data/lib/fuse_client/models/get_investment_holdings_response.rb +4 -14
- data/lib/fuse_client/models/get_investment_transactions_response.rb +4 -14
- data/lib/fuse_client/models/get_liabilities_response.rb +4 -14
- data/lib/fuse_client/models/get_transactions_response_data_inner.rb +4 -14
- data/lib/fuse_client/models/product.rb +44 -0
- data/lib/fuse_client/models/refresh_asset_report_request.rb +275 -0
- data/lib/fuse_client/models/{create_session_request_plaid.rb → update_entity_request.rb} +41 -21
- data/lib/fuse_client/models/update_entity_response.rb +268 -0
- data/lib/fuse_client/version.rb +1 -1
- data/lib/fuse_client.rb +8 -3
- data/spec/api/fuse_api_spec.rb +45 -0
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/aggregator_spec.rb +28 -0
- data/spec/models/create_asset_report_request_spec.rb +6 -0
- data/spec/models/{create_session_request_mx_spec.rb → create_entity_request_spec.rb} +10 -10
- data/spec/models/create_entity_response_spec.rb +52 -0
- data/spec/models/create_link_token_request_spec.rb +5 -5
- data/spec/models/create_session_request_spec.rb +1 -11
- data/spec/models/financial_connections_account_details_spec.rb +0 -6
- data/spec/models/financial_connections_holding_spec.rb +6 -0
- data/spec/models/get_entity_response_spec.rb +52 -0
- data/spec/models/get_investment_holdings_request_spec.rb +6 -0
- data/spec/models/get_investment_holdings_response_spec.rb +0 -6
- data/spec/models/get_investment_transactions_response_spec.rb +0 -6
- data/spec/models/get_liabilities_response_spec.rb +0 -6
- data/spec/models/get_transactions_response_data_inner_spec.rb +0 -6
- data/spec/models/product_spec.rb +28 -0
- data/spec/models/refresh_asset_report_request_spec.rb +46 -0
- data/spec/models/update_entity_request_spec.rb +46 -0
- data/spec/models/update_entity_response_spec.rb +52 -0
- metadata +36 -14
- data/docs/CreateLinkTokenRequestPlaidConfig.md +0 -18
- data/docs/CreateSessionRequestMx.md +0 -24
- data/docs/CreateSessionRequestPlaid.md +0 -18
- data/spec/models/create_link_token_request_plaid_config_spec.rb +0 -34
- data/spec/models/create_session_request_plaid_spec.rb +0 -34
data/docs/FuseApi.md
CHANGED
@@ -1,14 +1,16 @@
|
|
1
1
|
# FuseClient::FuseApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://sandbox-api.letsfuse.com*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_asset_report**](FuseApi.md#create_asset_report) | **POST** /v1/asset_report/create | |
|
8
|
+
| [**create_entity**](FuseApi.md#create_entity) | **POST** /v1/entities | Create entity |
|
8
9
|
| [**create_link_token**](FuseApi.md#create_link_token) | **POST** /v1/link/token | |
|
9
10
|
| [**create_session**](FuseApi.md#create_session) | **POST** /v1/session | |
|
10
11
|
| [**exchange_public_token**](FuseApi.md#exchange_public_token) | **POST** /v1/financial_connections/public_token/exchange | |
|
11
12
|
| [**get_asset_report**](FuseApi.md#get_asset_report) | **POST** /v1/asset_report | |
|
13
|
+
| [**get_entity**](FuseApi.md#get_entity) | **GET** /v1/entities/{entity_id} | Get entity |
|
12
14
|
| [**get_financial_connections_account_details**](FuseApi.md#get_financial_connections_account_details) | **POST** /v1/financial_connections/accounts/details | Get account details |
|
13
15
|
| [**get_financial_connections_accounts**](FuseApi.md#get_financial_connections_accounts) | **POST** /v1/financial_connections/accounts | Get accounts |
|
14
16
|
| [**get_financial_connections_balances**](FuseApi.md#get_financial_connections_balances) | **POST** /v1/financial_connections/balances | Get balances |
|
@@ -16,8 +18,10 @@ All URIs are relative to *https://yz9sph5c42.execute-api.us-east-1.amazonaws.com
|
|
16
18
|
| [**get_financial_connections_transactions**](FuseApi.md#get_financial_connections_transactions) | **POST** /v1/financial_connections/transactions | Get transactions |
|
17
19
|
| [**get_investment_holdings**](FuseApi.md#get_investment_holdings) | **POST** /v1/financial_connections/investments/holdings | Get investment holdings |
|
18
20
|
| [**get_investment_transactions**](FuseApi.md#get_investment_transactions) | **POST** /v1/financial_connections/investments/transactions | Get investment holdings |
|
21
|
+
| [**refresh_asset_report**](FuseApi.md#refresh_asset_report) | **POST** /v1/asset_report/refresh | |
|
19
22
|
| [**sync_financial_connections_data**](FuseApi.md#sync_financial_connections_data) | **POST** /v1/financial_connections/sync | Sync financial connections data |
|
20
23
|
| [**sync_financial_connections_transactions**](FuseApi.md#sync_financial_connections_transactions) | **POST** /v1/financial_connections/transactions/sync | Sync transactions |
|
24
|
+
| [**update_entity**](FuseApi.md#update_entity) | **PUT** /v1/entities/{entity_id_to_update} | Update entity |
|
21
25
|
| [**v1_financial_connections_liabilities_post**](FuseApi.md#v1_financial_connections_liabilities_post) | **POST** /v1/financial_connections/liabilities | Get liabilities |
|
22
26
|
|
23
27
|
|
@@ -99,6 +103,80 @@ end
|
|
99
103
|
- **Accept**: application/json
|
100
104
|
|
101
105
|
|
106
|
+
## create_entity
|
107
|
+
|
108
|
+
> <CreateEntityResponse> create_entity(create_entity_request)
|
109
|
+
|
110
|
+
Create entity
|
111
|
+
|
112
|
+
### Examples
|
113
|
+
|
114
|
+
```ruby
|
115
|
+
require 'time'
|
116
|
+
require 'fuse_client'
|
117
|
+
# setup authorization
|
118
|
+
FuseClient.configure do |config|
|
119
|
+
# Configure API key authorization: fuseApiKey
|
120
|
+
config.api_key['fuseApiKey'] = 'YOUR API KEY'
|
121
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
122
|
+
# config.api_key_prefix['fuseApiKey'] = 'Bearer'
|
123
|
+
|
124
|
+
# Configure API key authorization: fuseClientId
|
125
|
+
config.api_key['fuseClientId'] = 'YOUR API KEY'
|
126
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
127
|
+
# config.api_key_prefix['fuseClientId'] = 'Bearer'
|
128
|
+
end
|
129
|
+
|
130
|
+
api_instance = FuseClient::FuseApi.new
|
131
|
+
create_entity_request = FuseClient::CreateEntityRequest.new # CreateEntityRequest |
|
132
|
+
|
133
|
+
begin
|
134
|
+
# Create entity
|
135
|
+
result = api_instance.create_entity(create_entity_request)
|
136
|
+
p result
|
137
|
+
rescue FuseClient::ApiError => e
|
138
|
+
puts "Error when calling FuseApi->create_entity: #{e}"
|
139
|
+
end
|
140
|
+
```
|
141
|
+
|
142
|
+
#### Using the create_entity_with_http_info variant
|
143
|
+
|
144
|
+
This returns an Array which contains the response data, status code and headers.
|
145
|
+
|
146
|
+
> <Array(<CreateEntityResponse>, Integer, Hash)> create_entity_with_http_info(create_entity_request)
|
147
|
+
|
148
|
+
```ruby
|
149
|
+
begin
|
150
|
+
# Create entity
|
151
|
+
data, status_code, headers = api_instance.create_entity_with_http_info(create_entity_request)
|
152
|
+
p status_code # => 2xx
|
153
|
+
p headers # => { ... }
|
154
|
+
p data # => <CreateEntityResponse>
|
155
|
+
rescue FuseClient::ApiError => e
|
156
|
+
puts "Error when calling FuseApi->create_entity_with_http_info: #{e}"
|
157
|
+
end
|
158
|
+
```
|
159
|
+
|
160
|
+
### Parameters
|
161
|
+
|
162
|
+
| Name | Type | Description | Notes |
|
163
|
+
| ---- | ---- | ----------- | ----- |
|
164
|
+
| **create_entity_request** | [**CreateEntityRequest**](CreateEntityRequest.md) | | |
|
165
|
+
|
166
|
+
### Return type
|
167
|
+
|
168
|
+
[**CreateEntityResponse**](CreateEntityResponse.md)
|
169
|
+
|
170
|
+
### Authorization
|
171
|
+
|
172
|
+
[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
|
173
|
+
|
174
|
+
### HTTP request headers
|
175
|
+
|
176
|
+
- **Content-Type**: application/json
|
177
|
+
- **Accept**: application/json
|
178
|
+
|
179
|
+
|
102
180
|
## create_link_token
|
103
181
|
|
104
182
|
> <CreateLinkTokenResponse> create_link_token(opts)
|
@@ -411,6 +489,80 @@ end
|
|
411
489
|
- **Accept**: application/json
|
412
490
|
|
413
491
|
|
492
|
+
## get_entity
|
493
|
+
|
494
|
+
> <GetEntityResponse> get_entity(entity_id)
|
495
|
+
|
496
|
+
Get entity
|
497
|
+
|
498
|
+
### Examples
|
499
|
+
|
500
|
+
```ruby
|
501
|
+
require 'time'
|
502
|
+
require 'fuse_client'
|
503
|
+
# setup authorization
|
504
|
+
FuseClient.configure do |config|
|
505
|
+
# Configure API key authorization: fuseApiKey
|
506
|
+
config.api_key['fuseApiKey'] = 'YOUR API KEY'
|
507
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
508
|
+
# config.api_key_prefix['fuseApiKey'] = 'Bearer'
|
509
|
+
|
510
|
+
# Configure API key authorization: fuseClientId
|
511
|
+
config.api_key['fuseClientId'] = 'YOUR API KEY'
|
512
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
513
|
+
# config.api_key_prefix['fuseClientId'] = 'Bearer'
|
514
|
+
end
|
515
|
+
|
516
|
+
api_instance = FuseClient::FuseApi.new
|
517
|
+
entity_id = 'entity_id_example' # String |
|
518
|
+
|
519
|
+
begin
|
520
|
+
# Get entity
|
521
|
+
result = api_instance.get_entity(entity_id)
|
522
|
+
p result
|
523
|
+
rescue FuseClient::ApiError => e
|
524
|
+
puts "Error when calling FuseApi->get_entity: #{e}"
|
525
|
+
end
|
526
|
+
```
|
527
|
+
|
528
|
+
#### Using the get_entity_with_http_info variant
|
529
|
+
|
530
|
+
This returns an Array which contains the response data, status code and headers.
|
531
|
+
|
532
|
+
> <Array(<GetEntityResponse>, Integer, Hash)> get_entity_with_http_info(entity_id)
|
533
|
+
|
534
|
+
```ruby
|
535
|
+
begin
|
536
|
+
# Get entity
|
537
|
+
data, status_code, headers = api_instance.get_entity_with_http_info(entity_id)
|
538
|
+
p status_code # => 2xx
|
539
|
+
p headers # => { ... }
|
540
|
+
p data # => <GetEntityResponse>
|
541
|
+
rescue FuseClient::ApiError => e
|
542
|
+
puts "Error when calling FuseApi->get_entity_with_http_info: #{e}"
|
543
|
+
end
|
544
|
+
```
|
545
|
+
|
546
|
+
### Parameters
|
547
|
+
|
548
|
+
| Name | Type | Description | Notes |
|
549
|
+
| ---- | ---- | ----------- | ----- |
|
550
|
+
| **entity_id** | **String** | | |
|
551
|
+
|
552
|
+
### Return type
|
553
|
+
|
554
|
+
[**GetEntityResponse**](GetEntityResponse.md)
|
555
|
+
|
556
|
+
### Authorization
|
557
|
+
|
558
|
+
[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
|
559
|
+
|
560
|
+
### HTTP request headers
|
561
|
+
|
562
|
+
- **Content-Type**: Not defined
|
563
|
+
- **Accept**: application/json
|
564
|
+
|
565
|
+
|
414
566
|
## get_financial_connections_account_details
|
415
567
|
|
416
568
|
> <GetFinancialConnectionsAccountDetailsResponse> get_financial_connections_account_details(get_financial_connections_account_details_request)
|
@@ -929,6 +1081,84 @@ end
|
|
929
1081
|
- **Accept**: application/json
|
930
1082
|
|
931
1083
|
|
1084
|
+
## refresh_asset_report
|
1085
|
+
|
1086
|
+
> <CreateAssetReportResponse> refresh_asset_report(opts)
|
1087
|
+
|
1088
|
+
|
1089
|
+
|
1090
|
+
Refreshes the Asset Report in JSON format.
|
1091
|
+
|
1092
|
+
### Examples
|
1093
|
+
|
1094
|
+
```ruby
|
1095
|
+
require 'time'
|
1096
|
+
require 'fuse_client'
|
1097
|
+
# setup authorization
|
1098
|
+
FuseClient.configure do |config|
|
1099
|
+
# Configure API key authorization: fuseApiKey
|
1100
|
+
config.api_key['fuseApiKey'] = 'YOUR API KEY'
|
1101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1102
|
+
# config.api_key_prefix['fuseApiKey'] = 'Bearer'
|
1103
|
+
|
1104
|
+
# Configure API key authorization: fuseClientId
|
1105
|
+
config.api_key['fuseClientId'] = 'YOUR API KEY'
|
1106
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1107
|
+
# config.api_key_prefix['fuseClientId'] = 'Bearer'
|
1108
|
+
end
|
1109
|
+
|
1110
|
+
api_instance = FuseClient::FuseApi.new
|
1111
|
+
opts = {
|
1112
|
+
refresh_asset_report_request: FuseClient::RefreshAssetReportRequest.new({days_requested: 3.56}) # RefreshAssetReportRequest |
|
1113
|
+
}
|
1114
|
+
|
1115
|
+
begin
|
1116
|
+
|
1117
|
+
result = api_instance.refresh_asset_report(opts)
|
1118
|
+
p result
|
1119
|
+
rescue FuseClient::ApiError => e
|
1120
|
+
puts "Error when calling FuseApi->refresh_asset_report: #{e}"
|
1121
|
+
end
|
1122
|
+
```
|
1123
|
+
|
1124
|
+
#### Using the refresh_asset_report_with_http_info variant
|
1125
|
+
|
1126
|
+
This returns an Array which contains the response data, status code and headers.
|
1127
|
+
|
1128
|
+
> <Array(<CreateAssetReportResponse>, Integer, Hash)> refresh_asset_report_with_http_info(opts)
|
1129
|
+
|
1130
|
+
```ruby
|
1131
|
+
begin
|
1132
|
+
|
1133
|
+
data, status_code, headers = api_instance.refresh_asset_report_with_http_info(opts)
|
1134
|
+
p status_code # => 2xx
|
1135
|
+
p headers # => { ... }
|
1136
|
+
p data # => <CreateAssetReportResponse>
|
1137
|
+
rescue FuseClient::ApiError => e
|
1138
|
+
puts "Error when calling FuseApi->refresh_asset_report_with_http_info: #{e}"
|
1139
|
+
end
|
1140
|
+
```
|
1141
|
+
|
1142
|
+
### Parameters
|
1143
|
+
|
1144
|
+
| Name | Type | Description | Notes |
|
1145
|
+
| ---- | ---- | ----------- | ----- |
|
1146
|
+
| **refresh_asset_report_request** | [**RefreshAssetReportRequest**](RefreshAssetReportRequest.md) | | [optional] |
|
1147
|
+
|
1148
|
+
### Return type
|
1149
|
+
|
1150
|
+
[**CreateAssetReportResponse**](CreateAssetReportResponse.md)
|
1151
|
+
|
1152
|
+
### Authorization
|
1153
|
+
|
1154
|
+
[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
|
1155
|
+
|
1156
|
+
### HTTP request headers
|
1157
|
+
|
1158
|
+
- **Content-Type**: application/json
|
1159
|
+
- **Accept**: application/json
|
1160
|
+
|
1161
|
+
|
932
1162
|
## sync_financial_connections_data
|
933
1163
|
|
934
1164
|
> <SyncFinancialConnectionsDataResponse> sync_financial_connections_data(body)
|
@@ -1079,6 +1309,82 @@ end
|
|
1079
1309
|
- **Accept**: application/json
|
1080
1310
|
|
1081
1311
|
|
1312
|
+
## update_entity
|
1313
|
+
|
1314
|
+
> <UpdateEntityResponse> update_entity(entity_id_to_update, update_entity_request)
|
1315
|
+
|
1316
|
+
Update entity
|
1317
|
+
|
1318
|
+
### Examples
|
1319
|
+
|
1320
|
+
```ruby
|
1321
|
+
require 'time'
|
1322
|
+
require 'fuse_client'
|
1323
|
+
# setup authorization
|
1324
|
+
FuseClient.configure do |config|
|
1325
|
+
# Configure API key authorization: fuseApiKey
|
1326
|
+
config.api_key['fuseApiKey'] = 'YOUR API KEY'
|
1327
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1328
|
+
# config.api_key_prefix['fuseApiKey'] = 'Bearer'
|
1329
|
+
|
1330
|
+
# Configure API key authorization: fuseClientId
|
1331
|
+
config.api_key['fuseClientId'] = 'YOUR API KEY'
|
1332
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1333
|
+
# config.api_key_prefix['fuseClientId'] = 'Bearer'
|
1334
|
+
end
|
1335
|
+
|
1336
|
+
api_instance = FuseClient::FuseApi.new
|
1337
|
+
entity_id_to_update = 'entity_id_to_update_example' # String |
|
1338
|
+
update_entity_request = FuseClient::UpdateEntityRequest.new # UpdateEntityRequest |
|
1339
|
+
|
1340
|
+
begin
|
1341
|
+
# Update entity
|
1342
|
+
result = api_instance.update_entity(entity_id_to_update, update_entity_request)
|
1343
|
+
p result
|
1344
|
+
rescue FuseClient::ApiError => e
|
1345
|
+
puts "Error when calling FuseApi->update_entity: #{e}"
|
1346
|
+
end
|
1347
|
+
```
|
1348
|
+
|
1349
|
+
#### Using the update_entity_with_http_info variant
|
1350
|
+
|
1351
|
+
This returns an Array which contains the response data, status code and headers.
|
1352
|
+
|
1353
|
+
> <Array(<UpdateEntityResponse>, Integer, Hash)> update_entity_with_http_info(entity_id_to_update, update_entity_request)
|
1354
|
+
|
1355
|
+
```ruby
|
1356
|
+
begin
|
1357
|
+
# Update entity
|
1358
|
+
data, status_code, headers = api_instance.update_entity_with_http_info(entity_id_to_update, update_entity_request)
|
1359
|
+
p status_code # => 2xx
|
1360
|
+
p headers # => { ... }
|
1361
|
+
p data # => <UpdateEntityResponse>
|
1362
|
+
rescue FuseClient::ApiError => e
|
1363
|
+
puts "Error when calling FuseApi->update_entity_with_http_info: #{e}"
|
1364
|
+
end
|
1365
|
+
```
|
1366
|
+
|
1367
|
+
### Parameters
|
1368
|
+
|
1369
|
+
| Name | Type | Description | Notes |
|
1370
|
+
| ---- | ---- | ----------- | ----- |
|
1371
|
+
| **entity_id_to_update** | **String** | | |
|
1372
|
+
| **update_entity_request** | [**UpdateEntityRequest**](UpdateEntityRequest.md) | | |
|
1373
|
+
|
1374
|
+
### Return type
|
1375
|
+
|
1376
|
+
[**UpdateEntityResponse**](UpdateEntityResponse.md)
|
1377
|
+
|
1378
|
+
### Authorization
|
1379
|
+
|
1380
|
+
[fuseApiKey](../README.md#fuseApiKey), [fuseClientId](../README.md#fuseClientId)
|
1381
|
+
|
1382
|
+
### HTTP request headers
|
1383
|
+
|
1384
|
+
- **Content-Type**: application/json
|
1385
|
+
- **Accept**: application/json
|
1386
|
+
|
1387
|
+
|
1082
1388
|
## v1_financial_connections_liabilities_post
|
1083
1389
|
|
1084
1390
|
> <GetLiabilitiesResponse> v1_financial_connections_liabilities_post(get_liabilities_request)
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# FuseClient::GetEntityResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Id of the entity | [optional] |
|
8
|
+
| **email** | **String** | Email of the entity | [optional] |
|
9
|
+
| **aggregators** | [**Array<Aggregator>**](Aggregator.md) | These will force the user to connect through all of these aggregators | [optional] |
|
10
|
+
| **institution_ids** | **Array<String>** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'fuse_client'
|
16
|
+
|
17
|
+
instance = FuseClient::GetEntityResponse.new(
|
18
|
+
id: null,
|
19
|
+
email: null,
|
20
|
+
aggregators: null,
|
21
|
+
institution_ids: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **access_token** | **String** | Access token for authentication | |
|
8
|
+
| **iso_currency_code** | **String** | The ISO-4217 currency code to convert the holding to. | [optional] |
|
8
9
|
|
9
10
|
## Example
|
10
11
|
|
@@ -12,7 +13,8 @@
|
|
12
13
|
require 'fuse_client'
|
13
14
|
|
14
15
|
instance = FuseClient::GetInvestmentHoldingsRequest.new(
|
15
|
-
access_token: null
|
16
|
+
access_token: null,
|
17
|
+
iso_currency_code: null
|
16
18
|
)
|
17
19
|
```
|
18
20
|
|
@@ -7,7 +7,6 @@
|
|
7
7
|
| **accounts** | [**Array<FinancialConnectionsInvestmentAccount>**](FinancialConnectionsInvestmentAccount.md) | | [optional] |
|
8
8
|
| **holdings** | [**Array<FinancialConnectionsHolding>**](FinancialConnectionsHolding.md) | | [optional] |
|
9
9
|
| **securities** | [**Array<FinancialConnectionsInvestmentSecurity>**](FinancialConnectionsInvestmentSecurity.md) | | [optional] |
|
10
|
-
| **remote_data** | **Object** | The exact data from the aggregator (ie plaid) that we retrieved the information from. | [optional] |
|
11
10
|
|
12
11
|
## Example
|
13
12
|
|
@@ -17,8 +16,7 @@ require 'fuse_client'
|
|
17
16
|
instance = FuseClient::GetInvestmentHoldingsResponse.new(
|
18
17
|
accounts: null,
|
19
18
|
holdings: null,
|
20
|
-
securities: null
|
21
|
-
remote_data: null
|
19
|
+
securities: null
|
22
20
|
)
|
23
21
|
```
|
24
22
|
|
@@ -7,7 +7,6 @@
|
|
7
7
|
| **accounts** | [**Array<FinancialConnectionsInvestmentAccount>**](FinancialConnectionsInvestmentAccount.md) | | [optional] |
|
8
8
|
| **investment_transactions** | [**Array<FinancialConnectionsInvestmentTransaction>**](FinancialConnectionsInvestmentTransaction.md) | | [optional] |
|
9
9
|
| **securities** | [**Array<FinancialConnectionsInvestmentSecurity>**](FinancialConnectionsInvestmentSecurity.md) | | [optional] |
|
10
|
-
| **remote_data** | **Object** | The exact data from the aggregator (ie plaid) that we retrieved the information from. | [optional] |
|
11
10
|
|
12
11
|
## Example
|
13
12
|
|
@@ -17,8 +16,7 @@ require 'fuse_client'
|
|
17
16
|
instance = FuseClient::GetInvestmentTransactionsResponse.new(
|
18
17
|
accounts: null,
|
19
18
|
investment_transactions: null,
|
20
|
-
securities: null
|
21
|
-
remote_data: null
|
19
|
+
securities: null
|
22
20
|
)
|
23
21
|
```
|
24
22
|
|
@@ -5,7 +5,6 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **liabilities** | [**Array<FinancialConnectionsAccountLiability>**](FinancialConnectionsAccountLiability.md) | | [optional] |
|
8
|
-
| **remote_data** | **Object** | The exact data from the aggregator (ie plaid) that we retrieved the information from. | [optional] |
|
9
8
|
|
10
9
|
## Example
|
11
10
|
|
@@ -13,8 +12,7 @@
|
|
13
12
|
require 'fuse_client'
|
14
13
|
|
15
14
|
instance = FuseClient::GetLiabilitiesResponse.new(
|
16
|
-
liabilities: null
|
17
|
-
remote_data: null
|
15
|
+
liabilities: null
|
18
16
|
)
|
19
17
|
```
|
20
18
|
|
@@ -14,7 +14,6 @@
|
|
14
14
|
| **merchant** | [**GetTransactionsResponseDataInnerMerchant**](GetTransactionsResponseDataInnerMerchant.md) | | [optional] |
|
15
15
|
| **status** | **String** | The status of the transaction. This will be either POSTED or PENDING. | [optional] |
|
16
16
|
| **type** | **String** | Type of the transaction, ie adjustment | [optional] |
|
17
|
-
| **remote_data** | **Object** | The exact data from the aggregator (ie plaid) that we retrieved the information from | [optional] |
|
18
17
|
|
19
18
|
## Example
|
20
19
|
|
@@ -31,8 +30,7 @@ instance = FuseClient::GetTransactionsResponseDataInner.new(
|
|
31
30
|
category: null,
|
32
31
|
merchant: null,
|
33
32
|
status: null,
|
34
|
-
type: null
|
35
|
-
remote_data: null
|
33
|
+
type: null
|
36
34
|
)
|
37
35
|
```
|
38
36
|
|
data/docs/Product.md
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# FuseClient::RefreshAssetReportRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **access_token** | **String** | The asset_report_token returned by the original call to /asset_report/create | [optional] |
|
8
|
+
| **days_requested** | **Float** | The maximum integer number of days of history to include in the Asset Report | |
|
9
|
+
| **include_identity** | **Boolean** | Indicates whether to include identity data in the Asset Report | [optional][default to true] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'fuse_client'
|
15
|
+
|
16
|
+
instance = FuseClient::RefreshAssetReportRequest.new(
|
17
|
+
access_token: null,
|
18
|
+
days_requested: null,
|
19
|
+
include_identity: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# FuseClient::UpdateEntityRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | Email of the entity | [optional] |
|
8
|
+
| **aggregators** | [**Array<Aggregator>**](Aggregator.md) | These will force the user to connect through all of these aggregators | [optional] |
|
9
|
+
| **institution_ids** | **Array<String>** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'fuse_client'
|
15
|
+
|
16
|
+
instance = FuseClient::UpdateEntityRequest.new(
|
17
|
+
email: null,
|
18
|
+
aggregators: null,
|
19
|
+
institution_ids: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# FuseClient::UpdateEntityResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Id of the entity | [optional] |
|
8
|
+
| **email** | **String** | Email of the entity | [optional] |
|
9
|
+
| **aggregators** | [**Array<Aggregator>**](Aggregator.md) | These will force the user to connect through all of these aggregators | [optional] |
|
10
|
+
| **institution_ids** | **Array<String>** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'fuse_client'
|
16
|
+
|
17
|
+
instance = FuseClient::UpdateEntityResponse.new(
|
18
|
+
id: null,
|
19
|
+
email: null,
|
20
|
+
aggregators: null,
|
21
|
+
institution_ids: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|