From e7489e70ff037486828af0fa4b43a27ef6195dce Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 5 Nov 2024 00:15:45 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.426.0 --- .speakeasy/gen.lock | 14 +- .speakeasy/workflow.lock | 12 +- README.md | 452 +++++++++--------- RELEASES.md | 12 +- docs/sdks/appsv1/README.md | 10 +- docs/sdks/appsv2/README.md | 10 +- docs/sdks/authv1/README.md | 6 +- docs/sdks/billingv1/README.md | 24 +- docs/sdks/buildsv1/README.md | 10 +- docs/sdks/buildsv2/README.md | 14 +- docs/sdks/buildsv3/README.md | 12 +- docs/sdks/deploymentsv1/README.md | 8 +- docs/sdks/deploymentsv2/README.md | 8 +- docs/sdks/deploymentsv3/README.md | 8 +- docs/sdks/discoveryv1/README.md | 2 +- docs/sdks/discoveryv2/README.md | 2 +- docs/sdks/fleetsv1/README.md | 8 +- docs/sdks/lobbiesv1/README.md | 12 +- docs/sdks/lobbiesv2/README.md | 20 +- docs/sdks/lobbiesv3/README.md | 8 +- docs/sdks/logsv1/README.md | 4 +- docs/sdks/managementv1/README.md | 4 +- docs/sdks/metricsv1/README.md | 2 +- docs/sdks/organizationsv1/README.md | 30 +- docs/sdks/processesv1/README.md | 6 +- docs/sdks/processesv2/README.md | 10 +- docs/sdks/processesv3/README.md | 14 +- docs/sdks/roomsv1/README.md | 28 +- docs/sdks/roomsv2/README.md | 18 +- docs/sdks/tokensv1/README.md | 6 +- gen.yaml | 2 +- jsr.json | 2 +- package-lock.json | 4 +- package.json | 2 +- src/funcs/appsV1CreateAppV1Deprecated.ts | 3 + src/funcs/appsV1DeleteAppV1Deprecated.ts | 3 + src/funcs/appsV1GetAppInfoV1Deprecated.ts | 3 + src/funcs/appsV1GetAppsV1Deprecated.ts | 3 + src/funcs/appsV1UpdateAppV1Deprecated.ts | 3 + src/funcs/appsV2CreateApp.ts | 3 + src/funcs/appsV2DeleteApp.ts | 3 + src/funcs/appsV2GetApp.ts | 3 + src/funcs/appsV2GetApps.ts | 3 + src/funcs/appsV2UpdateApp.ts | 3 + src/funcs/authV1LoginAnonymous.ts | 3 + src/funcs/authV1LoginGoogle.ts | 3 + src/funcs/authV1LoginNickname.ts | 3 + src/funcs/billingV1GetBalance.ts | 3 + src/funcs/billingV1GetInvoices.ts | 3 + src/funcs/billingV1GetPaymentMethod.ts | 3 + src/funcs/billingV1GetUpcomingInvoiceItems.ts | 3 + src/funcs/billingV1GetUpcomingInvoiceTotal.ts | 3 + .../billingV1InitStripeCustomerPortalUrl.ts | 3 + src/funcs/buildsV1CreateBuildDeprecated.ts | 3 + src/funcs/buildsV1DeleteBuildDeprecated.ts | 3 + src/funcs/buildsV1GetBuildInfoDeprecated.ts | 3 + src/funcs/buildsV1GetBuildsDeprecated.ts | 3 + src/funcs/buildsV1RunBuildDeprecated.ts | 3 + src/funcs/buildsV2CreateBuildV2Deprecated.ts | 3 + ...sV2CreateBuildWithUploadUrlV2Deprecated.ts | 3 + ...2CreateWithMultipartUploadsV2Deprecated.ts | 3 + src/funcs/buildsV2DeleteBuildV2Deprecated.ts | 3 + src/funcs/buildsV2GetBuildInfoV2Deprecated.ts | 3 + src/funcs/buildsV2GetBuildsV2Deprecated.ts | 3 + src/funcs/buildsV2RunBuildV2Deprecated.ts | 3 + src/funcs/buildsV3CreateBuild.ts | 3 + src/funcs/buildsV3DeleteBuild.ts | 3 + src/funcs/buildsV3GetBuild.ts | 3 + src/funcs/buildsV3GetBuilds.ts | 3 + src/funcs/buildsV3RunBuild.ts | 3 + ...ploymentsV1CreateDeploymentV1Deprecated.ts | 3 + ...loymentsV1GetDeploymentInfoV1Deprecated.ts | 3 + ...deploymentsV1GetDeploymentsV1Deprecated.ts | 3 + ...ymentsV1GetLatestDeploymentV1Deprecated.ts | 3 + ...ploymentsV2CreateDeploymentV2Deprecated.ts | 3 + ...loymentsV2GetDeploymentInfoV2Deprecated.ts | 3 + ...deploymentsV2GetDeploymentsV2Deprecated.ts | 3 + ...ymentsV2GetLatestDeploymentV2Deprecated.ts | 3 + src/funcs/deploymentsV3CreateDeployment.ts | 3 + src/funcs/deploymentsV3GetDeployment.ts | 3 + src/funcs/deploymentsV3GetDeployments.ts | 3 + src/funcs/deploymentsV3GetLatestDeployment.ts | 3 + ...veryV1GetPingServiceEndpointsDeprecated.ts | 3 + .../discoveryV2GetPingServiceEndpoints.ts | 3 + src/funcs/fleetsV1GetFleetMetrics.ts | 3 + src/funcs/fleetsV1GetFleetRegion.ts | 3 + src/funcs/fleetsV1GetFleets.ts | 3 + src/funcs/fleetsV1UpdateFleetRegion.ts | 3 + .../lobbiesV1CreatePrivateLobbyDeprecated.ts | 2 + .../lobbiesV1CreatePublicLobbyDeprecated.ts | 2 + ...esV1ListActivePublicLobbiesDeprecatedV1.ts | 2 + src/funcs/lobbiesV2CreateLobbyDeprecated.ts | 3 + src/funcs/lobbiesV2CreateLocalLobby.ts | 2 + src/funcs/lobbiesV2CreatePrivateLobby.ts | 2 + src/funcs/lobbiesV2CreatePublicLobby.ts | 2 + src/funcs/lobbiesV2GetLobbyInfo.ts | 3 + ...esV2ListActivePublicLobbiesDeprecatedV2.ts | 3 + src/funcs/lobbiesV2SetLobbyState.ts | 3 + src/funcs/lobbiesV3CreateLobby.ts | 3 + src/funcs/lobbiesV3GetLobbyInfoByRoomId.ts | 3 + src/funcs/lobbiesV3GetLobbyInfoByShortCode.ts | 3 + src/funcs/lobbiesV3ListActivePublicLobbies.ts | 3 + src/funcs/logsV1DownloadLogForProcess.ts | 3 + src/funcs/logsV1GetLogsForProcess.ts | 3 + .../managementV1SendVerificationEmail.ts | 3 + src/funcs/metricsV1GetMetricsDeprecated.ts | 3 + src/funcs/organizationsV1AcceptInvite.ts | 3 + src/funcs/organizationsV1GetOrgMembers.ts | 3 + .../organizationsV1GetOrgPendingInvites.ts | 3 + src/funcs/organizationsV1GetOrgs.ts | 3 + .../organizationsV1GetUserPendingInvites.ts | 3 + src/funcs/organizationsV1InviteUser.ts | 3 + src/funcs/organizationsV1RejectInvite.ts | 3 + src/funcs/organizationsV1RescindInvite.ts | 3 + .../processesV1GetProcessInfoDeprecated.ts | 3 + src/funcs/processesV1GetRunningProcesses.ts | 3 + src/funcs/processesV1GetStoppedProcesses.ts | 3 + .../processesV2CreateProcessV2Deprecated.ts | 3 + ...ocessesV2GetLatestProcessesV2Deprecated.ts | 3 + .../processesV2GetProcessInfoV2Deprecated.ts | 3 + ...tProcessesCountExperimentalV2Deprecated.ts | 3 + .../processesV2StopProcessV2Deprecated.ts | 3 + src/funcs/processesV3CreateProcess.ts | 3 + src/funcs/processesV3GetLatestProcesses.ts | 3 + src/funcs/processesV3GetProcess.ts | 3 + src/funcs/processesV3GetProcessMetrics.ts | 3 + ...rocessesV3GetProcessesCountExperimental.ts | 3 + src/funcs/processesV3StopProcess.ts | 3 + src/funcs/roomsV1CreateRoomDeprecated.ts | 2 + src/funcs/roomsV1DestroyRoomDeprecated.ts | 2 + ...omsV1GetActiveRoomsForProcessDeprecated.ts | 2 + .../roomsV1GetConnectionInfoDeprecated.ts | 2 + ...sV1GetInactiveRoomsForProcessDeprecated.ts | 2 + src/funcs/roomsV1GetRoomInfoDeprecated.ts | 2 + src/funcs/roomsV1SuspendRoomDeprecated.ts | 2 + src/funcs/roomsV2CreateRoom.ts | 3 + src/funcs/roomsV2DestroyRoom.ts | 3 + src/funcs/roomsV2GetActiveRoomsForProcess.ts | 3 + src/funcs/roomsV2GetConnectionInfo.ts | 3 + .../roomsV2GetInactiveRoomsForProcess.ts | 3 + src/funcs/roomsV2GetRoomInfo.ts | 3 + src/funcs/roomsV2SuspendRoomV2Deprecated.ts | 3 + src/funcs/roomsV2UpdateRoomConfig.ts | 3 + src/funcs/tokensV1CreateOrgToken.ts | 3 + src/funcs/tokensV1GetOrgTokens.ts | 3 + src/funcs/tokensV1RevokeOrgToken.ts | 3 + src/lib/config.ts | 6 +- src/sdk/appsv1.ts | 15 + src/sdk/appsv2.ts | 15 + src/sdk/authv1.ts | 9 + src/sdk/billingv1.ts | 18 + src/sdk/buildsv1.ts | 15 + src/sdk/buildsv2.ts | 21 + src/sdk/buildsv3.ts | 15 + src/sdk/deploymentsv1.ts | 12 + src/sdk/deploymentsv2.ts | 12 + src/sdk/deploymentsv3.ts | 12 + src/sdk/discoveryv1.ts | 3 + src/sdk/discoveryv2.ts | 3 + src/sdk/fleetsv1.ts | 12 + src/sdk/lobbiesv1.ts | 6 + src/sdk/lobbiesv2.ts | 18 + src/sdk/lobbiesv3.ts | 12 + src/sdk/logsv1.ts | 6 + src/sdk/managementv1.ts | 3 + src/sdk/metricsv1.ts | 3 + src/sdk/organizationsv1.ts | 24 + src/sdk/processesv1.ts | 9 + src/sdk/processesv2.ts | 15 + src/sdk/processesv3.ts | 18 + src/sdk/roomsv1.ts | 14 + src/sdk/roomsv2.ts | 24 + src/sdk/tokensv1.ts | 9 + 173 files changed, 1072 insertions(+), 364 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 4ecbb5f2..71b6ea19 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 1b06df09-5141-4b14-b0b7-5415dbf16cfb management: - docChecksum: 83ae53941fd703d9ce4034ec1d57c1e8 + docChecksum: 35379ef2a587c306c931c0c2e615a982 docVersion: 0.0.1 - speakeasyVersion: 1.423.5 - generationVersion: 2.445.1 - releaseVersion: 2.10.9 - configChecksum: 0c1446ea5603afbd91bb798ecce16dbb + speakeasyVersion: 1.426.0 + generationVersion: 2.446.5 + releaseVersion: 2.10.10 + configChecksum: e484e4ea0663e0f2e18b334c80309c79 repoURL: https://github.com/hathora/cloud-sdk-typescript.git installationURL: https://github.com/hathora/cloud-sdk-typescript published: true @@ -14,12 +14,12 @@ features: typescript: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.11 - core: 3.18.2 + core: 3.18.3 defaultEnabledRetries: 0.1.0 deprecations: 2.81.1 downloadStreams: 0.1.1 enumUnions: 0.1.0 - envVarSecurityUsage: 0.1.1 + envVarSecurityUsage: 0.1.2 flattening: 2.82.0 globalSecurity: 2.82.11 globalSecurityCallbacks: 0.1.0 diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 4779a4ba..84f5a67a 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.423.5 +speakeasyVersion: 1.426.0 sources: my-source: sourceNamespace: my-source - sourceRevisionDigest: sha256:7b17585a296d8bcf4895f1d24e46387db47594390bc9cf2e6b8d1debcdda5060 - sourceBlobDigest: sha256:0e16ce9aaa07e858d7c86259cef36b8abf8e4a92edce30c9c7f89dd4dd23f638 + sourceRevisionDigest: sha256:a30fa9e0f9b60049cfdffd2f22a878d934c10e6b6179689ff5a9e4a25ee59850 + sourceBlobDigest: sha256:501b059979280d869a3e1a524597bfca46dc28e18023e63cad0fdf1ba1061442 tags: - latest - main @@ -11,10 +11,10 @@ targets: hathora-typescript: source: my-source sourceNamespace: my-source - sourceRevisionDigest: sha256:7b17585a296d8bcf4895f1d24e46387db47594390bc9cf2e6b8d1debcdda5060 - sourceBlobDigest: sha256:0e16ce9aaa07e858d7c86259cef36b8abf8e4a92edce30c9c7f89dd4dd23f638 + sourceRevisionDigest: sha256:a30fa9e0f9b60049cfdffd2f22a878d934c10e6b6179689ff5a9e4a25ee59850 + sourceBlobDigest: sha256:501b059979280d869a3e1a524597bfca46dc28e18023e63cad0fdf1ba1061442 codeSamplesNamespace: code-samples-typescript-hathora-typescript - codeSamplesRevisionDigest: sha256:a04681eac56ed5af947516a86cb00bd53689f0bb53c63152f1ba917bd301c706 + codeSamplesRevisionDigest: sha256:1b73ee0fea26147f713a901d4fa90bae4a761c8c499dbaabe333aca7b3382704 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/README.md b/README.md index 7bceb8b1..7710eacb 100755 --- a/README.md +++ b/README.md @@ -98,196 +98,194 @@ run(); ### [~~appsV1~~](docs/sdks/appsv1/README.md) -* [~~getAppsV1Deprecated~~](docs/sdks/appsv1/README.md#getappsv1deprecated) - Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. :warning: **Deprecated** -* [~~createAppV1Deprecated~~](docs/sdks/appsv1/README.md#createappv1deprecated) - Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~updateAppV1Deprecated~~](docs/sdks/appsv1/README.md#updateappv1deprecated) - Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. :warning: **Deprecated** -* [~~getAppInfoV1Deprecated~~](docs/sdks/appsv1/README.md#getappinfov1deprecated) - Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. :warning: **Deprecated** -* [~~deleteAppV1Deprecated~~](docs/sdks/appsv1/README.md#deleteappv1deprecated) - Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. :warning: **Deprecated** +* [~~getAppsV1Deprecated~~](docs/sdks/appsv1/README.md#getappsv1deprecated) - GetAppsV1Deprecated :warning: **Deprecated** +* [~~createAppV1Deprecated~~](docs/sdks/appsv1/README.md#createappv1deprecated) - CreateAppV1Deprecated :warning: **Deprecated** +* [~~updateAppV1Deprecated~~](docs/sdks/appsv1/README.md#updateappv1deprecated) - UpdateAppV1Deprecated :warning: **Deprecated** +* [~~getAppInfoV1Deprecated~~](docs/sdks/appsv1/README.md#getappinfov1deprecated) - GetAppInfoV1Deprecated :warning: **Deprecated** +* [~~deleteAppV1Deprecated~~](docs/sdks/appsv1/README.md#deleteappv1deprecated) - DeleteAppV1Deprecated :warning: **Deprecated** ### [appsV2](docs/sdks/appsv2/README.md) -* [getApps](docs/sdks/appsv2/README.md#getapps) - Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. -* [createApp](docs/sdks/appsv2/README.md#createapp) - Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). -* [updateApp](docs/sdks/appsv2/README.md#updateapp) - Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. -* [getApp](docs/sdks/appsv2/README.md#getapp) - Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. -* [deleteApp](docs/sdks/appsv2/README.md#deleteapp) - Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. +* [getApps](docs/sdks/appsv2/README.md#getapps) - GetApps +* [createApp](docs/sdks/appsv2/README.md#createapp) - CreateApp +* [updateApp](docs/sdks/appsv2/README.md#updateapp) - UpdateApp +* [getApp](docs/sdks/appsv2/README.md#getapp) - GetApp +* [deleteApp](docs/sdks/appsv2/README.md#deleteapp) - DeleteApp ### [authV1](docs/sdks/authv1/README.md) -* [loginAnonymous](docs/sdks/authv1/README.md#loginanonymous) - Returns a unique player token for an anonymous user. -* [loginNickname](docs/sdks/authv1/README.md#loginnickname) - Returns a unique player token with a specified nickname for a user. -* [loginGoogle](docs/sdks/authv1/README.md#logingoogle) - Returns a unique player token using a Google-signed OIDC `idToken`. +* [loginAnonymous](docs/sdks/authv1/README.md#loginanonymous) - LoginAnonymous +* [loginNickname](docs/sdks/authv1/README.md#loginnickname) - LoginNickname +* [loginGoogle](docs/sdks/authv1/README.md#logingoogle) - LoginGoogle ### [billingV1](docs/sdks/billingv1/README.md) -* [getBalance](docs/sdks/billingv1/README.md#getbalance) -* [getUpcomingInvoiceItems](docs/sdks/billingv1/README.md#getupcominginvoiceitems) -* [getUpcomingInvoiceTotal](docs/sdks/billingv1/README.md#getupcominginvoicetotal) -* [getPaymentMethod](docs/sdks/billingv1/README.md#getpaymentmethod) -* [initStripeCustomerPortalUrl](docs/sdks/billingv1/README.md#initstripecustomerportalurl) -* [getInvoices](docs/sdks/billingv1/README.md#getinvoices) +* [getBalance](docs/sdks/billingv1/README.md#getbalance) - GetBalance +* [getUpcomingInvoiceItems](docs/sdks/billingv1/README.md#getupcominginvoiceitems) - GetUpcomingInvoiceItems +* [getUpcomingInvoiceTotal](docs/sdks/billingv1/README.md#getupcominginvoicetotal) - GetUpcomingInvoiceTotal +* [getPaymentMethod](docs/sdks/billingv1/README.md#getpaymentmethod) - GetPaymentMethod +* [initStripeCustomerPortalUrl](docs/sdks/billingv1/README.md#initstripecustomerportalurl) - InitStripeCustomerPortalUrl +* [getInvoices](docs/sdks/billingv1/README.md#getinvoices) - GetInvoices ### [~~buildsV1~~](docs/sdks/buildsv1/README.md) -* [~~getBuildsDeprecated~~](docs/sdks/buildsv1/README.md#getbuildsdeprecated) - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getBuildInfoDeprecated~~](docs/sdks/buildsv1/README.md#getbuildinfodeprecated) - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). :warning: **Deprecated** -* [~~createBuildDeprecated~~](docs/sdks/buildsv1/README.md#createbuilddeprecated) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -* [~~deleteBuildDeprecated~~](docs/sdks/buildsv1/README.md#deletebuilddeprecated) - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. :warning: **Deprecated** -* [~~runBuildDeprecated~~](docs/sdks/buildsv1/README.md#runbuilddeprecated) - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). :warning: **Deprecated** +* [~~getBuildsDeprecated~~](docs/sdks/buildsv1/README.md#getbuildsdeprecated) - GetBuildsDeprecated :warning: **Deprecated** +* [~~getBuildInfoDeprecated~~](docs/sdks/buildsv1/README.md#getbuildinfodeprecated) - GetBuildInfoDeprecated :warning: **Deprecated** +* [~~createBuildDeprecated~~](docs/sdks/buildsv1/README.md#createbuilddeprecated) - CreateBuildDeprecated :warning: **Deprecated** +* [~~deleteBuildDeprecated~~](docs/sdks/buildsv1/README.md#deletebuilddeprecated) - DeleteBuildDeprecated :warning: **Deprecated** +* [~~runBuildDeprecated~~](docs/sdks/buildsv1/README.md#runbuilddeprecated) - RunBuildDeprecated :warning: **Deprecated** ### [~~buildsV2~~](docs/sdks/buildsv2/README.md) -* [~~getBuildsV2Deprecated~~](docs/sdks/buildsv2/README.md#getbuildsv2deprecated) - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getBuildInfoV2Deprecated~~](docs/sdks/buildsv2/README.md#getbuildinfov2deprecated) - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). :warning: **Deprecated** -* [~~createBuildV2Deprecated~~](docs/sdks/buildsv2/README.md#createbuildv2deprecated) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -* [~~createBuildWithUploadUrlV2Deprecated~~](docs/sdks/buildsv2/README.md#createbuildwithuploadurlv2deprecated) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with `uploadUrl` that can be used to upload the build to before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -* [~~createWithMultipartUploadsV2Deprecated~~](docs/sdks/buildsv2/README.md#createwithmultipartuploadsv2deprecated) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -* [~~deleteBuildV2Deprecated~~](docs/sdks/buildsv2/README.md#deletebuildv2deprecated) - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. :warning: **Deprecated** -* [~~runBuildV2Deprecated~~](docs/sdks/buildsv2/README.md#runbuildv2deprecated) - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). :warning: **Deprecated** +* [~~getBuildsV2Deprecated~~](docs/sdks/buildsv2/README.md#getbuildsv2deprecated) - GetBuildsV2Deprecated :warning: **Deprecated** +* [~~getBuildInfoV2Deprecated~~](docs/sdks/buildsv2/README.md#getbuildinfov2deprecated) - GetBuildInfoV2Deprecated :warning: **Deprecated** +* [~~createBuildV2Deprecated~~](docs/sdks/buildsv2/README.md#createbuildv2deprecated) - CreateBuildV2Deprecated :warning: **Deprecated** +* [~~createBuildWithUploadUrlV2Deprecated~~](docs/sdks/buildsv2/README.md#createbuildwithuploadurlv2deprecated) - CreateBuildWithUploadUrlV2Deprecated :warning: **Deprecated** +* [~~createWithMultipartUploadsV2Deprecated~~](docs/sdks/buildsv2/README.md#createwithmultipartuploadsv2deprecated) - CreateWithMultipartUploadsV2Deprecated :warning: **Deprecated** +* [~~deleteBuildV2Deprecated~~](docs/sdks/buildsv2/README.md#deletebuildv2deprecated) - DeleteBuildV2Deprecated :warning: **Deprecated** +* [~~runBuildV2Deprecated~~](docs/sdks/buildsv2/README.md#runbuildv2deprecated) - RunBuildV2Deprecated :warning: **Deprecated** ### [buildsV3](docs/sdks/buildsv3/README.md) -* [getBuilds](docs/sdks/buildsv3/README.md#getbuilds) - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). -* [createBuild](docs/sdks/buildsv3/README.md#createbuild) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. -* [getBuild](docs/sdks/buildsv3/README.md#getbuild) - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). -* [deleteBuild](docs/sdks/buildsv3/README.md#deletebuild) - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. -Be careful which builds you delete. This endpoint does not prevent you from deleting actively used builds. -Deleting a build that is actively build used by an app's deployment will cause failures when creating rooms. -* [runBuild](docs/sdks/buildsv3/README.md#runbuild) - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). +* [getBuilds](docs/sdks/buildsv3/README.md#getbuilds) - GetBuilds +* [createBuild](docs/sdks/buildsv3/README.md#createbuild) - CreateBuild +* [getBuild](docs/sdks/buildsv3/README.md#getbuild) - GetBuild +* [deleteBuild](docs/sdks/buildsv3/README.md#deletebuild) - DeleteBuild +* [runBuild](docs/sdks/buildsv3/README.md#runbuild) - RunBuild ### [~~deploymentsV1~~](docs/sdks/deploymentsv1/README.md) -* [~~getDeploymentsV1Deprecated~~](docs/sdks/deploymentsv1/README.md#getdeploymentsv1deprecated) - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getLatestDeploymentV1Deprecated~~](docs/sdks/deploymentsv1/README.md#getlatestdeploymentv1deprecated) - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getDeploymentInfoV1Deprecated~~](docs/sdks/deploymentsv1/README.md#getdeploymentinfov1deprecated) - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). :warning: **Deprecated** -* [~~createDeploymentV1Deprecated~~](docs/sdks/deploymentsv1/README.md#createdeploymentv1deprecated) - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. :warning: **Deprecated** +* [~~getDeploymentsV1Deprecated~~](docs/sdks/deploymentsv1/README.md#getdeploymentsv1deprecated) - GetDeploymentsV1Deprecated :warning: **Deprecated** +* [~~getLatestDeploymentV1Deprecated~~](docs/sdks/deploymentsv1/README.md#getlatestdeploymentv1deprecated) - GetLatestDeploymentV1Deprecated :warning: **Deprecated** +* [~~getDeploymentInfoV1Deprecated~~](docs/sdks/deploymentsv1/README.md#getdeploymentinfov1deprecated) - GetDeploymentInfoV1Deprecated :warning: **Deprecated** +* [~~createDeploymentV1Deprecated~~](docs/sdks/deploymentsv1/README.md#createdeploymentv1deprecated) - CreateDeploymentV1Deprecated :warning: **Deprecated** ### [~~deploymentsV2~~](docs/sdks/deploymentsv2/README.md) -* [~~getDeploymentsV2Deprecated~~](docs/sdks/deploymentsv2/README.md#getdeploymentsv2deprecated) - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getLatestDeploymentV2Deprecated~~](docs/sdks/deploymentsv2/README.md#getlatestdeploymentv2deprecated) - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getDeploymentInfoV2Deprecated~~](docs/sdks/deploymentsv2/README.md#getdeploymentinfov2deprecated) - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). :warning: **Deprecated** -* [~~createDeploymentV2Deprecated~~](docs/sdks/deploymentsv2/README.md#createdeploymentv2deprecated) - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. :warning: **Deprecated** +* [~~getDeploymentsV2Deprecated~~](docs/sdks/deploymentsv2/README.md#getdeploymentsv2deprecated) - GetDeploymentsV2Deprecated :warning: **Deprecated** +* [~~getLatestDeploymentV2Deprecated~~](docs/sdks/deploymentsv2/README.md#getlatestdeploymentv2deprecated) - GetLatestDeploymentV2Deprecated :warning: **Deprecated** +* [~~getDeploymentInfoV2Deprecated~~](docs/sdks/deploymentsv2/README.md#getdeploymentinfov2deprecated) - GetDeploymentInfoV2Deprecated :warning: **Deprecated** +* [~~createDeploymentV2Deprecated~~](docs/sdks/deploymentsv2/README.md#createdeploymentv2deprecated) - CreateDeploymentV2Deprecated :warning: **Deprecated** ### [deploymentsV3](docs/sdks/deploymentsv3/README.md) -* [getDeployments](docs/sdks/deploymentsv3/README.md#getdeployments) - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application), optionally filtered by deploymentTag. -* [createDeployment](docs/sdks/deploymentsv3/README.md#createdeployment) - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. -* [getLatestDeployment](docs/sdks/deploymentsv3/README.md#getlatestdeployment) - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). -* [getDeployment](docs/sdks/deploymentsv3/README.md#getdeployment) - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). +* [getDeployments](docs/sdks/deploymentsv3/README.md#getdeployments) - GetDeployments +* [createDeployment](docs/sdks/deploymentsv3/README.md#createdeployment) - CreateDeployment +* [getLatestDeployment](docs/sdks/deploymentsv3/README.md#getlatestdeployment) - GetLatestDeployment +* [getDeployment](docs/sdks/deploymentsv3/README.md#getdeployment) - GetDeployment ### [~~discoveryV1~~](docs/sdks/discoveryv1/README.md) -* [~~getPingServiceEndpointsDeprecated~~](docs/sdks/discoveryv1/README.md#getpingserviceendpointsdeprecated) - Returns an array of V1 regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. :warning: **Deprecated** +* [~~getPingServiceEndpointsDeprecated~~](docs/sdks/discoveryv1/README.md#getpingserviceendpointsdeprecated) - GetPingServiceEndpointsDeprecated :warning: **Deprecated** ### [discoveryV2](docs/sdks/discoveryv2/README.md) -* [getPingServiceEndpoints](docs/sdks/discoveryv2/README.md#getpingserviceendpoints) - Returns an array of all regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. +* [getPingServiceEndpoints](docs/sdks/discoveryv2/README.md#getpingserviceendpoints) - GetPingServiceEndpoints ### [fleetsV1](docs/sdks/fleetsv1/README.md) -* [getFleets](docs/sdks/fleetsv1/README.md#getfleets) - Returns an array of [fleets](https://hathora.dev/docs/concepts/hathora-entities#fleet). -* [getFleetRegion](docs/sdks/fleetsv1/README.md#getfleetregion) - Gets the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. -* [updateFleetRegion](docs/sdks/fleetsv1/README.md#updatefleetregion) - Updates the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. -* [getFleetMetrics](docs/sdks/fleetsv1/README.md#getfleetmetrics) - Gets metrics for a [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. +* [getFleets](docs/sdks/fleetsv1/README.md#getfleets) - GetFleets +* [getFleetRegion](docs/sdks/fleetsv1/README.md#getfleetregion) - GetFleetRegion +* [updateFleetRegion](docs/sdks/fleetsv1/README.md#updatefleetregion) - UpdateFleetRegion +* [getFleetMetrics](docs/sdks/fleetsv1/README.md#getfleetmetrics) - GetFleetMetrics ### [~~lobbiesV1~~](docs/sdks/lobbiesv1/README.md) -* [~~createPrivateLobbyDeprecated~~](docs/sdks/lobbiesv1/README.md#createprivatelobbydeprecated) - :warning: **Deprecated** -* [~~createPublicLobbyDeprecated~~](docs/sdks/lobbiesv1/README.md#createpubliclobbydeprecated) - :warning: **Deprecated** -* [~~listActivePublicLobbiesDeprecatedV1~~](docs/sdks/lobbiesv1/README.md#listactivepubliclobbiesdeprecatedv1) - :warning: **Deprecated** +* [~~createPrivateLobbyDeprecated~~](docs/sdks/lobbiesv1/README.md#createprivatelobbydeprecated) - CreatePrivateLobbyDeprecated :warning: **Deprecated** +* [~~createPublicLobbyDeprecated~~](docs/sdks/lobbiesv1/README.md#createpubliclobbydeprecated) - CreatePublicLobbyDeprecated :warning: **Deprecated** +* [~~listActivePublicLobbiesDeprecatedV1~~](docs/sdks/lobbiesv1/README.md#listactivepubliclobbiesdeprecatedv1) - ListActivePublicLobbiesDeprecatedV1 :warning: **Deprecated** ### [~~lobbiesV2~~](docs/sdks/lobbiesv2/README.md) -* [~~createPrivateLobby~~](docs/sdks/lobbiesv2/README.md#createprivatelobby) - :warning: **Deprecated** -* [~~createPublicLobby~~](docs/sdks/lobbiesv2/README.md#createpubliclobby) - :warning: **Deprecated** -* [~~createLocalLobby~~](docs/sdks/lobbiesv2/README.md#createlocallobby) - :warning: **Deprecated** -* [~~createLobbyDeprecated~~](docs/sdks/lobbiesv2/README.md#createlobbydeprecated) - 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. :warning: **Deprecated** -* [~~listActivePublicLobbiesDeprecatedV2~~](docs/sdks/lobbiesv2/README.md#listactivepubliclobbiesdeprecatedv2) - 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. :warning: **Deprecated** -* [~~getLobbyInfo~~](docs/sdks/lobbiesv2/README.md#getlobbyinfo) - Get details for a lobby. :warning: **Deprecated** -* [~~setLobbyState~~](docs/sdks/lobbiesv2/README.md#setlobbystate) - 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). :warning: **Deprecated** +* [~~createPrivateLobby~~](docs/sdks/lobbiesv2/README.md#createprivatelobby) - CreatePrivateLobby :warning: **Deprecated** +* [~~createPublicLobby~~](docs/sdks/lobbiesv2/README.md#createpubliclobby) - CreatePublicLobby :warning: **Deprecated** +* [~~createLocalLobby~~](docs/sdks/lobbiesv2/README.md#createlocallobby) - CreateLocalLobby :warning: **Deprecated** +* [~~createLobbyDeprecated~~](docs/sdks/lobbiesv2/README.md#createlobbydeprecated) - CreateLobbyDeprecated :warning: **Deprecated** +* [~~listActivePublicLobbiesDeprecatedV2~~](docs/sdks/lobbiesv2/README.md#listactivepubliclobbiesdeprecatedv2) - ListActivePublicLobbiesDeprecatedV2 :warning: **Deprecated** +* [~~getLobbyInfo~~](docs/sdks/lobbiesv2/README.md#getlobbyinfo) - GetLobbyInfo :warning: **Deprecated** +* [~~setLobbyState~~](docs/sdks/lobbiesv2/README.md#setlobbystate) - SetLobbyState :warning: **Deprecated** ### [lobbiesV3](docs/sdks/lobbiesv3/README.md) -* [createLobby](docs/sdks/lobbiesv3/README.md#createlobby) - 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. -* [listActivePublicLobbies](docs/sdks/lobbiesv3/README.md#listactivepubliclobbies) - 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. -* [getLobbyInfoByRoomId](docs/sdks/lobbiesv3/README.md#getlobbyinfobyroomid) - Get details for a lobby. -* [getLobbyInfoByShortCode](docs/sdks/lobbiesv3/README.md#getlobbyinfobyshortcode) - Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. +* [createLobby](docs/sdks/lobbiesv3/README.md#createlobby) - CreateLobby +* [listActivePublicLobbies](docs/sdks/lobbiesv3/README.md#listactivepubliclobbies) - ListActivePublicLobbies +* [getLobbyInfoByRoomId](docs/sdks/lobbiesv3/README.md#getlobbyinfobyroomid) - GetLobbyInfoByRoomId +* [getLobbyInfoByShortCode](docs/sdks/lobbiesv3/README.md#getlobbyinfobyshortcode) - GetLobbyInfoByShortCode ### [logsV1](docs/sdks/logsv1/README.md) -* [getLogsForProcess](docs/sdks/logsv1/README.md#getlogsforprocess) - Returns a stream of logs for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. -* [downloadLogForProcess](docs/sdks/logsv1/README.md#downloadlogforprocess) - Download entire log file for a stopped process. +* [getLogsForProcess](docs/sdks/logsv1/README.md#getlogsforprocess) - GetLogsForProcess +* [downloadLogForProcess](docs/sdks/logsv1/README.md#downloadlogforprocess) - DownloadLogForProcess ### [managementV1](docs/sdks/managementv1/README.md) -* [sendVerificationEmail](docs/sdks/managementv1/README.md#sendverificationemail) +* [sendVerificationEmail](docs/sdks/managementv1/README.md#sendverificationemail) - SendVerificationEmail ### [~~metricsV1~~](docs/sdks/metricsv1/README.md) -* [~~getMetricsDeprecated~~](docs/sdks/metricsv1/README.md#getmetricsdeprecated) - Get metrics for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. :warning: **Deprecated** +* [~~getMetricsDeprecated~~](docs/sdks/metricsv1/README.md#getmetricsdeprecated) - GetMetricsDeprecated :warning: **Deprecated** ### [organizationsV1](docs/sdks/organizationsv1/README.md) -* [getOrgs](docs/sdks/organizationsv1/README.md#getorgs) - Returns an unsorted list of all organizations that you are a member of (an accepted membership invite). An organization is uniquely identified by an `orgId`. -* [getUserPendingInvites](docs/sdks/organizationsv1/README.md#getuserpendinginvites) -* [getOrgMembers](docs/sdks/organizationsv1/README.md#getorgmembers) -* [inviteUser](docs/sdks/organizationsv1/README.md#inviteuser) -* [rescindInvite](docs/sdks/organizationsv1/README.md#rescindinvite) -* [getOrgPendingInvites](docs/sdks/organizationsv1/README.md#getorgpendinginvites) -* [acceptInvite](docs/sdks/organizationsv1/README.md#acceptinvite) -* [rejectInvite](docs/sdks/organizationsv1/README.md#rejectinvite) +* [getOrgs](docs/sdks/organizationsv1/README.md#getorgs) - GetOrgs +* [getUserPendingInvites](docs/sdks/organizationsv1/README.md#getuserpendinginvites) - GetUserPendingInvites +* [getOrgMembers](docs/sdks/organizationsv1/README.md#getorgmembers) - GetOrgMembers +* [inviteUser](docs/sdks/organizationsv1/README.md#inviteuser) - InviteUser +* [rescindInvite](docs/sdks/organizationsv1/README.md#rescindinvite) - RescindInvite +* [getOrgPendingInvites](docs/sdks/organizationsv1/README.md#getorgpendinginvites) - GetOrgPendingInvites +* [acceptInvite](docs/sdks/organizationsv1/README.md#acceptinvite) - AcceptInvite +* [rejectInvite](docs/sdks/organizationsv1/README.md#rejectinvite) - RejectInvite ### [~~processesV1~~](docs/sdks/processesv1/README.md) -* [~~getRunningProcesses~~](docs/sdks/processesv1/README.md#getrunningprocesses) - Retrieve 10 most recently started [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. :warning: **Deprecated** -* [~~getStoppedProcesses~~](docs/sdks/processesv1/README.md#getstoppedprocesses) - Retrieve 10 most recently stopped [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. :warning: **Deprecated** -* [~~getProcessInfoDeprecated~~](docs/sdks/processesv1/README.md#getprocessinfodeprecated) - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). :warning: **Deprecated** +* [~~getRunningProcesses~~](docs/sdks/processesv1/README.md#getrunningprocesses) - GetRunningProcesses :warning: **Deprecated** +* [~~getStoppedProcesses~~](docs/sdks/processesv1/README.md#getstoppedprocesses) - GetStoppedProcesses :warning: **Deprecated** +* [~~getProcessInfoDeprecated~~](docs/sdks/processesv1/README.md#getprocessinfodeprecated) - GetProcessInfoDeprecated :warning: **Deprecated** ### [~~processesV2~~](docs/sdks/processesv2/README.md) -* [~~getProcessInfoV2Deprecated~~](docs/sdks/processesv2/README.md#getprocessinfov2deprecated) - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). :warning: **Deprecated** -* [~~getLatestProcessesV2Deprecated~~](docs/sdks/processesv2/README.md#getlatestprocessesv2deprecated) - Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. :warning: **Deprecated** -* [~~getProcessesCountExperimentalV2Deprecated~~](docs/sdks/processesv2/README.md#getprocessescountexperimentalv2deprecated) - Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. :warning: **Deprecated** -* [~~stopProcessV2Deprecated~~](docs/sdks/processesv2/README.md#stopprocessv2deprecated) - Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. :warning: **Deprecated** -* [~~createProcessV2Deprecated~~](docs/sdks/processesv2/README.md#createprocessv2deprecated) - Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. :warning: **Deprecated** +* [~~getProcessInfoV2Deprecated~~](docs/sdks/processesv2/README.md#getprocessinfov2deprecated) - GetProcessInfoV2Deprecated :warning: **Deprecated** +* [~~getLatestProcessesV2Deprecated~~](docs/sdks/processesv2/README.md#getlatestprocessesv2deprecated) - GetLatestProcessesV2Deprecated :warning: **Deprecated** +* [~~getProcessesCountExperimentalV2Deprecated~~](docs/sdks/processesv2/README.md#getprocessescountexperimentalv2deprecated) - GetProcessesCountExperimentalV2Deprecated :warning: **Deprecated** +* [~~stopProcessV2Deprecated~~](docs/sdks/processesv2/README.md#stopprocessv2deprecated) - StopProcessV2Deprecated :warning: **Deprecated** +* [~~createProcessV2Deprecated~~](docs/sdks/processesv2/README.md#createprocessv2deprecated) - CreateProcessV2Deprecated :warning: **Deprecated** ### [processesV3](docs/sdks/processesv3/README.md) -* [getLatestProcesses](docs/sdks/processesv3/README.md#getlatestprocesses) - Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. -* [getProcessesCountExperimental](docs/sdks/processesv3/README.md#getprocessescountexperimental) - Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. -* [createProcess](docs/sdks/processesv3/README.md#createprocess) - Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. -* [getProcess](docs/sdks/processesv3/README.md#getprocess) - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). -* [stopProcess](docs/sdks/processesv3/README.md#stopprocess) - Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. -* [getProcessMetrics](docs/sdks/processesv3/README.md#getprocessmetrics) +* [getLatestProcesses](docs/sdks/processesv3/README.md#getlatestprocesses) - GetLatestProcesses +* [getProcessesCountExperimental](docs/sdks/processesv3/README.md#getprocessescountexperimental) - GetProcessesCountExperimental +* [createProcess](docs/sdks/processesv3/README.md#createprocess) - CreateProcess +* [getProcess](docs/sdks/processesv3/README.md#getprocess) - GetProcess +* [stopProcess](docs/sdks/processesv3/README.md#stopprocess) - StopProcess +* [getProcessMetrics](docs/sdks/processesv3/README.md#getprocessmetrics) - GetProcessMetrics ### [~~roomsV1~~](docs/sdks/roomsv1/README.md) -* [~~createRoomDeprecated~~](docs/sdks/roomsv1/README.md#createroomdeprecated) - :warning: **Deprecated** -* [~~getRoomInfoDeprecated~~](docs/sdks/roomsv1/README.md#getroominfodeprecated) - :warning: **Deprecated** -* [~~getActiveRoomsForProcessDeprecated~~](docs/sdks/roomsv1/README.md#getactiveroomsforprocessdeprecated) - :warning: **Deprecated** -* [~~getInactiveRoomsForProcessDeprecated~~](docs/sdks/roomsv1/README.md#getinactiveroomsforprocessdeprecated) - :warning: **Deprecated** -* [~~destroyRoomDeprecated~~](docs/sdks/roomsv1/README.md#destroyroomdeprecated) - :warning: **Deprecated** -* [~~suspendRoomDeprecated~~](docs/sdks/roomsv1/README.md#suspendroomdeprecated) - :warning: **Deprecated** -* [~~getConnectionInfoDeprecated~~](docs/sdks/roomsv1/README.md#getconnectioninfodeprecated) - :warning: **Deprecated** +* [~~createRoomDeprecated~~](docs/sdks/roomsv1/README.md#createroomdeprecated) - CreateRoomDeprecated :warning: **Deprecated** +* [~~getRoomInfoDeprecated~~](docs/sdks/roomsv1/README.md#getroominfodeprecated) - GetRoomInfoDeprecated :warning: **Deprecated** +* [~~getActiveRoomsForProcessDeprecated~~](docs/sdks/roomsv1/README.md#getactiveroomsforprocessdeprecated) - GetActiveRoomsForProcessDeprecated :warning: **Deprecated** +* [~~getInactiveRoomsForProcessDeprecated~~](docs/sdks/roomsv1/README.md#getinactiveroomsforprocessdeprecated) - GetInactiveRoomsForProcessDeprecated :warning: **Deprecated** +* [~~destroyRoomDeprecated~~](docs/sdks/roomsv1/README.md#destroyroomdeprecated) - DestroyRoomDeprecated :warning: **Deprecated** +* [~~suspendRoomDeprecated~~](docs/sdks/roomsv1/README.md#suspendroomdeprecated) - SuspendRoomDeprecated :warning: **Deprecated** +* [~~getConnectionInfoDeprecated~~](docs/sdks/roomsv1/README.md#getconnectioninfodeprecated) - GetConnectionInfoDeprecated :warning: **Deprecated** ### [roomsV2](docs/sdks/roomsv2/README.md) -* [createRoom](docs/sdks/roomsv2/README.md#createroom) - Create a new [room](https://hathora.dev/docs/concepts/hathora-entities#room) for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application). Poll the [`GetConnectionInfo()`](https://hathora.dev/api#tag/RoomV2/operation/GetConnectionInfo) endpoint to get connection details for an active room. -* [getRoomInfo](docs/sdks/roomsv2/README.md#getroominfo) - Retreive current and historical allocation data for a [room](https://hathora.dev/docs/concepts/hathora-entities#room). -* [getActiveRoomsForProcess](docs/sdks/roomsv2/README.md#getactiveroomsforprocess) - Get all active [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). -* [getInactiveRoomsForProcess](docs/sdks/roomsv2/README.md#getinactiveroomsforprocess) - Get all inactive [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). -* [destroyRoom](docs/sdks/roomsv2/README.md#destroyroom) - Destroy a [room](https://hathora.dev/docs/concepts/hathora-entities#room). All associated metadata is deleted. -* [~~suspendRoomV2Deprecated~~](docs/sdks/roomsv2/README.md#suspendroomv2deprecated) - Suspend a [room](https://hathora.dev/docs/concepts/hathora-entities#room). The room is unallocated from the process but can be rescheduled later using the same `roomId`. :warning: **Deprecated** -* [getConnectionInfo](docs/sdks/roomsv2/README.md#getconnectioninfo) - Poll this endpoint to get connection details to a [room](https://hathora.dev/docs/concepts/hathora-entities#room). Clients can call this endpoint without authentication. -* [updateRoomConfig](docs/sdks/roomsv2/README.md#updateroomconfig) +* [createRoom](docs/sdks/roomsv2/README.md#createroom) - CreateRoom +* [getRoomInfo](docs/sdks/roomsv2/README.md#getroominfo) - GetRoomInfo +* [getActiveRoomsForProcess](docs/sdks/roomsv2/README.md#getactiveroomsforprocess) - GetActiveRoomsForProcess +* [getInactiveRoomsForProcess](docs/sdks/roomsv2/README.md#getinactiveroomsforprocess) - GetInactiveRoomsForProcess +* [destroyRoom](docs/sdks/roomsv2/README.md#destroyroom) - DestroyRoom +* [~~suspendRoomV2Deprecated~~](docs/sdks/roomsv2/README.md#suspendroomv2deprecated) - SuspendRoomV2Deprecated :warning: **Deprecated** +* [getConnectionInfo](docs/sdks/roomsv2/README.md#getconnectioninfo) - GetConnectionInfo +* [updateRoomConfig](docs/sdks/roomsv2/README.md#updateroomconfig) - UpdateRoomConfig ### [tokensV1](docs/sdks/tokensv1/README.md) -* [getOrgTokens](docs/sdks/tokensv1/README.md#getorgtokens) - List all organization tokens for a given org. -* [createOrgToken](docs/sdks/tokensv1/README.md#createorgtoken) - Create a new organization token. -* [revokeOrgToken](docs/sdks/tokensv1/README.md#revokeorgtoken) - Revoke an organization token. +* [getOrgTokens](docs/sdks/tokensv1/README.md#getorgtokens) - GetOrgTokens +* [createOrgToken](docs/sdks/tokensv1/README.md#createorgtoken) - CreateOrgToken +* [revokeOrgToken](docs/sdks/tokensv1/README.md#revokeorgtoken) - RevokeOrgToken @@ -570,120 +568,118 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). Available standalone functions -- [`appsV2CreateApp`](docs/sdks/appsv2/README.md#createapp) - Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). -- [`appsV2DeleteApp`](docs/sdks/appsv2/README.md#deleteapp) - Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. -- [`appsV2GetApp`](docs/sdks/appsv2/README.md#getapp) - Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. -- [`appsV2GetApps`](docs/sdks/appsv2/README.md#getapps) - Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. -- [`appsV2UpdateApp`](docs/sdks/appsv2/README.md#updateapp) - Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. -- [`authV1LoginAnonymous`](docs/sdks/authv1/README.md#loginanonymous) - Returns a unique player token for an anonymous user. -- [`authV1LoginGoogle`](docs/sdks/authv1/README.md#logingoogle) - Returns a unique player token using a Google-signed OIDC `idToken`. -- [`authV1LoginNickname`](docs/sdks/authv1/README.md#loginnickname) - Returns a unique player token with a specified nickname for a user. -- [`billingV1GetBalance`](docs/sdks/billingv1/README.md#getbalance) -- [`billingV1GetInvoices`](docs/sdks/billingv1/README.md#getinvoices) -- [`billingV1GetPaymentMethod`](docs/sdks/billingv1/README.md#getpaymentmethod) -- [`billingV1GetUpcomingInvoiceItems`](docs/sdks/billingv1/README.md#getupcominginvoiceitems) -- [`billingV1GetUpcomingInvoiceTotal`](docs/sdks/billingv1/README.md#getupcominginvoicetotal) -- [`billingV1InitStripeCustomerPortalUrl`](docs/sdks/billingv1/README.md#initstripecustomerportalurl) -- [`buildsV3CreateBuild`](docs/sdks/buildsv3/README.md#createbuild) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. -- [`buildsV3DeleteBuild`](docs/sdks/buildsv3/README.md#deletebuild) - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. -Be careful which builds you delete. This endpoint does not prevent you from deleting actively used builds. -Deleting a build that is actively build used by an app's deployment will cause failures when creating rooms. -- [`buildsV3GetBuild`](docs/sdks/buildsv3/README.md#getbuild) - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). -- [`buildsV3GetBuilds`](docs/sdks/buildsv3/README.md#getbuilds) - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). -- [`buildsV3RunBuild`](docs/sdks/buildsv3/README.md#runbuild) - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). -- [`deploymentsV3CreateDeployment`](docs/sdks/deploymentsv3/README.md#createdeployment) - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. -- [`deploymentsV3GetDeployment`](docs/sdks/deploymentsv3/README.md#getdeployment) - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). -- [`deploymentsV3GetDeployments`](docs/sdks/deploymentsv3/README.md#getdeployments) - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application), optionally filtered by deploymentTag. -- [`deploymentsV3GetLatestDeployment`](docs/sdks/deploymentsv3/README.md#getlatestdeployment) - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). -- [`discoveryV2GetPingServiceEndpoints`](docs/sdks/discoveryv2/README.md#getpingserviceendpoints) - Returns an array of all regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. -- [`fleetsV1GetFleetMetrics`](docs/sdks/fleetsv1/README.md#getfleetmetrics) - Gets metrics for a [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. -- [`fleetsV1GetFleetRegion`](docs/sdks/fleetsv1/README.md#getfleetregion) - Gets the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. -- [`fleetsV1GetFleets`](docs/sdks/fleetsv1/README.md#getfleets) - Returns an array of [fleets](https://hathora.dev/docs/concepts/hathora-entities#fleet). -- [`fleetsV1UpdateFleetRegion`](docs/sdks/fleetsv1/README.md#updatefleetregion) - Updates the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. -- [`lobbiesV3CreateLobby`](docs/sdks/lobbiesv3/README.md#createlobby) - 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. -- [`lobbiesV3GetLobbyInfoByRoomId`](docs/sdks/lobbiesv3/README.md#getlobbyinfobyroomid) - Get details for a lobby. -- [`lobbiesV3GetLobbyInfoByShortCode`](docs/sdks/lobbiesv3/README.md#getlobbyinfobyshortcode) - Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. -- [`lobbiesV3ListActivePublicLobbies`](docs/sdks/lobbiesv3/README.md#listactivepubliclobbies) - 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. -- [`logsV1DownloadLogForProcess`](docs/sdks/logsv1/README.md#downloadlogforprocess) - Download entire log file for a stopped process. -- [`logsV1GetLogsForProcess`](docs/sdks/logsv1/README.md#getlogsforprocess) - Returns a stream of logs for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. -- [`managementV1SendVerificationEmail`](docs/sdks/managementv1/README.md#sendverificationemail) -- [`organizationsV1AcceptInvite`](docs/sdks/organizationsv1/README.md#acceptinvite) -- [`organizationsV1GetOrgMembers`](docs/sdks/organizationsv1/README.md#getorgmembers) -- [`organizationsV1GetOrgPendingInvites`](docs/sdks/organizationsv1/README.md#getorgpendinginvites) -- [`organizationsV1GetOrgs`](docs/sdks/organizationsv1/README.md#getorgs) - Returns an unsorted list of all organizations that you are a member of (an accepted membership invite). An organization is uniquely identified by an `orgId`. -- [`organizationsV1GetUserPendingInvites`](docs/sdks/organizationsv1/README.md#getuserpendinginvites) -- [`organizationsV1InviteUser`](docs/sdks/organizationsv1/README.md#inviteuser) -- [`organizationsV1RejectInvite`](docs/sdks/organizationsv1/README.md#rejectinvite) -- [`organizationsV1RescindInvite`](docs/sdks/organizationsv1/README.md#rescindinvite) -- [`processesV3CreateProcess`](docs/sdks/processesv3/README.md#createprocess) - Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. -- [`processesV3GetLatestProcesses`](docs/sdks/processesv3/README.md#getlatestprocesses) - Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. -- [`processesV3GetProcess`](docs/sdks/processesv3/README.md#getprocess) - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). -- [`processesV3GetProcessesCountExperimental`](docs/sdks/processesv3/README.md#getprocessescountexperimental) - Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. -- [`processesV3GetProcessMetrics`](docs/sdks/processesv3/README.md#getprocessmetrics) -- [`processesV3StopProcess`](docs/sdks/processesv3/README.md#stopprocess) - Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. -- [`roomsV2CreateRoom`](docs/sdks/roomsv2/README.md#createroom) - Create a new [room](https://hathora.dev/docs/concepts/hathora-entities#room) for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application). Poll the [`GetConnectionInfo()`](https://hathora.dev/api#tag/RoomV2/operation/GetConnectionInfo) endpoint to get connection details for an active room. -- [`roomsV2DestroyRoom`](docs/sdks/roomsv2/README.md#destroyroom) - Destroy a [room](https://hathora.dev/docs/concepts/hathora-entities#room). All associated metadata is deleted. -- [`roomsV2GetActiveRoomsForProcess`](docs/sdks/roomsv2/README.md#getactiveroomsforprocess) - Get all active [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). -- [`roomsV2GetConnectionInfo`](docs/sdks/roomsv2/README.md#getconnectioninfo) - Poll this endpoint to get connection details to a [room](https://hathora.dev/docs/concepts/hathora-entities#room). Clients can call this endpoint without authentication. -- [`roomsV2GetInactiveRoomsForProcess`](docs/sdks/roomsv2/README.md#getinactiveroomsforprocess) - Get all inactive [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). -- [`roomsV2GetRoomInfo`](docs/sdks/roomsv2/README.md#getroominfo) - Retreive current and historical allocation data for a [room](https://hathora.dev/docs/concepts/hathora-entities#room). -- [`roomsV2UpdateRoomConfig`](docs/sdks/roomsv2/README.md#updateroomconfig) -- [`tokensV1CreateOrgToken`](docs/sdks/tokensv1/README.md#createorgtoken) - Create a new organization token. -- [`tokensV1GetOrgTokens`](docs/sdks/tokensv1/README.md#getorgtokens) - List all organization tokens for a given org. -- [`tokensV1RevokeOrgToken`](docs/sdks/tokensv1/README.md#revokeorgtoken) - Revoke an organization token. -- ~~[`appsV1CreateAppV1Deprecated`](docs/sdks/appsv1/README.md#createappv1deprecated)~~ - Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -- ~~[`appsV1DeleteAppV1Deprecated`](docs/sdks/appsv1/README.md#deleteappv1deprecated)~~ - Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. :warning: **Deprecated** -- ~~[`appsV1GetAppInfoV1Deprecated`](docs/sdks/appsv1/README.md#getappinfov1deprecated)~~ - Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. :warning: **Deprecated** -- ~~[`appsV1GetAppsV1Deprecated`](docs/sdks/appsv1/README.md#getappsv1deprecated)~~ - Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. :warning: **Deprecated** -- ~~[`appsV1UpdateAppV1Deprecated`](docs/sdks/appsv1/README.md#updateappv1deprecated)~~ - Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. :warning: **Deprecated** -- ~~[`buildsV1CreateBuildDeprecated`](docs/sdks/buildsv1/README.md#createbuilddeprecated)~~ - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -- ~~[`buildsV1DeleteBuildDeprecated`](docs/sdks/buildsv1/README.md#deletebuilddeprecated)~~ - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. :warning: **Deprecated** -- ~~[`buildsV1GetBuildInfoDeprecated`](docs/sdks/buildsv1/README.md#getbuildinfodeprecated)~~ - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). :warning: **Deprecated** -- ~~[`buildsV1GetBuildsDeprecated`](docs/sdks/buildsv1/README.md#getbuildsdeprecated)~~ - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -- ~~[`buildsV1RunBuildDeprecated`](docs/sdks/buildsv1/README.md#runbuilddeprecated)~~ - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). :warning: **Deprecated** -- ~~[`buildsV2CreateBuildV2Deprecated`](docs/sdks/buildsv2/README.md#createbuildv2deprecated)~~ - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -- ~~[`buildsV2CreateBuildWithUploadUrlV2Deprecated`](docs/sdks/buildsv2/README.md#createbuildwithuploadurlv2deprecated)~~ - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with `uploadUrl` that can be used to upload the build to before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -- ~~[`buildsV2CreateWithMultipartUploadsV2Deprecated`](docs/sdks/buildsv2/README.md#createwithmultipartuploadsv2deprecated)~~ - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -- ~~[`buildsV2DeleteBuildV2Deprecated`](docs/sdks/buildsv2/README.md#deletebuildv2deprecated)~~ - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. :warning: **Deprecated** -- ~~[`buildsV2GetBuildInfoV2Deprecated`](docs/sdks/buildsv2/README.md#getbuildinfov2deprecated)~~ - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). :warning: **Deprecated** -- ~~[`buildsV2GetBuildsV2Deprecated`](docs/sdks/buildsv2/README.md#getbuildsv2deprecated)~~ - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -- ~~[`buildsV2RunBuildV2Deprecated`](docs/sdks/buildsv2/README.md#runbuildv2deprecated)~~ - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). :warning: **Deprecated** -- ~~[`deploymentsV1CreateDeploymentV1Deprecated`](docs/sdks/deploymentsv1/README.md#createdeploymentv1deprecated)~~ - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. :warning: **Deprecated** -- ~~[`deploymentsV1GetDeploymentInfoV1Deprecated`](docs/sdks/deploymentsv1/README.md#getdeploymentinfov1deprecated)~~ - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). :warning: **Deprecated** -- ~~[`deploymentsV1GetDeploymentsV1Deprecated`](docs/sdks/deploymentsv1/README.md#getdeploymentsv1deprecated)~~ - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -- ~~[`deploymentsV1GetLatestDeploymentV1Deprecated`](docs/sdks/deploymentsv1/README.md#getlatestdeploymentv1deprecated)~~ - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -- ~~[`deploymentsV2CreateDeploymentV2Deprecated`](docs/sdks/deploymentsv2/README.md#createdeploymentv2deprecated)~~ - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. :warning: **Deprecated** -- ~~[`deploymentsV2GetDeploymentInfoV2Deprecated`](docs/sdks/deploymentsv2/README.md#getdeploymentinfov2deprecated)~~ - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). :warning: **Deprecated** -- ~~[`deploymentsV2GetDeploymentsV2Deprecated`](docs/sdks/deploymentsv2/README.md#getdeploymentsv2deprecated)~~ - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -- ~~[`deploymentsV2GetLatestDeploymentV2Deprecated`](docs/sdks/deploymentsv2/README.md#getlatestdeploymentv2deprecated)~~ - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -- ~~[`discoveryV1GetPingServiceEndpointsDeprecated`](docs/sdks/discoveryv1/README.md#getpingserviceendpointsdeprecated)~~ - Returns an array of V1 regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. :warning: **Deprecated** -- ~~[`lobbiesV1CreatePrivateLobbyDeprecated`](docs/sdks/lobbiesv1/README.md#createprivatelobbydeprecated)~~ - :warning: **Deprecated** -- ~~[`lobbiesV1CreatePublicLobbyDeprecated`](docs/sdks/lobbiesv1/README.md#createpubliclobbydeprecated)~~ - :warning: **Deprecated** -- ~~[`lobbiesV1ListActivePublicLobbiesDeprecatedV1`](docs/sdks/lobbiesv1/README.md#listactivepubliclobbiesdeprecatedv1)~~ - :warning: **Deprecated** -- ~~[`lobbiesV2CreateLobbyDeprecated`](docs/sdks/lobbiesv2/README.md#createlobbydeprecated)~~ - 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. :warning: **Deprecated** -- ~~[`lobbiesV2CreateLocalLobby`](docs/sdks/lobbiesv2/README.md#createlocallobby)~~ - :warning: **Deprecated** -- ~~[`lobbiesV2CreatePrivateLobby`](docs/sdks/lobbiesv2/README.md#createprivatelobby)~~ - :warning: **Deprecated** -- ~~[`lobbiesV2CreatePublicLobby`](docs/sdks/lobbiesv2/README.md#createpubliclobby)~~ - :warning: **Deprecated** -- ~~[`lobbiesV2GetLobbyInfo`](docs/sdks/lobbiesv2/README.md#getlobbyinfo)~~ - Get details for a lobby. :warning: **Deprecated** -- ~~[`lobbiesV2ListActivePublicLobbiesDeprecatedV2`](docs/sdks/lobbiesv2/README.md#listactivepubliclobbiesdeprecatedv2)~~ - 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. :warning: **Deprecated** -- ~~[`lobbiesV2SetLobbyState`](docs/sdks/lobbiesv2/README.md#setlobbystate)~~ - 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). :warning: **Deprecated** -- ~~[`metricsV1GetMetricsDeprecated`](docs/sdks/metricsv1/README.md#getmetricsdeprecated)~~ - Get metrics for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. :warning: **Deprecated** -- ~~[`processesV1GetProcessInfoDeprecated`](docs/sdks/processesv1/README.md#getprocessinfodeprecated)~~ - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). :warning: **Deprecated** -- ~~[`processesV1GetRunningProcesses`](docs/sdks/processesv1/README.md#getrunningprocesses)~~ - Retrieve 10 most recently started [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. :warning: **Deprecated** -- ~~[`processesV1GetStoppedProcesses`](docs/sdks/processesv1/README.md#getstoppedprocesses)~~ - Retrieve 10 most recently stopped [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. :warning: **Deprecated** -- ~~[`processesV2CreateProcessV2Deprecated`](docs/sdks/processesv2/README.md#createprocessv2deprecated)~~ - Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. :warning: **Deprecated** -- ~~[`processesV2GetLatestProcessesV2Deprecated`](docs/sdks/processesv2/README.md#getlatestprocessesv2deprecated)~~ - Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. :warning: **Deprecated** -- ~~[`processesV2GetProcessesCountExperimentalV2Deprecated`](docs/sdks/processesv2/README.md#getprocessescountexperimentalv2deprecated)~~ - Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. :warning: **Deprecated** -- ~~[`processesV2GetProcessInfoV2Deprecated`](docs/sdks/processesv2/README.md#getprocessinfov2deprecated)~~ - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). :warning: **Deprecated** -- ~~[`processesV2StopProcessV2Deprecated`](docs/sdks/processesv2/README.md#stopprocessv2deprecated)~~ - Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. :warning: **Deprecated** -- ~~[`roomsV1CreateRoomDeprecated`](docs/sdks/roomsv1/README.md#createroomdeprecated)~~ - :warning: **Deprecated** -- ~~[`roomsV1DestroyRoomDeprecated`](docs/sdks/roomsv1/README.md#destroyroomdeprecated)~~ - :warning: **Deprecated** -- ~~[`roomsV1GetActiveRoomsForProcessDeprecated`](docs/sdks/roomsv1/README.md#getactiveroomsforprocessdeprecated)~~ - :warning: **Deprecated** -- ~~[`roomsV1GetConnectionInfoDeprecated`](docs/sdks/roomsv1/README.md#getconnectioninfodeprecated)~~ - :warning: **Deprecated** -- ~~[`roomsV1GetInactiveRoomsForProcessDeprecated`](docs/sdks/roomsv1/README.md#getinactiveroomsforprocessdeprecated)~~ - :warning: **Deprecated** -- ~~[`roomsV1GetRoomInfoDeprecated`](docs/sdks/roomsv1/README.md#getroominfodeprecated)~~ - :warning: **Deprecated** -- ~~[`roomsV1SuspendRoomDeprecated`](docs/sdks/roomsv1/README.md#suspendroomdeprecated)~~ - :warning: **Deprecated** -- ~~[`roomsV2SuspendRoomV2Deprecated`](docs/sdks/roomsv2/README.md#suspendroomv2deprecated)~~ - Suspend a [room](https://hathora.dev/docs/concepts/hathora-entities#room). The room is unallocated from the process but can be rescheduled later using the same `roomId`. :warning: **Deprecated** +- [`appsV2CreateApp`](docs/sdks/appsv2/README.md#createapp) - CreateApp +- [`appsV2DeleteApp`](docs/sdks/appsv2/README.md#deleteapp) - DeleteApp +- [`appsV2GetApp`](docs/sdks/appsv2/README.md#getapp) - GetApp +- [`appsV2GetApps`](docs/sdks/appsv2/README.md#getapps) - GetApps +- [`appsV2UpdateApp`](docs/sdks/appsv2/README.md#updateapp) - UpdateApp +- [`authV1LoginAnonymous`](docs/sdks/authv1/README.md#loginanonymous) - LoginAnonymous +- [`authV1LoginGoogle`](docs/sdks/authv1/README.md#logingoogle) - LoginGoogle +- [`authV1LoginNickname`](docs/sdks/authv1/README.md#loginnickname) - LoginNickname +- [`billingV1GetBalance`](docs/sdks/billingv1/README.md#getbalance) - GetBalance +- [`billingV1GetInvoices`](docs/sdks/billingv1/README.md#getinvoices) - GetInvoices +- [`billingV1GetPaymentMethod`](docs/sdks/billingv1/README.md#getpaymentmethod) - GetPaymentMethod +- [`billingV1GetUpcomingInvoiceItems`](docs/sdks/billingv1/README.md#getupcominginvoiceitems) - GetUpcomingInvoiceItems +- [`billingV1GetUpcomingInvoiceTotal`](docs/sdks/billingv1/README.md#getupcominginvoicetotal) - GetUpcomingInvoiceTotal +- [`billingV1InitStripeCustomerPortalUrl`](docs/sdks/billingv1/README.md#initstripecustomerportalurl) - InitStripeCustomerPortalUrl +- [`buildsV3CreateBuild`](docs/sdks/buildsv3/README.md#createbuild) - CreateBuild +- [`buildsV3DeleteBuild`](docs/sdks/buildsv3/README.md#deletebuild) - DeleteBuild +- [`buildsV3GetBuild`](docs/sdks/buildsv3/README.md#getbuild) - GetBuild +- [`buildsV3GetBuilds`](docs/sdks/buildsv3/README.md#getbuilds) - GetBuilds +- [`buildsV3RunBuild`](docs/sdks/buildsv3/README.md#runbuild) - RunBuild +- [`deploymentsV3CreateDeployment`](docs/sdks/deploymentsv3/README.md#createdeployment) - CreateDeployment +- [`deploymentsV3GetDeployment`](docs/sdks/deploymentsv3/README.md#getdeployment) - GetDeployment +- [`deploymentsV3GetDeployments`](docs/sdks/deploymentsv3/README.md#getdeployments) - GetDeployments +- [`deploymentsV3GetLatestDeployment`](docs/sdks/deploymentsv3/README.md#getlatestdeployment) - GetLatestDeployment +- [`discoveryV2GetPingServiceEndpoints`](docs/sdks/discoveryv2/README.md#getpingserviceendpoints) - GetPingServiceEndpoints +- [`fleetsV1GetFleetMetrics`](docs/sdks/fleetsv1/README.md#getfleetmetrics) - GetFleetMetrics +- [`fleetsV1GetFleetRegion`](docs/sdks/fleetsv1/README.md#getfleetregion) - GetFleetRegion +- [`fleetsV1GetFleets`](docs/sdks/fleetsv1/README.md#getfleets) - GetFleets +- [`fleetsV1UpdateFleetRegion`](docs/sdks/fleetsv1/README.md#updatefleetregion) - UpdateFleetRegion +- [`lobbiesV3CreateLobby`](docs/sdks/lobbiesv3/README.md#createlobby) - CreateLobby +- [`lobbiesV3GetLobbyInfoByRoomId`](docs/sdks/lobbiesv3/README.md#getlobbyinfobyroomid) - GetLobbyInfoByRoomId +- [`lobbiesV3GetLobbyInfoByShortCode`](docs/sdks/lobbiesv3/README.md#getlobbyinfobyshortcode) - GetLobbyInfoByShortCode +- [`lobbiesV3ListActivePublicLobbies`](docs/sdks/lobbiesv3/README.md#listactivepubliclobbies) - ListActivePublicLobbies +- [`logsV1DownloadLogForProcess`](docs/sdks/logsv1/README.md#downloadlogforprocess) - DownloadLogForProcess +- [`logsV1GetLogsForProcess`](docs/sdks/logsv1/README.md#getlogsforprocess) - GetLogsForProcess +- [`managementV1SendVerificationEmail`](docs/sdks/managementv1/README.md#sendverificationemail) - SendVerificationEmail +- [`organizationsV1AcceptInvite`](docs/sdks/organizationsv1/README.md#acceptinvite) - AcceptInvite +- [`organizationsV1GetOrgMembers`](docs/sdks/organizationsv1/README.md#getorgmembers) - GetOrgMembers +- [`organizationsV1GetOrgPendingInvites`](docs/sdks/organizationsv1/README.md#getorgpendinginvites) - GetOrgPendingInvites +- [`organizationsV1GetOrgs`](docs/sdks/organizationsv1/README.md#getorgs) - GetOrgs +- [`organizationsV1GetUserPendingInvites`](docs/sdks/organizationsv1/README.md#getuserpendinginvites) - GetUserPendingInvites +- [`organizationsV1InviteUser`](docs/sdks/organizationsv1/README.md#inviteuser) - InviteUser +- [`organizationsV1RejectInvite`](docs/sdks/organizationsv1/README.md#rejectinvite) - RejectInvite +- [`organizationsV1RescindInvite`](docs/sdks/organizationsv1/README.md#rescindinvite) - RescindInvite +- [`processesV3CreateProcess`](docs/sdks/processesv3/README.md#createprocess) - CreateProcess +- [`processesV3GetLatestProcesses`](docs/sdks/processesv3/README.md#getlatestprocesses) - GetLatestProcesses +- [`processesV3GetProcess`](docs/sdks/processesv3/README.md#getprocess) - GetProcess +- [`processesV3GetProcessesCountExperimental`](docs/sdks/processesv3/README.md#getprocessescountexperimental) - GetProcessesCountExperimental +- [`processesV3GetProcessMetrics`](docs/sdks/processesv3/README.md#getprocessmetrics) - GetProcessMetrics +- [`processesV3StopProcess`](docs/sdks/processesv3/README.md#stopprocess) - StopProcess +- [`roomsV2CreateRoom`](docs/sdks/roomsv2/README.md#createroom) - CreateRoom +- [`roomsV2DestroyRoom`](docs/sdks/roomsv2/README.md#destroyroom) - DestroyRoom +- [`roomsV2GetActiveRoomsForProcess`](docs/sdks/roomsv2/README.md#getactiveroomsforprocess) - GetActiveRoomsForProcess +- [`roomsV2GetConnectionInfo`](docs/sdks/roomsv2/README.md#getconnectioninfo) - GetConnectionInfo +- [`roomsV2GetInactiveRoomsForProcess`](docs/sdks/roomsv2/README.md#getinactiveroomsforprocess) - GetInactiveRoomsForProcess +- [`roomsV2GetRoomInfo`](docs/sdks/roomsv2/README.md#getroominfo) - GetRoomInfo +- [`roomsV2UpdateRoomConfig`](docs/sdks/roomsv2/README.md#updateroomconfig) - UpdateRoomConfig +- [`tokensV1CreateOrgToken`](docs/sdks/tokensv1/README.md#createorgtoken) - CreateOrgToken +- [`tokensV1GetOrgTokens`](docs/sdks/tokensv1/README.md#getorgtokens) - GetOrgTokens +- [`tokensV1RevokeOrgToken`](docs/sdks/tokensv1/README.md#revokeorgtoken) - RevokeOrgToken +- ~~[`appsV1CreateAppV1Deprecated`](docs/sdks/appsv1/README.md#createappv1deprecated)~~ - CreateAppV1Deprecated :warning: **Deprecated** +- ~~[`appsV1DeleteAppV1Deprecated`](docs/sdks/appsv1/README.md#deleteappv1deprecated)~~ - DeleteAppV1Deprecated :warning: **Deprecated** +- ~~[`appsV1GetAppInfoV1Deprecated`](docs/sdks/appsv1/README.md#getappinfov1deprecated)~~ - GetAppInfoV1Deprecated :warning: **Deprecated** +- ~~[`appsV1GetAppsV1Deprecated`](docs/sdks/appsv1/README.md#getappsv1deprecated)~~ - GetAppsV1Deprecated :warning: **Deprecated** +- ~~[`appsV1UpdateAppV1Deprecated`](docs/sdks/appsv1/README.md#updateappv1deprecated)~~ - UpdateAppV1Deprecated :warning: **Deprecated** +- ~~[`buildsV1CreateBuildDeprecated`](docs/sdks/buildsv1/README.md#createbuilddeprecated)~~ - CreateBuildDeprecated :warning: **Deprecated** +- ~~[`buildsV1DeleteBuildDeprecated`](docs/sdks/buildsv1/README.md#deletebuilddeprecated)~~ - DeleteBuildDeprecated :warning: **Deprecated** +- ~~[`buildsV1GetBuildInfoDeprecated`](docs/sdks/buildsv1/README.md#getbuildinfodeprecated)~~ - GetBuildInfoDeprecated :warning: **Deprecated** +- ~~[`buildsV1GetBuildsDeprecated`](docs/sdks/buildsv1/README.md#getbuildsdeprecated)~~ - GetBuildsDeprecated :warning: **Deprecated** +- ~~[`buildsV1RunBuildDeprecated`](docs/sdks/buildsv1/README.md#runbuilddeprecated)~~ - RunBuildDeprecated :warning: **Deprecated** +- ~~[`buildsV2CreateBuildV2Deprecated`](docs/sdks/buildsv2/README.md#createbuildv2deprecated)~~ - CreateBuildV2Deprecated :warning: **Deprecated** +- ~~[`buildsV2CreateBuildWithUploadUrlV2Deprecated`](docs/sdks/buildsv2/README.md#createbuildwithuploadurlv2deprecated)~~ - CreateBuildWithUploadUrlV2Deprecated :warning: **Deprecated** +- ~~[`buildsV2CreateWithMultipartUploadsV2Deprecated`](docs/sdks/buildsv2/README.md#createwithmultipartuploadsv2deprecated)~~ - CreateWithMultipartUploadsV2Deprecated :warning: **Deprecated** +- ~~[`buildsV2DeleteBuildV2Deprecated`](docs/sdks/buildsv2/README.md#deletebuildv2deprecated)~~ - DeleteBuildV2Deprecated :warning: **Deprecated** +- ~~[`buildsV2GetBuildInfoV2Deprecated`](docs/sdks/buildsv2/README.md#getbuildinfov2deprecated)~~ - GetBuildInfoV2Deprecated :warning: **Deprecated** +- ~~[`buildsV2GetBuildsV2Deprecated`](docs/sdks/buildsv2/README.md#getbuildsv2deprecated)~~ - GetBuildsV2Deprecated :warning: **Deprecated** +- ~~[`buildsV2RunBuildV2Deprecated`](docs/sdks/buildsv2/README.md#runbuildv2deprecated)~~ - RunBuildV2Deprecated :warning: **Deprecated** +- ~~[`deploymentsV1CreateDeploymentV1Deprecated`](docs/sdks/deploymentsv1/README.md#createdeploymentv1deprecated)~~ - CreateDeploymentV1Deprecated :warning: **Deprecated** +- ~~[`deploymentsV1GetDeploymentInfoV1Deprecated`](docs/sdks/deploymentsv1/README.md#getdeploymentinfov1deprecated)~~ - GetDeploymentInfoV1Deprecated :warning: **Deprecated** +- ~~[`deploymentsV1GetDeploymentsV1Deprecated`](docs/sdks/deploymentsv1/README.md#getdeploymentsv1deprecated)~~ - GetDeploymentsV1Deprecated :warning: **Deprecated** +- ~~[`deploymentsV1GetLatestDeploymentV1Deprecated`](docs/sdks/deploymentsv1/README.md#getlatestdeploymentv1deprecated)~~ - GetLatestDeploymentV1Deprecated :warning: **Deprecated** +- ~~[`deploymentsV2CreateDeploymentV2Deprecated`](docs/sdks/deploymentsv2/README.md#createdeploymentv2deprecated)~~ - CreateDeploymentV2Deprecated :warning: **Deprecated** +- ~~[`deploymentsV2GetDeploymentInfoV2Deprecated`](docs/sdks/deploymentsv2/README.md#getdeploymentinfov2deprecated)~~ - GetDeploymentInfoV2Deprecated :warning: **Deprecated** +- ~~[`deploymentsV2GetDeploymentsV2Deprecated`](docs/sdks/deploymentsv2/README.md#getdeploymentsv2deprecated)~~ - GetDeploymentsV2Deprecated :warning: **Deprecated** +- ~~[`deploymentsV2GetLatestDeploymentV2Deprecated`](docs/sdks/deploymentsv2/README.md#getlatestdeploymentv2deprecated)~~ - GetLatestDeploymentV2Deprecated :warning: **Deprecated** +- ~~[`discoveryV1GetPingServiceEndpointsDeprecated`](docs/sdks/discoveryv1/README.md#getpingserviceendpointsdeprecated)~~ - GetPingServiceEndpointsDeprecated :warning: **Deprecated** +- ~~[`lobbiesV1CreatePrivateLobbyDeprecated`](docs/sdks/lobbiesv1/README.md#createprivatelobbydeprecated)~~ - CreatePrivateLobbyDeprecated :warning: **Deprecated** +- ~~[`lobbiesV1CreatePublicLobbyDeprecated`](docs/sdks/lobbiesv1/README.md#createpubliclobbydeprecated)~~ - CreatePublicLobbyDeprecated :warning: **Deprecated** +- ~~[`lobbiesV1ListActivePublicLobbiesDeprecatedV1`](docs/sdks/lobbiesv1/README.md#listactivepubliclobbiesdeprecatedv1)~~ - ListActivePublicLobbiesDeprecatedV1 :warning: **Deprecated** +- ~~[`lobbiesV2CreateLobbyDeprecated`](docs/sdks/lobbiesv2/README.md#createlobbydeprecated)~~ - CreateLobbyDeprecated :warning: **Deprecated** +- ~~[`lobbiesV2CreateLocalLobby`](docs/sdks/lobbiesv2/README.md#createlocallobby)~~ - CreateLocalLobby :warning: **Deprecated** +- ~~[`lobbiesV2CreatePrivateLobby`](docs/sdks/lobbiesv2/README.md#createprivatelobby)~~ - CreatePrivateLobby :warning: **Deprecated** +- ~~[`lobbiesV2CreatePublicLobby`](docs/sdks/lobbiesv2/README.md#createpubliclobby)~~ - CreatePublicLobby :warning: **Deprecated** +- ~~[`lobbiesV2GetLobbyInfo`](docs/sdks/lobbiesv2/README.md#getlobbyinfo)~~ - GetLobbyInfo :warning: **Deprecated** +- ~~[`lobbiesV2ListActivePublicLobbiesDeprecatedV2`](docs/sdks/lobbiesv2/README.md#listactivepubliclobbiesdeprecatedv2)~~ - ListActivePublicLobbiesDeprecatedV2 :warning: **Deprecated** +- ~~[`lobbiesV2SetLobbyState`](docs/sdks/lobbiesv2/README.md#setlobbystate)~~ - SetLobbyState :warning: **Deprecated** +- ~~[`metricsV1GetMetricsDeprecated`](docs/sdks/metricsv1/README.md#getmetricsdeprecated)~~ - GetMetricsDeprecated :warning: **Deprecated** +- ~~[`processesV1GetProcessInfoDeprecated`](docs/sdks/processesv1/README.md#getprocessinfodeprecated)~~ - GetProcessInfoDeprecated :warning: **Deprecated** +- ~~[`processesV1GetRunningProcesses`](docs/sdks/processesv1/README.md#getrunningprocesses)~~ - GetRunningProcesses :warning: **Deprecated** +- ~~[`processesV1GetStoppedProcesses`](docs/sdks/processesv1/README.md#getstoppedprocesses)~~ - GetStoppedProcesses :warning: **Deprecated** +- ~~[`processesV2CreateProcessV2Deprecated`](docs/sdks/processesv2/README.md#createprocessv2deprecated)~~ - CreateProcessV2Deprecated :warning: **Deprecated** +- ~~[`processesV2GetLatestProcessesV2Deprecated`](docs/sdks/processesv2/README.md#getlatestprocessesv2deprecated)~~ - GetLatestProcessesV2Deprecated :warning: **Deprecated** +- ~~[`processesV2GetProcessesCountExperimentalV2Deprecated`](docs/sdks/processesv2/README.md#getprocessescountexperimentalv2deprecated)~~ - GetProcessesCountExperimentalV2Deprecated :warning: **Deprecated** +- ~~[`processesV2GetProcessInfoV2Deprecated`](docs/sdks/processesv2/README.md#getprocessinfov2deprecated)~~ - GetProcessInfoV2Deprecated :warning: **Deprecated** +- ~~[`processesV2StopProcessV2Deprecated`](docs/sdks/processesv2/README.md#stopprocessv2deprecated)~~ - StopProcessV2Deprecated :warning: **Deprecated** +- ~~[`roomsV1CreateRoomDeprecated`](docs/sdks/roomsv1/README.md#createroomdeprecated)~~ - CreateRoomDeprecated :warning: **Deprecated** +- ~~[`roomsV1DestroyRoomDeprecated`](docs/sdks/roomsv1/README.md#destroyroomdeprecated)~~ - DestroyRoomDeprecated :warning: **Deprecated** +- ~~[`roomsV1GetActiveRoomsForProcessDeprecated`](docs/sdks/roomsv1/README.md#getactiveroomsforprocessdeprecated)~~ - GetActiveRoomsForProcessDeprecated :warning: **Deprecated** +- ~~[`roomsV1GetConnectionInfoDeprecated`](docs/sdks/roomsv1/README.md#getconnectioninfodeprecated)~~ - GetConnectionInfoDeprecated :warning: **Deprecated** +- ~~[`roomsV1GetInactiveRoomsForProcessDeprecated`](docs/sdks/roomsv1/README.md#getinactiveroomsforprocessdeprecated)~~ - GetInactiveRoomsForProcessDeprecated :warning: **Deprecated** +- ~~[`roomsV1GetRoomInfoDeprecated`](docs/sdks/roomsv1/README.md#getroominfodeprecated)~~ - GetRoomInfoDeprecated :warning: **Deprecated** +- ~~[`roomsV1SuspendRoomDeprecated`](docs/sdks/roomsv1/README.md#suspendroomdeprecated)~~ - SuspendRoomDeprecated :warning: **Deprecated** +- ~~[`roomsV2SuspendRoomV2Deprecated`](docs/sdks/roomsv2/README.md#suspendroomv2deprecated)~~ - SuspendRoomV2Deprecated :warning: **Deprecated** diff --git a/RELEASES.md b/RELEASES.md index 970ad7c5..0e05d4a8 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -720,4 +720,14 @@ Based on: ### Generated - [typescript v2.10.9] . ### Releases -- [NPM v2.10.9] https://www.npmjs.com/package/@hathora/cloud-sdk-typescript/v/2.10.9 - . \ No newline at end of file +- [NPM v2.10.9] https://www.npmjs.com/package/@hathora/cloud-sdk-typescript/v/2.10.9 - . + +## 2024-11-05 00:14:51 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.426.0 (2.446.5) https://github.com/speakeasy-api/speakeasy +### Generated +- [typescript v2.10.10] . +### Releases +- [NPM v2.10.10] https://www.npmjs.com/package/@hathora/cloud-sdk-typescript/v/2.10.10 - . \ No newline at end of file diff --git a/docs/sdks/appsv1/README.md b/docs/sdks/appsv1/README.md index 1979329a..6fd4df17 100644 --- a/docs/sdks/appsv1/README.md +++ b/docs/sdks/appsv1/README.md @@ -5,11 +5,11 @@ ### Available Operations -* [~~getAppsV1Deprecated~~](#getappsv1deprecated) - Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. :warning: **Deprecated** -* [~~createAppV1Deprecated~~](#createappv1deprecated) - Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~updateAppV1Deprecated~~](#updateappv1deprecated) - Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. :warning: **Deprecated** -* [~~getAppInfoV1Deprecated~~](#getappinfov1deprecated) - Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. :warning: **Deprecated** -* [~~deleteAppV1Deprecated~~](#deleteappv1deprecated) - Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. :warning: **Deprecated** +* [~~getAppsV1Deprecated~~](#getappsv1deprecated) - GetAppsV1Deprecated :warning: **Deprecated** +* [~~createAppV1Deprecated~~](#createappv1deprecated) - CreateAppV1Deprecated :warning: **Deprecated** +* [~~updateAppV1Deprecated~~](#updateappv1deprecated) - UpdateAppV1Deprecated :warning: **Deprecated** +* [~~getAppInfoV1Deprecated~~](#getappinfov1deprecated) - GetAppInfoV1Deprecated :warning: **Deprecated** +* [~~deleteAppV1Deprecated~~](#deleteappv1deprecated) - DeleteAppV1Deprecated :warning: **Deprecated** ## ~~getAppsV1Deprecated~~ diff --git a/docs/sdks/appsv2/README.md b/docs/sdks/appsv2/README.md index 4305a82f..2e9b296a 100644 --- a/docs/sdks/appsv2/README.md +++ b/docs/sdks/appsv2/README.md @@ -7,11 +7,11 @@ Operations that allow you manage your [applications](https://hathora.dev/docs/co ### Available Operations -* [getApps](#getapps) - Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. -* [createApp](#createapp) - Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). -* [updateApp](#updateapp) - Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. -* [getApp](#getapp) - Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. -* [deleteApp](#deleteapp) - Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. +* [getApps](#getapps) - GetApps +* [createApp](#createapp) - CreateApp +* [updateApp](#updateapp) - UpdateApp +* [getApp](#getapp) - GetApp +* [deleteApp](#deleteapp) - DeleteApp ## getApps diff --git a/docs/sdks/authv1/README.md b/docs/sdks/authv1/README.md index 8d50902e..75824bce 100644 --- a/docs/sdks/authv1/README.md +++ b/docs/sdks/authv1/README.md @@ -7,9 +7,9 @@ Operations that allow you to generate a Hathora-signed [JSON web token (JWT)](ht ### Available Operations -* [loginAnonymous](#loginanonymous) - Returns a unique player token for an anonymous user. -* [loginNickname](#loginnickname) - Returns a unique player token with a specified nickname for a user. -* [loginGoogle](#logingoogle) - Returns a unique player token using a Google-signed OIDC `idToken`. +* [loginAnonymous](#loginanonymous) - LoginAnonymous +* [loginNickname](#loginnickname) - LoginNickname +* [loginGoogle](#logingoogle) - LoginGoogle ## loginAnonymous diff --git a/docs/sdks/billingv1/README.md b/docs/sdks/billingv1/README.md index 20fe98f4..683d2c53 100644 --- a/docs/sdks/billingv1/README.md +++ b/docs/sdks/billingv1/README.md @@ -7,15 +7,17 @@ ### Available Operations -* [getBalance](#getbalance) -* [getUpcomingInvoiceItems](#getupcominginvoiceitems) -* [getUpcomingInvoiceTotal](#getupcominginvoicetotal) -* [getPaymentMethod](#getpaymentmethod) -* [initStripeCustomerPortalUrl](#initstripecustomerportalurl) -* [getInvoices](#getinvoices) +* [getBalance](#getbalance) - GetBalance +* [getUpcomingInvoiceItems](#getupcominginvoiceitems) - GetUpcomingInvoiceItems +* [getUpcomingInvoiceTotal](#getupcominginvoicetotal) - GetUpcomingInvoiceTotal +* [getPaymentMethod](#getpaymentmethod) - GetPaymentMethod +* [initStripeCustomerPortalUrl](#initstripecustomerportalurl) - InitStripeCustomerPortalUrl +* [getInvoices](#getinvoices) - GetInvoices ## getBalance +GetBalance + ### Example Usage ```typescript @@ -88,6 +90,8 @@ run(); ## getUpcomingInvoiceItems +GetUpcomingInvoiceItems + ### Example Usage ```typescript @@ -160,6 +164,8 @@ run(); ## getUpcomingInvoiceTotal +GetUpcomingInvoiceTotal + ### Example Usage ```typescript @@ -232,6 +238,8 @@ run(); ## getPaymentMethod +GetPaymentMethod + ### Example Usage ```typescript @@ -304,6 +312,8 @@ run(); ## initStripeCustomerPortalUrl +InitStripeCustomerPortalUrl + ### Example Usage ```typescript @@ -381,6 +391,8 @@ run(); ## getInvoices +GetInvoices + ### Example Usage ```typescript diff --git a/docs/sdks/buildsv1/README.md b/docs/sdks/buildsv1/README.md index 3b75977a..91f0cd01 100644 --- a/docs/sdks/buildsv1/README.md +++ b/docs/sdks/buildsv1/README.md @@ -5,11 +5,11 @@ ### Available Operations -* [~~getBuildsDeprecated~~](#getbuildsdeprecated) - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getBuildInfoDeprecated~~](#getbuildinfodeprecated) - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). :warning: **Deprecated** -* [~~createBuildDeprecated~~](#createbuilddeprecated) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -* [~~deleteBuildDeprecated~~](#deletebuilddeprecated) - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. :warning: **Deprecated** -* [~~runBuildDeprecated~~](#runbuilddeprecated) - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). :warning: **Deprecated** +* [~~getBuildsDeprecated~~](#getbuildsdeprecated) - GetBuildsDeprecated :warning: **Deprecated** +* [~~getBuildInfoDeprecated~~](#getbuildinfodeprecated) - GetBuildInfoDeprecated :warning: **Deprecated** +* [~~createBuildDeprecated~~](#createbuilddeprecated) - CreateBuildDeprecated :warning: **Deprecated** +* [~~deleteBuildDeprecated~~](#deletebuilddeprecated) - DeleteBuildDeprecated :warning: **Deprecated** +* [~~runBuildDeprecated~~](#runbuilddeprecated) - RunBuildDeprecated :warning: **Deprecated** ## ~~getBuildsDeprecated~~ diff --git a/docs/sdks/buildsv2/README.md b/docs/sdks/buildsv2/README.md index 13be5083..988633c9 100644 --- a/docs/sdks/buildsv2/README.md +++ b/docs/sdks/buildsv2/README.md @@ -5,13 +5,13 @@ ### Available Operations -* [~~getBuildsV2Deprecated~~](#getbuildsv2deprecated) - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getBuildInfoV2Deprecated~~](#getbuildinfov2deprecated) - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). :warning: **Deprecated** -* [~~createBuildV2Deprecated~~](#createbuildv2deprecated) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -* [~~createBuildWithUploadUrlV2Deprecated~~](#createbuildwithuploadurlv2deprecated) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with `uploadUrl` that can be used to upload the build to before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -* [~~createWithMultipartUploadsV2Deprecated~~](#createwithmultipartuploadsv2deprecated) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. :warning: **Deprecated** -* [~~deleteBuildV2Deprecated~~](#deletebuildv2deprecated) - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. :warning: **Deprecated** -* [~~runBuildV2Deprecated~~](#runbuildv2deprecated) - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). :warning: **Deprecated** +* [~~getBuildsV2Deprecated~~](#getbuildsv2deprecated) - GetBuildsV2Deprecated :warning: **Deprecated** +* [~~getBuildInfoV2Deprecated~~](#getbuildinfov2deprecated) - GetBuildInfoV2Deprecated :warning: **Deprecated** +* [~~createBuildV2Deprecated~~](#createbuildv2deprecated) - CreateBuildV2Deprecated :warning: **Deprecated** +* [~~createBuildWithUploadUrlV2Deprecated~~](#createbuildwithuploadurlv2deprecated) - CreateBuildWithUploadUrlV2Deprecated :warning: **Deprecated** +* [~~createWithMultipartUploadsV2Deprecated~~](#createwithmultipartuploadsv2deprecated) - CreateWithMultipartUploadsV2Deprecated :warning: **Deprecated** +* [~~deleteBuildV2Deprecated~~](#deletebuildv2deprecated) - DeleteBuildV2Deprecated :warning: **Deprecated** +* [~~runBuildV2Deprecated~~](#runbuildv2deprecated) - RunBuildV2Deprecated :warning: **Deprecated** ## ~~getBuildsV2Deprecated~~ diff --git a/docs/sdks/buildsv3/README.md b/docs/sdks/buildsv3/README.md index fe1c0712..4df81af0 100644 --- a/docs/sdks/buildsv3/README.md +++ b/docs/sdks/buildsv3/README.md @@ -7,13 +7,11 @@ Operations that allow you create and manage your [builds](https://hathora.dev/do ### Available Operations -* [getBuilds](#getbuilds) - Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). -* [createBuild](#createbuild) - Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. -* [getBuild](#getbuild) - Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). -* [deleteBuild](#deletebuild) - Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. -Be careful which builds you delete. This endpoint does not prevent you from deleting actively used builds. -Deleting a build that is actively build used by an app's deployment will cause failures when creating rooms. -* [runBuild](#runbuild) - Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). +* [getBuilds](#getbuilds) - GetBuilds +* [createBuild](#createbuild) - CreateBuild +* [getBuild](#getbuild) - GetBuild +* [deleteBuild](#deletebuild) - DeleteBuild +* [runBuild](#runbuild) - RunBuild ## getBuilds diff --git a/docs/sdks/deploymentsv1/README.md b/docs/sdks/deploymentsv1/README.md index 473aa323..b1f03a07 100644 --- a/docs/sdks/deploymentsv1/README.md +++ b/docs/sdks/deploymentsv1/README.md @@ -5,10 +5,10 @@ ### Available Operations -* [~~getDeploymentsV1Deprecated~~](#getdeploymentsv1deprecated) - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getLatestDeploymentV1Deprecated~~](#getlatestdeploymentv1deprecated) - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getDeploymentInfoV1Deprecated~~](#getdeploymentinfov1deprecated) - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). :warning: **Deprecated** -* [~~createDeploymentV1Deprecated~~](#createdeploymentv1deprecated) - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. :warning: **Deprecated** +* [~~getDeploymentsV1Deprecated~~](#getdeploymentsv1deprecated) - GetDeploymentsV1Deprecated :warning: **Deprecated** +* [~~getLatestDeploymentV1Deprecated~~](#getlatestdeploymentv1deprecated) - GetLatestDeploymentV1Deprecated :warning: **Deprecated** +* [~~getDeploymentInfoV1Deprecated~~](#getdeploymentinfov1deprecated) - GetDeploymentInfoV1Deprecated :warning: **Deprecated** +* [~~createDeploymentV1Deprecated~~](#createdeploymentv1deprecated) - CreateDeploymentV1Deprecated :warning: **Deprecated** ## ~~getDeploymentsV1Deprecated~~ diff --git a/docs/sdks/deploymentsv2/README.md b/docs/sdks/deploymentsv2/README.md index 8c24790e..38b9a01e 100644 --- a/docs/sdks/deploymentsv2/README.md +++ b/docs/sdks/deploymentsv2/README.md @@ -5,10 +5,10 @@ ### Available Operations -* [~~getDeploymentsV2Deprecated~~](#getdeploymentsv2deprecated) - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getLatestDeploymentV2Deprecated~~](#getlatestdeploymentv2deprecated) - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). :warning: **Deprecated** -* [~~getDeploymentInfoV2Deprecated~~](#getdeploymentinfov2deprecated) - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). :warning: **Deprecated** -* [~~createDeploymentV2Deprecated~~](#createdeploymentv2deprecated) - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. :warning: **Deprecated** +* [~~getDeploymentsV2Deprecated~~](#getdeploymentsv2deprecated) - GetDeploymentsV2Deprecated :warning: **Deprecated** +* [~~getLatestDeploymentV2Deprecated~~](#getlatestdeploymentv2deprecated) - GetLatestDeploymentV2Deprecated :warning: **Deprecated** +* [~~getDeploymentInfoV2Deprecated~~](#getdeploymentinfov2deprecated) - GetDeploymentInfoV2Deprecated :warning: **Deprecated** +* [~~createDeploymentV2Deprecated~~](#createdeploymentv2deprecated) - CreateDeploymentV2Deprecated :warning: **Deprecated** ## ~~getDeploymentsV2Deprecated~~ diff --git a/docs/sdks/deploymentsv3/README.md b/docs/sdks/deploymentsv3/README.md index 9f3a55d5..f4598c8f 100644 --- a/docs/sdks/deploymentsv3/README.md +++ b/docs/sdks/deploymentsv3/README.md @@ -7,10 +7,10 @@ Operations that allow you configure and manage an application's [build](https:// ### Available Operations -* [getDeployments](#getdeployments) - Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application), optionally filtered by deploymentTag. -* [createDeployment](#createdeployment) - Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. -* [getLatestDeployment](#getlatestdeployment) - Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). -* [getDeployment](#getdeployment) - Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). +* [getDeployments](#getdeployments) - GetDeployments +* [createDeployment](#createdeployment) - CreateDeployment +* [getLatestDeployment](#getlatestdeployment) - GetLatestDeployment +* [getDeployment](#getdeployment) - GetDeployment ## getDeployments diff --git a/docs/sdks/discoveryv1/README.md b/docs/sdks/discoveryv1/README.md index b27f87f5..6eb7e388 100644 --- a/docs/sdks/discoveryv1/README.md +++ b/docs/sdks/discoveryv1/README.md @@ -7,7 +7,7 @@ Deprecated. Does not include latest Regions (missing Dallas region). Use [Discov ### Available Operations -* [~~getPingServiceEndpointsDeprecated~~](#getpingserviceendpointsdeprecated) - Returns an array of V1 regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. :warning: **Deprecated** +* [~~getPingServiceEndpointsDeprecated~~](#getpingserviceendpointsdeprecated) - GetPingServiceEndpointsDeprecated :warning: **Deprecated** ## ~~getPingServiceEndpointsDeprecated~~ diff --git a/docs/sdks/discoveryv2/README.md b/docs/sdks/discoveryv2/README.md index ffe6f51f..3c8a342b 100644 --- a/docs/sdks/discoveryv2/README.md +++ b/docs/sdks/discoveryv2/README.md @@ -7,7 +7,7 @@ Service that allows clients to directly ping all Hathora regions to get latency ### Available Operations -* [getPingServiceEndpoints](#getpingserviceendpoints) - Returns an array of all regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. +* [getPingServiceEndpoints](#getpingserviceendpoints) - GetPingServiceEndpoints ## getPingServiceEndpoints diff --git a/docs/sdks/fleetsv1/README.md b/docs/sdks/fleetsv1/README.md index eaaf5313..37c565f6 100644 --- a/docs/sdks/fleetsv1/README.md +++ b/docs/sdks/fleetsv1/README.md @@ -7,10 +7,10 @@ Operations to manage and view a [fleet](https://hathora.dev/docs/concepts/hathor ### Available Operations -* [getFleets](#getfleets) - Returns an array of [fleets](https://hathora.dev/docs/concepts/hathora-entities#fleet). -* [getFleetRegion](#getfleetregion) - Gets the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. -* [updateFleetRegion](#updatefleetregion) - Updates the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. -* [getFleetMetrics](#getfleetmetrics) - Gets metrics for a [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. +* [getFleets](#getfleets) - GetFleets +* [getFleetRegion](#getfleetregion) - GetFleetRegion +* [updateFleetRegion](#updatefleetregion) - UpdateFleetRegion +* [getFleetMetrics](#getfleetmetrics) - GetFleetMetrics ## getFleets diff --git a/docs/sdks/lobbiesv1/README.md b/docs/sdks/lobbiesv1/README.md index aca1bdf0..c59c3163 100644 --- a/docs/sdks/lobbiesv1/README.md +++ b/docs/sdks/lobbiesv1/README.md @@ -5,12 +5,14 @@ ### Available Operations -* [~~createPrivateLobbyDeprecated~~](#createprivatelobbydeprecated) - :warning: **Deprecated** -* [~~createPublicLobbyDeprecated~~](#createpubliclobbydeprecated) - :warning: **Deprecated** -* [~~listActivePublicLobbiesDeprecatedV1~~](#listactivepubliclobbiesdeprecatedv1) - :warning: **Deprecated** +* [~~createPrivateLobbyDeprecated~~](#createprivatelobbydeprecated) - CreatePrivateLobbyDeprecated :warning: **Deprecated** +* [~~createPublicLobbyDeprecated~~](#createpubliclobbydeprecated) - CreatePublicLobbyDeprecated :warning: **Deprecated** +* [~~listActivePublicLobbiesDeprecatedV1~~](#listactivepubliclobbiesdeprecatedv1) - ListActivePublicLobbiesDeprecatedV1 :warning: **Deprecated** ## ~~createPrivateLobbyDeprecated~~ +CreatePrivateLobbyDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -91,6 +93,8 @@ run(); ## ~~createPublicLobbyDeprecated~~ +CreatePublicLobbyDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -171,6 +175,8 @@ run(); ## ~~listActivePublicLobbiesDeprecatedV1~~ +ListActivePublicLobbiesDeprecatedV1 + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage diff --git a/docs/sdks/lobbiesv2/README.md b/docs/sdks/lobbiesv2/README.md index fa3449c8..5c2aaea3 100644 --- a/docs/sdks/lobbiesv2/README.md +++ b/docs/sdks/lobbiesv2/README.md @@ -5,16 +5,18 @@ ### Available Operations -* [~~createPrivateLobby~~](#createprivatelobby) - :warning: **Deprecated** -* [~~createPublicLobby~~](#createpubliclobby) - :warning: **Deprecated** -* [~~createLocalLobby~~](#createlocallobby) - :warning: **Deprecated** -* [~~createLobbyDeprecated~~](#createlobbydeprecated) - 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. :warning: **Deprecated** -* [~~listActivePublicLobbiesDeprecatedV2~~](#listactivepubliclobbiesdeprecatedv2) - 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. :warning: **Deprecated** -* [~~getLobbyInfo~~](#getlobbyinfo) - Get details for a lobby. :warning: **Deprecated** -* [~~setLobbyState~~](#setlobbystate) - 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). :warning: **Deprecated** +* [~~createPrivateLobby~~](#createprivatelobby) - CreatePrivateLobby :warning: **Deprecated** +* [~~createPublicLobby~~](#createpubliclobby) - CreatePublicLobby :warning: **Deprecated** +* [~~createLocalLobby~~](#createlocallobby) - CreateLocalLobby :warning: **Deprecated** +* [~~createLobbyDeprecated~~](#createlobbydeprecated) - CreateLobbyDeprecated :warning: **Deprecated** +* [~~listActivePublicLobbiesDeprecatedV2~~](#listactivepubliclobbiesdeprecatedv2) - ListActivePublicLobbiesDeprecatedV2 :warning: **Deprecated** +* [~~getLobbyInfo~~](#getlobbyinfo) - GetLobbyInfo :warning: **Deprecated** +* [~~setLobbyState~~](#setlobbystate) - SetLobbyState :warning: **Deprecated** ## ~~createPrivateLobby~~ +CreatePrivateLobby + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -101,6 +103,8 @@ run(); ## ~~createPublicLobby~~ +CreatePublicLobby + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -187,6 +191,8 @@ run(); ## ~~createLocalLobby~~ +CreateLocalLobby + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage diff --git a/docs/sdks/lobbiesv3/README.md b/docs/sdks/lobbiesv3/README.md index a9d6bceb..c7620225 100644 --- a/docs/sdks/lobbiesv3/README.md +++ b/docs/sdks/lobbiesv3/README.md @@ -5,10 +5,10 @@ ### Available Operations -* [createLobby](#createlobby) - 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. -* [listActivePublicLobbies](#listactivepubliclobbies) - 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. -* [getLobbyInfoByRoomId](#getlobbyinfobyroomid) - Get details for a lobby. -* [getLobbyInfoByShortCode](#getlobbyinfobyshortcode) - Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. +* [createLobby](#createlobby) - CreateLobby +* [listActivePublicLobbies](#listactivepubliclobbies) - ListActivePublicLobbies +* [getLobbyInfoByRoomId](#getlobbyinfobyroomid) - GetLobbyInfoByRoomId +* [getLobbyInfoByShortCode](#getlobbyinfobyshortcode) - GetLobbyInfoByShortCode ## createLobby diff --git a/docs/sdks/logsv1/README.md b/docs/sdks/logsv1/README.md index 75b09d1d..3c982c3d 100644 --- a/docs/sdks/logsv1/README.md +++ b/docs/sdks/logsv1/README.md @@ -5,8 +5,8 @@ ### Available Operations -* [getLogsForProcess](#getlogsforprocess) - Returns a stream of logs for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. -* [downloadLogForProcess](#downloadlogforprocess) - Download entire log file for a stopped process. +* [getLogsForProcess](#getlogsforprocess) - GetLogsForProcess +* [downloadLogForProcess](#downloadlogforprocess) - DownloadLogForProcess ## getLogsForProcess diff --git a/docs/sdks/managementv1/README.md b/docs/sdks/managementv1/README.md index 23922917..e99a0a08 100644 --- a/docs/sdks/managementv1/README.md +++ b/docs/sdks/managementv1/README.md @@ -7,10 +7,12 @@ ### Available Operations -* [sendVerificationEmail](#sendverificationemail) +* [sendVerificationEmail](#sendverificationemail) - SendVerificationEmail ## sendVerificationEmail +SendVerificationEmail + ### Example Usage ```typescript diff --git a/docs/sdks/metricsv1/README.md b/docs/sdks/metricsv1/README.md index 89a9d7db..6b97ae5a 100644 --- a/docs/sdks/metricsv1/README.md +++ b/docs/sdks/metricsv1/README.md @@ -7,7 +7,7 @@ Operations to get metrics by [process](https://hathora.dev/docs/concepts/hathora ### Available Operations -* [~~getMetricsDeprecated~~](#getmetricsdeprecated) - Get metrics for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. :warning: **Deprecated** +* [~~getMetricsDeprecated~~](#getmetricsdeprecated) - GetMetricsDeprecated :warning: **Deprecated** ## ~~getMetricsDeprecated~~ diff --git a/docs/sdks/organizationsv1/README.md b/docs/sdks/organizationsv1/README.md index abc2c99d..6732391c 100644 --- a/docs/sdks/organizationsv1/README.md +++ b/docs/sdks/organizationsv1/README.md @@ -5,14 +5,14 @@ ### Available Operations -* [getOrgs](#getorgs) - Returns an unsorted list of all organizations that you are a member of (an accepted membership invite). An organization is uniquely identified by an `orgId`. -* [getUserPendingInvites](#getuserpendinginvites) -* [getOrgMembers](#getorgmembers) -* [inviteUser](#inviteuser) -* [rescindInvite](#rescindinvite) -* [getOrgPendingInvites](#getorgpendinginvites) -* [acceptInvite](#acceptinvite) -* [rejectInvite](#rejectinvite) +* [getOrgs](#getorgs) - GetOrgs +* [getUserPendingInvites](#getuserpendinginvites) - GetUserPendingInvites +* [getOrgMembers](#getorgmembers) - GetOrgMembers +* [inviteUser](#inviteuser) - InviteUser +* [rescindInvite](#rescindinvite) - RescindInvite +* [getOrgPendingInvites](#getorgpendinginvites) - GetOrgPendingInvites +* [acceptInvite](#acceptinvite) - AcceptInvite +* [rejectInvite](#rejectinvite) - RejectInvite ## getOrgs @@ -90,6 +90,8 @@ run(); ## getUserPendingInvites +GetUserPendingInvites + ### Example Usage ```typescript @@ -162,6 +164,8 @@ run(); ## getOrgMembers +GetOrgMembers + ### Example Usage ```typescript @@ -235,6 +239,8 @@ run(); ## inviteUser +InviteUser + ### Example Usage ```typescript @@ -313,6 +319,8 @@ run(); ## rescindInvite +RescindInvite + ### Example Usage ```typescript @@ -389,6 +397,8 @@ run(); ## getOrgPendingInvites +GetOrgPendingInvites + ### Example Usage ```typescript @@ -462,6 +472,8 @@ run(); ## acceptInvite +AcceptInvite + ### Example Usage ```typescript @@ -533,6 +545,8 @@ run(); ## rejectInvite +RejectInvite + ### Example Usage ```typescript diff --git a/docs/sdks/processesv1/README.md b/docs/sdks/processesv1/README.md index 42da767f..2ac50bff 100644 --- a/docs/sdks/processesv1/README.md +++ b/docs/sdks/processesv1/README.md @@ -7,9 +7,9 @@ Deprecated. Use [ProcessesV3](https://hathora.dev/api#tag/ProcessesV3). ### Available Operations -* [~~getRunningProcesses~~](#getrunningprocesses) - Retrieve 10 most recently started [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. :warning: **Deprecated** -* [~~getStoppedProcesses~~](#getstoppedprocesses) - Retrieve 10 most recently stopped [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. :warning: **Deprecated** -* [~~getProcessInfoDeprecated~~](#getprocessinfodeprecated) - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). :warning: **Deprecated** +* [~~getRunningProcesses~~](#getrunningprocesses) - GetRunningProcesses :warning: **Deprecated** +* [~~getStoppedProcesses~~](#getstoppedprocesses) - GetStoppedProcesses :warning: **Deprecated** +* [~~getProcessInfoDeprecated~~](#getprocessinfodeprecated) - GetProcessInfoDeprecated :warning: **Deprecated** ## ~~getRunningProcesses~~ diff --git a/docs/sdks/processesv2/README.md b/docs/sdks/processesv2/README.md index 9ac1542f..bef3cbde 100644 --- a/docs/sdks/processesv2/README.md +++ b/docs/sdks/processesv2/README.md @@ -7,11 +7,11 @@ Deprecated. Use [ProcessesV3](https://hathora.dev/api#tag/ProcessesV3). ### Available Operations -* [~~getProcessInfoV2Deprecated~~](#getprocessinfov2deprecated) - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). :warning: **Deprecated** -* [~~getLatestProcessesV2Deprecated~~](#getlatestprocessesv2deprecated) - Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. :warning: **Deprecated** -* [~~getProcessesCountExperimentalV2Deprecated~~](#getprocessescountexperimentalv2deprecated) - Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. :warning: **Deprecated** -* [~~stopProcessV2Deprecated~~](#stopprocessv2deprecated) - Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. :warning: **Deprecated** -* [~~createProcessV2Deprecated~~](#createprocessv2deprecated) - Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. :warning: **Deprecated** +* [~~getProcessInfoV2Deprecated~~](#getprocessinfov2deprecated) - GetProcessInfoV2Deprecated :warning: **Deprecated** +* [~~getLatestProcessesV2Deprecated~~](#getlatestprocessesv2deprecated) - GetLatestProcessesV2Deprecated :warning: **Deprecated** +* [~~getProcessesCountExperimentalV2Deprecated~~](#getprocessescountexperimentalv2deprecated) - GetProcessesCountExperimentalV2Deprecated :warning: **Deprecated** +* [~~stopProcessV2Deprecated~~](#stopprocessv2deprecated) - StopProcessV2Deprecated :warning: **Deprecated** +* [~~createProcessV2Deprecated~~](#createprocessv2deprecated) - CreateProcessV2Deprecated :warning: **Deprecated** ## ~~getProcessInfoV2Deprecated~~ diff --git a/docs/sdks/processesv3/README.md b/docs/sdks/processesv3/README.md index 61146ef7..1b51f405 100644 --- a/docs/sdks/processesv3/README.md +++ b/docs/sdks/processesv3/README.md @@ -7,12 +7,12 @@ Operations to get data on active and stopped [processes](https://hathora.dev/doc ### Available Operations -* [getLatestProcesses](#getlatestprocesses) - Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. -* [getProcessesCountExperimental](#getprocessescountexperimental) - Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. -* [createProcess](#createprocess) - Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. -* [getProcess](#getprocess) - Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). -* [stopProcess](#stopprocess) - Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. -* [getProcessMetrics](#getprocessmetrics) +* [getLatestProcesses](#getlatestprocesses) - GetLatestProcesses +* [getProcessesCountExperimental](#getprocessescountexperimental) - GetProcessesCountExperimental +* [createProcess](#createprocess) - CreateProcess +* [getProcess](#getprocess) - GetProcess +* [stopProcess](#stopprocess) - StopProcess +* [getProcessMetrics](#getprocessmetrics) - GetProcessMetrics ## getLatestProcesses @@ -396,6 +396,8 @@ run(); ## getProcessMetrics +GetProcessMetrics + ### Example Usage ```typescript diff --git a/docs/sdks/roomsv1/README.md b/docs/sdks/roomsv1/README.md index f7eb1195..4e35a09c 100644 --- a/docs/sdks/roomsv1/README.md +++ b/docs/sdks/roomsv1/README.md @@ -5,16 +5,18 @@ ### Available Operations -* [~~createRoomDeprecated~~](#createroomdeprecated) - :warning: **Deprecated** -* [~~getRoomInfoDeprecated~~](#getroominfodeprecated) - :warning: **Deprecated** -* [~~getActiveRoomsForProcessDeprecated~~](#getactiveroomsforprocessdeprecated) - :warning: **Deprecated** -* [~~getInactiveRoomsForProcessDeprecated~~](#getinactiveroomsforprocessdeprecated) - :warning: **Deprecated** -* [~~destroyRoomDeprecated~~](#destroyroomdeprecated) - :warning: **Deprecated** -* [~~suspendRoomDeprecated~~](#suspendroomdeprecated) - :warning: **Deprecated** -* [~~getConnectionInfoDeprecated~~](#getconnectioninfodeprecated) - :warning: **Deprecated** +* [~~createRoomDeprecated~~](#createroomdeprecated) - CreateRoomDeprecated :warning: **Deprecated** +* [~~getRoomInfoDeprecated~~](#getroominfodeprecated) - GetRoomInfoDeprecated :warning: **Deprecated** +* [~~getActiveRoomsForProcessDeprecated~~](#getactiveroomsforprocessdeprecated) - GetActiveRoomsForProcessDeprecated :warning: **Deprecated** +* [~~getInactiveRoomsForProcessDeprecated~~](#getinactiveroomsforprocessdeprecated) - GetInactiveRoomsForProcessDeprecated :warning: **Deprecated** +* [~~destroyRoomDeprecated~~](#destroyroomdeprecated) - DestroyRoomDeprecated :warning: **Deprecated** +* [~~suspendRoomDeprecated~~](#suspendroomdeprecated) - SuspendRoomDeprecated :warning: **Deprecated** +* [~~getConnectionInfoDeprecated~~](#getconnectioninfodeprecated) - GetConnectionInfoDeprecated :warning: **Deprecated** ## ~~createRoomDeprecated~~ +CreateRoomDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -106,6 +108,8 @@ run(); ## ~~getRoomInfoDeprecated~~ +GetRoomInfoDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -182,6 +186,8 @@ run(); ## ~~getActiveRoomsForProcessDeprecated~~ +GetActiveRoomsForProcessDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -258,6 +264,8 @@ run(); ## ~~getInactiveRoomsForProcessDeprecated~~ +GetInactiveRoomsForProcessDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -334,6 +342,8 @@ run(); ## ~~destroyRoomDeprecated~~ +DestroyRoomDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -408,6 +418,8 @@ run(); ## ~~suspendRoomDeprecated~~ +SuspendRoomDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage @@ -482,6 +494,8 @@ run(); ## ~~getConnectionInfoDeprecated~~ +GetConnectionInfoDeprecated + > :warning: **DEPRECATED**: This will be removed in a future release, please migrate away from it as soon as possible. ### Example Usage diff --git a/docs/sdks/roomsv2/README.md b/docs/sdks/roomsv2/README.md index f8957089..10f2e541 100644 --- a/docs/sdks/roomsv2/README.md +++ b/docs/sdks/roomsv2/README.md @@ -5,14 +5,14 @@ ### Available Operations -* [createRoom](#createroom) - Create a new [room](https://hathora.dev/docs/concepts/hathora-entities#room) for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application). Poll the [`GetConnectionInfo()`](https://hathora.dev/api#tag/RoomV2/operation/GetConnectionInfo) endpoint to get connection details for an active room. -* [getRoomInfo](#getroominfo) - Retreive current and historical allocation data for a [room](https://hathora.dev/docs/concepts/hathora-entities#room). -* [getActiveRoomsForProcess](#getactiveroomsforprocess) - Get all active [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). -* [getInactiveRoomsForProcess](#getinactiveroomsforprocess) - Get all inactive [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). -* [destroyRoom](#destroyroom) - Destroy a [room](https://hathora.dev/docs/concepts/hathora-entities#room). All associated metadata is deleted. -* [~~suspendRoomV2Deprecated~~](#suspendroomv2deprecated) - Suspend a [room](https://hathora.dev/docs/concepts/hathora-entities#room). The room is unallocated from the process but can be rescheduled later using the same `roomId`. :warning: **Deprecated** -* [getConnectionInfo](#getconnectioninfo) - Poll this endpoint to get connection details to a [room](https://hathora.dev/docs/concepts/hathora-entities#room). Clients can call this endpoint without authentication. -* [updateRoomConfig](#updateroomconfig) +* [createRoom](#createroom) - CreateRoom +* [getRoomInfo](#getroominfo) - GetRoomInfo +* [getActiveRoomsForProcess](#getactiveroomsforprocess) - GetActiveRoomsForProcess +* [getInactiveRoomsForProcess](#getinactiveroomsforprocess) - GetInactiveRoomsForProcess +* [destroyRoom](#destroyroom) - DestroyRoom +* [~~suspendRoomV2Deprecated~~](#suspendroomv2deprecated) - SuspendRoomV2Deprecated :warning: **Deprecated** +* [getConnectionInfo](#getconnectioninfo) - GetConnectionInfo +* [updateRoomConfig](#updateroomconfig) - UpdateRoomConfig ## createRoom @@ -559,6 +559,8 @@ run(); ## updateRoomConfig +UpdateRoomConfig + ### Example Usage ```typescript diff --git a/docs/sdks/tokensv1/README.md b/docs/sdks/tokensv1/README.md index af849467..6607671e 100644 --- a/docs/sdks/tokensv1/README.md +++ b/docs/sdks/tokensv1/README.md @@ -7,9 +7,9 @@ ### Available Operations -* [getOrgTokens](#getorgtokens) - List all organization tokens for a given org. -* [createOrgToken](#createorgtoken) - Create a new organization token. -* [revokeOrgToken](#revokeorgtoken) - Revoke an organization token. +* [getOrgTokens](#getorgtokens) - GetOrgTokens +* [createOrgToken](#createorgtoken) - CreateOrgToken +* [revokeOrgToken](#revokeorgtoken) - RevokeOrgToken ## getOrgTokens diff --git a/gen.yaml b/gen.yaml index f73166da..c69d990d 100644 --- a/gen.yaml +++ b/gen.yaml @@ -18,7 +18,7 @@ management: generationVersion: 2.188.3 speakeasyVersion: 1.120.0 typescript: - version: 2.10.9 + version: 2.10.10 additionalDependencies: dependencies: {} devDependencies: {} diff --git a/jsr.json b/jsr.json index fdf6ae27..815cec94 100644 --- a/jsr.json +++ b/jsr.json @@ -2,7 +2,7 @@ { "name": "@hathora/cloud-sdk-typescript", - "version": "2.10.9", + "version": "2.10.10", "exports": { ".": "./src/index.ts", "./models/errors": "./src/models/errors/index.ts", diff --git a/package-lock.json b/package-lock.json index b0af2dd0..42a6da2f 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@hathora/cloud-sdk-typescript", - "version": "2.10.9", + "version": "2.10.10", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@hathora/cloud-sdk-typescript", - "version": "2.10.9", + "version": "2.10.10", "devDependencies": { "@typescript-eslint/eslint-plugin": "^7.7.1", "@typescript-eslint/parser": "^7.7.1", diff --git a/package.json b/package.json index 45b85ec3..cdf1e531 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@hathora/cloud-sdk-typescript", - "version": "2.10.9", + "version": "2.10.10", "author": "Hathora", "main": "./index.js", "sideEffects": false, diff --git a/src/funcs/appsV1CreateAppV1Deprecated.ts b/src/funcs/appsV1CreateAppV1Deprecated.ts index 03373b38..8591433c 100644 --- a/src/funcs/appsV1CreateAppV1Deprecated.ts +++ b/src/funcs/appsV1CreateAppV1Deprecated.ts @@ -23,6 +23,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; /** + * CreateAppV1Deprecated + * + * @remarks * Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/appsV1DeleteAppV1Deprecated.ts b/src/funcs/appsV1DeleteAppV1Deprecated.ts index e9e724a1..15637fef 100644 --- a/src/funcs/appsV1DeleteAppV1Deprecated.ts +++ b/src/funcs/appsV1DeleteAppV1Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * DeleteAppV1Deprecated + * + * @remarks * Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/appsV1GetAppInfoV1Deprecated.ts b/src/funcs/appsV1GetAppInfoV1Deprecated.ts index 87f01812..c8129d70 100644 --- a/src/funcs/appsV1GetAppInfoV1Deprecated.ts +++ b/src/funcs/appsV1GetAppInfoV1Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetAppInfoV1Deprecated + * + * @remarks * Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/appsV1GetAppsV1Deprecated.ts b/src/funcs/appsV1GetAppsV1Deprecated.ts index c0e1bc36..f5be3585 100644 --- a/src/funcs/appsV1GetAppsV1Deprecated.ts +++ b/src/funcs/appsV1GetAppsV1Deprecated.ts @@ -22,6 +22,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; /** + * GetAppsV1Deprecated + * + * @remarks * Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/appsV1UpdateAppV1Deprecated.ts b/src/funcs/appsV1UpdateAppV1Deprecated.ts index 36cf1ae9..3411b307 100644 --- a/src/funcs/appsV1UpdateAppV1Deprecated.ts +++ b/src/funcs/appsV1UpdateAppV1Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * UpdateAppV1Deprecated + * + * @remarks * Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/appsV2CreateApp.ts b/src/funcs/appsV2CreateApp.ts index 48cf1cc4..8da4163e 100644 --- a/src/funcs/appsV2CreateApp.ts +++ b/src/funcs/appsV2CreateApp.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateApp + * + * @remarks * Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). */ export async function appsV2CreateApp( diff --git a/src/funcs/appsV2DeleteApp.ts b/src/funcs/appsV2DeleteApp.ts index cb260ca1..05847655 100644 --- a/src/funcs/appsV2DeleteApp.ts +++ b/src/funcs/appsV2DeleteApp.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * DeleteApp + * + * @remarks * Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. */ export async function appsV2DeleteApp( diff --git a/src/funcs/appsV2GetApp.ts b/src/funcs/appsV2GetApp.ts index 74e04abe..e284bfe4 100644 --- a/src/funcs/appsV2GetApp.ts +++ b/src/funcs/appsV2GetApp.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetApp + * + * @remarks * Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. */ export async function appsV2GetApp( diff --git a/src/funcs/appsV2GetApps.ts b/src/funcs/appsV2GetApps.ts index c8ae40f4..9068a190 100644 --- a/src/funcs/appsV2GetApps.ts +++ b/src/funcs/appsV2GetApps.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetApps + * + * @remarks * Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. */ export async function appsV2GetApps( diff --git a/src/funcs/appsV2UpdateApp.ts b/src/funcs/appsV2UpdateApp.ts index 0f8893eb..41cefc4c 100644 --- a/src/funcs/appsV2UpdateApp.ts +++ b/src/funcs/appsV2UpdateApp.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * UpdateApp + * + * @remarks * Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. */ export async function appsV2UpdateApp( diff --git a/src/funcs/authV1LoginAnonymous.ts b/src/funcs/authV1LoginAnonymous.ts index 665f6721..e2acbf67 100644 --- a/src/funcs/authV1LoginAnonymous.ts +++ b/src/funcs/authV1LoginAnonymous.ts @@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * LoginAnonymous + * + * @remarks * Returns a unique player token for an anonymous user. */ export async function authV1LoginAnonymous( diff --git a/src/funcs/authV1LoginGoogle.ts b/src/funcs/authV1LoginGoogle.ts index 2320c11c..827024b2 100644 --- a/src/funcs/authV1LoginGoogle.ts +++ b/src/funcs/authV1LoginGoogle.ts @@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * LoginGoogle + * + * @remarks * Returns a unique player token using a Google-signed OIDC `idToken`. */ export async function authV1LoginGoogle( diff --git a/src/funcs/authV1LoginNickname.ts b/src/funcs/authV1LoginNickname.ts index bb0b71cc..7278a1a0 100644 --- a/src/funcs/authV1LoginNickname.ts +++ b/src/funcs/authV1LoginNickname.ts @@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * LoginNickname + * + * @remarks * Returns a unique player token with a specified nickname for a user. */ export async function authV1LoginNickname( diff --git a/src/funcs/billingV1GetBalance.ts b/src/funcs/billingV1GetBalance.ts index c376b825..98c5a941 100644 --- a/src/funcs/billingV1GetBalance.ts +++ b/src/funcs/billingV1GetBalance.ts @@ -20,6 +20,9 @@ import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; +/** + * GetBalance + */ export async function billingV1GetBalance( client: HathoraCloudCore, options?: RequestOptions, diff --git a/src/funcs/billingV1GetInvoices.ts b/src/funcs/billingV1GetInvoices.ts index 87506b02..1b07fac4 100644 --- a/src/funcs/billingV1GetInvoices.ts +++ b/src/funcs/billingV1GetInvoices.ts @@ -21,6 +21,9 @@ import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; +/** + * GetInvoices + */ export async function billingV1GetInvoices( client: HathoraCloudCore, options?: RequestOptions, diff --git a/src/funcs/billingV1GetPaymentMethod.ts b/src/funcs/billingV1GetPaymentMethod.ts index fc1053bd..620e6991 100644 --- a/src/funcs/billingV1GetPaymentMethod.ts +++ b/src/funcs/billingV1GetPaymentMethod.ts @@ -20,6 +20,9 @@ import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; +/** + * GetPaymentMethod + */ export async function billingV1GetPaymentMethod( client: HathoraCloudCore, options?: RequestOptions, diff --git a/src/funcs/billingV1GetUpcomingInvoiceItems.ts b/src/funcs/billingV1GetUpcomingInvoiceItems.ts index d3b1d3f2..96dce621 100644 --- a/src/funcs/billingV1GetUpcomingInvoiceItems.ts +++ b/src/funcs/billingV1GetUpcomingInvoiceItems.ts @@ -20,6 +20,9 @@ import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; +/** + * GetUpcomingInvoiceItems + */ export async function billingV1GetUpcomingInvoiceItems( client: HathoraCloudCore, options?: RequestOptions, diff --git a/src/funcs/billingV1GetUpcomingInvoiceTotal.ts b/src/funcs/billingV1GetUpcomingInvoiceTotal.ts index c744afc6..d67dc031 100644 --- a/src/funcs/billingV1GetUpcomingInvoiceTotal.ts +++ b/src/funcs/billingV1GetUpcomingInvoiceTotal.ts @@ -20,6 +20,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * GetUpcomingInvoiceTotal + */ export async function billingV1GetUpcomingInvoiceTotal( client: HathoraCloudCore, options?: RequestOptions, diff --git a/src/funcs/billingV1InitStripeCustomerPortalUrl.ts b/src/funcs/billingV1InitStripeCustomerPortalUrl.ts index 2c3df629..cedf7863 100644 --- a/src/funcs/billingV1InitStripeCustomerPortalUrl.ts +++ b/src/funcs/billingV1InitStripeCustomerPortalUrl.ts @@ -23,6 +23,9 @@ import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; +/** + * InitStripeCustomerPortalUrl + */ export async function billingV1InitStripeCustomerPortalUrl( client: HathoraCloudCore, request: components.CustomerPortalUrl, diff --git a/src/funcs/buildsV1CreateBuildDeprecated.ts b/src/funcs/buildsV1CreateBuildDeprecated.ts index 784a0293..e14f9d76 100644 --- a/src/funcs/buildsV1CreateBuildDeprecated.ts +++ b/src/funcs/buildsV1CreateBuildDeprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateBuildDeprecated + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV1DeleteBuildDeprecated.ts b/src/funcs/buildsV1DeleteBuildDeprecated.ts index 24675f85..b8c2e2a1 100644 --- a/src/funcs/buildsV1DeleteBuildDeprecated.ts +++ b/src/funcs/buildsV1DeleteBuildDeprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * DeleteBuildDeprecated + * + * @remarks * Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV1GetBuildInfoDeprecated.ts b/src/funcs/buildsV1GetBuildInfoDeprecated.ts index 39c5b7a0..3645d9f9 100644 --- a/src/funcs/buildsV1GetBuildInfoDeprecated.ts +++ b/src/funcs/buildsV1GetBuildInfoDeprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetBuildInfoDeprecated + * + * @remarks * Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV1GetBuildsDeprecated.ts b/src/funcs/buildsV1GetBuildsDeprecated.ts index f70e9cd3..ac0266ad 100644 --- a/src/funcs/buildsV1GetBuildsDeprecated.ts +++ b/src/funcs/buildsV1GetBuildsDeprecated.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetBuildsDeprecated + * + * @remarks * Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV1RunBuildDeprecated.ts b/src/funcs/buildsV1RunBuildDeprecated.ts index 5aafedcd..b5edbdd6 100644 --- a/src/funcs/buildsV1RunBuildDeprecated.ts +++ b/src/funcs/buildsV1RunBuildDeprecated.ts @@ -27,6 +27,9 @@ import { Result } from "../types/fp.js"; import { isReadableStream } from "../types/streams.js"; /** + * RunBuildDeprecated + * + * @remarks * Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV2CreateBuildV2Deprecated.ts b/src/funcs/buildsV2CreateBuildV2Deprecated.ts index 6f0d021a..a2d8bd64 100644 --- a/src/funcs/buildsV2CreateBuildV2Deprecated.ts +++ b/src/funcs/buildsV2CreateBuildV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateBuildV2Deprecated + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV2CreateBuildWithUploadUrlV2Deprecated.ts b/src/funcs/buildsV2CreateBuildWithUploadUrlV2Deprecated.ts index 4c1b5527..c492cfce 100644 --- a/src/funcs/buildsV2CreateBuildWithUploadUrlV2Deprecated.ts +++ b/src/funcs/buildsV2CreateBuildWithUploadUrlV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateBuildWithUploadUrlV2Deprecated + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with `uploadUrl` that can be used to upload the build to before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV2CreateWithMultipartUploadsV2Deprecated.ts b/src/funcs/buildsV2CreateWithMultipartUploadsV2Deprecated.ts index 2abd18be..9390b6e9 100644 --- a/src/funcs/buildsV2CreateWithMultipartUploadsV2Deprecated.ts +++ b/src/funcs/buildsV2CreateWithMultipartUploadsV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateWithMultipartUploadsV2Deprecated + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV2DeleteBuildV2Deprecated.ts b/src/funcs/buildsV2DeleteBuildV2Deprecated.ts index 99153eef..c276baf2 100644 --- a/src/funcs/buildsV2DeleteBuildV2Deprecated.ts +++ b/src/funcs/buildsV2DeleteBuildV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * DeleteBuildV2Deprecated + * + * @remarks * Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV2GetBuildInfoV2Deprecated.ts b/src/funcs/buildsV2GetBuildInfoV2Deprecated.ts index c7298b52..4fa1f002 100644 --- a/src/funcs/buildsV2GetBuildInfoV2Deprecated.ts +++ b/src/funcs/buildsV2GetBuildInfoV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetBuildInfoV2Deprecated + * + * @remarks * Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV2GetBuildsV2Deprecated.ts b/src/funcs/buildsV2GetBuildsV2Deprecated.ts index d7b5519a..26e6acdc 100644 --- a/src/funcs/buildsV2GetBuildsV2Deprecated.ts +++ b/src/funcs/buildsV2GetBuildsV2Deprecated.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetBuildsV2Deprecated + * + * @remarks * Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV2RunBuildV2Deprecated.ts b/src/funcs/buildsV2RunBuildV2Deprecated.ts index 6d42fb0c..1fcb2965 100644 --- a/src/funcs/buildsV2RunBuildV2Deprecated.ts +++ b/src/funcs/buildsV2RunBuildV2Deprecated.ts @@ -27,6 +27,9 @@ import { Result } from "../types/fp.js"; import { isReadableStream } from "../types/streams.js"; /** + * RunBuildV2Deprecated + * + * @remarks * Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/buildsV3CreateBuild.ts b/src/funcs/buildsV3CreateBuild.ts index be71cb70..42a472e5 100644 --- a/src/funcs/buildsV3CreateBuild.ts +++ b/src/funcs/buildsV3CreateBuild.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateBuild + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. */ export async function buildsV3CreateBuild( diff --git a/src/funcs/buildsV3DeleteBuild.ts b/src/funcs/buildsV3DeleteBuild.ts index 38232a49..03c80f38 100644 --- a/src/funcs/buildsV3DeleteBuild.ts +++ b/src/funcs/buildsV3DeleteBuild.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * DeleteBuild + * + * @remarks * Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. * Be careful which builds you delete. This endpoint does not prevent you from deleting actively used builds. * Deleting a build that is actively build used by an app's deployment will cause failures when creating rooms. diff --git a/src/funcs/buildsV3GetBuild.ts b/src/funcs/buildsV3GetBuild.ts index 981a3bcf..9c26a6dc 100644 --- a/src/funcs/buildsV3GetBuild.ts +++ b/src/funcs/buildsV3GetBuild.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetBuild + * + * @remarks * Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). */ export async function buildsV3GetBuild( diff --git a/src/funcs/buildsV3GetBuilds.ts b/src/funcs/buildsV3GetBuilds.ts index 852548a8..48dcc004 100644 --- a/src/funcs/buildsV3GetBuilds.ts +++ b/src/funcs/buildsV3GetBuilds.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetBuilds + * + * @remarks * Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). */ export async function buildsV3GetBuilds( diff --git a/src/funcs/buildsV3RunBuild.ts b/src/funcs/buildsV3RunBuild.ts index ebeb900d..24e7ed1c 100644 --- a/src/funcs/buildsV3RunBuild.ts +++ b/src/funcs/buildsV3RunBuild.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * RunBuild + * + * @remarks * Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). */ export async function buildsV3RunBuild( diff --git a/src/funcs/deploymentsV1CreateDeploymentV1Deprecated.ts b/src/funcs/deploymentsV1CreateDeploymentV1Deprecated.ts index 0b6755ae..f34428ce 100644 --- a/src/funcs/deploymentsV1CreateDeploymentV1Deprecated.ts +++ b/src/funcs/deploymentsV1CreateDeploymentV1Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateDeploymentV1Deprecated + * + * @remarks * Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/deploymentsV1GetDeploymentInfoV1Deprecated.ts b/src/funcs/deploymentsV1GetDeploymentInfoV1Deprecated.ts index 8ce24bfc..df503f56 100644 --- a/src/funcs/deploymentsV1GetDeploymentInfoV1Deprecated.ts +++ b/src/funcs/deploymentsV1GetDeploymentInfoV1Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetDeploymentInfoV1Deprecated + * + * @remarks * Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/deploymentsV1GetDeploymentsV1Deprecated.ts b/src/funcs/deploymentsV1GetDeploymentsV1Deprecated.ts index 7969871c..ba585b84 100644 --- a/src/funcs/deploymentsV1GetDeploymentsV1Deprecated.ts +++ b/src/funcs/deploymentsV1GetDeploymentsV1Deprecated.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetDeploymentsV1Deprecated + * + * @remarks * Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/deploymentsV1GetLatestDeploymentV1Deprecated.ts b/src/funcs/deploymentsV1GetLatestDeploymentV1Deprecated.ts index c974f9bd..22a8e02b 100644 --- a/src/funcs/deploymentsV1GetLatestDeploymentV1Deprecated.ts +++ b/src/funcs/deploymentsV1GetLatestDeploymentV1Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLatestDeploymentV1Deprecated + * + * @remarks * Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/deploymentsV2CreateDeploymentV2Deprecated.ts b/src/funcs/deploymentsV2CreateDeploymentV2Deprecated.ts index 57409f1e..b8c64b80 100644 --- a/src/funcs/deploymentsV2CreateDeploymentV2Deprecated.ts +++ b/src/funcs/deploymentsV2CreateDeploymentV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateDeploymentV2Deprecated + * + * @remarks * Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/deploymentsV2GetDeploymentInfoV2Deprecated.ts b/src/funcs/deploymentsV2GetDeploymentInfoV2Deprecated.ts index 2abab3ce..ee8f0b1e 100644 --- a/src/funcs/deploymentsV2GetDeploymentInfoV2Deprecated.ts +++ b/src/funcs/deploymentsV2GetDeploymentInfoV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetDeploymentInfoV2Deprecated + * + * @remarks * Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/deploymentsV2GetDeploymentsV2Deprecated.ts b/src/funcs/deploymentsV2GetDeploymentsV2Deprecated.ts index 546cdea7..54d64152 100644 --- a/src/funcs/deploymentsV2GetDeploymentsV2Deprecated.ts +++ b/src/funcs/deploymentsV2GetDeploymentsV2Deprecated.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetDeploymentsV2Deprecated + * + * @remarks * Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/deploymentsV2GetLatestDeploymentV2Deprecated.ts b/src/funcs/deploymentsV2GetLatestDeploymentV2Deprecated.ts index 0a0e6a32..50bb1bda 100644 --- a/src/funcs/deploymentsV2GetLatestDeploymentV2Deprecated.ts +++ b/src/funcs/deploymentsV2GetLatestDeploymentV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLatestDeploymentV2Deprecated + * + * @remarks * Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/deploymentsV3CreateDeployment.ts b/src/funcs/deploymentsV3CreateDeployment.ts index d580a9ec..766aa111 100644 --- a/src/funcs/deploymentsV3CreateDeployment.ts +++ b/src/funcs/deploymentsV3CreateDeployment.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateDeployment + * + * @remarks * Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. */ export async function deploymentsV3CreateDeployment( diff --git a/src/funcs/deploymentsV3GetDeployment.ts b/src/funcs/deploymentsV3GetDeployment.ts index bf94b30d..929b90b8 100644 --- a/src/funcs/deploymentsV3GetDeployment.ts +++ b/src/funcs/deploymentsV3GetDeployment.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetDeployment + * + * @remarks * Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). */ export async function deploymentsV3GetDeployment( diff --git a/src/funcs/deploymentsV3GetDeployments.ts b/src/funcs/deploymentsV3GetDeployments.ts index 4aa5d010..0f8121c4 100644 --- a/src/funcs/deploymentsV3GetDeployments.ts +++ b/src/funcs/deploymentsV3GetDeployments.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetDeployments + * + * @remarks * Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application), optionally filtered by deploymentTag. */ export async function deploymentsV3GetDeployments( diff --git a/src/funcs/deploymentsV3GetLatestDeployment.ts b/src/funcs/deploymentsV3GetLatestDeployment.ts index 8f8daef1..658beaa4 100644 --- a/src/funcs/deploymentsV3GetLatestDeployment.ts +++ b/src/funcs/deploymentsV3GetLatestDeployment.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLatestDeployment + * + * @remarks * Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). */ export async function deploymentsV3GetLatestDeployment( diff --git a/src/funcs/discoveryV1GetPingServiceEndpointsDeprecated.ts b/src/funcs/discoveryV1GetPingServiceEndpointsDeprecated.ts index a8da7594..d22486dd 100644 --- a/src/funcs/discoveryV1GetPingServiceEndpointsDeprecated.ts +++ b/src/funcs/discoveryV1GetPingServiceEndpointsDeprecated.ts @@ -20,6 +20,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; /** + * GetPingServiceEndpointsDeprecated + * + * @remarks * Returns an array of V1 regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/discoveryV2GetPingServiceEndpoints.ts b/src/funcs/discoveryV2GetPingServiceEndpoints.ts index c7f84d39..8052e800 100644 --- a/src/funcs/discoveryV2GetPingServiceEndpoints.ts +++ b/src/funcs/discoveryV2GetPingServiceEndpoints.ts @@ -20,6 +20,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; /** + * GetPingServiceEndpoints + * + * @remarks * Returns an array of all regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. */ export async function discoveryV2GetPingServiceEndpoints( diff --git a/src/funcs/fleetsV1GetFleetMetrics.ts b/src/funcs/fleetsV1GetFleetMetrics.ts index 573c28a5..027ac4af 100644 --- a/src/funcs/fleetsV1GetFleetMetrics.ts +++ b/src/funcs/fleetsV1GetFleetMetrics.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetFleetMetrics + * + * @remarks * Gets metrics for a [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. */ export async function fleetsV1GetFleetMetrics( diff --git a/src/funcs/fleetsV1GetFleetRegion.ts b/src/funcs/fleetsV1GetFleetRegion.ts index e7d50412..c9e15e88 100644 --- a/src/funcs/fleetsV1GetFleetRegion.ts +++ b/src/funcs/fleetsV1GetFleetRegion.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetFleetRegion + * + * @remarks * Gets the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. */ export async function fleetsV1GetFleetRegion( diff --git a/src/funcs/fleetsV1GetFleets.ts b/src/funcs/fleetsV1GetFleets.ts index 9114a879..d7c116c8 100644 --- a/src/funcs/fleetsV1GetFleets.ts +++ b/src/funcs/fleetsV1GetFleets.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetFleets + * + * @remarks * Returns an array of [fleets](https://hathora.dev/docs/concepts/hathora-entities#fleet). */ export async function fleetsV1GetFleets( diff --git a/src/funcs/fleetsV1UpdateFleetRegion.ts b/src/funcs/fleetsV1UpdateFleetRegion.ts index 60397e33..14676133 100644 --- a/src/funcs/fleetsV1UpdateFleetRegion.ts +++ b/src/funcs/fleetsV1UpdateFleetRegion.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * UpdateFleetRegion + * + * @remarks * Updates the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. */ export async function fleetsV1UpdateFleetRegion( diff --git a/src/funcs/lobbiesV1CreatePrivateLobbyDeprecated.ts b/src/funcs/lobbiesV1CreatePrivateLobbyDeprecated.ts index e4d86a28..7c3d53b1 100644 --- a/src/funcs/lobbiesV1CreatePrivateLobbyDeprecated.ts +++ b/src/funcs/lobbiesV1CreatePrivateLobbyDeprecated.ts @@ -25,6 +25,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreatePrivateLobbyDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function lobbiesV1CreatePrivateLobbyDeprecated( diff --git a/src/funcs/lobbiesV1CreatePublicLobbyDeprecated.ts b/src/funcs/lobbiesV1CreatePublicLobbyDeprecated.ts index ea77a4da..1720505c 100644 --- a/src/funcs/lobbiesV1CreatePublicLobbyDeprecated.ts +++ b/src/funcs/lobbiesV1CreatePublicLobbyDeprecated.ts @@ -25,6 +25,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreatePublicLobbyDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function lobbiesV1CreatePublicLobbyDeprecated( diff --git a/src/funcs/lobbiesV1ListActivePublicLobbiesDeprecatedV1.ts b/src/funcs/lobbiesV1ListActivePublicLobbiesDeprecatedV1.ts index 744f7801..a1e779fc 100644 --- a/src/funcs/lobbiesV1ListActivePublicLobbiesDeprecatedV1.ts +++ b/src/funcs/lobbiesV1ListActivePublicLobbiesDeprecatedV1.ts @@ -24,6 +24,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * ListActivePublicLobbiesDeprecatedV1 + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function lobbiesV1ListActivePublicLobbiesDeprecatedV1( diff --git a/src/funcs/lobbiesV2CreateLobbyDeprecated.ts b/src/funcs/lobbiesV2CreateLobbyDeprecated.ts index e988f028..fcd7b4a3 100644 --- a/src/funcs/lobbiesV2CreateLobbyDeprecated.ts +++ b/src/funcs/lobbiesV2CreateLobbyDeprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateLobbyDeprecated + * + * @remarks * 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. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/lobbiesV2CreateLocalLobby.ts b/src/funcs/lobbiesV2CreateLocalLobby.ts index ba32b83c..8794d13e 100644 --- a/src/funcs/lobbiesV2CreateLocalLobby.ts +++ b/src/funcs/lobbiesV2CreateLocalLobby.ts @@ -24,6 +24,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateLocalLobby + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function lobbiesV2CreateLocalLobby( diff --git a/src/funcs/lobbiesV2CreatePrivateLobby.ts b/src/funcs/lobbiesV2CreatePrivateLobby.ts index d2f47ee0..b2affaff 100644 --- a/src/funcs/lobbiesV2CreatePrivateLobby.ts +++ b/src/funcs/lobbiesV2CreatePrivateLobby.ts @@ -24,6 +24,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreatePrivateLobby + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function lobbiesV2CreatePrivateLobby( diff --git a/src/funcs/lobbiesV2CreatePublicLobby.ts b/src/funcs/lobbiesV2CreatePublicLobby.ts index eb4eeb7d..3b1dd591 100644 --- a/src/funcs/lobbiesV2CreatePublicLobby.ts +++ b/src/funcs/lobbiesV2CreatePublicLobby.ts @@ -24,6 +24,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreatePublicLobby + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function lobbiesV2CreatePublicLobby( diff --git a/src/funcs/lobbiesV2GetLobbyInfo.ts b/src/funcs/lobbiesV2GetLobbyInfo.ts index 821dd302..90ad34c3 100644 --- a/src/funcs/lobbiesV2GetLobbyInfo.ts +++ b/src/funcs/lobbiesV2GetLobbyInfo.ts @@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLobbyInfo + * + * @remarks * Get details for a lobby. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/lobbiesV2ListActivePublicLobbiesDeprecatedV2.ts b/src/funcs/lobbiesV2ListActivePublicLobbiesDeprecatedV2.ts index 38c6fcba..8c0f2dcb 100644 --- a/src/funcs/lobbiesV2ListActivePublicLobbiesDeprecatedV2.ts +++ b/src/funcs/lobbiesV2ListActivePublicLobbiesDeprecatedV2.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * ListActivePublicLobbiesDeprecatedV2 + * + * @remarks * 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. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/lobbiesV2SetLobbyState.ts b/src/funcs/lobbiesV2SetLobbyState.ts index 7dd6c211..dd0b521f 100644 --- a/src/funcs/lobbiesV2SetLobbyState.ts +++ b/src/funcs/lobbiesV2SetLobbyState.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * SetLobbyState + * + * @remarks * 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). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/lobbiesV3CreateLobby.ts b/src/funcs/lobbiesV3CreateLobby.ts index 9175bba8..5b30e0b5 100644 --- a/src/funcs/lobbiesV3CreateLobby.ts +++ b/src/funcs/lobbiesV3CreateLobby.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateLobby + * + * @remarks * 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. */ export async function lobbiesV3CreateLobby( diff --git a/src/funcs/lobbiesV3GetLobbyInfoByRoomId.ts b/src/funcs/lobbiesV3GetLobbyInfoByRoomId.ts index 9f782104..85e0f615 100644 --- a/src/funcs/lobbiesV3GetLobbyInfoByRoomId.ts +++ b/src/funcs/lobbiesV3GetLobbyInfoByRoomId.ts @@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLobbyInfoByRoomId + * + * @remarks * Get details for a lobby. */ export async function lobbiesV3GetLobbyInfoByRoomId( diff --git a/src/funcs/lobbiesV3GetLobbyInfoByShortCode.ts b/src/funcs/lobbiesV3GetLobbyInfoByShortCode.ts index f5978c3f..b8cf7862 100644 --- a/src/funcs/lobbiesV3GetLobbyInfoByShortCode.ts +++ b/src/funcs/lobbiesV3GetLobbyInfoByShortCode.ts @@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLobbyInfoByShortCode + * + * @remarks * Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. */ export async function lobbiesV3GetLobbyInfoByShortCode( diff --git a/src/funcs/lobbiesV3ListActivePublicLobbies.ts b/src/funcs/lobbiesV3ListActivePublicLobbies.ts index 220cddb2..1d034a38 100644 --- a/src/funcs/lobbiesV3ListActivePublicLobbies.ts +++ b/src/funcs/lobbiesV3ListActivePublicLobbies.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * ListActivePublicLobbies + * + * @remarks * 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. */ export async function lobbiesV3ListActivePublicLobbies( diff --git a/src/funcs/logsV1DownloadLogForProcess.ts b/src/funcs/logsV1DownloadLogForProcess.ts index 3787d72e..ea5a524a 100644 --- a/src/funcs/logsV1DownloadLogForProcess.ts +++ b/src/funcs/logsV1DownloadLogForProcess.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * DownloadLogForProcess + * + * @remarks * Download entire log file for a stopped process. */ export async function logsV1DownloadLogForProcess( diff --git a/src/funcs/logsV1GetLogsForProcess.ts b/src/funcs/logsV1GetLogsForProcess.ts index 1b069cc5..09575afe 100644 --- a/src/funcs/logsV1GetLogsForProcess.ts +++ b/src/funcs/logsV1GetLogsForProcess.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLogsForProcess + * + * @remarks * Returns a stream of logs for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. */ export async function logsV1GetLogsForProcess( diff --git a/src/funcs/managementV1SendVerificationEmail.ts b/src/funcs/managementV1SendVerificationEmail.ts index 0e8ebd8d..6c9587b3 100644 --- a/src/funcs/managementV1SendVerificationEmail.ts +++ b/src/funcs/managementV1SendVerificationEmail.ts @@ -21,6 +21,9 @@ import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; +/** + * SendVerificationEmail + */ export async function managementV1SendVerificationEmail( client: HathoraCloudCore, request: components.VerificationEmailRequest, diff --git a/src/funcs/metricsV1GetMetricsDeprecated.ts b/src/funcs/metricsV1GetMetricsDeprecated.ts index 717f8835..c5a57ae3 100644 --- a/src/funcs/metricsV1GetMetricsDeprecated.ts +++ b/src/funcs/metricsV1GetMetricsDeprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetMetricsDeprecated + * + * @remarks * Get metrics for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/organizationsV1AcceptInvite.ts b/src/funcs/organizationsV1AcceptInvite.ts index 2a514f32..e782f520 100644 --- a/src/funcs/organizationsV1AcceptInvite.ts +++ b/src/funcs/organizationsV1AcceptInvite.ts @@ -23,6 +23,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * AcceptInvite + */ export async function organizationsV1AcceptInvite( client: HathoraCloudCore, orgId: string, diff --git a/src/funcs/organizationsV1GetOrgMembers.ts b/src/funcs/organizationsV1GetOrgMembers.ts index 17ca0a22..205e97cb 100644 --- a/src/funcs/organizationsV1GetOrgMembers.ts +++ b/src/funcs/organizationsV1GetOrgMembers.ts @@ -23,6 +23,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * GetOrgMembers + */ export async function organizationsV1GetOrgMembers( client: HathoraCloudCore, orgId: string, diff --git a/src/funcs/organizationsV1GetOrgPendingInvites.ts b/src/funcs/organizationsV1GetOrgPendingInvites.ts index 8c39b2c4..977eee08 100644 --- a/src/funcs/organizationsV1GetOrgPendingInvites.ts +++ b/src/funcs/organizationsV1GetOrgPendingInvites.ts @@ -23,6 +23,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * GetOrgPendingInvites + */ export async function organizationsV1GetOrgPendingInvites( client: HathoraCloudCore, orgId: string, diff --git a/src/funcs/organizationsV1GetOrgs.ts b/src/funcs/organizationsV1GetOrgs.ts index f98a0b88..6d3782f8 100644 --- a/src/funcs/organizationsV1GetOrgs.ts +++ b/src/funcs/organizationsV1GetOrgs.ts @@ -21,6 +21,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; /** + * GetOrgs + * + * @remarks * Returns an unsorted list of all organizations that you are a member of (an accepted membership invite). An organization is uniquely identified by an `orgId`. */ export async function organizationsV1GetOrgs( diff --git a/src/funcs/organizationsV1GetUserPendingInvites.ts b/src/funcs/organizationsV1GetUserPendingInvites.ts index fb13e7be..ef2bf4a9 100644 --- a/src/funcs/organizationsV1GetUserPendingInvites.ts +++ b/src/funcs/organizationsV1GetUserPendingInvites.ts @@ -20,6 +20,9 @@ import { SDKError } from "../models/errors/sdkerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { Result } from "../types/fp.js"; +/** + * GetUserPendingInvites + */ export async function organizationsV1GetUserPendingInvites( client: HathoraCloudCore, options?: RequestOptions, diff --git a/src/funcs/organizationsV1InviteUser.ts b/src/funcs/organizationsV1InviteUser.ts index 2a34c8b7..47638b6f 100644 --- a/src/funcs/organizationsV1InviteUser.ts +++ b/src/funcs/organizationsV1InviteUser.ts @@ -23,6 +23,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * InviteUser + */ export async function organizationsV1InviteUser( client: HathoraCloudCore, createUserInvite: components.CreateUserInvite, diff --git a/src/funcs/organizationsV1RejectInvite.ts b/src/funcs/organizationsV1RejectInvite.ts index f14e7fee..8bb22dc6 100644 --- a/src/funcs/organizationsV1RejectInvite.ts +++ b/src/funcs/organizationsV1RejectInvite.ts @@ -23,6 +23,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * RejectInvite + */ export async function organizationsV1RejectInvite( client: HathoraCloudCore, orgId: string, diff --git a/src/funcs/organizationsV1RescindInvite.ts b/src/funcs/organizationsV1RescindInvite.ts index 5ed40633..6a843f04 100644 --- a/src/funcs/organizationsV1RescindInvite.ts +++ b/src/funcs/organizationsV1RescindInvite.ts @@ -24,6 +24,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * RescindInvite + */ export async function organizationsV1RescindInvite( client: HathoraCloudCore, rescindUserInvite: components.RescindUserInvite, diff --git a/src/funcs/processesV1GetProcessInfoDeprecated.ts b/src/funcs/processesV1GetProcessInfoDeprecated.ts index ee2d9037..a11c7593 100644 --- a/src/funcs/processesV1GetProcessInfoDeprecated.ts +++ b/src/funcs/processesV1GetProcessInfoDeprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetProcessInfoDeprecated + * + * @remarks * Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/processesV1GetRunningProcesses.ts b/src/funcs/processesV1GetRunningProcesses.ts index 72dad559..fe0d2033 100644 --- a/src/funcs/processesV1GetRunningProcesses.ts +++ b/src/funcs/processesV1GetRunningProcesses.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetRunningProcesses + * + * @remarks * Retrieve 10 most recently started [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/processesV1GetStoppedProcesses.ts b/src/funcs/processesV1GetStoppedProcesses.ts index 457a5ef7..565da359 100644 --- a/src/funcs/processesV1GetStoppedProcesses.ts +++ b/src/funcs/processesV1GetStoppedProcesses.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetStoppedProcesses + * + * @remarks * Retrieve 10 most recently stopped [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/processesV2CreateProcessV2Deprecated.ts b/src/funcs/processesV2CreateProcessV2Deprecated.ts index 2b83e2e8..07f94a93 100644 --- a/src/funcs/processesV2CreateProcessV2Deprecated.ts +++ b/src/funcs/processesV2CreateProcessV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateProcessV2Deprecated + * + * @remarks * Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/processesV2GetLatestProcessesV2Deprecated.ts b/src/funcs/processesV2GetLatestProcessesV2Deprecated.ts index 22b748ec..7dbad4e4 100644 --- a/src/funcs/processesV2GetLatestProcessesV2Deprecated.ts +++ b/src/funcs/processesV2GetLatestProcessesV2Deprecated.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLatestProcessesV2Deprecated + * + * @remarks * Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/processesV2GetProcessInfoV2Deprecated.ts b/src/funcs/processesV2GetProcessInfoV2Deprecated.ts index 723db227..8498eb6e 100644 --- a/src/funcs/processesV2GetProcessInfoV2Deprecated.ts +++ b/src/funcs/processesV2GetProcessInfoV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetProcessInfoV2Deprecated + * + * @remarks * Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/processesV2GetProcessesCountExperimentalV2Deprecated.ts b/src/funcs/processesV2GetProcessesCountExperimentalV2Deprecated.ts index dac30b9b..b3f27cde 100644 --- a/src/funcs/processesV2GetProcessesCountExperimentalV2Deprecated.ts +++ b/src/funcs/processesV2GetProcessesCountExperimentalV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetProcessesCountExperimentalV2Deprecated + * + * @remarks * Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/processesV2StopProcessV2Deprecated.ts b/src/funcs/processesV2StopProcessV2Deprecated.ts index 057f582b..bdcbfbc6 100644 --- a/src/funcs/processesV2StopProcessV2Deprecated.ts +++ b/src/funcs/processesV2StopProcessV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * StopProcessV2Deprecated + * + * @remarks * Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/processesV3CreateProcess.ts b/src/funcs/processesV3CreateProcess.ts index 10af3fcb..e044bca0 100644 --- a/src/funcs/processesV3CreateProcess.ts +++ b/src/funcs/processesV3CreateProcess.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateProcess + * + * @remarks * Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. */ export async function processesV3CreateProcess( diff --git a/src/funcs/processesV3GetLatestProcesses.ts b/src/funcs/processesV3GetLatestProcesses.ts index 6b605889..7b8db5a3 100644 --- a/src/funcs/processesV3GetLatestProcesses.ts +++ b/src/funcs/processesV3GetLatestProcesses.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetLatestProcesses + * + * @remarks * Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. */ export async function processesV3GetLatestProcesses( diff --git a/src/funcs/processesV3GetProcess.ts b/src/funcs/processesV3GetProcess.ts index 20b1f6df..c4779028 100644 --- a/src/funcs/processesV3GetProcess.ts +++ b/src/funcs/processesV3GetProcess.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetProcess + * + * @remarks * Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). */ export async function processesV3GetProcess( diff --git a/src/funcs/processesV3GetProcessMetrics.ts b/src/funcs/processesV3GetProcessMetrics.ts index 631e17c5..06a22865 100644 --- a/src/funcs/processesV3GetProcessMetrics.ts +++ b/src/funcs/processesV3GetProcessMetrics.ts @@ -23,6 +23,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * GetProcessMetrics + */ export async function processesV3GetProcessMetrics( client: HathoraCloudCore, request: operations.GetProcessMetricsRequest, diff --git a/src/funcs/processesV3GetProcessesCountExperimental.ts b/src/funcs/processesV3GetProcessesCountExperimental.ts index 1ea97d52..ee13fa01 100644 --- a/src/funcs/processesV3GetProcessesCountExperimental.ts +++ b/src/funcs/processesV3GetProcessesCountExperimental.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetProcessesCountExperimental + * + * @remarks * Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. */ export async function processesV3GetProcessesCountExperimental( diff --git a/src/funcs/processesV3StopProcess.ts b/src/funcs/processesV3StopProcess.ts index f7e075b3..e130b2fd 100644 --- a/src/funcs/processesV3StopProcess.ts +++ b/src/funcs/processesV3StopProcess.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * StopProcess + * + * @remarks * Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. */ export async function processesV3StopProcess( diff --git a/src/funcs/roomsV1CreateRoomDeprecated.ts b/src/funcs/roomsV1CreateRoomDeprecated.ts index a8d97e46..9ec918c3 100644 --- a/src/funcs/roomsV1CreateRoomDeprecated.ts +++ b/src/funcs/roomsV1CreateRoomDeprecated.ts @@ -25,6 +25,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateRoomDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function roomsV1CreateRoomDeprecated( diff --git a/src/funcs/roomsV1DestroyRoomDeprecated.ts b/src/funcs/roomsV1DestroyRoomDeprecated.ts index 51378025..c6c4626a 100644 --- a/src/funcs/roomsV1DestroyRoomDeprecated.ts +++ b/src/funcs/roomsV1DestroyRoomDeprecated.ts @@ -24,6 +24,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * DestroyRoomDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function roomsV1DestroyRoomDeprecated( diff --git a/src/funcs/roomsV1GetActiveRoomsForProcessDeprecated.ts b/src/funcs/roomsV1GetActiveRoomsForProcessDeprecated.ts index 882b963b..a057f684 100644 --- a/src/funcs/roomsV1GetActiveRoomsForProcessDeprecated.ts +++ b/src/funcs/roomsV1GetActiveRoomsForProcessDeprecated.ts @@ -25,6 +25,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetActiveRoomsForProcessDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function roomsV1GetActiveRoomsForProcessDeprecated( diff --git a/src/funcs/roomsV1GetConnectionInfoDeprecated.ts b/src/funcs/roomsV1GetConnectionInfoDeprecated.ts index e1597ef5..f1a171ce 100644 --- a/src/funcs/roomsV1GetConnectionInfoDeprecated.ts +++ b/src/funcs/roomsV1GetConnectionInfoDeprecated.ts @@ -23,6 +23,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetConnectionInfoDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function roomsV1GetConnectionInfoDeprecated( diff --git a/src/funcs/roomsV1GetInactiveRoomsForProcessDeprecated.ts b/src/funcs/roomsV1GetInactiveRoomsForProcessDeprecated.ts index 51366c3d..1f5e1153 100644 --- a/src/funcs/roomsV1GetInactiveRoomsForProcessDeprecated.ts +++ b/src/funcs/roomsV1GetInactiveRoomsForProcessDeprecated.ts @@ -25,6 +25,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetInactiveRoomsForProcessDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function roomsV1GetInactiveRoomsForProcessDeprecated( diff --git a/src/funcs/roomsV1GetRoomInfoDeprecated.ts b/src/funcs/roomsV1GetRoomInfoDeprecated.ts index 10f61045..91917460 100644 --- a/src/funcs/roomsV1GetRoomInfoDeprecated.ts +++ b/src/funcs/roomsV1GetRoomInfoDeprecated.ts @@ -24,6 +24,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetRoomInfoDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function roomsV1GetRoomInfoDeprecated( diff --git a/src/funcs/roomsV1SuspendRoomDeprecated.ts b/src/funcs/roomsV1SuspendRoomDeprecated.ts index 0525de10..e1fd6324 100644 --- a/src/funcs/roomsV1SuspendRoomDeprecated.ts +++ b/src/funcs/roomsV1SuspendRoomDeprecated.ts @@ -24,6 +24,8 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * SuspendRoomDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ export async function roomsV1SuspendRoomDeprecated( diff --git a/src/funcs/roomsV2CreateRoom.ts b/src/funcs/roomsV2CreateRoom.ts index 174b4d5c..eea78cbd 100644 --- a/src/funcs/roomsV2CreateRoom.ts +++ b/src/funcs/roomsV2CreateRoom.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateRoom + * + * @remarks * Create a new [room](https://hathora.dev/docs/concepts/hathora-entities#room) for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application). Poll the [`GetConnectionInfo()`](https://hathora.dev/api#tag/RoomV2/operation/GetConnectionInfo) endpoint to get connection details for an active room. */ export async function roomsV2CreateRoom( diff --git a/src/funcs/roomsV2DestroyRoom.ts b/src/funcs/roomsV2DestroyRoom.ts index 90addab3..cd17abb3 100644 --- a/src/funcs/roomsV2DestroyRoom.ts +++ b/src/funcs/roomsV2DestroyRoom.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * DestroyRoom + * + * @remarks * Destroy a [room](https://hathora.dev/docs/concepts/hathora-entities#room). All associated metadata is deleted. */ export async function roomsV2DestroyRoom( diff --git a/src/funcs/roomsV2GetActiveRoomsForProcess.ts b/src/funcs/roomsV2GetActiveRoomsForProcess.ts index 582ac792..726828b2 100644 --- a/src/funcs/roomsV2GetActiveRoomsForProcess.ts +++ b/src/funcs/roomsV2GetActiveRoomsForProcess.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetActiveRoomsForProcess + * + * @remarks * Get all active [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). */ export async function roomsV2GetActiveRoomsForProcess( diff --git a/src/funcs/roomsV2GetConnectionInfo.ts b/src/funcs/roomsV2GetConnectionInfo.ts index ffc4e7d2..117d03c2 100644 --- a/src/funcs/roomsV2GetConnectionInfo.ts +++ b/src/funcs/roomsV2GetConnectionInfo.ts @@ -23,6 +23,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetConnectionInfo + * + * @remarks * Poll this endpoint to get connection details to a [room](https://hathora.dev/docs/concepts/hathora-entities#room). Clients can call this endpoint without authentication. */ export async function roomsV2GetConnectionInfo( diff --git a/src/funcs/roomsV2GetInactiveRoomsForProcess.ts b/src/funcs/roomsV2GetInactiveRoomsForProcess.ts index 5f6d1ca8..25367b1d 100644 --- a/src/funcs/roomsV2GetInactiveRoomsForProcess.ts +++ b/src/funcs/roomsV2GetInactiveRoomsForProcess.ts @@ -25,6 +25,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetInactiveRoomsForProcess + * + * @remarks * Get all inactive [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). */ export async function roomsV2GetInactiveRoomsForProcess( diff --git a/src/funcs/roomsV2GetRoomInfo.ts b/src/funcs/roomsV2GetRoomInfo.ts index 6f7bfb94..3b6596de 100644 --- a/src/funcs/roomsV2GetRoomInfo.ts +++ b/src/funcs/roomsV2GetRoomInfo.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetRoomInfo + * + * @remarks * Retreive current and historical allocation data for a [room](https://hathora.dev/docs/concepts/hathora-entities#room). */ export async function roomsV2GetRoomInfo( diff --git a/src/funcs/roomsV2SuspendRoomV2Deprecated.ts b/src/funcs/roomsV2SuspendRoomV2Deprecated.ts index 05b27d4f..442b72b1 100644 --- a/src/funcs/roomsV2SuspendRoomV2Deprecated.ts +++ b/src/funcs/roomsV2SuspendRoomV2Deprecated.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * SuspendRoomV2Deprecated + * + * @remarks * Suspend a [room](https://hathora.dev/docs/concepts/hathora-entities#room). The room is unallocated from the process but can be rescheduled later using the same `roomId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/funcs/roomsV2UpdateRoomConfig.ts b/src/funcs/roomsV2UpdateRoomConfig.ts index 25f83be4..070e6ce4 100644 --- a/src/funcs/roomsV2UpdateRoomConfig.ts +++ b/src/funcs/roomsV2UpdateRoomConfig.ts @@ -24,6 +24,9 @@ import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; +/** + * UpdateRoomConfig + */ export async function roomsV2UpdateRoomConfig( client: HathoraCloudCore, updateRoomConfigParams: components.UpdateRoomConfigParams, diff --git a/src/funcs/tokensV1CreateOrgToken.ts b/src/funcs/tokensV1CreateOrgToken.ts index be45a2a9..8345a069 100644 --- a/src/funcs/tokensV1CreateOrgToken.ts +++ b/src/funcs/tokensV1CreateOrgToken.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * CreateOrgToken + * + * @remarks * Create a new organization token. */ export async function tokensV1CreateOrgToken( diff --git a/src/funcs/tokensV1GetOrgTokens.ts b/src/funcs/tokensV1GetOrgTokens.ts index da4ed390..bf196dd0 100644 --- a/src/funcs/tokensV1GetOrgTokens.ts +++ b/src/funcs/tokensV1GetOrgTokens.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * GetOrgTokens + * + * @remarks * List all organization tokens for a given org. */ export async function tokensV1GetOrgTokens( diff --git a/src/funcs/tokensV1RevokeOrgToken.ts b/src/funcs/tokensV1RevokeOrgToken.ts index ef9b6d4e..b357d156 100644 --- a/src/funcs/tokensV1RevokeOrgToken.ts +++ b/src/funcs/tokensV1RevokeOrgToken.ts @@ -24,6 +24,9 @@ import * as operations from "../models/operations/index.js"; import { Result } from "../types/fp.js"; /** + * RevokeOrgToken + * + * @remarks * Revoke an organization token. */ export async function tokensV1RevokeOrgToken( diff --git a/src/lib/config.ts b/src/lib/config.ts index 405c8ff4..ada08fab 100644 --- a/src/lib/config.ts +++ b/src/lib/config.ts @@ -60,8 +60,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null { export const SDK_METADATA = { language: "typescript", openapiDocVersion: "0.0.1", - sdkVersion: "2.10.9", - genVersion: "2.445.1", + sdkVersion: "2.10.10", + genVersion: "2.446.5", userAgent: - "speakeasy-sdk/typescript 2.10.9 2.445.1 0.0.1 @hathora/cloud-sdk-typescript", + "speakeasy-sdk/typescript 2.10.10 2.446.5 0.0.1 @hathora/cloud-sdk-typescript", } as const; diff --git a/src/sdk/appsv1.ts b/src/sdk/appsv1.ts index b057d9b1..62b0db5e 100644 --- a/src/sdk/appsv1.ts +++ b/src/sdk/appsv1.ts @@ -13,6 +13,9 @@ import { unwrapAsync } from "../types/fp.js"; export class AppsV1 extends ClientSDK { /** + * GetAppsV1Deprecated + * + * @remarks * Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -29,6 +32,9 @@ export class AppsV1 extends ClientSDK { } /** + * CreateAppV1Deprecated + * + * @remarks * Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -45,6 +51,9 @@ export class AppsV1 extends ClientSDK { } /** + * UpdateAppV1Deprecated + * + * @remarks * Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -63,6 +72,9 @@ export class AppsV1 extends ClientSDK { } /** + * GetAppInfoV1Deprecated + * + * @remarks * Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -79,6 +91,9 @@ export class AppsV1 extends ClientSDK { } /** + * DeleteAppV1Deprecated + * + * @remarks * Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/appsv2.ts b/src/sdk/appsv2.ts index 21555cef..841d46da 100644 --- a/src/sdk/appsv2.ts +++ b/src/sdk/appsv2.ts @@ -13,6 +13,9 @@ import { unwrapAsync } from "../types/fp.js"; export class AppsV2 extends ClientSDK { /** + * GetApps + * + * @remarks * Returns an unsorted list of your organization’s [applications](https://hathora.dev/docs/concepts/hathora-entities#application). An application is uniquely identified by an `appId`. */ async getApps( @@ -27,6 +30,9 @@ export class AppsV2 extends ClientSDK { } /** + * CreateApp + * + * @remarks * Create a new [application](https://hathora.dev/docs/concepts/hathora-entities#application). */ async createApp( @@ -43,6 +49,9 @@ export class AppsV2 extends ClientSDK { } /** + * UpdateApp + * + * @remarks * Update data for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. */ async updateApp( @@ -59,6 +68,9 @@ export class AppsV2 extends ClientSDK { } /** + * GetApp + * + * @remarks * Get details for an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. */ async getApp( @@ -73,6 +85,9 @@ export class AppsV2 extends ClientSDK { } /** + * DeleteApp + * + * @remarks * Delete an [application](https://hathora.dev/docs/concepts/hathora-entities#application) using `appId`. Your organization will lose access to this application. */ async deleteApp( diff --git a/src/sdk/authv1.ts b/src/sdk/authv1.ts index de823b8d..32ab56b3 100644 --- a/src/sdk/authv1.ts +++ b/src/sdk/authv1.ts @@ -11,6 +11,9 @@ import { unwrapAsync } from "../types/fp.js"; export class AuthV1 extends ClientSDK { /** + * LoginAnonymous + * + * @remarks * Returns a unique player token for an anonymous user. */ async loginAnonymous( @@ -25,6 +28,9 @@ export class AuthV1 extends ClientSDK { } /** + * LoginNickname + * + * @remarks * Returns a unique player token with a specified nickname for a user. */ async loginNickname( @@ -41,6 +47,9 @@ export class AuthV1 extends ClientSDK { } /** + * LoginGoogle + * + * @remarks * Returns a unique player token using a Google-signed OIDC `idToken`. */ async loginGoogle( diff --git a/src/sdk/billingv1.ts b/src/sdk/billingv1.ts index fdbdc05d..06c1772c 100644 --- a/src/sdk/billingv1.ts +++ b/src/sdk/billingv1.ts @@ -14,6 +14,9 @@ import * as operations from "../models/operations/index.js"; import { unwrapAsync } from "../types/fp.js"; export class BillingV1 extends ClientSDK { + /** + * GetBalance + */ async getBalance( options?: RequestOptions, ): Promise { @@ -23,6 +26,9 @@ export class BillingV1 extends ClientSDK { )); } + /** + * GetUpcomingInvoiceItems + */ async getUpcomingInvoiceItems( options?: RequestOptions, ): Promise { @@ -32,6 +38,9 @@ export class BillingV1 extends ClientSDK { )); } + /** + * GetUpcomingInvoiceTotal + */ async getUpcomingInvoiceTotal( options?: RequestOptions, ): Promise { @@ -41,6 +50,9 @@ export class BillingV1 extends ClientSDK { )); } + /** + * GetPaymentMethod + */ async getPaymentMethod( options?: RequestOptions, ): Promise { @@ -50,6 +62,9 @@ export class BillingV1 extends ClientSDK { )); } + /** + * InitStripeCustomerPortalUrl + */ async initStripeCustomerPortalUrl( request: components.CustomerPortalUrl, options?: RequestOptions, @@ -61,6 +76,9 @@ export class BillingV1 extends ClientSDK { )); } + /** + * GetInvoices + */ async getInvoices( options?: RequestOptions, ): Promise> { diff --git a/src/sdk/buildsv1.ts b/src/sdk/buildsv1.ts index a725a9dd..61e374a2 100644 --- a/src/sdk/buildsv1.ts +++ b/src/sdk/buildsv1.ts @@ -14,6 +14,9 @@ import { unwrapAsync } from "../types/fp.js"; export class BuildsV1 extends ClientSDK { /** + * GetBuildsDeprecated + * + * @remarks * Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -30,6 +33,9 @@ export class BuildsV1 extends ClientSDK { } /** + * GetBuildInfoDeprecated + * + * @remarks * Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -48,6 +54,9 @@ export class BuildsV1 extends ClientSDK { } /** + * CreateBuildDeprecated + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -66,6 +75,9 @@ export class BuildsV1 extends ClientSDK { } /** + * DeleteBuildDeprecated + * + * @remarks * Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -84,6 +96,9 @@ export class BuildsV1 extends ClientSDK { } /** + * RunBuildDeprecated + * + * @remarks * Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/buildsv2.ts b/src/sdk/buildsv2.ts index 2b9ae29b..0fde60e2 100644 --- a/src/sdk/buildsv2.ts +++ b/src/sdk/buildsv2.ts @@ -16,6 +16,9 @@ import { unwrapAsync } from "../types/fp.js"; export class BuildsV2 extends ClientSDK { /** + * GetBuildsV2Deprecated + * + * @remarks * Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -32,6 +35,9 @@ export class BuildsV2 extends ClientSDK { } /** + * GetBuildInfoV2Deprecated + * + * @remarks * Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -50,6 +56,9 @@ export class BuildsV2 extends ClientSDK { } /** + * CreateBuildV2Deprecated + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build). Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -68,6 +77,9 @@ export class BuildsV2 extends ClientSDK { } /** + * CreateBuildWithUploadUrlV2Deprecated + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with `uploadUrl` that can be used to upload the build to before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -86,6 +98,9 @@ export class BuildsV2 extends ClientSDK { } /** + * CreateWithMultipartUploadsV2Deprecated + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -104,6 +119,9 @@ export class BuildsV2 extends ClientSDK { } /** + * DeleteBuildV2Deprecated + * + * @remarks * Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -122,6 +140,9 @@ export class BuildsV2 extends ClientSDK { } /** + * RunBuildV2Deprecated + * + * @remarks * Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/buildsv3.ts b/src/sdk/buildsv3.ts index ff84d424..35870e4b 100644 --- a/src/sdk/buildsv3.ts +++ b/src/sdk/buildsv3.ts @@ -13,6 +13,9 @@ import { unwrapAsync } from "../types/fp.js"; export class BuildsV3 extends ClientSDK { /** + * GetBuilds + * + * @remarks * Returns an array of [builds](https://hathora.dev/docs/concepts/hathora-entities#build) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). */ async getBuilds( @@ -27,6 +30,9 @@ export class BuildsV3 extends ClientSDK { } /** + * CreateBuild + * + * @remarks * Creates a new [build](https://hathora.dev/docs/concepts/hathora-entities#build) with optional `multipartUploadUrls` that can be used to upload larger builds in parts before calling `runBuild`. Responds with a `buildId` that you must pass to [`RunBuild()`](https://hathora.dev/api#tag/BuildV1/operation/RunBuild) to build the game server artifact. You can optionally pass in a `buildTag` to associate an external version with a build. */ async createBuild( @@ -43,6 +49,9 @@ export class BuildsV3 extends ClientSDK { } /** + * GetBuild + * + * @remarks * Get details for a [build](https://hathora.dev/docs/concepts/hathora-entities#build). */ async getBuild( @@ -59,6 +68,9 @@ export class BuildsV3 extends ClientSDK { } /** + * DeleteBuild + * + * @remarks * Delete a [build](https://hathora.dev/docs/concepts/hathora-entities#build). All associated metadata is deleted. * Be careful which builds you delete. This endpoint does not prevent you from deleting actively used builds. * Deleting a build that is actively build used by an app's deployment will cause failures when creating rooms. @@ -77,6 +89,9 @@ export class BuildsV3 extends ClientSDK { } /** + * RunBuild + * + * @remarks * Builds a game server artifact from a tarball you provide. Pass in the `buildId` generated from [`CreateBuild()`](https://hathora.dev/api#tag/BuildV1/operation/CreateBuild). */ async runBuild( diff --git a/src/sdk/deploymentsv1.ts b/src/sdk/deploymentsv1.ts index f626ba02..c85338d2 100644 --- a/src/sdk/deploymentsv1.ts +++ b/src/sdk/deploymentsv1.ts @@ -12,6 +12,9 @@ import { unwrapAsync } from "../types/fp.js"; export class DeploymentsV1 extends ClientSDK { /** + * GetDeploymentsV1Deprecated + * + * @remarks * Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -28,6 +31,9 @@ export class DeploymentsV1 extends ClientSDK { } /** + * GetLatestDeploymentV1Deprecated + * + * @remarks * Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -44,6 +50,9 @@ export class DeploymentsV1 extends ClientSDK { } /** + * GetDeploymentInfoV1Deprecated + * + * @remarks * Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -62,6 +71,9 @@ export class DeploymentsV1 extends ClientSDK { } /** + * CreateDeploymentV1Deprecated + * + * @remarks * Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/deploymentsv2.ts b/src/sdk/deploymentsv2.ts index 63d6ec84..c930ba26 100644 --- a/src/sdk/deploymentsv2.ts +++ b/src/sdk/deploymentsv2.ts @@ -12,6 +12,9 @@ import { unwrapAsync } from "../types/fp.js"; export class DeploymentsV2 extends ClientSDK { /** + * GetDeploymentsV2Deprecated + * + * @remarks * Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -28,6 +31,9 @@ export class DeploymentsV2 extends ClientSDK { } /** + * GetLatestDeploymentV2Deprecated + * + * @remarks * Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -44,6 +50,9 @@ export class DeploymentsV2 extends ClientSDK { } /** + * GetDeploymentInfoV2Deprecated + * + * @remarks * Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -62,6 +71,9 @@ export class DeploymentsV2 extends ClientSDK { } /** + * CreateDeploymentV2Deprecated + * + * @remarks * Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/deploymentsv3.ts b/src/sdk/deploymentsv3.ts index e2e3d798..f5f112e1 100644 --- a/src/sdk/deploymentsv3.ts +++ b/src/sdk/deploymentsv3.ts @@ -12,6 +12,9 @@ import { unwrapAsync } from "../types/fp.js"; export class DeploymentsV3 extends ClientSDK { /** + * GetDeployments + * + * @remarks * Returns an array of [deployments](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application), optionally filtered by deploymentTag. */ async getDeployments( @@ -28,6 +31,9 @@ export class DeploymentsV3 extends ClientSDK { } /** + * CreateDeployment + * + * @remarks * Create a new [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). Creating a new deployment means all new rooms created will use the latest deployment configuration, but existing games in progress will not be affected. */ async createDeployment( @@ -44,6 +50,9 @@ export class DeploymentsV3 extends ClientSDK { } /** + * GetLatestDeployment + * + * @remarks * Get the latest [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment) for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). */ async getLatestDeployment( @@ -58,6 +67,9 @@ export class DeploymentsV3 extends ClientSDK { } /** + * GetDeployment + * + * @remarks * Get details for a [deployment](https://hathora.dev/docs/concepts/hathora-entities#deployment). */ async getDeployment( diff --git a/src/sdk/discoveryv1.ts b/src/sdk/discoveryv1.ts index 04fe2532..49f089c5 100644 --- a/src/sdk/discoveryv1.ts +++ b/src/sdk/discoveryv1.ts @@ -9,6 +9,9 @@ import { unwrapAsync } from "../types/fp.js"; export class DiscoveryV1 extends ClientSDK { /** + * GetPingServiceEndpointsDeprecated + * + * @remarks * Returns an array of V1 regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/discoveryv2.ts b/src/sdk/discoveryv2.ts index 09663c80..fca9b014 100644 --- a/src/sdk/discoveryv2.ts +++ b/src/sdk/discoveryv2.ts @@ -9,6 +9,9 @@ import { unwrapAsync } from "../types/fp.js"; export class DiscoveryV2 extends ClientSDK { /** + * GetPingServiceEndpoints + * + * @remarks * Returns an array of all regions with a host and port that a client can directly ping. Open a websocket connection to `wss://:/ws` and send a packet. To calculate ping, measure the time it takes to get an echo packet back. */ async getPingServiceEndpoints( diff --git a/src/sdk/fleetsv1.ts b/src/sdk/fleetsv1.ts index 7096192a..ba9b1221 100644 --- a/src/sdk/fleetsv1.ts +++ b/src/sdk/fleetsv1.ts @@ -13,6 +13,9 @@ import { unwrapAsync } from "../types/fp.js"; export class FleetsV1 extends ClientSDK { /** + * GetFleets + * + * @remarks * Returns an array of [fleets](https://hathora.dev/docs/concepts/hathora-entities#fleet). */ async getFleets( @@ -27,6 +30,9 @@ export class FleetsV1 extends ClientSDK { } /** + * GetFleetRegion + * + * @remarks * Gets the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. */ async getFleetRegion( @@ -45,6 +51,9 @@ export class FleetsV1 extends ClientSDK { } /** + * UpdateFleetRegion + * + * @remarks * Updates the configuration for a given [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. */ async updateFleetRegion( @@ -65,6 +74,9 @@ export class FleetsV1 extends ClientSDK { } /** + * GetFleetMetrics + * + * @remarks * Gets metrics for a [fleet](https://hathora.dev/docs/concepts/hathora-entities#fleet) in a region. */ async getFleetMetrics( diff --git a/src/sdk/lobbiesv1.ts b/src/sdk/lobbiesv1.ts index 4cbcee2a..f7dd3b58 100644 --- a/src/sdk/lobbiesv1.ts +++ b/src/sdk/lobbiesv1.ts @@ -12,6 +12,8 @@ import { unwrapAsync } from "../types/fp.js"; export class LobbiesV1 extends ClientSDK { /** + * CreatePrivateLobbyDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async createPrivateLobbyDeprecated( @@ -32,6 +34,8 @@ export class LobbiesV1 extends ClientSDK { } /** + * CreatePublicLobbyDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async createPublicLobbyDeprecated( @@ -52,6 +56,8 @@ export class LobbiesV1 extends ClientSDK { } /** + * ListActivePublicLobbiesDeprecatedV1 + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async listActivePublicLobbiesDeprecatedV1( diff --git a/src/sdk/lobbiesv2.ts b/src/sdk/lobbiesv2.ts index bcb8ef6f..424a0103 100644 --- a/src/sdk/lobbiesv2.ts +++ b/src/sdk/lobbiesv2.ts @@ -16,6 +16,8 @@ import { unwrapAsync } from "../types/fp.js"; export class LobbiesV2 extends ClientSDK { /** + * CreatePrivateLobby + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async createPrivateLobby( @@ -36,6 +38,8 @@ export class LobbiesV2 extends ClientSDK { } /** + * CreatePublicLobby + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async createPublicLobby( @@ -56,6 +60,8 @@ export class LobbiesV2 extends ClientSDK { } /** + * CreateLocalLobby + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async createLocalLobby( @@ -76,6 +82,9 @@ export class LobbiesV2 extends ClientSDK { } /** + * CreateLobbyDeprecated + * + * @remarks * 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. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -98,6 +107,9 @@ export class LobbiesV2 extends ClientSDK { } /** + * ListActivePublicLobbiesDeprecatedV2 + * + * @remarks * 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. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -116,6 +128,9 @@ export class LobbiesV2 extends ClientSDK { } /** + * GetLobbyInfo + * + * @remarks * Get details for a lobby. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -134,6 +149,9 @@ export class LobbiesV2 extends ClientSDK { } /** + * SetLobbyState + * + * @remarks * 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). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/lobbiesv3.ts b/src/sdk/lobbiesv3.ts index 35a42714..f8df5346 100644 --- a/src/sdk/lobbiesv3.ts +++ b/src/sdk/lobbiesv3.ts @@ -13,6 +13,9 @@ import { unwrapAsync } from "../types/fp.js"; export class LobbiesV3 extends ClientSDK { /** + * CreateLobby + * + * @remarks * 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. */ async createLobby( @@ -35,6 +38,9 @@ export class LobbiesV3 extends ClientSDK { } /** + * ListActivePublicLobbies + * + * @remarks * 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. */ async listActivePublicLobbies( @@ -51,6 +57,9 @@ export class LobbiesV3 extends ClientSDK { } /** + * GetLobbyInfoByRoomId + * + * @remarks * Get details for a lobby. */ async getLobbyInfoByRoomId( @@ -67,6 +76,9 @@ export class LobbiesV3 extends ClientSDK { } /** + * GetLobbyInfoByShortCode + * + * @remarks * Get details for a lobby. If 2 or more lobbies have the same `shortCode`, then the most recently created lobby will be returned. */ async getLobbyInfoByShortCode( diff --git a/src/sdk/logsv1.ts b/src/sdk/logsv1.ts index 6eff22aa..d2bc9946 100644 --- a/src/sdk/logsv1.ts +++ b/src/sdk/logsv1.ts @@ -9,6 +9,9 @@ import { unwrapAsync } from "../types/fp.js"; export class LogsV1 extends ClientSDK { /** + * GetLogsForProcess + * + * @remarks * Returns a stream of logs for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. */ async getLogsForProcess( @@ -29,6 +32,9 @@ export class LogsV1 extends ClientSDK { } /** + * DownloadLogForProcess + * + * @remarks * Download entire log file for a stopped process. */ async downloadLogForProcess( diff --git a/src/sdk/managementv1.ts b/src/sdk/managementv1.ts index d41b46c2..79a97853 100644 --- a/src/sdk/managementv1.ts +++ b/src/sdk/managementv1.ts @@ -8,6 +8,9 @@ import * as components from "../models/components/index.js"; import { unwrapAsync } from "../types/fp.js"; export class ManagementV1 extends ClientSDK { + /** + * SendVerificationEmail + */ async sendVerificationEmail( request: components.VerificationEmailRequest, options?: RequestOptions, diff --git a/src/sdk/metricsv1.ts b/src/sdk/metricsv1.ts index 339cd95c..2b467038 100644 --- a/src/sdk/metricsv1.ts +++ b/src/sdk/metricsv1.ts @@ -10,6 +10,9 @@ import { unwrapAsync } from "../types/fp.js"; export class MetricsV1 extends ClientSDK { /** + * GetMetricsDeprecated + * + * @remarks * Get metrics for a [process](https://hathora.dev/docs/concepts/hathora-entities#process) using `appId` and `processId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/organizationsv1.ts b/src/sdk/organizationsv1.ts index 9ba64c87..9f328d85 100644 --- a/src/sdk/organizationsv1.ts +++ b/src/sdk/organizationsv1.ts @@ -16,6 +16,9 @@ import { unwrapAsync } from "../types/fp.js"; export class OrganizationsV1 extends ClientSDK { /** + * GetOrgs + * + * @remarks * Returns an unsorted list of all organizations that you are a member of (an accepted membership invite). An organization is uniquely identified by an `orgId`. */ async getOrgs( @@ -27,6 +30,9 @@ export class OrganizationsV1 extends ClientSDK { )); } + /** + * GetUserPendingInvites + */ async getUserPendingInvites( options?: RequestOptions, ): Promise { @@ -36,6 +42,9 @@ export class OrganizationsV1 extends ClientSDK { )); } + /** + * GetOrgMembers + */ async getOrgMembers( orgId: string, options?: RequestOptions, @@ -47,6 +56,9 @@ export class OrganizationsV1 extends ClientSDK { )); } + /** + * InviteUser + */ async inviteUser( createUserInvite: components.CreateUserInvite, orgId: string, @@ -60,6 +72,9 @@ export class OrganizationsV1 extends ClientSDK { )); } + /** + * RescindInvite + */ async rescindInvite( rescindUserInvite: components.RescindUserInvite, orgId: string, @@ -73,6 +88,9 @@ export class OrganizationsV1 extends ClientSDK { )); } + /** + * GetOrgPendingInvites + */ async getOrgPendingInvites( orgId: string, options?: RequestOptions, @@ -84,6 +102,9 @@ export class OrganizationsV1 extends ClientSDK { )); } + /** + * AcceptInvite + */ async acceptInvite( orgId: string, options?: RequestOptions, @@ -95,6 +116,9 @@ export class OrganizationsV1 extends ClientSDK { )); } + /** + * RejectInvite + */ async rejectInvite( orgId: string, options?: RequestOptions, diff --git a/src/sdk/processesv1.ts b/src/sdk/processesv1.ts index 330f19db..a610150e 100644 --- a/src/sdk/processesv1.ts +++ b/src/sdk/processesv1.ts @@ -11,6 +11,9 @@ import { unwrapAsync } from "../types/fp.js"; export class ProcessesV1 extends ClientSDK { /** + * GetRunningProcesses + * + * @remarks * Retrieve 10 most recently started [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -29,6 +32,9 @@ export class ProcessesV1 extends ClientSDK { } /** + * GetStoppedProcesses + * + * @remarks * Retrieve 10 most recently stopped [process](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `region`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -47,6 +53,9 @@ export class ProcessesV1 extends ClientSDK { } /** + * GetProcessInfoDeprecated + * + * @remarks * Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/processesv2.ts b/src/sdk/processesv2.ts index 9a8774c9..5ee2e985 100644 --- a/src/sdk/processesv2.ts +++ b/src/sdk/processesv2.ts @@ -14,6 +14,9 @@ import { unwrapAsync } from "../types/fp.js"; export class ProcessesV2 extends ClientSDK { /** + * GetProcessInfoV2Deprecated + * + * @remarks * Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -32,6 +35,9 @@ export class ProcessesV2 extends ClientSDK { } /** + * GetLatestProcessesV2Deprecated + * + * @remarks * Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -52,6 +58,9 @@ export class ProcessesV2 extends ClientSDK { } /** + * GetProcessesCountExperimentalV2Deprecated + * + * @remarks * Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -72,6 +81,9 @@ export class ProcessesV2 extends ClientSDK { } /** + * StopProcessV2Deprecated + * + * @remarks * Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -90,6 +102,9 @@ export class ProcessesV2 extends ClientSDK { } /** + * CreateProcessV2Deprecated + * + * @remarks * Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. diff --git a/src/sdk/processesv3.ts b/src/sdk/processesv3.ts index a2dcb58a..d057b4ff 100644 --- a/src/sdk/processesv3.ts +++ b/src/sdk/processesv3.ts @@ -15,6 +15,9 @@ import { unwrapAsync } from "../types/fp.js"; export class ProcessesV3 extends ClientSDK { /** + * GetLatestProcesses + * + * @remarks * Retrieve the 10 most recent [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter the array by optionally passing in a `status` or `region`. */ async getLatestProcesses( @@ -33,6 +36,9 @@ export class ProcessesV3 extends ClientSDK { } /** + * GetProcessesCountExperimental + * + * @remarks * Count the number of [processes](https://hathora.dev/docs/concepts/hathora-entities#process) objects for an [application](https://hathora.dev/docs/concepts/hathora-entities#application). Filter by optionally passing in a `status` or `region`. */ async getProcessesCountExperimental( @@ -51,6 +57,9 @@ export class ProcessesV3 extends ClientSDK { } /** + * CreateProcess + * + * @remarks * Creates a [process](https://hathora.dev/docs/concepts/hathora-entities#process) without a room. Use this to pre-allocate processes ahead of time so that subsequent room assignment via [CreateRoom()](https://hathora.dev/api#tag/RoomV2/operation/CreateRoom) can be instant. */ async createProcess( @@ -67,6 +76,9 @@ export class ProcessesV3 extends ClientSDK { } /** + * GetProcess + * + * @remarks * Get details for a [process](https://hathora.dev/docs/concepts/hathora-entities#process). */ async getProcess( @@ -83,6 +95,9 @@ export class ProcessesV3 extends ClientSDK { } /** + * StopProcess + * + * @remarks * Stops a [process](https://hathora.dev/docs/concepts/hathora-entities#process) immediately. */ async stopProcess( @@ -98,6 +113,9 @@ export class ProcessesV3 extends ClientSDK { )); } + /** + * GetProcessMetrics + */ async getProcessMetrics( request: operations.GetProcessMetricsRequest, options?: RequestOptions, diff --git a/src/sdk/roomsv1.ts b/src/sdk/roomsv1.ts index 2962d9ca..d84aa144 100644 --- a/src/sdk/roomsv1.ts +++ b/src/sdk/roomsv1.ts @@ -15,6 +15,8 @@ import { unwrapAsync } from "../types/fp.js"; export class RoomsV1 extends ClientSDK { /** + * CreateRoomDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async createRoomDeprecated( @@ -33,6 +35,8 @@ export class RoomsV1 extends ClientSDK { } /** + * GetRoomInfoDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async getRoomInfoDeprecated( @@ -49,6 +53,8 @@ export class RoomsV1 extends ClientSDK { } /** + * GetActiveRoomsForProcessDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async getActiveRoomsForProcessDeprecated( @@ -65,6 +71,8 @@ export class RoomsV1 extends ClientSDK { } /** + * GetInactiveRoomsForProcessDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async getInactiveRoomsForProcessDeprecated( @@ -81,6 +89,8 @@ export class RoomsV1 extends ClientSDK { } /** + * DestroyRoomDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async destroyRoomDeprecated( @@ -97,6 +107,8 @@ export class RoomsV1 extends ClientSDK { } /** + * SuspendRoomDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async suspendRoomDeprecated( @@ -113,6 +125,8 @@ export class RoomsV1 extends ClientSDK { } /** + * GetConnectionInfoDeprecated + * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. */ async getConnectionInfoDeprecated( diff --git a/src/sdk/roomsv2.ts b/src/sdk/roomsv2.ts index 46e9b3ab..64e13e76 100644 --- a/src/sdk/roomsv2.ts +++ b/src/sdk/roomsv2.ts @@ -16,6 +16,9 @@ import { unwrapAsync } from "../types/fp.js"; export class RoomsV2 extends ClientSDK { /** + * CreateRoom + * + * @remarks * Create a new [room](https://hathora.dev/docs/concepts/hathora-entities#room) for an existing [application](https://hathora.dev/docs/concepts/hathora-entities#application). Poll the [`GetConnectionInfo()`](https://hathora.dev/api#tag/RoomV2/operation/GetConnectionInfo) endpoint to get connection details for an active room. */ async createRoom( @@ -34,6 +37,9 @@ export class RoomsV2 extends ClientSDK { } /** + * GetRoomInfo + * + * @remarks * Retreive current and historical allocation data for a [room](https://hathora.dev/docs/concepts/hathora-entities#room). */ async getRoomInfo( @@ -50,6 +56,9 @@ export class RoomsV2 extends ClientSDK { } /** + * GetActiveRoomsForProcess + * + * @remarks * Get all active [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). */ async getActiveRoomsForProcess( @@ -66,6 +75,9 @@ export class RoomsV2 extends ClientSDK { } /** + * GetInactiveRoomsForProcess + * + * @remarks * Get all inactive [rooms](https://hathora.dev/docs/concepts/hathora-entities#room) for a given [process](https://hathora.dev/docs/concepts/hathora-entities#process). */ async getInactiveRoomsForProcess( @@ -82,6 +94,9 @@ export class RoomsV2 extends ClientSDK { } /** + * DestroyRoom + * + * @remarks * Destroy a [room](https://hathora.dev/docs/concepts/hathora-entities#room). All associated metadata is deleted. */ async destroyRoom( @@ -98,6 +113,9 @@ export class RoomsV2 extends ClientSDK { } /** + * SuspendRoomV2Deprecated + * + * @remarks * Suspend a [room](https://hathora.dev/docs/concepts/hathora-entities#room). The room is unallocated from the process but can be rescheduled later using the same `roomId`. * * @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible. @@ -116,6 +134,9 @@ export class RoomsV2 extends ClientSDK { } /** + * GetConnectionInfo + * + * @remarks * Poll this endpoint to get connection details to a [room](https://hathora.dev/docs/concepts/hathora-entities#room). Clients can call this endpoint without authentication. */ async getConnectionInfo( @@ -131,6 +152,9 @@ export class RoomsV2 extends ClientSDK { )); } + /** + * UpdateRoomConfig + */ async updateRoomConfig( updateRoomConfigParams: components.UpdateRoomConfigParams, roomId: string, diff --git a/src/sdk/tokensv1.ts b/src/sdk/tokensv1.ts index 3d9249d1..dbcf8109 100644 --- a/src/sdk/tokensv1.ts +++ b/src/sdk/tokensv1.ts @@ -11,6 +11,9 @@ import { unwrapAsync } from "../types/fp.js"; export class TokensV1 extends ClientSDK { /** + * GetOrgTokens + * + * @remarks * List all organization tokens for a given org. */ async getOrgTokens( @@ -25,6 +28,9 @@ export class TokensV1 extends ClientSDK { } /** + * CreateOrgToken + * + * @remarks * Create a new organization token. */ async createOrgToken( @@ -41,6 +47,9 @@ export class TokensV1 extends ClientSDK { } /** + * RevokeOrgToken + * + * @remarks * Revoke an organization token. */ async revokeOrgToken(