wallee-ruby-sdk 5.2.0 → 6.0.0

data/lib/wallee-ruby-sdk/models/token_version.rb

@@ -1,36 +1,46 @@
-=begin
-The wallee API allows an easy interaction with the wallee 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
+# Wallee AG Ruby SDK
+#
+# This library allows to interact with the Wallee AG payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://en.wallee.com
+# 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 Wallee
-  # 
+module WalleeRubySdk
   class TokenVersion
-    # The date and time when the token version was activated.
-    attr_accessor :activated_on
+    # The hashed payment information that the token version represents.
+    attr_accessor :payment_information_hashes
 
-    # The billing address to be used for the transaction if no explicit billing address is provided during payment processing.
-    attr_accessor :billing_address
+    # The language that is linked to the object.
+    attr_accessor :language
+
+    attr_accessor :type
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # The environment in which the token version was created.
-    attr_accessor :environment
+    # Retry interval when the strategy advises retrying later.
+    attr_accessor :retry_in
+
+    attr_accessor :payment_connector_configuration
+
+    # The date and time when the token version was marked obsolete.
+    attr_accessor :obsoleted_on
 
     # The date and time when the token version is set to expire, after which it will be marked as obsolete.
     attr_accessor :expires_on
@@ -41,288 +51,371 @@ module Wallee
     # A unique identifier for the object.
     attr_accessor :id
 
+    attr_accessor :state
+
+    # The token name as specified by the processor.
+    attr_accessor :processor_token
+
+    # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
+    attr_accessor :planned_purge_date
+
+    attr_accessor :payment_method_brand
+
+    # The version is used for optimistic locking and incremented whenever the object is updated.
+    attr_accessor :version
+
+    # The date and time when the system last attempted a retry for this token version.
+    attr_accessor :last_retried_on
+
     # The labels providing additional information about the object.
     attr_accessor :labels
 
-    # The language that is linked to the object.
-    attr_accessor :language
+    attr_accessor :token
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # The name used to identify the token.
-    attr_accessor :name
-
-    # The date and time when the token version was marked obsolete.
-    attr_accessor :obsoleted_on
+    attr_accessor :environment
 
-    # The payment connector configuration that initialized the token version.
-    attr_accessor :payment_connector_configuration
+    # The date and time when the token version was activated.
+    attr_accessor :activated_on
 
-    # The hashed payment information that the token version represents.
-    attr_accessor :payment_information_hashes
+    # The name used to identify the token.
+    attr_accessor :name
 
-    # The payment method that initialized the token version.
     attr_accessor :payment_method
 
-    # The payment method brand that initialized the token version.
-    attr_accessor :payment_method_brand
-
-    # The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
-    attr_accessor :planned_purge_date
-
-    # The token name as specified by the processor.
-    attr_accessor :processor_token
-
-    # The shipping address to be used for the transaction if no explicit shipping address is provided during payment processing.
     attr_accessor :shipping_address
 
-    # The object's current state.
-    attr_accessor :state
-
-    # The token that the token version belongs to.
-    attr_accessor :token
+    attr_accessor :billing_address
 
-    # The type specifies the nature of the token and identifies the payment connector capable of processing it.
-    attr_accessor :type
+    attr_accessor :retry_strategy
+
+    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
 
-    # The version is used for optimistic locking and incremented whenever the object is updated.
-    attr_accessor :version
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'activated_on' => :'activatedOn',
-        :'billing_address' => :'billingAddress',
+        :'payment_information_hashes' => :'paymentInformationHashes',
+        :'language' => :'language',
+        :'type' => :'type',
         :'created_on' => :'createdOn',
-        :'environment' => :'environment',
+        :'retry_in' => :'retryIn',
+        :'payment_connector_configuration' => :'paymentConnectorConfiguration',
+        :'obsoleted_on' => :'obsoletedOn',
         :'expires_on' => :'expiresOn',
         :'icon_url' => :'iconUrl',
         :'id' => :'id',
