/** * 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 { CreateLobbyParams, CreatePrivateLobbyRequest, Lobby, Region, SetLobbyStateParams } from '../models'; export interface CreateLobbyDeprecatedRequest { appId: string; createLobbyParams: CreateLobbyParams; roomId?: string; } export interface CreateLocalLobbyRequest { appId: string; createPrivateLobbyRequest: CreatePrivateLobbyRequest; roomId?: string; } export interface CreatePrivateLobbyOperationRequest { appId: string; createPrivateLobbyRequest: CreatePrivateLobbyRequest; roomId?: string; } export interface CreatePublicLobbyRequest { appId: string; createPrivateLobbyRequest: CreatePrivateLobbyRequest; roomId?: string; } export interface GetLobbyInfoRequest { appId: string; roomId: string; } export interface ListActivePublicLobbiesDeprecatedV2Request { appId: string; region?: Region; } export interface SetLobbyStateRequest { appId: string; roomId: string; setLobbyStateParams: SetLobbyStateParams; } /** * LobbyV2Api - interface * * @export * @interface LobbyV2ApiInterface */ export interface LobbyV2ApiInterface { /** * 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 {CreateLobbyParams} createLobbyParams * @param {string} [roomId] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof LobbyV2ApiInterface */ createLobbyDeprecatedRaw(requestParameters: CreateLobbyDeprecatedRequest, 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. */ createLobbyDeprecated(appId: string, createLobbyParams: CreateLobbyParams, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @param {string} appId * @param {CreatePrivateLobbyRequest} createPrivateLobbyRequest * @param {string} [roomId] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof LobbyV2ApiInterface */ createLocalLobbyRaw(requestParameters: CreateLocalLobbyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** */ createLocalLobby(appId: string, createPrivateLobbyRequest: CreatePrivateLobbyRequest, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @param {string} appId * @param {CreatePrivateLobbyRequest} createPrivateLobbyRequest * @param {string} [roomId] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof LobbyV2ApiInterface */ createPrivateLobbyRaw(requestParameters: CreatePrivateLobbyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** */ createPrivateLobby(appId: string, createPrivateLobbyRequest: CreatePrivateLobbyRequest, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * * @param {string} appId * @param {CreatePrivateLobbyRequest} createPrivateLobbyRequest * @param {string} [roomId] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof LobbyV2ApiInterface */ createPublicLobbyRaw(requestParameters: CreatePublicLobbyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** */ createPublicLobby(appId: string, createPrivateLobbyRequest: CreatePrivateLobbyRequest, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get details for a lobby. * @param {string} appId * @param {string} roomId * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof LobbyV2ApiInterface */ getLobbyInfoRaw(requestParameters: GetLobbyInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get details for a lobby. */ getLobbyInfo(appId: string, roomId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get all active lobbies for a an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter 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] Region to filter by. If omitted, active public lobbies in all regions will be returned. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof LobbyV2ApiInterface */ listActivePublicLobbiesDeprecatedV2Raw(requestParameters: ListActivePublicLobbiesDeprecatedV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get all active lobbies for a an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `region`. Use this endpoint to display all public lobbies that a player can join in the game client. */ listActivePublicLobbiesDeprecatedV2(appId: string, region?: Region, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Set the state of a lobby. State is intended to be set by the server and must be smaller than 1MB. Use this endpoint to store match data like live player count to enforce max number of clients or persist end-game data (i.e. winner or final scores). * @param {string} appId * @param {string} roomId * @param {SetLobbyStateParams} setLobbyStateParams * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof LobbyV2ApiInterface */ setLobbyStateRaw(requestParameters: SetLobbyStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Set the state of a lobby. State is intended to be set by the server and must be smaller than 1MB. Use this endpoint to store match data like live player count to enforce max number of clients or persist end-game data (i.e. winner or final scores). */ setLobbyState(appId: string, roomId: string, setLobbyStateParams: SetLobbyStateParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class LobbyV2Api extends runtime.BaseAPI implements LobbyV2ApiInterface { /** * 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. */ createLobbyDeprecatedRaw(requestParameters: CreateLobbyDeprecatedRequest, 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. */ createLobbyDeprecated(appId: string, createLobbyParams: CreateLobbyParams, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** */ createLocalLobbyRaw(requestParameters: CreateLocalLobbyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** */ createLocalLobby(appId: string, createPrivateLobbyRequest: CreatePrivateLobbyRequest, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** */ createPrivateLobbyRaw(requestParameters: CreatePrivateLobbyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** */ createPrivateLobby(appId: string, createPrivateLobbyRequest: CreatePrivateLobbyRequest, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** */ createPublicLobbyRaw(requestParameters: CreatePublicLobbyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** */ createPublicLobby(appId: string, createPrivateLobbyRequest: CreatePrivateLobbyRequest, roomId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get details for a lobby. */ getLobbyInfoRaw(requestParameters: GetLobbyInfoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get details for a lobby. */ getLobbyInfo(appId: string, roomId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get all active lobbies for a an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `region`. Use this endpoint to display all public lobbies that a player can join in the game client. */ listActivePublicLobbiesDeprecatedV2Raw(requestParameters: ListActivePublicLobbiesDeprecatedV2Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get all active lobbies for a an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `region`. Use this endpoint to display all public lobbies that a player can join in the game client. */ listActivePublicLobbiesDeprecatedV2(appId: string, region?: Region, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Set the state of a lobby. State is intended to be set by the server and must be smaller than 1MB. Use this endpoint to store match data like live player count to enforce max number of clients or persist end-game data (i.e. winner or final scores). */ setLobbyStateRaw(requestParameters: SetLobbyStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Set the state of a lobby. State is intended to be set by the server and must be smaller than 1MB. Use this endpoint to store match data like live player count to enforce max number of clients or persist end-game data (i.e. winner or final scores). */ setLobbyState(appId: string, roomId: string, setLobbyStateParams: SetLobbyStateParams, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }