citypay_api_client 1.1.2 → 1.1.4

data/lib/citypay_api_client/models/direct_post_request.rb

@@ -1,11 +1,12 @@
 =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. 
+# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server  transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs.  Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing  Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure  authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for  Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability  for tokenised payments.  ## Compliance and Security Overview <aside class=\"notice\">   Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is    designed with stringent security measures and compliance protocols to safeguard sensitive information and meet    the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside>  ### Key Compliance and Security Measures  * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats.  ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations.  For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application.  Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution. 
 
+The version of the OpenAPI document: 6.9.9
 Contact: support@citypay.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.2.0
+Generator version: 7.13.0
 
 =end
 
@@ -17,7 +18,7 @@ module CityPayApiClient
     # The amount to authorise in the lowest unit of currency with a variable length to a maximum of 12 digits.  No decimal points are to be included and no divisional characters such as 1,024.  The amount should be the total amount required for the transaction.  For example with GBP £1,021.95 the amount value is 102195. 
     attr_accessor :amount
 
-    # A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation. 
+    # A policy value which determines whether an AVS postcode policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS postcode numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the postcode did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send postcode details for authorisation. 
     attr_accessor :avs_postcode_policy
 
     attr_accessor :bill_to
@@ -25,16 +26,16 @@ module CityPayApiClient
     # The card number (PAN) with a variable length to a maximum of 21 digits in numerical form. Any non numeric characters will be stripped out of the card number, this includes whitespace or separators internal of the provided value.  The card number must be treated as sensitive data. We only provide an obfuscated value in logging and reporting.  The plaintext value is encrypted in our database using AES 256 GMC bit encryption for settlement or refund purposes.  When providing the card number to our gateway through the authorisation API you will be handling the card data on your application. This will require further PCI controls to be in place and this value must never be stored. 
     attr_accessor :cardnumber
 
-    # The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify posession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm. 
+    # The Card Security Code (CSC) (also known as CV2/CVV2) is normally found on the back of the card (American Express has it on the front). The value helps to identify possession of the card as it is not available within the chip or magnetic swipe.  When forwarding the CSC, please ensure the value is a string as some values start with 0 and this will be stripped out by any integer parsing.  The CSC number aids fraud prevention in Mail Order and Internet payments.  Business rules are available on your account to identify whether to accept or decline transactions based on mismatched results of the CSC.  The Payment Card Industry (PCI) requires that at no stage of a transaction should the CSC be stored.  This applies to all entities handling card data.  It should also not be used in any hashing process.  CityPay do not store the value and have no method of retrieving the value once the transaction has been processed. For this reason, duplicate checking is unable to determine the CSC in its duplication check algorithm. 
     attr_accessor :csc
 
-    # A policy value which determines whether a CSC policy is enforced or bypassed.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation. 
+    # A policy value which determines whether a CSC policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the CSC value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the CSC did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send the CSC details for authorisation. 
     attr_accessor :csc_policy
 
     # The processing currency for the transaction. Will default to the merchant account currency.
     attr_accessor :currency
 
-    # A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass. 
+    # A policy value which determines whether a duplication policy is enforced or bypassed. A duplication check has a window of time set against your account within which it can action. If a previous transaction with matching values occurred within the window, any subsequent transaction will result in a T001 result.  Values are   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be checked for duplication within the duplication window.   `2` to bypass. Transactions that are bypassed will not be checked for duplication within the duplication window.   `3` to ignore. Transactions that are ignored will have the same affect as bypass. 
     attr_accessor :duplicate_policy
 
     # The month of expiry of the card. The month value should be a numerical value between 1 and 12. 
