moneykit 0.1.2 → 0.1.3
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 +1 -1
- data/README.md +1 -1
- data/docs/AccessTokenApi.md +10 -22
- data/docs/AccountNumbersApi.md +4 -8
- data/docs/AccountNumbersLinkProduct.md +4 -0
- data/docs/AccountNumbersProductSettings.md +1 -3
- data/docs/AccountsApi.md +10 -22
- data/docs/AccountsLinkProduct.md +5 -1
- data/docs/Body.md +1 -1
- data/docs/GetHoldingsResponse.md +24 -0
- data/docs/GetInvestmentTransactionsResponse.md +30 -0
- data/docs/HoldingResponse.md +30 -0
- data/docs/IdentityApi.md +1 -3
- data/docs/IdentityLinkProduct.md +4 -0
- data/docs/IdentityProductSettings.md +1 -3
- data/docs/InstitutionsApi.md +5 -11
- data/docs/InvestmentTransactionResponse.md +40 -0
- data/docs/InvestmentsApi.md +163 -0
- data/docs/InvestmentsLinkProduct.md +26 -0
- data/docs/InvestmentsProductSettings.md +1 -3
- data/docs/LinkCommon.md +1 -1
- data/docs/LinkError.md +15 -0
- data/docs/LinkProductFailureReasons.md +15 -0
- data/docs/LinkProducts.md +3 -1
- data/docs/LinkResponse.md +1 -1
- data/docs/LinkSessionApi.md +8 -16
- data/docs/LinkStateChangedWebhook.md +1 -1
- data/docs/LinksApi.md +20 -40
- data/docs/MoneyKitConnectFeatures.md +1 -1
- data/docs/ProductsApi.md +4 -8
- data/docs/Response401GetHoldingsLinksIdInvestmentsHoldingsGet.md +22 -0
- data/docs/Response401GetInvestmentTransactionsLinksIdInvestmentsTransactionsGet.md +22 -0
- data/docs/Response401GetTransactions.md +22 -0
- data/docs/Response401GetUserTransactions.md +22 -0
- data/docs/ResponseHandleLinkWebhookEventRequestBodyWebhookPost.md +1 -1
- data/docs/SecurityResponse.md +34 -0
- data/docs/TransactionSyncResponse.md +1 -1
- data/docs/TransactionsApi.md +5 -11
- data/docs/TransactionsLinkProduct.md +4 -0
- data/docs/TransactionsProductSettings.md +0 -2
- data/docs/UsersApi.md +6 -14
- data/docs/WebhooksApi.md +4 -8
- data/lib/moneykit/api/access_token_api.rb +1 -10
- data/lib/moneykit/api/account_numbers_api.rb +1 -4
- data/lib/moneykit/api/accounts_api.rb +1 -13
- data/lib/moneykit/api/identity_api.rb +1 -4
- data/lib/moneykit/api/institutions_api.rb +1 -7
- data/lib/moneykit/api/investments_api.rb +178 -0
- data/lib/moneykit/api/link_session_api.rb +1 -7
- data/lib/moneykit/api/links_api.rb +1 -16
- data/lib/moneykit/api/products_api.rb +1 -4
- data/lib/moneykit/api/transactions_api.rb +5 -14
- data/lib/moneykit/api/users_api.rb +1 -10
- data/lib/moneykit/api/webhooks_api.rb +1 -4
- data/lib/moneykit/api_client.rb +1 -1
- data/lib/moneykit/api_error.rb +1 -1
- data/lib/moneykit/configuration.rb +1 -1
- data/lib/moneykit/models/account.rb +1 -1
- data/lib/moneykit/models/account_balances.rb +1 -1
- data/lib/moneykit/models/account_group.rb +1 -1
- data/lib/moneykit/models/account_identity.rb +1 -1
- data/lib/moneykit/models/account_numbers.rb +1 -1
- data/lib/moneykit/models/account_numbers_link_product.rb +43 -2
- data/lib/moneykit/models/account_numbers_product_settings.rb +5 -36
- data/lib/moneykit/models/account_with_account_numbers.rb +1 -1
- data/lib/moneykit/models/accounts_link_product.rb +46 -5
- data/lib/moneykit/models/ach_number.rb +1 -1
- data/lib/moneykit/models/address.rb +1 -1
- data/lib/moneykit/models/api_error_auth_expired_access_token_response.rb +1 -1
- data/lib/moneykit/models/api_error_auth_unauthorized_response.rb +1 -1
- data/lib/moneykit/models/api_error_rate_limit_exceeded_response.rb +1 -1
- data/lib/moneykit/models/bacs_number.rb +1 -1
- data/lib/moneykit/models/basic_account_details.rb +1 -1
- data/lib/moneykit/models/body.rb +1 -1
- data/lib/moneykit/models/country.rb +1 -1
- data/lib/moneykit/models/create_link_session_request.rb +1 -1
- data/lib/moneykit/models/create_link_session_response.rb +1 -1
- data/lib/moneykit/models/currency.rb +1 -1
- data/lib/moneykit/models/cursor_pagination.rb +1 -1
- data/lib/moneykit/models/customer_app.rb +1 -1
- data/lib/moneykit/models/eft_number.rb +1 -1
- data/lib/moneykit/models/email.rb +1 -1
- data/lib/moneykit/models/exchange_token_request.rb +1 -1
- data/lib/moneykit/models/exchange_token_response.rb +1 -1
- data/lib/moneykit/models/generate_access_token_response.rb +1 -1
- data/lib/moneykit/models/get_account_numbers_response.rb +1 -1
- data/lib/moneykit/models/get_account_response.rb +1 -1
- data/lib/moneykit/models/get_accounts_response.rb +1 -1
- data/lib/moneykit/models/get_holdings_response.rb +273 -0
- data/lib/moneykit/models/get_institutions_response.rb +1 -1
- data/lib/moneykit/models/get_investment_transactions_response.rb +324 -0
- data/lib/moneykit/models/get_transactions_response.rb +1 -1
- data/lib/moneykit/models/get_user_accounts_response.rb +1 -1
- data/lib/moneykit/models/get_user_links_response.rb +1 -1
- data/lib/moneykit/models/get_user_transactions_response.rb +1 -1
- data/lib/moneykit/models/holding_response.rb +294 -0
- data/lib/moneykit/models/http_validation_error.rb +1 -1
- data/lib/moneykit/models/identity_link_product.rb +43 -2
- data/lib/moneykit/models/identity_product_settings.rb +5 -36
- data/lib/moneykit/models/identity_response.rb +1 -1
- data/lib/moneykit/models/institution.rb +1 -1
- data/lib/moneykit/models/institution_error_not_found_response.rb +1 -1
- data/lib/moneykit/models/international_number.rb +1 -1
- data/lib/moneykit/models/introspect_client_response.rb +1 -1
- data/lib/moneykit/models/investment_transaction_response.rb +365 -0
- data/lib/moneykit/models/investments_link_product.rb +280 -0
- data/lib/moneykit/models/investments_product_settings.rb +5 -36
- data/lib/moneykit/models/jwk_set.rb +1 -1
- data/lib/moneykit/models/link_common.rb +2 -2
- data/lib/moneykit/models/link_error.rb +44 -0
- data/lib/moneykit/models/link_error_bad_config_response.rb +1 -1
- data/lib/moneykit/models/link_error_bad_state_response.rb +1 -1
- data/lib/moneykit/models/link_error_deleted_response.rb +1 -1
- data/lib/moneykit/models/link_error_forbidden_action_response.rb +1 -1
- data/lib/moneykit/models/link_error_not_found_response.rb +1 -1
- data/lib/moneykit/models/link_error_unauthorized_access_response.rb +1 -1
- data/lib/moneykit/models/link_permission_scope.rb +1 -1
- data/lib/moneykit/models/link_permissions.rb +1 -1
- data/lib/moneykit/models/link_product_failure_reasons.rb +44 -0
- data/lib/moneykit/models/link_product_refresh_webhook.rb +1 -1
- data/lib/moneykit/models/link_product_state.rb +1 -1
- data/lib/moneykit/models/link_products.rb +14 -5
- data/lib/moneykit/models/link_response.rb +2 -2
- data/lib/moneykit/models/link_session_customer_user.rb +1 -1
- data/lib/moneykit/models/link_session_customer_user_email.rb +1 -1
- data/lib/moneykit/models/link_session_customer_user_phone.rb +1 -1
- data/lib/moneykit/models/link_session_error_forbidden_config_response.rb +1 -1
- data/lib/moneykit/models/link_session_error_invalid_token_exchange.rb +1 -1
- data/lib/moneykit/models/link_session_setting_overrides.rb +1 -1
- data/lib/moneykit/models/link_state.rb +1 -1
- data/lib/moneykit/models/link_state_changed_webhook.rb +2 -2
- data/lib/moneykit/models/money_kit_connect_features.rb +2 -2
- data/lib/moneykit/models/owner.rb +1 -1
- data/lib/moneykit/models/phone_number.rb +1 -1
- data/lib/moneykit/models/phone_number_type.rb +1 -1
- data/lib/moneykit/models/product.rb +1 -1
- data/lib/moneykit/models/products_settings.rb +1 -1
- data/lib/moneykit/models/provider.rb +1 -1
- data/lib/moneykit/models/refresh_products_request.rb +1 -1
- data/lib/moneykit/models/requested_link_permission.rb +1 -1
- data/lib/moneykit/models/response401_disconnect_links_id_delete.rb +1 -1
- data/lib/moneykit/models/response401_exchange_token_link_session_exchange_token_post.rb +1 -1
- data/lib/moneykit/models/response401_get_account_links_id_accounts_account_id_get.rb +1 -1
- data/lib/moneykit/models/response401_get_account_numbers_links_id_accounts_numbers_get.rb +1 -1
- data/lib/moneykit/models/response401_get_accounts_links_id_accounts_get.rb +1 -1
- data/lib/moneykit/models/response401_get_holdings_links_id_investments_holdings_get.rb +104 -0
- data/lib/moneykit/models/response401_get_identities_links_id_identity_get.rb +1 -1
- data/lib/moneykit/models/response401_get_institution_institutions_institution_id_get.rb +1 -1
- data/lib/moneykit/models/response401_get_institutions_institutions_get.rb +1 -1
- data/lib/moneykit/models/response401_get_investment_transactions_links_id_investments_transactions_get.rb +104 -0
- data/lib/moneykit/models/response401_get_link_links_id_get.rb +1 -1
- data/lib/moneykit/models/response401_get_transactions.rb +104 -0
- data/lib/moneykit/models/response401_get_transactions_diff_links_id_transactions_sync_get.rb +1 -1
- data/lib/moneykit/models/response401_get_user_accounts_users_id_accounts_get.rb +1 -1
- data/lib/moneykit/models/response401_get_user_links_users_id_links_get.rb +1 -1
- data/lib/moneykit/models/response401_get_user_transactions.rb +103 -0
- data/lib/moneykit/models/response401_get_well_known_jwks_well_known_jwks_json_get.rb +1 -1
- data/lib/moneykit/models/response401_instrospect_client_auth_introspect_get.rb +1 -1
- data/lib/moneykit/models/response401_refresh_products_links_id_products_post.rb +1 -1
- data/lib/moneykit/models/response401_reset_login_links_id_reset_post.rb +1 -1
- data/lib/moneykit/models/response401_trigger_test_link_webhook_event_webhooks_test_link_id_post.rb +1 -1
- data/lib/moneykit/models/response401_update_link_links_id_patch.rb +1 -1
- data/lib/moneykit/models/response_handle_link_webhook_event_request_body_webhook_post.rb +1 -1
- data/lib/moneykit/models/security_response.rb +321 -0
- data/lib/moneykit/models/transaction.rb +1 -1
- data/lib/moneykit/models/transaction_diff.rb +1 -1
- data/lib/moneykit/models/transaction_sync_response.rb +2 -2
- data/lib/moneykit/models/transaction_type.rb +1 -1
- data/lib/moneykit/models/transaction_type_filter.rb +1 -1
- data/lib/moneykit/models/transaction_updates_available_webhook.rb +1 -1
- data/lib/moneykit/models/transactions_link_product.rb +43 -2
- data/lib/moneykit/models/transactions_product_settings.rb +2 -33
- data/lib/moneykit/models/update_link_request.rb +1 -1
- data/lib/moneykit/models/validation_error.rb +1 -1
- data/lib/moneykit/models/validation_error_location_inner.rb +1 -1
- data/lib/moneykit/models/webhook_link_test_event.rb +1 -1
- data/lib/moneykit/models/webhook_test_link_request.rb +1 -1
- data/lib/moneykit/models/webhook_test_link_response.rb +1 -1
- data/lib/moneykit/version.rb +2 -2
- data/lib/moneykit.rb +14 -4
- data/moneykit.gemspec +1 -1
- data/spec/api/investments_api_spec.rb +65 -0
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/get_holdings_response_spec.rb +54 -0
- data/spec/models/get_investment_transactions_response_spec.rb +72 -0
- data/spec/models/holding_response_spec.rb +72 -0
- data/spec/models/investment_transaction_response_spec.rb +102 -0
- data/spec/models/investments_link_product_spec.rb +60 -0
- data/spec/models/link_error_spec.rb +30 -0
- data/spec/models/link_product_failure_reasons_spec.rb +30 -0
- data/spec/models/response401_get_holdings_links_id_investments_holdings_get_spec.rb +21 -0
- data/spec/models/response401_get_investment_transactions_links_id_investments_transactions_get_spec.rb +21 -0
- data/spec/models/response401_get_transactions_spec.rb +21 -0
- data/spec/models/response401_get_user_transactions_spec.rb +21 -0
- data/spec/models/security_response_spec.rb +84 -0
- data/spec/spec_helper.rb +1 -1
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.1.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.1.0/gem_make.out +5 -5
- metadata +54 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a22c2a494c76668563227b34d3e8cec426fd5e38d300aeb286ba4921c9ccde5d
|
|
4
|
+
data.tar.gz: e69d6adea8dc1d14616b976b176c4085f5e565e104d4912f19058c8f309a0e29
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: af5d0cfc48c84465d167bd854f893c09a8ca30e02d3539ccaaebf35c1bd16142d3cabd97fa80d9d9470c864de1497eb1269556ab6b57297981621c09b8fcf599
|
|
7
|
+
data.tar.gz: 65aaee9e75144a8a1fae50d87710b62efb67db6b67095987c3bdaa70319814adfb1b22eda3a90994ebb781775c494f7fe65c65afcc4ad91e79d62b57ca92f4bf
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
data/docs/AccessTokenApi.md
CHANGED
|
@@ -31,7 +31,6 @@ end
|
|
|
31
31
|
|
|
32
32
|
api_instance = MoneyKit::AccessTokenApi.new
|
|
33
33
|
opts = {
|
|
34
|
-
moneykit_version: 'moneykit_version_example', # String |
|
|
35
34
|
grant_type: 'grant_type_example', # String | Token grant type. Only `client_credentials` supported.
|
|
36
35
|
scope: 'scope_example', # String | Actions to be allowed for this token, given as one or more strings separated by spaces. If omitted, all actions allowed for your application will be granted to this token.
|
|
37
36
|
client_id: 'client_id_example', # String | Your application's MoneyKit client ID.
|
|
@@ -69,7 +68,6 @@ end
|
|
|
69
68
|
|
|
70
69
|
| Name | Type | Description | Notes |
|
|
71
70
|
| ---- | ---- | ----------- | ----- |
|
|
72
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
73
71
|
| **grant_type** | **String** | Token grant type. Only `client_credentials` supported. | [optional] |
|
|
74
72
|
| **scope** | **String** | Actions to be allowed for this token, given as one or more strings separated by spaces. If omitted, all actions allowed for your application will be granted to this token. | [optional][default to ''] |
|
|
75
73
|
| **client_id** | **String** | Your application's MoneyKit client ID. | [optional] |
|
|
@@ -91,7 +89,7 @@ end
|
|
|
91
89
|
|
|
92
90
|
## get_well_known_jwks
|
|
93
91
|
|
|
94
|
-
> <JWKSet> get_well_known_jwks
|
|
92
|
+
> <JWKSet> get_well_known_jwks
|
|
95
93
|
|
|
96
94
|
JSON Web Key Set
|
|
97
95
|
|
|
@@ -109,13 +107,10 @@ MoneyKit.configure do |config|
|
|
|
109
107
|
end
|
|
110
108
|
|
|
111
109
|
api_instance = MoneyKit::AccessTokenApi.new
|
|
112
|
-
opts = {
|
|
113
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
114
|
-
}
|
|
115
110
|
|
|
116
111
|
begin
|
|
117
112
|
# JSON Web Key Set
|
|
118
|
-
result = api_instance.get_well_known_jwks
|
|
113
|
+
result = api_instance.get_well_known_jwks
|
|
119
114
|
p result
|
|
120
115
|
rescue MoneyKit::ApiError => e
|
|
121
116
|
puts "Error when calling AccessTokenApi->get_well_known_jwks: #{e}"
|
|
@@ -126,12 +121,12 @@ end
|
|
|
126
121
|
|
|
127
122
|
This returns an Array which contains the response data, status code and headers.
|
|
128
123
|
|
|
129
|
-
> <Array(<JWKSet>, Integer, Hash)> get_well_known_jwks_with_http_info
|
|
124
|
+
> <Array(<JWKSet>, Integer, Hash)> get_well_known_jwks_with_http_info
|
|
130
125
|
|
|
131
126
|
```ruby
|
|
132
127
|
begin
|
|
133
128
|
# JSON Web Key Set
|
|
134
|
-
data, status_code, headers = api_instance.get_well_known_jwks_with_http_info
|
|
129
|
+
data, status_code, headers = api_instance.get_well_known_jwks_with_http_info
|
|
135
130
|
p status_code # => 2xx
|
|
136
131
|
p headers # => { ... }
|
|
137
132
|
p data # => <JWKSet>
|
|
@@ -142,9 +137,7 @@ end
|
|
|
142
137
|
|
|
143
138
|
### Parameters
|
|
144
139
|
|
|
145
|
-
|
|
146
|
-
| ---- | ---- | ----------- | ----- |
|
|
147
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
140
|
+
This endpoint does not need any parameter.
|
|
148
141
|
|
|
149
142
|
### Return type
|
|
150
143
|
|
|
@@ -162,7 +155,7 @@ end
|
|
|
162
155
|
|
|
163
156
|
## instrospect_client
|
|
164
157
|
|
|
165
|
-
> <IntrospectClientResponse> instrospect_client
|
|
158
|
+
> <IntrospectClientResponse> instrospect_client
|
|
166
159
|
|
|
167
160
|
/auth/introspect
|
|
168
161
|
|
|
@@ -180,13 +173,10 @@ MoneyKit.configure do |config|
|
|
|
180
173
|
end
|
|
181
174
|
|
|
182
175
|
api_instance = MoneyKit::AccessTokenApi.new
|
|
183
|
-
opts = {
|
|
184
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
185
|
-
}
|
|
186
176
|
|
|
187
177
|
begin
|
|
188
178
|
# /auth/introspect
|
|
189
|
-
result = api_instance.instrospect_client
|
|
179
|
+
result = api_instance.instrospect_client
|
|
190
180
|
p result
|
|
191
181
|
rescue MoneyKit::ApiError => e
|
|
192
182
|
puts "Error when calling AccessTokenApi->instrospect_client: #{e}"
|
|
@@ -197,12 +187,12 @@ end
|
|
|
197
187
|
|
|
198
188
|
This returns an Array which contains the response data, status code and headers.
|
|
199
189
|
|
|
200
|
-
> <Array(<IntrospectClientResponse>, Integer, Hash)> instrospect_client_with_http_info
|
|
190
|
+
> <Array(<IntrospectClientResponse>, Integer, Hash)> instrospect_client_with_http_info
|
|
201
191
|
|
|
202
192
|
```ruby
|
|
203
193
|
begin
|
|
204
194
|
# /auth/introspect
|
|
205
|
-
data, status_code, headers = api_instance.instrospect_client_with_http_info
|
|
195
|
+
data, status_code, headers = api_instance.instrospect_client_with_http_info
|
|
206
196
|
p status_code # => 2xx
|
|
207
197
|
p headers # => { ... }
|
|
208
198
|
p data # => <IntrospectClientResponse>
|
|
@@ -213,9 +203,7 @@ end
|
|
|
213
203
|
|
|
214
204
|
### Parameters
|
|
215
205
|
|
|
216
|
-
|
|
217
|
-
| ---- | ---- | ----------- | ----- |
|
|
218
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
206
|
+
This endpoint does not need any parameter.
|
|
219
207
|
|
|
220
208
|
### Return type
|
|
221
209
|
|
data/docs/AccountNumbersApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
|
9
9
|
|
|
10
10
|
## get_account_numbers
|
|
11
11
|
|
|
12
|
-
> <GetAccountNumbersResponse> get_account_numbers(id
|
|
12
|
+
> <GetAccountNumbersResponse> get_account_numbers(id)
|
|
13
13
|
|
|
14
14
|
/links/{id}/accounts/numbers
|
|
15
15
|
|
|
@@ -28,13 +28,10 @@ end
|
|
|
28
28
|
|
|
29
29
|
api_instance = MoneyKit::AccountNumbersApi.new
|
|
30
30
|
id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
|
|
31
|
-
opts = {
|
|
32
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
33
|
-
}
|
|
34
31
|
|
|
35
32
|
begin
|
|
36
33
|
# /links/{id}/accounts/numbers
|
|
37
|
-
result = api_instance.get_account_numbers(id
|
|
34
|
+
result = api_instance.get_account_numbers(id)
|
|
38
35
|
p result
|
|
39
36
|
rescue MoneyKit::ApiError => e
|
|
40
37
|
puts "Error when calling AccountNumbersApi->get_account_numbers: #{e}"
|
|
@@ -45,12 +42,12 @@ end
|
|
|
45
42
|
|
|
46
43
|
This returns an Array which contains the response data, status code and headers.
|
|
47
44
|
|
|
48
|
-
> <Array(<GetAccountNumbersResponse>, Integer, Hash)> get_account_numbers_with_http_info(id
|
|
45
|
+
> <Array(<GetAccountNumbersResponse>, Integer, Hash)> get_account_numbers_with_http_info(id)
|
|
49
46
|
|
|
50
47
|
```ruby
|
|
51
48
|
begin
|
|
52
49
|
# /links/{id}/accounts/numbers
|
|
53
|
-
data, status_code, headers = api_instance.get_account_numbers_with_http_info(id
|
|
50
|
+
data, status_code, headers = api_instance.get_account_numbers_with_http_info(id)
|
|
54
51
|
p status_code # => 2xx
|
|
55
52
|
p headers # => { ... }
|
|
56
53
|
p data # => <GetAccountNumbersResponse>
|
|
@@ -64,7 +61,6 @@ end
|
|
|
64
61
|
| Name | Type | Description | Notes |
|
|
65
62
|
| ---- | ---- | ----------- | ----- |
|
|
66
63
|
| **id** | **String** | The unique ID for this link. | |
|
|
67
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
68
64
|
|
|
69
65
|
### Return type
|
|
70
66
|
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **refreshed_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was updated. | [optional] |
|
|
8
8
|
| **last_attempted_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was attempted. | [optional] |
|
|
9
|
+
| **error_code** | [**LinkProductFailureReasons**](LinkProductFailureReasons.md) | | [optional] |
|
|
10
|
+
| **error_message** | **String** | The error message, if the last attempt to refresh the product failed. | [optional] |
|
|
9
11
|
| **settings** | [**AccountNumbersProductSettings**](AccountNumbersProductSettings.md) | | |
|
|
10
12
|
|
|
11
13
|
## Example
|
|
@@ -16,6 +18,8 @@ require 'moneykit'
|
|
|
16
18
|
instance = MoneyKit::AccountNumbersLinkProduct.new(
|
|
17
19
|
refreshed_at: 2023-02-16T09:14:11,
|
|
18
20
|
last_attempted_at: 2023-02-16T09:14:11,
|
|
21
|
+
error_code: null,
|
|
22
|
+
error_message: null,
|
|
19
23
|
settings: null
|
|
20
24
|
)
|
|
21
25
|
```
|
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **required** | **Boolean** | If true, only institutions supporting this product will be available. | [optional][default to false] |
|
|
8
8
|
| **prefetch** | **Boolean** | If true, the data will be available as soon as possible after linking, even if `required` is false. If false, the data will be available after the first manual data refresh. | [optional][default to false] |
|
|
9
|
-
| **product** | [**Product**](Product.md) | | [optional] |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
12
11
|
|
|
@@ -15,8 +14,7 @@ require 'moneykit'
|
|
|
15
14
|
|
|
16
15
|
instance = MoneyKit::AccountNumbersProductSettings.new(
|
|
17
16
|
required: null,
|
|
18
|
-
prefetch: null
|
|
19
|
-
product: null
|
|
17
|
+
prefetch: null
|
|
20
18
|
)
|
|
21
19
|
```
|
|
22
20
|
|
data/docs/AccountsApi.md
CHANGED
|
@@ -12,7 +12,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
|
12
12
|
|
|
13
13
|
## get_account
|
|
14
14
|
|
|
15
|
-
> <GetAccountResponse> get_account(id, account_id
|
|
15
|
+
> <GetAccountResponse> get_account(id, account_id)
|
|
16
16
|
|
|
17
17
|
/links/{id}/accounts/{account_id}
|
|
18
18
|
|
|
@@ -32,13 +32,10 @@ end
|
|
|
32
32
|
api_instance = MoneyKit::AccountsApi.new
|
|
33
33
|
id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
|
|
34
34
|
account_id = 'acc_6Tef269B6ZArSVpYrxtjBV' # String | The account ID to fetch.
|
|
35
|
-
opts = {
|
|
36
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
37
|
-
}
|
|
38
35
|
|
|
39
36
|
begin
|
|
40
37
|
# /links/{id}/accounts/{account_id}
|
|
41
|
-
result = api_instance.get_account(id, account_id
|
|
38
|
+
result = api_instance.get_account(id, account_id)
|
|
42
39
|
p result
|
|
43
40
|
rescue MoneyKit::ApiError => e
|
|
44
41
|
puts "Error when calling AccountsApi->get_account: #{e}"
|
|
@@ -49,12 +46,12 @@ end
|
|
|
49
46
|
|
|
50
47
|
This returns an Array which contains the response data, status code and headers.
|
|
51
48
|
|
|
52
|
-
> <Array(<GetAccountResponse>, Integer, Hash)> get_account_with_http_info(id, account_id
|
|
49
|
+
> <Array(<GetAccountResponse>, Integer, Hash)> get_account_with_http_info(id, account_id)
|
|
53
50
|
|
|
54
51
|
```ruby
|
|
55
52
|
begin
|
|
56
53
|
# /links/{id}/accounts/{account_id}
|
|
57
|
-
data, status_code, headers = api_instance.get_account_with_http_info(id, account_id
|
|
54
|
+
data, status_code, headers = api_instance.get_account_with_http_info(id, account_id)
|
|
58
55
|
p status_code # => 2xx
|
|
59
56
|
p headers # => { ... }
|
|
60
57
|
p data # => <GetAccountResponse>
|
|
@@ -69,7 +66,6 @@ end
|
|
|
69
66
|
| ---- | ---- | ----------- | ----- |
|
|
70
67
|
| **id** | **String** | The unique ID for this link. | |
|
|
71
68
|
| **account_id** | **String** | The account ID to fetch. | |
|
|
72
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
73
69
|
|
|
74
70
|
### Return type
|
|
75
71
|
|
|
@@ -87,7 +83,7 @@ end
|
|
|
87
83
|
|
|
88
84
|
## get_account_numbers
|
|
89
85
|
|
|
90
|
-
> <GetAccountNumbersResponse> get_account_numbers(id
|
|
86
|
+
> <GetAccountNumbersResponse> get_account_numbers(id)
|
|
91
87
|
|
|
92
88
|
/links/{id}/accounts/numbers
|
|
93
89
|
|
|
@@ -106,13 +102,10 @@ end
|
|
|
106
102
|
|
|
107
103
|
api_instance = MoneyKit::AccountsApi.new
|
|
108
104
|
id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
|
|
109
|
-
opts = {
|
|
110
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
111
|
-
}
|
|
112
105
|
|
|
113
106
|
begin
|
|
114
107
|
# /links/{id}/accounts/numbers
|
|
115
|
-
result = api_instance.get_account_numbers(id
|
|
108
|
+
result = api_instance.get_account_numbers(id)
|
|
116
109
|
p result
|
|
117
110
|
rescue MoneyKit::ApiError => e
|
|
118
111
|
puts "Error when calling AccountsApi->get_account_numbers: #{e}"
|
|
@@ -123,12 +116,12 @@ end
|
|
|
123
116
|
|
|
124
117
|
This returns an Array which contains the response data, status code and headers.
|
|
125
118
|
|
|
126
|
-
> <Array(<GetAccountNumbersResponse>, Integer, Hash)> get_account_numbers_with_http_info(id
|
|
119
|
+
> <Array(<GetAccountNumbersResponse>, Integer, Hash)> get_account_numbers_with_http_info(id)
|
|
127
120
|
|
|
128
121
|
```ruby
|
|
129
122
|
begin
|
|
130
123
|
# /links/{id}/accounts/numbers
|
|
131
|
-
data, status_code, headers = api_instance.get_account_numbers_with_http_info(id
|
|
124
|
+
data, status_code, headers = api_instance.get_account_numbers_with_http_info(id)
|
|
132
125
|
p status_code # => 2xx
|
|
133
126
|
p headers # => { ... }
|
|
134
127
|
p data # => <GetAccountNumbersResponse>
|
|
@@ -142,7 +135,6 @@ end
|
|
|
142
135
|
| Name | Type | Description | Notes |
|
|
143
136
|
| ---- | ---- | ----------- | ----- |
|
|
144
137
|
| **id** | **String** | The unique ID for this link. | |
|
|
145
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
146
138
|
|
|
147
139
|
### Return type
|
|
148
140
|
|
|
@@ -180,8 +172,7 @@ end
|
|
|
180
172
|
api_instance = MoneyKit::AccountsApi.new
|
|
181
173
|
id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
|
|
182
174
|
opts = {
|
|
183
|
-
account_ids: ['inner_example']
|
|
184
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
175
|
+
account_ids: ['inner_example'] # Array<String> | An optional list of account IDs to filter the results.
|
|
185
176
|
}
|
|
186
177
|
|
|
187
178
|
begin
|
|
@@ -217,7 +208,6 @@ end
|
|
|
217
208
|
| ---- | ---- | ----------- | ----- |
|
|
218
209
|
| **id** | **String** | The unique ID for this link. | |
|
|
219
210
|
| **account_ids** | [**Array<String>**](String.md) | An optional list of account IDs to filter the results. | [optional] |
|
|
220
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
221
211
|
|
|
222
212
|
### Return type
|
|
223
213
|
|
|
@@ -256,8 +246,7 @@ api_instance = MoneyKit::AccountsApi.new
|
|
|
256
246
|
id = 'MyUser1234' # String | The unique ID for this user. This is the same ID provided in the call to <a href=#operation/create_link_session>/link-session</a> to create any link for this user.
|
|
257
247
|
opts = {
|
|
258
248
|
account_id: ['inner_example'], # Array<String> | If present, filters results to accounts matching the given IDs.
|
|
259
|
-
institution_id: ['inner_example']
|
|
260
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
249
|
+
institution_id: ['inner_example'] # Array<String> | If present, filters results to accounts at institutions matching the given IDs.
|
|
261
250
|
}
|
|
262
251
|
|
|
263
252
|
begin
|
|
@@ -294,7 +283,6 @@ end
|
|
|
294
283
|
| **id** | **String** | The unique ID for this user. This is the same ID provided in the call to <a href=#operation/create_link_session>/link-session</a> to create any link for this user. | |
|
|
295
284
|
| **account_id** | [**Array<String>**](String.md) | If present, filters results to accounts matching the given IDs. | [optional] |
|
|
296
285
|
| **institution_id** | [**Array<String>**](String.md) | If present, filters results to accounts at institutions matching the given IDs. | [optional] |
|
|
297
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
298
286
|
|
|
299
287
|
### Return type
|
|
300
288
|
|
data/docs/AccountsLinkProduct.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **refreshed_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was updated. | [optional] |
|
|
8
8
|
| **last_attempted_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was attempted. | [optional] |
|
|
9
|
+
| **error_code** | [**LinkProductFailureReasons**](LinkProductFailureReasons.md) | | [optional] |
|
|
10
|
+
| **error_message** | **String** | The error message, if the last attempt to refresh the product failed. | [optional] |
|
|
9
11
|
|
|
10
12
|
## Example
|
|
11
13
|
|
|
@@ -14,7 +16,9 @@ require 'moneykit'
|
|
|
14
16
|
|
|
15
17
|
instance = MoneyKit::AccountsLinkProduct.new(
|
|
16
18
|
refreshed_at: 2023-02-16T09:14:11,
|
|
17
|
-
last_attempted_at: 2023-02-16T09:14:11
|
|
19
|
+
last_attempted_at: 2023-02-16T09:14:11,
|
|
20
|
+
error_code: null,
|
|
21
|
+
error_message: null
|
|
18
22
|
)
|
|
19
23
|
```
|
|
20
24
|
|
data/docs/Body.md
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
| **link_id** | **Object** | | |
|
|
13
13
|
| **link_tags** | **Object** | | |
|
|
14
14
|
| **state** | [**LinkProductState**](LinkProductState.md) | | |
|
|
15
|
-
| **error** | [**
|
|
15
|
+
| **error** | [**LinkError**](LinkError.md) | | [optional] |
|
|
16
16
|
| **error_message** | **Object** | | [optional] |
|
|
17
17
|
| **product** | [**Product**](Product.md) | | |
|
|
18
18
|
| **state_changed_at** | **Object** | | |
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# MoneyKit::GetHoldingsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **holdings** | [**Array<HoldingResponse>**](HoldingResponse.md) | | |
|
|
8
|
+
| **securities** | [**Array<SecurityResponse>**](SecurityResponse.md) | | |
|
|
9
|
+
| **accounts** | [**Array<Account>**](Account.md) | | |
|
|
10
|
+
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'moneykit'
|
|
16
|
+
|
|
17
|
+
instance = MoneyKit::GetHoldingsResponse.new(
|
|
18
|
+
holdings: null,
|
|
19
|
+
securities: null,
|
|
20
|
+
accounts: null,
|
|
21
|
+
link: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# MoneyKit::GetInvestmentTransactionsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total** | **Integer** | The total number of results for this query. | |
|
|
8
|
+
| **page** | **Integer** | The page number corresponding to this batch of results. | |
|
|
9
|
+
| **size** | **Integer** | The number of results in this batch. | |
|
|
10
|
+
| **investment_transactions** | [**Array<InvestmentTransactionResponse>**](InvestmentTransactionResponse.md) | | |
|
|
11
|
+
| **securities** | [**Array<SecurityResponse>**](SecurityResponse.md) | | |
|
|
12
|
+
| **accounts** | [**Array<Account>**](Account.md) | | |
|
|
13
|
+
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'moneykit'
|
|
19
|
+
|
|
20
|
+
instance = MoneyKit::GetInvestmentTransactionsResponse.new(
|
|
21
|
+
total: 82,
|
|
22
|
+
page: 1,
|
|
23
|
+
size: 50,
|
|
24
|
+
investment_transactions: null,
|
|
25
|
+
securities: null,
|
|
26
|
+
accounts: null,
|
|
27
|
+
link: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# MoneyKit::HoldingResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | The MoneyKit ID of the account for this holding. | |
|
|
8
|
+
| **security_id** | **String** | The MoneyKit ID of the security for this holding. | |
|
|
9
|
+
| **quantity** | **String** | The units of this security (aka \"shares\") held. | |
|
|
10
|
+
| **price** | **String** | The per-share price of this holding, as reported by the institution, denominated in account currency. | [optional] |
|
|
11
|
+
| **price_datetime** | **Time** | The timestamp for which the institution-reported price is valid. | [optional] |
|
|
12
|
+
| **value** | **String** | The value of this holding, as reported by the institution, denominated in account currency. | [optional] |
|
|
13
|
+
| **cost_basis** | **String** | The total purchase cost of the holding, as reported by the institution, denominated in account currency. | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'moneykit'
|
|
19
|
+
|
|
20
|
+
instance = MoneyKit::HoldingResponse.new(
|
|
21
|
+
account_id: acc_6Tef269B6ZArSVpYrxtjBV,
|
|
22
|
+
security_id: sec_bb6fi893jxdfNxyAjnb784,
|
|
23
|
+
quantity: 10,
|
|
24
|
+
price: 98.12,
|
|
25
|
+
price_datetime: 2023-02-16T09:14:11,
|
|
26
|
+
value: 987.15,
|
|
27
|
+
cost_basis: 781.38
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
data/docs/IdentityApi.md
CHANGED
|
@@ -29,8 +29,7 @@ end
|
|
|
29
29
|
api_instance = MoneyKit::IdentityApi.new
|
|
30
30
|
id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
|
|
31
31
|
opts = {
|
|
32
|
-
account_ids: ['inner_example']
|
|
33
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
32
|
+
account_ids: ['inner_example'] # Array<String> | An optional list of account IDs to filter the results.
|
|
34
33
|
}
|
|
35
34
|
|
|
36
35
|
begin
|
|
@@ -66,7 +65,6 @@ end
|
|
|
66
65
|
| ---- | ---- | ----------- | ----- |
|
|
67
66
|
| **id** | **String** | The unique ID for this link. | |
|
|
68
67
|
| **account_ids** | [**Array<String>**](String.md) | An optional list of account IDs to filter the results. | [optional] |
|
|
69
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
70
68
|
|
|
71
69
|
### Return type
|
|
72
70
|
|
data/docs/IdentityLinkProduct.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **refreshed_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was updated. | [optional] |
|
|
8
8
|
| **last_attempted_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was attempted. | [optional] |
|
|
9
|
+
| **error_code** | [**LinkProductFailureReasons**](LinkProductFailureReasons.md) | | [optional] |
|
|
10
|
+
| **error_message** | **String** | The error message, if the last attempt to refresh the product failed. | [optional] |
|
|
9
11
|
| **settings** | [**IdentityProductSettings**](IdentityProductSettings.md) | | |
|
|
10
12
|
|
|
11
13
|
## Example
|
|
@@ -16,6 +18,8 @@ require 'moneykit'
|
|
|
16
18
|
instance = MoneyKit::IdentityLinkProduct.new(
|
|
17
19
|
refreshed_at: 2023-02-16T09:14:11,
|
|
18
20
|
last_attempted_at: 2023-02-16T09:14:11,
|
|
21
|
+
error_code: null,
|
|
22
|
+
error_message: null,
|
|
19
23
|
settings: null
|
|
20
24
|
)
|
|
21
25
|
```
|
|
@@ -6,7 +6,6 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **required** | **Boolean** | If true, only institutions supporting this product will be available. | [optional][default to false] |
|
|
8
8
|
| **prefetch** | **Boolean** | If true, the data will be available as soon as possible after linking, even if `required` is false. If false, the data will be available after the first manual data refresh. | [optional][default to false] |
|
|
9
|
-
| **product** | [**Product**](Product.md) | | [optional] |
|
|
10
9
|
|
|
11
10
|
## Example
|
|
12
11
|
|
|
@@ -15,8 +14,7 @@ require 'moneykit'
|
|
|
15
14
|
|
|
16
15
|
instance = MoneyKit::IdentityProductSettings.new(
|
|
17
16
|
required: null,
|
|
18
|
-
prefetch: null
|
|
19
|
-
product: null
|
|
17
|
+
prefetch: null
|
|
20
18
|
)
|
|
21
19
|
```
|
|
22
20
|
|
data/docs/InstitutionsApi.md
CHANGED
|
@@ -10,7 +10,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
|
10
10
|
|
|
11
11
|
## get_institution
|
|
12
12
|
|
|
13
|
-
> <Institution> get_institution(institution_id
|
|
13
|
+
> <Institution> get_institution(institution_id)
|
|
14
14
|
|
|
15
15
|
/institutions/{institution_id}
|
|
16
16
|
|
|
@@ -29,13 +29,10 @@ end
|
|
|
29
29
|
|
|
30
30
|
api_instance = MoneyKit::InstitutionsApi.new
|
|
31
31
|
institution_id = 'chase' # String | The institution ID to fetch.
|
|
32
|
-
opts = {
|
|
33
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
34
|
-
}
|
|
35
32
|
|
|
36
33
|
begin
|
|
37
34
|
# /institutions/{institution_id}
|
|
38
|
-
result = api_instance.get_institution(institution_id
|
|
35
|
+
result = api_instance.get_institution(institution_id)
|
|
39
36
|
p result
|
|
40
37
|
rescue MoneyKit::ApiError => e
|
|
41
38
|
puts "Error when calling InstitutionsApi->get_institution: #{e}"
|
|
@@ -46,12 +43,12 @@ end
|
|
|
46
43
|
|
|
47
44
|
This returns an Array which contains the response data, status code and headers.
|
|
48
45
|
|
|
49
|
-
> <Array(<Institution>, Integer, Hash)> get_institution_with_http_info(institution_id
|
|
46
|
+
> <Array(<Institution>, Integer, Hash)> get_institution_with_http_info(institution_id)
|
|
50
47
|
|
|
51
48
|
```ruby
|
|
52
49
|
begin
|
|
53
50
|
# /institutions/{institution_id}
|
|
54
|
-
data, status_code, headers = api_instance.get_institution_with_http_info(institution_id
|
|
51
|
+
data, status_code, headers = api_instance.get_institution_with_http_info(institution_id)
|
|
55
52
|
p status_code # => 2xx
|
|
56
53
|
p headers # => { ... }
|
|
57
54
|
p data # => <Institution>
|
|
@@ -65,7 +62,6 @@ end
|
|
|
65
62
|
| Name | Type | Description | Notes |
|
|
66
63
|
| ---- | ---- | ----------- | ----- |
|
|
67
64
|
| **institution_id** | **String** | The institution ID to fetch. | |
|
|
68
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
69
65
|
|
|
70
66
|
### Return type
|
|
71
67
|
|
|
@@ -105,8 +101,7 @@ opts = {
|
|
|
105
101
|
name: 'Chase', # String | If provided, returns only institutions containing this name (wholly or as a prefix).
|
|
106
102
|
featured: true, # Boolean | If true, returns only featured institutions.
|
|
107
103
|
cursor: 'cursor_example', # String | Cursor to fetch the next set of institutions. (You get this value from the previous call to `/institutions`.)
|
|
108
|
-
limit: 56
|
|
109
|
-
moneykit_version: 'moneykit_version_example' # String |
|
|
104
|
+
limit: 56 # Integer | A limit on the number of institutions to be returned.
|
|
110
105
|
}
|
|
111
106
|
|
|
112
107
|
begin
|
|
@@ -144,7 +139,6 @@ end
|
|
|
144
139
|
| **featured** | **Boolean** | If true, returns only featured institutions. | [optional][default to false] |
|
|
145
140
|
| **cursor** | **String** | Cursor to fetch the next set of institutions. (You get this value from the previous call to `/institutions`.) | [optional] |
|
|
146
141
|
| **limit** | **Integer** | A limit on the number of institutions to be returned. | [optional][default to 50] |
|
|
147
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
|
148
142
|
|
|
149
143
|
### Return type
|
|
150
144
|
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# MoneyKit::InvestmentTransactionResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The unique ID for this investment transaction. | |
|
|
8
|
+
| **account_id** | **String** | The ID of the account in which this investment transaction occurred. | |
|
|
9
|
+
| **amount** | **String** | The total value of this transaction, denominated in account currency. Positive values indicate debits (deposits); negative values are credits (withdrawals). For example, for a `buy` transaction, the amount will be equal to `-(quantity * price + fees)`. | |
|
|
10
|
+
| **date** | **Date** | The effective (posted) date of the transaction, in ISO-8601 format. | |
|
|
11
|
+
| **datetime** | **Time** | If the institution has provided the actual time of the transaction, this field contains the full date and time of the transaction, in ISO-8601 format. If the time is not available, this field will be null. <p>Note that the time is generally reported in the timezone of the institution or the account holder. | [optional] |
|
|
12
|
+
| **description** | **String** | A normalized, cleaned transaction description suitable for presentation to the end user. | |
|
|
13
|
+
| **type** | **String** | The type of transaction (buy, sell, cash, fee, transfer). May include a dotted subtype, for example, `buy.buy_to_cover` or `fee.transfer_fee`. | |
|
|
14
|
+
| **fees** | **String** | The combined value of any fees applied to the transaction. Fees are subtracted from the total transaction amount, and are reported as positive values; refunds are reported as negative values. | [optional] |
|
|
15
|
+
| **forex_rate** | **String** | The currency exchange rate applied. Only present for transactions involving a security that is denominated in a currency other than the account currency. | [optional] |
|
|
16
|
+
| **price** | **String** | The price per share, denominated in account currency. Omitted for transactions not involving a security. | [optional] |
|
|
17
|
+
| **quantity** | **String** | The units of security (aka \"shares\") bought, sold, or transferred. Omitted for transactions not involving a security. Positive values indicate shares added to the account. | [optional] |
|
|
18
|
+
| **security_id** | **String** | The MoneyKit ID of the security involved in this transaction (for example, the security bought or sold, or upon which interest or dividends are paid. | [optional] |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'moneykit'
|
|
24
|
+
|
|
25
|
+
instance = MoneyKit::InvestmentTransactionResponse.new(
|
|
26
|
+
id: it_R73abx78zoa2NxyAlki90g,
|
|
27
|
+
account_id: acc_6Tef269B6ZArSVpYrxtjBV,
|
|
28
|
+
amount: 987.15,
|
|
29
|
+
date: 2023-02-16T00:00:00,
|
|
30
|
+
datetime: 2023-02-16T09:14:11,
|
|
31
|
+
description: Bought MSFT,
|
|
32
|
+
type: buy,
|
|
33
|
+
fees: 5.95,
|
|
34
|
+
forex_rate: null,
|
|
35
|
+
price: 98.12,
|
|
36
|
+
quantity: 10,
|
|
37
|
+
security_id: sec_bb6fi893jxdfNxyAjnb784
|
|
38
|
+
)
|
|
39
|
+
```
|
|
40
|
+
|