citypay_api_client 1.0.0

data/lib/citypay_api_client/models/register_card.rb

@@ -0,0 +1,336 @@
+=begin
+#CityPay Payment API
+
+# This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts.  ## Compliance and Security <aside class=\"notice\">   Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely   and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including: </aside>  * Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+
+The version of the OpenAPI document: 6.0.0
+Contact: support@citypay.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module CityPayApiClient
+  class RegisterCard
+    # The primary number of the card.
+    attr_accessor :cardnumber
+
+    # Determines whether the card should be the new default card.
+    attr_accessor :default
+
+    # The expiry month of the card.
+    attr_accessor :expmonth
+
+    # The expiry year of the card.
+    attr_accessor :expyear
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cardnumber' => :'cardnumber',
+        :'default' => :'default',
+        :'expmonth' => :'expmonth',
+        :'expyear' => :'expyear'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'cardnumber' => :'String',
+        :'default' => :'Boolean',
+        :'expmonth' => :'Integer',
+        :'expyear' => :'Integer'
+      }
+    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 `CityPayApiClient::RegisterCard` 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 `CityPayApiClient::RegisterCard`. 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?(:'cardnumber')
+        self.cardnumber = attributes[:'cardnumber']
+      end
+
+      if attributes.key?(:'default')
+        self.default = attributes[:'default']
+      end
+
+      if attributes.key?(:'expmonth')
+        self.expmonth = attributes[:'expmonth']
+      end
+
+      if attributes.key?(:'expyear')
+        self.expyear = attributes[:'expyear']
+      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
+      invalid_properties = Array.new
+      if @cardnumber.nil?
+        invalid_properties.push('invalid value for "cardnumber", cardnumber cannot be nil.')
+      end
+
+      if @cardnumber.to_s.length > 22
+        invalid_properties.push('invalid value for "cardnumber", the character length must be smaller than or equal to 22.')
+      end
+
+      if @cardnumber.to_s.length < 12
+        invalid_properties.push('invalid value for "cardnumber", the character length must be great than or equal to 12.')
+      end
+
+      if @expmonth.nil?
+        invalid_properties.push('invalid value for "expmonth", expmonth cannot be nil.')
+      end
+
+      if @expmonth > 12
+        invalid_properties.push('invalid value for "expmonth", must be smaller than or equal to 12.')
+      end
+
+      if @expmonth < 1
+        invalid_properties.push('invalid value for "expmonth", must be greater than or equal to 1.')
+      end
+
+      if @expyear.nil?
+        invalid_properties.push('invalid value for "expyear", expyear cannot be nil.')
+      end
+
+      if @expyear > 2100
+        invalid_properties.push('invalid value for "expyear", must be smaller than or equal to 2100.')
+      end
+
+      if @expyear < 2000
+        invalid_properties.push('invalid value for "expyear", must be greater than or equal to 2000.')
+      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?
+      return false if @cardnumber.nil?
+      return false if @cardnumber.to_s.length > 22
+      return false if @cardnumber.to_s.length < 12
+      return false if @expmonth.nil?
+      return false if @expmonth > 12
+      return false if @expmonth < 1
+      return false if @expyear.nil?
+      return false if @expyear > 2100
+      return false if @expyear < 2000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cardnumber Value to be assigned
+    def cardnumber=(cardnumber)
+      if cardnumber.nil?
+        fail ArgumentError, 'cardnumber cannot be nil'
+      end
+
+      if cardnumber.to_s.length > 22
+        fail ArgumentError, 'invalid value for "cardnumber", the character length must be smaller than or equal to 22.'
+      end
+
+      if cardnumber.to_s.length < 12
+        fail ArgumentError, 'invalid value for "cardnumber", the character length must be great than or equal to 12.'
+      end
+
+      @cardnumber = cardnumber
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expmonth Value to be assigned
+    def expmonth=(expmonth)
+      if expmonth.nil?
+        fail ArgumentError, 'expmonth cannot be nil'
+      end
+
+      if expmonth > 12
+        fail ArgumentError, 'invalid value for "expmonth", must be smaller than or equal to 12.'
+      end
+
+      if expmonth < 1
+        fail ArgumentError, 'invalid value for "expmonth", must be greater than or equal to 1.'
+      end
+
+      @expmonth = expmonth
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expyear Value to be assigned
+    def expyear=(expyear)
+      if expyear.nil?
+        fail ArgumentError, 'expyear cannot be nil'
+      end
+
+      if expyear > 2100
+        fail ArgumentError, 'invalid value for "expyear", must be smaller than or equal to 2100.'
+      end
+
+      if expyear < 2000
+        fail ArgumentError, 'invalid value for "expyear", must be greater than or equal to 2000.'
+      end
+
+      @expyear = expyear
+    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 &&
+          cardnumber == o.cardnumber &&
+          default == o.default &&
+          expmonth == o.expmonth &&
+          expyear == o.expyear
+    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
+      [cardnumber, default, expmonth, expyear].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(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
+        CityPayApiClient.const_get(type).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/citypay_api_client/models/request_challenged.rb

@@ -0,0 +1,247 @@
+=begin
+#CityPay Payment API
+
+# This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts.  ## Compliance and Security <aside class=\"notice\">   Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely   and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including: </aside>  * Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+
+The version of the OpenAPI document: 6.0.0
+Contact: support@citypay.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+
+module CityPayApiClient
+  class RequestChallenged
+    # The url of the Access Control Server (ACS) to forward the user to. 
+    attr_accessor :acs_url
+
+    # The challenge request data which is encoded for usage by the ACS.
+    attr_accessor :creq
+
+    # The merchant id that processed this transaction.
+    attr_accessor :merchantid
+
+    # The 3DSv2 trans id reference for the challenge process.
+    attr_accessor :three_d_server_trans_id
+
+    # The transaction number for the challenge, ordered incrementally from 1 for every merchant_id. 
+    attr_accessor :transno
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'acs_url' => :'acs_url',
+        :'creq' => :'creq',
+        :'merchantid' => :'merchantid',
+        :'three_d_server_trans_id' => :'ThreeDServerTransId',
+        :'transno' => :'transno'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'acs_url' => :'String',
+        :'creq' => :'String',
+        :'merchantid' => :'Integer',
+        :'three_d_server_trans_id' => :'String',
+        :'transno' => :'Integer'
+      }
+    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 `CityPayApiClient::RequestChallenged` 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 `CityPayApiClient::RequestChallenged`. 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?(:'acs_url')
+        self.acs_url = attributes[:'acs_url']
+      end
+
+      if attributes.key?(:'creq')
+        self.creq = attributes[:'creq']
+      end
+
+      if attributes.key?(:'merchantid')
+        self.merchantid = attributes[:'merchantid']
+      end
+
+      if attributes.key?(:'three_d_server_trans_id')
+        self.three_d_server_trans_id = attributes[:'three_d_server_trans_id']
+      end
+
+      if attributes.key?(:'transno')
+        self.transno = attributes[:'transno']
+      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
+      invalid_properties = Array.new
+      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?
+      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 &&
+          acs_url == o.acs_url &&
+          creq == o.creq &&
+          merchantid == o.merchantid &&
+          three_d_server_trans_id == o.three_d_server_trans_id &&
+          transno == o.transno
+    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
+      [acs_url, creq, merchantid, three_d_server_trans_id, transno].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if 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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(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
+        CityPayApiClient.const_get(type).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