soulfire.client_connect.ClientServiceSync

class soulfire.client_connect.ClientServiceSync

Bases: Protocol

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

get_client_data(request: soulfire.client_pb2.ClientDataRequest, ctx: connectrpc.request.RequestContext[soulfire.client_pb2.ClientDataRequest, soulfire.client_pb2.ClientDataResponse]) → soulfire.client_pb2.ClientDataResponse

generate_web_dav_token(request: soulfire.client_pb2.GenerateWebDAVTokenRequest, ctx: connectrpc.request.RequestContext[soulfire.client_pb2.GenerateWebDAVTokenRequest, soulfire.client_pb2.GenerateWebDAVTokenResponse]) → soulfire.client_pb2.GenerateWebDAVTokenResponse

generate_api_token(request: soulfire.client_pb2.GenerateAPITokenRequest, ctx: connectrpc.request.RequestContext[soulfire.client_pb2.GenerateAPITokenRequest, soulfire.client_pb2.GenerateAPITokenResponse]) → soulfire.client_pb2.GenerateAPITokenResponse

update_self_username(request: soulfire.client_pb2.UpdateSelfUsernameRequest, ctx: connectrpc.request.RequestContext[soulfire.client_pb2.UpdateSelfUsernameRequest, soulfire.client_pb2.UpdateSelfUsernameResponse]) → soulfire.client_pb2.UpdateSelfUsernameResponse

update_self_email(request: soulfire.client_pb2.UpdateSelfEmailRequest, ctx: connectrpc.request.RequestContext[soulfire.client_pb2.UpdateSelfEmailRequest, soulfire.client_pb2.UpdateSelfEmailResponse]) → soulfire.client_pb2.UpdateSelfEmailResponse

invalidate_self_sessions(request: soulfire.client_pb2.InvalidateSelfSessionsRequest, ctx: connectrpc.request.RequestContext[soulfire.client_pb2.InvalidateSelfSessionsRequest, soulfire.client_pb2.InvalidateSelfSessionsResponse]) → soulfire.client_pb2.InvalidateSelfSessionsResponse