Class APIGames

Constructors

constructor

new APIGames(web): APIGames
Parameters
- web: WebDataManager
Returns APIGames
- Defined in src/classes/games.ts:394

Methods

getChangelogs

getChangelogs(__namedParameters): Promise<WebResponse<ChangelogsResponse>>
Parameters
- __namedParameters: {
      appid?: number;
      auth: string;
      guildId: string;
      kind?: "patch" | "announcement";
      limit?: number;
  }
  - Optionalappid?: number
  - auth: string
  - guildId: string
  - Optionalkind?: "patch" | "announcement"
  - Optionallimit?: number
Returns Promise<WebResponse<ChangelogsResponse>>
- Defined in src/classes/games.ts:449

getConfig

getConfig(__namedParameters): Promise<WebResponse<GameConfigResponse>>
Parameters
- __namedParameters: {
  auth: string;
  guildId: string;
  }
  - auth: string
  - guildId: string
Returns Promise<WebResponse<GameConfigResponse>>
- Defined in src/classes/games.ts:397

getDeals

getDeals(__namedParameters): Promise<WebResponse<DealsCatalogResponse>>
Parameters
- __namedParameters: {
  auth: string;
  guildId: string;
  } & GameDealsQuery
Returns Promise<WebResponse<DealsCatalogResponse>>
- Defined in src/classes/games.ts:445

getFree

getFree(__namedParameters): Promise<WebResponse<FreeCatalogResponse>>
Parameters
- __namedParameters: {
      auth: string;
      dlc?: "0" | "1";
      guildId: string;
      playFree?: "1";
      store?: string;
  }
  - auth: string
  - Optionaldlc?: "0" | "1"
  - guildId: string
  - OptionalplayFree?: "1"
  - Optionalstore?: string
Returns Promise<WebResponse<FreeCatalogResponse>>
- Defined in src/classes/games.ts:437

getHealth

getHealth(__namedParameters): Promise<WebResponse<GameHealthBundle>>
Parameters
- __namedParameters: {
  auth: string;
  guildId: string;
  }
  - auth: string
  - guildId: string
Returns Promise<WebResponse<GameHealthBundle>>
- Defined in src/classes/games.ts:453

getMeta

getMeta(__namedParameters): Promise<WebResponse<GameMetaResponse>>
Combined providers + taxonomy bootstrap (the bot's /games/meta) — one call for picker UIs.
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      store?: string;
  }
  - auth: string
  - guildId: string
  - Optionalstore?: string
Returns Promise<WebResponse<GameMetaResponse>>
- Defined in src/classes/games.ts:425

getProviders

getProviders(__namedParameters): Promise<WebResponse<ProvidersResponse>>
Parameters
- __namedParameters: {
  auth: string;
  guildId: string;
  }
  - auth: string
  - guildId: string
Returns Promise<WebResponse<ProvidersResponse>>
- Defined in src/classes/games.ts:429

getRobloxPopular

getRobloxPopular(__namedParameters): Promise<WebResponse<RobloxDiscoverResponse>>
Discover grid — top ~100 Roblox games by players. following reflects THIS guild's follows.
Parameters
- __namedParameters: {
  auth: string;
  guildId: string;
  }
  - auth: string
  - guildId: string
Returns Promise<WebResponse<RobloxDiscoverResponse>>
- Defined in src/classes/games.ts:464

getTaxonomy

getTaxonomy(__namedParameters): Promise<WebResponse<TaxonomyResponse>>
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      store?: string;
  }
  - auth: string
  - guildId: string
  - Optionalstore?: string
Returns Promise<WebResponse<TaxonomyResponse>>
- Defined in src/classes/games.ts:433

getUpcoming

getUpcoming(__namedParameters): Promise<WebResponse<FreeCatalogResponse>>
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      store?: string;
  }
  - auth: string
  - guildId: string
  - Optionalstore?: string
Returns Promise<WebResponse<FreeCatalogResponse>>
- Defined in src/classes/games.ts:441

lookupRoblox

lookupRoblox(__namedParameters): Promise<WebResponse<RobloxLookupResult>>
Preview a pasted roblox.com/games/<id> URL or bare place id before following — resolves the title/thumbnail/players. placeId accepts a URL or id; the bot extracts the numeric id.
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      placeId: string | number;
  }
  - auth: string
  - guildId: string
  - placeId: string | number
Returns Promise<WebResponse<RobloxLookupResult>>
- Defined in src/classes/games.ts:475

searchRoblox

searchRoblox(__namedParameters): Promise<WebResponse<RobloxDiscoverResponse>>
Search Roblox games by name (live proxy). Same followable-card shape as the popular grid.
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      limit?: number;
      q: string;
  }
  - auth: string
  - guildId: string
  - Optionallimit?: number
  - q: string
Returns Promise<WebResponse<RobloxDiscoverResponse>>
- Defined in src/classes/games.ts:469

searchSteam

searchSteam(__namedParameters): Promise<WebResponse<SteamSearchResponse>>
Full Steam catalog search by name (proxied from the gameApi) — find ANY Steam game, not just catalog deals.
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      limit?: number;
      q: string;
  }
  - auth: string
  - guildId: string
  - Optionallimit?: number
  - q: string
Returns Promise<WebResponse<SteamSearchResponse>>
- Defined in src/classes/games.ts:458

testNotification

