postfinancecheckout-ruby-sdk 4.5.0 → 5.2.0

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

@@ -18,18 +18,18 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # This model holds the additional card authentication.
+  # 
   class CardCryptogramCreate
-    # 
-    attr_accessor :type
+    # The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.
+    attr_accessor :eci
 
-    # 
+    # The cryptogram value used for securing card transactions, format varying based on the PAN type.
     attr_accessor :value
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'type' => :'type',
+        :'eci' => :'eci',
         :'value' => :'value'
       }
     end
@@ -37,7 +37,7 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'type' => :'CardCryptogramType',
+        :'eci' => :'String',
         :'value' => :'String'
       }
     end
@@ -50,8 +50,8 @@ 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?(:'type')
-        self.type = attributes[:'type']
+      if attributes.has_key?(:'eci')
+        self.eci = attributes[:'eci']
       end
 
       if attributes.has_key?(:'value')
@@ -63,10 +63,6 @@ module PostFinanceCheckout
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @type.nil?
-        invalid_properties.push('invalid value for "type", type cannot be nil.')
-      end
-
       if @value.nil?
         invalid_properties.push('invalid value for "value", value cannot be nil.')
       end
@@ -77,7 +73,6 @@ module PostFinanceCheckout
     # 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 @type.nil?
       return false if @value.nil?
       true
     end
@@ -87,7 +82,7 @@ module PostFinanceCheckout
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          type == o.type &&
+          eci == o.eci &&
           value == o.value
     end
 
@@ -100,7 +95,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [type, value].hash
+      [eci, value].hash
     end
 
     # Builds the object from hash

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

@@ -18,21 +18,21 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # This model holds the cardholder authentication data (e.g. 3-D Secure authentication).
+  # 
   class CardholderAuthentication
-    # The authentication identifier as assigned by authentication system (e.g. XID or DSTransactionID).
+    # The identifier (e.g., XID or DSTransactionID) assigned by the authentication system for tracking and verification.
     attr_accessor :authentication_identifier
 
-    # 
+    # The result of the authentication process.
     attr_accessor :authentication_response
 
-    # The cardholder authentication value. Also known as Cardholder Authentication Verification Value (CAVV).
+    # The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.
     attr_accessor :authentication_value
 
-    # The Electronic Commerce Indicator (ECI) value. The ECI is returned by authentication system and indicates the outcome/status of authentication.
+    # The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.
     attr_accessor :electronic_commerce_indicator
 
-    # 
+    # The version of the authentication protocol (e.g., 3D Secure 1.0 or 2.0) used for the transaction.
     attr_accessor :version
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -18,21 +18,21 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # This model holds the cardholder authentication data (e.g. 3-D Secure authentication).
+  # 
   class CardholderAuthenticationCreate
-    # The authentication identifier as assigned by authentication system (e.g. XID or DSTransactionID).
+    # The identifier (e.g., XID or DSTransactionID) assigned by the authentication system for tracking and verification.
     attr_accessor :authentication_identifier
 
-    # 
+    # The result of the authentication process.
     attr_accessor :authentication_response
 
-    # The cardholder authentication value. Also known as Cardholder Authentication Verification Value (CAVV).
+    # The cryptographic token (CAVV/AAV) generated during the authentication process to validate the cardholder's identity.
     attr_accessor :authentication_value
 
-    # The Electronic Commerce Indicator (ECI) value. The ECI is returned by authentication system and indicates the outcome/status of authentication.
+    # The Electronic Commerce Indicator (ECI) represents the authentication level and indicates liability shift during online or card-not-present transactions.
     attr_accessor :electronic_commerce_indicator
 
-    # 
+    # The version of the authentication protocol (e.g., 3D Secure 1.0 or 2.0) used for the transaction.
     attr_accessor :version
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -20,46 +20,43 @@ require 'date'
 module PostFinanceCheckout
   # 
   class Charge
-    # 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 date on which the charge was created on.
+    # The date and time when the object was created.
     attr_accessor :created_on
 
-    # 
+    # The reason for the failure of the charge.
     attr_accessor :failure_reason
 
+    # A unique identifier for the object.
+    attr_accessor :id
+
     # The language that is linked to the object.
     attr_accessor :language
 
