11056298119

Committed 26 Sep 2024 04:22PM UTC coverage: 96.205% (-0.1%) from 96.317%

Build # 11056298119

Build Type

Pull #1400

github

Committed by

web-flow

Commit Message

Merge fe7c46e63 into 3587026b8

Pull Request Pull Request #1400: Update generated code

Run Details

1305 of 1945 branches covered (67.1%)

Branch coverage included in aggregate %.

631 of 718 new or added lines in 29 files covered. (87.88%)

5 existing lines in 3 files now uncovered.

67778 of 69863 relevant lines covered (97.02%)

0.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.5

/stripe/billing/_credit_balance_transaction_service.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from stripe.billing._credit_balance_transaction import CreditBalanceTransaction
from typing import List, cast
from typing_extensions import NotRequired, TypedDict


class CreditBalanceTransactionService(StripeService):
    class ListParams(TypedDict):
        credit_grant: NotRequired[str]
        """
        The credit grant for which to fetch credit balance transactions.
        """
        customer: str
        """
        The customer for which to fetch credit balance transactions.
        """
        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.
        """

    class RetrieveParams(TypedDict):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """

    def list(
        self,
        params: "CreditBalanceTransactionService.ListParams",
        options: RequestOptions = {},
    ) -> ListObject[CreditBalanceTransaction]:
        """
        Retrieve a list of credit balance transactions
        """
        return cast(
            ListObject[CreditBalanceTransaction],
            self._request(
                "get",
                "/v1/billing/credit_balance_transactions",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def list_async(
        self,
        params: "CreditBalanceTransactionService.ListParams",
        options: RequestOptions = {},
    ) -> ListObject[CreditBalanceTransaction]:
        """
        Retrieve a list of credit balance transactions
        """
        return cast(
            ListObject[CreditBalanceTransaction],
            await self._request_async(
                "get",
                "/v1/billing/credit_balance_transactions",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def retrieve(
        self,
        id: str,
        params: "CreditBalanceTransactionService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> CreditBalanceTransaction:
        """
        Retrieves a credit balance transaction
        """
        return cast(
            CreditBalanceTransaction,
            self._request(
                "get",
                "/v1/billing/credit_balance_transactions/{id}".format(
                    id=sanitize_id(id),
                ),
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def retrieve_async(
        self,
        id: str,
        params: "CreditBalanceTransactionService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> CreditBalanceTransaction:
        """
        Retrieves a credit balance transaction
        """
        return cast(
            CreditBalanceTransaction,
            await self._request_async(
                "get",
                "/v1/billing/credit_balance_transactions/{id}".format(
                    id=sanitize_id(id),
                ),
                base_address="api",
                params=params,
                options=options,
            ),
        )

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._list_object import ListObject	1✔
4	from stripe._request_options import RequestOptions	1✔
5	from stripe._stripe_service import StripeService	1✔
6	from stripe._util import sanitize_id	1✔
7	from stripe.billing._credit_balance_transaction import CreditBalanceTransaction	1✔
8	from typing import List, cast	1✔
9	from typing_extensions import NotRequired, TypedDict	1✔
10
11
12	class CreditBalanceTransactionService(StripeService):	1✔
13	class ListParams(TypedDict):	1✔
14	credit_grant: NotRequired[str]	1✔
15	"""	1✔
16	The credit grant for which to fetch credit balance transactions.
17	"""
18	customer: str	1✔
19	"""	1✔
20	The customer for which to fetch credit balance transactions.
21	"""
22	ending_before: NotRequired[str]	1✔
23	"""	1✔
24	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.
25	"""
26	expand: NotRequired[List[str]]	1✔
27	"""	1✔
28	Specifies which fields in the response should be expanded.
29	"""
30	limit: NotRequired[int]	1✔
31	"""	1✔
32	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
33	"""
34	starting_after: NotRequired[str]	1✔
35	"""	1✔
36	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.
37	"""
38
39	class RetrieveParams(TypedDict):	1✔
40	expand: NotRequired[List[str]]	1✔
41	"""	1✔
42	Specifies which fields in the response should be expanded.
43	"""
44
45	def list(	1✔
46	self,
47	params: "CreditBalanceTransactionService.ListParams",
48	options: RequestOptions = {},
49	) -> ListObject[CreditBalanceTransaction]:
50	"""
51	Retrieve a list of credit balance transactions
52	"""
NEW 53	return cast(	×
54	ListObject[CreditBalanceTransaction],
55	self._request(
56	"get",
57	"/v1/billing/credit_balance_transactions",
58	base_address="api",
59	params=params,
60	options=options,
61	),
62	)
63
64	async def list_async(	1✔
65	self,
66	params: "CreditBalanceTransactionService.ListParams",
67	options: RequestOptions = {},
68	) -> ListObject[CreditBalanceTransaction]:
69	"""
70	Retrieve a list of credit balance transactions
71	"""
NEW 72	return cast(	×
73	ListObject[CreditBalanceTransaction],
74	await self._request_async(
75	"get",
76	"/v1/billing/credit_balance_transactions",
77	base_address="api",
78	params=params,
79	options=options,
80	),
81	)
82
83	def retrieve(	1✔
84	self,
85	id: str,
86	params: "CreditBalanceTransactionService.RetrieveParams" = {},
87	options: RequestOptions = {},
88	) -> CreditBalanceTransaction:
89	"""
90	Retrieves a credit balance transaction
91	"""
NEW 92	return cast(	×
93	CreditBalanceTransaction,
94	self._request(
95	"get",
96	"/v1/billing/credit_balance_transactions/{id}".format(
97	id=sanitize_id(id),
98	),
99	base_address="api",
100	params=params,
101	options=options,
102	),
103	)
104
105	async def retrieve_async(	1✔
106	self,
107	id: str,
108	params: "CreditBalanceTransactionService.RetrieveParams" = {},
109	options: RequestOptions = {},
110	) -> CreditBalanceTransaction:
111	"""
112	Retrieves a credit balance transaction
113	"""
NEW 114	return cast(	×
115	CreditBalanceTransaction,
116	await self._request_async(
117	"get",
118	"/v1/billing/credit_balance_transactions/{id}".format(
119	id=sanitize_id(id),
120	),
121	base_address="api",
122	params=params,
123	options=options,
124	),
125	)

stripe / stripe-python / 11056298119

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous