ApplicationResponseData
An application, as returned bygetApplications, updateApplication, startApplication, stopApplication and restartApplication, and available in Application.data.
teamIdis only a string (ornull) in the application list and in the result ofcreateApplication. IngetApplication,updateApplication,startApplication,stopApplicationandrestartApplicationthe API returns the whole team object for team applications.currentResourceMetricsis not returned when an application is created, so it isundefinedin thedataof the instance returned bycreateApplication.internalPort,externalPortandassignedSubdomaincan be missing (undefined) instead ofnullwhen the application is not exposed via web.statuscan also be"error"after a failed rebuild.- The API returns more fields than the type declares, such as
mainFile,environmentVariables,assignedCustomDomain,repository,githubDeploysandcurrentResourceMetrics.startedAt. They are present at runtime, but TypeScript does not know about them.
CreateApplicationDataParams
The argument ofcreateApplication.
runtimeEnvironmentdoes not include"bun", which the API accepts.mainFileis required by the SDK, while the API also accepts astartupCommandwithout amainFile.- There is no
portnorassignedSubdomain, which the API requires whenexposedViaWebistrue. teamIdis sent to the API asteam.
UpdateApplicationDataParams
The argument ofupdateApplication. Application.update takes the same object without appId.
- Every field of the API is optional, but the SDK requires
appName,memoryMBandruntimeEnvironment(and the type also requiresstartupCommand). teamIdis ignored by the SDK. The API has no field to move an application to another team.runtimeEnvironmentdoes not include"bun".- There is no
port,assignedSubdomainnorassignedCustomDomain.
UserData
The result ofgetMe.
activeSessionsis declared as a tuple with exactly one session, but the API returns an array with any number of sessions (including none).currentSubscription.statusis"active","pending_cleanup"or"grace_period"in the API."suspended"is never returned.currentSubscription.planReference.enabledis a boolean in the API, not a string.
TeamResponseData
The result ofgetTeam, and the item type of getTeams.
applicationsCountis only returned bygetTeams. It isundefinedin the result ofgetTeam.- The API also returns the permissions
canManageApplicationBackup,canCreateDatabase,canDeleteDatabase,canUpdateDatabaseSettingsandcanChangeStatusDatabase. - The API returns more fields than the type declares, such as
databaseInstancesCount(ingetTeams), the owner’scurrentSubscription(ingetTeam) and theuserId,invitedAt,codeandsubscriptionEndsAtof each invite.