+    # The ID of the space this object belongs to.
+    attr_accessor :linked_space_id
+
     # 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 time zone that this object is associated with.
     attr_accessor :time_zone
 
-    # 
+    # The date and time when the charge will expire.
     attr_accessor :timeout_on
 
-    # 
+    # The transaction that the charge belongs to.
     attr_accessor :transaction
 
-    # 
+    # The type specifying how the customer was charged.
     attr_accessor :type
 
-    # The failure message describes for an end user why the charge is failed in the language of the user. This is only provided when the charge is marked as failed.
+    # The message that can be displayed to the customer explaining why the charge failed, in the customer's language.
     attr_accessor :user_failure_message
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -68,12 +65,11 @@ 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',
         :'created_on' => :'createdOn',
         :'failure_reason' => :'failureReason',
+        :'id' => :'id',
         :'language' => :'language',
+        :'linked_space_id' => :'linkedSpaceId',
         :'planned_purge_date' => :'plannedPurgeDate',
         :'space_view_id' => :'spaceViewId',
         :'state' => :'state',
@@ -89,12 +85,11 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
         :'created_on' => :'DateTime',
         :'failure_reason' => :'FailureReason',
+        :'id' => :'Integer',
         :'language' => :'String',
+        :'linked_space_id' => :'Integer',
         :'planned_purge_date' => :'DateTime',
         :'space_view_id' => :'Integer',
         :'state' => :'ChargeState',
@@ -115,18 +110,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?(:'createdOn')
         self.created_on = attributes[:'createdOn']
       end
@@ -135,10 +118,18 @@ module PostFinanceCheckout
         self.failure_reason = attributes[:'failureReason']
       end
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'language')
         self.language = attributes[:'language']
       end
 
+      if attributes.has_key?(:'linkedSpaceId')
+        self.linked_space_id = attributes[:'linkedSpaceId']
+      end
+
       if attributes.has_key?(:'plannedPurgeDate')
         self.planned_purge_date = attributes[:'plannedPurgeDate']
       end
@@ -194,12 +185,11 @@ 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 &&
           created_on == o.created_on &&
           failure_reason == o.failure_reason &&
+          id == o.id &&
           language == o.language &&
+          linked_space_id == o.linked_space_id &&
           planned_purge_date == o.planned_purge_date &&
           space_view_id == o.space_view_id &&
           state == o.state &&
@@ -220,7 +210,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, created_on, failure_reason, language, planned_purge_date, space_view_id, state, time_zone, timeout_on, transaction, type, user_failure_message, version].hash
+      [created_on, failure_reason, id, language, linked_space_id, planned_purge_date, space_view_id, state, time_zone, timeout_on, transaction, type, user_failure_message, version].hash
     end
 
     # Builds the object from hash

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

@@ -20,99 +20,96 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ChargeAttempt
-    # 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 charge that the charge attempt belongs to.
     attr_accessor :charge
 
-    # 
+    # The behavior that controls when the transaction is completed.
     attr_accessor :completion_behavior
 
-    # 
+    # The payment connector configuration that was used for the charge attempt.
     attr_accessor :connector_configuration
 
     # The date and time when the object was created.
     attr_accessor :created_on
 
-    # The customers presence indicates which kind of customer interaction was used during the charge attempt.
+    # The customer's presence indicates whether and in what way the charge attempt's customer is present.
     attr_accessor :customers_presence
 
-    # 
+    # The environment in which the charge attempt is executed.
     attr_accessor :environment
 
-    # 
+    # The date and time when the charge attempt failed.
     attr_accessor :failed_on
 
-    # 
+    # The reason for the failure of the charge attempt.
     attr_accessor :failure_reason
 
-    # 
+    # A unique identifier for the object.
+    attr_accessor :id
+
+    # Whether a new token version is being initialized.
     attr_accessor :initializing_token_version
 
-    # 
+    # The connector invocation that the charge attempt belongs to.
     attr_accessor :invocation
 
-    # 
+    # The labels providing additional information about the object.
     attr_accessor :labels
 
     # The language that is linked to the object.
     attr_accessor :language
 
-    # 
+    # 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 date and time when the next update of the object's state is planned.
     attr_accessor :next_update_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 URL to redirect the customer to after payment processing.
     attr_accessor :redirection_url
 
