moneykit 0.1.2 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (204) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +1 -1
  4. data/docs/AccessTokenApi.md +10 -22
  5. data/docs/AccountNumbersApi.md +4 -8
  6. data/docs/AccountNumbersLinkProduct.md +4 -0
  7. data/docs/AccountNumbersProductSettings.md +1 -3
  8. data/docs/AccountsApi.md +10 -22
  9. data/docs/AccountsLinkProduct.md +5 -1
  10. data/docs/Body.md +1 -1
  11. data/docs/GetHoldingsResponse.md +24 -0
  12. data/docs/GetInvestmentTransactionsResponse.md +30 -0
  13. data/docs/HoldingResponse.md +30 -0
  14. data/docs/IdentityApi.md +1 -3
  15. data/docs/IdentityLinkProduct.md +4 -0
  16. data/docs/IdentityProductSettings.md +1 -3
  17. data/docs/InstitutionsApi.md +5 -11
  18. data/docs/InvestmentTransactionResponse.md +40 -0
  19. data/docs/InvestmentsApi.md +163 -0
  20. data/docs/InvestmentsLinkProduct.md +26 -0
  21. data/docs/InvestmentsProductSettings.md +1 -3
  22. data/docs/LinkCommon.md +1 -1
  23. data/docs/LinkError.md +15 -0
  24. data/docs/LinkProductFailureReasons.md +15 -0
  25. data/docs/LinkProducts.md +3 -1
  26. data/docs/LinkResponse.md +1 -1
  27. data/docs/LinkSessionApi.md +8 -16
  28. data/docs/LinkStateChangedWebhook.md +1 -1
  29. data/docs/LinksApi.md +20 -40
  30. data/docs/MoneyKitConnectFeatures.md +1 -1
  31. data/docs/ProductsApi.md +4 -8
  32. data/docs/Response401GetHoldingsLinksIdInvestmentsHoldingsGet.md +22 -0
  33. data/docs/Response401GetInvestmentTransactionsLinksIdInvestmentsTransactionsGet.md +22 -0
  34. data/docs/Response401GetTransactions.md +22 -0
  35. data/docs/Response401GetUserTransactions.md +22 -0
  36. data/docs/ResponseHandleLinkWebhookEventRequestBodyWebhookPost.md +1 -1
  37. data/docs/SecurityResponse.md +34 -0
  38. data/docs/TransactionSyncResponse.md +1 -1
  39. data/docs/TransactionsApi.md +5 -11
  40. data/docs/TransactionsLinkProduct.md +4 -0
  41. data/docs/TransactionsProductSettings.md +0 -2
  42. data/docs/UsersApi.md +6 -14
  43. data/docs/WebhooksApi.md +4 -8
  44. data/lib/moneykit/api/access_token_api.rb +1 -10
  45. data/lib/moneykit/api/account_numbers_api.rb +1 -4
  46. data/lib/moneykit/api/accounts_api.rb +1 -13
  47. data/lib/moneykit/api/identity_api.rb +1 -4
  48. data/lib/moneykit/api/institutions_api.rb +1 -7
  49. data/lib/moneykit/api/investments_api.rb +178 -0
  50. data/lib/moneykit/api/link_session_api.rb +1 -7
  51. data/lib/moneykit/api/links_api.rb +1 -16
  52. data/lib/moneykit/api/products_api.rb +1 -4
  53. data/lib/moneykit/api/transactions_api.rb +5 -14
  54. data/lib/moneykit/api/users_api.rb +1 -10
  55. data/lib/moneykit/api/webhooks_api.rb +1 -4
  56. data/lib/moneykit/api_client.rb +1 -1
  57. data/lib/moneykit/api_error.rb +1 -1
  58. data/lib/moneykit/configuration.rb +1 -1
  59. data/lib/moneykit/models/account.rb +1 -1
  60. data/lib/moneykit/models/account_balances.rb +1 -1
  61. data/lib/moneykit/models/account_group.rb +1 -1
  62. data/lib/moneykit/models/account_identity.rb +1 -1
  63. data/lib/moneykit/models/account_numbers.rb +1 -1
  64. data/lib/moneykit/models/account_numbers_link_product.rb +43 -2
  65. data/lib/moneykit/models/account_numbers_product_settings.rb +5 -36
  66. data/lib/moneykit/models/account_with_account_numbers.rb +1 -1
  67. data/lib/moneykit/models/accounts_link_product.rb +46 -5
  68. data/lib/moneykit/models/ach_number.rb +1 -1
  69. data/lib/moneykit/models/address.rb +1 -1
  70. data/lib/moneykit/models/api_error_auth_expired_access_token_response.rb +1 -1
  71. data/lib/moneykit/models/api_error_auth_unauthorized_response.rb +1 -1
  72. data/lib/moneykit/models/api_error_rate_limit_exceeded_response.rb +1 -1
  73. data/lib/moneykit/models/bacs_number.rb +1 -1
  74. data/lib/moneykit/models/basic_account_details.rb +1 -1
  75. data/lib/moneykit/models/body.rb +1 -1
  76. data/lib/moneykit/models/country.rb +1 -1
  77. data/lib/moneykit/models/create_link_session_request.rb +1 -1
  78. data/lib/moneykit/models/create_link_session_response.rb +1 -1
  79. data/lib/moneykit/models/currency.rb +1 -1
  80. data/lib/moneykit/models/cursor_pagination.rb +1 -1
  81. data/lib/moneykit/models/customer_app.rb +1 -1
  82. data/lib/moneykit/models/eft_number.rb +1 -1
  83. data/lib/moneykit/models/email.rb +1 -1
  84. data/lib/moneykit/models/exchange_token_request.rb +1 -1
  85. data/lib/moneykit/models/exchange_token_response.rb +1 -1
  86. data/lib/moneykit/models/generate_access_token_response.rb +1 -1
  87. data/lib/moneykit/models/get_account_numbers_response.rb +1 -1
  88. data/lib/moneykit/models/get_account_response.rb +1 -1
  89. data/lib/moneykit/models/get_accounts_response.rb +1 -1
  90. data/lib/moneykit/models/get_holdings_response.rb +273 -0
  91. data/lib/moneykit/models/get_institutions_response.rb +1 -1
  92. data/lib/moneykit/models/get_investment_transactions_response.rb +324 -0
  93. data/lib/moneykit/models/get_transactions_response.rb +1 -1
  94. data/lib/moneykit/models/get_user_accounts_response.rb +1 -1
  95. data/lib/moneykit/models/get_user_links_response.rb +1 -1
  96. data/lib/moneykit/models/get_user_transactions_response.rb +1 -1
  97. data/lib/moneykit/models/holding_response.rb +294 -0
  98. data/lib/moneykit/models/http_validation_error.rb +1 -1
  99. data/lib/moneykit/models/identity_link_product.rb +43 -2
  100. data/lib/moneykit/models/identity_product_settings.rb +5 -36
  101. data/lib/moneykit/models/identity_response.rb +1 -1
  102. data/lib/moneykit/models/institution.rb +1 -1
  103. data/lib/moneykit/models/institution_error_not_found_response.rb +1 -1
  104. data/lib/moneykit/models/international_number.rb +1 -1
  105. data/lib/moneykit/models/introspect_client_response.rb +1 -1
  106. data/lib/moneykit/models/investment_transaction_response.rb +365 -0
  107. data/lib/moneykit/models/investments_link_product.rb +280 -0
  108. data/lib/moneykit/models/investments_product_settings.rb +5 -36
  109. data/lib/moneykit/models/jwk_set.rb +1 -1
  110. data/lib/moneykit/models/link_common.rb +2 -2
  111. data/lib/moneykit/models/link_error.rb +44 -0
  112. data/lib/moneykit/models/link_error_bad_config_response.rb +1 -1
  113. data/lib/moneykit/models/link_error_bad_state_response.rb +1 -1
  114. data/lib/moneykit/models/link_error_deleted_response.rb +1 -1
  115. data/lib/moneykit/models/link_error_forbidden_action_response.rb +1 -1
  116. data/lib/moneykit/models/link_error_not_found_response.rb +1 -1
  117. data/lib/moneykit/models/link_error_unauthorized_access_response.rb +1 -1
  118. data/lib/moneykit/models/link_permission_scope.rb +1 -1
  119. data/lib/moneykit/models/link_permissions.rb +1 -1
  120. data/lib/moneykit/models/link_product_failure_reasons.rb +44 -0
  121. data/lib/moneykit/models/link_product_refresh_webhook.rb +1 -1
  122. data/lib/moneykit/models/link_product_state.rb +1 -1
  123. data/lib/moneykit/models/link_products.rb +14 -5
  124. data/lib/moneykit/models/link_response.rb +2 -2
  125. data/lib/moneykit/models/link_session_customer_user.rb +1 -1
  126. data/lib/moneykit/models/link_session_customer_user_email.rb +1 -1
  127. data/lib/moneykit/models/link_session_customer_user_phone.rb +1 -1
  128. data/lib/moneykit/models/link_session_error_forbidden_config_response.rb +1 -1
  129. data/lib/moneykit/models/link_session_error_invalid_token_exchange.rb +1 -1
  130. data/lib/moneykit/models/link_session_setting_overrides.rb +1 -1
  131. data/lib/moneykit/models/link_state.rb +1 -1
  132. data/lib/moneykit/models/link_state_changed_webhook.rb +2 -2
  133. data/lib/moneykit/models/money_kit_connect_features.rb +2 -2
  134. data/lib/moneykit/models/owner.rb +1 -1
  135. data/lib/moneykit/models/phone_number.rb +1 -1
  136. data/lib/moneykit/models/phone_number_type.rb +1 -1
  137. data/lib/moneykit/models/product.rb +1 -1
  138. data/lib/moneykit/models/products_settings.rb +1 -1
  139. data/lib/moneykit/models/provider.rb +1 -1
  140. data/lib/moneykit/models/refresh_products_request.rb +1 -1
  141. data/lib/moneykit/models/requested_link_permission.rb +1 -1
  142. data/lib/moneykit/models/response401_disconnect_links_id_delete.rb +1 -1
  143. data/lib/moneykit/models/response401_exchange_token_link_session_exchange_token_post.rb +1 -1
  144. data/lib/moneykit/models/response401_get_account_links_id_accounts_account_id_get.rb +1 -1
  145. data/lib/moneykit/models/response401_get_account_numbers_links_id_accounts_numbers_get.rb +1 -1
  146. data/lib/moneykit/models/response401_get_accounts_links_id_accounts_get.rb +1 -1
  147. data/lib/moneykit/models/response401_get_holdings_links_id_investments_holdings_get.rb +104 -0
  148. data/lib/moneykit/models/response401_get_identities_links_id_identity_get.rb +1 -1
  149. data/lib/moneykit/models/response401_get_institution_institutions_institution_id_get.rb +1 -1
  150. data/lib/moneykit/models/response401_get_institutions_institutions_get.rb +1 -1
  151. data/lib/moneykit/models/response401_get_investment_transactions_links_id_investments_transactions_get.rb +104 -0
  152. data/lib/moneykit/models/response401_get_link_links_id_get.rb +1 -1
  153. data/lib/moneykit/models/response401_get_transactions.rb +104 -0
  154. data/lib/moneykit/models/response401_get_transactions_diff_links_id_transactions_sync_get.rb +1 -1
  155. data/lib/moneykit/models/response401_get_user_accounts_users_id_accounts_get.rb +1 -1
  156. data/lib/moneykit/models/response401_get_user_links_users_id_links_get.rb +1 -1
  157. data/lib/moneykit/models/response401_get_user_transactions.rb +103 -0
  158. data/lib/moneykit/models/response401_get_well_known_jwks_well_known_jwks_json_get.rb +1 -1
  159. data/lib/moneykit/models/response401_instrospect_client_auth_introspect_get.rb +1 -1
  160. data/lib/moneykit/models/response401_refresh_products_links_id_products_post.rb +1 -1
  161. data/lib/moneykit/models/response401_reset_login_links_id_reset_post.rb +1 -1
  162. data/lib/moneykit/models/response401_trigger_test_link_webhook_event_webhooks_test_link_id_post.rb +1 -1
  163. data/lib/moneykit/models/response401_update_link_links_id_patch.rb +1 -1
  164. data/lib/moneykit/models/response_handle_link_webhook_event_request_body_webhook_post.rb +1 -1
  165. data/lib/moneykit/models/security_response.rb +321 -0
  166. data/lib/moneykit/models/transaction.rb +1 -1
  167. data/lib/moneykit/models/transaction_diff.rb +1 -1
  168. data/lib/moneykit/models/transaction_sync_response.rb +2 -2
  169. data/lib/moneykit/models/transaction_type.rb +1 -1
  170. data/lib/moneykit/models/transaction_type_filter.rb +1 -1
  171. data/lib/moneykit/models/transaction_updates_available_webhook.rb +1 -1
  172. data/lib/moneykit/models/transactions_link_product.rb +43 -2
  173. data/lib/moneykit/models/transactions_product_settings.rb +2 -33
  174. data/lib/moneykit/models/update_link_request.rb +1 -1
  175. data/lib/moneykit/models/validation_error.rb +1 -1
  176. data/lib/moneykit/models/validation_error_location_inner.rb +1 -1
  177. data/lib/moneykit/models/webhook_link_test_event.rb +1 -1
  178. data/lib/moneykit/models/webhook_test_link_request.rb +1 -1
  179. data/lib/moneykit/models/webhook_test_link_response.rb +1 -1
  180. data/lib/moneykit/version.rb +2 -2
  181. data/lib/moneykit.rb +14 -4
  182. data/moneykit.gemspec +1 -1
  183. data/spec/api/investments_api_spec.rb +65 -0
  184. data/spec/api_client_spec.rb +1 -1
  185. data/spec/configuration_spec.rb +1 -1
  186. data/spec/models/get_holdings_response_spec.rb +54 -0
  187. data/spec/models/get_investment_transactions_response_spec.rb +72 -0
  188. data/spec/models/holding_response_spec.rb +72 -0
  189. data/spec/models/investment_transaction_response_spec.rb +102 -0
  190. data/spec/models/investments_link_product_spec.rb +60 -0
  191. data/spec/models/link_error_spec.rb +30 -0
  192. data/spec/models/link_product_failure_reasons_spec.rb +30 -0
  193. data/spec/models/response401_get_holdings_links_id_investments_holdings_get_spec.rb +21 -0
  194. data/spec/models/response401_get_investment_transactions_links_id_investments_transactions_get_spec.rb +21 -0
  195. data/spec/models/response401_get_transactions_spec.rb +21 -0
  196. data/spec/models/response401_get_user_transactions_spec.rb +21 -0
  197. data/spec/models/security_response_spec.rb +84 -0
  198. data/spec/spec_helper.rb +1 -1
  199. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
  200. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  201. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.1.1/gem_make.out +5 -5
  202. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.3/gem_make.out +5 -5
  203. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.1.0/gem_make.out +5 -5
  204. metadata +54 -2
