funblox/lib/index.d.ts

This package made by fedee#9606 this a roblox API you may use it for your verification or something if you use our package give us credit <3.

import * as got_cjs from 'got-cjs';

interface UserResponse {
    id: number;
    username: string;
    description: string;
    created: string;
    avatar_url: string;
    friends: {
        count: number;
        ids: Array<number>;
    };
    followers: {
        count: number;
        ids: Array<number>;
    };
    following: {
        count: number;
        ids: Array<number>;
    };
}
/**
 *
 * @param {number | string} identifier
 * @return {Promise<UserResponse>}
 */
declare function getUser(identifier: number | string): Promise<UserResponse>;

interface GroupData {
    id: number;
    name: string;
    description: string;
    owner: OwnerObject$1;
    membercount: number;
    thumbnail: string;
    shout: Shout;
    roles: Array<RoleJSON>;
}
interface RoleJSON {
    id: number;
    name: string;
    membercount: number;
}
interface OwnerObject$1 {
    buildersClubMembershipType: string;
    userId: number;
    username: string;
    displayName: string;
}
interface Shout {
    content: string;
    created: string;
    author: ShoutAuthor;
}
interface ShoutAuthor {
    id: number;
    username: string;
    displayName: string;
}
/**
 *
 * @param {number | string} identifier
 * @return {Promise<GroupData>}
 */
declare function getGroup(identifier: number | string): Promise<GroupData>;

interface RoleObject {
    id: number;
    name: string;
    rank: number;
}
/**
 * **getGroupRank**
 *
 * Gets user's group rank within a group
 * @param {number | string} groupId
 * @param {number | string} user
 * @return {Promise<RoleObject>} A Promise that resolves to the user's role in the group
 */
declare function getGroupRank(groupId: number | string, user: number | string): Promise<RoleObject>;

interface Game {
    id: number;
    name: string;
    description: string;
    creator: GameCreator;
    rootPlace: PlaceRoot;
    created: string;
    updated: string;
    placeVisits: number;
}
interface GameCreator {
    id: number;
    type: string;
    name: string;
}
interface PlaceRoot {
    id: number;
    type: string;
    name: string;
}
/**
 *
 * @param {number | string} userId
 * @param {number} limit
 * @return {Promise<Array<Game>>}
 */
declare function getUserFavoriteGames(userId: number | string, limit: number): Promise<Array<Game>>;

declare function getCategories(): Promise<Object>;

/**
 *
 * @param {number | string} bundleId
 * @return {Promise<string>}
 */
declare function getFavoritesOfBundle(bundleId: number | string): Promise<string>;

/**
 *
 * @param {number | string} itemId
 * @return {Promise<string>}
 */
declare function getFavoritesOfItem(itemId: number | string): Promise<string>;

interface PlayerThumbnail {
    Thumbnail: string;
}
/**
 * **getPlayerThumbnail**
 * @param {number | string} user
 * @param {string} size
 * @param {string} format
 * @param {boolean} isCircular
 * @param {string} cropType
 * @return {Promise<PlayerThumbnail>}
 */
declare function getPlayerThumbnail(user: number | string, size: string, format: string, isCircular: boolean, cropType?: string): Promise<PlayerThumbnail>;

interface Bundle {
    id: number;
    name: string;
    bundleType: string;
    creator: BundleCreator;
}
interface BundleCreator {
    id: number;
    name: string;
    type: string;
}
/**
 *
 * @param {string | number} userId
 * @return {Promise<Array<any>>}
 */
declare function getUserBundles(userId: string | number): Promise<Bundle>;

interface GameData {
    id: number;
    name: string;
    description: string;
    creator: OwnerObject;
    thumbnails: string;
    price: number;
    allowedGearGenres: string;
    allowedGearCategories: string;
    playing: number;
    visits: number;
    maxPlayers: number;
    created: string;
    updated: string;
    genres: string;
    favoritedCount: number;
}
interface OwnerObject {
    id: number;
    name: string;
    type: string;
    isRNVAccount: boolean;
}
/**
 *
 * @param {number} identifier
 * @return {Promise<GameData>}
 */
declare function export_default(identifier: number): Promise<GameData>;

interface VotesData {
    upVotes: number;
    downVotes: number;
}
declare function getGameVotes(id: number | string): Promise<VotesData>;

/**
 * @param {string} placeId
 * @return {Promise<Number>}
 */
declare function getUniverseId(placeId: number | string): Promise<number>;

/**
 * **Promote**
 * @param {number } groupid
 * @param { number | string } user
 * @return {Promise<Object>}
 */
declare function promote(groupid: number, user: string | number): Promise<object>;

/**
 * **Demote**
 * @param {number } groupid
 * @param { number | string } user
 * @return {Promise<Object>}
 */
declare function demote(groupid: number, user: string | number): Promise<object>;

/**
 * **setRank**
 * @param {number } groupid
 * @param { number } user
 * @param { number } newrank
 * @return {Promise<Object>}
 */
declare function setRank(groupid: number, user: number, newrank: number): Promise<object>;

/**
 * Set the cookie for the user
 * @param {string} cookie
 * @return {Promise<void>}
 */
declare function setCookie(cookie: string): Promise<void>;

declare const api: got_cjs.Got;
declare const economy: got_cjs.Got;
declare const auth: got_cjs.Got;
declare const groups: got_cjs.Got;
declare const games: got_cjs.Got;
declare const catalog: got_cjs.Got;
declare const friends: got_cjs.Got;
declare const thumbnails: got_cjs.Got;
declare const users: got_cjs.Got;
declare const mobileAPI: got_cjs.Got;

declare const api$1_api: typeof api;
declare const api$1_economy: typeof economy;
declare const api$1_auth: typeof auth;
declare const api$1_groups: typeof groups;
declare const api$1_games: typeof games;
declare const api$1_catalog: typeof catalog;
declare const api$1_friends: typeof friends;
declare const api$1_thumbnails: typeof thumbnails;
declare const api$1_users: typeof users;
declare const api$1_mobileAPI: typeof mobileAPI;
declare namespace api$1 {
  export {
    api$1_api as api,
    api$1_economy as economy,
    api$1_auth as auth,
    api$1_groups as groups,
    api$1_games as games,
    api$1_catalog as catalog,
    api$1_friends as friends,
    api$1_thumbnails as thumbnails,
    api$1_users as users,
    api$1_mobileAPI as mobileAPI,
  };
}

export { api$1 as api, demote, getCategories, getFavoritesOfBundle, getFavoritesOfItem, getGameVotes, getGroup, export_default as getPlaceInfo, getPlayerThumbnail, getUniverseId, getUser, getUserBundles, getUserFavoriteGames, getGroupRank as getUserRank, promote, setCookie, setRank };