findcord
Version:
discord botları için tasarlanmış bir api
381 lines (376 loc) • 20.4 kB
text/typescript
import * as http from 'http';
import * as nyro_dist_esm_src_services_engine from 'nyro/dist/esm/src/services/engine';
import * as nyro from 'nyro';
import { ResponseInterface } from 'nyro';
declare class Router {
static client: Promise<{
[EventEmitter.captureRejectionSymbol]?: (<K>(error: Error, event: string | symbol, ...args: any[]) => void) | undefined;
get: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
post: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
put: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
delete: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
patch: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
head: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
options: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
connect: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
trace: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
baseRequestOptions: nyro.OptionsInterface;
pluginManager: nyro.Plugin;
use: (plugin: nyro.PluginInterface) => void;
on: <K extends keyof nyro.Events>(event: K, listener: nyro.Events[K]) => nyro_dist_esm_src_services_engine.default;
once: <K extends keyof nyro.Events>(event: K, listener: nyro.Events[K]) => nyro_dist_esm_src_services_engine.default;
off: <K extends keyof nyro.Events>(event: K, listener: nyro.Events[K]) => nyro_dist_esm_src_services_engine.default;
emit: <K extends keyof nyro.Events>(event: K, ...args: Parameters<nyro.Events[K]>) => boolean;
setURL: (url: string) => nyro_dist_esm_src_services_engine.default;
setBaseURL: (baseURL: string) => nyro_dist_esm_src_services_engine.default;
setPath: (path: string) => nyro_dist_esm_src_services_engine.default;
setBodySchema: (bodySchema: any) => nyro_dist_esm_src_services_engine.default;
setAuth: (auth: nyro.AuthOptions) => nyro_dist_esm_src_services_engine.default;
setProxy: (proxy: nyro.ProxyOptions) => nyro_dist_esm_src_services_engine.default;
setMethod: (method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "CONNECT" | "TRACE") => nyro_dist_esm_src_services_engine.default;
setHeaders: (headers: (nyro.HeadersInterface & Record<string, string>)) => nyro_dist_esm_src_services_engine.default;
setParams: (params: Record<string, string>) => nyro_dist_esm_src_services_engine.default;
setQuery: (query: Record<string, string | number | boolean>) => nyro_dist_esm_src_services_engine.default;
setBody: (body: any) => nyro_dist_esm_src_services_engine.default;
setTimeout: (timeout: number) => nyro_dist_esm_src_services_engine.default;
setRetryOn: (retryOn: (req: http.RequestOptions, error: Error) => boolean) => nyro_dist_esm_src_services_engine.default;
setRetries: (retries: number) => nyro_dist_esm_src_services_engine.default;
setValidateStatus: (validateStatus: (status: number) => boolean) => nyro_dist_esm_src_services_engine.default;
setMaxBodyLength: (maxBodyLength: number) => nyro_dist_esm_src_services_engine.default;
setMaxContentLength: (maxContentLength: number) => nyro_dist_esm_src_services_engine.default;
setMaxRate: (maxRate: number) => nyro_dist_esm_src_services_engine.default;
setSignal: (signal: AbortSignal) => nyro_dist_esm_src_services_engine.default;
setOnDownloadProgress: (onDownloadProgress: (progress: {
percent: number;
transferredBytes: number;
totalBytes: number;
}) => void) => nyro_dist_esm_src_services_engine.default;
setTimeoutErrorMessage: (timeoutErrorMessage: string) => nyro_dist_esm_src_services_engine.default;
setResponseType: (responseType: ("json" | "text" | "blob" | "stream" | "arrayBuffer" | ("document" & string))) => nyro_dist_esm_src_services_engine.default;
setResponseEncoding: (responseEncoding: BufferEncoding) => nyro_dist_esm_src_services_engine.default;
setMaxRedirects: (maxRedirects: number) => nyro_dist_esm_src_services_engine.default;
setRetryDelay: (retryDelay: number) => nyro_dist_esm_src_services_engine.default;
setDecompress: (decompress: boolean) => nyro_dist_esm_src_services_engine.default;
download: <T, B>(url?: string, options?: nyro.OptionsInterface<B>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
pagination: <T, B>(options?: nyro.OptionsInterface<B>, paginationOptions?: nyro.PaginationOptions) => Promise<Array<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>>;
queue: <T, B>(requests: Array<nyro.OptionsInterface<B>>, queueOptions?: nyro.QueueOptions) => Promise<Array<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>>;
extend: <T, B>(extendOptions: nyro.OptionsInterface<B>) => Promise<{
[EventEmitter.captureRejectionSymbol]?: (<K>(error: Error, event: string | symbol, ...args: any[]) => void) | undefined;
get: <T_1, B_1>(url?: string, options?: nyro.OptionsInterface<B_1>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_1, nyro.OptionsInterface>>>;
post: <T_1, B_2>(url?: string, options?: nyro.OptionsInterface<B_2>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_2, nyro.OptionsInterface>>>;
put: <T_1, B_3>(url?: string, options?: nyro.OptionsInterface<B_3>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_3, nyro.OptionsInterface>>>;
delete: <T_1, B_4>(url?: string, options?: nyro.OptionsInterface<B_4>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_4, nyro.OptionsInterface>>>;
patch: <T_1, B_5>(url?: string, options?: nyro.OptionsInterface<B_5>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_5, nyro.OptionsInterface>>>;
head: <T_1, B_6>(url?: string, options?: nyro.OptionsInterface<B_6>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_6, nyro.OptionsInterface>>>;
options: <T_1, B_7>(url?: string, options?: nyro.OptionsInterface<B_7>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_7, nyro.OptionsInterface>>>;
connect: <T_1, B_8>(url?: string, options?: nyro.OptionsInterface<B_8>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_8, nyro.OptionsInterface>>>;
trace: <T_1, B_9>(url?: string, options?: nyro.OptionsInterface<B_9>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_9, nyro.OptionsInterface>>>;
baseRequestOptions: nyro.OptionsInterface;
pluginManager: nyro.Plugin;
use: (plugin: nyro.PluginInterface) => void;
on: <K extends keyof nyro.Events>(event: K, listener: nyro.Events[K]) => nyro_dist_esm_src_services_engine.default;
once: <K extends keyof nyro.Events>(event: K, listener: nyro.Events[K]) => nyro_dist_esm_src_services_engine.default;
off: <K extends keyof nyro.Events>(event: K, listener: nyro.Events[K]) => nyro_dist_esm_src_services_engine.default;
emit: <K extends keyof nyro.Events>(event: K, ...args: Parameters<nyro.Events[K]>) => boolean;
setURL: (url: string) => nyro_dist_esm_src_services_engine.default;
setBaseURL: (baseURL: string) => nyro_dist_esm_src_services_engine.default;
setPath: (path: string) => nyro_dist_esm_src_services_engine.default;
setBodySchema: (bodySchema: any) => nyro_dist_esm_src_services_engine.default;
setAuth: (auth: nyro.AuthOptions) => nyro_dist_esm_src_services_engine.default;
setProxy: (proxy: nyro.ProxyOptions) => nyro_dist_esm_src_services_engine.default;
setMethod: (method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "CONNECT" | "TRACE") => nyro_dist_esm_src_services_engine.default;
setHeaders: (headers: (nyro.HeadersInterface & Record<string, string>)) => nyro_dist_esm_src_services_engine.default;
setParams: (params: Record<string, string>) => nyro_dist_esm_src_services_engine.default;
setQuery: (query: Record<string, string | number | boolean>) => nyro_dist_esm_src_services_engine.default;
setBody: (body: any) => nyro_dist_esm_src_services_engine.default;
setTimeout: (timeout: number) => nyro_dist_esm_src_services_engine.default;
setRetryOn: (retryOn: (req: http.RequestOptions, error: Error) => boolean) => nyro_dist_esm_src_services_engine.default;
setRetries: (retries: number) => nyro_dist_esm_src_services_engine.default;
setValidateStatus: (validateStatus: (status: number) => boolean) => nyro_dist_esm_src_services_engine.default;
setMaxBodyLength: (maxBodyLength: number) => nyro_dist_esm_src_services_engine.default;
setMaxContentLength: (maxContentLength: number) => nyro_dist_esm_src_services_engine.default;
setMaxRate: (maxRate: number) => nyro_dist_esm_src_services_engine.default;
setSignal: (signal: AbortSignal) => nyro_dist_esm_src_services_engine.default;
setOnDownloadProgress: (onDownloadProgress: (progress: {
percent: number;
transferredBytes: number;
totalBytes: number;
}) => void) => nyro_dist_esm_src_services_engine.default;
setTimeoutErrorMessage: (timeoutErrorMessage: string) => nyro_dist_esm_src_services_engine.default;
setResponseType: (responseType: ("json" | "text" | "blob" | "stream" | "arrayBuffer" | ("document" & string))) => nyro_dist_esm_src_services_engine.default;
setResponseEncoding: (responseEncoding: BufferEncoding) => nyro_dist_esm_src_services_engine.default;
setMaxRedirects: (maxRedirects: number) => nyro_dist_esm_src_services_engine.default;
setRetryDelay: (retryDelay: number) => nyro_dist_esm_src_services_engine.default;
setDecompress: (decompress: boolean) => nyro_dist_esm_src_services_engine.default;
download: <T_1, B_10>(url?: string, options?: nyro.OptionsInterface<B_10>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_10, nyro.OptionsInterface>>>;
pagination: <T_1, B_11>(options?: nyro.OptionsInterface<B_11>, paginationOptions?: nyro.PaginationOptions) => Promise<Array<ResponseInterface<T_1, nyro.BodyFromSchema<B_11, nyro.OptionsInterface>>>>;
queue: <T_1, B_12>(requests: Array<nyro.OptionsInterface<B_12>>, queueOptions?: nyro.QueueOptions) => Promise<Array<ResponseInterface<T_1, nyro.BodyFromSchema<B_12, nyro.OptionsInterface>>>>;
extend: /*elided*/ any;
request: <T_1, B_13>(options?: nyro.OptionsInterface<B_13>, currentRedirects?: number, attempt?: number, visitedUrls?: Set<string>) => Promise<ResponseInterface<T_1, nyro.BodyFromSchema<B_13, nyro.OptionsInterface>>>;
addListener: <K>(eventName: string | symbol, listener: (...args: any[]) => void) => nyro_dist_esm_src_services_engine.default;
removeListener: <K>(eventName: string | symbol, listener: (...args: any[]) => void) => nyro_dist_esm_src_services_engine.default;
removeAllListeners: (eventName?: string | symbol | undefined) => nyro_dist_esm_src_services_engine.default;
setMaxListeners: (n: number) => nyro_dist_esm_src_services_engine.default;
getMaxListeners: () => number;
listeners: <K>(eventName: string | symbol) => Function[];
rawListeners: <K>(eventName: string | symbol) => Function[];
listenerCount: <K>(eventName: string | symbol, listener?: Function | undefined) => number;
prependListener: <K>(eventName: string | symbol, listener: (...args: any[]) => void) => nyro_dist_esm_src_services_engine.default;
prependOnceListener: <K>(eventName: string | symbol, listener: (...args: any[]) => void) => nyro_dist_esm_src_services_engine.default;
eventNames: () => (string | symbol)[];
}>;
request: <T, B>(options?: nyro.OptionsInterface<B>, currentRedirects?: number, attempt?: number, visitedUrls?: Set<string>) => Promise<ResponseInterface<T, nyro.BodyFromSchema<B, nyro.OptionsInterface>>>;
addListener: <K>(eventName: string | symbol, listener: (...args: any[]) => void) => nyro_dist_esm_src_services_engine.default;
removeListener: <K>(eventName: string | symbol, listener: (...args: any[]) => void) => nyro_dist_esm_src_services_engine.default;
removeAllListeners: (eventName?: string | symbol | undefined) => nyro_dist_esm_src_services_engine.default;
setMaxListeners: (n: number) => nyro_dist_esm_src_services_engine.default;
getMaxListeners: () => number;
listeners: <K>(eventName: string | symbol) => Function[];
rawListeners: <K>(eventName: string | symbol) => Function[];
listenerCount: <K>(eventName: string | symbol, listener?: Function | undefined) => number;
prependListener: <K>(eventName: string | symbol, listener: (...args: any[]) => void) => nyro_dist_esm_src_services_engine.default;
prependOnceListener: <K>(eventName: string | symbol, listener: (...args: any[]) => void) => nyro_dist_esm_src_services_engine.default;
eventNames: () => (string | symbol)[];
}>;
static headers: {
[key: string]: string;
};
constructor(apiKey: string);
sendRequest(path: string): Promise<ResponseInterface<any, any>>;
}
interface ImageOptions {
dynamic?: boolean;
extension?: 'webp' | 'png' | 'jpeg' | 'gif';
size?: 128 | 256 | 512 | 1024 | 2048 | 4096;
}
type ClientStatus = 'web' | 'mobile' | 'desktop';
type UserStatus = 'online' | 'offline' | 'idle' | 'dnd';
interface Activity {
id: string;
name: string;
type: 1 | 2 | 3 | 4 | 5;
createdTimestamp: number;
sessionId: string;
state: string;
flags: number;
party?: {
id: string;
};
assets?: {
largeImage: string;
largeText: string;
smallImage: string;
smallText: string;
};
}
interface UserPresence {
clientStatus: ClientStatus[];
status: UserStatus;
activities: Activity[];
}
interface UserFlags {
id: string;
description: string;
icon: string;
link?: string;
}
interface Guild {
id: string;
name: string;
icon: string;
banner: string;
iconURL: (ImageOptions?: ImageOptions) => string;
bannerURL: (ImageOptions?: ImageOptions) => string;
userDisplayName: string;
}
interface GuildStat {
id: string;
name: string;
icon: string;
banner: string;
iconURL: (ImageOptions?: ImageOptions) => string;
bannerURL: (ImageOptions?: ImageOptions) => string;
voiceStatitics: string;
messageStatitics: number;
}
interface ChannelUsers {
id: string;
username: string;
displayName: string;
avatar: string;
displayAvatarURL: (ImageOptions?: ImageOptions) => string;
bot: boolean;
}
interface WhereNow {
channel: {
id: string;
name: string;
users: ChannelUsers[];
size: number;
joinedTimestamp: number;
elepsedTime: string;
joinedTimestampISO: string;
};
guild: {
id: string;
name: string;
icon: string;
banner: string;
iconURL: (ImageOptions?: ImageOptions) => string;
bannerURL: (ImageOptions?: ImageOptions) => string;
};
}
interface Friends {
username: string;
displayName: string;
messageStatitics: number;
}
interface LastSeen {
message: {
guild: {
id: string;
name: string;
icon: string;
banner: string;
iconURL: (ImageOptions?: ImageOptions) => string;
bannerURL: (ImageOptions?: ImageOptions) => string;
};
channel: {
id: string;
name: string;
};
content: string;
timestamp: string;
};
voice: {
guild: {
id: string;
name: string;
icon: string;
banner: string;
iconURL: (ImageOptions?: ImageOptions) => string;
bannerURL: (ImageOptions?: ImageOptions) => string;
};
channel: {
id: string;
name: string;
};
stat: string;
timestamp: string;
users: {
id: string;
username: string;
avatarURL: (ImageOptions?: ImageOptions) => string;
displayName: string;
bot: boolean;
}[];
};
}
interface Punishments {
guild: {
id: string;
name: string;
icon: string;
banner: string;
iconURL: (ImageOptions?: ImageOptions) => string;
bannerURL: (ImageOptions?: ImageOptions) => string;
};
data: {
type: string;
reason: string;
timestamp: number;
};
}
interface Staff {
id: string;
name: string;
icon: string;
banner: string;
iconURL: (ImageOptions?: ImageOptions) => string;
bannerURL: (ImageOptions?: ImageOptions) => string;
}
interface User {
id: string;
username: string;
bio: string | null;
pronouns: string | null;
globalName: string;
legacyName: string | null;
avatar: string;
banner: string;
displayAvatarURL: (ImageOptions?: ImageOptions) => string;
displayBannerURL: (ImageOptions?: ImageOptions) => string;
presence: UserPresence;
flags: UserFlags[];
guilds: Guild[];
stats: GuildStat[];
whereNow: WhereNow;
friends: Friends[];
lastseen: LastSeen;
punishments: Punishments[];
staffs: Staff[];
nyroResponse: ResponseInterface<any, any>;
}
interface FullNameOptions {
isTagged?: boolean;
tagSymbol?: string;
normalSymbol?: string;
splitSymbol?: string;
}
interface UserQuery {
id: string;
name: string;
age: number;
sex: string;
fullName: (options?: FullNameOptions) => string;
nyroResponse: ResponseInterface<any, any>;
}
/**
* @class Client
* @description Findcord API'ye bağlanmak için kullanılır.
* @param {string} apiKey - Findcord API Anahtarı
* @example
* const Findcord = require('findcord');
* const client = new Findcord('API Anahtarı');
*
* client.fetch('Kullanıcı ID').then((response) => {
* console.log(response);
* });
*
* client.query('Kullanıcı ID').then((response) => {
* console.log(response);
* });
*
* @returns {Promise<User>} - Kullanıcı Bilgileri
* @returns {Promise<UserQuery>} - Kullanıcı Sorgusu
* @returns {Promise<Error>} - Hata
*/
declare class Client {
router: Router;
constructor(apiKey: string);
/**
* @method fetch
* @description Kullanıcı Bilgilerini Getirir.
* @param {string} userId - Kullanıcı ID
* @returns {Promise<User>} - Kullanıcı Bilgileri
* @returns {Promise<Error>} - Hata
* @example
* client.fetch('Kullanıcı ID').then((response) => {
* console.log(response);
* });
*/
fetch(userId: string): Promise<User>;
/**
* @method query
* @description Kullanıcı Sorgusu Yapar.
* @param {string} userId - Kullanıcı ID
* @returns {Promise<UserQuery>} - Kullanıcı Sorgusu
* @returns {Promise<Error>} - Hata
* @example
* client.query('Kullanıcı ID').then((response) => {
* console.log(response);
* });
*/
query(userId: string): Promise<UserQuery>;
}
export { Client as default };