3973 lines
111 KiB
TypeScript
3973 lines
111 KiB
TypeScript
/*
|
|
* version: 2023.12.0
|
|
* generatedAt: 2023-12-24T08:46:11.020Z
|
|
*/
|
|
|
|
import type { SwitchCaseResponseType } from '../api.js';
|
|
import type { Endpoints } from './endpoint.js';
|
|
|
|
declare module '../api.js' {
|
|
export interface APIClient {
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/meta', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/abuse-user-reports', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/accounts/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/accounts/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/accounts/find-by-email', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/ad/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/ad/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/ad/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/ad/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/announcements/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/announcements/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/announcements/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/announcements/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/avatar-decorations/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/avatar-decorations/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/avatar-decorations/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/avatar-decorations/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/delete-all-files-of-a-user', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/unset-user-avatar', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/unset-user-banner', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/drive/clean-remote-files', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/drive/cleanup', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/drive/files', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/drive/show-file', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/add-aliases-bulk', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/add', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/copy', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/delete-bulk', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/import-zip', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/list-remote', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/remove-aliases-bulk', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/set-aliases-bulk', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/set-category-bulk', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/set-license-bulk', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/emoji/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/federation/delete-all-files', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/federation/refresh-remote-instance-metadata', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/federation/remove-all-following', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/federation/update-instance', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/get-index-stats', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/get-table-stats', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/get-user-ips', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/invite/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/invite/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/promo/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/queue/clear', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/queue/deliver-delayed', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/queue/inbox-delayed', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/queue/promote', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/queue/stats', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/relays/add', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/relays/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/relays/remove', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/reset-password', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/resolve-abuse-user-report', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/send-email', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/server-info', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/show-moderation-logs', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/show-user', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/show-users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/suspend-user', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/unsuspend-user', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/update-meta', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/delete-account', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/update-user-note', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/roles/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/roles/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/roles/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/roles/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/roles/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/roles/assign', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/roles/unassign', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:admin*
|
|
*/
|
|
request<E extends 'admin/roles/update-default-policies', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No* / **Permission**: *read:admin*
|
|
*/
|
|
request<E extends 'admin/roles/users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'announcements', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'antennas/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'antennas/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'antennas/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'antennas/notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'antennas/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'antennas/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'ap/get', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'ap/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'app/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'app/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'auth/accept', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'auth/session/generate', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'auth/session/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'auth/session/userkey', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:blocks*
|
|
*/
|
|
request<E extends 'blocking/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:blocks*
|
|
*/
|
|
request<E extends 'blocking/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:blocks*
|
|
*/
|
|
request<E extends 'blocking/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:channels*
|
|
*/
|
|
request<E extends 'channels/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'channels/featured', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:channels*
|
|
*/
|
|
request<E extends 'channels/follow', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:channels*
|
|
*/
|
|
request<E extends 'channels/followed', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:channels*
|
|
*/
|
|
request<E extends 'channels/owned', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'channels/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'channels/timeline', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:channels*
|
|
*/
|
|
request<E extends 'channels/unfollow', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:channels*
|
|
*/
|
|
request<E extends 'channels/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:channels*
|
|
*/
|
|
request<E extends 'channels/favorite', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:channels*
|
|
*/
|
|
request<E extends 'channels/unfavorite', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:channels*
|
|
*/
|
|
request<E extends 'channels/my-favorites', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'channels/search', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/active-users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/ap-request', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/drive', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/federation', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/instance', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/user/drive', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/user/following', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/user/notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/user/pv', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/user/reactions', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'charts/users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'clips/add-note', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'clips/remove-note', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'clips/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'clips/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'clips/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'clips/notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'clips/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'clips/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:clip-favorite*
|
|
*/
|
|
request<E extends 'clips/favorite', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:clip-favorite*
|
|
*/
|
|
request<E extends 'clips/unfavorite', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:clip-favorite*
|
|
*/
|
|
request<E extends 'clips/my-favorites', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/files', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Find the notes to which the given file is attached.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/files/attached-notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Check if a given file exists.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/files/check-existence', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Upload a new drive file.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:drive*
|
|
*/
|
|
request<E extends 'drive/files/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Delete an existing drive file.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:drive*
|
|
*/
|
|
request<E extends 'drive/files/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Search for a drive file by a hash of the contents.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/files/find-by-hash', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Search for a drive file by the given parameters.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/files/find', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show the properties of a drive file.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/files/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Update the properties of a drive file.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:drive*
|
|
*/
|
|
request<E extends 'drive/files/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Request the server to download a new drive file from the specified URL.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:drive*
|
|
*/
|
|
request<E extends 'drive/files/upload-from-url', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/folders', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:drive*
|
|
*/
|
|
request<E extends 'drive/folders/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:drive*
|
|
*/
|
|
request<E extends 'drive/folders/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/folders/find', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/folders/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:drive*
|
|
*/
|
|
request<E extends 'drive/folders/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:drive*
|
|
*/
|
|
request<E extends 'drive/stream', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'email-address/available', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'endpoint', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'endpoints', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'export-custom-emojis', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'federation/followers', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'federation/following', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'federation/instances', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'federation/show-instance', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'federation/update-remote-user', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'federation/users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'federation/stats', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:following*
|
|
*/
|
|
request<E extends 'following/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:following*
|
|
*/
|
|
request<E extends 'following/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:following*
|
|
*/
|
|
request<E extends 'following/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:following*
|
|
*/
|
|
request<E extends 'following/update-all', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:following*
|
|
*/
|
|
request<E extends 'following/invalidate', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:following*
|
|
*/
|
|
request<E extends 'following/requests/accept', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:following*
|
|
*/
|
|
request<E extends 'following/requests/cancel', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:following*
|
|
*/
|
|
request<E extends 'following/requests/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:following*
|
|
*/
|
|
request<E extends 'following/requests/reject', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'gallery/featured', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'gallery/popular', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'gallery/posts', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:gallery*
|
|
*/
|
|
request<E extends 'gallery/posts/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:gallery*
|
|
*/
|
|
request<E extends 'gallery/posts/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:gallery-likes*
|
|
*/
|
|
request<E extends 'gallery/posts/like', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'gallery/posts/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:gallery-likes*
|
|
*/
|
|
request<E extends 'gallery/posts/unlike', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:gallery*
|
|
*/
|
|
request<E extends 'gallery/posts/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'get-online-users-count', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'get-avatar-decorations', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'hashtags/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'hashtags/search', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'hashtags/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'hashtags/trend', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'hashtags/users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/2fa/done', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/2fa/key-done', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/2fa/password-less', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/2fa/register-key', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/2fa/register', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/2fa/update-key', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/2fa/remove-key', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/2fa/unregister', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/apps', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/authorized-apps', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/claim-achievement', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/change-password', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/delete-account', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/export-blocking', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/export-following', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/export-mute', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/export-notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/export-favorites', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/export-user-lists', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/export-antennas', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:favorites*
|
|
*/
|
|
request<E extends 'i/favorites', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:gallery-likes*
|
|
*/
|
|
request<E extends 'i/gallery/likes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:gallery*
|
|
*/
|
|
request<E extends 'i/gallery/posts', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/import-blocking', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/import-following', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/import-muting', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/import-user-lists', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/import-antennas', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:notifications*
|
|
*/
|
|
request<E extends 'i/notifications', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:notifications*
|
|
*/
|
|
request<E extends 'i/notifications-grouped', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:page-likes*
|
|
*/
|
|
request<E extends 'i/page-likes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:pages*
|
|
*/
|
|
request<E extends 'i/pages', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'i/pin', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'i/read-all-unread-notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'i/read-announcement', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/regenerate-token', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/registry/get-all', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/registry/get-detail', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/registry/get', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/registry/keys-with-type', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/registry/keys', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/registry/remove', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/registry/scopes-with-domain', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/registry/set', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/revoke-token', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/signin-history', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'i/unpin', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/update-email', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'i/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'i/move', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'i/webhooks/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'i/webhooks/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'i/webhooks/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'i/webhooks/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'i/webhooks/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'invite/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'invite/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'invite/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'invite/limit', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'meta', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'emojis', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'emoji', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'miauth/gen-token', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:mutes*
|
|
*/
|
|
request<E extends 'mute/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:mutes*
|
|
*/
|
|
request<E extends 'mute/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:mutes*
|
|
*/
|
|
request<E extends 'mute/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:mutes*
|
|
*/
|
|
request<E extends 'renote-mute/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:mutes*
|
|
*/
|
|
request<E extends 'renote-mute/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:mutes*
|
|
*/
|
|
request<E extends 'renote-mute/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'my/apps', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/children', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/clips', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/conversation', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:notes*
|
|
*/
|
|
request<E extends 'notes/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:notes*
|
|
*/
|
|
request<E extends 'notes/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:favorites*
|
|
*/
|
|
request<E extends 'notes/favorites/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:favorites*
|
|
*/
|
|
request<E extends 'notes/favorites/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/featured', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/global-timeline', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'notes/hybrid-timeline', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/local-timeline', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'notes/mentions', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'notes/polls/recommendation', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:votes*
|
|
*/
|
|
request<E extends 'notes/polls/vote', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/reactions', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:reactions*
|
|
*/
|
|
request<E extends 'notes/reactions/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:reactions*
|
|
*/
|
|
request<E extends 'notes/reactions/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/renotes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/replies', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/search-by-tag', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/search', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'notes/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'notes/state', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'notes/thread-muting/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'notes/thread-muting/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'notes/timeline', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'notes/translate', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:notes*
|
|
*/
|
|
request<E extends 'notes/unrenote', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'notes/user-list-timeline', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:notifications*
|
|
*/
|
|
request<E extends 'notifications/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:notifications*
|
|
*/
|
|
request<E extends 'notifications/mark-all-as-read', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:notifications*
|
|
*/
|
|
request<E extends 'notifications/test-notification', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Internal Endpoint**: This endpoint is an API for the misskey mainframe and is not intended for use by third parties.
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'page-push', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:pages*
|
|
*/
|
|
request<E extends 'pages/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:pages*
|
|
*/
|
|
request<E extends 'pages/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'pages/featured', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:page-likes*
|
|
*/
|
|
request<E extends 'pages/like', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'pages/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:page-likes*
|
|
*/
|
|
request<E extends 'pages/unlike', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:pages*
|
|
*/
|
|
request<E extends 'pages/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:flash*
|
|
*/
|
|
request<E extends 'flash/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:flash*
|
|
*/
|
|
request<E extends 'flash/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'flash/featured', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:flash-likes*
|
|
*/
|
|
request<E extends 'flash/like', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'flash/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:flash-likes*
|
|
*/
|
|
request<E extends 'flash/unlike', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:flash*
|
|
*/
|
|
request<E extends 'flash/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:flash*
|
|
*/
|
|
request<E extends 'flash/my', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:flash-likes*
|
|
*/
|
|
request<E extends 'flash/my-likes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'ping', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'pinned-users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'promo/read', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'roles/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'roles/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'roles/users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'roles/notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Request a users password to be reset.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'request-reset-password', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Only available when running with <code>NODE_ENV=testing</code>. Reset the database and flush Redis.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'reset-db', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Complete the password reset that was previously requested.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'reset-password', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'server-info', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'stats', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Check push notification registration exists.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'sw/show-registration', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Update push notification registration.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'sw/update-registration', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Register to receive push notifications.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'sw/register', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Unregister from receiving push notifications.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'sw/unregister', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Endpoint for testing input validation.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'test', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'username/available', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show all clips this user owns.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/clips', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show everyone that follows this user.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/followers', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show everyone that this user is following.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/following', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show all gallery posts by the given user.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/gallery/posts', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Get a list of other users that the specified user frequently replies to.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/get-frequently-replied-users', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/featured-notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Create a new list of users.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'users/lists/create', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Delete an existing list of users.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'users/lists/delete', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show all lists that the authenticated user has created.
|
|
*
|
|
* **Credential required**: *No* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'users/lists/list', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Remove a user from a list.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'users/lists/pull', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Add a user to an existing list.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'users/lists/push', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show the properties of a list.
|
|
*
|
|
* **Credential required**: *No* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'users/lists/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'users/lists/favorite', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'users/lists/unfavorite', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Update the properties of a list.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'users/lists/update', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'users/lists/create-from-public', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'users/lists/update-membership', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'users/lists/get-memberships', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/notes', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show all pages this user created.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/pages', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show all flashs this user created.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/flashs', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show all reactions this user made.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/reactions', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show users that the authenticated user might be interested to follow.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *read:account*
|
|
*/
|
|
request<E extends 'users/recommendation', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show the different kinds of relations between the authenticated user and the specified user(s).
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'users/relation', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* File a report.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'users/report-abuse', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Search for a user by username and/or host.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/search-by-username-and-host', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Search for users.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/search', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* Show the properties of a user.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'users/show', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'users/achievements', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes* / **Permission**: *write:account*
|
|
*/
|
|
request<E extends 'users/update-memo', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'fetch-rss', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *Yes*
|
|
*/
|
|
request<E extends 'fetch-external-resources', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
|
|
/**
|
|
* No description provided.
|
|
*
|
|
* **Credential required**: *No*
|
|
*/
|
|
request<E extends 'retention', P extends Endpoints[E]['req']>(
|
|
endpoint: E,
|
|
params: P,
|
|
credential?: string | null,
|
|
): Promise<SwitchCaseResponseType<E, P>>;
|
|
}
|
|
}
|