@@ -49,7 +50,7 @@ module CityPayApiClient
     # A message authentication code ensures the data is authentic and that the intended amount has not been tampered with. The mac value is generated using a hash-based mac value. The following algorithm is used. - A key (k) is derived from your licence key - A value (v) is produced by concatenating the nonce, amount value and identifier, such as a purchase   with nonce `0123456789ABCDEF` an amount of £275.95 and an identifier of OD-12345678 would become   `0123456789ABCDEF27595OD-12345678` and extracting the UTF-8 byte values - The result from HMAC_SHA256(k, v) is hex-encoded (upper-case) - For instance, a licence key of `LK123456789`, a nonce of `0123456789ABCDEF`, an amount of `27595` and an identifier of `OD-12345678`  would generate a MAC of `163DBAB194D743866A9BCC7FC9C8A88FCD99C6BBBF08D619291212D1B91EE12E`. 
     attr_accessor :mac
 
-    # A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are  `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation. 
+    # A policy value which determines whether an AVS address policy is enforced, bypassed or ignored.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy. Transactions that are enforced will be rejected if the AVS address numeric value does not match.   `2` to bypass. Transactions that are bypassed will be allowed through even if the address did not match.   `3` to ignore. Transactions that are ignored will bypass the result and not send address numeric details for authorisation. 
     attr_accessor :match_avsa
 
     # The card holder name as appears on the card such as MR N E BODY. Required for some acquirers. 
@@ -58,6 +59,9 @@ module CityPayApiClient
     # A random value Hex string (uppercase) which is provided to the API to perform a digest. The value will be used in any digest function. 
     attr_accessor :nonce
 
+    # A policy value which determines whether a pre auth policy is enforced or bypassed.  Values are:   `0` for the default policy (default value if not supplied). Your default values are determined by your account manager on setup of the account.   `1` for an enforced policy.  Enforces pre-authorisation when it does not pre-auth by default.   `2` to bypass. Bypasses pre-authorisation when it is enabled to pre auth by default.   `3` to ignore. The same as the default policy (0). Although it currently mirrors the default, this option is included for compatibility with other policies. 
+    attr_accessor :pre_auth
+
     # The URL used to redirect back to your site when a transaction has been rejected or declined. Required if a url-encoded request. 
     attr_accessor :redirect_failure
 
@@ -66,7 +70,6 @@ module CityPayApiClient
 
     attr_accessor :ship_to
 
-    # A \"tag\" is a label that you can attach to a payment authorization. Tags can help you group transactions together based on certain criteria, like a work job or a ticket number. They can also assist in filtering transactions when you're generating reports.  Multiple Tags You can add more than one tag to a transaction by separating them with commas.  Limitations There is a maximum limit of 3 tags that can be added to a single transaction. Each tag can be no longer than 20 characters and alphanumeric with no spaces.  Example: Let's say you're a software company and you have different teams working on various projects. When a team makes a purchase or incurs an expense, they can tag the transaction with the project name, the team name, and the type of expense.  Project Name: Project_X Team Name: Team_A Type of Expense: Hardware So, the tag for a transaction might look like: Project_X,Team_A,Hardware  This way, when you're looking at your financial reports, you can easily filter transactions based on these tags to see how much each project or team is spending on different types of expenses. 
     attr_accessor :tag
 
     attr_accessor :threedsecure
@@ -77,6 +80,9 @@ module CityPayApiClient
     # The type of transaction being submitted. Normally this value is not required and your account manager may request that you set this field.
     attr_accessor :trans_type
 
+    # A uuid for the session. The value tracks through 3ds session and therefore should be a valid v4 uuid.
+    attr_accessor :uuid
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -95,19 +101,26 @@ module CityPayApiClient
         :'match_avsa' => :'match_avsa',
         :'name_on_card' => :'name_on_card',
         :'nonce' => :'nonce',
+        :'pre_auth' => :'pre_auth',
         :'redirect_failure' => :'redirect_failure',
         :'redirect_success' => :'redirect_success',
         :'ship_to' => :'ship_to',
         :'tag' => :'tag',
         :'threedsecure' => :'threedsecure',
         :'trans_info' => :'trans_info',
-        :'trans_type' => :'trans_type'
+        :'trans_type' => :'trans_type',
+        :'uuid' => :'uuid'
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -128,13 +141,15 @@ module CityPayApiClient
         :'match_avsa' => :'String',
         :'name_on_card' => :'String',
         :'nonce' => :'String',
