moneykit 0.1.9 → 0.1.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +1 -1
- data/docs/AccessTokenApi.md +26 -21
- data/docs/AccountBalances.md +2 -2
- data/docs/AccountGroup.md +1 -1
- data/docs/AccountIdentity.md +2 -0
- data/docs/AccountImportData.md +26 -0
- data/docs/AccountNumbersApi.md +9 -9
- data/docs/AccountResponse.md +28 -0
- data/docs/AccountWithAccountNumbersLegacy20230218.md +2 -0
- data/docs/AccountsApi.md +9 -9
- data/docs/Address.md +1 -1
- data/docs/AppClientResponse.md +2 -2
- data/docs/AppLinkStateChangedWebhook.md +36 -0
- data/docs/AppResponse.md +2 -2
- data/docs/Body.md +3 -3
- data/docs/CreateAccessTokenResponse.md +22 -0
- data/docs/CreateLinkSessionRequest.md +1 -1
- data/docs/CustomerUser.md +22 -0
- data/docs/CustomerUserEmail.md +20 -0
- data/docs/CustomerUserPhone.md +22 -0
- data/docs/Date.md +15 -0
- data/docs/Email.md +1 -1
- data/docs/GetAccountResponse.md +1 -1
- data/docs/GetAccountsResponse.md +1 -1
- data/docs/GetHoldingsResponse.md +1 -1
- data/docs/GetInvestmentTransactionsResponse.md +1 -1
- data/docs/GetTransactionsResponse.md +2 -2
- data/docs/GetUserTransactionsResponse.md +1 -1
- data/docs/ImportLinkRequest.md +26 -0
- data/docs/Institution.md +1 -1
- data/docs/LinkCommon.md +3 -3
- data/docs/LinkProductError.md +15 -0
- data/docs/LinkProductRefreshWebhook.md +2 -2
- data/docs/LinkProductResponse.md +28 -0
- data/docs/LinkProducts.md +7 -5
- data/docs/LinkResponse.md +3 -3
- data/docs/LinkSessionApi.md +1 -1
- data/docs/LinksApi.md +79 -9
- data/docs/PhoneNumber.md +1 -1
- data/docs/PublicLinkState.md +15 -0
- data/docs/Response401DeleteLinkLinksIdDelete.md +22 -0
- data/docs/Response401GetAccountNumbers.md +22 -0
- data/docs/Response401GetTransactionsSyncLinksIdTransactionsSyncGet.md +22 -0
- data/docs/Response401ImportLinkLinksImportPost.md +22 -0
- data/docs/ResponseHandleLinkWebhookEventRequestBodyWebhookPost.md +3 -3
- data/docs/TransactionCategoryResponse.md +20 -0
- data/docs/TransactionEnrichmentResponse.md +26 -0
- data/docs/TransactionImportData.md +28 -0
- data/docs/TransactionMerchantResponse.md +24 -0
- data/docs/TransactionProcessorResponse.md +24 -0
- data/docs/TransactionRecurrenceResponse.md +20 -0
- data/docs/TransactionResponse.md +42 -0
- data/docs/TransactionSubcategoryResponse.md +20 -0
- data/docs/TransactionSync.md +22 -0
- data/docs/TransactionSyncResponse.md +1 -1
- data/docs/TransactionUpdatesAvailableWebhook.md +4 -2
- data/docs/TransactionsApi.md +15 -15
- data/docs/TransactionsLinkProduct.md +1 -1
- data/lib/moneykit/api/access_token_api.rb +19 -16
- data/lib/moneykit/api/account_numbers_api.rb +7 -7
- data/lib/moneykit/api/accounts_api.rb +7 -7
- data/lib/moneykit/api/links_api.rb +75 -7
- data/lib/moneykit/api/transactions_api.rb +17 -17
- data/lib/moneykit/models/account_balances.rb +2 -30
- data/lib/moneykit/models/account_group.rb +1 -1
- data/lib/moneykit/models/account_identity.rb +11 -1
- data/lib/moneykit/models/account_import_data.rb +280 -0
- data/lib/moneykit/models/account_response.rb +290 -0
- data/lib/moneykit/models/account_with_account_numbers_legacy20230218.rb +11 -1
- data/lib/moneykit/models/address.rb +0 -2
- data/lib/moneykit/models/app_client_response.rb +1 -1
- data/lib/moneykit/models/app_link_state_changed_webhook.rb +394 -0
- data/lib/moneykit/models/body.rb +1 -1
- data/lib/moneykit/models/create_access_token_response.rb +255 -0
- data/lib/moneykit/models/create_link_session_request.rb +1 -1
- data/lib/moneykit/models/customer_user.rb +266 -0
- data/lib/moneykit/models/customer_user_email.rb +258 -0
- data/lib/moneykit/models/customer_user_phone.rb +289 -0
- data/lib/moneykit/models/date.rb +104 -0
- data/lib/moneykit/models/email.rb +0 -2
- data/lib/moneykit/models/get_account_response.rb +1 -1
- data/lib/moneykit/models/get_accounts_response.rb +1 -1
- data/lib/moneykit/models/get_holdings_response.rb +1 -1
- data/lib/moneykit/models/get_investment_transactions_response.rb +1 -1
- data/lib/moneykit/models/get_transactions_response.rb +2 -2
- data/lib/moneykit/models/get_user_transactions_response.rb +1 -1
- data/lib/moneykit/models/import_link_request.rb +303 -0
- data/lib/moneykit/models/institution.rb +0 -7
- data/lib/moneykit/models/link_common.rb +3 -3
- data/lib/moneykit/models/link_product_error.rb +46 -0
- data/lib/moneykit/models/link_product_refresh_webhook.rb +24 -24
- data/lib/moneykit/models/link_product_response.rb +283 -0
- data/lib/moneykit/models/link_product_state.rb +3 -1
- data/lib/moneykit/models/link_products.rb +16 -7
- data/lib/moneykit/models/link_response.rb +3 -3
- data/lib/moneykit/models/phone_number.rb +0 -2
- data/lib/moneykit/models/product.rb +2 -1
- data/lib/moneykit/models/provider.rb +1 -2
- data/lib/moneykit/models/public_link_error.rb +1 -1
- data/lib/moneykit/models/public_link_state.rb +43 -0
- data/lib/moneykit/models/response401_delete_link_links_id_delete.rb +104 -0
- data/lib/moneykit/models/response401_get_account_numbers.rb +104 -0
- data/lib/moneykit/models/response401_get_transactions_sync_links_id_transactions_sync_get.rb +104 -0
- data/lib/moneykit/models/response401_import_link_links_import_post.rb +103 -0
- data/lib/moneykit/models/response_handle_link_webhook_event_request_body_webhook_post.rb +1 -1
- data/lib/moneykit/models/transaction_category_response.rb +230 -0
- data/lib/moneykit/models/transaction_enrichment_response.rb +255 -0
- data/lib/moneykit/models/transaction_import_data.rb +283 -0
- data/lib/moneykit/models/transaction_merchant_response.rb +243 -0
- data/lib/moneykit/models/transaction_processor_response.rb +243 -0
- data/lib/moneykit/models/transaction_recurrence_response.rb +223 -0
- data/lib/moneykit/models/transaction_response.rb +402 -0
- data/lib/moneykit/models/transaction_subcategory_response.rb +230 -0
- data/lib/moneykit/models/transaction_sync.rb +257 -0
- data/lib/moneykit/models/transaction_sync_response.rb +1 -1
- data/lib/moneykit/models/transaction_updates_available_webhook.rb +42 -24
- data/lib/moneykit/models/transactions_link_product.rb +1 -1
- data/lib/moneykit/version.rb +1 -1
- data/lib/moneykit.rb +26 -17
- data/spec/models/account_import_data_spec.rb +60 -0
- data/spec/models/account_response_spec.rb +66 -0
- data/spec/models/app_link_state_changed_webhook_spec.rb +102 -0
- data/spec/models/create_access_token_response_spec.rb +48 -0
- data/spec/models/customer_user_email_spec.rb +42 -0
- data/spec/models/customer_user_phone_spec.rb +48 -0
- data/spec/models/customer_user_spec.rb +48 -0
- data/spec/models/date_spec.rb +21 -0
- data/spec/models/import_link_request_spec.rb +60 -0
- data/spec/models/link_product_error_spec.rb +30 -0
- data/spec/models/link_product_response_spec.rb +66 -0
- data/spec/models/public_link_error_spec.rb +30 -0
- data/spec/models/public_link_state_spec.rb +30 -0
- data/spec/models/response401_delete_link_links_id_delete_spec.rb +21 -0
- data/spec/models/response401_get_account_numbers_spec.rb +21 -0
- data/spec/models/response401_get_transactions_sync_links_id_transactions_sync_get_spec.rb +21 -0
- data/spec/models/response401_import_link_links_import_post_spec.rb +21 -0
- data/spec/models/transaction_category_response_spec.rb +42 -0
- data/spec/models/transaction_enrichment_response_spec.rb +60 -0
- data/spec/models/transaction_import_data_spec.rb +66 -0
- data/spec/models/transaction_merchant_response_spec.rb +54 -0
- data/spec/models/transaction_processor_response_spec.rb +54 -0
- data/spec/models/transaction_recurrence_response_spec.rb +42 -0
- data/spec/models/transaction_response_spec.rb +108 -0
- data/spec/models/transaction_subcategory_response_spec.rb +42 -0
- data/spec/models/transaction_sync_spec.rb +48 -0
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/byebug-11.1.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.1.1/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/psych-5.1.1.1/mkmf.log +2 -2
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/racc-1.7.3/gem_make.out +5 -5
- data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux/3.2.0/stringio-3.1.0/gem_make.out +5 -5
- metadata +222 -120
data/docs/GetHoldingsResponse.md
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **holdings** | [**Array<HoldingResponse>**](HoldingResponse.md) | | |
|
8
8
|
| **securities** | [**Array<SecurityResponse>**](SecurityResponse.md) | | |
|
9
|
-
| **accounts** | [**Array<
|
9
|
+
| **accounts** | [**Array<AccountResponse>**](AccountResponse.md) | | |
|
10
10
|
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
11
11
|
|
12
12
|
## Example
|
@@ -9,7 +9,7 @@
|
|
9
9
|
| **size** | **Integer** | The number of results in this batch. | |
|
10
10
|
| **investment_transactions** | [**Array<InvestmentTransactionResponse>**](InvestmentTransactionResponse.md) | | |
|
11
11
|
| **securities** | [**Array<SecurityResponse>**](SecurityResponse.md) | | |
|
12
|
-
| **accounts** | [**Array<
|
12
|
+
| **accounts** | [**Array<AccountResponse>**](AccountResponse.md) | | |
|
13
13
|
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
14
14
|
|
15
15
|
## Example
|
@@ -7,8 +7,8 @@
|
|
7
7
|
| **total** | **Integer** | The total number of results for this query. | |
|
8
8
|
| **page** | **Integer** | The page number corresponding to this batch of results. | |
|
9
9
|
| **size** | **Integer** | The number of results in this batch. | |
|
10
|
-
| **transactions** | [**Array<
|
11
|
-
| **accounts** | [**Array<
|
10
|
+
| **transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) | | |
|
11
|
+
| **accounts** | [**Array<AccountResponse>**](AccountResponse.md) | | |
|
12
12
|
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
13
13
|
|
14
14
|
## Example
|
@@ -7,7 +7,7 @@
|
|
7
7
|
| **total** | **Integer** | The total number of results for this query. | |
|
8
8
|
| **page** | **Integer** | The page number corresponding to this batch of results. | |
|
9
9
|
| **size** | **Integer** | The number of results in this batch. | |
|
10
|
-
| **transactions** | [**Array<
|
10
|
+
| **transactions** | [**Array<TransactionResponse>**](TransactionResponse.md) | | |
|
11
11
|
| **accounts** | [**Hash<String, BasicAccountDetails>**](BasicAccountDetails.md) | | |
|
12
12
|
|
13
13
|
## Example
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# MoneyKit::ImportLinkRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **customer_user** | [**CustomerUser**](CustomerUser.md) | | |
|
8
|
+
| **provider** | [**Provider**](Provider.md) | | [optional] |
|
9
|
+
| **institution_id** | **String** | MoneyKit's unique ID for this institution. If the imported link is synced with a data provider later, it will be connected to this institution. | |
|
10
|
+
| **accounts** | [**Array<AccountImportData>**](AccountImportData.md) | | |
|
11
|
+
| **transactions** | [**Array<TransactionImportData>**](TransactionImportData.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'moneykit'
|
17
|
+
|
18
|
+
instance = MoneyKit::ImportLinkRequest.new(
|
19
|
+
customer_user: null,
|
20
|
+
provider: null,
|
21
|
+
institution_id: chase,
|
22
|
+
accounts: null,
|
23
|
+
transactions: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/Institution.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
| **name** | **String** | The name of the institution. | |
|
10
10
|
| **country** | [**Country**](Country.md) | | |
|
11
11
|
| **domain** | **String** | The domain of the institution's user-facing website. | [optional] |
|
12
|
-
| **color** | **String** | The primary color of this institution, represented as hexcode. |
|
12
|
+
| **color** | **String** | The primary color of this institution, represented as hexcode. | [optional] |
|
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. | |
|
15
15
|
|
data/docs/LinkCommon.md
CHANGED
@@ -8,9 +8,9 @@
|
|
8
8
|
| **institution_id** | **String** | The unique ID for the institution this link is connected to. | |
|
9
9
|
| **institution_name** | **String** | The institution name this link is connected to. | |
|
10
10
|
| **institution_avatar** | **String** | An avatar image for the link's institution. | |
|
11
|
-
| **state** | [**
|
12
|
-
| **error_code** | [**
|
13
|
-
| **last_synced_at** | **Time** | An ISO-8601 timestamp indicating the last time that the
|
11
|
+
| **state** | [**PublicLinkState**](PublicLinkState.md) | | |
|
12
|
+
| **error_code** | [**PublicLinkError**](PublicLinkError.md) | | [optional] |
|
13
|
+
| **last_synced_at** | **Time** | (Deprecated) An ISO-8601 timestamp indicating the last time that the link was updated. | [optional] |
|
14
14
|
| **tags** | **Array<String>** | | [optional] |
|
15
15
|
| **products** | [**LinkProducts**](LinkProducts.md) | | |
|
16
16
|
| **available_products** | [**Array<Product>**](Product.md) | | |
|
@@ -4,13 +4,13 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **webhook_event** | **String** | | [optional][default to 'link.product_refresh'] |
|
8
7
|
| **webhook_major_version** | **Integer** | | [optional][default to WEBHOOK_MAJOR_VERSION::N1] |
|
9
8
|
| **webhook_minor_version** | **Integer** | | [optional][default to WEBHOOK_MINOR_VERSION::N0] |
|
10
9
|
| **webhook_idempotency_key** | **String** | | |
|
11
10
|
| **webhook_timestamp** | **Time** | | |
|
12
11
|
| **link_id** | **String** | | |
|
13
12
|
| **link_tags** | **Array<String>** | | |
|
13
|
+
| **webhook_event** | **String** | | [optional][default to 'link.product_refresh'] |
|
14
14
|
| **product** | [**Product**](Product.md) | | |
|
15
15
|
| **state** | [**LinkProductState**](LinkProductState.md) | | |
|
16
16
|
| **state_changed_at** | **Time** | | |
|
@@ -22,13 +22,13 @@
|
|
22
22
|
require 'moneykit'
|
23
23
|
|
24
24
|
instance = MoneyKit::LinkProductRefreshWebhook.new(
|
25
|
-
webhook_event: null,
|
26
25
|
webhook_major_version: null,
|
27
26
|
webhook_minor_version: null,
|
28
27
|
webhook_idempotency_key: null,
|
29
28
|
webhook_timestamp: null,
|
30
29
|
link_id: null,
|
31
30
|
link_tags: null,
|
31
|
+
webhook_event: null,
|
32
32
|
product: null,
|
33
33
|
state: null,
|
34
34
|
state_changed_at: null,
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MoneyKit::LinkProductResponse
|
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** | [**LinkProductError**](LinkProductError.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't currently be updated, the reason why it is unavailable. <p>Unavailable products can'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::LinkProductResponse.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,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accounts** | [**
|
8
|
-
| **account_numbers** | [**
|
9
|
-
| **identity** | [**
|
7
|
+
| **accounts** | [**LinkProductResponse**](LinkProductResponse.md) | | [optional] |
|
8
|
+
| **account_numbers** | [**LinkProductResponse**](LinkProductResponse.md) | | [optional] |
|
9
|
+
| **identity** | [**LinkProductResponse**](LinkProductResponse.md) | | [optional] |
|
10
10
|
| **transactions** | [**TransactionsLinkProduct**](TransactionsLinkProduct.md) | | [optional] |
|
11
|
-
| **investments** | [**
|
11
|
+
| **investments** | [**LinkProductResponse**](LinkProductResponse.md) | | [optional] |
|
12
|
+
| **enrichment** | [**LinkProductResponse**](LinkProductResponse.md) | | [optional] |
|
12
13
|
|
13
14
|
## Example
|
14
15
|
|
@@ -20,7 +21,8 @@ instance = MoneyKit::LinkProducts.new(
|
|
20
21
|
account_numbers: null,
|
21
22
|
identity: null,
|
22
23
|
transactions: null,
|
23
|
-
investments: null
|
24
|
+
investments: null,
|
25
|
+
enrichment: null
|
24
26
|
)
|
25
27
|
```
|
26
28
|
|
data/docs/LinkResponse.md
CHANGED
@@ -8,9 +8,9 @@
|
|
8
8
|
| **institution_id** | **String** | The unique ID for the institution this link is connected to. | |
|
9
9
|
| **institution_name** | **String** | The institution name this link is connected to. | |
|
10
10
|
| **institution_avatar** | **String** | An avatar image for the link's institution. | |
|
11
|
-
| **state** | [**
|
12
|
-
| **error_code** | [**
|
13
|
-
| **last_synced_at** | **Time** | An ISO-8601 timestamp indicating the last time that the
|
11
|
+
| **state** | [**PublicLinkState**](PublicLinkState.md) | | |
|
12
|
+
| **error_code** | [**PublicLinkError**](PublicLinkError.md) | | [optional] |
|
13
|
+
| **last_synced_at** | **Time** | (Deprecated) An ISO-8601 timestamp indicating the last time that the link was updated. | [optional] |
|
14
14
|
| **tags** | **Array<String>** | | [optional] |
|
15
15
|
| **products** | [**LinkProducts**](LinkProducts.md) | | |
|
16
16
|
| **available_products** | [**Array<Product>**](Product.md) | | |
|
data/docs/LinkSessionApi.md
CHANGED
@@ -28,7 +28,7 @@ MoneyKit.configure do |config|
|
|
28
28
|
end
|
29
29
|
|
30
30
|
api_instance = MoneyKit::LinkSessionApi.new
|
31
|
-
create_link_session_request = MoneyKit::CreateLinkSessionRequest.new({customer_user: MoneyKit::
|
31
|
+
create_link_session_request = MoneyKit::CreateLinkSessionRequest.new({customer_user: MoneyKit::CustomerUser.new({id: 'id_example'}), redirect_uri: 'https://yourdomain.com/oauth.html'}) # CreateLinkSessionRequest |
|
32
32
|
|
33
33
|
begin
|
34
34
|
# /link-session
|
data/docs/LinksApi.md
CHANGED
@@ -4,16 +4,17 @@ All URIs are relative to *https://api.moneykit.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
7
|
+
| [**delete_link**](LinksApi.md#delete_link) | **DELETE** /links/{id} | /links/{id} |
|
8
8
|
| [**get_link**](LinksApi.md#get_link) | **GET** /links/{id} | /links/{id} |
|
9
9
|
| [**get_user_links**](LinksApi.md#get_user_links) | **GET** /users/{id}/links | /users/{id}/links |
|
10
|
+
| [**import_link**](LinksApi.md#import_link) | **POST** /links/import | /links/import |
|
10
11
|
| [**reset_login**](LinksApi.md#reset_login) | **POST** /links/{id}/reset | Force a \"relink required\" state on a link (Test only). |
|
11
12
|
| [**update_link**](LinksApi.md#update_link) | **PATCH** /links/{id} | /links/{id} |
|
12
13
|
|
13
14
|
|
14
|
-
##
|
15
|
+
## delete_link
|
15
16
|
|
16
|
-
>
|
17
|
+
> delete_link(id)
|
17
18
|
|
18
19
|
/links/{id}
|
19
20
|
|
@@ -35,27 +36,27 @@ id = 'id_example' # String | The unique ID for this link.
|
|
35
36
|
|
36
37
|
begin
|
37
38
|
# /links/{id}
|
38
|
-
api_instance.
|
39
|
+
api_instance.delete_link(id)
|
39
40
|
rescue MoneyKit::ApiError => e
|
40
|
-
puts "Error when calling LinksApi->
|
41
|
+
puts "Error when calling LinksApi->delete_link: #{e}"
|
41
42
|
end
|
42
43
|
```
|
43
44
|
|
44
|
-
#### Using the
|
45
|
+
#### Using the delete_link_with_http_info variant
|
45
46
|
|
46
47
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
47
48
|
|
48
|
-
> <Array(nil, Integer, Hash)>
|
49
|
+
> <Array(nil, Integer, Hash)> delete_link_with_http_info(id)
|
49
50
|
|
50
51
|
```ruby
|
51
52
|
begin
|
52
53
|
# /links/{id}
|
53
|
-
data, status_code, headers = api_instance.
|
54
|
+
data, status_code, headers = api_instance.delete_link_with_http_info(id)
|
54
55
|
p status_code # => 2xx
|
55
56
|
p headers # => { ... }
|
56
57
|
p data # => nil
|
57
58
|
rescue MoneyKit::ApiError => e
|
58
|
-
puts "Error when calling LinksApi->
|
59
|
+
puts "Error when calling LinksApi->delete_link_with_http_info: #{e}"
|
59
60
|
end
|
60
61
|
```
|
61
62
|
|
@@ -217,6 +218,75 @@ end
|
|
217
218
|
- **Accept**: application/json
|
218
219
|
|
219
220
|
|
221
|
+
## import_link
|
222
|
+
|
223
|
+
> <LinkResponse> import_link(import_link_request)
|
224
|
+
|
225
|
+
/links/import
|
226
|
+
|
227
|
+
Creates a new link with pre-populated accounts and transactions. The new link will be created in an initially `disconnected` state, with an error code of `auth_expired`, but all data will be available. As with any disconnected link, the imported link can then be reconnected at any time by starting a new <a href=#operation/create_link_session>/link-session</a> with `existing_link_id` set to the link's `link_id`. Note that the link can be reconnected using any suitable provider.
|
228
|
+
|
229
|
+
### Examples
|
230
|
+
|
231
|
+
```ruby
|
232
|
+
require 'time'
|
233
|
+
require 'moneykit'
|
234
|
+
# setup authorization
|
235
|
+
MoneyKit.configure do |config|
|
236
|
+
# Configure OAuth2 access token for authorization: OAuth2ClientCredentials
|
237
|
+
config.access_token = 'YOUR ACCESS TOKEN'
|
238
|
+
end
|
239
|
+
|
240
|
+
api_instance = MoneyKit::LinksApi.new
|
241
|
+
import_link_request = MoneyKit::ImportLinkRequest.new({customer_user: MoneyKit::CustomerUser.new({id: 'id_example'}), institution_id: 'chase', accounts: [MoneyKit::AccountImportData.new({account_id: '74583934', name: 'Premier Checking', type: 'depository.checking', balances: MoneyKit::AccountBalances.new})], transactions: [MoneyKit::TransactionImportData.new({account_id: '74583934', amount: '384.05', date: 3.56})]}) # ImportLinkRequest |
|
242
|
+
|
243
|
+
begin
|
244
|
+
# /links/import
|
245
|
+
result = api_instance.import_link(import_link_request)
|
246
|
+
p result
|
247
|
+
rescue MoneyKit::ApiError => e
|
248
|
+
puts "Error when calling LinksApi->import_link: #{e}"
|
249
|
+
end
|
250
|
+
```
|
251
|
+
|
252
|
+
#### Using the import_link_with_http_info variant
|
253
|
+
|
254
|
+
This returns an Array which contains the response data, status code and headers.
|
255
|
+
|
256
|
+
> <Array(<LinkResponse>, Integer, Hash)> import_link_with_http_info(import_link_request)
|
257
|
+
|
258
|
+
```ruby
|
259
|
+
begin
|
260
|
+
# /links/import
|
261
|
+
data, status_code, headers = api_instance.import_link_with_http_info(import_link_request)
|
262
|
+
p status_code # => 2xx
|
263
|
+
p headers # => { ... }
|
264
|
+
p data # => <LinkResponse>
|
265
|
+
rescue MoneyKit::ApiError => e
|
266
|
+
puts "Error when calling LinksApi->import_link_with_http_info: #{e}"
|
267
|
+
end
|
268
|
+
```
|
269
|
+
|
270
|
+
### Parameters
|
271
|
+
|
272
|
+
| Name | Type | Description | Notes |
|
273
|
+
| ---- | ---- | ----------- | ----- |
|
274
|
+
| **import_link_request** | [**ImportLinkRequest**](ImportLinkRequest.md) | | |
|
275
|
+
|
276
|
+
### Return type
|
277
|
+
|
278
|
+
[**LinkResponse**](LinkResponse.md)
|
279
|
+
|
280
|
+
### Authorization
|
281
|
+
|
282
|
+
[OAuth2ClientCredentials](../README.md#OAuth2ClientCredentials)
|
283
|
+
|
284
|
+
### HTTP request headers
|
285
|
+
|
286
|
+
- **Content-Type**: application/json
|
287
|
+
- **Accept**: application/json
|
288
|
+
|
289
|
+
|
220
290
|
## reset_login
|
221
291
|
|
222
292
|
> <LinkResponse> reset_login(id)
|
data/docs/PhoneNumber.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **number** | **String** | A phone number for the account owner. | |
|
8
|
-
| **primary** | **Boolean** | Indicates if this is the primary phone number for the account owner. | [optional]
|
8
|
+
| **primary** | **Boolean** | Indicates if this is the primary phone number for the account owner. | [optional] |
|
9
9
|
| **type** | [**PhoneNumberType**](PhoneNumberType.md) | | |
|
10
10
|
|
11
11
|
## Example
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::Response401DeleteLinkLinksIdDelete
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_code** | **Object** | | [optional] |
|
8
|
+
| **error_message** | **Object** | | |
|
9
|
+
| **documentation_url** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::Response401DeleteLinkLinksIdDelete.new(
|
17
|
+
error_code: null,
|
18
|
+
error_message: null,
|
19
|
+
documentation_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::Response401GetAccountNumbers
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_code** | **Object** | | [optional] |
|
8
|
+
| **error_message** | **Object** | | |
|
9
|
+
| **documentation_url** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::Response401GetAccountNumbers.new(
|
17
|
+
error_code: null,
|
18
|
+
error_message: null,
|
19
|
+
documentation_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::Response401GetTransactionsSyncLinksIdTransactionsSyncGet
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_code** | **Object** | | [optional] |
|
8
|
+
| **error_message** | **Object** | | |
|
9
|
+
| **documentation_url** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::Response401GetTransactionsSyncLinksIdTransactionsSyncGet.new(
|
17
|
+
error_code: null,
|
18
|
+
error_message: null,
|
19
|
+
documentation_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::Response401ImportLinkLinksImportPost
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_code** | **Object** | | [optional] |
|
8
|
+
| **error_message** | **Object** | Error message | |
|
9
|
+
| **documentation_url** | **Object** | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::Response401ImportLinkLinksImportPost.new(
|
17
|
+
error_code: null,
|
18
|
+
error_message: Accounts access not permitted,
|
19
|
+
documentation_url: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -4,15 +4,15 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **webhook_event** | **Object** | | [optional] |
|
8
7
|
| **webhook_major_version** | **Object** | | [optional] |
|
9
8
|
| **webhook_minor_version** | **Object** | | [optional] |
|
10
9
|
| **webhook_idempotency_key** | **Object** | | |
|
11
10
|
| **webhook_timestamp** | **Object** | | |
|
12
11
|
| **link_id** | **Object** | | |
|
13
12
|
| **link_tags** | **Object** | | |
|
13
|
+
| **webhook_event** | **Object** | | [optional] |
|
14
14
|
| **state** | [**LinkProductState**](LinkProductState.md) | | |
|
15
|
-
| **error** | [**
|
15
|
+
| **error** | [**PublicLinkError**](PublicLinkError.md) | | [optional] |
|
16
16
|
| **error_message** | **Object** | | [optional] |
|
17
17
|
| **product** | [**Product**](Product.md) | | |
|
18
18
|
| **state_changed_at** | **Object** | | |
|
@@ -24,13 +24,13 @@
|
|
24
24
|
require 'moneykit'
|
25
25
|
|
26
26
|
instance = MoneyKit::ResponseHandleLinkWebhookEventRequestBodyWebhookPost.new(
|
27
|
-
webhook_event: null,
|
28
27
|
webhook_major_version: null,
|
29
28
|
webhook_minor_version: null,
|
30
29
|
webhook_idempotency_key: null,
|
31
30
|
webhook_timestamp: null,
|
32
31
|
link_id: null,
|
33
32
|
link_tags: null,
|
33
|
+
webhook_event: null,
|
34
34
|
state: null,
|
35
35
|
error: null,
|
36
36
|
error_message: null,
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MoneyKit::TransactionCategoryResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **value** | **String** | Transaction category | |
|
8
|
+
| **confidence** | **Integer** | Confidence score. Estimated accuracy of this data point (as a percentage). | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'moneykit'
|
14
|
+
|
15
|
+
instance = MoneyKit::TransactionCategoryResponse.new(
|
16
|
+
value: food_and_drink,
|
17
|
+
confidence: 99
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# MoneyKit::TransactionEnrichmentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **category** | [**TransactionCategoryResponse**](TransactionCategoryResponse.md) | | |
|
8
|
+
| **subcategory** | [**TransactionSubcategoryResponse**](TransactionSubcategoryResponse.md) | | [optional] |
|
9
|
+
| **merchant** | [**TransactionMerchantResponse**](TransactionMerchantResponse.md) | | [optional] |
|
10
|
+
| **processor** | [**TransactionProcessorResponse**](TransactionProcessorResponse.md) | | [optional] |
|
11
|
+
| **recurrence** | [**TransactionRecurrenceResponse**](TransactionRecurrenceResponse.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'moneykit'
|
17
|
+
|
18
|
+
instance = MoneyKit::TransactionEnrichmentResponse.new(
|
19
|
+
category: null,
|
20
|
+
subcategory: null,
|
21
|
+
merchant: null,
|
22
|
+
processor: null,
|
23
|
+
recurrence: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MoneyKit::TransactionImportData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_id** | **String** | Your internal ID for the account this transaction belongs to. The `account_id` **must** match one of the IDs provided in the `accounts` list. | |
|
8
|
+
| **transaction_id** | **String** | Your internal ID for this transaction. If supplied, this ID will be returned as the `original_id` of the transaction in future requests. | [optional] |
|
9
|
+
| **amount** | **String** | The amount of this transaction, denominated in account currency. Use positive numbers for credits (deposits), and negative numbers of debits (withdrawals). | |
|
10
|
+
| **date** | **Date** | | |
|
11
|
+
| **description** | **String** | A description of this transaction. | [optional] |
|
12
|
+
| **type** | **String** | A type or category for this transaction. Does not need to match MoneyKit types, but see <a href=/pages/categories>Transaction Categories</a> if you want to match our current schema. | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'moneykit'
|
18
|
+
|
19
|
+
instance = MoneyKit::TransactionImportData.new(
|
20
|
+
account_id: 74583934,
|
21
|
+
transaction_id: null,
|
22
|
+
amount: 384.05,
|
23
|
+
date: null,
|
24
|
+
description: Regina's Mulberry,
|
25
|
+
type: food_and_drinks.restaurants
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MoneyKit::TransactionMerchantResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier for the merchant | [optional] |
|
8
|
+
| **name** | **String** | Merchant name | [optional] |
|
9
|
+
| **logo** | **String** | Merchant logo URL | [optional] |
|
10
|
+
| **confidence** | **Integer** | Confidence score. Estimated accuracy of this data point (as a percentage). | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'moneykit'
|
16
|
+
|
17
|
+
instance = MoneyKit::TransactionMerchantResponse.new(
|
18
|
+
id: a0822a4f-a59b-4fc9-a768-d880da5bd090,
|
19
|
+
name: Starbucks,
|
20
|
+
logo: https://example.com/starbucks.png,
|
21
|
+
confidence: 99
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# MoneyKit::TransactionProcessorResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Unique identifier for the processor | [optional] |
|
8
|
+
| **name** | **String** | Processor name | [optional] |
|
9
|
+
| **logo** | **String** | Processor logo URL | [optional] |
|
10
|
+
| **confidence** | **Integer** | Confidence score. Estimated accuracy of this data point (as a percentage). | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'moneykit'
|
16
|
+
|
17
|
+
instance = MoneyKit::TransactionProcessorResponse.new(
|
18
|
+
id: a0822a4f-a59b-4fc9-a768-d880da5bd090,
|
19
|
+
name: Square,
|
20
|
+
logo: https://example.com/square.png,
|
21
|
+
confidence: 99
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MoneyKit::TransactionRecurrenceResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **frequency** | **String** | Frequency of the recurring transaction | [optional] |
|
8
|
+
| **next_predicted_date** | **Date** | Predicted date of next transaction | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'moneykit'
|
14
|
+
|
15
|
+
instance = MoneyKit::TransactionRecurrenceResponse.new(
|
16
|
+
frequency: monthly,
|
17
|
+
next_predicted_date: 2024-08-03
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|