citypay_api_client 1.0.3 → 1.1.2

data/lib/citypay_api_client/models/contact_details.rb

@@ -1,15 +1,16 @@
 =begin
 #CityPay Payment API
 
-# This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts.  ## Compliance and Security <aside class=\"notice\">   Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely   and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including: </aside>  * Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+# This CityPay API is an HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokenized payments using cardholder Accounts.  ## Compliance and Security Your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by  Visa and MasterCard and the PCI Security Standards Council. These include  * Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive cardholder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
 
 Contact: support@citypay.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 7.2.0
 
 =end
 
 require 'date'
+require 'time'
 
 module CityPayApiClient
   class ContactDetails
@@ -71,6 +72,11 @@ module CityPayApiClient
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -167,21 +173,26 @@ module CityPayApiClient
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if !@address1.nil? && @address1.to_s.length > 40
-        invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 40.')
+      if !@address1.nil? && @address1.to_s.length > 50
+        invalid_properties.push('invalid value for "address1", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@address2.nil? && @address2.to_s.length > 50
+        invalid_properties.push('invalid value for "address2", the character length must be smaller than or equal to 50.')
       end
 
-      if !@address2.nil? && @address2.to_s.length > 30
-        invalid_properties.push('invalid value for "address2", the character length must be smaller than or equal to 30.')
+      if !@address3.nil? && @address3.to_s.length > 50
+        invalid_properties.push('invalid value for "address3", the character length must be smaller than or equal to 50.')
       end
 
-      if !@address3.nil? && @address3.to_s.length > 20
-        invalid_properties.push('invalid value for "address3", the character length must be smaller than or equal to 20.')
+      if !@area.nil? && @area.to_s.length > 50
+        invalid_properties.push('invalid value for "area", the character length must be smaller than or equal to 50.')
       end
 
-      if !@area.nil? && @area.to_s.length > 20
-        invalid_properties.push('invalid value for "area", the character length must be smaller than or equal to 20.')
+      if !@company.nil? && @company.to_s.length > 50
+        invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 50.')
       end
 
       if !@country.nil? && @country.to_s.length > 2
@@ -192,12 +203,16 @@ module CityPayApiClient
         invalid_properties.push('invalid value for "country", the character length must be great than or equal to 2.')
       end
 
+      if !@email.nil? && @email.to_s.length > 254
+        invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 254.')
+      end
+
       if !@mobile_no.nil? && @mobile_no.to_s.length > 20
         invalid_properties.push('invalid value for "mobile_no", the character length must be smaller than or equal to 20.')
       end
 
-      if !@postcode.nil? && @postcode.to_s.length > 10
-        invalid_properties.push('invalid value for "postcode", the character length must be smaller than or equal to 10.')
+      if !@postcode.nil? && @postcode.to_s.length > 16
+        invalid_properties.push('invalid value for "postcode", the character length must be smaller than or equal to 16.')
       end
 
       if !@telephone_no.nil? && @telephone_no.to_s.length > 20
@@ -210,14 +225,17 @@ module CityPayApiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if !@address1.nil? && @address1.to_s.length > 40
-      return false if !@address2.nil? && @address2.to_s.length > 30
-      return false if !@address3.nil? && @address3.to_s.length > 20
-      return false if !@area.nil? && @area.to_s.length > 20
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if !@address1.nil? && @address1.to_s.length > 50
+      return false if !@address2.nil? && @address2.to_s.length > 50
+      return false if !@address3.nil? && @address3.to_s.length > 50
+      return false if !@area.nil? && @area.to_s.length > 50
+      return false if !@company.nil? && @company.to_s.length > 50
       return false if !@country.nil? && @country.to_s.length > 2
       return false if !@country.nil? && @country.to_s.length < 2
+      return false if !@email.nil? && @email.to_s.length > 254
       return false if !@mobile_no.nil? && @mobile_no.to_s.length > 20
-      return false if !@postcode.nil? && @postcode.to_s.length > 10
+      return false if !@postcode.nil? && @postcode.to_s.length > 16
       return false if !@telephone_no.nil? && @telephone_no.to_s.length > 20
       true
     end
@@ -225,8 +243,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] address1 Value to be assigned
     def address1=(address1)
