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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b58e851a3e57d16e10765fc1c5d02498d681f7eec264f210aa12218971e66bb5
4
- data.tar.gz: '09170391b76249ff26a5dc38690e3dad30d2e606a5f1af90074370236414e5e4'
3
+ metadata.gz: 49038e39b339500c639e79d4ea24595bc8af5610f1e24ce0f374dfcb7e4bd633
4
+ data.tar.gz: 766803455444f9a8369637af7e6575e1a8645f44927a62dad245305edeb3ef57
5
5
  SHA512:
6
- metadata.gz: ec0d3b7baca97c2e2c3d950687149ca9c01e364871d05c42301c70d2b1f46e4f434a804017730062fa5893c362870296f2e509271028af30c58464e2d041c452
7
- data.tar.gz: 454e763418c961943846b634eed790e182f64e4ff5e6ce47924577dfd0ae6c6101dc8d968ca2fedafcc38e11e993245c93a6f1d7dd0b36220a71a2363c9a7e7d
6
+ metadata.gz: 28609532bcb8518a01f52da21d2e1aff029f543ffd69f61e45ae3f9026398e021043c5024472c5987681e660d30d20f5258b02d08a39bc888701636688bfe64a
7
+ data.tar.gz: d6ae452acbff24cb002645f00add14ef778a624114cc968c8e779301b7298a826a1021564673798e6394a2934277438211f5f7d0aa6b1bb04c35d184749ae5cb
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- moneykit (0.1.6)
4
+ moneykit (0.1.9)
5
5
  faraday (>= 1.0.1, < 3.0)
6
6
  faraday-multipart
7
7
 
data/README.md CHANGED
@@ -16,7 +16,7 @@ bundle add moneykit.gemspec
16
16
  or add the following to your `Gemfile`
17
17
 
18
18
  ```
19
- gem 'moneykit', '~> 0.1.6'
19
+ gem 'moneykit', '~> 0.1.9'
20
20
  ```
21
21
 
22
22
  ## Getting Started
@@ -155,7 +155,7 @@ This endpoint does not need any parameter.
155
155
 
156
156
  ## instrospect_client
157
157
 
158
- > <IntrospectClientResponse> instrospect_client
158
+ > <AppClientResponse> instrospect_client
159
159
 
160
160
  /auth/introspect
161
161
 
@@ -187,7 +187,7 @@ end
187
187
 
188
188
  This returns an Array which contains the response data, status code and headers.
189
189
 
190
- > <Array(<IntrospectClientResponse>, Integer, Hash)> instrospect_client_with_http_info
190
+ > <Array(<AppClientResponse>, Integer, Hash)> instrospect_client_with_http_info
191
191
 
192
192
  ```ruby
193
193
  begin
@@ -195,7 +195,7 @@ begin
195
195
  data, status_code, headers = api_instance.instrospect_client_with_http_info
196
196
  p status_code # => 2xx
197
197
  p headers # => { ... }
198
- p data # => <IntrospectClientResponse>
198
+ p data # => <AppClientResponse>
199
199
  rescue MoneyKit::ApiError => e
200
200
  puts "Error when calling AccessTokenApi->instrospect_client_with_http_info: #{e}"
201
201
  end
@@ -207,7 +207,7 @@ This endpoint does not need any parameter.
207
207
 
208
208
  ### Return type
209
209
 
210
- [**IntrospectClientResponse**](IntrospectClientResponse.md)
210
+ [**AppClientResponse**](AppClientResponse.md)
211
211
 
212
212
  ### Authorization
213
213
 
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.moneykit.com*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**get_account_numbers**](AccountNumbersApi.md#get_account_numbers) | **GET** /links/{id}/accounts/numbers | /links/{id}/accounts/numbers |
7
+ | [**get_account_numbers_legacy20230218**](AccountNumbersApi.md#get_account_numbers_legacy20230218) | **GET** /links/{id}/accounts/numbers | /links/{id}/accounts/numbers |
8
8
 
9
9
 
10
- ## get_account_numbers
10
+ ## get_account_numbers_legacy20230218
11
11
 
12
- > <GetAccountNumbersResponse> get_account_numbers(id)
12
+ > <GetAccountNumbersResponseLegacy20230218> get_account_numbers_legacy20230218(id)
13
13
 
14
14
  /links/{id}/accounts/numbers
15
15
 
@@ -27,32 +27,32 @@ MoneyKit.configure do |config|
27
27
  end
28
28
 
29
29
  api_instance = MoneyKit::AccountNumbersApi.new
30
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
30
+ id = 'id_example' # String | The unique ID for this link.
31
31
 
32
32
  begin
33
33
  # /links/{id}/accounts/numbers
34
- result = api_instance.get_account_numbers(id)
34
+ result = api_instance.get_account_numbers_legacy20230218(id)
35
35
  p result
36
36
  rescue MoneyKit::ApiError => e
37
- puts "Error when calling AccountNumbersApi->get_account_numbers: #{e}"
37
+ puts "Error when calling AccountNumbersApi->get_account_numbers_legacy20230218: #{e}"
38
38
  end
39
39
  ```
