Update misskey-js API md file
This commit is contained in:
ssmucny
parent
bcbc261e3b
commit
5295ddae71
|
|
@ -1680,6 +1680,12 @@ export type Endpoints = {
|
|||
expiresAt?: null | number;
|
||||
expiredAfter?: null | number;
|
||||
};
|
||||
event?: null | {
|
||||
title: string;
|
||||
start: number;
|
||||
end?: null | number;
|
||||
metadata: Record<string, string[]>;
|
||||
};
|
||||
};
|
||||
res: {
|
||||
createdNote: Note;
|
||||
|
|
@ -1759,16 +1765,17 @@ export type Endpoints = {
|
|||
};
|
||||
'notes/events/search': {
|
||||
req: {
|
||||
query?: string;
|
||||
sinceId?: Note['id'];
|
||||
untilId?: Note['id'];
|
||||
limit?: number;
|
||||
offset?: number;
|
||||
host?: string;
|
||||
users?: User['id'][];
|
||||
sinceDate?: number;
|
||||
untilDate?: number;
|
||||
sortBy?: 'startDate' | 'craetedAt';
|
||||
filters?: Record<string, string[]>;
|
||||
sortBy?: 'startDate' | 'createAt'
|
||||
};
|
||||
res: Note[];
|
||||
};
|
||||
'notes/reactions': {
|
||||
|
|
@ -2168,9 +2175,9 @@ export type Endpoints = {
|
|||
req: TODO;
|
||||
res: TODO;
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
declare namespace entities {
|
||||
declare namespace entities {
|
||||
export {
|
||||
ID,
|
||||
DateString,
|
||||
|
|
@ -2213,11 +2220,11 @@ export type Endpoints = {
|
|||
UserSorting,
|
||||
OriginType
|
||||
}
|
||||
}
|
||||
export { entities }
|
||||
}
|
||||
export { entities }
|
||||
|
||||
// @public (undocumented)
|
||||
type FetchLike = (input: string, init?: {
|
||||
// @public (undocumented)
|
||||
type FetchLike = (input: string, init?: {
|
||||
method?: string;
|
||||
body?: string;
|
||||
credentials?: RequestCredentials;
|
||||
|
|
@ -2225,41 +2232,41 @@ export type Endpoints = {
|
|||
headers: {
|
||||
[key in string]: string;
|
||||
};
|
||||
}) => Promise<{
|
||||
}) => Promise<{
|
||||
status: number;
|
||||
json(): Promise<any>;
|
||||
}>;
|
||||
}>;
|
||||
|
||||
// @public (undocumented)
|
||||
export const ffVisibility: readonly ["public", "followers", "private"];
|
||||
// @public (undocumented)
|
||||
export const ffVisibility: readonly ["public", "followers", "private"];
|
||||
|
||||
// @public (undocumented)
|
||||
type Following = {
|
||||
// @public (undocumented)
|
||||
type Following = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
followerId: User['id'];
|
||||
followeeId: User['id'];
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type FollowingFolloweePopulated = Following & {
|
||||
// @public (undocumented)
|
||||
type FollowingFolloweePopulated = Following & {
|
||||
followee: UserDetailed;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type FollowingFollowerPopulated = Following & {
|
||||
// @public (undocumented)
|
||||
type FollowingFollowerPopulated = Following & {
|
||||
follower: UserDetailed;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type FollowRequest = {
|
||||
// @public (undocumented)
|
||||
type FollowRequest = {
|
||||
id: ID;
|
||||
follower: User;
|
||||
followee: User;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type GalleryPost = {
|
||||
// @public (undocumented)
|
||||
type GalleryPost = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
updatedAt: DateString;
|
||||
|
|
@ -2272,13 +2279,13 @@ export type Endpoints = {
|
|||
isSensitive: boolean;
|
||||
likedCount: number;
|
||||
isLiked?: boolean;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type ID = string;
|
||||
// @public (undocumented)
|
||||
type ID = string;
|
||||
|
||||
// @public (undocumented)
|
||||
type Instance = {
|
||||
// @public (undocumented)
|
||||
type Instance = {
|
||||
id: ID;
|
||||
caughtAt: DateString;
|
||||
host: string;
|
||||
|
|
@ -2305,16 +2312,16 @@ export type Endpoints = {
|
|||
faviconUrl: string | null;
|
||||
themeColor: string | null;
|
||||
infoUpdatedAt: DateString | null;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type InstanceMetadata = LiteInstanceMetadata | DetailedInstanceMetadata;
|
||||
// @public (undocumented)
|
||||
type InstanceMetadata = LiteInstanceMetadata | DetailedInstanceMetadata;
|
||||
|
||||
// @public (undocumented)
|
||||
function isAPIError(reason: any): reason is APIError;
|
||||
// @public (undocumented)
|
||||
function isAPIError(reason: any): reason is APIError;
|
||||
|
||||
// @public (undocumented)
|
||||
type LiteInstanceMetadata = {
|
||||
// @public (undocumented)
|
||||
type LiteInstanceMetadata = {
|
||||
maintainerName: string | null;
|
||||
maintainerEmail: string | null;
|
||||
version: string;
|
||||
|
|
@ -2363,10 +2370,10 @@ export type Endpoints = {
|
|||
}[];
|
||||
translatorAvailable: boolean;
|
||||
serverRules: string[];
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type MeDetailed = UserDetailed & {
|
||||
// @public (undocumented)
|
||||
type MeDetailed = UserDetailed & {
|
||||
avatarId: DriveFile['id'];
|
||||
bannerId: DriveFile['id'];
|
||||
autoAcceptFollowed: boolean;
|
||||
|
|
@ -2391,10 +2398,10 @@ export type Endpoints = {
|
|||
receiveAnnouncementEmail: boolean;
|
||||
usePasswordLessLogin: boolean;
|
||||
[other: string]: any;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type MessagingMessage = {
|
||||
// @public (undocumented)
|
||||
type MessagingMessage = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
file: DriveFile | null;
|
||||
|
|
@ -2408,13 +2415,13 @@ export type Endpoints = {
|
|||
recipientId: User['id'] | null;
|
||||
group?: UserGroup | null;
|
||||
groupId: UserGroup['id'] | null;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const mutedNoteReasons: readonly ["word", "manual", "spam", "other"];
|
||||
// @public (undocumented)
|
||||
export const mutedNoteReasons: readonly ["word", "manual", "spam", "other"];
|
||||
|
||||
// @public (undocumented)
|
||||
type Note = {
|
||||
// @public (undocumented)
|
||||
type Note = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
text: string | null;
|
||||
|
|
@ -2429,7 +2436,7 @@ export type Endpoints = {
|
|||
title: string;
|
||||
start: DateString;
|
||||
end: DateString | null;
|
||||
metadata: Record<string, string[]>;
|
||||
metadata: Record<string, string>;
|
||||
};
|
||||
files: DriveFile[];
|
||||
fileIds: DriveFile['id'][];
|
||||
|
|
@ -2456,95 +2463,95 @@ export type Endpoints = {
|
|||
uri?: string;
|
||||
url?: string;
|
||||
isHidden?: boolean;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type NoteFavorite = {
|
||||
// @public (undocumented)
|
||||
type NoteFavorite = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
noteId: Note['id'];
|
||||
note: Note;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type NoteReaction = {
|
||||
// @public (undocumented)
|
||||
type NoteReaction = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
user: UserLite;
|
||||
type: string;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const noteVisibilities: readonly ["public", "home", "followers", "specified"];
|
||||
// @public (undocumented)
|
||||
export const noteVisibilities: readonly ["public", "home", "followers", "specified"];
|
||||
|
||||
// @public (undocumented)
|
||||
type Notification_2 = {
|
||||
// @public (undocumented)
|
||||
type Notification_2 = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
isRead: boolean;
|
||||
} & ({
|
||||
} & ({
|
||||
type: 'reaction';
|
||||
reaction: string;
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
note: Note;
|
||||
} | {
|
||||
} | {
|
||||
type: 'reply';
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
note: Note;
|
||||
} | {
|
||||
} | {
|
||||
type: 'renote';
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
note: Note;
|
||||
} | {
|
||||
} | {
|
||||
type: 'quote';
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
note: Note;
|
||||
} | {
|
||||
} | {
|
||||
type: 'mention';
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
note: Note;
|
||||
} | {
|
||||
} | {
|
||||
type: 'pollVote';
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
note: Note;
|
||||
} | {
|
||||
} | {
|
||||
type: 'follow';
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
} | {
|
||||
} | {
|
||||
type: 'followRequestAccepted';
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
} | {
|
||||
} | {
|
||||
type: 'receiveFollowRequest';
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
} | {
|
||||
} | {
|
||||
type: 'groupInvited';
|
||||
invitation: UserGroup;
|
||||
user: User;
|
||||
userId: User['id'];
|
||||
} | {
|
||||
} | {
|
||||
type: 'app';
|
||||
header?: string | null;
|
||||
body: string;
|
||||
icon?: string | null;
|
||||
});
|
||||
});
|
||||
|
||||
// @public (undocumented)
|
||||
export const notificationTypes: readonly ["follow", "mention", "reply", "renote", "quote", "reaction", "pollVote", "pollEnded", "receiveFollowRequest", "followRequestAccepted", "groupInvited", "app"];
|
||||
// @public (undocumented)
|
||||
export const notificationTypes: readonly ["follow", "mention", "reply", "renote", "quote", "reaction", "pollVote", "pollEnded", "receiveFollowRequest", "followRequestAccepted", "groupInvited", "app"];
|
||||
|
||||
// @public (undocumented)
|
||||
type OriginType = 'combined' | 'local' | 'remote';
|
||||
// @public (undocumented)
|
||||
type OriginType = 'combined' | 'local' | 'remote';
|
||||
|
||||
// @public (undocumented)
|
||||
type Page = {
|
||||
// @public (undocumented)
|
||||
type Page = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
updatedAt: DateString;
|
||||
|
|
@ -2564,22 +2571,22 @@ export type Endpoints = {
|
|||
attachedFiles: any;
|
||||
likedCount: number;
|
||||
isLiked?: boolean;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type PageEvent = {
|
||||
// @public (undocumented)
|
||||
type PageEvent = {
|
||||
pageId: Page['id'];
|
||||
event: string;
|
||||
var: any;
|
||||
userId: User['id'];
|
||||
user: User;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
export const permissions: string[];
|
||||
// @public (undocumented)
|
||||
export const permissions: string[];
|
||||
|
||||
// @public (undocumented)
|
||||
type ServerInfo = {
|
||||
// @public (undocumented)
|
||||
type ServerInfo = {
|
||||
machine: string;
|
||||
cpu: {
|
||||
model: string;
|
||||
|
|
@ -2592,19 +2599,19 @@ export type Endpoints = {
|
|||
total: number;
|
||||
used: number;
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type Signin = {
|
||||
// @public (undocumented)
|
||||
type Signin = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
ip: string;
|
||||
headers: Record<string, any>;
|
||||
success: boolean;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type Stats = {
|
||||
// @public (undocumented)
|
||||
type Stats = {
|
||||
notesCount: number;
|
||||
originalNotesCount: number;
|
||||
usersCount: number;
|
||||
|
|
@ -2612,12 +2619,12 @@ export type Endpoints = {
|
|||
instances: number;
|
||||
driveUsageLocal: number;
|
||||
driveUsageRemote: number;
|
||||
};
|
||||
};
|
||||
|
||||
// Warning: (ae-forgotten-export) The symbol "StreamEvents" needs to be exported by the entry point index.d.ts
|
||||
//
|
||||
// @public (undocumented)
|
||||
export class Stream extends EventEmitter<StreamEvents> {
|
||||
// Warning: (ae-forgotten-export) The symbol "StreamEvents" needs to be exported by the entry point index.d.ts
|
||||
//
|
||||
// @public (undocumented)
|
||||
export class Stream extends EventEmitter<StreamEvents> {
|
||||
constructor(origin: string, user: {
|
||||
token: string;
|
||||
} | null, options?: {
|
||||
|
|
@ -2647,13 +2654,13 @@ export type Endpoints = {
|
|||
state: 'initializing' | 'reconnecting' | 'connected';
|
||||
// (undocumented)
|
||||
useChannel<C extends keyof Channels>(channel: C, params?: Channels[C]['params'], name?: string): ChannelConnection<Channels[C]>;
|
||||
}
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
type User = UserLite | UserDetailed;
|
||||
// @public (undocumented)
|
||||
type User = UserLite | UserDetailed;
|
||||
|
||||
// @public (undocumented)
|
||||
type UserDetailed = UserLite & {
|
||||
// @public (undocumented)
|
||||
type UserDetailed = UserLite & {
|
||||
bannerBlurhash: string | null;
|
||||
bannerColor: string | null;
|
||||
bannerUrl: string | null;
|
||||
|
|
@ -2695,21 +2702,21 @@ export type Endpoints = {
|
|||
updatedAt: DateString | null;
|
||||
uri: string | null;
|
||||
url: string | null;
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type UserGroup = TODO_2;
|
||||
// @public (undocumented)
|
||||
type UserGroup = TODO_2;
|
||||
|
||||
// @public (undocumented)
|
||||
type UserList = {
|
||||
// @public (undocumented)
|
||||
type UserList = {
|
||||
id: ID;
|
||||
createdAt: DateString;
|
||||
name: string;
|
||||
userIds: User['id'][];
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type UserLite = {
|
||||
// @public (undocumented)
|
||||
type UserLite = {
|
||||
id: ID;
|
||||
username: string;
|
||||
host: string | null;
|
||||
|
|
@ -2731,18 +2738,18 @@ export type Endpoints = {
|
|||
faviconUrl: Instance['faviconUrl'];
|
||||
themeColor: Instance['themeColor'];
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
// @public (undocumented)
|
||||
type UserSorting = '+follower' | '-follower' | '+createdAt' | '-createdAt' | '+updatedAt' | '-updatedAt';
|
||||
// @public (undocumented)
|
||||
type UserSorting = '+follower' | '-follower' | '+createdAt' | '-createdAt' | '+updatedAt' | '-updatedAt';
|
||||
|
||||
// Warnings were encountered during analysis:
|
||||
//
|
||||
// src/api.types.ts:16:32 - (ae-forgotten-export) The symbol "TODO" needs to be exported by the entry point index.d.ts
|
||||
// src/api.types.ts:18:25 - (ae-forgotten-export) The symbol "NoParams" needs to be exported by the entry point index.d.ts
|
||||
// src/api.types.ts:602:27 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts
|
||||
// src/streaming.types.ts:33:4 - (ae-forgotten-export) The symbol "FIXME" needs to be exported by the entry point index.d.ts
|
||||
// Warnings were encountered during analysis:
|
||||
//
|
||||
// src/api.types.ts:16:32 - (ae-forgotten-export) The symbol "TODO" needs to be exported by the entry point index.d.ts
|
||||
// src/api.types.ts:18:25 - (ae-forgotten-export) The symbol "NoParams" needs to be exported by the entry point index.d.ts
|
||||
// src/api.types.ts:614:18 - (ae-forgotten-export) The symbol "ShowUserReq" needs to be exported by the entry point index.d.ts
|
||||
// src/streaming.types.ts:33:4 - (ae-forgotten-export) The symbol "FIXME" needs to be exported by the entry point index.d.ts
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
// (No @packageDocumentation comment for this package)
|
||||
|
||||
```
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue