mx-platform-ruby 0.16.0 → 0.18.0

data/lib/mx-platform-ruby/models/account_create_request_body.rb

@@ -0,0 +1,228 @@
+=begin
+#MX Platform API
+
+#The MX 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 version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MxPlatformRuby
+  class AccountCreateRequestBody
+    attr_accessor :skip_webhook
+
+    attr_accessor :account
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'skip_webhook' => :'skip_webhook',
+        :'account' => :'account'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'skip_webhook' => :'Boolean',
+        :'account' => :'AccountCreateRequest'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'skip_webhook',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MxPlatformRuby::AccountCreateRequestBody` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MxPlatformRuby::AccountCreateRequestBody`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'skip_webhook')
+        self.skip_webhook = attributes[:'skip_webhook']
+      end
+
+      if attributes.key?(:'account')
+        self.account = attributes[:'account']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          skip_webhook == o.skip_webhook &&
+          account == o.account
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [skip_webhook, account].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = MxPlatformRuby.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/mx-platform-ruby/models/account_response.rb

@@ -55,10 +55,14 @@ module MxPlatformRuby
 
     attr_accessor :interest_rate
 
+    attr_accessor :is_business
+
     attr_accessor :is_closed
 
     attr_accessor :is_hidden
 
+    attr_accessor :is_manual
+
     attr_accessor :last_payment
 
     attr_accessor :last_payment_at
@@ -93,6 +97,8 @@ module MxPlatformRuby
 
     attr_accessor :premium_amount
 
+    attr_accessor :property_type
+
     attr_accessor :routing_number
 
     attr_accessor :started_on
@@ -132,8 +138,10 @@ module MxPlatformRuby
         :'institution_code' => :'institution_code',
         :'insured_name' => :'insured_name',
         :'interest_rate' => :'interest_rate',
+        :'is_business' => :'is_business',
         :'is_closed' => :'is_closed',
         :'is_hidden' => :'is_hidden',
+        :'is_manual' => :'is_manual',
         :'last_payment' => :'last_payment',
         :'last_payment_at' => :'last_payment_at',
         :'loan_amount' => :'loan_amount',
@@ -151,6 +159,7 @@ module MxPlatformRuby
         :'payment_due_at' => :'payment_due_at',
         :'payoff_balance' => :'payoff_balance',
         :'premium_amount' => :'premium_amount',
+        :'property_type' => :'property_type',
         :'routing_number' => :'routing_number',
         :'started_on' => :'started_on',
         :'subtype' => :'subtype',
@@ -190,8 +199,10 @@ module MxPlatformRuby
         :'institution_code' => :'String',
         :'insured_name' => :'String',
         :'interest_rate' => :'Float',
+        :'is_business' => :'Boolean',
         :'is_closed' => :'Boolean',
         :'is_hidden' => :'Boolean',
+        :'is_manual' => :'Boolean',
         :'last_payment' => :'Float',
         :'last_payment_at' => :'String',
         :'loan_amount' => :'Float',
@@ -209,6 +220,7 @@ module MxPlatformRuby
         :'payment_due_at' => :'String',
         :'payoff_balance' => :'Float',
         :'premium_amount' => :'Float',
+        :'property_type' => :'String',
         :'routing_number' => :'String',
         :'started_on' => :'String',
         :'subtype' => :'String',
@@ -243,8 +255,10 @@ module MxPlatformRuby
         :'institution_code',
         :'insured_name',
         :'interest_rate',
+        :'is_business',
         :'is_closed',
         :'is_hidden',
+        :'is_manual',
         :'last_payment',
         :'last_payment_at',
         :'loan_amount',
@@ -262,6 +276,7 @@ module MxPlatformRuby
         :'payment_due_at',
         :'payoff_balance',
         :'premium_amount',
+        :'property_type',
         :'routing_number',
         :'started_on',
         :'subtype',
@@ -368,6 +383,10 @@ module MxPlatformRuby
         self.interest_rate = attributes[:'interest_rate']
       end
 
+      if attributes.key?(:'is_business')
+        self.is_business = attributes[:'is_business']
+      end
+
       if attributes.key?(:'is_closed')
         self.is_closed = attributes[:'is_closed']
       end
@@ -376,6 +395,10 @@ module MxPlatformRuby
         self.is_hidden = attributes[:'is_hidden']
       end
 
+      if attributes.key?(:'is_manual')
+        self.is_manual = attributes[:'is_manual']
+      end
+
       if attributes.key?(:'last_payment')
         self.last_payment = attributes[:'last_payment']
       end
@@ -444,6 +467,10 @@ module MxPlatformRuby
         self.premium_amount = attributes[:'premium_amount']
       end
 
