postfinancecheckout-ruby-sdk 5.2.0 → 6.1.0

data/lib/postfinancecheckout-ruby-sdk/models/cardholder_authentication.rb

@@ -1,87 +1,128 @@
-=begin
-The PostFinance Checkout API allows an easy interaction with the PostFinance Checkout web service.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-=end
+# PostFinance Ruby SDK
+#
+# This library allows to interact with the PostFinance payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://www.postfinance.ch/en/private.html
+# Developer email: ecosystem-team@wallee.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 require 'date'
+require 'time'
 
-module PostFinanceCheckout
-  # 
+module PostfinancecheckoutRubySdk
   class CardholderAuthentication
     # The identifier (e.g., XID or DSTransactionID) assigned by the authentication system for tracking and verification.
     attr_accessor :authentication_identifier
 
-    # The result of the authentication process.
     attr_accessor :authentication_response
 
-    # The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.
-    attr_accessor :authentication_value
-
     # The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.
     attr_accessor :electronic_commerce_indicator
 
-    # The version of the authentication protocol (e.g., 3D Secure 1.0 or 2.0) used for the transaction.
+    # The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.
+    attr_accessor :authentication_value
+
     attr_accessor :version
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'authentication_identifier' => :'authenticationIdentifier',
         :'authentication_response' => :'authenticationResponse',
-        :'authentication_value' => :'authenticationValue',
         :'electronic_commerce_indicator' => :'electronicCommerceIndicator',
+        :'authentication_value' => :'authenticationValue',
         :'version' => :'version'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'authentication_identifier' => :'String',
         :'authentication_response' => :'CardAuthenticationResponse',
-        :'authentication_value' => :'String',
         :'electronic_commerce_indicator' => :'String',
+        :'authentication_value' => :'String',
         :'version' => :'CardAuthenticationVersion'
       }
     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 = {})
-      return unless attributes.is_a?(Hash)
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::CardholderAuthentication` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        unless self.class.attribute_map.key?(k.to_sym)
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::CardholderAuthentication`. 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.has_key?(:'authenticationIdentifier')
-        self.authentication_identifier = attributes[:'authenticationIdentifier']
+      if attributes.key?(:'authentication_identifier')
+        self.authentication_identifier = attributes[:'authentication_identifier']
       end
 
-      if attributes.has_key?(:'authenticationResponse')
-        self.authentication_response = attributes[:'authenticationResponse']
+      if attributes.key?(:'authentication_response')
+        self.authentication_response = attributes[:'authentication_response']
       end
 
-      if attributes.has_key?(:'authenticationValue')
-        self.authentication_value = attributes[:'authenticationValue']
+      if attributes.key?(:'electronic_commerce_indicator')
+        self.electronic_commerce_indicator = attributes[:'electronic_commerce_indicator']
       end
 
-      if attributes.has_key?(:'electronicCommerceIndicator')
-        self.electronic_commerce_indicator = attributes[:'electronicCommerceIndicator']
+      if attributes.key?(:'authentication_value')
+        self.authentication_value = attributes[:'authentication_value']
       end
 
-      if attributes.has_key?(:'version')
+      if attributes.key?(:'version')
         self.version = attributes[:'version']
       end
     end
@@ -89,6 +130,7 @@ module PostFinanceCheckout
     # 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
@@ -96,6 +138,7 @@ module PostFinanceCheckout
     # 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
 
@@ -106,8 +149,8 @@ module PostFinanceCheckout
       self.class == o.class &&
           authentication_identifier == o.authentication_identifier &&
           authentication_response == o.authentication_response &&
-          authentication_value == o.authentication_value &&
           electronic_commerce_indicator == o.electronic_commerce_indicator &&
+          authentication_value == o.authentication_value &&
           version == o.version
     end
 
@@ -118,39 +161,40 @@ module PostFinanceCheckout
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [authentication_identifier, authentication_response, authentication_value, electronic_commerce_indicator, version].hash
-    end
-
-    # Builds the object from hash
+      [authentication_identifier, authentication_response, electronic_commerce_indicator, authentication_value, version].hash
+    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)
+    def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_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
@@ -159,7 +203,7 @@ module PostFinanceCheckout
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -180,8 +224,9 @@ module PostFinanceCheckout
           end
         end
       else # model
-        temp_model = PostFinanceCheckout.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = PostfinancecheckoutRubySdk.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
 
@@ -203,7 +248,11 @@ module PostFinanceCheckout
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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
@@ -215,7 +264,7 @@ module PostFinanceCheckout
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -226,6 +275,5 @@ module PostFinanceCheckout
         value
       end
     end
-
   end
 end

data/lib/postfinancecheckout-ruby-sdk/models/cardholder_authentication_create.rb

