lemmy-js-client 1.0.0-post-tags.0 → 1.0.0-post-notifications.1

package/README.md

@@ -50,6 +50,15 @@ const posts = await client.getPosts(getPostsForm);
 
 Use `pnpm add` to develop and test changes locally:
 
-```
-pnpm add path/to/lemmy-js-client
-```
+`pnpm add path/to/lemmy-js-client`
+
+## OpenAPI
+
+To generate OpenAPI docs, run `pnpm tsoa`
+
+This creates two files:
+
+- `redoc-static.html` - A static html rendering of the OpenAPI docs.
+- `tsoa_build/swagger.json` - An OpenAPI / Swagger json file.
+
+To contribute, check out the [tsoa docs](https://tsoa-community.github.io/docs/).

package/dist/http.d.ts

@@ -1,3 +1,5 @@
+import { Controller } from "@tsoa/runtime";
+import { AdminListUsersI, CommunityIdQueryI, DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetMultiCommunityI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListInboxI, ListMediaI, ListMultiCommunitiesI, ListPersonContentI, ListPersonHiddenI, ListPersonLikedI, ListPersonReadI, ListPersonSavedI, ListPostLikesI, ListRegistrationApplicationsI, ListReportsI, ListTaglinesI, ResolveObjectI, SearchI, UploadImage } from "./other_types";
 import { AddAdmin } from "./types/AddAdmin";
 import { AddAdminResponse } from "./types/AddAdminResponse";
 import { AddModToCommunity } from "./types/AddModToCommunity";
@@ -8,7 +10,6 @@ import { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
 import { MarkManyPostsAsRead } from "./types/MarkManyPostsAsRead";
 import { BanPerson } from "./types/BanPerson";
 import { BanPersonResponse } from "./types/BanPersonResponse";
-import { BannedPersonsResponse } from "./types/BannedPersonsResponse";
 import { BlockCommunity } from "./types/BlockCommunity";
 import { BlockCommunityResponse } from "./types/BlockCommunityResponse";
 import { BlockPerson } from "./types/BlockPerson";
@@ -16,11 +17,13 @@ import { BlockPersonResponse } from "./types/BlockPersonResponse";
 import { ChangePassword } from "./types/ChangePassword";
 import { CommentReportResponse } from "./types/CommentReportResponse";
 import { CommentResponse } from "./types/CommentResponse";
+import { CommunityReportResponse } from "./types/CommunityReportResponse";
 import { CommunityResponse } from "./types/CommunityResponse";
 import { CreateComment } from "./types/CreateComment";
 import { CreateCommentLike } from "./types/CreateCommentLike";
 import { CreateCommentReport } from "./types/CreateCommentReport";
 import { CreateCommunity } from "./types/CreateCommunity";
+import { CreateCommunityReport } from "./types/CreateCommunityReport";
 import { CreateCommunityTag } from "./types/CreateCommunityTag";
 import { CreateCustomEmoji } from "./types/CreateCustomEmoji";
 import { CreateOAuthProvider } from "./types/CreateOAuthProvider";
@@ -64,13 +67,10 @@ import { GetSiteResponse } from "./types/GetSiteResponse";
 import { GetUnreadCountResponse } from "./types/GetUnreadCountResponse";
 import { GetUnreadRegistrationApplicationCountResponse } from "./types/GetUnreadRegistrationApplicationCountResponse";
 import { ListCommunitiesResponse } from "./types/ListCommunitiesResponse";
-import { ListCommunityTags } from "./types/ListCommunityTags";
-import { ListCommunityTagsResponse } from "./types/ListCommunityTagsResponse";
 import { ListRegistrationApplicationsResponse } from "./types/ListRegistrationApplicationsResponse";
 import { LockPost } from "./types/LockPost";
 import { Login } from "./types/Login";
 import { LoginResponse } from "./types/LoginResponse";
-import { MarkCommentReplyAsRead } from "./types/MarkCommentReplyAsRead";
 import { MarkPostAsRead } from "./types/MarkPostAsRead";
 import { MarkPrivateMessageAsRead } from "./types/MarkPrivateMessageAsRead";
 import { PasswordChangeAfterReset } from "./types/PasswordChangeAfterReset";
@@ -89,7 +89,7 @@ import { RemoveComment } from "./types/RemoveComment";
 import { RemoveCommunity } from "./types/RemoveCommunity";
 import { RemovePost } from "./types/RemovePost";
 import { ResolveCommentReport } from "./types/ResolveCommentReport";
-import { ResolveObjectResponse } from "./types/ResolveObjectResponse";
+import { ResolveCommunityReport } from "./types/ResolveCommunityReport";
 import { ResolvePostReport } from "./types/ResolvePostReport";
 import { ResolvePrivateMessageReport } from "./types/ResolvePrivateMessageReport";
 import { SaveComment } from "./types/SaveComment";
@@ -99,15 +99,12 @@ import { SearchResponse } from "./types/SearchResponse";
 import { SiteResponse } from "./types/SiteResponse";
 import { TransferCommunity } from "./types/TransferCommunity";
 import { UpdateCommunityTag } from "./types/UpdateCommunityTag";
-import { UpdatePostTags } from "./types/UpdatePostTags";
 import { VerifyEmail } from "./types/VerifyEmail";
-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";
 import { HideCommunity } from "./types/HideCommunity";
 import { GenerateTotpSecretResponse } from "./types/GenerateTotpSecretResponse";
 import { UpdateTotp } from "./types/UpdateTotp";
 import { UpdateTotpResponse } from "./types/UpdateTotpResponse";
 import { SuccessResponse } from "./types/SuccessResponse";
-import { LoginToken } from "./types/LoginToken";
 import { ListPostLikesResponse } from "./types/ListPostLikesResponse";
 import { ListCommentLikesResponse } from "./types/ListCommentLikesResponse";
 import { HidePost } from "./types/HidePost";
@@ -131,11 +128,22 @@ import { ListPersonContentResponse } from "./types/ListPersonContentResponse";
 import { ListPersonSavedResponse } from "./types/ListPersonSavedResponse";
 import { UploadImageResponse } from "./types/UploadImageResponse";
 import { ListInboxResponse } from "./types/ListInboxResponse";
-import { MarkPersonCommentMentionAsRead } from "./types/MarkPersonCommentMentionAsRead";
-import { MarkPersonPostMentionAsRead } from "./types/MarkPersonPostMentionAsRead";
 import { GetCommentsSlimResponse } from "./types/GetCommentsSlimResponse";
-import { Controller } from "tsoa";
-import { CommunityTagResponse } from "./types/CommunityTagResponse";
+import { Tag } from "./types/Tag";
+import { ResendVerificationEmail } from "./types/ResendVerificationEmail";
+import { ListPersonReadResponse } from "./types/ListPersonReadResponse";
+import { ListPersonHiddenResponse } from "./types/ListPersonHiddenResponse";
+import { CommunityIdQuery } from "./types/CommunityIdQuery";
+import { CreateMultiCommunity } from "./types/CreateMultiCommunity";
+import { UpdateMultiCommunity } from "./types/UpdateMultiCommunity";
+import { ListMultiCommunitiesResponse } from "./types/ListMultiCommunitiesResponse";
+import { AdminListUsersResponse } from "./types/AdminListUsersResponse";
+import { CreateOrDeleteMultiCommunityEntry } from "./types/CreateOrDeleteMultiCommunityEntry";
+import { GetMultiCommunityResponse } from "./types/GetMultiCommunityResponse";
+import { FollowMultiCommunity } from "./types/FollowMultiCommunity";
+import { ListLoginsResponse } from "./types/ListLoginsResponse";
+import { ListPersonLikedResponse } from "./types/ListPersonLikedResponse";
+import { MarkNotificationAsRead } from "./types/MarkNotificationAsRead";
 type RequestOptions = Pick<RequestInit, "signal">;
 /**
  * Helps build lemmy HTTP requests.
@@ -194,19 +202,27 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary List login tokens for your user
      */
-    listLogins(options?: RequestOptions): Promise<LoginToken[]>;
+    listLogins(options?: RequestOptions): Promise<ListLoginsResponse>;
     /**
      * @summary Returns an error message if your auth token is invalid
      */
     validateAuth(options?: RequestOptions): Promise<SuccessResponse>;
     /**
-     * @summary List all the media for your user
+     * @summary List all the media for your account.
      */
     listMedia(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
+    /**
+     * @summary Delete media for your account.
+     */
+    deleteMedia(form: DeleteImageParamsI, options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * @summary Delete any media. (Admin only)
+     */
+    deleteMediaAdmin(form: DeleteImageParamsI, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary List all the media known to your instance.
      */
-    listAllMedia(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
+    listMediaAdmin(form?: ListMediaI, options?: RequestOptions): Promise<ListMediaResponse>;
     /**
      * @summary Enable / Disable TOTP / two-factor authentication.
      *
@@ -220,13 +236,13 @@ export declare class LemmyHttp extends Controller {
      */
     getModlog(form?: GetModlogI, options?: RequestOptions): Promise<GetModlogResponse>;
     /**
-     * @summary Search lemmy.
+     * @summary Search lemmy. If `search_term` is a url it also attempts to fetch it, just like `resolve_object`.
      */
     search(form: SearchI, options?: RequestOptions): Promise<SearchResponse>;
     /**
      * @summary Fetch a non-local / federated object.
      */
-    resolveObject(form: ResolveObjectI, options?: RequestOptions): Promise<ResolveObjectResponse>;
+    resolveObject(form: ResolveObjectI, options?: RequestOptions): Promise<SearchResponse>;
     /**
      * @summary Create a new community.
      */
@@ -291,6 +307,14 @@ export declare class LemmyHttp extends Controller {
      * @summary Get a random community.
      */
     getRandomCommunity(form: GetRandomCommunityI, options?: RequestOptions): Promise<CommunityResponse>;
+    /**
+     * @summary Create a report for a community.
+     */
+    createCommunityReport(form: CreateCommunityReport, options?: RequestOptions): Promise<CommunityReportResponse>;
+    /**
+     * @summary Resolve a report for a private message.
+     */
+    resolveCommunityReport(form: ResolveCommunityReport, options?: RequestOptions): Promise<CommunityReportResponse>;
     /**
      * @summary Create a post.
      */
@@ -314,7 +338,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Mark a post as read.
      */
-    markPostAsRead(form: MarkPostAsRead, options?: RequestOptions): Promise<SuccessResponse>;
+    markPostAsRead(form: MarkPostAsRead, options?: RequestOptions): Promise<PostResponse>;
     /**
      * @summary Mark multiple posts as read.
      */
@@ -375,10 +399,6 @@ export declare class LemmyHttp extends Controller {
      * @summary A moderator remove for a comment.
      */
     removeComment(form: RemoveComment, options?: RequestOptions): Promise<CommentResponse>;
-    /**
-     * @summary Mark a comment as read.
-     */
-    markCommentReplyAsRead(form: MarkCommentReplyAsRead, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Like / vote on a comment.
      */
@@ -430,7 +450,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Mark a private message as read.
      */
-    markPrivateMessageAsRead(form: MarkPrivateMessageAsRead, options?: RequestOptions): Promise<PrivateMessageResponse>;
+    markPrivateMessageAsRead(form: MarkPrivateMessageAsRead, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Create a report for a private message.
      */
@@ -459,22 +479,14 @@ export declare class LemmyHttp extends Controller {
      * @summary List the content for a person.
      */
     listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<ListPersonContentResponse>;
-    /**
-     * @summary Mark a person mention as read.
-     */
-    markCommentMentionAsRead(form: MarkPersonCommentMentionAsRead, options?: RequestOptions): Promise<SuccessResponse>;
-    /**
-     * @summary Mark a person post body mention as read.
-     */
-    markPostMentionAsRead(form: MarkPersonPostMentionAsRead, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Ban a person from your site.
      */
     banPerson(form: BanPerson, options?: RequestOptions): Promise<BanPersonResponse>;
     /**
-     * @summary Get a list of banned users.
+     * @summary Get a list of users.
      */
-    getBannedPersons(options?: RequestOptions): Promise<BannedPersonsResponse>;
+    listUsers(form?: AdminListUsersI, options?: RequestOptions): Promise<AdminListUsersResponse>;
     /**
      * @summary Block a person.
      */
@@ -499,6 +511,10 @@ export declare class LemmyHttp extends Controller {
      * @summary Mark all replies as read.
      */
     markAllNotificationsAsRead(options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * @summary Mark a comment as read.
+     */
+    markNotificationAsRead(form: MarkNotificationAsRead, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Save your user settings.
      */
@@ -523,10 +539,26 @@ export declare class LemmyHttp extends Controller {
      * @summary Verify your email
      */
     verifyEmail(form: VerifyEmail, options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * @summary Resend a verification email.
+     */
+    resendVerificationEmail(form: ResendVerificationEmail, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary List your saved content.
      */
     listPersonSaved(form: ListPersonSavedI, options?: RequestOptions): Promise<ListPersonSavedResponse>;
+    /**
+     * @summary List your read content.
+     */
+    listPersonRead(form: ListPersonReadI, options?: RequestOptions): Promise<ListPersonReadResponse>;
+    /**
+     * @summary List your hidden content.
+     */
+    listPersonHidden(form: ListPersonHiddenI, options?: RequestOptions): Promise<ListPersonHiddenResponse>;
+    /**
+     * @summary List your liked content.
+     */
+    listPersonLiked(form: ListPersonLikedI, options?: RequestOptions): Promise<ListPersonLikedResponse>;
     /**
      * @summary Add an admin to your site.
      */
@@ -596,25 +628,17 @@ export declare class LemmyHttp extends Controller {
      */
     listTaglines(form: ListTaglinesI, options?: RequestOptions): Promise<ListTaglinesResponse>;
     /**
-     * @summary Create a community tag.
-     */
-    createCommunityTag(form: CreateCommunityTag, options?: RequestOptions): Promise<CommunityTagResponse>;
-    /**
-     * @summary Update a community tag.
+     * @summary Create a community post tag.
      */
-    updateCommunityTag(form: UpdateCommunityTag, options?: RequestOptions): Promise<CommunityTagResponse>;
+    createCommunityTag(form: CreateCommunityTag, options?: RequestOptions): Promise<Tag>;
     /**
-     * @summary List community tags.
+     * @summary Update a community post tag.
      */
-    listCommunityTags(form: ListCommunityTags, options?: RequestOptions): Promise<ListCommunityTagsResponse>;
+    updateCommunityTag(form: UpdateCommunityTag, options?: RequestOptions): Promise<Tag>;
     /**
-     * @summary Delete a community tag.
+     * @summary Delete a post tag in a community.
      */
-    deleteCommunityTag(form: DeleteCommunityTag, options?: RequestOptions): Promise<CommunityTagResponse>;
-    /**
-     * @summary Update post tags.
-     */
-    updatePostTags(form: UpdatePostTags, options?: RequestOptions): Promise<PostResponse>;
+    deleteCommunityTag(form: DeleteCommunityTag, options?: RequestOptions): Promise<Tag>;
     /**
      * @summary Create a new oauth provider method
      */
@@ -654,7 +678,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Upload new user avatar.
      */
-    uploadUserAvatar(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
+    uploadUserAvatar(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
     /**
      * @summary Delete the user avatar.
      */
@@ -662,7 +686,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Upload new user banner.
      */
-    uploadUserBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
+    uploadUserBanner(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
     /**
      * @summary Delete the user banner.
      */
@@ -670,23 +694,23 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Upload new community icon.
      */
-    uploadCommunityIcon(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
+    uploadCommunityIcon(query: CommunityIdQueryI, image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
     /**
      * @summary Delete the community icon.
      */
-    deleteCommunityIcon(options?: RequestOptions): Promise<SuccessResponse>;
+    deleteCommunityIcon(form: CommunityIdQuery, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Upload new community banner.
      */
-    uploadCommunityBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
+    uploadCommunityBanner(query: CommunityIdQueryI, image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
     /**
      * @summary Delete the community banner.
      */
-    deleteCommunityBanner(options?: RequestOptions): Promise<SuccessResponse>;
+    deleteCommunityBanner(form: CommunityIdQuery, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Upload new site icon.
      */
-    uploadSiteIcon(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
+    uploadSiteIcon(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
     /**
      * @summary Delete the site icon.
      */
@@ -694,7 +718,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Upload new site banner.
      */
-    uploadSiteBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
+    uploadSiteBanner(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
     /**
      * @summary Delete the site banner.
      */
@@ -703,14 +727,21 @@ export declare class LemmyHttp extends Controller {
      * @summary Upload an image to the server.
      */
     uploadImage(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
-    /**
-     * @summary Delete a pictrs image
-     */
-    deleteImage(form: DeleteImageParamsI, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Health check for image functionality
      */
     imageHealth(options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * Mark donation dialog as shown, so it isn't displayed anymore.
+     */
+    donationDialogShown(options?: RequestOptions): Promise<SuccessResponse>;
+    createMultiCommunity(form: CreateMultiCommunity, options?: RequestOptions): Promise<GetMultiCommunityResponse>;
+    updateMultiCommunity(form: UpdateMultiCommunity, options?: RequestOptions): Promise<SuccessResponse>;
+    getMultiCommunity(form: GetMultiCommunityI, options?: RequestOptions): Promise<GetMultiCommunityResponse>;
+    createMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<SuccessResponse>;
+    deleteMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<SuccessResponse>;
+    listMultiCommunities(form: ListMultiCommunitiesI, options?: RequestOptions): Promise<ListMultiCommunitiesResponse>;
+    followMultiCommunity(form: FollowMultiCommunity, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * Set the headers (can be used to set the auth header)
      */
@@ -718,4 +749,13 @@ export declare class LemmyHttp extends Controller {
         [key: string]: string;
     }): void;
 }
+/**
+ * A Lemmy error type.
+ *
+ * The name is the i18n translatable error code.
+ * The msg is either an empty string, or extra non-translatable info.
+ */
+export declare class LemmyError extends Error {
+    constructor(name: string, msg?: string);
+}
 export {};