8545333551

Committed 03 Apr 2024 08:49PM UTC coverage: 96.384% (+0.007%) from 96.377%

Build # 8545333551

Build Type

Pull #1285

github

Committed by

web-flow

Commit Message

Merge 9f6329ba6 into c42ba9419

Pull Request Pull Request #1285: Update generated code for beta

Run Details

1144 of 1812 branches covered (63.13%)

Branch coverage included in aggregate %.

373 of 379 new or added lines in 32 files covered. (98.42%)

22 existing lines in 3 files now uncovered.

81112 of 83530 relevant lines covered (97.11%)

0.97 hits per line

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

77.78

/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, Optional, 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[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.
        """

    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: Optional[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,
            ),
        )

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, Optional, 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[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	active: bool	1✔
82	"""	1✔
83	Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
84	"""
85	id: str	1✔
86	"""	1✔
87	Unique identifier for the object.
88	"""
89	livemode: bool	1✔
90	"""	1✔
91	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
92	"""
93	lookup_key: str	1✔
94	"""	1✔
95	A unique key you provide as your own system identifier. This may be up to 80 characters.
96	"""
97	metadata: Optional[Dict[str, str]]	1✔
98	"""	1✔
99	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.
100	"""
101	name: str	1✔
102	"""	1✔
103	The feature's name, for your own purpose, not meant to be displayable to the customer.
104	"""
105	object: Literal["entitlements.feature"]	1✔
106	"""	1✔
107	String representing the object's type. Objects of the same type share the same value.
108	"""
109
110	@classmethod	1✔
111	def create(cls, **params: Unpack["Feature.CreateParams"]) -> "Feature":	1✔
112	"""
113	Creates a feature
114	"""
115	return cast(	×
116	"Feature",
117	cls._static_request(
118	"post",
119	cls.class_url(),
120	params=params,
121	),
122	)
123
124	@classmethod	1✔
125	async def create_async(	1✔
126	cls, **params: Unpack["Feature.CreateParams"]
127	) -> "Feature":
128	"""
129	Creates a feature
130	"""
131	return cast(	×
132	"Feature",
133	await cls._static_request_async(
134	"post",
135	cls.class_url(),
136	params=params,
137	),
138	)
139
140	@classmethod	1✔
141	def list(	1✔
142	cls, **params: Unpack["Feature.ListParams"]
143	) -> ListObject["Feature"]:
144	"""
145	Retrieve a list of features
146	"""
147	result = cls._static_request(	×
148	"get",
149	cls.class_url(),
150	params=params,
151	)
152	if not isinstance(result, ListObject):	×
153
154	raise TypeError(	×
155	"Expected list object from API, got %s"
156	% (type(result).__name__)
157	)
158
159	return result	×
160
161	@classmethod	1✔
162	async def list_async(	1✔
163	cls, **params: Unpack["Feature.ListParams"]
164	) -> ListObject["Feature"]:
165	"""
166	Retrieve a list of features
167	"""
168	result = await cls._static_request_async(	×
169	"get",
170	cls.class_url(),
171	params=params,
172	)
173	if not isinstance(result, ListObject):	×
174
175	raise TypeError(	×
176	"Expected list object from API, got %s"
177	% (type(result).__name__)
178	)
179
180	return result	×
181
182	@classmethod	1✔
183	def modify(	1✔
184	cls, id: str, **params: Unpack["Feature.ModifyParams"]
185	) -> "Feature":
186	"""
187	Update a feature's metadata or permanently deactivate it.
188	"""
NEW 189	url = "%s/%s" % (cls.class_url(), sanitize_id(id))	×
NEW 190	return cast(	×
191	"Feature",
192	cls._static_request(
193	"post",
194	url,
195	params=params,
196	),
197	)
198
199	@classmethod	1✔
200	async def modify_async(	1✔
201	cls, id: str, **params: Unpack["Feature.ModifyParams"]
202	) -> "Feature":
203	"""
204	Update a feature's metadata or permanently deactivate it.
205	"""
NEW 206	url = "%s/%s" % (cls.class_url(), sanitize_id(id))	×
NEW 207	return cast(	×
208	"Feature",
209	await cls._static_request_async(
210	"post",
211	url,
212	params=params,
213	),
214	)

stripe / stripe-python / 8545333551

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