wallee-ruby-sdk 4.4.0 → 5.2.0

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

@@ -20,214 +20,214 @@ require 'date'
 module Wallee
   # 
   class Transaction
-    # 
+    # The 'Accept' header of the customer's web browser.
     attr_accessor :accept_header
 
-    # The accept language contains the header which indicates the language preferences of the buyer.
+    # The 'Accept Language' header of the customer's web browser.
     attr_accessor :accept_language_header
 
-    # 
+    # The payment method brands that can be used to authorize the transaction.
     attr_accessor :allowed_payment_method_brands
 
-    # 
+    # The payment method configurations that can be used to authorize the transaction.
     attr_accessor :allowed_payment_method_configurations
 
-    # 
+    # The sum of all line item prices including taxes in the transaction's currency.
     attr_accessor :authorization_amount
 
-    # The environment in which this transaction was successfully authorized.
+    # The environment in which the transaction was 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.
+    # The date and time when the transaction must be authorized, otherwise it will canceled.
     attr_accessor :authorization_timeout_on
 
-    # 
+    # The date and time when the transaction was authorized.
     attr_accessor :authorized_on
 
-    # When auto confirmation is enabled the transaction can be confirmed by the user and does not require an explicit confirmation through the web service API.
+    # Whether the transaction can be confirmed automatically or whether this must be done explicitly via the API. Default is true.
     attr_accessor :auto_confirmation_enabled
 
-    # 
+    # The address associated with the payment method for invoicing and transaction processing purposes.
     attr_accessor :billing_address
 
-    # When the charging of the customer fails we can retry the charging. This implies that we redirect the user back to the payment page which allows the customer to retry. By default we will retry.
+    # Whether the customer can make further payment attempts if the first one has failed. Default is true.
     attr_accessor :charge_retry_enabled
 
-    # The completed amount is the total amount which has been captured so far.
+    # The total amount that was completed, in the transaction's currency.
     attr_accessor :completed_amount
 
-    # 
+    # The date and time when the transaction was completed.
     attr_accessor :completed_on
 
-    # The completion behavior controls when the transaction is completed.
+    # The behavior that controls when the transaction is completed.
     attr_accessor :completion_behavior
 
-    # 
+    # The date and time when the transaction is completed automatically.
     attr_accessor :completion_timeout_on
 
-    # 
+    # The ID of the user the transaction was confirmed by.
     attr_accessor :confirmed_by
 
-    # 
+    # The date and time when the transaction was created.
     attr_accessor :confirmed_on
 
-    # 
+    # The ID of the user the transaction was created by.
     attr_accessor :created_by
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The three-letter code (ISO 4217 format) of the transaction's currency.
     attr_accessor :currency
 
-    # The customer email address is the email address of the customer. If no email address is provided on the shipping or billing address this address is used.
+    # The customer's email address.
     attr_accessor :customer_email_address
 
-    # 
+    # The unique identifier of the customer in the external system.
     attr_accessor :customer_id
 
-    # The customer's presence indicates what kind of authentication method was finally used during authorization of the transaction. If no value is provided, 'Virtually Present' is used by default.
+    # The customer's presence indicates whether and in what way the transaction's customer is present. Default is VIRTUAL_PRESENT.
     attr_accessor :customers_presence
 
-    # This date indicates when the decision has been made if a transaction should be delivered or not.
+    # This date and time when the decision was made as to whether the order should be shipped.
     attr_accessor :delivery_decision_made_on
 
-    # 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.
+    # Allows to link the transaction to the data collected from the customer's device.
     attr_accessor :device_session_identifier
 
-    # Flag indicating whether email sending is disabled for this particular transaction. Defaults to false.
+    # Whether email sending is deactivated for the transaction. Default is false.
     attr_accessor :emails_disabled
 
-    # The transaction's end of life indicates the date from which on no operation can be carried out anymore.
+    # The date and time when the transaction reaches its end of live. No further actions can be carried out at this time.
     attr_accessor :end_of_life
 
-    # 
+    # The environment used when rendering resources.
     attr_accessor :environment
 
-    # The environment selection strategy determines how the environment (test or production) for processing the transaction is selected.
+    # The strategy for determining whether the transaction is to be processed in the test or production environment.
     attr_accessor :environment_selection_strategy
 
-    # 
+    # The date and time when the transaction failed.
     attr_accessor :failed_on
 