40
40
 
41
- #### Using the get_account_numbers_with_http_info variant
41
+ #### Using the get_account_numbers_legacy20230218_with_http_info variant
42
42
 
43
43
  This returns an Array which contains the response data, status code and headers.
44
44
 
45
- > <Array(<GetAccountNumbersResponse>, Integer, Hash)> get_account_numbers_with_http_info(id)
45
+ > <Array(<GetAccountNumbersResponseLegacy20230218>, Integer, Hash)> get_account_numbers_legacy20230218_with_http_info(id)
46
46
 
47
47
  ```ruby
48
48
  begin
49
49
  # /links/{id}/accounts/numbers
50
- data, status_code, headers = api_instance.get_account_numbers_with_http_info(id)
50
+ data, status_code, headers = api_instance.get_account_numbers_legacy20230218_with_http_info(id)
51
51
  p status_code # => 2xx
52
52
  p headers # => { ... }
53
- p data # => <GetAccountNumbersResponse>
53
+ p data # => <GetAccountNumbersResponseLegacy20230218>
54
54
  rescue MoneyKit::ApiError => e
55
- puts "Error when calling AccountNumbersApi->get_account_numbers_with_http_info: #{e}"
55
+ puts "Error when calling AccountNumbersApi->get_account_numbers_legacy20230218_with_http_info: #{e}"
56
56
  end
57
57
  ```
58
58
 
@@ -64,7 +64,7 @@ end
64
64
 
65
65
  ### Return type
66
66
 
67
- [**GetAccountNumbersResponse**](GetAccountNumbersResponse.md)
67
+ [**GetAccountNumbersResponseLegacy20230218**](GetAccountNumbersResponseLegacy20230218.md)
68
68
 
69
69
  ### Authorization
70
70
 
