wallee-ruby-sdk 2.0.1 → 3.0.4

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

@@ -1,10 +1,6 @@
 =begin
-wallee API: 2.0.1
-
 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
@@ -42,6 +38,9 @@ module Wallee
     # The environment in which this transaction was successfully authorized.
     attr_accessor :authorization_environment
 
+    # The sales channel through which the transaction was placed.
+    attr_accessor :authorization_sales_channel
+
     # This is the time on which the transaction will be timed out when it is not at least authorized. The timeout time may change over time.
     attr_accessor :authorization_timeout_on
 
@@ -63,6 +62,9 @@ module Wallee
     # 
     attr_accessor :completed_on
 
+    # The completion behavior controls when the transaction is completed.
+    attr_accessor :completion_behavior
+
     # 
     attr_accessor :completion_timeout_on
 
@@ -96,6 +98,9 @@ module Wallee
     # The device session identifier links the transaction with the session identifier provided in the URL of the device data JavaScript. This allows to link the transaction with the collected device data of the buyer.
     attr_accessor :device_session_identifier
 
+    # Flag indicating whether email sending is disabled for this particular transaction. Defaults to false.
+    attr_accessor :emails_disabled
+
     # The transaction's end of life indicates the date from which on no operation can be carried out anymore.
     attr_accessor :end_of_life
 
@@ -129,6 +134,9 @@ module Wallee
     # 
     attr_accessor :invoice_merchant_reference
 
+    # 
+    attr_accessor :java_enabled
+
     # 
     attr_accessor :language
 
@@ -159,6 +167,15 @@ module Wallee
     # The refunded amount is the total amount which has been refunded so far.
     attr_accessor :refunded_amount
 
+    # 
+    attr_accessor :screen_color_depth
+
+    # 
+    attr_accessor :screen_height
+
+    # 
+    attr_accessor :screen_width
+
     # 
     attr_accessor :shipping_address
 
@@ -174,6 +191,9 @@ module Wallee
     # The user will be redirected to success URL when the transaction could be authorized or completed. In case no success URL is specified a default success page will be displayed.
     attr_accessor :success_url
 
+    # The terminal on which the payment was processed.
+    attr_accessor :terminal
+
     # 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
 
@@ -183,6 +203,12 @@ module Wallee
     # The tokenization mode controls if and how the tokenization of payment information is applied to the transaction.
     attr_accessor :tokenization_mode
 
+    # The total applied fees is the sum of all fees that have been applied so far.
+    attr_accessor :total_applied_fees
+
+    # The total settled amount is the total amount which has been settled so far.
+    attr_accessor :total_settled_amount
+
     # The user agent header provides the exact string which contains the user agent of the buyer.
     attr_accessor :user_agent_header
 
@@ -195,6 +221,12 @@ module Wallee
     # The version number indicates the version of the entity. The version is incremented whenever the entity is changed.
     attr_accessor :version
 
+    # 
+    attr_accessor :window_height
+
+    # 
+    attr_accessor :window_width
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -204,6 +236,7 @@ module Wallee
         :'allowed_payment_method_configurations' => :'allowedPaymentMethodConfigurations',
         :'authorization_amount' => :'authorizationAmount',
         :'authorization_environment' => :'authorizationEnvironment',
+        :'authorization_sales_channel' => :'authorizationSalesChannel',
         :'authorization_timeout_on' => :'authorizationTimeoutOn',
         :'authorized_on' => :'authorizedOn',
         :'auto_confirmation_enabled' => :'autoConfirmationEnabled',
@@ -211,6 +244,7 @@ module Wallee
         :'charge_retry_enabled' => :'chargeRetryEnabled',
         :'completed_amount' => :'completedAmount',
         :'completed_on' => :'completedOn',
+        :'completion_behavior' => :'completionBehavior',
         :'completion_timeout_on' => :'completionTimeoutOn',
         :'confirmed_by' => :'confirmedBy',
         :'confirmed_on' => :'confirmedOn',
@@ -222,6 +256,7 @@ module Wallee
         :'customers_presence' => :'customersPresence',
         :'delivery_decision_made_on' => :'deliveryDecisionMadeOn',
         :'device_session_identifier' => :'deviceSessionIdentifier',
+        :'emails_disabled' => :'emailsDisabled',
         :'end_of_life' => :'endOfLife',
         :'environment' => :'environment',
         :'environment_selection_strategy' => :'environmentSelectionStrategy',
