Response Types

This is an alphabetic listing of all response types.

Album

interface Album {
    name: string;
    id?: string;
    year: number;
    artist?: Artist;
    tracks?: Track[];
}

Artist

interface Artist {
    name: string;
    id?: string;
    albums?: Album[];
    tracks?: Track[];
}

Ban

interface Ban {
    user: BannedUser;
    moderator: string;
    reason: string;
    proof: string
    active: boolean;
    appealable: boolean;
    
    setUser(id: string, name: string, discriminator: string): Ban;
    setUser(user: Discord.User): Ban;
    setModerator(id: string): Ban;
    setReason(reason: string, proof: string): Ban;
}

BanAPIResponse

interface BanAPIResponse {
    success: boolean;
    message?: string;
}

BannedUser

interface BannedUser {
    id: string;
    username?: string;
    discriminator?: string;
}

Conversion

interface Conversion {
    value: number;
    pretty: string;
}

Image

interface Image {
    tag?: Tag;
    url: string;
    id?: string;
}

IPReport

interface IPReport {
    location: Location;
    map: string; // URL, Google Maps
}

Location

interface Location {
    lat: number;
    lon: number;
    address: string;
}

RedditImage

interface RedditImage extends Image {
    post: RedditPost;
}

RedditPost

interface ReditPost {
    title: string;
    subreddit: string;
    link: string;
    upvotes: number;
    downvotes: number;
    author: string;
    comments: number;
}

SpotifyAlbum

interface SpotifyAlbum {
    title: string;
    link: string;
    art: string;
}

SpotifyArtist

interface SpotifyArtist {
    name: string;
    link: string;
}

SpotifyTrack

interface SpotifyTrack {
    id: string;
    link: string;
    title: string;
    album: SpotifyAlbum;
    artists: SpotifyArtist[];
}

Suggestion

interface Suggestion {
    title: string;
    youtube: YouTubeTrack;
    spotify: SpotifyTrack;
}

Tag

interface Tag {
    name: string;
    nsfw: boolean;
}

Track

interface Track {
    name: string;
    id: string;
    artist?: Artist;
    albums?: Album[];
    lyrics: string;
    url: string;
}

WeatherReport

interface WeatherReport {
    location: Location;
    icon: string;
    summary: string;
    temperature: number;
    uvIndex: number;
    humidity: number;
    pressure: number;
    precipPossibility: number;
}

WikiHowArticle

interface WikiHowArticle {
    title: string;
    link: string;
}

WikiHowImage

interface WikiHowImage extends Image {
    article: WikiHowArticle;
}

YouTubeTrack

interface YouTubeTrack {
    id: string;
    link: string;
    title: string;
    thumbnail: string;
    description: string;
}