9034827691

Committed 10 May 2024 03:58PM UTC coverage: 96.377% (+0.002%) from 96.375%

Build # 9034827691

Build Type

Pull #1328

github

Committed by

web-flow

Commit Message

Merge 868522e32 into 287c85d98

Pull Request Pull Request #1328: Update generated code

Run Details

1076 of 1668 branches covered (64.51%)

Branch coverage included in aggregate %.

156 of 157 new or added lines in 18 files covered. (99.36%)

111 existing lines in 9 files now uncovered.

64252 of 66116 relevant lines covered (97.18%)

0.97 hits per line

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

74.47

/stripe/entitlements/_feature.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import sanitize_id
from typing import ClassVar, Dict, List, cast
from typing_extensions import Literal, NotRequired, Unpack


class Feature(
    CreateableAPIResource["Feature"],
    ListableAPIResource["Feature"],
    UpdateableAPIResource["Feature"],
):
    """
    A feature represents a monetizable ability or functionality in your system.
    Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
    """

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

    class CreateParams(RequestOptions):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        lookup_key: str
        """
        A unique key you provide as your own system identifier. This may be up to 80 characters.
        """
        metadata: NotRequired[Dict[str, str]]
        """
        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        """
        name: str
        """
        The feature's name, for your own purpose, not meant to be displayable to the customer.
        """

    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 ModifyParams(RequestOptions):
        active: NotRequired[bool]
        """
        Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
        """
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        metadata: NotRequired["Literal['']|Dict[str, str]"]
        """
        Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        """
        name: NotRequired[str]
        """
        The feature's name, for your own purpose, not meant to be displayable to the customer.
        """

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

    active: bool
    """
    Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
    """
    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.
    """
    metadata: Dict[str, str]
    """
    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
    """
    name: str
    """
    The feature's name, for your own purpose, not meant to be displayable to the customer.
    """
    object: Literal["entitlements.feature"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """

    @classmethod
    def create(cls, **params: Unpack["Feature.CreateParams"]) -> "Feature":
        """
        Creates a feature
        """
        return cast(
            "Feature",
            cls._static_request(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    async def create_async(
        cls, **params: Unpack["Feature.CreateParams"]
    ) -> "Feature":
        """
        Creates a feature
        """
        return cast(
            "Feature",
            await cls._static_request_async(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    def list(
        cls, **params: Unpack["Feature.ListParams"]
    ) -> ListObject["Feature"]:
        """
        Retrieve a list of features
        """
        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["Feature.ListParams"]
    ) -> ListObject["Feature"]:
        """
        Retrieve a list of features
        """
        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 modify(
        cls, id: str, **params: Unpack["Feature.ModifyParams"]
    ) -> "Feature":
        """
        Update a feature's metadata or permanently deactivate it.
        """
        url = "%s/%s" % (cls.class_url(), sanitize_id(id))
        return cast(
            "Feature",
            cls._static_request(
                "post",
                url,
                params=params,
            ),
        )

    @classmethod
    async def modify_async(
        cls, id: str, **params: Unpack["Feature.ModifyParams"]
    ) -> "Feature":
        """
        Update a feature's metadata or permanently deactivate it.
        """
        url = "%s/%s" % (cls.class_url(), sanitize_id(id))
        return cast(
            "Feature",
            await cls._static_request_async(
                "post",
                url,
                params=params,
            ),
        )

    @classmethod
    def retrieve(
        cls, id: str, **params: Unpack["Feature.RetrieveParams"]
    ) -> "Feature":
        """
        Retrieves a feature
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["Feature.RetrieveParams"]
    ) -> "Feature":
        """
        Retrieves a feature
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._createable_api_resource import CreateableAPIResource	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._updateable_api_resource import UpdateableAPIResource	1✔
8	from stripe._util import sanitize_id	1✔
9	from typing import ClassVar, Dict, List, cast	1✔
10	from typing_extensions import Literal, NotRequired, Unpack	1✔
11
12
13	class Feature(	1✔
14	CreateableAPIResource["Feature"],
15	ListableAPIResource["Feature"],
16	UpdateableAPIResource["Feature"],
17	):
18	"""
19	A feature represents a monetizable ability or functionality in your system.
20	Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
21	"""
22
23	OBJECT_NAME: ClassVar[	1✔
24	Literal["entitlements.feature"]
25	] = "entitlements.feature"
26
27	class CreateParams(RequestOptions):	1✔
28	expand: NotRequired[List[str]]	1✔
29	"""	1✔
30	Specifies which fields in the response should be expanded.
31	"""
32	lookup_key: str	1✔
33	"""	1✔
34	A unique key you provide as your own system identifier. This may be up to 80 characters.
35	"""
36	metadata: NotRequired[Dict[str, str]]	1✔
37	"""	1✔
38	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
39	"""
40	name: str	1✔
41	"""	1✔
42	The feature's name, for your own purpose, not meant to be displayable to the customer.
43	"""
44
45	class ListParams(RequestOptions):	1✔
46	ending_before: NotRequired[str]	1✔
47	"""	1✔
48	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.
49	"""
50	expand: NotRequired[List[str]]	1✔
51	"""	1✔
52	Specifies which fields in the response should be expanded.
53	"""
54	limit: NotRequired[int]	1✔
55	"""	1✔
56	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
57	"""
58	starting_after: NotRequired[str]	1✔
59	"""	1✔
60	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.
61	"""
62
63	class ModifyParams(RequestOptions):	1✔
64	active: NotRequired[bool]	1✔
65	"""	1✔
66	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
67	"""
68	expand: NotRequired[List[str]]	1✔
69	"""	1✔
70	Specifies which fields in the response should be expanded.
71	"""
72	metadata: NotRequired["Literal['']\|Dict[str, str]"]	1✔
73	"""	1✔
74	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
75	"""
76	name: NotRequired[str]	1✔
77	"""	1✔
78	The feature's name, for your own purpose, not meant to be displayable to the customer.
79	"""
80
81	class RetrieveParams(RequestOptions):	1✔
82	expand: NotRequired[List[str]]	1✔
83	"""	1✔
84	Specifies which fields in the response should be expanded.
85	"""
86
87	active: bool	1✔
88	"""	1✔
89	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
90	"""
91	id: str	1✔
92	"""	1✔
93	Unique identifier for the object.
94	"""
95	livemode: bool	1✔
96	"""	1✔
97	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
98	"""
99	lookup_key: str	1✔
100	"""	1✔
101	A unique key you provide as your own system identifier. This may be up to 80 characters.
102	"""
103	metadata: Dict[str, str]	1✔
104	"""	1✔
105	Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
106	"""
107	name: str	1✔
108	"""	1✔
109	The feature's name, for your own purpose, not meant to be displayable to the customer.
110	"""
111	object: Literal["entitlements.feature"]	1✔
112	"""	1✔
113	String representing the object's type. Objects of the same type share the same value.
114	"""
115
116	@classmethod	1✔
117	def create(cls, **params: Unpack["Feature.CreateParams"]) -> "Feature":	1✔
118	"""
119	Creates a feature
120	"""
UNCOV 121	return cast(	×
122	"Feature",
123	cls._static_request(
124	"post",
125	cls.class_url(),
126	params=params,
127	),
128	)
129
130	@classmethod	1✔
131	async def create_async(	1✔
132	cls, **params: Unpack["Feature.CreateParams"]
133	) -> "Feature":
134	"""
135	Creates a feature
136	"""
UNCOV 137	return cast(	×
138	"Feature",
139	await cls._static_request_async(
140	"post",
141	cls.class_url(),
142	params=params,
143	),
144	)
145
146	@classmethod	1✔
147	def list(	1✔
148	cls, **params: Unpack["Feature.ListParams"]
149	) -> ListObject["Feature"]:
150	"""
151	Retrieve a list of features
152	"""
UNCOV 153	result = cls._static_request(	×
154	"get",
155	cls.class_url(),
156	params=params,
157	)
UNCOV 158	if not isinstance(result, ListObject):	×
159
UNCOV 160	raise TypeError(	×
161	"Expected list object from API, got %s"
162	% (type(result).__name__)
163	)
164
UNCOV 165	return result	×
166
167	@classmethod	1✔
168	async def list_async(	1✔
169	cls, **params: Unpack["Feature.ListParams"]
170	) -> ListObject["Feature"]:
171	"""
172	Retrieve a list of features
173	"""
UNCOV 174	result = await cls._static_request_async(	×
175	"get",
176	cls.class_url(),
177	params=params,
178	)
UNCOV 179	if not isinstance(result, ListObject):	×
180
UNCOV 181	raise TypeError(	×
182	"Expected list object from API, got %s"
183	% (type(result).__name__)
184	)
185
UNCOV 186	return result	×
187
188	@classmethod	1✔
189	def modify(	1✔
190	cls, id: str, **params: Unpack["Feature.ModifyParams"]
191	) -> "Feature":
192	"""
193	Update a feature's metadata or permanently deactivate it.
194	"""
UNCOV 195	url = "%s/%s" % (cls.class_url(), sanitize_id(id))	×
UNCOV 196	return cast(	×
197	"Feature",
198	cls._static_request(
199	"post",
200	url,
201	params=params,
202	),
203	)
204
205	@classmethod	1✔
206	async def modify_async(	1✔
207	cls, id: str, **params: Unpack["Feature.ModifyParams"]
208	) -> "Feature":
209	"""
210	Update a feature's metadata or permanently deactivate it.
211	"""
UNCOV 212	url = "%s/%s" % (cls.class_url(), sanitize_id(id))	×
UNCOV 213	return cast(	×
214	"Feature",
215	await cls._static_request_async(
216	"post",
217	url,
218	params=params,
219	),
220	)
221
222	@classmethod	1✔
223	def retrieve(	1✔
224	cls, id: str, **params: Unpack["Feature.RetrieveParams"]
225	) -> "Feature":
226	"""
227	Retrieves a feature
228	"""
UNCOV 229	instance = cls(id, **params)	×
UNCOV 230	instance.refresh()	×
UNCOV 231	return instance	×
232
233	@classmethod	1✔
234	async def retrieve_async(	1✔
235	cls, id: str, **params: Unpack["Feature.RetrieveParams"]
236	) -> "Feature":
237	"""
238	Retrieves a feature
239	"""
UNCOV 240	instance = cls(id, **params)	×
UNCOV 241	await instance.refresh_async()	×
UNCOV 242	return instance	×

stripe / stripe-python / 9034827691

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