moneykit 0.1.2 → 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 +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
@@ -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
|
# Fetches details about a single institution.
|
24
24
|
# @param institution_id [String] The institution ID to fetch.
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
27
26
|
# @return [Institution]
|
28
27
|
def get_institution(institution_id, opts = {})
|
29
28
|
data, _status_code, _headers = get_institution_with_http_info(institution_id, opts)
|
@@ -34,7 +33,6 @@ module MoneyKit
|
|
34
33
|
# Fetches details about a single institution.
|
35
34
|
# @param institution_id [String] The institution ID to fetch.
|
36
35
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
38
36
|
# @return [Array<(Institution, Integer, Hash)>] Institution data, response status code and response headers
|
39
37
|
def get_institution_with_http_info(institution_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] || {}
|
@@ -92,7 +89,6 @@ module MoneyKit
|
|
92
89
|
# @option opts [Boolean] :featured If true, returns only featured institutions. (default to false)
|
93
90
|
# @option opts [String] :cursor Cursor to fetch the next set of institutions. (You get this value from the previous call to `/institutions`.)
|
94
91
|
# @option opts [Integer] :limit A limit on the number of institutions to be returned. (default to 50)
|
95
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
96
92
|
# @return [GetInstitutionsResponse]
|
97
93
|
def get_institutions(opts = {})
|
98
94
|
data, _status_code, _headers = get_institutions_with_http_info(opts)
|
@@ -106,7 +102,6 @@ module MoneyKit
|
|
106
102
|
# @option opts [Boolean] :featured If true, returns only featured institutions. (default to false)
|
107
103
|
# @option opts [String] :cursor Cursor to fetch the next set of institutions. (You get this value from the previous call to `/institutions`.)
|
108
104
|
# @option opts [Integer] :limit A limit on the number of institutions to be returned. (default to 50)
|
109
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
110
105
|
# @return [Array<(GetInstitutionsResponse, Integer, Hash)>] GetInstitutionsResponse data, response status code and response headers
|
111
106
|
def get_institutions_with_http_info(opts = {})
|
112
107
|
if @api_client.config.debugging
|
@@ -134,7 +129,6 @@ module MoneyKit
|
|
134
129
|
header_params = opts[:header_params] || {}
|
135
130
|
# HTTP header 'Accept' (if needed)
|
136
131
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
137
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
138
132
|
|
139
133
|
# form parameters
|
140
134
|
form_params = opts[:form_params] || {}
|
@@ -0,0 +1,178 @@
|
|
1
|
+
=begin
|
2
|
+
#MoneyKit API
|
3
|
+
|
4
|
+
#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2023-02-18
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 7.1.0
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module MoneyKit
|
16
|
+
class InvestmentsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# /links/{id}/investments/holdings
|
23
|
+
# Returns holdings for the investment accounts associated with a <a href=#tag/Links>link</a>. <p>**Note** that this endpoint does **not** trigger a fetch of holdings from the institution; it merely returns holdings that have already been fetched. **To force a check for new/updated owner information, 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
|
+
# @param id [String] The unique ID for this link.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [Array<String>] :account_ids An optional list of account IDs to filter the results.
|
27
|
+
# @return [GetHoldingsResponse]
|
28
|
+
def get_holdings(id, opts = {})
|
29
|
+
data, _status_code, _headers = get_holdings_with_http_info(id, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# /links/{id}/investments/holdings
|
34
|
+
# Returns holdings for the investment accounts associated with a <a href=#tag/Links>link</a>. <p>**Note** that this endpoint does **not** trigger a fetch of holdings from the institution; it merely returns holdings that have already been fetched. **To force a check for new/updated owner information, 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
|
+
# @param id [String] The unique ID for this link.
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @option opts [Array<String>] :account_ids An optional list of account IDs to filter the results.
|
38
|
+
# @return [Array<(GetHoldingsResponse, Integer, Hash)>] GetHoldingsResponse data, response status code and response headers
|
39
|
+
def get_holdings_with_http_info(id, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: InvestmentsApi.get_holdings ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'id' is set
|
44
|
+
if @api_client.config.client_side_validation && id.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling InvestmentsApi.get_holdings"
|
46
|
+
end
|
47
|
+
# resource path
|
48
|
+
local_var_path = '/links/{id}/investments/holdings'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
49
|
+
|
50
|
+
# query parameters
|
51
|
+
query_params = opts[:query_params] || {}
|
52
|
+
query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
|
53
|
+
|
54
|
+
# header parameters
|
55
|
+
header_params = opts[:header_params] || {}
|
56
|
+
# HTTP header 'Accept' (if needed)
|
57
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
58
|
+
|
59
|
+
# form parameters
|
60
|
+
form_params = opts[:form_params] || {}
|
61
|
+
|
62
|
+
# http body (model)
|
63
|
+
post_body = opts[:debug_body]
|
64
|
+
|
65
|
+
# return_type
|
66
|
+
return_type = opts[:debug_return_type] || 'GetHoldingsResponse'
|
67
|
+
|
68
|
+
# auth_names
|
69
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials']
|
70
|
+
|
71
|
+
new_options = opts.merge(
|
72
|
+
:operation => :"InvestmentsApi.get_holdings",
|
73
|
+
:header_params => header_params,
|
74
|
+
:query_params => query_params,
|
75
|
+
:form_params => form_params,
|
76
|
+
:body => post_body,
|
77
|
+
:auth_names => auth_names,
|
78
|
+
:return_type => return_type
|
79
|
+
)
|
80
|
+
|
81
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
82
|
+
if @api_client.config.debugging
|
83
|
+
@api_client.config.logger.debug "API called: InvestmentsApi#get_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
84
|
+
end
|
85
|
+
return data, status_code, headers
|
86
|
+
end
|
87
|
+
|
88
|
+
# /links/{id}/investments/transactions
|
89
|
+
# Returns investment 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. **To force a check for new/updated owner information, 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.
|
90
|
+
# @param id [String] The unique ID for this link.
|
91
|
+
# @param [Hash] opts the optional parameters
|
92
|
+
# @option opts [Array<String>] :account_ids An optional list of account IDs to filter the results.
|
93
|
+
# @option opts [Integer] :page The page number to return. (default to 1)
|
94
|
+
# @option opts [Integer] :size The number of items to return per page. (default to 50)
|
95
|
+
# @option opts [Date] :start_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`.
|
96
|
+
# @option opts [Date] :end_date The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
97
|
+
# @return [GetInvestmentTransactionsResponse]
|
98
|
+
def get_investment_transactions(id, opts = {})
|
99
|
+
data, _status_code, _headers = get_investment_transactions_with_http_info(id, opts)
|
100
|
+
data
|
101
|
+
end
|
102
|
+
|
103
|
+
# /links/{id}/investments/transactions
|
104
|
+
# Returns investment 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. **To force a check for new/updated owner information, 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.
|
105
|
+
# @param id [String] The unique ID for this link.
|
106
|
+
# @param [Hash] opts the optional parameters
|
107
|
+
# @option opts [Array<String>] :account_ids An optional list of account IDs to filter the results.
|
108
|
+
# @option opts [Integer] :page The page number to return. (default to 1)
|
109
|
+
# @option opts [Integer] :size The number of items to return per page. (default to 50)
|
110
|
+
# @option opts [Date] :start_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`.
|
111
|
+
# @option opts [Date] :end_date The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
112
|
+
# @return [Array<(GetInvestmentTransactionsResponse, Integer, Hash)>] GetInvestmentTransactionsResponse data, response status code and response headers
|
113
|
+
def get_investment_transactions_with_http_info(id, opts = {})
|
114
|
+
if @api_client.config.debugging
|
115
|
+
@api_client.config.logger.debug 'Calling API: InvestmentsApi.get_investment_transactions ...'
|
116
|
+
end
|
117
|
+
# verify the required parameter 'id' is set
|
118
|
+
if @api_client.config.client_side_validation && id.nil?
|
119
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling InvestmentsApi.get_investment_transactions"
|
120
|
+
end
|
121
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
122
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling InvestmentsApi.get_investment_transactions, must be greater than or equal to 1.'
|
123
|
+
end
|
124
|
+
|
125
|
+
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
|
126
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InvestmentsApi.get_investment_transactions, must be smaller than or equal to 100.'
|
127
|
+
end
|
128
|
+
|
129
|
+
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
|
130
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InvestmentsApi.get_investment_transactions, must be greater than or equal to 1.'
|
131
|
+
end
|
132
|
+
|
133
|
+
# resource path
|
134
|
+
local_var_path = '/links/{id}/investments/transactions'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
135
|
+
|
136
|
+
# query parameters
|
137
|
+
query_params = opts[:query_params] || {}
|
138
|
+
query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
|
139
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
140
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
141
|
+
query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
|
142
|
+
query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
|
143
|
+
|
144
|
+
# header parameters
|
145
|
+
header_params = opts[:header_params] || {}
|
146
|
+
# HTTP header 'Accept' (if needed)
|
147
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
148
|
+
|
149
|
+
# form parameters
|
150
|
+
form_params = opts[:form_params] || {}
|
151
|
+
|
152
|
+
# http body (model)
|
153
|
+
post_body = opts[:debug_body]
|
154
|
+
|
155
|
+
# return_type
|
156
|
+
return_type = opts[:debug_return_type] || 'GetInvestmentTransactionsResponse'
|
157
|
+
|
158
|
+
# auth_names
|
159
|
+
auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials']
|
160
|
+
|
161
|
+
new_options = opts.merge(
|
162
|
+
:operation => :"InvestmentsApi.get_investment_transactions",
|
163
|
+
:header_params => header_params,
|
164
|
+
:query_params => query_params,
|
165
|
+
:form_params => form_params,
|
166
|
+
:body => post_body,
|
167
|
+
:auth_names => auth_names,
|
168
|
+
:return_type => return_type
|
169
|
+
)
|
170
|
+
|
171
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
172
|
+
if @api_client.config.debugging
|
173
|
+
@api_client.config.logger.debug "API called: InvestmentsApi#get_investment_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
174
|
+
end
|
175
|
+
return data, status_code, headers
|
176
|
+
end
|
177
|
+
end
|
178
|
+
end
|
@@ -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
|
# This endpoint is to be called by your back end, to establish a new link session for creating a link to your end user's institution.
|
24
24
|
# @param create_link_session_request [CreateLinkSessionRequest]
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
27
26
|
# @return [CreateLinkSessionResponse]
|
28
27
|
def create_link_session(create_link_session_request, opts = {})
|
29
28
|
data, _status_code, _headers = create_link_session_with_http_info(create_link_session_request, opts)
|
@@ -34,7 +33,6 @@ module MoneyKit
|
|
34
33
|
# This endpoint is to be called by your back end, to establish a new link session for creating a link to your end user's institution.
|
35
34
|
# @param create_link_session_request [CreateLinkSessionRequest]
|
36
35
|
# @param [Hash] opts the optional parameters
|
37
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
38
36
|
# @return [Array<(CreateLinkSessionResponse, Integer, Hash)>] CreateLinkSessionResponse data, response status code and response headers
|
39
37
|
def create_link_session_with_http_info(create_link_session_request, opts = {})
|
40
38
|
if @api_client.config.debugging
|
@@ -59,7 +57,6 @@ module MoneyKit
|
|
59
57
|
if !content_type.nil?
|
60
58
|
header_params['Content-Type'] = content_type
|
61
59
|
end
|
62
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
63
60
|
|
64
61
|
# form parameters
|
65
62
|
form_params = opts[:form_params] || {}
|
@@ -94,7 +91,6 @@ module MoneyKit
|
|
94
91
|
# After the end user has successfully completed the linking process, your back end calls this endpoint to exchange the token received by your front end for a`link_id` that can be used to access the link's data.
|
95
92
|
# @param exchange_token_request [ExchangeTokenRequest]
|
96
93
|
# @param [Hash] opts the optional parameters
|
97
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
98
94
|
# @return [ExchangeTokenResponse]
|
99
95
|
def exchange_token(exchange_token_request, opts = {})
|
100
96
|
data, _status_code, _headers = exchange_token_with_http_info(exchange_token_request, opts)
|
@@ -105,7 +101,6 @@ module MoneyKit
|
|
105
101
|
# After the end user has successfully completed the linking process, your back end calls this endpoint to exchange the token received by your front end for a`link_id` that can be used to access the link's data.
|
106
102
|
# @param exchange_token_request [ExchangeTokenRequest]
|
107
103
|
# @param [Hash] opts the optional parameters
|
108
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
109
104
|
# @return [Array<(ExchangeTokenResponse, Integer, Hash)>] ExchangeTokenResponse data, response status code and response headers
|
110
105
|
def exchange_token_with_http_info(exchange_token_request, opts = {})
|
111
106
|
if @api_client.config.debugging
|
@@ -130,7 +125,6 @@ module MoneyKit
|
|
130
125
|
if !content_type.nil?
|
131
126
|
header_params['Content-Type'] = content_type
|
132
127
|
end
|
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] || {}
|
@@ -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
|
# Deletes this link and disables its access token. <p>After deletion, the link id and access token are no longer valid and cannot be used to access any data that was associated with it.
|
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 [nil]
|
28
27
|
def disconnect(id, opts = {})
|
29
28
|
disconnect_with_http_info(id, opts)
|
@@ -34,7 +33,6 @@ module MoneyKit
|
|
34
33
|
# Deletes this link and disables its access token. <p>After deletion, the link id and access token are no longer valid and cannot be used to access any data that was associated with it.
|
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<(nil, Integer, Hash)>] nil, response status code and response headers
|
39
37
|
def disconnect_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] || {}
|
@@ -89,7 +86,6 @@ module MoneyKit
|
|
89
86
|
# Fetches details about a link.
|
90
87
|
# @param id [String] The unique ID for this link.
|
91
88
|
# @param [Hash] opts the optional parameters
|
92
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
93
89
|
# @return [LinkResponse]
|
94
90
|
def get_link(id, opts = {})
|
95
91
|
data, _status_code, _headers = get_link_with_http_info(id, opts)
|
@@ -100,7 +96,6 @@ module MoneyKit
|
|
100
96
|
# Fetches details about a link.
|
101
97
|
# @param id [String] The unique ID for this link.
|
102
98
|
# @param [Hash] opts the optional parameters
|
103
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
104
99
|
# @return [Array<(LinkResponse, Integer, Hash)>] LinkResponse data, response status code and response headers
|
105
100
|
def get_link_with_http_info(id, opts = {})
|
106
101
|
if @api_client.config.debugging
|
@@ -120,7 +115,6 @@ module MoneyKit
|
|
120
115
|
header_params = opts[:header_params] || {}
|
121
116
|
# HTTP header 'Accept' (if needed)
|
122
117
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
123
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
124
118
|
|
125
119
|
# form parameters
|
126
120
|
form_params = opts[:form_params] || {}
|
@@ -155,7 +149,6 @@ module MoneyKit
|
|
155
149
|
# Fetches all links belonging to a <a href=#operation/get_user_accounts>user</a>.
|
156
150
|
# @param 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.
|
157
151
|
# @param [Hash] opts the optional parameters
|
158
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
159
152
|
# @return [GetUserLinksResponse]
|
160
153
|
def get_user_links(id, opts = {})
|
161
154
|
data, _status_code, _headers = get_user_links_with_http_info(id, opts)
|
@@ -166,7 +159,6 @@ module MoneyKit
|
|
166
159
|
# Fetches all links belonging to a <a href=#operation/get_user_accounts>user</a>.
|
167
160
|
# @param 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.
|
168
161
|
# @param [Hash] opts the optional parameters
|
169
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
170
162
|
# @return [Array<(GetUserLinksResponse, Integer, Hash)>] GetUserLinksResponse data, response status code and response headers
|
171
163
|
def get_user_links_with_http_info(id, opts = {})
|
172
164
|
if @api_client.config.debugging
|
@@ -186,7 +178,6 @@ module MoneyKit
|
|
186
178
|
header_params = opts[:header_params] || {}
|
187
179
|
# HTTP header 'Accept' (if needed)
|
188
180
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
189
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
190
181
|
|
191
182
|
# form parameters
|
192
183
|
form_params = opts[:form_params] || {}
|
@@ -220,7 +211,6 @@ module MoneyKit
|
|
220
211
|
# Force a \"relink required\" state on a link (Test only).
|
221
212
|
# @param id [String] The unique ID for this link.
|
222
213
|
# @param [Hash] opts the optional parameters
|
223
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
224
214
|
# @return [LinkResponse]
|
225
215
|
def reset_login(id, opts = {})
|
226
216
|
data, _status_code, _headers = reset_login_with_http_info(id, opts)
|
@@ -230,7 +220,6 @@ module MoneyKit
|
|
230
220
|
# Force a \"relink required\" state on a link (Test only).
|
231
221
|
# @param id [String] The unique ID for this link.
|
232
222
|
# @param [Hash] opts the optional parameters
|
233
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
234
223
|
# @return [Array<(LinkResponse, Integer, Hash)>] LinkResponse data, response status code and response headers
|
235
224
|
def reset_login_with_http_info(id, opts = {})
|
236
225
|
if @api_client.config.debugging
|
@@ -250,7 +239,6 @@ module MoneyKit
|
|
250
239
|
header_params = opts[:header_params] || {}
|
251
240
|
# HTTP header 'Accept' (if needed)
|
252
241
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
253
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
254
242
|
|
255
243
|
# form parameters
|
256
244
|
form_params = opts[:form_params] || {}
|
@@ -286,7 +274,6 @@ module MoneyKit
|
|
286
274
|
# @param id [String] The unique ID for this link.
|
287
275
|
# @param update_link_request [UpdateLinkRequest]
|
288
276
|
# @param [Hash] opts the optional parameters
|
289
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
290
277
|
# @return [LinkResponse]
|
291
278
|
def update_link(id, update_link_request, opts = {})
|
292
279
|
data, _status_code, _headers = update_link_with_http_info(id, update_link_request, opts)
|
@@ -298,7 +285,6 @@ module MoneyKit
|
|
298
285
|
# @param id [String] The unique ID for this link.
|
299
286
|
# @param update_link_request [UpdateLinkRequest]
|
300
287
|
# @param [Hash] opts the optional parameters
|
301
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
302
288
|
# @return [Array<(LinkResponse, Integer, Hash)>] LinkResponse data, response status code and response headers
|
303
289
|
def update_link_with_http_info(id, update_link_request, opts = {})
|
304
290
|
if @api_client.config.debugging
|
@@ -327,7 +313,6 @@ module MoneyKit
|
|
327
313
|
if !content_type.nil?
|
328
314
|
header_params['Content-Type'] = content_type
|
329
315
|
end
|
330
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
331
316
|
|
332
317
|
# form parameters
|
333
318
|
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
|
@@ -24,7 +24,6 @@ module MoneyKit
|
|
24
24
|
# @param id [String] The unique ID for this link.
|
25
25
|
# @param refresh_products_request [RefreshProductsRequest]
|
26
26
|
# @param [Hash] opts the optional parameters
|
27
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
28
27
|
# @return [nil]
|
29
28
|
def refresh_products(id, refresh_products_request, opts = {})
|
30
29
|
refresh_products_with_http_info(id, refresh_products_request, opts)
|
@@ -36,7 +35,6 @@ module MoneyKit
|
|
36
35
|
# @param id [String] The unique ID for this link.
|
37
36
|
# @param refresh_products_request [RefreshProductsRequest]
|
38
37
|
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
40
38
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
41
39
|
def refresh_products_with_http_info(id, refresh_products_request, opts = {})
|
42
40
|
if @api_client.config.debugging
|
@@ -65,7 +63,6 @@ module MoneyKit
|
|
65
63
|
if !content_type.nil?
|
66
64
|
header_params['Content-Type'] = content_type
|
67
65
|
end
|
68
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
69
66
|
|
70
67
|
# form parameters
|
71
68
|
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
|
@@ -20,7 +20,7 @@ module MoneyKit
|
|
20
20
|
@api_client = api_client
|
21
21
|
end
|
22
22
|
# /links/{id}/transactions
|
23
|
-
# Returns transactions for the accounts associated with a <a href=#tag/Links>link</a>. Results are
|
23
|
+
# 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.
|
24
24
|
# @param id [String] The unique ID for this link.
|
25
25
|
# @param [Hash] opts the optional parameters
|
26
26
|
# @option opts [Array<String>] :account_ids An optional list of account IDs to filter the results.
|
@@ -28,7 +28,6 @@ module MoneyKit
|
|
28
28
|
# @option opts [Integer] :size The number of items to return per page. (default to 50)
|
29
29
|
# @option opts [Date] :start_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`.
|
30
30
|
# @option opts [Date] :end_date The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
31
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
32
31
|
# @return [GetTransactionsResponse]
|
33
32
|
def get_transactions(id, opts = {})
|
34
33
|
data, _status_code, _headers = get_transactions_with_http_info(id, opts)
|
@@ -36,7 +35,7 @@ module MoneyKit
|
|
36
35
|
end
|
37
36
|
|
38
37
|
# /links/{id}/transactions
|
39
|
-
# Returns transactions for the accounts associated with a <a href=#tag/Links>link</a>. Results are
|
38
|
+
# 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.
|
40
39
|
# @param id [String] The unique ID for this link.
|
41
40
|
# @param [Hash] opts the optional parameters
|
42
41
|
# @option opts [Array<String>] :account_ids An optional list of account IDs to filter the results.
|
@@ -44,7 +43,6 @@ module MoneyKit
|
|
44
43
|
# @option opts [Integer] :size The number of items to return per page. (default to 50)
|
45
44
|
# @option opts [Date] :start_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`.
|
46
45
|
# @option opts [Date] :end_date The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
47
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
48
46
|
# @return [Array<(GetTransactionsResponse, Integer, Hash)>] GetTransactionsResponse data, response status code and response headers
|
49
47
|
def get_transactions_with_http_info(id, opts = {})
|
50
48
|
if @api_client.config.debugging
|
@@ -81,7 +79,6 @@ module MoneyKit
|
|
81
79
|
header_params = opts[:header_params] || {}
|
82
80
|
# HTTP header 'Accept' (if needed)
|
83
81
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
84
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
85
82
|
|
86
83
|
# form parameters
|
87
84
|
form_params = opts[:form_params] || {}
|
@@ -113,12 +110,11 @@ module MoneyKit
|
|
113
110
|
end
|
114
111
|
|
115
112
|
# /links/{id}/transactions/sync
|
116
|
-
# Provides a paginated feed of transactions, grouped into `created`, `updated`, and `removed` lists. <p>Each call will also return a `
|
113
|
+
# 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.
|
117
114
|
# @param id [String] The unique ID for this link.
|
118
115
|
# @param [Hash] opts the optional parameters
|
119
116
|
# @option opts [String] :cursor 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.
|
120
117
|
# @option opts [Integer] :size The number of items to return. (default to 50)
|
121
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
122
118
|
# @return [TransactionSyncResponse]
|
123
119
|
def get_transactions_diff(id, opts = {})
|
124
120
|
data, _status_code, _headers = get_transactions_diff_with_http_info(id, opts)
|
@@ -126,12 +122,11 @@ module MoneyKit
|
|
126
122
|
end
|
127
123
|
|
128
124
|
# /links/{id}/transactions/sync
|
129
|
-
# Provides a paginated feed of transactions, grouped into `created`, `updated`, and `removed` lists. <p>Each call will also return a `
|
125
|
+
# 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.
|
130
126
|
# @param id [String] The unique ID for this link.
|
131
127
|
# @param [Hash] opts the optional parameters
|
132
128
|
# @option opts [String] :cursor 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.
|
133
129
|
# @option opts [Integer] :size The number of items to return. (default to 50)
|
134
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
135
130
|
# @return [Array<(TransactionSyncResponse, Integer, Hash)>] TransactionSyncResponse data, response status code and response headers
|
136
131
|
def get_transactions_diff_with_http_info(id, opts = {})
|
137
132
|
if @api_client.config.debugging
|
@@ -161,7 +156,6 @@ module MoneyKit
|
|
161
156
|
header_params = opts[:header_params] || {}
|
162
157
|
# HTTP header 'Accept' (if needed)
|
163
158
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
164
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
165
159
|
|
166
160
|
# form parameters
|
167
161
|
form_params = opts[:form_params] || {}
|
@@ -204,7 +198,6 @@ module MoneyKit
|
|
204
198
|
# @option opts [Integer] :size The number of items to return per page. (default to 50)
|
205
199
|
# @option opts [Date] :start_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`.
|
206
200
|
# @option opts [Date] :end_date The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
207
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
208
201
|
# @return [GetUserTransactionsResponse]
|
209
202
|
def get_user_transactions(id, opts = {})
|
210
203
|
data, _status_code, _headers = get_user_transactions_with_http_info(id, opts)
|
@@ -223,7 +216,6 @@ module MoneyKit
|
|
223
216
|
# @option opts [Integer] :size The number of items to return per page. (default to 50)
|
224
217
|
# @option opts [Date] :start_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`.
|
225
218
|
# @option opts [Date] :end_date The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
|
226
|
-
# @option opts [String] :moneykit_version (default to '2023-02-18')
|
227
219
|
# @return [Array<(GetUserTransactionsResponse, Integer, Hash)>] GetUserTransactionsResponse data, response status code and response headers
|
228
220
|
def get_user_transactions_with_http_info(id, opts = {})
|
229
221
|
if @api_client.config.debugging
|
@@ -263,7 +255,6 @@ module MoneyKit
|
|
263
255
|
header_params = opts[:header_params] || {}
|
264
256
|
# HTTP header 'Accept' (if needed)
|
265
257
|
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
266
|
-
header_params[:'moneykit-version'] = opts[:'moneykit_version'] if !opts[:'moneykit_version'].nil?
|
267
258
|
|
268
259
|
# form parameters
|
269
260
|
form_params = opts[:form_params] || {}
|