9084563912

Committed 14 May 2024 06:42PM UTC coverage: 96.387% (+0.01%) from 96.375%

Build # 9084563912

Build Type

Pull #1328

github

Committed by

web-flow

Commit Message

Merge ad3546913 into 46edbe3eb

Pull Request Pull Request #1328: Update generated code

Run Details

1288 of 1901 branches covered (67.75%)

Branch coverage included in aggregate %.

88 of 89 new or added lines in 14 files covered. (98.88%)

803 existing lines in 91 files now uncovered.

64295 of 66140 relevant lines covered (97.21%)

0.97 hits per line

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

91.67

/stripe/_tax_id.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._deletable_api_resource import DeletableAPIResource
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 ClassVar, List, Optional, cast, overload
from typing_extensions import (
    Literal,
    NotRequired,
    TypedDict,
    Unpack,
    TYPE_CHECKING,
)

if TYPE_CHECKING:
    from stripe._account import Account
    from stripe._application import Application
    from stripe._customer import Customer


class TaxId(
    CreateableAPIResource["TaxId"],
    DeletableAPIResource["TaxId"],
    ListableAPIResource["TaxId"],
):
    """
    You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.
    Customer and account tax IDs get displayed on related invoices and credit notes.

    Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)
    """

    OBJECT_NAME: ClassVar[Literal["tax_id"]] = "tax_id"

    class Owner(StripeObject):
        account: Optional[ExpandableField["Account"]]
        """
        The account being referenced when `type` is `account`.
        """
        application: Optional[ExpandableField["Application"]]
        """
        The Connect Application being referenced when `type` is `application`.
        """
        customer: Optional[ExpandableField["Customer"]]
        """
        The customer being referenced when `type` is `customer`.
        """
        type: Literal["account", "application", "customer", "self"]
        """
        Type of owner referenced.
        """

    class Verification(StripeObject):
        status: Literal["pending", "unavailable", "unverified", "verified"]
        """
        Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.
        """
        verified_address: Optional[str]
        """
        Verified address.
        """
        verified_name: Optional[str]
        """
        Verified name.
        """

    class CreateParams(RequestOptions):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        owner: NotRequired["TaxId.CreateParamsOwner"]
        """
        The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
        """
        type: Literal[
            "ad_nrt",
            "ae_trn",
            "ar_cuit",
            "au_abn",
            "au_arn",
            "bg_uic",
            "bh_vat",
            "bo_tin",
            "br_cnpj",
            "br_cpf",
            "ca_bn",
            "ca_gst_hst",
            "ca_pst_bc",
            "ca_pst_mb",
            "ca_pst_sk",
            "ca_qst",
            "ch_vat",
            "cl_tin",
            "cn_tin",
            "co_nit",
            "cr_tin",
            "do_rcn",
            "ec_ruc",
            "eg_tin",
            "es_cif",
            "eu_oss_vat",
            "eu_vat",
            "gb_vat",
            "ge_vat",
            "hk_br",
            "hu_tin",
            "id_npwp",
            "il_vat",
            "in_gst",
            "is_vat",
            "jp_cn",
            "jp_rn",
            "jp_trn",
            "ke_pin",
            "kr_brn",
            "kz_bin",
            "li_uid",
            "mx_rfc",
            "my_frp",
            "my_itn",
            "my_sst",
            "ng_tin",
            "no_vat",
            "no_voec",
            "nz_gst",
            "om_vat",
            "pe_ruc",
            "ph_tin",
            "ro_tin",
            "rs_pib",
            "ru_inn",
            "ru_kpp",
            "sa_vat",
            "sg_gst",
            "sg_uen",
            "si_tin",
            "sv_nit",
            "th_vat",
            "tr_tin",
            "tw_vat",
            "ua_vat",
            "us_ein",
            "uy_ruc",
            "ve_rif",
            "vn_tin",
            "za_vat",
        ]
        """
        Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`
        """
        value: str
        """
        Value of the tax ID.
        """

    class CreateParamsOwner(TypedDict):
        account: NotRequired[str]
        """
        Account the tax ID belongs to. Required when `type=account`
        """
        customer: NotRequired[str]
        """
        Customer the tax ID belongs to. Required when `type=customer`
        """
        type: Literal["account", "application", "customer", "self"]
        """
        Type of owner referenced.
        """

    class DeleteParams(RequestOptions):
        pass

    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.
        """
        owner: NotRequired["TaxId.ListParamsOwner"]
        """
        The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
        """
        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 ListParamsOwner(TypedDict):
        account: NotRequired[str]
        """
        Account the tax ID belongs to. Required when `type=account`
        """
        customer: NotRequired[str]
        """
        Customer the tax ID belongs to. Required when `type=customer`
        """
        type: Literal["account", "application", "customer", "self"]
        """
        Type of owner referenced.
        """

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

    country: Optional[str]
    """
    Two-letter ISO code representing the country of the tax ID.
    """
    created: int
    """
    Time at which the object was created. Measured in seconds since the Unix epoch.
    """
    customer: Optional[ExpandableField["Customer"]]
    """
    ID of the customer.
    """
    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_id"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    owner: Optional[Owner]
    """
    The account or customer the tax ID belongs to.
    """
    type: Literal[
        "ad_nrt",
        "ae_trn",
        "ar_cuit",
        "au_abn",
        "au_arn",
        "bg_uic",
        "bh_vat",
        "bo_tin",
        "br_cnpj",
        "br_cpf",
        "ca_bn",
        "ca_gst_hst",
        "ca_pst_bc",
        "ca_pst_mb",
        "ca_pst_sk",
        "ca_qst",
        "ch_vat",
        "cl_tin",
        "cn_tin",
        "co_nit",
        "cr_tin",
        "do_rcn",
        "ec_ruc",
        "eg_tin",
        "es_cif",
        "eu_oss_vat",
        "eu_vat",
        "gb_vat",
        "ge_vat",
        "hk_br",
        "hu_tin",
        "id_npwp",
        "il_vat",
        "in_gst",
        "is_vat",
        "jp_cn",
        "jp_rn",
        "jp_trn",
        "ke_pin",
        "kr_brn",
        "kz_bin",
        "li_uid",
        "mx_rfc",
        "my_frp",
        "my_itn",
        "my_sst",
        "ng_tin",
        "no_vat",
        "no_voec",
        "nz_gst",
        "om_vat",
        "pe_ruc",
        "ph_tin",
        "ro_tin",
        "rs_pib",
        "ru_inn",
        "ru_kpp",
        "sa_vat",
        "sg_gst",
        "sg_uen",
        "si_tin",
        "sv_nit",
        "th_vat",
        "tr_tin",
        "tw_vat",
        "ua_vat",
        "unknown",
        "us_ein",
        "uy_ruc",
        "ve_rif",
        "vn_tin",
        "za_vat",
    ]
    """
    Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
    """
    value: str
    """
    Value of the tax ID.
    """
    verification: Optional[Verification]
    """
    Tax ID verification information.
    """
    deleted: Optional[Literal[True]]
    """
    Always true for a deleted object
    """

    @classmethod
    def create(cls, **params: Unpack["TaxId.CreateParams"]) -> "TaxId":
        """
        Creates a new account or customer tax_id object.
        """
        return cast(
            "TaxId",
            cls._static_request(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    async def create_async(
        cls, **params: Unpack["TaxId.CreateParams"]
    ) -> "TaxId":
        """
        Creates a new account or customer tax_id object.
        """
        return cast(
            "TaxId",
            await cls._static_request_async(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    def _cls_delete(
        cls, sid: str, **params: Unpack["TaxId.DeleteParams"]
    ) -> "TaxId":
        """
        Deletes an existing account or customer tax_id object.
        """
        url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
        return cast(
            "TaxId",
            cls._static_request(
                "delete",
                url,
                params=params,
            ),
        )

    @overload
    @staticmethod
    def delete(sid: str, **params: Unpack["TaxId.DeleteParams"]) -> "TaxId":
        """
        Deletes an existing account or customer tax_id object.
        """
        ...

    @overload
    def delete(self, **params: Unpack["TaxId.DeleteParams"]) -> "TaxId":
        """
        Deletes an existing account or customer tax_id object.
        """
        ...

    @class_method_variant("_cls_delete")
    def delete(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["TaxId.DeleteParams"]
    ) -> "TaxId":
        """
        Deletes an existing account or customer tax_id object.
        """
        return self._request_and_refresh(
            "delete",
            self.instance_url(),
            params=params,
        )

    @classmethod
    async def _cls_delete_async(
        cls, sid: str, **params: Unpack["TaxId.DeleteParams"]
    ) -> "TaxId":
        """
        Deletes an existing account or customer tax_id object.
        """
        url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
        return cast(
            "TaxId",
            await cls._static_request_async(
                "delete",
                url,
                params=params,
            ),
        )

    @overload
    @staticmethod
    async def delete_async(
        sid: str, **params: Unpack["TaxId.DeleteParams"]
    ) -> "TaxId":
        """
        Deletes an existing account or customer tax_id object.
        """
        ...

    @overload
    async def delete_async(
        self, **params: Unpack["TaxId.DeleteParams"]
    ) -> "TaxId":
        """
        Deletes an existing account or customer tax_id object.
        """
        ...

    @class_method_variant("_cls_delete_async")
    async def delete_async(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["TaxId.DeleteParams"]
    ) -> "TaxId":
        """
        Deletes an existing account or customer tax_id object.
        """
        return await self._request_and_refresh_async(
            "delete",
            self.instance_url(),
            params=params,
        )

    @classmethod
    def list(cls, **params: Unpack["TaxId.ListParams"]) -> ListObject["TaxId"]:
        """
        Returns a list of tax IDs.
        """
        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["TaxId.ListParams"]
    ) -> ListObject["TaxId"]:
        """
        Returns a list of tax IDs.
        """
        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 retrieve(
        cls, id: str, **params: Unpack["TaxId.RetrieveParams"]
    ) -> "TaxId":
        """
        Retrieves an account or customer tax_id object.
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["TaxId.RetrieveParams"]
    ) -> "TaxId":
        """
        Retrieves an account or customer tax_id object.
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

    _inner_class_types = {"owner": Owner, "verification": Verification}

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._createable_api_resource import CreateableAPIResource	1✔
4	from stripe._deletable_api_resource import DeletableAPIResource	1✔
5	from stripe._expandable_field import ExpandableField	1✔
6	from stripe._list_object import ListObject	1✔
7	from stripe._listable_api_resource import ListableAPIResource	1✔
8	from stripe._request_options import RequestOptions	1✔
9	from stripe._stripe_object import StripeObject	1✔
10	from stripe._util import class_method_variant, sanitize_id	1✔
11	from typing import ClassVar, List, Optional, cast, overload	1✔
12	from typing_extensions import (	1✔
13	Literal,
14	NotRequired,
15	TypedDict,
16	Unpack,
17	TYPE_CHECKING,
18	)
19
20	if TYPE_CHECKING:	1!
21	from stripe._account import Account	×
22	from stripe._application import Application	×
23	from stripe._customer import Customer	×
24
25
26	class TaxId(	1✔
27	CreateableAPIResource["TaxId"],
28	DeletableAPIResource["TaxId"],
29	ListableAPIResource["TaxId"],
30	):
31	"""
32	You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.
33	Customer and account tax IDs get displayed on related invoices and credit notes.
34
35	Related guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)
36	"""
37
38	OBJECT_NAME: ClassVar[Literal["tax_id"]] = "tax_id"	1✔
39
40	class Owner(StripeObject):	1✔
41	account: Optional[ExpandableField["Account"]]	1✔
42	"""	1✔
43	The account being referenced when `type` is `account`.
44	"""
45	application: Optional[ExpandableField["Application"]]	1✔
46	"""	1✔
47	The Connect Application being referenced when `type` is `application`.
48	"""
49	customer: Optional[ExpandableField["Customer"]]	1✔
50	"""	1✔
51	The customer being referenced when `type` is `customer`.
52	"""
53	type: Literal["account", "application", "customer", "self"]	1✔
54	"""	1✔
55	Type of owner referenced.
56	"""
57
58	class Verification(StripeObject):	1✔
59	status: Literal["pending", "unavailable", "unverified", "verified"]	1✔
60	"""	1✔
61	Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`.
62	"""
63	verified_address: Optional[str]	1✔
64	"""	1✔
65	Verified address.
66	"""
67	verified_name: Optional[str]	1✔
68	"""	1✔
69	Verified name.
70	"""
71
72	class CreateParams(RequestOptions):	1✔
73	expand: NotRequired[List[str]]	1✔
74	"""	1✔
75	Specifies which fields in the response should be expanded.
76	"""
77	owner: NotRequired["TaxId.CreateParamsOwner"]	1✔
78	"""	1✔
79	The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
80	"""
81	type: Literal[	1✔
82	"ad_nrt",
83	"ae_trn",
84	"ar_cuit",
85	"au_abn",
86	"au_arn",
87	"bg_uic",
88	"bh_vat",
89	"bo_tin",
90	"br_cnpj",
91	"br_cpf",
92	"ca_bn",
93	"ca_gst_hst",
94	"ca_pst_bc",
95	"ca_pst_mb",
96	"ca_pst_sk",
97	"ca_qst",
98	"ch_vat",
99	"cl_tin",
100	"cn_tin",
101	"co_nit",
102	"cr_tin",
103	"do_rcn",
104	"ec_ruc",
105	"eg_tin",
106	"es_cif",
107	"eu_oss_vat",
108	"eu_vat",
109	"gb_vat",
110	"ge_vat",
111	"hk_br",
112	"hu_tin",
113	"id_npwp",
114	"il_vat",
115	"in_gst",
116	"is_vat",
117	"jp_cn",
118	"jp_rn",
119	"jp_trn",
120	"ke_pin",
121	"kr_brn",
122	"kz_bin",
123	"li_uid",
124	"mx_rfc",
125	"my_frp",
126	"my_itn",
127	"my_sst",
128	"ng_tin",
129	"no_vat",
130	"no_voec",
131	"nz_gst",
132	"om_vat",
133	"pe_ruc",
134	"ph_tin",
135	"ro_tin",
136	"rs_pib",
137	"ru_inn",
138	"ru_kpp",
139	"sa_vat",
140	"sg_gst",
141	"sg_uen",
142	"si_tin",
143	"sv_nit",
144	"th_vat",
145	"tr_tin",
146	"tw_vat",
147	"ua_vat",
148	"us_ein",
149	"uy_ruc",
150	"ve_rif",
151	"vn_tin",
152	"za_vat",
153	]
154	"""	1✔
155	Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`
156	"""
157	value: str	1✔
158	"""	1✔
159	Value of the tax ID.
160	"""
161
162	class CreateParamsOwner(TypedDict):	1✔
163	account: NotRequired[str]	1✔
164	"""	1✔
165	Account the tax ID belongs to. Required when `type=account`
166	"""
167	customer: NotRequired[str]	1✔
168	"""	1✔
169	Customer the tax ID belongs to. Required when `type=customer`
170	"""
171	type: Literal["account", "application", "customer", "self"]	1✔
172	"""	1✔
173	Type of owner referenced.
174	"""
175
176	class DeleteParams(RequestOptions):	1✔
177	pass	1✔
178
179	class ListParams(RequestOptions):	1✔
180	ending_before: NotRequired[str]	1✔
181	"""	1✔
182	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.
183	"""
184	expand: NotRequired[List[str]]	1✔
185	"""	1✔
186	Specifies which fields in the response should be expanded.
187	"""
188	limit: NotRequired[int]	1✔
189	"""	1✔
190	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
191	"""
192	owner: NotRequired["TaxId.ListParamsOwner"]	1✔
193	"""	1✔
194	The account or customer the tax ID belongs to. Defaults to `owner[type]=self`.
195	"""
196	starting_after: NotRequired[str]	1✔
197	"""	1✔
198	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.
199	"""
200
201	class ListParamsOwner(TypedDict):	1✔
202	account: NotRequired[str]	1✔
203	"""	1✔
204	Account the tax ID belongs to. Required when `type=account`
205	"""
206	customer: NotRequired[str]	1✔
207	"""	1✔
208	Customer the tax ID belongs to. Required when `type=customer`
209	"""
210	type: Literal["account", "application", "customer", "self"]	1✔
211	"""	1✔
212	Type of owner referenced.
213	"""
214
215	class RetrieveParams(RequestOptions):	1✔
216	expand: NotRequired[List[str]]	1✔
217	"""	1✔
218	Specifies which fields in the response should be expanded.
219	"""
220
221	country: Optional[str]	1✔
222	"""	1✔
223	Two-letter ISO code representing the country of the tax ID.
224	"""
225	created: int	1✔
226	"""	1✔
227	Time at which the object was created. Measured in seconds since the Unix epoch.
228	"""
229	customer: Optional[ExpandableField["Customer"]]	1✔
230	"""	1✔
231	ID of the customer.
232	"""
233	id: str	1✔
234	"""	1✔
235	Unique identifier for the object.
236	"""
237	livemode: bool	1✔
238	"""	1✔
239	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
240	"""
241	object: Literal["tax_id"]	1✔
242	"""	1✔
243	String representing the object's type. Objects of the same type share the same value.
244	"""
245	owner: Optional[Owner]	1✔
246	"""	1✔
247	The account or customer the tax ID belongs to.
248	"""
249	type: Literal[	1✔
250	"ad_nrt",
251	"ae_trn",
252	"ar_cuit",
253	"au_abn",
254	"au_arn",
255	"bg_uic",
256	"bh_vat",
257	"bo_tin",
258	"br_cnpj",
259	"br_cpf",
260	"ca_bn",
261	"ca_gst_hst",
262	"ca_pst_bc",
263	"ca_pst_mb",
264	"ca_pst_sk",
265	"ca_qst",
266	"ch_vat",
267	"cl_tin",
268	"cn_tin",
269	"co_nit",
270	"cr_tin",
271	"do_rcn",
272	"ec_ruc",
273	"eg_tin",
274	"es_cif",
275	"eu_oss_vat",
276	"eu_vat",
277	"gb_vat",
278	"ge_vat",
279	"hk_br",
280	"hu_tin",
281	"id_npwp",
282	"il_vat",
283	"in_gst",
284	"is_vat",
285	"jp_cn",
286	"jp_rn",
287	"jp_trn",
288	"ke_pin",
289	"kr_brn",
290	"kz_bin",
291	"li_uid",
292	"mx_rfc",
293	"my_frp",
294	"my_itn",
295	"my_sst",
296	"ng_tin",
297	"no_vat",
298	"no_voec",
299	"nz_gst",
300	"om_vat",
301	"pe_ruc",
302	"ph_tin",
303	"ro_tin",
304	"rs_pib",
305	"ru_inn",
306	"ru_kpp",
307	"sa_vat",
308	"sg_gst",
309	"sg_uen",
310	"si_tin",
311	"sv_nit",
312	"th_vat",
313	"tr_tin",
314	"tw_vat",
315	"ua_vat",
316	"unknown",
317	"us_ein",
318	"uy_ruc",
319	"ve_rif",
320	"vn_tin",
321	"za_vat",
322	]
323	"""	1✔
324	Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`
325	"""
326	value: str	1✔
327	"""	1✔
328	Value of the tax ID.
329	"""
330	verification: Optional[Verification]	1✔
331	"""	1✔
332	Tax ID verification information.
333	"""
334	deleted: Optional[Literal[True]]	1✔
335	"""	1✔
336	Always true for a deleted object
337	"""
338
339	@classmethod	1✔
340	def create(cls, **params: Unpack["TaxId.CreateParams"]) -> "TaxId":	1✔
341	"""
342	Creates a new account or customer tax_id object.
343	"""
344	return cast(	1✔
345	"TaxId",
346	cls._static_request(
347	"post",
348	cls.class_url(),
349	params=params,
350	),
351	)
352
353	@classmethod	1✔
354	async def create_async(	1✔
355	cls, **params: Unpack["TaxId.CreateParams"]
356	) -> "TaxId":
357	"""
358	Creates a new account or customer tax_id object.
359	"""
360	return cast(	1✔
361	"TaxId",
362	await cls._static_request_async(
363	"post",
364	cls.class_url(),
365	params=params,
366	),
367	)
368
369	@classmethod	1✔
370	def _cls_delete(	1✔
371	cls, sid: str, **params: Unpack["TaxId.DeleteParams"]
372	) -> "TaxId":
373	"""
374	Deletes an existing account or customer tax_id object.
375	"""
376	url = "%s/%s" % (cls.class_url(), sanitize_id(sid))	1✔
377	return cast(	1✔
378	"TaxId",
379	cls._static_request(
380	"delete",
381	url,
382	params=params,
383	),
384	)
385
386	@overload	1✔
387	@staticmethod	1✔
388	def delete(sid: str, **params: Unpack["TaxId.DeleteParams"]) -> "TaxId":	1✔
389	"""
390	Deletes an existing account or customer tax_id object.
391	"""
392	...	×
393
394	@overload	1✔
395	def delete(self, **params: Unpack["TaxId.DeleteParams"]) -> "TaxId":	1✔
396	"""
397	Deletes an existing account or customer tax_id object.
398	"""
399	...	×
400
401	@class_method_variant("_cls_delete")	1✔
402	def delete( # pyright: ignore[reportGeneralTypeIssues]	1✔
403	self, **params: Unpack["TaxId.DeleteParams"]
404	) -> "TaxId":
405	"""
406	Deletes an existing account or customer tax_id object.
407	"""
408	return self._request_and_refresh(	1✔
409	"delete",
410	self.instance_url(),
411	params=params,
412	)
413
414	@classmethod	1✔
415	async def _cls_delete_async(	1✔
416	cls, sid: str, **params: Unpack["TaxId.DeleteParams"]
417	) -> "TaxId":
418	"""
419	Deletes an existing account or customer tax_id object.
420	"""
421	url = "%s/%s" % (cls.class_url(), sanitize_id(sid))	1✔
422	return cast(	1✔
423	"TaxId",
424	await cls._static_request_async(
425	"delete",
426	url,
427	params=params,
428	),
429	)
430
431	@overload	1✔
432	@staticmethod	1✔
433	async def delete_async(	1✔
434	sid: str, **params: Unpack["TaxId.DeleteParams"]
435	) -> "TaxId":
436	"""
437	Deletes an existing account or customer tax_id object.
438	"""
439	...	×
440
441	@overload	1✔
442	async def delete_async(	1✔
443	self, **params: Unpack["TaxId.DeleteParams"]
444	) -> "TaxId":
445	"""
446	Deletes an existing account or customer tax_id object.
447	"""
448	...	×
449
450	@class_method_variant("_cls_delete_async")	1✔
451	async def delete_async( # pyright: ignore[reportGeneralTypeIssues]	1✔
452	self, **params: Unpack["TaxId.DeleteParams"]
453	) -> "TaxId":
454	"""
455	Deletes an existing account or customer tax_id object.
456	"""
457	return await self._request_and_refresh_async(	×
458	"delete",
459	self.instance_url(),
460	params=params,
461	)
462
463	@classmethod	1✔
464	def list(cls, **params: Unpack["TaxId.ListParams"]) -> ListObject["TaxId"]:	1✔
465	"""
466	Returns a list of tax IDs.
467	"""
468	result = cls._static_request(	1✔
469	"get",
470	cls.class_url(),
471	params=params,
472	)
473	if not isinstance(result, ListObject):	1!
UNCOV 474	raise TypeError(	×
475	"Expected list object from API, got %s"
476	% (type(result).__name__)
477	)
478
479	return result	1✔
480
481	@classmethod	1✔
482	async def list_async(	1✔
483	cls, **params: Unpack["TaxId.ListParams"]
484	) -> ListObject["TaxId"]:
485	"""
486	Returns a list of tax IDs.
487	"""
488	result = await cls._static_request_async(	1✔
489	"get",
490	cls.class_url(),
491	params=params,
492	)
493	if not isinstance(result, ListObject):	1!
UNCOV 494	raise TypeError(	×
495	"Expected list object from API, got %s"
496	% (type(result).__name__)
497	)
498
499	return result	1✔
500
501	@classmethod	1✔
502	def retrieve(	1✔
503	cls, id: str, **params: Unpack["TaxId.RetrieveParams"]
504	) -> "TaxId":
505	"""
506	Retrieves an account or customer tax_id object.
507	"""
508	instance = cls(id, **params)	1✔
509	instance.refresh()	1✔
510	return instance	1✔
511
512	@classmethod	1✔
513	async def retrieve_async(	1✔
514	cls, id: str, **params: Unpack["TaxId.RetrieveParams"]
515	) -> "TaxId":
516	"""
517	Retrieves an account or customer tax_id object.
518	"""
519	instance = cls(id, **params)	1✔
520	await instance.refresh_async()	1✔
521	return instance	1✔
522
523	_inner_class_types = {"owner": Owner, "verification": Verification}	1✔

stripe / stripe-python / 9084563912

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