komoju-sdk 1.0.0.beta.1

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

@@ -0,0 +1,474 @@
+=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 CreatePaymentRequestWithCustomer
+    # 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
+
+    # If `false`, the payment will be authorized on success, and you must manually capture it later to secure funds.  The payment will be captured immediately if omitted.
+    attr_accessor :capture
+
+    # A description from your application for this payment.
+    attr_accessor :description
+
+    attr_accessor :tax
+
+    attr_accessor :currency
+
+    # A unique ID from your application used to track this payment.
+    attr_accessor :external_order_num
+
+    # For offsite payment methods, specify the URL where user will be redirected to after they have completed the payment.
+    attr_accessor :return_url
+
+    # For offsite payment methods, specify the URL where user will be redirected to if they cancel the payment.
+    attr_accessor :cancel_url
+
+    attr_accessor :locale
+
+    # Specify a key-value map which will be stored on the payment. You can use this field to store metadata related to this payment. Keys and values must be strings. Keys have a maximum length of 30 characters. Values have a maximum length of 2000 characters.
+    attr_accessor :metadata
+
+    # On supported merchant and supported payment methods, specify a custom Merchant Category Code (MCC) for this payment.  See [Dynamic Statement Descriptors & MCCs](https://doc.komoju.com/docs/payments-with-dynamic-statement-descriptors) for more information.
+    attr_accessor :mcc
+
+    attr_accessor :statement_descriptor
+
+    attr_accessor :fraud_details
+
+    attr_accessor :platform_details
+
+    # For a subscription payment, specify customer's identifier for this payment.  This identifier can be obtained from [Customer: Create](https://doc.komoju.com/reference/createcustomer) endpoint.
+    attr_accessor :customer
+
+    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
+      {
+        :'amount' => :'amount',
+        :'capture' => :'capture',
+        :'description' => :'description',
+        :'tax' => :'tax',
+        :'currency' => :'currency',
+        :'external_order_num' => :'external_order_num',
+        :'return_url' => :'return_url',
+        :'cancel_url' => :'cancel_url',
+        :'locale' => :'locale',
+        :'metadata' => :'metadata',
+        :'mcc' => :'mcc',
+        :'statement_descriptor' => :'statement_descriptor',
+        :'fraud_details' => :'fraud_details',
+        :'platform_details' => :'platform_details',
+        :'customer' => :'customer'
+      }
+    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
+      {
+        :'amount' => :'Integer',
+        :'capture' => :'Boolean',
+        :'description' => :'String',
+        :'tax' => :'CreatePaymentRequestWithPaymentDetailsTax',
+        :'currency' => :'Currency',
+        :'external_order_num' => :'String',
+        :'return_url' => :'String',
+        :'cancel_url' => :'String',
+        :'locale' => :'Locale',
+        :'metadata' => :'Object',
+        :'mcc' => :'String',
+        :'statement_descriptor' => :'StatementDescriptor',
+        :'fraud_details' => :'FraudDetails',
+        :'platform_details' => :'PlatformDetails',
+        :'customer' => :'String'
+      }
+    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::CreatePaymentRequestWithCustomer` 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::CreatePaymentRequestWithCustomer`. 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?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'capture')
+        self.capture = attributes[:'capture']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'tax')
+        self.tax = attributes[:'tax']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:'external_order_num')
+        self.external_order_num = attributes[:'external_order_num']
+      end
+
+      if attributes.key?(:'return_url')
+        self.return_url = attributes[:'return_url']
+      end
+
+      if attributes.key?(:'cancel_url')
+        self.cancel_url = attributes[:'cancel_url']
+      end
+
+      if attributes.key?(:'locale')
+        self.locale = attributes[:'locale']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'mcc')
+        self.mcc = attributes[:'mcc']
+      end
+
+      if attributes.key?(:'statement_descriptor')
+        self.statement_descriptor = attributes[:'statement_descriptor']
+      end
+
+      if attributes.key?(:'fraud_details')
+        self.fraud_details = attributes[:'fraud_details']
+      end
+
+      if attributes.key?(:'platform_details')
+        self.platform_details = attributes[:'platform_details']
+      end
+
+      if attributes.key?(:'customer')
+        self.customer = attributes[:'customer']
+      else
+        self.customer = 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 @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 @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if !@mcc.nil? && @mcc.to_s.length > 4
+        invalid_properties.push('invalid value for "mcc", the character length must be smaller than or equal to 4.')
+      end
+
+      if !@mcc.nil? && @mcc.to_s.length < 4
+        invalid_properties.push('invalid value for "mcc", the character length must be great than or equal to 4.')
+      end
+
+      if @customer.nil?
+        invalid_properties.push('invalid value for "customer", customer cannot be nil.')
+      end
+
+      if @customer.to_s.length > 25
+        invalid_properties.push('invalid value for "customer", the character length must be smaller than or equal to 25.')
+      end
+
+      if @customer.to_s.length < 25
+        invalid_properties.push('invalid value for "customer", the character length must be great than or equal to 25.')
+      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 @amount.nil?
+      return false if @amount < 0
+      return false if @currency.nil?
+      return false if !@mcc.nil? && @mcc.to_s.length > 4
+      return false if !@mcc.nil? && @mcc.to_s.length < 4
+      return false if @customer.nil?
+      return false if @customer.to_s.length > 25
+      return false if @customer.to_s.length < 25
+      true
+    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] mcc Value to be assigned
+    def mcc=(mcc)
+      if mcc.nil?
+        fail ArgumentError, 'mcc cannot be nil'
+      end
+
+      if mcc.to_s.length > 4
+        fail ArgumentError, 'invalid value for "mcc", the character length must be smaller than or equal to 4.'
+      end
+
+      if mcc.to_s.length < 4
+        fail ArgumentError, 'invalid value for "mcc", the character length must be great than or equal to 4.'
+      end
+
+      @mcc = mcc
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] customer Value to be assigned
+    def customer=(customer)
+      if customer.nil?
+        fail ArgumentError, 'customer cannot be nil'
+      end
+
+      if customer.to_s.length > 25
+        fail ArgumentError, 'invalid value for "customer", the character length must be smaller than or equal to 25.'
+      end
+
+      if customer.to_s.length < 25
+        fail ArgumentError, 'invalid value for "customer", the character length must be great than or equal to 25.'
+      end
+
+      @customer = customer
+    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 &&
+          amount == o.amount &&
+          capture == o.capture &&
+          description == o.description &&
+          tax == o.tax &&
+          currency == o.currency &&
+          external_order_num == o.external_order_num &&
+          return_url == o.return_url &&
+          cancel_url == o.cancel_url &&
+          locale == o.locale &&
+          metadata == o.metadata &&
+          mcc == o.mcc &&
+          statement_descriptor == o.statement_descriptor &&
+          fraud_details == o.fraud_details &&
+          platform_details == o.platform_details &&
+          customer == o.customer
+    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
+      [amount, capture, description, tax, currency, external_order_num, return_url, cancel_url, locale, metadata, mcc, statement_descriptor, fraud_details, platform_details, customer].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