moneykit 0.1.1 → 0.1.3
Sign up to get free protection for your applications and to get access to all the features.
- 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 +3 -1
- data/docs/LinkError.md +15 -0
- data/docs/LinkProductFailureReasons.md +15 -0
- data/docs/LinkProducts.md +3 -1
- data/docs/LinkResponse.md +3 -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 +20 -3
- 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 +20 -3
- 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 +153 -101
data/docs/ProductsApi.md
CHANGED
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
9
9
|
|
10
10
|
## refresh_products
|
11
11
|
|
12
|
-
> refresh_products(id, refresh_products_request
|
12
|
+
> refresh_products(id, refresh_products_request)
|
13
13
|
|
14
14
|
/links/{id}/products
|
15
15
|
|
@@ -29,13 +29,10 @@ end
|
|
29
29
|
api_instance = MoneyKit::ProductsApi.new
|
30
30
|
id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
|
31
31
|
refresh_products_request = MoneyKit::RefreshProductsRequest.new({products: [MoneyKit::Product::ACCOUNTS]}) # RefreshProductsRequest |
|
32
|
-
opts = {
|
33
|
-
moneykit_version: 'moneykit_version_example' # String |
|
34
|
-
}
|
35
32
|
|
36
33
|
begin
|
37
34
|
# /links/{id}/products
|
38
|
-
api_instance.refresh_products(id, refresh_products_request
|
35
|
+
api_instance.refresh_products(id, refresh_products_request)
|
39
36
|
rescue MoneyKit::ApiError => e
|
40
37
|
puts "Error when calling ProductsApi->refresh_products: #{e}"
|
41
38
|
end
|
@@ -45,12 +42,12 @@ end
|
|
45
42
|
|
46
43
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
47
44
|
|
48
|
-
> <Array(nil, Integer, Hash)> refresh_products_with_http_info(id, refresh_products_request
|
45
|
+
> <Array(nil, Integer, Hash)> refresh_products_with_http_info(id, refresh_products_request)
|
49
46
|
|
50
47
|
```ruby
|
51
48
|
begin
|
52
49
|
# /links/{id}/products
|
53
|
-
data, status_code, headers = api_instance.refresh_products_with_http_info(id, refresh_products_request
|
50
|
+
data, status_code, headers = api_instance.refresh_products_with_http_info(id, refresh_products_request)
|
54
51
|
p status_code # => 2xx
|
55
52
|
p headers # => { ... }
|
56
53
|
p data # => nil
|
@@ -65,7 +62,6 @@ end
|
|
65
62
|
| ---- | ---- | ----------- | ----- |
|
66
63
|
| **id** | **String** | The unique ID for this link. | |
|
67
64
|
| **refresh_products_request** | [**RefreshProductsRequest**](RefreshProductsRequest.md) | | |
|
68
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
69
65
|
|
70
66
|
### Return type
|
71
67
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::Response401GetHoldingsLinksIdInvestmentsHoldingsGet
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_code** | **Object** | | [optional] |
|
8
|
+
| **error_message** | **Object** | | |
|
9
|
+
| **documentation_url** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::Response401GetHoldingsLinksIdInvestmentsHoldingsGet.new(
|
17
|
+
error_code: null,
|
18
|
+
error_message: null,
|
19
|
+
documentation_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::Response401GetInvestmentTransactionsLinksIdInvestmentsTransactionsGet
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_code** | **Object** | | [optional] |
|
8
|
+
| **error_message** | **Object** | | |
|
9
|
+
| **documentation_url** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::Response401GetInvestmentTransactionsLinksIdInvestmentsTransactionsGet.new(
|
17
|
+
error_code: null,
|
18
|
+
error_message: null,
|
19
|
+
documentation_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::Response401GetTransactions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_code** | **Object** | | [optional] |
|
8
|
+
| **error_message** | **Object** | | |
|
9
|
+
| **documentation_url** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::Response401GetTransactions.new(
|
17
|
+
error_code: null,
|
18
|
+
error_message: null,
|
19
|
+
documentation_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::Response401GetUserTransactions
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_code** | **Object** | | [optional] |
|
8
|
+
| **error_message** | **Object** | Error message | |
|
9
|
+
| **documentation_url** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::Response401GetUserTransactions.new(
|
17
|
+
error_code: null,
|
18
|
+
error_message: Accounts access not permitted,
|
19
|
+
documentation_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -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,34 @@
|
|
1
|
+
# MoneyKit::SecurityResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | A unique MoneyKit ID for this security. | |
|
8
|
+
| **name** | **String** | A user-facing name for this security. | |
|
9
|
+
| **type** | **String** | The type of this security. Will be one of: <p>`cash`: Cash, currency, and money market funds <p>`crypto`: Digital or virtual currencies <p>`derivative`: Options, warrants, and other derivative instruments <p>`equity`: Equities (stocks) <p>`etf`: Exchange-traded investment funds <p>`bond`: Bonds and certificates of deposit (CDs) <p>`loan`: Loans and loan receivables <p>`fund`: Open- and closed-end vehicles pooling funds of multiple investors <p>`unknown`: Indicates the type is unknown or does not fit into any other category | |
|
10
|
+
| **currency** | **String** | The ISO-4217 code for the currency in which this security is priced. | |
|
11
|
+
| **ticker** | **String** | The security's public trading symbol, if available. | [optional] |
|
12
|
+
| **isin** | **String** | The ISO 6166 globally unique ID for this security, if available. | [optional] |
|
13
|
+
| **sedol** | **String** | The security's SEDOL ID from the London Stock Exchange, if available. | [optional] |
|
14
|
+
| **close_price** | **String** | The price of the security at the close of the previous trading session, given in pricing currency. | [optional] |
|
15
|
+
| **close_date** | **Date** | The date for which `close_price` is given. | [optional] |
|
16
|
+
|
17
|
+
## Example
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'moneykit'
|
21
|
+
|
22
|
+
instance = MoneyKit::SecurityResponse.new(
|
23
|
+
id: sec_bb6fi893jxdfNxyAjnb784,
|
24
|
+
name: Microsoft,
|
25
|
+
type: equity,
|
26
|
+
currency: USD,
|
27
|
+
ticker: MSFT,
|
28
|
+
isin: US5949181045,
|
29
|
+
sedol: null,
|
30
|
+
close_price: 98.12,
|
31
|
+
close_date: 2022-02-08
|
32
|
+
)
|
33
|
+
```
|
34
|
+
|
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **transactions** | [**TransactionDiff**](TransactionDiff.md) | | |
|
8
8
|
| **cursor** | [**CursorPagination**](CursorPagination.md) | | |
|
9
|
-
| **has_more** | **Boolean** | This condition indicates the presence of transaction updates exceeding the requested count. If true, additional updates
|
9
|
+
| **has_more** | **Boolean** | This condition indicates the presence of transaction updates exceeding the requested count. If true, additional updates MUST be retrieved by making an additional request with cursor set to `cursor.next`. | |
|
10
10
|
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
11
11
|
|
12
12
|
## Example
|
data/docs/TransactionsApi.md
CHANGED
@@ -15,7 +15,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
15
15
|
|
16
16
|
/links/{id}/transactions
|
17
17
|
|
18
|
-
Returns transactions for the accounts associated with a <a href=#tag/Links>link</a>. Results are
|
18
|
+
Returns transactions for the accounts associated with a <a href=#tag/Links>link</a>. Results are paginated, and returned in reverse chronological order. <p>**Note** that this endpoint does **not** trigger a fetch of transactions from the institution; it merely returns transactions that have already been fetched, either because `prefetch` was requested when the link was created, or because of scheduled or on-demand updates. <p>MoneyKit checks for updated account data, including transactions, periodically throughout the day, but the update frequency can vary, depending on the downstream data provider, the institution, and whether one or both provide webhook-based updates. **To force a check for updated transactions, you can use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.
|
19
19
|
|
20
20
|
### Examples
|
21
21
|
|
@@ -35,8 +35,7 @@ opts = {
|
|
35
35
|
page: 56, # Integer | The page number to return.
|
36
36
|
size: 56, # Integer | The number of items to return per page.
|
37
37
|
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the `end_date`. <p>If you want to retrieve **all** transactions, use `1900-01-01`.
|
38
|
-
end_date: Date.parse('2013-10-20')
|
39
|
-
moneykit_version: 'moneykit_version_example' # String |
|
38
|
+
end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
40
39
|
}
|
41
40
|
|
42
41
|
begin
|
@@ -76,7 +75,6 @@ end
|
|
76
75
|
| **size** | **Integer** | The number of items to return per page. | [optional][default to 50] |
|
77
76
|
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the `end_date`. <p>If you want to retrieve **all** transactions, use `1900-01-01`. | [optional] |
|
78
77
|
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today. | [optional] |
|
79
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
80
78
|
|
81
79
|
### Return type
|
82
80
|
|
@@ -98,7 +96,7 @@ end
|
|
98
96
|
|
99
97
|
/links/{id}/transactions/sync
|
100
98
|
|
101
|
-
Provides a paginated feed of transactions, grouped into `created`, `updated`, and `removed` lists. <p>Each call will also return a `
|
99
|
+
Provides a paginated feed of transactions, grouped into `created`, `updated`, and `removed` lists. <p>Each call will also return a `cursor.next` value. In subsequent calls, include that value to receive only changes that have occurred since the previous call. <p>Large numbers of transactions will be paginated, and the `has_more` field will be true. You should continue calling this endpoint with each new `cursor.next` value until `has_more` is false. <p>**Note** that this endpoint does **not** trigger a fetch of transactions from the institution; it merely returns transactions that have already been fetched, either because `prefetch` was requested when the link was created, or because of scheduled or on-demand updates. <p>MoneyKit checks for updated account data, including transactions, periodically throughout the day, but the update frequency can vary, depending on the downstream data provider, the institution, and whether one or both provide webhook-based updates. **To force a check for updated transactions, you can use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>Note also that the `transactions.updates_available` webhook will alert you when new data is available.
|
102
100
|
|
103
101
|
### Examples
|
104
102
|
|
@@ -115,8 +113,7 @@ api_instance = MoneyKit::TransactionsApi.new
|
|
115
113
|
id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
|
116
114
|
opts = {
|
117
115
|
cursor: 'cursor_example', # String | A cursor value representing the last update requested. If included, the response will only return changes after this update. If omitted, a complete history of updates will be returned. This value must be stored by the client as we do not keep track of customer cursors.
|
118
|
-
size: 56
|
119
|
-
moneykit_version: 'moneykit_version_example' # String |
|
116
|
+
size: 56 # Integer | The number of items to return.
|
120
117
|
}
|
121
118
|
|
122
119
|
begin
|
@@ -153,7 +150,6 @@ end
|
|
153
150
|
| **id** | **String** | The unique ID for this link. | |
|
154
151
|
| **cursor** | **String** | A cursor value representing the last update requested. If included, the response will only return changes after this update. If omitted, a complete history of updates will be returned. This value must be stored by the client as we do not keep track of customer cursors. | [optional] |
|
155
152
|
| **size** | **Integer** | The number of items to return. | [optional][default to 50] |
|
156
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
157
153
|
|
158
154
|
### Return type
|
159
155
|
|
@@ -198,8 +194,7 @@ opts = {
|
|
198
194
|
page: 56, # Integer | The page number to return.
|
199
195
|
size: 56, # Integer | The number of items to return per page.
|
200
196
|
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the `end_date`. <p>If you want to retrieve **all** transactions, use `1900-01-01`.
|
201
|
-
end_date: Date.parse('2013-10-20')
|
202
|
-
moneykit_version: 'moneykit_version_example' # String |
|
197
|
+
end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
203
198
|
}
|
204
199
|
|
205
200
|
begin
|
@@ -242,7 +237,6 @@ end
|
|
242
237
|
| **size** | **Integer** | The number of items to return per page. | [optional][default to 50] |
|
243
238
|
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the `end_date`. <p>If you want to retrieve **all** transactions, use `1900-01-01`. | [optional] |
|
244
239
|
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today. | [optional] |
|
245
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
246
240
|
|
247
241
|
### Return type
|
248
242
|
|
@@ -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** | [**TransactionsProductSettings**](TransactionsProductSettings.md) | | |
|
10
12
|
|
11
13
|
## Example
|
@@ -16,6 +18,8 @@ require 'moneykit'
|
|
16
18
|
instance = MoneyKit::TransactionsLinkProduct.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
|
| **extend_history** | **Boolean** | If true, MoneyKit will attempt to fetch as much transaction history as possible. Not all institutions supply the same extent of transaction history. Generally, however, at least the past 30 days of transactions are available. | [optional][default to false] |
|
11
10
|
|
12
11
|
## Example
|
@@ -17,7 +16,6 @@ require 'moneykit'
|
|
17
16
|
instance = MoneyKit::TransactionsProductSettings.new(
|
18
17
|
required: null,
|
19
18
|
prefetch: null,
|
20
|
-
product: null,
|
21
19
|
extend_history: null
|
22
20
|
)
|
23
21
|
```
|
data/docs/UsersApi.md
CHANGED
@@ -32,8 +32,7 @@ api_instance = MoneyKit::UsersApi.new
|
|
32
32
|
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.
|
33
33
|
opts = {
|
34
34
|
account_id: ['inner_example'], # Array<String> | If present, filters results to accounts matching the given IDs.
|
35
|
-
institution_id: ['inner_example']
|
36
|
-
moneykit_version: 'moneykit_version_example' # String |
|
35
|
+
institution_id: ['inner_example'] # Array<String> | If present, filters results to accounts at institutions matching the given IDs.
|
37
36
|
}
|
38
37
|
|
39
38
|
begin
|
@@ -70,7 +69,6 @@ end
|
|
70
69
|
| **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. | |
|
71
70
|
| **account_id** | [**Array<String>**](String.md) | If present, filters results to accounts matching the given IDs. | [optional] |
|
72
71
|
| **institution_id** | [**Array<String>**](String.md) | If present, filters results to accounts at institutions matching the given IDs. | [optional] |
|
73
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
74
72
|
|
75
73
|
### Return type
|
76
74
|
|
@@ -88,7 +86,7 @@ end
|
|
88
86
|
|
89
87
|
## get_user_links
|
90
88
|
|
91
|
-
> <GetUserLinksResponse> get_user_links(id
|
89
|
+
> <GetUserLinksResponse> get_user_links(id)
|
92
90
|
|
93
91
|
/users/{id}/links
|
94
92
|
|
@@ -107,13 +105,10 @@ end
|
|
107
105
|
|
108
106
|
api_instance = MoneyKit::UsersApi.new
|
109
107
|
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.
|
110
|
-
opts = {
|
111
|
-
moneykit_version: 'moneykit_version_example' # String |
|
112
|
-
}
|
113
108
|
|
114
109
|
begin
|
115
110
|
# /users/{id}/links
|
116
|
-
result = api_instance.get_user_links(id
|
111
|
+
result = api_instance.get_user_links(id)
|
117
112
|
p result
|
118
113
|
rescue MoneyKit::ApiError => e
|
119
114
|
puts "Error when calling UsersApi->get_user_links: #{e}"
|
@@ -124,12 +119,12 @@ end
|
|
124
119
|
|
125
120
|
This returns an Array which contains the response data, status code and headers.
|
126
121
|
|
127
|
-
> <Array(<GetUserLinksResponse>, Integer, Hash)> get_user_links_with_http_info(id
|
122
|
+
> <Array(<GetUserLinksResponse>, Integer, Hash)> get_user_links_with_http_info(id)
|
128
123
|
|
129
124
|
```ruby
|
130
125
|
begin
|
131
126
|
# /users/{id}/links
|
132
|
-
data, status_code, headers = api_instance.get_user_links_with_http_info(id
|
127
|
+
data, status_code, headers = api_instance.get_user_links_with_http_info(id)
|
133
128
|
p status_code # => 2xx
|
134
129
|
p headers # => { ... }
|
135
130
|
p data # => <GetUserLinksResponse>
|
@@ -143,7 +138,6 @@ end
|
|
143
138
|
| Name | Type | Description | Notes |
|
144
139
|
| ---- | ---- | ----------- | ----- |
|
145
140
|
| **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. | |
|
146
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
147
141
|
|
148
142
|
### Return type
|
149
143
|
|
@@ -188,8 +182,7 @@ opts = {
|
|
188
182
|
page: 56, # Integer | The page number to return.
|
189
183
|
size: 56, # Integer | The number of items to return per page.
|
190
184
|
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the `end_date`. <p>If you want to retrieve **all** transactions, use `1900-01-01`.
|
191
|
-
end_date: Date.parse('2013-10-20')
|
192
|
-
moneykit_version: 'moneykit_version_example' # String |
|
185
|
+
end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
193
186
|
}
|
194
187
|
|
195
188
|
begin
|
@@ -232,7 +225,6 @@ end
|
|
232
225
|
| **size** | **Integer** | The number of items to return per page. | [optional][default to 50] |
|
233
226
|
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to 90 days before the `end_date`. <p>If you want to retrieve **all** transactions, use `1900-01-01`. | [optional] |
|
234
227
|
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today. | [optional] |
|
235
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
236
228
|
|
237
229
|
### Return type
|
238
230
|
|
data/docs/WebhooksApi.md
CHANGED
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
9
9
|
|
10
10
|
## trigger_test_link_webhook_event
|
11
11
|
|
12
|
-
> <WebhookTestLinkResponse> trigger_test_link_webhook_event(id, webhook_test_link_request
|
12
|
+
> <WebhookTestLinkResponse> trigger_test_link_webhook_event(id, webhook_test_link_request)
|
13
13
|
|
14
14
|
Trigger a test webhook event for a link (Sandbox only).
|
15
15
|
|
@@ -27,13 +27,10 @@ end
|
|
27
27
|
api_instance = MoneyKit::WebhooksApi.new
|
28
28
|
id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
|
29
29
|
webhook_test_link_request = MoneyKit::WebhookTestLinkRequest.new({webhook_event: MoneyKit::WebhookLinkTestEvent::LINK_STATE_CHANGED, webhook_idempotency_key: 'webhook_idempotency_key_example'}) # WebhookTestLinkRequest |
|
30
|
-
opts = {
|
31
|
-
moneykit_version: 'moneykit_version_example' # String |
|
32
|
-
}
|
33
30
|
|
34
31
|
begin
|
35
32
|
# Trigger a test webhook event for a link (Sandbox only).
|
36
|
-
result = api_instance.trigger_test_link_webhook_event(id, webhook_test_link_request
|
33
|
+
result = api_instance.trigger_test_link_webhook_event(id, webhook_test_link_request)
|
37
34
|
p result
|
38
35
|
rescue MoneyKit::ApiError => e
|
39
36
|
puts "Error when calling WebhooksApi->trigger_test_link_webhook_event: #{e}"
|
@@ -44,12 +41,12 @@ end
|
|
44
41
|
|
45
42
|
This returns an Array which contains the response data, status code and headers.
|
46
43
|
|
47
|
-
> <Array(<WebhookTestLinkResponse>, Integer, Hash)> trigger_test_link_webhook_event_with_http_info(id, webhook_test_link_request
|
44
|
+
> <Array(<WebhookTestLinkResponse>, Integer, Hash)> trigger_test_link_webhook_event_with_http_info(id, webhook_test_link_request)
|
48
45
|
|
49
46
|
```ruby
|
50
47
|
begin
|
51
48
|
# Trigger a test webhook event for a link (Sandbox only).
|
52
|
-
data, status_code, headers = api_instance.trigger_test_link_webhook_event_with_http_info(id, webhook_test_link_request
|
49
|
+
data, status_code, headers = api_instance.trigger_test_link_webhook_event_with_http_info(id, webhook_test_link_request)
|
53
50
|
p status_code # => 2xx
|
54
51
|
p headers # => { ... }
|
55
52
|
p data # => <WebhookTestLinkResponse>
|
@@ -64,7 +61,6 @@ end
|
|
64
61
|
| ---- | ---- | ----------- | ----- |
|
65
62
|
| **id** | **String** | The unique ID for this link. | |
|
66
63
|
| **webhook_test_link_request** | [**WebhookTestLinkRequest**](WebhookTestLinkRequest.md) | | |
|
67
|
-
| **moneykit_version** | **String** | | [optional][default to '2023-02-18'] |
|
68
64
|
|
69
65
|
### Return type
|
70
66
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document:
|
6
|
+
The version of the OpenAPI document: 2023-02-18
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 7.1.0
|
@@ -22,7 +22,6 @@ module MoneyKit
|
|
22
22
|
# /auth/token
|
23
23
|
# Create a new short-lived access token by validating your `client_id` and `client_secret`. The `access_token` is to be forwarded with all subsequent requests as `Authorization: Bearer {access_token}` HTTP header. When the token expires you must regenerate your `access_token`. The `client_id` and `client_secret` can be supplied as POST body parameters, or as a HTTP basic auth header.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
26
25
|
# @option opts [String] :grant_type Token grant type. Only `client_credentials` supported.
|
27
26
|
# @option opts [String] :scope 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. (default to '')
|
28
27
|
# @option opts [String] :client_id Your application's MoneyKit client ID.
|
@@ -36,7 +35,6 @@ module MoneyKit
|
|
36
35
|
# /auth/token
|
37
36
|
# Create a new short-lived access token by validating your `client_id` and `client_secret`. The `access_token` is to be forwarded with all subsequent requests as `Authorization: Bearer {access_token}` HTTP header. When the token expires you must regenerate your `access_token`. The `client_id` and `client_secret` can be supplied as POST body parameters, or as a HTTP basic auth header.
|
38
37
|
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
40
38
|
# @option opts [String] :grant_type Token grant type. Only `client_credentials` supported.
|
41
39
|
# @option opts [String] :scope 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. (default to '')
|
42
40
|
# @option opts [String] :client_id Your application's MoneyKit client ID.
|
@@ -66,7 +64,6 @@ module MoneyKit
|
|
66
64
|
if !content_type.nil?
|
67
65
|
header_params['Content-Type'] = content_type
|
68
66
|
end
|
69
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
70
67
|
|
71
68
|
# form parameters
|
72
69
|
form_params = opts[:form_params] || {}
|
@@ -104,7 +101,6 @@ module MoneyKit
|
|
104
101
|
# JSON Web Key Set
|
105
102
|
# The JSON Web Key Set (JWKS) is a set of keys containing the public keys used to verify webhook JSON Web Tokens (JWT) issued by MoneyKit webhooks.
|
106
103
|
# @param [Hash] opts the optional parameters
|
107
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
108
104
|
# @return [JWKSet]
|
109
105
|
def get_well_known_jwks(opts = {})
|
110
106
|
data, _status_code, _headers = get_well_known_jwks_with_http_info(opts)
|
@@ -114,7 +110,6 @@ module MoneyKit
|
|
114
110
|
# JSON Web Key Set
|
115
111
|
# The JSON Web Key Set (JWKS) is a set of keys containing the public keys used to verify webhook JSON Web Tokens (JWT) issued by MoneyKit webhooks.
|
116
112
|
# @param [Hash] opts the optional parameters
|
117
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
118
113
|
# @return [Array<(JWKSet, Integer, Hash)>] JWKSet data, response status code and response headers
|
119
114
|
def get_well_known_jwks_with_http_info(opts = {})
|
120
115
|
if @api_client.config.debugging
|
@@ -130,7 +125,6 @@ module MoneyKit
|
|
130
125
|
header_params = opts[:header_params] || {}
|
131
126
|
# HTTP header 'Accept' (if needed)
|
132
127
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
133
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
134
128
|
|
135
129
|
# form parameters
|
136
130
|
form_params = opts[:form_params] || {}
|
@@ -164,7 +158,6 @@ module MoneyKit
|
|
164
158
|
# /auth/introspect
|
165
159
|
# Get details about the client and application associated with your `access_token`.
|
166
160
|
# @param [Hash] opts the optional parameters
|
167
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
168
161
|
# @return [IntrospectClientResponse]
|
169
162
|
def instrospect_client(opts = {})
|
170
163
|
data, _status_code, _headers = instrospect_client_with_http_info(opts)
|
@@ -174,7 +167,6 @@ module MoneyKit
|
|
174
167
|
# /auth/introspect
|
175
168
|
# Get details about the client and application associated with your `access_token`.
|
176
169
|
# @param [Hash] opts the optional parameters
|
177
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
178
170
|
# @return [Array<(IntrospectClientResponse, Integer, Hash)>] IntrospectClientResponse data, response status code and response headers
|
179
171
|
def instrospect_client_with_http_info(opts = {})
|
180
172
|
if @api_client.config.debugging
|
@@ -190,7 +182,6 @@ module MoneyKit
|
|
190
182
|
header_params = opts[:header_params] || {}
|
191
183
|
# HTTP header 'Accept' (if needed)
|
192
184
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
193
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
194
185
|
|
195
186
|
# form parameters
|
196
187
|
form_params = opts[:form_params] || {}
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
5
|
|
6
|
-
The version of the OpenAPI document:
|
6
|
+
The version of the OpenAPI document: 2023-02-18
|
7
7
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 7.1.0
|
@@ -23,7 +23,6 @@ module MoneyKit
|
|
23
23
|
# Returns a list of open, permissioned accounts associated with a <a href=#tag/Links>link</a>, including full account and routing numbers for appropriate accounts (such as checking and savings accounts). <p>**Note** that this endpoint does **not** trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because `prefetch` was requested when the link was created, or because of an on-demand update. **To force a check for new/updated account numbers, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.
|
24
24
|
# @param id [String] The unique ID for this link.
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
27
26
|
# @return [GetAccountNumbersResponse]
|
28
27
|
def get_account_numbers(id, opts = {})
|
29
28
|
data, _status_code, _headers = get_account_numbers_with_http_info(id, opts)
|
@@ -34,7 +33,6 @@ module MoneyKit
|
|
34
33
|
# Returns a list of open, permissioned accounts associated with a <a href=#tag/Links>link</a>, including full account and routing numbers for appropriate accounts (such as checking and savings accounts). <p>**Note** that this endpoint does **not** trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because `prefetch` was requested when the link was created, or because of an on-demand update. **To force a check for new/updated account numbers, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.
|
35
34
|
# @param id [String] The unique ID for this link.
|
36
35
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
38
36
|
# @return [Array<(GetAccountNumbersResponse, Integer, Hash)>] GetAccountNumbersResponse data, response status code and response headers
|
39
37
|
def get_account_numbers_with_http_info(id, opts = {})
|
40
38
|
if @api_client.config.debugging
|
@@ -54,7 +52,6 @@ module MoneyKit
|
|
54
52
|
header_params = opts[:header_params] || {}
|
55
53
|
# HTTP header 'Accept' (if needed)
|
56
54
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
57
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
58
55
|
|
59
56
|
# form parameters
|
60
57
|
form_params = opts[:form_params] || {}
|