lemmy-js-client 1.0.0-split-hide-media.0 → 1.0.0-split-hide-media.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -27,7 +27,10 @@ import { LemmyHttp, Login } from "lemmy-js-client";
27
27
  // Build the client
28
28
  const baseUrl = "https://lemmy.ml";
29
29
  const headers = {["x-real-ip": ...]};
30
- const client: LemmyHttp = new LemmyHttp(baseUrl, { headers });
30
+ const client: LemmyHttp = new LemmyHttp(baseUrl, {
31
+ headers,
32
+ useRequestState: true
33
+ });
31
34
 
32
35
  // Build the login form
33
36
  const loginForm: Login = {
package/dist/http.d.ts CHANGED
@@ -146,7 +146,6 @@ import { PersonView } from "./types/PersonView";
146
146
  import { NodeInfo } from "./types/NodeInfo";
147
147
  import { UserSettingsBackup } from "./types/UserSettingsBackup";
148
148
  import { SearchResponse } from "./types/SearchResponse";
149
- import { RequestState } from "./request_state";
150
149
  import { CreateInvitation } from "./types/CreateInvitation";
151
150
  import { CreateInvitationResponse } from "./types/CreateInvitationResponse";
152
151
  import { RevokeInvitation } from "./types/RevokeInvitation";
@@ -170,10 +169,11 @@ declare class LemmyController extends Controller {
170
169
  headers?: {
171
170
  [key: string]: string;
172
171
  };
172
+ useRequestState: boolean;
173
173
  });
174
- upload<ResponseType>(path: string, { image }: UploadImage, options?: RequestOptions): Promise<RequestState<ResponseType>>;
175
- uploadWithQuery<QueryType extends object, ResponseType>(path: string, query: QueryType, { image }: UploadImage, options?: RequestOptions): Promise<RequestState<ResponseType>>;
176
- wrapper<BodyType extends object, ResponseType>(type_: HttpType, endpoint: string, form: BodyType, options: RequestOptions | undefined, no_prefix?: boolean): Promise<RequestState<ResponseType>>;
174
+ upload<ResponseType>(path: string, { image }: UploadImage, options?: RequestOptions): Promise<ResponseType | import("./request_state").RequestState<ResponseType> | undefined>;
175
+ uploadWithQuery<QueryType extends object, ResponseType>(path: string, query: QueryType, { image }: UploadImage, options?: RequestOptions): Promise<ResponseType | import("./request_state").RequestState<ResponseType> | undefined>;
176
+ wrapper<BodyType extends object, ResponseType>(type_: HttpType, endpoint: string, form: BodyType, options: RequestOptions | undefined, noPrefix?: boolean): Promise<ResponseType | import("./request_state").RequestState<ResponseType> | undefined>;
177
177
  /**
178
178
  * Set the headers (can be used to set the auth header)
179
179
  */
