proton_api 1.8.0

data/lib/proton_api/models/customer_analysis_request.rb

@@ -0,0 +1,286 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'date'
+
+module ProtonApi
+  class CustomerAnalysisRequest
+    attr_accessor :end_date
+
+    attr_accessor :benchmark_end_date
+
+    attr_accessor :customer_ids
+
+    attr_accessor :client_id
+
+    attr_accessor :response_limit
+
+    attr_accessor :currency_conversion
+
+    attr_accessor :start_date
+
+    attr_accessor :currency_code
+
+    attr_accessor :only_active_customers
+
+    attr_accessor :benchmark_start_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'end_date' => :'end_date',
+        :'benchmark_end_date' => :'benchmark_end_date',
+        :'customer_ids' => :'customer_ids',
+        :'client_id' => :'client_id',
+        :'response_limit' => :'response_limit',
+        :'currency_conversion' => :'currency_conversion',
+        :'start_date' => :'start_date',
+        :'currency_code' => :'currency_code',
+        :'only_active_customers' => :'only_active_customers',
+        :'benchmark_start_date' => :'benchmark_start_date'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'end_date' => :'Date',
+        :'benchmark_end_date' => :'Date',
+        :'customer_ids' => :'Array<String>',
+        :'client_id' => :'String',
+        :'response_limit' => :'Integer',
+        :'currency_conversion' => :'String',
+        :'start_date' => :'Date',
+        :'currency_code' => :'String',
+        :'only_active_customers' => :'BOOLEAN',
+        :'benchmark_start_date' => :'Date'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'end_date')
+        self.end_date = attributes[:'end_date']
+      end
+
+      if attributes.has_key?(:'benchmark_end_date')
+        self.benchmark_end_date = attributes[:'benchmark_end_date']
+      end
+
+      if attributes.has_key?(:'customer_ids')
+        if (value = attributes[:'customer_ids']).is_a?(Array)
+          self.customer_ids = value
+        end
+      end
+
+      if attributes.has_key?(:'client_id')
+        self.client_id = attributes[:'client_id']
+      end
+
+      if attributes.has_key?(:'response_limit')
+        self.response_limit = attributes[:'response_limit']
+      else
+        self.response_limit = 10
+      end
+
+      if attributes.has_key?(:'currency_conversion')
+        self.currency_conversion = attributes[:'currency_conversion']
+      end
+
+      if attributes.has_key?(:'start_date')
+        self.start_date = attributes[:'start_date']
+      end
+
+      if attributes.has_key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.has_key?(:'only_active_customers')
+        self.only_active_customers = attributes[:'only_active_customers']
+      else
+        self.only_active_customers = false
+      end
+
+      if attributes.has_key?(:'benchmark_start_date')
+        self.benchmark_start_date = attributes[:'benchmark_start_date']
+      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
+      if !@response_limit.nil? && @response_limit < 1
+        invalid_properties.push('invalid value for "response_limit", must be greater than or equal to 1.')
+      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?
+      return false if !@response_limit.nil? && @response_limit < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] response_limit Value to be assigned
+    def response_limit=(response_limit)
+      if !response_limit.nil? && response_limit < 1
+        fail ArgumentError, 'invalid value for "response_limit", must be greater than or equal to 1.'
+      end
+
+      @response_limit = response_limit
+    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 &&
+          end_date == o.end_date &&
+          benchmark_end_date == o.benchmark_end_date &&
+          customer_ids == o.customer_ids &&
+          client_id == o.client_id &&
+          response_limit == o.response_limit &&
+          currency_conversion == o.currency_conversion &&
+          start_date == o.start_date &&
+          currency_code == o.currency_code &&
+          only_active_customers == o.only_active_customers &&
+          benchmark_start_date == o.benchmark_start_date
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [end_date, benchmark_end_date, customer_ids, client_id, response_limit, currency_conversion, start_date, currency_code, only_active_customers, benchmark_start_date].hash
+    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.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = ProtonApi.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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/proton_api/models/decumulation_goal_deposit_config.rb