+        :'pre_auth' => :'String',
         :'redirect_failure' => :'String',
         :'redirect_success' => :'String',
         :'ship_to' => :'ContactDetails',
-        :'tag' => :'String',
+        :'tag' => :'Array<String>',
         :'threedsecure' => :'ThreeDSecure',
         :'trans_info' => :'String',
-        :'trans_type' => :'String'
+        :'trans_type' => :'String',
+        :'uuid' => :'String'
       }
     end
 
@@ -152,9 +167,10 @@ module CityPayApiClient
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       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::DirectPostRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::DirectPostRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -175,8 +191,6 @@ module CityPayApiClient
 
       if attributes.key?(:'cardnumber')
         self.cardnumber = attributes[:'cardnumber']
-      else
-        self.cardnumber = nil
       end
 
       if attributes.key?(:'csc')
@@ -197,14 +211,10 @@ module CityPayApiClient
 
       if attributes.key?(:'expmonth')
         self.expmonth = attributes[:'expmonth']
-      else
-        self.expmonth = nil
       end
 
       if attributes.key?(:'expyear')
         self.expyear = attributes[:'expyear']
-      else
-        self.expyear = nil
       end
 
       if attributes.key?(:'identifier')
@@ -231,6 +241,10 @@ module CityPayApiClient
         self.nonce = attributes[:'nonce']
       end
 
+      if attributes.key?(:'pre_auth')
+        self.pre_auth = attributes[:'pre_auth']
+      end
+
       if attributes.key?(:'redirect_failure')
         self.redirect_failure = attributes[:'redirect_failure']
       end
@@ -244,7 +258,9 @@ module CityPayApiClient
       end
 
       if attributes.key?(:'tag')
-        self.tag = attributes[:'tag']
+        if (value = attributes[:'tag']).is_a?(Array)
+          self.tag = value
+        end
       end
 
       if attributes.key?(:'threedsecure')
@@ -258,6 +274,10 @@ module CityPayApiClient
       if attributes.key?(:'trans_type')
         self.trans_type = attributes[:'trans_type']
       end
+
+      if attributes.key?(:'uuid')
+        self.uuid = attributes[:'uuid']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -269,16 +289,12 @@ module CityPayApiClient
         invalid_properties.push('invalid value for "amount", amount cannot be nil.')
       end
 
-      if @cardnumber.nil?
-        invalid_properties.push('invalid value for "cardnumber", cardnumber cannot be nil.')
-      end
-
-      if @cardnumber.to_s.length > 22
+      if !@cardnumber.nil? && @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.')
+      if !@cardnumber.nil? && @cardnumber.to_s.length < 12
+        invalid_properties.push('invalid value for "cardnumber", the character length must be greater than or equal to 12.')
       end
 
       if !@csc.nil? && @csc.to_s.length > 4
@@ -286,7 +302,7 @@ module CityPayApiClient
       end
 
       if !@csc.nil? && @csc.to_s.length < 3
-        invalid_properties.push('invalid value for "csc", the character length must be great than or equal to 3.')
+        invalid_properties.push('invalid value for "csc", the character length must be greater than or equal to 3.')
       end
 
       if !@currency.nil? && @currency.to_s.length > 3
@@ -294,30 +310,22 @@ module CityPayApiClient
       end
 
       if !@currency.nil? && @currency.to_s.length < 3
-        invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
-      end
-
-      if @expmonth.nil?
-        invalid_properties.push('invalid value for "expmonth", expmonth cannot be nil.')
+        invalid_properties.push('invalid value for "currency", the character length must be greater than or equal to 3.')
       end
 
-      if @expmonth > 12
+      if !@expmonth.nil? && @expmonth > 12
         invalid_properties.push('invalid value for "expmonth", must be smaller than or equal to 12.')
       end
 
-      if @expmonth < 1
+      if !@expmonth.nil? && @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
+      if !@expyear.nil? && @expyear > 2100
         invalid_properties.push('invalid value for "expyear", must be smaller than or equal to 2100.')
       end
 
