moneykit 0.1.6 → 0.1.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +1 -1
  4. data/docs/AccessTokenApi.md +4 -4
  5. data/docs/AccountNumbersApi.md +12 -12
  6. data/docs/AccountNumbersLegacy20230218.md +24 -0
  7. data/docs/AccountWithAccountNumbersLegacy20230218.md +28 -0
  8. data/docs/AccountsApi.md +20 -20
  9. data/docs/AppClientResponse.md +26 -0
  10. data/docs/AppResponse.md +24 -0
  11. data/docs/CreateLinkSessionRequest.md +2 -2
  12. data/docs/GetAccountNumbersResponseLegacy20230218.md +20 -0
  13. data/docs/IdentityApi.md +1 -1
  14. data/docs/Institution.md +1 -1
  15. data/docs/InstitutionsApi.md +2 -2
  16. data/docs/InvestmentTransactionResponse.md +4 -4
  17. data/docs/InvestmentsApi.md +2 -2
  18. data/docs/LinkProduct.md +28 -0
  19. data/docs/LinkProducts.md +4 -4
  20. data/docs/LinksApi.md +5 -5
  21. data/docs/MoneyKitConnectFeatures.md +3 -1
  22. data/docs/ProductSettings.md +24 -0
  23. data/docs/ProductsApi.md +1 -1
  24. data/docs/ProductsSettings.md +3 -3
  25. data/docs/RequestedLinkPermission.md +2 -2
  26. data/docs/Response401GetAccountNumbersLegacy20230218LinksIdAccountsNumbersGet.md +22 -0
  27. data/docs/SecurityResponse.md +2 -2
  28. data/docs/TransactionsApi.md +5 -5
  29. data/docs/TransactionsLinkProduct.md +6 -4
  30. data/docs/TransactionsProductSettings.md +4 -2
  31. data/docs/UsersApi.md +7 -7
  32. data/docs/WebhooksApi.md +1 -1
  33. data/lib/moneykit/api/access_token_api.rb +3 -3
  34. data/lib/moneykit/api/account_numbers_api.rb +10 -10
  35. data/lib/moneykit/api/accounts_api.rb +16 -16
  36. data/lib/moneykit/api/investments_api.rb +2 -2
  37. data/lib/moneykit/api/transactions_api.rb +6 -6
  38. data/lib/moneykit/api/users_api.rb +8 -8
  39. data/lib/moneykit/models/account_numbers_legacy20230218.rb +275 -0
  40. data/lib/moneykit/models/account_with_account_numbers_legacy20230218.rb +296 -0
  41. data/lib/moneykit/models/app_client_response.rb +281 -0
  42. data/lib/moneykit/models/app_response.rb +272 -0
  43. data/lib/moneykit/models/create_link_session_request.rb +2 -2
  44. data/lib/moneykit/models/get_account_numbers_response_legacy20230218.rb +237 -0
  45. data/lib/moneykit/models/institution.rb +1 -1
  46. data/lib/moneykit/models/investment_transaction_response.rb +13 -13
  47. data/lib/moneykit/models/link_product.rb +283 -0
  48. data/lib/moneykit/models/link_product_failure_reasons.rb +2 -1
  49. data/lib/moneykit/models/link_products.rb +4 -4
  50. data/lib/moneykit/models/money_kit_connect_features.rb +16 -4
  51. data/lib/moneykit/models/product_settings.rb +249 -0
  52. data/lib/moneykit/models/products_settings.rb +3 -3
  53. data/lib/moneykit/models/requested_link_permission.rb +2 -2
  54. data/lib/moneykit/models/response401_get_account_numbers_legacy20230218_links_id_accounts_numbers_get.rb +104 -0
  55. data/lib/moneykit/models/security_response.rb +11 -11
  56. data/lib/moneykit/models/transactions_link_product.rb +22 -18
  57. data/lib/moneykit/models/transactions_product_settings.rb +20 -10
  58. data/lib/moneykit/version.rb +1 -1
  59. data/lib/moneykit.rb +8 -14
  60. data/spec/models/account_numbers_legacy20230218_spec.rb +54 -0
  61. data/spec/models/account_with_account_numbers_legacy20230218_spec.rb +66 -0
  62. data/spec/models/app_client_response_spec.rb +60 -0
  63. data/spec/models/app_response_spec.rb +54 -0
  64. data/spec/models/get_account_numbers_response_legacy20230218_spec.rb +42 -0
  65. data/spec/models/link_product_spec.rb +66 -0
  66. data/spec/models/product_settings_spec.rb +54 -0
  67. data/spec/models/response401_get_account_numbers_legacy20230218_links_id_accounts_numbers_get_spec.rb +21 -0
  68. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/byebug/byebug.so +0 -0
  69. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  70. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  71. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/jaro_winkler/jaro_winkler_ext.so +0 -0
  72. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.1.1/gem_make.out +5 -5
  73. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.1.1/psych.so +0 -0
  74. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.3/gem_make.out +5 -5
  75. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.3/racc/cparse.so +0 -0
  76. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.1.0/gem_make.out +5 -5
  77. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.1.0/stringio.so +0 -0
  78. data/vendor/bundle/ruby/3.2.0/gems/byebug-11.1.3/lib/byebug/byebug.so +0 -0
  79. data/vendor/bundle/ruby/3.2.0/gems/jaro_winkler-1.5.6/lib/jaro_winkler/jaro_winkler_ext.so +0 -0
  80. data/vendor/bundle/ruby/3.2.0/gems/psych-5.1.1.1/lib/psych.so +0 -0
  81. data/vendor/bundle/ruby/3.2.0/gems/racc-1.7.3/lib/racc/cparse.so +0 -0
  82. data/vendor/bundle/ruby/3.2.0/gems/stringio-3.1.0/lib/stringio.so +0 -0
  83. metadata +143 -111
