postfinancecheckout-ruby-sdk 5.2.0 → 6.0.0

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

@@ -1,175 +1,215 @@
-=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 SubscriptionSuspension
-    # The date and time when the object was created.
-    attr_accessor :created_on
-
     # The date and time when the suspension ended.
     attr_accessor :effective_end_date
 
-    # Whether the subscription should be terminated or reactivated after the suspension has reached its end date.
-    attr_accessor :end_action
+    # A note that contains details about the suspension. It is not disclosed to the subscriber.
+    attr_accessor :note
 
-    # A unique identifier for the object.
-    attr_accessor :id
+    attr_accessor :reason
+
+    # The period bill that led to the suspension of the subscription.
+    attr_accessor :period_bill
+
+    # 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 language that is linked to the object.
     attr_accessor :language
 
-    # The ID of the space this object belongs to.
-    attr_accessor :linked_space_id
+    attr_accessor :subscription
 
-    # A note that contains details about the suspension. It is not disclosed to the subscriber.
-    attr_accessor :note
+    # The date and time when the object was created.
+    attr_accessor :created_on
 
-    # The period bill that led to the suspension of the subscription.
-    attr_accessor :period_bill
+    # The version is used for optimistic locking and incremented whenever the object is updated.
+    attr_accessor :version
 
     # The date and time when the suspension is planned to end.
     attr_accessor :planned_end_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
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
 
-    # The reason why the subscription was suspended.
-    attr_accessor :reason
+    attr_accessor :end_action
+
+    # A unique identifier for the object.
+    attr_accessor :id
 
-    # The object's current state.
     attr_accessor :state
 
-    # The subscription that this suspension belongs to.
-    attr_accessor :subscription
+    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
       {
-        :'created_on' => :'createdOn',
         :'effective_end_date' => :'effectiveEndDate',
-        :'end_action' => :'endAction',
-        :'id' => :'id',
-        :'language' => :'language',
-        :'linked_space_id' => :'linkedSpaceId',
         :'note' => :'note',
+        :'reason' => :'reason',
         :'period_bill' => :'periodBill',
-        :'planned_end_date' => :'plannedEndDate',
         :'planned_purge_date' => :'plannedPurgeDate',
-        :'reason' => :'reason',
-        :'state' => :'state',
+        :'language' => :'language',
         :'subscription' => :'subscription',
-        :'version' => :'version'
+        :'created_on' => :'createdOn',
+        :'version' => :'version',
+        :'planned_end_date' => :'plannedEndDate',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'end_action' => :'endAction',
+        :'id' => :'id',
+        :'state' => :'state'
       }
     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
       {
-        :'created_on' => :'DateTime',
-        :'effective_end_date' => :'DateTime',
-        :'end_action' => :'SubscriptionSuspensionAction',
-        :'id' => :'Integer',
-        :'language' => :'String',
-        :'linked_space_id' => :'Integer',
+        :'effective_end_date' => :'Time',
         :'note' => :'String',
-        :'period_bill' => :'Integer',
-        :'planned_end_date' => :'DateTime',
-        :'planned_purge_date' => :'DateTime',
         :'reason' => :'SubscriptionSuspensionReason',
-        :'state' => :'SubscriptionSuspensionState',
-        :'subscription' => :'Integer',
-        :'version' => :'Integer'
+        :'period_bill' => :'Integer',
+        :'planned_purge_date' => :'Time',
+        :'language' => :'String',
+        :'subscription' => :'Subscription',
+        :'created_on' => :'Time',
+        :'version' => :'Integer',
+        :'planned_end_date' => :'Time',
+        :'linked_space_id' => :'Integer',
+        :'end_action' => :'SubscriptionSuspensionAction',
+        :'id' => :'Integer',
+        :'state' => :'SubscriptionSuspensionState'
       }
     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::SubscriptionSuspension` 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::SubscriptionSuspension`. 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?(:'createdOn')
-        self.created_on = attributes[:'createdOn']
+      if attributes.key?(:'effective_end_date')
+        self.effective_end_date = attributes[:'effective_end_date']
       end
 
-      if attributes.has_key?(:'effectiveEndDate')
-        self.effective_end_date = attributes[:'effectiveEndDate']
+      if attributes.key?(:'note')
+        self.note = attributes[:'note']
       end
 
-      if attributes.has_key?(:'endAction')
-        self.end_action = attributes[:'endAction']
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
       end
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'period_bill')
+        self.period_bill = attributes[:'period_bill']
       end
 
-      if attributes.has_key?(:'language')
-        self.language = attributes[:'language']
+      if attributes.key?(:'planned_purge_date')
+        self.planned_purge_date = attributes[:'planned_purge_date']
       end
 
-      if attributes.has_key?(:'linkedSpaceId')
-        self.linked_space_id = attributes[:'linkedSpaceId']
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
       end
 
-      if attributes.has_key?(:'note')
-        self.note = attributes[:'note']
+      if attributes.key?(:'subscription')
+        self.subscription = attributes[:'subscription']
       end
 