@@ -0,0 +1,163 @@
1
+ # MoneyKit::InvestmentsApi
2
+
3
+ All URIs are relative to *https://api.moneykit.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_holdings**](InvestmentsApi.md#get_holdings) | **GET** /links/{id}/investments/holdings | /links/{id}/investments/holdings |
8
+ | [**get_investment_transactions**](InvestmentsApi.md#get_investment_transactions) | **GET** /links/{id}/investments/transactions | /links/{id}/investments/transactions |
9
+
10
+
11
+ ## get_holdings
12
+
13
+ > <GetHoldingsResponse> get_holdings(id, opts)
14
+
15
+ /links/{id}/investments/holdings
16
+
17
+ Returns holdings for the investment accounts associated with a <a href=#tag/Links>link</a>. <p>**Note** that this endpoint does **not** trigger a fetch of holdings from the institution; it merely returns holdings that have already been fetched. **To force a check for new/updated owner information, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.
18
+
19
+ ### Examples
20
+
21
+ ```ruby
22
+ require 'time'
23
+ require 'moneykit'
24
+ # setup authorization
25
+ MoneyKit.configure do |config|
26
+ # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
27
+ config.access_token = 'YOUR ACCESS TOKEN'
28
+ end
29
+
30
+ api_instance = MoneyKit::InvestmentsApi.new
31
+ id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
32
+ opts = {
33
+ account_ids: ['inner_example'] # Array<String> | An optional list of account IDs to filter the results.
34
+ }
35
+
36
+ begin
37
+ # /links/{id}/investments/holdings
38
+ result = api_instance.get_holdings(id, opts)
39
+ p result
40
+ rescue MoneyKit::ApiError => e
41
+ puts "Error when calling InvestmentsApi->get_holdings: #{e}"
42
+ end
43
+ ```
44
+
45
+ #### Using the get_holdings_with_http_info variant
46
+
47
+ This returns an Array which contains the response data, status code and headers.
48
+
49
+ > <Array(<GetHoldingsResponse>, Integer, Hash)> get_holdings_with_http_info(id, opts)
50
+
51
+ ```ruby
52
+ begin
53
+ # /links/{id}/investments/holdings
54
+ data, status_code, headers = api_instance.get_holdings_with_http_info(id, opts)
55
+ p status_code # => 2xx
56
+ p headers # => { ... }
57
+ p data # => <GetHoldingsResponse>
58
+ rescue MoneyKit::ApiError => e
59
+ puts "Error when calling InvestmentsApi->get_holdings_with_http_info: #{e}"
60
+ end
61
+ ```
62
+
63
+ ### Parameters
64
+
65
+ | Name | Type | Description | Notes |
66
+ | ---- | ---- | ----------- | ----- |
67
+ | **id** | **String** | The unique ID for this link. | |
68
+ | **account_ids** | [**Array&lt;String&gt;**](String.md) | An optional list of account IDs to filter the results. | [optional] |
69
+
70
+ ### Return type
71
+
72
+ [**GetHoldingsResponse**](GetHoldingsResponse.md)
73
+
74
+ ### Authorization
75
+
76
+ [OAuth2ClientCredentials](../README.md#OAuth2ClientCredentials)
77
+
78
+ ### HTTP request headers
79
+
80
+ - **Content-Type**: Not defined
81
+ - **Accept**: application/json
82
+
83
+
84
+ ## get_investment_transactions
85
+
86
+ > <GetInvestmentTransactionsResponse> get_investment_transactions(id, opts)
87
+
88
+ /links/{id}/investments/transactions
89
+
90
+ Returns investment transactions for the accounts associated with a <a href=#tag/Links>link</a>. Results are paginated, and returned in reverse chronological order. <p>**Note** that this endpoint does **not** trigger a fetch of transactions from the institution; it merely returns transactions that have already been fetched. **To force a check for new/updated owner information, you must use the <a href=#operation/refresh_products>/products</a> endpoint.** <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can get from any previous response for this or any other account or link request. If the refreshed_at date has not increased, then updated data is not yet available.
91
+
92
+ ### Examples
93
+
94
+ ```ruby
95
+ require 'time'
96
+ require 'moneykit'
97
+ # setup authorization
98
+ MoneyKit.configure do |config|
99
+ # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
100
+ config.access_token = 'YOUR ACCESS TOKEN'
101
+ end
102
+
103
+ api_instance = MoneyKit::InvestmentsApi.new
104
+ id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
105
+ opts = {
106
+ account_ids: ['inner_example'], # Array<String> | An optional list of account IDs to filter the results.
107
+ page: 56, # Integer | The page number to return.
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. Defaults to 90 days before the `end_date`. <p>If you want to retrieve **all** transactions, use `1900-01-01`.
110
+ end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today.
111
+ }
112
+
113
+ begin
114
+ # /links/{id}/investments/transactions
115
+ result = api_instance.get_investment_transactions(id, opts)
116
+ p result
117
+ rescue MoneyKit::ApiError => e
118
+ puts "Error when calling InvestmentsApi->get_investment_transactions: #{e}"
119
+ end
120
+ ```
121
+
122
+ #### Using the get_investment_transactions_with_http_info variant
123
+
124
+ This returns an Array which contains the response data, status code and headers.
125
+
126
+ > <Array(<GetInvestmentTransactionsResponse>, Integer, Hash)> get_investment_transactions_with_http_info(id, opts)
127
+
128
+ ```ruby
129
+ begin
130
+ # /links/{id}/investments/transactions
131
+ data, status_code, headers = api_instance.get_investment_transactions_with_http_info(id, opts)
132
+ p status_code # => 2xx
133
+ p headers # => { ... }
134
+ p data # => <GetInvestmentTransactionsResponse>
135
+ rescue MoneyKit::ApiError => e
136
+ puts "Error when calling InvestmentsApi->get_investment_transactions_with_http_info: #{e}"
137
+ end
138
+ ```
139
+
140
+ ### Parameters
141
+
142
+ | Name | Type | Description | Notes |
143
+ | ---- | ---- | ----------- | ----- |
144
+ | **id** | **String** | The unique ID for this link. | |
145
+ | **account_ids** | [**Array&lt;String&gt;**](String.md) | An optional list of account IDs to filter the results. | [optional] |
146
+ | **page** | **Integer** | The page number to return. | [optional][default to 1] |
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. Defaults to 90 days before the &#x60;end_date&#x60;. &lt;p&gt;If you want to retrieve **all** transactions, use &#x60;1900-01-01&#x60;. | [optional] |
149
+ | **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD. Defaults to today. | [optional] |
150
+
151
+ ### Return type
152
+
153
+ [**GetInvestmentTransactionsResponse**](GetInvestmentTransactionsResponse.md)
154
+
155
+ ### Authorization
156
+
157
+ [OAuth2ClientCredentials](../README.md#OAuth2ClientCredentials)
158
+
159
+ ### HTTP request headers
160
+
161
+ - **Content-Type**: Not defined
162
+ - **Accept**: application/json
163
+
@@ -0,0 +1,26 @@
1
+ # MoneyKit::InvestmentsLinkProduct
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
+ | **settings** | [**InvestmentsProductSettings**](InvestmentsProductSettings.md) | | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'moneykit'
17
+
18
+ instance = MoneyKit::InvestmentsLinkProduct.new(
19
+ refreshed_at: 2023-02-16T09:14:11,
20
+ last_attempted_at: 2023-02-16T09:14:11,
21
+ error_code: null,
22
+ error_message: null,
23
+ settings: null
24
+ )
25
+ ```
26
+
@@ -6,7 +6,6 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **required** | **Boolean** | If true, only institutions supporting this product will be available. | [optional][default to false] |
8
8
  | **prefetch** | **Boolean** | If true, the data will be available as soon as possible after linking, even if &#x60;required&#x60; is false. If false, the data will be available after the first manual data refresh. | [optional][default to false] |
9
- | **product** | [**Product**](Product.md) | | [optional] |
10
9
 
11
10
  ## Example
12
11
 
@@ -15,8 +14,7 @@ require 'moneykit'
15
14
 
16
15
  instance = MoneyKit::InvestmentsProductSettings.new(
17
16
  required: null,
18
- prefetch: null,
19
- product: null
17
+ prefetch: null
20
18
  )
21
19
  ```
22
20
 
data/docs/LinkCommon.md CHANGED
@@ -9,7 +9,7 @@
9
9
  | **institution_name** | **String** | The institution name this link is connected to. | |
10
10
  | **institution_avatar** | **String** | An avatar image for the link&#39;s institution. | |
11
11
  | **state** | [**LinkState**](LinkState.md) | | |
12
- | **error_code** | [**PublicLinkError**](PublicLinkError.md) | | [optional] |
12
+ | **error_code** | [**LinkError**](LinkError.md) | | [optional] |
13
13
  | **last_synced_at** | **Time** | An ISO-8601 timestamp indicating the last time that the account was updated. | [optional] |
14
14
  | **tags** | **Array&lt;String&gt;** | | [optional] |
15
15
  | **products** | [**LinkProducts**](LinkProducts.md) | | |
data/docs/LinkError.md ADDED
@@ -0,0 +1,15 @@
1
+ # MoneyKit::LinkError
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'moneykit'
12
+
13
+ instance = MoneyKit::LinkError.new()
14
+ ```
15
+
@@ -0,0 +1,15 @@
1
+ # MoneyKit::LinkProductFailureReasons
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'moneykit'
12
+
13
+ instance = MoneyKit::LinkProductFailureReasons.new()
14
+ ```
15
+
data/docs/LinkProducts.md CHANGED
@@ -8,6 +8,7 @@
8
8
  | **account_numbers** | [**AccountNumbersLinkProduct**](AccountNumbersLinkProduct.md) | | [optional] |
9
9
  | **identity** | [**IdentityLinkProduct**](IdentityLinkProduct.md) | | [optional] |
10
10
  | **transactions** | [**TransactionsLinkProduct**](TransactionsLinkProduct.md) | | [optional] |
11
+ | **investments** | [**InvestmentsLinkProduct**](InvestmentsLinkProduct.md) | | [optional] |
11
12
 
12
13
  ## Example
13
14
 
@@ -18,7 +19,8 @@ instance = MoneyKit::LinkProducts.new(
18
19
  accounts: null,
19
20
  account_numbers: null,
20
21
  identity: null,
21
- transactions: null
22
+ transactions: null,
23
+ investments: null
22
24
  )
23
25
  ```
24
26
 
data/docs/LinkResponse.md CHANGED
@@ -9,7 +9,7 @@
9
9
  | **institution_name** | **String** | The institution name this link is connected to. | |
10
10
  | **institution_avatar** | **String** | An avatar image for the link&#39;s institution. | |
11
11
  | **state** | [**LinkState**](LinkState.md) | | |
12
- | **error_code** | [**PublicLinkError**](PublicLinkError.md) | | [optional] |
12
+ | **error_code** | [**LinkError**](LinkError.md) | | [optional] |
13
13
  | **last_synced_at** | **Time** | An ISO-8601 timestamp indicating the last time that the account was updated. | [optional] |
14
14
  | **tags** | **Array&lt;String&gt;** | | [optional] |
15
15
  | **products** | [**LinkProducts**](LinkProducts.md) | | |
@@ -10,7 +10,7 @@ All URIs are relative to *https://api.moneykit.com*
10
10
 
11
11
  ## create_link_session
12
12
 
13
- > <CreateLinkSessionResponse> create_link_session(create_link_session_request, opts)
13
+ > <CreateLinkSessionResponse> create_link_session(create_link_session_request)
14
14
 
15
15
  /link-session
16
16
 
@@ -29,13 +29,10 @@ end
29
29
 
30
30
  api_instance = MoneyKit::LinkSessionApi.new
31
31
  create_link_session_request = MoneyKit::CreateLinkSessionRequest.new({customer_user: MoneyKit::LinkSessionCustomerUser.new({id: 'id_example'}), redirect_uri: 'https://yourdomain.com/oauth.html'}) # CreateLinkSessionRequest |
32
- opts = {
33
- moneykit_version: 'moneykit_version_example' # String |
34
- }
35
32
 
36
33
  begin
37
34
  # /link-session
38
- result = api_instance.create_link_session(create_link_session_request, opts)
35
+ result = api_instance.create_link_session(create_link_session_request)
39
36
  p result
40
37
  rescue MoneyKit::ApiError => e
41
38
  puts "Error when calling LinkSessionApi->create_link_session: #{e}"
@@ -46,12 +43,12 @@ end
46
43
 
47
44
  This returns an Array which contains the response data, status code and headers.
48
45
 
49
- > <Array(<CreateLinkSessionResponse>, Integer, Hash)> create_link_session_with_http_info(create_link_session_request, opts)
46
+ > <Array(<CreateLinkSessionResponse>, Integer, Hash)> create_link_session_with_http_info(create_link_session_request)
50
47
 
51
48
  ```ruby
52
49
  begin
53
50
  # /link-session
54
- data, status_code, headers = api_instance.create_link_session_with_http_info(create_link_session_request, opts)
51
+ data, status_code, headers = api_instance.create_link_session_with_http_info(create_link_session_request)
55
52
  p status_code # => 2xx
56
53
  p headers # => { ... }
57
54
  p data # => <CreateLinkSessionResponse>
@@ -65,7 +62,6 @@ end
65
62
  | Name | Type | Description | Notes |
66
63
  | ---- | ---- | ----------- | ----- |
67
64
  | **create_link_session_request** | [**CreateLinkSessionRequest**](CreateLinkSessionRequest.md) | | |
68
- | **moneykit_version** | **String** | | [optional][default to &#39;2023-02-18&#39;] |
69
65
 
70
66
  ### Return type
71
67
 
@@ -83,7 +79,7 @@ end
83
79
 
84
80
  ## exchange_token
85
81
 
86
- > <ExchangeTokenResponse> exchange_token(exchange_token_request, opts)
82
+ > <ExchangeTokenResponse> exchange_token(exchange_token_request)
87
83
 
88
84
  /link-session/exchange-token
89
85
 
@@ -102,13 +98,10 @@ end
102
98
 
103
99
  api_instance = MoneyKit::LinkSessionApi.new
104
100
  exchange_token_request = MoneyKit::ExchangeTokenRequest.new({exchangeable_token: 'c7318ff7-257c-490e-8242-03a815b223b7'}) # ExchangeTokenRequest |
105
- opts = {
106
- moneykit_version: 'moneykit_version_example' # String |
107
- }
108
101
 
109
102
  begin
110
103
  # /link-session/exchange-token
111
- result = api_instance.exchange_token(exchange_token_request, opts)
104
+ result = api_instance.exchange_token(exchange_token_request)
112
105
  p result
113
106
  rescue MoneyKit::ApiError => e
114
107
  puts "Error when calling LinkSessionApi->exchange_token: #{e}"
@@ -119,12 +112,12 @@ end
119
112
 
120
113
  This returns an Array which contains the response data, status code and headers.
121
114
 
122
- > <Array(<ExchangeTokenResponse>, Integer, Hash)> exchange_token_with_http_info(exchange_token_request, opts)
115
+ > <Array(<ExchangeTokenResponse>, Integer, Hash)> exchange_token_with_http_info(exchange_token_request)
123
116
 
124
117
  ```ruby
125
118
  begin
126
119
  # /link-session/exchange-token
127
- data, status_code, headers = api_instance.exchange_token_with_http_info(exchange_token_request, opts)
120
+ data, status_code, headers = api_instance.exchange_token_with_http_info(exchange_token_request)
128
121
  p status_code # => 2xx
129
122
  p headers # => { ... }
130
123
  p data # => <ExchangeTokenResponse>
@@ -138,7 +131,6 @@ end
138
131
  | Name | Type | Description | Notes |
139
132
  | ---- | ---- | ----------- | ----- |
140
133
  | **exchange_token_request** | [**ExchangeTokenRequest**](ExchangeTokenRequest.md) | | |
141
- | **moneykit_version** | **String** | | [optional][default to &#39;2023-02-18&#39;] |
142
134
 
143
135
  ### Return type
144
136
 
@@ -12,7 +12,7 @@
12
12
  | **link_id** | **String** | | |
13
13
  | **link_tags** | **Array&lt;String&gt;** | | |
14
14
  | **state** | [**LinkState**](LinkState.md) | | |
15
- | **error** | [**PublicLinkError**](PublicLinkError.md) | | [optional] |
15
+ | **error** | [**LinkError**](LinkError.md) | | [optional] |
16
16
  | **error_message** | **String** | | [optional] |
17
17
 
18
18
  ## Example
data/docs/LinksApi.md CHANGED
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.moneykit.com*
13
13
 
14
14
  ## disconnect
15
15
 
16
- > disconnect(id, opts)
16
+ > disconnect(id)
17
17
 
18
18
  /links/{id}
19
19
 
@@ -32,13 +32,10 @@ end
32
32
 
33
33
  api_instance = MoneyKit::LinksApi.new
34
34
  id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
35
- opts = {
36
- moneykit_version: 'moneykit_version_example' # String |
37
- }
38
35
 
39
36
  begin
40
37
  # /links/{id}
41
- api_instance.disconnect(id, opts)
38
+ api_instance.disconnect(id)
42
39
  rescue MoneyKit::ApiError => e
43
40
  puts "Error when calling LinksApi->disconnect: #{e}"
44
41
  end
@@ -48,12 +45,12 @@ end
48
45
 
49
46
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
50
47
 
51
- > <Array(nil, Integer, Hash)> disconnect_with_http_info(id, opts)
48
+ > <Array(nil, Integer, Hash)> disconnect_with_http_info(id)
52
49
 
53
50
  ```ruby
54
51
  begin
55
52
  # /links/{id}
56
- data, status_code, headers = api_instance.disconnect_with_http_info(id, opts)
53
+ data, status_code, headers = api_instance.disconnect_with_http_info(id)
57
54
  p status_code # => 2xx
58
55
  p headers # => { ... }
59
56
  p data # => nil
@@ -67,7 +64,6 @@ end
67
64
  | Name | Type | Description | Notes |
68
65
  | ---- | ---- | ----------- | ----- |
69
66
  | **id** | **String** | The unique ID for this link. | |
70
- | **moneykit_version** | **String** | | [optional][default to &#39;2023-02-18&#39;] |
71
67
 
72
68
  ### Return type
73
69
 
@@ -85,7 +81,7 @@ nil (empty response body)
85
81
 
86
82
  ## get_link
87
83
 
88
- > <LinkResponse> get_link(id, opts)
84
+ > <LinkResponse> get_link(id)
89
85
 
90
86
  /links/{id}
91
87
 
@@ -104,13 +100,10 @@ end
104
100
 
105
101
  api_instance = MoneyKit::LinksApi.new
106
102
  id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
107
- opts = {
108
- moneykit_version: 'moneykit_version_example' # String |
109
- }
110
103
 
111
104
  begin
112
105
  # /links/{id}
113
- result = api_instance.get_link(id, opts)
106
+ result = api_instance.get_link(id)
114
107
  p result
115
108
  rescue MoneyKit::ApiError => e
116
109
  puts "Error when calling LinksApi->get_link: #{e}"
@@ -121,12 +114,12 @@ end
121
114
 
122
115
  This returns an Array which contains the response data, status code and headers.
123
116
 
124
- > <Array(<LinkResponse>, Integer, Hash)> get_link_with_http_info(id, opts)
117
+ > <Array(<LinkResponse>, Integer, Hash)> get_link_with_http_info(id)
125
118
 
126
119
  ```ruby
127
120
  begin
128
121
  # /links/{id}
129
- data, status_code, headers = api_instance.get_link_with_http_info(id, opts)
122
+ data, status_code, headers = api_instance.get_link_with_http_info(id)
130
123
  p status_code # => 2xx
131
124
  p headers # => { ... }
132
125
  p data # => <LinkResponse>
@@ -140,7 +133,6 @@ end
140
133
  | Name | Type | Description | Notes |
141
134
  | ---- | ---- | ----------- | ----- |
142
135
  | **id** | **String** | The unique ID for this link. | |
143
- | **moneykit_version** | **String** | | [optional][default to &#39;2023-02-18&#39;] |
144
136
 
145
137
  ### Return type
146
138
 
@@ -158,7 +150,7 @@ end
158
150
 
159
151
  ## get_user_links
160
152
 
161
- > <GetUserLinksResponse> get_user_links(id, opts)
153
+ > <GetUserLinksResponse> get_user_links(id)
162
154
 
163
155
  /users/{id}/links
164
156
 
@@ -177,13 +169,10 @@ end
177
169
 
178
170
  api_instance = MoneyKit::LinksApi.new
179
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.
180
- opts = {
181
- moneykit_version: 'moneykit_version_example' # String |
182
- }
183
172
 
184
173
  begin
185
174
  # /users/{id}/links
186
- result = api_instance.get_user_links(id, opts)
175
+ result = api_instance.get_user_links(id)
187
176
  p result
188
177
  rescue MoneyKit::ApiError => e
189
178
  puts "Error when calling LinksApi->get_user_links: #{e}"
@@ -194,12 +183,12 @@ end
194
183
 
195
184
  This returns an Array which contains the response data, status code and headers.
196
185
 
197
- > <Array(<GetUserLinksResponse>, Integer, Hash)> get_user_links_with_http_info(id, opts)
186
+ > <Array(<GetUserLinksResponse>, Integer, Hash)> get_user_links_with_http_info(id)
198
187
 
199
188
  ```ruby
200
189
  begin
201
190
  # /users/{id}/links
202
- data, status_code, headers = api_instance.get_user_links_with_http_info(id, opts)
191
+ data, status_code, headers = api_instance.get_user_links_with_http_info(id)
203
192
  p status_code # => 2xx
204
193
  p headers # => { ... }
205
194
  p data # => <GetUserLinksResponse>
@@ -213,7 +202,6 @@ end
213
202
  | Name | Type | Description | Notes |
214
203
  | ---- | ---- | ----------- | ----- |
215
204
  | **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. | |
216
- | **moneykit_version** | **String** | | [optional][default to &#39;2023-02-18&#39;] |
217
205
 
218
206
  ### Return type
219
207
 
@@ -231,7 +219,7 @@ end
231
219
 
232
220
  ## reset_login
233
221
 
234
- > <LinkResponse> reset_login(id, opts)
222
+ > <LinkResponse> reset_login(id)
235
223
 
236
224
  Force a \"relink required\" state on a link (Test only).
237
225
 
@@ -248,13 +236,10 @@ end
248
236
 
249
237
  api_instance = MoneyKit::LinksApi.new
250
238
  id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
251
- opts = {
252
- moneykit_version: 'moneykit_version_example' # String |
253
- }
254
239
 
255
240
  begin
256
241
  # Force a \"relink required\" state on a link (Test only).
257
- result = api_instance.reset_login(id, opts)
242
+ result = api_instance.reset_login(id)
258
243
  p result
259
244
  rescue MoneyKit::ApiError => e
260
245
  puts "Error when calling LinksApi->reset_login: #{e}"
@@ -265,12 +250,12 @@ end
265
250
 
266
251
  This returns an Array which contains the response data, status code and headers.
267
252
 
268
- > <Array(<LinkResponse>, Integer, Hash)> reset_login_with_http_info(id, opts)
253
+ > <Array(<LinkResponse>, Integer, Hash)> reset_login_with_http_info(id)
269
254
 
270
255
  ```ruby
271
256
  begin
272
257
  # Force a \"relink required\" state on a link (Test only).
273
- data, status_code, headers = api_instance.reset_login_with_http_info(id, opts)
258
+ data, status_code, headers = api_instance.reset_login_with_http_info(id)
274
259
  p status_code # => 2xx
275
260
  p headers # => { ... }
276
261
  p data # => <LinkResponse>
@@ -284,7 +269,6 @@ end
284
269
  | Name | Type | Description | Notes |
285
270
  | ---- | ---- | ----------- | ----- |
286
271
  | **id** | **String** | The unique ID for this link. | |
287
- | **moneykit_version** | **String** | | [optional][default to &#39;2023-02-18&#39;] |
288
272
 
289
273
  ### Return type
290
274
 
@@ -302,7 +286,7 @@ end
302
286
 
303
287
  ## update_link
304
288
 
305
- > <LinkResponse> update_link(id, update_link_request, opts)
289
+ > <LinkResponse> update_link(id, update_link_request)
306
290
 
307
291
  /links/{id}
308
292
 
@@ -322,13 +306,10 @@ end
322
306
  api_instance = MoneyKit::LinksApi.new
323
307
  id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
324
308
  update_link_request = MoneyKit::UpdateLinkRequest.new # UpdateLinkRequest |
325
- opts = {
326
- moneykit_version: 'moneykit_version_example' # String |
327
- }
328
309
 
329
310
  begin
330
311
  # /links/{id}
331
- result = api_instance.update_link(id, update_link_request, opts)
312
+ result = api_instance.update_link(id, update_link_request)
332
313
  p result
333
314
  rescue MoneyKit::ApiError => e
334
315
  puts "Error when calling LinksApi->update_link: #{e}"
@@ -339,12 +320,12 @@ end
339
320
 
340
321
  This returns an Array which contains the response data, status code and headers.
341
322
 
342
- > <Array(<LinkResponse>, Integer, Hash)> update_link_with_http_info(id, update_link_request, opts)
323
+ > <Array(<LinkResponse>, Integer, Hash)> update_link_with_http_info(id, update_link_request)
343
324
 
344
325
  ```ruby
345
326
  begin
346
327
  # /links/{id}
347
- data, status_code, headers = api_instance.update_link_with_http_info(id, update_link_request, opts)
328
+ data, status_code, headers = api_instance.update_link_with_http_info(id, update_link_request)
348
329
  p status_code # => 2xx
349
330
  p headers # => { ... }
350
331
  p data # => <LinkResponse>
@@ -359,7 +340,6 @@ end
359
340
  | ---- | ---- | ----------- | ----- |
360
341
  | **id** | **String** | The unique ID for this link. | |
361
342
  | **update_link_request** | [**UpdateLinkRequest**](UpdateLinkRequest.md) | | |
362
- | **moneykit_version** | **String** | | [optional][default to &#39;2023-02-18&#39;] |
363
343
 
364
344
  ### Return type
365
345
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **issue_reporter** | **Boolean** | If enabled, the user can report linking issues directly to MoneyKit. | [optional][default to false] |
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
9
 
10
10
  ## Example
data/docs/ProductsApi.md CHANGED
@@ -9,7 +9,7 @@ All URIs are relative to *https://api.moneykit.com*
9
9
 
10
10
  ## refresh_products
11
11
 
12
- > refresh_products(id, refresh_products_request, opts)
12
+ > refresh_products(id, refresh_products_request)
13
13
 
14
14
  /links/{id}/products
15
15
 
@@ -29,13 +29,10 @@ end
29
29
  api_instance = MoneyKit::ProductsApi.new
30
30
  id = 'mk_eqkWN34UEoa2NxyALG8pcV' # String | The unique ID for this link.
31
31
  refresh_products_request = MoneyKit::RefreshProductsRequest.new({products: [MoneyKit::Product::ACCOUNTS]}) # RefreshProductsRequest |
32
- opts = {
33
- moneykit_version: 'moneykit_version_example' # String |
34
- }
35
32
 
36
33
  begin
37
34
  # /links/{id}/products
38
- api_instance.refresh_products(id, refresh_products_request, opts)
35
+ api_instance.refresh_products(id, refresh_products_request)
39
36
  rescue MoneyKit::ApiError => e
40
37
  puts "Error when calling ProductsApi->refresh_products: #{e}"
41
38
  end
@@ -45,12 +42,12 @@ end
45
42
 
46
43
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
47
44
 
48
- > <Array(nil, Integer, Hash)> refresh_products_with_http_info(id, refresh_products_request, opts)
45
+ > <Array(nil, Integer, Hash)> refresh_products_with_http_info(id, refresh_products_request)
49
46
 
50
47
  ```ruby
51
48
  begin
52
49
  # /links/{id}/products
53
- data, status_code, headers = api_instance.refresh_products_with_http_info(id, refresh_products_request, opts)
50
+ data, status_code, headers = api_instance.refresh_products_with_http_info(id, refresh_products_request)
54
51
  p status_code # => 2xx
55
52
  p headers # => { ... }
56
53
  p data # => nil
@@ -65,7 +62,6 @@ end
65
62
  | ---- | ---- | ----------- | ----- |
66
63
  | **id** | **String** | The unique ID for this link. | |
67
64
  | **refresh_products_request** | [**RefreshProductsRequest**](RefreshProductsRequest.md) | | |
68
- | **moneykit_version** | **String** | | [optional][default to &#39;2023-02-18&#39;] |
69
65
 
70
66
  ### Return type
71
67