PYTHON _received_credit_service.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING

if TYPE_CHECKING:
    from stripe._list_object import ListObject
    from stripe._request_options import RequestOptions
    from stripe.params.treasury._received_credit_list_params import (
        ReceivedCreditListParams,
    )
    from stripe.params.treasury._received_credit_retrieve_params import (
        ReceivedCreditRetrieveParams,
    )
    from stripe.treasury._received_credit import ReceivedCredit


class ReceivedCreditService(StripeService):
    def list(
        self,
        params: "ReceivedCreditListParams",
        options: Optional["RequestOptions"] = None,
    ) -> "ListObject[ReceivedCredit]":
        """
        Returns a list of ReceivedCredits.
        """
        return cast(
            "ListObject[ReceivedCredit]",
            self._request(
                "get",
                "/v1/treasury/received_credits",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def list_async(
        self,
        params: "ReceivedCreditListParams",
        options: Optional["RequestOptions"] = None,
    ) -> "ListObject[ReceivedCredit]":
        """
        Returns a list of ReceivedCredits.
        """
        return cast(
            "ListObject[ReceivedCredit]",
            await self._request_async(
                "get",
                "/v1/treasury/received_credits",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def retrieve(
        self,
        id: str,
        params: Optional["ReceivedCreditRetrieveParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "ReceivedCredit":
        """
        Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
        """
        return cast(
            "ReceivedCredit",
            self._request(
                "get",
                "/v1/treasury/received_credits/{id}".format(
                    id=sanitize_id(id)
                ),
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def retrieve_async(
        self,
        id: str,
        params: Optional["ReceivedCreditRetrieveParams"] = None,
        options: Optional["RequestOptions"] = None,
    ) -> "ReceivedCredit":
        """
        Retrieves the details of an existing ReceivedCredit by passing the unique ReceivedCredit ID from the ReceivedCredit list.
        """
        return cast(
            "ReceivedCredit",
            await self._request_async(
                "get",
                "/v1/treasury/received_credits/{id}".format(
                    id=sanitize_id(id)
                ),
                base_address="api",
                params=params,
                options=options,
            ),
        )