citypay_api_client 1.0.3 → 1.1.2

data/lib/citypay_api_client/models/acl_check_response_model.rb

@@ -0,0 +1,244 @@
+=begin
+#CityPay Payment API
+
+# This CityPay API is an HTTP RESTful payment API used for direct server to server transactional processing. It provides a number of payment mechanisms including: Internet, MOTO, Continuous Authority transaction processing, 3-D Secure decision handling using RFA Secure, Authorisation, Refunding, Pre-Authorisation, Cancellation/Voids and Completion processing. The API is also capable of tokenized payments using cardholder Accounts.  ## Compliance and Security Your application will need to adhere to PCI-DSS standards to operate safely and to meet requirements set out by  Visa and MasterCard and the PCI Security Standards Council. These include  * Data must be collected using TLS version 1.2 using [strong cryptography](https://citypay.github.io/api-docs/payment-api/#enabled-tls-ciphers). We will not accept calls to our API at   lower grade encryption levels. We regularly scan our TLS endpoints for vulnerabilities and perform TLS assessments   as part of our compliance program. * The application must not store sensitive cardholder data (CHD) such as the card security code (CSC) or   primary access number (PAN) * The application must not display the full card number on receipts, it is recommended to mask the PAN   and show the last 4 digits. The API will return this for you for ease of receipt creation * If you are developing a website, you will be required to perform regular scans on the network where you host the   application to meet your compliance obligations * You will be required to be PCI Compliant and the application must adhere to the security standard. Further information   is available from [https://www.pcisecuritystandards.org/](https://www.pcisecuritystandards.org/) * The API verifies that the request is for a valid account and originates from a trusted source using the remote IP   address. Our application firewalls analyse data that may be an attempt to break a large number of security common   security vulnerabilities. 
+
+Contact: support@citypay.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.2.0
+
+=end
+
+require 'date'
+require 'time'
+
+module CityPayApiClient
+  class AclCheckResponseModel
+    # The name or value of the acl which was found to match the ip address.
+    attr_accessor :acl
+
+    # Whether the ACL was returned via a cached instance.
+    attr_accessor :cache
+
+    # The IP address used in the lookup.
+    attr_accessor :ip
+
+    # The source provider of the ACL.
+    attr_accessor :provider
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'acl' => :'acl',
+        :'cache' => :'cache',
+        :'ip' => :'ip',
+        :'provider' => :'provider'
+      }
+    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
+      {
+        :'acl' => :'String',
+        :'cache' => :'Boolean',
+        :'ip' => :'String',
+        :'provider' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `CityPayApiClient::AclCheckResponseModel` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `CityPayApiClient::AclCheckResponseModel`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'acl')
+        self.acl = attributes[:'acl']
+      end
+
+      if attributes.key?(:'cache')
+        self.cache = attributes[:'cache']
+      end
+
+      if attributes.key?(:'ip')
+        self.ip = attributes[:'ip']
+      end
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          acl == o.acl &&
+          cache == o.cache &&
+          ip == o.ip &&
+          provider == o.provider
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [acl, cache, ip, provider].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = CityPayApiClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/citypay_api_client/models/airline_advice.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 AirlineAdvice
@@ -22,7 +23,7 @@ module CityPayApiClient
     # The Electronic Ticket Indicator, a code that indicates if an electronic ticket was issued.  Defaults to true.
     attr_accessor :eticket_indicator
 
-    # A value that indicates the number of air travel segments included on this ticket. Valid entries include the numerals “0” through “4”. Required only if the transaction type is TKT or EXC. 
+    # A value that indicates the number of air travel segments included on this ticket.  Valid entries include the numerals “0” through “4”. Required only if the transaction type is TKT or EXC. 
     attr_accessor :no_air_segments
 
     # The number of people in the party.
@@ -54,7 +55,7 @@ module CityPayApiClient
     # This must be a valid ticket number, i.e. numeric (the first 3 digits must represent the valid IATA plate carrier code). The final check digit should be validated prior to submission. On credit charges, this field should contain the number of the original ticket, and not of a replacement. 
     attr_accessor :ticket_no
 