@@ -4,10 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **account_numbers** | [**AccountNumbersProductSettings**](AccountNumbersProductSettings.md) | | [optional] |
8
- | **identity** | [**IdentityProductSettings**](IdentityProductSettings.md) | | [optional] |
7
+ | **account_numbers** | [**ProductSettings**](ProductSettings.md) | | [optional] |
8
+ | **identity** | [**ProductSettings**](ProductSettings.md) | | [optional] |
9
9
  | **transactions** | [**TransactionsProductSettings**](TransactionsProductSettings.md) | | [optional] |
10
- | **investments** | [**InvestmentsProductSettings**](InvestmentsProductSettings.md) | | [optional] |
10
+ | **investments** | [**ProductSettings**](ProductSettings.md) | | [optional] |
11
11
 
12
12
  ## Example
13
13
 
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **scope** | [**LinkPermissionScope**](LinkPermissionScope.md) | | |
8
- | **reason** | **String** | A **brief** description of the reason your app wants this data. This description will be displayed to the user when permission is requested. | |
7
+ | **scope** | [**Product**](Product.md) | | |
8
+ | **reason** | **String** | A **brief** description of the reason your app wants this data. This description will follow the words \"...data is used to\", and will be displayed to the user when permission is requested. | |
9
9
  | **required** | **Boolean** | If true, only institutions that support this data type will be available, and the user **must** grant this permission or the link will not be created. If false, then the available institutions list may include those that do not support this data type, and even if the user declines to grant this permission, the link will still be created (so long as at least one permission is granted). | |
10
10
 
11
11
  ## Example
