chore: synced file(s) with sumup/apis

src/Checkouts/Checkouts.php

@@ -80,6 +80,7 @@ private static function assertRequiredFields(array $data, array $requiredFields)
 class CheckoutsListAvailablePaymentMethodsResponse
 {
     /**
+     * Payment methods available to the merchant for the checkout.
      *
      * @var CheckoutsListAvailablePaymentMethodsResponseItem[]|null
      */
@@ -90,7 +91,7 @@ class CheckoutsListAvailablePaymentMethodsResponse
 class CheckoutsListAvailablePaymentMethodsResponseItem
 {
     /**
-     * The ID of the payment method.
+     * Unique identifier of the payment method.
      *
      * @var string
      */
@@ -106,7 +107,7 @@ class CheckoutsListAvailablePaymentMethodsResponseItem
 class CheckoutsListParams
 {
     /**
-     * Filters the list of checkout resources by the unique ID of the checkout.
+     * Filters the list of checkout resources by the unique reference of the checkout.
      *
      * @var string|null
      */
@@ -223,7 +224,7 @@ public function create(\SumUp\Types\CheckoutCreateRequest|array $body, ?RequestO
     /**
      * Create an Apple Pay session
      *
-     * @param string $checkoutId Unique ID of the checkout resource.
+     * @param string $checkoutId Unique identifier of the checkout resource.
      * @param CheckoutsCreateApplePaySessionRequest|array<string, mixed>|null $body Optional request payload
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
@@ -259,7 +260,7 @@ public function createApplePaySession(string $checkoutId, CheckoutsCreateApplePa
     /**
      * Deactivate a checkout
      *
-     * @param string $checkoutId Unique ID of the checkout resource.
+     * @param string $checkoutId Unique identifier of the checkout resource.
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
      * @return \SumUp\Types\Checkout
@@ -286,7 +287,7 @@ public function deactivate(string $checkoutId, ?RequestOptions $requestOptions =
     /**
      * Retrieve a checkout
      *
-     * @param string $checkoutId Unique ID of the checkout resource.
+     * @param string $checkoutId Unique identifier of the checkout resource.
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
      * @return \SumUp\Types\CheckoutSuccess
@@ -351,7 +352,7 @@ public function list(?CheckoutsListParams $queryParams = null, ?RequestOptions $
     /**
      * Get available payment methods
      *
-     * @param string $merchantCode The SumUp merchant code.
+     * @param string $merchantCode Short unique identifier for the merchant.
      * @param CheckoutsListAvailablePaymentMethodsParams|null $queryParams Optional query string parameters
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
@@ -392,7 +393,7 @@ public function listAvailablePaymentMethods(string $merchantCode, ?CheckoutsList
     /**
      * Process a checkout
      *
-     * @param string $checkoutId Unique ID of the checkout resource.
+     * @param string $checkoutId Unique identifier of the checkout resource.
      * @param \SumUp\Types\ProcessCheckout|array<string, mixed> $body Required request payload
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
@@ -429,7 +430,7 @@ public function process(string $checkoutId, \SumUp\Types\ProcessCheckout|array $
     /**
      * Update a checkout
      *
-     * @param string $checkoutId Unique ID of the checkout resource.
+     * @param string $checkoutId Unique identifier of the checkout resource.
      * @param \SumUp\Types\CheckoutUpdateRequest|array<string, mixed> $body Required request payload
      * @param RequestOptions|null $requestOptions Optional typed request options
      *

src/Customers/Customers.php

@@ -126,7 +126,7 @@ public function create(\SumUp\Types\Customer|array $body, ?RequestOptions $reque
     /**
      * Deactivate a payment instrument
      *
-     * @param string $customerId Unique ID of the saved customer resource.
+     * @param string $customerId Unique identifier of the saved customer resource.
      * @param string $token Unique token identifying the card saved as a payment instrument resource.
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
@@ -157,7 +157,7 @@ public function deactivatePaymentInstrument(string $customerId, string $token, ?
     /**
      * Retrieve a customer
      *
-     * @param string $customerId Unique ID of the saved customer resource.
+     * @param string $customerId Unique identifier of the saved customer resource.
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
      * @return \SumUp\Types\Customer
@@ -184,7 +184,7 @@ public function get(string $customerId, ?RequestOptions $requestOptions = null):
     /**
      * List payment instruments
      *
-     * @param string $customerId Unique ID of the saved customer resource.
+     * @param string $customerId Unique identifier of the saved customer resource.
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
      * @return \SumUp\Types\PaymentInstrumentResponse[]
@@ -213,7 +213,7 @@ public function listPaymentInstruments(string $customerId, ?RequestOptions $requ
     /**
      * Update a customer
      *
-     * @param string $customerId Unique ID of the saved customer resource.
+     * @param string $customerId Unique identifier of the saved customer resource.
      * @param CustomersUpdateRequest|array<string, mixed> $body Required request payload
      * @param RequestOptions|null $requestOptions Optional typed request options
      *

src/Payouts/Payouts.php

@@ -95,7 +95,7 @@ public function __construct(HttpClientInterface $client, string $accessToken)
     /**
      * List payouts
      *
-     * @param string $merchantCode Merchant code of the account whose payouts should be listed.
+     * @param string $merchantCode Short unique identifier for the merchant.
      * @param PayoutsListParams|null $queryParams Optional query string parameters
      * @param RequestOptions|null $requestOptions Optional typed request options
      *

src/Readers/Readers.php

@@ -165,6 +165,8 @@ class ReadersListResponse
 /**
  * Class Readers
  *
+ * A reader represents a device that accepts payments. You can use the SumUp Solo to accept in-person payments.
+ *
  * @package SumUp\Services
  */
 class Readers implements SumUpService
@@ -299,7 +301,6 @@ public function createGoCheckout(string $merchantCode, string $readerId, \SumUp\
             '401' => ['type' => 'class', 'class' => \SumUp\Types\Problem::class],
             '404' => ['type' => 'class', 'class' => \SumUp\Types\Problem::class],
             '422' => ['type' => 'class', 'class' => \SumUp\Types\Problem::class],
-            '500' => ['type' => 'class', 'class' => \SumUp\Types\Problem::class],
         ], 'POST', $path);
     }
 

src/Receipts/Receipts.php

@@ -19,14 +19,14 @@
 class ReceiptsGetParams
 {
     /**
-     * Merchant code.
+     * Short unique identifier for the merchant.
      *
      * @var string
      */
     public string $mid;
 
     /**
-     * The ID of the transaction event (refund).
+     * Unique identifier of the transaction event to include on the receipt.
      *
      * @var int|null
      */

src/Transactions/Transactions.php

@@ -55,12 +55,14 @@ public static function fromArray(array $data): self
 class TransactionsListResponse
 {
     /**
+     * Transactions in the current result page.
      *
      * @var \SumUp\Types\TransactionHistory[]|null
      */
     public ?array $items = null;
 
     /**
+     * Pagination links for navigating the transaction history.
      *
      * @var \SumUp\Types\TransactionsHistoryLink[]|null
      */
@@ -90,14 +92,14 @@ class TransactionsGetParams
     public ?string $transactionCode = null;
 
     /**
-     * External/foreign transaction id (passed by clients).
+     * External transaction identifier supplied by the client.
      *
      * @var string|null
      */
     public ?string $foreignTransactionId = null;
 
     /**
-     * Client transaction id.
+     * Client-supplied identifier of the transaction.
      *
      * @var string|null
      */
@@ -260,7 +262,7 @@ public function __construct(HttpClientInterface $client, string $accessToken)
     /**
      * Retrieve a transaction
      *
-     * @param string $merchantCode Merchant code of the account whose transaction should be retrieved.
+     * @param string $merchantCode Short unique identifier for the merchant.
      * @param TransactionsGetParams|null $queryParams Optional query string parameters
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
@@ -308,7 +310,7 @@ public function get(string $merchantCode, ?TransactionsGetParams $queryParams =
     /**
      * List transactions
      *
-     * @param string $merchantCode Merchant code of the account whose transaction history should be listed.
+     * @param string $merchantCode Short unique identifier for the merchant.
      * @param TransactionsListParams|null $queryParams Optional query string parameters
      * @param RequestOptions|null $requestOptions Optional typed request options
      *
@@ -383,8 +385,8 @@ public function list(string $merchantCode, ?TransactionsListParams $queryParams
     /**
      * Refund a transaction
      *
-     * @param string $merchantCode Merchant code of the account that owns the payment to refund.
-     * @param string $transactionId Unique ID of the transaction.
+     * @param string $merchantCode Short unique identifier for the merchant.
+     * @param string $transactionId Unique identifier of the transaction.
      * @param TransactionsRefundRequest|array<string, mixed>|null $body Optional request payload
      * @param RequestOptions|null $requestOptions Optional typed request options
      *

src/Types/Checkout.php

@@ -24,14 +24,14 @@ class Checkout
     public ?float $amount = null;
 
     /**
-     * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.
+     * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
      *
      * @var CheckoutCurrency|null
      */
     public ?CheckoutCurrency $currency = null;
 
     /**
-     * Merchant account that receives the payment.
+     * Short unique identifier for the merchant that receives the payment.
      *
      * @var string|null
      */
@@ -66,7 +66,7 @@ class Checkout
     public ?CheckoutStatus $status = null;
 
     /**
-     * Date and time of the creation of the payment checkout. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.
+     * The timestamp of when the checkout was created.
      *
      * @var string|null
      */

src/Types/CheckoutCreateRequest.php

@@ -24,14 +24,14 @@ class CheckoutCreateRequest
     public float $amount;
 
     /**
-     * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.
+     * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
      *
      * @var CheckoutCreateRequestCurrency
      */
     public CheckoutCreateRequestCurrency $currency;
 
     /**
-     * Merchant account that should receive the payment.
+     * Short unique identifier for the merchant that should receive the payment.
      *
      * @var string
      */

src/Types/CheckoutCreateRequestCurrency.php

@@ -5,7 +5,7 @@
 namespace SumUp\Types;
 
 /**
- * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.
+ * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
  */
 enum CheckoutCreateRequestCurrency: string
 {

src/Types/CheckoutCurrency.php

@@ -5,7 +5,7 @@
 namespace SumUp\Types;
 
 /**
- * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.
+ * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
  */
 enum CheckoutCurrency: string
 {

src/Types/CheckoutSuccess.php

@@ -24,14 +24,14 @@ class CheckoutSuccess
     public ?float $amount = null;
 
     /**
-     * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.
+     * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
      *
      * @var string|null
      */
     public ?string $currency = null;
 
     /**
-     * Merchant account that receives the payment.
+     * Short unique identifier for the merchant that receives the payment.
      *
      * @var string|null
      */
@@ -66,7 +66,7 @@ class CheckoutSuccess
     public ?string $status = null;
 
     /**
-     * Date and time of the creation of the payment checkout. Response format expressed according to [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) code.
+     * The timestamp of when the checkout was created.
      *
      * @var string|null
      */
@@ -115,14 +115,14 @@ class CheckoutSuccess
     public ?string $transactionCode = null;
 
     /**
-     * Transaction ID of the successful transaction with which the payment for the checkout is completed.
+     * Unique identifier of the successful transaction that completed payment for the checkout.
      *
      * @var string|null
      */
     public ?string $transactionId = null;
 
     /**
-     * Name of the merchant
+     * Name of the merchant.
      *
      * @var string|null
      */

src/Types/CheckoutSuccessPaymentInstrument.php

@@ -10,7 +10,7 @@
 class CheckoutSuccessPaymentInstrument
 {
     /**
-     * Token value
+     * Unique token of the saved payment instrument.
      *
      * @var string|null
      */

src/Types/CheckoutUpdateRequest.php

@@ -17,7 +17,7 @@ class CheckoutUpdateRequest
     public ?float $amount = null;
 
     /**
-     * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.
+     * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
      *
      * @var CheckoutUpdateRequestCurrency|null
      */

src/Types/CheckoutUpdateRequestCurrency.php

@@ -5,7 +5,7 @@
 namespace SumUp\Types;
 
 /**
- * Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.
+ * Three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the amount.
  */
 enum CheckoutUpdateRequestCurrency: string
 {

src/Types/Customer.php

@@ -10,7 +10,7 @@
 class Customer
 {
     /**
-     * Unique ID of the customer.
+     * Unique identifier of the customer.
      *
      * @var string
      */

src/Types/DetailsError.php

@@ -5,7 +5,7 @@
 namespace SumUp\Types;
 
 /**
- * Error message structure.
+ * Details of a request validation error.
  */
 class DetailsError
 {
@@ -24,7 +24,7 @@ class DetailsError
     public ?string $details = null;
 
     /**
-     * The status code.
+     * HTTP status code for the error.
      *
      * @var float|null
      */

src/Types/Error.php

@@ -5,7 +5,7 @@
 namespace SumUp\Types;
 
 /**
- * Error message structure.
+ * Details of an API error.
  */
 class Error
 {

src/Types/ErrorForbidden.php

@@ -5,7 +5,7 @@
 namespace SumUp\Types;
 
 /**
- * Error message for forbidden requests.
+ * Details of an error returned for a forbidden request.
  */
 class ErrorForbidden
 {