chore: generate code

Author: sumup-bot[bot]

src/main/java/com/sumup/sdk/clients/CheckoutsAsyncClient.java

@@ -14,10 +14,19 @@
 /**
  * Client for the "Checkouts" API group.
  *
- * <p>Accept payments from your end users by adding the Checkouts model to your platform. SumUp
- * supports standard and single payment 3DS checkout flows. The Checkout model allows creating,
- * listing, retrieving, processing and deactivating checkouts. A payment is completed by creating a
- * checkout and then processing the checkout.
+ * <p>Checkouts represent online payment sessions that you create before attempting to charge a
+ * payer. A checkout captures the payment intent, such as the amount, currency, merchant, and
+ * optional customer or redirect settings, and then moves through its lifecycle as you process it.
+ * Use this tag to: - create a checkout before collecting or confirming payment details - process
+ * the checkout with a card, saved card, wallet, or supported alternative payment method - retrieve
+ * or list checkouts to inspect their current state and associated payment attempts - deactivate a
+ * checkout that should no longer be used Typical workflow: - create a checkout with the order
+ * amount, currency, and merchant information - process the checkout through SumUp client tools such
+ * as the [Payment Widget and Swift Checkout
+ * SDK](https://developer.sumup.com/online-payments/checkouts) - retrieve the checkout or use the
+ * Transactions endpoints to inspect the resulting payment record Checkouts are used to initiate and
+ * orchestrate online payments. Transactions remain the authoritative record of the resulting
+ * payment outcome.
  */
 public final class CheckoutsAsyncClient {
   private final ApiClient apiClient;

src/main/java/com/sumup/sdk/clients/CheckoutsClient.java

@@ -13,10 +13,19 @@
 /**
  * Client for the "Checkouts" API group.
  *
- * <p>Accept payments from your end users by adding the Checkouts model to your platform. SumUp
- * supports standard and single payment 3DS checkout flows. The Checkout model allows creating,
- * listing, retrieving, processing and deactivating checkouts. A payment is completed by creating a
- * checkout and then processing the checkout.
+ * <p>Checkouts represent online payment sessions that you create before attempting to charge a
+ * payer. A checkout captures the payment intent, such as the amount, currency, merchant, and
+ * optional customer or redirect settings, and then moves through its lifecycle as you process it.
+ * Use this tag to: - create a checkout before collecting or confirming payment details - process
+ * the checkout with a card, saved card, wallet, or supported alternative payment method - retrieve
+ * or list checkouts to inspect their current state and associated payment attempts - deactivate a
+ * checkout that should no longer be used Typical workflow: - create a checkout with the order
+ * amount, currency, and merchant information - process the checkout through SumUp client tools such
+ * as the [Payment Widget and Swift Checkout
+ * SDK](https://developer.sumup.com/online-payments/checkouts) - retrieve the checkout or use the
+ * Transactions endpoints to inspect the resulting payment record Checkouts are used to initiate and
+ * orchestrate online payments. Transactions remain the authoritative record of the resulting
+ * payment outcome.
  */
 public final class CheckoutsClient {
   private final ApiClient apiClient;

src/main/java/com/sumup/sdk/clients/PayoutsAsyncClient.java

@@ -33,7 +33,7 @@ public PayoutsAsyncClient(ApiClient apiClient) {
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayouts
    *
@@ -52,7 +52,7 @@ public CompletableFuture<com.sumup.sdk.models.FinancialPayouts> listPayouts(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayouts
    *
@@ -75,7 +75,7 @@ public CompletableFuture<com.sumup.sdk.models.FinancialPayouts> listPayouts(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayouts
    *
@@ -116,7 +116,7 @@ public CompletableFuture<com.sumup.sdk.models.FinancialPayouts> listPayouts(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayoutsV1
    *
@@ -137,7 +137,7 @@ public CompletableFuture<com.sumup.sdk.models.FinancialPayouts> listPayoutsV1(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayoutsV1
    *
@@ -162,7 +162,7 @@ public CompletableFuture<com.sumup.sdk.models.FinancialPayouts> listPayoutsV1(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayoutsV1
    *

src/main/java/com/sumup/sdk/clients/PayoutsClient.java

@@ -32,7 +32,7 @@ public PayoutsClient(ApiClient apiClient) {
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayouts
    *
@@ -51,7 +51,7 @@ public com.sumup.sdk.models.FinancialPayouts listPayouts(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayouts
    *
@@ -74,7 +74,7 @@ public com.sumup.sdk.models.FinancialPayouts listPayouts(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayouts
    *
@@ -115,7 +115,7 @@ public com.sumup.sdk.models.FinancialPayouts listPayouts(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayoutsV1
    *
@@ -136,7 +136,7 @@ public com.sumup.sdk.models.FinancialPayouts listPayoutsV1(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayoutsV1
    *
@@ -161,7 +161,7 @@ public com.sumup.sdk.models.FinancialPayouts listPayoutsV1(
   /**
    * List payouts
    *
-   * <p>Lists ordered payouts for the merchant profile.
+   * <p>Lists ordered payouts for the merchant account.
    *
    * <p>Operation ID: ListPayoutsV1
    *

src/main/java/com/sumup/sdk/clients/TransactionsAsyncClient.java

@@ -14,8 +14,22 @@
 /**
  * Client for the "Transactions" API group.
  *
- * <p>Retrieve details for a specific transaction by it’s `id` or any other required query
- * parameter, or list all transactions related to the merchant account.
+ * <p>Transactions represent completed or attempted payment operations processed for a merchant
+ * account. A transaction contains the core payment result, such as the amount, currency, payment
+ * method, creation time, and current high-level status. In addition to the main payment outcome, a
+ * transaction can contain related events that describe what happened after the original payment
+ * attempt. These events provide visibility into the financial lifecycle of the transaction, for
+ * example: - `PAYOUT`: the payment being prepared for payout or included in a payout to the
+ * merchant - `REFUND`: money returned to the payer - `CHARGE_BACK`: money reversed after the
+ * original payment - `PAYOUT_DEDUCTION`: an amount deducted from a payout to cover a refund or
+ * chargeback From an integrator's perspective, transactions are the authoritative record of payment
+ * outcomes. Use this tag to: - list transactions for reporting, reconciliation, and customer
+ * support workflows - retrieve a single transaction when you need the latest payment details -
+ * inspect `simple_status` for the current merchant-facing outcome of the payment - inspect `events`
+ * or `transaction_events` when you need refund, payout, or chargeback history Typical workflow: -
+ * create and process payments through the Checkouts endpoints - use the Transactions endpoints to
+ * read the resulting payment records - use the returned statuses and events to update your own
+ * order, accounting, or support systems
  */
 public final class TransactionsAsyncClient {
   private final ApiClient apiClient;
@@ -33,8 +47,8 @@ public TransactionsAsyncClient(ApiClient apiClient) {
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransaction
    *
@@ -53,8 +67,8 @@ public CompletableFuture<com.sumup.sdk.models.TransactionFull> getTransaction()
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransaction
    *
@@ -73,8 +87,8 @@ public CompletableFuture<com.sumup.sdk.models.TransactionFull> getTransaction(
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransaction
    *
@@ -106,8 +120,8 @@ public CompletableFuture<com.sumup.sdk.models.TransactionFull> getTransaction(
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransactionV2.1
    *
@@ -126,8 +140,8 @@ public CompletableFuture<com.sumup.sdk.models.TransactionFull> getTransactionV21
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransactionV2.1
    *
@@ -147,8 +161,8 @@ public CompletableFuture<com.sumup.sdk.models.TransactionFull> getTransactionV21
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransactionV2.1
    *

src/main/java/com/sumup/sdk/clients/TransactionsClient.java

@@ -13,8 +13,22 @@
 /**
  * Client for the "Transactions" API group.
  *
- * <p>Retrieve details for a specific transaction by it’s `id` or any other required query
- * parameter, or list all transactions related to the merchant account.
+ * <p>Transactions represent completed or attempted payment operations processed for a merchant
+ * account. A transaction contains the core payment result, such as the amount, currency, payment
+ * method, creation time, and current high-level status. In addition to the main payment outcome, a
+ * transaction can contain related events that describe what happened after the original payment
+ * attempt. These events provide visibility into the financial lifecycle of the transaction, for
+ * example: - `PAYOUT`: the payment being prepared for payout or included in a payout to the
+ * merchant - `REFUND`: money returned to the payer - `CHARGE_BACK`: money reversed after the
+ * original payment - `PAYOUT_DEDUCTION`: an amount deducted from a payout to cover a refund or
+ * chargeback From an integrator's perspective, transactions are the authoritative record of payment
+ * outcomes. Use this tag to: - list transactions for reporting, reconciliation, and customer
+ * support workflows - retrieve a single transaction when you need the latest payment details -
+ * inspect `simple_status` for the current merchant-facing outcome of the payment - inspect `events`
+ * or `transaction_events` when you need refund, payout, or chargeback history Typical workflow: -
+ * create and process payments through the Checkouts endpoints - use the Transactions endpoints to
+ * read the resulting payment records - use the returned statuses and events to update your own
+ * order, accounting, or support systems
  */
 public final class TransactionsClient {
   private final ApiClient apiClient;
@@ -32,8 +46,8 @@ public TransactionsClient(ApiClient apiClient) {
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransaction
    *
@@ -51,8 +65,8 @@ public com.sumup.sdk.models.TransactionFull getTransaction() throws ApiException
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransaction
    *
@@ -71,8 +85,8 @@ public com.sumup.sdk.models.TransactionFull getTransaction(
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransaction
    *
@@ -104,8 +118,8 @@ public com.sumup.sdk.models.TransactionFull getTransaction(
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransactionV2.1
    *
@@ -124,8 +138,8 @@ public com.sumup.sdk.models.TransactionFull getTransactionV21(String merchantCod
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransactionV2.1
    *
@@ -145,8 +159,8 @@ public com.sumup.sdk.models.TransactionFull getTransactionV21(
    * Retrieve a transaction
    *
    * <p>Retrieves the full details of an identified transaction. The transaction resource is
-   * identified by a query parameter and *one* of following parameters is required: * `id` *
-   * `internal_id` * `transaction_code` * `foreign_transaction_id` * `client_transaction_id`
+   * identified by a query parameter and *one* of following parameters is required: - `id` -
+   * `internal_id` - `transaction_code` - `foreign_transaction_id` - `client_transaction_id`
    *
    * <p>Operation ID: GetTransactionV2.1
    *