lemmy-js-client 0.17.0-rc.14 → 0.17.0-rc.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,25 +1,26 @@
1
- import { Option } from "option-t/esm/PlainOption";
1
+ import { Option } from "@sniptt/monads";
2
2
  import { ListingType, SearchType, SortType } from "../others";
3
3
  import { CommentView, CommunityBlockView, CommunityFollowerView, CommunityModeratorView, CommunityView, LocalUserSettingsView, ModAddCommunityView, ModAddView, ModBanFromCommunityView, ModBanView, ModLockPostView, ModRemoveCommentView, ModRemoveCommunityView, ModRemovePostView, ModStickyPostView, ModTransferCommunityView, PersonBlockView, PersonViewSafe, PostView, RegistrationApplicationView, SiteView } from "../views";
4
4
  /**
5
5
  * Search lemmy for different types of data.
6
6
  */
7
- export interface Search {
7
+ export declare class Search {
8
8
  /**
9
9
  * The search query string.
10
10
  */
11
11
  q: string;
12
- type_?: SearchType;
13
- community_id?: number;
14
- community_name?: string;
15
- creator_id?: number;
16
- sort?: SortType;
17
- listing_type?: ListingType;
18
- page?: number;
19
- limit?: number;
20
- auth?: string;
21
- }
22
- export interface SearchResponse {
12
+ type_: Option<SearchType>;
13
+ community_id: Option<number>;
14
+ community_name: Option<string>;
15
+ creator_id: Option<number>;
16
+ sort: Option<SortType>;
17
+ listing_type: Option<ListingType>;
18
+ page: Option<number>;
19
+ limit: Option<number>;
20
+ auth: Option<string>;
21
+ constructor(q: string, 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>);
22
+ }
23
+ export declare class SearchResponse {
23
24
  /**
24
25
  * The [[SearchType]].
25
26
  */
@@ -29,14 +30,15 @@ export interface SearchResponse {
29
30
  communities: CommunityView[];
30
31
  users: PersonViewSafe[];
31
32
  }
32
- export interface GetModlog {
33
- mod_person_id?: number;
34
- community_id?: number;
35
- page?: number;
36
- limit?: number;
37
- auth?: string;
33
+ export declare class GetModlog {
34
+ mod_person_id: Option<number>;
35
+ community_id: Option<number>;
36
+ page: Option<number>;
37
+ limit: Option<number>;
38
+ auth: Option<string>;
39
+ constructor(mod_person_id: Option<number>, community_id: Option<number>, page: Option<number>, limit: Option<number>, auth: Option<string>);
38
40
  }
39
- export interface GetModlogResponse {
41
+ export declare class GetModlogResponse {
40
42
  removed_posts: ModRemovePostView[];
41
43
  locked_posts: ModLockPostView[];
42
44
  stickied_posts: ModStickyPostView[];
@@ -48,62 +50,65 @@ export interface GetModlogResponse {
48
50
  transferred_to_community: ModTransferCommunityView[];
49
51
  added: ModAddView[];
50
52
  }
51
- export interface CreateSite {
53
+ export declare class CreateSite {
52
54
  name: string;
53
55
  sidebar: Option<string>;
54
- description?: string;
55
- icon?: string;
56
- banner?: string;
57
- enable_downvotes?: boolean;
58
- open_registration?: boolean;
59
- enable_nsfw?: boolean;
60
- community_creation_admin_only?: boolean;
61
- require_email_verification?: boolean;
62
- require_application?: boolean;
63
- application_question?: string;
64
- private_instance?: boolean;
65
- default_theme?: string;
66
- default_post_listing_type?: string;
56
+ description: Option<string>;
57
+ icon: Option<string>;
58
+ banner: Option<string>;
59
+ enable_downvotes: Option<boolean>;
60
+ open_registration: Option<boolean>;
61
+ enable_nsfw: Option<boolean>;
62
+ community_creation_admin_only: Option<boolean>;
63
+ require_email_verification: Option<boolean>;
64
+ require_application: Option<boolean>;
65
+ application_question: Option<string>;
66
+ private_instance: Option<boolean>;
67
+ default_theme: Option<string>;
68
+ default_post_listing_type: Option<string>;
67
69
  auth: string;
70
+ constructor(name: 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>, auth: string);
68
71
  }
69
- export interface EditSite {
70
- name?: string;
72
+ export declare class EditSite {
73
+ name: Option<string>;
71
74
  sidebar: Option<string>;
72
- description?: string;
73
- icon?: string;
74
- banner?: string;
75
- enable_downvotes?: boolean;
76
- open_registration?: boolean;
77
- enable_nsfw?: boolean;
78
- community_creation_admin_only?: boolean;
79
- require_email_verification?: boolean;
80
- require_application?: boolean;
81
- application_question?: string;
82
- private_instance?: boolean;
83
- default_theme?: string;
84
- legal_information?: string;
85
- default_post_listing_type?: string;
75
+ description: Option<string>;
76
+ icon: Option<string>;
77
+ banner: Option<string>;
78
+ enable_downvotes: Option<boolean>;
79
+ open_registration: Option<boolean>;
80
+ enable_nsfw: Option<boolean>;
81
+ community_creation_admin_only: Option<boolean>;
82
+ require_email_verification: Option<boolean>;
83
+ require_application: Option<boolean>;
84
+ application_question: Option<string>;
85
+ private_instance: Option<boolean>;
86
+ default_theme: Option<string>;
87
+ legal_information: Option<string>;
88
+ default_post_listing_type: Option<string>;
86
89
  auth: string;
90
+ constructor(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>, auth: string);
87
91
  }
88
- export interface GetSite {
89
- auth?: string;
92
+ export declare class GetSite {
93
+ auth: Option<string>;
94
+ constructor(auth: Option<string>);
90
95
  }
91
- export interface SiteResponse {
96
+ export declare class SiteResponse {
92
97
  site_view: SiteView;
93
98
  }
94
- export interface GetSiteResponse {
99
+ export declare class GetSiteResponse {
95
100
  /**
96
101
  * Optional, because the site might not be set up yet.
97
102
  */
98
- site_view?: SiteView;
103
+ site_view: Option<SiteView>;
99
104
  admins: PersonViewSafe[];
100
105
  online: number;
101
106
  version: string;
102
107
  /**
103
108
  * If you're logged in, you'll get back extra user info.
104
109
  */
105
- my_user?: MyUserInfo;
106
- federated_instances?: FederatedInstances;
110
+ my_user: Option<MyUserInfo>;
111
+ federated_instances: Option<FederatedInstances>;
107
112
  }
108
113
  /**
109
114
  * Your user info, such as blocks, follows, etc.
@@ -115,58 +120,65 @@ export interface MyUserInfo {
115
120
  community_blocks: CommunityBlockView[];
116
121
  person_blocks: PersonBlockView[];
117
122
  }
118
- export interface LeaveAdmin {
123
+ export declare class LeaveAdmin {
119
124
  auth: string;
125
+ constructor(auth: string);
120
126
  }
121
- export interface GetSiteConfig {
127
+ export declare class GetSiteConfig {
122
128
  auth: string;
129
+ constructor(auth: string);
123
130
  }
124
- export interface GetSiteConfigResponse {
131
+ export declare class GetSiteConfigResponse {
125
132
  config_hjson: string;
126
133
  }
127
- export interface SaveSiteConfig {
134
+ export declare class SaveSiteConfig {
128
135
  config_hjson: string;
129
136
  auth: string;
137
+ constructor(config_hjson: string, auth: string);
130
138
  }
131
- export interface FederatedInstances {
139
+ export declare class FederatedInstances {
132
140
  linked: string[];
133
- allowed?: string[];
134
- blocked?: string[];
141
+ allowed: Option<string[]>;
142
+ blocked: Option<string[]>;
135
143
  }
136
- export interface ResolveObject {
144
+ export declare class ResolveObject {
137
145
  q: string;
138
- auth?: string;
146
+ auth: Option<string>;
147
+ constructor(q: string, auth: Option<string>);
139
148
  }
140
- export interface ResolveObjectResponse {
141
- comment?: CommentView;
142
- post?: PostView;
143
- community?: CommunityView;
144
- person?: PersonViewSafe;
149
+ export declare class ResolveObjectResponse {
150
+ comment: Option<CommentView>;
151
+ post: Option<PostView>;
152
+ community: Option<CommunityView>;
153
+ person: Option<PersonViewSafe>;
145
154
  }
146
- export interface ListRegistrationApplications {
155
+ export declare class ListRegistrationApplications {
147
156
  /**
148
157
  * Only shows the unread applications (IE those without an admin actor)
149
158
  */
150
- unread_only?: boolean;
151
- page?: number;
152
- limit?: number;
159
+ unread_only: Option<boolean>;
160
+ page: Option<number>;
161
+ limit: Option<number>;
153
162
  auth: string;
163
+ constructor(unread_only: Option<boolean>, page: Option<number>, limit: Option<number>, auth: string);
154
164
  }
155
- export interface ListRegistrationApplicationsResponse {
165
+ export declare class ListRegistrationApplicationsResponse {
156
166
  registration_applications: RegistrationApplicationView[];
157
167
  }
158
- export interface ApproveRegistrationApplication {
168
+ export declare class ApproveRegistrationApplication {
159
169
  id: number;
160
170
  approve: boolean;
161
- deny_reason?: string;
171
+ deny_reason: Option<string>;
162
172
  auth: string;
173
+ constructor(id: number, approve: boolean, deny_reason: Option<string>, auth: string);
163
174
  }
164
- export interface RegistrationApplicationResponse {
175
+ export declare class RegistrationApplicationResponse {
165
176
  registration_application: RegistrationApplicationView;
166
177
  }
167
- export interface GetUnreadRegistrationApplicationCount {
178
+ export declare class GetUnreadRegistrationApplicationCount {
168
179
  auth: string;
180
+ constructor(auth: string);
169
181
  }
170
- export interface GetUnreadRegistrationApplicationCountResponse {
182
+ export declare class GetUnreadRegistrationApplicationCountResponse {
171
183
  registration_applications: number;
172
184
  }