dbots
Version:
Discord bot list poster and stats retriever
56 lines (55 loc) • 2.14 kB
TypeScript
import { Service, ServicePostOptions } from '../Service';
import { IDResolvable } from '../../Utils/Util';
import { Query } from '../../Utils/Constants';
/** The user agent used options for the DiscordBotsGG service */
export interface DiscordBotsGGUserAgent {
/** The bot's library */
library: string;
/** The bot ID for the user agent */
clientID: string;
}
/**
* Represents the Discord Bots service.
* @see https://discord.bots.gg/docs
*/
export default class DiscordBotsGG extends Service {
/** The user agent options for this service */
private agent;
/**
* @param token The token/key for the service
* @param userAgent The user agent options of the service. Providing this is highly recommended.
*/
constructor(token: string, userAgent?: DiscordBotsGGUserAgent);
/** The values that can be used to select the service. */
static get aliases(): string[];
/** The logo URL. */
static get logoURL(): string;
/** Service's name. */
static get serviceName(): string;
/** The website URL. */
static get websiteURL(): string;
/** The base URL of the service's API. */
static get baseURL(): string;
/**
* Creates a compliant user agent to use for any API calls to Discord Bots.
* @param botID The ID of the bot that the agent will be identified with
* @param library The library the agent is using
*/
static userAgent(botID: IDResolvable, library?: string): string;
/**
* Posts statistics to this service.
* @param options The options of the request
*/
static post(options: ServicePostOptions): Promise<import("axios").AxiosResponse<any, any>>;
/**
* Gets the bot listed on this service.
* @param id The bot's ID
* @param sanitized Whether to sanitize descriptions
*/
getBot(id: IDResolvable, sanitized?: boolean): Promise<import("axios").AxiosResponse<any, any>>;
/**
* Gets a list of bots on this service.
* @param query The query string that will be used in the request
*/
getBots(query?: Query): Promise<import("axios").AxiosResponse<any, any>>;
}