lemmy-js-client 0.17.0-rc.4 → 0.17.0-rc.40

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

@@ -1,32 +1,27 @@
-import { CommentView, CommunityBlockView, CommunityFollowerView, CommunityModeratorView, CommunityView, LocalUserSettingsView, ModAddCommunityView, ModAddView, ModBanFromCommunityView, ModBanView, ModLockPostView, ModRemoveCommentView, ModRemoveCommunityView, ModRemovePostView, ModStickyPostView, ModTransferCommunityView, PersonBlockView, PersonViewSafe, PostView, RegistrationApplicationView, SiteView } from "../views";
+import { Option } from "@sniptt/monads";
+import "reflect-metadata";
+import { ListingType, SearchType, SortType } from "../others";
+import { AdminPurgeCommentView, AdminPurgeCommunityView, AdminPurgePersonView, AdminPurgePostView, CommentView, CommunityBlockView, CommunityFollowerView, CommunityModeratorView, CommunityView, LocalUserSettingsView, ModAddCommunityView, ModAddView, ModBanFromCommunityView, ModBanView, ModLockPostView, ModRemoveCommentView, ModRemoveCommunityView, ModRemovePostView, ModStickyPostView, ModTransferCommunityView, PersonBlockView, PersonViewSafe, PostView, RegistrationApplicationView, SiteView } from "../views";
 /**
  * Search lemmy for different types of data.
  */
