feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 239
-openapi_spec_hash: ec98ee98f7777d5d0f87bcb178e47d8d
+openapi_spec_hash: 9a0cb386fed2275f199e490e83da391c
 config_hash: 1ca082e374ef7000e2a5971e8da740e0

src/CheckTransfers/CheckTransferStopPaymentParams.php

@@ -11,7 +11,7 @@
 use Increase\Core\Contracts\BaseModel;
 
 /**
- * Stop payment on a Check Transfer.
+ * Request a stop payment on a Check Transfer. This can be done any time before the check is deposited. A stopped check cannot be deposited and the funds held by the transfer's Pending Transaction are released back to the account's available balance.
  *
  * @see Increase\Services\CheckTransfersService::stopPayment()
  *

src/EventSubscriptions/EventSubscription/SelectedEventCategory/EventCategory.php

@@ -145,6 +145,10 @@ enum EventCategory: string
 
     case INBOUND_WIRE_TRANSFER_UPDATED = 'inbound_wire_transfer.updated';
 
+    case INTEREST_RATE_PLAN_CREATED = 'interest_rate_plan.created';
+
+    case INTEREST_RATE_PLAN_UPDATED = 'interest_rate_plan.updated';
+
     case INTRAFI_ACCOUNT_ENROLLMENT_CREATED = 'intrafi_account_enrollment.created';
 
     case INTRAFI_ACCOUNT_ENROLLMENT_UPDATED = 'intrafi_account_enrollment.updated';

src/EventSubscriptions/EventSubscriptionCreateParams/SelectedEventCategory/EventCategory.php

@@ -145,6 +145,10 @@ enum EventCategory: string
 
     case INBOUND_WIRE_TRANSFER_UPDATED = 'inbound_wire_transfer.updated';
 
+    case INTEREST_RATE_PLAN_CREATED = 'interest_rate_plan.created';
+
+    case INTEREST_RATE_PLAN_UPDATED = 'interest_rate_plan.updated';
+
     case INTRAFI_ACCOUNT_ENROLLMENT_CREATED = 'intrafi_account_enrollment.created';
 
     case INTRAFI_ACCOUNT_ENROLLMENT_UPDATED = 'intrafi_account_enrollment.updated';

src/Events/Event/Category.php

@@ -145,6 +145,10 @@ enum Category: string
 
     case INBOUND_WIRE_TRANSFER_UPDATED = 'inbound_wire_transfer.updated';
 
+    case INTEREST_RATE_PLAN_CREATED = 'interest_rate_plan.created';
+
+    case INTEREST_RATE_PLAN_UPDATED = 'interest_rate_plan.updated';
+
     case INTRAFI_ACCOUNT_ENROLLMENT_CREATED = 'intrafi_account_enrollment.created';
 
     case INTRAFI_ACCOUNT_ENROLLMENT_UPDATED = 'intrafi_account_enrollment.updated';

src/Events/EventListParams/Category/In.php

@@ -142,6 +142,10 @@ enum In: string
 
     case INBOUND_WIRE_TRANSFER_UPDATED = 'inbound_wire_transfer.updated';
 
+    case INTEREST_RATE_PLAN_CREATED = 'interest_rate_plan.created';
+
+    case INTEREST_RATE_PLAN_UPDATED = 'interest_rate_plan.updated';
+
     case INTRAFI_ACCOUNT_ENROLLMENT_CREATED = 'intrafi_account_enrollment.created';
 
     case INTRAFI_ACCOUNT_ENROLLMENT_UPDATED = 'intrafi_account_enrollment.updated';

src/Events/UnwrapWebhookEvent/Category.php

@@ -145,6 +145,10 @@ enum Category: string
 
     case INBOUND_WIRE_TRANSFER_UPDATED = 'inbound_wire_transfer.updated';
 
+    case INTEREST_RATE_PLAN_CREATED = 'interest_rate_plan.created';
+
+    case INTEREST_RATE_PLAN_UPDATED = 'interest_rate_plan.updated';
+
     case INTRAFI_ACCOUNT_ENROLLMENT_CREATED = 'intrafi_account_enrollment.created';
 
     case INTRAFI_ACCOUNT_ENROLLMENT_UPDATED = 'intrafi_account_enrollment.updated';

src/InboundCheckDeposits/InboundCheckDeposit.php

@@ -27,6 +27,7 @@
  *   accountNumberID: string|null,
  *   adjustments: list<Adjustment|AdjustmentShape>,
  *   amount: int,
+ *   automaticallyResolvesAt: \DateTimeInterface,
  *   backImageFileID: string|null,
  *   bankOfFirstDepositRoutingNumber: string|null,
  *   checkNumber: string|null,
@@ -86,6 +87,12 @@ final class InboundCheckDeposit implements BaseModel
     #[Required]
     public int $amount;
 
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Inbound Check Deposit will be automatically resolved if it has not been actioned by then.
+     */
+    #[Required('automatically_resolves_at')]
+    public \DateTimeInterface $automaticallyResolvesAt;
+
     /**
      * The ID for the File containing the image of the back of the check.
      */