-      if @expyear < 2000
+      if !@expyear.nil? && @expyear < 2000
         invalid_properties.push('invalid value for "expyear", must be greater than or equal to 2000.')
       end
 
@@ -330,7 +338,7 @@ module CityPayApiClient
       end
 
       if @identifier.to_s.length < 4
-        invalid_properties.push('invalid value for "identifier", the character length must be great than or equal to 4.')
+        invalid_properties.push('invalid value for "identifier", the character length must be greater than or equal to 4.')
       end
 
       if @mac.nil?
@@ -342,7 +350,7 @@ module CityPayApiClient
       end
 
       if !@name_on_card.nil? && @name_on_card.to_s.length < 2
-        invalid_properties.push('invalid value for "name_on_card", the character length must be great than or equal to 2.')
+        invalid_properties.push('invalid value for "name_on_card", the character length must be greater than or equal to 2.')
       end
 
       if !@trans_info.nil? && @trans_info.to_s.length > 50
@@ -353,6 +361,14 @@ module CityPayApiClient
         invalid_properties.push('invalid value for "trans_type", the character length must be smaller than or equal to 1.')
       end
 
+      if !@uuid.nil? && @uuid.to_s.length > 36
+        invalid_properties.push('invalid value for "uuid", the character length must be smaller than or equal to 36.')
+      end
+
+      if !@uuid.nil? && @uuid.to_s.length < 36
+        invalid_properties.push('invalid value for "uuid", the character length must be greater than or equal to 36.')
+      end
+
       invalid_properties
     end
 
@@ -361,19 +377,16 @@ module CityPayApiClient
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @amount.nil?
-      return false if @cardnumber.nil?
-      return false if @cardnumber.to_s.length > 22
-      return false if @cardnumber.to_s.length < 12
+      return false if !@cardnumber.nil? && @cardnumber.to_s.length > 22
+      return false if !@cardnumber.nil? && @cardnumber.to_s.length < 12
       return false if !@csc.nil? && @csc.to_s.length > 4
       return false if !@csc.nil? && @csc.to_s.length < 3
       return false if !@currency.nil? && @currency.to_s.length > 3
       return false if !@currency.nil? && @currency.to_s.length < 3
-      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
+      return false if !@expmonth.nil? && @expmonth > 12
+      return false if !@expmonth.nil? && @expmonth < 1
+      return false if !@expyear.nil? && @expyear > 2100
+      return false if !@expyear.nil? && @expyear < 2000
       return false if @identifier.nil?
       return false if @identifier.to_s.length > 50
       return false if @identifier.to_s.length < 4
@@ -382,32 +395,26 @@ module CityPayApiClient
       return false if !@name_on_card.nil? && @name_on_card.to_s.length < 2
       return false if !@trans_info.nil? && @trans_info.to_s.length > 50
       return false if !@trans_type.nil? && @trans_type.to_s.length > 1
+      return false if !@uuid.nil? && @uuid.to_s.length > 36
+      return false if !@uuid.nil? && @uuid.to_s.length < 36
       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
-
       @amount = amount
     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.'
+        fail ArgumentError, 'invalid value for "cardnumber", the character length must be greater than or equal to 12.'
       end
 
       @cardnumber = cardnumber
@@ -416,16 +423,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] csc Value to be assigned
     def csc=(csc)
-      if csc.nil?
-        fail ArgumentError, 'csc cannot be nil'
-      end
-
       if csc.to_s.length > 4
         fail ArgumentError, 'invalid value for "csc", the character length must be smaller than or equal to 4.'
       end
 
       if csc.to_s.length < 3
-        fail ArgumentError, 'invalid value for "csc", the character length must be great than or equal to 3.'
+        fail ArgumentError, 'invalid value for "csc", the character length must be greater than or equal to 3.'
       end
 
       @csc = csc
@@ -434,16 +437,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] currency Value to be assigned
     def currency=(currency)