-      if !address1.nil? && address1.to_s.length > 40
-        fail ArgumentError, 'invalid value for "address1", the character length must be smaller than or equal to 40.'
+      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
 
       @address1 = address1
@@ -235,8 +257,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] address2 Value to be assigned
     def address2=(address2)
-      if !address2.nil? && address2.to_s.length > 30
-        fail ArgumentError, 'invalid value for "address2", the character length must be smaller than or equal to 30.'
+      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
 
       @address2 = address2
@@ -245,8 +271,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] address3 Value to be assigned
     def address3=(address3)
-      if !address3.nil? && address3.to_s.length > 20
-        fail ArgumentError, 'invalid value for "address3", the character length must be smaller than or equal to 20.'
+      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
 
       @address3 = address3
@@ -255,31 +285,71 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] area Value to be assigned
     def area=(area)
-      if !area.nil? && area.to_s.length > 20
-        fail ArgumentError, 'invalid value for "area", the character length must be smaller than or equal to 20.'
+      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
 
       @area = area
     end
 
+    # 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
+
+      @company = company
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] country Value to be assigned
     def country=(country)
-      if !country.nil? && country.to_s.length > 2
+      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.nil? && country.to_s.length < 2
+      if country.to_s.length < 2
         fail ArgumentError, 'invalid value for "country", the character length must be great than or equal to 2.'
       end
 
       @country = country
     end
 
+    # 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
+
+      @email = email
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] mobile_no Value to be assigned
     def mobile_no=(mobile_no)
-      if !mobile_no.nil? && mobile_no.to_s.length > 20
+      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
 
@@ -289,8 +359,12 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] postcode Value to be assigned
     def postcode=(postcode)
-      if !postcode.nil? && postcode.to_s.length > 10
-        fail ArgumentError, 'invalid value for "postcode", the character length must be smaller than or equal to 10.'
+      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
 
       @postcode = postcode
@@ -299,7 +373,11 @@ 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? && telephone_no.to_s.length > 20
+      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
 
@@ -342,37 +420,33 @@ module CityPayApiClient
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -402,7 +476,9 @@ module CityPayApiClient
           end
         end
       else # model
-        CityPayApiClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = CityPayApiClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -428,7 +504,7 @@ module CityPayApiClient
           is_nullable = self.class.openapi_nullable.include?(attr)
           next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
         end
-        
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -451,5 +527,7 @@ module CityPayApiClient
         value
       end
     end
+
   end
+
 end

data/lib/citypay_api_client/models/decision.rb

@@ -1,15 +1,16 @@
 =begin
 #CityPay Payment API
 
-# This CityPay API is a HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokinsed payments using Card Holder Accounts.  ## Compliance and Security <aside class=\"notice\">   Before we begin a reminder that your application will need to adhere to PCI-DSS standards to operate safely   and to meet requirements set out by Visa and MasterCard and the PCI Security Standards Council including: </aside>  * Data must be collected using TLS version 1.2 using [strong cryptography](#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive card holder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+# This CityPay API is an HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokenized payments using cardholder Accounts.  ## Compliance and Security Your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by  Visa and MasterCard and the PCI Security Standards Council. These include  * Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive cardholder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
 
 Contact: support@citypay.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 7.2.0
 
 =end
 
 require 'date'
+require 'time'
 
 module CityPayApiClient
   class Decision
@@ -28,6 +29,11 @@ module CityPayApiClient
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
     def self.openapi_types
       {
@@ -74,6 +80,7 @@ module CityPayApiClient
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       invalid_properties
     end
@@ -81,6 +88,7 @@ module CityPayApiClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       true
     end
 
@@ -110,37 +118,33 @@ module CityPayApiClient
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
     def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.openapi_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
           # check to ensure the input is an array given that the attribute
           # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end # or else data not found in attributes(hash), not an issue as the data can be optional
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -170,7 +174,9 @@ module CityPayApiClient
           end
         end
       else # model
-        CityPayApiClient.const_get(type).build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = CityPayApiClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -196,7 +202,7 @@ module CityPayApiClient
           is_nullable = self.class.openapi_nullable.include?(attr)
           next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
         end
-        
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -219,5 +225,7 @@ module CityPayApiClient
         value
       end
     end
+
   end
+
 end