komoju-sdk 1.0.0.beta.1

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

@@ -0,0 +1,398 @@
+=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 ThreeDsAuthResult
+    # Directory Server reference number for this 3DS transaction.
+    attr_accessor :ds_reference_number
+
+    # Access Control Server reference number assigned by the card scheme.
+    attr_accessor :acs_reference_number
+
+    # 3DS requestor transaction ID generated by the merchant's 3DS SDK.
+    attr_accessor :three_ds_requestor_trans_id
+
+    # Access Control Server transaction ID assigned by the card issuer.
+    attr_accessor :acs_trans_id
+
+    # Directory Server transaction ID for this authentication.
+    attr_accessor :ds_trans_id
+
+    # Electronic Commerce Indicator indicating the authentication outcome.
+    attr_accessor :eci
+
+    # Version of the 3DS protocol used (e.g. \"2.1.0\").
+    attr_accessor :message_version
+
+    # Authentication type used for this 3DS transaction.
+    attr_accessor :authentication_type
+
+    # Cardholder Authentication Verification Value (CAVV) from the issuer.
+    attr_accessor :authentication_value
+
+    # Transaction status code (e.g. \"Y\" for authenticated, \"N\" for not authenticated).
+    attr_accessor :trans_status
+
+    # 3DS Server transaction ID assigned by the 3DS server.
+    attr_accessor :three_ds_server_trans_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ds_reference_number' => :'dsReferenceNumber',
+        :'acs_reference_number' => :'acsReferenceNumber',
+        :'three_ds_requestor_trans_id' => :'threeDSRequestorTransID',
+        :'acs_trans_id' => :'acsTransID',
+        :'ds_trans_id' => :'dsTransID',
+        :'eci' => :'eci',
+        :'message_version' => :'messageVersion',
+        :'authentication_type' => :'authenticationType',
+        :'authentication_value' => :'authenticationValue',
+        :'trans_status' => :'transStatus',
+        :'three_ds_server_trans_id' => :'threeDSServerTransID'
+      }
+    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
+      {
+        :'ds_reference_number' => :'String',
+        :'acs_reference_number' => :'String',
+        :'three_ds_requestor_trans_id' => :'String',
+        :'acs_trans_id' => :'String',
+        :'ds_trans_id' => :'String',
+        :'eci' => :'String',
+        :'message_version' => :'String',
+        :'authentication_type' => :'String',
+        :'authentication_value' => :'String',
+        :'trans_status' => :'String',
+        :'three_ds_server_trans_id' => :'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::ThreeDsAuthResult` 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::ThreeDsAuthResult`. 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?(:'ds_reference_number')
+        self.ds_reference_number = attributes[:'ds_reference_number']
+      else
+        self.ds_reference_number = nil
+      end
+
+      if attributes.key?(:'acs_reference_number')
+        self.acs_reference_number = attributes[:'acs_reference_number']
+      else
+        self.acs_reference_number = nil
+      end
+
+      if attributes.key?(:'three_ds_requestor_trans_id')
+        self.three_ds_requestor_trans_id = attributes[:'three_ds_requestor_trans_id']
+      else
+        self.three_ds_requestor_trans_id = nil
+      end
+
+      if attributes.key?(:'acs_trans_id')
+        self.acs_trans_id = attributes[:'acs_trans_id']
+      else
+        self.acs_trans_id = nil
+      end
+
+      if attributes.key?(:'ds_trans_id')
+        self.ds_trans_id = attributes[:'ds_trans_id']
+      else
+        self.ds_trans_id = nil
+      end
+
+      if attributes.key?(:'eci')
+        self.eci = attributes[:'eci']
+      else
+        self.eci = nil
+      end
+
+      if attributes.key?(:'message_version')
+        self.message_version = attributes[:'message_version']
+      else
+        self.message_version = nil
+      end
+
+      if attributes.key?(:'authentication_type')
+        self.authentication_type = attributes[:'authentication_type']
+      else
+        self.authentication_type = nil
+      end
+
+      if attributes.key?(:'authentication_value')
+        self.authentication_value = attributes[:'authentication_value']
+      else
+        self.authentication_value = nil
+      end
+
+      if attributes.key?(:'trans_status')
+        self.trans_status = attributes[:'trans_status']
+      else
+        self.trans_status = nil
+      end
+
+      if attributes.key?(:'three_ds_server_trans_id')
+        self.three_ds_server_trans_id = attributes[:'three_ds_server_trans_id']
+      else
+        self.three_ds_server_trans_id = 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 @ds_reference_number.nil?
+        invalid_properties.push('invalid value for "ds_reference_number", ds_reference_number cannot be nil.')
+      end
+
+      if @acs_reference_number.nil?
+        invalid_properties.push('invalid value for "acs_reference_number", acs_reference_number cannot be nil.')
+      end
+
+      if @three_ds_requestor_trans_id.nil?
+        invalid_properties.push('invalid value for "three_ds_requestor_trans_id", three_ds_requestor_trans_id cannot be nil.')
+      end
+
+      if @acs_trans_id.nil?
+        invalid_properties.push('invalid value for "acs_trans_id", acs_trans_id cannot be nil.')
+      end
+
+      if @ds_trans_id.nil?
+        invalid_properties.push('invalid value for "ds_trans_id", ds_trans_id cannot be nil.')
+      end
+
+      if @eci.nil?
+        invalid_properties.push('invalid value for "eci", eci cannot be nil.')
+      end
+
+      if @message_version.nil?
+        invalid_properties.push('invalid value for "message_version", message_version cannot be nil.')
+      end
+
+      if @authentication_type.nil?
+        invalid_properties.push('invalid value for "authentication_type", authentication_type cannot be nil.')
+      end
+
+      if @authentication_value.nil?
+        invalid_properties.push('invalid value for "authentication_value", authentication_value cannot be nil.')
+      end
+
+      if @trans_status.nil?
+        invalid_properties.push('invalid value for "trans_status", trans_status cannot be nil.')
+      end
+
+      if @three_ds_server_trans_id.nil?
+        invalid_properties.push('invalid value for "three_ds_server_trans_id", three_ds_server_trans_id 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 @ds_reference_number.nil?
+      return false if @acs_reference_number.nil?
+      return false if @three_ds_requestor_trans_id.nil?
+      return false if @acs_trans_id.nil?
+      return false if @ds_trans_id.nil?
+      return false if @eci.nil?
+      return false if @message_version.nil?
+      return false if @authentication_type.nil?
+      return false if @authentication_value.nil?
+      return false if @trans_status.nil?
+      return false if @three_ds_server_trans_id.nil?
+      true
+    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 &&
+          ds_reference_number == o.ds_reference_number &&
+          acs_reference_number == o.acs_reference_number &&
+          three_ds_requestor_trans_id == o.three_ds_requestor_trans_id &&
+          acs_trans_id == o.acs_trans_id &&
+          ds_trans_id == o.ds_trans_id &&
+          eci == o.eci &&
+          message_version == o.message_version &&
+          authentication_type == o.authentication_type &&
+          authentication_value == o.authentication_value &&
+          trans_status == o.trans_status &&
+          three_ds_server_trans_id == o.three_ds_server_trans_id
+    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
+      [ds_reference_number, acs_reference_number, three_ds_requestor_trans_id, acs_trans_id, ds_trans_id, eci, message_version, authentication_type, authentication_value, trans_status, three_ds_server_trans_id].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

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

@@ -0,0 +1,306 @@
+=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 Token
+    # A unique 25-character alphanumeric resource identifier.
+    attr_accessor :id
+
+    # Resource type name, always \"token\".
+    attr_accessor :resource
+
+    # Timestamp when the token was created.
+    attr_accessor :created_at
+
+    attr_accessor :payment_details
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'resource' => :'resource',
+        :'created_at' => :'createdAt',
+        :'payment_details' => :'payment_details'
+      }
+    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',
+        :'created_at' => :'Time',
+        :'payment_details' => :'TokenPaymentDetails'
+      }
+    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::Token` 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::Token`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'payment_details')
+        self.payment_details = attributes[:'payment_details']
+      else
+        self.payment_details = 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 @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @payment_details.nil?
+        invalid_properties.push('invalid value for "payment_details", payment_details 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 @created_at.nil?
+      return false if @payment_details.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 &&
+          created_at == o.created_at &&
+          payment_details == o.payment_details
+    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, created_at, payment_details].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