lemmy-js-client 1.0.0-alpha.0 → 1.0.0-api-updates-3.0

package/README.md

@@ -52,6 +52,12 @@ Use `pnpm add` to develop and test changes locally:
 
 `pnpm add path/to/lemmy-js-client`
 
+Alternatively, use `yalc publish` and `yalc add lemmy-js-client`
+
+## Generating typescript types from lemmy structs
+
+Run `./scripts/copy_generated_types_from_lemmy.sh`
+
 ## OpenAPI
 
 To generate OpenAPI docs, run `pnpm tsoa`

package/dist/http.d.ts

@@ -1,5 +1,5 @@
 import { Controller } from "@tsoa/runtime";
-import { DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetCommunityPendingFollowsCountI, GetModlogI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListBannedPersonsI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListInboxI, ListMediaI, ListPersonContentI, ListPersonSavedI, ListPostLikesI, ListRegistrationApplicationsI, ListReportsI, ListTaglinesI, ResolveObjectI, SearchI, UploadImage } from "./other_types";
+import { AdminListUsersI, CommunityIdQueryI, DeleteImageParamsI, GetCommentI, GetCommentsI, GetCommunityI, GetModlogI, GetMultiCommunityI, GetPersonDetailsI, GetPostI, GetPostsI, GetRandomCommunityI, GetRegistrationApplicationI, GetReportCountI, GetSiteMetadataI, ListCommentLikesI, ListCommunitiesI, ListCommunityPendingFollowsI, ListCustomEmojisI, ListNotificationsI, 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";
@@ -9,20 +9,20 @@ import { BanFromCommunity } from "./types/BanFromCommunity";
 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";
-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 { UpdateCommunityTag } from "./types/UpdateCommunityTag";
 import { CreateCustomEmoji } from "./types/CreateCustomEmoji";
 import { CreateOAuthProvider } from "./types/CreateOAuthProvider";
 import { CreatePost } from "./types/CreatePost";
@@ -35,6 +35,7 @@ import { CustomEmojiResponse } from "./types/CustomEmojiResponse";
 import { DeleteAccount } from "./types/DeleteAccount";
 import { DeleteComment } from "./types/DeleteComment";
 import { DeleteCommunity } from "./types/DeleteCommunity";
+import { DeleteCommunityTag } from "./types/DeleteCommunityTag";
 import { DeleteCustomEmoji } from "./types/DeleteCustomEmoji";
 import { DeleteOAuthProvider } from "./types/DeleteOAuthProvider";
 import { DeletePost } from "./types/DeletePost";
@@ -66,11 +67,10 @@ import { GetUnreadRegistrationApplicationCountResponse } from "./types/GetUnread
 import { ListCommunitiesResponse } from "./types/ListCommunitiesResponse";
 import { ListRegistrationApplicationsResponse } from "./types/ListRegistrationApplicationsResponse";
 import { LockPost } from "./types/LockPost";
+import { LockComment } from "./types/LockComment";
 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";
 import { PasswordReset } from "./types/PasswordReset";
 import { PostReportResponse } from "./types/PostReportResponse";
@@ -87,7 +87,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";
@@ -102,7 +102,6 @@ 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";
@@ -119,17 +118,36 @@ import { GetCommunityPendingFollowsCountResponse } from "./types/GetCommunityPen
 import { ListCommunityPendingFollowsResponse } from "./types/ListCommunityPendingFollowsResponse";
 import { ListReportsResponse } from "./types/ListReportsResponse";
 import { MyUserInfo } from "./types/MyUserInfo";
-import { UserBlockInstanceParams } from "./types/UserBlockInstanceParams";
 import { AdminAllowInstanceParams } from "./types/AdminAllowInstanceParams";
 import { AdminBlockInstanceParams } from "./types/AdminBlockInstanceParams";
 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 { 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 { NotePerson } from "./types/NotePerson";
+import { UserBlockInstanceCommunitiesParams } from "./types/UserBlockInstanceCommunitiesParams";
+import { UserBlockInstancePersonsParams } from "./types/UserBlockInstancePersonsParams";
+import { MarkNotificationAsRead } from "./types/MarkNotificationAsRead";
+import { ListNotificationsResponse } from "./types/ListNotificationsResponse";
+import { ModEditPost } from "./types/ModEditPost";
+import { UpdateCommunityNotifications } from "./types/UpdateCommunityNotifications";
+import { UpdatePostNotifications } from "./types/UpdatePostNotifications";
+import { MultiCommunityResponse } from "./types/MultiCommunityResponse";
+import { PersonResponse } from "./types/PersonResponse";
 type RequestOptions = Pick<RequestInit, "signal">;
 /**
  * Helps build lemmy HTTP requests.
@@ -188,19 +206,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.
      *
@@ -214,13 +240,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.
      */
@@ -244,7 +270,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get a community's pending follows count.
      */
-    getCommunityPendingFollowsCount(form: GetCommunityPendingFollowsCountI, options?: RequestOptions): Promise<GetCommunityPendingFollowsCountResponse>;
+    getCommunityPendingFollowsCount(options?: RequestOptions): Promise<GetCommunityPendingFollowsCountResponse>;
     /**
      * @summary Get a community's pending followers.
      */
@@ -256,7 +282,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Block a community.
      */
-    blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<BlockCommunityResponse>;
+    blockCommunity(form: BlockCommunity, options?: RequestOptions): Promise<CommunityResponse>;
     /**
      * @summary Delete a community.
      */
@@ -285,6 +311,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.
      */
@@ -297,6 +331,10 @@ export declare class LemmyHttp extends Controller {
      * @summary Edit a post.
      */
     editPost(form: EditPost, options?: RequestOptions): Promise<PostResponse>;
+    /**
+     * @summary Mods can change nsfw flag and tags for a post
+     */
+    modEditPost(form: ModEditPost, options?: RequestOptions): Promise<PostResponse>;
     /**
      * @summary Delete a post.
      */
@@ -308,7 +346,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.
      */
@@ -316,7 +354,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Hide a post from list views.
      */
-    hidePost(form: HidePost, options?: RequestOptions): Promise<SuccessResponse>;
+    hidePost(form: HidePost, options?: RequestOptions): Promise<PostResponse>;
     /**
      * @summary A moderator can lock a post ( IE disable new comments ).
      */
@@ -370,11 +408,11 @@ export declare class LemmyHttp extends Controller {
      */
     removeComment(form: RemoveComment, options?: RequestOptions): Promise<CommentResponse>;
     /**
-     * @summary Mark a comment as read.
+     * @summary A moderator can lock a comment (IE disable replies).
      */
-    markCommentReplyAsRead(form: MarkCommentReplyAsRead, options?: RequestOptions): Promise<SuccessResponse>;
+    lockComment(form: LockComment, options?: RequestOptions): Promise<CommentResponse>;
     /**
-     * @summary Like / vote on a comment.
+     * @Summary Like / vote on a comment.
      */
     likeComment(form: CreateCommentLike, options?: RequestOptions): Promise<CommentResponse>;
     /**
@@ -421,10 +459,6 @@ export declare class LemmyHttp extends Controller {
      * @summary Delete a private message.
      */
     deletePrivateMessage(form: DeletePrivateMessage, options?: RequestOptions): Promise<PrivateMessageResponse>;
-    /**
-     * @summary Mark a private message as read.
-     */
-    markPrivateMessageAsRead(form: MarkPrivateMessageAsRead, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Create a report for a private message.
      */
@@ -454,25 +488,21 @@ export declare class LemmyHttp extends Controller {
      */
     listPersonContent(form?: ListPersonContentI, options?: RequestOptions): Promise<ListPersonContentResponse>;
     /**
-     * @summary Mark a person mention as read.
+     * @summary Make a note for a person.
      */
-    markCommentMentionAsRead(form: MarkPersonCommentMentionAsRead, options?: RequestOptions): Promise<SuccessResponse>;
-    /**
-     * @summary Mark a person post body mention as read.
-     */
-    markPostMentionAsRead(form: MarkPersonPostMentionAsRead, options?: RequestOptions): Promise<SuccessResponse>;
+    notePerson(form: NotePerson, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Ban a person from your site.
      */
-    banPerson(form: BanPerson, options?: RequestOptions): Promise<BanPersonResponse>;
+    banPerson(form: BanPerson, options?: RequestOptions): Promise<PersonResponse>;
     /**
-     * @summary Get a list of banned users.
+     * @summary Get a list of users.
      */
-    listBannedPersons(form?: ListBannedPersonsI, options?: RequestOptions): Promise<BannedPersonsResponse>;
+    listUsers(form?: AdminListUsersI, options?: RequestOptions): Promise<AdminListUsersResponse>;
     /**
      * @summary Block a person.
      */
-    blockPerson(form: BlockPerson, options?: RequestOptions): Promise<BlockPersonResponse>;
+    blockPerson(form: BlockPerson, options?: RequestOptions): Promise<PersonResponse>;
     /**
      * @summary Fetch a Captcha.
      */
@@ -493,6 +523,10 @@ export declare class LemmyHttp extends Controller {
      * @summary Mark all replies as read.
      */
     markAllNotificationsAsRead(options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * @summary Mark a notification as read.
+     */
+    markNotificationAsRead(form: MarkNotificationAsRead, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Save your user settings.
      */
@@ -512,7 +546,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get your inbox (replies, comment mentions, post mentions, and messages)
      */
-    listInbox(form: ListInboxI, options?: RequestOptions): Promise<ListInboxResponse>;
+    listNotifications(form: ListNotificationsI, options?: RequestOptions): Promise<ListNotificationsResponse>;
     /**
      * @summary Verify your email
      */
@@ -525,6 +559,18 @@ export declare class LemmyHttp extends Controller {
      * @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.
      */
@@ -593,6 +639,18 @@ export declare class LemmyHttp extends Controller {
      * @summary List taglines.
      */
     listTaglines(form: ListTaglinesI, options?: RequestOptions): Promise<ListTaglinesResponse>;
+    /**
+     * @summary Create a community post tag.
+     */
+    createCommunityTag(form: CreateCommunityTag, options?: RequestOptions): Promise<Tag>;
+    /**
+     * @summary Edit a community post tag.
+     */
+    updateCommunityTag(form: UpdateCommunityTag, options?: RequestOptions): Promise<Tag>;
+    /**
+     * @summary Delete a post tag in a community.
+     */
+    deleteCommunityTag(form: DeleteCommunityTag, options?: RequestOptions): Promise<Tag>;
     /**
      * @summary Create a new oauth provider method
      */
@@ -618,9 +676,13 @@ export declare class LemmyHttp extends Controller {
      */
     listReports(form: ListReportsI, options?: RequestOptions): Promise<ListReportsResponse>;
     /**
-     * @summary Block an instance as user.
+     * @summary Block an instance's communities as a user.
+     */
+    userBlockInstanceCommunities(form: UserBlockInstanceCommunitiesParams, options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * @summary Block an instance's persons as a user.
      */
-    userBlockInstance(form: UserBlockInstanceParams, options?: RequestOptions): Promise<SuccessResponse>;
+    userBlockInstancePersons(form: UserBlockInstancePersonsParams, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * @summary Globally block an instance as admin.
      */
@@ -648,19 +710,19 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Upload new community icon.
      */
-    uploadCommunityIcon(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
+    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<UploadImageResponse>;
+    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.
      */
@@ -681,20 +743,29 @@ 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.
-     *
-     * `HTTP.POST /user/donation_dialog_shown`
      */
-    donation_dialog_shown(options?: RequestOptions): Promise<SuccessResponse>;
+    donationDialogShown(options?: RequestOptions): Promise<SuccessResponse>;
+    createMultiCommunity(form: CreateMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse>;
+    updateMultiCommunity(form: UpdateMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse>;
+    getMultiCommunity(form: GetMultiCommunityI, options?: RequestOptions): Promise<GetMultiCommunityResponse>;
+    createMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<CommunityResponse>;
+    deleteMultiCommunityEntry(form: CreateOrDeleteMultiCommunityEntry, options?: RequestOptions): Promise<SuccessResponse>;
+    listMultiCommunities(form: ListMultiCommunitiesI, options?: RequestOptions): Promise<ListMultiCommunitiesResponse>;
+    followMultiCommunity(form: FollowMultiCommunity, options?: RequestOptions): Promise<MultiCommunityResponse>;
+    /**
+     * @summary Change notification settings for a community
+     */
+    updateCommunityNotifications(form: UpdateCommunityNotifications, options?: RequestOptions): Promise<SuccessResponse>;
+    /**
+     * @summary Change notification settings for a post
+     */
+    updatePostNotifications(form: UpdatePostNotifications, options?: RequestOptions): Promise<SuccessResponse>;
     /**
      * Set the headers (can be used to set the auth header)
      */
@@ -702,4 +773,14 @@ 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 {
+    status: number;
+    constructor(name: string, status: number, msg?: string);
+}
 export {};