wallee-ruby-sdk 4.5.0 → 6.0.0

data/lib/wallee-ruby-sdk/models/token_create.rb

@@ -1,114 +1,165 @@
-=begin
-The wallee API allows an easy interaction with the wallee 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
+# Wallee AG Ruby SDK
+#
+# This library allows to interact with the Wallee AG payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://en.wallee.com
+# 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 Wallee
-  # 
+module WalleeRubySdk
   class TokenCreate
-    # The customer email address is the email address of the customer.
+    # Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
+    attr_accessor :enabled_for_one_click_payment
+
+    # The customer's email address.
     attr_accessor :customer_email_address
 
-    # The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.
+    # The reference used to identify the payment token (e.g. the customer's ID or email address).
+    attr_accessor :token_reference
+
+    # The unique identifier of the customer in the external system.
     attr_accessor :customer_id
 
-    # When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
-    attr_accessor :enabled_for_one_click_payment
+    # The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
+    attr_accessor :time_zone
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
-    attr_accessor :time_zone
-
-    # Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).
-    attr_accessor :token_reference
-
-    # 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.
+    # 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 object's current state.
     attr_accessor :state
 
+    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
       {
+        :'enabled_for_one_click_payment' => :'enabledForOneClickPayment',
         :'customer_email_address' => :'customerEmailAddress',
+        :'token_reference' => :'tokenReference',
         :'customer_id' => :'customerId',
-        :'enabled_for_one_click_payment' => :'enabledForOneClickPayment',
-        :'language' => :'language',
         :'time_zone' => :'timeZone',
-        :'token_reference' => :'tokenReference',
+        :'language' => :'language',
         :'external_id' => :'externalId',
         :'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
       {
+        :'enabled_for_one_click_payment' => :'Boolean',
         :'customer_email_address' => :'String',
+        :'token_reference' => :'String',
         :'customer_id' => :'String',
-        :'enabled_for_one_click_payment' => :'BOOLEAN',
-        :'language' => :'String',
         :'time_zone' => :'String',
-        :'token_reference' => :'String',
+        :'language' => :'String',
         :'external_id' => :'String',
         :'state' => :'CreationEntityState'
       }
     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
+      [
+      :'AbstractTokenUpdate'
+      ]
+    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 `WalleeRubySdk::TokenCreate` 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 `WalleeRubySdk::TokenCreate`. 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?(:'customerEmailAddress')
-        self.customer_email_address = attributes[:'customerEmailAddress']
+      if attributes.key?(:'enabled_for_one_click_payment')
+        self.enabled_for_one_click_payment = attributes[:'enabled_for_one_click_payment']
       end
 
-      if attributes.has_key?(:'customerId')
-        self.customer_id = attributes[:'customerId']
+      if attributes.key?(:'customer_email_address')
+        self.customer_email_address = attributes[:'customer_email_address']
       end
 
-      if attributes.has_key?(:'enabledForOneClickPayment')
-        self.enabled_for_one_click_payment = attributes[:'enabledForOneClickPayment']
+      if attributes.key?(:'token_reference')
+        self.token_reference = attributes[:'token_reference']
       end
 
-      if attributes.has_key?(:'language')
-        self.language = attributes[:'language']
+      if attributes.key?(:'customer_id')
+        self.customer_id = attributes[:'customer_id']
       end
 
-      if attributes.has_key?(:'timeZone')
-        self.time_zone = attributes[:'timeZone']
+      if attributes.key?(:'time_zone')
+        self.time_zone = attributes[:'time_zone']
       end
 
-      if attributes.has_key?(:'tokenReference')
-        self.token_reference = attributes[:'tokenReference']
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
       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?(:'state')
+      if attributes.key?(:'state')
         self.state = attributes[:'state']
       end
     end
@@ -116,6 +167,7 @@ module Wallee
     # 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 !@customer_email_address.nil? && @customer_email_address.to_s.length > 150
         invalid_properties.push('invalid value for "customer_email_address", the character length must be smaller than or equal to 150.')
@@ -125,6 +177,11 @@ module Wallee
         invalid_properties.push('invalid value for "token_reference", the character length must be smaller than or equal to 100.')
       end
 
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if !@token_reference.nil? && @token_reference !~ pattern
+        invalid_properties.push("invalid value for \"token_reference\", must conform to the pattern #{pattern}.")
+      end
+
       if @external_id.nil?
         invalid_properties.push('invalid value for "external_id", external_id cannot be nil.')
       end
@@ -135,8 +192,11 @@ module Wallee
     # 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 !@customer_email_address.nil? && @customer_email_address.to_s.length > 150
       return false if !@token_reference.nil? && @token_reference.to_s.length > 100
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      return false if !@token_reference.nil? && @token_reference !~ pattern
       return false if @external_id.nil?
       true
     end
@@ -144,7 +204,11 @@ module Wallee
     # Custom attribute writer method with validation
     # @param [Object] customer_email_address Value to be assigned
     def customer_email_address=(customer_email_address)
-      if !customer_email_address.nil? && customer_email_address.to_s.length > 150
+      if customer_email_address.nil?
+        fail ArgumentError, 'customer_email_address cannot be nil'
+      end
+
+      if customer_email_address.to_s.length > 150
         fail ArgumentError, 'invalid value for "customer_email_address", the character length must be smaller than or equal to 150.'
       end
 
@@ -154,10 +218,19 @@ module Wallee
     # Custom attribute writer method with validation
     # @param [Object] token_reference Value to be assigned
     def token_reference=(token_reference)
-      if !token_reference.nil? && token_reference.to_s.length > 100
+      if token_reference.nil?
+        fail ArgumentError, 'token_reference cannot be nil'
+      end
+
+      if token_reference.to_s.length > 100
         fail ArgumentError, 'invalid value for "token_reference", the character length must be smaller than or equal to 100.'
       end
 
+      pattern = Regexp.new(/[	\x20-\x7e]*/)
+      if token_reference !~ pattern
+        fail ArgumentError, "invalid value for \"token_reference\", must conform to the pattern #{pattern}."
+      end
+
       @token_reference = token_reference
     end
 
@@ -166,12 +239,12 @@ module Wallee
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          enabled_for_one_click_payment == o.enabled_for_one_click_payment &&
           customer_email_address == o.customer_email_address &&
+          token_reference == o.token_reference &&
           customer_id == o.customer_id &&
-          enabled_for_one_click_payment == o.enabled_for_one_click_payment &&
-          language == o.language &&
           time_zone == o.time_zone &&
-          token_reference == o.token_reference &&
+          language == o.language &&
           external_id == o.external_id &&
           state == o.state
     end
@@ -183,39 +256,40 @@ module Wallee
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [customer_email_address, customer_id, enabled_for_one_click_payment, language, time_zone, token_reference, external_id, state].hash
-    end
-
-    # Builds the object from hash
+      [enabled_for_one_click_payment, customer_email_address, token_reference, customer_id, time_zone, language, external_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
@@ -224,7 +298,7 @@ module Wallee
         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 +319,9 @@ module Wallee
           end
         end
       else # model
-        temp_model = Wallee.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = WalleeRubySdk.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 +343,11 @@ module Wallee
       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 +359,7 @@ module Wallee
     # @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 +370,5 @@ module Wallee
         value
       end
     end
-
   end
 end

data/lib/wallee-ruby-sdk/models/token_list_response.rb

@@ -0,0 +1,241 @@
+# Wallee AG Ruby SDK
+#
+# This library allows to interact with the Wallee AG payment service.
+#
+# Copyright owner: Wallee AG
+# Website: https://en.wallee.com
+# 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 WalleeRubySdk
+  class TokenListResponse
+    # An array containing the actual response objects.
+    attr_accessor :data
+
+    # Whether there are more objects available after this set. If false, there are no more objects to retrieve.
+    attr_accessor :has_more
+
+    # The applied limit on the number of objects returned.
+    attr_accessor :limit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'has_more' => :'hasMore',
+        :'limit' => :'limit'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'data' => :'Array<Token>',
+        :'has_more' => :'Boolean',
+        :'limit' => :'Integer'
+      }
+    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 = {})
+      unless attributes.is_a?(Hash)
+        fail ArgumentError, "The input argument (attributes) must be a hash in `WalleeRubySdk::TokenListResponse` initialize method"
+      end
+
+      # 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 `WalleeRubySdk::TokenListResponse`. 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.key?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'has_more')
+        self.has_more = attributes[:'has_more']
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      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
+      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'
+      true
+    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 &&
+          data == o.data &&
+          has_more == o.has_more &&
+          limit == o.limit
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [data, has_more, limit].hash
+    end    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      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 self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = WalleeRubySdk.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
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        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
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @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) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end