wallee-ruby-sdk 2.2.4 → 3.0.6

data/lib/wallee-ruby-sdk/api_client.rb

@@ -147,7 +147,8 @@ module Wallee
     # @return [Hash] the authentication headers
     def get_authentication_headers(http_method, path, query)
       base_url = URI(@config.base_url)
-      completed_path = "#{base_url.path}#{path}"+'?'+query.map{|k,v| "#{k}=#{v}"}.join('&')
+      completed_path = "#{base_url.path}#{path}"
+      completed_path += "?" + query.map{|k,v| "#{k}=#{v}"}.join('&') unless query.empty?
       version = "1"
       timestamp = Time.now.to_i
       securedData = "#{version}|#{@config.user_id}|#{timestamp}|#{http_method.upcase}|#{completed_path}"

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

@@ -31,8 +31,8 @@ module Wallee
     # The available from date defines the latest date on which the payment link can be used to initialize a transaction. When no date is specified there will be no restriction.
     attr_accessor :available_until
 
-    # By making the billing address required the transaction can only be created when a billing address is provided within the request.
-    attr_accessor :billing_address_required
+    # The billing address handling mode controls if the address is collected or not and how it is collected.
+    attr_accessor :billing_address_handling_mode
 
     # The currency defines in which currency the payment is executed in. If no currency is defined it has to be specified within the request parameter 'currency'.
     attr_accessor :currency
@@ -49,8 +49,8 @@ module Wallee
     # The payment link name is used internally to identify the payment link. For example the name is used within search fields and hence it should be distinct and descriptive.
     attr_accessor :name
 
-    # By making the shipping address required the transaction can only be created when a shipping address is provided within the request.
-    attr_accessor :shipping_address_required
+    # The shipping address handling mode controls if the address is collected or not and how it is collected.
+    attr_accessor :shipping_address_handling_mode
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -59,13 +59,13 @@ module Wallee
         :'applied_space_view' => :'appliedSpaceView',
         :'available_from' => :'availableFrom',
         :'available_until' => :'availableUntil',
-        :'billing_address_required' => :'billingAddressRequired',
+        :'billing_address_handling_mode' => :'billingAddressHandlingMode',
         :'currency' => :'currency',
         :'language' => :'language',
         :'line_items' => :'lineItems',
         :'maximal_number_of_transactions' => :'maximalNumberOfTransactions',
         :'name' => :'name',
-        :'shipping_address_required' => :'shippingAddressRequired'
+        :'shipping_address_handling_mode' => :'shippingAddressHandlingMode'
       }
     end
 
@@ -76,13 +76,13 @@ module Wallee
         :'applied_space_view' => :'Integer',
         :'available_from' => :'DateTime',
         :'available_until' => :'DateTime',
-        :'billing_address_required' => :'BOOLEAN',
+        :'billing_address_handling_mode' => :'PaymentLinkAddressHandlingMode',
         :'currency' => :'String',
         :'language' => :'String',
         :'line_items' => :'Array<LineItemCreate>',
         :'maximal_number_of_transactions' => :'Integer',
         :'name' => :'String',
-        :'shipping_address_required' => :'BOOLEAN'
+        :'shipping_address_handling_mode' => :'PaymentLinkAddressHandlingMode'
       }
     end
 
@@ -112,8 +112,8 @@ module Wallee
         self.available_until = attributes[:'availableUntil']
       end
 
-      if attributes.has_key?(:'billingAddressRequired')
-        self.billing_address_required = attributes[:'billingAddressRequired']
+      if attributes.has_key?(:'billingAddressHandlingMode')
+        self.billing_address_handling_mode = attributes[:'billingAddressHandlingMode']
       end
 
       if attributes.has_key?(:'currency')
@@ -138,8 +138,8 @@ module Wallee
         self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'shippingAddressRequired')
-        self.shipping_address_required = attributes[:'shippingAddressRequired']
+      if attributes.has_key?(:'shippingAddressHandlingMode')
+        self.shipping_address_handling_mode = attributes[:'shippingAddressHandlingMode']
       end
     end
 
