1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
# -*- 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._updateable_api_resource import UpdateableAPIResource
from stripe._util import sanitize_id
from typing import ClassVar, Dict, cast
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.entitlements._feature_create_params import (
FeatureCreateParams,
)
from stripe.params.entitlements._feature_list_params import (
FeatureListParams,
)
from stripe.params.entitlements._feature_modify_params import (
FeatureModifyParams,
)
from stripe.params.entitlements._feature_retrieve_params import (
FeatureRetrieveParams,
)
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"
)
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["FeatureCreateParams"]) -> "Feature":
"""
Creates a feature
"""
return cast(
"Feature",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["FeatureCreateParams"]
) -> "Feature":
"""
Creates a feature
"""
return cast(
"Feature",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def list(
cls, **params: Unpack["FeatureListParams"]
) -> 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["FeatureListParams"]
) -> 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["FeatureModifyParams"]
) -> "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["FeatureModifyParams"]
) -> "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["FeatureRetrieveParams"]
) -> "Feature":
"""
Retrieves a feature
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["FeatureRetrieveParams"]
) -> "Feature":
"""
Retrieves a feature
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
|
