@rebornteam/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @rebornteam/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to https://api.smsh.sh

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AdminAuditLogApi | search | GET /admin/audit-log | Search the admin audit log AdminAuditLogApi | searchCursor | GET /admin/audit-log/cursor | Cursor-paginated audit-log search (infinite scroll) AdminClientCredentialsApi | disableClient | POST /admin/client/{id}/disable | Disable client credentials AdminClientCredentialsApi | enableClient | POST /admin/client/{id}/enable | Enable client credentials AdminClientCredentialsApi | generateClientCredentials | POST /admin/client/generate | Generate new client credentials AdminClientCredentialsApi | listClients | GET /admin/client | List client credentials AdminClientCredentialsApi | revokeToken | DELETE /admin/client/{id} | Revoke client credentials AdminClientCredentialsApi | rotateToken | POST /admin/client/{id}/rotate | Rotate client credentials AdminClientCredentialsApi | updateClient | PUT /admin/client/{id} | Update client metadata AdminConnectionsApi | backfillLocation | POST /admin/connection/backfill-location | Start a location backfill job AdminConnectionsApi | createBypass | POST /admin/connection/bypass | Create connection bypass AdminConnectionsApi | getConnection | GET /admin/connection/{id} | Get connection detail AdminConnectionsApi | getConnectionPlayers | GET /admin/connection/{id}/players | List players who have used this connection AdminConnectionsApi | listAllConnections | GET /admin/connection | List all connections (paginated) AdminConnectionsApi | listConnections | GET /admin/connection/recent | List recent connections AdminConnectionsApi | recheckService | POST /admin/connection/{connectionId}/recheck/{service} | Refresh a single VPN check AdminDashboardApi | dashboardStats | GET /admin/dashboard | Get dashboard statistics AdminJobsApi | cancel | DELETE /admin/job/{id} | Request cancellation of an async job AdminJobsApi | downloadArtifact | GET /admin/job/{id}/artifact.csv | Download a job's CSV artifact AdminJobsApi | get | GET /admin/job/{id} | Get one async job AdminJobsApi | list | GET /admin/job | List async jobs AdminPlayersApi | addAltExemption | POST /admin/player/{uuid}/alt-exemption | Add an alt exemption AdminPlayersApi | backfillUsernames | POST /admin/player/backfill-usernames | Start a username backfill job AdminPlayersApi | bulkRevokePropagated | POST /admin/player/player-punishment/bulk-revoke | Bulk-revoke PROPAGATED links by source AdminPlayersApi | createPlayerNote | POST /admin/player/{uuid}/note | Create a staff note on a player AdminPlayersApi | deletePlayerNote | DELETE /admin/player/{uuid}/note/{noteId} | Soft-delete a staff note AdminPlayersApi | getAltGraph | GET /admin/player/{uuid}/alt-graph | Alt-graph traversal rooted at a player AdminPlayersApi | getPlayer | GET /admin/player/{uuid} | Get player detail AdminPlayersApi | getPlayerAlts | GET /admin/player/{uuid}/alts | List a player's alt accounts AdminPlayersApi | getPlayerConnections | GET /admin/player/{uuid}/connections | List a player's connection history AdminPlayersApi | getPlayerPunishments | GET /admin/player/{uuid}/player-punishments | List a player's full punishment history AdminPlayersApi | getSessionStats | GET /admin/player/{uuid}/session-stats | Get a player's aggregate session stats AdminPlayersApi | listAltExemptions | GET /admin/player/{uuid}/alt-exemption | List a player's alt exemptions AdminPlayersApi | listPlayerNotes | GET /admin/player/{uuid}/notes | List staff notes on a player AdminPlayersApi | listPlayers | GET /admin/player | List players AdminPlayersApi | listSessions | GET /admin/player/{uuid}/sessions | List a player's session history AdminPlayersApi | removeAltExemption | DELETE /admin/player/{uuid}/alt-exemption/{altPlayerUuid} | Remove an alt exemption AdminPlayersApi | revokePropagatedLink | DELETE /admin/player/{uuid}/player-punishment/{playerPunishmentId} | Revoke a propagated punishment link AdminPlayersApi | setAggressiveModeImmunity | PATCH /admin/player/{uuid}/aggressive-mode-immunity | Toggle aggressive-mode immunity AdminPlayersApi | trustFactorBreakdown | GET /admin/player/{uuid}/trust-factor-breakdown | Trust factor breakdown for a player AdminPlayersApi | trustFactorHistory | GET /admin/player/{uuid}/trust-factor-history | Trust factor history for a player AdminPlayersApi | trustFactorRecompute | POST /admin/player/trust-factor-recompute | Start a trust-factor recompute job AdminPunishmentsApi | applyPunishment | POST /admin/punishment/apply | Apply punishment AdminPunishmentsApi | createDraft | POST /admin/punishment/draft | Evaluate punishment impact AdminPunishmentsApi | editPunishment | PATCH /admin/punishment/{id} | Edit a punishment AdminPunishmentsApi | getPunishmentTargets | GET /admin/punishment/{id}/targets | List a punishment's current participants AdminPunishmentsApi | getPunishments | GET /admin/punishment | List punishments AdminPunishmentsApi | propagationSweep | POST /admin/punishment/propagation-sweep | Start an alt-propagation sweep job AdminPunishmentsApi | searchTargets | GET /admin/punishment/search | Search punishment targets AdminReportsApi | list1 | GET /admin/report | List reports AdminReportsApi | resolve | POST /admin/report/{id}/resolve | Resolve a report AuthenticationApi | callback | GET /auth/discord/callback | Discord - OAuth2 callback AuthenticationApi | initiateLogin | GET /auth/discord | Discord - Initiate login AuthenticationApi | me | GET /auth/me | Get current user profile AuthenticationApi | token | POST /oauth/token | Service - Exchange client credentials for token ChatApi | history | GET /v1/chat | Get chat history ChatApi | ingest | POST /v1/chat | Ingest a chat message ConnectionApi | getConnectionDetails | GET /v1/connection/get-connection-details/{ip} | Check Connection and Detect VPN/Proxy (DEPRECATED for player-join use) PlayerApi | getPlayer1 | GET /v1/player/{uuid} | Get player information PlayerApi | getUsernames | GET /v1/player/usernames | Batch resolve UUIDs to usernames PlayerSessionsApi | end | POST /v1/player-session/end | Close the active player session PlayerSessionsApi | start | POST /v1/player-session/start | Player join — unified authorization + session-open PunishmentApi | getPunishmentSeverities | GET /v1/punishment/severities | Get punishment severities PunishmentApi | getPunishments1 | GET /v1/punishment | Get punishments by player PunishmentApi | getPunishmentsByIp | GET /v1/punishment/ip | Get punishments by IP address PunishmentApi | getRecentPunishments | GET /v1/punishment/recent | List recent punishments ReportApi | submit | POST /v1/report | Submit a peer report ServerSessionsApi | heartbeat | PUT /v1/servers/{id}/heartbeat | Send a heartbeat ServerSessionsApi | listAll | GET /v1/servers/history | List all server sessions ServerSessionsApi | listOnline | GET /v1/servers | List online server sessions ServerSessionsApi | markOffline | PUT /v1/servers/{id}/offline | Mark a session offline ServerSessionsApi | register | POST /v1/servers | Register a server session