-    # 
+    # The sales channel through which the charge attempt was made.
     attr_accessor :sales_channel
 
-    # 
+    # 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 date and time when the charge attempt succeeded.
     attr_accessor :succeeded_on
 
-    # 
+    # The payment terminal through which the charge attempt was made.
     attr_accessor :terminal
 
-    # 
+    # 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 token version used for the charge attempt.
     attr_accessor :token_version
 
-    # The user failure message contains the message for the user in case the attempt failed. The message is localized into the language specified on the transaction.
+    # The message that can be displayed to the customer explaining why the charge attempt failed, in the customer's language.
     attr_accessor :user_failure_message
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
     attr_accessor :version
 
-    # 
+    # The type of wallet used to make the charge attempt.
     attr_accessor :wallet
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'id' => :'id',
-        :'linked_space_id' => :'linkedSpaceId',
-        :'linked_transaction' => :'linkedTransaction',
         :'charge' => :'charge',
         :'completion_behavior' => :'completionBehavior',
         :'connector_configuration' => :'connectorConfiguration',
@@ -121,10 +118,13 @@ module PostFinanceCheckout
         :'environment' => :'environment',
         :'failed_on' => :'failedOn',
         :'failure_reason' => :'failureReason',
+        :'id' => :'id',
         :'initializing_token_version' => :'initializingTokenVersion',
         :'invocation' => :'invocation',
         :'labels' => :'labels',
         :'language' => :'language',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'linked_transaction' => :'linkedTransaction',
         :'next_update_on' => :'nextUpdateOn',
         :'planned_purge_date' => :'plannedPurgeDate',
         :'redirection_url' => :'redirectionUrl',
@@ -145,9 +145,6 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
         :'charge' => :'Charge',
         :'completion_behavior' => :'TransactionCompletionBehavior',
         :'connector_configuration' => :'PaymentConnectorConfiguration',
@@ -156,10 +153,13 @@ module PostFinanceCheckout
         :'environment' => :'ChargeAttemptEnvironment',
         :'failed_on' => :'DateTime',
         :'failure_reason' => :'FailureReason',
+        :'id' => :'Integer',
         :'initializing_token_version' => :'BOOLEAN',
         :'invocation' => :'ConnectorInvocation',
         :'labels' => :'Array<Label>',
         :'language' => :'String',
+        :'linked_space_id' => :'Integer',
+        :'linked_transaction' => :'Integer',
         :'next_update_on' => :'DateTime',
         :'planned_purge_date' => :'DateTime',
         :'redirection_url' => :'String',
@@ -185,18 +185,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?(:'charge')
         self.charge = attributes[:'charge']
       end
@@ -229,6 +217,10 @@ module PostFinanceCheckout
         self.failure_reason = attributes[:'failureReason']
       end
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'initializingTokenVersion')
         self.initializing_token_version = attributes[:'initializingTokenVersion']
       end
@@ -247,6 +239,14 @@ module PostFinanceCheckout
         self.language = attributes[:'language']
       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?(:'nextUpdateOn')
         self.next_update_on = attributes[:'nextUpdateOn']
       end
@@ -337,9 +337,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 &&
           charge == o.charge &&
           completion_behavior == o.completion_behavior &&
           connector_configuration == o.connector_configuration &&
@@ -348,10 +345,13 @@ module PostFinanceCheckout
           environment == o.environment &&
           failed_on == o.failed_on &&
           failure_reason == o.failure_reason &&
+          id == o.id &&
           initializing_token_version == o.initializing_token_version &&
           invocation == o.invocation &&
           labels == o.labels &&
           language == o.language &&
+          linked_space_id == o.linked_space_id &&
+          linked_transaction == o.linked_transaction &&
           next_update_on == o.next_update_on &&
           planned_purge_date == o.planned_purge_date &&
           redirection_url == o.redirection_url &&
