mx-platform-ruby 1.10.0 → 1.10.1

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

@@ -0,0 +1,400 @@
+=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.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MxPlatformRuby
+  class ACHReturnCreateRequest
+    # The unique identifier for the account associated with the transaction. Defined by MX.
+    attr_accessor :account_guid
+
+    # The last 4 digits of the account number used for the transaction by the Originating Depository Financial Institution (ODFI).
+    attr_accessor :account_number_last_four
+
+    # The date and time when the transaction was initiated by the Originating Depository Financial Institution (ODFI) in ISO 8601 format without timestamp.
+    attr_accessor :ach_initiated_at
+
+    # The account number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`.
+    attr_accessor :corrected_account_number
+
+    # The routing number correction reported by the RDFI. Populate only if the `resolution_code` is `NOTICE_OF_CHANGE`. Must be a valid 9-digit routing number format.
+    attr_accessor :corrected_routing_number
+
+    # Client-defined identifier for this specific return submission. Allows you to track and reference you requests.
+    attr_accessor :id
+
+    # The unique identifier for the member associated with the transaction. Defined by MX.
+    attr_accessor :member_guid
+
+    # Incorrect account number used in the ACH transaction.
+    attr_accessor :return_account_number
+
+    # The associated ACH return code and notice of change code (for example, R02, R03, R04, R05, R20, NOC). See [Return Codes](/api-reference/platform-api/reference/ach-return-fields#return-codes) for a complete list.
+    attr_accessor :return_code
+
+    # Notes that you set to inform MX on internal ACH processing.
+    attr_accessor :return_notes
+
+    # Incorrect routing number used in the ACH transaction.
+    attr_accessor :return_routing_number
+
+    # The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.
+    attr_accessor :returned_at
+
+    # The SEC code (Standard Entry Class Code)–a three-letter code describing how a payment was authorized (for example, `WEB`). See [SEC Codes](/api-reference/platform-api/reference/ach-return-fields#sec-codes) for a complete list.
+    attr_accessor :sec_code
+
+    # The amount of the transaction.
+    attr_accessor :transaction_amount
+
+    # The transaction amount range, used for impact assessment.
+    attr_accessor :transaction_amount_range
+
+    # MX-defined identifier for the user associated with the ACH return.
+    attr_accessor :user_guid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_guid' => :'account_guid',
+        :'account_number_last_four' => :'account_number_last_four',
+        :'ach_initiated_at' => :'ach_initiated_at',
+        :'corrected_account_number' => :'corrected_account_number',
+        :'corrected_routing_number' => :'corrected_routing_number',
+        :'id' => :'id',
+        :'member_guid' => :'member_guid',
+        :'return_account_number' => :'return_account_number',
+        :'return_code' => :'return_code',
+        :'return_notes' => :'return_notes',
+        :'return_routing_number' => :'return_routing_number',
+        :'returned_at' => :'returned_at',
+        :'sec_code' => :'sec_code',
+        :'transaction_amount' => :'transaction_amount',
+        :'transaction_amount_range' => :'transaction_amount_range',
+        :'user_guid' => :'user_guid'
+      }
+    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
+      {
+        :'account_guid' => :'String',
+        :'account_number_last_four' => :'String',
+        :'ach_initiated_at' => :'String',
+        :'corrected_account_number' => :'String',
+        :'corrected_routing_number' => :'String',
+        :'id' => :'String',
+        :'member_guid' => :'String',
+        :'return_account_number' => :'String',
+        :'return_code' => :'String',
+        :'return_notes' => :'String',
+        :'return_routing_number' => :'String',
+        :'returned_at' => :'String',
+        :'sec_code' => :'String',
+        :'transaction_amount' => :'Float',
+        :'transaction_amount_range' => :'Float',
+        :'user_guid' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ACHReturnCreateRequest` 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::ACHReturnCreateRequest`. 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?(:'account_guid')
+        self.account_guid = attributes[:'account_guid']
+      else
+        self.account_guid = nil
+      end
+
+      if attributes.key?(:'account_number_last_four')
+        self.account_number_last_four = attributes[:'account_number_last_four']
+      end
+
+      if attributes.key?(:'ach_initiated_at')
+        self.ach_initiated_at = attributes[:'ach_initiated_at']
+      end
+
+      if attributes.key?(:'corrected_account_number')
+        self.corrected_account_number = attributes[:'corrected_account_number']
+      end
+
+      if attributes.key?(:'corrected_routing_number')
+        self.corrected_routing_number = attributes[:'corrected_routing_number']
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'member_guid')
+        self.member_guid = attributes[:'member_guid']
+      else
+        self.member_guid = nil
+      end
+
+      if attributes.key?(:'return_account_number')
+        self.return_account_number = attributes[:'return_account_number']
+      end
+
+      if attributes.key?(:'return_code')
+        self.return_code = attributes[:'return_code']
+      else
+        self.return_code = nil
+      end
+
+      if attributes.key?(:'return_notes')
+        self.return_notes = attributes[:'return_notes']
+      end
+
+      if attributes.key?(:'return_routing_number')
+        self.return_routing_number = attributes[:'return_routing_number']
+      end
+
+      if attributes.key?(:'returned_at')
+        self.returned_at = attributes[:'returned_at']
+      end
+
+      if attributes.key?(:'sec_code')
+        self.sec_code = attributes[:'sec_code']
+      end
+
+      if attributes.key?(:'transaction_amount')
+        self.transaction_amount = attributes[:'transaction_amount']
+      end
+
+      if attributes.key?(:'transaction_amount_range')
+        self.transaction_amount_range = attributes[:'transaction_amount_range']
+      end
+
+      if attributes.key?(:'user_guid')
+        self.user_guid = attributes[:'user_guid']
+      else
+        self.user_guid = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @account_guid.nil?
+        invalid_properties.push('invalid value for "account_guid", account_guid cannot be nil.')
+      end
+
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @member_guid.nil?
+        invalid_properties.push('invalid value for "member_guid", member_guid cannot be nil.')
+      end
+
+      if @return_code.nil?
+        invalid_properties.push('invalid value for "return_code", return_code cannot be nil.')
+      end
+
+      if @user_guid.nil?
+        invalid_properties.push('invalid value for "user_guid", user_guid cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @account_guid.nil?
+      return false if @id.nil?
+      return false if @member_guid.nil?
+      return false if @return_code.nil?
+      return false if @user_guid.nil?
+      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 &&
+          account_guid == o.account_guid &&
+          account_number_last_four == o.account_number_last_four &&
+          ach_initiated_at == o.ach_initiated_at &&
+          corrected_account_number == o.corrected_account_number &&
+          corrected_routing_number == o.corrected_routing_number &&
+          id == o.id &&
+          member_guid == o.member_guid &&
+          return_account_number == o.return_account_number &&
+          return_code == o.return_code &&
+          return_notes == o.return_notes &&
+          return_routing_number == o.return_routing_number &&
+          returned_at == o.returned_at &&
+          sec_code == o.sec_code &&
+          transaction_amount == o.transaction_amount &&
+          transaction_amount_range == o.transaction_amount_range &&
+          user_guid == o.user_guid
+    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
+      [account_guid, account_number_last_four, ach_initiated_at, corrected_account_number, corrected_routing_number, id, member_guid, return_account_number, return_code, return_notes, return_routing_number, returned_at, sec_code, transaction_amount, transaction_amount_range, user_guid].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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_any_of) || 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/ach_return_create_request_body.rb

@@ -0,0 +1,214 @@
+=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.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MxPlatformRuby
+  class ACHReturnCreateRequestBody
+    attr_accessor :ach_return
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ach_return' => :'ach_return'
+      }
+    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
+      {
+        :'ach_return' => :'ACHReturnCreateRequest'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ACHReturnCreateRequestBody` 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::ACHReturnCreateRequestBody`. 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?(:'ach_return')
+        self.ach_return = attributes[:'ach_return']
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      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 &&
+          ach_return == o.ach_return
+    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
+      [ach_return].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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_any_of) || 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