citypay_api_client 1.0.3 → 1.1.2

data/lib/citypay_api_client/models/paylink_config.rb

@@ -0,0 +1,428 @@
+=begin
+#CityPay Payment API
+
+# This CityPay API is an 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 tokenized payments using cardholder Accounts.  ## Compliance and Security 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. These include  * Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#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 cardholder 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. 
+
+Contact: support@citypay.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module CityPayApiClient
+  class PaylinkConfig
+    # Specifies the approach to be adopted by the Paylink form when displaying a 3-D Secure challenge window. The values may be  iframe: shows the 3-D Secure ACS in an iframe dialog, neatly embedding it in Paylink. This provides a more seamless flow for the cardholder who is able to validate and authenticate their card using a dialog provided by their card issuer.  inline: an inline mode transfers the full browser window to the authentication server, allowing the payment cardholder to see their payment card issuer's URL and the certificate status in the browser. If you request an iframe mode and the browser width is deemed as being small (< 768px) then an inline mode will be enforced. This is to ensure that mobile users have an improved user experience. 
+    attr_accessor :acs_mode
+
+    attr_accessor :custom_params
+
+    # Directly specify the merchant descriptor used for the transaction to be displayed on the payment page.
+    attr_accessor :descriptor
+
+    # Specifies a period of time in seconds after which the token cannot be used. A value of 0 defines that the token will never expire. The API will convert an expiry time based on a string value. For instance:   s - Time in seconds, for example 90s.   m - Time in minutes, for example 20m.   h - Time in hours, for example 4h.   w - Time in weeks, for example 4w.   M - Time in months, for example 6M.   y - Time in years, for example 1y.   Defaults to 30 minutes. 
+    attr_accessor :expire_in
+
+    attr_accessor :field_guard
+
+    attr_accessor :lock_params
+
+    # A URL of a logo to include in the form. The URL should be delivered using HTTPS.
+    attr_accessor :merch_logo
+
+    # A URL of the merchant terms and conditions for payment. If a value is supplied, a checkbox will be required to be completed to confirm that the cardholder agrees to these conditions before payment. A modal dialogue is displayed with the content of the conditions displayed.
+    attr_accessor :merch_terms
+
+    attr_accessor :options
+
+    attr_accessor :part_payments
+
+    attr_accessor :pass_through_data
+
+    attr_accessor :pass_through_headers
+
+    # Specifies a URL to use for a call back when the payment is completed. see Postback Handling }.
+    attr_accessor :postback
+
+    # A password to be added to the postback for HTTP Basic Authentication.
+    attr_accessor :postback_password
+
+    # The policy setting for the postback see Postback Handling.
+    attr_accessor :postback_policy
+
+    # A username to be added to the postback for HTTP Basic Authentication.
+    attr_accessor :postback_username
+
+    # A value which can delay the redirection in seconds. A value of 0 will redirect immediately.
+    attr_accessor :redirect_delay
+
+    # A URL which the browser is redirected to on non-completion of a transaction.
+    attr_accessor :redirect_failure
+
+    # A URL which the browser is redirected to on authorisation of a transaction.
+    attr_accessor :redirect_success
+
+    # The Paylink renderer engine to use.
+    attr_accessor :renderer
+
+    # If a value of true is specified, any redirection will include the transaction result in parameters. It is recommended to use the postback integration rather than redirection parameters.
+    attr_accessor :return_params
+
+    attr_accessor :ui
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'acs_mode' => :'acs_mode',
+        :'custom_params' => :'custom_params',
+        :'descriptor' => :'descriptor',
+        :'expire_in' => :'expire_in',
+        :'field_guard' => :'field_guard',
+        :'lock_params' => :'lock_params',
+        :'merch_logo' => :'merch_logo',
+        :'merch_terms' => :'merch_terms',
+        :'options' => :'options',
+        :'part_payments' => :'part_payments',
+        :'pass_through_data' => :'pass_through_data',
+        :'pass_through_headers' => :'pass_through_headers',
+        :'postback' => :'postback',
+        :'postback_password' => :'postback_password',
+        :'postback_policy' => :'postback_policy',
+        :'postback_username' => :'postback_username',
+        :'redirect_delay' => :'redirect_delay',
+        :'redirect_failure' => :'redirect_failure',
+        :'redirect_success' => :'redirect_success',
+        :'renderer' => :'renderer',
+        :'return_params' => :'return_params',
+        :'ui' => :'ui'
+      }
+    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
+      {
+        :'acs_mode' => :'String',
+        :'custom_params' => :'Array<PaylinkCustomParam>',
+        :'descriptor' => :'String',
+        :'expire_in' => :'String',
+        :'field_guard' => :'Array<PaylinkFieldGuardModel>',
+        :'lock_params' => :'Array<String>',
+        :'merch_logo' => :'String',
+        :'merch_terms' => :'String',
+        :'options' => :'Array<String>',
+        :'part_payments' => :'PaylinkPartPayments',
+        :'pass_through_data' => :'Hash<String, String>',
+        :'pass_through_headers' => :'Hash<String, String>',
+        :'postback' => :'String',
+        :'postback_password' => :'String',
+        :'postback_policy' => :'String',
+        :'postback_username' => :'String',
+        :'redirect_delay' => :'Integer',
+        :'redirect_failure' => :'String',
+        :'redirect_success' => :'String',
+        :'renderer' => :'String',
+        :'return_params' => :'Boolean',
+        :'ui' => :'PaylinkUI'
+      }
+    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::PaylinkConfig` 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::PaylinkConfig`. 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_mode')
+        self.acs_mode = attributes[:'acs_mode']
+      end
+
+      if attributes.key?(:'custom_params')
+        if (value = attributes[:'custom_params']).is_a?(Array)
+          self.custom_params = value
+        end
+      end
+
+      if attributes.key?(:'descriptor')
+        self.descriptor = attributes[:'descriptor']
+      end
+
+      if attributes.key?(:'expire_in')
+        self.expire_in = attributes[:'expire_in']
+      end
+
+      if attributes.key?(:'field_guard')
+        if (value = attributes[:'field_guard']).is_a?(Array)
+          self.field_guard = value
+        end
+      end
+
+      if attributes.key?(:'lock_params')
+        if (value = attributes[:'lock_params']).is_a?(Array)
+          self.lock_params = value
+        end
+      end
+
+      if attributes.key?(:'merch_logo')
+        self.merch_logo = attributes[:'merch_logo']
+      end
+
+      if attributes.key?(:'merch_terms')
+        self.merch_terms = attributes[:'merch_terms']
+      end
+
+      if attributes.key?(:'options')
+        if (value = attributes[:'options']).is_a?(Array)
+          self.options = value
+        end
+      end
+
+      if attributes.key?(:'part_payments')
+        self.part_payments = attributes[:'part_payments']
+      end
+
+      if attributes.key?(:'pass_through_data')
+        if (value = attributes[:'pass_through_data']).is_a?(Hash)
+          self.pass_through_data = value
+        end
+      end
+
+      if attributes.key?(:'pass_through_headers')
+        if (value = attributes[:'pass_through_headers']).is_a?(Hash)
+          self.pass_through_headers = value
+        end
+      end
+
+      if attributes.key?(:'postback')
+        self.postback = attributes[:'postback']
+      end
+
+      if attributes.key?(:'postback_password')
+        self.postback_password = attributes[:'postback_password']
+      end
+
+      if attributes.key?(:'postback_policy')
+        self.postback_policy = attributes[:'postback_policy']
+      end
+
+      if attributes.key?(:'postback_username')
+        self.postback_username = attributes[:'postback_username']
+      end
+
+      if attributes.key?(:'redirect_delay')
+        self.redirect_delay = attributes[:'redirect_delay']
+      end
+
+      if attributes.key?(:'redirect_failure')
+        self.redirect_failure = attributes[:'redirect_failure']
+      end
+
+      if attributes.key?(:'redirect_success')
+        self.redirect_success = attributes[:'redirect_success']
+      end
+
+      if attributes.key?(:'renderer')
+        self.renderer = attributes[:'renderer']
+      end
+
+      if attributes.key?(:'return_params')
+        self.return_params = attributes[:'return_params']
+      end
+
+      if attributes.key?(:'ui')
+        self.ui = attributes[:'ui']
+      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
+      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'
+      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_mode == o.acs_mode &&
+          custom_params == o.custom_params &&
+          descriptor == o.descriptor &&
+          expire_in == o.expire_in &&
+          field_guard == o.field_guard &&
+          lock_params == o.lock_params &&
+          merch_logo == o.merch_logo &&
+          merch_terms == o.merch_terms &&
+          options == o.options &&
+          part_payments == o.part_payments &&
+          pass_through_data == o.pass_through_data &&
+          pass_through_headers == o.pass_through_headers &&
+          postback == o.postback &&
+          postback_password == o.postback_password &&
+          postback_policy == o.postback_policy &&
+          postback_username == o.postback_username &&
+          redirect_delay == o.redirect_delay &&
+          redirect_failure == o.redirect_failure &&
+          redirect_success == o.redirect_success &&
+          renderer == o.renderer &&
+          return_params == o.return_params &&
+          ui == o.ui
+    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_mode, custom_params, descriptor, expire_in, field_guard, lock_params, merch_logo, merch_terms, options, part_payments, pass_through_data, pass_through_headers, postback, postback_password, postback_policy, postback_username, redirect_delay, redirect_failure, redirect_success, renderer, return_params, ui].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
+      new(transformed_hash)
+    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)
+      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
+        # models (e.g. Pet) or oneOf
+        klass = CityPayApiClient.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