postfinancecheckout-ruby-sdk 5.2.0 → 6.0.0

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

@@ -1,24 +1,27 @@
-=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 TransactionInvoiceCommentCreate
     # The comment's actual content.
     attr_accessor :content
@@ -34,34 +37,62 @@ module PostFinanceCheckout
       }
     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
       {
         :'content' => :'String',
         :'transaction_invoice' => :'Integer'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'AbstractTransactionInvoiceCommentActive'
+      ]
+    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::TransactionInvoiceCommentCreate` 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::TransactionInvoiceCommentCreate`. 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?(:'content')
+      if attributes.key?(:'content')
         self.content = attributes[:'content']
       end
 
-      if attributes.has_key?(:'transactionInvoice')
-        self.transaction_invoice = attributes[:'transactionInvoice']
+      if attributes.key?(:'transaction_invoice')
+        self.transaction_invoice = attributes[:'transaction_invoice']
+      else
+        self.transaction_invoice = nil
       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 !@content.nil? && @content.to_s.length > 262144
         invalid_properties.push('invalid value for "content", the character length must be smaller than or equal to 262144.')
@@ -77,6 +108,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 !@content.nil? && @content.to_s.length > 262144
       return false if @transaction_invoice.nil?
       true
@@ -85,7 +117,11 @@ module PostFinanceCheckout
     # Custom attribute writer method with validation
     # @param [Object] content Value to be assigned
     def content=(content)
-      if !content.nil? && content.to_s.length > 262144
+      if content.nil?
+        fail ArgumentError, 'content cannot be nil'
+      end
+
+      if content.to_s.length > 262144
         fail ArgumentError, 'invalid value for "content", the character length must be smaller than or equal to 262144.'
       end
 
@@ -108,39 +144,40 @@ module PostFinanceCheckout
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [content, transaction_invoice].hash
-    end
-
-    # Builds the object from 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
@@ -149,7 +186,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
@@ -170,8 +207,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
 
@@ -193,7 +231,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
@@ -205,7 +247,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) }
@@ -216,6 +258,5 @@ module PostFinanceCheckout
         value
       end
     end
-
   end
 end

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

@@ -1,27 +1,30 @@
-=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 TransactionInvoiceReplacement
-    # The address associated with the invoice, used for billing purposes.
-    attr_accessor :billing_address
+    # The invoiced line items that will appear on the invoice document.
+    attr_accessor :line_items
 
     # The due date for payment of the invoice.
     attr_accessor :due_on
@@ -29,78 +32,104 @@ module PostFinanceCheckout
     # 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 invoiced line items that will appear on the invoice document.
-    attr_accessor :line_items
-
-    # The merchant's reference used to identify the invoice.
-    attr_accessor :merchant_reference
+    attr_accessor :billing_address
 
     # Whether the invoice will be sent to the customer via email.
     attr_accessor :sent_to_customer
 
+    # The merchant's reference used to identify the invoice.
+    attr_accessor :merchant_reference
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'billing_address' => :'billingAddress',
+        :'line_items' => :'lineItems',
         :'due_on' => :'dueOn',
         :'external_id' => :'externalId',