-export interface Search {
+export declare class Search {
     /**
      * The search query string.
      */
     q: string;
-    /**
-     * The [[SearchType]].
-     */
-    type_?: string;
-    community_id?: number;
-    community_name?: string;
-    creator_id?: number;
-    /**
-     * The [[SortType]].
-     */
-    sort?: string;
-    /**
-     * The [[ListingType]].
-     */
-    listing_type?: string;
-    page?: number;
-    limit?: number;
-    auth?: string;
-}
-export interface SearchResponse {
+    type_: Option<SearchType>;
+    community_id: Option<number>;
+    community_name: Option<string>;
+    creator_id: Option<number>;
+    sort: Option<SortType>;
+    listing_type: Option<ListingType>;
+    page: Option<number>;
+    limit: Option<number>;
+    auth: Option<string>;
+    constructor(init: Search);
+}
+export declare class SearchResponse {
     /**
      * The [[SearchType]].
      */
@@ -36,14 +31,15 @@ export interface SearchResponse {
     communities: CommunityView[];
     users: PersonViewSafe[];
 }
-export interface GetModlog {
-    mod_person_id?: number;
-    community_id?: number;
-    page?: number;
-    limit?: number;
-    auth?: string;
+export declare class GetModlog {
+    mod_person_id: Option<number>;
+    community_id: Option<number>;
+    page: Option<number>;
+    limit: Option<number>;
+    auth: Option<string>;
+    constructor(init: GetModlog);
 }
-export interface GetModlogResponse {
+export declare class GetModlogResponse {
     removed_posts: ModRemovePostView[];
     locked_posts: ModLockPostView[];
     stickied_posts: ModStickyPostView[];
@@ -54,125 +50,158 @@ export interface GetModlogResponse {
     added_to_community: ModAddCommunityView[];
     transferred_to_community: ModTransferCommunityView[];
     added: ModAddView[];
+    admin_purged_persons: AdminPurgePersonView[];
+    admin_purged_communities: AdminPurgeCommunityView[];
+    admin_purged_posts: AdminPurgePostView[];
+    admin_purged_comments: AdminPurgeCommentView[];
 }
-export interface CreateSite {
+export declare class CreateSite {
     name: string;
-    sidebar?: string;
-    description?: string;
-    icon?: string;
-    banner?: string;
-    enable_downvotes?: boolean;
-    open_registration?: boolean;
-    enable_nsfw?: boolean;
-    community_creation_admin_only?: boolean;
-    require_email_verification?: boolean;
-    require_application?: boolean;
-    application_question?: string;
-    private_instance?: boolean;
-    default_theme?: string;
-    default_post_listing_type?: string;
+    sidebar: Option<string>;
+    description: Option<string>;
+    icon: Option<string>;
+    banner: Option<string>;
+    enable_downvotes: Option<boolean>;
+    open_registration: Option<boolean>;
+    enable_nsfw: Option<boolean>;
+    community_creation_admin_only: Option<boolean>;
+    require_email_verification: Option<boolean>;
+    require_application: Option<boolean>;
+    application_question: Option<string>;
+    private_instance: Option<boolean>;
+    default_theme: Option<string>;
+    default_post_listing_type: Option<string>;
+    application_email_admins: Option<boolean>;
     auth: string;
-}
-export interface EditSite {
-    name?: string;
-    sidebar?: string;
-    description?: string;
-    icon?: string;
-    banner?: string;
-    enable_downvotes?: boolean;
-    open_registration?: boolean;
-    enable_nsfw?: boolean;
-    community_creation_admin_only?: boolean;
-    require_email_verification?: boolean;
-    require_application?: boolean;
-    application_question?: string;
-    private_instance?: boolean;
-    default_theme?: string;
-    default_post_listing_type?: string;
+    constructor(init: CreateSite);
+}
+export declare class EditSite {
+    name: Option<string>;
+    sidebar: Option<string>;
+    description: Option<string>;
+    icon: Option<string>;
+    banner: Option<string>;
+    enable_downvotes: Option<boolean>;
+    open_registration: Option<boolean>;
+    enable_nsfw: Option<boolean>;
+    community_creation_admin_only: Option<boolean>;
+    require_email_verification: Option<boolean>;
+    require_application: Option<boolean>;
+    application_question: Option<string>;
+    private_instance: Option<boolean>;
+    default_theme: Option<string>;
+    legal_information: Option<string>;
+    default_post_listing_type: Option<string>;
+    application_email_admins: Option<boolean>;
     auth: string;
+    constructor(init: EditSite);
 }
-export interface GetSite {
-    auth?: string;
+export declare class GetSite {
+    auth: Option<string>;
+    constructor(init: GetSite);
 }
-export interface SiteResponse {
+export declare class SiteResponse {
     site_view: SiteView;
 }
-export interface GetSiteResponse {
+export declare class GetSiteResponse {
     /**
      * Optional, because the site might not be set up yet.
      */
-    site_view?: SiteView;
+    site_view: Option<SiteView>;
     admins: PersonViewSafe[];
     online: number;
     version: string;
     /**
      * If you're logged in, you'll get back extra user info.
      */
-    my_user?: MyUserInfo;
-    federated_instances?: FederatedInstances;
+    my_user: Option<MyUserInfo>;
+    federated_instances: Option<FederatedInstances>;
 }
 /**
  * Your user info, such as blocks, follows, etc.
  */
-export interface MyUserInfo {
+export declare class MyUserInfo {
     local_user_view: LocalUserSettingsView;
     follows: CommunityFollowerView[];
     moderates: CommunityModeratorView[];
     community_blocks: CommunityBlockView[];
     person_blocks: PersonBlockView[];
 }
-export interface LeaveAdmin {
+export declare class LeaveAdmin {
     auth: string;
+    constructor(init: LeaveAdmin);
 }
-export interface GetSiteConfig {
-    auth: string;
+export declare class FederatedInstances {
+    linked: string[];
+    allowed: Option<string[]>;
+    blocked: Option<string[]>;
+    constructor(init: FederatedInstances);
 }
-export interface GetSiteConfigResponse {
-    config_hjson: string;
+export declare class ResolveObject {
+    q: string;
+    auth: Option<string>;
+    constructor(init: ResolveObject);
+}
+export declare class ResolveObjectResponse {
+    comment: Option<CommentView>;
+    post: Option<PostView>;
+    community: Option<CommunityView>;
+    person: Option<PersonViewSafe>;
+}
+export declare class PurgePerson {
+    person_id: number;
+    reason: Option<string>;
+    auth: string;
+    constructor(init: PurgePerson);
 }
-export interface SaveSiteConfig {
-    config_hjson: string;
+export declare class PurgeCommunity {
+    community_id: number;
+    reason: Option<string>;
     auth: string;
+    constructor(init: PurgeCommunity);
 }
-export interface FederatedInstances {
-    linked: string[];
-    allowed?: string[];
-    blocked?: string[];
+export declare class PurgePost {
+    post_id: number;
+    reason: Option<string>;
+    auth: string;
+    constructor(init: PurgePost);
 }
-export interface ResolveObject {
-    q: string;
-    auth?: string;
+export declare class PurgeComment {
+    comment_id: number;
+    reason: Option<string>;
+    auth: string;
+    constructor(init: PurgeComment);
 }
-export interface ResolveObjectResponse {
-    comment?: CommentView;
-    post?: PostView;
-    community?: CommunityView;
-    person?: PersonViewSafe;
+export declare class PurgeItemResponse {
+    success: boolean;
 }
-export interface ListRegistrationApplications {
+export declare class ListRegistrationApplications {
     /**
      * Only shows the unread applications (IE those without an admin actor)
      */
-    unread_only?: boolean;
-    page?: number;
-    limit?: number;
+    unread_only: Option<boolean>;
+    page: Option<number>;
+    limit: Option<number>;
     auth: string;
+    constructor(init: ListRegistrationApplications);
 }
-export interface ListRegistrationApplicationsResponse {
+export declare class ListRegistrationApplicationsResponse {
     registration_applications: RegistrationApplicationView[];
 }
-export interface ApproveRegistrationApplication {
+export declare class ApproveRegistrationApplication {
     id: number;
     approve: boolean;
-    deny_reason?: string;
+    deny_reason: Option<string>;
     auth: string;
+    constructor(init: ApproveRegistrationApplication);
 }
-export interface RegistrationApplicationResponse {
+export declare class RegistrationApplicationResponse {
     registration_application: RegistrationApplicationView;
 }
-export interface GetUnreadRegistrationApplicationCount {
+export declare class GetUnreadRegistrationApplicationCount {
     auth: string;
+    constructor(init: GetUnreadRegistrationApplicationCount);
 }
-export interface GetUnreadRegistrationApplicationCountResponse {
+export declare class GetUnreadRegistrationApplicationCountResponse {
     registration_applications: number;
 }