lemmy-js-client 1.0.0-post-tags.0 → 1.0.0-remove-page-limit.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 { 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 { AddAdmin } from "./types/AddAdmin";
 import { AddAdminResponse } from "./types/AddAdminResponse";
 import { AddModToCommunity } from "./types/AddModToCommunity";
@@ -64,8 +66,6 @@ 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";
@@ -99,9 +99,7 @@ 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";
@@ -134,8 +132,8 @@ 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";
 type RequestOptions = Pick<RequestInit, "signal">;
 /**
  * Helps build lemmy HTTP requests.
@@ -200,13 +198,21 @@ export declare class LemmyHttp extends Controller {
      */
     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.
      *
@@ -430,7 +436,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.
      */
@@ -474,7 +480,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Get a list of banned users.
      */
-    getBannedPersons(options?: RequestOptions): Promise<BannedPersonsResponse>;
+    listBannedPersons(form?: ListBannedPersonsI, options?: RequestOptions): Promise<BannedPersonsResponse>;
     /**
      * @summary Block a person.
      */
@@ -523,6 +529,10 @@ 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.
      */
@@ -596,25 +606,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 +656,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 +664,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,7 +672,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Upload new community icon.
      */
-    uploadCommunityIcon(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
+    uploadCommunityIcon(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
     /**
      * @summary Delete the community icon.
      */
@@ -678,7 +680,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @summary Upload new community banner.
      */
-    uploadCommunityBanner(image: UploadImage, options?: RequestOptions): Promise<SuccessResponse>;
+    uploadCommunityBanner(image: UploadImage, options?: RequestOptions): Promise<UploadImageResponse>;
     /**
      * @summary Delete the community banner.
      */
@@ -686,7 +688,7 @@ export declare class LemmyHttp extends Controller {
     /**
      * @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 +696,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 +705,16 @@ 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>;
     /**
      * Set the headers (can be used to set the auth header)
      */