@@ -180,13 +180,13 @@ module Wallee
           applied_space_view == o.applied_space_view &&
           available_from == o.available_from &&
           available_until == o.available_until &&
-          billing_address_required == o.billing_address_required &&
+          billing_address_handling_mode == o.billing_address_handling_mode &&
           currency == o.currency &&
           language == o.language &&
           line_items == o.line_items &&
           maximal_number_of_transactions == o.maximal_number_of_transactions &&
           name == o.name &&
-          shipping_address_required == o.shipping_address_required
+          shipping_address_handling_mode == o.shipping_address_handling_mode
     end
 
     # @see the `==` method
@@ -198,7 +198,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allowed_payment_method_configurations, applied_space_view, available_from, available_until, billing_address_required, currency, language, line_items, maximal_number_of_transactions, name, shipping_address_required].hash
+      [allowed_payment_method_configurations, applied_space_view, available_from, available_until, billing_address_handling_mode, currency, language, line_items, maximal_number_of_transactions, name, shipping_address_handling_mode].hash
     end
 
     # Builds the object from hash

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

@@ -28,6 +28,9 @@ module Wallee
     # The product name is used internally to identify the configuration in administrative interfaces. For example it is used within search fields and hence it should be distinct and descriptive.
     attr_accessor :name
 
+    # Marks the product as locked. Meaning that customer can not change away from this product or change to this product later on.
+    attr_accessor :product_locked
+
     # The sort order controls in which order the product is listed. The sort order is used to order the products in ascending order.
     attr_accessor :sort_order
 
@@ -40,6 +43,7 @@ module Wallee
         :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
         :'failed_payment_suspension_period' => :'failedPaymentSuspensionPeriod',
         :'name' => :'name',
+        :'product_locked' => :'productLocked',
         :'sort_order' => :'sortOrder',
         :'state' => :'state'
       }
@@ -51,6 +55,7 @@ module Wallee
         :'allowed_payment_method_configurations' => :'Array<Integer>',
         :'failed_payment_suspension_period' => :'String',
         :'name' => :'String',
+        :'product_locked' => :'BOOLEAN',
         :'sort_order' => :'Integer',
         :'state' => :'SubscriptionProductState'
       }
@@ -78,6 +83,10 @@ module Wallee
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'productLocked')
+        self.product_locked = attributes[:'productLocked']
+      end
+
       if attributes.has_key?(:'sortOrder')
         self.sort_order = attributes[:'sortOrder']
       end
@@ -123,6 +132,7 @@ module Wallee
           allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
           failed_payment_suspension_period == o.failed_payment_suspension_period &&
           name == o.name &&
+          product_locked == o.product_locked &&
           sort_order == o.sort_order &&
           state == o.state
     end
@@ -136,7 +146,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [allowed_payment_method_configurations, failed_payment_suspension_period, name, sort_order, state].hash
+      [allowed_payment_method_configurations, failed_payment_suspension_period, name, product_locked, sort_order, state].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,221 @@
+=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
+  # This model holds the card data and optional cardholder authentication details.
+  class AuthenticatedCardData
+    # The additional authentication value used to secure the tokenized card transactions.
+    attr_accessor :cryptogram
+
+    # 
+    attr_accessor :recurring_indicator
+
+    # 
+    attr_accessor :token_requestor_id
+
+    # The cardholder authentication information. The authentication is optional and can be provided if the cardholder has been already authenticated (e.g. in 3-D Secure system).
+    attr_accessor :cardholder_authentication
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cryptogram' => :'cryptogram',
+        :'recurring_indicator' => :'recurringIndicator',
+        :'token_requestor_id' => :'tokenRequestorId',
+        :'cardholder_authentication' => :'cardholderAuthentication'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'cryptogram' => :'CardCryptogram',
+        :'recurring_indicator' => :'RecurringIndicator',
+        :'token_requestor_id' => :'String',
+        :'cardholder_authentication' => :'CardholderAuthentication'
+      }
+    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?(:'cryptogram')
+        self.cryptogram = attributes[:'cryptogram']
+      end
+
+      if attributes.has_key?(:'recurringIndicator')
+        self.recurring_indicator = attributes[:'recurringIndicator']
+      end
+
+      if attributes.has_key?(:'tokenRequestorId')
+        self.token_requestor_id = attributes[:'tokenRequestorId']
+      end
+
+      if attributes.has_key?(:'cardholderAuthentication')
+        self.cardholder_authentication = attributes[:'cardholderAuthentication']
+      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 &&
+          cryptogram == o.cryptogram &&
+          recurring_indicator == o.recurring_indicator &&
+          token_requestor_id == o.token_requestor_id &&
+          cardholder_authentication == o.cardholder_authentication
+    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
+      [cryptogram, recurring_indicator, token_requestor_id, cardholder_authentication].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/{unencrypted_card_data.rb → authenticated_card_data_create.rb}

