Class SoulFireAdmin

High-level access to SoulFire's administrative control plane.

Generated service clients remain available through soulfire.service() for new or uncommon fields.

Constructors

constructor

new SoulFireAdmin(transport: Transport): SoulFireAdmin
Parameters
- transport: Transport
Returns SoulFireAdmin
- Defined in sdk/typescript/src/admin.ts:109

Methods

activateScript

activateScript(
    instanceId: string,
    request: InstanceInput<typeof ActivateScriptRequestSchema>,
    options?: CallOptions,
): Stream<ScriptEvent, SoulFireOperationError>
Parameters
- instanceId: string
- request: InstanceInput<typeof ActivateScriptRequestSchema>
- Optionaloptions: CallOptions
Returns Stream<ScriptEvent, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:525

auditLog

auditLog(
instanceId: string,
options?: CallOptions,
): Effect<InstanceAuditLogResponse_AuditLogEntry[], SoulFireOperationError>
Parameters
- instanceId: string
- Optionaloptions: CallOptions
Returns Effect<InstanceAuditLogResponse_AuditLogEntry[], SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:442

clientData

clientData(
options?: CallOptions,
): Effect<ClientDataResponse, SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Effect<ClientDataResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:122

completeCommand

completeCommand(
request: Input<typeof CommandCompletionRequestSchema>,
options?: CallOptions,
): Effect<CommandCompletionResponse, SoulFireOperationError>
Parameters
- request: Input<typeof CommandCompletionRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<CommandCompletionResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:410

createScript

createScript(
    instanceId: string,
    request: InstanceInput<typeof CreateScriptRequestSchema>,
    options?: CallOptions,
): Effect<CreateScriptResponse, SoulFireOperationError>
Parameters
- instanceId: string
- request: InstanceInput<typeof CreateScriptRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<CreateScriptResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:483

createUser

createUser(
request: Input<typeof UserCreateRequestSchema>,
options?: CallOptions,
): Effect<string, SoulFireOperationError>
Parameters
- request: Input<typeof UserCreateRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<string, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:245

deactivateScript

deactivateScript(
    instanceId: string,
    scriptId: string,
    options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- instanceId: string
- scriptId: string
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:542

deleteScript

deleteScript(
    instanceId: string,
    scriptId: string,
    options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- instanceId: string
- scriptId: string
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:509

deleteUser

deleteUser(
userId: string,
options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- userId: string
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:256

deleteUserPluginPermissionGrant

deleteUserPluginPermissionGrant(
    userId: string,
    request: UserInput<typeof DeleteUserPluginPermissionGrantRequestSchema>,
    options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- userId: string
- request: UserInput<typeof DeleteUserPluginPermissionGrantRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:336

download

download(
request: Input<typeof DownloadRequestSchema>,
options?: CallOptions,
): Effect<DownloadResponse, SoulFireOperationError>
Parameters
- request: Input<typeof DownloadRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<DownloadResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:419

dryRunScript

dryRunScript(
    instanceId: string,
    request: InstanceInput<typeof DryRunScriptRequestSchema>,
    options?: CallOptions,
): Stream<ScriptEvent, SoulFireOperationError>
Parameters
- instanceId: string
- request: InstanceInput<typeof DryRunScriptRequestSchema>
- Optionaloptions: CallOptions
Returns Stream<ScriptEvent, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:619

executeCommand

executeCommand(
request: Input<typeof CommandRequestSchema>,
options?: CallOptions,
): Effect<CommandResponse, SoulFireOperationError>
Parameters
- request: Input<typeof CommandRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<CommandResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:401

generateApiToken

generateApiToken(options?: CallOptions): Effect<string, SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Effect<string, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:140

generateUserApiToken

generateUserApiToken(
userId: string,
options?: CallOptions,
): Effect<string, SoulFireOperationError>
Parameters
- userId: string
- Optionaloptions: CallOptions
Returns Effect<string, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:295

generateWebDavToken

generateWebDavToken(
options?: CallOptions,
): Effect<string, SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Effect<string, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:130

instanceMetrics

instanceMetrics(
    instanceId: string,
    since?: Timestamp,
    options?: CallOptions,
): Effect<GetInstanceMetricsResponse, SoulFireOperationError>
Parameters
- instanceId: string
- Optionalsince: Timestamp
- Optionaloptions: CallOptions
Returns Effect<GetInstanceMetricsResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:388

invalidateOwnSessions

invalidateOwnSessions(
options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:177

invalidateUserSessions

invalidateUserSessions(
userId: string,
options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- userId: string
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:280

logs

logs(
request: Input<typeof LogRequestSchema>,
options?: CallOptions,
): Stream<LogResponse, SoulFireOperationError>
Parameters
- request: Input<typeof LogRequestSchema>
- Optionaloptions: CallOptions
Returns Stream<LogResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:363

nodeTypes

nodeTypes(
request?: Input<typeof GetNodeTypesRequestSchema>,
options?: CallOptions,
): Effect<GetNodeTypesResponse, SoulFireOperationError>
Parameters
- request: Input<typeof GetNodeTypesRequestSchema> = {}
- Optionaloptions: CallOptions
Returns Effect<GetNodeTypesResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:588

pluginStats

pluginStats(
instanceId: string,
options?: CallOptions,
): Effect<PluginRuntimeStat[], SoulFireOperationError>
Parameters
- instanceId: string
- Optionaloptions: CallOptions
Returns Effect<PluginRuntimeStat[], SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:428

previousLogs

previousLogs(
request: Input<typeof PreviousLogRequestSchema>,
options?: CallOptions,
): Effect<LogString[], SoulFireOperationError>
Parameters
- request: Input<typeof PreviousLogRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<LogString[], SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:352

script

script(
    instanceId: string,
    scriptId: string,
    options?: CallOptions,
): Effect<GetScriptResponse, SoulFireOperationError>
Parameters
- instanceId: string
- scriptId: string
- Optionaloptions: CallOptions
Returns Effect<GetScriptResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:470

scriptLogs

scriptLogs(
    instanceId: string,
    request: InstanceInput<typeof SubscribeScriptLogsRequestSchema>,
    options?: CallOptions,
): Stream<ScriptLogEntry, SoulFireOperationError>
Parameters
- instanceId: string
- request: InstanceInput<typeof SubscribeScriptLogsRequestSchema>
- Optionaloptions: CallOptions
Returns Stream<ScriptLogEntry, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:571

scriptRegistryData

scriptRegistryData(
request?: Input<typeof GetRegistryDataRequestSchema>,
options?: CallOptions,
): Effect<GetRegistryDataResponse, SoulFireOperationError>
Parameters
- request: Input<typeof GetRegistryDataRequestSchema> = {}
- Optionaloptions: CallOptions
Returns Effect<GetRegistryDataResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:597

scripts

scripts(
instanceId: string,
options?: CallOptions,
): Effect<ScriptInfo[], SoulFireOperationError>
Parameters
- instanceId: string
- Optionaloptions: CallOptions
Returns Effect<ScriptInfo[], SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:459

scriptStatus

scriptStatus(
    instanceId: string,
    scriptId: string,
    options?: CallOptions,
): Effect<GetScriptStatusResponse, SoulFireOperationError>
Parameters
- instanceId: string
- scriptId: string
- Optionaloptions: CallOptions
Returns Effect<GetScriptStatusResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:558

serverInfo

serverInfo(
options?: CallOptions,
): Effect<ServerInfoResponse, SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Effect<ServerInfoResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:188

serverMetrics

serverMetrics(
since?: Timestamp,
options?: CallOptions,
): Effect<GetServerMetricsResponse, SoulFireOperationError>
Parameters
- Optionalsince: Timestamp
- Optionaloptions: CallOptions
Returns Effect<GetServerMetricsResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:376

setServerConfigEntry

setServerConfigEntry(
request: Input<typeof ServerUpdateConfigEntryRequestSchema>,
options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- request: Input<typeof ServerUpdateConfigEntryRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:211

setUserPluginPermissionGrant

setUserPluginPermissionGrant(
    userId: string,
    request: UserInput<typeof SetUserPluginPermissionGrantRequestSchema>,
    options?: CallOptions,
): Effect<UserPluginPermissionGrant, SoulFireOperationError>
Parameters
- userId: string
- request: UserInput<typeof SetUserPluginPermissionGrantRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<UserPluginPermissionGrant, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:323

updateEmail

updateEmail(
email: string,
options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- email: string
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:165

updateScript

updateScript(
    instanceId: string,
    request: InstanceInput<typeof UpdateScriptRequestSchema>,
    options?: CallOptions,
): Effect<UpdateScriptResponse, SoulFireOperationError>
Parameters
- instanceId: string
- request: InstanceInput<typeof UpdateScriptRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<UpdateScriptResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:496

updateServerConfig

updateServerConfig(
config: ServerConfig,
options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- config: ServerConfig
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:196

updateUser

updateUser(
request: Input<typeof UpdateUserRequestSchema>,
options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- request: Input<typeof UpdateUserRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:268

updateUsername

updateUsername(
username: string,
options?: CallOptions,
): Effect<void, SoulFireOperationError>
Parameters
- username: string
- Optionaloptions: CallOptions
Returns Effect<void, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:150

user

user(
userId: string,
options?: CallOptions,
): Effect<UserInfoResponse, SoulFireOperationError>
Parameters
- userId: string
- Optionaloptions: CallOptions
Returns Effect<UserInfoResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:236

userPluginPermissionGrants

userPluginPermissionGrants(
userId: string,
options?: CallOptions,
): Effect<UserPluginPermissionGrant[], SoulFireOperationError>
Parameters
- userId: string
- Optionaloptions: CallOptions
Returns Effect<UserPluginPermissionGrant[], SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:309

users

users(
options?: CallOptions,
): Effect<UserListResponse_User[], SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Effect<UserListResponse_User[], SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:226

validateScript

validateScript(
    instanceId: string,
    request: InstanceInput<typeof ValidateScriptRequestSchema>,
    options?: CallOptions,
): Effect<ValidateScriptResponse, SoulFireOperationError>
Parameters
- instanceId: string
- request: InstanceInput<typeof ValidateScriptRequestSchema>
- Optionaloptions: CallOptions
Returns Effect<ValidateScriptResponse, SoulFireOperationError>
- Defined in sdk/typescript/src/admin.ts:606

Class SoulFireAdmin

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SoulFireAdmin

Methods

activateScript

Parameters

Returns Stream<ScriptEvent, SoulFireOperationError>

auditLog

Parameters

Returns Effect<InstanceAuditLogResponse_AuditLogEntry[], SoulFireOperationError>

clientData

Parameters

Returns Effect<ClientDataResponse, SoulFireOperationError>

completeCommand

Parameters

Returns Effect<CommandCompletionResponse, SoulFireOperationError>

createScript

Parameters

Returns Effect<CreateScriptResponse, SoulFireOperationError>

createUser

Parameters

Returns Effect<string, SoulFireOperationError>

deactivateScript

Parameters

Returns Effect<void, SoulFireOperationError>

deleteScript

Parameters

Returns Effect<void, SoulFireOperationError>

deleteUser

Parameters

Returns Effect<void, SoulFireOperationError>

deleteUserPluginPermissionGrant

Parameters

Returns Effect<void, SoulFireOperationError>

download

Parameters

Returns Effect<DownloadResponse, SoulFireOperationError>

dryRunScript

Parameters

Returns Stream<ScriptEvent, SoulFireOperationError>

executeCommand

Parameters

Returns Effect<CommandResponse, SoulFireOperationError>

generateApiToken

Parameters

Returns Effect<string, SoulFireOperationError>

generateUserApiToken

Parameters

Returns Effect<string, SoulFireOperationError>

generateWebDavToken

Parameters

Returns Effect<string, SoulFireOperationError>

instanceMetrics

Parameters

Returns Effect<GetInstanceMetricsResponse, SoulFireOperationError>

invalidateOwnSessions

Parameters

Returns Effect<void, SoulFireOperationError>

invalidateUserSessions

Parameters

Returns Effect<void, SoulFireOperationError>

logs

Parameters

Returns Stream<LogResponse, SoulFireOperationError>

nodeTypes

Parameters

Returns Effect<GetNodeTypesResponse, SoulFireOperationError>

pluginStats

Parameters

Returns Effect<PluginRuntimeStat[], SoulFireOperationError>

previousLogs

Parameters

Returns Effect<LogString[], SoulFireOperationError>

script

Parameters