@@ -233,6 +268,7 @@ module Wallee
         :'internet_protocol_address' => :'internetProtocolAddress',
         :'internet_protocol_address_country' => :'internetProtocolAddressCountry',
         :'invoice_merchant_reference' => :'invoiceMerchantReference',
+        :'java_enabled' => :'javaEnabled',
         :'language' => :'language',
         :'line_items' => :'lineItems',
         :'linked_space_id' => :'linkedSpaceId',
@@ -243,18 +279,26 @@ module Wallee
         :'planned_purge_date' => :'plannedPurgeDate',
         :'processing_on' => :'processingOn',
         :'refunded_amount' => :'refundedAmount',
+        :'screen_color_depth' => :'screenColorDepth',
+        :'screen_height' => :'screenHeight',
+        :'screen_width' => :'screenWidth',
         :'shipping_address' => :'shippingAddress',
         :'shipping_method' => :'shippingMethod',
         :'space_view_id' => :'spaceViewId',
         :'state' => :'state',
         :'success_url' => :'successUrl',
+        :'terminal' => :'terminal',
         :'time_zone' => :'timeZone',
         :'token' => :'token',
         :'tokenization_mode' => :'tokenizationMode',
+        :'total_applied_fees' => :'totalAppliedFees',
+        :'total_settled_amount' => :'totalSettledAmount',
         :'user_agent_header' => :'userAgentHeader',
         :'user_failure_message' => :'userFailureMessage',
         :'user_interface_type' => :'userInterfaceType',
-        :'version' => :'version'
+        :'version' => :'version',
+        :'window_height' => :'windowHeight',
+        :'window_width' => :'windowWidth'
       }
     end
 
@@ -267,6 +311,7 @@ module Wallee
         :'allowed_payment_method_configurations' => :'Array<Integer>',
         :'authorization_amount' => :'Float',
         :'authorization_environment' => :'ChargeAttemptEnvironment',
+        :'authorization_sales_channel' => :'Integer',
         :'authorization_timeout_on' => :'DateTime',
         :'authorized_on' => :'DateTime',
         :'auto_confirmation_enabled' => :'BOOLEAN',
@@ -274,6 +319,7 @@ module Wallee
         :'charge_retry_enabled' => :'BOOLEAN',
         :'completed_amount' => :'Float',
         :'completed_on' => :'DateTime',
+        :'completion_behavior' => :'TransactionCompletionBehavior',
         :'completion_timeout_on' => :'DateTime',
         :'confirmed_by' => :'Integer',
         :'confirmed_on' => :'DateTime',
@@ -285,6 +331,7 @@ module Wallee
         :'customers_presence' => :'CustomersPresence',
         :'delivery_decision_made_on' => :'DateTime',
         :'device_session_identifier' => :'String',
+        :'emails_disabled' => :'BOOLEAN',
         :'end_of_life' => :'DateTime',
         :'environment' => :'Environment',
         :'environment_selection_strategy' => :'TransactionEnvironmentSelectionStrategy',
@@ -296,6 +343,7 @@ module Wallee
         :'internet_protocol_address' => :'String',
         :'internet_protocol_address_country' => :'String',
         :'invoice_merchant_reference' => :'String',
+        :'java_enabled' => :'BOOLEAN',
         :'language' => :'String',
         :'line_items' => :'Array<LineItem>',
         :'linked_space_id' => :'Integer',
@@ -306,18 +354,26 @@ module Wallee
         :'planned_purge_date' => :'DateTime',
         :'processing_on' => :'DateTime',
         :'refunded_amount' => :'Float',
+        :'screen_color_depth' => :'String',
+        :'screen_height' => :'String',
+        :'screen_width' => :'String',
         :'shipping_address' => :'Address',
         :'shipping_method' => :'String',
         :'space_view_id' => :'Integer',
         :'state' => :'TransactionState',
         :'success_url' => :'String',
+        :'terminal' => :'PaymentTerminal',
         :'time_zone' => :'String',
         :'token' => :'Token',
         :'tokenization_mode' => :'TokenizationMode',
+        :'total_applied_fees' => :'Float',
+        :'total_settled_amount' => :'Float',
         :'user_agent_header' => :'String',
         :'user_failure_message' => :'String',
         :'user_interface_type' => :'TransactionUserInterfaceType',
-        :'version' => :'Integer'
+        :'version' => :'Integer',
+        :'window_height' => :'String',
+        :'window_width' => :'String'
       }
     end
 