@@ -1,94 +1,140 @@
-=begin
-The PostFinance Checkout API allows an easy interaction with the PostFinance Checkout web service.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-
-=end
+# PostFinance Ruby SDK
+#
+# This library allows to interact with the PostFinance payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://www.postfinance.ch/en/private.html
+# Developer email: ecosystem-team@wallee.com
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 require 'date'
+require 'time'
 
-module PostFinanceCheckout
-  # 
+module PostfinancecheckoutRubySdk
   class CardholderAuthenticationCreate
     # The identifier (e.g., XID or DSTransactionID) assigned by the authentication system for tracking and verification.
     attr_accessor :authentication_identifier
 
-    # The result of the authentication process.
     attr_accessor :authentication_response
 
-    # The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.
-    attr_accessor :authentication_value
-
     # The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.
     attr_accessor :electronic_commerce_indicator
 
-    # The version of the authentication protocol (e.g., 3D Secure 1.0 or 2.0) used for the transaction.
+    # The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.
+    attr_accessor :authentication_value
+
     attr_accessor :version
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'authentication_identifier' => :'authenticationIdentifier',
         :'authentication_response' => :'authenticationResponse',
-        :'authentication_value' => :'authenticationValue',
         :'electronic_commerce_indicator' => :'electronicCommerceIndicator',
+        :'authentication_value' => :'authenticationValue',
         :'version' => :'version'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'authentication_identifier' => :'String',
         :'authentication_response' => :'CardAuthenticationResponse',
-        :'authentication_value' => :'String',
         :'electronic_commerce_indicator' => :'String',
+        :'authentication_value' => :'String',
         :'version' => :'CardAuthenticationVersion'
       }
     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 = {})
-      return unless attributes.is_a?(Hash)
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::CardholderAuthenticationCreate` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        unless self.class.attribute_map.key?(k.to_sym)
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::CardholderAuthenticationCreate`. 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.has_key?(:'authenticationIdentifier')
-        self.authentication_identifier = attributes[:'authenticationIdentifier']
+      if attributes.key?(:'authentication_identifier')
+        self.authentication_identifier = attributes[:'authentication_identifier']
       end
 
-      if attributes.has_key?(:'authenticationResponse')
-        self.authentication_response = attributes[:'authenticationResponse']
+      if attributes.key?(:'authentication_response')
+        self.authentication_response = attributes[:'authentication_response']
+      else
+        self.authentication_response = nil
       end
 
-      if attributes.has_key?(:'authenticationValue')
-        self.authentication_value = attributes[:'authenticationValue']
+      if attributes.key?(:'electronic_commerce_indicator')
+        self.electronic_commerce_indicator = attributes[:'electronic_commerce_indicator']
       end
 
-      if attributes.has_key?(:'electronicCommerceIndicator')
-        self.electronic_commerce_indicator = attributes[:'electronicCommerceIndicator']
+      if attributes.key?(:'authentication_value')
+        self.authentication_value = attributes[:'authentication_value']
       end
 
-      if attributes.has_key?(:'version')
+      if attributes.key?(:'version')
         self.version = attributes[:'version']
+      else
+        self.version = 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 @authentication_response.nil?
         invalid_properties.push('invalid value for "authentication_response", authentication_response cannot be nil.')
@@ -104,6 +150,7 @@ module PostFinanceCheckout
     # 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 @authentication_response.nil?
       return false if @version.nil?
       true
@@ -116,8 +163,8 @@ module PostFinanceCheckout
       self.class == o.class &&
           authentication_identifier == o.authentication_identifier &&
           authentication_response == o.authentication_response &&
-          authentication_value == o.authentication_value &&
           electronic_commerce_indicator == o.electronic_commerce_indicator &&
+          authentication_value == o.authentication_value &&
           version == o.version
     end
 
@@ -128,39 +175,40 @@ module PostFinanceCheckout
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [authentication_identifier, authentication_response, authentication_value, electronic_commerce_indicator, version].hash
-    end
-
-    # Builds the object from hash
+      [authentication_identifier, authentication_response, electronic_commerce_indicator, authentication_value, version].hash
+    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)
+    def self.build_from_hash(attributes)
       return nil unless attributes.is_a?(Hash)
-      self.class.swagger_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
@@ -169,7 +217,7 @@ module PostFinanceCheckout
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -190,8 +238,9 @@ module PostFinanceCheckout
           end
         end
       else # model
-        temp_model = PostFinanceCheckout.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = PostfinancecheckoutRubySdk.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
 
@@ -213,7 +262,11 @@ module PostFinanceCheckout
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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
@@ -225,7 +278,7 @@ module PostFinanceCheckout
     # @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) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }
@@ -236,6 +289,5 @@ module PostFinanceCheckout
         value
       end
     end
-
   end
 end