@my-swu/simulator-client / AdminResource
Interface: AdminResource
Defined in: packages/ts-sdk/src/resources/admin.ts:56
Simulator administration API methods.
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
console.log(adminResource)Methods
closeRankedMetaWindow()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { closeRankedMetaWindow } = adminResource
console.log(closeRankedMetaWindow)closeRankedMetaWindow(
auth,windowId,options?):Promise<MetaWindowsResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:142
Closes one ranked meta window and returns the updated window list.
Parameters
auth
windowId
string
options?
Returns
Promise<MetaWindowsResponse>
createGameReplayShare()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { createGameReplayShare } = adminResource
console.log(createGameReplayShare)createGameReplayShare(
auth,historyId,options?):Promise<CreateMatchHistoryReplayShareResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:92
Creates or returns the hidden-information replay capability for one completed game.
Parameters
auth
historyId
string
options?
Returns
Promise<CreateMatchHistoryReplayShareResponse>
createRankedMetaWindow()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { createRankedMetaWindow } = adminResource
console.log(createRankedMetaWindow)createRankedMetaWindow(
auth,request,options?):Promise<MetaWindowsResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:136
Creates a ranked meta window, closing any previously open window as needed.
Parameters
auth
request
options?
Returns
Promise<MetaWindowsResponse>
getGameDebugBundle()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { getGameDebugBundle } = adminResource
console.log(getGameDebugBundle)getGameDebugBundle(
auth,historyId,options?):Promise<AdminMatchDebugBundle>
Defined in: packages/ts-sdk/src/resources/admin.ts:64
Returns all durable diagnostics for one match with restore credentials removed.
Parameters
auth
historyId
string
options?
Returns
Promise<AdminMatchDebugBundle>
getGameReplay()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { getGameReplay } = adminResource
console.log(getGameReplay)getGameReplay(
auth,historyId,options?):Promise<AdminMatchReplayResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:70
Returns a completed replay archive for one match.
Parameters
auth
historyId
string
options?
Returns
Promise<AdminMatchReplayResponse>
getMatchDebugBundle()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { getMatchDebugBundle } = adminResource
console.log(getMatchDebugBundle)getMatchDebugBundle(
auth,matchId,options?):Promise<AdminMatchDebugBundle>
Defined in: packages/ts-sdk/src/resources/admin.ts:80
Returns all diagnostics for one match by runtime match id, including a match that is still in progress (the live runtime is exported first, the durable row serves once the runtime is gone).
Parameters
auth
matchId
string
options?
Returns
Promise<AdminMatchDebugBundle>
getMatchReplay()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { getMatchReplay } = adminResource
console.log(getMatchReplay)getMatchReplay(
auth,matchId,options?):Promise<AdminMatchReplayResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:86
Returns the replay archive for one match by runtime match id, live matches included.
Parameters
auth
matchId
string
options?
Returns
Promise<AdminMatchReplayResponse>
getSimulatorReport()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { getSimulatorReport } = adminResource
console.log(getSimulatorReport)getSimulatorReport(
auth,reportId,options?):Promise<SimulatorReportResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:104
Returns one full sanitized simulator support bundle.
Parameters
auth
reportId
string
options?
Returns
Promise<SimulatorReportResponse>
listGames()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { listGames } = adminResource
console.log(listGames)listGames(
auth,query?,options?):Promise<AdminMatchListResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:58
Lists durable saved and completed matches for simulator support work.
Parameters
auth
query?
AdminGameListOptions
options?
Returns
Promise<AdminMatchListResponse>
listRankedMetaWindows()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { listRankedMetaWindows } = adminResource
console.log(listRankedMetaWindows)listRankedMetaWindows(
auth,options?):Promise<MetaWindowsResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:148
Lists every ranked meta window and identifies the currently active window.
Parameters
auth
options?
Returns
Promise<MetaWindowsResponse>
listSimulatorReports()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { listSimulatorReports } = adminResource
console.log(listSimulatorReports)listSimulatorReports(
auth,query?,options?):Promise<SimulatorReportListResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:98
Lists safe metadata for retained simulator diagnostic reports.
Parameters
auth
query?
SimulatorReportListOptions
options?
Returns
Promise<SimulatorReportListResponse>
matchChatMessage()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { matchChatMessage } = adminResource
console.log(matchChatMessage)matchChatMessage(
auth,matchId,messageId,options?):Promise<MatchChatLookupResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:158
Returns the server's own record of one match chat message.
Moderation reports carry a reporter-supplied copy of the message; this is how a caller replaces that copy with what the match actually broadcast.
Parameters
auth
matchId
string
messageId
string
options?
Returns
Promise<MatchChatLookupResponse>
rankedLeaderboard()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { rankedLeaderboard } = adminResource
console.log(rankedLeaderboard)rankedLeaderboard(
auth,windowId,query?,options?):Promise<RankedLeaderboardResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:171
Returns one paginated, placement-complete internal leaderboard page.
Parameters
auth
windowId
string
query?
options?
Returns
Promise<RankedLeaderboardResponse>
rankedProfile()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { rankedProfile } = adminResource
console.log(rankedProfile)rankedProfile(
auth,request,options?):Promise<RankedProfileResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:165
Returns one account's placement-safe internal ranked profile.
Parameters
auth
request
options?
Returns
Promise<RankedProfileResponse>
refreshCardCatalog()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { refreshCardCatalog } = adminResource
console.log(refreshCardCatalog)refreshCardCatalog(
auth,options?):Promise<CardCatalogRefreshResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:110
Refreshes expansion legality metadata across simulator replicas.
Parameters
auth
options?
Returns
Promise<CardCatalogRefreshResponse>
setMaintenance()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { setMaintenance } = adminResource
console.log(setMaintenance)setMaintenance(
auth,request,options?):Promise<SimulatorAdminStatusResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:124
Enables or disables simulator maintenance/drain mode.
Parameters
auth
request
SetSimulatorMaintenanceRequest
options?
Returns
Promise<SimulatorAdminStatusResponse>
setRankedAdmission()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { setRankedAdmission } = adminResource
console.log(setRankedAdmission)setRankedAdmission(
auth,request,options?):Promise<SimulatorAdminStatusResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:130
Enables or pauses new ranked matchmaking admissions without hiding ranked reads.
Parameters
auth
request
options?
Returns
Promise<SimulatorAdminStatusResponse>
status()
Example:
import { createSimulatorClient } from '@my-swu/simulator-client'
// Point this at the simulator HTTP origin for /health and /api routes.
const simulatorClient = createSimulatorClient({
baseUrl: 'http://127.0.0.1:4000',
})
const adminResource = simulatorClient.admin
const { status: healthStatus } = adminResource
console.log(healthStatus)status(
auth,options?):Promise<SimulatorAdminStatusResponse>
Defined in: packages/ts-sdk/src/resources/admin.ts:117
Returns live simulator operational status and counters.
Parameters
auth
options?
Returns
Promise<SimulatorAdminStatusResponse>