postfinancecheckout-ruby-sdk 4.5.0 → 5.2.0

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

@@ -18,21 +18,25 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # This model holds the card data in plain.
+  # 
   class TokenizedCardData
-    # 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
 
     # 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'
       }
@@ -42,6 +46,7 @@ module PostFinanceCheckout
     def self.swagger_types
       {
         :'cryptogram' => :'CardCryptogram',
+        :'initial_recurring_transaction' => :'BOOLEAN',
         :'recurring_indicator' => :'RecurringIndicator',
         :'token_requestor_id' => :'String'
       }
@@ -59,6 +64,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
@@ -87,6 +96,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
     end
@@ -100,7 +110,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cryptogram, recurring_indicator, token_requestor_id].hash
+      [cryptogram, initial_recurring_transaction, recurring_indicator, token_requestor_id].hash
     end
 
     # Builds the object from hash

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

@@ -18,30 +18,33 @@ limitations under the License.
 require 'date'
 
 module PostFinanceCheckout
-  # This model holds the card data in plain.
+  # 
   class TokenizedCardDataCreate
-    # 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 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.
@@ -51,6 +54,7 @@ module PostFinanceCheckout
         :'card_verification_code' => :'cardVerificationCode',
         :'cryptogram' => :'cryptogram',
         :'expiry_date' => :'expiryDate',
+        :'pan_type' => :'panType',
         :'primary_account_number' => :'primaryAccountNumber',
         :'recurring_indicator' => :'recurringIndicator',
         :'scheme_transaction_reference' => :'schemeTransactionReference',
@@ -65,6 +69,7 @@ module PostFinanceCheckout
         :'card_verification_code' => :'String',
         :'cryptogram' => :'CardCryptogramCreate',
         :'expiry_date' => :'String',
+        :'pan_type' => :'PanType',
         :'primary_account_number' => :'String',
         :'recurring_indicator' => :'RecurringIndicator',
         :'scheme_transaction_reference' => :'String',
@@ -96,6 +101,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
@@ -222,6 +231,7 @@ module PostFinanceCheckout
           card_verification_code == o.card_verification_code &&
           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 &&
@@ -237,7 +247,7 @@ module PostFinanceCheckout
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [card_holder_name, card_verification_code, cryptogram, expiry_date, primary_account_number, recurring_indicator, scheme_transaction_reference, token_requestor_id].hash
+      [card_holder_name, card_verification_code, 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/transaction.rb

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

@@ -44,7 +44,7 @@ module PostFinanceCheckout
     # 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/postfinancecheckout-ruby-sdk/models/transaction_comment_create.rb

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