nildb.user_client

User NIL DB client implementation.

class NilDbUserClientOptions(*, about: ReadAboutNodeResponse, base_url: str)

Bases: NilDbBaseClientOptions

Options for NIL DB user client.

class NilDbUserClient(options: NilDbUserClientOptions)

Bases: NilDbBaseClient

User NIL DB client implementation.

async read_profile(token: str) → ReadUserProfileResponse

Retrieve the authenticated user’s profile information.

async create_owned_data(token: str, body: CreateOwnedDataRequest) → CreateDataResponse

Create user-owned data in an owned collection.

async list_data_references(token: str) → ListDataReferencesResponse

List all data records owned by the authenticated user.

async read_data(token: str, params: ReadDataRequestParams) → ReadDataResponse

Retrieve user-owned data by collection and document id.

async delete_data(token: str, params: DeleteDocumentRequestParams) → None

Delete a user-owned data document.

async grant_access(token: str, body: GrantAccessToDataRequest) → None

Grant access to user-owned data.

async revoke_access(token: str, body: RevokeAccessToDataRequest) → None

Revoke access to user-owned data.

async update_data(token: str, body: UpdateUserDataRequest) → None

Update a user-owned data document.

async create_nil_db_user_client(base_url: str) → NilDbUserClient

Create a NIL DB user client.

Parameters:

base_url – Base URL for the NIL DB service

Returns:

NIL DB user client