+        :'state' => :'state',
+        :'processor_token' => :'processorToken',
+        :'planned_purge_date' => :'plannedPurgeDate',
+        :'payment_method_brand' => :'paymentMethodBrand',
+        :'version' => :'version',
+        :'last_retried_on' => :'lastRetriedOn',
         :'labels' => :'labels',
-        :'language' => :'language',
+        :'token' => :'token',
         :'linked_space_id' => :'linkedSpaceId',
+        :'environment' => :'environment',
+        :'activated_on' => :'activatedOn',
         :'name' => :'name',
-        :'obsoleted_on' => :'obsoletedOn',
-        :'payment_connector_configuration' => :'paymentConnectorConfiguration',
-        :'payment_information_hashes' => :'paymentInformationHashes',
         :'payment_method' => :'paymentMethod',
-        :'payment_method_brand' => :'paymentMethodBrand',
-        :'planned_purge_date' => :'plannedPurgeDate',
-        :'processor_token' => :'processorToken',
         :'shipping_address' => :'shippingAddress',
-        :'state' => :'state',
-        :'token' => :'token',
-        :'type' => :'type',
-        :'version' => :'version'
+        :'billing_address' => :'billingAddress',
+        :'retry_strategy' => :'retryStrategy'
       }
     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
       {
-        :'activated_on' => :'DateTime',
-        :'billing_address' => :'Address',
-        :'created_on' => :'DateTime',
-        :'environment' => :'ChargeAttemptEnvironment',
-        :'expires_on' => :'DateTime',
+        :'payment_information_hashes' => :'Array<PaymentInformationHash>',
+        :'language' => :'String',
+        :'type' => :'TokenVersionType',
+        :'created_on' => :'Time',
+        :'retry_in' => :'String',
+        :'payment_connector_configuration' => :'PaymentConnectorConfiguration',
+        :'obsoleted_on' => :'Time',
+        :'expires_on' => :'Time',
         :'icon_url' => :'String',
         :'id' => :'Integer',
+        :'state' => :'TokenVersionState',
+        :'processor_token' => :'String',
+        :'planned_purge_date' => :'Time',
+        :'payment_method_brand' => :'PaymentMethodBrand',
+        :'version' => :'Integer',
+        :'last_retried_on' => :'Time',
         :'labels' => :'Array<Label>',
-        :'language' => :'String',
+        :'token' => :'Token',
         :'linked_space_id' => :'Integer',
+        :'environment' => :'ChargeAttemptEnvironment',
+        :'activated_on' => :'Time',
         :'name' => :'String',
-        :'obsoleted_on' => :'DateTime',
-        :'payment_connector_configuration' => :'PaymentConnectorConfiguration',
-        :'payment_information_hashes' => :'Array<PaymentInformationHash>',
-        :'payment_method' => :'Integer',
-        :'payment_method_brand' => :'Integer',
-        :'planned_purge_date' => :'DateTime',
-        :'processor_token' => :'String',
+        :'payment_method' => :'PaymentMethod',
         :'shipping_address' => :'Address',
-        :'state' => :'TokenVersionState',
-        :'token' => :'Token',
-        :'type' => :'TokenVersionType',
-        :'version' => :'Integer'
+        :'billing_address' => :'Address',
+        :'retry_strategy' => :'TokenVersionRetryStrategy'
       }
     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 `WalleeRubySdk::TokenVersion` 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 `WalleeRubySdk::TokenVersion`. 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?(:'activatedOn')
-        self.activated_on = attributes[:'activatedOn']
+      if attributes.key?(:'payment_information_hashes')
+        if (value = attributes[:'payment_information_hashes']).is_a?(Array)
+          self.payment_information_hashes = value
+        end
       end
 
-      if attributes.has_key?(:'billingAddress')
-        self.billing_address = attributes[:'billingAddress']
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
       end
 
-      if attributes.has_key?(:'createdOn')
-        self.created_on = attributes[:'createdOn']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       end
 
-      if attributes.has_key?(:'environment')
-        self.environment = attributes[:'environment']
+      if attributes.key?(:'created_on')
+        self.created_on = attributes[:'created_on']
       end
 
-      if attributes.has_key?(:'expiresOn')
-        self.expires_on = attributes[:'expiresOn']
+      if attributes.key?(:'retry_in')
+        self.retry_in = attributes[:'retry_in']
       end
 
