Update with latest OpenAPI changes

moneykit · Oct 8, 2024 · 282bd6c · 282bd6c
1 parent eb5ee8c
commit 282bd6c
Show file tree

Hide file tree

Showing 174 changed files with 450 additions and 298 deletions.
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -73,7 +73,6 @@ docs/LinkProductRefreshWebhook.md
 docs/LinkProductResponse.md
 docs/LinkProductState.md
 docs/LinkProducts.md
-docs/LinkResponse.md
 docs/LinkSessionApi.md
 docs/LinkSessionErrorForbiddenConfigResponse.md
 docs/LinkSessionErrorInvalidTokenExchange.md
@@ -219,7 +218,6 @@ lib/moneykit/models/link_product_refresh_webhook.rb
 lib/moneykit/models/link_product_response.rb
 lib/moneykit/models/link_product_state.rb
 lib/moneykit/models/link_products.rb
-lib/moneykit/models/link_response.rb
 lib/moneykit/models/link_session_error_forbidden_config_response.rb
 lib/moneykit/models/link_session_error_invalid_token_exchange.rb
 lib/moneykit/models/link_session_setting_overrides.rb

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    moneykit (0.1.13)
+    moneykit (0.1.14)
       faraday (>= 1.0.1, < 3.0)
       faraday-multipart
 

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ bundle add moneykit.gemspec
 or add the following to your `Gemfile`
 
 ```
-gem 'moneykit', '~> 0.1.13'
+gem 'moneykit', '~> 0.1.14'
 ```
 
 ## Getting Started

