lemmy-js-client 0.20.0-search-combined.1 → 0.20.0-show-mod-reports.0
Sign up to get free protection for your applications and to get access to all the features.
- package/README.md +1 -1
- package/dist/http.d.ts +175 -440
- package/dist/http.js +1086 -391
- package/dist/index.d.ts +3 -1
- package/dist/other_types.d.ts +81 -0
- package/dist/types/CommentSlimView.d.ts +20 -0
- package/dist/types/CommentSlimView.js +2 -0
- package/dist/types/Community.d.ts +2 -2
- package/dist/types/GetCommentsSlimResponse.d.ts +7 -0
- package/dist/types/GetCommentsSlimResponse.js +2 -0
- package/dist/types/ListReports.d.ts +14 -0
- package/dist/types/Person.d.ts +2 -2
- package/dist/types/PersonContentType.d.ts +1 -1
- package/dist/types/ReportType.d.ts +4 -0
- package/dist/types/Site.d.ts +2 -2
- package/dist/types/SuccessResponse.d.ts +1 -1
- package/package.json +8 -4
- package/dist/types/SearchCombinedId.d.ts +0 -4
- /package/dist/types/{SearchCombinedId.js → ReportType.js} +0 -0
package/dist/http.d.ts
CHANGED
@@ -49,30 +49,19 @@ import { OAuthProvider } from "./types/OAuthProvider";
|
|
49
49
|
import { FeaturePost } from "./types/FeaturePost";
|
50
50
|
import { FollowCommunity } from "./types/FollowCommunity";
|
51
51
|
import { GetCaptchaResponse } from "./types/GetCaptchaResponse";
|
52
|
-
import { GetComment } from "./types/GetComment";
|
53
|
-
import { GetComments } from "./types/GetComments";
|
54
52
|
import { GetCommentsResponse } from "./types/GetCommentsResponse";
|
55
|
-
import { GetCommunity } from "./types/GetCommunity";
|
56
53
|
import { GetCommunityResponse } from "./types/GetCommunityResponse";
|
57
54
|
import { GetFederatedInstancesResponse } from "./types/GetFederatedInstancesResponse";
|
58
|
-
import { GetModlog } from "./types/GetModlog";
|
59
55
|
import { GetModlogResponse } from "./types/GetModlogResponse";
|
60
|
-
import { GetPersonDetails } from "./types/GetPersonDetails";
|
61
56
|
import { GetPersonDetailsResponse } from "./types/GetPersonDetailsResponse";
|
62
|
-
import { GetPost } from "./types/GetPost";
|
63
57
|
import { GetPostResponse } from "./types/GetPostResponse";
|
64
|
-
import { GetPosts } from "./types/GetPosts";
|
65
58
|
import { GetPostsResponse } from "./types/GetPostsResponse";
|
66
|
-
import { GetReportCount } from "./types/GetReportCount";
|
67
59
|
import { GetReportCountResponse } from "./types/GetReportCountResponse";
|
68
|
-
import { GetSiteMetadata } from "./types/GetSiteMetadata";
|
69
60
|
import { GetSiteMetadataResponse } from "./types/GetSiteMetadataResponse";
|
70
61
|
import { GetSiteResponse } from "./types/GetSiteResponse";
|
71
62
|
import { GetUnreadCountResponse } from "./types/GetUnreadCountResponse";
|
72
63
|
import { GetUnreadRegistrationApplicationCountResponse } from "./types/GetUnreadRegistrationApplicationCountResponse";
|
73
|
-
import { ListCommunities } from "./types/ListCommunities";
|
74
64
|
import { ListCommunitiesResponse } from "./types/ListCommunitiesResponse";
|
75
|
-
import { ListRegistrationApplications } from "./types/ListRegistrationApplications";
|
76
65
|
import { ListRegistrationApplicationsResponse } from "./types/ListRegistrationApplicationsResponse";
|
77
66
|
import { LockPost } from "./types/LockPost";
|
78
67
|
import { Login } from "./types/Login";
|
@@ -96,69 +85,55 @@ import { RemoveComment } from "./types/RemoveComment";
|
|
96
85
|
import { RemoveCommunity } from "./types/RemoveCommunity";
|
97
86
|
import { RemovePost } from "./types/RemovePost";
|
98
87
|
import { ResolveCommentReport } from "./types/ResolveCommentReport";
|
99
|
-
import { ResolveObject } from "./types/ResolveObject";
|
100
88
|
import { ResolveObjectResponse } from "./types/ResolveObjectResponse";
|
101
89
|
import { ResolvePostReport } from "./types/ResolvePostReport";
|
102
90
|
import { ResolvePrivateMessageReport } from "./types/ResolvePrivateMessageReport";
|
103
91
|
import { SaveComment } from "./types/SaveComment";
|
104
92
|
import { SavePost } from "./types/SavePost";
|
105
93
|
import { SaveUserSettings } from "./types/SaveUserSettings";
|
106
|
-
import { Search } from "./types/Search";
|
107
94
|
import { SearchResponse } from "./types/SearchResponse";
|
108
95
|
import { SiteResponse } from "./types/SiteResponse";
|
109
96
|
import { TransferCommunity } from "./types/TransferCommunity";
|
110
97
|
import { VerifyEmail } from "./types/VerifyEmail";
|
111
|
-
import { UploadImage } from "./other_types";
|
98
|
+
import { DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListInboxI, ListMediaI, ListPersonContentI, ListPersonSavedI, ListPostLikesI, ListRegistrationApplicationsI, ListReportsI, ListTaglinesI, ResolveObjectI, SearchI, UploadImage } from "./other_types";
|
112
99
|
import { HideCommunity } from "./types/HideCommunity";
|
113
100
|
import { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
|
114
101
|
import { UpdateTotp } from "./types/UpdateTotp";
|
115
102
|
import { UpdateTotpResponse } from "./types/UpdateTotpResponse";
|
116
103
|
import { SuccessResponse } from "./types/SuccessResponse";
|
117
104
|
import { LoginToken } from "./types/LoginToken";
|
118
|
-
import { ListPostLikes } from "./types/ListPostLikes";
|
119
105
|
import { ListPostLikesResponse } from "./types/ListPostLikesResponse";
|
120
|
-
import { ListCommentLikes } from "./types/ListCommentLikes";
|
121
106
|
import { ListCommentLikesResponse } from "./types/ListCommentLikesResponse";
|
122
107
|
import { HidePost } from "./types/HidePost";
|
123
|
-
import { ListMedia } from "./types/ListMedia";
|
124
108
|
import { ListMediaResponse } from "./types/ListMediaResponse";
|
125
109
|
import { AuthenticateWithOauth } from "./types/AuthenticateWithOauth";
|
126
|
-
import { GetRegistrationApplication } from "./types/GetRegistrationApplication";
|
127
110
|
import { CreateTagline } from "./types/CreateTagline";
|
128
111
|
import { TaglineResponse } from "./types/TaglineResponse";
|
129
112
|
import { UpdateTagline } from "./types/UpdateTagline";
|
130
113
|
import { DeleteTagline } from "./types/DeleteTagline";
|
131
|
-
import { ListTaglines } from "./types/ListTaglines";
|
132
114
|
import { ListTaglinesResponse } from "./types/ListTaglinesResponse";
|
133
|
-
import { ListCustomEmojis } from "./types/ListCustomEmojis";
|
134
115
|
import { ListCustomEmojisResponse } from "./types/ListCustomEmojisResponse";
|
135
|
-
import { GetRandomCommunity } from "./types/GetRandomCommunity";
|
136
116
|
import { ApproveCommunityPendingFollower } from "./types/ApproveCommunityPendingFollower";
|
137
117
|
import { GetCommunityPendingFollowsCountResponse } from "./types/GetCommunityPendingFollowsCountResponse";
|
138
118
|
import { ListCommunityPendingFollowsResponse } from "./types/ListCommunityPendingFollowsResponse";
|
139
|
-
import { ListCommunityPendingFollows } from "./types/ListCommunityPendingFollows";
|
140
|
-
import { CommunityId } from "./types/CommunityId";
|
141
|
-
import { ListReports } from "./types/ListReports";
|
142
119
|
import { ListReportsResponse } from "./types/ListReportsResponse";
|
143
120
|
import { MyUserInfo } from "./types/MyUserInfo";
|
144
121
|
import { UserBlockInstanceParams } from "./types/UserBlockInstanceParams";
|
145
122
|
import { AdminAllowInstanceParams } from "./types/AdminAllowInstanceParams";
|
146
123
|
import { AdminBlockInstanceParams } from "./types/AdminBlockInstanceParams";
|
147
|
-
import { ListPersonContent } from "./types/ListPersonContent";
|
148
124
|
import { ListPersonContentResponse } from "./types/ListPersonContentResponse";
|
149
|
-
import { ListPersonSaved } from "./types/ListPersonSaved";
|
150
125
|
import { ListPersonSavedResponse } from "./types/ListPersonSavedResponse";
|
151
|
-
import { DeleteImageParams } from "./types/DeleteImageParams";
|
152
126
|
import { UploadImageResponse } from "./types/UploadImageResponse";
|
153
127
|
import { ListInboxResponse } from "./types/ListInboxResponse";
|
154
|
-
import { ListInbox } from "./types/ListInbox";
|
155
128
|
import { MarkPersonCommentMentionAsRead } from "./types/MarkPersonCommentMentionAsRead";
|
156
129
|
import { MarkPersonPostMentionAsRead } from "./types/MarkPersonPostMentionAsRead";
|
130
|
+
import { GetCommentsSlimResponse } from "./types/GetCommentsSlimResponse";
|
131
|
+
import { Controller } from "tsoa";
|
157
132
|
type RequestOptions = Pick<RequestInit, "signal">;
|
158
133
|
/**
|
159
134
|
* Helps build lemmy HTTP requests.
|
160
135
|
*/
|
161
|
-
export declare class LemmyHttp {
|
136
|
+
export declare class LemmyHttp extends Controller {
|
162
137
|
#private;
|
163
138
|
/**
|
164
139
|
* Generates a new instance of LemmyHttp.
|
@@ -172,781 +147,541 @@ export declare class LemmyHttp {
|
|
172
147
|
};
|
173
148
|
});
|
174
149
|
/**
|
175
|
-
* Gets the site, and your user data.
|
176
|
-
*
|
177
|
-
* `HTTP.GET /site`
|
150
|
+
* @summary Gets the site, and your user data.
|
178
151
|
*/
|
179
152
|
getSite(options?: RequestOptions): Promise<GetSiteResponse>;
|
180
153
|
/**
|
181
|
-
* Create your site.
|
182
|
-
*
|
183
|
-
* `HTTP.POST /site`
|
154
|
+
* @summary Create your site.
|
184
155
|
*/
|
185
156
|
createSite(form: CreateSite, options?: RequestOptions): Promise<SiteResponse>;
|
186
157
|
/**
|
187
|
-
* Edit your site.
|
188
|
-
*
|
189
|
-
* `HTTP.PUT /site`
|
158
|
+
* @summary Edit your site.
|
190
159
|
*/
|
191
160
|
editSite(form: EditSite, options?: RequestOptions): Promise<SiteResponse>;
|
192
161
|
/**
|
193
|
-
* Leave the Site admins.
|
194
|
-
*
|
195
|
-
* `HTTP.POST /admin/leave`
|
162
|
+
* @summary Leave the Site admins.
|
196
163
|
*/
|
197
164
|
leaveAdmin(options?: RequestOptions): Promise<GetSiteResponse>;
|
198
165
|
/**
|
199
|
-
* Generate a TOTP / two-factor secret.
|
166
|
+
* @summary Generate a TOTP / two-factor secret.
|
200
167
|
*
|
168
|
+
* Generate a TOTP / two-factor secret.
|
201
169
|
* Afterwards you need to call `/account/auth/totp/update` with a valid token to enable it.
|
202
|
-
*
|
203
|
-
* `HTTP.POST /account/auth/totp/generate`
|
204
170
|
*/
|
205
171
|
generateTotpSecret(options?: RequestOptions): Promise<GenerateTotpSecretResponse>;
|
206
172
|
/**
|
207
|
-
* Get data of current user.
|
208
|
-
*
|
209
|
-
* `HTTP.GET /account`
|
173
|
+
* @summary Get data of current user.
|
210
174
|
*/
|
211
175
|
getMyUser(options?: RequestOptions): Promise<MyUserInfo>;
|
212
176
|
/**
|
177
|
+
* @summary Export a backup of your user settings.
|
178
|
+
*
|
213
179
|
* Export a backup of your user settings, including your saved content,
|
214
180
|
* followed communities, and blocks.
|
215
|
-
*
|
216
|
-
* `HTTP.GET /account/settings/export`
|
217
181
|
*/
|
218
182
|
exportSettings(options?: RequestOptions): Promise<string>;
|
219
183
|
/**
|
220
|
-
* Import a backup of your user settings.
|
221
|
-
*
|
222
|
-
* `HTTP.POST /account/settings/import`
|
184
|
+
* @summary Import a backup of your user settings.
|
223
185
|
*/
|
224
186
|
importSettings(form: any, options?: RequestOptions): Promise<SuccessResponse>;
|
225
187
|
/**
|
226
|
-
* List login tokens for your user
|
227
|
-
*
|
228
|
-
* `HTTP.GET /account/list_logins`
|
188
|
+
* @summary List login tokens for your user
|
229
189
|
*/
|
230
190
|
listLogins(options?: RequestOptions): Promise<LoginToken[]>;
|
231
191
|
/**
|
232
|
-
* Returns an error message if your auth token is invalid
|
233
|
-
*
|
234
|
-
* `HTTP.GET /account/validate_auth`
|
192
|
+
* @summary Returns an error message if your auth token is invalid
|
235
193
|
*/
|
236
194
|
validateAuth(options?: RequestOptions): Promise<SuccessResponse>;
|
237
195
|
/**
|
238
|
-
* List all the media for your user
|
239
|
-
*
|
240
|
-
* `HTTP.GET /account/list_media`
|
196
|
+
* @summary List all the media for your user
|
241
197
|
*/
|
242
|
-
listMedia(form?:
|
198
|
+
listMedia(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
|
243
199
|
/**
|
244
|
-
* List all the media known to your instance.
|
245
|
-
*
|
246
|
-
* `HTTP.GET /admin/list_all_media`
|
200
|
+
* @summary List all the media known to your instance.
|
247
201
|
*/
|
248
|
-
listAllMedia(form?:
|
202
|
+
listAllMedia(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
|
249
203
|
/**
|
250
|
-
* Enable / Disable TOTP / two-factor authentication.
|
204
|
+
* @summary Enable / Disable TOTP / two-factor authentication.
|
251
205
|
*
|
252
206
|
* To enable, you need to first call `/account/auth/totp/generate` and then pass a valid token to this.
|
253
207
|
*
|
254
208
|
* Disabling is only possible if 2FA was previously enabled. Again it is necessary to pass a valid token.
|
255
|
-
*
|
256
|
-
* `HTTP.POST /account/auth/totp/update`
|
257
209
|
*/
|
258
210
|
updateTotp(form: UpdateTotp, options?: RequestOptions): Promise<UpdateTotpResponse>;
|
259
211
|
/**
|
260
|
-
* Get the modlog.
|
261
|
-
*
|
262
|
-
* `HTTP.GET /modlog`
|
212
|
+
* @summary Get the modlog.
|
263
213
|
*/
|
264
|
-
getModlog(form?:
|
214
|
+
getModlog(form?: GetModlogI, options?: RequestOptions): Promise<GetModlogResponse>;
|
265
215
|
/**
|
266
|
-
* Search lemmy.
|
267
|
-
*
|
268
|
-
* `HTTP.GET /search`
|
216
|
+
* @summary Search lemmy.
|
269
217
|
*/
|
270
|
-
search(form:
|
218
|
+
search(form: SearchI, options?: RequestOptions): Promise<SearchResponse>;
|
271
219
|
/**
|
272
|
-
* Fetch a non-local / federated object.
|
273
|
-
*
|
274
|
-
* `HTTP.GET /resolve_object`
|
220
|
+
* @summary Fetch a non-local / federated object.
|
275
221
|
*/
|
276
|
-
resolveObject(form:
|
222
|
+
resolveObject(form: ResolveObjectI, options?: RequestOptions): Promise<ResolveObjectResponse>;
|
277
223
|
/**
|
278
|
-
* Create a new community.
|
279
|
-
*
|
280
|
-
* `HTTP.POST /community`
|
224
|
+
* @summary Create a new community.
|
281
225
|
*/
|
282
226
|
createCommunity(form: CreateCommunity, options?: RequestOptions): Promise<CommunityResponse>;
|
283
227
|
/**
|
284
|
-
* Get / fetch a community.
|
285
|
-
*
|
286
|
-
* `HTTP.GET /community`
|
228
|
+
* @summary Get / fetch a community.
|
287
229
|
*/
|
288
|
-
getCommunity(form?:
|
230
|
+
getCommunity(form?: GetCommunityI, options?: RequestOptions): Promise<GetCommunityResponse>;
|
289
231
|
/**
|
290
|
-
* Edit a community.
|
291
|
-
*
|
292
|
-
* `HTTP.PUT /community`
|
232
|
+
* @summary Edit a community.
|
293
233
|
*/
|
294
234
|
editCommunity(form: EditCommunity, options?: RequestOptions): Promise<CommunityResponse>;
|
295
235
|
/**
|
296
|
-
* List communities, with various filters.
|
297
|
-
*
|
298
|
-
* `HTTP.GET /community/list`
|
236
|
+
* @summary List communities, with various filters.
|
299
237
|
*/
|
300
|
-
listCommunities(form?:
|
238
|
+
listCommunities(form?: ListCommunitiesI, options?: RequestOptions): Promise<ListCommunitiesResponse>;
|
301
239
|
/**
|
302
|
-
* Follow / subscribe to a community.
|
303
|
-
*
|
304
|
-
* `HTTP.POST /community/follow`
|
240
|
+
* @summary Follow / subscribe to a community.
|
305
241
|
*/
|
306
242
|
followCommunity(form: FollowCommunity, options?: RequestOptions): Promise<CommunityResponse>;
|
307
|
-
|
308
|
-
|
243
|
+
/**
|
244
|
+
* @summary Get a community's pending follows count.
|
245
|
+
*/
|
246
|
+
getCommunityPendingFollowsCount(form: GetCommunityPendingFollowsCountI, options?: RequestOptions): Promise<GetCommunityPendingFollowsCountResponse>;
|
247
|
+
/**
|
248
|
+
* @summary Get a community's pending followers.
|
249
|
+
*/
|
250
|
+
listCommunityPendingFollows(form: ListCommunityPendingFollowsI, options?: RequestOptions): Promise<ListCommunityPendingFollowsResponse>;
|
251
|
+
/**
|
252
|
+
* @summary Approve a community pending follow request.
|
253
|
+
*/
|
309
254
|
approveCommunityPendingFollow(form: ApproveCommunityPendingFollower, options?: RequestOptions): Promise<SuccessResponse>;
|
310
255
|
/**
|
311
|
-
* Block a community.
|
312
|
-
*
|
313
|
-
* `HTTP.POST /account/block/community`
|
256
|
+
* @summary Block a community.
|
314
257
|
*/
|
315
258
|
blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<BlockCommunityResponse>;
|
316
259
|
/**
|
317
|
-
* Delete a community.
|
318
|
-
*
|
319
|
-
* `HTTP.POST /community/delete`
|
260
|
+
* @summary Delete a community.
|
320
261
|
*/
|
321
262
|
deleteCommunity(form: DeleteCommunity, options?: RequestOptions): Promise<CommunityResponse>;
|
322
263
|
/**
|
323
|
-
* Hide a community from public / "All" view. Admins only.
|
324
|
-
*
|
325
|
-
* `HTTP.PUT /community/hide`
|
264
|
+
* @summary Hide a community from public / "All" view. Admins only.
|
326
265
|
*/
|
327
266
|
hideCommunity(form: HideCommunity, options?: RequestOptions): Promise<SuccessResponse>;
|
328
267
|
/**
|
329
|
-
* A moderator remove for a community.
|
330
|
-
*
|
331
|
-
* `HTTP.POST /community/remove`
|
268
|
+
* @summary A moderator remove for a community.
|
332
269
|
*/
|
333
270
|
removeCommunity(form: RemoveCommunity, options?: RequestOptions): Promise<CommunityResponse>;
|
334
271
|
/**
|
335
|
-
* Transfer your community to an existing moderator.
|
336
|
-
*
|
337
|
-
* `HTTP.POST /community/transfer`
|
272
|
+
* @summary Transfer your community to an existing moderator.
|
338
273
|
*/
|
339
274
|
transferCommunity(form: TransferCommunity, options?: RequestOptions): Promise<GetCommunityResponse>;
|
340
275
|
/**
|
341
|
-
* Ban a user from a community.
|
342
|
-
*
|
343
|
-
* `HTTP.POST /community/ban_user`
|
276
|
+
* @summary Ban a user from a community.
|
344
277
|
*/
|
345
278
|
banFromCommunity(form: BanFromCommunity, options?: RequestOptions): Promise<BanFromCommunityResponse>;
|
346
279
|
/**
|
347
|
-
* Add a moderator to your community.
|
348
|
-
*
|
349
|
-
* `HTTP.POST /community/mod`
|
280
|
+
* @summary Add a moderator to your community.
|
350
281
|
*/
|
351
282
|
addModToCommunity(form: AddModToCommunity, options?: RequestOptions): Promise<AddModToCommunityResponse>;
|
352
283
|
/**
|
353
|
-
* Get a random community.
|
354
|
-
*
|
355
|
-
* `HTTP.GET /community/random`
|
284
|
+
* @summary Get a random community.
|
356
285
|
*/
|
357
|
-
getRandomCommunity(form:
|
286
|
+
getRandomCommunity(form: GetRandomCommunityI, options?: RequestOptions): Promise<CommunityResponse>;
|
358
287
|
/**
|
359
|
-
* Create a post.
|
360
|
-
*
|
361
|
-
* `HTTP.POST /post`
|
288
|
+
* @summary Create a post.
|
362
289
|
*/
|
363
290
|
createPost(form: CreatePost, options?: RequestOptions): Promise<PostResponse>;
|
364
291
|
/**
|
365
|
-
* Get / fetch a post.
|
366
|
-
*
|
367
|
-
* `HTTP.GET /post`
|
292
|
+
* @summary Get / fetch a post.
|
368
293
|
*/
|
369
|
-
getPost(form?:
|
294
|
+
getPost(form?: GetPostI, options?: RequestOptions): Promise<GetPostResponse>;
|
370
295
|
/**
|
371
|
-
* Edit a post.
|
372
|
-
*
|
373
|
-
* `HTTP.PUT /post`
|
296
|
+
* @summary Edit a post.
|
374
297
|
*/
|
375
298
|
editPost(form: EditPost, options?: RequestOptions): Promise<PostResponse>;
|
376
299
|
/**
|
377
|
-
* Delete a post.
|
378
|
-
*
|
379
|
-
* `HTTP.POST /post/delete`
|
300
|
+
* @summary Delete a post.
|
380
301
|
*/
|
381
302
|
deletePost(form: DeletePost, options?: RequestOptions): Promise<PostResponse>;
|
382
303
|
/**
|
383
|
-
* A moderator remove for a post.
|
384
|
-
*
|
385
|
-
* `HTTP.POST /post/remove`
|
304
|
+
* @summary A moderator remove for a post.
|
386
305
|
*/
|
387
306
|
removePost(form: RemovePost, options?: RequestOptions): Promise<PostResponse>;
|
388
307
|
/**
|
389
|
-
* Mark a post as read.
|
390
|
-
*
|
391
|
-
* `HTTP.POST /post/mark_as_read`
|
308
|
+
* @summary Mark a post as read.
|
392
309
|
*/
|
393
310
|
markPostAsRead(form: MarkPostAsRead, options?: RequestOptions): Promise<SuccessResponse>;
|
394
311
|
/**
|
395
|
-
* Mark multiple posts as read.
|
396
|
-
*
|
397
|
-
* `HTTP.POST /post/mark_as_read/many`
|
312
|
+
* @summary Mark multiple posts as read.
|
398
313
|
*/
|
399
314
|
markManyPostAsRead(form: MarkManyPostsAsRead, options?: RequestOptions): Promise<SuccessResponse>;
|
400
315
|
/**
|
401
|
-
* Hide a post from list views.
|
402
|
-
*
|
403
|
-
* `HTTP.POST /post/hide`
|
316
|
+
* @summary Hide a post from list views.
|
404
317
|
*/
|
405
318
|
hidePost(form: HidePost, options?: RequestOptions): Promise<SuccessResponse>;
|
406
319
|
/**
|
407
|
-
* A moderator can lock a post ( IE disable new comments ).
|
408
|
-
*
|
409
|
-
* `HTTP.POST /post/lock`
|
320
|
+
* @summary A moderator can lock a post ( IE disable new comments ).
|
410
321
|
*/
|
411
322
|
lockPost(form: LockPost, options?: RequestOptions): Promise<PostResponse>;
|
412
323
|
/**
|
413
|
-
* A moderator can feature a community post ( IE stick it to the top of a community ).
|
414
|
-
*
|
415
|
-
* `HTTP.POST /post/feature`
|
324
|
+
* @summary A moderator can feature a community post ( IE stick it to the top of a community ).
|
416
325
|
*/
|
417
326
|
featurePost(form: FeaturePost, options?: RequestOptions): Promise<PostResponse>;
|
418
327
|
/**
|
419
|
-
* Get / fetch posts, with various filters.
|
420
|
-
*
|
421
|
-
* `HTTP.GET /post/list`
|
328
|
+
* @summary Get / fetch posts, with various filters.
|
422
329
|
*/
|
423
|
-
getPosts(form?:
|
330
|
+
getPosts(form?: GetPostsI, options?: RequestOptions): Promise<GetPostsResponse>;
|
424
331
|
/**
|
425
|
-
* Like / vote on a post.
|
426
|
-
*
|
427
|
-
* `HTTP.POST /post/like`
|
332
|
+
* @summary Like / vote on a post.
|
428
333
|
*/
|
429
334
|
likePost(form: CreatePostLike, options?: RequestOptions): Promise<PostResponse>;
|
430
335
|
/**
|
431
|
-
* List a post's likes. Admin-only.
|
432
|
-
*
|
433
|
-
* `HTTP.GET /post/like/list`
|
336
|
+
* @summary List a post's likes. Admin-only.
|
434
337
|
*/
|
435
|
-
listPostLikes(form:
|
338
|
+
listPostLikes(form: ListPostLikesI, options?: RequestOptions): Promise<ListPostLikesResponse>;
|
436
339
|
/**
|
437
|
-
* Save a post.
|
438
|
-
*
|
439
|
-
* `HTTP.PUT /post/save`
|
340
|
+
* @summary Save a post.
|
440
341
|
*/
|
441
342
|
savePost(form: SavePost, options?: RequestOptions): Promise<PostResponse>;
|
442
343
|
/**
|
443
|
-
* Report a post.
|
444
|
-
*
|
445
|
-
* `HTTP.POST /post/report`
|
344
|
+
* @summary Report a post.
|
446
345
|
*/
|
447
346
|
createPostReport(form: CreatePostReport, options?: RequestOptions): Promise<PostReportResponse>;
|
448
347
|
/**
|
449
|
-
* Resolve a post report. Only a mod can do this.
|
450
|
-
*
|
451
|
-
* `HTTP.PUT /post/report/resolve`
|
348
|
+
* @summary Resolve a post report. Only a mod can do this.
|
452
349
|
*/
|
453
350
|
resolvePostReport(form: ResolvePostReport, options?: RequestOptions): Promise<PostReportResponse>;
|
454
351
|
/**
|
455
|
-
* Fetch metadata for any given site.
|
456
|
-
*
|
457
|
-
* `HTTP.GET /post/site_metadata`
|
352
|
+
* @summary Fetch metadata for any given site.
|
458
353
|
*/
|
459
|
-
getSiteMetadata(form:
|
354
|
+
getSiteMetadata(form: GetSiteMetadataI, options?: RequestOptions): Promise<GetSiteMetadataResponse>;
|
460
355
|
/**
|
461
|
-
* Create a comment.
|
462
|
-
*
|
463
|
-
* `HTTP.POST /comment`
|
356
|
+
* @summary Create a comment.
|
464
357
|
*/
|
465
358
|
createComment(form: CreateComment, options?: RequestOptions): Promise<CommentResponse>;
|
466
359
|
/**
|
467
|
-
* Edit a comment.
|
468
|
-
*
|
469
|
-
* `HTTP.PUT /comment`
|
360
|
+
* @summary Edit a comment.
|
470
361
|
*/
|
471
362
|
editComment(form: EditComment, options?: RequestOptions): Promise<CommentResponse>;
|
472
363
|
/**
|
473
|
-
* Delete a comment.
|
474
|
-
*
|
475
|
-
* `HTTP.POST /comment/delete`
|
364
|
+
* @summary Delete a comment.
|
476
365
|
*/
|
477
366
|
deleteComment(form: DeleteComment, options?: RequestOptions): Promise<CommentResponse>;
|
478
367
|
/**
|
479
|
-
* A moderator remove for a comment.
|
480
|
-
*
|
481
|
-
* `HTTP.POST /comment/remove`
|
368
|
+
* @summary A moderator remove for a comment.
|
482
369
|
*/
|
483
370
|
removeComment(form: RemoveComment, options?: RequestOptions): Promise<CommentResponse>;
|
484
371
|
/**
|
485
|
-
* Mark a comment as read.
|
486
|
-
*
|
487
|
-
* `HTTP.POST /comment/mark_as_read`
|
372
|
+
* @summary Mark a comment as read.
|
488
373
|
*/
|
489
374
|
markCommentReplyAsRead(form: MarkCommentReplyAsRead, options?: RequestOptions): Promise<SuccessResponse>;
|
490
375
|
/**
|
491
|
-
* Like / vote on a comment.
|
492
|
-
*
|
493
|
-
* `HTTP.POST /comment/like`
|
376
|
+
* @summary Like / vote on a comment.
|
494
377
|
*/
|
495
378
|
likeComment(form: CreateCommentLike, options?: RequestOptions): Promise<CommentResponse>;
|
496
379
|
/**
|
497
|
-
* List a comment's likes. Admin-only.
|
498
|
-
*
|
499
|
-
* `HTTP.GET /comment/like/list`
|
380
|
+
* @summary List a comment's likes. Admin-only.
|
500
381
|
*/
|
501
|
-
listCommentLikes(form:
|
382
|
+
listCommentLikes(form: ListCommentLikesI, options?: RequestOptions): Promise<ListCommentLikesResponse>;
|
502
383
|
/**
|
503
|
-
* Save a comment.
|
504
|
-
*
|
505
|
-
* `HTTP.PUT /comment/save`
|
384
|
+
* @summary Save a comment.
|
506
385
|
*/
|
507
386
|
saveComment(form: SaveComment, options?: RequestOptions): Promise<CommentResponse>;
|
508
387
|
/**
|
509
|
-
* Distinguishes a comment (speak as moderator)
|
510
|
-
*
|
511
|
-
* `HTTP.POST /comment/distinguish`
|
388
|
+
* @summary Distinguishes a comment (speak as moderator)
|
512
389
|
*/
|
513
390
|
distinguishComment(form: DistinguishComment, options?: RequestOptions): Promise<CommentResponse>;
|
514
391
|
/**
|
515
|
-
* Get / fetch comments.
|
516
|
-
*
|
517
|
-
* `HTTP.GET /comment/list`
|
392
|
+
* @summary Get / fetch comments.
|
518
393
|
*/
|
519
|
-
getComments(form?:
|
394
|
+
getComments(form?: GetCommentsI, options?: RequestOptions): Promise<GetCommentsResponse>;
|
520
395
|
/**
|
521
|
-
* Get / fetch
|
522
|
-
*
|
523
|
-
* `HTTP.GET /comment`
|
396
|
+
* @summary Get / fetch comments, but without the post or community.
|
524
397
|
*/
|
525
|
-
|
398
|
+
getCommentsSlim(form?: GetCommentsI, options?: RequestOptions): Promise<GetCommentsSlimResponse>;
|
526
399
|
/**
|
527
|
-
*
|
528
|
-
|
529
|
-
|
400
|
+
* @summary Get / fetch comment.
|
401
|
+
*/
|
402
|
+
getComment(form: GetCommentI, options?: RequestOptions): Promise<CommentResponse>;
|
403
|
+
/**
|
404
|
+
* @summary Report a comment.
|
530
405
|
*/
|
531
406
|
createCommentReport(form: CreateCommentReport, options?: RequestOptions): Promise<CommentReportResponse>;
|
532
407
|
/**
|
533
|
-
* Resolve a comment report. Only a mod can do this.
|
534
|
-
*
|
535
|
-
* `HTTP.PUT /comment/report/resolve`
|
408
|
+
* @summary Resolve a comment report. Only a mod can do this.
|
536
409
|
*/
|
537
410
|
resolveCommentReport(form: ResolveCommentReport, options?: RequestOptions): Promise<CommentReportResponse>;
|
538
411
|
/**
|
539
|
-
* Create a private message.
|
540
|
-
*
|
541
|
-
* `HTTP.POST /private_message`
|
412
|
+
* @summary Create a private message.
|
542
413
|
*/
|
543
414
|
createPrivateMessage(form: CreatePrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse>;
|
544
415
|
/**
|
545
|
-
* Edit a private message.
|
546
|
-
*
|
547
|
-
* `HTTP.PUT /private_message`
|
416
|
+
* @summary Edit a private message.
|
548
417
|
*/
|
549
418
|
editPrivateMessage(form: EditPrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse>;
|
550
419
|
/**
|
551
|
-
* Delete a private message.
|
552
|
-
*
|
553
|
-
* `HTTP.POST /private_message/delete`
|
420
|
+
* @summary Delete a private message.
|
554
421
|
*/
|
555
422
|
deletePrivateMessage(form: DeletePrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse>;
|
556
423
|
/**
|
557
|
-
* Mark a private message as read.
|
558
|
-
*
|
559
|
-
* `HTTP.POST /private_message/mark_as_read`
|
424
|
+
* @summary Mark a private message as read.
|
560
425
|
*/
|
561
426
|
markPrivateMessageAsRead(form: MarkPrivateMessageAsRead, options?: RequestOptions): Promise<PrivateMessageResponse>;
|
562
427
|
/**
|
563
|
-
* Create a report for a private message.
|
564
|
-
*
|
565
|
-
* `HTTP.POST /private_message/report`
|
428
|
+
* @summary Create a report for a private message.
|
566
429
|
*/
|
567
430
|
createPrivateMessageReport(form: CreatePrivateMessageReport, options?: RequestOptions): Promise<PrivateMessageReportResponse>;
|
568
431
|
/**
|
569
|
-
* Resolve a report for a private message.
|
570
|
-
*
|
571
|
-
* `HTTP.PUT /private_message/report/resolve`
|
432
|
+
* @summary Resolve a report for a private message.
|
572
433
|
*/
|
573
434
|
resolvePrivateMessageReport(form: ResolvePrivateMessageReport, options?: RequestOptions): Promise<PrivateMessageReportResponse>;
|
574
435
|
/**
|
575
|
-
* Register a new user.
|
576
|
-
*
|
577
|
-
* `HTTP.POST /account/auth/register`
|
436
|
+
* @summary Register a new user.
|
578
437
|
*/
|
579
438
|
register(form: Register, options?: RequestOptions): Promise<LoginResponse>;
|
580
439
|
/**
|
581
|
-
* Log into lemmy.
|
582
|
-
*
|
583
|
-
* `HTTP.POST /account/auth/login`
|
440
|
+
* @summary Log into lemmy.
|
584
441
|
*/
|
585
442
|
login(form: Login, options?: RequestOptions): Promise<LoginResponse>;
|
586
443
|
/**
|
587
|
-
* Invalidate the currently used auth token.
|
588
|
-
*
|
589
|
-
* `HTTP.POST /account/auth/logout`
|
444
|
+
* @summary Invalidate the currently used auth token.
|
590
445
|
*/
|
591
446
|
logout(options?: RequestOptions): Promise<SuccessResponse>;
|
592
447
|
/**
|
593
|
-
* Get the details for a person.
|
594
|
-
*
|
595
|
-
* `HTTP.GET /person`
|
448
|
+
* @summary Get the details for a person.
|
596
449
|
*/
|
597
|
-
getPersonDetails(form?:
|
450
|
+
getPersonDetails(form?: GetPersonDetailsI, options?: RequestOptions): Promise<GetPersonDetailsResponse>;
|
598
451
|
/**
|
599
|
-
* List the content for a person.
|
600
|
-
*
|
601
|
-
* `HTTP.GET /person/content`
|
452
|
+
* @summary List the content for a person.
|
602
453
|
*/
|
603
|
-
listPersonContent(form?:
|
454
|
+
listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<ListPersonContentResponse>;
|
604
455
|
/**
|
605
|
-
* Mark a person mention as read.
|
606
|
-
*
|
607
|
-
* `HTTP.POST /account/mention/comment/mark_as_read`
|
456
|
+
* @summary Mark a person mention as read.
|
608
457
|
*/
|
609
458
|
markCommentMentionAsRead(form: MarkPersonCommentMentionAsRead, options?: RequestOptions): Promise<SuccessResponse>;
|
610
459
|
/**
|
611
|
-
* Mark a person post body mention as read.
|
612
|
-
*
|
613
|
-
* `HTTP.POST /account/mention/post/mark_as_read`
|
460
|
+
* @summary Mark a person post body mention as read.
|
614
461
|
*/
|
615
462
|
markPostMentionAsRead(form: MarkPersonPostMentionAsRead, options?: RequestOptions): Promise<SuccessResponse>;
|
616
463
|
/**
|
617
|
-
* Ban a person from your site.
|
618
|
-
*
|
619
|
-
* `HTTP.POST /admin/ban`
|
464
|
+
* @summary Ban a person from your site.
|
620
465
|
*/
|
621
466
|
banPerson(form: BanPerson, options?: RequestOptions): Promise<BanPersonResponse>;
|
622
467
|
/**
|
623
|
-
* Get a list of banned users
|
624
|
-
*
|
625
|
-
* `HTTP.GET /admin/banned`
|
468
|
+
* @summary Get a list of banned users.
|
626
469
|
*/
|
627
470
|
getBannedPersons(options?: RequestOptions): Promise<BannedPersonsResponse>;
|
628
471
|
/**
|
629
|
-
* Block a person.
|
630
|
-
*
|
631
|
-
* `HTTP.POST /account/block/person`
|
472
|
+
* @summary Block a person.
|
632
473
|
*/
|
633
474
|
blockPerson(form: BlockPerson, options?: RequestOptions): Promise<BlockPersonResponse>;
|
634
475
|
/**
|
635
|
-
* Fetch a Captcha.
|
636
|
-
*
|
637
|
-
* `HTTP.GET /account/auth/get_captcha`
|
476
|
+
* @summary Fetch a Captcha.
|
638
477
|
*/
|
639
478
|
getCaptcha(options?: RequestOptions): Promise<GetCaptchaResponse>;
|
640
479
|
/**
|
641
|
-
* Delete your account.
|
642
|
-
*
|
643
|
-
* `HTTP.POST /account/delete`
|
480
|
+
* @summary Delete your account.
|
644
481
|
*/
|
645
482
|
deleteAccount(form: DeleteAccount, options?: RequestOptions): Promise<SuccessResponse>;
|
646
483
|
/**
|
647
|
-
* Reset your password.
|
648
|
-
*
|
649
|
-
* `HTTP.POST /account/auth/password_reset`
|
484
|
+
* @summary Reset your password.
|
650
485
|
*/
|
651
486
|
passwordReset(form: PasswordReset, options?: RequestOptions): Promise<SuccessResponse>;
|
652
487
|
/**
|
653
|
-
* Change your password from an email / token based reset.
|
654
|
-
*
|
655
|
-
* `HTTP.POST /account/auth/password_change`
|
488
|
+
* @summary Change your password from an email / token based reset.
|
656
489
|
*/
|
657
490
|
passwordChangeAfterReset(form: PasswordChangeAfterReset, options?: RequestOptions): Promise<SuccessResponse>;
|
658
491
|
/**
|
659
|
-
* Mark all replies as read.
|
660
|
-
*
|
661
|
-
* `HTTP.POST /account/mark_as_read/all`
|
492
|
+
* @summary Mark all replies as read.
|
662
493
|
*/
|
663
494
|
markAllNotificationsAsRead(options?: RequestOptions): Promise<SuccessResponse>;
|
664
495
|
/**
|
665
|
-
* Save your user settings.
|
666
|
-
*
|
667
|
-
* `HTTP.PUT /account/settings/save`
|
496
|
+
* @summary Save your user settings.
|
668
497
|
*/
|
669
498
|
saveUserSettings(form: SaveUserSettings, options?: RequestOptions): Promise<SuccessResponse>;
|
670
499
|
/**
|
671
|
-
* Change your user password.
|
672
|
-
*
|
673
|
-
* `HTTP.PUT /account/auth/change_password`
|
500
|
+
* @summary Change your user password.
|
674
501
|
*/
|
675
502
|
changePassword(form: ChangePassword, options?: RequestOptions): Promise<LoginResponse>;
|
676
503
|
/**
|
677
|
-
* Get counts for your reports
|
678
|
-
*
|
679
|
-
* `HTTP.GET /account/report_count`
|
504
|
+
* @summary Get counts for your reports.
|
680
505
|
*/
|
681
|
-
getReportCount(form:
|
506
|
+
getReportCount(form: GetReportCountI, options?: RequestOptions): Promise<GetReportCountResponse>;
|
682
507
|
/**
|
683
|
-
* Get your unread counts
|
684
|
-
*
|
685
|
-
* `HTTP.GET /account/unread_count`
|
508
|
+
* @summary Get your unread counts.
|
686
509
|
*/
|
687
510
|
getUnreadCount(options?: RequestOptions): Promise<GetUnreadCountResponse>;
|
688
511
|
/**
|
689
|
-
* Get your inbox (replies, comment mentions, post mentions, and messages)
|
690
|
-
*
|
691
|
-
* `HTTP.GET /account/inbox`
|
512
|
+
* @summary Get your inbox (replies, comment mentions, post mentions, and messages)
|
692
513
|
*/
|
693
|
-
listInbox(form:
|
514
|
+
listInbox(form: ListInboxI, options?: RequestOptions): Promise<ListInboxResponse>;
|
694
515
|
/**
|
695
|
-
* Verify your email
|
696
|
-
*
|
697
|
-
* `HTTP.POST /account/auth/verify_email`
|
516
|
+
* @summary Verify your email
|
698
517
|
*/
|
699
518
|
verifyEmail(form: VerifyEmail, options?: RequestOptions): Promise<SuccessResponse>;
|
700
519
|
/**
|
701
|
-
* List your saved content.
|
702
|
-
*
|
703
|
-
* `HTTP.GET /account/auth/saved`
|
520
|
+
* @summary List your saved content.
|
704
521
|
*/
|
705
|
-
listPersonSaved(form:
|
522
|
+
listPersonSaved(form: ListPersonSavedI, options?: RequestOptions): Promise<ListPersonSavedResponse>;
|
706
523
|
/**
|
707
|
-
* Add an admin to your site.
|
708
|
-
*
|
709
|
-
* `HTTP.POST /admin/add`
|
524
|
+
* @summary Add an admin to your site.
|
710
525
|
*/
|
711
526
|
addAdmin(form: AddAdmin, options?: RequestOptions): Promise<AddAdminResponse>;
|
712
527
|
/**
|
713
|
-
* Get the unread registration applications count.
|
714
|
-
*
|
715
|
-
* `HTTP.GET /admin/registration_application/count`
|
528
|
+
* @summary Get the unread registration applications count.
|
716
529
|
*/
|
717
530
|
getUnreadRegistrationApplicationCount(options?: RequestOptions): Promise<GetUnreadRegistrationApplicationCountResponse>;
|
718
531
|
/**
|
719
|
-
* List the registration applications.
|
720
|
-
*
|
721
|
-
* `HTTP.GET /admin/registration_application/list`
|
532
|
+
* @summary List the registration applications.
|
722
533
|
*/
|
723
|
-
listRegistrationApplications(form:
|
534
|
+
listRegistrationApplications(form: ListRegistrationApplicationsI, options?: RequestOptions): Promise<ListRegistrationApplicationsResponse>;
|
724
535
|
/**
|
725
|
-
* Approve a registration application
|
726
|
-
*
|
727
|
-
* `HTTP.PUT /admin/registration_application/approve`
|
536
|
+
* @summary Approve a registration application
|
728
537
|
*/
|
729
538
|
approveRegistrationApplication(form: ApproveRegistrationApplication, options?: RequestOptions): Promise<RegistrationApplicationResponse>;
|
730
539
|
/**
|
731
|
-
* Get the application a user submitted when they first registered their account
|
732
|
-
*
|
733
|
-
* `HTTP.GET /admin/registration_application`
|
540
|
+
* @summary Get the application a user submitted when they first registered their account
|
734
541
|
*/
|
735
|
-
getRegistrationApplication(form:
|
542
|
+
getRegistrationApplication(form: GetRegistrationApplicationI, options?: RequestOptions): Promise<RegistrationApplicationResponse>;
|
736
543
|
/**
|
737
|
-
* Purge / Delete a person from the database.
|
738
|
-
*
|
739
|
-
* `HTTP.POST /admin/purge/person`
|
544
|
+
* @summary Purge / Delete a person from the database.
|
740
545
|
*/
|
741
546
|
purgePerson(form: PurgePerson, options?: RequestOptions): Promise<SuccessResponse>;
|
742
547
|
/**
|
743
|
-
* Purge / Delete a community from the database.
|
744
|
-
*
|
745
|
-
* `HTTP.POST /admin/purge/community`
|
548
|
+
* @summary Purge / Delete a community from the database.
|
746
549
|
*/
|
747
550
|
purgeCommunity(form: PurgeCommunity, options?: RequestOptions): Promise<SuccessResponse>;
|
748
551
|
/**
|
749
|
-
* Purge / Delete a post from the database.
|
750
|
-
*
|
751
|
-
* `HTTP.POST /admin/purge/post`
|
552
|
+
* @summary Purge / Delete a post from the database.
|
752
553
|
*/
|
753
554
|
purgePost(form: PurgePost, options?: RequestOptions): Promise<SuccessResponse>;
|
754
555
|
/**
|
755
|
-
* Purge / Delete a comment from the database.
|
756
|
-
*
|
757
|
-
* `HTTP.POST /admin/purge/comment`
|
556
|
+
* @summary Purge / Delete a comment from the database.
|
758
557
|
*/
|
759
558
|
purgeComment(form: PurgeComment, options?: RequestOptions): Promise<SuccessResponse>;
|
760
559
|
/**
|
761
|
-
* Create a new custom emoji
|
762
|
-
*
|
763
|
-
* `HTTP.POST /custom_emoji`
|
560
|
+
* @summary Create a new custom emoji.
|
764
561
|
*/
|
765
562
|
createCustomEmoji(form: CreateCustomEmoji, options?: RequestOptions): Promise<CustomEmojiResponse>;
|
766
563
|
/**
|
767
|
-
* Edit an existing custom emoji
|
768
|
-
*
|
769
|
-
* `HTTP.PUT /custom_emoji`
|
564
|
+
* @summary Edit an existing custom emoji.
|
770
565
|
*/
|
771
566
|
editCustomEmoji(form: EditCustomEmoji, options?: RequestOptions): Promise<CustomEmojiResponse>;
|
772
567
|
/**
|
773
|
-
* Delete a custom emoji
|
774
|
-
*
|
775
|
-
* `HTTP.Post /custom_emoji/delete`
|
568
|
+
* @summary Delete a custom emoji.
|
776
569
|
*/
|
777
570
|
deleteCustomEmoji(form: DeleteCustomEmoji, options?: RequestOptions): Promise<SuccessResponse>;
|
778
571
|
/**
|
779
|
-
* List custom emojis
|
780
|
-
*
|
781
|
-
* `HTTP.GET /custom_emoji/list`
|
572
|
+
* @summary List custom emojis
|
782
573
|
*/
|
783
|
-
listCustomEmojis(form:
|
574
|
+
listCustomEmojis(form: ListCustomEmojisI, options?: RequestOptions): Promise<ListCustomEmojisResponse>;
|
784
575
|
/**
|
785
|
-
* Create a new tagline
|
786
|
-
*
|
787
|
-
* `HTTP.POST /admin/tagline`
|
576
|
+
* @summary Create a new tagline
|
788
577
|
*/
|
789
578
|
createTagline(form: CreateTagline, options?: RequestOptions): Promise<TaglineResponse>;
|
790
579
|
/**
|
791
|
-
* Edit an existing tagline
|
792
|
-
*
|
793
|
-
* `HTTP.PUT /admin/tagline`
|
580
|
+
* @summary Edit an existing tagline
|
794
581
|
*/
|
795
582
|
editTagline(form: UpdateTagline, options?: RequestOptions): Promise<TaglineResponse>;
|
796
583
|
/**
|
797
|
-
* Delete a tagline
|
798
|
-
*
|
799
|
-
* `HTTP.Post /admin/tagline/delete`
|
584
|
+
* @summary Delete a tagline
|
800
585
|
*/
|
801
586
|
deleteTagline(form: DeleteTagline, options?: RequestOptions): Promise<SuccessResponse>;
|
802
587
|
/**
|
803
|
-
* List taglines
|
804
|
-
*
|
805
|
-
* `HTTP.GET /admin/tagline/list`
|
588
|
+
* @summary List taglines.
|
806
589
|
*/
|
807
|
-
listTaglines(form:
|
590
|
+
listTaglines(form: ListTaglinesI, options?: RequestOptions): Promise<ListTaglinesResponse>;
|
808
591
|
/**
|
809
|
-
* Create a new oauth provider method
|
810
|
-
*
|
811
|
-
* `HTTP.POST /oauth_provider`
|
592
|
+
* @summary Create a new oauth provider method
|
812
593
|
*/
|
813
594
|
createOAuthProvider(form: CreateOAuthProvider, options?: RequestOptions): Promise<OAuthProvider>;
|
814
595
|
/**
|
815
|
-
* Edit an existing oauth provider method
|
816
|
-
*
|
817
|
-
* `HTTP.PUT /oauth_provider`
|
596
|
+
* @summary Edit an existing oauth provider method
|
818
597
|
*/
|
819
598
|
editOAuthProvider(form: EditOAuthProvider, options?: RequestOptions): Promise<OAuthProvider>;
|
820
599
|
/**
|
821
|
-
* Delete an oauth provider method
|
822
|
-
*
|
823
|
-
* `HTTP.Post /oauth_provider/delete`
|
600
|
+
* @summary Delete an oauth provider method
|
824
601
|
*/
|
825
602
|
deleteOAuthProvider(form: DeleteOAuthProvider, options?: RequestOptions): Promise<SuccessResponse>;
|
826
603
|
/**
|
827
|
-
* Authenticate with OAuth
|
828
|
-
*
|
829
|
-
* `HTTP.Post /oauth/authenticate`
|
604
|
+
* @summary Authenticate with OAuth
|
830
605
|
*/
|
831
606
|
authenticateWithOAuth(form: AuthenticateWithOauth, options?: RequestOptions): Promise<LoginResponse>;
|
832
607
|
/**
|
833
|
-
* Fetch federated instances.
|
834
|
-
*
|
835
|
-
* `HTTP.Get /federated_instances`
|
608
|
+
* @summary Fetch federated instances.
|
836
609
|
*/
|
837
610
|
getFederatedInstances(options?: RequestOptions): Promise<GetFederatedInstancesResponse>;
|
838
611
|
/**
|
839
|
-
* List user reports.
|
840
|
-
*
|
841
|
-
* `HTTP.GET /report/list`
|
612
|
+
* @summary List user reports.
|
842
613
|
*/
|
843
|
-
listReports(form:
|
614
|
+
listReports(form: ListReportsI, options?: RequestOptions): Promise<ListReportsResponse>;
|
844
615
|
/**
|
845
|
-
* Block an instance as user.
|
846
|
-
*
|
847
|
-
* `HTTP.Post /account/block/instance`
|
616
|
+
* @summary Block an instance as user.
|
848
617
|
*/
|
849
618
|
userBlockInstance(form: UserBlockInstanceParams, options?: RequestOptions): Promise<SuccessResponse>;
|
850
619
|
/**
|
851
|
-
* Globally block an instance as admin.
|
852
|
-
*
|
853
|
-
* `HTTP.Post /admin/instance/block`
|
620
|
+
* @summary Globally block an instance as admin.
|
854
621
|
*/
|
855
622
|
adminBlockInstance(form: AdminBlockInstanceParams, options?: RequestOptions): Promise<SuccessResponse>;
|
856
623
|
/**
|
857
|
-
* Globally allow an instance as admin.
|
858
|
-
*
|
859
|
-
* `HTTP.Post /admin/instance/allow`
|
624
|
+
* @summary Globally allow an instance as admin.
|
860
625
|
*/
|
861
626
|
adminAllowInstance(form: AdminAllowInstanceParams, options?: RequestOptions): Promise<SuccessResponse>;
|
862
627
|
/**
|
863
|
-
* Upload new user avatar.
|
864
|
-
*
|
865
|
-
* `HTTP.Post /account/avatar`
|
628
|
+
* @summary Upload new user avatar.
|
866
629
|
*/
|
867
630
|
uploadUserAvatar(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
|
868
631
|
/**
|
869
|
-
* Delete the user avatar.
|
870
|
-
*
|
871
|
-
* `HTTP.Delete /account/avatar`
|
632
|
+
* @summary Delete the user avatar.
|
872
633
|
*/
|
873
634
|
deleteUserAvatar(options?: RequestOptions): Promise<SuccessResponse>;
|
874
635
|
/**
|
875
|
-
* Upload new user banner.
|
876
|
-
*
|
877
|
-
* `HTTP.Post /account/banner`
|
636
|
+
* @summary Upload new user banner.
|
878
637
|
*/
|
879
638
|
uploadUserBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
|
880
639
|
/**
|
881
|
-
* Delete the user banner.
|
882
|
-
*
|
883
|
-
* `HTTP.Delete /account/banner`
|
640
|
+
* @summary Delete the user banner.
|
884
641
|
*/
|
885
642
|
deleteUserBanner(options?: RequestOptions): Promise<SuccessResponse>;
|
886
643
|
/**
|
887
|
-
* Upload new community icon.
|
888
|
-
*
|
889
|
-
* `HTTP.Post /community/icon`
|
644
|
+
* @summary Upload new community icon.
|
890
645
|
*/
|
891
646
|
uploadCommunityIcon(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
|
892
647
|
/**
|
893
|
-
* Delete the community icon.
|
894
|
-
*
|
895
|
-
* `HTTP.Delete /community/icon`
|
648
|
+
* @summary Delete the community icon.
|
896
649
|
*/
|
897
650
|
deleteCommunityIcon(options?: RequestOptions): Promise<SuccessResponse>;
|
898
651
|
/**
|
899
|
-
* Upload new community banner.
|
900
|
-
*
|
901
|
-
* `HTTP.Post /community/banner`
|
652
|
+
* @summary Upload new community banner.
|
902
653
|
*/
|
903
654
|
uploadCommunityBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
|
904
655
|
/**
|
905
|
-
* Delete the community banner.
|
906
|
-
*
|
907
|
-
* `HTTP.Delete /community/banner`
|
656
|
+
* @summary Delete the community banner.
|
908
657
|
*/
|
909
658
|
deleteCommunityBanner(options?: RequestOptions): Promise<SuccessResponse>;
|
910
659
|
/**
|
911
|
-
* Upload new site icon.
|
912
|
-
*
|
913
|
-
* `HTTP.Post /site/icon`
|
660
|
+
* @summary Upload new site icon.
|
914
661
|
*/
|
915
662
|
uploadSiteIcon(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
|
916
663
|
/**
|
917
|
-
* Delete the site icon.
|
918
|
-
*
|
919
|
-
* `HTTP.Delete /site/icon`
|
664
|
+
* @summary Delete the site icon.
|
920
665
|
*/
|
921
666
|
deleteSiteIcon(options?: RequestOptions): Promise<SuccessResponse>;
|
922
667
|
/**
|
923
|
-
* Upload new site banner.
|
924
|
-
*
|
925
|
-
* `HTTP.Post /site/banner`
|
668
|
+
* @summary Upload new site banner.
|
926
669
|
*/
|
927
670
|
uploadSiteBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
|
928
671
|
/**
|
929
|
-
* Delete the site banner.
|
930
|
-
*
|
931
|
-
* `HTTP.Delete /site/banner`
|
672
|
+
* @summary Delete the site banner.
|
932
673
|
*/
|
933
674
|
deleteSiteBanner(options?: RequestOptions): Promise<SuccessResponse>;
|
934
675
|
/**
|
935
|
-
* Upload an image to the server.
|
936
|
-
*
|
937
|
-
* `HTTP.Post /image`
|
676
|
+
* @summary Upload an image to the server.
|
938
677
|
*/
|
939
678
|
uploadImage(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
|
940
679
|
/**
|
941
|
-
* Delete a pictrs image
|
942
|
-
*
|
943
|
-
* `HTTP.Delete /image`
|
680
|
+
* @summary Delete a pictrs image
|
944
681
|
*/
|
945
|
-
deleteImage(form:
|
682
|
+
deleteImage(form: DeleteImageParamsI, options?: RequestOptions): Promise<SuccessResponse>;
|
946
683
|
/**
|
947
|
-
* Health check for image functionality
|
948
|
-
*
|
949
|
-
* `HTTP.Get /image/health`
|
684
|
+
* @summary Health check for image functionality
|
950
685
|
*/
|
951
686
|
imageHealth(options?: RequestOptions): Promise<SuccessResponse>;
|
952
687
|
/**
|