postfinancecheckout-ruby-sdk 4.5.0 → 5.2.0

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

@@ -19,22 +19,22 @@ require 'date'
 
 module PostFinanceCheckout
   class AbstractTokenUpdate
-    # The customer email address is the email address of the customer.
+    # The customer's email address.
     attr_accessor :customer_email_address
 
-    # The customer ID identifies the customer in the merchant system. In case the customer ID has been provided it has to correspond with the customer ID provided on the transaction. The customer ID will not be changed automatically. The merchant system has to provide it.
+    # The unique identifier of the customer in the external system.
     attr_accessor :customer_id
 
-    # When a token is enabled for one-click payments the buyer will be able to select the token within the iFrame or on the payment page to pay with the token. The usage of the token will reduce the number of steps the buyer has to go through. The buyer is linked via the customer ID on the transaction with the token. Means the token will be visible for buyers with the same customer ID. Additionally the payment method has to be configured to allow the one-click payments.
+    # Whether the token is enabled for one-click payments, which simplify the payment process for the customer. One-click tokens are linked to customers via the customer ID.
     attr_accessor :enabled_for_one_click_payment
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # The time zone defines in which time zone the customer is located in. The time zone may affects how dates are formatted when interacting with the customer.
+    # The customer's time zone, which affects how dates and times are formatted when communicating with the customer.
     attr_accessor :time_zone
 
-    # Use something that it is easy to identify and may help you find the token (e.g. customer id, email address).
+    # The reference used to identify the payment token (e.g. the customer's ID or email address).
     attr_accessor :token_reference
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,61 +19,61 @@ require 'date'
 
 module PostFinanceCheckout
   class AbstractTransactionPending
-    # 
+    # 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
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,9 +19,6 @@ require 'date'
 
 module PostFinanceCheckout
   class AbstractWebhookListenerUpdate
-    # Whether signature header and state property are enabled in webhook payload.
-    attr_accessor :enable_payload_signature_and_state
-
     # The entity's target states that are to be monitored.
     attr_accessor :entity_states
 
@@ -37,7 +34,6 @@ module PostFinanceCheckout
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'enable_payload_signature_and_state' => :'enablePayloadSignatureAndState',
         :'entity_states' => :'entityStates',
         :'name' => :'name',
         :'notify_every_change' => :'notifyEveryChange',
@@ -48,7 +44,6 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'enable_payload_signature_and_state' => :'BOOLEAN',
         :'entity_states' => :'Array<String>',
         :'name' => :'String',
         :'notify_every_change' => :'BOOLEAN',
@@ -64,10 +59,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?(:'enablePayloadSignatureAndState')
-        self.enable_payload_signature_and_state = attributes[:'enablePayloadSignatureAndState']
-      end
-
       if attributes.has_key?(:'entityStates')
         if (value = attributes[:'entityStates']).is_a?(Array)
           self.entity_states = value
@@ -120,7 +111,6 @@ module PostFinanceCheckout
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          enable_payload_signature_and_state == o.enable_payload_signature_and_state &&
           entity_states == o.entity_states &&
           name == o.name &&
           notify_every_change == o.notify_every_change &&
@@ -136,7 +126,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [enable_payload_signature_and_state, entity_states, name, notify_every_change, state].hash
+      [entity_states, name, notify_every_change, state].hash
     end
 
     # Builds the object from hash

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

@@ -18,24 +18,28 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # This model holds the card data and optional cardholder authentication details.
+  # 
   class AuthenticatedCardData
-    # The additional authentication value used to secure the tokenized card transactions.
+    # An additional authentication value that enhances the security of tokenized card transactions.
     attr_accessor :cryptogram
 
-    # 
+    # Whether the transaction is an initial recurring transaction, based on the recurring indicator. This is used to identify the first transaction in a recurring payment setup.
+    attr_accessor :initial_recurring_transaction
+
+    # The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.
     attr_accessor :recurring_indicator
 
-    # 
+    # The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.
     attr_accessor :token_requestor_id
 
-    # 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).
+    # Optional authentication details for the cardholder, such as 3D Secure authentication, used when the cardholder has already been verified during the transaction for added security.
     attr_accessor :cardholder_authentication
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'cryptogram' => :'cryptogram',
+        :'initial_recurring_transaction' => :'initialRecurringTransaction',
         :'recurring_indicator' => :'recurringIndicator',
         :'token_requestor_id' => :'tokenRequestorId',
         :'cardholder_authentication' => :'cardholderAuthentication'
