komoju-sdk 1.0.0.beta.1

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

@@ -0,0 +1,797 @@
+=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 Payment
+    # A unique 25-character alphanumeric payment identifier.
+    attr_accessor :id
+
+    # Resource name. Will always be `payment`.
+    attr_accessor :resource
+
+    attr_accessor :status
+
+    # The payment amount before tax, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :amount
+
+    # The tax amount, greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :tax
+
+    # Customer UUID if associated with a customer, otherwise null.
+    attr_accessor :customer
+
+    # Deadline by which the payment must be completed, or null.
+    attr_accessor :payment_deadline
+
+    attr_accessor :payment_details
+
+    # Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :payment_method_fee
+
+    # Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :total
+
+    attr_accessor :currency
+
+    # A description for this payment. May be null if it's not set.
+    attr_accessor :description
+
+    # Timestamp when the payment was captured, or null if not yet captured.
+    attr_accessor :captured_at
+
+    # Merchant-assigned external order number for this payment.
+    attr_accessor :external_order_num
+
+    # Arbitrary key-value metadata attached at payment creation time.
+    attr_accessor :metadata
+
+    # Timestamp when the payment was created.
+    attr_accessor :created_at
+
+    # Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).
+    attr_accessor :amount_refunded
+
+    attr_accessor :locale
+
+    # A unique 25-character alphanumeric resource identifier.
+    attr_accessor :session
+
+    # Customer's family name.
+    attr_accessor :customer_family_name
+
+    # Customer's given name.
+    attr_accessor :customer_given_name
+
+    # Merchant Category Code used for this payment.
+    attr_accessor :mcc
+
+    attr_accessor :statement_descriptor
+
+    attr_accessor :platform_details
+
+    # An array of refunds. Will be an empty array if there are no refunds.
+    attr_accessor :refunds
+
+    # An array of refund requests. Will be an empty array if there are no refund requests.
+    attr_accessor :refund_requests
+
+    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',
+        :'status' => :'status',
+        :'amount' => :'amount',
+        :'tax' => :'tax',
+        :'customer' => :'customer',
+        :'payment_deadline' => :'payment_deadline',
+        :'payment_details' => :'payment_details',
+        :'payment_method_fee' => :'payment_method_fee',
+        :'total' => :'total',
+        :'currency' => :'currency',
+        :'description' => :'description',
+        :'captured_at' => :'captured_at',
+        :'external_order_num' => :'external_order_num',
+        :'metadata' => :'metadata',
+        :'created_at' => :'created_at',
+        :'amount_refunded' => :'amount_refunded',
+        :'locale' => :'locale',
+        :'session' => :'session',
+        :'customer_family_name' => :'customer_family_name',
+        :'customer_given_name' => :'customer_given_name',
+        :'mcc' => :'mcc',
+        :'statement_descriptor' => :'statement_descriptor',
+        :'platform_details' => :'platform_details',
+        :'refunds' => :'refunds',
+        :'refund_requests' => :'refund_requests'
+      }
+    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',
+        :'status' => :'PaymentStatus',
+        :'amount' => :'Integer',
+        :'tax' => :'Integer',
+        :'customer' => :'String',
+        :'payment_deadline' => :'Time',
+        :'payment_details' => :'ResponsePaymentDetailsAll',
+        :'payment_method_fee' => :'Integer',
+        :'total' => :'Integer',
+        :'currency' => :'Currency',
+        :'description' => :'String',
+        :'captured_at' => :'Time',
+        :'external_order_num' => :'String',
+        :'metadata' => :'Object',
+        :'created_at' => :'Time',
+        :'amount_refunded' => :'Integer',
+        :'locale' => :'Locale',
+        :'session' => :'String',
+        :'customer_family_name' => :'String',
+        :'customer_given_name' => :'String',
+        :'mcc' => :'String',
+        :'statement_descriptor' => :'StatementDescriptor',
+        :'platform_details' => :'PlatformDetails',
+        :'refunds' => :'Array<Refund>',
+        :'refund_requests' => :'Array<RefundRequest>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'customer',
+        :'payment_deadline',
+        :'description',
+        :'captured_at',
+        :'external_order_num',
+        :'customer_family_name',
+        :'customer_given_name',
+        :'mcc',
+      ])
+    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::Payment` 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::Payment`. 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?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'tax')
+        self.tax = attributes[:'tax']
+      else
+        self.tax = nil
+      end
+
+      if attributes.key?(:'customer')
+        self.customer = attributes[:'customer']
+      else
+        self.customer = nil
+      end
+
+      if attributes.key?(:'payment_deadline')
+        self.payment_deadline = attributes[:'payment_deadline']
+      else
+        self.payment_deadline = nil
+      end
+
+      if attributes.key?(:'payment_details')
+        self.payment_details = attributes[:'payment_details']
+      else
+        self.payment_details = nil
+      end
+
+      if attributes.key?(:'payment_method_fee')
+        self.payment_method_fee = attributes[:'payment_method_fee']
+      else
+        self.payment_method_fee = nil
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = nil
+      end
+
+      if attributes.key?(:'captured_at')
+        self.captured_at = attributes[:'captured_at']
+      else
+        self.captured_at = nil
+      end
+
+      if attributes.key?(:'external_order_num')
+        self.external_order_num = attributes[:'external_order_num']
+      else
+        self.external_order_num = nil
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      else
+        self.metadata = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'amount_refunded')
+        self.amount_refunded = attributes[:'amount_refunded']
+      else
+        self.amount_refunded = nil
+      end
+
+      if attributes.key?(:'locale')
+        self.locale = attributes[:'locale']
+      else
+        self.locale = nil
+      end
+
+      if attributes.key?(:'session')
+        self.session = attributes[:'session']
+      else
+        self.session = nil
+      end
+
+      if attributes.key?(:'customer_family_name')
+        self.customer_family_name = attributes[:'customer_family_name']
+      else
+        self.customer_family_name = nil
+      end
+
+      if attributes.key?(:'customer_given_name')
+        self.customer_given_name = attributes[:'customer_given_name']
+      else
+        self.customer_given_name = nil
+      end
+
+      if attributes.key?(:'mcc')
+        self.mcc = attributes[:'mcc']
+      else
+        self.mcc = nil
+      end
+
+      if attributes.key?(:'statement_descriptor')
+        self.statement_descriptor = attributes[:'statement_descriptor']
+      else
+        self.statement_descriptor = nil
+      end
+
+      if attributes.key?(:'platform_details')
+        self.platform_details = attributes[:'platform_details']
+      end
+
+      if attributes.key?(:'refunds')
+        if (value = attributes[:'refunds']).is_a?(Array)
+          self.refunds = value
+        end
+      else
+        self.refunds = nil
+      end
+
+      if attributes.key?(:'refund_requests')
+        if (value = attributes[:'refund_requests']).is_a?(Array)
+          self.refund_requests = value
+        end
+      else
+        self.refund_requests = 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 @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @tax.nil?
+        invalid_properties.push('invalid value for "tax", tax cannot be nil.')
+      end
+
+      if @tax < 0
+        invalid_properties.push('invalid value for "tax", must be greater than or equal to 0.')
+      end
+
+      if @payment_details.nil?
+        invalid_properties.push('invalid value for "payment_details", payment_details cannot be nil.')
+      end
+
+      if @payment_method_fee.nil?
+        invalid_properties.push('invalid value for "payment_method_fee", payment_method_fee cannot be nil.')
+      end
+
+      if @payment_method_fee < 0
+        invalid_properties.push('invalid value for "payment_method_fee", must be greater than or equal to 0.')
+      end
+
+      if @total.nil?
+        invalid_properties.push('invalid value for "total", total cannot be nil.')
+      end
+
+      if @total < 0
+        invalid_properties.push('invalid value for "total", must be greater than or equal to 0.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @metadata.nil?
+        invalid_properties.push('invalid value for "metadata", metadata cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @amount_refunded.nil?
+        invalid_properties.push('invalid value for "amount_refunded", amount_refunded cannot be nil.')
+      end
+
+      if @amount_refunded < 0
+        invalid_properties.push('invalid value for "amount_refunded", must be greater than or equal to 0.')
+      end
+
+      if @locale.nil?
+        invalid_properties.push('invalid value for "locale", locale cannot be nil.')
+      end
+
+      if @session.nil?
+        invalid_properties.push('invalid value for "session", session cannot be nil.')
+      end
+
+      if @session.to_s.length > 25
+        invalid_properties.push('invalid value for "session", the character length must be smaller than or equal to 25.')
+      end
+
+      if @session.to_s.length < 25
+        invalid_properties.push('invalid value for "session", the character length must be great than or equal to 25.')
+      end
+
+      if @statement_descriptor.nil?
+        invalid_properties.push('invalid value for "statement_descriptor", statement_descriptor cannot be nil.')
+      end
+
+      if @refunds.nil?
+        invalid_properties.push('invalid value for "refunds", refunds cannot be nil.')
+      end
+
+      if @refund_requests.nil?
+        invalid_properties.push('invalid value for "refund_requests", refund_requests 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?
+      resource_validator = EnumAttributeValidator.new('String', ["payment"])
+      return false unless resource_validator.valid?(@resource)
+      return false if @status.nil?
+      return false if @amount.nil?
+      return false if @amount < 0
+      return false if @tax.nil?
+      return false if @tax < 0
+      return false if @payment_details.nil?
+      return false if @payment_method_fee.nil?
+      return false if @payment_method_fee < 0
+      return false if @total.nil?
+      return false if @total < 0
+      return false if @currency.nil?
+      return false if @metadata.nil?
+      return false if @created_at.nil?
+      return false if @amount_refunded.nil?
+      return false if @amount_refunded < 0
+      return false if @locale.nil?
+      return false if @session.nil?
+      return false if @session.to_s.length > 25
+      return false if @session.to_s.length < 25
+      return false if @statement_descriptor.nil?
+      return false if @refunds.nil?
+      return false if @refund_requests.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 checking allowed values (enum).
+    # @param [Object] resource Object to be assigned
+    def resource=(resource)
+      validator = EnumAttributeValidator.new('String', ["payment"])
+      unless validator.valid?(resource)
+        fail ArgumentError, "invalid value for \"resource\", must be one of #{validator.allowable_values}."
+      end
+      @resource = resource
+    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] tax Value to be assigned
+    def tax=(tax)
+      if tax.nil?
+        fail ArgumentError, 'tax cannot be nil'
+      end
+
+      if tax < 0
+        fail ArgumentError, 'invalid value for "tax", must be greater than or equal to 0.'
+      end
+
+      @tax = tax
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payment_method_fee Value to be assigned
+    def payment_method_fee=(payment_method_fee)
+      if payment_method_fee.nil?
+        fail ArgumentError, 'payment_method_fee cannot be nil'
+      end
+
+      if payment_method_fee < 0
+        fail ArgumentError, 'invalid value for "payment_method_fee", must be greater than or equal to 0.'
+      end
+
+      @payment_method_fee = payment_method_fee
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total Value to be assigned
+    def total=(total)
+      if total.nil?
+        fail ArgumentError, 'total cannot be nil'
+      end
+
+      if total < 0
+        fail ArgumentError, 'invalid value for "total", must be greater than or equal to 0.'
+      end
+
+      @total = total
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount_refunded Value to be assigned
+    def amount_refunded=(amount_refunded)
+      if amount_refunded.nil?
+        fail ArgumentError, 'amount_refunded cannot be nil'
+      end
+
+      if amount_refunded < 0
+        fail ArgumentError, 'invalid value for "amount_refunded", must be greater than or equal to 0.'
+      end
+
+      @amount_refunded = amount_refunded
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] session Value to be assigned
+    def session=(session)
+      if session.nil?
+        fail ArgumentError, 'session cannot be nil'
+      end
+
+      if session.to_s.length > 25
+        fail ArgumentError, 'invalid value for "session", the character length must be smaller than or equal to 25.'
+      end
+
+      if session.to_s.length < 25
+        fail ArgumentError, 'invalid value for "session", the character length must be great than or equal to 25.'
+      end
+
+      @session = session
+    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 &&
+          status == o.status &&
+          amount == o.amount &&
+          tax == o.tax &&
+          customer == o.customer &&
+          payment_deadline == o.payment_deadline &&
+          payment_details == o.payment_details &&
+          payment_method_fee == o.payment_method_fee &&
+          total == o.total &&
+          currency == o.currency &&
+          description == o.description &&
+          captured_at == o.captured_at &&
+          external_order_num == o.external_order_num &&
+          metadata == o.metadata &&
+          created_at == o.created_at &&
+          amount_refunded == o.amount_refunded &&
+          locale == o.locale &&
+          session == o.session &&
+          customer_family_name == o.customer_family_name &&
+          customer_given_name == o.customer_given_name &&
+          mcc == o.mcc &&
+          statement_descriptor == o.statement_descriptor &&
+          platform_details == o.platform_details &&
+          refunds == o.refunds &&
+          refund_requests == o.refund_requests
+    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, status, amount, tax, customer, payment_deadline, payment_details, payment_method_fee, total, currency, description, captured_at, external_order_num, metadata, created_at, amount_refunded, locale, session, customer_family_name, customer_given_name, mcc, statement_descriptor, platform_details, refunds, refund_requests].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