wallee-ruby-sdk 4.4.0 → 5.2.0

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

@@ -0,0 +1,201 @@
+=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
+
+require 'date'
+
+module Wallee
+  # 
+  class TaxLine
+    # 
+    attr_accessor :rate
+
+    # 
+    attr_accessor :title
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rate' => :'rate',
+        :'title' => :'title'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'rate' => :'Float',
+        :'title' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'rate')
+        self.rate = attributes[:'rate']
+      end
+
+      if attributes.has_key?(:'title')
+        self.title = attributes[:'title']
+      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
+      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?
+      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 &&
+          rate == o.rate &&
+          title == o.title
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [rate, title].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)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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) } )
+          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
+      end
+
+      self
+    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)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        temp_model = Wallee.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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

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

@@ -23,16 +23,16 @@ module Wallee
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # The customer email address is the email address of the customer.
+    # 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 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.
+    # 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
 
-    # 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
 
     # A unique identifier for the object.
@@ -50,10 +50,10 @@ module Wallee
     # The object's current state.
     attr_accessor :state
 
-    # 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.
+    # The customer's time zone, which affects how dates and times are formatted when communicating 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).
+    # The reference used to identify the payment token (e.g. the customer's ID or email address).
     attr_accessor :token_reference
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -20,25 +20,25 @@ require 'date'
 module Wallee
   # 
   class TokenCreate
-    # The customer email address is the email address of the customer.
+    # 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 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.
+    # 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 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.
+    # The customer's time zone, which affects how dates and times are formatted when communicating 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).
+    # The reference used to identify the payment token (e.g. the customer's ID or 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.

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

@@ -20,22 +20,22 @@ require 'date'
 module Wallee
   # 
   class TokenUpdate
-    # The customer email address is the email address of the customer.
+    # 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 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.
+    # 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 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.
+    # The customer's time zone, which affects how dates and times are formatted when communicating 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).
+    # The reference used to identify the payment token (e.g. the customer's ID or email address).
     attr_accessor :token_reference
 
     # The ID is the primary key of the entity. The ID identifies the entity uniquely.

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

@@ -20,28 +20,28 @@ require 'date'
 module Wallee
   # 
   class TokenVersion
-    # 
+    # The date and time when the token version was activated.
     attr_accessor :activated_on
 
-    # 
+    # The billing address to be used for the transaction if no explicit billing address is provided during payment processing.
     attr_accessor :billing_address
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The environment in which the token version was created.
     attr_accessor :environment
 
-    # The expires on date indicates when token version expires. Once this date is reached the token version is marked as obsolete.
+    # The date and time when the token version is set to expire, after which it will be marked as obsolete.
     attr_accessor :expires_on
 
-    # 
+    # The URL to the token's icon displayed to the customer.
     attr_accessor :icon_url
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The labels providing additional information about the object.
     attr_accessor :labels
 
     # The language that is linked to the object.
@@ -50,40 +50,40 @@ module Wallee
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The name used to identify the token.
     attr_accessor :name
 
-    # 
+    # The date and time when the token version was marked obsolete.
     attr_accessor :obsoleted_on
 
-    # 
+    # The payment connector configuration that initialized the token version.
     attr_accessor :payment_connector_configuration
 
-    # The payment information hash set contains hashes of the payment information represented by this token version.
+    # The hashed payment information that the token version represents.
     attr_accessor :payment_information_hashes
 
-    # 
+    # The payment method that initialized the token version.
     attr_accessor :payment_method
 
-    # 
+    # The payment method brand that initialized the token version.
     attr_accessor :payment_method_brand
 
     # 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 token name as specified by the processor.
     attr_accessor :processor_token
 
-    # 
+    # The shipping address to be used for the transaction if no explicit shipping address is provided during payment processing.
     attr_accessor :shipping_address
 
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The token that the token version belongs to.
     attr_accessor :token
 
-    # The token version type determines what kind of token it is and by which payment connector the token can be processed by.
+    # The type specifies the nature of the token and identifies the payment connector capable of processing it.
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -23,7 +23,7 @@ module Wallee
     # The localized description of the object.
     attr_accessor :description
 
-    # 
+    # The feature that the token version type belongs to.
     attr_accessor :feature
 
     # A unique identifier for the object.

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

@@ -18,21 +18,25 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # This model holds the card data in plain.
+  # 
   class TokenizedCardData
-    # The additional authentication value used to secure the tokenized card transactions.
+    # An additional authentication value that enhances the security of tokenized card transactions.
     attr_accessor :cryptogram
 
-    # 
+    # Whether the transaction is an initial recurring transaction, based on the recurring indicator. This is used to identify the first transaction in a recurring payment setup.
+    attr_accessor :initial_recurring_transaction
+
+    # The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.
     attr_accessor :recurring_indicator
 
-    # 
+    # The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.
     attr_accessor :token_requestor_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'cryptogram' => :'cryptogram',