-      if attributes.has_key?(:'iconUrl')
-        self.icon_url = attributes[:'iconUrl']
+      if attributes.key?(:'payment_connector_configuration')
+        self.payment_connector_configuration = attributes[:'payment_connector_configuration']
       end
 
-      if attributes.has_key?(:'id')
+      if attributes.key?(:'obsoleted_on')
+        self.obsoleted_on = attributes[:'obsoleted_on']
+      end
+
+      if attributes.key?(:'expires_on')
+        self.expires_on = attributes[:'expires_on']
+      end
+
+      if attributes.key?(:'icon_url')
+        self.icon_url = attributes[:'icon_url']
+      end
+
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'labels')
-        if (value = attributes[:'labels']).is_a?(Array)
-          self.labels = value
-        end
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
       end
 
-      if attributes.has_key?(:'language')
-        self.language = attributes[:'language']
+      if attributes.key?(:'processor_token')
+        self.processor_token = attributes[:'processor_token']
       end
 
-      if attributes.has_key?(:'linkedSpaceId')
-        self.linked_space_id = attributes[:'linkedSpaceId']
+      if attributes.key?(:'planned_purge_date')
+        self.planned_purge_date = attributes[:'planned_purge_date']
       end
 
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'payment_method_brand')
+        self.payment_method_brand = attributes[:'payment_method_brand']
       end
 
-      if attributes.has_key?(:'obsoletedOn')
-        self.obsoleted_on = attributes[:'obsoletedOn']
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
       end
 
-      if attributes.has_key?(:'paymentConnectorConfiguration')
-        self.payment_connector_configuration = attributes[:'paymentConnectorConfiguration']
+      if attributes.key?(:'last_retried_on')
+        self.last_retried_on = attributes[:'last_retried_on']
       end
 
-      if attributes.has_key?(:'paymentInformationHashes')
-        if (value = attributes[:'paymentInformationHashes']).is_a?(Array)
-          self.payment_information_hashes = value
+      if attributes.key?(:'labels')
+        if (value = attributes[:'labels']).is_a?(Array)
+          self.labels = value
         end
       end
 
-      if attributes.has_key?(:'paymentMethod')
-        self.payment_method = attributes[:'paymentMethod']
+      if attributes.key?(:'token')
+        self.token = attributes[:'token']
       end
 
-      if attributes.has_key?(:'paymentMethodBrand')
-        self.payment_method_brand = attributes[:'paymentMethodBrand']
+      if attributes.key?(:'linked_space_id')
+        self.linked_space_id = attributes[:'linked_space_id']
       end
 
-      if attributes.has_key?(:'plannedPurgeDate')
-        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      if attributes.key?(:'environment')
+        self.environment = attributes[:'environment']
       end
 
-      if attributes.has_key?(:'processorToken')
-        self.processor_token = attributes[:'processorToken']
+      if attributes.key?(:'activated_on')
+        self.activated_on = attributes[:'activated_on']
       end
 
-      if attributes.has_key?(:'shippingAddress')
-        self.shipping_address = attributes[:'shippingAddress']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'payment_method')
+        self.payment_method = attributes[:'payment_method']
       end
 
-      if attributes.has_key?(:'token')
-        self.token = attributes[:'token']
+      if attributes.key?(:'shipping_address')
+        self.shipping_address = attributes[:'shipping_address']
       end
 
-      if attributes.has_key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'billing_address')
+        self.billing_address = attributes[:'billing_address']
       end
 
-      if attributes.has_key?(:'version')
-        self.version = attributes[:'version']
+      if attributes.key?(:'retry_strategy')
+        self.retry_strategy = attributes[:'retry_strategy']
       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 !@name.nil? && @name.to_s.length > 150
-        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 150.')
-      end
-
       if !@processor_token.nil? && @processor_token.to_s.length > 150
         invalid_properties.push('invalid value for "processor_token", the character length must be smaller than or equal to 150.')
       end
 
+      if !@name.nil? && @name.to_s.length > 150
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 150.')
+      end
+
       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?
