mx-platform-ruby 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 262c6362945060899351feb3aa49356bbfa5a234f917b2efa099f39188f4cc55
-  data.tar.gz: 3dfa97a2aa14f65c8f048f8c9e6a5bbc199bc3fef5c0ccbe58e7f11e38737aad
+  metadata.gz: 8e1b23a7826a1747fe4e70489563eccfb6ebf00fe33a1bb3fa196d848aad5319
+  data.tar.gz: 24b24c73997bd24c5e0d98996e62c01822fa3905d0a083780b31724c38e7b42c
 SHA512:
-  metadata.gz: 986214ba1b32b491894c84294f03c7413a62b8fe145c485ac9965bd90285981fac989e1e8607ba48f32ecfc08e54ea8d01fe34d62be775143f43eeaa10036627
-  data.tar.gz: a0e99f8388aea551610df4241e34c57a0c4c035d6b3fd3a8da6edb5c37c1422a379846ef6ec411cb8e9ba67d3e9ca22cd74c6c99125dc5f9569a2af3fec3e2ab
+  metadata.gz: 1929b26718b7e202f2d9cba036fcc2d7f1911de6eeeac9471653caecc2465b142a22761d2b0078126c41a51c47208b8a1c2da1fa4c944fbb51a97831c63a8727
+  data.tar.gz: 418722dca6d503d7fd646955f001fb1c7778921b85aa2ef050fa23142d4c5c6b2842e114917fc21cad7039609a9f0fc636735343aeb42309ecc6f2c1ff3b3f80

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mx-platform-ruby (0.6.3)
+    mx-platform-ruby (0.7.0)
       faraday (~> 1.0, >= 1.0.1)
 
 GEM
@@ -10,7 +10,7 @@ GEM
     ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
@@ -34,7 +34,7 @@ GEM
     method_source (1.0.0)
     multipart-post (2.1.1)
     parallel (1.21.0)
-    parser (3.0.3.1)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -42,7 +42,8 @@ GEM
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    psych (4.0.2)
+    psych (4.0.3)
+      stringio
     rainbow (3.0.0)
     rake (13.0.6)
     rspec (3.10.0)
@@ -68,6 +69,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
+    stringio (3.0.1)
     unicode-display_width (1.5.0)
 
 PLATFORMS
@@ -81,4 +83,4 @@ DEPENDENCIES
   rubocop (~> 0.66.0)
 
 BUNDLED WITH
-   2.2.32
+   2.3.4

data/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

data/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)

data/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,

data/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
 )
 ```

data/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,7 +2220,6 @@ 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.
@@ -2226,7 +2227,7 @@ opts = {
 
 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)

data/lib/mx-platform-ruby/api/mx_platform_api.rb

@@ -2101,31 +2101,94 @@ module MxPlatformRuby
     end
 
     # List default categories
-    # Use this endpoint to read the attributes of a specific user.
-    # @param user_guid [String] The unique id for a `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.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Specify current page.
     # @option opts [Integer] :records_per_page Specify records per page.
     # @return [CategoriesResponseBody]
-    def list_default_categories(user_guid, opts = {})
-      data, _status_code, _headers = list_default_categories_with_http_info(user_guid, opts)
+    def list_default_categories(opts = {})
+      data, _status_code, _headers = list_default_categories_with_http_info(opts)
       data
     end
 
     # List default categories
-    # Use this endpoint to read the attributes of a specific user.
-    # @param user_guid [String] The unique id for a `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.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Specify current page.
     # @option opts [Integer] :records_per_page Specify records per page.
     # @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
-    def list_default_categories_with_http_info(user_guid, opts = {})
+    def list_default_categories_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories ...'
       end
