mx-platform-ruby 0.6.0 → 0.7.0

data/lib/mx-platform-ruby/models/tagging_response.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.0
 
 =end
 
@@ -55,6 +55,7 @@ module MxPlatformRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'member_is_managed_by_user',
       ])
     end
 

data/lib/mx-platform-ruby/models/tagging_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/tagging_update_request.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/tagging_update_request_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/taggings_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/tags_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transaction_response.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.0
 
 =end
 
@@ -23,6 +23,8 @@ module MxPlatformRuby
 
     attr_accessor :category
 
+    attr_accessor :category_guid
+
     attr_accessor :check_number_string
 
     attr_accessor :created_at
@@ -33,6 +35,8 @@ module MxPlatformRuby
 
     attr_accessor :description
 
+    attr_accessor :extended_transaction_type
+
     attr_accessor :guid
 
     attr_accessor :id
@@ -104,11 +108,13 @@ module MxPlatformRuby
         :'account_id' => :'account_id',
         :'amount' => :'amount',
         :'category' => :'category',
+        :'category_guid' => :'category_guid',
         :'check_number_string' => :'check_number_string',
         :'created_at' => :'created_at',
         :'currency_code' => :'currency_code',
         :'date' => :'date',
         :'description' => :'description',
+        :'extended_transaction_type' => :'extended_transaction_type',
         :'guid' => :'guid',
         :'id' => :'id',
         :'is_bill_pay' => :'is_bill_pay',
@@ -156,11 +162,13 @@ module MxPlatformRuby
         :'account_id' => :'String',
         :'amount' => :'Float',
         :'category' => :'String',
+        :'category_guid' => :'String',
         :'check_number_string' => :'String',
         :'created_at' => :'String',
         :'currency_code' => :'String',
         :'date' => :'String',
         :'description' => :'String',
+        :'extended_transaction_type' => :'String',
         :'guid' => :'String',
         :'id' => :'String',
         :'is_bill_pay' => :'Boolean',
@@ -199,6 +207,43 @@ module MxPlatformRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'account_id',
+        :'amount',
+        :'category',
+        :'category_guid',
+        :'check_number_string',
+        :'created_at',
+        :'currency_code',
+        :'date',
+        :'description',
+        :'extended_transaction_type',
+        :'id',
+        :'is_bill_pay',
+        :'is_direct_deposit',
+        :'is_expense',
+        :'is_fee',
+        :'is_income',
+        :'is_international',
+        :'is_overdraft_fee',
+        :'is_payroll_advance',
+        :'is_recurring',
+        :'is_subscription',
+        :'latitude',
+        :'localized_description',
+        :'localized_memo',
+        :'longitude',
+        :'member_is_managed_by_user',
+        :'memo',
+        :'merchant_category_code',
+        :'metadata',
+        :'original_description',
+        :'posted_at',
+        :'status',
+        :'top_level_category',
+        :'transacted_at',
+        :'type',
+        :'updated_at',
+        :'user_id'
       ])
     end
 
@@ -233,6 +278,10 @@ module MxPlatformRuby
         self.category = attributes[:'category']
       end
 
+      if attributes.key?(:'category_guid')
+        self.category_guid = attributes[:'category_guid']
+      end
+
       if attributes.key?(:'check_number_string')
         self.check_number_string = attributes[:'check_number_string']
       end
@@ -253,6 +302,10 @@ module MxPlatformRuby
         self.description = attributes[:'description']
       end
 
+      if attributes.key?(:'extended_transaction_type')
+        self.extended_transaction_type = attributes[:'extended_transaction_type']
+      end
+
       if attributes.key?(:'guid')
         self.guid = attributes[:'guid']
       end
@@ -404,11 +457,13 @@ module MxPlatformRuby
           account_id == o.account_id &&
           amount == o.amount &&
           category == o.category &&
+          category_guid == o.category_guid &&
           check_number_string == o.check_number_string &&
           created_at == o.created_at &&
           currency_code == o.currency_code &&
           date == o.date &&
           description == o.description &&
