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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: '037968a94cecf50506f0c4bff21d8c539da2130bce46775d2de8803110bb5c38'
|
4
|
+
data.tar.gz: 7056a6d7cd24518d110b940458a48c3671c105aef161b3fee2c72e7ee90802ec
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 728e0b3a20a0e7a76d7d82cdc9639c93a20f68d15e91df05b9c33bca0accf9c9d9bffc0e9cd6059ba054182333edbb8032cc8b40897e86604a72ab853582e3dc
|
7
|
+
data.tar.gz: 6eed503a9fa47dc1e4da80c6df5d000d330ad99e2329ca4659c33c3d168b06b9eadffa527a12af43a813b51db17ea85ba5d2384ea94979a907afbc3af190f4eb
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
data/docs/AccessTokenApi.md
CHANGED
@@ -4,14 +4,14 @@ All URIs are relative to *https://api.moneykit.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
8
|
-
| [**
|
7
|
+
| [**create_access_token**](AccessTokenApi.md#create_access_token) | **POST** /auth/token | /auth/token |
|
8
|
+
| [**get_app_jwks**](AccessTokenApi.md#get_app_jwks) | **GET** /.well-known/jwks.json | JSON Web Key Set |
|
9
9
|
| [**instrospect_client**](AccessTokenApi.md#instrospect_client) | **GET** /auth/introspect | /auth/introspect |
|
10
10
|
|
11
11
|
|
12
|
-
##
|
12
|
+
## create_access_token
|
13
13
|
|
14
|
-
> <
|
14
|
+
> <CreateAccessTokenResponse> create_access_token(opts)
|
15
15
|
|
16
16
|
/auth/token
|
17
17
|
|
@@ -39,28 +39,28 @@ opts = {
|
|
39
39
|
|
40
40
|
begin
|
41
41
|
# /auth/token
|
42
|
-
result = api_instance.
|
42
|
+
result = api_instance.create_access_token(opts)
|
43
43
|
p result
|
44
44
|
rescue MoneyKit::ApiError => e
|
45
|
-
puts "Error when calling AccessTokenApi->
|
45
|
+
puts "Error when calling AccessTokenApi->create_access_token: #{e}"
|
46
46
|
end
|
47
47
|
```
|
48
48
|
|
49
|
-
#### Using the
|
49
|
+
#### Using the create_access_token_with_http_info variant
|
50
50
|
|
51
51
|
This returns an Array which contains the response data, status code and headers.
|
52
52
|
|
53
|
-
> <Array(<
|
53
|
+
> <Array(<CreateAccessTokenResponse>, Integer, Hash)> create_access_token_with_http_info(opts)
|
54
54
|
|
55
55
|
```ruby
|
56
56
|
begin
|
57
57
|
# /auth/token
|
58
|
-
data, status_code, headers = api_instance.
|
58
|
+
data, status_code, headers = api_instance.create_access_token_with_http_info(opts)
|
59
59
|
p status_code # => 2xx
|
60
60
|
p headers # => { ... }
|
61
|
-
p data # => <
|
61
|
+
p data # => <CreateAccessTokenResponse>
|
62
62
|
rescue MoneyKit::ApiError => e
|
63
|
-
puts "Error when calling AccessTokenApi->
|
63
|
+
puts "Error when calling AccessTokenApi->create_access_token_with_http_info: #{e}"
|
64
64
|
end
|
65
65
|
```
|
66
66
|
|
@@ -75,7 +75,7 @@ end
|
|
75
75
|
|
76
76
|
### Return type
|
77
77
|
|
78
|
-
[**
|
78
|
+
[**CreateAccessTokenResponse**](CreateAccessTokenResponse.md)
|
79
79
|
|
80
80
|
### Authorization
|
81
81
|
|
@@ -87,9 +87,9 @@ end
|
|
87
87
|
- **Accept**: application/json
|
88
88
|
|
89
89
|
|
90
|
-
##
|
90
|
+
## get_app_jwks
|
91
91
|
|
92
|
-
> <JWKSet>
|
92
|
+
> <JWKSet> get_app_jwks(opts)
|
93
93
|
|
94
94
|
JSON Web Key Set
|
95
95
|
|
@@ -107,37 +107,42 @@ MoneyKit.configure do |config|
|
|
107
107
|
end
|
108
108
|
|
109
109
|
api_instance = MoneyKit::AccessTokenApi.new
|
110
|
+
opts = {
|
111
|
+
x_client_id: 'x_client_id_example' # String | Your client ID.
|
112
|
+
}
|
110
113
|
|
111
114
|
begin
|
112
115
|
# JSON Web Key Set
|
113
|
-
result = api_instance.
|
116
|
+
result = api_instance.get_app_jwks(opts)
|
114
117
|
p result
|
115
118
|
rescue MoneyKit::ApiError => e
|
116
|
-
puts "Error when calling AccessTokenApi->
|
119
|
+
puts "Error when calling AccessTokenApi->get_app_jwks: #{e}"
|
117
120
|
end
|
118
121
|
```
|
119
122
|
|
120
|
-
#### Using the
|
123
|
+
#### Using the get_app_jwks_with_http_info variant
|
121
124
|
|
122
125
|
This returns an Array which contains the response data, status code and headers.
|
123
126
|
|
124
|
-
> <Array(<JWKSet>, Integer, Hash)>
|
127
|
+
> <Array(<JWKSet>, Integer, Hash)> get_app_jwks_with_http_info(opts)
|
125
128
|
|
126
129
|
```ruby
|
127
130
|
begin
|
128
131
|
# JSON Web Key Set
|
129
|
-
data, status_code, headers = api_instance.
|
132
|
+
data, status_code, headers = api_instance.get_app_jwks_with_http_info(opts)
|
130
133
|
p status_code # => 2xx
|
131
134
|
p headers # => { ... }
|
132
135
|
p data # => <JWKSet>
|
133
136
|
rescue MoneyKit::ApiError => e
|
134
|
-
puts "Error when calling AccessTokenApi->
|
137
|
+
puts "Error when calling AccessTokenApi->get_app_jwks_with_http_info: #{e}"
|
135
138
|
end
|
136
139
|
```
|
137
140
|
|
138
141
|
### Parameters
|
139
142
|
|
140
|
-
|
143
|
+
| Name | Type | Description | Notes |
|
144
|
+
| ---- | ---- | ----------- | ----- |
|
145
|
+
| **x_client_id** | **String** | Your client ID. | [optional] |
|
141
146
|
|
142
147
|
### Return type
|
143
148
|
|
data/docs/AccountBalances.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **currency** |
|
7
|
+
| **currency** | **String** | A three-character currency code (ISO-4217 or similar, *e.g.*, `USD`, `CAD`) for the account balances. | [optional] |
|
8
8
|
| **available** | **Float** | The amount of funds available for use. Not all institutions report the available balance. <p>Note that the available balance typically does not include overdraft limits. | [optional] |
|
9
9
|
| **current** | **Float** | The total amount of funds in the account. <p>For credit or loan accounts, a positive number indicates the amount owed by the account holder. If the balance is negative (this is rare), this indicates an amount owed **to** the account holder. <p>For depository or investment accounts, a positive number is the asset value of the account. If the balance is negative (this is rare), this indicates an overdraft or margin condition. | [optional] |
|
10
10
|
| **limit** | **Float** | The credit limit on the account. Typically this exists only for credit-type accounts. <p>In some cases, this may represent the overdraft limit for depository accounts. | [optional] |
|
@@ -16,7 +16,7 @@
|
|
16
16
|
require 'moneykit'
|
17
17
|
|
18
18
|
instance = MoneyKit::AccountBalances.new(
|
19
|
-
currency:
|
19
|
+
currency: USD,
|
20
20
|
available: 340.12,
|
21
21
|
current: 445.89,
|
22
22
|
limit: 500,
|
data/docs/AccountGroup.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accounts** | [**Array<
|
7
|
+
| **accounts** | [**Array<AccountResponse>**](AccountResponse.md) | | |
|
8
8
|
| **last_synced_at** | **Time** | An ISO-8601 timestamp indicating the last time that the account was updated. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
data/docs/AccountIdentity.md
CHANGED
@@ -9,6 +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. | |
|
10
10
|
| **account_mask** | **String** | The last four characters (usually digits) of the account number. Note that this mask may be non-unique between accounts. | [optional] |
|
11
11
|
| **balances** | [**AccountBalances**](AccountBalances.md) | | |
|
12
|
+
| **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
|
12
13
|
| **owners** | [**Array<Owner>**](Owner.md) | | |
|
13
14
|
|
14
15
|
## Example
|
@@ -22,6 +23,7 @@ instance = MoneyKit::AccountIdentity.new(
|
|
22
23
|
name: Premier Checking,
|
23
24
|
account_mask: 3748,
|
24
25
|
balances: null,
|
26
|
+
original_id: null,
|
25
27
|
owners: null
|
26
28
|
)
|
27
29
|
```
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# MoneyKit::AccountImportData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_id** | **String** | Your internal ID for this account. Must be unique within the imported account batch. | |
|
8
|
+
| **name** | **String** | The account name. This value may change if synced with a data provider later. | |
|
9
|
+
| **type** | **String** | The account type. It can have any initial value but it will be converted to a MoneyKit account type (see <a href=/pages/account_types>Account Types</a>) upon output. The account may change types if it is synced with a data provider later. | |
|
10
|
+
| **mask** | **String** | The last four characters (usually digits) of the account number. This field can be omitted, but you are strongly encouraged to supply it because it is the most important factor for properly connecting new data to this account if it is synced with a data provider later. | [optional] |
|
11
|
+
| **balances** | [**AccountBalances**](AccountBalances.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'moneykit'
|
17
|
+
|
18
|
+
instance = MoneyKit::AccountImportData.new(
|
19
|
+
account_id: 74583934,
|
20
|
+
name: Premier Checking,
|
21
|
+
type: depository.checking,
|
22
|
+
mask: 3748,
|
23
|
+
balances: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/AccountNumbersApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.moneykit.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
7
|
+
| [**get_account_numbers**](AccountNumbersApi.md#get_account_numbers) | **GET** /links/{id}/accounts/numbers | /links/{id}/accounts/numbers |
|
8
8
|
|
9
9
|
|
10
|
-
##
|
10
|
+
## get_account_numbers
|
11
11
|
|
12
|
-
> <GetAccountNumbersResponseLegacy20230218>
|
12
|
+
> <GetAccountNumbersResponseLegacy20230218> get_account_numbers(id)
|
13
13
|
|
14
14
|
/links/{id}/accounts/numbers
|
15
15
|
|
@@ -31,28 +31,28 @@ id = 'id_example' # String | The unique ID for this link.
|
|
31
31
|
|
32
32
|
begin
|
33
33
|
# /links/{id}/accounts/numbers
|
34
|
-
result = api_instance.
|
34
|
+
result = api_instance.get_account_numbers(id)
|
35
35
|
p result
|
36
36
|
rescue MoneyKit::ApiError => e
|
37
|
-
puts "Error when calling AccountNumbersApi->
|
37
|
+
puts "Error when calling AccountNumbersApi->get_account_numbers: #{e}"
|
38
38
|
end
|
39
39
|
```
|
40
40
|
|
41
|
-
#### Using the
|
41
|
+
#### Using the get_account_numbers_with_http_info variant
|
42
42
|
|
43
43
|
This returns an Array which contains the response data, status code and headers.
|
44
44
|
|
45
|
-
> <Array(<GetAccountNumbersResponseLegacy20230218>, Integer, Hash)>
|
45
|
+
> <Array(<GetAccountNumbersResponseLegacy20230218>, Integer, Hash)> get_account_numbers_with_http_info(id)
|
46
46
|
|
47
47
|
```ruby
|
48
48
|
begin
|
49
49
|
# /links/{id}/accounts/numbers
|
50
|
-
data, status_code, headers = api_instance.
|
50
|
+
data, status_code, headers = api_instance.get_account_numbers_with_http_info(id)
|
51
51
|
p status_code # => 2xx
|
52
52
|
p headers # => { ... }
|
53
53
|
p data # => <GetAccountNumbersResponseLegacy20230218>
|
54
54
|
rescue MoneyKit::ApiError => e
|
55
|
-
puts "Error when calling AccountNumbersApi->
|
55
|
+
puts "Error when calling AccountNumbersApi->get_account_numbers_with_http_info: #{e}"
|
56
56
|
end
|
57
57
|
```
|
58
58
|
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# MoneyKit::AccountResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_id** | **String** | MoneyKit's unique ID for the account. <p>The `account_id` is distinct from the institution's account number. For accounts that may change account numbers from time to time, such as credit cards, MoneyKit attempts to keep the `account_id` constant. However, if MoneyKit can't reconcile the new account data with the old data, the `account_id` may change. | |
|
8
|
+
| **account_type** | **String** | See <a href=/pages/account_types>Account Types</a> for an explanation of account types. Account types are dot-prefixed with one of `depository`, `investment`, `liability`, or `other`; or the value is `unknown`. <p>**Balances for `liability` accounts are reversed:** negative balances (the amount owed) are reported as positive values. For all other types of accounts, a negative balance indicates the amount owed. | |
|
9
|
+
| **name** | **String** | The account name, according to the institution. Note that some institutions allow the end user to nickname the account; in such cases this field may be the name assigned by the user. | |
|
10
|
+
| **account_mask** | **String** | The last four characters (usually digits) of the account number. Note that this mask may be non-unique between accounts. | [optional] |
|
11
|
+
| **balances** | [**AccountBalances**](AccountBalances.md) | | |
|
12
|
+
| **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'moneykit'
|
18
|
+
|
19
|
+
instance = MoneyKit::AccountResponse.new(
|
20
|
+
account_id: acc_6Tef269B6ZArSVpYrxtjBV,
|
21
|
+
account_type: depository.checking,
|
22
|
+
name: Premier Checking,
|
23
|
+
account_mask: 3748,
|
24
|
+
balances: null,
|
25
|
+
original_id: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -9,6 +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. | |
|
10
10
|
| **account_mask** | **String** | The last four characters (usually digits) of the account number. Note that this mask may be non-unique between accounts. | [optional] |
|
11
11
|
| **balances** | [**AccountBalances**](AccountBalances.md) | | |
|
12
|
+
| **original_id** | **String** | The original ID of this account, if supplied (by you) during an import. | [optional] |
|
12
13
|
| **numbers** | [**AccountNumbersLegacy20230218**](AccountNumbersLegacy20230218.md) | | |
|
13
14
|
|
14
15
|
## Example
|
@@ -22,6 +23,7 @@ instance = MoneyKit::AccountWithAccountNumbersLegacy20230218.new(
|
|
22
23
|
name: Premier Checking,
|
23
24
|
account_mask: 3748,
|
24
25
|
balances: null,
|
26
|
+
original_id: null,
|
25
27
|
numbers: null
|
26
28
|
)
|
27
29
|
```
|
data/docs/AccountsApi.md
CHANGED
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.moneykit.com*
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**get_account**](AccountsApi.md#get_account) | **GET** /links/{id}/accounts/{account_id} | /links/{id}/accounts/{account_id} |
|
8
|
-
| [**
|
8
|
+
| [**get_account_numbers**](AccountsApi.md#get_account_numbers) | **GET** /links/{id}/accounts/numbers | /links/{id}/accounts/numbers |
|
9
9
|
| [**get_accounts**](AccountsApi.md#get_accounts) | **GET** /links/{id}/accounts | /links/{id}/accounts |
|
10
10
|
| [**get_user_accounts**](AccountsApi.md#get_user_accounts) | **GET** /users/{id}/accounts | /users/{id}/accounts |
|
11
11
|
|
@@ -81,9 +81,9 @@ end
|
|
81
81
|
- **Accept**: application/json
|
82
82
|
|
83
83
|
|
84
|
-
##
|
84
|
+
## get_account_numbers
|
85
85
|
|
86
|
-
> <GetAccountNumbersResponseLegacy20230218>
|
86
|
+
> <GetAccountNumbersResponseLegacy20230218> get_account_numbers(id)
|
87
87
|
|
88
88
|
/links/{id}/accounts/numbers
|
89
89
|
|
@@ -105,28 +105,28 @@ id = 'id_example' # String | The unique ID for this link.
|
|
105
105
|
|
106
106
|
begin
|
107
107
|
# /links/{id}/accounts/numbers
|
108
|
-
result = api_instance.
|
108
|
+
result = api_instance.get_account_numbers(id)
|
109
109
|
p result
|
110
110
|
rescue MoneyKit::ApiError => e
|
111
|
-
puts "Error when calling AccountsApi->
|
111
|
+
puts "Error when calling AccountsApi->get_account_numbers: #{e}"
|
112
112
|
end
|
113
113
|
```
|
114
114
|
|
115
|
-
#### Using the
|
115
|
+
#### Using the get_account_numbers_with_http_info variant
|
116
116
|
|
117
117
|
This returns an Array which contains the response data, status code and headers.
|
118
118
|
|
119
|
-
> <Array(<GetAccountNumbersResponseLegacy20230218>, Integer, Hash)>
|
119
|
+
> <Array(<GetAccountNumbersResponseLegacy20230218>, Integer, Hash)> get_account_numbers_with_http_info(id)
|
120
120
|
|
121
121
|
```ruby
|
122
122
|
begin
|
123
123
|
# /links/{id}/accounts/numbers
|
124
|
-
data, status_code, headers = api_instance.
|
124
|
+
data, status_code, headers = api_instance.get_account_numbers_with_http_info(id)
|
125
125
|
p status_code # => 2xx
|
126
126
|
p headers # => { ... }
|
127
127
|
p data # => <GetAccountNumbersResponseLegacy20230218>
|
128
128
|
rescue MoneyKit::ApiError => e
|
129
|
-
puts "Error when calling AccountsApi->
|
129
|
+
puts "Error when calling AccountsApi->get_account_numbers_with_http_info: #{e}"
|
130
130
|
end
|
131
131
|
```
|
132
132
|
|
data/docs/Address.md
CHANGED
@@ -9,7 +9,7 @@
|
|
9
9
|
| **postal_code** | **String** | The postal or zip code of the address. | [optional] |
|
10
10
|
| **region** | **String** | The region or state of the address. | [optional] |
|
11
11
|
| **street** | **String** | The street of the address. | [optional] |
|
12
|
-
| **primary** | **Boolean** | Indicates if this is the primary address for the account owner. | [optional]
|
12
|
+
| **primary** | **Boolean** | Indicates if this is the primary address for the account owner. | [optional] |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
data/docs/AppClientResponse.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **client_id** | **String** | The client's client ID. | |
|
8
|
-
| **client_name** | **String** | Friendly client name for identification. | |
|
8
|
+
| **client_name** | **String** | (deprecated) Friendly client name for identification. | |
|
9
9
|
| **scope** | **String** | Actions allowed by this client. | |
|
10
10
|
| **app** | [**AppResponse**](AppResponse.md) | | |
|
11
11
|
| **disabled_at** | **Time** | Set to timestamp if the client has been disabled. | [optional] |
|
@@ -17,7 +17,7 @@ require 'moneykit'
|
|
17
17
|
|
18
18
|
instance = MoneyKit::AppClientResponse.new(
|
19
19
|
client_id: live_5c739a369515e10fc9e0,
|
20
|
-
client_name:
|
20
|
+
client_name: unused,
|
21
21
|
scope: null,
|
22
22
|
app: null,
|
23
23
|
disabled_at: null
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# MoneyKit::AppLinkStateChangedWebhook
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **webhook_major_version** | **Integer** | | [optional][default to WEBHOOK_MAJOR_VERSION::N1] |
|
8
|
+
| **webhook_minor_version** | **Integer** | | [optional][default to WEBHOOK_MINOR_VERSION::N0] |
|
9
|
+
| **webhook_idempotency_key** | **String** | | |
|
10
|
+
| **webhook_timestamp** | **Time** | | |
|
11
|
+
| **link_id** | **String** | | |
|
12
|
+
| **link_tags** | **Array<String>** | | |
|
13
|
+
| **webhook_event** | **String** | | [optional][default to 'link.state_changed'] |
|
14
|
+
| **state** | [**PublicLinkState**](PublicLinkState.md) | | |
|
15
|
+
| **error** | [**PublicLinkError**](PublicLinkError.md) | | [optional] |
|
16
|
+
| **error_message** | **String** | | [optional] |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'moneykit'
|
22
|
+
|
23
|
+
instance = MoneyKit::AppLinkStateChangedWebhook.new(
|
24
|
+
webhook_major_version: null,
|
25
|
+
webhook_minor_version: null,
|
26
|
+
webhook_idempotency_key: null,
|
27
|
+
webhook_timestamp: null,
|
28
|
+
link_id: null,
|
29
|
+
link_tags: null,
|
30
|
+
webhook_event: null,
|
31
|
+
state: null,
|
32
|
+
error: null,
|
33
|
+
error_message: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
data/docs/AppResponse.md
CHANGED
data/docs/Body.md
CHANGED
@@ -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::Body.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,22 @@
|
|
1
|
+
# MoneyKit::CreateAccessTokenResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **access_token** | **String** | Short-lived access token. | |
|
8
|
+
| **token_type** | **String** | Always \"bearer\". | |
|
9
|
+
| **expires_in** | **Integer** | How long until `access_token` expires in seconds. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::CreateAccessTokenResponse.new(
|
17
|
+
access_token: 52ea3d1b4f9a53fffb67...,
|
18
|
+
token_type: bearer,
|
19
|
+
expires_in: 3600
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **settings** | [**LinkSessionSettingOverrides**](LinkSessionSettingOverrides.md) | | [optional] |
|
8
|
-
| **customer_user** | [**
|
8
|
+
| **customer_user** | [**CustomerUser**](CustomerUser.md) | | |
|
9
9
|
| **existing_link_id** | **String** | Supply the existing `link_id` if you are asking the user to reconnect or modify this link. <p>When reconnecting, if new accounts are discovered they will be presented to the user so permission to access them can be granted (or denied). Access to previously permitted accounts is not revokable at this point. <p>If necessary, MoneyKit may attempt to reconnect the account using a different provider than the link was originally connected through. The change in provider is generally seamless. MoneyKit normalizes incoming data to minimize provider-specific differences, and we deduplicate new transactions, so data continuity is generally assured; however, small discrepancies can still occur. <p>A reconnection cannot change the institution, the customer_user.id, or the country for an existing link. These parameters will be silently ignored if `existing_link_id` is supplied. <p>New products can be added to an existing link. The user will be asked for permission for any added products. Existing product settings, however, cannot be changed and will be silently ignored. <p>The `webhook` for an existing link **can** be changed, and the existing webhook will be **removed** if the `webhook` parameter is omitted, so you should supply the `webhook` URL if you want to receive webhook events for the reconnected link. <p>Similarly, a reconnected link will be assigned whatever `link_tags` are supplied, and existing tags will be removed if `link_tags` is omitted, so you should supply the `link_tags` you want the link to have, if any. | [optional] |
|
10
10
|
| **institution_id** | **String** | The ID of the institution you want to link to. Providing this will skip the institution selection step. This field is ignored if `existing_link_id` is provided. | [optional] |
|
11
11
|
| **redirect_uri** | **String** | For Oauth linking, a URI indicating the destination, in your application, where the user should be sent after authenticating with the institution. The `redirect_uri` should not contain any query parameters, and it must be pre-approved by MoneyKit during the app setup process. | |
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::CustomerUser
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Your own unique ID for this user. Typically this will be a UUID or primary key from your application. | |
|
8
|
+
| **email** | [**CustomerUserEmail**](CustomerUserEmail.md) | | [optional] |
|
9
|
+
| **phone** | [**CustomerUserPhone**](CustomerUserPhone.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::CustomerUser.new(
|
17
|
+
id: null,
|
18
|
+
email: null,
|
19
|
+
phone: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# MoneyKit::CustomerUserEmail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **address** | **String** | The user's email address. | |
|
8
|
+
| **customer_verified_at** | **Time** | Optional timestamp that marks when you last verified this email (such as when the user most recently clicked a verification url sent to this address). Only include this field if you verified the address. You may supply zeros if the time (but not the date) is unknown. | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'moneykit'
|
14
|
+
|
15
|
+
instance = MoneyKit::CustomerUserEmail.new(
|
16
|
+
address: null,
|
17
|
+
customer_verified_at: 2023-02-16T00:00:00
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# MoneyKit::CustomerUserPhone
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **number** | **String** | The user's phone number, preferably in E164 format, including the country code. | |
|
8
|
+
| **country** | [**Country**](Country.md) | | [optional] |
|
9
|
+
| **customer_verified_at** | **Time** | Optional timestamp that marks when you last verified this number (such as when the user most recently returned a verification code sent via SMS to this number). Only include this field if you verified the number. You may supply zeros if the time (but not the date) is unknown. | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'moneykit'
|
15
|
+
|
16
|
+
instance = MoneyKit::CustomerUserPhone.new(
|
17
|
+
number: +16175551212,
|
18
|
+
country: null,
|
19
|
+
customer_verified_at: 2023-02-16T00:00:00
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/Date.md
ADDED
data/docs/Email.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **address** | **String** | An email address for the account owner. | |
|
8
|
-
| **primary** | **Boolean** | Indicates if this is the primary email address for the account owner. | [optional]
|
8
|
+
| **primary** | **Boolean** | Indicates if this is the primary email address for the account owner. | [optional] |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/GetAccountResponse.md
CHANGED
data/docs/GetAccountsResponse.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **accounts** | [**Array<
|
7
|
+
| **accounts** | [**Array<AccountResponse>**](AccountResponse.md) | | |
|
8
8
|
| **link** | [**LinkCommon**](LinkCommon.md) | | |
|
9
9
|
|
10
10
|
## Example
|