feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: 85e424bee4fe449466ceada88117613e
+openapi_spec_hash: 4b35e1ea5ca1121f4c8d11ff7ee6255b
 config_hash: 1ca082e374ef7000e2a5971e8da740e0

src/InboundCheckDeposits/InboundCheckDeposit/Adjustment.php

@@ -29,7 +29,7 @@ final class Adjustment implements BaseModel
     public \DateTimeInterface $adjustedAt;
 
     /**
-     * The amount of the adjustment.
+     * The amount of the adjustment in USD cents. A positive amount is a credit to your account and a negative amount is a debit.
      */
     #[Required]
     public int $amount;
@@ -106,7 +106,7 @@ public function withAdjustedAt(\DateTimeInterface $adjustedAt): self
     }
 
     /**
-     * The amount of the adjustment.
+     * The amount of the adjustment in USD cents. A positive amount is a credit to your account and a negative amount is a debit.
      */
     public function withAmount(int $amount): self
     {

src/InboundFednowTransfers/InboundFednowTransfer.php

@@ -32,8 +32,10 @@
  *   debtorName: string,
  *   debtorRoutingNumber: string,
  *   decline: null|Decline|DeclineShape,
+ *   endToEndIdentification: string|null,
  *   status: Status|value-of<Status>,
  *   transactionID: string|null,
+ *   transactionIdentification: string|null,
  *   type: Type|value-of<Type>,
  *   uniqueEndToEndTransactionReference: string|null,
  *   unstructuredRemittanceInformation: string|null,
@@ -118,6 +120,12 @@ final class InboundFednowTransfer implements BaseModel
     #[Required]
     public ?Decline $decline;
 
+    /**
+     * A free-form reference string set by the sender, to help identify the transfer.
+     */
+    #[Required('end_to_end_identification')]
+    public ?string $endToEndIdentification;
+
     /**
      * The lifecycle status of the transfer.
      *
@@ -132,6 +140,12 @@ final class InboundFednowTransfer implements BaseModel
     #[Required('transaction_id')]
     public ?string $transactionID;
 
+    /**
+     * The FedNow network identification of the transfer.
+     */
+    #[Required('transaction_identification')]
+    public ?string $transactionIdentification;
+
     /**
      * A constant representing the object's type. For this resource it will always be `inbound_fednow_transfer`.
      *
@@ -170,8 +184,10 @@ final class InboundFednowTransfer implements BaseModel
      *   debtorName: ...,
      *   debtorRoutingNumber: ...,
      *   decline: ...,
+     *   endToEndIdentification: ...,
      *   status: ...,
      *   transactionID: ...,
+     *   transactionIdentification: ...,
      *   type: ...,
      *   uniqueEndToEndTransactionReference: ...,
      *   unstructuredRemittanceInformation: ...,
@@ -194,8 +210,10 @@ final class InboundFednowTransfer implements BaseModel
      *   ->withDebtorName(...)
      *   ->withDebtorRoutingNumber(...)
      *   ->withDecline(...)
+     *   ->withEndToEndIdentification(...)
      *   ->withStatus(...)
      *   ->withTransactionID(...)
+     *   ->withTransactionIdentification(...)
      *   ->withType(...)
      *   ->withUniqueEndToEndTransactionReference(...)
      *   ->withUnstructuredRemittanceInformation(...)
@@ -230,8 +248,10 @@ public static function with(
         string $debtorName,
         string $debtorRoutingNumber,
         Decline|array|null $decline,
+        ?string $endToEndIdentification,
         Status|string $status,
         ?string $transactionID,
+        ?string $transactionIdentification,
         Type|string $type,
         ?string $uniqueEndToEndTransactionReference,
         ?string $unstructuredRemittanceInformation,
@@ -250,8 +270,10 @@ public static function with(
         $self['debtorName'] = $debtorName;
         $self['debtorRoutingNumber'] = $debtorRoutingNumber;
         $self['decline'] = $decline;
+        $self['endToEndIdentification'] = $endToEndIdentification;
         $self['status'] = $status;
         $self['transactionID'] = $transactionID;
+        $self['transactionIdentification'] = $transactionIdentification;
         $self['type'] = $type;
         $self['uniqueEndToEndTransactionReference'] = $uniqueEndToEndTransactionReference;
         $self['unstructuredRemittanceInformation'] = $unstructuredRemittanceInformation;
@@ -398,6 +420,18 @@ public function withDecline(Decline|array|null $decline): self
         return $self;
     }
 
+    /**
+     * A free-form reference string set by the sender, to help identify the transfer.
+     */
+    public function withEndToEndIdentification(
+        ?string $endToEndIdentification
+    ): self {
+        $self = clone $this;
+        $self['endToEndIdentification'] = $endToEndIdentification;
+
+        return $self;
+    }
+
     /**
      * The lifecycle status of the transfer.
      *
@@ -422,6 +456,18 @@ public function withTransactionID(?string $transactionID): self
         return $self;
     }
 
+    /**
+     * The FedNow network identification of the transfer.
+     */
+    public function withTransactionIdentification(
+        ?string $transactionIdentification
+    ): self {
+        $self = clone $this;
+        $self['transactionIdentification'] = $transactionIdentification;
+
+        return $self;
+    }
+
     /**
      * A constant representing the object's type. For this resource it will always be `inbound_fednow_transfer`.
      *

src/PhysicalCards/PhysicalCardCreateParams.php

@@ -40,7 +40,7 @@ final class PhysicalCardCreateParams implements BaseModel
     public string $cardID;
 
     /**
-     * Details about the cardholder, as it will appear on the physical card.
+     * Details about the cardholder, as it will appear on the physical card. The combined first name and last name cannot exceed 25 characters.
      */
     #[Required]
     public Cardholder $cardholder;
@@ -116,7 +116,7 @@ public function withCardID(string $cardID): self
     }
 
     /**
-     * Details about the cardholder, as it will appear on the physical card.
+     * Details about the cardholder, as it will appear on the physical card. The combined first name and last name cannot exceed 25 characters.
      *
      * @param Cardholder|CardholderShape $cardholder
      */

