Skip to content

Commit a9853e7

Browse files
Include updates to OpenAPI spec
Regenerates the library to pull in recent changes to our OpenAPI spec.
1 parent 67dc5ae commit a9853e7

10 files changed

Lines changed: 339 additions & 33 deletions

File tree

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 MX Technologies Inc.
3+
Copyright (c) 2022 MX Technologies Inc.
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ openapi-generator-cli generate \
7777

7878
## Contributing
7979

80-
Please [open an issue](https://github.com/mxenabled/mx-platform-java/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-java/pulls)
80+
Please [open an issue](https://github.com/mxenabled/mx-platform-ruby/issues) or [submit a pull request.](https://github.com/mxenabled/mx-platform-ruby/pulls)

docs/EnhanceTransactionResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ instance = MxPlatformRuby::EnhanceTransactionResponse.new(
5252
is_payroll_advance: false,
5353
is_subscription: false,
5454
memo: Additional-information*on_transaction,
55-
merchant_category_code: 5411,
55+
merchant_category_code: 4121,
5656
merchant_guid: MCH-14f25b63-ef47-a38e-b2b6-d02b280b6e4e,
5757
merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea,
5858
original_description: ubr* pending.uber.com,

docs/EnhanceTransactionsRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ instance = MxPlatformRuby::EnhanceTransactionsRequest.new(
2323
extended_transaction_type: partner_transaction_type,
2424
id: ID-123,
2525
memo: Additional-information*on_transaction,
26-
merchant_category_code: 123,
26+
merchant_category_code: 4121,
2727
type: DEBIT
2828
)
2929
```

docs/MxPlatformApi.md

Lines changed: 159 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ All URIs are relative to *https://api.mx.com*
3333
| [**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member |
3434
| [**list_account_owners_by_member**](MxPlatformApi.md#list_account_owners_by_member) | **GET** /users/{user_guid}/members/{member_guid}/account_owners | List account owners by member |
3535
| [**list_categories**](MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories |
36-
| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories |
36+
| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /categories/default | List default categories |
37+
| [**list_default_categories_by_user**](MxPlatformApi.md#list_default_categories_by_user) | **GET** /users/{user_guid}/categories/default | List default categories by user |
3738
| [**list_favorite_institutions**](MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions |
3839
| [**list_holdings**](MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings |
3940
| [**list_holdings_by_member**](MxPlatformApi.md#list_holdings_by_member) | **GET** /users/{user_guid}/members/{member_guid}/holdings | List holdings by member |
@@ -58,7 +59,8 @@ All URIs are relative to *https://api.mx.com*
5859
| [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts |
5960
| [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users |
6061
| [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account |
61-
| [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category |
62+
| [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read a custom category |
63+
| [**read_default_category**](MxPlatformApi.md#read_default_category) | **GET** /categories/{category_guid} | Read a default category |
6264
| [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding |
6365
| [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution |
6466
| [**read_managed_account**](MxPlatformApi.md#read_managed_account) | **GET** /users/{user_guid}/managed_members/{member_guid}/accounts/{account_guid} | Read managed account |
@@ -2199,11 +2201,11 @@ end
21992201

22002202
## list_default_categories
22012203

2202-
> <CategoriesResponseBody> list_default_categories(user_guid, opts)
2204+
> <CategoriesResponseBody> list_default_categories(opts)
22032205
22042206
List default categories
22052207

2206-
Use this endpoint to read the attributes of a specific user.
2208+
Use this endpoint to retrieve a list of all the default categories and subcategories offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
22072209

22082210
### Examples
22092211

@@ -2218,15 +2220,14 @@ MxPlatformRuby.configure do |config|
22182220
end
22192221

22202222
api_instance = MxPlatformRuby::MxPlatformApi.new
2221-
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
22222223
opts = {
22232224
page: 1, # Integer | Specify current page.
22242225
records_per_page: 10 # Integer | Specify records per page.
22252226
}
22262227

22272228
begin
22282229
# List default categories
2229-
result = api_instance.list_default_categories(user_guid, opts)
2230+
result = api_instance.list_default_categories(opts)
22302231
p result
22312232
rescue MxPlatformRuby::ApiError => e
22322233
puts "Error when calling MxPlatformApi->list_default_categories: #{e}"
@@ -2237,12 +2238,12 @@ end
22372238

22382239
This returns an Array which contains the response data, status code and headers.
22392240

2240-
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid, opts)
2241+
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(opts)
22412242
22422243
```ruby
22432244
begin
22442245
# List default categories
2245-
data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid, opts)
2246+
data, status_code, headers = api_instance.list_default_categories_with_http_info(opts)
22462247
p status_code # => 2xx
22472248
p headers # => { ... }
22482249
p data # => <CategoriesResponseBody>
@@ -2253,6 +2254,81 @@ end
22532254

22542255
### Parameters
22552256

2257+
| Name | Type | Description | Notes |
2258+
| ---- | ---- | ----------- | ----- |
2259+
| **page** | **Integer** | Specify current page. | [optional] |
2260+
| **records_per_page** | **Integer** | Specify records per page. | [optional] |
2261+
2262+
### Return type
2263+
2264+
[**CategoriesResponseBody**](CategoriesResponseBody.md)
2265+
2266+
### Authorization
2267+
2268+
[basicAuth](../README.md#basicAuth)
2269+
2270+
### HTTP request headers
2271+
2272+
- **Content-Type**: Not defined
2273+
- **Accept**: application/vnd.mx.api.v1+json
2274+
2275+
2276+
## list_default_categories_by_user
2277+
2278+
> <CategoriesResponseBody> list_default_categories_by_user(user_guid, opts)
2279+
2280+
List default categories by user
2281+
2282+
Use this endpoint to retrieve a list of all the default categories and subcategories, scoped by user, offered within the MX Platform API. In other words, each item in the returned list will have its `is_default` field set to `true`. There are currently 119 default categories and subcategories. Both the _list default categories_ and _list default categories by user_ endpoints return the same results. The different routes are provided for convenience.
2283+
2284+
### Examples
2285+
2286+
```ruby
2287+
require 'time'
2288+
require 'mx-platform-ruby'
2289+
# setup authorization
2290+
MxPlatformRuby.configure do |config|
2291+
# Configure HTTP basic authorization: basicAuth
2292+
config.username = 'YOUR USERNAME'
2293+
config.password = 'YOUR PASSWORD'
2294+
end
2295+
2296+
api_instance = MxPlatformRuby::MxPlatformApi.new
2297+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
2298+
opts = {
2299+
page: 1, # Integer | Specify current page.
2300+
records_per_page: 10 # Integer | Specify records per page.
2301+
}
2302+
2303+
begin
2304+
# List default categories by user
2305+
result = api_instance.list_default_categories_by_user(user_guid, opts)
2306+
p result
2307+
rescue MxPlatformRuby::ApiError => e
2308+
puts "Error when calling MxPlatformApi->list_default_categories_by_user: #{e}"
2309+
end
2310+
```
2311+
2312+
#### Using the list_default_categories_by_user_with_http_info variant
2313+
2314+
This returns an Array which contains the response data, status code and headers.
2315+
2316+
> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_by_user_with_http_info(user_guid, opts)
2317+
2318+
```ruby
2319+
begin
2320+
# List default categories by user
2321+
data, status_code, headers = api_instance.list_default_categories_by_user_with_http_info(user_guid, opts)
2322+
p status_code # => 2xx
2323+
p headers # => { ... }
2324+
p data # => <CategoriesResponseBody>
2325+
rescue MxPlatformRuby::ApiError => e
2326+
puts "Error when calling MxPlatformApi->list_default_categories_by_user_with_http_info: #{e}"
2327+
end
2328+
```
2329+
2330+
### Parameters
2331+
22562332
| Name | Type | Description | Notes |
22572333
| ---- | ---- | ----------- | ----- |
22582334
| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
@@ -4139,7 +4215,7 @@ end
41394215

41404216
> <CategoryResponseBody> read_category(category_guid, user_guid)
41414217
4142-
Read category
4218+
Read a custom category
41434219

41444220
Use this endpoint to read the attributes of either a default category or a custom category.
41454221

@@ -4160,7 +4236,7 @@ category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique
41604236
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
41614237

41624238
begin
4163-
# Read category
4239+
# Read a custom category
41644240
result = api_instance.read_category(category_guid, user_guid)
41654241
p result
41664242
rescue MxPlatformRuby::ApiError => e
@@ -4176,7 +4252,7 @@ This returns an Array which contains the response data, status code and headers.
41764252
41774253
```ruby
41784254
begin
4179-
# Read category
4255+
# Read a custom category
41804256
data, status_code, headers = api_instance.read_category_with_http_info(category_guid, user_guid)
41814257
p status_code # => 2xx
41824258
p headers # => { ... }
@@ -4207,6 +4283,78 @@ end
42074283
- **Accept**: application/vnd.mx.api.v1+json
42084284

42094285

4286+
## read_default_category
4287+
4288+
> <CategoryResponseBody> read_default_category(category_guid, user_guid)
4289+
4290+
Read a default category
4291+
4292+
Use this endpoint to read the attributes of a default category.
4293+
4294+
### Examples
4295+
4296+
```ruby
4297+
require 'time'
4298+
require 'mx-platform-ruby'
4299+
# setup authorization
4300+
MxPlatformRuby.configure do |config|
4301+
# Configure HTTP basic authorization: basicAuth
4302+
config.username = 'YOUR USERNAME'
4303+
config.password = 'YOUR PASSWORD'
4304+
end
4305+
4306+
api_instance = MxPlatformRuby::MxPlatformApi.new
4307+
category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
4308+
user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
4309+
4310+
begin
4311+
# Read a default category
4312+
result = api_instance.read_default_category(category_guid, user_guid)
4313+
p result
4314+
rescue MxPlatformRuby::ApiError => e
4315+
puts "Error when calling MxPlatformApi->read_default_category: #{e}"
4316+
end
4317+
```
4318+
4319+
#### Using the read_default_category_with_http_info variant
4320+
4321+
This returns an Array which contains the response data, status code and headers.
4322+
4323+
> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid, user_guid)
4324+
4325+
```ruby
4326+
begin
4327+
# Read a default category
4328+
data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid, user_guid)
4329+
p status_code # => 2xx
4330+
p headers # => { ... }
4331+
p data # => <CategoryResponseBody>
4332+
rescue MxPlatformRuby::ApiError => e
4333+
puts "Error when calling MxPlatformApi->read_default_category_with_http_info: #{e}"
4334+
end
4335+
```
4336+
4337+
### Parameters
4338+
4339+
| Name | Type | Description | Notes |
4340+
| ---- | ---- | ----------- | ----- |
4341+
| **category_guid** | **String** | The unique id for a &#x60;category&#x60;. | |
4342+
| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. | |
4343+
4344+
### Return type
4345+
4346+
[**CategoryResponseBody**](CategoryResponseBody.md)
4347+
4348+
### Authorization
4349+
4350+
[basicAuth](../README.md#basicAuth)
4351+
4352+
### HTTP request headers
4353+
4354+
- **Content-Type**: Not defined
4355+
- **Accept**: application/vnd.mx.api.v1+json
4356+
4357+
42104358
## read_holding
42114359

42124360
> <HoldingResponseBody> read_holding(holding_guid, user_guid)

0 commit comments

Comments
 (0)