-      if currency.nil?
-        fail ArgumentError, 'currency cannot be nil'
-      end
-
       if currency.to_s.length > 3
         fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
       end
 
       if currency.to_s.length < 3
-        fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
+        fail ArgumentError, 'invalid value for "currency", the character length must be greater than or equal to 3.'
       end
 
       @currency = currency
@@ -452,10 +451,6 @@ module CityPayApiClient
     # 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
@@ -470,10 +465,6 @@ module CityPayApiClient
     # 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
@@ -488,16 +479,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] identifier Value to be assigned
     def identifier=(identifier)
-      if identifier.nil?
-        fail ArgumentError, 'identifier cannot be nil'
-      end
-
       if identifier.to_s.length > 50
         fail ArgumentError, 'invalid value for "identifier", the character length must be smaller than or equal to 50.'
       end
 
       if identifier.to_s.length < 4
-        fail ArgumentError, 'invalid value for "identifier", the character length must be great than or equal to 4.'
+        fail ArgumentError, 'invalid value for "identifier", the character length must be greater than or equal to 4.'
       end
 
       @identifier = identifier
@@ -506,16 +493,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] name_on_card Value to be assigned
     def name_on_card=(name_on_card)
-      if name_on_card.nil?
-        fail ArgumentError, 'name_on_card cannot be nil'
-      end
-
       if name_on_card.to_s.length > 45
         fail ArgumentError, 'invalid value for "name_on_card", the character length must be smaller than or equal to 45.'
       end
 
       if name_on_card.to_s.length < 2
-        fail ArgumentError, 'invalid value for "name_on_card", the character length must be great than or equal to 2.'
+        fail ArgumentError, 'invalid value for "name_on_card", the character length must be greater than or equal to 2.'
       end
 
       @name_on_card = name_on_card
@@ -524,10 +507,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] trans_info Value to be assigned
     def trans_info=(trans_info)
-      if trans_info.nil?
-        fail ArgumentError, 'trans_info cannot be nil'
-      end
-
       if trans_info.to_s.length > 50
         fail ArgumentError, 'invalid value for "trans_info", the character length must be smaller than or equal to 50.'
       end
@@ -538,10 +517,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] trans_type Value to be assigned
     def trans_type=(trans_type)
-      if trans_type.nil?
-        fail ArgumentError, 'trans_type cannot be nil'
-      end
-
       if trans_type.to_s.length > 1
         fail ArgumentError, 'invalid value for "trans_type", the character length must be smaller than or equal to 1.'
       end
@@ -549,6 +524,20 @@ module CityPayApiClient
       @trans_type = trans_type
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] uuid Value to be assigned
+    def uuid=(uuid)
+      if uuid.to_s.length > 36
+        fail ArgumentError, 'invalid value for "uuid", the character length must be smaller than or equal to 36.'
+      end
+
+      if uuid.to_s.length < 36
+        fail ArgumentError, 'invalid value for "uuid", the character length must be greater than or equal to 36.'
+      end
+
+      @uuid = uuid
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -569,13 +558,15 @@ module CityPayApiClient
           match_avsa == o.match_avsa &&
           name_on_card == o.name_on_card &&
           nonce == o.nonce &&
+          pre_auth == o.pre_auth &&
           redirect_failure == o.redirect_failure &&
           redirect_success == o.redirect_success &&
           ship_to == o.ship_to &&
           tag == o.tag &&
           threedsecure == o.threedsecure &&
           trans_info == o.trans_info &&
-          trans_type == o.trans_type
+          trans_type == o.trans_type &&
+          uuid == o.uuid
     end
 
     # @see the `==` method
@@ -587,7 +578,7 @@ module CityPayApiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, avs_postcode_policy, bill_to, cardnumber, csc, csc_policy, currency, duplicate_policy, expmonth, expyear, identifier, mac, match_avsa, name_on_card, nonce, redirect_failure, redirect_success, ship_to, tag, threedsecure, trans_info, trans_type].hash
+      [amount, avs_postcode_policy, bill_to, cardnumber, csc, csc_policy, currency, duplicate_policy, expmonth, expyear, identifier, mac, match_avsa, name_on_card, nonce, pre_auth, redirect_failure, redirect_success, ship_to, tag, threedsecure, trans_info, trans_type, uuid].hash
     end
 
     # Builds the object from hash
