dbots/src/Interface/Lists/DiscordsCom.ts

Discord bot list poster and stats retriever

import { Service, ServicePostOptions } from '../Service'
import { Util, IDResolvable } from '../../Utils/Util'
import { Query } from '../../Utils/Constants'

/**
 * Represents the Discords.com service (formerly Bots For Discord).
 * @see https://docs.discords.com/
 */
export default class DiscordsCom extends Service {
  /** The values that can be used to select the service. */
  static get aliases() {
    return ['botsfordiscord', 'botsfordiscord.com', 'discords', 'discords.com']
  }

  /** The logo URL. */
  static get logoURL() {
    return 'https://discords.com/bots/img/manifest/icon-512x512.png'
  }

  /** Service's name. */
  static get serviceName() {
    return 'Discords.com'
  }

  /** The website URL. */
  static get websiteURL() {
    return 'https://discords.com/bots'
  }

  /** The base URL of the service's API. */
  static get baseURL() {
    return 'https://discords.com/bots/api'
  }

  /**
   * Posts statistics to this service.
   * <warn>Shard data posting is not supported for this service.</warn>
   * @param options The options of the request.
   */
  static post(options: ServicePostOptions) {
    const { token, clientID, serverCount } = options
    return super._post({
      method: 'post',
      url: `/bot/${Util.resolveID(clientID)}/setservers`,
      headers: { Authorization: token },
      data: { server_count: Util.resolveCount(serverCount) }
    })
  }

  /**
   * Gets the bot listed on this service.
   * @param id The bot's ID.
   */
  getBot(id: IDResolvable) {
    return this._request({ url: `/bot/${Util.resolveID(id)}` })
  }

  /**
   * Gets the list of people who voted a bot.
   * @param id The bot's ID.
   */
  getBotVotes(id: IDResolvable) {
    return this._request(
      {
        url: `/bot/${Util.resolveID(id)}/votes`,
        headers: {
          Authorization: this.token,
          'Content-Type': 'application/json'
        }
      },
      { requiresToken: true }
    )
  }

  /**
   * Gets the list of people who voted a bot in the last 12 hours.
   * @param id The bot's ID.
   */
  getBotVotes12h(id: IDResolvable) {
    return this._request(
      {
        url: `/bot/${Util.resolveID(id)}/votes12h`,
        headers: {
          Authorization: this.token
        }
      },
      { requiresToken: true }
    )
  }

  /**
   * Gets the user listed on this service.
   * @param id The user's ID.
   */
  getUser(id: IDResolvable) {
    return this._request({ url: `/user/${Util.resolveID(id)}` })
  }

  /**
   * Gets the user's bots listed for this service.
   * @param id The user's ID.
   */
  getUserBots(id: IDResolvable) {
    return this._request({ url: `/user/${Util.resolveID(id)}/bots` })
  }

  /**
   * Gets the widget URL for this bot.
   * @param id The bot's ID.
   * @param query The query that will be used in the request.
   */
  getWidgetURL(id: IDResolvable, query?: Query) {
    return this._appendQuery(`/bot/${Util.resolveID(id)}/widget`, query || {})
  }
}