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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._expandable_field import ExpandableField
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, Optional, cast
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe._file import File
from stripe.params._file_link_create_params import FileLinkCreateParams
from stripe.params._file_link_list_params import FileLinkListParams
from stripe.params._file_link_modify_params import FileLinkModifyParams
from stripe.params._file_link_retrieve_params import FileLinkRetrieveParams
class FileLink(
CreateableAPIResource["FileLink"],
ListableAPIResource["FileLink"],
UpdateableAPIResource["FileLink"],
):
"""
To share the contents of a `File` object with non-Stripe users, you can
create a `FileLink`. `FileLink`s contain a URL that you can use to
retrieve the contents of the file without authentication.
"""
OBJECT_NAME: ClassVar[Literal["file_link"]] = "file_link"
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
expired: bool
"""
Returns if the link is already expired.
"""
expires_at: Optional[int]
"""
Time that the link expires.
"""
file: ExpandableField["File"]
"""
The file object this link points 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.
"""
metadata: Dict[str, str]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
"""
object: Literal["file_link"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
url: Optional[str]
"""
The publicly accessible URL to download the file.
"""
@classmethod
def create(cls, **params: Unpack["FileLinkCreateParams"]) -> "FileLink":
"""
Creates a new file link object.
"""
return cast(
"FileLink",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["FileLinkCreateParams"]
) -> "FileLink":
"""
Creates a new file link object.
"""
return cast(
"FileLink",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def list(
cls, **params: Unpack["FileLinkListParams"]
) -> ListObject["FileLink"]:
"""
Returns a list of file links.
"""
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["FileLinkListParams"]
) -> ListObject["FileLink"]:
"""
Returns a list of file links.
"""
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["FileLinkModifyParams"]
) -> "FileLink":
"""
Updates an existing file link object. Expired links can no longer be updated.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"FileLink",
cls._static_request(
"post",
url,
params=params,
),
)
@classmethod
async def modify_async(
cls, id: str, **params: Unpack["FileLinkModifyParams"]
) -> "FileLink":
"""
Updates an existing file link object. Expired links can no longer be updated.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"FileLink",
await cls._static_request_async(
"post",
url,
params=params,
),
)
@classmethod
def retrieve(
cls, id: str, **params: Unpack["FileLinkRetrieveParams"]
) -> "FileLink":
"""
Retrieves the file link with the given ID.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["FileLinkRetrieveParams"]
) -> "FileLink":
"""
Retrieves the file link with the given ID.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
|