@@ -18,27 +18,47 @@ limitations under the License.
 require 'date'
 
 module Wallee
-  # This model holds the card data in plain.
-  class UnencryptedCardData
+  # This model holds the card data and optional cardholder authentication details.
+  class AuthenticatedCardDataCreate
     # The card holder name is the name printed onto the card. It identifies the person who owns the card.
     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.
     attr_accessor :card_verification_code
 
+    # The cardholder authentication information. The authentication is optional and can be provided if the cardholder has been already authenticated (e.g. in 3-D Secure system).
+    attr_accessor :cardholder_authentication
+
+    # The additional authentication value used to secure the 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).
     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.
     attr_accessor :primary_account_number
 
+    # 
+    attr_accessor :recurring_indicator
+
+    # 
+    attr_accessor :scheme_transaction_reference
+
+    # 
+    attr_accessor :token_requestor_id
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'card_holder_name' => :'cardHolderName',
         :'card_verification_code' => :'cardVerificationCode',
+        :'cardholder_authentication' => :'cardholderAuthentication',
+        :'cryptogram' => :'cryptogram',
         :'expiry_date' => :'expiryDate',
-        :'primary_account_number' => :'primaryAccountNumber'
+        :'primary_account_number' => :'primaryAccountNumber',
+        :'recurring_indicator' => :'recurringIndicator',
+        :'scheme_transaction_reference' => :'schemeTransactionReference',
+        :'token_requestor_id' => :'tokenRequestorId'
       }
     end
 
@@ -47,8 +67,13 @@ module Wallee
       {
         :'card_holder_name' => :'String',
         :'card_verification_code' => :'String',
+        :'cardholder_authentication' => :'CardholderAuthenticationCreate',
+        :'cryptogram' => :'CardCryptogramCreate',
         :'expiry_date' => :'String',
-        :'primary_account_number' => :'String'
+        :'primary_account_number' => :'String',
+        :'recurring_indicator' => :'RecurringIndicator',
+        :'scheme_transaction_reference' => :'String',
+        :'token_requestor_id' => :'String'
       }
     end
 
@@ -68,6 +93,14 @@ module Wallee
         self.card_verification_code = attributes[:'cardVerificationCode']
       end
 
+      if attributes.has_key?(:'cardholderAuthentication')
+        self.cardholder_authentication = attributes[:'cardholderAuthentication']
+      end
+
+      if attributes.has_key?(:'cryptogram')
+        self.cryptogram = attributes[:'cryptogram']
+      end
+
       if attributes.has_key?(:'expiryDate')
         self.expiry_date = attributes[:'expiryDate']
       end
@@ -75,6 +108,18 @@ module Wallee
       if attributes.has_key?(:'primaryAccountNumber')
         self.primary_account_number = attributes[:'primaryAccountNumber']
       end
+
+      if attributes.has_key?(:'recurringIndicator')
+        self.recurring_indicator = attributes[:'recurringIndicator']
+      end
+
+      if attributes.has_key?(:'schemeTransactionReference')
+        self.scheme_transaction_reference = attributes[:'schemeTransactionReference']
+      end
+
+      if attributes.has_key?(:'tokenRequestorId')
+        self.token_requestor_id = attributes[:'tokenRequestorId']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -93,14 +138,22 @@ module Wallee
         invalid_properties.push('invalid value for "card_verification_code", the character length must be great than or equal to 3.')
       end
 
