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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
# -*- 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._stripe_object import StripeObject
from typing import ClassVar, Optional, cast
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.apps._secret_create_params import SecretCreateParams
from stripe.params.apps._secret_delete_where_params import (
SecretDeleteWhereParams,
)
from stripe.params.apps._secret_find_params import SecretFindParams
from stripe.params.apps._secret_list_params import SecretListParams
class Secret(CreateableAPIResource["Secret"], ListableAPIResource["Secret"]):
"""
Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)
"""
OBJECT_NAME: ClassVar[Literal["apps.secret"]] = "apps.secret"
class Scope(StripeObject):
type: Literal["account", "user"]
"""
The secret scope type.
"""
user: Optional[str]
"""
The user ID, if type is set to "user"
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
deleted: Optional[bool]
"""
If true, indicates that this secret has been deleted
"""
expires_at: Optional[int]
"""
The Unix timestamp for the expiry time of the secret, after which the secret deletes.
"""
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.
"""
name: str
"""
A name for the secret that's unique within the scope.
"""
object: Literal["apps.secret"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
payload: Optional[str]
"""
The plaintext secret value to be stored.
"""
scope: Scope
@classmethod
def create(cls, **params: Unpack["SecretCreateParams"]) -> "Secret":
"""
Create or replace a secret in the secret store.
"""
return cast(
"Secret",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["SecretCreateParams"]
) -> "Secret":
"""
Create or replace a secret in the secret store.
"""
return cast(
"Secret",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def delete_where(
cls, **params: Unpack["SecretDeleteWhereParams"]
) -> "Secret":
"""
Deletes a secret from the secret store by name and scope.
"""
return cast(
"Secret",
cls._static_request(
"post",
"/v1/apps/secrets/delete",
params=params,
),
)
@classmethod
async def delete_where_async(
cls, **params: Unpack["SecretDeleteWhereParams"]
) -> "Secret":
"""
Deletes a secret from the secret store by name and scope.
"""
return cast(
"Secret",
await cls._static_request_async(
"post",
"/v1/apps/secrets/delete",
params=params,
),
)
@classmethod
def find(cls, **params: Unpack["SecretFindParams"]) -> "Secret":
"""
Finds a secret in the secret store by name and scope.
"""
return cast(
"Secret",
cls._static_request(
"get",
"/v1/apps/secrets/find",
params=params,
),
)
@classmethod
async def find_async(
cls, **params: Unpack["SecretFindParams"]
) -> "Secret":
"""
Finds a secret in the secret store by name and scope.
"""
return cast(
"Secret",
await cls._static_request_async(
"get",
"/v1/apps/secrets/find",
params=params,
),
)
@classmethod
def list(
cls, **params: Unpack["SecretListParams"]
) -> ListObject["Secret"]:
"""
List all secrets stored on the given scope.
"""
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["SecretListParams"]
) -> ListObject["Secret"]:
"""
List all secrets stored on the given scope.
"""
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
_inner_class_types = {"scope": Scope}
|
