vrpayment-ruby-sdk 5.1.0 → 6.0.0

data/lib/vrpayment-ruby-sdk/models/payment_link.rb

@@ -1,225 +1,280 @@
-=begin
-The VR Payment API allows an easy interaction with the VR Payment web service.
+# VR Payment Ruby SDK
+#
+# This library allows to interact with the VR Payment payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://www.vr-payment.de
+# 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.
 
-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
+require 'date'
+require 'time'
 
-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.
+module VrpaymentRubySdk
+  class PaymentLink
+    attr_accessor :shipping_address_handling_mode
 
-=end
+    # The domains to which the user is allowed to be redirected after the payment is completed. The following options can be configured: Exact domain: enter a full domain, e.g. (https://example.com). Wildcard domain: use to allow subdomains, e.g. (https://*.example.com). All domains: use (ALL) to allow redirection to any domain (not recommended for security reasons). No domains : use (NONE) to disallow any redirection. Only one option per line is allowed. Invalid entries will be rejected. 
+    attr_accessor :allowed_redirection_domains
 
-require 'date'
+    # 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
 
-module VRPayment
-  # 
-  class PaymentLink
-    # The payment method configurations that customers can use for making payments.
-    attr_accessor :allowed_payment_method_configurations
+    # A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
+    attr_accessor :external_id
 
-    # The payment link can be used within a specific space view, which may apply a customized design to the payment page.
-    attr_accessor :applied_space_view
+    # The language for displaying the payment page. If not specified, it can be supplied via the 'language' request parameter.
+    attr_accessor :language
 
     # The earliest date the payment link can be used to initiate a transaction. If no date is provided, the link will be available immediately.
     attr_accessor :available_from
 
+    # The version is used for optimistic locking and incremented whenever the object is updated.
+    attr_accessor :version
+
+    # The public URL to share with customers for making payments.
+    attr_accessor :url
+
+    # The line items representing what is being sold. If not specified, they can be supplied via request parameters.
+    attr_accessor :line_items
+
+    attr_accessor :protection_mode
+
     # The latest date the payment link can be used to initiate a transaction. If no date is provided, the link will remain available indefinitely.
     attr_accessor :available_until
 
-    # The handling mode defines whether a billing address is required and specifies how it should be provided.
-    attr_accessor :billing_address_handling_mode
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
+
+    # The name used to identify the payment link.
+    attr_accessor :name
 
     # The three-letter currency code (ISO 4217). If not specified, it must be provided in the 'currency' request parameter.
     attr_accessor :currency
 
-    # A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
-    attr_accessor :external_id
-
     # A unique identifier for the object.
     attr_accessor :id
 
-    # The language for displaying the payment page. If not specified, it can be supplied via the 'language' request parameter.
-    attr_accessor :language
-
-    # The line items representing what is being sold. If not specified, they can be supplied via request parameters.
-    attr_accessor :line_items
-
-    # The ID of the space this object belongs to.
-    attr_accessor :linked_space_id
+    attr_accessor :state
 
     # The maximum number of transactions that can be initiated using the payment link.
     attr_accessor :maximal_number_of_transactions
 
-    # The name used to identify the payment link.
-    attr_accessor :name
-
-    # 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 protection mode defines whether the payment link is protected against tampering and specifies the protection method.
-    attr_accessor :protection_mode
+    # The payment method configurations that customers can use for making payments.
+    attr_accessor :allowed_payment_method_configurations
 
-    # The handling mode defines whether a shipping address is required and specifies how it should be provided.
-    attr_accessor :shipping_address_handling_mode
+    # The payment link can be used within a specific space view, which may apply a customized design to the payment page.
+    attr_accessor :applied_space_view
 
-    # The object's current state.
-    attr_accessor :state
+    attr_accessor :billing_address_handling_mode
 
