Skip to main content

MeApi

Struct MeApi 

Source
pub struct MeApi { /* private fields */ }
Expand description

The calling identity: profile, tenants, head agent

Implementations§

Source§

impl MeApi

Source

pub async fn delete(&self) -> Result<DeleteMeResponse>

Delete your own account

Self-serve account deletion — the App Store 5.1.1(v) requirement, and the only path to it in the mobile clients. Any authenticated member deletes their OWN account: the user record and the email-membership index in every tenant the address belongs to, their api keys (the per-tenant row AND the global hash, so live sessions die at once), and data tagged with them as data subject, erased through the same sweep as /data-subject/erasure.

Every refusal is checked across ALL memberships BEFORE anything is deleted, so a half-delete cannot happen.

WRITE SEMANTICS: replaces nothing — it removes. A second call answers 404: after a successful delete there is no record to delete, which is the honest answer rather than a silent success.

DELETE /api/v1/me

Source

pub async fn export_my_account( &self, params: &ExportMyAccountParams, ) -> Result<AccountExport>

Export everything in this account

Chats, projects, memories and the account record. format=zip (the default) answers a zip attachment; format=json answers the same bundle as one document, which is easier to pipe and which a browser will show rather than download.

Check complete: when a size ceiling is hit the export still succeeds and omitted names what was left out. A truncated export that does not say so is the failure this field exists to prevent.

GET /api/v1/me/export

Source

pub async fn get_my_preferences(&self) -> Result<UserPreferences>

Read personal instructions

Requires a credential bound to a person: an API key that carries no user identity is refused with 403, because personal instructions belong to the account holder rather than the key.

GET /api/v1/me/preferences

Source

pub async fn patch(&self, body: &PatchMeRequest) -> Result<PatchMeResponse>

Set or clear your avatar

The one field a person may change about themselves here: avatar_url. It must name a file this tenant owns — /api/v1/files/\<file_id\>/content, absolute or relative — whose mime_type is image/*; null clears it. The change is written to the caller’s user row in every tenant they belong to (updated_rows says how many). Anything else in the body is ignored; a body without avatar_url is 400. WRITE SEMANTICS: replaces — avatar_url is the whole writable surface and must be present; there is nothing to merge.

PATCH /api/v1/me

Source

pub async fn switch_tenant( &self, body: &SwitchTenantRequest, ) -> Result<SwitchTenantResponse>

Switch the active workspace

Requires a user session (JWT). An API key is refused with 403, because a key is bound to the tenant it was created in — create a key inside the target tenant instead. This endpoint used to answer {"switched": true} for api-key callers and change nothing, which is why the refusal is now explicit and documented.

The answer carries the target context; the client re-issues a key through the normal post-login flow.

POST /api/v1/me/tenants/switch

Source

pub async fn update_my_preferences( &self, body: &UpdateMyPreferencesRequest, ) -> Result<UserPreferences>

Write personal instructions

Both fields are optional; what is sent is merged onto the stored record. Same person-bound credential rule as the read.

PUT /api/v1/me/preferences

Trait Implementations§

Source§

impl Clone for MeApi

Source§

fn clone(&self) -> MeApi

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for MeApi

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for MeApi

§

impl !UnwindSafe for MeApi

§

impl Freeze for MeApi

§

impl Send for MeApi

§

impl Sync for MeApi

§

impl Unpin for MeApi

§

impl UnsafeUnpin for MeApi

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more