8839116456

Committed 25 Apr 2024 08:41PM UTC coverage: 96.415% (+0.001%) from 96.414%

Build # 8839116456

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #1308 from stripe/latest-codegen-beta

Update generated code for beta

Run Details

1135 of 1796 branches covered (63.2%)

Branch coverage included in aggregate %.

144 of 145 new or added lines in 12 files covered. (99.31%)

1 existing line in 1 file now uncovered.

81795 of 84218 relevant lines covered (97.12%)

0.97 hits per line

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

67.74

/stripe/entitlements/_active_entitlement.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 typing import ClassVar, List
from typing_extensions import Literal, NotRequired, Unpack, TYPE_CHECKING

if TYPE_CHECKING:
    from stripe.entitlements._feature import Feature


class ActiveEntitlement(ListableAPIResource["ActiveEntitlement"]):
    """
    An active entitlement describes access to a feature for a customer.
    """

    OBJECT_NAME: ClassVar[
        Literal["entitlements.active_entitlement"]
    ] = "entitlements.active_entitlement"

    class ListParams(RequestOptions):
        customer: str
        """
        The ID of the customer.
        """
        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.
        """

    feature: ExpandableField["Feature"]
    """
    The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.
    """
    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.
    """
    lookup_key: str
    """
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    """
    object: Literal["entitlements.active_entitlement"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """

    @classmethod
    def list(
        cls, **params: Unpack["ActiveEntitlement.ListParams"]
    ) -> ListObject["ActiveEntitlement"]:
        """
        Retrieve a list of active entitlements for a customer
        """
        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["ActiveEntitlement.ListParams"]
    ) -> ListObject["ActiveEntitlement"]:
        """
        Retrieve a list of active entitlements for a customer
        """
        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["ActiveEntitlement.RetrieveParams"]
    ) -> "ActiveEntitlement":
        """
        Retrieve an active entitlement
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["ActiveEntitlement.RetrieveParams"]
    ) -> "ActiveEntitlement":
        """
        Retrieve an active entitlement
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

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 typing import ClassVar, List	1✔
8	from typing_extensions import Literal, NotRequired, Unpack, TYPE_CHECKING	1✔
9
10	if TYPE_CHECKING:	1!
NEW 11	from stripe.entitlements._feature import Feature	×
12
13
14	class ActiveEntitlement(ListableAPIResource["ActiveEntitlement"]):	1✔
15	"""
16	An active entitlement describes access to a feature for a customer.
17	"""
18
19	OBJECT_NAME: ClassVar[	1✔
20	Literal["entitlements.active_entitlement"]
21	] = "entitlements.active_entitlement"
22
23	class ListParams(RequestOptions):	1✔
24	customer: str	1✔
25	"""	1✔
26	The ID of the customer.
27	"""
28	ending_before: NotRequired[str]	1✔
29	"""	1✔
30	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.
31	"""
32	expand: NotRequired[List[str]]	1✔
33	"""	1✔
34	Specifies which fields in the response should be expanded.
35	"""
36	limit: NotRequired[int]	1✔
37	"""	1✔
38	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
39	"""
40	starting_after: NotRequired[str]	1✔
41	"""	1✔
42	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.
43	"""
44
45	class RetrieveParams(RequestOptions):	1✔
46	expand: NotRequired[List[str]]	1✔
47	"""	1✔
48	Specifies which fields in the response should be expanded.
49	"""
50
51	feature: ExpandableField["Feature"]	1✔
52	"""	1✔
53	The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.
54	"""
55	id: str	1✔
56	"""	1✔
57	Unique identifier for the object.
58	"""
59	livemode: bool	1✔
60	"""	1✔
61	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
62	"""
63	lookup_key: str	1✔
64	"""	1✔
65	A unique key you provide as your own system identifier. This may be up to 80 characters.
66	"""
67	object: Literal["entitlements.active_entitlement"]	1✔
68	"""	1✔
69	String representing the object's type. Objects of the same type share the same value.
70	"""
71
72	@classmethod	1✔
73	def list(	1✔
74	cls, **params: Unpack["ActiveEntitlement.ListParams"]
75	) -> ListObject["ActiveEntitlement"]:
76	"""
77	Retrieve a list of active entitlements for a customer
78	"""
79	result = cls._static_request(	×
80	"get",
81	cls.class_url(),
82	params=params,
83	)
84	if not isinstance(result, ListObject):	×
85
86	raise TypeError(	×
87	"Expected list object from API, got %s"
88	% (type(result).__name__)
89	)
90
91	return result	×
92
93	@classmethod	1✔
94	async def list_async(	1✔
95	cls, **params: Unpack["ActiveEntitlement.ListParams"]
96	) -> ListObject["ActiveEntitlement"]:
97	"""
98	Retrieve a list of active entitlements for a customer
99	"""
100	result = await cls._static_request_async(	×
101	"get",
102	cls.class_url(),
103	params=params,
104	)
105	if not isinstance(result, ListObject):	×
106
107	raise TypeError(	×
108	"Expected list object from API, got %s"
109	% (type(result).__name__)
110	)
111
112	return result	×
113
114	@classmethod	1✔
115	def retrieve(	1✔
116	cls, id: str, **params: Unpack["ActiveEntitlement.RetrieveParams"]
117	) -> "ActiveEntitlement":
118	"""
119	Retrieve an active entitlement
120	"""
121	instance = cls(id, **params)	×
122	instance.refresh()	×
123	return instance	×
124
125	@classmethod	1✔
126	async def retrieve_async(	1✔
127	cls, id: str, **params: Unpack["ActiveEntitlement.RetrieveParams"]
128	) -> "ActiveEntitlement":
129	"""
130	Retrieve an active entitlement
131	"""
132	instance = cls(id, **params)	×
133	await instance.refresh_async()	×
134	return instance	×

stripe / stripe-python / 8839116456

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