komoju-sdk 1.0.0.beta.1

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

@@ -0,0 +1,571 @@
+=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 Disbursement
+    # A unique 25-character alphanumeric resource identifier.
+    attr_accessor :id
+
+    attr_accessor :currency
+
+    # Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :amount
+
+    # Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :fee
+
+    # Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :fee_tax
+
+    attr_accessor :status
+
+    # 4-digit Zengin bank code of the recipient's bank.
+    attr_accessor :bank_code
+
+    # 3-digit Zengin branch code.
+    attr_accessor :branch_code
+
+    # Type of the recipient's bank account.
+    attr_accessor :account_type
+
+    # Recipient's bank account number.
+    attr_accessor :account_number
+
+    # Name of the recipient bank account holder in katakana.
+    attr_accessor :account_name_kana
+
+    # Error message if the disbursement failed, otherwise null.
+    attr_accessor :error
+
+    # Merchant-assigned external reference ID for this disbursement.
+    attr_accessor :external_id
+
+    # Timestamp when the disbursement was created.
+    attr_accessor :created_at
+
+    # Timestamp when the disbursement record was last updated.
+    attr_accessor :last_updated_at
+
+    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',
+        :'currency' => :'currency',
+        :'amount' => :'amount',
+        :'fee' => :'fee',
+        :'fee_tax' => :'fee_tax',
+        :'status' => :'status',
+        :'bank_code' => :'bank_code',
+        :'branch_code' => :'branch_code',
+        :'account_type' => :'account_type',
+        :'account_number' => :'account_number',
+        :'account_name_kana' => :'account_name_kana',
+        :'error' => :'error',
+        :'external_id' => :'external_id',
+        :'created_at' => :'created_at',
+        :'last_updated_at' => :'last_updated_at'
+      }
+    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',
+        :'currency' => :'Currency',
+        :'amount' => :'Integer',
+        :'fee' => :'Integer',
+        :'fee_tax' => :'Integer',
+        :'status' => :'DisbursementStatus',
+        :'bank_code' => :'String',
+        :'branch_code' => :'String',
+        :'account_type' => :'String',
+        :'account_number' => :'String',
+        :'account_name_kana' => :'String',
+        :'error' => :'String',
+        :'external_id' => :'String',
+        :'created_at' => :'Time',
+        :'last_updated_at' => :'Time'
+      }
+    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::Disbursement` 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::Disbursement`. 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?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'fee')
+        self.fee = attributes[:'fee']
+      else
+        self.fee = nil
+      end
+
+      if attributes.key?(:'fee_tax')
+        self.fee_tax = attributes[:'fee_tax']
+      else
+        self.fee_tax = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'bank_code')
+        self.bank_code = attributes[:'bank_code']
+      else
+        self.bank_code = nil
+      end
+
+      if attributes.key?(:'branch_code')
+        self.branch_code = attributes[:'branch_code']
+      else
+        self.branch_code = nil
+      end
+
+      if attributes.key?(:'account_type')
+        self.account_type = attributes[:'account_type']
+      else
+        self.account_type = nil
+      end
+
+      if attributes.key?(:'account_number')
+        self.account_number = attributes[:'account_number']
+      else
+        self.account_number = nil
+      end
+
+      if attributes.key?(:'account_name_kana')
+        self.account_name_kana = attributes[:'account_name_kana']
+      else
+        self.account_name_kana = nil
+      end
+
+      if attributes.key?(:'error')
+        self.error = attributes[:'error']
+      else
+        self.error = nil
+      end
+
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      else
+        self.external_id = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'last_updated_at')
+        self.last_updated_at = attributes[:'last_updated_at']
+      else
+        self.last_updated_at = 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 @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @amount < 0
+        invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.')
+      end
+
+      if @fee.nil?
+        invalid_properties.push('invalid value for "fee", fee cannot be nil.')
+      end
+
+      if @fee < 0
+        invalid_properties.push('invalid value for "fee", must be greater than or equal to 0.')
+      end
+
+      if @fee_tax.nil?
+        invalid_properties.push('invalid value for "fee_tax", fee_tax cannot be nil.')
+      end
+
+      if @fee_tax < 0
+        invalid_properties.push('invalid value for "fee_tax", must be greater than or equal to 0.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @bank_code.nil?
+        invalid_properties.push('invalid value for "bank_code", bank_code cannot be nil.')
+      end
+
+      if @branch_code.nil?
+        invalid_properties.push('invalid value for "branch_code", branch_code cannot be nil.')
+      end
+
+      if @account_type.nil?
+        invalid_properties.push('invalid value for "account_type", account_type cannot be nil.')
+      end
+
+      if @account_number.nil?
+        invalid_properties.push('invalid value for "account_number", account_number cannot be nil.')
+      end
+
+      if @account_name_kana.nil?
+        invalid_properties.push('invalid value for "account_name_kana", account_name_kana cannot be nil.')
+      end
+
+      if @error.nil?
+        invalid_properties.push('invalid value for "error", error cannot be nil.')
+      end
+
+      if @external_id.nil?
+        invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @last_updated_at.nil?
+        invalid_properties.push('invalid value for "last_updated_at", last_updated_at 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 @currency.nil?
+      return false if @amount.nil?
+      return false if @amount < 0
+      return false if @fee.nil?
+      return false if @fee < 0
+      return false if @fee_tax.nil?
+      return false if @fee_tax < 0
+      return false if @status.nil?
+      return false if @bank_code.nil?
+      return false if @branch_code.nil?
+      return false if @account_type.nil?
+      return false if @account_number.nil?
+      return false if @account_name_kana.nil?
+      return false if @error.nil?
+      return false if @external_id.nil?
+      return false if @created_at.nil?
+      return false if @last_updated_at.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
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if amount.nil?
+        fail ArgumentError, 'amount cannot be nil'
+      end
+
+      if amount < 0
+        fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 0.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fee Value to be assigned
+    def fee=(fee)
+      if fee.nil?
+        fail ArgumentError, 'fee cannot be nil'
+      end
+
+      if fee < 0
+        fail ArgumentError, 'invalid value for "fee", must be greater than or equal to 0.'
+      end
+
+      @fee = fee
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] fee_tax Value to be assigned
+    def fee_tax=(fee_tax)
+      if fee_tax.nil?
+        fail ArgumentError, 'fee_tax cannot be nil'
+      end
+
+      if fee_tax < 0
+        fail ArgumentError, 'invalid value for "fee_tax", must be greater than or equal to 0.'
+      end
+
+      @fee_tax = fee_tax
+    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 &&
+          currency == o.currency &&
+          amount == o.amount &&
+          fee == o.fee &&
+          fee_tax == o.fee_tax &&
+          status == o.status &&
+          bank_code == o.bank_code &&
+          branch_code == o.branch_code &&
+          account_type == o.account_type &&
+          account_number == o.account_number &&
+          account_name_kana == o.account_name_kana &&
+          error == o.error &&
+          external_id == o.external_id &&
+          created_at == o.created_at &&
+          last_updated_at == o.last_updated_at
+    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, currency, amount, fee, fee_tax, status, bank_code, branch_code, account_type, account_number, account_name_kana, error, external_id, created_at, last_updated_at].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