moneykit 0.1.13 → 0.1.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +1 -1
- data/docs/AccessTokenApi.md +14 -17
- data/docs/AccountIdentity.md +4 -0
- data/docs/AccountResponse.md +5 -1
- data/docs/AccountWithAccountNumbersLegacy20230218.md +4 -0
- data/docs/AccountsApi.md +2 -2
- data/docs/Address.md +1 -1
- data/docs/CreateAccessTokenResponse.md +1 -1
- data/docs/CustomerUserPhone.md +1 -1
- data/docs/Email.md +1 -1
- data/docs/ExchangeTokenResponse.md +1 -1
- data/docs/IdentityApi.md +1 -1
- data/docs/ImportLinkRequest.md +2 -2
- data/docs/InvestmentsApi.md +4 -4
- data/docs/LinkCommon.md +4 -0
- data/docs/LinksApi.md +20 -20
- data/docs/MoneyKitConnectFeatures.md +3 -1
- data/docs/PhoneNumber.md +3 -3
- data/docs/TransactionSyncResponse.md +2 -0
- data/docs/TransactionsApi.md +11 -11
- data/docs/UpdateLinkRequest.md +2 -0
- data/docs/UsersApi.md +10 -10
- data/lib/moneykit/api/access_token_api.rb +12 -9
- data/lib/moneykit/api/accounts_api.rb +2 -2
- data/lib/moneykit/api/identity_api.rb +2 -2
- data/lib/moneykit/api/investments_api.rb +4 -4
- data/lib/moneykit/api/links_api.rb +16 -16
- data/lib/moneykit/api/transactions_api.rb +12 -12
- data/lib/moneykit/api/users_api.rb +10 -10
- data/lib/moneykit/api_client.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 +22 -2
- data/lib/moneykit/models/account_import_data.rb +1 -1
- data/lib/moneykit/models/account_numbers.rb +1 -1
- data/lib/moneykit/models/account_numbers_legacy20230218.rb +1 -1
- data/lib/moneykit/models/account_numbers_link_product.rb +1 -1
- data/lib/moneykit/models/account_numbers_product_settings.rb +1 -1
- data/lib/moneykit/models/account_response.rb +25 -5
- data/lib/moneykit/models/account_with_account_numbers.rb +1 -1
- data/lib/moneykit/models/account_with_account_numbers_legacy20230218.rb +22 -2
- data/lib/moneykit/models/accounts_link_product.rb +1 -1
- data/lib/moneykit/models/ach_number.rb +1 -1
- data/lib/moneykit/models/address.rb +2 -2
- 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/app_client_response.rb +1 -1
- data/lib/moneykit/models/app_link_state_changed_webhook.rb +1 -1
- data/lib/moneykit/models/app_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/create_access_token_response.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/cursor_pagination.rb +1 -1
- data/lib/moneykit/models/customer_app.rb +1 -1
- data/lib/moneykit/models/customer_user.rb +1 -1
- data/lib/moneykit/models/customer_user_email.rb +1 -1
- data/lib/moneykit/models/customer_user_phone.rb +1 -1
- data/lib/moneykit/models/date.rb +1 -1
- data/lib/moneykit/models/eft_number.rb +1 -1
- data/lib/moneykit/models/email.rb +2 -2
- data/lib/moneykit/models/exchange_token_request.rb +1 -1
- data/lib/moneykit/models/exchange_token_response.rb +2 -2
- 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_numbers_response_legacy20230218.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 +1 -1
- data/lib/moneykit/models/get_institutions_response.rb +1 -1
- data/lib/moneykit/models/get_investment_transactions_response.rb +1 -1
- 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 +1 -1
- data/lib/moneykit/models/http_validation_error.rb +1 -1
- data/lib/moneykit/models/identity_link_product.rb +1 -1
- data/lib/moneykit/models/identity_product_settings.rb +1 -1
- data/lib/moneykit/models/identity_response.rb +1 -1
- data/lib/moneykit/models/import_link_request.rb +2 -2
- 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 +1 -1
- data/lib/moneykit/models/investments_link_product.rb +1 -1
- data/lib/moneykit/models/investments_product_settings.rb +1 -1
- data/lib/moneykit/models/jwk_set.rb +1 -1
- data/lib/moneykit/models/link_common.rb +28 -2
- 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_permissions.rb +1 -1
- data/lib/moneykit/models/link_product.rb +1 -1
- data/lib/moneykit/models/link_product_error.rb +2 -1
- data/lib/moneykit/models/link_product_refresh_webhook.rb +1 -1
- data/lib/moneykit/models/link_product_response.rb +1 -1
- data/lib/moneykit/models/link_products.rb +1 -1
- 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_changed_webhook.rb +1 -1
- data/lib/moneykit/models/money_kit_connect_features.rb +17 -5
- data/lib/moneykit/models/owner.rb +1 -1
- data/lib/moneykit/models/phone_number.rb +3 -3
- data/lib/moneykit/models/product_settings.rb +1 -1
- data/lib/moneykit/models/products_settings.rb +1 -1
- data/lib/moneykit/models/public_link_error.rb +6 -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_delete_link_links_id_delete.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.rb +1 -1
- data/lib/moneykit/models/response401_get_account_numbers_legacy20230218_links_id_accounts_numbers_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 +1 -1
- 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 +1 -1
- data/lib/moneykit/models/response401_get_link_links_id_get.rb +1 -1
- data/lib/moneykit/models/response401_get_transactions.rb +1 -1
- data/lib/moneykit/models/response401_get_transactions_diff_links_id_transactions_sync_get.rb +1 -1
- data/lib/moneykit/models/response401_get_transactions_sync_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 +1 -1
- data/lib/moneykit/models/response401_get_well_known_jwks_well_known_jwks_json_get.rb +1 -1
- data/lib/moneykit/models/response401_import_link_links_import_post.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 +1 -1
- data/lib/moneykit/models/transaction.rb +1 -1
- data/lib/moneykit/models/transaction_category_response.rb +1 -1
- data/lib/moneykit/models/transaction_diff.rb +1 -1
- data/lib/moneykit/models/transaction_enrichment_response.rb +1 -1
- data/lib/moneykit/models/transaction_import_data.rb +1 -1
- data/lib/moneykit/models/transaction_merchant_response.rb +1 -1
- data/lib/moneykit/models/transaction_processor_response.rb +1 -1
- data/lib/moneykit/models/transaction_recurrence_response.rb +1 -1
- data/lib/moneykit/models/transaction_response.rb +1 -1
- data/lib/moneykit/models/transaction_subcategory_response.rb +1 -1
- data/lib/moneykit/models/transaction_sync.rb +1 -1
- data/lib/moneykit/models/transaction_sync_response.rb +20 -2
- data/lib/moneykit/models/transaction_updates_available_webhook.rb +1 -1
- data/lib/moneykit/models/transactions_link_product.rb +1 -1
- data/lib/moneykit/models/transactions_product_settings.rb +1 -1
- data/lib/moneykit/models/update_link_request.rb +13 -2
- 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_test_link_request.rb +1 -1
- data/lib/moneykit/models/webhook_test_link_response.rb +1 -1
- data/lib/moneykit/version.rb +1 -1
- data/lib/moneykit.rb +0 -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 +144 -144
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: aa4e20b64bf5154d4b87bfc2813945aeb7ee93bff7654a7addc3c14f2f311809
|
4
|
+
data.tar.gz: 95627b9f129712be30c4c09ccc70e6b71d6c02611cafdd2413cc8e98ab135fd8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 79f9e5487b2593718dde16ce6c1c76ed6235a29f640ee549f0e499f90820a663cc142a67ee7182d678ea57dcd4094fcde9c8d162cbeead3e97b916fe8b09fca9
|
7
|
+
data.tar.gz: 5e8a31d79d4b7f284b2a6d2afaa68bc6f2626ec9ada06977666415b5018877a6be728f04ef76e77e9a00ee97a0cf5115a3a84f4e32e660f8d9d75c4cd02b7260
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
data/docs/AccessTokenApi.md
CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**create_access_token**](AccessTokenApi.md#create_access_token) | **POST** /auth/token | /auth/token |
|
8
|
-
| [**
|
8
|
+
| [**get_well_known_jwks**](AccessTokenApi.md#get_well_known_jwks) | **GET** /.well-known/jwks.json | JSON Web Key Set |
|
9
9
|
| [**instrospect_client**](AccessTokenApi.md#instrospect_client) | **GET** /auth/introspect | /auth/introspect |
|
10
10
|
|
11
11
|
|
@@ -87,54 +87,50 @@ end
|
|
87
87
|
- **Accept**: application/json
|
88
88
|
|
89
89
|
|
90
|
-
##
|
90
|
+
## get_well_known_jwks
|
91
91
|
|
92
|
-
> <JWKSet>
|
92
|
+
> <JWKSet> get_well_known_jwks(opts)
|
93
93
|
|
94
94
|
JSON Web Key Set
|
95
95
|
|
96
|
-
The JSON Web Key Set (JWKS) is a set of keys containing the public keys used to verify webhook
|
96
|
+
The JSON Web Key Set (JWKS) is a set of keys containing the public keys used to verify JWTs in webhooks sent by MoneyKit. The JWKS should be cached, but MoneyKit rotates its webhook keys periodically, so if an incoming webhook's JWT has a key ID (`kid`) not contained in the cached JWKS, you should fetch and cache the updated JWKS using this endpoint.
|
97
97
|
|
98
98
|
### Examples
|
99
99
|
|
100
100
|
```ruby
|
101
101
|
require 'time'
|
102
102
|
require 'moneykit'
|
103
|
-
# setup authorization
|
104
|
-
MoneyKit.configure do |config|
|
105
|
-
# Configure OAuth2 access token for authorization: OAuth2ClientCredentials
|
106
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
107
|
-
end
|
108
103
|
|
109
104
|
api_instance = MoneyKit::AccessTokenApi.new
|
110
105
|
opts = {
|
111
|
-
x_client_id: 'x_client_id_example' # String | Your client ID.
|
106
|
+
x_client_id: 'x_client_id_example', # String | Your client ID.
|
107
|
+
authorization: 'authorization_example' # String | (Deprecated) An access token obtained from <a href=#operation/create_access_token>/auth/token</a>. This method works but is deprecated in favor of using `X-Client-Id`.
|
112
108
|
}
|
113
109
|
|
114
110
|
begin
|
115
111
|
# JSON Web Key Set
|
116
|
-
result = api_instance.
|
112
|
+
result = api_instance.get_well_known_jwks(opts)
|
117
113
|
p result
|
118
114
|
rescue MoneyKit::ApiError => e
|
119
|
-
puts "Error when calling AccessTokenApi->
|
115
|
+
puts "Error when calling AccessTokenApi->get_well_known_jwks: #{e}"
|
120
116
|
end
|
121
117
|
```
|
122
118
|
|
123
|
-
#### Using the
|
119
|
+
#### Using the get_well_known_jwks_with_http_info variant
|
124
120
|
|
125
121
|
This returns an Array which contains the response data, status code and headers.
|
126
122
|
|
127
|
-
> <Array(<JWKSet>, Integer, Hash)>
|
123
|
+
> <Array(<JWKSet>, Integer, Hash)> get_well_known_jwks_with_http_info(opts)
|
128
124
|
|
129
125
|
```ruby
|
130
126
|
begin
|
131
127
|
# JSON Web Key Set
|
132
|
-
data, status_code, headers = api_instance.
|
128
|
+
data, status_code, headers = api_instance.get_well_known_jwks_with_http_info(opts)
|
133
129
|
p status_code # => 2xx
|
134
130
|
p headers # => { ... }
|
135
131
|
p data # => <JWKSet>
|
136
132
|
rescue MoneyKit::ApiError => e
|
137
|
-
puts "Error when calling AccessTokenApi->
|
133
|
+
puts "Error when calling AccessTokenApi->get_well_known_jwks_with_http_info: #{e}"
|
138
134
|
end
|
139
135
|
```
|
140
136
|
|
@@ -143,6 +139,7 @@ end
|
|
143
139
|
| Name | Type | Description | Notes |
|
144
140
|
| ---- | ---- | ----------- | ----- |
|
145
141
|
| **x_client_id** | **String** | Your client ID. | [optional] |
|
142
|
+
| **authorization** | **String** | (Deprecated) An access token obtained from <a href=#operation/create_access_token>/auth/token</a>. This method works but is deprecated in favor of using `X-Client-Id`. | [optional] |
|
146
143
|
|
147
144
|
### Return type
|
148
145
|
|
@@ -150,7 +147,7 @@ end
|
|
150
147
|
|
151
148
|
### Authorization
|
152
149
|
|
153
|
-
|
150
|
+
No authorization required
|
154
151
|
|
155
152
|
### HTTP request headers
|
156
153
|
|
data/docs/AccountIdentity.md
CHANGED
@@ -9,7 +9,9 @@
|
|
9
9
|
| **name** | **String** | The account name, according to the institution. Note that some institutions allow the end user to nickname the account; in such cases this field may be the name assigned by the user. | |
|
10
10
|
| **account_mask** | **String** | The last four characters (usually digits) of the account number. Note that this mask may be non-unique between accounts. | [optional] |
|
11
11
|
| **balances** | [**AccountBalances**](AccountBalances.md) | | |
|
12
|
+
| **raw_provider_data** | **Object** | Raw account data from the provider. | [optional] |
|
12
13
|
| **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
|
14
|
+
| **closed** | **Boolean** | True if this account is closed. | [optional] |
|
13
15
|
| **owners** | [**Array<Owner>**](Owner.md) | | |
|
14
16
|
|
15
17
|
## Example
|
@@ -23,7 +25,9 @@ instance = MoneyKit::AccountIdentity.new(
|
|
23
25
|
name: Premier Checking,
|
24
26
|
account_mask: 3748,
|
25
27
|
balances: null,
|
28
|
+
raw_provider_data: null,
|
26
29
|
original_id: null,
|
30
|
+
closed: null,
|
27
31
|
owners: null
|
28
32
|
)
|
29
33
|
```
|
data/docs/AccountResponse.md
CHANGED
@@ -9,7 +9,9 @@
|
|
9
9
|
| **name** | **String** | The account name, according to the institution. Note that some institutions allow the end user to nickname the account; in such cases this field may be the name assigned by the user. | |
|
10
10
|
| **account_mask** | **String** | The last four characters (usually digits) of the account number. Note that this mask may be non-unique between accounts. | [optional] |
|
11
11
|
| **balances** | [**AccountBalances**](AccountBalances.md) | | |
|
12
|
+
| **raw_provider_data** | **Object** | Raw account data from the provider. | [optional] |
|
12
13
|
| **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
|
14
|
+
| **closed** | **Boolean** | True if this account is closed. | [optional] |
|
13
15
|
|
14
16
|
## Example
|
15
17
|
|
@@ -22,7 +24,9 @@ instance = MoneyKit::AccountResponse.new(
|
|
22
24
|
name: Premier Checking,
|
23
25
|
account_mask: 3748,
|
24
26
|
balances: null,
|
25
|
-
|
27
|
+
raw_provider_data: null,
|
28
|
+
original_id: null,
|
29
|
+
closed: null
|
26
30
|
)
|
27
31
|
```
|
28
32
|
|
@@ -9,7 +9,9 @@
|
|
9
9
|
| **name** | **String** | The account name, according to the institution. Note that some institutions allow the end user to nickname the account; in such cases this field may be the name assigned by the user. | |
|
10
10
|
| **account_mask** | **String** | The last four characters (usually digits) of the account number. Note that this mask may be non-unique between accounts. | [optional] |
|
11
11
|
| **balances** | [**AccountBalances**](AccountBalances.md) | | |
|
12
|
+
| **raw_provider_data** | **Object** | Raw account data from the provider. | [optional] |
|
12
13
|
| **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
|
14
|
+
| **closed** | **Boolean** | True if this account is closed. | [optional] |
|
13
15
|
| **numbers** | [**AccountNumbersLegacy20230218**](AccountNumbersLegacy20230218.md) | | |
|
14
16
|
|
15
17
|
## Example
|
@@ -23,7 +25,9 @@ instance = MoneyKit::AccountWithAccountNumbersLegacy20230218.new(
|
|
23
25
|
name: Premier Checking,
|
24
26
|
account_mask: 3748,
|
25
27
|
balances: null,
|
28
|
+
raw_provider_data: null,
|
26
29
|
original_id: null,
|
30
|
+
closed: null,
|
27
31
|
numbers: null
|
28
32
|
)
|
29
33
|
```
|
data/docs/AccountsApi.md
CHANGED
@@ -243,7 +243,7 @@ MoneyKit.configure do |config|
|
|
243
243
|
end
|
244
244
|
|
245
245
|
api_instance = MoneyKit::AccountsApi.new
|
246
|
-
id = 'id_example' # String | The unique ID for this user. This is the same ID provided in the call to <a href
|
246
|
+
id = 'id_example' # String | The unique ID for this user. This is the same ID provided in the call to <a href=/api/operation/create_link_session#customer_user-id>link-session</a> to create any link for this user.
|
247
247
|
opts = {
|
248
248
|
account_ids: ['inner_example'], # Array<String> | If present, filters results to accounts matching the given IDs.
|
249
249
|
institution_ids: ['inner_example'] # Array<String> | If present, filters results to accounts at institutions matching the given IDs.
|
@@ -280,7 +280,7 @@ end
|
|
280
280
|
|
281
281
|
| Name | Type | Description | Notes |
|
282
282
|
| ---- | ---- | ----------- | ----- |
|
283
|
-
| **id** | **String** | The unique ID for this user. This is the same ID provided in the call to <a href=
|
283
|
+
| **id** | **String** | The unique ID for this user. This is the same ID provided in the call to <a href=/api/operation/create_link_session#customer_user-id>link-session</a> to create any link for this user. | |
|
284
284
|
| **account_ids** | [**Array<String>**](String.md) | If present, filters results to accounts matching the given IDs. | [optional] |
|
285
285
|
| **institution_ids** | [**Array<String>**](String.md) | If present, filters results to accounts at institutions matching the given IDs. | [optional] |
|
286
286
|
|
data/docs/Address.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
| **postal_code** | **String** | The postal or zip code of the address. | [optional] |
|
10
10
|
| **region** | **String** | The region or state of the address. | [optional] |
|
11
11
|
| **street** | **String** | The street of the address. | [optional] |
|
12
|
-
| **primary** | **Boolean** | Indicates if this is the primary address for the account owner. | [optional] |
|
12
|
+
| **primary** | **Boolean** | Indicates if this is the primary address for the account owner, as reported by the institution. | [optional] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
data/docs/CustomerUserPhone.md
CHANGED
data/docs/Email.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **address** | **String** | An email address for the account owner. | |
|
8
|
-
| **primary** | **Boolean** | Indicates if this is the primary email address for the account owner. | [optional] |
|
8
|
+
| **primary** | **Boolean** | Indicates if this is the primary email address for the account owner, as reported by the institution. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **link_id** | **String** |
|
7
|
+
| **link_id** | **String** | DEPRECATED: Please use `link.link_id` for this value | |
|
8
8
|
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
9
9
|
|
10
10
|
## Example
|
data/docs/IdentityApi.md
CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
13
13
|
|
14
14
|
/links/{id}/identity
|
15
15
|
|
16
|
-
Returns account owner information from the institution, including names, emails, phone numbers, and addresses, for all permissioned accounts associated with a <a href=#tag/Links>link</a>. <p>Some fields may be empty, if not provided by the institution. <p>**Note** that this endpoint does **not** trigger a fetch of owner information from the institution; it merely returns owner information that has 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 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.
|
16
|
+
Returns account owner information from the institution, including names, emails, phone numbers, and addresses, for all permissioned accounts associated with a <a href=#tag/Links>link</a>. This information will appear in the `owners` list in the `accounts` object. <p>Some fields may be empty, if not provided by the institution. <p>**Note** that this endpoint does **not** trigger a fetch of owner information from the institution; it merely returns owner information that has 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 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.
|
17
17
|
|
18
18
|
### Examples
|
19
19
|
|
data/docs/ImportLinkRequest.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **customer_user** | [**CustomerUser**](CustomerUser.md) | | |
|
8
8
|
| **provider** | [**Provider**](Provider.md) | | [optional] |
|
9
|
-
| **institution_id** | **String** | MoneyKit's unique ID for this institution. If the imported link is
|
9
|
+
| **institution_id** | **String** | MoneyKit's unique ID for this institution. If you use a MoneyKit-supported provider, you can also submit the provider name and __their__ institution_id in dotted notation, such as `mx.chase` or `yodlee.30188`. If the imported link is synced with a data provider later, it will be connected to this institution. Note that MoneyKit may reconnect the link using any supported provider, not just the one given during this import. | |
|
10
10
|
| **accounts** | [**Array<AccountImportData>**](AccountImportData.md) | | |
|
11
11
|
| **transactions** | [**Array<TransactionImportData>**](TransactionImportData.md) | | |
|
12
12
|
|
@@ -18,7 +18,7 @@ require 'moneykit'
|
|
18
18
|
instance = MoneyKit::ImportLinkRequest.new(
|
19
19
|
customer_user: null,
|
20
20
|
provider: null,
|
21
|
-
institution_id:
|
21
|
+
institution_id: null,
|
22
22
|
accounts: null,
|
23
23
|
transactions: null
|
24
24
|
)
|
data/docs/InvestmentsApi.md
CHANGED
@@ -106,8 +106,8 @@ opts = {
|
|
106
106
|
account_ids: ['inner_example'], # Array<String> | An optional list of account IDs to filter the results.
|
107
107
|
page: 56, # Integer | The page number to return.
|
108
108
|
size: 56, # Integer | The number of items to return per page.
|
109
|
-
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
110
|
-
end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
109
|
+
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
110
|
+
end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
111
111
|
}
|
112
112
|
|
113
113
|
begin
|
@@ -145,8 +145,8 @@ end
|
|
145
145
|
| **account_ids** | [**Array<String>**](String.md) | An optional list of account IDs to filter the results. | [optional] |
|
146
146
|
| **page** | **Integer** | The page number to return. | [optional][default to 1] |
|
147
147
|
| **size** | **Integer** | The number of items to return per page. | [optional][default to 50] |
|
148
|
-
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
149
|
-
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
148
|
+
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD. | [optional] |
|
149
|
+
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD. | [optional] |
|
150
150
|
|
151
151
|
### Return type
|
152
152
|
|
data/docs/LinkCommon.md
CHANGED
@@ -11,7 +11,9 @@
|
|
11
11
|
| **state** | [**PublicLinkState**](PublicLinkState.md) | | |
|
12
12
|
| **error_code** | [**PublicLinkError**](PublicLinkError.md) | | [optional] |
|
13
13
|
| **last_synced_at** | **Time** | (Deprecated) An ISO-8601 timestamp indicating the last time that the link was updated. | [optional] |
|
14
|
+
| **provider** | [**Provider**](Provider.md) | | |
|
14
15
|
| **tags** | **Array<String>** | | [optional] |
|
16
|
+
| **webhook** | **String** | The webhook url assigned to this link. | [optional] |
|
15
17
|
| **products** | [**LinkProducts**](LinkProducts.md) | | |
|
16
18
|
| **available_products** | [**Array<Product>**](Product.md) | | |
|
17
19
|
|
@@ -28,7 +30,9 @@ instance = MoneyKit::LinkCommon.new(
|
|
28
30
|
state: null,
|
29
31
|
error_code: null,
|
30
32
|
last_synced_at: 2023-02-16T09:14:11,
|
33
|
+
provider: null,
|
31
34
|
tags: null,
|
35
|
+
webhook: https://example.com/webhook,
|
32
36
|
products: null,
|
33
37
|
available_products: null
|
34
38
|
)
|
data/docs/LinksApi.md
CHANGED
@@ -82,7 +82,7 @@ nil (empty response body)
|
|
82
82
|
|
83
83
|
## get_link
|
84
84
|
|
85
|
-
> <
|
85
|
+
> <LinkCommon> get_link(id)
|
86
86
|
|
87
87
|
/links/{id}
|
88
88
|
|
@@ -115,7 +115,7 @@ end
|
|
115
115
|
|
116
116
|
This returns an Array which contains the response data, status code and headers.
|
117
117
|
|
118
|
-
> <Array(<
|
118
|
+
> <Array(<LinkCommon>, Integer, Hash)> get_link_with_http_info(id)
|
119
119
|
|
120
120
|
```ruby
|
121
121
|
begin
|
@@ -123,7 +123,7 @@ begin
|
|
123
123
|
data, status_code, headers = api_instance.get_link_with_http_info(id)
|
124
124
|
p status_code # => 2xx
|
125
125
|
p headers # => { ... }
|
126
|
-
p data # => <
|
126
|
+
p data # => <LinkCommon>
|
127
127
|
rescue MoneyKit::ApiError => e
|
128
128
|
puts "Error when calling LinksApi->get_link_with_http_info: #{e}"
|
129
129
|
end
|
@@ -137,7 +137,7 @@ end
|
|
137
137
|
|
138
138
|
### Return type
|
139
139
|
|
140
|
-
[**
|
140
|
+
[**LinkCommon**](LinkCommon.md)
|
141
141
|
|
142
142
|
### Authorization
|
143
143
|
|
@@ -169,7 +169,7 @@ MoneyKit.configure do |config|
|
|
169
169
|
end
|
170
170
|
|
171
171
|
api_instance = MoneyKit::LinksApi.new
|
172
|
-
id = 'id_example' # String | The unique ID for this user. This is the same ID provided in the call to <a href
|
172
|
+
id = 'id_example' # String | The unique ID for this user. This is the same ID provided in the call to <a href=/api/operation/create_link_session#customer_user-id>link-session</a> to create any link for this user.
|
173
173
|
|
174
174
|
begin
|
175
175
|
# /users/{id}/links
|
@@ -202,7 +202,7 @@ end
|
|
202
202
|
|
203
203
|
| Name | Type | Description | Notes |
|
204
204
|
| ---- | ---- | ----------- | ----- |
|
205
|
-
| **id** | **String** | The unique ID for this user. This is the same ID provided in the call to <a href=
|
205
|
+
| **id** | **String** | The unique ID for this user. This is the same ID provided in the call to <a href=/api/operation/create_link_session#customer_user-id>link-session</a> to create any link for this user. | |
|
206
206
|
|
207
207
|
### Return type
|
208
208
|
|
@@ -220,11 +220,11 @@ end
|
|
220
220
|
|
221
221
|
## import_link
|
222
222
|
|
223
|
-
> <
|
223
|
+
> <LinkCommon> import_link(import_link_request)
|
224
224
|
|
225
225
|
/links/import
|
226
226
|
|
227
|
-
Creates a new link with pre-populated accounts and transactions. The new link will be created in an initially `disconnected` state, with an error code of `auth_expired`, but all data will be available. As with any disconnected link, the imported link can then be reconnected at any time by starting a new <a href=#operation/create_link_session>/link-session</a> with `existing_link_id` set to the link's `link_id`. Note that the link can be reconnected using any suitable provider.
|
227
|
+
Creates a new link with pre-populated accounts and transactions. The new link will be created in an initially `disconnected` state, with an error code of `auth_expired`, but all data will be available. As with any disconnected link, the imported link can then be reconnected at any time by starting a new <a href=#operation/create_link_session>/link-session</a> with `existing_link_id` set to the link's `link_id`. Note that the link can be reconnected using any suitable provider. <p> The imported data has a maximum size limit of 1MB, which corresponds very roughly to about 4000 transactions. The data is processed synchronously, so you can expect a delay of up to 10 seconds before the response is transmitted. You should set generous HTTP read timeouts to avoid disconnecting before the import is complete.
|
228
228
|
|
229
229
|
### Examples
|
230
230
|
|
@@ -238,7 +238,7 @@ MoneyKit.configure do |config|
|
|
238
238
|
end
|
239
239
|
|
240
240
|
api_instance = MoneyKit::LinksApi.new
|
241
|
-
import_link_request = MoneyKit::ImportLinkRequest.new({customer_user: MoneyKit::CustomerUser.new({id: 'id_example'}), institution_id: '
|
241
|
+
import_link_request = MoneyKit::ImportLinkRequest.new({customer_user: MoneyKit::CustomerUser.new({id: 'id_example'}), institution_id: 'institution_id_example', accounts: [MoneyKit::AccountImportData.new({account_id: '74583934', name: 'Premier Checking', type: 'depository.checking', balances: MoneyKit::AccountBalances.new})], transactions: [MoneyKit::TransactionImportData.new({account_id: '74583934', amount: '384.05', date: 3.56})]}) # ImportLinkRequest |
|
242
242
|
|
243
243
|
begin
|
244
244
|
# /links/import
|
@@ -253,7 +253,7 @@ end
|
|
253
253
|
|
254
254
|
This returns an Array which contains the response data, status code and headers.
|
255
255
|
|
256
|
-
> <Array(<
|
256
|
+
> <Array(<LinkCommon>, Integer, Hash)> import_link_with_http_info(import_link_request)
|
257
257
|
|
258
258
|
```ruby
|
259
259
|
begin
|
@@ -261,7 +261,7 @@ begin
|
|
261
261
|
data, status_code, headers = api_instance.import_link_with_http_info(import_link_request)
|
262
262
|
p status_code # => 2xx
|
263
263
|
p headers # => { ... }
|
264
|
-
p data # => <
|
264
|
+
p data # => <LinkCommon>
|
265
265
|
rescue MoneyKit::ApiError => e
|
266
266
|
puts "Error when calling LinksApi->import_link_with_http_info: #{e}"
|
267
267
|
end
|
@@ -275,7 +275,7 @@ end
|
|
275
275
|
|
276
276
|
### Return type
|
277
277
|
|
278
|
-
[**
|
278
|
+
[**LinkCommon**](LinkCommon.md)
|
279
279
|
|
280
280
|
### Authorization
|
281
281
|
|
@@ -289,7 +289,7 @@ end
|
|
289
289
|
|
290
290
|
## reset_login
|
291
291
|
|
292
|
-
> <
|
292
|
+
> <LinkCommon> reset_login(id)
|
293
293
|
|
294
294
|
Force a \"relink required\" state on a link (Test only).
|
295
295
|
|
@@ -320,7 +320,7 @@ end
|
|
320
320
|
|
321
321
|
This returns an Array which contains the response data, status code and headers.
|
322
322
|
|
323
|
-
> <Array(<
|
323
|
+
> <Array(<LinkCommon>, Integer, Hash)> reset_login_with_http_info(id)
|
324
324
|
|
325
325
|
```ruby
|
326
326
|
begin
|
@@ -328,7 +328,7 @@ begin
|
|
328
328
|
data, status_code, headers = api_instance.reset_login_with_http_info(id)
|
329
329
|
p status_code # => 2xx
|
330
330
|
p headers # => { ... }
|
331
|
-
p data # => <
|
331
|
+
p data # => <LinkCommon>
|
332
332
|
rescue MoneyKit::ApiError => e
|
333
333
|
puts "Error when calling LinksApi->reset_login_with_http_info: #{e}"
|
334
334
|
end
|
@@ -342,7 +342,7 @@ end
|
|
342
342
|
|
343
343
|
### Return type
|
344
344
|
|
345
|
-
[**
|
345
|
+
[**LinkCommon**](LinkCommon.md)
|
346
346
|
|
347
347
|
### Authorization
|
348
348
|
|
@@ -356,7 +356,7 @@ end
|
|
356
356
|
|
357
357
|
## update_link
|
358
358
|
|
359
|
-
> <
|
359
|
+
> <LinkCommon> update_link(id, update_link_request)
|
360
360
|
|
361
361
|
/links/{id}
|
362
362
|
|
@@ -390,7 +390,7 @@ end
|
|
390
390
|
|
391
391
|
This returns an Array which contains the response data, status code and headers.
|
392
392
|
|
393
|
-
> <Array(<
|
393
|
+
> <Array(<LinkCommon>, Integer, Hash)> update_link_with_http_info(id, update_link_request)
|
394
394
|
|
395
395
|
```ruby
|
396
396
|
begin
|
@@ -398,7 +398,7 @@ begin
|
|
398
398
|
data, status_code, headers = api_instance.update_link_with_http_info(id, update_link_request)
|
399
399
|
p status_code # => 2xx
|
400
400
|
p headers # => { ... }
|
401
|
-
p data # => <
|
401
|
+
p data # => <LinkCommon>
|
402
402
|
rescue MoneyKit::ApiError => e
|
403
403
|
puts "Error when calling LinksApi->update_link_with_http_info: #{e}"
|
404
404
|
end
|
@@ -413,7 +413,7 @@ end
|
|
413
413
|
|
414
414
|
### Return type
|
415
415
|
|
416
|
-
[**
|
416
|
+
[**LinkCommon**](LinkCommon.md)
|
417
417
|
|
418
418
|
### Authorization
|
419
419
|
|
@@ -7,6 +7,7 @@
|
|
7
7
|
| **issue_reporter** | **Boolean** | If enabled, the user can report linking issues directly to MoneyKit via 'Report Issue' button. | [optional][default to false] |
|
8
8
|
| **enable_money_id** | **Boolean** | If enabled, the user can register for, or login into, Money ID. | [optional][default to false] |
|
9
9
|
| **duplicate_institution_warning** | **Boolean** | If enabled, the user will see a warning when trying to connect the same institution more than once. | [optional][default to false] |
|
10
|
+
| **connect_manually** | **Boolean** | If enabled, the user can click a button in the MoneyKit Connect SDK to connect manually if the institution they are looking for doesn't exist in our catalog. | [optional][default to false] |
|
10
11
|
|
11
12
|
## Example
|
12
13
|
|
@@ -16,7 +17,8 @@ require 'moneykit'
|
|
16
17
|
instance = MoneyKit::MoneyKitConnectFeatures.new(
|
17
18
|
issue_reporter: null,
|
18
19
|
enable_money_id: null,
|
19
|
-
duplicate_institution_warning: null
|
20
|
+
duplicate_institution_warning: null,
|
21
|
+
connect_manually: null
|
20
22
|
)
|
21
23
|
```
|
22
24
|
|
data/docs/PhoneNumber.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **number** | **String** | A phone number for the account owner. | |
|
8
|
-
| **primary** | **Boolean** | Indicates if this is the primary phone number for the account owner. | [optional] |
|
7
|
+
| **number** | **String** | A phone number for the account owner. Phone numbers may have a variety of formats; they may or may not have country-code prefixes; and they may contain extensions. | |
|
8
|
+
| **primary** | **Boolean** | Indicates if this is the primary phone number for the account owner, as reported by the institution. | [optional] |
|
9
9
|
| **type** | [**PhoneNumberType**](PhoneNumberType.md) | | |
|
10
10
|
|
11
11
|
## Example
|
@@ -14,7 +14,7 @@
|
|
14
14
|
require 'moneykit'
|
15
15
|
|
16
16
|
instance = MoneyKit::PhoneNumber.new(
|
17
|
-
number:
|
17
|
+
number: 6175551212,
|
18
18
|
primary: null,
|
19
19
|
type: null
|
20
20
|
)
|
@@ -5,6 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **transactions** | [**TransactionSync**](TransactionSync.md) | | |
|
8
|
+
| **accounts** | [**Array<AccountResponse>**](AccountResponse.md) | | |
|
8
9
|
| **cursor** | [**CursorPagination**](CursorPagination.md) | | |
|
9
10
|
| **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
11
|
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
@@ -16,6 +17,7 @@ require 'moneykit'
|
|
16
17
|
|
17
18
|
instance = MoneyKit::TransactionSyncResponse.new(
|
18
19
|
transactions: null,
|
20
|
+
accounts: null,
|
19
21
|
cursor: null,
|
20
22
|
has_more: null,
|
21
23
|
link: null
|
data/docs/TransactionsApi.md
CHANGED
@@ -32,8 +32,8 @@ api_instance = MoneyKit::TransactionsApi.new
|
|
32
32
|
id = 'id_example' # String | The unique ID for this link.
|
33
33
|
opts = {
|
34
34
|
account_ids: ['inner_example'], # Array<String> | An optional list of account IDs to filter the results.
|
35
|
-
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
36
|
-
end_date: Date.parse('2013-10-20'), # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
35
|
+
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
36
|
+
end_date: Date.parse('2013-10-20'), # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
37
37
|
page: 56, # Integer | The page number to return.
|
38
38
|
size: 56 # Integer | The number of items to return per page.
|
39
39
|
}
|
@@ -71,8 +71,8 @@ end
|
|
71
71
|
| ---- | ---- | ----------- | ----- |
|
72
72
|
| **id** | **String** | The unique ID for this link. | |
|
73
73
|
| **account_ids** | [**Array<String>**](String.md) | An optional list of account IDs to filter the results. | [optional] |
|
74
|
-
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
75
|
-
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
74
|
+
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD. | [optional] |
|
75
|
+
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD. | [optional] |
|
76
76
|
| **page** | **Integer** | The page number to return. | [optional][default to 1] |
|
77
77
|
| **size** | **Integer** | The number of items to return per page. | [optional][default to 50] |
|
78
78
|
|
@@ -96,7 +96,7 @@ end
|
|
96
96
|
|
97
97
|
/links/{id}/transactions/sync
|
98
98
|
|
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>**Pending** transactions will only be reported as `created`. Pending transactions are completely removed and replaced with each transaction refresh or update; no attempt is made to track their removal or modification. <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.
|
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. **Note** that these lists are **unordered**, so it is possible to get transactions with dates that precede those you've fetched in previous calls to this endpoint. Older transactions can be added, for example, when historical data becomes accessible later. <p>**Pending** transactions will only be reported as `created`. Pending transactions are completely removed and replaced with each transaction refresh or update; no attempt is made to track their removal or modification. Pending transactions will **not** be reported in the `removed` list. If you store pending transactions, you should remove and replace them entirely each time you fetch new transactions. <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.
|
100
100
|
|
101
101
|
### Examples
|
102
102
|
|
@@ -185,7 +185,7 @@ MoneyKit.configure do |config|
|
|
185
185
|
end
|
186
186
|
|
187
187
|
api_instance = MoneyKit::TransactionsApi.new
|
188
|
-
id = 'id_example' # String | The unique ID for this user. This is the same ID provided in the call to <a href
|
188
|
+
id = 'id_example' # String | The unique ID for this user. This is the same ID provided in the call to <a href=/api/operation/create_link_session#customer_user-id>link-session</a> to create any link for this user.
|
189
189
|
opts = {
|
190
190
|
transaction_type: [MoneyKit::TransactionTypeFilter::CREDIT], # Array<TransactionTypeFilter> |
|
191
191
|
category: ['inner_example'], # Array<String> |
|
@@ -193,8 +193,8 @@ opts = {
|
|
193
193
|
institution_id: ['inner_example'], # Array<String> | If present, filters results to transactions at institutions matching the given IDs.
|
194
194
|
page: 56, # Integer | The page number to return.
|
195
195
|
size: 56, # Integer | The number of items to return per page.
|
196
|
-
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
197
|
-
end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
196
|
+
start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
197
|
+
end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
198
198
|
}
|
199
199
|
|
200
200
|
begin
|
@@ -228,15 +228,15 @@ end
|
|
228
228
|
|
229
229
|
| Name | Type | Description | Notes |
|
230
230
|
| ---- | ---- | ----------- | ----- |
|
231
|
-
| **id** | **String** | The unique ID for this user. This is the same ID provided in the call to <a href=
|
231
|
+
| **id** | **String** | The unique ID for this user. This is the same ID provided in the call to <a href=/api/operation/create_link_session#customer_user-id>link-session</a> to create any link for this user. | |
|
232
232
|
| **transaction_type** | [**Array<TransactionTypeFilter>**](TransactionTypeFilter.md) | | [optional] |
|
233
233
|
| **category** | [**Array<String>**](String.md) | | [optional] |
|
234
234
|
| **account_id** | [**Array<String>**](String.md) | If present, filters results to transactions in accounts matching the given IDs. | [optional] |
|
235
235
|
| **institution_id** | [**Array<String>**](String.md) | If present, filters results to transactions at institutions matching the given IDs. | [optional] |
|
236
236
|
| **page** | **Integer** | The page number to return. | [optional][default to 1] |
|
237
237
|
| **size** | **Integer** | The number of items to return per page. | [optional][default to 50] |
|
238
|
-
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
|
239
|
-
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD.
|
238
|
+
| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD. | [optional] |
|
239
|
+
| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD. | [optional] |
|
240
240
|
|
241
241
|
### Return type
|
242
242
|
|