+        :'initial_recurring_transaction' => :'initialRecurringTransaction',
         :'recurring_indicator' => :'recurringIndicator',
         :'token_requestor_id' => :'tokenRequestorId'
       }
@@ -42,6 +46,7 @@ module Wallee
     def self.swagger_types
       {
         :'cryptogram' => :'CardCryptogram',
+        :'initial_recurring_transaction' => :'BOOLEAN',
         :'recurring_indicator' => :'RecurringIndicator',
         :'token_requestor_id' => :'String'
       }
@@ -59,6 +64,10 @@ module Wallee
         self.cryptogram = attributes[:'cryptogram']
       end
 
+      if attributes.has_key?(:'initialRecurringTransaction')
+        self.initial_recurring_transaction = attributes[:'initialRecurringTransaction']
+      end
+
       if attributes.has_key?(:'recurringIndicator')
         self.recurring_indicator = attributes[:'recurringIndicator']
       end
@@ -87,6 +96,7 @@ module Wallee
       return true if self.equal?(o)
       self.class == o.class &&
           cryptogram == o.cryptogram &&
+          initial_recurring_transaction == o.initial_recurring_transaction &&
           recurring_indicator == o.recurring_indicator &&
           token_requestor_id == o.token_requestor_id
     end
@@ -100,7 +110,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cryptogram, recurring_indicator, token_requestor_id].hash
+      [cryptogram, initial_recurring_transaction, recurring_indicator, token_requestor_id].hash
     end
 
     # Builds the object from hash

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

@@ -18,30 +18,33 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # This model holds the card data in plain.
+  # 
   class TokenizedCardDataCreate
-    # The card holder name is the name printed onto the card. It identifies the person who owns the card.
+    # The name of the cardholder, as printed on the card, identifying the card owner.
     attr_accessor :card_holder_name
 
-    # The card verification code (CVC) is a 3 to 4 digit code typically printed on the back of the card. It helps to ensure that the card holder is authorizing the transaction. For card not-present transactions this field is optional.
+    # The security code used to validate the card during transactions.
     attr_accessor :card_verification_code
 
-    # The additional authentication value used to secure the tokenized card transactions.
+    # An additional authentication value that enhances the security of tokenized card transactions.
     attr_accessor :cryptogram
 
-    # The card expiry date indicates when the card expires. The format is the format yyyy-mm where yyyy is the year (e.g. 2019) and the mm is the month (e.g. 09).
+    # The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).
     attr_accessor :expiry_date
 
-    # The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
+    # The type of PAN or token, indicating the source or security method of the card information.
+    attr_accessor :pan_type
+
+    # The card's primary account number (PAN), the unique identifier of the card.
     attr_accessor :primary_account_number
 
-    # 
+    # The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.
     attr_accessor :recurring_indicator
 
-    # 
+    # A reference specific to the card's transaction within its payment scheme.
     attr_accessor :scheme_transaction_reference
 
-    # 
+    # The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.
     attr_accessor :token_requestor_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -51,6 +54,7 @@ module Wallee
         :'card_verification_code' => :'cardVerificationCode',
         :'cryptogram' => :'cryptogram',
         :'expiry_date' => :'expiryDate',
+        :'pan_type' => :'panType',
         :'primary_account_number' => :'primaryAccountNumber',
         :'recurring_indicator' => :'recurringIndicator',
         :'scheme_transaction_reference' => :'schemeTransactionReference',
@@ -65,6 +69,7 @@ module Wallee
         :'card_verification_code' => :'String',
         :'cryptogram' => :'CardCryptogramCreate',
         :'expiry_date' => :'String',
+        :'pan_type' => :'PanType',
         :'primary_account_number' => :'String',
         :'recurring_indicator' => :'RecurringIndicator',
         :'scheme_transaction_reference' => :'String',
@@ -96,6 +101,10 @@ module Wallee
         self.expiry_date = attributes[:'expiryDate']
       end
 
+      if attributes.has_key?(:'panType')
+        self.pan_type = attributes[:'panType']
+      end
+
       if attributes.has_key?(:'primaryAccountNumber')
         self.primary_account_number = attributes[:'primaryAccountNumber']
       end
@@ -222,6 +231,7 @@ module Wallee
           card_verification_code == o.card_verification_code &&
           cryptogram == o.cryptogram &&
           expiry_date == o.expiry_date &&
+          pan_type == o.pan_type &&
           primary_account_number == o.primary_account_number &&
           recurring_indicator == o.recurring_indicator &&
           scheme_transaction_reference == o.scheme_transaction_reference &&
@@ -237,7 +247,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [card_holder_name, card_verification_code, cryptogram, expiry_date, primary_account_number, recurring_indicator, scheme_transaction_reference, token_requestor_id].hash
+      [card_holder_name, card_verification_code, cryptogram, expiry_date, pan_type, primary_account_number, recurring_indicator, scheme_transaction_reference, token_requestor_id].hash
     end
 
     # Builds the object from hash