Skip to content

Commit 0883fad

Browse files
author
Brett Mortensen
committed
Add docs
Add `/docs` directory which can be linked to through the README.
1 parent f5ea6f4 commit 0883fad

100 files changed

Lines changed: 7546 additions & 6 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.openapi-generator/FILES‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,102 @@
33
Gemfile
44
README.md
55
Rakefile
6+
docs/Account.md
7+
docs/AccountNumber.md
8+
docs/AccountNumbersResponseBody.md
9+
docs/AccountOwner.md
10+
docs/AccountOwnersResponseBody.md
11+
docs/AccountResponseBody.md
12+
docs/AccountUpdateRequest.md
13+
docs/AccountUpdateRequestBody.md
14+
docs/AccountsResponseBody.md
15+
docs/CategoriesResponseBody.md
16+
docs/Category.md
17+
docs/CategoryCreateRequest.md
18+
docs/CategoryCreateRequestBody.md
19+
docs/CategoryResponseBody.md
20+
docs/CategoryUpdateRequest.md
21+
docs/CategoryUpdateRequestBody.md
22+
docs/Challenge.md
23+
docs/ChallengeImageOptions.md
24+
docs/ChallengeOptions.md
25+
docs/ChallengesResponseBody.md
26+
docs/ConnectWidget.md
27+
docs/ConnectWidgetRequest.md
28+
docs/ConnectWidgetRequestBody.md
29+
docs/ConnectWidgetResponseBody.md
30+
docs/Credential.md
31+
docs/CredentialRequest.md
32+
docs/CredentialsResponseBody.md
33+
docs/EnhanceTransaction.md
34+
docs/EnhanceTransactionsRequest.md
35+
docs/EnhanceTransactionsRequestBody.md
36+
docs/EnhanceTransactionsResponseBody.md
37+
docs/Holding.md
38+
docs/HoldingResponseBody.md
39+
docs/HoldingsResponseBody.md
40+
docs/InlineResponse200.md
41+
docs/Institution.md
42+
docs/InstitutionResponseBody.md
43+
docs/InstitutionsResponseBody.md
44+
docs/Member.md
45+
docs/MemberCreateRequest.md
46+
docs/MemberCreateRequestBody.md
47+
docs/MemberResponseBody.md
48+
docs/MemberResumeRequest.md
49+
docs/MemberResumeRequestBody.md
50+
docs/MemberStatus.md
51+
docs/MemberStatusResponseBody.md
52+
docs/MemberUpdateRequest.md
53+
docs/MemberUpdateRequestBody.md
54+
docs/MembersResponseBody.md
55+
docs/Merchant.md
56+
docs/MerchantResponseBody.md
57+
docs/MerchantsResponseBody.md
58+
docs/MxPlatformApi.md
59+
docs/OAuthWindow.md
60+
docs/OAuthWindowResponseBody.md
61+
docs/Pagination.md
62+
docs/Statement.md
63+
docs/StatementResponseBody.md
64+
docs/StatementsResponseBody.md
65+
docs/Tag.md
66+
docs/TagCreateRequest.md
67+
docs/TagCreateRequestBody.md
68+
docs/TagResponseBody.md
69+
docs/TagUpdateRequest.md
70+
docs/TagUpdateRequestBody.md
71+
docs/Tagging.md
72+
docs/TaggingCreateRequest.md
73+
docs/TaggingCreateRequestBody.md
74+
docs/TaggingResponseBody.md
75+
docs/TaggingUpdateRequest.md
76+
docs/TaggingUpdateRequestBody.md
77+
docs/TaggingsResponseBody.md
78+
docs/TagsResponseBody.md
79+
docs/Transaction.md
80+
docs/TransactionResponseBody.md
81+
docs/TransactionRule.md
82+
docs/TransactionRuleCreateRequest.md
83+
docs/TransactionRuleCreateRequestBody.md
84+
docs/TransactionRuleResponseBody.md
85+
docs/TransactionRuleUpdateRequest.md
86+
docs/TransactionRuleUpdateRequestBody.md
87+
docs/TransactionRulesResponseBody.md
88+
docs/TransactionUpdateRequest.md
89+
docs/TransactionUpdateRequestBody.md
90+
docs/TransactionsResponseBody.md
91+
docs/User.md
92+
docs/UserCreateRequest.md
93+
docs/UserCreateRequestBody.md
94+
docs/UserResponseBody.md
95+
docs/UserUpdateRequest.md
96+
docs/UserUpdateRequestBody.md
97+
docs/UsersResponseBody.md
98+
docs/Widget.md
99+
docs/WidgetRequest.md
100+
docs/WidgetRequestBody.md
101+
docs/WidgetResponseBody.md
6102
lib/mx-platform-ruby.rb
7103
lib/mx-platform-ruby/api/mx_platform_api.rb
8104
lib/mx-platform-ruby/api_client.rb

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The MX Platform API is a powerful, fully-featured API designed to make aggregati
77
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
88

