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
211
212
213
214
215
216
217
218
219
220
221 | class TagsAPI:
"""
Interface for interacting with the `/api/v1/tags` CTFd API endpoint.
"""
def __init__(self, client: APIClient):
self._client = client
@admin_only
def list(
self,
*,
value: str | None = None,
challenge_id: int | None = None,
q: str | None = None,
field: Literal["value", "challenge_id"] | None = None,
) -> list[Tag]:
# Check if q and field are both provided or both not provided
if q is None != field is None:
raise ValueError("q and field must be provided together")
params = {}
if value is not None:
params["value"] = value
if challenge_id is not None:
params["challenge_id"] = challenge_id
if q is not None:
params["q"] = q
params["field"] = field
return self._client.request(
"GET",
"/api/v1/tags",
params=params,
model=tag_list_adapter,
error_models={
400: BadRequest,
401: Unauthorized,
403: Forbidden,
},
)
@admin_only
async def async_list(
self,
*,
value: str | None = None,
challenge_id: int | None = None,
q: str | None = None,
field: Literal["value", "challenge_id"] | None = None,
) -> list[Tag]:
# Check if q and field are both provided or both not provided
if q is None != field is None:
raise ValueError("q and field must be provided together")
params = {}
if value is not None:
params["value"] = value
if challenge_id is not None:
params["challenge_id"] = challenge_id
if q is not None:
params["q"] = q
params["field"] = field
return await self._client.request(
"GET",
"/api/v1/tags",
params=params,
model=tag_list_adapter,
error_models={
400: BadRequest,
401: Unauthorized,
403: Forbidden,
},
)
@admin_only
def create(self, value: str, challenge_id: int) -> Tag:
return self._client.request(
"POST",
"/api/v1/tags",
json={"value": value, "challenge_id": challenge_id},
model=Tag,
error_models={400: BadRequest, 401: Unauthorized, 403: Forbidden},
)
@admin_only
async def async_create(self, value: str, challenge_id: int) -> Tag:
return await self._client.request(
"POST",
"/api/v1/tags",
json={"value": value, "challenge_id": challenge_id},
model=Tag,
error_models={400: BadRequest, 401: Unauthorized, 403: Forbidden},
)
@admin_only
def get(self, tag_id: int) -> Tag:
return self._client.request(
"GET",
f"/api/v1/tags/{tag_id}",
model=Tag,
error_models={
400: BadRequest,
401: Unauthorized,
403: Forbidden,
404: NotFound,
},
)
@admin_only
async def async_get(self, tag_id: int) -> Tag:
return await self._client.request(
"GET",
f"/api/v1/tags/{tag_id}",
model=Tag,
error_models={
400: BadRequest,
401: Unauthorized,
403: Forbidden,
404: NotFound,
},
)
@admin_only
def update(
self,
tag_id: int,
*,
value: str = MISSING,
challenge_id: int = MISSING,
) -> Tag:
payload = {}
if value is not MISSING:
payload["value"] = value
if challenge_id is not MISSING:
# I have no idea what would happen if this is changed
payload["challenge_id"] = challenge_id
return self._client.request(
"PATCH",
f"/api/v1/tags/{tag_id}",
json=payload,
model=Tag,
error_models={
400: BadRequest,
401: Unauthorized,
403: Forbidden,
404: NotFound,
},
)
@admin_only
async def async_update(
self,
tag_id: int,
*,
value: str = MISSING,
challenge_id: int = MISSING,
) -> Tag:
payload = {}
if value is not MISSING:
payload["value"] = value
if challenge_id is not MISSING:
# I have no idea what would happen if this is changed
payload["challenge_id"] = challenge_id
return await self._client.request(
"PATCH",
f"/api/v1/tags/{tag_id}",
json=payload,
model=Tag,
error_models={
400: BadRequest,
401: Unauthorized,
403: Forbidden,
404: NotFound,
},
)
@admin_only
def delete(self, tag_id: int) -> Literal[True]:
return self._client.request(
"DELETE",
f"/api/v1/tags/{tag_id}",
error_models={
400: BadRequest,
401: Unauthorized,
403: Forbidden,
404: NotFound,
},
)
@admin_only
async def async_delete(self, tag_id: int) -> Literal[True]:
return await self._client.request(
"DELETE",
f"/api/v1/tags/{tag_id}",
error_models={
400: BadRequest,
401: Unauthorized,
403: Forbidden,
404: NotFound,
},
)
|