citypay_api_client 1.1.3 → 1.1.4

data/lib/citypay_api_client/models/charge_request.rb

@@ -3,9 +3,10 @@
 
 # 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
 
@@ -20,7 +21,7 @@ module CityPayApiClient
     # 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
 
-    # Merchant-initiated transactions (MITs) are payments you trigger, where the cardholder has previously consented to you carrying out such payments. These may be scheduled (such as recurring payments and installments) or unscheduled (like account top-ups triggered by balance thresholds and no-show charges).  Scheduled --- These are regular payments using stored card details, like installments or a monthly subscription fee.  - `I` Instalment - A single purchase of goods or services billed to a cardholder in multiple transactions, over a period of time agreed by the cardholder and you.  - `R` Recurring - Transactions processed at fixed, regular intervals not to exceed one year between transactions, representing an agreement between a cardholder and you to purchase goods or services provided over a period of time.  Unscheduled --- These are payments using stored card details that do not occur on a regular schedule, like top-ups for a digital wallet triggered by the balance falling below a certain threshold.  - `A` Reauthorisation - a purchase made after the original purchase. A common scenario is delayed/split shipments.  - `C` Unscheduled Payment - A transaction using a stored credential for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date. This includes account top-ups triggered by balance thresholds.  - `D` Delayed Charge - A delayed charge is typically used in hotel, cruise lines and vehicle rental environments to perform a supplemental account charge after original services are rendered.  - `L` Incremental - An incremental authorisation is typically found in hotel and car rental environments, where the cardholder has agreed to pay for any service incurred during the duration of the contract. An incremental authorisation is where you need to seek authorisation of further funds in addition to what you have originally requested. A common scenario is additional services charged to the contract, such as extending a stay in a hotel.  - `S` Resubmission - When the original purchase occurred, but you were not able to get authorisation at the time the goods or services were provided. It should be only used where the goods or services have already been provided, but the authorisation request is declined for insufficient funds.  - `X` No-show - A no-show is a transaction where you are enabled to charge for services which the cardholder entered into an agreement to purchase, but the cardholder did not meet the terms of the agreement. 
+    # Merchant-initiated transactions (MITs) are payments you trigger, where the cardholder has previously consented to you carrying out such payments. These may be scheduled (such as recurring payments and installments) or unscheduled (like account top-ups triggered by balance thresholds and no-show charges).  Scheduled These are regular payments using stored card details, like installments or a monthly subscription fee.  - `I` Instalment - A single purchase of goods or services billed to a cardholder in multiple transactions, over a period of time agreed by the cardholder and you.  - `R` Recurring - Transactions processed at fixed, regular intervals not to exceed one year between transactions, representing an agreement between a cardholder and you to purchase goods or services provided over a period of time.  Unscheduled These are payments using stored card details that do not occur on a regular schedule, like top-ups for a digital wallet triggered by the balance falling below a certain threshold.  - `A` Reauthorisation - a purchase made after the original purchase. A common scenario is delayed/split shipments.  - `C` Unscheduled Payment - A transaction using a stored credential for a fixed or variable amount that does not occur on a scheduled or regularly occurring transaction date. This includes account top-ups triggered by balance thresholds.  - `D` Delayed Charge - A delayed charge is typically used in hotel, cruise lines and vehicle rental environments to perform a supplemental account charge after original services are rendered.  - `L` Incremental - An incremental authorisation is typically found in hotel and car rental environments, where the cardholder has agreed to pay for any service incurred during the duration of the contract. An incremental authorisation is where you need to seek authorisation of further funds in addition to what you have originally requested. A common scenario is additional services charged to the contract, such as extending a stay in a hotel.  - `S` Resubmission - When the original purchase occurred, but you were not able to get authorisation at the time the goods or services were provided. It should be only used where the goods or services have already been provided, but the authorisation request is declined for insufficient funds.  - `X` No-show - A no-show is a transaction where you are enabled to charge for services which the cardholder entered into an agreement to purchase, but the cardholder did not meet the terms of the agreement.  - `N` Not Applicable - For all other transactions the value will be not applicable. 
     attr_accessor :cardholder_agreement
 
     # 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. 
@@ -47,11 +48,14 @@ module CityPayApiClient
     # Identifies the merchant account to perform processing for.
     attr_accessor :merchantid
 
+    # 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
+
     attr_accessor :tag
 
     attr_accessor :threedsecure
 
-    # A tokenised form of a card that belongs to a card holder's account and that has been previously registered. The token is time based and will only be active for a short duration. The value is therefore designed not to be stored remotely for future use.   Tokens will start with ct and are resiliently tamper proof using HMacSHA-256. No sensitive card data is stored internally within the token.   Each card will contain a different token and the value may be different on any retrieval call.   The value can be presented for payment as a selection value to an end user in a web application. 
+    # A tokenised form of a card that belongs to a card holder's account and that has been previously registered. The token is time based and will only be active for a short duration. The value is therefore designed not to be stored remotely for future use.   Tokens will start with `ct` and are resiliently tamper proof using HMacSHA-256. No sensitive card data is stored internally within the token.   Each card will contain a different token and the value may be different on any retrieval call.   The value can be presented for payment as a selection value to an end user in a web application. 
     attr_accessor :token
 
     # Further information that can be added to the transaction will display in reporting. Can be used for flexible values such as operator id.
