mx-platform-ruby 1.10.0 → 1.11.0

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

@@ -1,9 +1,9 @@
 =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 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: 0.1.0
+The version of the OpenAPI document: 20111101
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.8.0

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

@@ -0,0 +1,575 @@
+=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 InvestmentHoldingResponse
+    attr_accessor :account_guid
+
+    attr_accessor :cost_basis
+
+    attr_accessor :coupon_yield
+
+    attr_accessor :currency_code
+
+    attr_accessor :current_price
+
+    attr_accessor :daily_change
+
+    attr_accessor :description
+
+    attr_accessor :expiration
+
+    attr_accessor :face_value
+
+    attr_accessor :frequency
+
+    attr_accessor :guid
+
+    attr_accessor :market_value
+
+    attr_accessor :maturity_date
+
+    attr_accessor :percentage_change
+
+    attr_accessor :purchase_price
+
+    attr_accessor :quantity
+
+    attr_accessor :rate
+
+    attr_accessor :strike_price
+
+    attr_accessor :symbol
+
+    attr_accessor :term
+
+    attr_accessor :today_ugl_amount
+
+    attr_accessor :today_ugl_percentage
+
+    attr_accessor :total_ugl_amount
+
+    attr_accessor :total_ugl_percentage
+
+    attr_accessor :unvested_quantity
+
+    attr_accessor :unvested_value
+
+    attr_accessor :user_guid
+
+    attr_accessor :vested_quantity
+
+    attr_accessor :vested_value
+
+    attr_accessor :created_at
+
+    attr_accessor :current_price_as_of
+
+    attr_accessor :issue_date
+
+    attr_accessor :vesting_start_date
+
+    attr_accessor :vesting_end_date
+
+    attr_accessor :put_or_call
+
+    attr_accessor :holding_type
+
+    attr_accessor :term_unit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_guid' => :'account_guid',
+        :'cost_basis' => :'cost_basis',
+        :'coupon_yield' => :'coupon_yield',
+        :'currency_code' => :'currency_code',
+        :'current_price' => :'current_price',
+        :'daily_change' => :'daily_change',
+        :'description' => :'description',
+        :'expiration' => :'expiration',
+        :'face_value' => :'face_value',
+        :'frequency' => :'frequency',
+        :'guid' => :'guid',
+        :'market_value' => :'market_value',
+        :'maturity_date' => :'maturity_date',
+        :'percentage_change' => :'percentage_change',
+        :'purchase_price' => :'purchase_price',
+        :'quantity' => :'quantity',
+        :'rate' => :'rate',
+        :'strike_price' => :'strike_price',
+        :'symbol' => :'symbol',
+        :'term' => :'term',
+        :'today_ugl_amount' => :'today_ugl_amount',
+        :'today_ugl_percentage' => :'today_ugl_percentage',
+        :'total_ugl_amount' => :'total_ugl_amount',
+        :'total_ugl_percentage' => :'total_ugl_percentage',
+        :'unvested_quantity' => :'unvested_quantity',
+        :'unvested_value' => :'unvested_value',
+        :'user_guid' => :'user_guid',
+        :'vested_quantity' => :'vested_quantity',
+        :'vested_value' => :'vested_value',
+        :'created_at' => :'created_at',
+        :'current_price_as_of' => :'current_price_as_of',
+        :'issue_date' => :'issue_date',
+        :'vesting_start_date' => :'vesting_start_date',
+        :'vesting_end_date' => :'vesting_end_date',
+        :'put_or_call' => :'put_or_call',
+        :'holding_type' => :'holding_type',
+        :'term_unit' => :'term_unit'
+      }
+    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',
+        :'cost_basis' => :'Float',
+        :'coupon_yield' => :'String',
+        :'currency_code' => :'String',
+        :'current_price' => :'Float',
+        :'daily_change' => :'Float',
+        :'description' => :'String',
+        :'expiration' => :'String',
+        :'face_value' => :'Float',
+        :'frequency' => :'String',
+        :'guid' => :'String',
+        :'market_value' => :'Float',
+        :'maturity_date' => :'String',
+        :'percentage_change' => :'Float',
+        :'purchase_price' => :'Float',
+        :'quantity' => :'String',
+        :'rate' => :'Float',
+        :'strike_price' => :'Float',
+        :'symbol' => :'String',
+        :'term' => :'String',
+        :'today_ugl_amount' => :'Float',
+        :'today_ugl_percentage' => :'Float',
+        :'total_ugl_amount' => :'Float',
+        :'total_ugl_percentage' => :'Float',
+        :'unvested_quantity' => :'Float',
+        :'unvested_value' => :'Float',
+        :'user_guid' => :'String',
+        :'vested_quantity' => :'Float',
+        :'vested_value' => :'Float',
+        :'created_at' => :'String',
+        :'current_price_as_of' => :'String',
+        :'issue_date' => :'String',
+        :'vesting_start_date' => :'String',
+        :'vesting_end_date' => :'String',
+        :'put_or_call' => :'String',
+        :'holding_type' => :'String',
+        :'term_unit' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'account_guid',
+        :'cost_basis',
+        :'coupon_yield',
+        :'currency_code',
+        :'current_price',
+        :'daily_change',
+        :'description',
+        :'expiration',
+        :'face_value',
+        :'frequency',
+        :'guid',
+        :'market_value',
+        :'maturity_date',
+        :'percentage_change',
+        :'purchase_price',
+        :'quantity',
+        :'rate',
+        :'strike_price',
+        :'symbol',
+        :'term',
+        :'today_ugl_amount',
+        :'today_ugl_percentage',
+        :'total_ugl_amount',
+        :'total_ugl_percentage',
+        :'unvested_quantity',
+        :'unvested_value',
+        :'user_guid',
+        :'vested_quantity',
+        :'vested_value',
+        :'created_at',
+        :'current_price_as_of',
+        :'issue_date',
+        :'vesting_start_date',
+        :'vesting_end_date',
+        :'put_or_call',
+        :'holding_type',
+        :'term_unit'
+      ])
+    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::InvestmentHoldingResponse` 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::InvestmentHoldingResponse`. 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?(:'cost_basis')
+        self.cost_basis = attributes[:'cost_basis']
+      end
+
+      if attributes.key?(:'coupon_yield')
+        self.coupon_yield = attributes[:'coupon_yield']
+      end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.key?(:'current_price')
+        self.current_price = attributes[:'current_price']
+      end
+
+      if attributes.key?(:'daily_change')
+        self.daily_change = attributes[:'daily_change']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'expiration')
+        self.expiration = attributes[:'expiration']
+      end
+
+      if attributes.key?(:'face_value')
+        self.face_value = attributes[:'face_value']
+      end
+
+      if attributes.key?(:'frequency')
+        self.frequency = attributes[:'frequency']
+      end
+
+      if attributes.key?(:'guid')
+        self.guid = attributes[:'guid']
+      end
+
+      if attributes.key?(:'market_value')
+        self.market_value = attributes[:'market_value']
+      end
+
+      if attributes.key?(:'maturity_date')
+        self.maturity_date = attributes[:'maturity_date']
+      end
+
+      if attributes.key?(:'percentage_change')
+        self.percentage_change = attributes[:'percentage_change']
+      end
+
+      if attributes.key?(:'purchase_price')
+        self.purchase_price = attributes[:'purchase_price']
+      end
+
+      if attributes.key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      end
+
+      if attributes.key?(:'rate')
+        self.rate = attributes[:'rate']
+      end
+
+      if attributes.key?(:'strike_price')
+        self.strike_price = attributes[:'strike_price']
+      end
+
+      if attributes.key?(:'symbol')
+        self.symbol = attributes[:'symbol']
+      end
+
+      if attributes.key?(:'term')
+        self.term = attributes[:'term']
+      end
+
+      if attributes.key?(:'today_ugl_amount')
+        self.today_ugl_amount = attributes[:'today_ugl_amount']
+      end
+
+      if attributes.key?(:'today_ugl_percentage')
+        self.today_ugl_percentage = attributes[:'today_ugl_percentage']
+      end
+
+      if attributes.key?(:'total_ugl_amount')
+        self.total_ugl_amount = attributes[:'total_ugl_amount']
+      end
+
+      if attributes.key?(:'total_ugl_percentage')
+        self.total_ugl_percentage = attributes[:'total_ugl_percentage']
+      end
+
+      if attributes.key?(:'unvested_quantity')
+        self.unvested_quantity = attributes[:'unvested_quantity']
+      end
+
+      if attributes.key?(:'unvested_value')
+        self.unvested_value = attributes[:'unvested_value']
+      end
+
+      if attributes.key?(:'user_guid')
+        self.user_guid = attributes[:'user_guid']
+      end
+
+      if attributes.key?(:'vested_quantity')
+        self.vested_quantity = attributes[:'vested_quantity']
+      end
+
+      if attributes.key?(:'vested_value')
+        self.vested_value = attributes[:'vested_value']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'current_price_as_of')
+        self.current_price_as_of = attributes[:'current_price_as_of']
+      end
+
+      if attributes.key?(:'issue_date')
+        self.issue_date = attributes[:'issue_date']
+      end
+
+      if attributes.key?(:'vesting_start_date')
+        self.vesting_start_date = attributes[:'vesting_start_date']
+      end
+
+      if attributes.key?(:'vesting_end_date')
+        self.vesting_end_date = attributes[:'vesting_end_date']
+      end
+
+      if attributes.key?(:'put_or_call')
+        self.put_or_call = attributes[:'put_or_call']
+      end
+
+      if attributes.key?(:'holding_type')
+        self.holding_type = attributes[:'holding_type']
+      end
+
+      if attributes.key?(:'term_unit')
+        self.term_unit = attributes[:'term_unit']
+      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 &&
+          cost_basis == o.cost_basis &&
+          coupon_yield == o.coupon_yield &&
+          currency_code == o.currency_code &&
+          current_price == o.current_price &&
+          daily_change == o.daily_change &&
+          description == o.description &&
+          expiration == o.expiration &&
+          face_value == o.face_value &&
+          frequency == o.frequency &&
+          guid == o.guid &&
+          market_value == o.market_value &&
+          maturity_date == o.maturity_date &&
+          percentage_change == o.percentage_change &&
+          purchase_price == o.purchase_price &&
+          quantity == o.quantity &&
+          rate == o.rate &&
+          strike_price == o.strike_price &&
+          symbol == o.symbol &&
+          term == o.term &&
+          today_ugl_amount == o.today_ugl_amount &&
+          today_ugl_percentage == o.today_ugl_percentage &&
+          total_ugl_amount == o.total_ugl_amount &&
+          total_ugl_percentage == o.total_ugl_percentage &&
+          unvested_quantity == o.unvested_quantity &&
+          unvested_value == o.unvested_value &&
+          user_guid == o.user_guid &&
+          vested_quantity == o.vested_quantity &&
+          vested_value == o.vested_value &&
+          created_at == o.created_at &&
+          current_price_as_of == o.current_price_as_of &&
+          issue_date == o.issue_date &&
+          vesting_start_date == o.vesting_start_date &&
+          vesting_end_date == o.vesting_end_date &&
+          put_or_call == o.put_or_call &&
+          holding_type == o.holding_type &&
+          term_unit == o.term_unit
+    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, cost_basis, coupon_yield, currency_code, current_price, daily_change, description, expiration, face_value, frequency, guid, market_value, maturity_date, percentage_change, purchase_price, quantity, rate, strike_price, symbol, term, today_ugl_amount, today_ugl_percentage, total_ugl_amount, total_ugl_percentage, unvested_quantity, unvested_value, user_guid, vested_quantity, vested_value, created_at, current_price_as_of, issue_date, vesting_start_date, vesting_end_date, put_or_call, holding_type, term_unit].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