testNotification(__namedParameters): Promise<WebResponse<string>>
Send a sample notification for one feature (the "Test" button). free = free-game/deal, changelog = patch notes, roblox = Roblox update. channelId (required) and pingRoleId (optional) come from the possibly-unsaved dashboard form, so the test reflects what the admin is configuring right now — not the last-saved config. Uses the exact render/webhook/permission path the real pings take. Requires that feature be enabled.
Parameters
- __namedParameters: {
      auth: string;
      channelId: string;
      guildId: string;
      pingRoleId?: null | string;
      type: "free" | "changelog" | "roblox";
  }
  - auth: string
  - channelId: string
  - guildId: string
  - OptionalpingRoleId?: null | string
  - type: "free" | "changelog" | "roblox"
Returns Promise<WebResponse<string>>
- Defined in src/classes/games.ts:484

updateCategoryRoutes

updateCategoryRoutes(__namedParameters): Promise<WebResponse<{
routes: GameCategoryRoute[];
}>>
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
      routes: GameCategoryRoute[];
  }
  - auth: string
  - guildId: string
  - routes: GameCategoryRoute[]
Returns Promise<WebResponse<{
routes: GameCategoryRoute[];
}>>
- Defined in src/classes/games.ts:419

updateChangelogGames

updateChangelogGames(__namedParameters): Promise<WebResponse<{
games: ChangelogGame[];
}>>
Parameters
- __namedParameters: {
      auth: string;
      games: ChangelogGame[];
      guildId: string;
  }
  - auth: string
  - games: ChangelogGame[]
  - guildId: string
Returns Promise<WebResponse<{
games: ChangelogGame[];
}>>
- Defined in src/classes/games.ts:409

updateConfig

updateConfig(__namedParameters): Promise<WebResponse<GameConfig>>
Parameters
- __namedParameters: {
      auth: string;
      guildId: string;
  } & Partial<Omit<GameConfig,
      | "guildId"
      | "categoryRoutes"
      | "trackedGames"
      | "changelogGames"
      | "robloxGames">>
Returns Promise<WebResponse<GameConfig>>
- Defined in src/classes/games.ts:401

updateRobloxGames

updateRobloxGames(__namedParameters): Promise<WebResponse<{
games: RobloxGame[];
}>>
Replace the guild's followed Roblox experiences (replace-semantics). placeId accepts a game URL, a bare id, or a numeric string — the bot extracts the place id. Capped at 500.
Parameters
- __namedParameters: {
      auth: string;
      games: RobloxGame[];
      guildId: string;
  }
  - auth: string
  - games: RobloxGame[]
  - guildId: string
Returns Promise<WebResponse<{
games: RobloxGame[];
}>>
- Defined in src/classes/games.ts:415

updateTrackedGames

updateTrackedGames(__namedParameters): Promise<WebResponse<{
games: TrackedGame[];
}>>
Parameters
- __namedParameters: {
      auth: string;
      games: TrackedGame[];
      guildId: string;
  }
  - auth: string
  - games: TrackedGame[]
  - guildId: string
Returns Promise<WebResponse<{
games: TrackedGame[];
}>>
- Defined in src/classes/games.ts:405

Class APIGames

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns APIGames

Methods

getChangelogs

Parameters

Optionalappid?: number

auth: string

guildId: string

Optionalkind?: "patch" | "announcement"

Optionallimit?: number

Returns Promise<WebResponse<ChangelogsResponse>>

getConfig

Parameters

auth: string

guildId: string

Returns Promise<WebResponse<GameConfigResponse>>

getDeals

Parameters

Returns Promise<WebResponse<DealsCatalogResponse>>

getFree

Parameters

auth: string

Optionaldlc?: "0" | "1"

guildId: string

OptionalplayFree?: "1"

Optionalstore?: string

Returns Promise<WebResponse<FreeCatalogResponse>>

getHealth

Parameters

auth: string

guildId: string

Returns Promise<WebResponse<GameHealthBundle>>

getMeta

Parameters

auth: string

guildId: string

Optionalstore?: string

Returns Promise<WebResponse<GameMetaResponse>>

getProviders

Parameters

auth: string

guildId: string

Returns Promise<WebResponse<ProvidersResponse>>

getRobloxPopular

Parameters

auth: string

guildId: string

Returns Promise<WebResponse<RobloxDiscoverResponse>>

getTaxonomy

Parameters

auth: string

guildId: string

Optionalstore?: string

Returns Promise<WebResponse<TaxonomyResponse>>

getUpcoming

Parameters

auth: string

guildId: string

Optionalstore?: string

Returns Promise<WebResponse<FreeCatalogResponse>>

lookupRoblox

Parameters

auth: string

guildId: string

placeId: string | number

Returns Promise<WebResponse<RobloxLookupResult>>

searchRoblox

Parameters

auth: string

guildId: string

Optionallimit?: number

q: string

Returns Promise<WebResponse<RobloxDiscoverResponse>>

searchSteam

`Optional`appid?: number

`Optional`kind?: "patch" | "announcement"

`Optional`limit?: number

`Optional`dlc?: "0" | "1"

`Optional`playFree?: "1"

`Optional`store?: string

`Optional`store?: string

`Optional`store?: string

`Optional`store?: string

`Optional`limit?: number

`Optional`limit?: number

`Optional`pingRoleId?: null | string

Returns Promise<WebResponse<{
routes: GameCategoryRoute[];
}>>

Returns Promise<WebResponse<{
games: ChangelogGame[];
}>>

Returns Promise<WebResponse<{
games: RobloxGame[];
}>>

Returns Promise<WebResponse<{
games: TrackedGame[];
}>>