SoulFireAdmin
Public Python members of SoulFireAdmin.
Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.
Methods decorated with @fn return effects. Their implementation signatures use EffectGen for the generator body. Compose them with yield from inside a scoped workflow.
client_data
@fn("SoulFireAdmin.client_data")
def client_data(
self, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[ClientDataResponse, SoulFireOperationError]generate_webdav_token
@fn("SoulFireAdmin.generate_webdav_token")
def generate_webdav_token(
self, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[str, SoulFireOperationError]generate_api_token
@fn("SoulFireAdmin.generate_api_token")
def generate_api_token(
self, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[str, SoulFireOperationError]update_username
@fn("SoulFireAdmin.update_username")
def update_username(
self, username: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[None, SoulFireOperationError]update_email
@fn("SoulFireAdmin.update_email")
def update_email(
self, email: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[None, SoulFireOperationError]invalidate_own_sessions
@fn("SoulFireAdmin.invalidate_own_sessions")
def invalidate_own_sessions(
self, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[None, SoulFireOperationError]server_info
@fn("SoulFireAdmin.server_info")
def server_info(
self, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[ServerInfoResponse, SoulFireOperationError]update_server_config
@fn("SoulFireAdmin.update_server_config")
def update_server_config(
self, config: ServerConfig, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[None, SoulFireOperationError]set_server_config_entry
@fn("SoulFireAdmin.set_server_config_entry")
def set_server_config_entry(
self,
request: ServerUpdateConfigEntryRequest,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]list_users
@fn("SoulFireAdmin.list_users")
def list_users(
self, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[list[UserListResponse.User], SoulFireOperationError]user
@fn("SoulFireAdmin.user")
def user(
self, user_id: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[UserInfoResponse, SoulFireOperationError]create_user
@fn("SoulFireAdmin.create_user")
def create_user(
self, request: UserCreateRequest, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[str, SoulFireOperationError]delete_user
@fn("SoulFireAdmin.delete_user")
def delete_user(
self, user_id: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[None, SoulFireOperationError]update_user
@fn("SoulFireAdmin.update_user")
def update_user(
self, request: UpdateUserRequest, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[None, SoulFireOperationError]invalidate_user_sessions
@fn("SoulFireAdmin.invalidate_user_sessions")
def invalidate_user_sessions(
self, user_id: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[None, SoulFireOperationError]generate_user_api_token
@fn("SoulFireAdmin.generate_user_api_token")
def generate_user_api_token(
self, user_id: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[str, SoulFireOperationError]user_plugin_permission_grants
@fn("SoulFireAdmin.user_plugin_permission_grants")
def user_plugin_permission_grants(
self, user_id: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[list[UserPluginPermissionGrant], SoulFireOperationError]set_user_plugin_permission_grant
@fn("SoulFireAdmin.set_user_plugin_permission_grant")
def set_user_plugin_permission_grant(
self,
user_id: str,
permission_id: str,
scope: PluginPermissionScope,
*,
resource_id: str | None = None,
granted: bool = True,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[UserPluginPermissionGrant, SoulFireOperationError]delete_user_plugin_permission_grant
@fn("SoulFireAdmin.delete_user_plugin_permission_grant")
def delete_user_plugin_permission_grant(
self,
user_id: str,
permission_id: str,
scope: PluginPermissionScope,
*,
resource_id: str | None = None,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]previous_logs
@fn("SoulFireAdmin.previous_logs")
def previous_logs(
self,
scope: LogScope,
count: int = 300,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[list[LogString], SoulFireOperationError]logs
def logs(
self, scope: LogScope, *, headers: Headers = None, timeout_ms: int | None = None
) -> Stream[LogResponse, SoulFireOperationError]server_metrics
@fn("SoulFireAdmin.server_metrics")
def server_metrics(
self,
since: Timestamp | None = None,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[GetServerMetricsResponse, SoulFireOperationError]instance_metrics
@fn("SoulFireAdmin.instance_metrics")
def instance_metrics(
self,
instance_id: str,
since: Timestamp | None = None,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[GetInstanceMetricsResponse, SoulFireOperationError]execute_command
@fn("SoulFireAdmin.execute_command")
def execute_command(
self, request: CommandRequest, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[CommandResponse, SoulFireOperationError]complete_command
@fn("SoulFireAdmin.complete_command")
def complete_command(
self,
request: CommandCompletionRequest,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[CommandCompletionResponse, SoulFireOperationError]download
@fn("SoulFireAdmin.download")
def download(
self, request: DownloadRequest, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[DownloadResponse, SoulFireOperationError]plugin_stats
@fn("SoulFireAdmin.plugin_stats")
def plugin_stats(
self, instance_id: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[list[PluginRuntimeStat], SoulFireOperationError]audit_log
@fn("SoulFireAdmin.audit_log")
def audit_log(
self, instance_id: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[list[InstanceAuditLogResponse.AuditLogEntry], SoulFireOperationError]list_scripts
@fn("SoulFireAdmin.list_scripts")
def list_scripts(
self, instance_id: str, *, headers: Headers = None, timeout_ms: int | None = None
) -> EffectGen[list[ScriptInfo], SoulFireOperationError]script
@fn("SoulFireAdmin.script")
def script(
self,
instance_id: str,
script_id: str,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[GetScriptResponse, SoulFireOperationError]create_script
@fn("SoulFireAdmin.create_script")
def create_script(
self,
request: CreateScriptRequest,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[CreateScriptResponse, SoulFireOperationError]update_script
@fn("SoulFireAdmin.update_script")
def update_script(
self,
request: UpdateScriptRequest,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[UpdateScriptResponse, SoulFireOperationError]delete_script
@fn("SoulFireAdmin.delete_script")
def delete_script(
self,
instance_id: str,
script_id: str,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]activate_script
def activate_script(
self,
instance_id: str,
script_id: str,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> Stream[ScriptEvent, SoulFireOperationError]deactivate_script
@fn("SoulFireAdmin.deactivate_script")
def deactivate_script(
self,
instance_id: str,
script_id: str,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[None, SoulFireOperationError]script_status
@fn("SoulFireAdmin.script_status")
def script_status(
self,
instance_id: str,
script_id: str,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[GetScriptStatusResponse, SoulFireOperationError]script_logs
def script_logs(
self,
request: SubscribeScriptLogsRequest,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> Stream[ScriptLogEntry, SoulFireOperationError]node_types
@fn("SoulFireAdmin.node_types")
def node_types(
self,
request: GetNodeTypesRequest | None = None,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[GetNodeTypesResponse, SoulFireOperationError]script_registry_data
@fn("SoulFireAdmin.script_registry_data")
def script_registry_data(
self,
request: GetRegistryDataRequest | None = None,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[GetRegistryDataResponse, SoulFireOperationError]validate_script
@fn("SoulFireAdmin.validate_script")
def validate_script(
self,
request: ValidateScriptRequest,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> EffectGen[ValidateScriptResponse, SoulFireOperationError]dry_run_script
def dry_run_script(
self,
request: DryRunScriptRequest,
*,
headers: Headers = None,
timeout_ms: int | None = None,
) -> Stream[ScriptEvent, SoulFireOperationError]How is this page?
Last updated on