postfinancecheckout-ruby-sdk 5.2.0 → 6.0.0

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

@@ -1,143 +1,198 @@
-=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
   # The subscription charge represents a single charge carried out for a particular subscription.
   class SubscriptionChargeCreate
-    # 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 URL to redirect the customer back to after they canceled or failed to authenticated their payment.
-    attr_accessor :failed_url
+    # The merchant's reference used to identify the charge.
+    attr_accessor :reference
 
     # The date and time when the execution of the charge is planned.
     attr_accessor :planned_execution_date
 
-    # The processing type specifies how the charge is to be processed.
     attr_accessor :processing_type
 
-    # The merchant's reference used to identify the charge.
-    attr_accessor :reference
+    # 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 URL to redirect the customer back to after they successfully authenticated their payment.
+    attr_accessor :success_url
 
     # The subscription that the charge belongs to.
     attr_accessor :subscription
 
-    # The URL to redirect the customer back to after they successfully authenticated their payment.
-    attr_accessor :success_url
+    # The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
+    attr_accessor :failed_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
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'external_id' => :'externalId',
-        :'failed_url' => :'failedUrl',
+        :'reference' => :'reference',
         :'planned_execution_date' => :'plannedExecutionDate',
         :'processing_type' => :'processingType',
-        :'reference' => :'reference',
+        :'external_id' => :'externalId',
+        :'success_url' => :'successUrl',
         :'subscription' => :'subscription',
-        :'success_url' => :'successUrl'
+        :'failed_url' => :'failedUrl'
       }
     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
       {
-        :'external_id' => :'String',
-        :'failed_url' => :'String',
-        :'planned_execution_date' => :'DateTime',
-        :'processing_type' => :'SubscriptionChargeProcessingType',
         :'reference' => :'String',
+        :'planned_execution_date' => :'Time',
+        :'processing_type' => :'SubscriptionChargeProcessingType',
+        :'external_id' => :'String',
+        :'success_url' => :'String',
         :'subscription' => :'Integer',
-        :'success_url' => :'String'
+        :'failed_url' => :'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 = {})
-      return unless attributes.is_a?(Hash)
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::SubscriptionChargeCreate` 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::SubscriptionChargeCreate`. 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?(:'externalId')
-        self.external_id = attributes[:'externalId']
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
       end
 
-      if attributes.has_key?(:'failedUrl')
-        self.failed_url = attributes[:'failedUrl']
+      if attributes.key?(:'planned_execution_date')
+        self.planned_execution_date = attributes[:'planned_execution_date']
       end
 
-      if attributes.has_key?(:'plannedExecutionDate')
-        self.planned_execution_date = attributes[:'plannedExecutionDate']
+      if attributes.key?(:'processing_type')
+        self.processing_type = attributes[:'processing_type']
+      else
+        self.processing_type = nil
       end
 
-      if attributes.has_key?(:'processingType')
-        self.processing_type = attributes[:'processingType']
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      else
+        self.external_id = nil
       end
 
-      if attributes.has_key?(:'reference')
-        self.reference = attributes[:'reference']
+      if attributes.key?(:'success_url')
+        self.success_url = attributes[:'success_url']
       end
 
-      if attributes.has_key?(:'subscription')
+      if attributes.key?(:'subscription')
         self.subscription = attributes[:'subscription']
+      else
+        self.subscription = nil
       end
 
-      if attributes.has_key?(:'successUrl')
-        self.success_url = attributes[:'successUrl']
+      if attributes.key?(:'failed_url')
+        self.failed_url = attributes[:'failed_url']
       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 @external_id.nil?
-        invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
-      end
-
-      if !@failed_url.nil? && @failed_url.to_s.length > 500
-        invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 500.')
+      if !@reference.nil? && @reference.to_s.length > 100
+        invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 100.')
       end
 
-      if !@failed_url.nil? && @failed_url.to_s.length < 9
-        invalid_properties.push('invalid value for "failed_url", the character length must be great than or equal to 9.')
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if !@reference.nil? && @reference !~ pattern
+        invalid_properties.push("invalid value for \"reference\", must conform to the pattern #{pattern}.")
       end
 
       if @processing_type.nil?
         invalid_properties.push('invalid value for "processing_type", processing_type cannot be nil.')
       end
 
-      if !@reference.nil? && @reference.to_s.length > 100
-        invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 100.')
+      if @external_id.nil?
+        invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
+      end
+
+      if !@success_url.nil? && @success_url.to_s.length > 500
+        invalid_properties.push('invalid value for "success_url", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@success_url.nil? && @success_url.to_s.length < 9
+        invalid_properties.push('invalid value for "success_url", the character length must be greater than or equal to 9.')
       end
 
       if @subscription.nil?
         invalid_properties.push('invalid value for "subscription", subscription cannot be nil.')
       end
 
-      if !@success_url.nil? && @success_url.to_s.length > 500
-        invalid_properties.push('invalid value for "success_url", the character length must be smaller than or equal to 500.')
+      if !@failed_url.nil? && @failed_url.to_s.length > 500
+        invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 500.')
       end
 
-      if !@success_url.nil? && @success_url.to_s.length < 9
-        invalid_properties.push('invalid value for "success_url", the character length must be great than or equal to 9.')
+      if !@failed_url.nil? && @failed_url.to_s.length < 9
+        invalid_properties.push('invalid value for "failed_url", the character length must be greater than or equal to 9.')
       end
 
       invalid_properties
@@ -146,36 +201,34 @@ module PostFinanceCheckout
     # 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 @external_id.nil?
-      return false if !@failed_url.nil? && @failed_url.to_s.length > 500
-      return false if !@failed_url.nil? && @failed_url.to_s.length < 9
-      return false if @processing_type.nil?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@reference.nil? && @reference.to_s.length > 100
-      return false if @subscription.nil?
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      return false if !@reference.nil? && @reference !~ pattern
+      return false if @processing_type.nil?
+      return false if @external_id.nil?
       return false if !@success_url.nil? && @success_url.to_s.length > 500
       return false if !@success_url.nil? && @success_url.to_s.length < 9
+      return false if @subscription.nil?
+      return false if !@failed_url.nil? && @failed_url.to_s.length > 500
+      return false if !@failed_url.nil? && @failed_url.to_s.length < 9
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] failed_url Value to be assigned
-    def failed_url=(failed_url)
-      if !failed_url.nil? && failed_url.to_s.length > 500
-        fail ArgumentError, 'invalid value for "failed_url", the character length must be smaller than or equal to 500.'
+    # @param [Object] reference Value to be assigned
+    def reference=(reference)
+      if reference.nil?
+        fail ArgumentError, 'reference cannot be nil'
       end
 
-      if !failed_url.nil? && failed_url.to_s.length < 9
-        fail ArgumentError, 'invalid value for "failed_url", the character length must be great than or equal to 9.'
+      if reference.to_s.length > 100
+        fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 100.'
       end
 
-      @failed_url = failed_url
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] reference Value to be assigned
-    def reference=(reference)
-      if !reference.nil? && reference.to_s.length > 100
-        fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 100.'
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if reference !~ pattern
+        fail ArgumentError, "invalid value for \"reference\", must conform to the pattern #{pattern}."
       end
 
       @reference = reference
