/** * Hathora Cloud API * Welcome to the Hathora Cloud API documentation! Learn how to use the Hathora Cloud APIs to build and scale your game servers globally. * * The version of the OpenAPI document: 0.0.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { CreateLobbyV3Params, LobbyV3, Region } from '../models'; export interface CreateLobbyRequest { appId: string; createLobbyV3Params: CreateLobbyV3Params; shortCode?: string; roomId?: string; } export interface GetLobbyInfoByRoomIdRequest { appId: string; roomId: string; } export interface GetLobbyInfoByShortCodeRequest { appId: string; shortCode: string; } export interface ListActivePublicLobbiesRequest { appId: string; region?: Region; } /** * LobbyV3Api - interface * * @export * @interface LobbyV3ApiInterface */ export interface LobbyV3ApiInterface { /** * Create a new lobby for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). A lobby object is a wrapper around a [room](https://hathora.dev/docs/concepts/hathora-entities#room) object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players. * @param {string} appId * @param {CreateLobbyV3Params} createLobbyV3Params * @param {string} [shortCode] * @param {string} [roomId] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LobbyV3ApiInterface */ createLobbyRaw(requestParameters: CreateLobbyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new lobby for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). A lobby object is a wrapper around a [room](https://hathora.dev/docs/concepts/hathora-entities#room) object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players. */ createLobby(appId: string, createLobbyV3Params: CreateLobbyV3Params, shortCode?: string, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get details for a lobby. * @param {string} appId * @param {string} roomId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LobbyV3ApiInterface */ getLobbyInfoByRoomIdRaw(requestParameters: GetLobbyInfoByRoomIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get details for a lobby. */ getLobbyInfoByRoomId(appId: string, roomId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. * @param {string} appId * @param {string} shortCode * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LobbyV3ApiInterface */ getLobbyInfoByShortCodeRaw(requestParameters: GetLobbyInfoByShortCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. */ getLobbyInfoByShortCode(appId: string, shortCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get all active lobbies for a given [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. Use this endpoint to display all public lobbies that a player can join in the game client. * @param {string} appId * @param {Region} [region] If omitted, active public lobbies in all regions will be returned. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof LobbyV3ApiInterface */ listActivePublicLobbiesRaw(requestParameters: ListActivePublicLobbiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get all active lobbies for a given [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. Use this endpoint to display all public lobbies that a player can join in the game client. */ listActivePublicLobbies(appId: string, region?: Region, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; } /** * */ export declare class LobbyV3Api extends runtime.BaseAPI implements LobbyV3ApiInterface { /** * Create a new lobby for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). A lobby object is a wrapper around a [room](https://hathora.dev/docs/concepts/hathora-entities#room) object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players. */ createLobbyRaw(requestParameters: CreateLobbyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new lobby for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). A lobby object is a wrapper around a [room](https://hathora.dev/docs/concepts/hathora-entities#room) object. With a lobby, you get additional functionality like configuring the visibility of the room, managing the state of a match, and retrieving a list of public lobbies to display to players. */ createLobby(appId: string, createLobbyV3Params: CreateLobbyV3Params, shortCode?: string, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get details for a lobby. */ getLobbyInfoByRoomIdRaw(requestParameters: GetLobbyInfoByRoomIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get details for a lobby. */ getLobbyInfoByRoomId(appId: string, roomId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. */ getLobbyInfoByShortCodeRaw(requestParameters: GetLobbyInfoByShortCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. */ getLobbyInfoByShortCode(appId: string, shortCode: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get all active lobbies for a given [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. Use this endpoint to display all public lobbies that a player can join in the game client. */ listActivePublicLobbiesRaw(requestParameters: ListActivePublicLobbiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get all active lobbies for a given [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. Use this endpoint to display all public lobbies that a player can join in the game client. */ listActivePublicLobbies(appId: string, region?: Region, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; }