SoulFireAdmin
Public TypeScript members of SoulFireAdmin.
Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.
Compose Effect operations with yield* inside a scoped workflow. Properties expose sub-clients and state.
clientData
clientData(
options?: CallOptions,
): Effect.Effect<ClientDataResponse, SoulFireOperationError>generateWebDavToken
generateWebDavToken(
options?: CallOptions,
): Effect.Effect<string, SoulFireOperationError>generateApiToken
generateApiToken(
options?: CallOptions,
): Effect.Effect<string, SoulFireOperationError>updateUsername
updateUsername(
username: string,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>updateEmail
updateEmail(
email: string,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>invalidateOwnSessions
invalidateOwnSessions(
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>serverInfo
serverInfo(
options?: CallOptions,
): Effect.Effect<ServerInfoResponse, SoulFireOperationError>updateServerConfig
updateServerConfig(
config: ServerConfig,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>setServerConfigEntry
setServerConfigEntry(
request: Input<typeof ServerUpdateConfigEntryRequestSchema>,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>users
users(
options?: CallOptions,
): Effect.Effect<UserListResponse_User[], SoulFireOperationError>user
user(
userId: string,
options?: CallOptions,
): Effect.Effect<UserInfoResponse, SoulFireOperationError>createUser
createUser(
request: Input<typeof UserCreateRequestSchema>,
options?: CallOptions,
): Effect.Effect<string, SoulFireOperationError>deleteUser
deleteUser(
userId: string,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>updateUser
updateUser(
request: Input<typeof UpdateUserRequestSchema>,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>invalidateUserSessions
invalidateUserSessions(
userId: string,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>generateUserApiToken
generateUserApiToken(
userId: string,
options?: CallOptions,
): Effect.Effect<string, SoulFireOperationError>userPluginPermissionGrants
userPluginPermissionGrants(
userId: string,
options?: CallOptions,
): Effect.Effect<UserPluginPermissionGrant[], SoulFireOperationError>setUserPluginPermissionGrant
setUserPluginPermissionGrant(
userId: string,
request: UserInput<typeof SetUserPluginPermissionGrantRequestSchema>,
options?: CallOptions,
): Effect.Effect<UserPluginPermissionGrant, SoulFireOperationError>deleteUserPluginPermissionGrant
deleteUserPluginPermissionGrant(
userId: string,
request: UserInput<typeof DeleteUserPluginPermissionGrantRequestSchema>,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>previousLogs
previousLogs(
request: Input<typeof PreviousLogRequestSchema>,
options?: CallOptions,
): Effect.Effect<LogString[], SoulFireOperationError>logs
logs(
request: Input<typeof LogRequestSchema>,
options?: CallOptions,
): Stream.Stream<LogResponse, SoulFireOperationError>serverMetrics
serverMetrics(
since?: Timestamp,
options?: CallOptions,
): Effect.Effect<GetServerMetricsResponse, SoulFireOperationError>instanceMetrics
instanceMetrics(
instanceId: string,
since?: Timestamp,
options?: CallOptions,
): Effect.Effect<GetInstanceMetricsResponse, SoulFireOperationError>executeCommand
executeCommand(
request: Input<typeof CommandRequestSchema>,
options?: CallOptions,
): Effect.Effect<CommandResponse, SoulFireOperationError>completeCommand
completeCommand(
request: Input<typeof CommandCompletionRequestSchema>,
options?: CallOptions,
): Effect.Effect<CommandCompletionResponse, SoulFireOperationError>download
download(
request: Input<typeof DownloadRequestSchema>,
options?: CallOptions,
): Effect.Effect<DownloadResponse, SoulFireOperationError>pluginStats
pluginStats(
instanceId: string,
options?: CallOptions,
): Effect.Effect<PluginRuntimeStat[], SoulFireOperationError>auditLog
auditLog(
instanceId: string,
options?: CallOptions,
): Effect.Effect<
InstanceAuditLogResponse_AuditLogEntry[],
SoulFireOperationError
>scripts
scripts(
instanceId: string,
options?: CallOptions,
): Effect.Effect<ScriptInfo[], SoulFireOperationError>script
script(
instanceId: string,
scriptId: string,
options?: CallOptions,
): Effect.Effect<GetScriptResponse, SoulFireOperationError>createScript
createScript(
instanceId: string,
request: InstanceInput<typeof CreateScriptRequestSchema>,
options?: CallOptions,
): Effect.Effect<CreateScriptResponse, SoulFireOperationError>updateScript
updateScript(
instanceId: string,
request: InstanceInput<typeof UpdateScriptRequestSchema>,
options?: CallOptions,
): Effect.Effect<UpdateScriptResponse, SoulFireOperationError>deleteScript
deleteScript(
instanceId: string,
scriptId: string,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>activateScript
activateScript(
instanceId: string,
request: InstanceInput<typeof ActivateScriptRequestSchema>,
options?: CallOptions,
): Stream.Stream<ScriptEvent, SoulFireOperationError>deactivateScript
deactivateScript(
instanceId: string,
scriptId: string,
options?: CallOptions,
): Effect.Effect<void, SoulFireOperationError>scriptStatus
scriptStatus(
instanceId: string,
scriptId: string,
options?: CallOptions,
): Effect.Effect<GetScriptStatusResponse, SoulFireOperationError>scriptLogs
scriptLogs(
instanceId: string,
request: InstanceInput<typeof SubscribeScriptLogsRequestSchema>,
options?: CallOptions,
): Stream.Stream<ScriptLogEntry, SoulFireOperationError>nodeTypes
nodeTypes(
request: Input<typeof GetNodeTypesRequestSchema> = {},
options?: CallOptions,
): Effect.Effect<GetNodeTypesResponse, SoulFireOperationError>scriptRegistryData
scriptRegistryData(
request: Input<typeof GetRegistryDataRequestSchema> = {},
options?: CallOptions,
): Effect.Effect<GetRegistryDataResponse, SoulFireOperationError>validateScript
validateScript(
instanceId: string,
request: InstanceInput<typeof ValidateScriptRequestSchema>,
options?: CallOptions,
): Effect.Effect<ValidateScriptResponse, SoulFireOperationError>dryRunScript
dryRunScript(
instanceId: string,
request: InstanceInput<typeof DryRunScriptRequestSchema>,
options?: CallOptions,
): Stream.Stream<ScriptEvent, SoulFireOperationError>How is this page?
Last updated on