@@ -184,29 +237,51 @@ module PostFinanceCheckout
     # Custom attribute writer method with validation
     # @param [Object] success_url Value to be assigned
     def success_url=(success_url)
-      if !success_url.nil? && success_url.to_s.length > 500
+      if success_url.nil?
+        fail ArgumentError, 'success_url cannot be nil'
+      end
+
+      if success_url.to_s.length > 500
         fail ArgumentError, 'invalid value for "success_url", the character length must be smaller than or equal to 500.'
       end
 
-      if !success_url.nil? && success_url.to_s.length < 9
-        fail ArgumentError, 'invalid value for "success_url", the character length must be great than or equal to 9.'
+      if success_url.to_s.length < 9
+        fail ArgumentError, 'invalid value for "success_url", the character length must be greater than or equal to 9.'
       end
 
       @success_url = success_url
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] failed_url Value to be assigned
+    def failed_url=(failed_url)
+      if failed_url.nil?
+        fail ArgumentError, 'failed_url cannot be nil'
+      end
+
+      if failed_url.to_s.length > 500
+        fail ArgumentError, 'invalid value for "failed_url", the character length must be smaller than or equal to 500.'
+      end
+
+      if failed_url.to_s.length < 9
+        fail ArgumentError, 'invalid value for "failed_url", the character length must be greater than or equal to 9.'
+      end
+
+      @failed_url = failed_url
+    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 &&
-          external_id == o.external_id &&
-          failed_url == o.failed_url &&
+          reference == o.reference &&
           planned_execution_date == o.planned_execution_date &&
           processing_type == o.processing_type &&
-          reference == o.reference &&
+          external_id == o.external_id &&
+          success_url == o.success_url &&
           subscription == o.subscription &&
-          success_url == o.success_url
+          failed_url == o.failed_url
     end
 
     # @see the `==` method
@@ -216,39 +291,40 @@ module PostFinanceCheckout
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [external_id, failed_url, planned_execution_date, processing_type, reference, subscription, success_url].hash
-    end
-
-    # Builds the object from hash
+      [reference, planned_execution_date, processing_type, external_id, success_url, subscription, failed_url].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
@@ -257,7 +333,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
@@ -278,8 +354,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
 
@@ -301,7 +378,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
@@ -313,7 +394,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) }
@@ -324,6 +405,5 @@ module PostFinanceCheckout
         value
       end
     end
-
   end
 end