@@ -0,0 +1,24 @@
1
+ # MoneyKit::AccountNumbersLegacy20230218
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ach** | [**Array&lt;AchNumber&gt;**](AchNumber.md) | | |
8
+ | **bacs** | [**Array&lt;BacsNumber&gt;**](BacsNumber.md) | | |
9
+ | **eft** | [**Array&lt;EftNumber&gt;**](EftNumber.md) | | |
10
+ | **international** | [**Array&lt;InternationalNumber&gt;**](InternationalNumber.md) | | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'moneykit'
16
+
17
+ instance = MoneyKit::AccountNumbersLegacy20230218.new(
18
+ ach: null,
19
+ bacs: null,
20
+ eft: null,
21
+ international: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,28 @@
1
+ # MoneyKit::AccountWithAccountNumbersLegacy20230218
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | MoneyKit&#39;s unique ID for the account. &lt;p&gt;The &#x60;account_id&#x60; is distinct from the institution&#39;s account number. For accounts that may change account numbers from time to time, such as credit cards, MoneyKit attempts to keep the &#x60;account_id&#x60; constant. However, if MoneyKit can&#39;t reconcile the new account data with the old data, the &#x60;account_id&#x60; may change. | |
8
+ | **account_type** | **String** | See &lt;a href&#x3D;/pages/account_types&gt;Account Types&lt;/a&gt; for an explanation of account types. Account types are dot-prefixed with one of &#x60;depository&#x60;, &#x60;investment&#x60;, &#x60;liability&#x60;, or &#x60;other&#x60;; or the value is &#x60;unknown&#x60;. &lt;p&gt;**Balances for &#x60;liability&#x60; accounts are reversed:** negative balances (the amount owed) are reported as positive values. For all other types of accounts, a negative balance indicates the amount owed. | |
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
+ | **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
+ | **balances** | [**AccountBalances**](AccountBalances.md) | | |
12
+ | **numbers** | [**AccountNumbersLegacy20230218**](AccountNumbersLegacy20230218.md) | | |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moneykit'
18
+
19
+ instance = MoneyKit::AccountWithAccountNumbersLegacy20230218.new(
20
+ account_id: acc_6Tef269B6ZArSVpYrxtjBV,
21
+ account_type: depository.checking,
22
+ name: Premier Checking,
23
+ account_mask: 3748,
24
+ balances: null,
25
+ numbers: null
26
+ )
27
+ ```
28
+
data/docs/AccountsApi.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
  | [**get_account**](AccountsApi.md#get_account) | **GET** /links/{id}/accounts/{account_id} | /links/{id}/accounts/{account_id} |
8
- | [**get_account_numbers**](AccountsApi.md#get_account_numbers) | **GET** /links/{id}/accounts/numbers | /links/{id}/accounts/numbers |
8
+ | [**get_account_numbers_legacy20230218**](AccountsApi.md#get_account_numbers_legacy20230218) | **GET** /links/{id}/accounts/numbers | /links/{id}/accounts/numbers |
9
9
  | [**get_accounts**](AccountsApi.md#get_accounts) | **GET** /links/{id}/accounts | /links/{id}/accounts |
10
10
  | [**get_user_accounts**](AccountsApi.md#get_user_accounts) | **GET** /users/{id}/accounts | /users/{id}/accounts |
11
11
 
@@ -30,8 +30,8 @@ MoneyKit.configure do |config|
30
30
  end
31
31
 
32
32
  api_instance = MoneyKit::AccountsApi.new
33
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
34
- account_id = 'acc_6Tef269B6ZArSVpYrxtjBV' # String | The account ID to fetch.
33
+ id = 'id_example' # String | The unique ID for this link.
34
+ account_id = 'account_id_example' # String | The account ID to fetch.
35
35
 
36
36
  begin
37
37
  # /links/{id}/accounts/{account_id}
@@ -81,9 +81,9 @@ end
81
81
  - **Accept**: application/json
82
82
 
83
83
 
84
- ## get_account_numbers
84
+ ## get_account_numbers_legacy20230218
85
85
 
86
- > <GetAccountNumbersResponse> get_account_numbers(id)
86
+ > <GetAccountNumbersResponseLegacy20230218> get_account_numbers_legacy20230218(id)
87
87
 
88
88
  /links/{id}/accounts/numbers
89
89
 
@@ -101,32 +101,32 @@ MoneyKit.configure do |config|
101
101
  end
102
102
 
103
103
  api_instance = MoneyKit::AccountsApi.new
104
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
104
+ id = 'id_example' # String | The unique ID for this link.
105
105
 
106
106
  begin
107
107
  # /links/{id}/accounts/numbers
108
- result = api_instance.get_account_numbers(id)
108
+ result = api_instance.get_account_numbers_legacy20230218(id)
109
109
  p result
110
110
  rescue MoneyKit::ApiError => e
111
- puts "Error when calling AccountsApi->get_account_numbers: #{e}"
111
+ puts "Error when calling AccountsApi->get_account_numbers_legacy20230218: #{e}"
112
112
  end
113
113
  ```
114
114
 
115
- #### Using the get_account_numbers_with_http_info variant
115
+ #### Using the get_account_numbers_legacy20230218_with_http_info variant
116
116
 
117
117
  This returns an Array which contains the response data, status code and headers.
118
118
 
119
- > <Array(<GetAccountNumbersResponse>, Integer, Hash)> get_account_numbers_with_http_info(id)
119
+ > <Array(<GetAccountNumbersResponseLegacy20230218>, Integer, Hash)> get_account_numbers_legacy20230218_with_http_info(id)
120
120
 
121
121
  ```ruby
122
122
  begin
123
123
  # /links/{id}/accounts/numbers
124
- data, status_code, headers = api_instance.get_account_numbers_with_http_info(id)
124
+ data, status_code, headers = api_instance.get_account_numbers_legacy20230218_with_http_info(id)
125
125
  p status_code # => 2xx
126
126
  p headers # => { ... }
127
- p data # => <GetAccountNumbersResponse>
127
+ p data # => <GetAccountNumbersResponseLegacy20230218>
128
128
  rescue MoneyKit::ApiError => e
129
- puts "Error when calling AccountsApi->get_account_numbers_with_http_info: #{e}"
129
+ puts "Error when calling AccountsApi->get_account_numbers_legacy20230218_with_http_info: #{e}"
130
130
  end
131
131
  ```
132
132
 
@@ -138,7 +138,7 @@ end
138
138
 
139
139
  ### Return type
140
140
 
141
- [**GetAccountNumbersResponse**](GetAccountNumbersResponse.md)
141
+ [**GetAccountNumbersResponseLegacy20230218**](GetAccountNumbersResponseLegacy20230218.md)
142
142
 
143
143
  ### Authorization
144
144
 
@@ -170,7 +170,7 @@ MoneyKit.configure do |config|
170
170
  end
171
171
 
172
172
  api_instance = MoneyKit::AccountsApi.new
173
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
173
+ id = 'id_example' # String | The unique ID for this link.
174
174
  opts = {
175
175
  account_ids: ['inner_example'] # Array<String> | An optional list of account IDs to filter the results.
176
176
  }
@@ -243,10 +243,10 @@ MoneyKit.configure do |config|
243
243
  end
244
244
 
245
245
  api_instance = MoneyKit::AccountsApi.new
246
- id = 'MyUser1234' # String | The unique ID for this user. This is the same ID provided in the call to <a href=#operation/create_link_session>/link-session</a> to create any link for this user.
246
+ 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.
247
247
  opts = {
248
- account_id: ['inner_example'], # Array<String> | If present, filters results to accounts matching the given IDs.
249
- institution_id: ['inner_example'] # Array<String> | If present, filters results to accounts at institutions matching the given IDs.
248
+ account_ids: ['inner_example'], # Array<String> | If present, filters results to accounts matching the given IDs.
249
+ institution_ids: ['inner_example'] # Array<String> | If present, filters results to accounts at institutions matching the given IDs.
250
250
  }
251
251
 
252
252
  begin
@@ -281,8 +281,8 @@ end
281
281
  | Name | Type | Description | Notes |
282
282
  | ---- | ---- | ----------- | ----- |
283
283
  | **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. | |
284
- | **account_id** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts matching the given IDs. | [optional] |
285
- | **institution_id** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts at institutions matching the given IDs. | [optional] |
284
+ | **account_ids** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts matching the given IDs. | [optional] |
285
+ | **institution_ids** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts at institutions matching the given IDs. | [optional] |
286
286
 
287
287
  ### Return type
288
288
 
@@ -0,0 +1,26 @@
1
+ # MoneyKit::AppClientResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **client_id** | **String** | The client&#39;s client ID. | |
8
+ | **client_name** | **String** | Friendly client name for identification. | |
9
+ | **scope** | **String** | Actions allowed by this client. | |
10
+ | **app** | [**AppResponse**](AppResponse.md) | | |
11
+ | **disabled_at** | **Time** | Set to timestamp if the client has been disabled. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'moneykit'
17
+
18
+ instance = MoneyKit::AppClientResponse.new(
19
+ client_id: live_5c739a369515e10fc9e0,
20
+ client_name: My App (Prod),
21
+ scope: null,
22
+ app: null,
23
+ disabled_at: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,24 @@
1
+ # MoneyKit::AppResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **app_id** | **String** | Your app&#39;s ID. | |
8
+ | **name** | **String** | Your app&#39;s name. | |
9
+ | **id** | **String** | Your app&#39;s ID. | |
10
+ | **app_name** | **String** | Your app&#39;s name. | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'moneykit'
16
+
17
+ instance = MoneyKit::AppResponse.new(
18
+ app_id: 3d18cdd1-fa96-4423-b781-bd5be036830e,
19
+ name: My App,
20
+ id: 3d18cdd1-fa96-4423-b781-bd5be036830e,
21
+ app_name: My App
22
+ )
23
+ ```
24
+
@@ -6,9 +6,9 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **settings** | [**LinkSessionSettingOverrides**](LinkSessionSettingOverrides.md) | | [optional] |
8
8
  | **customer_user** | [**LinkSessionCustomerUser**](LinkSessionCustomerUser.md) | | |
9
- | **existing_link_id** | **String** | Supply the existing &#x60;link_id&#x60; if you are asking the user to reconnect this link. &lt;p&gt;When reconnecting, if new accounts are discovered they will be presented to the user so permission to access them can be granted (or denied). Access to previously permitted accounts is not revokable at this point. &lt;p&gt;If necessary, MoneyKit may attempt to reconnect the account using a different provider than the link was originally connected through. The change in provider is generally seamless. MoneyKit normalizes incoming data to minimize provider-specific differences, and we deduplicate new transactions, so data continuity is generally assured; however, small discrepancies can still occur. &lt;p&gt;A reconnection cannot change the institution, the customer_user.id, the products, or the country for an existing link. These parameters will be silently ignored if &#x60;existing_link_id&#x60; is supplied. &lt;p&gt;The &#x60;webhook&#x60; for an existing link **can** be changed, and the existing webhook will be **removed** if the &#x60;webhook&#x60; parameter is omitted, so you should supply the &#x60;webhook&#x60; URL if you want to receive webhook events for the reconnected link. &lt;p&gt;Similarly, a reconnected link will be assigned whatever &#x60;link_tags&#x60; are supplied, and existing tags will be removed if &#x60;link_tags&#x60; is omitted, so you should supply the &#x60;link_tags&#x60; you want the link to have, if any. | [optional] |
9
+ | **existing_link_id** | **String** | Supply the existing &#x60;link_id&#x60; if you are asking the user to reconnect or modify this link. &lt;p&gt;When reconnecting, if new accounts are discovered they will be presented to the user so permission to access them can be granted (or denied). Access to previously permitted accounts is not revokable at this point. &lt;p&gt;If necessary, MoneyKit may attempt to reconnect the account using a different provider than the link was originally connected through. The change in provider is generally seamless. MoneyKit normalizes incoming data to minimize provider-specific differences, and we deduplicate new transactions, so data continuity is generally assured; however, small discrepancies can still occur. &lt;p&gt;A reconnection cannot change the institution, the customer_user.id, or the country for an existing link. These parameters will be silently ignored if &#x60;existing_link_id&#x60; is supplied. &lt;p&gt;New products can be added to an existing link. The user will be asked for permission for any added products. Existing product settings, however, cannot be changed and will be silently ignored. &lt;p&gt;The &#x60;webhook&#x60; for an existing link **can** be changed, and the existing webhook will be **removed** if the &#x60;webhook&#x60; parameter is omitted, so you should supply the &#x60;webhook&#x60; URL if you want to receive webhook events for the reconnected link. &lt;p&gt;Similarly, a reconnected link will be assigned whatever &#x60;link_tags&#x60; are supplied, and existing tags will be removed if &#x60;link_tags&#x60; is omitted, so you should supply the &#x60;link_tags&#x60; you want the link to have, if any. | [optional] |
10
10
  | **institution_id** | **String** | The ID of the institution you want to link to. Providing this will skip the institution selection step. This field is ignored if &#x60;existing_link_id&#x60; is provided. | [optional] |
11
- | **redirect_uri** | **String** | For Oauth linking, a URI indicating the destination, in your application, where the user should be sent after authenticating with the institution. The &#x60;redirect_uri&#x60; should not contain any query parameters, and it must be pre-approved by MoneyKit during the customer setup process. | |
11
+ | **redirect_uri** | **String** | For Oauth linking, a URI indicating the destination, in your application, where the user should be sent after authenticating with the institution. The &#x60;redirect_uri&#x60; should not contain any query parameters, and it must be pre-approved by MoneyKit during the app setup process. | |
12
12
  | **webhook** | **String** | The destination URL to which any webhooks should be sent. | [optional] |
13
13
  | **link_tags** | **Array&lt;String&gt;** | | [optional] |
14
14
  | **connect_features** | [**MoneyKitConnectFeatures**](MoneyKitConnectFeatures.md) | | [optional] |
@@ -0,0 +1,20 @@
1
+ # MoneyKit::GetAccountNumbersResponseLegacy20230218
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **accounts** | [**Array&lt;AccountWithAccountNumbersLegacy20230218&gt;**](AccountWithAccountNumbersLegacy20230218.md) | | |
8
+ | **link** | [**LinkCommon**](LinkCommon.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'moneykit'
14
+
15
+ instance = MoneyKit::GetAccountNumbersResponseLegacy20230218.new(
16
+ accounts: null,
17
+ link: null
18
+ )
19
+ ```
20
+
data/docs/IdentityApi.md CHANGED
@@ -27,7 +27,7 @@ MoneyKit.configure do |config|
27
27
  end
28
28
 
29
29
  api_instance = MoneyKit::IdentityApi.new
30
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
30
+ id = 'id_example' # String | The unique ID for this link.
31
31
  opts = {
32
32
  account_ids: ['inner_example'] # Array<String> | An optional list of account IDs to filter the results.
33
33
  }
data/docs/Institution.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **institution_id_aliases** | **Array&lt;String&gt;** | | |
9
9
  | **name** | **String** | The name of the institution. | |
10
10
  | **country** | [**Country**](Country.md) | | |
11
- | **domain** | **String** | The domain of the institution&#39;s customer-facing website. | [optional] |
11
+ | **domain** | **String** | The domain of the institution&#39;s user-facing website. | [optional] |
12
12
  | **color** | **String** | The primary color of this institution, represented as hexcode. | |
13
13
  | **color_dark** | **String** | The dark-mode primary color of this institution, represented as hexcode. | [optional] |
14
14
  | **is_featured** | **Boolean** | True for institutions that should be visually promoted to the end-user. | |
@@ -28,7 +28,7 @@ MoneyKit.configure do |config|
28
28
  end
29
29
 
30
30
  api_instance = MoneyKit::InstitutionsApi.new
31
- institution_id = 'chase' # String | The institution ID to fetch.
31
+ institution_id = 'institution_id_example' # String | The institution ID to fetch.
32
32
 
33
33
  begin
34
34
  # /institutions/{institution_id}
@@ -98,7 +98,7 @@ end
98
98
 
99
99
  api_instance = MoneyKit::InstitutionsApi.new
100
100
  opts = {
101
- name: 'Chase', # String | If provided, returns only institutions containing this name (wholly or as a prefix).
101
+ name: 'name_example', # String | If provided, returns only institutions containing this name (wholly or as a prefix).
102
102
  featured: true, # Boolean | If true, returns only featured institutions.
103
103
  cursor: 'cursor_example', # String | Cursor to fetch the next set of institutions. (You get this value from the previous call to `/institutions`.)
104
104
  limit: 56 # Integer | A limit on the number of institutions to be returned.
@@ -4,14 +4,14 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | The unique ID for this investment transaction. | |
7
+ | **investment_transaction_id** | **String** | The unique ID for this investment transaction. | |
8
8
  | **account_id** | **String** | The ID of the account in which this investment transaction occurred. | |
9
- | **amount** | **String** | The total value of this transaction, denominated in account currency. Positive values indicate debits (deposits); negative values are credits (withdrawals). For example, for a &#x60;buy&#x60; transaction, the amount will be equal to &#x60;-(quantity * price + fees)&#x60;. | |
9
+ | **amount** | **String** | The total value of this transaction, denominated in account currency. Positive values indicate debits (withdrawals); negative values are credits (deposits). When a transaction has both quantity and price, the amount should be equal to &#x60;quantity * price + fees&#x60;. | |
10
10
  | **date** | **Date** | The effective (posted) date of the transaction, in ISO-8601 format. | |
11
11
  | **datetime** | **Time** | If the institution has provided the actual time of the transaction, this field contains the full date and time of the transaction, in ISO-8601 format. If the time is not available, this field will be null. &lt;p&gt;Note that the time is generally reported in the timezone of the institution or the account holder. | [optional] |
12
12
  | **description** | **String** | A normalized, cleaned transaction description suitable for presentation to the end user. | |
13
13
  | **type** | **String** | The type of transaction (buy, sell, cash, fee, transfer). May include a dotted subtype, for example, &#x60;buy.buy_to_cover&#x60; or &#x60;fee.transfer_fee&#x60;. | |
14
- | **fees** | **String** | The combined value of any fees applied to the transaction. Fees are subtracted from the total transaction amount, and are reported as positive values; refunds are reported as negative values. | [optional] |
14
+ | **fees** | **String** | The combined value of any fees applied to the transaction. Fees are reported as positive values; refunds are reported as negative values. | [optional] |
15
15
  | **forex_rate** | **String** | The currency exchange rate applied. Only present for transactions involving a security that is denominated in a currency other than the account currency. | [optional] |
16
16
  | **price** | **String** | The price per share, denominated in account currency. Omitted for transactions not involving a security. | [optional] |
17
17
  | **quantity** | **String** | The units of security (aka \&quot;shares\&quot;) bought, sold, or transferred. Omitted for transactions not involving a security. Positive values indicate shares added to the account. | [optional] |
@@ -23,7 +23,7 @@
23
23
  require 'moneykit'
24
24
 
25
25
  instance = MoneyKit::InvestmentTransactionResponse.new(
26
- id: it_R73abx78zoa2NxyAlki90g,
26
+ investment_transaction_id: it_R73abx78zoa2NxyAlki90g,
27
27
  account_id: acc_6Tef269B6ZArSVpYrxtjBV,
28
28
  amount: 987.15,
29
29
  date: 2023-02-16T00:00:00,
@@ -28,7 +28,7 @@ MoneyKit.configure do |config|
28
28
  end
29
29
 
30
30
  api_instance = MoneyKit::InvestmentsApi.new
31
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
31
+ id = 'id_example' # String | The unique ID for this link.
32
32
  opts = {
33
33
  account_ids: ['inner_example'] # Array<String> | An optional list of account IDs to filter the results.
34
34
  }
@@ -101,7 +101,7 @@ MoneyKit.configure do |config|
101
101
  end
102
102
 
103
103
  api_instance = MoneyKit::InvestmentsApi.new
104
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
104
+ id = 'id_example' # String | The unique ID for this link.
105
105
  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.
@@ -0,0 +1,28 @@
1
+ # MoneyKit::LinkProduct
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **refreshed_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was updated. | [optional] |
8
+ | **last_attempted_at** | **Time** | An ISO-8601 timestamp indicating the last time that the product was attempted. | [optional] |
9
+ | **error_code** | [**LinkProductFailureReasons**](LinkProductFailureReasons.md) | | [optional] |
10
+ | **error_message** | **String** | The error message, if the last attempt to refresh the product failed. | [optional] |
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** | [**ProductSettings**](ProductSettings.md) | | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'moneykit'
18
+
19
+ instance = MoneyKit::LinkProduct.new(
20
+ refreshed_at: 2023-02-16T09:14:11,
21
+ last_attempted_at: 2023-02-16T09:14:11,
22
+ error_code: null,
23
+ error_message: null,
24
+ unavailable: null,
25
+ settings: null
26
+ )
27
+ ```
28
+
data/docs/LinkProducts.md CHANGED
@@ -4,11 +4,11 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **accounts** | [**AccountsLinkProduct**](AccountsLinkProduct.md) | | [optional] |
8
- | **account_numbers** | [**AccountNumbersLinkProduct**](AccountNumbersLinkProduct.md) | | [optional] |
9
- | **identity** | [**IdentityLinkProduct**](IdentityLinkProduct.md) | | [optional] |
7
+ | **accounts** | [**LinkProduct**](LinkProduct.md) | | [optional] |
8
+ | **account_numbers** | [**LinkProduct**](LinkProduct.md) | | [optional] |
9
+ | **identity** | [**LinkProduct**](LinkProduct.md) | | [optional] |
10
10
  | **transactions** | [**TransactionsLinkProduct**](TransactionsLinkProduct.md) | | [optional] |
11
- | **investments** | [**InvestmentsLinkProduct**](InvestmentsLinkProduct.md) | | [optional] |
11
+ | **investments** | [**LinkProduct**](LinkProduct.md) | | [optional] |
12
12
 
13
13
  ## Example
14
14
 
data/docs/LinksApi.md CHANGED
@@ -31,7 +31,7 @@ MoneyKit.configure do |config|
31
31
  end
32
32
 
33
33
  api_instance = MoneyKit::LinksApi.new
34
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
34
+ id = 'id_example' # String | The unique ID for this link.
35
35
 
36
36
  begin
37
37
  # /links/{id}
@@ -99,7 +99,7 @@ MoneyKit.configure do |config|
99
99
  end
100
100
 
101
101
  api_instance = MoneyKit::LinksApi.new
102
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
102
+ id = 'id_example' # String | The unique ID for this link.
103
103
 
104
104
  begin
105
105
  # /links/{id}
@@ -168,7 +168,7 @@ MoneyKit.configure do |config|
168
168
  end
169
169
 
170
170
  api_instance = MoneyKit::LinksApi.new
171
- 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.
171
+ 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.
172
172
 
173
173
  begin
174
174
  # /users/{id}/links
@@ -235,7 +235,7 @@ MoneyKit.configure do |config|
235
235
  end
236
236
 
237
237
  api_instance = MoneyKit::LinksApi.new
238
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
238
+ id = 'id_example' # String | The unique ID for this link.
239
239
 
240
240
  begin
241
241
  # Force a \"relink required\" state on a link (Test only).
@@ -304,7 +304,7 @@ MoneyKit.configure do |config|
304
304
  end
305
305
 
306
306
  api_instance = MoneyKit::LinksApi.new
307
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
307
+ id = 'id_example' # String | The unique ID for this link.
308
308
  update_link_request = MoneyKit::UpdateLinkRequest.new # UpdateLinkRequest |
309
309
 
310
310
  begin
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **issue_reporter** | **Boolean** | If enabled, the user can report linking issues directly to MoneyKit via &#39;Report Issue&#39; 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
+ | **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] |
9
10
 
10
11
  ## Example
11
12
 
@@ -14,7 +15,8 @@ require 'moneykit'
14
15
 
15
16
  instance = MoneyKit::MoneyKitConnectFeatures.new(
16
17
  issue_reporter: null,
17
- enable_money_id: null
18
+ enable_money_id: null,
19
+ duplicate_institution_warning: null
18
20
  )
19
21
  ```
20
22
 
@@ -0,0 +1,24 @@
1
+ # MoneyKit::ProductSettings
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
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] |
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] |
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] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'moneykit'
16
+
17
+ instance = MoneyKit::ProductSettings.new(
18
+ required: null,
19
+ require_permission: null,
20
+ prefetch: null,
21
+ reason: display your account balances
22
+ )
23
+ ```
24
+
data/docs/ProductsApi.md CHANGED
@@ -27,7 +27,7 @@ MoneyKit.configure do |config|
27
27
  end
28
28
 
29
29
  api_instance = MoneyKit::ProductsApi.new
30
- id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
30
+ id = 'id_example' # String | The unique ID for this link.
31
31
  refresh_products_request = MoneyKit::RefreshProductsRequest.new({products: [MoneyKit::Product::ACCOUNTS]}) # RefreshProductsRequest |
32
32
 
33
33
  begin