lemmy-js-client 0.17.0-rc.13 → 0.17.0-rc.16

package/dist/interfaces/api/person.d.ts

@@ -1,43 +1,46 @@
+import { Option } from "@sniptt/monads";
 import { SortType } from "../others";
 import { CommentView, CommunityModeratorView, PersonMentionView, PersonViewSafe, PostView, PrivateMessageView } from "../views";
-export interface Login {
+export declare class Login {
     username_or_email: string;
     password: string;
+    constructor(username_or_email: string, password: string);
 }
 /**
  * Register a new user.
  *
  * Only the first user to register will be able to be the admin.
  */
-export interface Register {
+export declare class Register {
     username: string;
     /**
      * Email is mandatory if email verification is enabled on the server
      */
-    email?: string;
+    email: Option<string>;
     password: string;
     password_verify: string;
     show_nsfw: boolean;
     /**
      * Captcha is only checked if these are enabled in the server.
      */
-    captcha_uuid?: string;
-    captcha_answer?: string;
-    honeypot?: string;
+    captcha_uuid: Option<string>;
+    captcha_answer: Option<string>;
+    honeypot: Option<string>;
     /**
      * An answer is mandatory if require application is enabled on the server
      */
-    answer?: string;
+    answer: Option<string>;
+    constructor(username: string, email: Option<string>, password: string, password_verify: string, show_nsfw: boolean, captcha_uuid: Option<string>, captcha_answer: Option<string>, honeypot: Option<string>, answer: Option<string>);
 }
-export interface GetCaptcha {
+export declare class GetCaptcha {
 }
-export interface GetCaptchaResponse {
+export declare class GetCaptchaResponse {
     /**
      * Will be undefined if captchas are disabled.
      */
-    ok?: CaptchaResponse;
+    ok: Option<CaptchaResponse>;
 }
-export interface CaptchaResponse {
+export declare class CaptchaResponse {
     /**
      * A Base64 encoded png.
      */
@@ -45,227 +48,248 @@ export interface CaptchaResponse {
     /**
      * A Base64 encoded wav file.
      */
-    wav?: string;
+    wav: Option<string>;
     /**
      * A UUID to match the one given on request.
      */
     uuid: string;
 }
-export interface SaveUserSettings {
-    show_nsfw?: boolean;
+export declare class SaveUserSettings {
+    show_nsfw: Option<boolean>;
     /**
      * Default for this is `browser`.
      */
-    theme?: string;
+    theme: Option<string>;
     /**
      * The [[SortType]].
      *
      * The Sort types from above, zero indexed as a number
      */
-    default_sort_type?: number;
+    default_sort_type: Option<number>;
     /**
      * The [[ListingType]].
      *
      * Post listing types are `All, Subscribed, Community`
      */
-    default_listing_type?: number;
-    lang?: string;
-    avatar?: string;
-    banner?: string;
-    display_name?: string;
-    email?: string;
-    bio?: string;
-    matrix_user_id?: string;
-    show_avatars?: boolean;
-    show_scores?: boolean;
-    send_notifications_to_email?: boolean;
-    bot_account?: boolean;
-    show_bot_accounts?: boolean;
-    show_read_posts?: boolean;
-    show_new_post_notifs?: boolean;
+    default_listing_type: Option<number>;
+    lang: Option<string>;
+    avatar: Option<string>;
+    banner: Option<string>;
+    display_name: Option<string>;
+    email: Option<string>;
+    bio: Option<string>;
+    matrix_user_id: Option<string>;
+    show_avatars: Option<boolean>;
+    show_scores: Option<boolean>;
+    send_notifications_to_email: Option<boolean>;
+    bot_account: Option<boolean>;
+    show_bot_accounts: Option<boolean>;
+    show_read_posts: Option<boolean>;
+    show_new_post_notifs: Option<boolean>;
     auth: string;
+    constructor(show_nsfw: Option<boolean>, theme: Option<string>, default_sort_type: Option<number>, default_listing_type: Option<number>, lang: Option<string>, avatar: Option<string>, banner: Option<string>, display_name: Option<string>, email: Option<string>, bio: Option<string>, matrix_user_id: Option<string>, show_avatars: Option<boolean>, show_scores: Option<boolean>, send_notifications_to_email: Option<boolean>, bot_account: Option<boolean>, show_bot_accounts: Option<boolean>, show_read_posts: Option<boolean>, show_new_post_notifs: Option<boolean>, auth: string);
 }
-export interface ChangePassword {
+export declare class ChangePassword {
     new_password: string;
     new_password_verify: string;
     old_password: string;
     auth: string;
+    constructor(new_password: string, new_password_verify: string, old_password: string, auth: string);
 }
 /**
  * The `jwt` string should be stored and used anywhere `auth` is called for.
  */
-export interface LoginResponse {
+export declare class LoginResponse {
     /**
      * This is None in response to `Register` if email verification is enabled, or the server requires registration applications.
      */
-    jwt?: string;
+    jwt: Option<string>;
     verify_email_sent: boolean;
     registration_created: boolean;
 }
-export interface GetPersonDetails {
-    person_id?: number;
+export declare class GetPersonDetails {
+    person_id: Option<number>;
     /**
      * To get details for a federated user, use `person@instance.tld`.
      */
-    username?: string;
-    sort?: SortType;
-    page?: number;
-    limit?: number;
-    community_id?: number;
-    saved_only?: boolean;
-    auth?: string;
-}
-export interface GetPersonDetailsResponse {
+    username: Option<string>;
+    sort: Option<SortType>;
+    page: Option<number>;
+    limit: Option<number>;
+    community_id: Option<number>;
+    saved_only: Option<boolean>;
+    auth: Option<string>;
+    constructor(person_id: Option<number>, username: Option<string>, sort: Option<SortType>, page: Option<number>, limit: Option<number>, community_id: Option<number>, saved_only: Option<boolean>, auth: Option<string>);
+}
+export declare class GetPersonDetailsResponse {
     person_view: PersonViewSafe;
     comments: CommentView[];
     posts: PostView[];
     moderates: CommunityModeratorView[];
 }
-export interface GetRepliesResponse {
+export declare class GetRepliesResponse {
     replies: CommentView[];
 }
-export interface GetPersonMentionsResponse {
+export declare class GetPersonMentionsResponse {
     mentions: PersonMentionView[];
 }
-export interface MarkAllAsRead {
+export declare class MarkAllAsRead {
     auth: string;
+    constructor(auth: string);
 }
-export interface AddAdmin {
+export declare class AddAdmin {
     person_id: number;
     added: boolean;
     auth: string;
+    constructor(person_id: number, added: boolean, auth: string);
 }
-export interface AddAdminResponse {
+export declare class AddAdminResponse {
     admins: PersonViewSafe[];
 }
-export interface BanPerson {
+export declare class BanPerson {
     person_id: number;
     ban: boolean;
     /**
      * Removes/Restores their comments, posts, and communities
      */
-    remove_data?: boolean;
-    reason?: string;
+    remove_data: Option<boolean>;
+    reason: Option<string>;
     /**
      * The expire time in Unix seconds
      */
-    expires?: number;
+    expires: Option<number>;
     auth: string;
+    constructor(person_id: number, ban: boolean, remove_data: Option<boolean>, reason: Option<string>, expires: Option<number>, auth: string);
 }
-export interface BanPersonResponse {
+export declare class BanPersonResponse {
     person_view: PersonViewSafe;
     banned: boolean;
 }
-export interface GetReplies {
-    sort?: SortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
+export declare class GetReplies {
+    sort: Option<SortType>;
+    page: Option<number>;
+    limit: Option<number>;
+    unread_only: Option<boolean>;
     auth: string;
+    constructor(sort: Option<SortType>, page: Option<number>, limit: Option<number>, unread_only: Option<boolean>, auth: string);
 }
-export interface GetPersonMentions {
-    sort?: SortType;
-    page?: number;
-    limit?: number;
-    unread_only?: boolean;
+export declare class GetPersonMentions {
+    sort: Option<SortType>;
+    page: Option<number>;
+    limit: Option<number>;
+    unread_only: Option<boolean>;
     auth: string;
+    constructor(sort: Option<SortType>, page: Option<number>, limit: Option<number>, unread_only: Option<boolean>, auth: string);
 }
-export interface MarkPersonMentionAsRead {
+export declare class MarkPersonMentionAsRead {
     person_mention_id: number;
     read: boolean;
     auth: string;
+    constructor(person_mention_id: number, read: boolean, auth: string);
 }
-export interface PersonMentionResponse {
+export declare class PersonMentionResponse {
     person_mention_view: PersonMentionView;
 }
 /**
  * Permanently deletes your posts and comments
  */
-export interface DeleteAccount {
+export declare class DeleteAccount {
     password: string;
     auth: string;
+    constructor(password: string, auth: string);
 }
-export interface DeleteAccountResponse {
+export declare class DeleteAccountResponse {
 }
-export interface PasswordReset {
+export declare class PasswordReset {
     email: string;
+    constructor(email: string);
 }
-export interface PasswordResetResponse {
+export declare class PasswordResetResponse {
 }
-export interface PasswordChange {
+export declare class PasswordChange {
     token: string;
     password: string;
     password_verify: string;
+    constructor(token: string, password: string, password_verify: string);
 }
-export interface CreatePrivateMessage {
+export declare class CreatePrivateMessage {
     content: string;
     recipient_id: number;
     auth: string;
+    constructor(content: string, recipient_id: number, auth: string);
 }
-export interface EditPrivateMessage {
+export declare class EditPrivateMessage {
     private_message_id: number;
     content: string;
     auth: string;
+    constructor(private_message_id: number, content: string, auth: string);
 }
-export interface DeletePrivateMessage {
+export declare class DeletePrivateMessage {
     private_message_id: number;
     deleted: boolean;
     auth: string;
+    constructor(private_message_id: number, deleted: boolean, auth: string);
 }
-export interface MarkPrivateMessageAsRead {
+export declare class MarkPrivateMessageAsRead {
     private_message_id: number;
     read: boolean;
     auth: string;
+    constructor(private_message_id: number, read: boolean, auth: string);
 }
-export interface GetPrivateMessages {
-    unread_only?: boolean;
-    page?: number;
-    limit?: number;
+export declare class GetPrivateMessages {
+    unread_only: Option<boolean>;
+    page: Option<number>;
+    limit: Option<number>;
     auth: string;
 }
-export interface PrivateMessagesResponse {
+export declare class PrivateMessagesResponse {
     private_messages: PrivateMessageView[];
 }
-export interface PrivateMessageResponse {
+export declare class PrivateMessageResponse {
     private_message_view: PrivateMessageView;
 }
-export interface GetReportCount {
+export declare class GetReportCount {
     /**
      * If a community is supplied, returns the report count for only that community, otherwise returns the report count for all communities the user moderates.
      */
-    community_id?: number;
+    community_id: Option<number>;
     auth: string;
+    constructor(community_id: Option<number>, auth: string);
 }
-export interface GetReportCountResponse {
-    community_id?: number;
+export declare class GetReportCountResponse {
+    community_id: Option<number>;
     comment_reports: number;
     post_reports: number;
 }
-export interface GetUnreadCount {
+export declare class GetUnreadCount {
     auth: string;
+    constructor(auth: string);
 }
-export interface GetUnreadCountResponse {
+export declare class GetUnreadCountResponse {
     replies: number;
     mentions: number;
     private_messages: number;
 }
-export interface VerifyEmail {
+export declare class VerifyEmail {
     token: string;
+    constructor(token: string);
 }
-export interface VerifyEmailResponse {
+export declare class VerifyEmailResponse {
 }
-export interface BlockPerson {
+export declare class BlockPerson {
     person_id: number;
     block: boolean;
     auth: string;
+    constructor(person_id: number, block: boolean, auth: string);
 }
-export interface BlockPersonResponse {
+export declare class BlockPersonResponse {
     person_view: PersonViewSafe;
     blocked: boolean;
 }
-export interface GetBannedPersons {
+export declare class GetBannedPersons {
     auth: string;
+    constructor(auth: string);
 }
-export interface BannedPersonsResponse {
+export declare class BannedPersonsResponse {
     banned: PersonViewSafe[];
 }