@@ -377,7 +377,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, charge, completion_behavior, connector_configuration, created_on, customers_presence, environment, failed_on, failure_reason, initializing_token_version, invocation, labels, language, next_update_on, planned_purge_date, redirection_url, sales_channel, space_view_id, state, succeeded_on, terminal, time_zone, timeout_on, token_version, user_failure_message, version, wallet].hash
+      [charge, completion_behavior, connector_configuration, created_on, customers_presence, environment, failed_on, failure_reason, id, initializing_token_version, invocation, labels, language, linked_space_id, linked_transaction, next_update_on, planned_purge_date, redirection_url, sales_channel, space_view_id, state, succeeded_on, terminal, time_zone, timeout_on, token_version, user_failure_message, version, wallet].hash
     end
 
     # Builds the object from hash

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

@@ -20,34 +20,34 @@ require 'date'
 module PostFinanceCheckout
   # 
   class ChargeBankTransaction
+    # Provides general information about the bank transaction.
+    attr_accessor :bank_transaction
+
+    # The transaction completion this bank transaction is belongs to.
+    attr_accessor :completion
+
     # A unique identifier for the object.
     attr_accessor :id
 
+    # The language that is linked to the object.
+    attr_accessor :language
+
     # 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
 
-    # 
-    attr_accessor :bank_transaction
-
-    # 
-    attr_accessor :completion
-
-    # The language that is linked to the object.
-    attr_accessor :language
-
-    # 
+    # The ID of the space view this object is linked to.
     attr_accessor :space_view_id
 
-    # 
+    # The payment transaction this bank transaction belongs to.
     attr_accessor :transaction
 
-    # Specify the posting amount in the transaction's currency.
+    # The posting amount represents the monetary value of the bank transaction, recorded in the payment transaction's currency, before applying any adjustments.
     attr_accessor :transaction_currency_amount
 
-    # 
+    # The value amount represents the net monetary value of the bank transaction, recorded in the payment transaction's currency, after applicable deductions.
     attr_accessor :transaction_currency_value_amount
 
     # The version is used for optimistic locking and incremented whenever the object is updated.
@@ -56,12 +56,12 @@ 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',
         :'bank_transaction' => :'bankTransaction',
         :'completion' => :'completion',
+        :'id' => :'id',
         :'language' => :'language',
+        :'linked_space_id' => :'linkedSpaceId',
+        :'linked_transaction' => :'linkedTransaction',
         :'space_view_id' => :'spaceViewId',
         :'transaction' => :'transaction',
         :'transaction_currency_amount' => :'transactionCurrencyAmount',
@@ -73,12 +73,12 @@ module PostFinanceCheckout
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'id' => :'Integer',
-        :'linked_space_id' => :'Integer',
-        :'linked_transaction' => :'Integer',
         :'bank_transaction' => :'BankTransaction',
         :'completion' => :'Integer',
+        :'id' => :'Integer',
         :'language' => :'String',
+        :'linked_space_id' => :'Integer',
+        :'linked_transaction' => :'Integer',
         :'space_view_id' => :'Integer',
         :'transaction' => :'Transaction',
         :'transaction_currency_amount' => :'Float',
@@ -95,18 +95,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?(:'bankTransaction')
         self.bank_transaction = attributes[:'bankTransaction']
       end
@@ -115,10 +103,22 @@ module PostFinanceCheckout
         self.completion = attributes[:'completion']
       end
 
+      if attributes.has_key?(:'id')
+        self.id = attributes[:'id']
+      end
+
       if attributes.has_key?(:'language')
         self.language = attributes[:'language']
       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?(:'spaceViewId')
         self.space_view_id = attributes[:'spaceViewId']
       end
@@ -158,12 +158,12 @@ 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 &&
           bank_transaction == o.bank_transaction &&
           completion == o.completion &&
+          id == o.id &&
           language == o.language &&
+          linked_space_id == o.linked_space_id &&
+          linked_transaction == o.linked_transaction &&
           space_view_id == o.space_view_id &&
           transaction == o.transaction &&
           transaction_currency_amount == o.transaction_currency_amount &&
@@ -180,7 +180,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, linked_space_id, linked_transaction, bank_transaction, completion, language, space_view_id, transaction, transaction_currency_amount, transaction_currency_value_amount, version].hash
+      [bank_transaction, completion, id, language, linked_space_id, linked_transaction, space_view_id, transaction, transaction_currency_amount, transaction_currency_value_amount, version].hash
     end
 
     # Builds the object from hash