@@ -46,6 +50,7 @@ module PostFinanceCheckout
     def self.swagger_types
       {
         :'cryptogram' => :'CardCryptogram',
+        :'initial_recurring_transaction' => :'BOOLEAN',
         :'recurring_indicator' => :'RecurringIndicator',
         :'token_requestor_id' => :'String',
         :'cardholder_authentication' => :'CardholderAuthentication'
@@ -64,6 +69,10 @@ module PostFinanceCheckout
         self.cryptogram = attributes[:'cryptogram']
       end
 
+      if attributes.has_key?(:'initialRecurringTransaction')
+        self.initial_recurring_transaction = attributes[:'initialRecurringTransaction']
+      end
+
       if attributes.has_key?(:'recurringIndicator')
         self.recurring_indicator = attributes[:'recurringIndicator']
       end
@@ -96,6 +105,7 @@ module PostFinanceCheckout
       return true if self.equal?(o)
       self.class == o.class &&
           cryptogram == o.cryptogram &&
+          initial_recurring_transaction == o.initial_recurring_transaction &&
           recurring_indicator == o.recurring_indicator &&
           token_requestor_id == o.token_requestor_id &&
           cardholder_authentication == o.cardholder_authentication
@@ -110,7 +120,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cryptogram, recurring_indicator, token_requestor_id, cardholder_authentication].hash
+      [cryptogram, initial_recurring_transaction, recurring_indicator, token_requestor_id, cardholder_authentication].hash
     end
 
     # Builds the object from hash

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

@@ -18,33 +18,36 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # 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.
+    # The name of the cardholder, as printed on the card, identifying the card owner.
     attr_accessor :card_holder_name
 
-    # The card verification code (CVC) is a 3 to 4 digit code typically printed on the back of the card. It helps to ensure that the card holder is authorizing the transaction. For card not-present transactions this field is optional.
+    # The security code used to validate the card during transactions.
     attr_accessor :card_verification_code
 
-    # The 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).
+    # Optional authentication details for the cardholder, such as 3D Secure authentication, used when the cardholder has already been verified during the transaction for added security.
     attr_accessor :cardholder_authentication
 
-    # The additional authentication value used to secure the tokenized card transactions.
+    # An additional authentication value that enhances the security of tokenized card transactions.
     attr_accessor :cryptogram
 
-    # The card expiry date indicates when the card expires. The format is the format yyyy-mm where yyyy is the year (e.g. 2019) and the mm is the month (e.g. 09).
+    # The expiry date of the card, indicating its validity period in yyyy-mm format (e.g., 2023-09).
     attr_accessor :expiry_date
 
-    # The primary account number (PAN) identifies the card. The number is numeric and typically printed on the front of the card.
+    # The type of PAN or token, indicating the source or security method of the card information.
+    attr_accessor :pan_type
+
+    # The card's primary account number (PAN), the unique identifier of the card.
     attr_accessor :primary_account_number
 
-    # 
+    # The indicator used to distinguish between recurring and one-time transactions. If omitted, it will be automatically determined based on the transaction's properties.
     attr_accessor :recurring_indicator
 
-    # 
+    # A reference specific to the card's transaction within its payment scheme.
     attr_accessor :scheme_transaction_reference
 
-    # 
+    # The token requestor identifier (TRID) identifies the entity requesting tokenization for a card transaction.
     attr_accessor :token_requestor_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -55,6 +58,7 @@ module PostFinanceCheckout
         :'cardholder_authentication' => :'cardholderAuthentication',
         :'cryptogram' => :'cryptogram',
         :'expiry_date' => :'expiryDate',
+        :'pan_type' => :'panType',
         :'primary_account_number' => :'primaryAccountNumber',
         :'recurring_indicator' => :'recurringIndicator',
         :'scheme_transaction_reference' => :'schemeTransactionReference',
@@ -70,6 +74,7 @@ module PostFinanceCheckout
         :'cardholder_authentication' => :'CardholderAuthenticationCreate',
         :'cryptogram' => :'CardCryptogramCreate',
         :'expiry_date' => :'String',
+        :'pan_type' => :'PanType',
         :'primary_account_number' => :'String',
         :'recurring_indicator' => :'RecurringIndicator',
         :'scheme_transaction_reference' => :'String',
@@ -105,6 +110,10 @@ module PostFinanceCheckout
         self.expiry_date = attributes[:'expiryDate']
       end
 
+      if attributes.has_key?(:'panType')
+        self.pan_type = attributes[:'panType']
+      end
+
       if attributes.has_key?(:'primaryAccountNumber')
         self.primary_account_number = attributes[:'primaryAccountNumber']
       end
@@ -232,6 +241,7 @@ module PostFinanceCheckout
           cardholder_authentication == o.cardholder_authentication &&
           cryptogram == o.cryptogram &&
           expiry_date == o.expiry_date &&
+          pan_type == o.pan_type &&
           primary_account_number == o.primary_account_number &&
           recurring_indicator == o.recurring_indicator &&
           scheme_transaction_reference == o.scheme_transaction_reference &&
@@ -247,7 +257,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [card_holder_name, card_verification_code, cardholder_authentication, cryptogram, expiry_date, primary_account_number, recurring_indicator, scheme_transaction_reference, token_requestor_id].hash
+      [card_holder_name, card_verification_code, cardholder_authentication, cryptogram, expiry_date, pan_type, primary_account_number, recurring_indicator, scheme_transaction_reference, token_requestor_id].hash
     end
 
     # Builds the object from hash

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

@@ -20,13 +20,13 @@ require 'date'
 module PostFinanceCheckout
   # 
   class BankAccount
