8442428644

Committed 26 Mar 2024 08:23PM UTC coverage: 96.386% (+0.001%) from 96.385%

Build # 8442428644

Build Type

Pull #1277

github

Committed by

web-flow

Commit Message

Merge 09f2fb2b1 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 %.

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

859 existing lines in 55 files now uncovered.

81007 of 83419 relevant lines covered (97.11%)

0.97 hits per line

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

80.29

/stripe/tax/_form.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from stripe._util import class_method_variant, sanitize_id
from typing import Any, ClassVar, List, Optional, cast, overload
from typing_extensions import (
    Literal,
    NotRequired,
    TypedDict,
    Unpack,
    TYPE_CHECKING,
)

if TYPE_CHECKING:
    from stripe._account import Account


class Form(ListableAPIResource["Form"]):
    """
    Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.

    Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
    """

    OBJECT_NAME: ClassVar[Literal["tax.form"]] = "tax.form"

    class FilingStatus(StripeObject):
        class Jurisdiction(StripeObject):
            country: str
            """
            Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Always `US`.
            """
            level: Literal["country", "state"]
            """
            Indicates the level of the jurisdiction where the form was filed.
            """
            state: Optional[str]
            """
            [ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, "NY" for New York, United States.
            """

        effective_at: int
        """
        Time when the filing status was updated.
        """
        jurisdiction: Jurisdiction
        value: Literal["accepted", "filed", "rejected"]
        """
        The current status of the filed form.
        """
        _inner_class_types = {"jurisdiction": Jurisdiction}

    class Payee(StripeObject):
        account: Optional[ExpandableField["Account"]]
        """
        The ID of the payee's Stripe account.
        """
        type: Literal["account"]
        """
        Always `account`.
        """

    class Us1099K(StripeObject):
        reporting_year: int
        """
        Year represented by the information reported on the tax form.
        """

    class Us1099Misc(StripeObject):
        reporting_year: int
        """
        Year represented by the information reported on the tax form.
        """

    class Us1099Nec(StripeObject):
        reporting_year: int
        """
        Year represented by the information reported on the tax form.
        """

    class ListParams(RequestOptions):
        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: "Form.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(RequestOptions):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """

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

    corrected_by: Optional[ExpandableField["Form"]]
    """
    The form that corrects this form, if any.
    """
    created: int
    """
    Time at which the object was created. Measured in seconds since the Unix epoch.
    """
    filing_statuses: List[FilingStatus]
    """
    A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction's tax authority.
    """
    id: str
    """
    Unique identifier for the object.
    """
    livemode: bool
    """
    Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
    """
    object: Literal["tax.form"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    payee: Payee
    type: Literal["us_1099_k", "us_1099_misc", "us_1099_nec"]
    """
    The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
    """
    us_1099_k: Optional[Us1099K]
    us_1099_misc: Optional[Us1099Misc]
    us_1099_nec: Optional[Us1099Nec]

    @classmethod
    def list(cls, **params: Unpack["Form.ListParams"]) -> 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.
        """
        result = cls._static_request(
            "get",
            cls.class_url(),
            params=params,
        )
        if not isinstance(result, ListObject):

            raise TypeError(
                "Expected list object from API, got %s"
                % (type(result).__name__)
            )

        return result

    @classmethod
    async def list_async(
        cls, **params: Unpack["Form.ListParams"]
    ) -> 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.
        """
        result = await cls._static_request_async(
            "get",
            cls.class_url(),
            params=params,
        )
        if not isinstance(result, ListObject):

            raise TypeError(
                "Expected list object from API, got %s"
                % (type(result).__name__)
            )

        return result

    @classmethod
    def _cls_pdf(cls, id: str, **params: Unpack["Form.PdfParams"]) -> Any:
        """
        Download the PDF for a tax form.
        """
        return cast(
            Any,
            cls._static_request_stream(
                "get",
                "/v1/tax/forms/{id}/pdf".format(id=sanitize_id(id)),
                params=params,
                base_address="files",
            ),
        )

    @overload
    @staticmethod
    def pdf(id: str, **params: Unpack["Form.PdfParams"]) -> Any:
        """
        Download the PDF for a tax form.
        """
        ...

    @overload
    def pdf(self, **params: Unpack["Form.PdfParams"]) -> Any:
        """
        Download the PDF for a tax form.
        """
        ...

    @class_method_variant("_cls_pdf")
    def pdf(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["Form.PdfParams"]
    ) -> Any:
        """
        Download the PDF for a tax form.
        """
        return cast(
            Any,
            self._request_stream(
                "get",
                "/v1/tax/forms/{id}/pdf".format(
                    id=sanitize_id(self.get("id"))
                ),
                params=params,
            ),
        )

    @classmethod
    async def _cls_pdf_async(
        cls, id: str, **params: Unpack["Form.PdfParams"]
    ) -> Any:
        """
        Download the PDF for a tax form.
        """
        return cast(
            Any,
            await cls._static_request_stream_async(
                "get",
                "/v1/tax/forms/{id}/pdf".format(id=sanitize_id(id)),
                params=params,
                base_address="files",
            ),
        )

    @overload
    @staticmethod
    async def pdf_async(id: str, **params: Unpack["Form.PdfParams"]) -> Any:
        """
        Download the PDF for a tax form.
        """
        ...

    @overload
    async def pdf_async(self, **params: Unpack["Form.PdfParams"]) -> Any:
        """
        Download the PDF for a tax form.
        """
        ...

    @class_method_variant("_cls_pdf_async")
    async def pdf_async(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["Form.PdfParams"]
    ) -> 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(self.get("id"))
                ),
                params=params,
            ),
        )

    @classmethod
    def retrieve(
        cls, id: str, **params: Unpack["Form.RetrieveParams"]
    ) -> "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.
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["Form.RetrieveParams"]
    ) -> "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.
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

    _inner_class_types = {
        "filing_statuses": FilingStatus,
        "payee": Payee,
        "us_1099_k": Us1099K,
        "us_1099_misc": Us1099Misc,
        "us_1099_nec": Us1099Nec,
    }

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._expandable_field import ExpandableField	1✔
4	from stripe._list_object import ListObject	1✔
5	from stripe._listable_api_resource import ListableAPIResource	1✔
6	from stripe._request_options import RequestOptions	1✔
7	from stripe._stripe_object import StripeObject	1✔
8	from stripe._util import class_method_variant, sanitize_id	1✔
9	from typing import Any, ClassVar, List, Optional, cast, overload	1✔
10	from typing_extensions import (	1✔
11	Literal,
12	NotRequired,
13	TypedDict,
14	Unpack,
15	TYPE_CHECKING,
16	)
17
18	if TYPE_CHECKING:	1!
19	from stripe._account import Account	×
20
21
22	class Form(ListableAPIResource["Form"]):	1✔
23	"""
24	Tax forms are legal documents which are delivered to one or more tax authorities for information reporting purposes.
25
26	Related guide: [US tax reporting for Connect platforms](https://stripe.com/docs/connect/tax-reporting)
27	"""
28
29	OBJECT_NAME: ClassVar[Literal["tax.form"]] = "tax.form"	1✔
30
31	class FilingStatus(StripeObject):	1✔
32	class Jurisdiction(StripeObject):	1✔
33	country: str	1✔
34	"""	1✔
35	Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). Always `US`.
36	"""
37	level: Literal["country", "state"]	1✔
38	"""	1✔
39	Indicates the level of the jurisdiction where the form was filed.
40	"""
41	state: Optional[str]	1✔
42	"""	1✔
43	[ISO 3166-2 U.S. state code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix, if any. For example, "NY" for New York, United States.
44	"""
45
46	effective_at: int	1✔
47	"""	1✔
48	Time when the filing status was updated.
49	"""
50	jurisdiction: Jurisdiction	1✔
51	value: Literal["accepted", "filed", "rejected"]	1✔
52	"""	1✔
53	The current status of the filed form.
54	"""
55	_inner_class_types = {"jurisdiction": Jurisdiction}	1✔
56
57	class Payee(StripeObject):	1✔
58	account: Optional[ExpandableField["Account"]]	1✔
59	"""	1✔
60	The ID of the payee's Stripe account.
61	"""
62	type: Literal["account"]	1✔
63	"""	1✔
64	Always `account`.
65	"""
66
67	class Us1099K(StripeObject):	1✔
68	reporting_year: int	1✔
69	"""	1✔
70	Year represented by the information reported on the tax form.
71	"""
72
73	class Us1099Misc(StripeObject):	1✔
74	reporting_year: int	1✔
75	"""	1✔
76	Year represented by the information reported on the tax form.
77	"""
78
79	class Us1099Nec(StripeObject):	1✔
80	reporting_year: int	1✔
81	"""	1✔
82	Year represented by the information reported on the tax form.
83	"""
84
85	class ListParams(RequestOptions):	1✔
86	ending_before: NotRequired[str]	1✔
87	"""	1✔
88	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.
89	"""
90	expand: NotRequired[List[str]]	1✔
91	"""	1✔
92	Specifies which fields in the response should be expanded.
93	"""
94	limit: NotRequired[int]	1✔
95	"""	1✔
96	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
97	"""
98	payee: "Form.ListParamsPayee"	1✔
99	"""	1✔
100	The payee whose volume is represented on the tax form.
101	"""
102	starting_after: NotRequired[str]	1✔
103	"""	1✔
104	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.
105	"""
106	type: NotRequired[Literal["us_1099_k", "us_1099_misc", "us_1099_nec"]]	1✔
107	"""	1✔
108	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.
109	"""
110
111	class ListParamsPayee(TypedDict):	1✔
112	account: NotRequired[str]	1✔
113	"""	1✔
114	The ID of the Stripe account whose forms will be retrieved.
115	"""
116	type: NotRequired[Literal["account"]]	1✔
117	"""	1✔
118	Specifies the payee type. Always `account`.
119	"""
120
121	class PdfParams(RequestOptions):	1✔
122	expand: NotRequired[List[str]]	1✔
123	"""	1✔
124	Specifies which fields in the response should be expanded.
125	"""
126
127	class RetrieveParams(RequestOptions):	1✔
128	expand: NotRequired[List[str]]	1✔
129	"""	1✔
130	Specifies which fields in the response should be expanded.
131	"""
132
133	corrected_by: Optional[ExpandableField["Form"]]	1✔
134	"""	1✔
135	The form that corrects this form, if any.
136	"""
137	created: int	1✔
138	"""	1✔
139	Time at which the object was created. Measured in seconds since the Unix epoch.
140	"""
141	filing_statuses: List[FilingStatus]	1✔
142	"""	1✔
143	A list of tax filing statuses. Note that a filing status will only be included if the form has been filed directly with the jurisdiction's tax authority.
144	"""
145	id: str	1✔
146	"""	1✔
147	Unique identifier for the object.
148	"""
149	livemode: bool	1✔
150	"""	1✔
151	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
152	"""
153	object: Literal["tax.form"]	1✔
154	"""	1✔
155	String representing the object's type. Objects of the same type share the same value.
156	"""
157	payee: Payee	1✔
158	type: Literal["us_1099_k", "us_1099_misc", "us_1099_nec"]	1✔
159	"""	1✔
160	The type of the tax form. An additional hash is included on the tax form with a name matching this value. It contains additional information specific to the tax form type.
161	"""
162	us_1099_k: Optional[Us1099K]	1✔
163	us_1099_misc: Optional[Us1099Misc]	1✔
164	us_1099_nec: Optional[Us1099Nec]	1✔
165
166	@classmethod	1✔
167	def list(cls, **params: Unpack["Form.ListParams"]) -> ListObject["Form"]:	1✔
168	"""
169	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.
170	"""
UNCOV 171	result = cls._static_request(	×
172	"get",
173	cls.class_url(),
174	params=params,
175	)
UNCOV 176	if not isinstance(result, ListObject):	×
177
178	raise TypeError(	×
179	"Expected list object from API, got %s"
180	% (type(result).__name__)
181	)
182
UNCOV 183	return result	×
184
185	@classmethod	1✔
186	async def list_async(	1✔
187	cls, **params: Unpack["Form.ListParams"]
188	) -> ListObject["Form"]:
189	"""
190	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.
191	"""
UNCOV 192	result = await cls._static_request_async(	×
193	"get",
194	cls.class_url(),
195	params=params,
196	)
UNCOV 197	if not isinstance(result, ListObject):	×
198
199	raise TypeError(	×
200	"Expected list object from API, got %s"
201	% (type(result).__name__)
202	)
203
UNCOV 204	return result	×
205
206	@classmethod	1✔
207	def _cls_pdf(cls, id: str, **params: Unpack["Form.PdfParams"]) -> Any:	1✔
208	"""
209	Download the PDF for a tax form.
210	"""
211	return cast(	1✔
212	Any,
213	cls._static_request_stream(
214	"get",
215	"/v1/tax/forms/{id}/pdf".format(id=sanitize_id(id)),
216	params=params,
217	base_address="files",
218	),
219	)
220
221	@overload	1✔
222	@staticmethod	1✔
223	def pdf(id: str, **params: Unpack["Form.PdfParams"]) -> Any:	1✔
224	"""
225	Download the PDF for a tax form.
226	"""
UNCOV 227	...	×
228
229	@overload	1✔
230	def pdf(self, **params: Unpack["Form.PdfParams"]) -> Any:	1✔
231	"""
232	Download the PDF for a tax form.
233	"""
UNCOV 234	...	×
235
236	@class_method_variant("_cls_pdf")	1✔
237	def pdf( # pyright: ignore[reportGeneralTypeIssues]	1✔
238	self, **params: Unpack["Form.PdfParams"]
239	) -> Any:
240	"""
241	Download the PDF for a tax form.
242	"""
UNCOV 243	return cast(	×
244	Any,
245	self._request_stream(
246	"get",
247	"/v1/tax/forms/{id}/pdf".format(
248	id=sanitize_id(self.get("id"))
249	),
250	params=params,
251	),
252	)
253
254	@classmethod	1✔
255	async def _cls_pdf_async(	1✔
256	cls, id: str, **params: Unpack["Form.PdfParams"]
257	) -> Any:
258	"""
259	Download the PDF for a tax form.
260	"""
UNCOV 261	return cast(	×
262	Any,
263	await cls._static_request_stream_async(
264	"get",
265	"/v1/tax/forms/{id}/pdf".format(id=sanitize_id(id)),
266	params=params,
267	base_address="files",
268	),
269	)
270
271	@overload	1✔
272	@staticmethod	1✔
273	async def pdf_async(id: str, **params: Unpack["Form.PdfParams"]) -> Any:	1✔
274	"""
275	Download the PDF for a tax form.
276	"""
UNCOV 277	...	×
278
279	@overload	1✔
280	async def pdf_async(self, **params: Unpack["Form.PdfParams"]) -> Any:	1✔
281	"""
282	Download the PDF for a tax form.
283	"""
UNCOV 284	...	×
285
286	@class_method_variant("_cls_pdf_async")	1✔
287	async def pdf_async( # pyright: ignore[reportGeneralTypeIssues]	1✔
288	self, **params: Unpack["Form.PdfParams"]
289	) -> Any:
290	"""
291	Download the PDF for a tax form.
292	"""
UNCOV 293	return cast(	×
294	Any,
295	await self._request_stream_async(
296	"get",
297	"/v1/tax/forms/{id}/pdf".format(
298	id=sanitize_id(self.get("id"))
299	),
300	params=params,
301	),
302	)
303
304	@classmethod	1✔
305	def retrieve(	1✔
306	cls, id: str, **params: Unpack["Form.RetrieveParams"]
307	) -> "Form":
308	"""
309	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.
310	"""
UNCOV 311	instance = cls(id, **params)	×
UNCOV 312	instance.refresh()	×
313	return instance	×
314
315	@classmethod	1✔
316	async def retrieve_async(	1✔
317	cls, id: str, **params: Unpack["Form.RetrieveParams"]
318	) -> "Form":
319	"""
320	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.
321	"""
UNCOV 322	instance = cls(id, **params)	×
UNCOV 323	await instance.refresh_async()	×
324	return instance	×
325
326	_inner_class_types = {	1✔
327	"filing_statuses": FilingStatus,
328	"payee": Payee,
329	"us_1099_k": Us1099K,
330	"us_1099_misc": Us1099Misc,
331	"us_1099_nec": Us1099Nec,
332	}

stripe / stripe-python / 8442428644

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