Merge pull request #40 from mxenabled/bm/openapi_update

Include updates to OpenAPI spec

Author: brettmortensen

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 MX Technologies Inc.
+Copyright (c) 2022 MX Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -77,4 +77,4 @@ openapi-generator-cli generate \
 
 ## Contributing
 
-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)
+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

@@ -52,7 +52,7 @@ instance = MxPlatformRuby::EnhanceTransactionResponse.new(
   is_payroll_advance: false,
   is_subscription: false,
   memo: Additional-information*on_transaction,
-  merchant_category_code: 5411,
+  merchant_category_code: 4121,
   merchant_guid: MCH-14f25b63-ef47-a38e-b2b6-d02b280b6e4e,
   merchant_location_guid: MCL-00024e59-18b5-4d79-b879-2a7896726fea,
   original_description: ubr* pending.uber.com,

docs/EnhanceTransactionsRequest.md

@@ -23,7 +23,7 @@ instance = MxPlatformRuby::EnhanceTransactionsRequest.new(
   extended_transaction_type: partner_transaction_type,
   id: ID-123,
   memo: Additional-information*on_transaction,
-  merchant_category_code: 123,
+  merchant_category_code: 4121,
   type: DEBIT
 )
 ```

docs/MxPlatformApi.md

@@ -33,7 +33,8 @@ All URIs are relative to *https://api.mx.com*
 | [**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 |
 | [**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 |
 | [**list_categories**](MxPlatformApi.md#list_categories) | **GET** /users/{user_guid}/categories | List categories |
-| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /users/{user_guid}/categories/default | List default categories |
+| [**list_default_categories**](MxPlatformApi.md#list_default_categories) | **GET** /categories/default | List default categories |
+| [**list_default_categories_by_user**](MxPlatformApi.md#list_default_categories_by_user) | **GET** /users/{user_guid}/categories/default | List default categories by user |
 | [**list_favorite_institutions**](MxPlatformApi.md#list_favorite_institutions) | **GET** /institutions/favorites | List favorite institutions |
 | [**list_holdings**](MxPlatformApi.md#list_holdings) | **GET** /users/{user_guid}/holdings | List holdings |
 | [**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*
 | [**list_user_accounts**](MxPlatformApi.md#list_user_accounts) | **GET** /users/{user_guid}/accounts | List accounts |
 | [**list_users**](MxPlatformApi.md#list_users) | **GET** /users | List users |
 | [**read_account**](MxPlatformApi.md#read_account) | **GET** /users/{user_guid}/accounts/{account_guid} | Read account |
-| [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read category |
+| [**read_category**](MxPlatformApi.md#read_category) | **GET** /users/{user_guid}/categories/{category_guid} | Read a custom category |
+| [**read_default_category**](MxPlatformApi.md#read_default_category) | **GET** /categories/{category_guid} | Read a default category |
 | [**read_holding**](MxPlatformApi.md#read_holding) | **GET** /users/{user_guid}/holdings/{holding_guid} | Read holding |
 | [**read_institution**](MxPlatformApi.md#read_institution) | **GET** /institutions/{institution_code} | Read institution |
 | [**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
 
 ## list_default_categories
 
-> <CategoriesResponseBody> list_default_categories(user_guid, opts)
+> <CategoriesResponseBody> list_default_categories(opts)
 
 List default categories
 
-Use this endpoint to read the attributes of a specific user.
+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.
 
 ### Examples
 
@@ -2218,15 +2220,14 @@ MxPlatformRuby.configure do |config|
 end
 
 api_instance = MxPlatformRuby::MxPlatformApi.new
-user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
 opts = {
   page: 1, # Integer | Specify current page.
   records_per_page: 10 # Integer | Specify records per page.
 }
 
 begin
   # List default categories
-  result = api_instance.list_default_categories(user_guid, opts)
+  result = api_instance.list_default_categories(opts)
   p result
 rescue MxPlatformRuby::ApiError => e
   puts "Error when calling MxPlatformApi->list_default_categories: #{e}"
@@ -2237,12 +2238,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(user_guid, opts)
+> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_with_http_info(opts)
 
 ```ruby
 begin
   # List default categories
-  data, status_code, headers = api_instance.list_default_categories_with_http_info(user_guid, opts)
+  data, status_code, headers = api_instance.list_default_categories_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CategoriesResponseBody>
@@ -2253,6 +2254,81 @@ end
 
 ### Parameters
 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Specify current page. | [optional] |
+| **records_per_page** | **Integer** | Specify records per page. | [optional] |
+
+### Return type
+
+[**CategoriesResponseBody**](CategoriesResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
+## list_default_categories_by_user
+
+> <CategoriesResponseBody> list_default_categories_by_user(user_guid, opts)
+
+List default categories by user
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+opts = {
+  page: 1, # Integer | Specify current page.
+  records_per_page: 10 # Integer | Specify records per page.
+}
+
+begin
+  # List default categories by user
+  result = api_instance.list_default_categories_by_user(user_guid, opts)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->list_default_categories_by_user: #{e}"
+end
+```
+
+#### Using the list_default_categories_by_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CategoriesResponseBody>, Integer, Hash)> list_default_categories_by_user_with_http_info(user_guid, opts)
+
+```ruby
+begin
+  # List default categories by user
+  data, status_code, headers = api_instance.list_default_categories_by_user_with_http_info(user_guid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CategoriesResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->list_default_categories_by_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
@@ -4139,7 +4215,7 @@ end
 
 > <CategoryResponseBody> read_category(category_guid, user_guid)
 
-Read category
+Read a custom category
 
 Use this endpoint to read the attributes of either a default category or a custom category.
 
@@ -4160,7 +4236,7 @@ category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique
 user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
 
 begin
-  # Read category
+  # Read a custom category
   result = api_instance.read_category(category_guid, user_guid)
   p result
 rescue MxPlatformRuby::ApiError => e
@@ -4176,7 +4252,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Read category
+  # Read a custom category
   data, status_code, headers = api_instance.read_category_with_http_info(category_guid, user_guid)
   p status_code # => 2xx
   p headers # => { ... }
@@ -4207,6 +4283,78 @@ end
 - **Accept**: application/vnd.mx.api.v1+json
 
 
+## read_default_category
+
+> <CategoryResponseBody> read_default_category(category_guid, user_guid)
+
+Read a default category
+
+Use this endpoint to read the attributes of a default category.
+
+### Examples
+
+```ruby
+require 'time'
+require 'mx-platform-ruby'
+# setup authorization
+MxPlatformRuby.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = MxPlatformRuby::MxPlatformApi.new
+category_guid = 'CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874' # String | The unique id for a `category`.
+user_guid = 'USR-fa7537f3-48aa-a683-a02a-b18940482f54' # String | The unique id for a `user`.
+
+begin
+  # Read a default category
+  result = api_instance.read_default_category(category_guid, user_guid)
+  p result
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->read_default_category: #{e}"
+end
+```
+
+#### Using the read_default_category_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CategoryResponseBody>, Integer, Hash)> read_default_category_with_http_info(category_guid, user_guid)
+
+```ruby
+begin
+  # Read a default category
+  data, status_code, headers = api_instance.read_default_category_with_http_info(category_guid, user_guid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CategoryResponseBody>
+rescue MxPlatformRuby::ApiError => e
+  puts "Error when calling MxPlatformApi->read_default_category_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_guid** | **String** | The unique id for a &#x60;category&#x60;. |  |
+| **user_guid** | **String** | The unique id for a &#x60;user&#x60;. |  |
+
+### Return type
+
+[**CategoryResponseBody**](CategoryResponseBody.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/vnd.mx.api.v1+json
+
+
 ## read_holding
 
 > <HoldingResponseBody> read_holding(holding_guid, user_guid)