komoju-sdk 1.0.0.beta.1

data/lib/komoju-sdk/models/settlement.rb

@@ -0,0 +1,597 @@
+=begin
+#KOMOJU API
+
+#Full featured access to the KOMOJU payments system.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Komoju
+  class Settlement
+    # A unique 25-character alphanumeric resource identifier.
+    attr_accessor :id
+
+    # Resource type name, always \"settlement\".
+    attr_accessor :resource
+
+    # Human-readable reference code for this settlement.
+    attr_accessor :reference
+
+    attr_accessor :status
+
+    # Name of the merchant associated with this settlement.
+    attr_accessor :merchant_name
+
+    # Legal company name of the merchant.
+    attr_accessor :company_name
+
+    # Settlement cycle identifier (e.g. the week or month period covered).
+    attr_accessor :cycle
+
+    # Amount in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :transaction_amount_cents
+
+    attr_accessor :currency
+
+    # Amount in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :fee_amount_cents
+
+    # Amount in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :fee_tax_amount_cents
+
+    # Amount in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :settlement_amount_cents
+
+    attr_accessor :fx_currency
+
+    # Exchange rate applied for FX conversion.
+    attr_accessor :fx_conversion_rate
+
+    # Amount in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :fx_conversion_amount_cents
+
+    # Amount in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :bank_transfer_amount_cents
+
+    # Amount in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :remittance_amount_cents
+
+    # Cutoff timestamp for transactions included in this settlement.
+    attr_accessor :cutoff_time
+
+    # Timestamp when this settlement record was created.
+    attr_accessor :created_at
+
+    attr_accessor :download
+
+    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
+      {
+        :'id' => :'id',
+        :'resource' => :'resource',
+        :'reference' => :'reference',
+        :'status' => :'status',
+        :'merchant_name' => :'merchant_name',
+        :'company_name' => :'company_name',
+        :'cycle' => :'cycle',
+        :'transaction_amount_cents' => :'transaction_amount_cents',
+        :'currency' => :'currency',
+        :'fee_amount_cents' => :'fee_amount_cents',
+        :'fee_tax_amount_cents' => :'fee_tax_amount_cents',
+        :'settlement_amount_cents' => :'settlement_amount_cents',
+        :'fx_currency' => :'fx_currency',
+        :'fx_conversion_rate' => :'fx_conversion_rate',
+        :'fx_conversion_amount_cents' => :'fx_conversion_amount_cents',
+        :'bank_transfer_amount_cents' => :'bank_transfer_amount_cents',
+        :'remittance_amount_cents' => :'remittance_amount_cents',
+        :'cutoff_time' => :'cutoff_time',
+        :'created_at' => :'created_at',
+        :'download' => :'download'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'resource' => :'String',
+        :'reference' => :'String',
+        :'status' => :'Status',
+        :'merchant_name' => :'String',
+        :'company_name' => :'String',
+        :'cycle' => :'String',
+        :'transaction_amount_cents' => :'Integer',
+        :'currency' => :'Currency',
+        :'fee_amount_cents' => :'Integer',
+        :'fee_tax_amount_cents' => :'Integer',
+        :'settlement_amount_cents' => :'Integer',
+        :'fx_currency' => :'Currency',
+        :'fx_conversion_rate' => :'String',
+        :'fx_conversion_amount_cents' => :'Integer',
+        :'bank_transfer_amount_cents' => :'Integer',
+        :'remittance_amount_cents' => :'Integer',
+        :'cutoff_time' => :'Time',
+        :'created_at' => :'Time',
+        :'download' => :'SettlementDownload'
+      }
+    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 `Komoju::Settlement` 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 `Komoju::Settlement`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'resource')
+        self.resource = attributes[:'resource']
+      else
+        self.resource = nil
+      end
+
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
+      else
+        self.reference = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'merchant_name')
+        self.merchant_name = attributes[:'merchant_name']
+      else
+        self.merchant_name = nil
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      else
+        self.company_name = nil
+      end
+
+      if attributes.key?(:'cycle')
+        self.cycle = attributes[:'cycle']
+      else
+        self.cycle = nil
+      end
+
+      if attributes.key?(:'transaction_amount_cents')
+        self.transaction_amount_cents = attributes[:'transaction_amount_cents']
+      else
+        self.transaction_amount_cents = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:'fee_amount_cents')
+        self.fee_amount_cents = attributes[:'fee_amount_cents']
+      else
+        self.fee_amount_cents = nil
+      end
+
+      if attributes.key?(:'fee_tax_amount_cents')
+        self.fee_tax_amount_cents = attributes[:'fee_tax_amount_cents']
+      else
+        self.fee_tax_amount_cents = nil
+      end
+
+      if attributes.key?(:'settlement_amount_cents')
+        self.settlement_amount_cents = attributes[:'settlement_amount_cents']
+      else
+        self.settlement_amount_cents = nil
+      end
+
+      if attributes.key?(:'fx_currency')
+        self.fx_currency = attributes[:'fx_currency']
+      else
+        self.fx_currency = nil
+      end
+
+      if attributes.key?(:'fx_conversion_rate')
+        self.fx_conversion_rate = attributes[:'fx_conversion_rate']
+      else
+        self.fx_conversion_rate = nil
+      end
+
+      if attributes.key?(:'fx_conversion_amount_cents')
+        self.fx_conversion_amount_cents = attributes[:'fx_conversion_amount_cents']
+      else
+        self.fx_conversion_amount_cents = nil
+      end
+
+      if attributes.key?(:'bank_transfer_amount_cents')
+        self.bank_transfer_amount_cents = attributes[:'bank_transfer_amount_cents']
+      else
+        self.bank_transfer_amount_cents = nil
+      end
+
+      if attributes.key?(:'remittance_amount_cents')
+        self.remittance_amount_cents = attributes[:'remittance_amount_cents']
+      else
+        self.remittance_amount_cents = nil
+      end
+
+      if attributes.key?(:'cutoff_time')
+        self.cutoff_time = attributes[:'cutoff_time']
+      else
+        self.cutoff_time = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'download')
+        self.download = attributes[:'download']
+      else
+        self.download = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @id.to_s.length > 25
+        invalid_properties.push('invalid value for "id", the character length must be smaller than or equal to 25.')
+      end
+
+      if @id.to_s.length < 25
+        invalid_properties.push('invalid value for "id", the character length must be great than or equal to 25.')
+      end
+
+      if @resource.nil?
+        invalid_properties.push('invalid value for "resource", resource cannot be nil.')
+      end
+
+      if @reference.nil?
+        invalid_properties.push('invalid value for "reference", reference cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @merchant_name.nil?
+        invalid_properties.push('invalid value for "merchant_name", merchant_name cannot be nil.')
+      end
+
+      if @company_name.nil?
+        invalid_properties.push('invalid value for "company_name", company_name cannot be nil.')
+      end
+
+      if @cycle.nil?
+        invalid_properties.push('invalid value for "cycle", cycle cannot be nil.')
+      end
+
+      if @transaction_amount_cents.nil?
+        invalid_properties.push('invalid value for "transaction_amount_cents", transaction_amount_cents cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @fee_amount_cents.nil?
+        invalid_properties.push('invalid value for "fee_amount_cents", fee_amount_cents cannot be nil.')
+      end
+
+      if @fee_tax_amount_cents.nil?
+        invalid_properties.push('invalid value for "fee_tax_amount_cents", fee_tax_amount_cents cannot be nil.')
+      end
+
+      if @settlement_amount_cents.nil?
+        invalid_properties.push('invalid value for "settlement_amount_cents", settlement_amount_cents cannot be nil.')
+      end
+
+      if @fx_currency.nil?
+        invalid_properties.push('invalid value for "fx_currency", fx_currency cannot be nil.')
+      end
+
+      if @fx_conversion_rate.nil?
+        invalid_properties.push('invalid value for "fx_conversion_rate", fx_conversion_rate cannot be nil.')
+      end
+
+      if @fx_conversion_amount_cents.nil?
+        invalid_properties.push('invalid value for "fx_conversion_amount_cents", fx_conversion_amount_cents cannot be nil.')
+      end
+
+      if @bank_transfer_amount_cents.nil?
+        invalid_properties.push('invalid value for "bank_transfer_amount_cents", bank_transfer_amount_cents cannot be nil.')
+      end
+
+      if @remittance_amount_cents.nil?
+        invalid_properties.push('invalid value for "remittance_amount_cents", remittance_amount_cents cannot be nil.')
+      end
+
+      if @cutoff_time.nil?
+        invalid_properties.push('invalid value for "cutoff_time", cutoff_time cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @download.nil?
+        invalid_properties.push('invalid value for "download", download 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 @id.nil?
+      return false if @id.to_s.length > 25
+      return false if @id.to_s.length < 25
+      return false if @resource.nil?
+      return false if @reference.nil?
+      return false if @status.nil?
+      return false if @merchant_name.nil?
+      return false if @company_name.nil?
+      return false if @cycle.nil?
+      return false if @transaction_amount_cents.nil?
+      return false if @currency.nil?
+      return false if @fee_amount_cents.nil?
+      return false if @fee_tax_amount_cents.nil?
+      return false if @settlement_amount_cents.nil?
+      return false if @fx_currency.nil?
+      return false if @fx_conversion_rate.nil?
+      return false if @fx_conversion_amount_cents.nil?
+      return false if @bank_transfer_amount_cents.nil?
+      return false if @remittance_amount_cents.nil?
+      return false if @cutoff_time.nil?
+      return false if @created_at.nil?
+      return false if @download.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      if id.to_s.length > 25
+        fail ArgumentError, 'invalid value for "id", the character length must be smaller than or equal to 25.'
+      end
+
+      if id.to_s.length < 25
+        fail ArgumentError, 'invalid value for "id", the character length must be great than or equal to 25.'
+      end
+
+      @id = id
+    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 &&
+          id == o.id &&
+          resource == o.resource &&
+          reference == o.reference &&
+          status == o.status &&
+          merchant_name == o.merchant_name &&
+          company_name == o.company_name &&
+          cycle == o.cycle &&
+          transaction_amount_cents == o.transaction_amount_cents &&
+          currency == o.currency &&
+          fee_amount_cents == o.fee_amount_cents &&
+          fee_tax_amount_cents == o.fee_tax_amount_cents &&
+          settlement_amount_cents == o.settlement_amount_cents &&
+          fx_currency == o.fx_currency &&
+          fx_conversion_rate == o.fx_conversion_rate &&
+          fx_conversion_amount_cents == o.fx_conversion_amount_cents &&
+          bank_transfer_amount_cents == o.bank_transfer_amount_cents &&
+          remittance_amount_cents == o.remittance_amount_cents &&
+          cutoff_time == o.cutoff_time &&
+          created_at == o.created_at &&
+          download == o.download
+    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
+      [id, resource, reference, status, merchant_name, company_name, cycle, transaction_amount_cents, currency, fee_amount_cents, fee_tax_amount_cents, settlement_amount_cents, fx_currency, fx_conversion_rate, fx_conversion_amount_cents, bank_transfer_amount_cents, remittance_amount_cents, cutoff_time, created_at, download].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
+      begin
+        new(transformed_hash)
+      rescue ArgumentError => e
+        obj = allocate
+        transformed_hash.each { |k, v| obj.instance_variable_set(:"@#{k}", v) }
+        obj
+      end
+    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) rescue value
+      when :Date
+        Date.parse(value) rescue 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 = Komoju.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