99
- API version: 0.1.0
10-
- Package version: 0.2.0
10+
- Package version: 0.2.1
1111
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
1212
For more information, please visit [https://www.mx.com/products/platform-api](https://www.mx.com/products/platform-api)
1313

@@ -24,16 +24,16 @@ gem build mx-platform-ruby.gemspec
2424
Then either install the gem locally:
2525

2626
```shell
27-
gem install ./mx-platform-ruby-0.2.0.gem
27+
gem install ./mx-platform-ruby-0.2.1.gem
2828
```
2929

30-
(for development, run `gem install --dev ./mx-platform-ruby-0.2.0.gem` to install the development dependencies)
30+
(for development, run `gem install --dev ./mx-platform-ruby-0.2.1.gem` to install the development dependencies)
3131

3232
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
3333

3434
Finally add this to the Gemfile:
3535

36-
gem 'mx-platform-ruby', '~> 0.2.0'
36+
gem 'mx-platform-ruby', '~> 0.2.1'
3737

3838
### Install from Git
3939

‎docs/Account.md‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# MxPlatformRuby::Account
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** | | [optional] |
13+
| **cash_balance** | **Float** | | [optional] |
14+
| **cash_surrender_value** | **Float** | | [optional] |
15+
| **created_at** | **String** | | [optional] |
16+
| **credit_limit** | **Float** | | [optional] |
17+
| **currency_code** | **String** | | [optional] |
18+
| **day_payment_is_due** | **Integer** | | [optional] |
19+
| **death_benefit** | **Integer** | | [optional] |
20+
| **guid** | **String** | | [optional] |
21+
| **holdings_value** | **Float** | | [optional] |
22+
| **id** | **String** | | [optional] |
23+
| **institution_code** | **String** | | [optional] |
24+
| **insured_name** | **String** | | [optional] |
25+
| **interest_rate** | **Float** | | [optional] |
26+
| **is_closed** | **Boolean** | | [optional] |
27+
| **is_hidden** | **Boolean** | | [optional] |
28+
| **last_payment** | **Float** | | [optional] |
29+
| **last_payment_at** | **String** | | [optional] |
30+
| **loan_amount** | **Float** | | [optional] |
31+
| **matures_on** | **String** | | [optional] |
32+
| **member_guid** | **String** | | [optional] |
33+
| **minimum_balance** | **Float** | | [optional] |
34+
| **minimum_payment** | **Float** | | [optional] |
35+
| **name** | **String** | | [optional] |
36+
| **original_balance** | **Float** | | [optional] |
37+
| **pay_out_amount** | **Float** | | [optional] |
38+
| **payment_due_at** | **String** | | [optional] |
39+
| **payoff_balance** | **Float** | | [optional] |
40+
| **premium_amount** | **Float** | | [optional] |
41+
| **started_on** | **String** | | [optional] |
42+
| **subtype** | **String** | | [optional] |
43+
| **total_account_value** | **Float** | | [optional] |
44+
| **type** | **String** | | [optional] |
45+
| **updated_at** | **String** | | [optional] |
46+
| **user_guid** | **String** | | [optional] |
47+
48+
## Example
49+
50+
```ruby
51+
require 'mx-platform-ruby'
52+
53+
instance = MxPlatformRuby::Account.new(
54+
account_number: 5366,
55+
apr: 1.0,
56+
apy: 1.0,
57+
available_balance: 1000.0,
58+
available_credit: 1000.0,
59+
balance: 1000.0,
60+
cash_balance: 1000.0,
61+
cash_surrender_value: 1000.0,
62+
created_at: 2016-10-13T17:57:37.000Z,
63+
credit_limit: 100.0,
64+
currency_code: USD,
65+
day_payment_is_due: 20,
66+
death_benefit: 1000,
67+
guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
68+
holdings_value: 1000.0,
69+
id: 1040434698,
70+
institution_code: chase,
71+
insured_name: Frodo Baggins,
72+
interest_rate: 1.0,
73+
is_closed: false,
74+
is_hidden: false,
75+
last_payment: 100.0,
76+
last_payment_at: 2015-10-13T17:57:37.000Z,
77+
loan_amount: 1000.0,
78+
matures_on: 2015-10-13T17:57:37.000Z,
79+
member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
80+
minimum_balance: 100.0,
81+
minimum_payment: 10.0,
82+
name: Test account 2,
83+
original_balance: 10.0,
84+
pay_out_amount: 10.0,
85+
payment_due_at: 2015-10-13T17:57:37.000Z,
86+
payoff_balance: 10.0,
87+
premium_amount: 1.0,
88+
started_on: 2015-10-13T17:57:37.000Z,
89+
subtype: NONE,
90+
total_account_value: 1.0,
91+
type: SAVINGS,
92+
updated_at: 2016-10-13T18:08:00.000Z,
93+
user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
94+
)
95+
```
96+

‎docs/AccountNumber.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# MxPlatformRuby::AccountNumber
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **account_guid** | **String** | | [optional] |
8+
| **account_number** | **String** | | [optional] |
9+
| **guid** | **String** | | [optional] |
10+
| **institution_number** | **String** | | [optional] |
11+
| **member_guid** | **String** | | [optional] |
12+
| **routing_number** | **String** | | [optional] |
13+
| **transit_number** | **String** | | [optional] |
14+
| **user_guid** | **String** | | [optional] |
15+
16+
## Example
17+
18+
```ruby
19+
require 'mx-platform-ruby'
20+
21+
instance = MxPlatformRuby::AccountNumber.new(
22+
account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
23+
account_number: 10001,
24+
guid: ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f,
25+
institution_number: 123,
26+
member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
27+
routing_number: 68899990000000,
28+
transit_number: 12345,
29+
user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
30+
)
31+
```
32+

‎docs/AccountNumbersResponseBody.md‎

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

‎docs/AccountOwner.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# MxPlatformRuby::AccountOwner
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **account_guid** | **String** | | [optional] |
8+
| **address** | **String** | | [optional] |
9+
| **city** | **String** | | [optional] |
10+
| **country** | **String** | | [optional] |
11+
| **email** | **String** | | [optional] |
12+
| **guid** | **String** | | [optional] |
13+
| **member_guid** | **String** | | [optional] |
14+
| **owner_name** | **String** | | [optional] |
15+
| **phone** | **String** | | [optional] |
16+
| **postal_code** | **String** | | [optional] |
17+
| **state** | **String** | | [optional] |
18+
| **user_guid** | **String** | | [optional] |
19+
20+
## Example
21+
22+
```ruby
23+
require 'mx-platform-ruby'
24+
25+
instance = MxPlatformRuby::AccountOwner.new(
26+
account_guid: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1,
27+
address: 123 This Way,
28+
city: Middlesex,
29+
country: US,
30+
email: donnie@darko.co,
31+
guid: ACO-63dc7714-6fc0-4aa2-a069-c06cdccd1af9,
32+
member_guid: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b,
33+
owner_name: Donnie Darko,
34+
phone: 555-555-5555,
35+
postal_code: 00000-0000,
36+
state: VA,
37+
user_guid: USR-fa7537f3-48aa-a683-a02a-b18940482f54
38+
)
39+
```
40+

‎docs/AccountOwnersResponseBody.md‎

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

‎docs/AccountResponseBody.md‎

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

‎docs/AccountUpdateRequest.md‎

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

0 commit comments

Comments
 (0)