-      if attributes.has_key?(:'periodBill')
-        self.period_bill = attributes[:'periodBill']
+      if attributes.key?(:'created_on')
+        self.created_on = attributes[:'created_on']
       end
 
-      if attributes.has_key?(:'plannedEndDate')
-        self.planned_end_date = attributes[:'plannedEndDate']
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
       end
 
-      if attributes.has_key?(:'plannedPurgeDate')
-        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      if attributes.key?(:'planned_end_date')
+        self.planned_end_date = attributes[:'planned_end_date']
       end
 
-      if attributes.has_key?(:'reason')
-        self.reason = attributes[:'reason']
+      if attributes.key?(:'linked_space_id')
+        self.linked_space_id = attributes[:'linked_space_id']
       end
 
-      if attributes.has_key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'end_action')
+        self.end_action = attributes[:'end_action']
       end
 
-      if attributes.has_key?(:'subscription')
-        self.subscription = attributes[:'subscription']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'version')
-        self.version = attributes[:'version']
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
       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 !@note.nil? && @note.to_s.length > 300
         invalid_properties.push('invalid value for "note", the character length must be smaller than or equal to 300.')
@@ -181,6 +221,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 !@note.nil? && @note.to_s.length > 300
       true
     end
@@ -188,7 +229,11 @@ module PostFinanceCheckout
     # Custom attribute writer method with validation
     # @param [Object] note Value to be assigned
     def note=(note)
-      if !note.nil? && note.to_s.length > 300
+      if note.nil?
+        fail ArgumentError, 'note cannot be nil'
+      end
+
+      if note.to_s.length > 300
         fail ArgumentError, 'invalid value for "note", the character length must be smaller than or equal to 300.'
       end
 
@@ -200,20 +245,20 @@ module PostFinanceCheckout
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          created_on == o.created_on &&
           effective_end_date == o.effective_end_date &&
-          end_action == o.end_action &&
-          id == o.id &&
-          language == o.language &&
-          linked_space_id == o.linked_space_id &&
           note == o.note &&
+          reason == o.reason &&
           period_bill == o.period_bill &&
-          planned_end_date == o.planned_end_date &&
           planned_purge_date == o.planned_purge_date &&
-          reason == o.reason &&
-          state == o.state &&
+          language == o.language &&
           subscription == o.subscription &&
-          version == o.version
+          created_on == o.created_on &&
+          version == o.version &&
+          planned_end_date == o.planned_end_date &&
+          linked_space_id == o.linked_space_id &&
+          end_action == o.end_action &&
+          id == o.id &&
+          state == o.state
     end
 
     # @see the `==` method
@@ -223,39 +268,40 @@ module PostFinanceCheckout
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [created_on, effective_end_date, end_action, id, language, linked_space_id, note, period_bill, planned_end_date, planned_purge_date, reason, state, subscription, version].hash
-    end
-
-    # Builds the object from hash
+      [effective_end_date, note, reason, period_bill, planned_purge_date, language, subscription, created_on, version, planned_end_date, linked_space_id, end_action, id, state].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
@@ -264,7 +310,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
@@ -285,8 +331,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
 
@@ -308,7 +355,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
@@ -320,7 +371,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) }
@@ -331,6 +382,5 @@ module PostFinanceCheckout
         value
       end
     end
-
   end
 end

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

@@ -1,35 +1,48 @@
-=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 SubscriptionSuspensionAction
-    
-    TERMINATE = 'TERMINATE'.freeze
-    REACTIVATE = 'REACTIVATE'.freeze
+    TERMINATE = "TERMINATE".freeze
+    REACTIVATE = "REACTIVATE".freeze
+
+    def self.all_vars
+      @all_vars ||= [TERMINATE, REACTIVATE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      constantValues = SubscriptionSuspensionAction.constants.select { |c| SubscriptionSuspensionAction::const_get(c) == value }
-      raise "Invalid ENUM value #{value} for class #SubscriptionSuspensionAction" if constantValues.empty?
-      value
+      return value if SubscriptionSuspensionAction.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #SubscriptionSuspensionAction"
     end
   end
 end

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

@@ -1,36 +1,49 @@
-=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 SubscriptionSuspensionReason
-    
-    FAILED_CHARGE = 'FAILED_CHARGE'.freeze
-    SUBSCRIBER_INITIATED_REFUND = 'SUBSCRIBER_INITIATED_REFUND'.freeze
-    MANUAL = 'MANUAL'.freeze
+    FAILED_CHARGE = "FAILED_CHARGE".freeze
+    SUBSCRIBER_INITIATED_REFUND = "SUBSCRIBER_INITIATED_REFUND".freeze
+    MANUAL = "MANUAL".freeze
+
+    def self.all_vars
+      @all_vars ||= [FAILED_CHARGE, SUBSCRIBER_INITIATED_REFUND, MANUAL].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      constantValues = SubscriptionSuspensionReason.constants.select { |c| SubscriptionSuspensionReason::const_get(c) == value }
-      raise "Invalid ENUM value #{value} for class #SubscriptionSuspensionReason" if constantValues.empty?
-      value
+      return value if SubscriptionSuspensionReason.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #SubscriptionSuspensionReason"
     end
   end
 end