@@ -357,6 +413,10 @@ module Wallee
         self.authorization_environment = attributes[:'authorizationEnvironment']
       end
 
+      if attributes.has_key?(:'authorizationSalesChannel')
+        self.authorization_sales_channel = attributes[:'authorizationSalesChannel']
+      end
+
       if attributes.has_key?(:'authorizationTimeoutOn')
         self.authorization_timeout_on = attributes[:'authorizationTimeoutOn']
       end
@@ -385,6 +445,10 @@ module Wallee
         self.completed_on = attributes[:'completedOn']
       end
 
+      if attributes.has_key?(:'completionBehavior')
+        self.completion_behavior = attributes[:'completionBehavior']
+      end
+
       if attributes.has_key?(:'completionTimeoutOn')
         self.completion_timeout_on = attributes[:'completionTimeoutOn']
       end
@@ -429,6 +493,10 @@ module Wallee
         self.device_session_identifier = attributes[:'deviceSessionIdentifier']
       end
 
+      if attributes.has_key?(:'emailsDisabled')
+        self.emails_disabled = attributes[:'emailsDisabled']
+      end
+
       if attributes.has_key?(:'endOfLife')
         self.end_of_life = attributes[:'endOfLife']
       end
@@ -473,6 +541,10 @@ module Wallee
         self.invoice_merchant_reference = attributes[:'invoiceMerchantReference']
       end
 
+      if attributes.has_key?(:'javaEnabled')
+        self.java_enabled = attributes[:'javaEnabled']
+      end
+
       if attributes.has_key?(:'language')
         self.language = attributes[:'language']
       end
@@ -517,6 +589,18 @@ module Wallee
         self.refunded_amount = attributes[:'refundedAmount']
       end
 
+      if attributes.has_key?(:'screenColorDepth')
+        self.screen_color_depth = attributes[:'screenColorDepth']
+      end
+
+      if attributes.has_key?(:'screenHeight')
+        self.screen_height = attributes[:'screenHeight']
+      end
+
+      if attributes.has_key?(:'screenWidth')
+        self.screen_width = attributes[:'screenWidth']
+      end
+
       if attributes.has_key?(:'shippingAddress')
         self.shipping_address = attributes[:'shippingAddress']
       end
@@ -537,6 +621,10 @@ module Wallee
         self.success_url = attributes[:'successUrl']
       end
 
+      if attributes.has_key?(:'terminal')
+        self.terminal = attributes[:'terminal']
+      end
+
       if attributes.has_key?(:'timeZone')
         self.time_zone = attributes[:'timeZone']
       end
@@ -549,6 +637,14 @@ module Wallee
         self.tokenization_mode = attributes[:'tokenizationMode']
       end
 
+      if attributes.has_key?(:'totalAppliedFees')
+        self.total_applied_fees = attributes[:'totalAppliedFees']
+      end
+
+      if attributes.has_key?(:'totalSettledAmount')
+        self.total_settled_amount = attributes[:'totalSettledAmount']
+      end
+
       if attributes.has_key?(:'userAgentHeader')
         self.user_agent_header = attributes[:'userAgentHeader']
       end
@@ -564,21 +660,161 @@ module Wallee
       if attributes.has_key?(:'version')
         self.version = attributes[:'version']
       end