-    # The optional description is shown along the identifier. The intention of the description is to give an alternative name to the bank account.
+    # The description serves as an alternative name for the bank account.
     attr_accessor :description
 
     # A unique identifier for the object.
     attr_accessor :id
 
-    # The bank account identifier is responsible to uniquely identify the bank account.
+    # The identifier is used to uniquely identify the bank account.
     attr_accessor :identifier
 
     # The ID of the space this object belongs to.
@@ -38,7 +38,7 @@ module PostFinanceCheckout
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # The bank account's type
     attr_accessor :type
 
     # The version is used for optimistic locking and incremented whenever the object is updated.

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

@@ -26,7 +26,7 @@ module PostFinanceCheckout
     # A unique identifier for the object.
     attr_accessor :id
 
-    # 
+    # The identifier name specifies how the bank account type's identifier is called.
     attr_accessor :identifier_name
 
     # The localized name of the object.

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

@@ -20,22 +20,22 @@ require 'date'
 module PostFinanceCheckout
   # 
   class BankTransaction
-    # The adjustments applied on this bank transaction.
+    # Adjustments are changes made to the initial transaction amount, such as fees or corrections.
     attr_accessor :adjustments
 
-    # The created by indicates the user which has created the bank transaction.
+    # The ID of the user the bank transaction was created by.
     attr_accessor :created_by
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # The currency bank account which is used to handle money flow.
+    # The currency bank account that sends or receives money based on the bank transaction's flow direction.
     attr_accessor :currency_bank_account
 
-    # 
+    # A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.
     attr_accessor :external_id
 
-    # 
+    # Indicates the direction of a bank transaction, specifying whether the amount flows into or out of the bank account.
     attr_accessor :flow_direction
 
     # A unique identifier for the object.
@@ -44,31 +44,34 @@ module PostFinanceCheckout
     # The ID of the space this object belongs to.
     attr_accessor :linked_space_id
 
+    # The payment date specifies the date on which the payment was processed.
+    attr_accessor :payment_date
+
     # 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 posting amount indicates the amount including adjustments.
+    # The posting amount refers to the monetary value recorded for the bank transaction prior to any adjustments.
     attr_accessor :posting_amount
 
-    # 
+    # A unique reference to identify the bank transaction.
     attr_accessor :reference
 
-    # 
+    # The source indicates how the bank transaction was created.
     attr_accessor :source
 
     # The object's current state.
     attr_accessor :state
 
-    # 
+    # Represents the total value of all adjustments to the bank transaction, including tax.
     attr_accessor :total_adjustment_amount_including_tax
 
-    # 
+    # The bank transaction's type.
     attr_accessor :type
 
-    # 
+    # The value amount represents the net monetary value of the transaction after applicable deductions.
     attr_accessor :value_amount
 
-    # The value date describes the date the amount is effective on the account.
+    # The value date indicates the date on which the transaction amount becomes effective.
     attr_accessor :value_date
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -85,6 +88,7 @@ module PostFinanceCheckout
         :'flow_direction' => :'flowDirection',
         :'id' => :'id',
         :'linked_space_id' => :'linkedSpaceId',
+        :'payment_date' => :'paymentDate',
         :'planned_purge_date' => :'plannedPurgeDate',
         :'posting_amount' => :'postingAmount',
         :'reference' => :'reference',
@@ -109,6 +113,7 @@ module PostFinanceCheckout
         :'flow_direction' => :'BankTransactionFlowDirection',
         :'id' => :'Integer',
         :'linked_space_id' => :'Integer',
+        :'payment_date' => :'DateTime',
         :'planned_purge_date' => :'DateTime',
         :'posting_amount' => :'Float',
         :'reference' => :'String',
@@ -164,6 +169,10 @@ module PostFinanceCheckout
         self.linked_space_id = attributes[:'linkedSpaceId']
       end
 
+      if attributes.has_key?(:'paymentDate')
+        self.payment_date = attributes[:'paymentDate']
+      end
+
       if attributes.has_key?(:'plannedPurgeDate')
         self.planned_purge_date = attributes[:'plannedPurgeDate']
       end
@@ -255,6 +264,7 @@ module PostFinanceCheckout
           flow_direction == o.flow_direction &&
           id == o.id &&
           linked_space_id == o.linked_space_id &&
+          payment_date == o.payment_date &&
           planned_purge_date == o.planned_purge_date &&
           posting_amount == o.posting_amount &&
           reference == o.reference &&
@@ -276,7 +286,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [adjustments, created_by, created_on, currency_bank_account, external_id, flow_direction, id, linked_space_id, planned_purge_date, posting_amount, reference, source, state, total_adjustment_amount_including_tax, type, value_amount, value_date, version].hash
+      [adjustments, created_by, created_on, currency_bank_account, external_id, flow_direction, id, linked_space_id, payment_date, planned_purge_date, posting_amount, reference, source, state, total_adjustment_amount_including_tax, type, value_amount, value_date, version].hash
     end
 
     # Builds the object from hash