@@ -74,6 +78,7 @@ module CityPayApiClient
         :'initiation' => :'initiation',
         :'match_avsa' => :'match_avsa',
         :'merchantid' => :'merchantid',
+        :'pre_auth' => :'pre_auth',
         :'tag' => :'tag',
         :'threedsecure' => :'threedsecure',
         :'token' => :'token',
@@ -82,9 +87,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.
@@ -101,6 +111,7 @@ module CityPayApiClient
         :'initiation' => :'String',
         :'match_avsa' => :'String',
         :'merchantid' => :'Integer',
+        :'pre_auth' => :'String',
         :'tag' => :'Array<String>',
         :'threedsecure' => :'ThreeDSecure',
         :'token' => :'String',
@@ -123,9 +134,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::ChargeRequest`. 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::ChargeRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -180,6 +192,10 @@ module CityPayApiClient
         self.merchantid = nil
       end
 
+      if attributes.key?(:'pre_auth')
+        self.pre_auth = attributes[:'pre_auth']
+      end
+
       if attributes.key?(:'tag')
         if (value = attributes[:'tag']).is_a?(Array)
           self.tag = value
@@ -223,7 +239,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
@@ -231,7 +247,7 @@ 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.')
+        invalid_properties.push('invalid value for "currency", the character length must be greater than or equal to 3.')
       end
 
       if @identifier.nil?
@@ -243,7 +259,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 !@initiation.nil? && @initiation.to_s.length > 1
@@ -293,20 +309,12 @@ module CityPayApiClient
     # 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] cardholder_agreement Value to be assigned
     def cardholder_agreement=(cardholder_agreement)
-      if cardholder_agreement.nil?
-        fail ArgumentError, 'cardholder_agreement cannot be nil'
-      end
-
       if cardholder_agreement.to_s.length > 1
         fail ArgumentError, 'invalid value for "cardholder_agreement", the character length must be smaller than or equal to 1.'
       end
@@ -317,16 +325,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
@@ -335,16 +339,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
@@ -353,16 +353,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
@@ -371,10 +367,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] initiation Value to be assigned
     def initiation=(initiation)
-      if initiation.nil?
-        fail ArgumentError, 'initiation cannot be nil'
-      end
-
       if initiation.to_s.length > 1
         fail ArgumentError, 'invalid value for "initiation", the character length must be smaller than or equal to 1.'
       end
@@ -385,10 +377,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
@@ -399,10 +387,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
@@ -426,6 +410,7 @@ module CityPayApiClient
           initiation == o.initiation &&
           match_avsa == o.match_avsa &&
           merchantid == o.merchantid &&
+          pre_auth == o.pre_auth &&
           tag == o.tag &&
           threedsecure == o.threedsecure &&
           token == o.token &&
@@ -442,7 +427,7 @@ module CityPayApiClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [amount, avs_postcode_policy, cardholder_agreement, csc, csc_policy, currency, duplicate_policy, identifier, initiation, match_avsa, merchantid, tag, threedsecure, token, trans_info, trans_type].hash
+      [amount, avs_postcode_policy, cardholder_agreement, csc, csc_policy, currency, duplicate_policy, identifier, initiation, match_avsa, merchantid, pre_auth, tag, threedsecure, token, trans_info, trans_type].hash
     end
 
     # Builds the object from hash
@@ -557,6 +542,7 @@ module CityPayApiClient
       end
     end
 
+
   end
 
 end

data/lib/citypay_api_client/models/check_batch_status.rb

@@ -3,9 +3,10 @@
 
 # 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
 
@@ -27,9 +28,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.
@@ -54,9 +60,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::CheckBatchStatus`. 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::CheckBatchStatus`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -88,7 +95,7 @@ module CityPayApiClient
       end
 
       if !@client_account_id.nil? && @client_account_id.to_s.length < 3
-        invalid_properties.push('invalid value for "client_account_id", the character length must be great than or equal to 3.')
+        invalid_properties.push('invalid value for "client_account_id", the character length must be greater than or equal to 3.')
       end
 
       invalid_properties
@@ -107,16 +114,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] client_account_id Value to be assigned
     def client_account_id=(client_account_id)
-      if client_account_id.nil?
-        fail ArgumentError, 'client_account_id cannot be nil'
-      end
-
       if client_account_id.to_s.length > 20
         fail ArgumentError, 'invalid value for "client_account_id", the character length must be smaller than or equal to 20.'
       end
 
       if client_account_id.to_s.length < 3
-        fail ArgumentError, 'invalid value for "client_account_id", the character length must be great than or equal to 3.'
+        fail ArgumentError, 'invalid value for "client_account_id", the character length must be greater than or equal to 3.'
       end
 
       @client_account_id = client_account_id
@@ -255,6 +258,7 @@ module CityPayApiClient
       end
     end
 
+
   end
 
 end

data/lib/citypay_api_client/models/check_batch_status_response.rb

@@ -3,9 +3,10 @@
 
 # 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
 
@@ -23,9 +24,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.
@@ -49,9 +55,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::CheckBatchStatusResponse`. 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::CheckBatchStatusResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -210,6 +217,7 @@ module CityPayApiClient
       end
     end
 