-    # The user will be redirected to failed URL when the transaction could not be authorized or completed. In case no failed URL is specified a default failed page will be displayed.
+    # The URL to redirect the customer back to after they canceled or failed to authenticated their payment.
     attr_accessor :failed_url
 
-    # The failure reason describes why the transaction failed. This is only provided when the transaction is marked as failed.
+    # The reason for the failure of the transaction.
     attr_accessor :failure_reason
 
-    # 
+    # The group that the transaction belongs to.
     attr_accessor :group
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # The Internet Protocol (IP) address identifies the device of the buyer.
+    # The IP address of the customer's device.
     attr_accessor :internet_protocol_address
 
-    # 
+    # The country determined from the IP address of the customer's device.
     attr_accessor :internet_protocol_address_country
 
-    # 
+    # The merchant's reference used to identify the invoice.
     attr_accessor :invoice_merchant_reference
 
-    # 
+    # Whether Java is enabled on the customer's web browser.
     attr_accessor :java_enabled
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # 
+    # The line items purchased by the customer.
     attr_accessor :line_items
 
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
-    # 
+    # The merchant's reference used to identify the transaction.
     attr_accessor :merchant_reference
 
     # Allow to store additional information about the object.
     attr_accessor :meta_data
 
-    # 
+    # The parent transaction which was (partially) replaced by this transaction.
     attr_accessor :parent
 
-    # 
+    # The payment connector configuration that was used to authorize the transaction.
     attr_accessor :payment_connector_configuration
 
     # 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 date and time when the processing of the transaction was started.
     attr_accessor :processing_on
 
-    # The refunded amount is the total amount which has been refunded so far.
+    # The total amount that was refunded, in the transaction's currency.
     attr_accessor :refunded_amount
 
-    # 
+    # The screen color depth of the customer's web browser.
     attr_accessor :screen_color_depth
 
-    # 
+    # The screen height of the customer's web browser.
     attr_accessor :screen_height
 
-    # 
+    # The screen width of the customer's web browser.
     attr_accessor :screen_width
 
-    # 
+    # The address to where the order will be shipped.
     attr_accessor :shipping_address
 
-    # 
+    # The name of the shipping method used to ship the products.
     attr_accessor :shipping_method
 
-    # 
+    # The ID of the space view this object is linked to.
     attr_accessor :space_view_id
 
     # The object's current state.
     attr_accessor :state
 
-    # 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.
+    # The URL to redirect the customer back to after they successfully authenticated their payment.
     attr_accessor :success_url
 
-    # The terminal on which the payment was processed.
+    # The payment terminal through 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.
+    # The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
     attr_accessor :time_zone
 
-    # 
+    # The payment token that should be used to charge the customer.
     attr_accessor :token
 
-    # The tokenization mode controls if and how the tokenization of payment information is applied to the transaction.
+    # The tokenization mode specifies whether 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.
+    # The total of all fees charged, in the transaction's currency.
     attr_accessor :total_applied_fees
 
-    # The total settled amount is the total amount which has been settled so far.
+    # The total amount that was settled, in the transaction's currency.
     attr_accessor :total_settled_amount
 
-    # The user agent header provides the exact string which contains the user agent of the buyer.
+    # The 'User Agent' header of the customer's web browser.
     attr_accessor :user_agent_header
 
-    # The failure message describes for an end user why the transaction is failed in the language of the user. This is only provided when the transaction is marked as failed.
+    # The message that can be displayed to the customer explaining why the transaction failed, in the customer's language.
     attr_accessor :user_failure_message
 
-    # The user interface type defines through which user interface the transaction has been processed resp. created.
+    # The type of user interface the customer used to provide the payment information.
     attr_accessor :user_interface_type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
     attr_accessor :version
 
-    # 
+    # The window height of the customer's web browser.
     attr_accessor :window_height
 
-    # 
+    # The window width of the customer's web browser.
     attr_accessor :window_width
 
-    # The number of years the transaction will be stored after it has been authorized.
+    # The number of years the transaction is kept after its authorization.
     attr_accessor :years_to_keep
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -44,7 +44,7 @@ module Wallee
     # Whether the comment is pinned to the top.
     attr_accessor :pinned
 
-    # 
+    # The transaction that the comment belongs to.
     attr_accessor :transaction
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -23,7 +23,7 @@ module Wallee
     # The comment's actual content.
     attr_accessor :content
 