@@ -190,6 +197,7 @@ final class InboundCheckDeposit implements BaseModel
      *   accountNumberID: ...,
      *   adjustments: ...,
      *   amount: ...,
+     *   automaticallyResolvesAt: ...,
      *   backImageFileID: ...,
      *   bankOfFirstDepositRoutingNumber: ...,
      *   checkNumber: ...,
@@ -217,6 +225,7 @@ final class InboundCheckDeposit implements BaseModel
      *   ->withAccountNumberID(...)
      *   ->withAdjustments(...)
      *   ->withAmount(...)
+     *   ->withAutomaticallyResolvesAt(...)
      *   ->withBackImageFileID(...)
      *   ->withBankOfFirstDepositRoutingNumber(...)
      *   ->withCheckNumber(...)
@@ -257,6 +266,7 @@ public static function with(
         ?string $accountNumberID,
         array $adjustments,
         int $amount,
+        \DateTimeInterface $automaticallyResolvesAt,
         ?string $backImageFileID,
         ?string $bankOfFirstDepositRoutingNumber,
         ?string $checkNumber,
@@ -280,6 +290,7 @@ public static function with(
         $self['accountNumberID'] = $accountNumberID;
         $self['adjustments'] = $adjustments;
         $self['amount'] = $amount;
+        $self['automaticallyResolvesAt'] = $automaticallyResolvesAt;
         $self['backImageFileID'] = $backImageFileID;
         $self['bankOfFirstDepositRoutingNumber'] = $bankOfFirstDepositRoutingNumber;
         $self['checkNumber'] = $checkNumber;
@@ -366,6 +377,18 @@ public function withAmount(int $amount): self
         return $self;
     }
 
+    /**
+     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Inbound Check Deposit will be automatically resolved if it has not been actioned by then.
+     */
+    public function withAutomaticallyResolvesAt(
+        \DateTimeInterface $automaticallyResolvesAt
+    ): self {
+        $self = clone $this;
+        $self['automaticallyResolvesAt'] = $automaticallyResolvesAt;
+
+        return $self;
+    }
+
     /**
      * The ID for the File containing the image of the back of the check.
      */

src/RoutingNumbers/RoutingNumberListResponse.php

@@ -9,6 +9,7 @@
 use Increase\Core\Contracts\BaseModel;
 use Increase\RoutingNumbers\RoutingNumberListResponse\ACHTransfers;
 use Increase\RoutingNumbers\RoutingNumberListResponse\FednowTransfers;
+use Increase\RoutingNumbers\RoutingNumberListResponse\RealTimePaymentsRequestForPayment;
 use Increase\RoutingNumbers\RoutingNumberListResponse\RealTimePaymentsTransfers;
 use Increase\RoutingNumbers\RoutingNumberListResponse\Type;
 use Increase\RoutingNumbers\RoutingNumberListResponse\WireTransfers;
@@ -20,6 +21,7 @@
  *   achTransfers: ACHTransfers|value-of<ACHTransfers>,
  *   fednowTransfers: FednowTransfers|value-of<FednowTransfers>,
  *   name: string,
+ *   realTimePaymentsRequestForPayment: RealTimePaymentsRequestForPayment|value-of<RealTimePaymentsRequestForPayment>,
  *   realTimePaymentsTransfers: RealTimePaymentsTransfers|value-of<RealTimePaymentsTransfers>,
  *   routingNumber: string,
  *   type: Type|value-of<Type>,
@@ -53,6 +55,17 @@ final class RoutingNumberListResponse implements BaseModel
     #[Required]
     public string $name;
 
+    /**
+     * This routing number's support for Real-Time Payments Requests for Payment.
+     *
+     * @var value-of<RealTimePaymentsRequestForPayment> $realTimePaymentsRequestForPayment
+     */
+    #[Required(
+        'real_time_payments_request_for_payment',
+        enum: RealTimePaymentsRequestForPayment::class,
+    )]
+    public string $realTimePaymentsRequestForPayment;
+
     /**
      * This routing number's support for Real-Time Payments Transfers.
      *
@@ -95,6 +108,7 @@ enum: RealTimePaymentsTransfers::class
      *   achTransfers: ...,
      *   fednowTransfers: ...,
      *   name: ...,
+     *   realTimePaymentsRequestForPayment: ...,
      *   realTimePaymentsTransfers: ...,
      *   routingNumber: ...,
      *   type: ...,
@@ -109,6 +123,7 @@ enum: RealTimePaymentsTransfers::class
      *   ->withACHTransfers(...)
      *   ->withFednowTransfers(...)
      *   ->withName(...)
+     *   ->withRealTimePaymentsRequestForPayment(...)
      *   ->withRealTimePaymentsTransfers(...)
      *   ->withRoutingNumber(...)
      *   ->withType(...)
@@ -127,6 +142,7 @@ public function __construct()
      *
      * @param ACHTransfers|value-of<ACHTransfers> $achTransfers
      * @param FednowTransfers|value-of<FednowTransfers> $fednowTransfers
+     * @param RealTimePaymentsRequestForPayment|value-of<RealTimePaymentsRequestForPayment> $realTimePaymentsRequestForPayment
      * @param RealTimePaymentsTransfers|value-of<RealTimePaymentsTransfers> $realTimePaymentsTransfers
      * @param Type|value-of<Type> $type
      * @param WireTransfers|value-of<WireTransfers> $wireTransfers
@@ -135,6 +151,7 @@ public static function with(
         ACHTransfers|string $achTransfers,
         FednowTransfers|string $fednowTransfers,
         string $name,
+        RealTimePaymentsRequestForPayment|string $realTimePaymentsRequestForPayment,
         RealTimePaymentsTransfers|string $realTimePaymentsTransfers,
         string $routingNumber,
         Type|string $type,
@@ -145,6 +162,7 @@ public static function with(
         $self['achTransfers'] = $achTransfers;
         $self['fednowTransfers'] = $fednowTransfers;
         $self['name'] = $name;
+        $self['realTimePaymentsRequestForPayment'] = $realTimePaymentsRequestForPayment;
         $self['realTimePaymentsTransfers'] = $realTimePaymentsTransfers;
         $self['routingNumber'] = $routingNumber;
         $self['type'] = $type;
@@ -191,6 +209,20 @@ public function withName(string $name): self
         return $self;
     }
 
+    /**
+     * This routing number's support for Real-Time Payments Requests for Payment.
+     *
+     * @param RealTimePaymentsRequestForPayment|value-of<RealTimePaymentsRequestForPayment> $realTimePaymentsRequestForPayment
+     */
+    public function withRealTimePaymentsRequestForPayment(
+        RealTimePaymentsRequestForPayment|string $realTimePaymentsRequestForPayment
+    ): self {
+        $self = clone $this;
+        $self['realTimePaymentsRequestForPayment'] = $realTimePaymentsRequestForPayment;
+
+        return $self;
+    }
+
     /**
      * This routing number's support for Real-Time Payments Transfers.
      *

src/RoutingNumbers/RoutingNumberListResponse/RealTimePaymentsRequestForPayment.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Increase\RoutingNumbers\RoutingNumberListResponse;
+
+/**
+ * This routing number's support for Real-Time Payments Requests for Payment.
+ */
+enum RealTimePaymentsRequestForPayment: string
+{
+    case SUPPORTED = 'supported';
+
+    case NOT_SUPPORTED = 'not_supported';
+}