@@ -702,6 +693,7 @@ module CityPayApiClient
       end
     end
 
+
   end
 
 end

data/lib/citypay_api_client/models/direct_token_auth_request.rb

@@ -1,11 +1,12 @@
 =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. 
+# Welcome to the CityPay API, a robust HTTP API payment solution designed for seamless server-to-server  transactional processing. Our API facilitates a wide array of payment operations, catering to diverse business needs.  Whether you're integrating Internet payments, handling Mail Order/Telephone Order (MOTO) transactions, managing  Subscriptions with Recurring and Continuous Authority payments, or navigating the complexities of 3-D Secure  authentication, our API is equipped to support your requirements. Additionally, we offer functionalities for  Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids, and Completion processing, alongside the capability  for tokenised payments.  ## Compliance and Security Overview <aside class=\"notice\">   Ensuring the security of payment transactions and compliance with industry standards is paramount. Our API is    designed with stringent security measures and compliance protocols to safeguard sensitive information and meet    the rigorous requirements of Visa, MasterCard, and the PCI Security Standards Council. </aside>  ### Key Compliance and Security Measures  * **TLS Encryption**: All data transmissions must utilise TLS version 1.2 or higher, employing [strong cryptography](#enabled-tls-ciphers). Our infrastructure strictly enforces this requirement to maintain the integrity and confidentiality of data in transit. We conduct regular scans and assessments of our TLS endpoints to identify and mitigate vulnerabilities. * **Data Storage Prohibitions**: Storing sensitive cardholder data (CHD), such as the card security code (CSC) or primary account number (PAN), is strictly prohibited. Our API is designed to minimize your exposure to sensitive data, thereby reducing your compliance burden. * **Data Masking**: For consumer protection and compliance, full card numbers must not be displayed on receipts or any customer-facing materials. Our API automatically masks PANs, displaying only the last four digits to facilitate safe receipt generation. * **Network Scans**: If your application is web-based, regular scans of your hosting environment are mandatory to identify and rectify potential vulnerabilities. This proactive measure is crucial for maintaining a secure and compliant online presence. * **PCI Compliance**: Adherence to PCI DSS standards is not optional; it's a requirement for operating securely and legally in the payments ecosystem. For detailed information on compliance requirements and resources, please visit the PCI Security Standards Council website [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/). * **Request Validation**: Our API includes mechanisms to verify the legitimacy of each request, ensuring it pertains to a valid account and originates from a trusted source. We leverage remote IP address verification alongside sophisticated application firewall technologies to thwart a wide array of common security threats.  ## Getting Started Before integrating with the CityPay API, ensure your application and development practices align with the outlined compliance and security measures. This preparatory step is crucial for a smooth integration process and the long-term success of your payment processing operations.  For further details on API endpoints, request/response formats, and code examples, proceed to the subsequent sections of our documentation. Our aim is to provide you with all the necessary tools and information to integrate our payment processing capabilities seamlessly into your application.  Thank you for choosing CityPay API. We look forward to supporting your payment processing needs with our secure, compliant, and versatile API solution. 
 
+The version of the OpenAPI document: 6.9.9
 Contact: support@citypay.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 7.2.0
+Generator version: 7.13.0
 
 =end
 
@@ -36,9 +37,14 @@ module CityPayApiClient
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
     # Returns all the JSON keys this model knows about
     def self.acceptable_attributes
-      attribute_map.values
+      acceptable_attribute_map.values
     end
 
     # Attribute type mapping.
@@ -65,9 +71,10 @@ module CityPayApiClient
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
       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::DirectTokenAuthRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::DirectTokenAuthRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -239,6 +246,7 @@ module CityPayApiClient
       end
     end
 
+
   end
 
 end