postfinancecheckout-ruby-sdk 5.2.0 → 6.1.0

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

@@ -1,229 +1,275 @@
-=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 BankTransaction
     # Adjustments are changes made to the initial transaction amount, such as fees or corrections.
     attr_accessor :adjustments
 
-    # The ID of the user the bank transaction was created by.
-    attr_accessor :created_by
-
-    # The date and time when the object was created.
-    attr_accessor :created_on
-
-    # The currency bank account that sends or receives money based on the bank transaction's flow direction.
     attr_accessor :currency_bank_account
 
+    # 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
+
     # A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
     attr_accessor :external_id
 
-    # Indicates the direction of a bank transaction, specifying whether the amount flows into or out of the bank account.
-    attr_accessor :flow_direction
+    # The posting amount refers to the monetary value recorded for the bank transaction prior to any adjustments.
+    attr_accessor :posting_amount
 
-    # A unique identifier for the object.
-    attr_accessor :id
+    # The source indicates how the bank transaction was created.
+    attr_accessor :source
 
-    # The ID of the space this object belongs to.
-    attr_accessor :linked_space_id
+    # The value date indicates the date on which the transaction amount becomes effective.
+    attr_accessor :value_date
 
-    # The payment date specifies the date on which the payment was processed.
-    attr_accessor :payment_date
+    # The bank transaction's type.
+    attr_accessor :type
 
-    # 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 date and time when the object was created.
+    attr_accessor :created_on
 
-    # The posting amount refers to the monetary value recorded for the bank transaction prior to any adjustments.
-    attr_accessor :posting_amount
+    # The version is used for optimistic locking and incremented whenever the object is updated.
+    attr_accessor :version
 
     # A unique reference to identify the bank transaction.
     attr_accessor :reference
 
-    # The source indicates how the bank transaction was created.
-    attr_accessor :source
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
+
+    # The value amount represents the net monetary value of the transaction after applicable deductions.
+    attr_accessor :value_amount
+
+    attr_accessor :flow_direction
+
+    # The ID of the user the bank transaction was created by.
+    attr_accessor :created_by
+
+    # A unique identifier for the object.
+    attr_accessor :id
 
-    # The object's current state.
     attr_accessor :state
 
+    # The payment date specifies the date on which the payment was processed.
+    attr_accessor :payment_date
+
     # Represents the total value of all adjustments to the bank transaction, including tax.
     attr_accessor :total_adjustment_amount_including_tax
 
-    # The bank transaction's type.
-    attr_accessor :type
-
-    # The value amount represents the net monetary value of the transaction after applicable deductions.
-    attr_accessor :value_amount
-
-    # The value date indicates the date on which the transaction amount becomes effective.
-    attr_accessor :value_date
+    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
       {
         :'adjustments' => :'adjustments',
-        :'created_by' => :'createdBy',
-        :'created_on' => :'createdOn',
         :'currency_bank_account' => :'currencyBankAccount',
-        :'external_id' => :'externalId',
-        :'flow_direction' => :'flowDirection',
-        :'id' => :'id',
-        :'linked_space_id' => :'linkedSpaceId',
-        :'payment_date' => :'paymentDate',
         :'planned_purge_date' => :'plannedPurgeDate',
+        :'external_id' => :'externalId',
         :'posting_amount' => :'postingAmount',
-        :'reference' => :'reference',
         :'source' => :'source',
-        :'state' => :'state',
-        :'total_adjustment_amount_including_tax' => :'totalAdjustmentAmountIncludingTax',
+        :'value_date' => :'valueDate',
         :'type' => :'type',
+        :'created_on' => :'createdOn',
+        :'version' => :'version',
+        :'reference' => :'reference',
+        :'linked_space_id' => :'linkedSpaceId',
         :'value_amount' => :'valueAmount',
-        :'value_date' => :'valueDate',
-        :'version' => :'version'
+        :'flow_direction' => :'flowDirection',
+        :'created_by' => :'createdBy',
+        :'id' => :'id',
+        :'state' => :'state',
+        :'payment_date' => :'paymentDate',
+        :'total_adjustment_amount_including_tax' => :'totalAdjustmentAmountIncludingTax'
       }
     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
       {
         :'adjustments' => :'Array<PaymentAdjustment>',
-        :'created_by' => :'Integer',
-        :'created_on' => :'DateTime',
         :'currency_bank_account' => :'CurrencyBankAccount',
+        :'planned_purge_date' => :'Time',
         :'external_id' => :'String',
-        :'flow_direction' => :'BankTransactionFlowDirection',
-        :'id' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'payment_date' => :'DateTime',
-        :'planned_purge_date' => :'DateTime',
         :'posting_amount' => :'Float',
-        :'reference' => :'String',
         :'source' => :'Integer',
-        :'state' => :'BankTransactionState',
-        :'total_adjustment_amount_including_tax' => :'Float',
+        :'value_date' => :'Time',
         :'type' => :'Integer',
+        :'created_on' => :'Time',
+        :'version' => :'Integer',
+        :'reference' => :'String',
+        :'linked_space_id' => :'Integer',
         :'value_amount' => :'Float',
-        :'value_date' => :'DateTime',
-        :'version' => :'Integer'
+        :'flow_direction' => :'BankTransactionFlowDirection',
+        :'created_by' => :'Integer',
+        :'id' => :'Integer',
+        :'state' => :'BankTransactionState',
+        :'payment_date' => :'Time',
+        :'total_adjustment_amount_including_tax' => :'Float'
       }
     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::BankTransaction` 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::BankTransaction`. 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?(:'adjustments')