-    # The public URL to share with customers for making payments.
-    attr_accessor :url
+    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
       {
-        :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
-        :'applied_space_view' => :'appliedSpaceView',
-        :'available_from' => :'availableFrom',
-        :'available_until' => :'availableUntil',
-        :'billing_address_handling_mode' => :'billingAddressHandlingMode',
-        :'currency' => :'currency',
+        :'shipping_address_handling_mode' => :'shippingAddressHandlingMode',
+        :'allowed_redirection_domains' => :'allowedRedirectionDomains',
+        :'planned_purge_date' => :'plannedPurgeDate',
         :'external_id' => :'externalId',
-        :'id' => :'id',
         :'language' => :'language',
+        :'available_from' => :'availableFrom',
+        :'version' => :'version',
+        :'url' => :'url',
         :'line_items' => :'lineItems',
+        :'protection_mode' => :'protectionMode',
+        :'available_until' => :'availableUntil',
         :'linked_space_id' => :'linkedSpaceId',
-        :'maximal_number_of_transactions' => :'maximalNumberOfTransactions',
         :'name' => :'name',
-        :'planned_purge_date' => :'plannedPurgeDate',
-        :'protection_mode' => :'protectionMode',
-        :'shipping_address_handling_mode' => :'shippingAddressHandlingMode',
+        :'currency' => :'currency',
+        :'id' => :'id',
         :'state' => :'state',
-        :'url' => :'url',
-        :'version' => :'version'
+        :'maximal_number_of_transactions' => :'maximalNumberOfTransactions',
+        :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
+        :'applied_space_view' => :'appliedSpaceView',
+        :'billing_address_handling_mode' => :'billingAddressHandlingMode'
       }
     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
       {
-        :'allowed_payment_method_configurations' => :'Array<PaymentMethodConfiguration>',
-        :'applied_space_view' => :'Integer',
-        :'available_from' => :'DateTime',
-        :'available_until' => :'DateTime',
-        :'billing_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
-        :'currency' => :'String',
+        :'shipping_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
+        :'allowed_redirection_domains' => :'Array<String>',
+        :'planned_purge_date' => :'Time',
         :'external_id' => :'String',
-        :'id' => :'Integer',
         :'language' => :'String',
+        :'available_from' => :'Time',
+        :'version' => :'Integer',
+        :'url' => :'String',
         :'line_items' => :'Array<LineItem>',
+        :'protection_mode' => :'PaymentLinkProtectionMode',
+        :'available_until' => :'Time',
         :'linked_space_id' => :'Integer',
-        :'maximal_number_of_transactions' => :'Integer',
         :'name' => :'String',
-        :'planned_purge_date' => :'DateTime',
-        :'protection_mode' => :'PaymentLinkProtectionMode',
-        :'shipping_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
+        :'currency' => :'String',
+        :'id' => :'Integer',
         :'state' => :'CreationEntityState',
-        :'url' => :'String',
-        :'version' => :'Integer'
+        :'maximal_number_of_transactions' => :'Integer',
+        :'allowed_payment_method_configurations' => :'Array<PaymentMethodConfiguration>',
+        :'applied_space_view' => :'Integer',
+        :'billing_address_handling_mode' => :'PaymentLinkAddressHandlingMode'
       }
     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)
-
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `VrpaymentRubySdk::PaymentLink` initialize method"
+      end
 
-      if attributes.has_key?(:'allowedPaymentMethodConfigurations')
-        if (value = attributes[:'allowedPaymentMethodConfigurations']).is_a?(Array)
-          self.allowed_payment_method_configurations = value
+      # 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 `VrpaymentRubySdk::PaymentLink`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
-      end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'appliedSpaceView')
-        self.applied_space_view = attributes[:'appliedSpaceView']
+      if attributes.key?(:'shipping_address_handling_mode')
+        self.shipping_address_handling_mode = attributes[:'shipping_address_handling_mode']
       end
 
-      if attributes.has_key?(:'availableFrom')
-        self.available_from = attributes[:'availableFrom']
+      if attributes.key?(:'allowed_redirection_domains')
+        if (value = attributes[:'allowed_redirection_domains']).is_a?(Array)
+          self.allowed_redirection_domains = value
+        end
       end
 
-      if attributes.has_key?(:'availableUntil')
-        self.available_until = attributes[:'availableUntil']
+      if attributes.key?(:'planned_purge_date')
+        self.planned_purge_date = attributes[:'planned_purge_date']
       end
 
-      if attributes.has_key?(:'billingAddressHandlingMode')
-        self.billing_address_handling_mode = attributes[:'billingAddressHandlingMode']
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
       end
 
-      if attributes.has_key?(:'currency')
-        self.currency = attributes[:'currency']
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
       end
 
-      if attributes.has_key?(:'externalId')
-        self.external_id = attributes[:'externalId']
+      if attributes.key?(:'available_from')
+        self.available_from = attributes[:'available_from']
       end
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
       end
 
-      if attributes.has_key?(:'language')
-        self.language = attributes[:'language']
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
       end
 
-      if attributes.has_key?(:'lineItems')
-        if (value = attributes[:'lineItems']).is_a?(Array)
+      if attributes.key?(:'line_items')
+        if (value = attributes[:'line_items']).is_a?(Array)
           self.line_items = value
         end
       end
 
-      if attributes.has_key?(:'linkedSpaceId')
-        self.linked_space_id = attributes[:'linkedSpaceId']
+      if attributes.key?(:'protection_mode')
+        self.protection_mode = attributes[:'protection_mode']
       end
 
-      if attributes.has_key?(:'maximalNumberOfTransactions')
-        self.maximal_number_of_transactions = attributes[:'maximalNumberOfTransactions']
+      if attributes.key?(:'available_until')
+        self.available_until = attributes[:'available_until']
       end
 
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
+      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?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'protectionMode')
-        self.protection_mode = attributes[:'protectionMode']
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
       end
 
-      if attributes.has_key?(:'shippingAddressHandlingMode')
-        self.shipping_address_handling_mode = attributes[:'shippingAddressHandlingMode']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'state')
+      if attributes.key?(:'state')
         self.state = attributes[:'state']
       end
 