+      if attributes.key?(:'property_type')
+        self.property_type = attributes[:'property_type']
+      end
+
       if attributes.key?(:'routing_number')
         self.routing_number = attributes[:'routing_number']
       end
@@ -515,8 +542,10 @@ module MxPlatformRuby
           institution_code == o.institution_code &&
           insured_name == o.insured_name &&
           interest_rate == o.interest_rate &&
+          is_business == o.is_business &&
           is_closed == o.is_closed &&
           is_hidden == o.is_hidden &&
+          is_manual == o.is_manual &&
           last_payment == o.last_payment &&
           last_payment_at == o.last_payment_at &&
           loan_amount == o.loan_amount &&
@@ -534,6 +563,7 @@ module MxPlatformRuby
           payment_due_at == o.payment_due_at &&
           payoff_balance == o.payoff_balance &&
           premium_amount == o.premium_amount &&
+          property_type == o.property_type &&
           routing_number == o.routing_number &&
           started_on == o.started_on &&
           subtype == o.subtype &&
@@ -553,7 +583,7 @@ module MxPlatformRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_number, apr, apy, available_balance, available_credit, balance, cash_balance, cash_surrender_value, created_at, credit_limit, currency_code, day_payment_is_due, death_benefit, guid, holdings_value, id, imported_at, institution_code, insured_name, interest_rate, is_closed, is_hidden, last_payment, last_payment_at, loan_amount, matures_on, member_guid, member_id, member_is_managed_by_user, metadata, minimum_balance, minimum_payment, name, nickname, original_balance, pay_out_amount, payment_due_at, payoff_balance, premium_amount, routing_number, started_on, subtype, total_account_value, type, updated_at, user_guid, user_id].hash
+      [account_number, apr, apy, available_balance, available_credit, balance, cash_balance, cash_surrender_value, created_at, credit_limit, currency_code, day_payment_is_due, death_benefit, guid, holdings_value, id, imported_at, institution_code, insured_name, interest_rate, is_business, is_closed, is_hidden, is_manual, last_payment, last_payment_at, loan_amount, matures_on, member_guid, member_id, member_is_managed_by_user, metadata, minimum_balance, minimum_payment, name, nickname, original_balance, pay_out_amount, payment_due_at, payoff_balance, premium_amount, property_type, routing_number, started_on, subtype, total_account_value, type, updated_at, user_guid, user_id].hash
     end
 
     # Builds the object from hash

data/lib/mx-platform-ruby/models/institution_response.rb

@@ -17,6 +17,10 @@ module MxPlatformRuby
   class InstitutionResponse
     attr_accessor :code
 
+    attr_accessor :forgot_password_url
+
+    attr_accessor :forgot_username_url
+
     attr_accessor :instructional_text
 
     attr_accessor :medium_logo_url
@@ -35,12 +39,16 @@ module MxPlatformRuby
 
     attr_accessor :supports_transaction_history
 
+    attr_accessor :trouble_signing_in_url
+
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'code' => :'code',
+        :'forgot_password_url' => :'forgot_password_url',
+        :'forgot_username_url' => :'forgot_username_url',
         :'instructional_text' => :'instructional_text',
         :'medium_logo_url' => :'medium_logo_url',
         :'name' => :'name',
@@ -50,6 +58,7 @@ module MxPlatformRuby
         :'supports_account_verification' => :'supports_account_verification',
         :'supports_oauth' => :'supports_oauth',
         :'supports_transaction_history' => :'supports_transaction_history',
+        :'trouble_signing_in_url' => :'trouble_signing_in_url',
         :'url' => :'url'
       }
     end
@@ -63,6 +72,8 @@ module MxPlatformRuby
     def self.openapi_types
       {
         :'code' => :'String',
+        :'forgot_password_url' => :'String',
+        :'forgot_username_url' => :'String',
         :'instructional_text' => :'String',
         :'medium_logo_url' => :'String',
         :'name' => :'String',
@@ -72,6 +83,7 @@ module MxPlatformRuby
         :'supports_account_verification' => :'Boolean',
         :'supports_oauth' => :'Boolean',
         :'supports_transaction_history' => :'Boolean',
+        :'trouble_signing_in_url' => :'String',
         :'url' => :'String'
       }
     end
@@ -80,6 +92,8 @@ module MxPlatformRuby
     def self.openapi_nullable
       Set.new([
         :'code',
+        :'forgot_password_url',
+        :'forgot_username_url',
         :'instructional_text',
         :'medium_logo_url',
         :'name',
@@ -89,6 +103,7 @@ module MxPlatformRuby
         :'supports_account_verification',
         :'supports_oauth',
         :'supports_transaction_history',
+        :'trouble_signing_in_url',
         :'url'
       ])
     end
@@ -112,6 +127,14 @@ module MxPlatformRuby
         self.code = attributes[:'code']
       end
 