Documentation For Models

• AdminAltAccount
• AdminAltExemption
• AdminAltGraph
• AdminAltGraphEdge
• AdminAltGraphNode
• AdminApplyPunishmentRequest
• AdminApplyPunishmentResponse
• AdminApplyPunishmentResult
• AdminAsyncJob
• AdminAsyncJobArtifactMeta
• AdminAsyncJobStartResponse
• AdminAuditLogEntry
• AdminBulkRevokeRequest
• AdminBulkRevokeResponse
• AdminClientCredentialResponse
• AdminConnectionBypassResponse
• AdminConnectionCheckResult
• AdminCreateAltExemptionRequest
• AdminCreatePlayerNoteRequest
• AdminCreatePunishmentDraftRequest
• AdminDashboardConnectionResponse
• AdminGetDashboardStats
• AdminIpSearchResult
• AdminPlayerDetailResponse
• AdminPlayerNote
• AdminPlayerPunishmentResponse
• AdminPlayerReport
• AdminPlayerSearchResult
• AdminPlayerSession
• AdminPlayerSessionStats
• AdminPlayerSummary
• AdminPunishmentDraftResponse
• AdminPunishmentEvaluation
• AdminPunishmentListItem
• AdminPunishmentSearchResponse
• AdminPunishmentTarget
• AdminPunishmentTargets
• AdminReportTarget
• AdminResolveReportRequest
• AdminSetAggressiveModeImmunityRequest
• AdminTrustFactorBreakdown
• AdminTrustFactorHistoryEntry
• AdminTrustFactorImpact
• AdminUpdatePunishmentRequest
• AdminUsernameHistoryEntry
• ChatMessageDTO
• ChatMessageRequest
• ClientCredentialRequest
• ConnectionGetConnectionDetailsResponse
• ConnectionResult
• ConnectionResultResultCode
• CreateBypassRequest
• CreateReportRequest
• CreateReportResponse
• CursoredPageAdminAuditLogEntry
• CursoredPageable
• GameType
• JobStatus
• PageAdminAltAccount
• PageAdminAltExemption
• PageAdminAsyncJob
• PageAdminAuditLogEntry
• PageAdminDashboardConnectionResponse
• PageAdminPlayerNote
• PageAdminPlayerPunishmentResponse
• PageAdminPlayerReport
• PageAdminPlayerSession
• PageAdminPlayerSummary
• PageAdminPunishmentListItem
• PagePunishmentGetPunishmentResponse
• Pageable
• PageableMode
• PlayerGetPlayerInformation
• PlayerSessionEndRequest
• PlayerSessionEndResponse
• PlayerSessionStartRequest
• PlayerSessionStartResponse
• PunishmentGetPunishmentResponse
• PunishmentSeveritiesResponse
• PunishmentSeveritiesResponsePunishmentTypeInfo
• PunishmentSeveritiesResponseSeverityInfo
• PunishmentSource
• PunishmentTargetType
• PunishmentType
• Rank
• Region
• ReportCategory
• SearchKind
• ServerHeartbeatRequest
• ServerRegisterRequest
• ServerSessionDTO
• SliceAdminAltAccount
• SliceAdminAltExemption
• SliceAdminAsyncJob
• SliceAdminAuditLogEntry
• SliceAdminDashboardConnectionResponse
• SliceAdminPlayerNote
• SliceAdminPlayerPunishmentResponse
• SliceAdminPlayerReport
• SliceAdminPlayerSession
• SliceAdminPlayerSummary
• SliceAdminPunishmentListItem
• SlicePunishmentGetPunishmentResponse
• Sort
• SortOrder
• SortOrderDirection
• TokenRequest
• UpdateClientRequest
• UserProfileResponse

Documentation For Authorization

Authentication schemes defined for the API:

DiscordAuth

• Type: Bearer authentication (JWT)