komoju-sdk 1.0.0.beta.1

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

@@ -0,0 +1,727 @@
+=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 PaymentDetailsCreditCard
+    # Payment method type.
+    attr_accessor :type
+
+    # Customer's email address. Will be used for fraud prevention and payment receipt.
+    attr_accessor :email
+
+    # Credit card number.
+    attr_accessor :number
+
+    # Credit card expiration month.
+    attr_accessor :month
+
+    # Credit card expiration year.  If this value is less than 100, it will be treated as two digits year in the current century. E.g. If current year is `2024`, `99` means `2099`.
+    attr_accessor :year
+
+    # Credit card verification value (Also known as CVV2 or CVC2).
+    attr_accessor :verification_value
+
+    # Full name of the customer.  This attribute takes precedence over `given_name` and `family_name`.
+    attr_accessor :name
+
+    # Given name of the customer.  **Note:** You should only set this attribute if you have separate fields for given name and family name. Otherwise, you should only set the full name via `name`.
+    attr_accessor :given_name
+
+    # Family name of the customer.  **Note:** You should only set this attribute if you have separate fields for given name and family name. Otherwise, you should only set the full name via `name`.
+    attr_accessor :family_name
+
+    # If the payment is not immediately captured, specify how many days before the payment expires.  If this value is omitted, the default expiry day shown in the merchant dashboard will be used.
+    attr_accessor :expiry_days
+
+    attr_accessor :intent
+
+    # Specify the initiator of this payment.  Specifying this attribute can increase authorization credit card payments authorization rates, especially when using a stored card.  You can set this value to `customer` when the payment is being made for one-time goods or service purchase, or `merchant` for recurring subscription or installment payments.
+    attr_accessor :initiator
+
+    # Specify whether this payment is the first (`first`) or a subsequent payment in a series (`used`).  Specifying this attribute can increase authorization credit card payments authorization rates, especially when using a stored card.
+    attr_accessor :usage
+
+    # Specify a scheme reference value, which is used to track the chain of multiple related payments.  This value can be subscription number for a recurring subscription payments, or installment agreement number for installment payments.  Specifying this attribute can increase authorization credit card payments authorization rates, especially when using a stored card.
+    attr_accessor :scheme_reference
+
+    attr_accessor :installments
+
+    # Shipping address name. This is the recipient's name.
+    attr_accessor :shipping_address_name
+
+    # Shipping address line 1.
+    attr_accessor :shipping_address_line1
+
+    # Shipping address line 2.
+    attr_accessor :shipping_address_line2
+
+    # Shipping address city.
+    attr_accessor :shipping_address_city
+
+    # Shipping address state.
+    attr_accessor :shipping_address_state
+
+    # Shipping address ZIP code.
+    attr_accessor :shipping_address_zip
+
+    # Shipping address country.
+    attr_accessor :shipping_address_country
+
+    # Billing address name. This is the paying customer's name.
+    attr_accessor :billing_address_name
+
+    # Billing address line 1.
+    attr_accessor :billing_address_line1
+
+    # Billing address line 2.
+    attr_accessor :billing_address_line2
+
+    # Billing address city.
+    attr_accessor :billing_address_city
+
+    # Billing address state.
+    attr_accessor :billing_address_state
+
+    # Billing address ZIP code.
+    attr_accessor :billing_address_zip
+
+    # Billing address country.
+    attr_accessor :billing_address_country
+
+    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
+      {
+        :'type' => :'type',
+        :'email' => :'email',
+        :'number' => :'number',
+        :'month' => :'month',
+        :'year' => :'year',
+        :'verification_value' => :'verification_value',
+        :'name' => :'name',
+        :'given_name' => :'given_name',
+        :'family_name' => :'family_name',
+        :'expiry_days' => :'expiry_days',
+        :'intent' => :'intent',
+        :'initiator' => :'initiator',
+        :'usage' => :'usage',
+        :'scheme_reference' => :'scheme_reference',
+        :'installments' => :'installments',
+        :'shipping_address_name' => :'shipping_address_name',
+        :'shipping_address_line1' => :'shipping_address_line1',
+        :'shipping_address_line2' => :'shipping_address_line2',
+        :'shipping_address_city' => :'shipping_address_city',
+        :'shipping_address_state' => :'shipping_address_state',
+        :'shipping_address_zip' => :'shipping_address_zip',
+        :'shipping_address_country' => :'shipping_address_country',
+        :'billing_address_name' => :'billing_address_name',
+        :'billing_address_line1' => :'billing_address_line1',
+        :'billing_address_line2' => :'billing_address_line2',
+        :'billing_address_city' => :'billing_address_city',
+        :'billing_address_state' => :'billing_address_state',
+        :'billing_address_zip' => :'billing_address_zip',
+        :'billing_address_country' => :'billing_address_country'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'email' => :'String',
+        :'number' => :'String',
+        :'month' => :'Integer',
+        :'year' => :'Integer',
+        :'verification_value' => :'String',
+        :'name' => :'String',
+        :'given_name' => :'String',
+        :'family_name' => :'String',
+        :'expiry_days' => :'Integer',
+        :'intent' => :'Intent',
+        :'initiator' => :'String',
+        :'usage' => :'String',
+        :'scheme_reference' => :'String',
+        :'installments' => :'Installments',
+        :'shipping_address_name' => :'String',
+        :'shipping_address_line1' => :'String',
+        :'shipping_address_line2' => :'String',
+        :'shipping_address_city' => :'String',
+        :'shipping_address_state' => :'String',
+        :'shipping_address_zip' => :'String',
+        :'shipping_address_country' => :'String',
+        :'billing_address_name' => :'String',
+        :'billing_address_line1' => :'String',
+        :'billing_address_line2' => :'String',
+        :'billing_address_city' => :'String',
+        :'billing_address_state' => :'String',
+        :'billing_address_zip' => :'String',
+        :'billing_address_country' => :'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::PaymentDetailsCreditCard` 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::PaymentDetailsCreditCard`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      else
+        self.number = nil
+      end
+
+      if attributes.key?(:'month')
+        self.month = attributes[:'month']
+      else
+        self.month = nil
+      end
+
+      if attributes.key?(:'year')
+        self.year = attributes[:'year']
+      else
+        self.year = nil
+      end
+
+      if attributes.key?(:'verification_value')
+        self.verification_value = attributes[:'verification_value']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'given_name')
+        self.given_name = attributes[:'given_name']
+      end
+
+      if attributes.key?(:'family_name')
+        self.family_name = attributes[:'family_name']
+      end
+
+      if attributes.key?(:'expiry_days')
+        self.expiry_days = attributes[:'expiry_days']
+      end
+
+      if attributes.key?(:'intent')
+        self.intent = attributes[:'intent']
+      end
+
+      if attributes.key?(:'initiator')
+        self.initiator = attributes[:'initiator']
+      end
+
+      if attributes.key?(:'usage')
+        self.usage = attributes[:'usage']
+      end
+
+      if attributes.key?(:'scheme_reference')
+        self.scheme_reference = attributes[:'scheme_reference']
+      end
+
+      if attributes.key?(:'installments')
+        self.installments = attributes[:'installments']
+      end
+
+      if attributes.key?(:'shipping_address_name')
+        self.shipping_address_name = attributes[:'shipping_address_name']
+      end
+
+      if attributes.key?(:'shipping_address_line1')
+        self.shipping_address_line1 = attributes[:'shipping_address_line1']
+      end
+
+      if attributes.key?(:'shipping_address_line2')
+        self.shipping_address_line2 = attributes[:'shipping_address_line2']
+      end
+
+      if attributes.key?(:'shipping_address_city')
+        self.shipping_address_city = attributes[:'shipping_address_city']
+      end
+
+      if attributes.key?(:'shipping_address_state')
+        self.shipping_address_state = attributes[:'shipping_address_state']
+      end
+
+      if attributes.key?(:'shipping_address_zip')
+        self.shipping_address_zip = attributes[:'shipping_address_zip']
+      end
+
+      if attributes.key?(:'shipping_address_country')
+        self.shipping_address_country = attributes[:'shipping_address_country']
+      end
+
+      if attributes.key?(:'billing_address_name')
+        self.billing_address_name = attributes[:'billing_address_name']
+      end
+
+      if attributes.key?(:'billing_address_line1')
+        self.billing_address_line1 = attributes[:'billing_address_line1']
+      end
+
+      if attributes.key?(:'billing_address_line2')
+        self.billing_address_line2 = attributes[:'billing_address_line2']
+      end
+
+      if attributes.key?(:'billing_address_city')
+        self.billing_address_city = attributes[:'billing_address_city']
+      end
+
+      if attributes.key?(:'billing_address_state')
+        self.billing_address_state = attributes[:'billing_address_state']
+      end
+
+      if attributes.key?(:'billing_address_zip')
+        self.billing_address_zip = attributes[:'billing_address_zip']
+      end
+
+      if attributes.key?(:'billing_address_country')
+        self.billing_address_country = attributes[:'billing_address_country']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @number.nil?
+        invalid_properties.push('invalid value for "number", number cannot be nil.')
+      end
+
+      if @number.to_s.length > 19
+        invalid_properties.push('invalid value for "number", the character length must be smaller than or equal to 19.')
+      end
+
+      if @number.to_s.length < 8
+        invalid_properties.push('invalid value for "number", the character length must be great than or equal to 8.')
+      end
+
+      if @month.nil?
+        invalid_properties.push('invalid value for "month", month cannot be nil.')
+      end
+
+      if @month > 12
+        invalid_properties.push('invalid value for "month", must be smaller than or equal to 12.')
+      end
+
+      if @month < 1
+        invalid_properties.push('invalid value for "month", must be greater than or equal to 1.')
+      end
+
+      if @year.nil?
+        invalid_properties.push('invalid value for "year", year cannot be nil.')
+      end
+
+      if @year > 2100
+        invalid_properties.push('invalid value for "year", must be smaller than or equal to 2100.')
+      end
+
+      if @year < 0
+        invalid_properties.push('invalid value for "year", must be greater than or equal to 0.')
+      end
+
+      if !@name.nil? && @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@given_name.nil? && @given_name.to_s.length > 255
+        invalid_properties.push('invalid value for "given_name", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@family_name.nil? && @family_name.to_s.length > 255
+        invalid_properties.push('invalid value for "family_name", the character length must be smaller than or equal to 255.')
+      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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["credit_card"])
+      return false unless type_validator.valid?(@type)
+      return false if @number.nil?
+      return false if @number.to_s.length > 19
+      return false if @number.to_s.length < 8
+      return false if @month.nil?
+      return false if @month > 12
+      return false if @month < 1
+      return false if @year.nil?
+      return false if @year > 2100
+      return false if @year < 0
+      return false if !@name.nil? && @name.to_s.length > 255
+      return false if !@given_name.nil? && @given_name.to_s.length > 255
+      return false if !@family_name.nil? && @family_name.to_s.length > 255
+      initiator_validator = EnumAttributeValidator.new('String', ["merchant", "customer"])
+      return false unless initiator_validator.valid?(@initiator)
+      usage_validator = EnumAttributeValidator.new('String', ["first", "used"])
+      return false unless usage_validator.valid?(@usage)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["credit_card"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] number Value to be assigned
+    def number=(number)
+      if number.nil?
+        fail ArgumentError, 'number cannot be nil'
+      end
+
+      if number.to_s.length > 19
+        fail ArgumentError, 'invalid value for "number", the character length must be smaller than or equal to 19.'
+      end
+
+      if number.to_s.length < 8
+        fail ArgumentError, 'invalid value for "number", the character length must be great than or equal to 8.'
+      end
+
+      @number = number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] month Value to be assigned
+    def month=(month)
+      if month.nil?
+        fail ArgumentError, 'month cannot be nil'
+      end
+
+      if month > 12
+        fail ArgumentError, 'invalid value for "month", must be smaller than or equal to 12.'
+      end
+
+      if month < 1
+        fail ArgumentError, 'invalid value for "month", must be greater than or equal to 1.'
+      end
+
+      @month = month
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] year Value to be assigned
+    def year=(year)
+      if year.nil?
+        fail ArgumentError, 'year cannot be nil'
+      end
+
+      if year > 2100
+        fail ArgumentError, 'invalid value for "year", must be smaller than or equal to 2100.'
+      end
+
+      if year < 0
+        fail ArgumentError, 'invalid value for "year", must be greater than or equal to 0.'
+      end
+
+      @year = year
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] given_name Value to be assigned
+    def given_name=(given_name)
+      if given_name.nil?
+        fail ArgumentError, 'given_name cannot be nil'
+      end
+
+      if given_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "given_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @given_name = given_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] family_name Value to be assigned
+    def family_name=(family_name)
+      if family_name.nil?
+        fail ArgumentError, 'family_name cannot be nil'
+      end
+
+      if family_name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "family_name", the character length must be smaller than or equal to 255.'
+      end
+
+      @family_name = family_name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] initiator Object to be assigned
+    def initiator=(initiator)
+      validator = EnumAttributeValidator.new('String', ["merchant", "customer"])
+      unless validator.valid?(initiator)
+        fail ArgumentError, "invalid value for \"initiator\", must be one of #{validator.allowable_values}."
+      end
+      @initiator = initiator
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] usage Object to be assigned
+    def usage=(usage)
+      validator = EnumAttributeValidator.new('String', ["first", "used"])
+      unless validator.valid?(usage)
+        fail ArgumentError, "invalid value for \"usage\", must be one of #{validator.allowable_values}."
+      end
+      @usage = usage
+    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 &&
+          type == o.type &&
+          email == o.email &&
+          number == o.number &&
+          month == o.month &&
+          year == o.year &&
+          verification_value == o.verification_value &&
+          name == o.name &&
+          given_name == o.given_name &&
+          family_name == o.family_name &&
+          expiry_days == o.expiry_days &&
+          intent == o.intent &&
+          initiator == o.initiator &&
+          usage == o.usage &&
+          scheme_reference == o.scheme_reference &&
+          installments == o.installments &&
+          shipping_address_name == o.shipping_address_name &&
+          shipping_address_line1 == o.shipping_address_line1 &&
+          shipping_address_line2 == o.shipping_address_line2 &&
+          shipping_address_city == o.shipping_address_city &&
+          shipping_address_state == o.shipping_address_state &&
+          shipping_address_zip == o.shipping_address_zip &&
+          shipping_address_country == o.shipping_address_country &&
+          billing_address_name == o.billing_address_name &&
+          billing_address_line1 == o.billing_address_line1 &&
+          billing_address_line2 == o.billing_address_line2 &&
+          billing_address_city == o.billing_address_city &&
+          billing_address_state == o.billing_address_state &&
+          billing_address_zip == o.billing_address_zip &&
+          billing_address_country == o.billing_address_country
+    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
+      [type, email, number, month, year, verification_value, name, given_name, family_name, expiry_days, intent, initiator, usage, scheme_reference, installments, shipping_address_name, shipping_address_line1, shipping_address_line2, shipping_address_city, shipping_address_state, shipping_address_zip, shipping_address_country, billing_address_name, billing_address_line1, billing_address_line2, billing_address_city, billing_address_state, billing_address_zip, billing_address_country].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