-      return false if !@name.nil? && @name.to_s.length > 150
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@processor_token.nil? && @processor_token.to_s.length > 150
+      return false if !@name.nil? && @name.to_s.length > 150
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      if !name.nil? && name.to_s.length > 150
-        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 150.'
+    # @param [Object] payment_information_hashes Value to be assigned
+    def payment_information_hashes=(payment_information_hashes)
+      if payment_information_hashes.nil?
+        fail ArgumentError, 'payment_information_hashes cannot be nil'
       end
 
-      @name = name
+      @payment_information_hashes = payment_information_hashes
     end
 
     # Custom attribute writer method with validation
     # @param [Object] processor_token Value to be assigned
     def processor_token=(processor_token)
-      if !processor_token.nil? && processor_token.to_s.length > 150
+      if processor_token.nil?
+        fail ArgumentError, 'processor_token cannot be nil'
+      end
+
+      if processor_token.to_s.length > 150
         fail ArgumentError, 'invalid value for "processor_token", the character length must be smaller than or equal to 150.'
       end
 
       @processor_token = processor_token
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] labels Value to be assigned
+    def labels=(labels)
+      if labels.nil?
+        fail ArgumentError, 'labels cannot be nil'
+      end
+
+      @labels = labels
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 150
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 150.'
+      end
+
+      @name = name
+    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 &&
-          activated_on == o.activated_on &&
-          billing_address == o.billing_address &&
+          payment_information_hashes == o.payment_information_hashes &&
+          language == o.language &&
+          type == o.type &&
           created_on == o.created_on &&
-          environment == o.environment &&
+          retry_in == o.retry_in &&
+          payment_connector_configuration == o.payment_connector_configuration &&
+          obsoleted_on == o.obsoleted_on &&
           expires_on == o.expires_on &&
           icon_url == o.icon_url &&
           id == o.id &&
+          state == o.state &&
+          processor_token == o.processor_token &&
+          planned_purge_date == o.planned_purge_date &&
+          payment_method_brand == o.payment_method_brand &&
+          version == o.version &&
+          last_retried_on == o.last_retried_on &&
           labels == o.labels &&
-          language == o.language &&
+          token == o.token &&
           linked_space_id == o.linked_space_id &&
+          environment == o.environment &&
+          activated_on == o.activated_on &&
           name == o.name &&
-          obsoleted_on == o.obsoleted_on &&
-          payment_connector_configuration == o.payment_connector_configuration &&
-          payment_information_hashes == o.payment_information_hashes &&
           payment_method == o.payment_method &&
-          payment_method_brand == o.payment_method_brand &&
-          planned_purge_date == o.planned_purge_date &&
-          processor_token == o.processor_token &&
           shipping_address == o.shipping_address &&
-          state == o.state &&
-          token == o.token &&
-          type == o.type &&
-          version == o.version
+          billing_address == o.billing_address &&
+          retry_strategy == o.retry_strategy
     end
 
     # @see the `==` method
@@ -332,39 +425,40 @@ module Wallee
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [activated_on, billing_address, created_on, environment, expires_on, icon_url, id, labels, language, linked_space_id, name, obsoleted_on, payment_connector_configuration, payment_information_hashes, payment_method, payment_method_brand, planned_purge_date, processor_token, shipping_address, state, token, type, version].hash
-    end
-
-    # Builds the object from hash
+      [payment_information_hashes, language, type, created_on, retry_in, payment_connector_configuration, obsoleted_on, expires_on, icon_url, id, state, processor_token, planned_purge_date, payment_method_brand, version, last_retried_on, labels, token, linked_space_id, environment, activated_on, name, payment_method, shipping_address, billing_address, retry_strategy].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
@@ -373,7 +467,7 @@ module Wallee
         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
@@ -394,8 +488,9 @@ module Wallee
           end
         end
       else # model
-        temp_model = Wallee.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = WalleeRubySdk.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
 
@@ -417,7 +512,11 @@ module Wallee
       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
@@ -429,7 +528,7 @@ module Wallee
     # @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) }
@@ -440,6 +539,5 @@ module Wallee
         value
       end
     end
-
   end
 end