inbound_wire_transfers.py

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from __future__ import annotations

import httpx

from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
from ..._utils import maybe_transform, async_maybe_transform
from ..._compat import cached_property
from ..._resource import SyncAPIResource, AsyncAPIResource
from ..._response import (
    to_raw_response_wrapper,
    to_streamed_response_wrapper,
    async_to_raw_response_wrapper,
    async_to_streamed_response_wrapper,
)
from ..._base_client import make_request_options
from ...types.simulations import inbound_wire_transfer_create_params
from ...types.inbound_wire_transfer import InboundWireTransfer

__all__ = ["InboundWireTransfersResource", "AsyncInboundWireTransfersResource"]


class InboundWireTransfersResource(SyncAPIResource):
    @cached_property
    def with_raw_response(self) -> InboundWireTransfersResourceWithRawResponse:
        """
        This property can be used as a prefix for any HTTP method call to return
        the raw response object instead of the parsed content.

        For more information, see https://www.github.com/Increase/increase-python#accessing-raw-response-data-eg-headers
        """
        return InboundWireTransfersResourceWithRawResponse(self)

    @cached_property
    def with_streaming_response(self) -> InboundWireTransfersResourceWithStreamingResponse:
        """
        An alternative to `.with_raw_response` that doesn't eagerly read the response body.

        For more information, see https://www.github.com/Increase/increase-python#with_streaming_response
        """
        return InboundWireTransfersResourceWithStreamingResponse(self)

    def create(
        self,
        *,
        account_number_id: str,
        amount: int,
        creditor_address_line1: str | Omit = omit,
        creditor_address_line2: str | Omit = omit,
        creditor_address_line3: str | Omit = omit,
        creditor_name: str | Omit = omit,
        debtor_address_line1: str | Omit = omit,
        debtor_address_line2: str | Omit = omit,
        debtor_address_line3: str | Omit = omit,
        debtor_name: str | Omit = omit,
        end_to_end_identification: str | Omit = omit,
        instructing_agent_routing_number: str | Omit = omit,
        instruction_identification: str | Omit = omit,
        purpose: str | Omit = omit,
        unique_end_to_end_transaction_reference: str | Omit = omit,
        unstructured_remittance_information: str | Omit = omit,
        wire_drawdown_request_id: str | 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,
    ) -> InboundWireTransfer:
        """
        Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.

        Args:
          account_number_id: The identifier of the Account Number the inbound Wire Transfer is for.

          amount: The transfer amount in cents. Must be positive.

          creditor_address_line1: The sending bank will set creditor_address_line1 in production. You can simulate
              any value here.

          creditor_address_line2: The sending bank will set creditor_address_line2 in production. You can simulate
              any value here.

          creditor_address_line3: The sending bank will set creditor_address_line3 in production. You can simulate
              any value here.

          creditor_name: The sending bank will set creditor_name in production. You can simulate any
              value here.

          debtor_address_line1: The sending bank will set debtor_address_line1 in production. You can simulate
              any value here.

          debtor_address_line2: The sending bank will set debtor_address_line2 in production. You can simulate
              any value here.

          debtor_address_line3: The sending bank will set debtor_address_line3 in production. You can simulate
              any value here.

          debtor_name: The sending bank will set debtor_name in production. You can simulate any value
              here.

          end_to_end_identification: The sending bank will set end_to_end_identification in production. You can
              simulate any value here.

          instructing_agent_routing_number: The sending bank will set instructing_agent_routing_number in production. You
              can simulate any value here.

          instruction_identification: The sending bank will set instruction_identification in production. You can
              simulate any value here.

          purpose: The sending bank will set purpose in production. You can simulate any value
              here.

          unique_end_to_end_transaction_reference: The sending bank will set unique_end_to_end_transaction_reference in production.
              You can simulate any value here.

          unstructured_remittance_information: The sending bank will set unstructured_remittance_information in production. You
              can simulate any value here.

          wire_drawdown_request_id: The identifier of a Wire Drawdown Request the inbound Wire Transfer is
              fulfilling.

          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
        """
        return self._post(
            "/simulations/inbound_wire_transfers",
            body=maybe_transform(
                {
                    "account_number_id": account_number_id,
                    "amount": amount,
                    "creditor_address_line1": creditor_address_line1,
                    "creditor_address_line2": creditor_address_line2,
                    "creditor_address_line3": creditor_address_line3,
                    "creditor_name": creditor_name,
                    "debtor_address_line1": debtor_address_line1,
                    "debtor_address_line2": debtor_address_line2,
                    "debtor_address_line3": debtor_address_line3,
                    "debtor_name": debtor_name,
                    "end_to_end_identification": end_to_end_identification,
                    "instructing_agent_routing_number": instructing_agent_routing_number,
                    "instruction_identification": instruction_identification,
                    "purpose": purpose,
                    "unique_end_to_end_transaction_reference": unique_end_to_end_transaction_reference,
                    "unstructured_remittance_information": unstructured_remittance_information,
                    "wire_drawdown_request_id": wire_drawdown_request_id,
                },
                inbound_wire_transfer_create_params.InboundWireTransferCreateParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=InboundWireTransfer,
        )


class AsyncInboundWireTransfersResource(AsyncAPIResource):
    @cached_property
    def with_raw_response(self) -> AsyncInboundWireTransfersResourceWithRawResponse:
        """
        This property can be used as a prefix for any HTTP method call to return
        the raw response object instead of the parsed content.

        For more information, see https://www.github.com/Increase/increase-python#accessing-raw-response-data-eg-headers
        """
        return AsyncInboundWireTransfersResourceWithRawResponse(self)

    @cached_property
    def with_streaming_response(self) -> AsyncInboundWireTransfersResourceWithStreamingResponse:
        """
        An alternative to `.with_raw_response` that doesn't eagerly read the response body.

        For more information, see https://www.github.com/Increase/increase-python#with_streaming_response
        """
        return AsyncInboundWireTransfersResourceWithStreamingResponse(self)

    async def create(
        self,
        *,
        account_number_id: str,
        amount: int,
        creditor_address_line1: str | Omit = omit,
        creditor_address_line2: str | Omit = omit,
        creditor_address_line3: str | Omit = omit,
        creditor_name: str | Omit = omit,
        debtor_address_line1: str | Omit = omit,
        debtor_address_line2: str | Omit = omit,
        debtor_address_line3: str | Omit = omit,
        debtor_name: str | Omit = omit,
        end_to_end_identification: str | Omit = omit,
        instructing_agent_routing_number: str | Omit = omit,
        instruction_identification: str | Omit = omit,
        purpose: str | Omit = omit,
        unique_end_to_end_transaction_reference: str | Omit = omit,
        unstructured_remittance_information: str | Omit = omit,
        wire_drawdown_request_id: str | 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,
    ) -> InboundWireTransfer:
        """
        Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account.

        Args:
          account_number_id: The identifier of the Account Number the inbound Wire Transfer is for.

          amount: The transfer amount in cents. Must be positive.

          creditor_address_line1: The sending bank will set creditor_address_line1 in production. You can simulate
              any value here.

          creditor_address_line2: The sending bank will set creditor_address_line2 in production. You can simulate
              any value here.

          creditor_address_line3: The sending bank will set creditor_address_line3 in production. You can simulate
              any value here.

          creditor_name: The sending bank will set creditor_name in production. You can simulate any
              value here.

          debtor_address_line1: The sending bank will set debtor_address_line1 in production. You can simulate
              any value here.

          debtor_address_line2: The sending bank will set debtor_address_line2 in production. You can simulate
              any value here.

          debtor_address_line3: The sending bank will set debtor_address_line3 in production. You can simulate
              any value here.

          debtor_name: The sending bank will set debtor_name in production. You can simulate any value
              here.

          end_to_end_identification: The sending bank will set end_to_end_identification in production. You can
              simulate any value here.

          instructing_agent_routing_number: The sending bank will set instructing_agent_routing_number in production. You
              can simulate any value here.

          instruction_identification: The sending bank will set instruction_identification in production. You can
              simulate any value here.

          purpose: The sending bank will set purpose in production. You can simulate any value
              here.

          unique_end_to_end_transaction_reference: The sending bank will set unique_end_to_end_transaction_reference in production.
              You can simulate any value here.

          unstructured_remittance_information: The sending bank will set unstructured_remittance_information in production. You
              can simulate any value here.

          wire_drawdown_request_id: The identifier of a Wire Drawdown Request the inbound Wire Transfer is
              fulfilling.

          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
        """
        return await self._post(
            "/simulations/inbound_wire_transfers",
            body=await async_maybe_transform(
                {
                    "account_number_id": account_number_id,
                    "amount": amount,
                    "creditor_address_line1": creditor_address_line1,
                    "creditor_address_line2": creditor_address_line2,
                    "creditor_address_line3": creditor_address_line3,
                    "creditor_name": creditor_name,
                    "debtor_address_line1": debtor_address_line1,
                    "debtor_address_line2": debtor_address_line2,
                    "debtor_address_line3": debtor_address_line3,
                    "debtor_name": debtor_name,
                    "end_to_end_identification": end_to_end_identification,
                    "instructing_agent_routing_number": instructing_agent_routing_number,
                    "instruction_identification": instruction_identification,
                    "purpose": purpose,
                    "unique_end_to_end_transaction_reference": unique_end_to_end_transaction_reference,
                    "unstructured_remittance_information": unstructured_remittance_information,
                    "wire_drawdown_request_id": wire_drawdown_request_id,
                },
                inbound_wire_transfer_create_params.InboundWireTransferCreateParams,
            ),
            options=make_request_options(
                extra_headers=extra_headers,
                extra_query=extra_query,
                extra_body=extra_body,
                timeout=timeout,
                idempotency_key=idempotency_key,
            ),
            cast_to=InboundWireTransfer,
        )


class InboundWireTransfersResourceWithRawResponse:
    def __init__(self, inbound_wire_transfers: InboundWireTransfersResource) -> None:
        self._inbound_wire_transfers = inbound_wire_transfers

        self.create = to_raw_response_wrapper(
            inbound_wire_transfers.create,
        )


class AsyncInboundWireTransfersResourceWithRawResponse:
    def __init__(self, inbound_wire_transfers: AsyncInboundWireTransfersResource) -> None:
        self._inbound_wire_transfers = inbound_wire_transfers

        self.create = async_to_raw_response_wrapper(
            inbound_wire_transfers.create,
        )


class InboundWireTransfersResourceWithStreamingResponse:
    def __init__(self, inbound_wire_transfers: InboundWireTransfersResource) -> None:
        self._inbound_wire_transfers = inbound_wire_transfers

        self.create = to_streamed_response_wrapper(
            inbound_wire_transfers.create,
        )


class AsyncInboundWireTransfersResourceWithStreamingResponse:
    def __init__(self, inbound_wire_transfers: AsyncInboundWireTransfersResource) -> None:
        self._inbound_wire_transfers = inbound_wire_transfers

        self.create = async_to_streamed_response_wrapper(
            inbound_wire_transfers.create,
        )