diff --git a/docs/AccessTokenApi.md b/docs/AccessTokenApi.md
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.moneykit.com*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_access_token**](AccessTokenApi.md#create_access_token) | **POST** /auth/token | /auth/token |
-| [**get_app_jwks**](AccessTokenApi.md#get_app_jwks) | **GET** /.well-known/jwks.json | JSON Web Key Set |
+| [**get_well_known_jwks**](AccessTokenApi.md#get_well_known_jwks) | **GET** /.well-known/jwks.json | JSON Web Key Set |
 | [**instrospect_client**](AccessTokenApi.md#instrospect_client) | **GET** /auth/introspect | /auth/introspect |
 
 
@@ -87,54 +87,50 @@ end
 - **Accept**: application/json
 
 
-## get_app_jwks
+## get_well_known_jwks
 
-> <JWKSet> get_app_jwks(opts)
+> <JWKSet> get_well_known_jwks(opts)
 
 JSON Web Key Set
 
-The JSON Web Key Set (JWKS) is a set of keys containing the public keys used to verify webhook JSON Web Tokens (JWT) issued by MoneyKit webhooks.
+The JSON Web Key Set (JWKS) is a set of keys containing the public keys used to verify     JWTs in webhooks sent by MoneyKit.      The JWKS should be cached, but MoneyKit rotates its webhook keys periodically, so if an     incoming webhook's JWT has a key ID (`kid`) not contained in the cached JWKS, you should fetch     and cache the updated JWKS using this endpoint.
 
 ### Examples
 
 ```ruby
 require 'time'
 require 'moneykit'
-# setup authorization
-MoneyKit.configure do |config|
-  # Configure OAuth2 access token for authorization: OAuth2ClientCredentials
-  config.access_token = 'YOUR ACCESS TOKEN'
-end
 
 api_instance = MoneyKit::AccessTokenApi.new
 opts = {
-  x_client_id: 'x_client_id_example' # String | Your client ID.
+  x_client_id: 'x_client_id_example', # String | Your client ID.
+  authorization: 'authorization_example' # String | (Deprecated) An access token obtained from <a href=#operation/create_access_token>/auth/token</a>.  This method works         but is deprecated in favor of using `X-Client-Id`.
 }
 
 begin
   # JSON Web Key Set
-  result = api_instance.get_app_jwks(opts)
+  result = api_instance.get_well_known_jwks(opts)
   p result
 rescue MoneyKit::ApiError => e
-  puts "Error when calling AccessTokenApi->get_app_jwks: #{e}"
+  puts "Error when calling AccessTokenApi->get_well_known_jwks: #{e}"
 end
 ```
 
-#### Using the get_app_jwks_with_http_info variant
+#### Using the get_well_known_jwks_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<JWKSet>, Integer, Hash)> get_app_jwks_with_http_info(opts)
+> <Array(<JWKSet>, Integer, Hash)> get_well_known_jwks_with_http_info(opts)
 
 ```ruby
 begin
   # JSON Web Key Set
-  data, status_code, headers = api_instance.get_app_jwks_with_http_info(opts)
+  data, status_code, headers = api_instance.get_well_known_jwks_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <JWKSet>
 rescue MoneyKit::ApiError => e
-  puts "Error when calling AccessTokenApi->get_app_jwks_with_http_info: #{e}"
+  puts "Error when calling AccessTokenApi->get_well_known_jwks_with_http_info: #{e}"
 end
 ```
 
@@ -143,14 +139,15 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **x_client_id** | **String** | Your client ID. | [optional] |
+| **authorization** | **String** | (Deprecated) An access token obtained from &lt;a href&#x3D;#operation/create_access_token&gt;/auth/token&lt;/a&gt;.  This method works         but is deprecated in favor of using &#x60;X-Client-Id&#x60;. | [optional] |
 
 ### Return type
 
 [**JWKSet**](JWKSet.md)
 
 ### Authorization
 
-[OAuth2ClientCredentials](../README.md#OAuth2ClientCredentials)
+No authorization required
 
 ### HTTP request headers
 

diff --git a/docs/AccountIdentity.md b/docs/AccountIdentity.md
@@ -9,7 +9,9 @@
 | **name** | **String** | The account name, according to the institution.  Note that some institutions allow         the end user to nickname the account; in such cases this field may be the name assigned by the user. |  |
 | **account_mask** | **String** | The last four characters (usually digits) of the account number.         Note that this mask may be non-unique between accounts. | [optional] |
 | **balances** | [**AccountBalances**](AccountBalances.md) |  |  |
+| **raw_provider_data** | **Object** | Raw account data from the provider. | [optional] |
 | **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
+| **closed** | **Boolean** | True if this account is closed. | [optional] |
 | **owners** | [**Array&lt;Owner&gt;**](Owner.md) |  |  |
 
 ## Example
@@ -23,7 +25,9 @@ instance = MoneyKit::AccountIdentity.new(
   name: Premier Checking,
   account_mask: 3748,
   balances: null,
+  raw_provider_data: null,
   original_id: null,
+  closed: null,
   owners: null
 )
 ```

diff --git a/docs/AccountResponse.md b/docs/AccountResponse.md
@@ -9,7 +9,9 @@
 | **name** | **String** | The account name, according to the institution.  Note that some institutions allow         the end user to nickname the account; in such cases this field may be the name assigned by the user. |  |
 | **account_mask** | **String** | The last four characters (usually digits) of the account number.         Note that this mask may be non-unique between accounts. | [optional] |
 | **balances** | [**AccountBalances**](AccountBalances.md) |  |  |
+| **raw_provider_data** | **Object** | Raw account data from the provider. | [optional] |
 | **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
+| **closed** | **Boolean** | True if this account is closed. | [optional] |
 
 ## Example
 
@@ -22,7 +24,9 @@ instance = MoneyKit::AccountResponse.new(
   name: Premier Checking,
   account_mask: 3748,
   balances: null,
-  original_id: null
+  raw_provider_data: null,
+  original_id: null,
+  closed: null
 )
 ```
 
diff --git a/docs/AccountWithAccountNumbersLegacy20230218.md b/docs/AccountWithAccountNumbersLegacy20230218.md
@@ -9,7 +9,9 @@
 | **name** | **String** | The account name, according to the institution.  Note that some institutions allow         the end user to nickname the account; in such cases this field may be the name assigned by the user. |  |
 | **account_mask** | **String** | The last four characters (usually digits) of the account number.         Note that this mask may be non-unique between accounts. | [optional] |
 | **balances** | [**AccountBalances**](AccountBalances.md) |  |  |
+| **raw_provider_data** | **Object** | Raw account data from the provider. | [optional] |
 | **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
+| **closed** | **Boolean** | True if this account is closed. | [optional] |
 | **numbers** | [**AccountNumbersLegacy20230218**](AccountNumbersLegacy20230218.md) |  |  |
 
 ## Example
@@ -23,7 +25,9 @@ instance = MoneyKit::AccountWithAccountNumbersLegacy20230218.new(
   name: Premier Checking,
   account_mask: 3748,
   balances: null,
+  raw_provider_data: null,
   original_id: null,
+  closed: null,
   numbers: null
 )
 ```

diff --git a/docs/AccountsApi.md b/docs/AccountsApi.md
@@ -243,7 +243,7 @@ MoneyKit.configure do |config|
 end
 
 api_instance = MoneyKit::AccountsApi.new
-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.
+id = 'id_example' # String | The unique ID for this user.  This is the same ID provided         in the call to <a href=/api/operation/create_link_session#customer_user-id>link-session</a> to create any link for this user.
 opts = {
   account_ids: ['inner_example'], # Array<String> | If present, filters results to accounts matching the given IDs.
   institution_ids: ['inner_example'] # Array<String> | If present, filters results to accounts at institutions matching the given IDs.
@@ -280,7 +280,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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. |  |
+| **id** | **String** | The unique ID for this user.  This is the same ID provided         in the call to &lt;a href&#x3D;/api/operation/create_link_session#customer_user-id&gt;link-session&lt;/a&gt; to create any link for this user. |  |
 | **account_ids** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts matching the given IDs. | [optional] |
 | **institution_ids** | [**Array&lt;String&gt;**](String.md) | If present, filters results to accounts at institutions matching the given IDs. | [optional] |
 

diff --git a/docs/Address.md b/docs/Address.md
@@ -9,7 +9,7 @@
 | **postal_code** | **String** | The postal or zip code of the address. | [optional] |
 | **region** | **String** | The region or state of the address. | [optional] |
 | **street** | **String** | The street of the address. | [optional] |
-| **primary** | **Boolean** | Indicates if this is the primary address for the account owner. | [optional] |
+| **primary** | **Boolean** | Indicates if this is the primary address for the account owner, as reported by the institution. | [optional] |
 
 ## Example
 

diff --git a/docs/CreateAccessTokenResponse.md b/docs/CreateAccessTokenResponse.md
@@ -14,7 +14,7 @@
 require 'moneykit'
 
 instance = MoneyKit::CreateAccessTokenResponse.new(
-  access_token: 52ea3d1b4f9a53fffb67...,
+  access_token: 52ea3d1b...4f9a53fffb67,
   token_type: bearer,
   expires_in: 3600
 )

diff --git a/docs/CustomerUserPhone.md b/docs/CustomerUserPhone.md
@@ -14,7 +14,7 @@
 require 'moneykit'
 
 instance = MoneyKit::CustomerUserPhone.new(
-  number: +16175551212,
+  number: 6175551212,
   country: null,
   customer_verified_at: 2023-02-16T00:00:00
 )

diff --git a/docs/Email.md b/docs/Email.md
@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **address** | **String** | An email address for the account owner. |  |
-| **primary** | **Boolean** | Indicates if this is the primary email address for the account owner. | [optional] |
+| **primary** | **Boolean** | Indicates if this is the primary email address for the account owner, as reported by the institution. | [optional] |
 
 ## Example
 

diff --git a/docs/ExchangeTokenResponse.md b/docs/ExchangeTokenResponse.md
@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **link_id** | **String** | The unique ID associated with this link. |  |
+| **link_id** | **String** | DEPRECATED: Please use &#x60;link.link_id&#x60; for this value |  |
 | **link** | [**LinkCommon**](LinkCommon.md) |  |  |
 
 ## Example

diff --git a/docs/IdentityApi.md b/docs/IdentityApi.md
@@ -13,7 +13,7 @@ All URIs are relative to *https://api.moneykit.com*
 
 /links/{id}/identity
 
-Returns account owner information from the institution, including names, emails, phone     numbers, and addresses, for all permissioned accounts associated with a <a href=#tag/Links>link</a>.     <p>Some fields may be empty, if not provided by the institution.     <p>**Note** that this endpoint does **not** trigger a fetch of owner information from the institution; it merely returns     owner information that has already been fetched, either because `prefetch` was requested when the link was created,     or because of an on-demand update.  **To force a check for new/updated owner information, you must use the     <a href=#operation/refresh_products>/products</a> endpoint.**     <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date     for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can     get from any previous response for this or any other account or link request.  If the refreshed_at date has not     increased, then updated data is not yet available.
+Returns account owner information from the institution, including names, emails, phone     numbers, and addresses, for all permissioned accounts associated with a <a href=#tag/Links>link</a>.  This information     will appear in the `owners` list in the `accounts` object.     <p>Some fields may be empty, if not provided by the institution.     <p>**Note** that this endpoint does **not** trigger a fetch of owner information from the institution; it merely returns     owner information that has already been fetched, either because `prefetch` was requested when the link was created,     or because of an on-demand update.  **To force a check for new/updated owner information, you must use the     <a href=#operation/refresh_products>/products</a> endpoint.**     <p>If you have requested prefetch or an on-demand update, you should check the `refreshed_at` date     for this product in the returned response, and compare that against the previous `refreshed_at` date, which you can     get from any previous response for this or any other account or link request.  If the refreshed_at date has not     increased, then updated data is not yet available.
 
 ### Examples
 

diff --git a/docs/ImportLinkRequest.md b/docs/ImportLinkRequest.md
@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **customer_user** | [**CustomerUser**](CustomerUser.md) |  |  |
 | **provider** | [**Provider**](Provider.md) |  | [optional] |
-| **institution_id** | **String** | MoneyKit&#39;s unique ID for this institution.  If the imported link is         synced with a data provider later, it will be connected to this institution. |  |
+| **institution_id** | **String** | MoneyKit&#39;s unique ID for this institution.  If you use a MoneyKit-supported provider, you can         also submit the provider name and __their__ institution_id in dotted notation, such as &#x60;mx.chase&#x60;         or &#x60;yodlee.30188&#x60;.  If the imported link is synced with a data provider later, it will be connected to         this institution.  Note that MoneyKit may reconnect the link using any supported provider, not just the one         given during this import. |  |
 | **accounts** | [**Array&lt;AccountImportData&gt;**](AccountImportData.md) |  |  |
 | **transactions** | [**Array&lt;TransactionImportData&gt;**](TransactionImportData.md) |  |  |
 
@@ -18,7 +18,7 @@ require 'moneykit'
 instance = MoneyKit::ImportLinkRequest.new(
   customer_user: null,
   provider: null,
-  institution_id: chase,
+  institution_id: null,
   accounts: null,
   transactions: null
 )

diff --git a/docs/InvestmentsApi.md b/docs/InvestmentsApi.md
@@ -106,8 +106,8 @@ opts = {
   account_ids: ['inner_example'], # Array<String> | An optional list of account IDs to filter the results.
   page: 56, # Integer | The page number to return.
   size: 56, # Integer | The number of items to return per page.
-  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`.
-  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.
+  start_date: Date.parse('2013-10-20'), # Date | The earliest date for which data should be returned, formatted as YYYY-MM-DD.
+  end_date: Date.parse('2013-10-20') # Date | The latest date for which data should be returned, formatted as YYYY-MM-DD.
 }
 
 begin
@@ -145,8 +145,8 @@ end
 | **account_ids** | [**Array&lt;String&gt;**](String.md) | An optional list of account IDs to filter the results. | [optional] |
 | **page** | **Integer** | The page number to return. | [optional][default to 1] |
 | **size** | **Integer** | The number of items to return per page. | [optional][default to 50] |
-| **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] |
-| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD.             Defaults to today. | [optional] |
+| **start_date** | **Date** | The earliest date for which data should be returned, formatted as YYYY-MM-DD. | [optional] |
+| **end_date** | **Date** | The latest date for which data should be returned, formatted as YYYY-MM-DD. | [optional] |
 
 ### Return type
 

diff --git a/docs/LinkCommon.md b/docs/LinkCommon.md
@@ -11,7 +11,9 @@
 | **state** | [**PublicLinkState**](PublicLinkState.md) |  |  |
 | **error_code** | [**PublicLinkError**](PublicLinkError.md) |  | [optional] |
 | **last_synced_at** | **Time** | (Deprecated) An ISO-8601 timestamp indicating the last time that the link was updated. | [optional] |
+| **provider** | [**Provider**](Provider.md) |  |  |
 | **tags** | **Array&lt;String&gt;** |  | [optional] |
+| **webhook** | **String** | The webhook url assigned to this link. | [optional] |
 | **products** | [**LinkProducts**](LinkProducts.md) |  |  |
 | **available_products** | [**Array&lt;Product&gt;**](Product.md) |  |  |
 
@@ -28,7 +30,9 @@ instance = MoneyKit::LinkCommon.new(
   state: null,
   error_code: null,
   last_synced_at: 2023-02-16T09:14:11,
+  provider: null,
   tags: null,
+  webhook: https://example.com/webhook,
   products: null,
   available_products: null
 )