+
+      if attributes.has_key?(:'windowHeight')
+        self.window_height = attributes[:'windowHeight']
+      end
+
+      if attributes.has_key?(:'windowWidth')
+        self.window_width = attributes[:'windowWidth']
+      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
+      if !@customer_email_address.nil? && @customer_email_address.to_s.length > 254
+        invalid_properties.push('invalid value for "customer_email_address", the character length must be smaller than or equal to 254.')
+      end
+
+      if !@device_session_identifier.nil? && @device_session_identifier.to_s.length > 40
+        invalid_properties.push('invalid value for "device_session_identifier", the character length must be smaller than or equal to 40.')
+      end
+
+      if !@device_session_identifier.nil? && @device_session_identifier.to_s.length < 10
+        invalid_properties.push('invalid value for "device_session_identifier", the character length must be great than or equal to 10.')
+      end
+
+      if !@failed_url.nil? && @failed_url.to_s.length > 1000
+        invalid_properties.push('invalid value for "failed_url", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@failed_url.nil? && @failed_url.to_s.length < 9
+        invalid_properties.push('invalid value for "failed_url", the character length must be great than or equal to 9.')
+      end
+
+      if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
+        invalid_properties.push('invalid value for "invoice_merchant_reference", the character length must be smaller than or equal to 100.')
+      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
+
+      if !@shipping_method.nil? && @shipping_method.to_s.length > 200
+        invalid_properties.push('invalid value for "shipping_method", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@success_url.nil? && @success_url.to_s.length > 1000
+        invalid_properties.push('invalid value for "success_url", the character length must be smaller than or equal to 1000.')
+      end
+
+      if !@success_url.nil? && @success_url.to_s.length < 9
+        invalid_properties.push('invalid value for "success_url", the character length must be great than or equal to 9.')
+      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?
+      return false if !@customer_email_address.nil? && @customer_email_address.to_s.length > 254
+      return false if !@device_session_identifier.nil? && @device_session_identifier.to_s.length > 40
+      return false if !@device_session_identifier.nil? && @device_session_identifier.to_s.length < 10
+      return false if !@failed_url.nil? && @failed_url.to_s.length > 1000
+      return false if !@failed_url.nil? && @failed_url.to_s.length < 9
+      return false if !@invoice_merchant_reference.nil? && @invoice_merchant_reference.to_s.length > 100
+      return false if !@merchant_reference.nil? && @merchant_reference.to_s.length > 100
+      return false if !@shipping_method.nil? && @shipping_method.to_s.length > 200
+      return false if !@success_url.nil? && @success_url.to_s.length > 1000
+      return false if !@success_url.nil? && @success_url.to_s.length < 9
       true
     end
 
+    # 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 > 254
+        fail ArgumentError, 'invalid value for "customer_email_address", the character length must be smaller than or equal to 254.'
+      end
+
+      @customer_email_address = customer_email_address
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] device_session_identifier Value to be assigned
+    def device_session_identifier=(device_session_identifier)
+      if !device_session_identifier.nil? && device_session_identifier.to_s.length > 40
+        fail ArgumentError, 'invalid value for "device_session_identifier", the character length must be smaller than or equal to 40.'
+      end
+
+      if !device_session_identifier.nil? && device_session_identifier.to_s.length < 10
+        fail ArgumentError, 'invalid value for "device_session_identifier", the character length must be great than or equal to 10.'
+      end
+
+      @device_session_identifier = device_session_identifier
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] failed_url Value to be assigned
+    def failed_url=(failed_url)
+      if !failed_url.nil? && failed_url.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "failed_url", the character length must be smaller than or equal to 1000.'
+      end
+
+      if !failed_url.nil? && failed_url.to_s.length < 9
+        fail ArgumentError, 'invalid value for "failed_url", the character length must be great than or equal to 9.'
+      end
+
+      @failed_url = failed_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_merchant_reference Value to be assigned
+    def invoice_merchant_reference=(invoice_merchant_reference)
+      if !invoice_merchant_reference.nil? && invoice_merchant_reference.to_s.length > 100
+        fail ArgumentError, 'invalid value for "invoice_merchant_reference", the character length must be smaller than or equal to 100.'
+      end
+
+      @invoice_merchant_reference = invoice_merchant_reference
+    end
+
+    # 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
+        fail ArgumentError, 'invalid value for "merchant_reference", the character length must be smaller than or equal to 100.'
+      end
+
+      @merchant_reference = merchant_reference
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shipping_method Value to be assigned
+    def shipping_method=(shipping_method)
+      if !shipping_method.nil? && shipping_method.to_s.length > 200
+        fail ArgumentError, 'invalid value for "shipping_method", the character length must be smaller than or equal to 200.'
+      end
+
+      @shipping_method = shipping_method
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] success_url Value to be assigned
+    def success_url=(success_url)
+      if !success_url.nil? && success_url.to_s.length > 1000
+        fail ArgumentError, 'invalid value for "success_url", the character length must be smaller than or equal to 1000.'
+      end
+
+      if !success_url.nil? && success_url.to_s.length < 9
+        fail ArgumentError, 'invalid value for "success_url", the character length must be great than or equal to 9.'
+      end
+
+      @success_url = success_url
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -590,6 +826,7 @@ module Wallee
           allowed_payment_method_configurations == o.allowed_payment_method_configurations &&
           authorization_amount == o.authorization_amount &&
           authorization_environment == o.authorization_environment &&
+          authorization_sales_channel == o.authorization_sales_channel &&
           authorization_timeout_on == o.authorization_timeout_on &&
           authorized_on == o.authorized_on &&
           auto_confirmation_enabled == o.auto_confirmation_enabled &&