src/Services/CheckTransfersRawService.php

@@ -204,7 +204,7 @@ public function cancel(
     /**
      * @api
      *
-     * Stop payment on a Check Transfer
+     * Request a stop payment on a Check Transfer. This can be done any time before the check is deposited. A stopped check cannot be deposited and the funds held by the transfer's Pending Transaction are released back to the account's available balance.
      *
      * @param string $checkTransferID the identifier of the Check Transfer
      * @param array{

src/Services/CheckTransfersService.php

@@ -200,7 +200,7 @@ public function cancel(
     /**
      * @api
      *
-     * Stop payment on a Check Transfer
+     * Request a stop payment on a Check Transfer. This can be done any time before the check is deposited. A stopped check cannot be deposited and the funds held by the transfer's Pending Transaction are released back to the account's available balance.
      *
      * @param string $checkTransferID the identifier of the Check Transfer
      * @param Reason|value-of<Reason> $reason the reason why this transfer should be stopped

src/Services/Simulations/InboundCheckDepositsRawService.php

@@ -29,7 +29,7 @@ public function __construct(private Client $client) {}
     /**
      * @api
      *
-     * Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Inbound Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.
+     * Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. The resulting Inbound Check Deposit will have a `status` of `pending`, and after an hour Increase will evaluate it as we would in production and either create a Transaction or a Declined Transaction as a result. To resolve it sooner, use the simulation to accept an Inbound Check Deposit or the API to decline one.
      *
      * @param array{
      *   accountNumberID: string,

src/Services/Simulations/InboundCheckDepositsService.php

@@ -34,7 +34,7 @@ public function __construct(private Client $client)
     /**
      * @api
      *
-     * Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Inbound Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.
+     * Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. The resulting Inbound Check Deposit will have a `status` of `pending`, and after an hour Increase will evaluate it as we would in production and either create a Transaction or a Declined Transaction as a result. To resolve it sooner, use the simulation to accept an Inbound Check Deposit or the API to decline one.
      *
      * @param string $accountNumberID the identifier of the Account Number the Inbound Check Deposit will be against
      * @param int $amount the check amount in cents

src/Simulations/InboundCheckDeposits/InboundCheckDepositCreateParams.php

@@ -12,7 +12,7 @@
 use Increase\Simulations\InboundCheckDeposits\InboundCheckDepositCreateParams\PayeeNameAnalysis;
 
 /**
- * Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Inbound Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.
+ * Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. The resulting Inbound Check Deposit will have a `status` of `pending`, and after an hour Increase will evaluate it as we would in production and either create a Transaction or a Declined Transaction as a result. To resolve it sooner, use the simulation to accept an Inbound Check Deposit or the API to decline one.
  *
  * @see Increase\Services\Simulations\InboundCheckDepositsService::create()
  *

src/WireDrawdownRequests/WireDrawdownRequest/CreditorAddress.php

@@ -50,7 +50,7 @@ final class CreditorAddress implements BaseModel
     public ?string $line2;
 
     /**
-     * The ZIP code of the address.
+     * The postal code of the address.
      */
     #[Required('postal_code')]
     public ?string $postalCode;
@@ -158,7 +158,7 @@ public function withLine2(?string $line2): self
     }
 
     /**
-     * The ZIP code of the address.
+     * The postal code of the address.
      */
     public function withPostalCode(?string $postalCode): self
     {

src/WireDrawdownRequests/WireDrawdownRequest/DebtorAddress.php

@@ -50,7 +50,7 @@ final class DebtorAddress implements BaseModel
     public ?string $line2;
 
     /**
-     * The ZIP code of the address.
+     * The postal code of the address.
      */
     #[Required('postal_code')]
     public ?string $postalCode;
@@ -158,7 +158,7 @@ public function withLine2(?string $line2): self
     }
 
     /**
-     * The ZIP code of the address.
+     * The postal code of the address.
      */
     public function withPostalCode(?string $postalCode): self
     {

src/WireDrawdownRequests/WireDrawdownRequestCreateParams/CreditorAddress.php

@@ -51,7 +51,7 @@ final class CreditorAddress implements BaseModel
     public ?string $line2;
 
     /**
-     * The ZIP code of the address.
+     * The postal code of the address.
      */
     #[Optional('postal_code')]
     public ?string $postalCode;
@@ -152,7 +152,7 @@ public function withLine2(string $line2): self
     }
 
     /**
-     * The ZIP code of the address.
+     * The postal code of the address.
      */
     public function withPostalCode(string $postalCode): self
     {

src/WireDrawdownRequests/WireDrawdownRequestCreateParams/DebtorAddress.php

@@ -51,7 +51,7 @@ final class DebtorAddress implements BaseModel
     public ?string $line2;
 
     /**
-     * The ZIP code of the address.
+     * The postal code of the address.
      */
     #[Optional('postal_code')]
     public ?string $postalCode;
@@ -152,7 +152,7 @@ public function withLine2(string $line2): self
     }
 
     /**
-     * The ZIP code of the address.
+     * The postal code of the address.
      */
     public function withPostalCode(string $postalCode): self
     {