@@ -0,0 +1,22 @@
1
+ # MoneyKit::Response401GetAccountNumbersLegacy20230218LinksIdAccountsNumbersGet
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error_code** | **Object** | | [optional] |
8
+ | **error_message** | **Object** | | |
9
+ | **documentation_url** | **Object** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'moneykit'
15
+
16
+ instance = MoneyKit::Response401GetAccountNumbersLegacy20230218LinksIdAccountsNumbersGet.new(
17
+ error_code: null,
18
+ error_message: null,
19
+ documentation_url: null
20
+ )
21
+ ```
22
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | A unique MoneyKit ID for this security. | |
7
+ | **security_id** | **String** | A unique MoneyKit ID for this security. | |
8
8
  | **name** | **String** | A user-facing name for this security. | |
9
9
  | **type** | **String** | The type of this security. Will be one of: <p>`cash`: Cash, currency, and money market funds <p>`crypto`: Digital or virtual currencies <p>`derivative`: Options, warrants, and other derivative instruments <p>`equity`: Equities (stocks) <p>`etf`: Exchange-traded investment funds <p>`bond`: Bonds and certificates of deposit (CDs) <p>`loan`: Loans and loan receivables <p>`fund`: Open- and closed-end vehicles pooling funds of multiple investors <p>`unknown`: Indicates the type is unknown or does not fit into any other category | |
10
10
  | **currency** | **String** | The ISO-4217 code for the currency in which this security is priced. | |
@@ -20,7 +20,7 @@
20
20
  require 'moneykit'
21
21
 
22
22
  instance = MoneyKit::SecurityResponse.new(
23
- id: sec_bb6fi893jxdfNxyAjnb784,
23
+ security_id: sec_bb6fi893jxdfNxyAjnb784,
24
24
  name: Microsoft,
25
25
  type: equity,
26
26
  currency: USD,
@@ -29,7 +29,7 @@ MoneyKit.configure do |config|
29
29
  end
30
30
 
31
31
  api_instance = MoneyKit::TransactionsApi.new
32
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
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
35
  page: 56, # Integer | The page number to return.
@@ -110,9 +110,9 @@ MoneyKit.configure do |config|
110
110
  end
111
111
 
112
112
  api_instance = MoneyKit::TransactionsApi.new
113
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
113
+ id = 'id_example' # String | The unique ID for this link.
114
114
  opts = {
115
- cursor: 'cursor_example', # String | A cursor value representing the last update requested. If included, the response will only return changes after this update. If omitted, a complete history of updates will be returned. This value must be stored by the client as we do not keep track of customer cursors.
115
+ cursor: 'cursor_example', # String | A cursor value representing the last update requested. If included, the response will only return changes after this update. If omitted, a complete history of updates will be returned. This value must be stored by the client as we do not keep track of app cursors.
116
116
  size: 56 # Integer | The number of items to return.
117
117
  }
118
118
 
@@ -148,7 +148,7 @@ end
148
148
  | Name | Type | Description | Notes |
149
149
  | ---- | ---- | ----------- | ----- |
150
150
  | **id** | **String** | The unique ID for this link. | |
151
- | **cursor** | **String** | A cursor value representing the last update requested. If included, the response will only return changes after this update. If omitted, a complete history of updates will be returned. This value must be stored by the client as we do not keep track of customer cursors. | [optional] |
151
+ | **cursor** | **String** | A cursor value representing the last update requested. If included, the response will only return changes after this update. If omitted, a complete history of updates will be returned. This value must be stored by the client as we do not keep track of app cursors. | [optional] |
152
152
  | **size** | **Integer** | The number of items to return. | [optional][default to 50] |
153
153
 
154
154
  ### Return type
@@ -185,7 +185,7 @@ MoneyKit.configure do |config|
185
185
  end
186
186
 
187
187
  api_instance = MoneyKit::TransactionsApi.new
188
- id = 'MyUser1234' # String | The unique ID for this user. This is the same ID provided in the call to <a href=#operation/create_link_session>/link-session</a> to create any link for this user.
188
+ id = 'id_example' # 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.
189
189
  opts = {
190
190
  transaction_type: [MoneyKit::TransactionTypeFilter::CREDIT], # Array<TransactionTypeFilter> |
191
191
  category: ['inner_example'], # Array<String> |
@@ -8,8 +8,9 @@
8
8
  | **last_attempted_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was attempted. | [optional] |
9
9
  | **error_code** | [**LinkProductFailureReasons**](LinkProductFailureReasons.md) | | [optional] |
10
10
  | **error_message** | **String** | The error message, if the last attempt to refresh the product failed. | [optional] |
11
- | **has_history** | **Boolean** | | |
12
- | **settings** | [**TransactionsProductSettings**](TransactionsProductSettings.md) | | |
11
+ | **unavailable** | **String** | If this product can&#39;t currently be updated, the reason why it is unavailable. &lt;p&gt;Unavailable products can&#39;t be refreshed, but past data, if any, is still accessible. | [optional] |
12
+ | **settings** | [**TransactionsProductSettings**](TransactionsProductSettings.md) | | [optional] |
13
+ | **has_history** | **Boolean** | DEPRECATED: No longer used as we fetch as much history as possible. | |
13
14
 
14
15
  ## Example
15
16
 
@@ -21,8 +22,9 @@ instance = MoneyKit::TransactionsLinkProduct.new(
21
22
  last_attempted_at: 2023-02-16T09:14:11,
22
23
  error_code: null,
23
24
  error_message: null,
24
- has_history: null,
25
- settings: null
25
+ unavailable: null,
26
+ settings: null,
27
+ has_history: null
26
28
  )
27
29
  ```
28
30
 
@@ -5,8 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **required** | **Boolean** | If true, only institutions supporting this product will be available. | [optional][default to false] |
8
+ | **require_permission** | **Boolean** | This flag matters only if &#x60;required&#x60; is false. For non-required products, the product permission is normally presented to the user as optional (granted by default, but the user may opt out). If this flag is true, however, the product permission will be presented in the UI as non-optional: the user&#39;s only choice is to grant the permission or to cancel the link. &lt;p&gt; Note that this field is ignored if &#x60;required&#x60; is true. Permission is always mandatory for required products. | [optional][default to false] |
8
9
  | **prefetch** | **Boolean** | If true, the data will be available as soon as possible after linking, even if &#x60;required&#x60; is false. If false, the data will be available after the first manual data refresh. | [optional][default to false] |