-        :'line_items' => :'lineItems',
-        :'merchant_reference' => :'merchantReference',
-        :'sent_to_customer' => :'sentToCustomer'
+        :'billing_address' => :'billingAddress',
+        :'sent_to_customer' => :'sentToCustomer',
+        :'merchant_reference' => :'merchantReference'
       }
     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
       {
-        :'billing_address' => :'AddressCreate',
-        :'due_on' => :'DateTime',
-        :'external_id' => :'String',
         :'line_items' => :'Array<LineItemCreate>',
-        :'merchant_reference' => :'String',
-        :'sent_to_customer' => :'BOOLEAN'
+        :'due_on' => :'Time',
+        :'external_id' => :'String',
+        :'billing_address' => :'AddressCreate',
+        :'sent_to_customer' => :'Boolean',
+        :'merchant_reference' => :'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::TransactionInvoiceReplacement` 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::TransactionInvoiceReplacement`. 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?(:'billingAddress')
-        self.billing_address = attributes[:'billingAddress']
+      if attributes.key?(:'line_items')
+        if (value = attributes[:'line_items']).is_a?(Array)
+          self.line_items = value
+        end
+      else
+        self.line_items = nil
       end
 
-      if attributes.has_key?(:'dueOn')
-        self.due_on = attributes[:'dueOn']
+      if attributes.key?(:'due_on')
+        self.due_on = attributes[:'due_on']
       end
 
-      if attributes.has_key?(:'externalId')
-        self.external_id = attributes[:'externalId']
+      if attributes.key?(:'external_id')
+        self.external_id = attributes[:'external_id']
+      else
+        self.external_id = nil
       end
 
-      if attributes.has_key?(:'lineItems')
-        if (value = attributes[:'lineItems']).is_a?(Array)
-          self.line_items = value
-        end
+      if attributes.key?(:'billing_address')
+        self.billing_address = attributes[:'billing_address']
       end
 
-      if attributes.has_key?(:'merchantReference')
-        self.merchant_reference = attributes[:'merchantReference']
+      if attributes.key?(:'sent_to_customer')
+        self.sent_to_customer = attributes[:'sent_to_customer']
       end
 
-      if attributes.has_key?(:'sentToCustomer')
-        self.sent_to_customer = attributes[:'sentToCustomer']
+      if attributes.key?(:'merchant_reference')
+        self.merchant_reference = attributes[:'merchant_reference']
       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 @line_items.nil?
+        invalid_properties.push('invalid value for "line_items", line_items cannot be nil.')
+      end
+
       if @external_id.nil?
         invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
       end
@@ -110,28 +139,39 @@ module PostFinanceCheckout
       end
 
       if @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
 
-      if @line_items.nil?
-        invalid_properties.push('invalid value for "line_items", line_items cannot be nil.')
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if @external_id !~ pattern
+        invalid_properties.push("invalid value for \"external_id\", must conform to the pattern #{pattern}.")
       end
 
       if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
         invalid_properties.push('invalid value for "merchant_reference", the character length must be smaller than or equal to 100.')
       end
 
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if !@merchant_reference.nil? && @merchant_reference !~ pattern
+        invalid_properties.push("invalid value for \"merchant_reference\", must conform to the pattern #{pattern}.")
+      end
+
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @line_items.nil?
       return false if @external_id.nil?
       return false if @external_id.to_s.length > 100
       return false if @external_id.to_s.length < 1
-      return false if @line_items.nil?
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      return false if @external_id !~ pattern
       return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      return false if !@merchant_reference.nil? && @merchant_reference !~ pattern
       true
     end
 
@@ -147,7 +187,12 @@ module PostFinanceCheckout
       end
 
       if external_id.to_s.length < 1
-        fail ArgumentError, 'invalid value for "external_id", the character length must be great than or equal to 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
@@ -156,10 +201,19 @@ module PostFinanceCheckout
     # Custom attribute writer method with validation
     # @param [Object] merchant_reference Value to be assigned
     def merchant_reference=(merchant_reference)
-      if !merchant_reference.nil? && merchant_reference.to_s.length > 100
+      if merchant_reference.nil?
+        fail ArgumentError, 'merchant_reference cannot be nil'
+      end
+
+      if merchant_reference.to_s.length > 100
         fail ArgumentError, 'invalid value for "merchant_reference", the character length must be smaller than or equal to 100.'
       end
 
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if merchant_reference !~ pattern
+        fail ArgumentError, "invalid value for \"merchant_reference\", must conform to the pattern #{pattern}."
+      end
+
       @merchant_reference = merchant_reference
     end
 
@@ -168,12 +222,12 @@ module PostFinanceCheckout
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          billing_address == o.billing_address &&
+          line_items == o.line_items &&
           due_on == o.due_on &&
           external_id == o.external_id &&
-          line_items == o.line_items &&
-          merchant_reference == o.merchant_reference &&
-          sent_to_customer == o.sent_to_customer
+          billing_address == o.billing_address &&
+          sent_to_customer == o.sent_to_customer &&
+          merchant_reference == o.merchant_reference
     end
 
     # @see the `==` method
@@ -183,39 +237,40 @@ module PostFinanceCheckout
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [billing_address, due_on, external_id, line_items, merchant_reference, sent_to_customer].hash
-    end
-
-    # Builds the object from hash
+      [line_items, due_on, external_id, billing_address, sent_to_customer, merchant_reference].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
@@ -224,7 +279,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
@@ -245,8 +300,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
 
@@ -268,7 +324,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
@@ -280,7 +340,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) }
@@ -291,6 +351,5 @@ module PostFinanceCheckout
         value
       end
     end
-
   end
 end