mx-platform-ruby 0.37.0 → 0.39.0

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

@@ -0,0 +1,295 @@
+=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: 7.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MxPlatformRuby
+  class RewardsResponse
+    attr_accessor :account_guid
+
+    attr_accessor :balance_type
+
+    attr_accessor :balance
+
+    attr_accessor :created_at
+
+    attr_accessor :description
+
+    attr_accessor :expires_on
+
+    attr_accessor :guid
+
+    attr_accessor :member_guid
+
+    attr_accessor :unit_type
+
+    attr_accessor :user_guid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_guid' => :'account_guid',
+        :'balance_type' => :'balance_type',
+        :'balance' => :'balance',
+        :'created_at' => :'created_at',
+        :'description' => :'description',
+        :'expires_on' => :'expires_on',
+        :'guid' => :'guid',
+        :'member_guid' => :'member_guid',
+        :'unit_type' => :'unit_type',
+        :'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',
+        :'balance_type' => :'String',
+        :'balance' => :'Integer',
+        :'created_at' => :'String',
+        :'description' => :'String',
+        :'expires_on' => :'String',
+        :'guid' => :'String',
+        :'member_guid' => :'String',
+        :'unit_type' => :'String',
+        :'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::RewardsResponse` 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::RewardsResponse`. 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']
+      end
+
+      if attributes.key?(:'balance_type')
+        self.balance_type = attributes[:'balance_type']
+      end
+
+      if attributes.key?(:'balance')
+        self.balance = attributes[:'balance']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'expires_on')
+        self.expires_on = attributes[:'expires_on']
+      end
+
+      if attributes.key?(:'guid')
+        self.guid = attributes[:'guid']
+      end
+
+      if attributes.key?(:'member_guid')
+        self.member_guid = attributes[:'member_guid']
+      end
+
+      if attributes.key?(:'unit_type')
+        self.unit_type = attributes[:'unit_type']
+      end
+
+      if attributes.key?(:'user_guid')
+        self.user_guid = attributes[:'user_guid']
+      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 &&
+          account_guid == o.account_guid &&
+          balance_type == o.balance_type &&
+          balance == o.balance &&
+          created_at == o.created_at &&
+          description == o.description &&
+          expires_on == o.expires_on &&
+          guid == o.guid &&
+          member_guid == o.member_guid &&
+          unit_type == o.unit_type &&
+          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, balance_type, balance, created_at, description, expires_on, guid, member_guid, unit_type, 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_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/rewards_response_body.rb

@@ -0,0 +1,225 @@
+=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: 7.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MxPlatformRuby
+  class RewardsResponseBody
+    attr_accessor :rewards
+
+    attr_accessor :pagination
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rewards' => :'rewards',
+        :'pagination' => :'pagination'
+      }
+    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
+      {
+        :'rewards' => :'Array<RewardsResponse>',
+        :'pagination' => :'PaginationResponse'
+      }
+    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::RewardsResponseBody` 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::RewardsResponseBody`. 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?(:'rewards')
+        if (value = attributes[:'rewards']).is_a?(Array)
+          self.rewards = value
+        end
+      end
+
+      if attributes.key?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      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 &&
+          rewards == o.rewards &&
+          pagination == o.pagination
+    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
+      [rewards, pagination].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_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/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 7.0.1
 =end
 
 module MxPlatformRuby
-  VERSION = '0.37.0'
+  VERSION = '0.39.0'
 end

data/lib/mx-platform-ruby.rb

@@ -48,6 +48,8 @@ require 'mx-platform-ruby/models/connect_widget_response_body'
 require 'mx-platform-ruby/models/credential_request'
 require 'mx-platform-ruby/models/credential_response'
 require 'mx-platform-ruby/models/credentials_response_body'
+require 'mx-platform-ruby/models/credit_card_product'
+require 'mx-platform-ruby/models/credit_card_product_response'
 require 'mx-platform-ruby/models/enhance_transaction_response'
 require 'mx-platform-ruby/models/enhance_transactions_request'
 require 'mx-platform-ruby/models/enhance_transactions_request_body'
