lemmy-js-client 0.20.0-alpha.6 → 0.20.0-api-v4.0

package/dist/types/LemmyErrorType.d.ts

@@ -1,3 +1,4 @@
+import type { FederationError } from "./FederationError";
 export type LemmyErrorType = {
     error: "report_reason_required";
 } | {
@@ -24,18 +25,12 @@ export type LemmyErrorType = {
     error: "couldnt_update_private_message";
 } | {
     error: "cannot_leave_admin";
-} | {
-    error: "no_lines_in_html";
-} | {
-    error: "site_metadata_page_is_not_doctype_html";
 } | {
     error: "pictrs_response_error";
     message: string;
 } | {
     error: "pictrs_purge_response_error";
     message: string;
-} | {
-    error: "pictrs_caching_disabled";
 } | {
     error: "image_url_missing_path_segments";
 } | {
@@ -48,10 +43,6 @@ export type LemmyErrorType = {
     error: "not_an_image_type";
 } | {
     error: "not_a_mod_or_admin";
-} | {
-    error: "no_admins";
-} | {
-    error: "not_top_admin";
 } | {
     error: "not_top_mod";
 } | {
@@ -64,40 +55,12 @@ export type LemmyErrorType = {
     error: "site_ban";
 } | {
     error: "deleted";
-} | {
-    error: "banned_from_community";
-} | {
-    error: "couldnt_find_community";
-} | {
-    error: "couldnt_find_person";
-} | {
-    error: "couldnt_find_comment";
-} | {
-    error: "couldnt_find_comment_report";
-} | {
-    error: "couldnt_find_post_report";
-} | {
-    error: "couldnt_find_private_message_report";
-} | {
-    error: "couldnt_find_local_user";
-} | {
-    error: "couldnt_find_person_mention";
-} | {
-    error: "couldnt_find_registration_application";
-} | {
-    error: "couldnt_find_comment_reply";
-} | {
-    error: "couldnt_find_private_message";
-} | {
-    error: "couldnt_find_activity";
 } | {
     error: "person_is_blocked";
 } | {
     error: "community_is_blocked";
 } | {
     error: "instance_is_blocked";
-} | {
-    error: "downvotes_are_disabled";
 } | {
     error: "instance_is_private";
 } | {
@@ -124,14 +87,10 @@ export type LemmyErrorType = {
     error: "community_already_exists";
 } | {
     error: "language_not_allowed";
-} | {
-    error: "only_mods_can_post_in_community";
 } | {
     error: "couldnt_update_post";
 } | {
     error: "no_post_edit_allowed";
-} | {
-    error: "couldnt_find_post";
 } | {
     error: "edit_private_message_not_allowed";
 } | {
@@ -144,43 +103,20 @@ export type LemmyErrorType = {
     error: "registration_closed";
 } | {
     error: "registration_application_answer_required";
+} | {
+    error: "registration_username_required";
 } | {
     error: "email_already_exists";
 } | {
-    error: "federation_forbidden_by_strict_allow_list";
+    error: "username_already_exists";
 } | {
     error: "person_is_banned_from_community";
-} | {
-    error: "object_is_not_public";
-} | {
-    error: "invalid_community";
-} | {
-    error: "cannot_create_post_or_comment_in_deleted_or_removed_community";
-} | {
-    error: "cannot_receive_page";
-} | {
-    error: "new_post_cannot_be_locked";
-} | {
-    error: "only_local_admin_can_remove_community";
-} | {
-    error: "only_local_admin_can_restore_community";
 } | {
     error: "no_id_given";
 } | {
     error: "incorrect_login";
-} | {
-    error: "invalid_query";
 } | {
     error: "object_not_local";
-} | {
-    error: "post_is_locked";
-} | {
-    error: "person_is_banned_from_site";
-    message: string;
-} | {
-    error: "invalid_vote_value";
-} | {
-    error: "page_does_not_specify_creator";
 } | {
     error: "no_email_setup";
 } | {
@@ -239,8 +175,6 @@ export type LemmyErrorType = {
     error: "person_block_already_exists";
 } | {
     error: "user_already_exists";
-} | {
-    error: "token_not_found";
 } | {
     error: "couldnt_like_post";
 } | {
@@ -255,8 +189,6 @@ export type LemmyErrorType = {
     error: "couldnt_update_replies";
 } | {
     error: "couldnt_update_person_mentions";
-} | {
-    error: "post_title_too_long";
 } | {
     error: "couldnt_create_post";
 } | {
@@ -283,21 +215,11 @@ export type LemmyErrorType = {
     error: "email_send_failed";
 } | {
     error: "slurs";
-} | {
-    error: "couldnt_find_object";
 } | {
     error: "registration_denied";
-    message: string | null;
-} | {
-    error: "federation_disabled";
-} | {
-    error: "domain_blocked";
-    message: string;
-} | {
-    error: "domain_not_in_allow_list";
-    message: string;
-} | {
-    error: "federation_disabled_by_strict_allow_list";
+    message: {
+        reason?: string;
+    };
 } | {
     error: "site_name_required";
 } | {
@@ -320,8 +242,6 @@ export type LemmyErrorType = {
     error: "instance_block_already_exists";
 } | {
     error: "too_many_items";
-} | {
-    error: "community_has_no_followers";
 } | {
     error: "ban_expiration_in_past";
 } | {
@@ -330,15 +250,30 @@ export type LemmyErrorType = {
     error: "invalid_bot_action";
 } | {
     error: "cant_block_local_instance";
-} | {
-    error: "url_without_domain";
-} | {
-    error: "inbox_timeout";
 } | {
     error: "unknown";
     message: string;
 } | {
-    error: "cant_delete_site";
+    error: "url_length_overflow";
+} | {
+    error: "oauth_authorization_invalid";
+} | {
+    error: "oauth_login_failed";
+} | {
+    error: "oauth_registration_closed";
+} | {
+    error: "couldnt_delete_oauth_provider";
+} | {
+    error: "not_found";
+} | {
+    error: "community_has_no_followers";
 } | {
     error: "post_schedule_time_must_be_in_future";
+} | {
+    error: "too_many_scheduled_posts";
+} | {
+    error: "federation_error";
+    message: {
+        error?: FederationError;
+    };
 };

package/dist/types/LemmyErrorType.js

@@ -1,3 +1,2 @@
 "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/LinkMetadata.d.ts

@@ -1,7 +1,11 @@
-export interface LinkMetadata {
+import type { DbUrl } from "./DbUrl";
+/**
+ * Site metadata, from its opengraph tags.
+ */
+export type LinkMetadata = {
+    content_type?: string;
     title?: string;
     description?: string;
-    image?: string;
-    embed_video_url?: string;
-    content_type?: string;
-}
+    image?: DbUrl;
+    embed_video_url?: DbUrl;
+};

package/dist/types/LinkMetadata.js

@@ -1,3 +1,2 @@
 "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/ListCommentLikes.d.ts

@@ -1,6 +1,9 @@
 import type { CommentId } from "./CommentId";
-export interface ListCommentLikes {
+/**
+ * List comment likes. Admins-only.
+ */
+export type ListCommentLikes = {
     comment_id: CommentId;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListCommentLikesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { VoteView } from "./VoteView";
-export interface ListCommentLikesResponse {
+/**
+ * The comment likes response
+ */
+export type ListCommentLikesResponse = {
     comment_likes: Array<VoteView>;
-}
+};

package/dist/types/ListCommentReports.d.ts

@@ -1,9 +1,18 @@
 import type { CommentId } from "./CommentId";
 import type { CommunityId } from "./CommunityId";
-export interface ListCommentReports {
+/**
+ * List comment reports.
+ */
+export type ListCommentReports = {
     comment_id?: CommentId;
     page?: number;
     limit?: number;
+    /**
+     * Only shows the unresolved reports
+     */
     unresolved_only?: boolean;
+    /**
+     * if no community is given, it returns reports for all communities moderated by the auth user
+     */
     community_id?: CommunityId;
-}
+};

package/dist/types/ListCommentReportsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommentReportView } from "./CommentReportView";
-export interface ListCommentReportsResponse {
+/**
+ * The comment report list response.
+ */
+export type ListCommentReportsResponse = {
     comment_reports: Array<CommentReportView>;
-}
+};

package/dist/types/ListCommunities.d.ts

@@ -1,9 +1,12 @@
+import type { CommunitySortType } from "./CommunitySortType";
 import type { ListingType } from "./ListingType";
-import type { SortType } from "./SortType";
-export interface ListCommunities {
+/**
+ * Fetches a list of communities.
+ */
+export type ListCommunities = {
     type_?: ListingType;
-    sort?: SortType;
+    sort?: CommunitySortType;
     show_nsfw?: boolean;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListCommunitiesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { CommunityView } from "./CommunityView";
-export interface ListCommunitiesResponse {
+/**
+ * The response for listing communities.
+ */
+export type ListCommunitiesResponse = {
     communities: Array<CommunityView>;
-}
+};

package/dist/types/ListCommunityPendingFollows.d.ts

@@ -0,0 +1,9 @@
+export type ListCommunityPendingFollows = {
+    /**
+     * Only shows the unapproved applications
+     */
+    pending_only?: boolean;
+    all_communities?: boolean;
+    page?: number;
+    limit?: number;
+};

package/dist/types/ListCommunityPendingFollows.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/ListCommunityPendingFollowsResponse.d.ts

@@ -0,0 +1,4 @@
+import type { PendingFollow } from "./PendingFollow";
+export type ListCommunityPendingFollowsResponse = {
+    items: Array<PendingFollow>;
+};

package/dist/types/ListCommunityPendingFollowsResponse.js

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

package/dist/types/ListCustomEmojis.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Fetches a list of custom emojis.
+ */
+export type ListCustomEmojis = {
+    page?: number;
+    limit?: number;
+    category?: string;
+    ignore_page_limits?: boolean;
+};

package/dist/types/ListCustomEmojis.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/ListCustomEmojisResponse.d.ts

@@ -0,0 +1,7 @@
+import type { CustomEmojiView } from "./CustomEmojiView";
+/**
+ * A response for custom emojis.
+ */
+export type ListCustomEmojisResponse = {
+    custom_emojis: Array<CustomEmojiView>;
+};

package/dist/types/ListCustomEmojisResponse.js

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

package/dist/types/ListLoginsResponse.d.ts

@@ -0,0 +1,4 @@
+import type { LoginToken } from "./LoginToken";
+export type ListLoginsResponse = {
+    logins: Array<LoginToken>;
+};

package/dist/types/ListLoginsResponse.js

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

package/dist/types/ListMedia.d.ts

@@ -1,4 +1,7 @@
-export interface ListMedia {
+/**
+ * Get your user's image / media uploads.
+ */
+export type ListMedia = {
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListMediaResponse.d.ts

@@ -1,4 +1,4 @@
 import type { LocalImageView } from "./LocalImageView";
-export interface ListMediaResponse {
+export type ListMediaResponse = {
     images: Array<LocalImageView>;
-}
+};

package/dist/types/ListPostLikes.d.ts

@@ -1,6 +1,9 @@
 import type { PostId } from "./PostId";
-export interface ListPostLikes {
+/**
+ * List post likes. Admins-only.
+ */
+export type ListPostLikes = {
     post_id: PostId;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListPostLikesResponse.d.ts

@@ -1,4 +1,7 @@
 import type { VoteView } from "./VoteView";
-export interface ListPostLikesResponse {
+/**
+ * The post likes response
+ */
+export type ListPostLikesResponse = {
     post_likes: Array<VoteView>;
-}
+};

package/dist/types/ListPostReports.d.ts

@@ -1,9 +1,18 @@
 import type { CommunityId } from "./CommunityId";
 import type { PostId } from "./PostId";
-export interface ListPostReports {
+/**
+ * List post reports.
+ */
+export type ListPostReports = {
     page?: number;
     limit?: number;
+    /**
+     * Only shows the unresolved reports
+     */
     unresolved_only?: boolean;
+    /**
+     * if no community is given, it returns reports for all communities moderated by the auth user
+     */
     community_id?: CommunityId;
     post_id?: PostId;
-}
+};

package/dist/types/ListPostReportsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PostReportView } from "./PostReportView";
-export interface ListPostReportsResponse {
+/**
+ * The post reports response.
+ */
+export type ListPostReportsResponse = {
     post_reports: Array<PostReportView>;
-}
+};

package/dist/types/ListPrivateMessageReports.d.ts

@@ -1,5 +1,11 @@
-export interface ListPrivateMessageReports {
+/**
+ * List private message reports.
+ */
+export type ListPrivateMessageReports = {
     page?: number;
     limit?: number;
+    /**
+     * Only shows the unresolved reports
+     */
     unresolved_only?: boolean;
-}
+};

package/dist/types/ListPrivateMessageReportsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { PrivateMessageReportView } from "./PrivateMessageReportView";
-export interface ListPrivateMessageReportsResponse {
+/**
+ * The response for list private message reports.
+ */
+export type ListPrivateMessageReportsResponse = {
     private_message_reports: Array<PrivateMessageReportView>;
-}
+};

package/dist/types/ListRegistrationApplications.d.ts

@@ -1,5 +1,11 @@
-export interface ListRegistrationApplications {
+/**
+ * Fetches a list of registration applications.
+ */
+export type ListRegistrationApplications = {
+    /**
+     * Only shows the unread applications (IE those without an admin actor)
+     */
     unread_only?: boolean;
     page?: number;
     limit?: number;
-}
+};

package/dist/types/ListRegistrationApplicationsResponse.d.ts

@@ -1,4 +1,7 @@
 import type { RegistrationApplicationView } from "./RegistrationApplicationView";
-export interface ListRegistrationApplicationsResponse {
+/**
+ * The list of registration applications.
+ */
+export type ListRegistrationApplicationsResponse = {
     registration_applications: Array<RegistrationApplicationView>;
-}
+};

package/dist/types/ListTaglines.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Fetches a list of taglines.
+ */
+export type ListTaglines = {
+    page?: number;
+    limit?: number;
+};

package/dist/types/ListTaglines.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/ListTaglinesResponse.d.ts

@@ -0,0 +1,7 @@
+import type { Tagline } from "./Tagline";
+/**
+ * A response for taglines.
+ */
+export type ListTaglinesResponse = {
+    taglines: Array<Tagline>;
+};

package/dist/types/ListTaglinesResponse.js

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

package/dist/types/ListingType.d.ts

@@ -1 +1,4 @@
+/**
+ * A listing type for post and comment list fetches.
+ */
 export type ListingType = "All" | "Local" | "Subscribed" | "ModeratorView";

package/dist/types/LocalImage.d.ts

@@ -1,7 +1,7 @@
 import type { LocalUserId } from "./LocalUserId";
-export interface LocalImage {
+export type LocalImage = {
     local_user_id?: LocalUserId;
     pictrs_alias: string;
     pictrs_delete_token: string;
     published: string;
-}
+};

package/dist/types/LocalImageView.d.ts

@@ -1,6 +1,9 @@
 import type { LocalImage } from "./LocalImage";
 import type { Person } from "./Person";
-export interface LocalImageView {
+/**
+ * A local image view.
+ */
+export type LocalImageView = {
     local_image: LocalImage;
     person: Person;
-}
+};