+      if attributes.key?(:'adjustments')
         if (value = attributes[:'adjustments']).is_a?(Array)
           self.adjustments = value
         end
       end
 
-      if attributes.has_key?(:'createdBy')
-        self.created_by = attributes[:'createdBy']
+      if attributes.key?(:'currency_bank_account')
+        self.currency_bank_account = attributes[:'currency_bank_account']
       end
 
-      if attributes.has_key?(:'createdOn')
-        self.created_on = attributes[:'createdOn']
+      if attributes.key?(:'planned_purge_date')
+        self.planned_purge_date = attributes[:'planned_purge_date']
       end
 
-      if attributes.has_key?(:'currencyBankAccount')
-        self.currency_bank_account = attributes[:'currencyBankAccount']
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
       end
 
-      if attributes.has_key?(:'externalId')
-        self.external_id = attributes[:'externalId']
+      if attributes.key?(:'posting_amount')
+        self.posting_amount = attributes[:'posting_amount']
       end
 
-      if attributes.has_key?(:'flowDirection')
-        self.flow_direction = attributes[:'flowDirection']
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
       end
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
+      if attributes.key?(:'value_date')
+        self.value_date = attributes[:'value_date']
       end
 
-      if attributes.has_key?(:'linkedSpaceId')
-        self.linked_space_id = attributes[:'linkedSpaceId']
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
       end
 
-      if attributes.has_key?(:'paymentDate')
-        self.payment_date = attributes[:'paymentDate']
+      if attributes.key?(:'created_on')
+        self.created_on = attributes[:'created_on']
       end
 
-      if attributes.has_key?(:'plannedPurgeDate')
-        self.planned_purge_date = attributes[:'plannedPurgeDate']
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
       end
 
-      if attributes.has_key?(:'postingAmount')
-        self.posting_amount = attributes[:'postingAmount']
+      if attributes.key?(:'reference')
+        self.reference = attributes[:'reference']
       end
 
-      if attributes.has_key?(:'reference')
-        self.reference = attributes[:'reference']
+      if attributes.key?(:'linked_space_id')
+        self.linked_space_id = attributes[:'linked_space_id']
       end
 
-      if attributes.has_key?(:'source')
-        self.source = attributes[:'source']
+      if attributes.key?(:'value_amount')
+        self.value_amount = attributes[:'value_amount']
       end
 
-      if attributes.has_key?(:'state')
-        self.state = attributes[:'state']
+      if attributes.key?(:'flow_direction')
+        self.flow_direction = attributes[:'flow_direction']
       end
 
-      if attributes.has_key?(:'totalAdjustmentAmountIncludingTax')
-        self.total_adjustment_amount_including_tax = attributes[:'totalAdjustmentAmountIncludingTax']
+      if attributes.key?(:'created_by')
+        self.created_by = attributes[:'created_by']
       end
 
-      if attributes.has_key?(:'type')
-        self.type = attributes[:'type']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'valueAmount')
-        self.value_amount = attributes[:'valueAmount']
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
       end
 
-      if attributes.has_key?(:'valueDate')
-        self.value_date = attributes[:'valueDate']
+      if attributes.key?(:'payment_date')
+        self.payment_date = attributes[:'payment_date']
       end
 
-      if attributes.has_key?(:'version')
-        self.version = attributes[:'version']
+      if attributes.key?(:'total_adjustment_amount_including_tax')
+        self.total_adjustment_amount_including_tax = attributes[:'total_adjustment_amount_including_tax']
       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? && @external_id.to_s.length > 100
         invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 100.')
       end
 
       if !@external_id.nil? && @external_id.to_s.length < 1