src/PhysicalCards/PhysicalCardCreateParams/Cardholder.php

@@ -9,7 +9,7 @@
 use Increase\Core\Contracts\BaseModel;
 
 /**
- * Details about the cardholder, as it will appear on the physical card.
+ * Details about the cardholder, as it will appear on the physical card. The combined first name and last name cannot exceed 25 characters.
  *
  * @phpstan-type CardholderShape = array{firstName: string, lastName: string}
  */

src/ServiceContracts/PhysicalCardsContract.php

@@ -25,7 +25,7 @@ interface PhysicalCardsContract
      * @api
      *
      * @param string $cardID the underlying card representing this physical card
-     * @param Cardholder|CardholderShape $cardholder details about the cardholder, as it will appear on the physical card
+     * @param Cardholder|CardholderShape $cardholder Details about the cardholder, as it will appear on the physical card. The combined first name and last name cannot exceed 25 characters.
      * @param Shipment|ShipmentShape $shipment the details used to ship this physical card
      * @param string $physicalCardProfileID The physical card profile to use for this physical card. The latest default physical card profile will be used if not provided.
      * @param RequestOpts|null $requestOptions

src/ServiceContracts/Simulations/InboundCheckDepositsContract.php

@@ -38,7 +38,7 @@ public function create(
      * @api
      *
      * @param string $inboundCheckDepositID the identifier of the Inbound Check Deposit to adjust
-     * @param int $amount The adjustment amount in cents. Defaults to the amount of the Inbound Check Deposit.
+     * @param int $amount The adjustment amount in cents. A positive amount means that the funds are being returned to you by the other bank and is a credit to your account, as happens for a `wrong_payee_credit`. A negative amount is a debit to your account, as happens for a `late_return`. Defaults to the amount of the Inbound Check Deposit.
      * @param Reason|value-of<Reason> $reason The reason for the adjustment. Defaults to `wrong_payee_credit`.
      * @param RequestOpts|null $requestOptions
      *

src/Services/PhysicalCardsService.php

@@ -43,7 +43,7 @@ public function __construct(private Client $client)
      * Create a Physical Card
      *
      * @param string $cardID the underlying card representing this physical card
-     * @param Cardholder|CardholderShape $cardholder details about the cardholder, as it will appear on the physical card
+     * @param Cardholder|CardholderShape $cardholder Details about the cardholder, as it will appear on the physical card. The combined first name and last name cannot exceed 25 characters.
      * @param Shipment|ShipmentShape $shipment the details used to ship this physical card
      * @param string $physicalCardProfileID The physical card profile to use for this physical card. The latest default physical card profile will be used if not provided.
      * @param RequestOpts|null $requestOptions

src/Services/Simulations/InboundCheckDepositsRawService.php

@@ -69,7 +69,7 @@ public function create(
      *
      * @param string $inboundCheckDepositID the identifier of the Inbound Check Deposit to adjust
      * @param array{
-     *   amount?: int, reason?: value-of<Reason>
+     *   amount?: int, reason?: Reason|value-of<Reason>
      * }|InboundCheckDepositAdjustmentParams $params
      * @param RequestOpts|null $requestOptions
      *

src/Services/Simulations/InboundCheckDepositsService.php

@@ -72,7 +72,7 @@ public function create(
      * Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit must have a `status` of `accepted`.
      *
      * @param string $inboundCheckDepositID the identifier of the Inbound Check Deposit to adjust
-     * @param int $amount The adjustment amount in cents. Defaults to the amount of the Inbound Check Deposit.
+     * @param int $amount The adjustment amount in cents. A positive amount means that the funds are being returned to you by the other bank and is a credit to your account, as happens for a `wrong_payee_credit`. A negative amount is a debit to your account, as happens for a `late_return`. Defaults to the amount of the Inbound Check Deposit.
      * @param Reason|value-of<Reason> $reason The reason for the adjustment. Defaults to `wrong_payee_credit`.
      * @param RequestOpts|null $requestOptions
      *

src/Simulations/InboundCheckDeposits/InboundCheckDepositAdjustmentParams.php

@@ -26,7 +26,7 @@ final class InboundCheckDepositAdjustmentParams implements BaseModel
     use SdkParams;
 
     /**
-     * The adjustment amount in cents. Defaults to the amount of the Inbound Check Deposit.
+     * The adjustment amount in cents. A positive amount means that the funds are being returned to you by the other bank and is a credit to your account, as happens for a `wrong_payee_credit`. A negative amount is a debit to your account, as happens for a `late_return`. Defaults to the amount of the Inbound Check Deposit.
      */
     #[Optional]
     public ?int $amount;
@@ -64,7 +64,7 @@ public static function with(
     }
 
     /**
-     * The adjustment amount in cents. Defaults to the amount of the Inbound Check Deposit.
+     * The adjustment amount in cents. A positive amount means that the funds are being returned to you by the other bank and is a credit to your account, as happens for a `wrong_payee_credit`. A negative amount is a debit to your account, as happens for a `late_return`. Defaults to the amount of the Inbound Check Deposit.
      */
     public function withAmount(int $amount): self
     {

src/Simulations/InboundCheckDeposits/InboundCheckDepositAdjustmentParams/Reason.php

@@ -12,10 +12,4 @@ enum Reason: string
     case LATE_RETURN = 'late_return';
 
     case WRONG_PAYEE_CREDIT = 'wrong_payee_credit';
-
-    case ADJUSTED_AMOUNT = 'adjusted_amount';
-
-    case NON_CONFORMING_ITEM = 'non_conforming_item';
-
-    case PAID = 'paid';
 }

src/Transactions/Transaction/Source/InboundCheckAdjustment.php

@@ -28,7 +28,7 @@ final class InboundCheckAdjustment implements BaseModel
     public string $adjustedTransactionID;
 
     /**
-     * The amount of the check adjustment.
+     * The amount of the check adjustment in USD cents. A positive amount is a credit to your account and a negative amount is a debit.
      */
     #[Required]
     public int $amount;
@@ -99,7 +99,7 @@ public function withAdjustedTransactionID(
     }
 
     /**
-     * The amount of the check adjustment.
+     * The amount of the check adjustment in USD cents. A positive amount is a credit to your account and a negative amount is a debit.
      */
     public function withAmount(int $amount): self
     {