-      if !@primary_account_number.nil? && @primary_account_number.to_s.length > 30
+      if @primary_account_number.nil?
+        invalid_properties.push('invalid value for "primary_account_number", primary_account_number cannot be nil.')
+      end
+
+      if @primary_account_number.to_s.length > 30
         invalid_properties.push('invalid value for "primary_account_number", the character length must be smaller than or equal to 30.')
       end
 
-      if !@primary_account_number.nil? && @primary_account_number.to_s.length < 10
+      if @primary_account_number.to_s.length < 10
         invalid_properties.push('invalid value for "primary_account_number", the character length must be great than or equal to 10.')
       end
 
+      if !@scheme_transaction_reference.nil? && @scheme_transaction_reference.to_s.length > 100
+        invalid_properties.push('invalid value for "scheme_transaction_reference", the character length must be smaller than or equal to 100.')
+      end
+
       invalid_properties
     end
 
@@ -110,8 +163,10 @@ module Wallee
       return false if !@card_holder_name.nil? && @card_holder_name.to_s.length > 100
       return false if !@card_verification_code.nil? && @card_verification_code.to_s.length > 4
       return false if !@card_verification_code.nil? && @card_verification_code.to_s.length < 3
-      return false if !@primary_account_number.nil? && @primary_account_number.to_s.length > 30
-      return false if !@primary_account_number.nil? && @primary_account_number.to_s.length < 10
+      return false if @primary_account_number.nil?
+      return false if @primary_account_number.to_s.length > 30
+      return false if @primary_account_number.to_s.length < 10
+      return false if !@scheme_transaction_reference.nil? && @scheme_transaction_reference.to_s.length > 100
       true
     end
 
@@ -142,17 +197,31 @@ module Wallee
     # Custom attribute writer method with validation
     # @param [Object] primary_account_number Value to be assigned
     def primary_account_number=(primary_account_number)
-      if !primary_account_number.nil? && primary_account_number.to_s.length > 30
+      if primary_account_number.nil?
+        fail ArgumentError, 'primary_account_number cannot be nil'
+      end
+
+      if primary_account_number.to_s.length > 30
         fail ArgumentError, 'invalid value for "primary_account_number", the character length must be smaller than or equal to 30.'
       end
 
-      if !primary_account_number.nil? && primary_account_number.to_s.length < 10
+      if primary_account_number.to_s.length < 10
         fail ArgumentError, 'invalid value for "primary_account_number", the character length must be great than or equal to 10.'
       end
 
       @primary_account_number = primary_account_number
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] scheme_transaction_reference Value to be assigned
+    def scheme_transaction_reference=(scheme_transaction_reference)
+      if !scheme_transaction_reference.nil? && scheme_transaction_reference.to_s.length > 100
+        fail ArgumentError, 'invalid value for "scheme_transaction_reference", the character length must be smaller than or equal to 100.'
+      end
+
+      @scheme_transaction_reference = scheme_transaction_reference
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -160,8 +229,13 @@ module Wallee
       self.class == o.class &&
           card_holder_name == o.card_holder_name &&
           card_verification_code == o.card_verification_code &&
+          cardholder_authentication == o.cardholder_authentication &&
+          cryptogram == o.cryptogram &&
           expiry_date == o.expiry_date &&
-          primary_account_number == o.primary_account_number
+          primary_account_number == o.primary_account_number &&
+          recurring_indicator == o.recurring_indicator &&
+          scheme_transaction_reference == o.scheme_transaction_reference &&
+          token_requestor_id == o.token_requestor_id
     end
 
     # @see the `==` method
@@ -173,7 +247,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [card_holder_name, card_verification_code, expiry_date, primary_account_number].hash
+      [card_holder_name, card_verification_code, cardholder_authentication, cryptogram, expiry_date, primary_account_number, recurring_indicator, scheme_transaction_reference, token_requestor_id].hash
     end
 
     # Builds the object from hash