-        invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
+        invalid_properties.push('invalid value for "external_id", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if !@external_id.nil? && @external_id !~ pattern
+        invalid_properties.push("invalid value for \"external_id\", must conform to the pattern #{pattern}.")
       end
 
       invalid_properties
@@ -232,20 +278,32 @@ 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 !@external_id.nil? && @external_id.to_s.length > 100
       return false if !@external_id.nil? && @external_id.to_s.length < 1
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      return false if !@external_id.nil? && @external_id !~ pattern
       true
     end
 
     # Custom attribute writer method with validation
     # @param [Object] external_id Value to be assigned
     def external_id=(external_id)
-      if !external_id.nil? && external_id.to_s.length > 100
+      if external_id.nil?
+        fail ArgumentError, 'external_id cannot be nil'
+      end
+
+      if external_id.to_s.length > 100
         fail ArgumentError, 'invalid value for "external_id", the character length must be smaller than or equal to 100.'
       end
 
-      if !external_id.nil? && external_id.to_s.length < 1
-        fail ArgumentError, 'invalid value for "external_id", the character length must be great than or equal to 1.'
+      if external_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "external_id", the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if external_id !~ pattern
+        fail ArgumentError, "invalid value for \"external_id\", must conform to the pattern #{pattern}."
       end
 
       @external_id = external_id
@@ -257,24 +315,24 @@ module PostFinanceCheckout
       return true if self.equal?(o)
       self.class == o.class &&
           adjustments == o.adjustments &&
-          created_by == o.created_by &&
-          created_on == o.created_on &&
           currency_bank_account == o.currency_bank_account &&
-          external_id == o.external_id &&
-          flow_direction == o.flow_direction &&
-          id == o.id &&
-          linked_space_id == o.linked_space_id &&
-          payment_date == o.payment_date &&
           planned_purge_date == o.planned_purge_date &&
+          external_id == o.external_id &&
           posting_amount == o.posting_amount &&
-          reference == o.reference &&
           source == o.source &&
-          state == o.state &&
-          total_adjustment_amount_including_tax == o.total_adjustment_amount_including_tax &&
+          value_date == o.value_date &&
           type == o.type &&
+          created_on == o.created_on &&
+          version == o.version &&
+          reference == o.reference &&
+          linked_space_id == o.linked_space_id &&
           value_amount == o.value_amount &&
-          value_date == o.value_date &&
-          version == o.version
+          flow_direction == o.flow_direction &&
+          created_by == o.created_by &&
+          id == o.id &&
+          state == o.state &&
+          payment_date == o.payment_date &&
+          total_adjustment_amount_including_tax == o.total_adjustment_amount_including_tax
     end
 
     # @see the `==` method
@@ -284,39 +342,40 @@ module PostFinanceCheckout
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [adjustments, created_by, created_on, currency_bank_account, external_id, flow_direction, id, linked_space_id, payment_date, planned_purge_date, posting_amount, reference, source, state, total_adjustment_amount_including_tax, type, value_amount, value_date, version].hash
-    end
-
-    # Builds the object from hash
+      [adjustments, currency_bank_account, planned_purge_date, external_id, posting_amount, source, value_date, type, created_on, version, reference, linked_space_id, value_amount, flow_direction, created_by, id, state, payment_date, total_adjustment_amount_including_tax].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
@@ -325,7 +384,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
@@ -346,8 +405,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
 
@@ -369,7 +429,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
@@ -381,7 +445,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) }
@@ -392,6 +456,5 @@ module PostFinanceCheckout
         value
       end
     end
-
   end
 end

data/lib/postfinancecheckout-ruby-sdk/models/bank_transaction_flow_direction.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 BankTransactionFlowDirection
-    
-    INFLOW = 'INFLOW'.freeze
-    OUTFLOW = 'OUTFLOW'.freeze
+    INFLOW = "INFLOW".freeze
+    OUTFLOW = "OUTFLOW".freeze
+
+    def self.all_vars
+      @all_vars ||= [INFLOW, OUTFLOW].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 = BankTransactionFlowDirection.constants.select { |c| BankTransactionFlowDirection::const_get(c) == value }
-      raise "Invalid ENUM value #{value} for class #BankTransactionFlowDirection" if constantValues.empty?
-      value
+      return value if BankTransactionFlowDirection.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #BankTransactionFlowDirection"
     end
   end
 end