@@ -597,6 +834,7 @@ module Wallee
           charge_retry_enabled == o.charge_retry_enabled &&
           completed_amount == o.completed_amount &&
           completed_on == o.completed_on &&
+          completion_behavior == o.completion_behavior &&
           completion_timeout_on == o.completion_timeout_on &&
           confirmed_by == o.confirmed_by &&
           confirmed_on == o.confirmed_on &&
@@ -608,6 +846,7 @@ module Wallee
           customers_presence == o.customers_presence &&
           delivery_decision_made_on == o.delivery_decision_made_on &&
           device_session_identifier == o.device_session_identifier &&
+          emails_disabled == o.emails_disabled &&
           end_of_life == o.end_of_life &&
           environment == o.environment &&
           environment_selection_strategy == o.environment_selection_strategy &&
@@ -619,6 +858,7 @@ module Wallee
           internet_protocol_address == o.internet_protocol_address &&
           internet_protocol_address_country == o.internet_protocol_address_country &&
           invoice_merchant_reference == o.invoice_merchant_reference &&
+          java_enabled == o.java_enabled &&
           language == o.language &&
           line_items == o.line_items &&
           linked_space_id == o.linked_space_id &&
@@ -629,18 +869,26 @@ module Wallee
           planned_purge_date == o.planned_purge_date &&
           processing_on == o.processing_on &&
           refunded_amount == o.refunded_amount &&
+          screen_color_depth == o.screen_color_depth &&
+          screen_height == o.screen_height &&
+          screen_width == o.screen_width &&
           shipping_address == o.shipping_address &&
           shipping_method == o.shipping_method &&
           space_view_id == o.space_view_id &&
           state == o.state &&
           success_url == o.success_url &&
+          terminal == o.terminal &&
           time_zone == o.time_zone &&
           token == o.token &&
           tokenization_mode == o.tokenization_mode &&
+          total_applied_fees == o.total_applied_fees &&
+          total_settled_amount == o.total_settled_amount &&
           user_agent_header == o.user_agent_header &&
           user_failure_message == o.user_failure_message &&
           user_interface_type == o.user_interface_type &&
-          version == o.version
+          version == o.version &&
+          window_height == o.window_height &&
+          window_width == o.window_width
     end
 
     # @see the `==` method
@@ -652,7 +900,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [accept_header, accept_language_header, allowed_payment_method_brands, allowed_payment_method_configurations, authorization_amount, authorization_environment, authorization_timeout_on, authorized_on, auto_confirmation_enabled, billing_address, charge_retry_enabled, completed_amount, completed_on, completion_timeout_on, confirmed_by, confirmed_on, created_by, created_on, currency, customer_email_address, customer_id, customers_presence, delivery_decision_made_on, device_session_identifier, end_of_life, environment, environment_selection_strategy, failed_on, failed_url, failure_reason, group, id, internet_protocol_address, internet_protocol_address_country, invoice_merchant_reference, language, line_items, linked_space_id, merchant_reference, meta_data, parent, payment_connector_configuration, planned_purge_date, processing_on, refunded_amount, shipping_address, shipping_method, space_view_id, state, success_url, time_zone, token, tokenization_mode, user_agent_header, user_failure_message, user_interface_type, version].hash
+      [accept_header, accept_language_header, allowed_payment_method_brands, allowed_payment_method_configurations, authorization_amount, authorization_environment, authorization_sales_channel, authorization_timeout_on, authorized_on, auto_confirmation_enabled, billing_address, charge_retry_enabled, completed_amount, completed_on, completion_behavior, completion_timeout_on, confirmed_by, confirmed_on, created_by, created_on, currency, customer_email_address, customer_id, customers_presence, delivery_decision_made_on, device_session_identifier, emails_disabled, end_of_life, environment, environment_selection_strategy, failed_on, failed_url, failure_reason, group, id, internet_protocol_address, internet_protocol_address_country, invoice_merchant_reference, java_enabled, language, line_items, linked_space_id, merchant_reference, meta_data, parent, payment_connector_configuration, planned_purge_date, processing_on, refunded_amount, screen_color_depth, screen_height, screen_width, shipping_address, shipping_method, space_view_id, state, success_url, terminal, time_zone, token, tokenization_mode, total_applied_fees, total_settled_amount, user_agent_header, user_failure_message, user_interface_type, version, window_height, window_width].hash
     end
 
     # Builds the object from hash
@@ -662,7 +910,7 @@ module Wallee
       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 the attribute
+          # 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) } )