9
- | **extend_history** | **Boolean** | If true, MoneyKit will attempt to fetch as much transaction history as possible. Not all institutions supply the same extent of transaction history. Generally, however, at least the past 30 days of transactions are available. | [optional][default to false] |
10
+ | **reason** | **String** | A **brief** description of the reason your app wants this data. This description will follow the words \&quot;...data is used to\&quot;, and will be displayed to the user when permission is requested. You should provide this field if your app does not request this product by default, or if you want to show a particular reason for requesting the product during this link session. | [optional] |
10
11
 
11
12
  ## Example
12
13
 
@@ -15,8 +16,9 @@ require 'moneykit'
15
16
 
16
17
  instance = MoneyKit::TransactionsProductSettings.new(
17
18
  required: null,
19
+ require_permission: null,
18
20
  prefetch: null,
19
- extend_history: null
21
+ reason: display your account balances
20
22
  )
21
23
  ```
22
24
 
data/docs/UsersApi.md CHANGED
@@ -29,10 +29,10 @@ MoneyKit.configure do |config|
29
29
  end
30
30
 
31
31
  api_instance = MoneyKit::UsersApi.new
32
- id = 'MyUser1234' # String | The unique ID for this user. This is the same ID provided in the call to <a href=#operation/create_link_session>/link-session</a> to create any link for this user.
32
+ id = 'id_example' # String | The unique ID for this user. This is the same ID provided in the call to <a href=#operation/create_link_session>/link-session</a> to create any link for this user.
33
33
  opts = {
34
- account_id: ['inner_example'], # Array<String> | If present, filters results to accounts matching the given IDs.
35
- institution_id: ['inner_example'] # Array<String> | If present, filters results to accounts at institutions matching the given IDs.
34
+ account_ids: ['inner_example'], # Array<String> | If present, filters results to accounts matching the given IDs.
35
+ institution_ids: ['inner_example'] # Array<String> | If present, filters results to accounts at institutions matching the given IDs.
36
36
  }
37
37
 
38
38
  begin
@@ -67,8 +67,8 @@ end
67
67
  | Name | Type | Description | Notes |
68
68
  | ---- | ---- | ----------- | ----- |
69
69
  | **id** | **String** | The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;#operation/create_link_session&gt;/link-session&lt;/a&gt; to create any link for this user. | |
70
- | **account_id** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts matching the given IDs. | [optional] |
71
- | **institution_id** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts at institutions matching the given IDs. | [optional] |
70
+ | **account_ids** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts matching the given IDs. | [optional] |
71
+ | **institution_ids** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts at institutions matching the given IDs. | [optional] |
72
72
 
73
73
  ### Return type
74
74
 
@@ -104,7 +104,7 @@ MoneyKit.configure do |config|
104
104
  end
105
105
 
106
106
  api_instance = MoneyKit::UsersApi.new
107
- id = 'MyUser1234' # String | The unique ID for this user. This is the same ID provided in the call to <a href=#operation/create_link_session>/link-session</a> to create any link for this user.
107
+ id = 'id_example' # 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.
108
108
 
109
109
  begin
110
110
  # /users/{id}/links
@@ -173,7 +173,7 @@ MoneyKit.configure do |config|
173
173
  end
174
174
 
175
175
  api_instance = MoneyKit::UsersApi.new
176
- id = 'MyUser1234' # String | The unique ID for this user. This is the same ID provided in the call to <a href=#operation/create_link_session>/link-session</a> to create any link for this user.
176
+ id = 'id_example' # 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.
177
177
  opts = {
178
178
  transaction_type: [MoneyKit::TransactionTypeFilter::CREDIT], # Array<TransactionTypeFilter> |
179
179
  category: ['inner_example'], # Array<String> |
data/docs/WebhooksApi.md CHANGED
@@ -25,7 +25,7 @@ MoneyKit.configure do |config|
25
25
  end
26
26
 
27
27
  api_instance = MoneyKit::WebhooksApi.new
28
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
28
+ id = 'id_example' # String | The unique ID for this link.
29
29
  webhook_test_link_request = MoneyKit::WebhookTestLinkRequest.new({webhook_event: MoneyKit::WebhookLinkTestEvent::LINK_STATE_CHANGED, webhook_idempotency_key: 'webhook_idempotency_key_example'}) # WebhookTestLinkRequest |
30
30
 
31
31
  begin
@@ -158,7 +158,7 @@ module MoneyKit
158
158
  # /auth/introspect
159
159
  # Get details about the client and application associated with your `access_token`.
160
160
  # @param [Hash] opts the optional parameters
161
- # @return [IntrospectClientResponse]
161
+ # @return [AppClientResponse]
162
162
  def instrospect_client(opts = {})
163
163
  data, _status_code, _headers = instrospect_client_with_http_info(opts)
164
164
  data
@@ -167,7 +167,7 @@ module MoneyKit
167
167
  # /auth/introspect
168
168
  # Get details about the client and application associated with your &#x60;access_token&#x60;.
169
169
  # @param [Hash] opts the optional parameters
170
- # @return [Array<(IntrospectClientResponse, Integer, Hash)>] IntrospectClientResponse data, response status code and response headers
170
+ # @return [Array<(AppClientResponse, Integer, Hash)>] AppClientResponse data, response status code and response headers
171
171
  def instrospect_client_with_http_info(opts = {})
172
172
  if @api_client.config.debugging
173
173
  @api_client.config.logger.debug 'Calling API: AccessTokenApi.instrospect_client ...'
@@ -190,7 +190,7 @@ module MoneyKit
190
190
  post_body = opts[:debug_body]
191
191
 
192
192
  # return_type
193
- return_type = opts[:debug_return_type] || 'IntrospectClientResponse'
193
+ return_type = opts[:debug_return_type] || 'AppClientResponse'
194
194
 
195
195
  # auth_names
196
196
  auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials']
@@ -23,9 +23,9 @@ module MoneyKit
23
23
  # Returns a list of open, permissioned accounts associated with a <a href=#tag/Links>link</a>, including full account and routing numbers for appropriate accounts (such as checking and savings accounts). <p>**Note** that this endpoint does **not** trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because `prefetch` was requested when the link was created, or because of an on-demand update. **To force a check for new/updated account numbers, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.
24
24
  # @param id [String] The unique ID for this link.
25
25
  # @param [Hash] opts the optional parameters
26
- # @return [GetAccountNumbersResponse]
27
- def get_account_numbers(id, opts = {})
28
- data, _status_code, _headers = get_account_numbers_with_http_info(id, opts)
26
+ # @return [GetAccountNumbersResponseLegacy20230218]
27
+ def get_account_numbers_legacy20230218(id, opts = {})
28
+ data, _status_code, _headers = get_account_numbers_legacy20230218_with_http_info(id, opts)
29
29
  data
30
30
  end
31
31
 
@@ -33,14 +33,14 @@ module MoneyKit
33
33
  # Returns a list of open, permissioned accounts associated with a &lt;a href&#x3D;#tag/Links&gt;link&lt;/a&gt;, including full account and routing numbers for appropriate accounts (such as checking and savings accounts). &lt;p&gt;**Note** that this endpoint does **not** trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because &#x60;prefetch&#x60; was requested when the link was created, or because of an on-demand update. **To force a check for new/updated account numbers, you must use the &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.** &lt;p&gt;If you have requested prefetch or an on-demand update, you should check the &#x60;refreshed_at&#x60; date for this product in the returned response, and compare that against the previous &#x60;refreshed_at&#x60; 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.
34
34
  # @param id [String] The unique ID for this link.
35
35
  # @param [Hash] opts the optional parameters
36
- # @return [Array<(GetAccountNumbersResponse, Integer, Hash)>] GetAccountNumbersResponse data, response status code and response headers
37
- def get_account_numbers_with_http_info(id, opts = {})
36
+ # @return [Array<(GetAccountNumbersResponseLegacy20230218, Integer, Hash)>] GetAccountNumbersResponseLegacy20230218 data, response status code and response headers
37
+ def get_account_numbers_legacy20230218_with_http_info(id, opts = {})
38
38
  if @api_client.config.debugging
39
- @api_client.config.logger.debug 'Calling API: AccountNumbersApi.get_account_numbers ...'
39
+ @api_client.config.logger.debug 'Calling API: AccountNumbersApi.get_account_numbers_legacy20230218 ...'
40
40
  end
41
41
  # verify the required parameter 'id' is set
42
42
  if @api_client.config.client_side_validation && id.nil?
43
- fail ArgumentError, "Missing the required parameter 'id' when calling AccountNumbersApi.get_account_numbers"
43
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccountNumbersApi.get_account_numbers_legacy20230218"
44
44
  end
45
45
  # resource path
46
46
  local_var_path = '/links/{id}/accounts/numbers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
@@ -60,13 +60,13 @@ module MoneyKit
60
60
  post_body = opts[:debug_body]
61
61
 
62
62
  # return_type
63
- return_type = opts[:debug_return_type] || 'GetAccountNumbersResponse'
63
+ return_type = opts[:debug_return_type] || 'GetAccountNumbersResponseLegacy20230218'
64
64
 
65
65
  # auth_names
66
66
  auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials']
67
67
 
68
68
  new_options = opts.merge(
69
- :operation => :"AccountNumbersApi.get_account_numbers",
69
+ :operation => :"AccountNumbersApi.get_account_numbers_legacy20230218",
70
70
  :header_params => header_params,
71
71
  :query_params => query_params,
72
72
  :form_params => form_params,
@@ -77,7 +77,7 @@ module MoneyKit
77
77
 
78
78
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
79
  if @api_client.config.debugging
80
- @api_client.config.logger.debug "API called: AccountNumbersApi#get_account_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
+ @api_client.config.logger.debug "API called: AccountNumbersApi#get_account_numbers_legacy20230218\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
81
  end
82
82
  return data, status_code, headers
83
83
  end
@@ -92,9 +92,9 @@ module MoneyKit
92
92
  # Returns a list of open, permissioned accounts associated with a <a href=#tag/Links>link</a>, including full account and routing numbers for appropriate accounts (such as checking and savings accounts). <p>**Note** that this endpoint does **not** trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because `prefetch` was requested when the link was created, or because of an on-demand update. **To force a check for new/updated account numbers, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.
93
93
  # @param id [String] The unique ID for this link.
94
94
  # @param [Hash] opts the optional parameters
95
- # @return [GetAccountNumbersResponse]
96
- def get_account_numbers(id, opts = {})
97
- data, _status_code, _headers = get_account_numbers_with_http_info(id, opts)
95
+ # @return [GetAccountNumbersResponseLegacy20230218]
96
+ def get_account_numbers_legacy20230218(id, opts = {})
97
+ data, _status_code, _headers = get_account_numbers_legacy20230218_with_http_info(id, opts)
98
98
  data
99
99
  end
100
100
 
@@ -102,14 +102,14 @@ module MoneyKit
102
102
  # Returns a list of open, permissioned accounts associated with a &lt;a href&#x3D;#tag/Links&gt;link&lt;/a&gt;, including full account and routing numbers for appropriate accounts (such as checking and savings accounts). &lt;p&gt;**Note** that this endpoint does **not** trigger a fetch of account numbers from the institution; it merely returns account numbers that have already been fetched, either because &#x60;prefetch&#x60; was requested when the link was created, or because of an on-demand update. **To force a check for new/updated account numbers, you must use the &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.** &lt;p&gt;If you have requested prefetch or an on-demand update, you should check the &#x60;refreshed_at&#x60; date for this product in the returned response, and compare that against the previous &#x60;refreshed_at&#x60; 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.
103
103
  # @param id [String] The unique ID for this link.
104
104
  # @param [Hash] opts the optional parameters
105
- # @return [Array<(GetAccountNumbersResponse, Integer, Hash)>] GetAccountNumbersResponse data, response status code and response headers
106
- def get_account_numbers_with_http_info(id, opts = {})
105
+ # @return [Array<(GetAccountNumbersResponseLegacy20230218, Integer, Hash)>] GetAccountNumbersResponseLegacy20230218 data, response status code and response headers
106
+ def get_account_numbers_legacy20230218_with_http_info(id, opts = {})
107
107
  if @api_client.config.debugging
108
- @api_client.config.logger.debug 'Calling API: AccountsApi.get_account_numbers ...'
108
+ @api_client.config.logger.debug 'Calling API: AccountsApi.get_account_numbers_legacy20230218 ...'
109
109
  end
110
110
  # verify the required parameter 'id' is set
111
111
  if @api_client.config.client_side_validation && id.nil?
112
- fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.get_account_numbers"
112
+ fail ArgumentError, "Missing the required parameter 'id' when calling AccountsApi.get_account_numbers_legacy20230218"
113
113
  end
114
114
  # resource path
115
115
  local_var_path = '/links/{id}/accounts/numbers'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
@@ -129,13 +129,13 @@ module MoneyKit
129
129
  post_body = opts[:debug_body]
130
130
 
131
131
  # return_type
132
- return_type = opts[:debug_return_type] || 'GetAccountNumbersResponse'
132
+ return_type = opts[:debug_return_type] || 'GetAccountNumbersResponseLegacy20230218'
133
133
 
134
134
  # auth_names
135
135
  auth_names = opts[:debug_auth_names] || ['OAuth2ClientCredentials']
136
136
 
137
137
  new_options = opts.merge(
138
- :operation => :"AccountsApi.get_account_numbers",
138
+ :operation => :"AccountsApi.get_account_numbers_legacy20230218",
139
139
  :header_params => header_params,
140
140
  :query_params => query_params,
141
141
  :form_params => form_params,
@@ -146,7 +146,7 @@ module MoneyKit
146
146
 
147
147
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
148
148
  if @api_client.config.debugging
149
- @api_client.config.logger.debug "API called: AccountsApi#get_account_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
149
+ @api_client.config.logger.debug "API called: AccountsApi#get_account_numbers_legacy20230218\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
150
150
  end
151
151
  return data, status_code, headers
152
152
  end
@@ -221,8 +221,8 @@ module MoneyKit
221
221
  # Fetches all accounts belonging to a <a href=#operation/get_user_accounts>user</a>.
222
222
  # @param id [String] The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;#operation/create_link_session&gt;/link-session&lt;/a&gt; to create any link for this user.
223
223
  # @param [Hash] opts the optional parameters
224
- # @option opts [Array<String>] :account_id If present, filters results to accounts matching the given IDs.
225
- # @option opts [Array<String>] :institution_id If present, filters results to accounts at institutions matching the given IDs.
224
+ # @option opts [Array<String>] :account_ids If present, filters results to accounts matching the given IDs.
225
+ # @option opts [Array<String>] :institution_ids If present, filters results to accounts at institutions matching the given IDs.
226
226
  # @return [GetUserAccountsResponse]
227
227
  def get_user_accounts(id, opts = {})
228
228
  data, _status_code, _headers = get_user_accounts_with_http_info(id, opts)
@@ -233,8 +233,8 @@ module MoneyKit
233
233
  # Fetches all accounts belonging to a &lt;a href&#x3D;#operation/get_user_accounts&gt;user&lt;/a&gt;.
234
234
  # @param id [String] The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;#operation/create_link_session&gt;/link-session&lt;/a&gt; to create any link for this user.
235
235
  # @param [Hash] opts the optional parameters
236
- # @option opts [Array<String>] :account_id If present, filters results to accounts matching the given IDs.
237
- # @option opts [Array<String>] :institution_id If present, filters results to accounts at institutions matching the given IDs.
236
+ # @option opts [Array<String>] :account_ids If present, filters results to accounts matching the given IDs.
237
+ # @option opts [Array<String>] :institution_ids If present, filters results to accounts at institutions matching the given IDs.
238
238
  # @return [Array<(GetUserAccountsResponse, Integer, Hash)>] GetUserAccountsResponse data, response status code and response headers
239
239
  def get_user_accounts_with_http_info(id, opts = {})
240
240
  if @api_client.config.debugging
@@ -249,8 +249,8 @@ module MoneyKit
249
249
 
250
250
  # query parameters
251
251
  query_params = opts[:query_params] || {}
252
- query_params[:'account_id'] = @api_client.build_collection_param(opts[:'account_id'], :multi) if !opts[:'account_id'].nil?
253
- query_params[:'institution_id'] = @api_client.build_collection_param(opts[:'institution_id'], :multi) if !opts[:'institution_id'].nil?
252
+ query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
253
+ query_params[:'institution_ids'] = @api_client.build_collection_param(opts[:'institution_ids'], :multi) if !opts[:'institution_ids'].nil?
254
254
 
255
255
  # header parameters
256
256
  header_params = opts[:header_params] || {}
@@ -122,8 +122,8 @@ module MoneyKit
122
122
  fail ArgumentError, 'invalid value for "opts[:"page"]" when calling InvestmentsApi.get_investment_transactions, must be greater than or equal to 1.'
123
123
  end
124
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.'
125
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 500
126
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InvestmentsApi.get_investment_transactions, must be smaller than or equal to 500.'
127
127
  end
128
128
 
129
129
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
@@ -56,8 +56,8 @@ module MoneyKit
56
56
  fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TransactionsApi.get_transactions, must be greater than or equal to 1.'
57
57
  end
58
58
 
59
- if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
60
- fail ArgumentError, 'invalid value for "opts[:"size"]" when calling TransactionsApi.get_transactions, must be smaller than or equal to 100.'
59
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 500
60
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling TransactionsApi.get_transactions, must be smaller than or equal to 500.'
61
61
  end
62
62
 
63
63
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
@@ -113,7 +113,7 @@ module MoneyKit
113
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.
114
114
  # @param id [String] The unique ID for this link.
115
115
  # @param [Hash] opts the optional parameters
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.
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 app cursors.
117
117
  # @option opts [Integer] :size The number of items to return. (default to 50)
118
118
  # @return [TransactionSyncResponse]
119
119
  def get_transactions_diff(id, opts = {})
@@ -125,7 +125,7 @@ module MoneyKit
125
125
  # Provides a paginated feed of transactions, grouped into &#x60;created&#x60;, &#x60;updated&#x60;, and &#x60;removed&#x60; lists. &lt;p&gt;Each call will also return a &#x60;cursor.next&#x60; value. In subsequent calls, include that value to receive only changes that have occurred since the previous call. &lt;p&gt;Large numbers of transactions will be paginated, and the &#x60;has_more&#x60; field will be true. You should continue calling this endpoint with each new &#x60;cursor.next&#x60; value until &#x60;has_more&#x60; is false. &lt;p&gt;**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 &#x60;prefetch&#x60; was requested when the link was created, or because of scheduled or on-demand updates. &lt;p&gt;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 &lt;a href&#x3D;#operation/refresh_products&gt;/products&lt;/a&gt; endpoint.** &lt;p&gt;Note also that the &#x60;transactions.updates_available&#x60; webhook will alert you when new data is available.
126
126
  # @param id [String] The unique ID for this link.
127
127
  # @param [Hash] opts the optional parameters
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.
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 app cursors.
129
129
  # @option opts [Integer] :size The number of items to return. (default to 50)
130
130
  # @return [Array<(TransactionSyncResponse, Integer, Hash)>] TransactionSyncResponse data, response status code and response headers
131
131
  def get_transactions_diff_with_http_info(id, opts = {})
@@ -229,8 +229,8 @@ module MoneyKit
229
229
  fail ArgumentError, 'invalid value for "opts[:"page"]" when calling TransactionsApi.get_user_transactions, must be greater than or equal to 1.'
230
230
  end
231
231
 
232
- if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
233
- fail ArgumentError, 'invalid value for "opts[:"size"]" when calling TransactionsApi.get_user_transactions, must be smaller than or equal to 100.'
232
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 500
233
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling TransactionsApi.get_user_transactions, must be smaller than or equal to 500.'
234
234
  end
235
235
 
236
236
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
@@ -23,8 +23,8 @@ module MoneyKit
23
23
  # Fetches all accounts belonging to a <a href=#operation/get_user_accounts>user</a>.
24
24
  # @param id [String] The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;#operation/create_link_session&gt;/link-session&lt;/a&gt; to create any link for this user.
25
25
  # @param [Hash] opts the optional parameters
26
- # @option opts [Array<String>] :account_id If present, filters results to accounts matching the given IDs.
27
- # @option opts [Array<String>] :institution_id If present, filters results to accounts at institutions matching the given IDs.
26
+ # @option opts [Array<String>] :account_ids If present, filters results to accounts matching the given IDs.
27
+ # @option opts [Array<String>] :institution_ids If present, filters results to accounts at institutions matching the given IDs.
28
28
  # @return [GetUserAccountsResponse]
29
29
  def get_user_accounts(id, opts = {})
30
30
  data, _status_code, _headers = get_user_accounts_with_http_info(id, opts)
@@ -35,8 +35,8 @@ module MoneyKit
35
35
  # Fetches all accounts belonging to a &lt;a href&#x3D;#operation/get_user_accounts&gt;user&lt;/a&gt;.
36
36
  # @param id [String] The unique ID for this user. This is the same ID provided in the call to &lt;a href&#x3D;#operation/create_link_session&gt;/link-session&lt;/a&gt; to create any link for this user.
37
37
  # @param [Hash] opts the optional parameters
38
- # @option opts [Array<String>] :account_id If present, filters results to accounts matching the given IDs.
39
- # @option opts [Array<String>] :institution_id If present, filters results to accounts at institutions matching the given IDs.
38
+ # @option opts [Array<String>] :account_ids If present, filters results to accounts matching the given IDs.
39
+ # @option opts [Array<String>] :institution_ids If present, filters results to accounts at institutions matching the given IDs.
40
40
  # @return [Array<(GetUserAccountsResponse, Integer, Hash)>] GetUserAccountsResponse data, response status code and response headers
41
41
  def get_user_accounts_with_http_info(id, opts = {})
42
42
  if @api_client.config.debugging
@@ -51,8 +51,8 @@ module MoneyKit
51
51
 
52
52
  # query parameters
53
53
  query_params = opts[:query_params] || {}
54
- query_params[:'account_id'] = @api_client.build_collection_param(opts[:'account_id'], :multi) if !opts[:'account_id'].nil?
55
- query_params[:'institution_id'] = @api_client.build_collection_param(opts[:'institution_id'], :multi) if !opts[:'institution_id'].nil?
54
+ query_params[:'account_ids'] = @api_client.build_collection_param(opts[:'account_ids'], :multi) if !opts[:'account_ids'].nil?
55
+ query_params[:'institution_ids'] = @api_client.build_collection_param(opts[:'institution_ids'], :multi) if !opts[:'institution_ids'].nil?
56
56
 
57
57
  # header parameters
58
58
  header_params = opts[:header_params] || {}
@@ -194,8 +194,8 @@ module MoneyKit
194
194
  fail ArgumentError, 'invalid value for "opts[:"page"]" when calling UsersApi.get_user_transactions, must be greater than or equal to 1.'
195
195
  end
196
196
 
197
- if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
198
- fail ArgumentError, 'invalid value for "opts[:"size"]" when calling UsersApi.get_user_transactions, must be smaller than or equal to 100.'
197
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 500
198
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling UsersApi.get_user_transactions, must be smaller than or equal to 500.'
199
199
  end
200
200
 
201
201
  if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1