-    # 
+    # The transaction that the comment belongs to.
     attr_accessor :transaction
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,94 +20,94 @@ require 'date'
 module Wallee
   # 
   class TransactionCompletion
-    # A unique identifier for the object.
-    attr_accessor :id
-
-    # The ID of the space this object belongs to.
-    attr_accessor :linked_space_id
-
-    # 
-    attr_accessor :linked_transaction
-
-    # The amount which is captured. The amount represents sum of line items including taxes.
+    # The total amount to be captured in this completion, including taxes.
     attr_accessor :amount
 
-    # The base line items on which the completion is applied on.
+    # The original line items from the transaction that serve as the baseline for this completion.
     attr_accessor :base_line_items
 
-    # 
+    # The ID of the user the transaction completion was created by.
     attr_accessor :created_by
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # The external ID helps to identify the entity and a subsequent creation of an entity with the same ID will not create a new entity.
+    # 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 date and time when the transaction completion failed.
     attr_accessor :failed_on
 
-    # 
+    # The reason for the failure of the transaction completion.
     attr_accessor :failure_reason
 
-    # 
+    # A unique identifier for the object.
+    attr_accessor :id
+
+    # The merchant's reference used to identify the invoice.
     attr_accessor :invoice_merchant_reference
 
-    # 
+    # The labels providing additional information about the object.
     attr_accessor :labels
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # Indicates if this is the last completion. After the last completion is created the transaction cannot be completed anymore.
+    # Whether this is the final completion for the transaction. After the last completion is successfully created, the transaction enters its final state, and no further completions can occur.
     attr_accessor :last_completion
 
-    # 
+    # The specific version of the line items that are being used for this completion.
     attr_accessor :line_item_version
 
-    # The line items which are captured.
+    # The line items captured in this transaction completion.
     attr_accessor :line_items
 
-    # 
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
+
+    # The payment transaction this object is linked to.
+    attr_accessor :linked_transaction
+
+    # The mode of transaction completion, such as online or offline, determining how the completion process is executed.
     attr_accessor :mode
 
-    # 
+    # The date and time when the next update of the object's state is planned.
     attr_accessor :next_update_on
 
-    # 
+    # Payment-specific details related to this transaction completion such as payment instructions or references needed for processing.
     attr_accessor :payment_information
 
     # 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 date and time when the processing of the transaction completion was started.
     attr_accessor :processing_on
 
-    # 
+    # The reference ID provided by the payment processor, used to trace the completion through the external payment system.
     attr_accessor :processor_reference
 
-    # 
+    # The line items yet to be captured in the transaction.
     attr_accessor :remaining_line_items
 
-    # 
+    # The ID of the space view this object is linked to.
     attr_accessor :space_view_id
 
     # The object's current state.
     attr_accessor :state
 
-    # The statement descriptor explain charges or payments on bank statements.
+    # The statement descriptor that appears on a customer's bank statement, providing an explanation for charges or payments, helping customers identify the transaction.
     attr_accessor :statement_descriptor
 
-    # 
+    # The date and time when the transaction completion succeeded.
     attr_accessor :succeeded_on
 
-    # The total sum of all taxes of line items.
+    # The portion of the captured amount that corresponds to taxes.
     attr_accessor :tax_amount
 
-    # 
+    # The time zone that this object is associated with.
     attr_accessor :time_zone
 
-    # 
+    # The date and time when the object will expire.
     attr_accessor :timeout_on
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -116,9 +116,6 @@ module Wallee
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'linked_space_id' => :'linkedSpaceId',
-        :'linked_transaction' => :'linkedTransaction',
         :'amount' => :'amount',
         :'base_line_items' => :'baseLineItems',
         :'created_by' => :'createdBy',
@@ -126,12 +123,15 @@ module Wallee
         :'external_id' => :'externalId',
         :'failed_on' => :'failedOn',
         :'failure_reason' => :'failureReason',
+        :'id' => :'id',
         :'invoice_merchant_reference' => :'invoiceMerchantReference',
         :'labels' => :'labels',
         :'language' => :'language',
         :'last_completion' => :'lastCompletion',
         :'line_item_version' => :'lineItemVersion',
         :'line_items' => :'lineItems',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'linked_transaction' => :'linkedTransaction',
         :'mode' => :'mode',
         :'next_update_on' => :'nextUpdateOn',
         :'payment_information' => :'paymentInformation',
