8428814992

Committed 26 Mar 2024 12:20AM UTC coverage: 96.383% (-0.002%) from 96.385%

Build # 8428814992

Build Type

Pull #1277

github

Committed by

web-flow

Commit Message

Merge 2b6af4e1b into f33afdb07

Pull Request Pull Request #1277: Update generated code for beta

Run Details

1144 of 1812 branches covered (63.13%)

Branch coverage included in aggregate %.

112 of 112 new or added lines in 7 files covered. (100.0%)

863 existing lines in 57 files now uncovered.

80929 of 83341 relevant lines covered (97.11%)

0.97 hits per line

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

88.64

/stripe/tax/_form_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.tax._form import Form
from typing import Any, List, cast
from typing_extensions import Literal, NotRequired, TypedDict


class FormService(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.
        """
        payee: "FormService.ListParamsPayee"
        """
        The payee whose volume is represented on the tax form.
        """
        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.
        """
        type: NotRequired[Literal["us_1099_k", "us_1099_misc", "us_1099_nec"]]
        """
        An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
        """

    class ListParamsPayee(TypedDict):
        account: NotRequired[str]
        """
        The ID of the Stripe account whose forms will be retrieved.
        """
        type: NotRequired[Literal["account"]]
        """
        Specifies the payee type. Always `account`.
        """

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

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

    def list(
        self, params: "FormService.ListParams", options: RequestOptions = {}
    ) -> ListObject[Form]:
        """
        Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
        """
        return cast(
            ListObject[Form],
            self._request(
                "get",
                "/v1/tax/forms",
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def list_async(
        self, params: "FormService.ListParams", options: RequestOptions = {}
    ) -> ListObject[Form]:
        """
        Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
        """
        return cast(
            ListObject[Form],
            await self._request_async(
                "get",
                "/v1/tax/forms",
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def retrieve(
        self,
        id: str,
        params: "FormService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> Form:
        """
        Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
        """
        return cast(
            Form,
            self._request(
                "get",
                "/v1/tax/forms/{id}".format(id=sanitize_id(id)),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def retrieve_async(
        self,
        id: str,
        params: "FormService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> Form:
        """
        Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
        """
        return cast(
            Form,
            await self._request_async(
                "get",
                "/v1/tax/forms/{id}".format(id=sanitize_id(id)),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def pdf(
        self,
        id: str,
        params: "FormService.PdfParams" = {},
        options: RequestOptions = {},
    ) -> Any:
        """
        Download the PDF for a tax form.
        """
        return cast(
            Any,
            self._request_stream(
                "get",
                "/v1/tax/forms/{id}/pdf".format(id=sanitize_id(id)),
                api_mode="V1",
                base_address="files",
                params=params,
                options=options,
            ),
        )

    async def pdf_async(
        self,
        id: str,
        params: "FormService.PdfParams" = {},
        options: RequestOptions = {},
    ) -> Any:
        """
        Download the PDF for a tax form.
        """
        return cast(
            Any,
            await self._request_stream_async(
                "get",
                "/v1/tax/forms/{id}/pdf".format(id=sanitize_id(id)),
                api_mode="V1",
                base_address="files",
                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.tax._form import Form	1✔
8	from typing import Any, List, cast	1✔
9	from typing_extensions import Literal, NotRequired, TypedDict	1✔
10
11
12	class FormService(StripeService):	1✔
13	class ListParams(TypedDict):	1✔
14	ending_before: NotRequired[str]	1✔
15	"""	1✔
16	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.
17	"""
18	expand: NotRequired[List[str]]	1✔
19	"""	1✔
20	Specifies which fields in the response should be expanded.
21	"""
22	limit: NotRequired[int]	1✔
23	"""	1✔
24	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
25	"""
26	payee: "FormService.ListParamsPayee"	1✔
27	"""	1✔
28	The payee whose volume is represented on the tax form.
29	"""
30	starting_after: NotRequired[str]	1✔
31	"""	1✔
32	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.
33	"""
34	type: NotRequired[Literal["us_1099_k", "us_1099_misc", "us_1099_nec"]]	1✔
35	"""	1✔
36	An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future tax form types. If your integration expects only one type of tax form in the response, make sure to provide a type value in the request.
37	"""
38
39	class ListParamsPayee(TypedDict):	1✔
40	account: NotRequired[str]	1✔
41	"""	1✔
42	The ID of the Stripe account whose forms will be retrieved.
43	"""
44	type: NotRequired[Literal["account"]]	1✔
45	"""	1✔
46	Specifies the payee type. Always `account`.
47	"""
48
49	class PdfParams(TypedDict):	1✔
50	expand: NotRequired[List[str]]	1✔
51	"""	1✔
52	Specifies which fields in the response should be expanded.
53	"""
54
55	class RetrieveParams(TypedDict):	1✔
56	expand: NotRequired[List[str]]	1✔
57	"""	1✔
58	Specifies which fields in the response should be expanded.
59	"""
60
61	def list(	1✔
62	self, params: "FormService.ListParams", options: RequestOptions = {}
63	) -> ListObject[Form]:
64	"""
65	Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
66	"""
UNCOV 67	return cast(	×
68	ListObject[Form],
69	self._request(
70	"get",
71	"/v1/tax/forms",
72	api_mode="V1",
73	base_address="api",
74	params=params,
75	options=options,
76	),
77	)
78
79	async def list_async(	1✔
80	self, params: "FormService.ListParams", options: RequestOptions = {}
81	) -> ListObject[Form]:
82	"""
83	Returns a list of tax forms which were previously created. The tax forms are returned in sorted order, with the oldest tax forms appearing first.
84	"""
UNCOV 85	return cast(	×
86	ListObject[Form],
87	await self._request_async(
88	"get",
89	"/v1/tax/forms",
90	api_mode="V1",
91	base_address="api",
92	params=params,
93	options=options,
94	),
95	)
96
97	def retrieve(	1✔
98	self,
99	id: str,
100	params: "FormService.RetrieveParams" = {},
101	options: RequestOptions = {},
102	) -> Form:
103	"""
104	Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
105	"""
UNCOV 106	return cast(	×
107	Form,
108	self._request(
109	"get",
110	"/v1/tax/forms/{id}".format(id=sanitize_id(id)),
111	api_mode="V1",
112	base_address="api",
113	params=params,
114	options=options,
115	),
116	)
117
118	async def retrieve_async(	1✔
119	self,
120	id: str,
121	params: "FormService.RetrieveParams" = {},
122	options: RequestOptions = {},
123	) -> Form:
124	"""
125	Retrieves the details of a tax form that has previously been created. Supply the unique tax form ID that was returned from your previous request, and Stripe will return the corresponding tax form information.
126	"""
UNCOV 127	return cast(	×
128	Form,
129	await self._request_async(
130	"get",
131	"/v1/tax/forms/{id}".format(id=sanitize_id(id)),
132	api_mode="V1",
133	base_address="api",
134	params=params,
135	options=options,
136	),
137	)
138
139	def pdf(	1✔
140	self,
141	id: str,
142	params: "FormService.PdfParams" = {},
143	options: RequestOptions = {},
144	) -> Any:
145	"""
146	Download the PDF for a tax form.
147	"""
148	return cast(	1✔
149	Any,
150	self._request_stream(
151	"get",
152	"/v1/tax/forms/{id}/pdf".format(id=sanitize_id(id)),
153	api_mode="V1",
154	base_address="files",
155	params=params,
156	options=options,
157	),
158	)
159
160	async def pdf_async(	1✔
161	self,
162	id: str,
163	params: "FormService.PdfParams" = {},
164	options: RequestOptions = {},
165	) -> Any:
166	"""
167	Download the PDF for a tax form.
168	"""
UNCOV 169	return cast(	×
170	Any,
171	await self._request_stream_async(
172	"get",
173	"/v1/tax/forms/{id}/pdf".format(id=sanitize_id(id)),
174	api_mode="V1",
175	base_address="files",
176	params=params,
177	options=options,
178	),
179	)

stripe / stripe-python / 8428814992

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