Skip to content

Commit 41e74c7

Browse files
author
devexperience
committed
Generated version 0.18.0
This commit was automatically created by a GitHub Action to generate version 0.18.0 of this library.
1 parent 9e34404 commit 41e74c7

16 files changed

Lines changed: 1460 additions & 3 deletions

‎.openapi-generator/FILES‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
Gemfile
44
README.md
55
Rakefile
6+
docs/AccountCreateRequest.md
7+
docs/AccountCreateRequestBody.md
68
docs/AccountNumberResponse.md
79
docs/AccountNumbersResponseBody.md
810
docs/AccountOwnerResponse.md
@@ -128,6 +130,8 @@ lib/mx-platform-ruby/api/mx_platform_api.rb
128130
lib/mx-platform-ruby/api_client.rb
129131
lib/mx-platform-ruby/api_error.rb
130132
lib/mx-platform-ruby/configuration.rb
133+
lib/mx-platform-ruby/models/account_create_request.rb
134+
lib/mx-platform-ruby/models/account_create_request_body.rb
131135
lib/mx-platform-ruby/models/account_number_response.rb
132136
lib/mx-platform-ruby/models/account_numbers_response_body.rb
133137
lib/mx-platform-ruby/models/account_owner_response.rb
@@ -252,6 +256,8 @@ mx-platform-ruby.gemspec
252256
spec/api/mx_platform_api_spec.rb
253257
spec/api_client_spec.rb
254258
spec/configuration_spec.rb
259+
spec/models/account_create_request_body_spec.rb
260+
spec/models/account_create_request_spec.rb
255261
spec/models/account_number_response_spec.rb
256262
spec/models/account_numbers_response_body_spec.rb
257263
spec/models/account_owner_response_spec.rb

‎docs/AccountCreateRequest.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# MxPlatformRuby::AccountCreateRequest
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **account_number** | **String** | | [optional] |
8+
| **apr** | **Float** | | [optional] |
9+
| **apy** | **Float** | | [optional] |
10+
| **available_balance** | **Float** | | [optional] |
11+
| **available_credit** | **Float** | | [optional] |
12+
| **balance** | **Float** | | |
13+
| **cash_surrender_value** | **Float** | | [optional] |
14+
| **credit_limit** | **Float** | | [optional] |
15+
| **currency_code** | **String** | | [optional] |
16+
| **day_payment_is_due** | **Integer** | | [optional] |
17+
| **death_benefit** | **Integer** | | [optional] |
18+
| **id** | **String** | | [optional] |
19+
| **interest_rate** | **Float** | | [optional] |
20+
| **is_closed** | **Boolean** | | [optional] |
21+
| **is_hidden** | **Boolean** | | [optional] |
22+
| **last_payment** | **Float** | | [optional] |
23+
| **last_payment_at** | **String** | | [optional] |
24+
| **loan_amount** | **Float** | | [optional] |
25+
| **matures_on** | **String** | | [optional] |
26+
| **metadata** | **String** | | [optional] |
27+
| **minimum_balance** | **Float** | | [optional] |
28+
| **minimum_payment** | **Float** | | [optional] |
29+
| **name** | **String** | | |
30+
| **nickname** | **String** | | [optional] |
31+
| **original_balance** | **Float** | | [optional] |
32+
| **payment_due_at** | **String** | | [optional] |
33+
| **payoff_balance** | **Float** | | [optional] |
34+
| **routing_number** | **String** | | [optional] |
35+
| **started_on** | **String** | | [optional] |
36+
| **subtype** | **String** | | [optional] |
37+
| **type** | **String** | | |
38+
39+
## Example
40+
41+
```ruby
42+
require 'mx-platform-ruby'
43+
44+
instance = MxPlatformRuby::AccountCreateRequest.new(
45+
account_number: 5366,
46+
apr: 1.0,
47+
apy: 1.0,
48+
available_balance: 1000.0,
49+
available_credit: 1000.0,
50+
balance: 1000.0,
51+
cash_surrender_value: 1000.0,
52+
credit_limit: 100.0,
53+
currency_code: USD,
54+
day_payment_is_due: 20,
55+
death_benefit: 1000,
56+
id: 1040434698,
57+
interest_rate: 1.0,
58+
is_closed: false,
59+
is_hidden: false,
60+
last_payment: 100.0,
61+
last_payment_at: 2015-10-13T17:57:37.000Z,
62+
loan_amount: 1000.0,
63+
matures_on: 2015-10-13T17:57:37.000Z,
64+
metadata: some metadata,
65+
minimum_balance: 100.0,
66+
minimum_payment: 10.0,
67+
name: Test account 2,
68+
nickname: Swiss Account,
69+
original_balance: 10.0,
70+
payment_due_at: 2015-10-13T17:57:37.000Z,
71+
payoff_balance: 10.0,
72+
routing_number: 68899990000000,
73+
started_on: 2015-10-13T17:57:37.000Z,
74+
subtype: NONE,
75+
type: SAVINGS
76+
)
77+
```
78+

‎docs/AccountCreateRequestBody.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# MxPlatformRuby::AccountCreateRequestBody
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **skip_webhook** | **Boolean** | | [optional] |
8+
| **account** | [**AccountCreateRequest**](AccountCreateRequest.md) | | [optional] |
9+
10+
## Example
11+
12+
```ruby
13+
require 'mx-platform-ruby'
14+
15+
instance = MxPlatformRuby::AccountCreateRequestBody.new(
16+
skip_webhook: true,
17+
account: null
18+
)
19+
```
20+

‎docs/AccountResponse.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,10 @@
2424
| **institution_code** | **String** | | [optional] |
2525
| **insured_name** | **String** | | [optional] |
2626
| **interest_rate** | **Float** | | [optional] |
27+
| **is_business** | **Boolean** | | [optional] |
2728
| **is_closed** | **Boolean** | | [optional] |
2829
| **is_hidden** | **Boolean** | | [optional] |
30+
| **is_manual** | **Boolean** | | [optional] |
2931
| **last_payment** | **Float** | | [optional] |
3032
| **last_payment_at** | **String** | | [optional] |
3133
| **loan_amount** | **Float** | | [optional] |
@@ -43,6 +45,7 @@
4345
| **payment_due_at** | **String** | | [optional] |
4446
| **payoff_balance** | **Float** | | [optional] |
4547
| **premium_amount** | **Float** | | [optional] |
48+
| **property_type** | **String** | | [optional] |
4649
| **routing_number** | **String** | | [optional] |
4750
| **started_on** | **String** | | [optional] |
4851
| **subtype** | **String** | | [optional] |
@@ -78,8 +81,10 @@ instance = MxPlatformRuby::AccountResponse.new(
7881
institution_code: chase,
7982
insured_name: Frodo Baggins,
8083
interest_rate: 1.0,
84+
is_business: false,
8185
is_closed: false,
8286
is_hidden: false,
87+
is_manual: false,
8388
last_payment: 100.0,
8489
last_payment_at: 2015-10-13T17:57:37.000Z,
8590
loan_amount: 1000.0,
@@ -97,6 +102,7 @@ instance = MxPlatformRuby::AccountResponse.new(
97102
payment_due_at: 2015-10-13T17:57:37.000Z,
98103
payoff_balance: 10.0,
99104
premium_amount: 1.0,
105+
property_type: 1,
100106
routing_number: 68899990000000,
101107
started_on: 2015-10-13T17:57:37.000Z,
102108
subtype: NONE,

‎docs/MxPlatformApi.md‎

Lines changed: 145 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ All URIs are relative to *https://api.mx.com*
1010
| [**create_managed_account**](MxPlatformApi.md#create_managed_account) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts | Create managed account |
1111
| [**create_managed_member**](MxPlatformApi.md#create_managed_member) | **POST** /users/{user_guid}/managed_members | Create managed member |
1212
| [**create_managed_transaction**](MxPlatformApi.md#create_managed_transaction) | **POST** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions | Create managed transaction |
13+
| [**create_manual_account**](MxPlatformApi.md#create_manual_account) | **POST** /users/{user_guid}/accounts | Create manual account |
1314
| [**create_member**](MxPlatformApi.md#create_member) | **POST** /users/{user_guid}/members | Create member |
1415
| [**create_tag**](MxPlatformApi.md#create_tag) | **POST** /users/{user_guid}/tags | Create tag |
1516
| [**create_tagging**](MxPlatformApi.md#create_tagging) | **POST** /users/{user_guid}/taggings | Create tagging |
@@ -19,6 +20,7 @@ All URIs are relative to *https://api.mx.com*
1920
| [**delete_managed_account**](MxPlatformApi.md#delete_managed_account) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Delete managed account |
2021
| [**delete_managed_member**](MxPlatformApi.md#delete_managed_member) | **DELETE** /users/{user_guid}/managed_members/{member_guid} | Delete managed member |
2122
| [**delete_managed_transaction**](MxPlatformApi.md#delete_managed_transaction) | **DELETE** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid}/transactions/{transaction_guid} | Delete managed transaction |
23+
| [**delete_manual_account**](MxPlatformApi.md#delete_manual_account) | **DELETE** /users/{user_guid}/accounts/{account_guid} | Delete manual account |
2224
| [**delete_member**](MxPlatformApi.md#delete_member) | **DELETE** /users/{user_guid}/members/{member_guid} | Delete member |
2325
| [**delete_tag**](MxPlatformApi.md#delete_tag) | **DELETE** /users/{user_guid}/tags/{tag_guid} | Delete tag |
2426
| [**delete_tagging**](MxPlatformApi.md#delete_tagging) | **DELETE** /users/{user_guid}/taggings/{tagging_guid} | Delete tagging |
@@ -541,6 +543,78 @@ end
541543
- **Accept**: application/vnd.mx.api.v1+json
542544

543545

546+
## create_manual_account
547+
548+
> <AccountResponseBody> create_manual_account(user_guid, account_create_request_body)
549+
550+
Create manual account
551+
552+
This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed..
553+
554+
### Examples
555+
556+
```ruby
557+
require 'time'
558+
require 'mx-platform-ruby'
559+
# setup authorization
560+
MxPlatformRuby.configure do |config|
561+
# Configure HTTP basic authorization: basicAuth
562+
config.username = 'YOUR USERNAME'
563+
config.password = 'YOUR PASSWORD'
564+
end
565+
566+
api_instance = MxPlatformRuby::MxPlatformApi.new
567+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
568+
account_create_request_body = MxPlatformRuby::AccountCreateRequestBody.new # AccountCreateRequestBody | Manual account object to be created.
569+
570+
begin
571+
# Create manual account
572+
result = api_instance.create_manual_account(user_guid, account_create_request_body)
573+
p result
574+
rescue MxPlatformRuby::ApiError => e
575+
puts "Error when calling MxPlatformApi->create_manual_account: #{e}"
576+
end
577+
```
578+
579+
#### Using the create_manual_account_with_http_info variant
580+
581+
This returns an Array which contains the response data, status code and headers.
582+
583+
> <Array(<AccountResponseBody>, Integer, Hash)> create_manual_account_with_http_info(user_guid, account_create_request_body)
584+
585+
```ruby
586+
begin
587+
# Create manual account
588+
data, status_code, headers = api_instance.create_manual_account_with_http_info(user_guid, account_create_request_body)
589+
p status_code # => 2xx
590+
p headers # => { ... }
591+
p data # => <AccountResponseBody>
592+
rescue MxPlatformRuby::ApiError => e
593+
puts "Error when calling MxPlatformApi->create_manual_account_with_http_info: #{e}"
594+
end
595+
```
596+
597+
### Parameters
598+
599+
| Name | Type | Description | Notes |
600+
| ---- | ---- | ----------- | ----- |
601+
| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
602+
| **account_create_request_body** | [**AccountCreateRequestBody**](AccountCreateRequestBody.md) | Manual account object to be created. | |
603+
604+
### Return type
605+
606+
[**AccountResponseBody**](AccountResponseBody.md)
607+
608+
### Authorization
609+
610+
[basicAuth](../README.md#basicAuth)
611+
612+
### HTTP request headers
613+
614+
- **Content-Type**: application/json
615+
- **Accept**: application/vnd.mx.api.v1+json
616+
617+
544618
## create_member
545619

546620
> <MemberResponseBody> create_member(user_guid, member_create_request_body)
@@ -1189,6 +1263,77 @@ nil (empty response body)
11891263
- **Accept**: Not defined
11901264

11911265

1266+
## delete_manual_account
1267+
1268+
> delete_manual_account(account_guid, user_guid)
1269+
1270+
Delete manual account
1271+
1272+
This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`.
1273+
1274+
### Examples
1275+
1276+
```ruby
1277+
require 'time'
1278+
require 'mx-platform-ruby'
1279+
# setup authorization
1280+
MxPlatformRuby.configure do |config|
1281+
# Configure HTTP basic authorization: basicAuth
1282+
config.username = 'YOUR USERNAME'
1283+
config.password = 'YOUR PASSWORD'
1284+
end
1285+
1286+
api_instance = MxPlatformRuby::MxPlatformApi.new
1287+
account_guid = 'ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1' # String | The unique id for an `account`.
1288+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
1289+
1290+
begin
1291+
# Delete manual account
1292+
api_instance.delete_manual_account(account_guid, user_guid)
1293+
rescue MxPlatformRuby::ApiError => e
1294+
puts "Error when calling MxPlatformApi->delete_manual_account: #{e}"
1295+
end
1296+
```
1297+
1298+
#### Using the delete_manual_account_with_http_info variant
1299+
1300+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
1301+
1302+
> <Array(nil, Integer, Hash)> delete_manual_account_with_http_info(account_guid, user_guid)
1303+
1304+
```ruby
1305+
begin
1306+
# Delete manual account
1307+
data, status_code, headers = api_instance.delete_manual_account_with_http_info(account_guid, user_guid)
1308+
p status_code # => 2xx
1309+
p headers # => { ... }
1310+
p data # => nil
1311+
rescue MxPlatformRuby::ApiError => e
1312+
puts "Error when calling MxPlatformApi->delete_manual_account_with_http_info: #{e}"
1313+
end
1314+
```
1315+
1316+
### Parameters
1317+
1318+
| Name | Type | Description | Notes |
1319+
| ---- | ---- | ----------- | ----- |
1320+
| **account_guid** | **String** | The unique id for an &#x60;account&#x60;. | |
1321+
| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
1322+
1323+
### Return type
1324+
1325+
nil (empty response body)
1326+
1327+
### Authorization
1328+
1329+
[basicAuth](../README.md#basicAuth)
1330+
1331+
### HTTP request headers
1332+
1333+
- **Content-Type**: Not defined
1334+
- **Accept**: Not defined
1335+
1336+
11921337
## delete_member
11931338

11941339
> delete_member(member_guid, user_guid)

‎lib/mx-platform-ruby.rb‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
require 'mx-platform-ruby/configuration'
1818

1919
# Models
20+
require 'mx-platform-ruby/models/account_create_request'
21+
require 'mx-platform-ruby/models/account_create_request_body'
2022
require 'mx-platform-ruby/models/account_number_response'
2123
require 'mx-platform-ruby/models/account_numbers_response_body'
2224
require 'mx-platform-ruby/models/account_owner_response'

0 commit comments

Comments
 (0)