40045-vm/venv/lib/python3.11/site-packages/stripe/_source_transaction_service.py
2026-05-20 10:50:30 +00:00

74 lines
2.7 KiB
Python

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._source_transaction import SourceTransaction
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import List, cast
from typing_extensions import NotRequired, TypedDict
class SourceTransactionService(StripeService):
class ListParams(TypedDict):
ending_before: NotRequired[str]
"""
A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
"""
def list(
self,
source: str,
params: "SourceTransactionService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[SourceTransaction]:
"""
List source transactions for a given source.
"""
return cast(
ListObject[SourceTransaction],
self._request(
"get",
"/v1/sources/{source}/source_transactions".format(
source=sanitize_id(source),
),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
source: str,
params: "SourceTransactionService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[SourceTransaction]:
"""
List source transactions for a given source.
"""
return cast(
ListObject[SourceTransaction],
await self._request_async(
"get",
"/v1/sources/{source}/source_transactions".format(
source=sanitize_id(source),
),
base_address="api",
params=params,
options=options,
),
)