mx-platform-ruby 0.6.1 → 0.8.0

data/openapi/templates/README.mustache

@@ -1,14 +1,16 @@
-*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform API Ruby Library.*
+*This project is currently in **Beta**. Please open up an issue [here](https://github.com/mxenabled/mx-platform-ruby/issues) to report issues using the MX Platform Ruby library.*
 
-*This project was automatically generated by the [OpenAPI Generator](https://openapi-generator.tech).*
+# MX Platform Ruby
 
-# MX Platform Ruby - v{{gemVersion}}
+The [MX Platform API](https://www.mx.com/products/platform-api) is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.
 
-The Ruby gem for the {{appName}}.
+## Documentation
+
+Examples for the API endpoints can be found [here.](https://docs.mx.com/api)
+
+## Requirements
 
-{{#appDescriptionWithNewLines}}
-{{{.}}}
-{{/appDescriptionWithNewLines}}
+- Ruby >= 2.6
 
 ## Installation
 
@@ -20,31 +22,28 @@ gem 'mx-platform-ruby'
 
 And then execute:
 ```shell
-$ bundle
+bundle
 ```
 
 Or install it yourself with:
 ```shell
-$ gem install mx-platform-ruby
+gem install mx-platform-ruby
 ```
 
 ## Getting Started
 
 In order to make requests, you will need to [sign up](https://dashboard.mx.com/sign_up) for the MX Platform API and get a `Client ID` and `API Key`.
 
-Please follow the [installation](#installation) procedure and then run the following code:
-
+Please follow the [installation](#installation) procedure and then run the following code to create your first User:
 ```ruby
-# Load the gem
 require 'mx-platform-ruby'
 
-# setup authorization
 MxPlatformRuby.configure do |config|
-  # Configure HTTP basic authorization
-  config.username = 'Your Client ID from https://dashboard.mx.com'
-  config.password = 'Your API Key from https://dashboard.mx.com'
+  # Configure with your Client ID/API Key from https://dashboard.mx.com
+  config.username = 'Your Client ID'
+  config.password = 'Your API Key'
 
-  # Configure server. 0 for production, 1 for development
+  # Configure environment. 0 for production, 1 for development
   config.server_index = 1
 end
 
@@ -56,7 +55,6 @@ user_create_request_body = MxPlatformRuby::UserCreateRequestBody.new(
 )
 
 begin
-  # Create user
   result = api_instance.create_user(user_create_request_body)
   p result
 rescue MxPlatformRuby::ApiError => e
@@ -64,6 +62,19 @@ rescue MxPlatformRuby::ApiError => e
 end
 ```
 
-## Documentation
+## Development
+
+This project was generated by the [OpenAPI Generator](https://openapi-generator.tech). To generate this library, verify you have the latest version of the `openapi-generator-cli` found [here.](https://github.com/OpenAPITools/openapi-generator#17---npm)
+
+Running the following command in this repo's directory will generate this library using the [MX Platform API OpenAPI spec](https://github.com/mxenabled/openapi/blob/master/openapi/mx_platform_api_beta.yml) with our [configuration and templates.](https://github.com/mxenabled/mx-platform-ruby/tree/master/openapi)
+```shell
+openapi-generator-cli generate \
+-i https://raw.githubusercontent.com/mxenabled/openapi/master/openapi/mx_platform_api_beta.yml \
+-g ruby \
+-c ./openapi/config.yml \
+-t ./openapi/templates
+```
+
+## Contributing
 
-Additional examples for the API endpoints can be found [here](docs/MxPlatformApi.md).
+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

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -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`.

data/spec/api_client_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -159,8 +159,8 @@ describe MxPlatformRuby::ApiClient do
     let(:api_client) { MxPlatformRuby::ApiClient.new }
 
     it 'works' do
-      expect(api_client.select_header_content_type(nil)).to eq('application/json')
-      expect(api_client.select_header_content_type([])).to eq('application/json')
+      expect(api_client.select_header_content_type(nil)).to be_nil
+      expect(api_client.select_header_content_type([])).to be_nil
 
       expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
       expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')

data/spec/configuration_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/account_number_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/account_numbers_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/account_owner_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/account_owners_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/account_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/account_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/account_update_request_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/account_update_request_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/accounts_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/categories_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/category_create_request_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/category_create_request_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/category_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/category_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/category_update_request_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/category_update_request_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/challenge_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/challenges_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/connect_widget_request_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/connect_widget_request_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/connect_widget_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/connect_widget_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/credential_request_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/credential_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/credentials_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/enhance_transaction_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -31,18 +31,42 @@ describe MxPlatformRuby::EnhanceTransactionResponse do
     end
   end
 
+  describe 'test attribute "categorized_by"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "category"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  describe 'test attribute "category_guid"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "described_by"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "description"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  describe 'test attribute "extended_transaction_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "id"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -97,6 +121,18 @@ describe MxPlatformRuby::EnhanceTransactionResponse do
     end
   end
 
+  describe 'test attribute "is_subscription"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "memo"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "merchant_category_code"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -109,6 +145,12 @@ describe MxPlatformRuby::EnhanceTransactionResponse do
     end
   end
 
+  describe 'test attribute "merchant_location_guid"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "original_description"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/enhance_transactions_request_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/enhance_transactions_request_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 
@@ -37,12 +37,24 @@ describe MxPlatformRuby::EnhanceTransactionsRequest do
     end
   end
 
+  describe 'test attribute "extended_transaction_type"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "id"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
     end
   end
 
+  describe 'test attribute "memo"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   describe 'test attribute "merchant_category_code"' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/enhance_transactions_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/holding_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/holding_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/holdings_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/image_option_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/institution_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/institution_response_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end
 

data/spec/models/institutions_response_body_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.2.1
+OpenAPI Generator version: 5.3.1
 
 =end