-    # This field contains the Transaction Type code assigned to this transaction. Valid codes include:   - `TKT` = Ticket Purchase  - `REF` = Refund  - `EXC` = Exchange Ticket  - `MSC` = Miscellaneous (non-Ticket Purchase- and non-Exchange Ticket-related transactions only). 
+    # This field contains the Transaction Type code assigned to this transaction. Valid codes include:   - `TKT` = Ticket Purchase   - `REF` = Refund   - `EXC` = Exchange Ticket   - `MSC` = Miscellaneous (non-Ticket Purchase- and non-Exchange Ticket-related transactions only). 
     attr_accessor :transaction_type
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -79,6 +80,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
       {
@@ -124,6 +130,8 @@ module CityPayApiClient
 
       if attributes.key?(:'carrier_name')
         self.carrier_name = attributes[:'carrier_name']
+      else
+        self.carrier_name = nil
       end
 
       if attributes.key?(:'conjunction_ticket_indicator')
@@ -152,6 +160,8 @@ module CityPayApiClient
 
       if attributes.key?(:'segment1')
         self.segment1 = attributes[:'segment1']
+      else
+        self.segment1 = nil
       end
 
       if attributes.key?(:'segment2')
@@ -168,28 +178,39 @@ module CityPayApiClient
 
       if attributes.key?(:'ticket_issue_city')
         self.ticket_issue_city = attributes[:'ticket_issue_city']
+      else
+        self.ticket_issue_city = nil
       end
 
       if attributes.key?(:'ticket_issue_date')
         self.ticket_issue_date = attributes[:'ticket_issue_date']
+      else
+        self.ticket_issue_date = nil
       end
 
       if attributes.key?(:'ticket_issue_name')
         self.ticket_issue_name = attributes[:'ticket_issue_name']
+      else
+        self.ticket_issue_name = nil
       end
 
       if attributes.key?(:'ticket_no')
         self.ticket_no = attributes[:'ticket_no']
+      else
+        self.ticket_no = nil
       end
 
       if attributes.key?(:'transaction_type')
         self.transaction_type = attributes[:'transaction_type']
+      else
+        self.transaction_type = nil
       end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
       if @carrier_name.nil?
         invalid_properties.push('invalid value for "carrier_name", carrier_name cannot be nil.')
@@ -207,10 +228,6 @@ module CityPayApiClient
         invalid_properties.push('invalid value for "no_air_segments", must be greater than or equal to 0.')
       end
 
-      if @number_in_party.nil?
-        invalid_properties.push('invalid value for "number_in_party", number_in_party cannot be nil.')
-      end
-
       if !@original_ticket_no.nil? && @original_ticket_no.to_s.length > 14
         invalid_properties.push('invalid value for "original_ticket_no", the character length must be smaller than or equal to 14.')
       end
@@ -269,11 +286,11 @@ 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'
       return false if @carrier_name.nil?
       return false if @carrier_name.to_s.length > 25
       return false if !@no_air_segments.nil? && @no_air_segments > 4
       return false if !@no_air_segments.nil? && @no_air_segments < 0
-      return false if @number_in_party.nil?
       return false if !@original_ticket_no.nil? && @original_ticket_no.to_s.length > 14
       return false if !@passenger_name.nil? && @passenger_name.to_s.length > 25
       return false if @segment1.nil?
@@ -307,11 +324,15 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] no_air_segments Value to be assigned
     def no_air_segments=(no_air_segments)
-      if !no_air_segments.nil? && no_air_segments > 4
+      if no_air_segments.nil?
+        fail ArgumentError, 'no_air_segments cannot be nil'
+      end
+
+      if no_air_segments > 4
         fail ArgumentError, 'invalid value for "no_air_segments", must be smaller than or equal to 4.'
       end
 
-      if !no_air_segments.nil? && no_air_segments < 0
+      if no_air_segments < 0
         fail ArgumentError, 'invalid value for "no_air_segments", must be greater than or equal to 0.'
       end
 
@@ -321,7 +342,11 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] original_ticket_no Value to be assigned
     def original_ticket_no=(original_ticket_no)
-      if !original_ticket_no.nil? && original_ticket_no.to_s.length > 14
+      if original_ticket_no.nil?
+        fail ArgumentError, 'original_ticket_no cannot be nil'
+      end
+
+      if original_ticket_no.to_s.length > 14
         fail ArgumentError, 'invalid value for "original_ticket_no", the character length must be smaller than or equal to 14.'
       end
 
@@ -331,7 +356,11 @@ module CityPayApiClient
     # Custom attribute writer method with validation
     # @param [Object] passenger_name Value to be assigned
     def passenger_name=(passenger_name)
-      if !passenger_name.nil? && passenger_name.to_s.length > 25
+      if passenger_name.nil?
+        fail ArgumentError, 'passenger_name cannot be nil'
+      end
+
+      if passenger_name.to_s.length > 25
         fail ArgumentError, 'invalid value for "passenger_name", the character length must be smaller than or equal to 25.'
       end
 
@@ -437,37 +466,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
@@ -497,7 +522,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
 
@@ -523,7 +550,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
@@ -546,5 +573,7 @@ module CityPayApiClient
         value
       end
     end
+
   end
+
 end