@@ -188,65 +188,65 @@ export declare class LemmyHttp extends LemmyController {
188
188
  /**
189
189
  * @summary Gets the site, and your user data.
190
190
  */
191
- getSite(options?: RequestOptions): Promise<RequestState<GetSiteResponse>>;
191
+ getSite(options?: RequestOptions): Promise<GetSiteResponse | import("./request_state").RequestState<GetSiteResponse> | undefined>;
192
192
  /**
193
193
  * @summary Create your site.
194
194
  */
195
- createSite(form: CreateSite, options?: RequestOptions): Promise<RequestState<SiteResponse>>;
195
+ createSite(form: CreateSite, options?: RequestOptions): Promise<SiteResponse | import("./request_state").RequestState<SiteResponse> | undefined>;
196
196
  /**
197
197
  * @summary Edit your site.
198
198
  */
199
- editSite(form: EditSite, options?: RequestOptions): Promise<RequestState<SiteResponse>>;
199
+ editSite(form: EditSite, options?: RequestOptions): Promise<SiteResponse | import("./request_state").RequestState<SiteResponse> | undefined>;
200
200
  /**
201
201
  * @summary Leave the Site admins.
202
202
  */
203
- leaveAdmin(options?: RequestOptions): Promise<RequestState<GetSiteResponse>>;
203
+ leaveAdmin(options?: RequestOptions): Promise<GetSiteResponse | import("./request_state").RequestState<GetSiteResponse> | undefined>;
204
204
  /**
205
205
  * @summary Generate a TOTP / two-factor secret.
206
206
  *
207
207
  * Generate a TOTP / two-factor secret.
208
208
  * Afterwards you need to call `/account/auth/totp/edit` with a valid token to enable it.
209
209
  */
210
- generateTotpSecret(options?: RequestOptions): Promise<RequestState<GenerateTotpSecretResponse>>;
210
+ generateTotpSecret(options?: RequestOptions): Promise<GenerateTotpSecretResponse | import("./request_state").RequestState<GenerateTotpSecretResponse> | undefined>;
211
211
  /**
212
212
  * @summary Get data of current user.
213
213
  */
214
- getMyUser(options?: RequestOptions): Promise<RequestState<MyUserInfo>>;
214
+ getMyUser(options?: RequestOptions): Promise<MyUserInfo | import("./request_state").RequestState<MyUserInfo> | undefined>;
215
215
  /**
216
216
  * @summary Export a backup of your user settings.
217
217
  *
218
218
  * Export a backup of your user settings, including your saved content,
219
219
  * followed communities, and blocks.
220
220
  */
221
- exportUserSettings(options?: RequestOptions): Promise<RequestState<string>>;
221
+ exportUserSettings(options?: RequestOptions): Promise<string | import("./request_state").RequestState<string> | undefined>;
222
222
  /**
223
223
  * @summary Import a backup of your user settings.
224
224
  */
225
- importUserSettings(form: UserSettingsBackup, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
225
+ importUserSettings(form: UserSettingsBackup, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
226
226
  /**
227
227
  * @summary List login tokens for your user
228
228
  */
229
- listLogins(options?: RequestOptions): Promise<RequestState<ListLoginsResponse>>;
229
+ listLogins(options?: RequestOptions): Promise<ListLoginsResponse | import("./request_state").RequestState<ListLoginsResponse> | undefined>;
230
230
  /**
231
231
  * @summary Returns an error message if your auth token is invalid
232
232
  */
233
- validateAuth(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
233
+ validateAuth(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
234
234
  /**
235
235
  * @summary List all the media for your account.
236
236
  */
237
- listMedia(form?: ListMediaI, options?: RequestOptions): Promise<RequestState<PagedResponse<LocalImageView>>>;
237
+ listMedia(form?: ListMediaI, options?: RequestOptions): Promise<PagedResponse<LocalImageView> | import("./request_state").RequestState<PagedResponse<LocalImageView>> | undefined>;
238
238
  /**
239
239
  * @summary Delete media for your account.
240
240
  */
241
- deleteMedia(form: DeleteImageParamsI, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
241
+ deleteMedia(form: DeleteImageParamsI, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
242
242
  /**
243
243
  * @summary Delete any media. (Admin only)
244
244
  */
245
- adminDeleteMedia(form: DeleteImageParamsI, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
245
+ adminDeleteMedia(form: DeleteImageParamsI, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
246
246
  /**
247
247
  * @summary List all the media known to your instance.
248
248
  */
249
- adminListMedia(form?: ListMediaI, options?: RequestOptions): Promise<RequestState<PagedResponse<LocalImageView>>>;
249
+ adminListMedia(form?: ListMediaI, options?: RequestOptions): Promise<PagedResponse<LocalImageView> | import("./request_state").RequestState<PagedResponse<LocalImageView>> | undefined>;
250
250
  /**
251
251
  * @summary Enable / Disable TOTP / two-factor authentication.
252
252
  *
@@ -254,557 +254,557 @@ export declare class LemmyHttp extends LemmyController {
254
254
  *
255
255
  * Disabling is only possible if 2FA was previously enabled. Again it is necessary to pass a valid token.
256
256
  */
257
- editTotp(form: EditTotp, options?: RequestOptions): Promise<RequestState<EditTotpResponse>>;
257
+ editTotp(form: EditTotp, options?: RequestOptions): Promise<EditTotpResponse | import("./request_state").RequestState<EditTotpResponse> | undefined>;
258
258
  /**
259
259
  * @summary Get the modlog.
260
260
  */
261
- getModlog(form?: GetModlogI, options?: RequestOptions): Promise<RequestState<PagedResponse<ModlogView>>>;
261
+ getModlog(form?: GetModlogI, options?: RequestOptions): Promise<PagedResponse<ModlogView> | import("./request_state").RequestState<PagedResponse<ModlogView>> | undefined>;
262
262
  /**
263
263
  * @summary Search lemmy. If `search_term` is a url it also attempts to fetch it, just like `resolve_object`.
264
264
  */
265
- search(form: SearchI, options?: RequestOptions): Promise<RequestState<SearchResponse>>;
265
+ search(form: SearchI, options?: RequestOptions): Promise<SearchResponse | import("./request_state").RequestState<SearchResponse> | undefined>;
266
266
  /**
267
267
  * @summary Fetch a non-local / federated object.
268
268
  */
269
- resolveObject(form: ResolveObjectI, options?: RequestOptions): Promise<RequestState<ResolveObjectView>>;
269
+ resolveObject(form: ResolveObjectI, options?: RequestOptions): Promise<ResolveObjectView | import("./request_state").RequestState<ResolveObjectView> | undefined>;
270
270
  /**
271
271
  * @summary Create a new community.
272
272
  */
273
- createCommunity(form: CreateCommunity, options?: RequestOptions): Promise<RequestState<CommunityResponse>>;
273
+ createCommunity(form: CreateCommunity, options?: RequestOptions): Promise<CommunityResponse | import("./request_state").RequestState<CommunityResponse> | undefined>;
274
274
  /**
275
275
  * @summary Get / fetch a community.
276
276
  */
277
- getCommunity(form?: GetCommunityI, options?: RequestOptions): Promise<RequestState<GetCommunityResponse>>;
277
+ getCommunity(form?: GetCommunityI, options?: RequestOptions): Promise<GetCommunityResponse | import("./request_state").RequestState<GetCommunityResponse> | undefined>;
278
278
  /**
279
279
  * @summary Edit a community.
280
280
  */
281
- editCommunity(form: EditCommunity, options?: RequestOptions): Promise<RequestState<CommunityResponse>>;
281
+ editCommunity(form: EditCommunity, options?: RequestOptions): Promise<CommunityResponse | import("./request_state").RequestState<CommunityResponse> | undefined>;
282
282
  /**
283
283
  * @summary List communities, with various filters.
284
284
  */
285
- listCommunities(form?: ListCommunitiesI, options?: RequestOptions): Promise<RequestState<PagedResponse<CommunityView>>>;
285
+ listCommunities(form?: ListCommunitiesI, options?: RequestOptions): Promise<PagedResponse<CommunityView> | import("./request_state").RequestState<PagedResponse<CommunityView>> | undefined>;
286
286
  /**
287
287
  * @summary Follow / subscribe to a community.
288
288
  */
289
- followCommunity(form: FollowCommunity, options?: RequestOptions): Promise<RequestState<CommunityResponse>>;
289
+ followCommunity(form: FollowCommunity, options?: RequestOptions): Promise<CommunityResponse | import("./request_state").RequestState<CommunityResponse> | undefined>;
290
290
  /**
291
291
  * @summary Returns the amount of unread items of various types. For normal users this means * the number of unread notifications, mods and admins get additional unread counts for
292
292
  * reports, registration applications and pending follows to private communities.
293
293
  */
294
- getUnreadCounts(options?: RequestOptions): Promise<RequestState<UnreadCountsResponse>>;
294
+ getUnreadCounts(options?: RequestOptions): Promise<UnreadCountsResponse | import("./request_state").RequestState<UnreadCountsResponse> | undefined>;
295
295
  /**
296
296
  * @summary Get a community's pending followers.
297
297
  */
298
- listCommunityPendingFollows(form: ListCommunityPendingFollowsI, options?: RequestOptions): Promise<RequestState<PagedResponse<PendingFollowerView>>>;
298
+ listCommunityPendingFollows(form: ListCommunityPendingFollowsI, options?: RequestOptions): Promise<PagedResponse<PendingFollowerView> | import("./request_state").RequestState<PagedResponse<PendingFollowerView>> | undefined>;
299
299
  /**
300
300
  * @summary Approve a community pending follow request.
301
301
  */
302
- approveCommunityPendingFollow(form: ApproveCommunityPendingFollower, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
302
+ approveCommunityPendingFollow(form: ApproveCommunityPendingFollower, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
303
303
  /**
304
304
  * @summary Block a community.
305
305
  */
306
- blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<RequestState<CommunityResponse>>;
306
+ blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<CommunityResponse | import("./request_state").RequestState<CommunityResponse> | undefined>;
307
307
  /**
308
308
  * @summary Delete a community.
309
309
  */
310
- deleteCommunity(form: DeleteCommunity, options?: RequestOptions): Promise<RequestState<CommunityResponse>>;
310
+ deleteCommunity(form: DeleteCommunity, options?: RequestOptions): Promise<CommunityResponse | import("./request_state").RequestState<CommunityResponse> | undefined>;
311
311
  /**
312
312
  * @summary Hide a community from public / "All" view. Admins only.
313
313
  */
314
- hideCommunity(form: HideCommunity, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
314
+ hideCommunity(form: HideCommunity, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
315
315
  /**
316
316
  * @summary A moderator remove for a community.
317
317
  */
318
- removeCommunity(form: RemoveCommunity, options?: RequestOptions): Promise<RequestState<CommunityResponse>>;
318
+ removeCommunity(form: RemoveCommunity, options?: RequestOptions): Promise<CommunityResponse | import("./request_state").RequestState<CommunityResponse> | undefined>;
319
319
  /**
320
320
  * @summary Transfer your community to an existing moderator.
321
321
  */
322
- transferCommunity(form: TransferCommunity, options?: RequestOptions): Promise<RequestState<GetCommunityResponse>>;
322
+ transferCommunity(form: TransferCommunity, options?: RequestOptions): Promise<GetCommunityResponse | import("./request_state").RequestState<GetCommunityResponse> | undefined>;
323
323
  /**
324
324
  * @summary Ban a user from a community.
325
325
  */
326
- banFromCommunity(form: BanFromCommunity, options?: RequestOptions): Promise<RequestState<PersonResponse>>;
326
+ banFromCommunity(form: BanFromCommunity, options?: RequestOptions): Promise<PersonResponse | import("./request_state").RequestState<PersonResponse> | undefined>;
327
327
  /**
328
328
  * @summary Add a moderator to your community.
329
329
  */
330
- addModToCommunity(form: AddModToCommunity, options?: RequestOptions): Promise<RequestState<AddModToCommunityResponse>>;
330
+ addModToCommunity(form: AddModToCommunity, options?: RequestOptions): Promise<AddModToCommunityResponse | import("./request_state").RequestState<AddModToCommunityResponse> | undefined>;
331
331
  /**
332
332
  * @summary Get a random community.
333
333
  */
334
- getRandomCommunity(form: GetRandomCommunityI, options?: RequestOptions): Promise<RequestState<CommunityResponse>>;
334
+ getRandomCommunity(form: GetRandomCommunityI, options?: RequestOptions): Promise<CommunityResponse | import("./request_state").RequestState<CommunityResponse> | undefined>;
335
335
  /**
336
336
  * @summary Create a report for a community.
337
337
  */
338
- createCommunityReport(form: CreateCommunityReport, options?: RequestOptions): Promise<RequestState<CommunityReportResponse>>;
338
+ createCommunityReport(form: CreateCommunityReport, options?: RequestOptions): Promise<CommunityReportResponse | import("./request_state").RequestState<CommunityReportResponse> | undefined>;
339
339
  /**
340
340
  * @summary Resolve a report for a private message.
341
341
  */
342
- resolveCommunityReport(form: ResolveCommunityReport, options?: RequestOptions): Promise<RequestState<CommunityReportResponse>>;
342
+ resolveCommunityReport(form: ResolveCommunityReport, options?: RequestOptions): Promise<CommunityReportResponse | import("./request_state").RequestState<CommunityReportResponse> | undefined>;
343
343
  /**
344
344
  * @summary Create a post.
345
345
  */
346
- createPost(form: CreatePost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
346
+ createPost(form: CreatePost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
347
347
  /**
348
348
  * @summary Get / fetch a post.
349
349
  */
350
- getPost(form?: GetPostI, options?: RequestOptions): Promise<RequestState<GetPostResponse>>;
350
+ getPost(form?: GetPostI, options?: RequestOptions): Promise<GetPostResponse | import("./request_state").RequestState<GetPostResponse> | undefined>;
351
351
  /**
352
352
  * @summary Edit a post.
353
353
  */
354
- editPost(form: EditPost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
354
+ editPost(form: EditPost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
355
355
  /**
356
356
  * @summary Mods can change nsfw flag and tags for a post
357
357
  */
358
- modEditPost(form: ModEditPost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
358
+ modEditPost(form: ModEditPost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
359
359
  /**
360
360
  * @summary Creates a warning against a post and notifies the user.
361
361
  */
362
- warnPost(form: CreatePostWarning, options?: RequestOptions): Promise<RequestState<PostResponse>>;
362
+ warnPost(form: CreatePostWarning, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
363
363
  /**
364
364
  * @summary Delete a post.
365
365
  */
366
- deletePost(form: DeletePost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
366
+ deletePost(form: DeletePost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
367
367
  /**
368
368
  * @summary A moderator remove for a post.
369
369
  */
370
- removePost(form: RemovePost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
370
+ removePost(form: RemovePost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
371
371
  /**
372
372
  * @summary Mark a post as read.
373
373
  */
374
- markPostAsRead(form: MarkPostAsRead, options?: RequestOptions): Promise<RequestState<PostResponse>>;
374
+ markPostAsRead(form: MarkPostAsRead, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
375
375
  /**
376
376
  * @summary Mark multiple posts as read.
377
377
  */
378
- markManyPostsAsRead(form: MarkManyPostsAsRead, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
378
+ markManyPostsAsRead(form: MarkManyPostsAsRead, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
379
379
  /**
380
380
  * @summary Hide a post from list views.
381
381
  */
382
- hidePost(form: HidePost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
382
+ hidePost(form: HidePost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
383
383
  /**
384
384
  * @summary A moderator can lock a post ( IE disable new comments ).
385
385
  */
386
- lockPost(form: LockPost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
386
+ lockPost(form: LockPost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
387
387
  /**
388
388
  * @summary A moderator can feature a community post ( IE stick it to the top of a community ).
389
389
  */
390
- featurePost(form: FeaturePost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
390
+ featurePost(form: FeaturePost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
391
391
  /**
392
392
  * @summary Get / fetch posts, with various filters.
393
393
  */
394
- getPosts(form?: GetPostsI, options?: RequestOptions): Promise<RequestState<PagedResponse<PostView>>>;
394
+ getPosts(form?: GetPostsI, options?: RequestOptions): Promise<PagedResponse<PostView> | import("./request_state").RequestState<PagedResponse<PostView>> | undefined>;
395
395
  /**
396
396
  * @summary Like / vote on a post.
397
397
  */
398
- likePost(form: CreatePostLike, options?: RequestOptions): Promise<RequestState<PostResponse>>;
398
+ likePost(form: CreatePostLike, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
399
399
  /**
400
400
  * @summary List a post's likes. Admin-only.
401
401
  */
402
- listPostLikes(form: ListPostLikesI, options?: RequestOptions): Promise<RequestState<PagedResponse<VoteView>>>;
402
+ listPostLikes(form: ListPostLikesI, options?: RequestOptions): Promise<PagedResponse<VoteView> | import("./request_state").RequestState<PagedResponse<VoteView>> | undefined>;
403
403
  /**
404
404
  * @summary Save a post.
405
405
  */
406
- savePost(form: SavePost, options?: RequestOptions): Promise<RequestState<PostResponse>>;
406
+ savePost(form: SavePost, options?: RequestOptions): Promise<PostResponse | import("./request_state").RequestState<PostResponse> | undefined>;
407
407
  /**
408
408
  * @summary Report a post.
409
409
  */
410
- createPostReport(form: CreatePostReport, options?: RequestOptions): Promise<RequestState<PostReportResponse>>;
410
+ createPostReport(form: CreatePostReport, options?: RequestOptions): Promise<PostReportResponse | import("./request_state").RequestState<PostReportResponse> | undefined>;
411
411
  /**
412
412
  * @summary Resolve a post report. Only a mod can do this.
413
413
  */
414
- resolvePostReport(form: ResolvePostReport, options?: RequestOptions): Promise<RequestState<PostReportResponse>>;
414
+ resolvePostReport(form: ResolvePostReport, options?: RequestOptions): Promise<PostReportResponse | import("./request_state").RequestState<PostReportResponse> | undefined>;
415
415
  /**
416
416
  * @summary Fetch metadata for any given site.
417
417
  */
418
- getSiteMetadata(form: GetSiteMetadataI, options?: RequestOptions): Promise<RequestState<GetSiteMetadataResponse>>;
418
+ getSiteMetadata(form: GetSiteMetadataI, options?: RequestOptions): Promise<GetSiteMetadataResponse | import("./request_state").RequestState<GetSiteMetadataResponse> | undefined>;
419
419
  /**
420
420
  * @summary Create a comment.
421
421
  */
422
- createComment(form: CreateComment, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
422
+ createComment(form: CreateComment, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
423
423
  /**
424
424
  * @summary Edit a comment.
425
425
  */
426
- editComment(form: EditComment, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
426
+ editComment(form: EditComment, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
427
427
  /**
428
428
  * @summary Delete a comment.
429
429
  */
430
- deleteComment(form: DeleteComment, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
430
+ deleteComment(form: DeleteComment, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
431
431
  /**
432
432
  * @summary A moderator remove for a comment.
433
433
  */
434
- removeComment(form: RemoveComment, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
434
+ removeComment(form: RemoveComment, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
435
435
  /**
436
436
  * @summary A moderator can lock a comment (IE disable replies).
437
437
  */
438
- lockComment(form: LockComment, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
438
+ lockComment(form: LockComment, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
439
439
  /**
440
440
  * @Summary Like / vote on a comment.
441
441
  */
442
- likeComment(form: CreateCommentLike, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
442
+ likeComment(form: CreateCommentLike, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
443
443
  /**
444
444
  * @summary List a comment's likes. Admin-only.
445
445
  */
446
- listCommentLikes(form: ListCommentLikesI, options?: RequestOptions): Promise<RequestState<PagedResponse<VoteView>>>;
446
+ listCommentLikes(form: ListCommentLikesI, options?: RequestOptions): Promise<PagedResponse<VoteView> | import("./request_state").RequestState<PagedResponse<VoteView>> | undefined>;
447
447
  /**
448
448
  * @summary Save a comment.
449
449
  */
450
- saveComment(form: SaveComment, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
450
+ saveComment(form: SaveComment, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
451
451
  /**
452
452
  * @summary Distinguishes a comment (speak as moderator)
453
453
  */
454
- distinguishComment(form: DistinguishComment, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
454
+ distinguishComment(form: DistinguishComment, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
455
455
  /**
456
456
  * @summary Get / fetch comments.
457
457
  */
458
- getComments(form?: GetCommentsI, options?: RequestOptions): Promise<RequestState<PagedResponse<CommentView>>>;
458
+ getComments(form?: GetCommentsI, options?: RequestOptions): Promise<PagedResponse<CommentView> | import("./request_state").RequestState<PagedResponse<CommentView>> | undefined>;
459
459
  /**
460
460
  * @summary Get / fetch comments, but without the post or community.
461
461
  */
462
- getCommentsSlim(form?: GetCommentsI, options?: RequestOptions): Promise<RequestState<PagedResponse<CommentSlimView>>>;
462
+ getCommentsSlim(form?: GetCommentsI, options?: RequestOptions): Promise<PagedResponse<CommentSlimView> | import("./request_state").RequestState<PagedResponse<CommentSlimView>> | undefined>;
463
463
  /**
464
464
  * @summary Get / fetch comment.
465
465
  */
466
- getComment(form: GetCommentI, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
466
+ getComment(form: GetCommentI, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
467
467
  /**
468
468
  * @summary Creates a warning against a comment and notifies the user.
469
469
  */
470
- warnComment(form: CreateCommentWarning, options?: RequestOptions): Promise<RequestState<CommentResponse>>;
470
+ warnComment(form: CreateCommentWarning, options?: RequestOptions): Promise<CommentResponse | import("./request_state").RequestState<CommentResponse> | undefined>;
471
471
  /**
472
472
  * @summary Report a comment.
473
473
  */
474
- createCommentReport(form: CreateCommentReport, options?: RequestOptions): Promise<RequestState<CommentReportResponse>>;
474
+ createCommentReport(form: CreateCommentReport, options?: RequestOptions): Promise<CommentReportResponse | import("./request_state").RequestState<CommentReportResponse> | undefined>;
475
475
  /**
476
476
  * @summary Resolve a comment report. Only a mod can do this.
477
477
  */
478
- resolveCommentReport(form: ResolveCommentReport, options?: RequestOptions): Promise<RequestState<CommentReportResponse>>;
478
+ resolveCommentReport(form: ResolveCommentReport, options?: RequestOptions): Promise<CommentReportResponse | import("./request_state").RequestState<CommentReportResponse> | undefined>;
479
479
  /**
480
480
  * @summary Create a private message.
481
481
  */
482
- createPrivateMessage(form: CreatePrivateMessage, options?: RequestOptions): Promise<RequestState<PrivateMessageResponse>>;
482
+ createPrivateMessage(form: CreatePrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse | import("./request_state").RequestState<PrivateMessageResponse> | undefined>;
483
483
  /**
484
484
  * @summary Edit a private message.
485
485
  */
486
- editPrivateMessage(form: EditPrivateMessage, options?: RequestOptions): Promise<RequestState<PrivateMessageResponse>>;
486
+ editPrivateMessage(form: EditPrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse | import("./request_state").RequestState<PrivateMessageResponse> | undefined>;
487
487
  /**
488
488
  * @summary Delete a private message.
489
489
  */
490
- deletePrivateMessage(form: DeletePrivateMessage, options?: RequestOptions): Promise<RequestState<PrivateMessageResponse>>;
490
+ deletePrivateMessage(form: DeletePrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse | import("./request_state").RequestState<PrivateMessageResponse> | undefined>;
491
491
  /**
492
492
  * @summary Create a report for a private message.
493
493
  */
494
- createPrivateMessageReport(form: CreatePrivateMessageReport, options?: RequestOptions): Promise<RequestState<PrivateMessageReportResponse>>;
494
+ createPrivateMessageReport(form: CreatePrivateMessageReport, options?: RequestOptions): Promise<PrivateMessageReportResponse | import("./request_state").RequestState<PrivateMessageReportResponse> | undefined>;
495
495
  /**
496
496
  * @summary Resolve a report for a private message.
497
497
  */
498
- resolvePrivateMessageReport(form: ResolvePrivateMessageReport, options?: RequestOptions): Promise<RequestState<PrivateMessageReportResponse>>;
498
+ resolvePrivateMessageReport(form: ResolvePrivateMessageReport, options?: RequestOptions): Promise<PrivateMessageReportResponse | import("./request_state").RequestState<PrivateMessageReportResponse> | undefined>;
499
499
  /**
500
500
  * @summary Register a new user.
501
501
  */
502
- register(form: Register, options?: RequestOptions): Promise<RequestState<LoginResponse>>;
502
+ register(form: Register, options?: RequestOptions): Promise<LoginResponse | import("./request_state").RequestState<LoginResponse> | undefined>;
503
503
  /**
504
504
  * @summary Log into lemmy.
505
505
  */
506
- login(form: Login, options?: RequestOptions): Promise<RequestState<LoginResponse>>;
506
+ login(form: Login, options?: RequestOptions): Promise<LoginResponse | import("./request_state").RequestState<LoginResponse> | undefined>;
507
507
  /**
508
508
  * @summary Invalidate the currently used auth token.
509
509
  */
510
- logout(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
510
+ logout(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
511
511
  /**
512
512
  * @summary Get the details for a person.
513
513
  */
514
- getPersonDetails(form?: GetPersonDetailsI, options?: RequestOptions): Promise<RequestState<GetPersonDetailsResponse>>;
514
+ getPersonDetails(form?: GetPersonDetailsI, options?: RequestOptions): Promise<GetPersonDetailsResponse | import("./request_state").RequestState<GetPersonDetailsResponse> | undefined>;
515
515
  /**
516
516
  * @summary List the content for a person.
517
517
  */
518
- listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<RequestState<PagedResponse<PostCommentCombinedView>>>;
518
+ listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<PagedResponse<PostCommentCombinedView> | import("./request_state").RequestState<PagedResponse<PostCommentCombinedView>> | undefined>;
519
519
  /**
520
520
  * @summary Make a note for a person.
521
521
  */
522
- notePerson(form: NotePerson, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
522
+ notePerson(form: NotePerson, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
523
523
  /**
524
524
  * @summary List persons.
525
525
  */
526
- listPersons(form?: ListPersonsI, options?: RequestOptions): Promise<RequestState<PagedResponse<PersonView>>>;
526
+ listPersons(form?: ListPersonsI, options?: RequestOptions): Promise<PagedResponse<PersonView> | import("./request_state").RequestState<PagedResponse<PersonView>> | undefined>;
527
527
  /**
528
528
  * @summary Ban a person from your site.
529
529
  */
530
- banPerson(form: BanPerson, options?: RequestOptions): Promise<RequestState<PersonResponse>>;
530
+ banPerson(form: BanPerson, options?: RequestOptions): Promise<PersonResponse | import("./request_state").RequestState<PersonResponse> | undefined>;
531
531
  /**
532
532
  * @summary Get a list of users.
533
533
  */
534
- adminListUsers(form?: AdminListUsersI, options?: RequestOptions): Promise<RequestState<PagedResponse<LocalUserView>>>;
534
+ adminListUsers(form?: AdminListUsersI, options?: RequestOptions): Promise<PagedResponse<LocalUserView> | import("./request_state").RequestState<PagedResponse<LocalUserView>> | undefined>;
535
535
  /**
536
536
  * @summary Block a person.
537
537
  */
538
- blockPerson(form: BlockPerson, options?: RequestOptions): Promise<RequestState<PersonResponse>>;
538
+ blockPerson(form: BlockPerson, options?: RequestOptions): Promise<PersonResponse | import("./request_state").RequestState<PersonResponse> | undefined>;
539
539
  /**
540
540
  * @summary Fetch a Captcha.
541
541
  */
542
- getCaptcha(options?: RequestOptions): Promise<RequestState<GetCaptchaResponse>>;
542
+ getCaptcha(options?: RequestOptions): Promise<GetCaptchaResponse | import("./request_state").RequestState<GetCaptchaResponse> | undefined>;
543
543
  /**
544
544
  * @summary Delete your account.
545
545
  */
546
- deleteAccount(form: DeleteAccount, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
546
+ deleteAccount(form: DeleteAccount, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
547
547
  /**
548
548
  * @summary Reset your password.
549
549
  */
550
- resetPassword(form: ResetPassword, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
550
+ resetPassword(form: ResetPassword, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
551
551
  /**
552
552
  * @summary Change your password from an email / token based reset.
553
553
  */
554
- changePasswordAfterReset(form: ChangePasswordAfterReset, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
554
+ changePasswordAfterReset(form: ChangePasswordAfterReset, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
555
555
  /**
556
556
  * @summary Mark all notifications as read.
557
557
  */
558
- markAllNotificationsAsRead(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
558
+ markAllNotificationsAsRead(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
559
559
  /**
560
560
  * @summary Mark a notification as read.
561
561
  */
562
- markNotificationAsRead(form: MarkNotificationAsRead, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
562
+ markNotificationAsRead(form: MarkNotificationAsRead, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
563
563
  /**
564
564
  * @summary Save your user settings.
565
565
  */
566
- saveUserSettings(form: SaveUserSettings, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
566
+ saveUserSettings(form: SaveUserSettings, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
567
567
  /**
568
568
  * @summary Change your user password.
569
569
  */
570
- changePassword(form: ChangePassword, options?: RequestOptions): Promise<RequestState<LoginResponse>>;
570
+ changePassword(form: ChangePassword, options?: RequestOptions): Promise<LoginResponse | import("./request_state").RequestState<LoginResponse> | undefined>;
571
571
  /**
572
572
  * @summary Get your inbox (replies, comment mentions, post mentions, and messages)
573
573
  */
574
- listNotifications(form: ListNotificationsI, options?: RequestOptions): Promise<RequestState<PagedResponse<NotificationView>>>;
574
+ listNotifications(form: ListNotificationsI, options?: RequestOptions): Promise<PagedResponse<NotificationView> | import("./request_state").RequestState<PagedResponse<NotificationView>> | undefined>;
575
575
  /**
576
576
  * @summary Verify your email
577
577
  */
578
- verifyEmail(form: VerifyEmail, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
578
+ verifyEmail(form: VerifyEmail, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
579
579
  /**
580
580
  * @summary Resend a verification email.
581
581
  */
582
- resendVerificationEmail(form: ResendVerificationEmail, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
582
+ resendVerificationEmail(form: ResendVerificationEmail, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
583
583
  /**
584
584
  * @summary List your saved content.
585
585
  */
586
- listPersonSaved(form: ListPersonSavedI, options?: RequestOptions): Promise<RequestState<PagedResponse<PostCommentCombinedView>>>;
586
+ listPersonSaved(form: ListPersonSavedI, options?: RequestOptions): Promise<PagedResponse<PostCommentCombinedView> | import("./request_state").RequestState<PagedResponse<PostCommentCombinedView>> | undefined>;
587
587
  /**
588
588
  * @summary List your read content.
589
589
  */
590
- listPersonRead(form: ListPersonReadI, options?: RequestOptions): Promise<RequestState<PagedResponse<PostView>>>;
590
+ listPersonRead(form: ListPersonReadI, options?: RequestOptions): Promise<PagedResponse<PostView> | import("./request_state").RequestState<PagedResponse<PostView>> | undefined>;
591
591
  /**
592
592
  * @summary List your hidden content.
593
593
  */
594
- listPersonHidden(form: ListPersonHiddenI, options?: RequestOptions): Promise<RequestState<PagedResponse<PostView>>>;
594
+ listPersonHidden(form: ListPersonHiddenI, options?: RequestOptions): Promise<PagedResponse<PostView> | import("./request_state").RequestState<PagedResponse<PostView>> | undefined>;
595
595
  /**
596
596
  * @summary List your liked content.
597
597
  */
598
- listPersonLiked(form: ListPersonLikedI, options?: RequestOptions): Promise<RequestState<PagedResponse<PostCommentCombinedView>>>;
598
+ listPersonLiked(form: ListPersonLikedI, options?: RequestOptions): Promise<PagedResponse<PostCommentCombinedView> | import("./request_state").RequestState<PagedResponse<PostCommentCombinedView>> | undefined>;
599
599
  /**
600
600
  * @summary Add an admin to your site.
601
601
  */
602
- addAdmin(form: AddAdmin, options?: RequestOptions): Promise<RequestState<AddAdminResponse>>;
602
+ addAdmin(form: AddAdmin, options?: RequestOptions): Promise<AddAdminResponse | import("./request_state").RequestState<AddAdminResponse> | undefined>;
603
603
  /**
604
604
  * @summary List the registration applications.
605
605
  */
606
- listRegistrationApplications(form: ListRegistrationApplicationsI, options?: RequestOptions): Promise<RequestState<PagedResponse<RegistrationApplicationView>>>;
606
+ listRegistrationApplications(form: ListRegistrationApplicationsI, options?: RequestOptions): Promise<PagedResponse<RegistrationApplicationView> | import("./request_state").RequestState<PagedResponse<RegistrationApplicationView>> | undefined>;
607
607
  /**
608
608
  * @summary Approve a registration application
609
609
  */
610
- approveRegistrationApplication(form: ApproveRegistrationApplication, options?: RequestOptions): Promise<RequestState<RegistrationApplicationResponse>>;
610
+ approveRegistrationApplication(form: ApproveRegistrationApplication, options?: RequestOptions): Promise<RegistrationApplicationResponse | import("./request_state").RequestState<RegistrationApplicationResponse> | undefined>;
611
611
  /**
612
612
  * @summary Get the application a user submitted when they first registered their account
613
613
  */
614
- getRegistrationApplication(form: GetRegistrationApplicationI, options?: RequestOptions): Promise<RequestState<RegistrationApplicationResponse>>;
614
+ getRegistrationApplication(form: GetRegistrationApplicationI, options?: RequestOptions): Promise<RegistrationApplicationResponse | import("./request_state").RequestState<RegistrationApplicationResponse> | undefined>;
615
615
  /**
616
616
  * @summary Purge / Delete a person from the database.
617
617
  */
618
- purgePerson(form: PurgePerson, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
618
+ purgePerson(form: PurgePerson, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
619
619
  /**
620
620
  * @summary Purge / Delete a community from the database.
621
621
  */
622
- purgeCommunity(form: PurgeCommunity, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
622
+ purgeCommunity(form: PurgeCommunity, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
623
623
  /**
624
624
  * @summary Purge / Delete a post from the database.
625
625
  */
626
- purgePost(form: PurgePost, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
626
+ purgePost(form: PurgePost, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
627
627
  /**
628
628
  * @summary Purge / Delete a comment from the database.
629
629
  */
630
- purgeComment(form: PurgeComment, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
630
+ purgeComment(form: PurgeComment, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
631
631
  /**
632
632
  * @summary Create a new custom emoji.
633
633
  */
634
- createCustomEmoji(form: CreateCustomEmoji, options?: RequestOptions): Promise<RequestState<CustomEmojiResponse>>;
634
+ createCustomEmoji(form: CreateCustomEmoji, options?: RequestOptions): Promise<CustomEmojiResponse | import("./request_state").RequestState<CustomEmojiResponse> | undefined>;
635
635
  /**
636
636
  * @summary Edit an existing custom emoji.
637
637
  */
638
- editCustomEmoji(form: EditCustomEmoji, options?: RequestOptions): Promise<RequestState<CustomEmojiResponse>>;
638
+ editCustomEmoji(form: EditCustomEmoji, options?: RequestOptions): Promise<CustomEmojiResponse | import("./request_state").RequestState<CustomEmojiResponse> | undefined>;
639
639
  /**
640
640
  * @summary Delete a custom emoji.
641
641
  */
642
- deleteCustomEmoji(form: DeleteCustomEmoji, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
642
+ deleteCustomEmoji(form: DeleteCustomEmoji, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
643
643
  /**
644
644
  * @summary List custom emojis
645
645
  */
646
- listCustomEmojis(form: ListCustomEmojisI, options?: RequestOptions): Promise<RequestState<ListCustomEmojisResponse>>;
646
+ listCustomEmojis(form: ListCustomEmojisI, options?: RequestOptions): Promise<ListCustomEmojisResponse | import("./request_state").RequestState<ListCustomEmojisResponse> | undefined>;
647
647
  /**
648
648
  * @summary Create a new tagline
649
649
  */
650
- createTagline(form: CreateTagline, options?: RequestOptions): Promise<RequestState<TaglineResponse>>;
650
+ createTagline(form: CreateTagline, options?: RequestOptions): Promise<TaglineResponse | import("./request_state").RequestState<TaglineResponse> | undefined>;
651
651
  /**
652
652
  * @summary Edit an existing tagline
653
653
  */
654
- editTagline(form: EditTagline, options?: RequestOptions): Promise<RequestState<TaglineResponse>>;
654
+ editTagline(form: EditTagline, options?: RequestOptions): Promise<TaglineResponse | import("./request_state").RequestState<TaglineResponse> | undefined>;
655
655
  /**
656
656
  * @summary Delete a tagline
657
657
  */
658
- deleteTagline(form: DeleteTagline, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
658
+ deleteTagline(form: DeleteTagline, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
659
659
  /**
660
660
  * @summary List taglines.
661
661
  */
662
- listTaglines(form: ListTaglinesI, options?: RequestOptions): Promise<RequestState<PagedResponse<Tagline>>>;
662
+ listTaglines(form: ListTaglinesI, options?: RequestOptions): Promise<PagedResponse<Tagline> | import("./request_state").RequestState<PagedResponse<Tagline>> | undefined>;
663
663
  /**
664
664
  * @summary Create a community post tag.
665
665
  */
666
- createCommunityTag(form: CreateCommunityTag, options?: RequestOptions): Promise<RequestState<CommunityTag>>;
666
+ createCommunityTag(form: CreateCommunityTag, options?: RequestOptions): Promise<CommunityTag | import("./request_state").RequestState<CommunityTag> | undefined>;
667
667
  /**
668
668
  * @summary Edit a community post tag.
669
669
  */
670
- editCommunityTag(form: EditCommunityTag, options?: RequestOptions): Promise<RequestState<CommunityTag>>;
670
+ editCommunityTag(form: EditCommunityTag, options?: RequestOptions): Promise<CommunityTag | import("./request_state").RequestState<CommunityTag> | undefined>;
671
671
  /**
672
672
  * @summary Delete a post tag in a community.
673
673
  */
674
- deleteCommunityTag(form: DeleteCommunityTag, options?: RequestOptions): Promise<RequestState<CommunityTag>>;
674
+ deleteCommunityTag(form: DeleteCommunityTag, options?: RequestOptions): Promise<CommunityTag | import("./request_state").RequestState<CommunityTag> | undefined>;
675
675
  /**
676
676
  * @summary Create a new oauth provider method
677
677
  */
678
- createOAuthProvider(form: CreateOAuthProvider, options?: RequestOptions): Promise<RequestState<AdminOAuthProvider>>;
678
+ createOAuthProvider(form: CreateOAuthProvider, options?: RequestOptions): Promise<AdminOAuthProvider | import("./request_state").RequestState<AdminOAuthProvider> | undefined>;
679
679
  /**
680
680
  * @summary Edit an existing oauth provider method
681
681
  */
682
- editOAuthProvider(form: EditOAuthProvider, options?: RequestOptions): Promise<RequestState<AdminOAuthProvider>>;
682
+ editOAuthProvider(form: EditOAuthProvider, options?: RequestOptions): Promise<AdminOAuthProvider | import("./request_state").RequestState<AdminOAuthProvider> | undefined>;
683
683
  /**
684
684
  * @summary Delete an oauth provider method
685
685
  */
686
- deleteOAuthProvider(form: DeleteOAuthProvider, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
686
+ deleteOAuthProvider(form: DeleteOAuthProvider, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
687
687
  /**
688
688
  * @summary Authenticate with OAuth
689
689
  */
690
- authenticateWithOAuth(form: AuthenticateWithOauth, options?: RequestOptions): Promise<RequestState<LoginResponse>>;
690
+ authenticateWithOAuth(form: AuthenticateWithOauth, options?: RequestOptions): Promise<LoginResponse | import("./request_state").RequestState<LoginResponse> | undefined>;
691
691
  /**
692
692
  * @summary Fetch federated instances.
693
693
  */
694
- getFederatedInstances(form: GetFederatedInstancesI, options?: RequestOptions): Promise<RequestState<PagedResponse<FederatedInstanceView>>>;
694
+ getFederatedInstances(form: GetFederatedInstancesI, options?: RequestOptions): Promise<PagedResponse<FederatedInstanceView> | import("./request_state").RequestState<PagedResponse<FederatedInstanceView>> | undefined>;
695
695
  /**
696
696
  * @summary List user reports.
697
697
  */
698
- listReports(form: ListReportsI, options?: RequestOptions): Promise<RequestState<PagedResponse<ReportCombinedView>>>;
698
+ listReports(form: ListReportsI, options?: RequestOptions): Promise<PagedResponse<ReportCombinedView> | import("./request_state").RequestState<PagedResponse<ReportCombinedView>> | undefined>;
699
699
  /**
700
700
  * @summary Block an instance's communities as a user.
701
701
  */
702
- userBlockInstanceCommunities(form: UserBlockInstanceCommunitiesParams, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
702
+ userBlockInstanceCommunities(form: UserBlockInstanceCommunitiesParams, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
703
703
  /**
704
704
  * @summary Block an instance's persons as a user.
705
705
  */
706
- userBlockInstancePersons(form: UserBlockInstancePersonsParams, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
706
+ userBlockInstancePersons(form: UserBlockInstancePersonsParams, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
707
707
  /**
708
708
  * @summary Globally block an instance as admin.
709
709
  */
710
- adminBlockInstance(form: AdminBlockInstanceParams, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
710
+ adminBlockInstance(form: AdminBlockInstanceParams, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
711
711
  /**
712
712
  * @summary Globally allow an instance as admin.
713
713
  */
714
- adminAllowInstance(form: AdminAllowInstanceParams, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
714
+ adminAllowInstance(form: AdminAllowInstanceParams, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
715
715
  /**
716
716
  * @summary Upload new user avatar.
717
717
  */
718
- uploadUserAvatar(image: UploadImage, options?: RequestOptions): Promise<RequestState<UploadImageResponse>>;
718
+ uploadUserAvatar(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse | import("./request_state").RequestState<UploadImageResponse> | undefined>;
719
719
  /**
720
720
  * @summary Delete the user avatar.
721
721
  */
722
- deleteUserAvatar(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
722
+ deleteUserAvatar(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
723
723
  /**
724
724
  * @summary Upload new user banner.
725
725
  */
726
- uploadUserBanner(image: UploadImage, options?: RequestOptions): Promise<RequestState<UploadImageResponse>>;
726
+ uploadUserBanner(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse | import("./request_state").RequestState<UploadImageResponse> | undefined>;
727
727
  /**
728
728
  * @summary Delete the user banner.
729
729
  */
730
- deleteUserBanner(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
730
+ deleteUserBanner(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
731
731
  /**
732
732
  * @summary Upload new community icon.
733
733
  */
734
- uploadCommunityIcon(query: CommunityIdQueryI, image: UploadImage, options?: RequestOptions): Promise<RequestState<UploadImageResponse>>;
734
+ uploadCommunityIcon(query: CommunityIdQueryI, image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse | import("./request_state").RequestState<UploadImageResponse> | undefined>;
735
735
  /**
736
736
  * @summary Delete the community icon.
737
737
  */
738
- deleteCommunityIcon(form: CommunityIdQuery, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
738
+ deleteCommunityIcon(form: CommunityIdQuery, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
739
739
  /**
740
740
  * @summary Upload new community banner.
741
741
  */
742
- uploadCommunityBanner(query: CommunityIdQueryI, image: UploadImage, options?: RequestOptions): Promise<RequestState<UploadImageResponse>>;
742
+ uploadCommunityBanner(query: CommunityIdQueryI, image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse | import("./request_state").RequestState<UploadImageResponse> | undefined>;
743
743
  /**
744
744
  * @summary Delete the community banner.
745
745
  */
746
- deleteCommunityBanner(form: CommunityIdQuery, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
746
+ deleteCommunityBanner(form: CommunityIdQuery, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
747
747
  /**
748
748
  * @summary Upload new site icon.
749
749
  */
750
- uploadSiteIcon(image: UploadImage, options?: RequestOptions): Promise<RequestState<UploadImageResponse>>;
750
+ uploadSiteIcon(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse | import("./request_state").RequestState<UploadImageResponse> | undefined>;
751
751
  /**
752
752
  * @summary Delete the site icon.
753
753
  */
754
- deleteSiteIcon(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
754
+ deleteSiteIcon(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
755
755
  /**
756
756
  * @summary Upload new site banner.
757
757
  */
758
- uploadSiteBanner(image: UploadImage, options?: RequestOptions): Promise<RequestState<UploadImageResponse>>;
758
+ uploadSiteBanner(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse | import("./request_state").RequestState<UploadImageResponse> | undefined>;
759
759
  /**
760
760
  * @summary Delete the site banner.
761
761
  */
762
- deleteSiteBanner(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
762
+ deleteSiteBanner(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
763
763
  /**
764
764
  * @summary Upload an image to the server.
765
765
  */
766
- uploadImage(image: UploadImage, options?: RequestOptions): Promise<RequestState<UploadImageResponse>>;
766
+ uploadImage(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse | import("./request_state").RequestState<UploadImageResponse> | undefined>;
767
767
  /**
768
768
  * @summary Health check for image functionality
769
769
  */
770
- imageHealth(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
770
+ imageHealth(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
771
771
  /**
772
772
  * Mark the donation dialog as shown, so it isn't displayed anymore.
773
773
  */
774
- markDonationDialogShown(options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
775
- createMultiCommunity(form: CreateMultiCommunity, options?: RequestOptions): Promise<RequestState<MultiCommunityResponse>>;
776
- editMultiCommunity(form: EditMultiCommunity, options?: RequestOptions): Promise<RequestState<MultiCommunityResponse>>;
777
- getMultiCommunity(form: GetMultiCommunityI, options?: RequestOptions): Promise<RequestState<GetMultiCommunityResponse>>;
778
- createMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<RequestState<CommunityResponse>>;
779
- deleteMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
780
- listMultiCommunities(form: ListMultiCommunitiesI, options?: RequestOptions): Promise<RequestState<PagedResponse<MultiCommunityView>>>;
781
- followMultiCommunity(form: FollowMultiCommunity, options?: RequestOptions): Promise<RequestState<MultiCommunityResponse>>;
774
+ markDonationDialogShown(options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
775
+ createMultiCommunity(form: CreateMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse | import("./request_state").RequestState<MultiCommunityResponse> | undefined>;
776
+ editMultiCommunity(form: EditMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse | import("./request_state").RequestState<MultiCommunityResponse> | undefined>;
777
+ getMultiCommunity(form: GetMultiCommunityI, options?: RequestOptions): Promise<GetMultiCommunityResponse | import("./request_state").RequestState<GetMultiCommunityResponse> | undefined>;
778
+ createMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<CommunityResponse | import("./request_state").RequestState<CommunityResponse> | undefined>;
779
+ deleteMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
780
+ listMultiCommunities(form: ListMultiCommunitiesI, options?: RequestOptions): Promise<PagedResponse<MultiCommunityView> | import("./request_state").RequestState<PagedResponse<MultiCommunityView>> | undefined>;
781
+ followMultiCommunity(form: FollowMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse | import("./request_state").RequestState<MultiCommunityResponse> | undefined>;
782
782
  /**
783
783
  * @summary Change notification settings for a community
784
784
  */
785
- editCommunityNotifications(form: EditCommunityNotifications, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
785
+ editCommunityNotifications(form: EditCommunityNotifications, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
786
786
  /**
787
787
  * @summary Change notification settings for a post
788
788
  */
789
- editPostNotifications(form: EditPostNotifications, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
789
+ editPostNotifications(form: EditPostNotifications, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
790
790
  /**
791
791
  * @summary Create a new registration invitation
792
792
  */
793
- createRegistrationInvitation(form: CreateInvitation, options?: RequestOptions): Promise<RequestState<CreateInvitationResponse>>;
793
+ createRegistrationInvitation(form: CreateInvitation, options?: RequestOptions): Promise<CreateInvitationResponse | import("./request_state").RequestState<CreateInvitationResponse> | undefined>;
794
794
  /**
795
795
  * @summary Revoke a previously created registration invitation
796
796
  */
797
- revokeRegistrationInvitation(form: RevokeInvitation, options?: RequestOptions): Promise<RequestState<SuccessResponse>>;
797
+ revokeRegistrationInvitation(form: RevokeInvitation, options?: RequestOptions): Promise<SuccessResponse | import("./request_state").RequestState<SuccessResponse> | undefined>;
798
798
  /**
799
799
  * @summary Revoke a previously created registration invitation
800
800
  */
801
- listRegistrationInvitations(form: ListInvitationsI, options?: RequestOptions): Promise<RequestState<PagedResponse<LocalUserInvite>>>;
801
+ listRegistrationInvitations(form: ListInvitationsI, options?: RequestOptions): Promise<PagedResponse<LocalUserInvite> | import("./request_state").RequestState<PagedResponse<LocalUserInvite>> | undefined>;
802
802
  }
803
803
  export declare class NodeInfoHttp extends LemmyController {
804
804
  /**
805
805
  * @summary Metadata for the instance
806
806
  */
807
- nodeinfo(options?: RequestOptions): Promise<RequestState<NodeInfo>>;
807
+ nodeinfo(options?: RequestOptions): Promise<NodeInfo | import("./request_state").RequestState<NodeInfo> | undefined>;
808
808
  }
809
809
  /**
810
810
  * A Lemmy error type.
package/dist/http.js CHANGED
@@ -19,12 +19,12 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
19
19
  if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
20
20
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
21
21
  };
22
- var _LemmyController_instances, _LemmyController_apiUrl, _LemmyController_headers, _LemmyController_fetchFunction, _LemmyController_buildFullUrl;
22
+ var _LemmyController_instances, _LemmyController_apiUrl, _LemmyController_headers, _LemmyController_fetchFunction, _LemmyController_useRequestState, _LemmyController_buildFullUrl;
23
23
  Object.defineProperty(exports, "__esModule", { value: true });
24
24
  exports.LemmyError = exports.NodeInfoHttp = exports.LemmyHttp = void 0;
25
25
  const runtime_1 = require("@tsoa/runtime");
26
26
  const other_types_1 = require("./other_types");
27
- const request_state_1 = require("./request_state");
27
+ const map_request_state_1 = require("./map_request_state");
28
28
  var HttpType;
29
29
  (function (HttpType) {
30
30
  HttpType["Get"] = "GET";
@@ -44,6 +44,7 @@ class LemmyController extends runtime_1.Controller {
44
44
  _LemmyController_apiUrl.set(this, void 0);
45
45
  _LemmyController_headers.set(this, {});
46
46
  _LemmyController_fetchFunction.set(this, fetch.bind(globalThis));
47
+ _LemmyController_useRequestState.set(this, false);
47
48
  __classPrivateFieldSet(this, _LemmyController_apiUrl, `${baseUrl.replace(/\/+$/, "")}/api/${other_types_1.VERSION}`, "f");
48
49
  if (options?.headers) {
49
50
  __classPrivateFieldSet(this, _LemmyController_headers, options.headers, "f");
@@ -51,6 +52,9 @@ class LemmyController extends runtime_1.Controller {
51
52
  if (options?.fetchFunction) {
52
53
  __classPrivateFieldSet(this, _LemmyController_fetchFunction, options.fetchFunction, "f");
53
54
  }
55
+ if (options?.useRequestState) {
56
+ __classPrivateFieldSet(this, _LemmyController_useRequestState, options.useRequestState, "f");
57
+ }
54
58
  }
55
59
  async upload(path, { image }, options) {
56
60
  let error;
@@ -77,16 +81,16 @@ class LemmyController extends runtime_1.Controller {
77
81
  // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
78
82
  error = err instanceof Error ? err : new Error("" + err);
79
83
  }
80
- return (0, request_state_1.mapToRequestState)(result, error);
84
+ return (0, map_request_state_1.mapToRequestState)(__classPrivateFieldGet(this, _LemmyController_useRequestState, "f"), result, error);
81
85
  }
82
86
  async uploadWithQuery(path, query, { image }, options) {
83
87
  return this.upload(`${path}?${encodeGetParams(query)}`, { image }, options);
84
88
  }
85
- async wrapper(type_, endpoint, form, options, no_prefix = false) {
89
+ async wrapper(type_, endpoint, form, options, noPrefix = false) {
86
90
  let error;
87
91
  let result;
88
92
  try {
89
- const url = no_prefix ? endpoint : __classPrivateFieldGet(this, _LemmyController_instances, "m", _LemmyController_buildFullUrl).call(this, endpoint);
93
+ const url = noPrefix ? endpoint : __classPrivateFieldGet(this, _LemmyController_instances, "m", _LemmyController_buildFullUrl).call(this, endpoint);
90
94
  let response;
91
95
  if (type_ === HttpType.Get) {
92
96
  const getUrl = `${url}?${encodeGetParams(form)}`;
@@ -128,7 +132,7 @@ class LemmyController extends runtime_1.Controller {
128
132
  // eslint-disable-next-line @typescript-eslint/restrict-plus-operands
129
133
  error = err instanceof Error ? err : new Error("" + err);
130
134
  }
131
- return (0, request_state_1.mapToRequestState)(result, error);
135
+ return (0, map_request_state_1.mapToRequestState)(__classPrivateFieldGet(this, _LemmyController_useRequestState, "f"), result, error);
132
136
  }
133
137
  /**
134
138
  * Set the headers (can be used to set the auth header)
@@ -137,7 +141,7 @@ class LemmyController extends runtime_1.Controller {
137
141
  __classPrivateFieldSet(this, _LemmyController_headers, headers, "f");
138
142
  }
139
143
  }
140
- _LemmyController_apiUrl = new WeakMap(), _LemmyController_headers = new WeakMap(), _LemmyController_fetchFunction = new WeakMap(), _LemmyController_instances = new WeakSet(), _LemmyController_buildFullUrl = function _LemmyController_buildFullUrl(endpoint) {
144
+ _LemmyController_apiUrl = new WeakMap(), _LemmyController_headers = new WeakMap(), _LemmyController_fetchFunction = new WeakMap(), _LemmyController_useRequestState = new WeakMap(), _LemmyController_instances = new WeakSet(), _LemmyController_buildFullUrl = function _LemmyController_buildFullUrl(endpoint) {
141
145
  return `${__classPrivateFieldGet(this, _LemmyController_apiUrl, "f")}${endpoint}`;
142
146
  };
143
147
  /**
@@ -0,0 +1,2 @@
1
+ import { RequestState } from "./request_state";
2
+ export declare function mapToRequestState<ResultT>(useRequestState: boolean, result?: ResultT, error?: Error): RequestState<ResultT> | ResultT | undefined;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.mapToRequestState = mapToRequestState;
4
+ function mapToRequestState(useRequestState, result, error) {
5
+ if (!useRequestState) {
6
+ return result;
7
+ }
8
+ if (error) {
9
+ return { state: "failed", err: error };
10
+ }
11
+ if (result !== undefined) {
12
+ return { state: "success", data: result };
13
+ }
14
+ return { state: "empty" };
15
+ }
@@ -0,0 +1,2 @@
1
+ import { RequestState } from "./request_state";
2
+ export declare function mapToRequestState<ResultT>(useRequestState: boolean, result?: ResultT, error?: Error): RequestState<ResultT> | ResultT | undefined;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.mapToRequestState = mapToRequestState;
4
+ function mapToRequestState(useRequestState, result, error) {
5
+ if (!useRequestState) {
6
+ return result;
7
+ }
8
+ if (error) {
9
+ return { state: "failed", err: error };
10
+ }
11
+ if (result !== undefined) {
12
+ return { state: "success", data: result };
13
+ }
14
+ return { state: "empty" };
15
+ }
@@ -0,0 +1 @@
1
+ export declare function mapToRequestState<ResultT>(_useRequestState: boolean, result?: ResultT, _error?: Error): ResultT | undefined;
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.mapToRequestState = mapToRequestState;
4
+ // Does not return `RequestState<ResultT>` so that it doesnt become part of OpenAPI spec.
5
+ function mapToRequestState(_useRequestState, result, _error) {
6
+ return result;
7
+ }
@@ -24,4 +24,3 @@ export type SuccessRequestState<T> = {
24
24
  * Can be empty, loading, failed, or success
25
25
  */
26
26
  export type RequestState<T> = EmptyRequestState | LoadingRequestState | FailedRequestState | SuccessRequestState<T>;
27
- export declare function mapToRequestState<ResultT>(result?: ResultT, error?: Error): RequestState<ResultT>;
@@ -1,15 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.LOADING_REQUEST = exports.EMPTY_REQUEST = void 0;
4
- exports.mapToRequestState = mapToRequestState;
5
4
  exports.EMPTY_REQUEST = { state: "empty" };
6
5
  exports.LOADING_REQUEST = { state: "loading" };
7
- function mapToRequestState(result, error) {
8
- if (error) {
9
- return { state: "failed", err: error };
10
- }
11
- if (result !== undefined) {
12
- return { state: "success", data: result };
13
- }
14
- return { state: "empty" };
15
- }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "lemmy-js-client",
3
3
  "description": "A javascript / typescript client for Lemmy",
4
- "version": "1.0.0-split-hide-media.0",
4
+ "version": "1.0.0-split-hide-media.1",
5
5
  "author": "Dessalines",
6
6
  "license": "AGPL-3.0",
7
7
  "main": "./dist/index.js",
@@ -13,7 +13,7 @@
13
13
  "docs": "typedoc src/index.ts",
14
14
  "lint": "tsc --noEmit && eslint --report-unused-disable-directives && prettier --check src",
15
15
  "prepare": "pnpm run build && husky",
16
- "tsoa": "tsoa spec-and-routes && tsc && redocly build-docs tsoa_build/swagger.json"
16
+ "tsoa": "./scripts/tsoa.sh"
17
17
  },
18
18
  "repository": {
19
19
  "type": "git",