+      if attributes.key?(:'forgot_password_url')
+        self.forgot_password_url = attributes[:'forgot_password_url']
+      end
+
+      if attributes.key?(:'forgot_username_url')
+        self.forgot_username_url = attributes[:'forgot_username_url']
+      end
+
       if attributes.key?(:'instructional_text')
         self.instructional_text = attributes[:'instructional_text']
       end
@@ -148,6 +171,10 @@ module MxPlatformRuby
         self.supports_transaction_history = attributes[:'supports_transaction_history']
       end
 
+      if attributes.key?(:'trouble_signing_in_url')
+        self.trouble_signing_in_url = attributes[:'trouble_signing_in_url']
+      end
+
       if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
@@ -172,6 +199,8 @@ module MxPlatformRuby
       return true if self.equal?(o)
       self.class == o.class &&
           code == o.code &&
+          forgot_password_url == o.forgot_password_url &&
+          forgot_username_url == o.forgot_username_url &&
           instructional_text == o.instructional_text &&
           medium_logo_url == o.medium_logo_url &&
           name == o.name &&
@@ -181,6 +210,7 @@ module MxPlatformRuby
           supports_account_verification == o.supports_account_verification &&
           supports_oauth == o.supports_oauth &&
           supports_transaction_history == o.supports_transaction_history &&
+          trouble_signing_in_url == o.trouble_signing_in_url &&
           url == o.url
     end
 
@@ -193,7 +223,7 @@ module MxPlatformRuby
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [code, instructional_text, medium_logo_url, name, small_logo_url, supports_account_identification, supports_account_statement, supports_account_verification, supports_oauth, supports_transaction_history, url].hash
+      [code, forgot_password_url, forgot_username_url, instructional_text, medium_logo_url, name, small_logo_url, supports_account_identification, supports_account_statement, supports_account_verification, supports_oauth, supports_transaction_history, trouble_signing_in_url, url].hash
     end
 
     # Builds the object from hash

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

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module MxPlatformRuby
-  VERSION = '0.16.0'
+  VERSION = '0.18.0'
 end

data/lib/mx-platform-ruby.rb

@@ -17,6 +17,8 @@ require 'mx-platform-ruby/version'
 require 'mx-platform-ruby/configuration'
 
 # Models
+require 'mx-platform-ruby/models/account_create_request'
+require 'mx-platform-ruby/models/account_create_request_body'
 require 'mx-platform-ruby/models/account_number_response'
 require 'mx-platform-ruby/models/account_numbers_response_body'
 require 'mx-platform-ruby/models/account_owner_response'

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.16.0
+gemVersion: 0.18.0
 library: faraday
 moduleName: MxPlatformRuby

data/spec/api/mx_platform_api_spec.rb

@@ -113,6 +113,19 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for create_manual_account
+  # Create manual account
+  # This endpoint can only be used to create manual accounts. Creating a manual account will automatically create it under the Manual Institution member. Since a manual account has no credentials tied to the member, the account will never aggregate or include data from a data feed..
+  # @param user_guid The unique id for a `user`.
+  # @param account_create_request_body Manual account object to be created.
+  # @param [Hash] opts the optional parameters
+  # @return [AccountResponseBody]
+  describe 'create_manual_account 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 create_member
   # Create member
   # This endpoint allows you to create a new member. Members are created with the required parameters credentials and institution_code, and the optional parameters id and metadata. When creating a member, youll need to include the correct type of credential required by the financial institution and provided by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials` endpoint. If successful, the MX Platform API will respond with the newly-created member object. Once you successfully create a member, MX will immediately validate the provided credentials and attempt to aggregate data for accounts and transactions.
@@ -232,6 +245,19 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for delete_manual_account
+  # Delete manual account
+  # This endpoint deletes accounts that were manually created. The API will respond with an empty object and a status of `204 No Content`.
+  # @param account_guid The unique id for an `account`.
+  # @param user_guid The unique id for a `user`.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_manual_account 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 delete_member
   # Delete member
   # Accessing this endpoint will permanently delete a member.

data/spec/models/account_create_request_body_spec.rb

@@ -0,0 +1,40 @@
+=begin
+#MX Platform API
+
+#The MX 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 version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for MxPlatformRuby::AccountCreateRequestBody
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe MxPlatformRuby::AccountCreateRequestBody do
+  let(:instance) { MxPlatformRuby::AccountCreateRequestBody.new }
+
+  describe 'test an instance of AccountCreateRequestBody' do
+    it 'should create an instance of AccountCreateRequestBody' do
+      expect(instance).to be_instance_of(MxPlatformRuby::AccountCreateRequestBody)
+    end
+  end
+  describe 'test attribute "skip_webhook"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "account"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end