@@ -153,9 +153,6 @@ module Wallee
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
         :'amount' => :'Float',
         :'base_line_items' => :'Array<LineItem>',
         :'created_by' => :'Integer',
@@ -163,12 +160,15 @@ module Wallee
         :'external_id' => :'String',
         :'failed_on' => :'DateTime',
         :'failure_reason' => :'FailureReason',
+        :'id' => :'Integer',
         :'invoice_merchant_reference' => :'String',
         :'labels' => :'Array<Label>',
         :'language' => :'String',
         :'last_completion' => :'BOOLEAN',
         :'line_item_version' => :'TransactionLineItemVersion',
         :'line_items' => :'Array<LineItem>',
+        :'linked_space_id' => :'Integer',
+        :'linked_transaction' => :'Integer',
         :'mode' => :'TransactionCompletionMode',
         :'next_update_on' => :'DateTime',
         :'payment_information' => :'String',
@@ -195,18 +195,6 @@ module Wallee
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
-      end
-
-      if attributes.has_key?(:'linkedSpaceId')
-        self.linked_space_id = attributes[:'linkedSpaceId']
-      end
-
-      if attributes.has_key?(:'linkedTransaction')
-        self.linked_transaction = attributes[:'linkedTransaction']
-      end
-
       if attributes.has_key?(:'amount')
         self.amount = attributes[:'amount']
       end
@@ -237,6 +225,10 @@ module Wallee
         self.failure_reason = attributes[:'failureReason']
       end
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'invoiceMerchantReference')
         self.invoice_merchant_reference = attributes[:'invoiceMerchantReference']
       end
@@ -265,6 +257,14 @@ module Wallee
         end
       end
 
+      if attributes.has_key?(:'linkedSpaceId')
+        self.linked_space_id = attributes[:'linkedSpaceId']
+      end
+
+      if attributes.has_key?(:'linkedTransaction')
+        self.linked_transaction = attributes[:'linkedTransaction']
+      end
+
       if attributes.has_key?(:'mode')
         self.mode = attributes[:'mode']
       end
@@ -400,9 +400,6 @@ module Wallee
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          id == o.id &&
-          linked_space_id == o.linked_space_id &&
-          linked_transaction == o.linked_transaction &&
           amount == o.amount &&
           base_line_items == o.base_line_items &&
           created_by == o.created_by &&
@@ -410,12 +407,15 @@ module Wallee
           external_id == o.external_id &&
           failed_on == o.failed_on &&
           failure_reason == o.failure_reason &&
+          id == o.id &&
           invoice_merchant_reference == o.invoice_merchant_reference &&
           labels == o.labels &&
           language == o.language &&
           last_completion == o.last_completion &&
           line_item_version == o.line_item_version &&
           line_items == o.line_items &&
+          linked_space_id == o.linked_space_id &&
+          linked_transaction == o.linked_transaction &&
           mode == o.mode &&
           next_update_on == o.next_update_on &&
           payment_information == o.payment_information &&
@@ -442,7 +442,7 @@ module Wallee
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, amount, base_line_items, created_by, created_on, external_id, failed_on, failure_reason, invoice_merchant_reference, labels, language, last_completion, line_item_version, line_items, mode, next_update_on, payment_information, planned_purge_date, processing_on, processor_reference, remaining_line_items, space_view_id, state, statement_descriptor, succeeded_on, tax_amount, time_zone, timeout_on, version].hash
+      [amount, base_line_items, created_by, created_on, external_id, failed_on, failure_reason, id, invoice_merchant_reference, labels, language, last_completion, line_item_version, line_items, linked_space_id, linked_transaction, mode, next_update_on, payment_information, planned_purge_date, processing_on, processor_reference, remaining_line_items, space_view_id, state, statement_descriptor, succeeded_on, tax_amount, time_zone, timeout_on, version].hash
     end
 
     # Builds the object from hash

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

@@ -32,7 +32,7 @@ module Wallee
     # The line items which will be used to complete the transaction.
     attr_accessor :line_items
 
-    # The statement descriptor explain charges or payments on bank statements.
+    # The statement descriptor that appears on a customer's bank statement, providing an explanation for charges or payments, helping customers identify the transaction.
     attr_accessor :statement_descriptor
 
     # The ID of the transaction which should be completed.