-      if attributes.has_key?(:'url')
-        self.url = attributes[:'url']
+      if attributes.key?(:'maximal_number_of_transactions')
+        self.maximal_number_of_transactions = attributes[:'maximal_number_of_transactions']
       end
 
-      if attributes.has_key?(:'version')
-        self.version = attributes[:'version']
+      if attributes.key?(:'allowed_payment_method_configurations')
+        if (value = attributes[:'allowed_payment_method_configurations']).is_a?(Array)
+          self.allowed_payment_method_configurations = value
+        end
+      end
+
+      if attributes.key?(:'applied_space_view')
+        self.applied_space_view = attributes[:'applied_space_view']
+      end
+
+      if attributes.key?(:'billing_address_handling_mode')
+        self.billing_address_handling_mode = attributes[:'billing_address_handling_mode']
       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 !@allowed_redirection_domains.nil? && @allowed_redirection_domains.length < 1
+        invalid_properties.push('invalid value for "allowed_redirection_domains", number of items must be greater than or equal to 1.')
+      end
+
       if !@name.nil? && @name.to_s.length > 100
         invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
       end
@@ -230,44 +285,75 @@ module VRPayment
     # 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 !@allowed_redirection_domains.nil? && @allowed_redirection_domains.length < 1
       return false if !@name.nil? && @name.to_s.length > 100
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] allowed_redirection_domains Value to be assigned
+    def allowed_redirection_domains=(allowed_redirection_domains)
+      if allowed_redirection_domains.nil?
+        fail ArgumentError, 'allowed_redirection_domains cannot be nil'
+      end
+
+      if allowed_redirection_domains.length < 1
+        fail ArgumentError, 'invalid value for "allowed_redirection_domains", number of items must be greater than or equal to 1.'
+      end
+
+      @allowed_redirection_domains = allowed_redirection_domains
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] name Value to be assigned
     def name=(name)
-      if !name.nil? && name.to_s.length > 100
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 100
         fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
       end
 
       @name = name
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] allowed_payment_method_configurations Value to be assigned
+    def allowed_payment_method_configurations=(allowed_payment_method_configurations)
+      if allowed_payment_method_configurations.nil?
+        fail ArgumentError, 'allowed_payment_method_configurations cannot be nil'
+      end
+
+      @allowed_payment_method_configurations = allowed_payment_method_configurations
+    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 &&
-          allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
-          applied_space_view == o.applied_space_view &&
-          available_from == o.available_from &&
-          available_until == o.available_until &&
-          billing_address_handling_mode == o.billing_address_handling_mode &&
-          currency == o.currency &&
+          shipping_address_handling_mode == o.shipping_address_handling_mode &&
+          allowed_redirection_domains == o.allowed_redirection_domains &&
+          planned_purge_date == o.planned_purge_date &&
           external_id == o.external_id &&
-          id == o.id &&
           language == o.language &&
+          available_from == o.available_from &&
+          version == o.version &&
+          url == o.url &&
           line_items == o.line_items &&
+          protection_mode == o.protection_mode &&
+          available_until == o.available_until &&
           linked_space_id == o.linked_space_id &&
-          maximal_number_of_transactions == o.maximal_number_of_transactions &&
           name == o.name &&
-          planned_purge_date == o.planned_purge_date &&
-          protection_mode == o.protection_mode &&
-          shipping_address_handling_mode == o.shipping_address_handling_mode &&
+          currency == o.currency &&
+          id == o.id &&
           state == o.state &&
-          url == o.url &&
-          version == o.version
+          maximal_number_of_transactions == o.maximal_number_of_transactions &&
+          allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
+          applied_space_view == o.applied_space_view &&
+          billing_address_handling_mode == o.billing_address_handling_mode
     end
 
     # @see the `==` method
@@ -277,39 +363,40 @@ module VRPayment
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [allowed_payment_method_configurations, applied_space_view, available_from, available_until, billing_address_handling_mode, currency, external_id, id, language, line_items, linked_space_id, maximal_number_of_transactions, name, planned_purge_date, protection_mode, shipping_address_handling_mode, state, url, version].hash
-    end
-
-    # Builds the object from hash
+      [shipping_address_handling_mode, allowed_redirection_domains, planned_purge_date, external_id, language, available_from, version, url, line_items, protection_mode, available_until, linked_space_id, name, currency, id, state, maximal_number_of_transactions, allowed_payment_method_configurations, applied_space_view, billing_address_handling_mode].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
@@ -318,7 +405,7 @@ module VRPayment
         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
@@ -339,8 +426,9 @@ module VRPayment
           end
         end
       else # model
-        temp_model = VRPayment.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = VrpaymentRubySdk.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
 
@@ -362,7 +450,11 @@ module VRPayment
       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
@@ -374,7 +466,7 @@ module VRPayment
     # @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) }
@@ -385,6 +477,5 @@ module VRPayment
         value
       end
     end
-
   end
 end