feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 232
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-8bcd1f04377ee8ae354a1cb3b1c214232c8b448a93c98502ea92b696bf0757bf.yml
-openapi_spec_hash: c338b176720c2dc69dd3f7db351ea8a5
-config_hash: d15ecbf4dc8a7a0ef99397d11b557444
+configured_endpoints: 233
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-1ed184e346fa8c739f7de410b940df9f160681dd818eed4ec1e48b40451007d0.yml
+openapi_spec_hash: 0bc3978204acc7949c98e1d098bf5e1c
+config_hash: ca482105d83c23b2986f1c9c441c4343

api.md

@@ -993,6 +993,7 @@ Methods:
 
 Methods:
 
+- <code title="post /simulations/check_deposits/{check_deposit_id}/adjustment">client.simulations.check_deposits.<a href="./src/increase/resources/simulations/check_deposits.py">adjustment</a>(check_deposit_id, \*\*<a href="src/increase/types/simulations/check_deposit_adjustment_params.py">params</a>) -> <a href="./src/increase/types/check_deposit.py">CheckDeposit</a></code>
 - <code title="post /simulations/check_deposits/{check_deposit_id}/reject">client.simulations.check_deposits.<a href="./src/increase/resources/simulations/check_deposits.py">reject</a>(check_deposit_id) -> <a href="./src/increase/types/check_deposit.py">CheckDeposit</a></code>
 - <code title="post /simulations/check_deposits/{check_deposit_id}/return">client.simulations.check*deposits.<a href="./src/increase/resources/simulations/check_deposits.py">return*</a>(check_deposit_id) -> <a href="./src/increase/types/check_deposit.py">CheckDeposit</a></code>
 - <code title="post /simulations/check_deposits/{check_deposit_id}/submit">client.simulations.check_deposits.<a href="./src/increase/resources/simulations/check_deposits.py">submit</a>(check_deposit_id, \*\*<a href="src/increase/types/simulations/check_deposit_submit_params.py">params</a>) -> <a href="./src/increase/types/check_deposit.py">CheckDeposit</a></code>

src/increase/resources/simulations/check_deposits.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+from typing_extensions import Literal
+
 import httpx
 
 from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
@@ -15,7 +17,7 @@
     async_to_streamed_response_wrapper,
 )
 from ..._base_client import make_request_options
-from ...types.simulations import check_deposit_submit_params
+from ...types.simulations import check_deposit_submit_params, check_deposit_adjustment_params
 from ...types.check_deposit import CheckDeposit
 
 __all__ = ["CheckDepositsResource", "AsyncCheckDepositsResource"]