@@ -99,6 +101,10 @@ require 'mx-platform-ruby/models/payment_processor_authorization_code_request'
 require 'mx-platform-ruby/models/payment_processor_authorization_code_request_body'
 require 'mx-platform-ruby/models/payment_processor_authorization_code_response'
 require 'mx-platform-ruby/models/payment_processor_authorization_code_response_body'
+require 'mx-platform-ruby/models/reward_response'
+require 'mx-platform-ruby/models/reward_response_body'
+require 'mx-platform-ruby/models/rewards_response'
+require 'mx-platform-ruby/models/rewards_response_body'
 require 'mx-platform-ruby/models/scheduled_payment_response'
 require 'mx-platform-ruby/models/scheduled_payments_response_body'
 require 'mx-platform-ruby/models/spending_plan_account_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.37.0
+gemVersion: 0.39.0
 library: faraday
 moduleName: MxPlatformRuby

data/spec/api/mx_platform_api_spec.rb

@@ -190,6 +190,18 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for credit_card
+  # Read a Credit Card Product
+  # This endpoint returns the specified `credit_card_product` according to the unique GUID.
+  # @param credit_card_product_guid The required `credit_card_product_guid` can be found on the `account` object.
+  # @param [Hash] opts the optional parameters
+  # @return [CreditCardProductResponse]
+  describe 'credit_card test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for delete_category
   # Delete category
   # Use this endpoint to delete a specific custom category according to its unique GUID. The API will respond with an empty object and a status of `204 No Content`.
@@ -387,6 +399,19 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for fetch_rewards
+  # Fetch Rewards
+  # Calling this endpoint initiates an aggregation-type event which will gather the member's rewards information, as well as account and transaction information. Rewards data is also gathered with daily background aggregations.
+  # @param user_guid The unique id for a `user`.
+  # @param member_guid The unique identifier for the member. Defined by MX.
+  # @param [Hash] opts the optional parameters
+  # @return [MemberResponseBody]
+  describe 'fetch_rewards test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for fetch_statements
   # Fetch statements
   # Use this endpoint to fetch the statements associated with a particular member.
@@ -738,6 +763,19 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for list_rewards
+  # List Rewards
+  # Use this endpoint to list all the `rewards` associated with a specified `member`.
+  # @param user_guid The unique id for a `user`.
+  # @param member_guid The unique identifier for the member. Defined by MX.
+  # @param [Hash] opts the optional parameters
+  # @return [RewardsResponseBody]
+  describe 'list_rewards test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for list_statements_by_member
   # List statements by member
   # Use this endpoint to get an array of available statements.
@@ -1078,6 +1116,20 @@ describe 'MxPlatformApi' do
     end
   end
 
+  # unit tests for read_rewards
+  # Read Reward
+  # Use this endpoint to read a specific `reward` based on its unique GUID..
+  # @param user_guid The unique id for a `user`.
+  # @param member_guid The unique identifier for the member. Defined by MX.
+  # @param reward_guid The unique identifier for the rewards. Defined by MX.
+  # @param [Hash] opts the optional parameters
+  # @return [RewardResponseBody]
+  describe 'read_rewards test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for read_statement_by_member
   # Read statement by member
   # Use this endpoint to read a JSON representation of the statement.

data/spec/models/account_response_spec.rb

@@ -313,6 +313,12 @@ describe MxPlatformRuby::AccountResponse do
     end
   end
 
+  describe 'test attribute "statement_balance"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "subtype"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/credit_card_product_response_spec.rb

@@ -0,0 +1,34 @@
+=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: 7.0.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for MxPlatformRuby::CreditCardProductResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe MxPlatformRuby::CreditCardProductResponse do
+  let(:instance) { MxPlatformRuby::CreditCardProductResponse.new }
+
+  describe 'test an instance of CreditCardProductResponse' do
+    it 'should create an instance of CreditCardProductResponse' do
+      expect(instance).to be_instance_of(MxPlatformRuby::CreditCardProductResponse)
+    end
+  end
+  describe 'test attribute "reward"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end