postfinancecheckout-ruby-sdk 4.5.0 → 5.2.0

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

@@ -20,94 +20,94 @@ require 'date'
 module PostFinanceCheckout
   # 
   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 PostFinanceCheckout
     # 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 PostFinanceCheckout
         :'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 PostFinanceCheckout
     # 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 PostFinanceCheckout
         :'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 PostFinanceCheckout
       # 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 PostFinanceCheckout
         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 PostFinanceCheckout
         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 PostFinanceCheckout
     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 PostFinanceCheckout
           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 PostFinanceCheckout
     # 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/postfinancecheckout-ruby-sdk/models/transaction_completion_request.rb

@@ -32,7 +32,7 @@ module PostFinanceCheckout
     # 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.

data/lib/postfinancecheckout-ruby-sdk/models/transaction_create.rb

@@ -20,85 +20,85 @@ require 'date'
 module PostFinanceCheckout
   # 
   class TransactionCreate
-    # 
+    # 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 address associated with the payment method for invoicing and transaction processing purposes.
     attr_accessor :billing_address
 
-    # The completion behavior controls when the transaction is completed.
+    # The behavior that controls when the transaction is completed.
     attr_accessor :completion_behavior
 
-    # 
+    # 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 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 merchant's reference used to identify the invoice.
     attr_accessor :invoice_merchant_reference
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # 
+    # The line items purchased by the customer.
     attr_accessor :line_items
 
-    # 
+    # 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 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 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 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
 
-    # 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
 
-    # 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 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
 
-    # 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 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 ID of the space view this object is linked to.
     attr_accessor :space_view_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/postfinancecheckout-ruby-sdk/models/transaction_group.rb

@@ -20,13 +20,13 @@ require 'date'
 module PostFinanceCheckout
   # 
   class TransactionGroup
-    # 
+    # The date and time when the initial transaction in the group was created.
     attr_accessor :begin_date
 
-    # 
+    # The unique identifier of the customer in the external system.
     attr_accessor :customer_id
 
-    # 
+    # The date and time when the final transaction in the group was last updated.
     attr_accessor :end_date
 
     # A unique identifier for the object.

data/lib/postfinancecheckout-ruby-sdk/models/transaction_invoice.rb

@@ -18,72 +18,72 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # The transaction invoice represents the invoice document for a particular transaction.
+  # 
   class TransactionInvoice
-    # 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 total sum of all line items on the invoice, including taxes.
     attr_accessor :amount
 
-    # 
+    # The address associated with the invoice, used for billing purposes.
     attr_accessor :billing_address
 
-    # 
+    # The transaction completion this object is linked to.
     attr_accessor :completion
 
-    # The date on which the invoice is created on.
+    # The date and time when the object was created.
     attr_accessor :created_on
 
-    # The id of the user which marked the invoice as derecognized.
+    # The ID of the user the invoice was derecognized by.
     attr_accessor :derecognized_by
 
-    # The date on which the invoice is marked as derecognized.
+    # The date and time when the invoice was derecognized, meaning it is no longer considered outstanding or valid in the system.
     attr_accessor :derecognized_on
 
-    # The date on which the invoice should be paid on.
+    # The due date for payment of the invoice.
     attr_accessor :due_on
 
-    # 
+    # The environment used when rendering resources.
     attr_accessor :environment
 
-    # 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
 
+    # A unique identifier for the object.
+    attr_accessor :id
+
     # The language that is linked to the object.
     attr_accessor :language
 
-    # 
+    # The invoiced line items that will appear on the invoice document.
     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 merchant's reference used to identify the invoice.
     attr_accessor :merchant_reference
 
-    # The outstanding amount indicates how much the buyer owes the merchant. A negative amount indicates that the invoice is overpaid.
+    # The remaining amount the buyer owes to the merchant. A negative value indicates the invoice has been overpaid.
     attr_accessor :outstanding_amount
 
-    # The date on which the invoice is marked as paid. Eventually this date lags behind of the actual paid date.
+    # The date and time when the invoice was recorded as paid. May differ from the actual payment date due to processing delays.
     attr_accessor :paid_on
 
     # 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 ID of the space view this object is linked to.
     attr_accessor :space_view_id
 
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The portion of the invoiced amount that corresponds to taxes.
     attr_accessor :tax_amount
 
-    # 
+    # The time zone that this object is associated with.
     attr_accessor :time_zone
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -92,9 +92,6 @@ module PostFinanceCheckout
     # 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',
         :'billing_address' => :'billingAddress',
         :'completion' => :'completion',
@@ -104,8 +101,11 @@ module PostFinanceCheckout
         :'due_on' => :'dueOn',
         :'environment' => :'environment',
         :'external_id' => :'externalId',
+        :'id' => :'id',
         :'language' => :'language',
         :'line_items' => :'lineItems',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'linked_transaction' => :'linkedTransaction',
         :'merchant_reference' => :'merchantReference',
         :'outstanding_amount' => :'outstandingAmount',
         :'paid_on' => :'paidOn',
@@ -121,9 +121,6 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
         :'amount' => :'Float',
         :'billing_address' => :'Address',
         :'completion' => :'TransactionCompletion',
@@ -133,8 +130,11 @@ module PostFinanceCheckout
         :'due_on' => :'DateTime',
         :'environment' => :'Environment',
         :'external_id' => :'String',
+        :'id' => :'Integer',
         :'language' => :'String',
         :'line_items' => :'Array<LineItem>',
+        :'linked_space_id' => :'Integer',
+        :'linked_transaction' => :'Integer',
         :'merchant_reference' => :'String',
         :'outstanding_amount' => :'Float',
         :'paid_on' => :'DateTime',
@@ -155,18 +155,6 @@ module PostFinanceCheckout
       # 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
@@ -203,6 +191,10 @@ module PostFinanceCheckout
         self.external_id = attributes[:'externalId']
       end
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'language')
         self.language = attributes[:'language']
       end
@@ -213,6 +205,14 @@ module PostFinanceCheckout
         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?(:'merchantReference')
         self.merchant_reference = attributes[:'merchantReference']
       end
@@ -307,9 +307,6 @@ module PostFinanceCheckout
     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 &&
           billing_address == o.billing_address &&
           completion == o.completion &&
@@ -319,8 +316,11 @@ module PostFinanceCheckout
           due_on == o.due_on &&
           environment == o.environment &&
           external_id == o.external_id &&
+          id == o.id &&
           language == o.language &&
           line_items == o.line_items &&
+          linked_space_id == o.linked_space_id &&
+          linked_transaction == o.linked_transaction &&
           merchant_reference == o.merchant_reference &&
           outstanding_amount == o.outstanding_amount &&
           paid_on == o.paid_on &&
@@ -341,7 +341,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, amount, billing_address, completion, created_on, derecognized_by, derecognized_on, due_on, environment, external_id, language, line_items, merchant_reference, outstanding_amount, paid_on, planned_purge_date, space_view_id, state, tax_amount, time_zone, version].hash
+      [amount, billing_address, completion, created_on, derecognized_by, derecognized_on, due_on, environment, external_id, id, language, line_items, linked_space_id, linked_transaction, merchant_reference, outstanding_amount, paid_on, planned_purge_date, space_view_id, state, tax_amount, time_zone, version].hash
     end
 
     # Builds the object from hash

data/lib/postfinancecheckout-ruby-sdk/models/transaction_invoice_comment.rb

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

data/lib/postfinancecheckout-ruby-sdk/models/transaction_invoice_comment_create.rb

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