+          extended_transaction_type == o.extended_transaction_type &&
           guid == o.guid &&
           id == o.id &&
           is_bill_pay == o.is_bill_pay &&
@@ -452,7 +507,7 @@ module MxPlatformRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_guid, account_id, amount, category, check_number_string, created_at, currency_code, date, description, guid, id, is_bill_pay, is_direct_deposit, is_expense, is_fee, is_income, is_international, is_overdraft_fee, is_payroll_advance, is_recurring, is_subscription, latitude, localized_description, localized_memo, longitude, member_guid, member_is_managed_by_user, memo, merchant_category_code, merchant_guid, merchant_location_guid, metadata, original_description, posted_at, status, top_level_category, transacted_at, type, updated_at, user_guid, user_id].hash
+      [account_guid, account_id, amount, category, category_guid, check_number_string, created_at, currency_code, date, description, extended_transaction_type, guid, id, is_bill_pay, is_direct_deposit, is_expense, is_fee, is_income, is_international, is_overdraft_fee, is_payroll_advance, is_recurring, is_subscription, latitude, localized_description, localized_memo, longitude, member_guid, member_is_managed_by_user, memo, merchant_category_code, merchant_guid, merchant_location_guid, metadata, original_description, posted_at, status, top_level_category, transacted_at, type, updated_at, user_guid, user_id].hash
     end
 
     # Builds the object from hash

data/lib/mx-platform-ruby/models/transaction_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transaction_rule_create_request.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transaction_rule_create_request_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transaction_rule_response.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.0
 
 =end
 
@@ -63,6 +63,10 @@ module MxPlatformRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'created_at',
+        :'description',
+        :'match_description',
+        :'updated_at',
       ])
     end
 

data/lib/mx-platform-ruby/models/transaction_rule_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transaction_rule_update_request.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.0
 
 =end
 
@@ -47,6 +47,8 @@ module MxPlatformRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'description',
+        :'match_description'
       ])
     end
 

data/lib/mx-platform-ruby/models/transaction_rule_update_request_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transaction_rules_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transaction_update_request.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transaction_update_request_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/transactions_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/user_create_request.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/user_create_request_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/user_response.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.0
 
 =end
 
@@ -55,6 +55,10 @@ module MxPlatformRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'email',
+        :'id',
+        :'is_disabled',
+        :'metadata'
       ])
     end
 

data/lib/mx-platform-ruby/models/user_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/user_update_request.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/user_update_request_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/users_response_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/widget_request.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/widget_request_body.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.0
 
 =end
 

data/lib/mx-platform-ruby/models/widget_response.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.0
 
 =end
 
@@ -47,6 +47,9 @@ module MxPlatformRuby
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'type',
+        :'url',
+        :'user_id'
       ])
     end
 

data/lib/mx-platform-ruby/models/widget_response_body.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.0
 
 =end
 

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

@@ -6,10 +6,10 @@
 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.0
 
 =end
 
 module MxPlatformRuby
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/lib/mx-platform-ruby.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.0
 
 =end
 

data/mx-platform-ruby.gemspec

@@ -8,7 +8,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.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.0"
+gemVersion: "0.7.0"
 library: "faraday"
 moduleName: "MxPlatformRuby"

data/openapi/templates/README.mustache

@@ -1,16 +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.*
 
-# {{gemName}}
+# MX Platform Ruby
 
-{{moduleName}} - the Ruby gem for the {{appName}}
+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.
 
-{{#appDescriptionWithNewLines}}
-{{{.}}}
-{{/appDescriptionWithNewLines}}
+## Documentation
+
+Examples for the API endpoints can be found [here.](https://docs.mx.com/api)
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+## Requirements
 
-- Package version: {{gemVersion}}
+- Ruby >= 2.6
 
 ## Installation
 
@@ -22,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
 
@@ -58,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
@@ -66,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)