9086309001

Committed 14 May 2024 09:16PM UTC coverage: 96.388% (+0.01%) from 96.375%

Build # 9086309001

Build Type

Pull #1328

github

Committed by

web-flow

Commit Message

Merge a6423c6ee into 46edbe3eb

Pull Request Pull Request #1328: Update generated code

Run Details

1288 of 1901 branches covered (67.75%)

Branch coverage included in aggregate %.

90 of 91 new or added lines in 14 files covered. (98.9%)

803 existing lines in 91 files now uncovered.

64297 of 66142 relevant lines covered (97.21%)

0.97 hits per line

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

92.45

/stripe/_tax_code.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from typing import ClassVar, List
from typing_extensions import Literal, NotRequired, Unpack


class TaxCode(ListableAPIResource["TaxCode"]):
    """
    [Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
    """

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

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

    description: str
    """
    A detailed description of which types of products the tax code represents.
    """
    id: str
    """
    Unique identifier for the object.
    """
    name: str
    """
    A short name for the tax code.
    """
    object: Literal["tax_code"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """

    @classmethod
    def list(
        cls, **params: Unpack["TaxCode.ListParams"]
    ) -> ListObject["TaxCode"]:
        """
        A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
        """
        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["TaxCode.ListParams"]
    ) -> ListObject["TaxCode"]:
        """
        A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
        """
        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["TaxCode.RetrieveParams"]
    ) -> "TaxCode":
        """
        Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["TaxCode.RetrieveParams"]
    ) -> "TaxCode":
        """
        Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._list_object import ListObject	1✔
4	from stripe._listable_api_resource import ListableAPIResource	1✔
5	from stripe._request_options import RequestOptions	1✔
6	from typing import ClassVar, List	1✔
7	from typing_extensions import Literal, NotRequired, Unpack	1✔
8
9
10	class TaxCode(ListableAPIResource["TaxCode"]):	1✔
11	"""
12	[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes.
13	"""
14
15	OBJECT_NAME: ClassVar[Literal["tax_code"]] = "tax_code"	1✔
16
17	class ListParams(RequestOptions):	1✔
18	ending_before: NotRequired[str]	1✔
19	"""	1✔
20	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.
21	"""
22	expand: NotRequired[List[str]]	1✔
23	"""	1✔
24	Specifies which fields in the response should be expanded.
25	"""
26	limit: NotRequired[int]	1✔
27	"""	1✔
28	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
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
35	class RetrieveParams(RequestOptions):	1✔
36	expand: NotRequired[List[str]]	1✔
37	"""	1✔
38	Specifies which fields in the response should be expanded.
39	"""
40
41	description: str	1✔
42	"""	1✔
43	A detailed description of which types of products the tax code represents.
44	"""
45	id: str	1✔
46	"""	1✔
47	Unique identifier for the object.
48	"""
49	name: str	1✔
50	"""	1✔
51	A short name for the tax code.
52	"""
53	object: Literal["tax_code"]	1✔
54	"""	1✔
55	String representing the object's type. Objects of the same type share the same value.
56	"""
57
58	@classmethod	1✔
59	def list(	1✔
60	cls, **params: Unpack["TaxCode.ListParams"]
61	) -> ListObject["TaxCode"]:
62	"""
63	A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
64	"""
65	result = cls._static_request(	1✔
66	"get",
67	cls.class_url(),
68	params=params,
69	)
70	if not isinstance(result, ListObject):	1!
UNCOV 71	raise TypeError(	×
72	"Expected list object from API, got %s"
73	% (type(result).__name__)
74	)
75
76	return result	1✔
77
78	@classmethod	1✔
79	async def list_async(	1✔
80	cls, **params: Unpack["TaxCode.ListParams"]
81	) -> ListObject["TaxCode"]:
82	"""
83	A list of [all tax codes available](https://stripe.com/docs/tax/tax-categories) to add to Products in order to allow specific tax calculations.
84	"""
85	result = await cls._static_request_async(	1✔
86	"get",
87	cls.class_url(),
88	params=params,
89	)
90	if not isinstance(result, ListObject):	1!
UNCOV 91	raise TypeError(	×
92	"Expected list object from API, got %s"
93	% (type(result).__name__)
94	)
95
96	return result	1✔
97
98	@classmethod	1✔
99	def retrieve(	1✔
100	cls, id: str, **params: Unpack["TaxCode.RetrieveParams"]
101	) -> "TaxCode":
102	"""
103	Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
104	"""
105	instance = cls(id, **params)	1✔
106	instance.refresh()	1✔
107	return instance	1✔
108
109	@classmethod	1✔
110	async def retrieve_async(	1✔
111	cls, id: str, **params: Unpack["TaxCode.RetrieveParams"]
112	) -> "TaxCode":
113	"""
114	Retrieves the details of an existing tax code. Supply the unique tax code ID and Stripe will return the corresponding tax code information.
115	"""
116	instance = cls(id, **params)	1✔
117	await instance.refresh_async()	1✔
118	return instance	1✔

stripe / stripe-python / 9086309001

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