+
   end
 
 end

data/lib/citypay_api_client/models/contact_details.rb

@@ -3,9 +3,10 @@
 
 # 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
 
@@ -72,9 +73,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.
@@ -110,9 +116,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::ContactDetails`. 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::ContactDetails`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -200,7 +207,7 @@ module CityPayApiClient
       end
 
       if !@country.nil? && @country.to_s.length < 2
-        invalid_properties.push('invalid value for "country", the character length must be great than or equal to 2.')
+        invalid_properties.push('invalid value for "country", the character length must be greater than or equal to 2.')
       end
 
       if !@email.nil? && @email.to_s.length > 254
@@ -243,10 +250,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] address1 Value to be assigned
     def address1=(address1)
-      if address1.nil?
-        fail ArgumentError, 'address1 cannot be nil'
-      end
-
       if address1.to_s.length > 50
         fail ArgumentError, 'invalid value for "address1", the character length must be smaller than or equal to 50.'
       end
@@ -257,10 +260,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] address2 Value to be assigned
     def address2=(address2)
-      if address2.nil?
-        fail ArgumentError, 'address2 cannot be nil'
-      end
-
       if address2.to_s.length > 50
         fail ArgumentError, 'invalid value for "address2", the character length must be smaller than or equal to 50.'
       end
@@ -271,10 +270,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] address3 Value to be assigned
     def address3=(address3)
-      if address3.nil?
-        fail ArgumentError, 'address3 cannot be nil'
-      end
-
       if address3.to_s.length > 50
         fail ArgumentError, 'invalid value for "address3", the character length must be smaller than or equal to 50.'
       end
@@ -285,10 +280,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] area Value to be assigned
     def area=(area)
-      if area.nil?
-        fail ArgumentError, 'area cannot be nil'
-      end
-
       if area.to_s.length > 50
         fail ArgumentError, 'invalid value for "area", the character length must be smaller than or equal to 50.'
       end
@@ -299,10 +290,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] company Value to be assigned
     def company=(company)
-      if company.nil?
-        fail ArgumentError, 'company cannot be nil'
-      end
-
       if company.to_s.length > 50
         fail ArgumentError, 'invalid value for "company", the character length must be smaller than or equal to 50.'
       end
@@ -313,16 +300,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] country Value to be assigned
     def country=(country)
-      if country.nil?
-        fail ArgumentError, 'country cannot be nil'
-      end
-
       if country.to_s.length > 2
         fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
       end
 
       if country.to_s.length < 2
-        fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 2.'
+        fail ArgumentError, 'invalid value for "country", the character length must be greater than or equal to 2.'
       end
 
       @country = country
@@ -331,10 +314,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] email Value to be assigned
     def email=(email)
-      if email.nil?
-        fail ArgumentError, 'email cannot be nil'
-      end
-
       if email.to_s.length > 254
         fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 254.'
       end
@@ -345,10 +324,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] mobile_no Value to be assigned
     def mobile_no=(mobile_no)
-      if mobile_no.nil?
-        fail ArgumentError, 'mobile_no cannot be nil'
-      end
-
       if mobile_no.to_s.length > 20
         fail ArgumentError, 'invalid value for "mobile_no", the character length must be smaller than or equal to 20.'
       end
@@ -359,10 +334,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] postcode Value to be assigned
     def postcode=(postcode)
-      if postcode.nil?
-        fail ArgumentError, 'postcode cannot be nil'
-      end
-
       if postcode.to_s.length > 16
         fail ArgumentError, 'invalid value for "postcode", the character length must be smaller than or equal to 16.'
       end
@@ -373,10 +344,6 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] telephone_no Value to be assigned
     def telephone_no=(telephone_no)
-      if telephone_no.nil?
-        fail ArgumentError, 'telephone_no cannot be nil'
-      end
-
       if telephone_no.to_s.length > 20
         fail ArgumentError, 'invalid value for "telephone_no", the character length must be smaller than or equal to 20.'
       end
@@ -528,6 +495,7 @@ module CityPayApiClient
       end
     end
 
+
   end
 
 end

data/lib/citypay_api_client/models/decision.rb

@@ -3,9 +3,10 @@
 
 # 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
 
@@ -26,9 +27,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.
@@ -53,9 +59,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::Decision`. 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::Decision`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -217,6 +224,7 @@ module CityPayApiClient
       end
     end
 
+
   end
 
 end