@@ -0,0 +1,338 @@
+=begin
+#Hydrogen Proton API
+
+#Financial engineering module of Hydrogen Atom
+
+OpenAPI spec version: 1.8.0
+Contact: info@hydrogenplatform.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.17
+
+=end
+
+require 'date'
+
+module ProtonApi
+  class DecumulationGoalDepositConfig
+    attr_accessor :dep_amount
+
+    attr_accessor :dep_end_period
+
+    attr_accessor :dep_end_reference
+
+    attr_accessor :dep_frequency
+
+    attr_accessor :dep_start_period
+
+    attr_accessor :dep_inflation
+
+    attr_accessor :dep_start_reference
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'dep_amount' => :'dep_amount',
+        :'dep_end_period' => :'dep_end_period',
+        :'dep_end_reference' => :'dep_end_reference',
+        :'dep_frequency' => :'dep_frequency',
+        :'dep_start_period' => :'dep_start_period',
+        :'dep_inflation' => :'dep_inflation',
+        :'dep_start_reference' => :'dep_start_reference'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'dep_amount' => :'Float',
+        :'dep_end_period' => :'Integer',
+        :'dep_end_reference' => :'String',
+        :'dep_frequency' => :'String',
+        :'dep_start_period' => :'Integer',
+        :'dep_inflation' => :'Float',
+        :'dep_start_reference' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'dep_amount')
+        self.dep_amount = attributes[:'dep_amount']
+      end
+
+      if attributes.has_key?(:'dep_end_period')
+        self.dep_end_period = attributes[:'dep_end_period']
+      else
+        self.dep_end_period = 0
+      end
+
+      if attributes.has_key?(:'dep_end_reference')
+        self.dep_end_reference = attributes[:'dep_end_reference']
+      else
+        self.dep_end_reference = 'a_end'
+      end
+
+      if attributes.has_key?(:'dep_frequency')
+        self.dep_frequency = attributes[:'dep_frequency']
+      else
+        self.dep_frequency = 'year'
+      end
+
+      if attributes.has_key?(:'dep_start_period')
+        self.dep_start_period = attributes[:'dep_start_period']
+      else
+        self.dep_start_period = 0
+      end
+
+      if attributes.has_key?(:'dep_inflation')
+        self.dep_inflation = attributes[:'dep_inflation']
+      else
+        self.dep_inflation = 0.0
+      end
+
+      if attributes.has_key?(:'dep_start_reference')
+        self.dep_start_reference = attributes[:'dep_start_reference']
+      else
+        self.dep_start_reference = 'a_start'
+      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
+      if !@dep_amount.nil? && @dep_amount < 0
+        invalid_properties.push('invalid value for "dep_amount", must be greater than or equal to 0.')
+      end
+
+      if !@dep_inflation.nil? && @dep_inflation < -1
+        invalid_properties.push('invalid value for "dep_inflation", must be greater than or equal to -1.')
+      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?
+      return false if !@dep_amount.nil? && @dep_amount < 0
+      dep_end_reference_validator = EnumAttributeValidator.new('String', ['a_start', 'a_end', 'd_end'])
+      return false unless dep_end_reference_validator.valid?(@dep_end_reference)
+      dep_frequency_validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day'])
+      return false unless dep_frequency_validator.valid?(@dep_frequency)
+      return false if !@dep_inflation.nil? && @dep_inflation < -1
+      dep_start_reference_validator = EnumAttributeValidator.new('String', ['a_start', 'a_end', 'd_end'])
+      return false unless dep_start_reference_validator.valid?(@dep_start_reference)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dep_amount Value to be assigned
+    def dep_amount=(dep_amount)
+      if !dep_amount.nil? && dep_amount < 0
+        fail ArgumentError, 'invalid value for "dep_amount", must be greater than or equal to 0.'
+      end
+
+      @dep_amount = dep_amount
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] dep_end_reference Object to be assigned
+    def dep_end_reference=(dep_end_reference)
+      validator = EnumAttributeValidator.new('String', ['a_start', 'a_end', 'd_end'])
+      unless validator.valid?(dep_end_reference)
+        fail ArgumentError, 'invalid value for "dep_end_reference", must be one of #{validator.allowable_values}.'
+      end
+      @dep_end_reference = dep_end_reference
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] dep_frequency Object to be assigned
+    def dep_frequency=(dep_frequency)
+      validator = EnumAttributeValidator.new('String', ['year', 'six_months', 'quarter', 'month', 'two_weeks', 'week', 'day'])
+      unless validator.valid?(dep_frequency)
+        fail ArgumentError, 'invalid value for "dep_frequency", must be one of #{validator.allowable_values}.'
+      end
+      @dep_frequency = dep_frequency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dep_inflation Value to be assigned
+    def dep_inflation=(dep_inflation)
+      if !dep_inflation.nil? && dep_inflation < -1
+        fail ArgumentError, 'invalid value for "dep_inflation", must be greater than or equal to -1.'
+      end
+
+      @dep_inflation = dep_inflation
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] dep_start_reference Object to be assigned
+    def dep_start_reference=(dep_start_reference)
+      validator = EnumAttributeValidator.new('String', ['a_start', 'a_end', 'd_end'])
+      unless validator.valid?(dep_start_reference)
+        fail ArgumentError, 'invalid value for "dep_start_reference", must be one of #{validator.allowable_values}.'
+      end
+      @dep_start_reference = dep_start_reference
+    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 &&
+          dep_amount == o.dep_amount &&
+          dep_end_period == o.dep_end_period &&
+          dep_end_reference == o.dep_end_reference &&
+          dep_frequency == o.dep_frequency &&
+          dep_start_period == o.dep_start_period &&
+          dep_inflation == o.dep_inflation &&
+          dep_start_reference == o.dep_start_reference
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [dep_amount, dep_end_period, dep_end_reference, dep_frequency, dep_start_period, dep_inflation, dep_start_reference].hash
+    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.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = ProtonApi.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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