lemmy-js-client 0.19.0-alpha.12 → 0.19.0-alpha.14

package/dist/http.d.ts

@@ -1,13 +1,20 @@
 import fetch from "cross-fetch";
 import { AddAdmin } from "./types/AddAdmin";
+import { AddAdminResponse } from "./types/AddAdminResponse";
 import { AddModToCommunity } from "./types/AddModToCommunity";
+import { AddModToCommunityResponse } from "./types/AddModToCommunityResponse";
 import { ApproveRegistrationApplication } from "./types/ApproveRegistrationApplication";
 import { BanFromCommunity } from "./types/BanFromCommunity";
+import { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
 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 { CommentReplyResponse } from "./types/CommentReplyResponse";
 import { CommentReportResponse } from "./types/CommentReportResponse";
 import { CommentResponse } from "./types/CommentResponse";
 import { CommunityResponse } from "./types/CommunityResponse";
@@ -115,10 +122,12 @@ import { VerifyEmail } from "./types/VerifyEmail";
 import { DeleteImage, UploadImage, UploadImageResponse } from "./types/others";
 import { HideCommunity } from "./types/HideCommunity";
 import { BlockInstance } from "./types/BlockInstance";
+import { BlockInstanceResponse } from "./types/BlockInstanceResponse";
 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";
 /**
  * Helps build lemmy HTTP requests.
  */
@@ -167,6 +176,31 @@ export declare class LemmyHttp {
      * `HTTP.POST /user/totp/generate`
      */
     generateTotpSecret(): Promise<GenerateTotpSecretResponse>;
+    /**
+     * Export a backup of your user settings, including your saved content,
+     * followed communities, and blocks.
+     *
+     * `HTTP.GET /user/export_settings`
+     */
+    exportSettings(): Promise<any>;
+    /**
+     * Import a backup of your user settings.
+     *
+     * `HTTP.POST /user/import_settings`
+     */
+    importSettings(form: any): Promise<SuccessResponse>;
+    /**
+     * List login tokens for your user
+     *
+     * `HTTP.GET /user/list_logins`
+     */
+    listLogins(): Promise<LoginToken[]>;
+    /**
+     * Returns an error message if your auth token is invalid
+     *
+     * `HTTP.GET /user/validate_auth`
+     */
+    validateAuth(): Promise<SuccessResponse>;
     /**
      * Enable / Disable TOTP / two-factor authentication.
      *
@@ -230,7 +264,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /community/block`
      */
-    blockCommunity(form: BlockCommunity): Promise<SuccessResponse>;
+    blockCommunity(form: BlockCommunity): Promise<BlockCommunityResponse>;
     /**
      * Delete a community.
      *
@@ -238,11 +272,11 @@ export declare class LemmyHttp {
      */
     deleteCommunity(form: DeleteCommunity): Promise<CommunityResponse>;
     /**
-     * Hide a community from public view.
+     * Hide a community from public / "All" view. Admins only.
      *
      * `HTTP.PUT /community/hide`
      */
-    hideCommunity(form: HideCommunity): Promise<CommunityResponse>;
+    hideCommunity(form: HideCommunity): Promise<SuccessResponse>;
     /**
      * A moderator remove for a community.
      *
@@ -260,13 +294,13 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /community/ban_user`
      */
-    banFromCommunity(form: BanFromCommunity): Promise<SuccessResponse>;
+    banFromCommunity(form: BanFromCommunity): Promise<BanFromCommunityResponse>;
     /**
      * Add a moderator to your community.
      *
      * `HTTP.POST /community/mod`
      */
-    addModToCommunity(form: AddModToCommunity): Promise<SuccessResponse>;
+    addModToCommunity(form: AddModToCommunity): Promise<AddModToCommunityResponse>;
     /**
      * Create a post.
      *
@@ -302,7 +336,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /post/mark_as_read`
      */
-    markPostAsRead(form: MarkPostAsRead): Promise<PostResponse>;
+    markPostAsRead(form: MarkPostAsRead): Promise<SuccessResponse>;
     /**
      * A moderator can lock a post ( IE disable new comments ).
      *
@@ -386,7 +420,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /comment/mark_as_read`
      */
-    markCommentReplyAsRead(form: MarkCommentReplyAsRead): Promise<SuccessResponse>;
+    markCommentReplyAsRead(form: MarkCommentReplyAsRead): Promise<CommentReplyResponse>;
     /**
      * Like / vote on a comment.
      *
@@ -524,7 +558,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /user/ban`
      */
-    banPerson(form: BanPerson): Promise<SuccessResponse>;
+    banPerson(form: BanPerson): Promise<BanPersonResponse>;
     /**
      * Get a list of banned users
      *
@@ -536,7 +570,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /user/block`
      */
-    blockPerson(form: BlockPerson): Promise<SuccessResponse>;
+    blockPerson(form: BlockPerson): Promise<BlockPersonResponse>;
     /**
      * Fetch a Captcha.
      *
@@ -560,7 +594,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /user/password_change`
      */
-    passwordChangeAfterReset(form: PasswordChangeAfterReset): Promise<LoginResponse>;
+    passwordChangeAfterReset(form: PasswordChangeAfterReset): Promise<SuccessResponse>;
     /**
      * Mark all replies as read.
      *
@@ -572,7 +606,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.PUT /user/save_user_settings`
      */
-    saveUserSettings(form: SaveUserSettings): Promise<LoginResponse>;
+    saveUserSettings(form: SaveUserSettings): Promise<SuccessResponse>;
     /**
      * Change your user password.
      *
@@ -602,7 +636,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.POST /admin/add`
      */
-    addAdmin(form: AddAdmin): Promise<SuccessResponse>;
+    addAdmin(form: AddAdmin): Promise<AddAdminResponse>;
     /**
      * Get the unread registration applications count.
      *
@@ -674,7 +708,7 @@ export declare class LemmyHttp {
      *
      * `HTTP.Post /site/block`
      */
-    blockInstance(form: BlockInstance): Promise<SuccessResponse>;
+    blockInstance(form: BlockInstance): Promise<BlockInstanceResponse>;
     /**
      * Upload an image to the server.
      */

package/dist/http.js

@@ -100,6 +100,39 @@ class LemmyHttp {
     generateTotpSecret() {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/user/totp/generate", {});
     }
+    /**
+     * Export a backup of your user settings, including your saved content,
+     * followed communities, and blocks.
+     *
+     * `HTTP.GET /user/export_settings`
+     */
+    exportSettings() {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/user/export_settings", {});
+    }
+    /**
+     * Import a backup of your user settings.
+     *
+     * `HTTP.POST /user/import_settings`
+     */
+    importSettings(form) {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/user/import_settings", form);
+    }
+    /**
+     * List login tokens for your user
+     *
+     * `HTTP.GET /user/list_logins`
+     */
+    listLogins() {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/user/list_logins", {});
+    }
+    /**
+     * Returns an error message if your auth token is invalid
+     *
+     * `HTTP.GET /user/validate_auth`
+     */
+    validateAuth() {
+        return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Get, "/user/validate_auth", {});
+    }
     /**
      * Enable / Disable TOTP / two-factor authentication.
      *
@@ -193,7 +226,7 @@ class LemmyHttp {
         return __classPrivateFieldGet(this, _LemmyHttp_instances, "m", _LemmyHttp_wrapper).call(this, HttpType.Post, "/community/delete", form);
     }
     /**
-     * Hide a community from public view.
+     * Hide a community from public / "All" view. Admins only.
      *
      * `HTTP.PUT /community/hide`
      */

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./http";
 export { AddAdmin } from "./types/AddAdmin";
+export { AddAdminResponse } from "./types/AddAdminResponse";
 export { AddModToCommunity } from "./types/AddModToCommunity";
+export { AddModToCommunityResponse } from "./types/AddModToCommunityResponse";
 export { AdminPurgeComment } from "./types/AdminPurgeComment";
 export { AdminPurgeCommentView } from "./types/AdminPurgeCommentView";
 export { AdminPurgeCommunity } from "./types/AdminPurgeCommunity";
@@ -11,11 +13,16 @@ export { AdminPurgePost } from "./types/AdminPurgePost";
 export { AdminPurgePostView } from "./types/AdminPurgePostView";
 export { ApproveRegistrationApplication } from "./types/ApproveRegistrationApplication";
 export { BanFromCommunity } from "./types/BanFromCommunity";
+export { BanFromCommunityResponse } from "./types/BanFromCommunityResponse";
 export { BanPerson } from "./types/BanPerson";
+export { BanPersonResponse } from "./types/BanPersonResponse";
 export { BannedPersonsResponse } from "./types/BannedPersonsResponse";
 export { BlockCommunity } from "./types/BlockCommunity";
+export { BlockCommunityResponse } from "./types/BlockCommunityResponse";
 export { BlockInstance } from "./types/BlockInstance";
+export { BlockInstanceResponse } from "./types/BlockInstanceResponse";
 export { BlockPerson } from "./types/BlockPerson";
+export { BlockPersonResponse } from "./types/BlockPersonResponse";
 export { CaptchaResponse } from "./types/CaptchaResponse";
 export { ChangePassword } from "./types/ChangePassword";
 export { Comment } from "./types/Comment";
@@ -23,6 +30,7 @@ export { CommentAggregates } from "./types/CommentAggregates";
 export { CommentId } from "./types/CommentId";
 export { CommentReply } from "./types/CommentReply";
 export { CommentReplyId } from "./types/CommentReplyId";
+export { CommentReplyResponse } from "./types/CommentReplyResponse";
 export { CommentReplyView } from "./types/CommentReplyView";
 export { CommentReport } from "./types/CommentReport";
 export { CommentReportId } from "./types/CommentReportId";
@@ -129,6 +137,7 @@ export { LocalUserView } from "./types/LocalUserView";
 export { LockPost } from "./types/LockPost";
 export { Login } from "./types/Login";
 export { LoginResponse } from "./types/LoginResponse";
+export { LoginToken } from "./types/LoginToken";
 export { MarkCommentReplyAsRead } from "./types/MarkCommentReplyAsRead";
 export { MarkPersonMentionAsRead } from "./types/MarkPersonMentionAsRead";
 export { MarkPostAsRead } from "./types/MarkPostAsRead";
@@ -170,6 +179,7 @@ export { PersonMention } from "./types/PersonMention";
 export { PersonMentionId } from "./types/PersonMentionId";
 export { PersonMentionResponse } from "./types/PersonMentionResponse";
 export { PersonMentionView } from "./types/PersonMentionView";
+export { PersonSortType } from "./types/PersonSortType";
 export { PersonView } from "./types/PersonView";
 export { Post } from "./types/Post";
 export { PostAggregates } from "./types/PostAggregates";

package/dist/types/AddAdminResponse.d.ts

@@ -0,0 +1,4 @@
+import type { PersonView } from "./PersonView";
+export interface AddAdminResponse {
+    admins: Array<PersonView>;
+}

package/dist/types/AddAdminResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/AddModToCommunityResponse.d.ts

@@ -0,0 +1,4 @@
+import type { CommunityModeratorView } from "./CommunityModeratorView";
+export interface AddModToCommunityResponse {
+    moderators: Array<CommunityModeratorView>;
+}

package/dist/types/AddModToCommunityResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/BanFromCommunityResponse.d.ts

@@ -0,0 +1,5 @@
+import type { PersonView } from "./PersonView";
+export interface BanFromCommunityResponse {
+    person_view: PersonView;
+    banned: boolean;
+}

package/dist/types/BanFromCommunityResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/BanPersonResponse.d.ts

@@ -0,0 +1,5 @@
+import type { PersonView } from "./PersonView";
+export interface BanPersonResponse {
+    person_view: PersonView;
+    banned: boolean;
+}

package/dist/types/BanPersonResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/BlockCommunityResponse.d.ts

@@ -0,0 +1,5 @@
+import type { CommunityView } from "./CommunityView";
+export interface BlockCommunityResponse {
+    community_view: CommunityView;
+    blocked: boolean;
+}

package/dist/types/BlockCommunityResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/BlockInstanceResponse.d.ts

@@ -0,0 +1,3 @@
+export interface BlockInstanceResponse {
+    blocked: boolean;
+}

package/dist/types/BlockInstanceResponse.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/BlockPersonResponse.d.ts

@@ -0,0 +1,5 @@
+import type { PersonView } from "./PersonView";
+export interface BlockPersonResponse {
+    person_view: PersonView;
+    blocked: boolean;
+}

package/dist/types/BlockPersonResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/CommentReplyResponse.d.ts

@@ -0,0 +1,4 @@
+import type { CommentReplyView } from "./CommentReplyView";
+export interface CommentReplyResponse {
+    comment_reply_view: CommentReplyView;
+}

package/dist/types/CommentReplyResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/LoginToken.d.ts

@@ -0,0 +1,8 @@
+import type { LocalUserId } from "./LocalUserId";
+export interface LoginToken {
+    id: number;
+    user_id: LocalUserId;
+    published: string;
+    ip?: string;
+    user_agent?: string;
+}

package/dist/types/LoginToken.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/MarkPostAsRead.d.ts

@@ -1,6 +1,6 @@
 import type { PostId } from "./PostId";
 export interface MarkPostAsRead {
-    post_id: PostId;
-    post_ids: Array<PostId>;
+    post_id?: PostId;
+    post_ids?: Array<PostId>;
     read: boolean;
 }

package/dist/types/PersonSortType.d.ts

@@ -0,0 +1 @@
+export type PersonSortType = "New" | "Old" | "MostComments" | "CommentScore" | "PostScore" | "PostCount";

package/dist/types/PersonSortType.js

@@ -0,0 +1,3 @@
+"use strict";
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lemmy-js-client",
-  "version": "0.19.0-alpha.12",
+  "version": "0.19.0-alpha.14",
   "description": "A javascript / typescript client for Lemmy",
   "repository": "https://github.com/LemmyNet/lemmy-js-client",
   "license": "AGPL-3.0",