+      # resource path
+      local_var_path = '/categories/default'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CategoriesResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.list_default_categories",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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.
+    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
+    # @return [CategoriesResponseBody]
+    def list_default_categories_by_user(user_guid, opts = {})
+      data, _status_code, _headers = list_default_categories_by_user_with_http_info(user_guid, opts)
+      data
+    end
+
+    # 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 &#x60;is_default&#x60; field set to &#x60;true&#x60;. 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.
+    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Specify current page.
+    # @option opts [Integer] :records_per_page Specify records per page.
+    # @return [Array<(CategoriesResponseBody, Integer, Hash)>] CategoriesResponseBody data, response status code and response headers
+    def list_default_categories_by_user_with_http_info(user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.list_default_categories_by_user ...'
+      end
       # verify the required parameter 'user_guid' is set
       if @api_client.config.client_side_validation && user_guid.nil?
-        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_default_categories"
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.list_default_categories_by_user"
       end
       # resource path
       local_var_path = '/users/{user_guid}/categories/default'.sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
@@ -2153,7 +2216,7 @@ module MxPlatformRuby
       auth_names = opts[:debug_auth_names] || ['basicAuth']
 
       new_options = opts.merge(
-        :operation => :"MxPlatformApi.list_default_categories",
+        :operation => :"MxPlatformApi.list_default_categories_by_user",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -2164,7 +2227,7 @@ module MxPlatformRuby
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: MxPlatformApi#list_default_categories_by_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -3900,7 +3963,7 @@ module MxPlatformRuby
       return data, status_code, headers
     end
 
-    # Read category
+    # Read a custom category
     # Use this endpoint to read the attributes of either a default category or a custom category.
     # @param category_guid [String] The unique id for a &#x60;category&#x60;.
     # @param user_guid [String] The unique id for a &#x60;user&#x60;.
@@ -3911,7 +3974,7 @@ module MxPlatformRuby
       data
     end
 
-    # Read category
+    # Read a custom category
     # Use this endpoint to read the attributes of either a default category or a custom category.
     # @param category_guid [String] The unique id for a &#x60;category&#x60;.
     # @param user_guid [String] The unique id for a &#x60;user&#x60;.
@@ -3969,6 +4032,75 @@ module MxPlatformRuby
       return data, status_code, headers
     end
 
+    # Read a default category
+    # Use this endpoint to read the attributes of a default category.
+    # @param category_guid [String] The unique id for a &#x60;category&#x60;.
+    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [CategoryResponseBody]
+    def read_default_category(category_guid, user_guid, opts = {})
+      data, _status_code, _headers = read_default_category_with_http_info(category_guid, user_guid, opts)
+      data
+    end
+
+    # Read a default category
+    # Use this endpoint to read the attributes of a default category.
+    # @param category_guid [String] The unique id for a &#x60;category&#x60;.
+    # @param user_guid [String] The unique id for a &#x60;user&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CategoryResponseBody, Integer, Hash)>] CategoryResponseBody data, response status code and response headers
+    def read_default_category_with_http_info(category_guid, user_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MxPlatformApi.read_default_category ...'
+      end
+      # verify the required parameter 'category_guid' is set
+      if @api_client.config.client_side_validation && category_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'category_guid' when calling MxPlatformApi.read_default_category"
+      end
+      # verify the required parameter 'user_guid' is set
+      if @api_client.config.client_side_validation && user_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'user_guid' when calling MxPlatformApi.read_default_category"
+      end
+      # resource path
+      local_var_path = '/categories/{category_guid}'.sub('{' + 'category_guid' + '}', CGI.escape(category_guid.to_s)).sub('{' + 'user_guid' + '}', CGI.escape(user_guid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CategoryResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MxPlatformApi.read_default_category",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MxPlatformApi#read_default_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Read holding
     # Use this endpoint to read the attributes of a specific `holding`.
     # @param holding_guid [String] The unique id for a &#x60;holding&#x60;.

data/lib/mx-platform-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.3.0
 =end
 
 module MxPlatformRuby
-  VERSION = '0.6.3'
+  VERSION = '0.7.0'
 end

data/openapi/config.yml

@@ -6,6 +6,6 @@ gemHomepage: "https://github.com/mxenabled/mx-platform-ruby"
 gemLicense: "MIT"
 gemName: "mx-platform-ruby"
 gemRequiredRubyVersion: ">= 2.6"
-gemVersion: "0.6.3"
+gemVersion: "0.7.0"
 library: "faraday"
 moduleName: "MxPlatformRuby"

data/openapi/templates/README.mustache

@@ -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)

data/spec/api/mx_platform_api_spec.rb

@@ -420,8 +420,7 @@ describe 'MxPlatformApi' do
 
   # unit tests for list_default_categories
   # List default categories
-  # Use this endpoint to read the attributes of a specific user.
-  # @param user_guid The unique id for a `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.
   # @param [Hash] opts the optional parameters
   # @option opts [Integer] :page Specify current page.
   # @option opts [Integer] :records_per_page Specify records per page.
@@ -432,6 +431,20 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for list_default_categories_by_user
+  # 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.
+  # @param user_guid The unique id for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Specify current page.
+  # @option opts [Integer] :records_per_page Specify records per page.
+  # @return [CategoriesResponseBody]
+  describe 'list_default_categories_by_user test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for list_favorite_institutions
   # List favorite institutions
   # This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
@@ -789,7 +802,7 @@ describe 'MxPlatformApi' do
   end
 
   # unit tests for read_category
-  # Read category
+  # Read a custom category
   # Use this endpoint to read the attributes of either a default category or a custom category.
   # @param category_guid The unique id for a `category`.
   # @param user_guid The unique id for a `user`.
@@ -801,6 +814,19 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for read_default_category
+  # Read a default category
+  # Use this endpoint to read the attributes of a default category.
+  # @param category_guid The unique id for a `category`.
+  # @param user_guid The unique id for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [CategoryResponseBody]
+  describe 'read_default_category test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for read_holding
   # Read holding
   # Use this endpoint to read the attributes of a specific `holding`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mx-platform-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - MX
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2022-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -427,112 +427,112 @@ test_files:
 - spec/api/mx_platform_api_spec.rb
 - spec/api_client_spec.rb
 - spec/configuration_spec.rb
-- spec/models/tag_update_request_body_spec.rb
-- spec/models/enhance_transaction_response_spec.rb
-- spec/models/enhance_transactions_response_body_spec.rb
-- spec/models/user_response_body_spec.rb
-- spec/models/account_update_request_spec.rb
-- spec/models/tagging_create_request_spec.rb
-- spec/models/member_update_request_spec.rb
-- spec/models/user_update_request_body_spec.rb
-- spec/models/transaction_update_request_spec.rb
-- spec/models/institutions_response_body_spec.rb
-- spec/models/transactions_response_body_spec.rb
-- spec/models/transaction_update_request_body_spec.rb
-- spec/models/member_status_response_body_spec.rb
-- spec/models/category_response_spec.rb
-- spec/models/option_response_spec.rb
-- spec/models/tag_response_body_spec.rb
-- spec/models/pagination_response_spec.rb
+- spec/models/managed_transaction_update_request_spec.rb
+- spec/models/connect_widget_request_body_spec.rb
+- spec/models/tagging_response_spec.rb
+- spec/models/widget_request_body_spec.rb
+- spec/models/transaction_rules_response_body_spec.rb
 - spec/models/transaction_rule_response_body_spec.rb
-- spec/models/categories_response_body_spec.rb
-- spec/models/members_response_body_spec.rb
+- spec/models/tag_response_spec.rb
+- spec/models/merchant_location_response_body_spec.rb
+- spec/models/managed_member_update_request_spec.rb
+- spec/models/member_status_response_spec.rb
+- spec/models/managed_transaction_update_request_body_spec.rb
 - spec/models/member_create_request_body_spec.rb
-- spec/models/credential_request_spec.rb
+- spec/models/user_create_request_body_spec.rb
+- spec/models/member_create_request_spec.rb
+- spec/models/managed_account_create_request_body_spec.rb
+- spec/models/user_update_request_spec.rb
+- spec/models/enhance_transactions_request_body_spec.rb
+- spec/models/tagging_update_request_body_spec.rb
+- spec/models/user_response_body_spec.rb
+- spec/models/transaction_response_spec.rb
+- spec/models/member_response_body_spec.rb
+- spec/models/account_response_spec.rb
 - spec/models/category_create_request_spec.rb
-- spec/models/statement_response_spec.rb
-- spec/models/managed_member_create_request_body_spec.rb
-- spec/models/credential_response_spec.rb
+- spec/models/widget_request_spec.rb
+- spec/models/institutions_response_body_spec.rb
+- spec/models/user_update_request_body_spec.rb
 - spec/models/merchant_response_body_spec.rb
-- spec/models/credentials_response_body_spec.rb
-- spec/models/category_update_request_spec.rb
-- spec/models/connect_widget_request_body_spec.rb
-- spec/models/account_numbers_response_body_spec.rb
-- spec/models/member_status_response_spec.rb
-- spec/models/holdings_response_body_spec.rb
-- spec/models/holding_response_body_spec.rb
-- spec/models/account_number_response_spec.rb
-- spec/models/managed_member_update_request_spec.rb
-- spec/models/user_create_request_body_spec.rb
-- spec/models/transaction_rule_create_request_spec.rb
-- spec/models/statements_response_body_spec.rb
+- spec/models/credential_response_spec.rb
 - spec/models/tag_update_request_spec.rb
-- spec/models/managed_member_update_request_body_spec.rb
-- spec/models/member_response_spec.rb
-- spec/models/enhance_transactions_request_spec.rb
-- spec/models/managed_account_update_request_body_spec.rb
-- spec/models/institution_response_body_spec.rb
-- spec/models/tagging_update_request_spec.rb
-- spec/models/statement_response_body_spec.rb
-- spec/models/accounts_response_body_spec.rb
-- spec/models/tag_create_request_body_spec.rb
 - spec/models/connect_widget_request_spec.rb
-- spec/models/managed_account_create_request_body_spec.rb
-- spec/models/merchant_response_spec.rb
-- spec/models/widget_response_body_spec.rb
-- spec/models/widget_request_spec.rb
+- spec/models/connect_widget_response_body_spec.rb
+- spec/models/user_create_request_spec.rb
+- spec/models/transaction_update_request_spec.rb
+- spec/models/transaction_rule_response_spec.rb
+- spec/models/transaction_update_request_body_spec.rb
 - spec/models/category_update_request_body_spec.rb
-- spec/models/image_option_response_spec.rb
-- spec/models/managed_transaction_create_request_body_spec.rb
-- spec/models/challenge_response_spec.rb
-- spec/models/account_owner_response_spec.rb
-- spec/models/tagging_update_request_body_spec.rb
-- spec/models/transaction_rule_create_request_body_spec.rb
+- spec/models/users_response_body_spec.rb
+- spec/models/enhance_transactions_response_body_spec.rb
+- spec/models/tagging_response_body_spec.rb
+- spec/models/tag_create_request_spec.rb
+- spec/models/member_update_request_body_spec.rb
 - spec/models/merchants_response_body_spec.rb
+- spec/models/transaction_rule_create_request_spec.rb
+- spec/models/categories_response_body_spec.rb
+- spec/models/tags_response_body_spec.rb
+- spec/models/enhance_transactions_request_spec.rb
+- spec/models/member_response_spec.rb
 - spec/models/managed_member_create_request_spec.rb
-- spec/models/transaction_response_spec.rb
-- spec/models/tag_create_request_spec.rb
+- spec/models/challenge_response_spec.rb
 - spec/models/holding_response_spec.rb
-- spec/models/user_update_request_spec.rb
+- spec/models/pagination_response_spec.rb
+- spec/models/managed_account_update_request_spec.rb
+- spec/models/merchant_response_spec.rb
+- spec/models/members_response_body_spec.rb
+- spec/models/tag_response_body_spec.rb
+- spec/models/category_create_request_body_spec.rb
+- spec/models/option_response_spec.rb
+- spec/models/category_response_body_spec.rb
+- spec/models/managed_member_update_request_body_spec.rb
+- spec/models/managed_account_create_request_spec.rb
 - spec/models/o_auth_window_response_spec.rb
-- spec/models/users_response_body_spec.rb
-- spec/models/managed_transaction_update_request_body_spec.rb
-- spec/models/member_update_request_body_spec.rb
-- spec/models/challenges_response_body_spec.rb
-- spec/models/tag_response_spec.rb
-- spec/models/account_owners_response_body_spec.rb
+- spec/models/account_numbers_response_body_spec.rb
+- spec/models/member_status_response_body_spec.rb
+- spec/models/managed_member_create_request_body_spec.rb
+- spec/models/taggings_response_body_spec.rb
+- spec/models/statements_response_body_spec.rb
+- spec/models/holdings_response_body_spec.rb
+- spec/models/member_resume_request_spec.rb
+- spec/models/member_update_request_spec.rb
 - spec/models/merchant_location_response_spec.rb
-- spec/models/connect_widget_response_body_spec.rb
+- spec/models/account_update_request_spec.rb
 - spec/models/widget_response_spec.rb
-- spec/models/managed_transaction_create_request_spec.rb
-- spec/models/account_response_body_spec.rb
-- spec/models/transaction_rule_update_request_body_spec.rb
-- spec/models/transaction_rules_response_body_spec.rb
-- spec/models/managed_account_update_request_spec.rb
-- spec/models/taggings_response_body_spec.rb
-- spec/models/managed_account_create_request_spec.rb
-- spec/models/member_response_body_spec.rb
-- spec/models/tagging_response_body_spec.rb
-- spec/models/transaction_response_body_spec.rb
-- spec/models/managed_transaction_update_request_spec.rb
-- spec/models/tags_response_body_spec.rb
-- spec/models/o_auth_window_response_body_spec.rb
-- spec/models/member_create_request_spec.rb
+- spec/models/user_response_spec.rb
 - spec/models/tagging_create_request_body_spec.rb
-- spec/models/user_create_request_spec.rb
-- spec/models/transaction_rule_response_spec.rb
-- spec/models/transaction_rule_update_request_spec.rb
-- spec/models/merchant_location_response_body_spec.rb
+- spec/models/managed_account_update_request_body_spec.rb
+- spec/models/tagging_update_request_spec.rb
+- spec/models/statement_response_body_spec.rb
+- spec/models/credentials_response_body_spec.rb
+- spec/models/challenges_response_body_spec.rb
+- spec/models/credential_request_spec.rb
+- spec/models/transaction_response_body_spec.rb
 - spec/models/member_resume_request_body_spec.rb
-- spec/models/user_response_spec.rb
-- spec/models/member_resume_request_spec.rb
-- spec/models/category_create_request_body_spec.rb
-- spec/models/account_response_spec.rb
-- spec/models/account_update_request_body_spec.rb
+- spec/models/account_owner_response_spec.rb
+- spec/models/transaction_rule_update_request_spec.rb
+- spec/models/institution_response_body_spec.rb
+- spec/models/holding_response_body_spec.rb
+- spec/models/account_owners_response_body_spec.rb
+- spec/models/account_number_response_spec.rb
 - spec/models/institution_response_spec.rb
 - spec/models/connect_widget_response_spec.rb
-- spec/models/enhance_transactions_request_body_spec.rb
-- spec/models/widget_request_body_spec.rb
-- spec/models/tagging_response_spec.rb
-- spec/models/category_response_body_spec.rb
+- spec/models/category_update_request_spec.rb
+- spec/models/transactions_response_body_spec.rb
+- spec/models/tag_update_request_body_spec.rb
+- spec/models/image_option_response_spec.rb
+- spec/models/accounts_response_body_spec.rb
+- spec/models/widget_response_body_spec.rb
+- spec/models/managed_transaction_create_request_body_spec.rb
+- spec/models/tagging_create_request_spec.rb
+- spec/models/statement_response_spec.rb
+- spec/models/account_response_body_spec.rb
+- spec/models/account_update_request_body_spec.rb
+- spec/models/category_response_spec.rb
+- spec/models/transaction_rule_update_request_body_spec.rb
+- spec/models/enhance_transaction_response_spec.rb
+- spec/models/tag_create_request_body_spec.rb
+- spec/models/transaction_rule_create_request_body_spec.rb
+- spec/models/o_auth_window_response_body_spec.rb
+- spec/models/managed_transaction_create_request_spec.rb
 - spec/spec_helper.rb