@@ -41,6 +43,80 @@ def with_streaming_response(self) -> CheckDepositsResourceWithStreamingResponse:
         """
         return CheckDepositsResourceWithStreamingResponse(self)
 
+    def adjustment(
+        self,
+        check_deposit_id: str,
+        *,
+        amount: int | Omit = omit,
+        reason: Literal["late_return", "wrong_payee_credit", "adjusted_amount", "non_conforming_item", "paid"]
+        | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+        idempotency_key: str | None = None,
+    ) -> CheckDeposit:
+        """
+        Simulates the creation of a
+        [Check Deposit Adjustment](#check-deposit-adjustments) on a
+        [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
+        of `submitted`.
+
+        Args:
+          check_deposit_id: The identifier of the Check Deposit you wish to adjust.
+
+          amount: The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
+              cents). A negative amount means that the funds are being clawed back by the
+              other bank and is a debit to your account. Defaults to the negative of the Check
+              Deposit amount.
+
+          reason: The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+              used for a low quality image that the recipient wasn't able to handle.
+
+              - `late_return` - The return was initiated too late and the receiving
+                institution has responded with a Late Return Claim.
+              - `wrong_payee_credit` - The check was deposited to the wrong payee and the
+                depositing institution has reimbursed the funds with a Wrong Payee Credit.
+              - `adjusted_amount` - The check was deposited with a different amount than what
+                was written on the check.
+              - `non_conforming_item` - The recipient was not able to process the check. This
+                usually happens for e.g., low quality images.
+              - `paid` - The check has already been deposited elsewhere and so this is a
+                duplicate.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not check_deposit_id:
+            raise ValueError(f"Expected a non-empty value for `check_deposit_id` but received {check_deposit_id!r}")
+        return self._post(
+            f"/simulations/check_deposits/{check_deposit_id}/adjustment",
+            body=maybe_transform(
+                {
+                    "amount": amount,
+                    "reason": reason,
+                },
+                check_deposit_adjustment_params.CheckDepositAdjustmentParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=CheckDeposit,
+        )
+
     def reject(
         self,
         check_deposit_id: str,
@@ -197,6 +273,80 @@ def with_streaming_response(self) -> AsyncCheckDepositsResourceWithStreamingResp
         """
         return AsyncCheckDepositsResourceWithStreamingResponse(self)
 
+    async def adjustment(
+        self,
+        check_deposit_id: str,
+        *,
+        amount: int | Omit = omit,
+        reason: Literal["late_return", "wrong_payee_credit", "adjusted_amount", "non_conforming_item", "paid"]
+        | Omit = omit,
+        # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
+        # The extra values given here take precedence over values defined on the client or passed to this method.
+        extra_headers: Headers | None = None,
+        extra_query: Query | None = None,
+        extra_body: Body | None = None,
+        timeout: float | httpx.Timeout | None | NotGiven = not_given,
+        idempotency_key: str | None = None,
+    ) -> CheckDeposit:
+        """
+        Simulates the creation of a
+        [Check Deposit Adjustment](#check-deposit-adjustments) on a
+        [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
+        of `submitted`.
+
+        Args:
+          check_deposit_id: The identifier of the Check Deposit you wish to adjust.
+
+          amount: The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
+              cents). A negative amount means that the funds are being clawed back by the
+              other bank and is a debit to your account. Defaults to the negative of the Check
+              Deposit amount.
+
+          reason: The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+              used for a low quality image that the recipient wasn't able to handle.
+
+              - `late_return` - The return was initiated too late and the receiving
+                institution has responded with a Late Return Claim.
+              - `wrong_payee_credit` - The check was deposited to the wrong payee and the
+                depositing institution has reimbursed the funds with a Wrong Payee Credit.
+              - `adjusted_amount` - The check was deposited with a different amount than what
+                was written on the check.
+              - `non_conforming_item` - The recipient was not able to process the check. This
+                usually happens for e.g., low quality images.
+              - `paid` - The check has already been deposited elsewhere and so this is a
+                duplicate.
+
+          extra_headers: Send extra headers
+
+          extra_query: Add additional query parameters to the request
+
+          extra_body: Add additional JSON properties to the request
+
+          timeout: Override the client-level default timeout for this request, in seconds
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not check_deposit_id:
+            raise ValueError(f"Expected a non-empty value for `check_deposit_id` but received {check_deposit_id!r}")
+        return await self._post(
+            f"/simulations/check_deposits/{check_deposit_id}/adjustment",
+            body=await async_maybe_transform(
+                {
+                    "amount": amount,
+                    "reason": reason,
+                },
+                check_deposit_adjustment_params.CheckDepositAdjustmentParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=CheckDeposit,
+        )
+
     async def reject(
         self,
         check_deposit_id: str,
@@ -337,6 +487,9 @@ class CheckDepositsResourceWithRawResponse:
     def __init__(self, check_deposits: CheckDepositsResource) -> None:
         self._check_deposits = check_deposits
 
+        self.adjustment = to_raw_response_wrapper(
+            check_deposits.adjustment,
+        )
         self.reject = to_raw_response_wrapper(
             check_deposits.reject,
         )
@@ -352,6 +505,9 @@ class AsyncCheckDepositsResourceWithRawResponse:
     def __init__(self, check_deposits: AsyncCheckDepositsResource) -> None:
         self._check_deposits = check_deposits
 
+        self.adjustment = async_to_raw_response_wrapper(
+            check_deposits.adjustment,
+        )
         self.reject = async_to_raw_response_wrapper(
             check_deposits.reject,
         )
@@ -367,6 +523,9 @@ class CheckDepositsResourceWithStreamingResponse:
     def __init__(self, check_deposits: CheckDepositsResource) -> None:
         self._check_deposits = check_deposits
 
+        self.adjustment = to_streamed_response_wrapper(
+            check_deposits.adjustment,
+        )
         self.reject = to_streamed_response_wrapper(
             check_deposits.reject,
         )
@@ -382,6 +541,9 @@ class AsyncCheckDepositsResourceWithStreamingResponse:
     def __init__(self, check_deposits: AsyncCheckDepositsResource) -> None:
         self._check_deposits = check_deposits
 
+        self.adjustment = async_to_streamed_response_wrapper(
+            check_deposits.adjustment,
+        )
         self.reject = async_to_streamed_response_wrapper(
             check_deposits.reject,
         )

src/increase/types/simulations/__init__.py

@@ -16,6 +16,7 @@
 from .card_settlement_create_params import CardSettlementCreateParams as CardSettlementCreateParams
 from .interest_payment_create_params import InterestPaymentCreateParams as InterestPaymentCreateParams
 from .account_statement_create_params import AccountStatementCreateParams as AccountStatementCreateParams
+from .check_deposit_adjustment_params import CheckDepositAdjustmentParams as CheckDepositAdjustmentParams
 from .inbound_mail_item_create_params import InboundMailItemCreateParams as InboundMailItemCreateParams
 from .card_authorization_create_params import CardAuthorizationCreateParams as CardAuthorizationCreateParams
 from .card_authentication_create_params import CardAuthenticationCreateParams as CardAuthenticationCreateParams

src/increase/types/simulations/check_deposit_adjustment_params.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["CheckDepositAdjustmentParams"]
+
+
+class CheckDepositAdjustmentParams(TypedDict, total=False):
+    amount: int
+    """
+    The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
+    cents). A negative amount means that the funds are being clawed back by the
+    other bank and is a debit to your account. Defaults to the negative of the Check
+    Deposit amount.
+    """
+
+    reason: Literal["late_return", "wrong_payee_credit", "adjusted_amount", "non_conforming_item", "paid"]
+    """The reason for the adjustment.
+
+    Defaults to `non_conforming_item`, which is often used for a low quality image
+    that the recipient wasn't able to handle.
+
+    - `late_return` - The return was initiated too late and the receiving
+      institution has responded with a Late Return Claim.
+    - `wrong_payee_credit` - The check was deposited to the wrong payee and the
+      depositing institution has reimbursed the funds with a Wrong Payee Credit.
+    - `adjusted_amount` - The check was deposited with a different amount than what
+      was written on the check.
+    - `non_conforming_item` - The recipient was not able to process the check. This
+      usually happens for e.g., low quality images.
+    - `paid` - The check has already been deposited elsewhere and so this is a
+      duplicate.
+    """

tests/api_resources/simulations/test_check_deposits.py

@@ -17,6 +17,53 @@
 class TestCheckDeposits:
     parametrize = pytest.mark.parametrize("client", [False, True], indirect=True, ids=["loose", "strict"])
 
+    @parametrize
+    def test_method_adjustment(self, client: Increase) -> None:
+        check_deposit = client.simulations.check_deposits.adjustment(
+            check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
+        )
+        assert_matches_type(CheckDeposit, check_deposit, path=["response"])
+
+    @parametrize
+    def test_method_adjustment_with_all_params(self, client: Increase) -> None:
+        check_deposit = client.simulations.check_deposits.adjustment(
+            check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
+            amount=-1000000000,
+            reason="late_return",
+        )
+        assert_matches_type(CheckDeposit, check_deposit, path=["response"])
+
+    @parametrize
+    def test_raw_response_adjustment(self, client: Increase) -> None:
+        response = client.simulations.check_deposits.with_raw_response.adjustment(
+            check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        check_deposit = response.parse()
+        assert_matches_type(CheckDeposit, check_deposit, path=["response"])
+
+    @parametrize
+    def test_streaming_response_adjustment(self, client: Increase) -> None:
+        with client.simulations.check_deposits.with_streaming_response.adjustment(
+            check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            check_deposit = response.parse()
+            assert_matches_type(CheckDeposit, check_deposit, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    def test_path_params_adjustment(self, client: Increase) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `check_deposit_id` but received ''"):
+            client.simulations.check_deposits.with_raw_response.adjustment(
+                check_deposit_id="",
+            )
+
     @parametrize
     def test_method_reject(self, client: Increase) -> None:
         check_deposit = client.simulations.check_deposits.reject(
@@ -149,6 +196,53 @@ class TestAsyncCheckDeposits:
         "async_client", [False, True, {"http_client": "aiohttp"}], indirect=True, ids=["loose", "strict", "aiohttp"]
     )
 
+    @parametrize
+    async def test_method_adjustment(self, async_client: AsyncIncrease) -> None:
+        check_deposit = await async_client.simulations.check_deposits.adjustment(
+            check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
+        )
+        assert_matches_type(CheckDeposit, check_deposit, path=["response"])
+
+    @parametrize
+    async def test_method_adjustment_with_all_params(self, async_client: AsyncIncrease) -> None:
+        check_deposit = await async_client.simulations.check_deposits.adjustment(
+            check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
+            amount=-1000000000,
+            reason="late_return",
+        )
+        assert_matches_type(CheckDeposit, check_deposit, path=["response"])
+
+    @parametrize
+    async def test_raw_response_adjustment(self, async_client: AsyncIncrease) -> None:
+        response = await async_client.simulations.check_deposits.with_raw_response.adjustment(
+            check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
+        )
+
+        assert response.is_closed is True
+        assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+        check_deposit = await response.parse()
+        assert_matches_type(CheckDeposit, check_deposit, path=["response"])
+
+    @parametrize
+    async def test_streaming_response_adjustment(self, async_client: AsyncIncrease) -> None:
+        async with async_client.simulations.check_deposits.with_streaming_response.adjustment(
+            check_deposit_id="check_deposit_f06n9gpg7sxn8t19lfc1",
+        ) as response:
+            assert not response.is_closed
+            assert response.http_request.headers.get("X-Stainless-Lang") == "python"
+
+            check_deposit = await response.parse()
+            assert_matches_type(CheckDeposit, check_deposit, path=["response"])
+
+        assert cast(Any, response.is_closed) is True
+
+    @parametrize
+    async def test_path_params_adjustment(self, async_client: AsyncIncrease) -> None:
+        with pytest.raises(ValueError, match=r"Expected a non-empty value for `check_deposit_id` but received ''"):
+            await async_client.simulations.check_deposits.with_raw_response.adjustment(
+                check_deposit_id="",
+            )
+
     @parametrize
     async def test_method_reject(self, async_client: AsyncIncrease) -> None:
         check_deposit = await async_client.simulations.check_deposits.reject(