Struct Client 

pub struct Client { /* private fields */ }

The Commit API client. Holds configuration and a connection pool, never sessions.

Implementations

impl Client

pub fn new(base_url: &str) -> Result<Self, Error>

Accepts the API origin, or the origin followed by /api/v1 or /api/v1/. Plain http:// is accepted only for this machine (localhost, 127.0.0.1, ::1).

pub fn with_bearer(self, access_token: impl Into<String>) -> Self

Authenticates with a Silicon Accounts access token issued to Commit (Authorization: Bearer …).

pub fn with_proof(self, proof: impl Into<String>) -> Result<Self, Error>

Authenticates as another app acting for an account, with a User verification proof (Authorization: Proof sap_…) issued for Commit with the scopes of the actions you call (each route’s action id, e.g. commit.todos.list). Commit must allow your app for those scopes.

pub fn with_telemetry(self, _enabled: bool) -> Self

👎Deprecated since 0.6.0:

Commit records no telemetry; this does nothing and can be removed

Does nothing. Commit records no telemetry, so there is nothing to turn on or off.

pub fn with_source(self, source: &'static str) -> Result<Self, Error>

👎Deprecated since 0.6.0:

Commit records no request diagnostics; this does nothing and can be removed

Does nothing. The source only named the interface in request diagnostics, which Commit no longer records. A value other than cli, browser, daemon or rust-client is still refused.

pub fn with_mutation(self, mutation: Mutation) -> Self

Attaches retry/precondition inputs to writes made through this clone.

pub fn base_url(&self) -> &Url

The /api/v1/ base every request goes to.

pub fn new_idempotency_key() -> String

A fresh random idempotency key.

impl Client

Public and account endpoints.

pub async fn health(&self) -> Result<Value, Error>

GET /healthz (public): the API process is alive.

pub async fn ready(&self) -> Result<Value, Error>

GET /readyz (public): the API can serve requests.

pub async fn version(&self) -> Result<Value, Error>

GET /api/v1/version (public): build metadata. Sends no credentials.

pub async fn contracts(&self) -> Result<Value, Error>

GET /api/v1/contracts: the live compatibility matrix.

pub async fn accounts(&self) -> Result<Value, Error>

GET /api/v1/accounts (public): how to sign in to Commit (app id, Silicon Accounts URLs, the scopes Commit honours). Sends no credentials.

pub async fn me(&self) -> Result<Value, Error>

GET /api/v1/me: the caller as Commit sees it (uuid, id, kind, name, photo, shared email, custodian or Silicons, and via_app for proofs).

pub async fn silicon_allowlist(&self, silicon: &str) -> Result<Value, Error>

GET /api/v1/silicons/{silicon}/allowed-accounts: the accounts a Silicon accepts todos and project invitations from besides its custodian and the custodian’s other Silicons (read by the Silicon or its custodian).

pub async fn allow_account( &self, silicon: &str, account: &str, ) -> Result<Value, Error>

PUT /api/v1/silicons/{silicon}/allowed-accounts/{account}: lets account reach the Silicon.

pub async fn disallow_account( &self, silicon: &str, account: &str, ) -> Result<Value, Error>

DELETE /api/v1/silicons/{silicon}/allowed-accounts/{account}.

pub async fn email_settings(&self) -> Result<Value, Error>

GET /api/v1/email-settings: the caller’s email delivery preferences.

pub async fn set_email_settings(&self, body: &Value) -> Result<Value, Error>

PUT /api/v1/email-settings: replaces the address and the subscribed events.

pub async fn report(&self, body: &Value) -> Result<Value, Error>

POST /api/v1/reports: a bug report for Commit’s maintainers (keep the mutation across retries).

impl Client

Todos, notes and notification rules.

pub async fn list_todos(&self, query: &[(&str, &str)]) -> Result<Value, Error>

GET /api/v1/todos (view, status, assigned_to, assigned_by, created_from, created_to, limit, cursor).

pub async fn get_todo(&self, todo_id: &str) -> Result<Value, Error>

GET /api/v1/todos/{todo_id}.

pub async fn create_todo<T: Serialize + ?Sized>( &self, body: &T, ) -> Result<Value, Error>

POST /api/v1/todos.

pub async fn update_todo<T: Serialize + ?Sized>( &self, todo_id: &str, body: &T, ) -> Result<Value, Error>

PATCH /api/v1/todos/{todo_id}.

pub async fn delete_todo(&self, todo_id: &str) -> Result<Value, Error>

DELETE /api/v1/todos/{todo_id}.

pub async fn list_notes( &self, todo_id: &str, query: &[(&str, &str)], ) -> Result<Value, Error>

GET /api/v1/todos/{todo_id}/notes.

pub async fn add_note<T: Serialize + ?Sized>( &self, todo_id: &str, body: &T, ) -> Result<Value, Error>

POST /api/v1/todos/{todo_id}/notes.

pub async fn todo_subscription(&self, todo_id: &str) -> Result<Value, Error>

GET /api/v1/todos/{todo_id}/notification-subscription.

pub async fn replace_todo_subscription<T: Serialize + ?Sized>( &self, todo_id: &str, body: &T, ) -> Result<Value, Error>

PUT /api/v1/todos/{todo_id}/notification-subscription.

pub async fn notification_settings(&self) -> Result<Value, Error>

GET /api/v1/notification-settings: the caller’s Silicon webhook settings.

pub async fn notification_settings_of( &self, silicon: &str, ) -> Result<Value, Error>

GET /api/v1/notification-settings?silicon=si:…: a Silicon’s settings, read by the Silicon or its custodian.

pub async fn update_notification_settings<T: Serialize + ?Sized>( &self, body: &T, ) -> Result<Value, Error>

PUT /api/v1/notification-settings.

pub async fn update_notification_settings_of<T: Serialize + ?Sized>( &self, silicon: &str, body: &T, ) -> Result<Value, Error>

PUT /api/v1/notification-settings?silicon=si:…: replaces a Silicon’s settings as the Silicon or its custodian.

impl Client

Projects, diaries, tasks, entries and versions.

pub async fn list_projects( &self, query: &[(&str, &str)], ) -> Result<Value, Error>

GET /api/v1/projects (status, silicon_id, limit, cursor).

pub async fn get_project(&self, project_id: &str) -> Result<Value, Error>

GET /api/v1/projects/{project_id} (id or UID).

pub async fn create_project<T: Serialize + ?Sized>( &self, body: &T, ) -> Result<Value, Error>

POST /api/v1/projects.

pub async fn update_project<T: Serialize + ?Sized>( &self, project_id: &str, body: &T, ) -> Result<Value, Error>

PATCH /api/v1/projects/{project_id}.

pub async fn project_diary(&self, project_id: &str) -> Result<Value, Error>

GET /api/v1/projects/{project_id}/diary.

pub async fn replace_project_diary<T: Serialize + ?Sized>( &self, project_id: &str, body: &T, ) -> Result<Value, Error>

PUT /api/v1/projects/{project_id}/diary (send If-Match).

pub async fn project_tasks( &self, project_id: &str, query: &[(&str, &str)], ) -> Result<Value, Error>

GET /api/v1/projects/{project_id}/tasks.

pub async fn project_entries( &self, project_id: &str, query: &[(&str, &str)], ) -> Result<Value, Error>

GET /api/v1/projects/{project_id}/entries: blockers, updates and completion.

pub async fn create_project_task<T: Serialize + ?Sized>( &self, project_id: &str, body: &T, ) -> Result<Value, Error>

POST /api/v1/projects/{project_id}/tasks.

pub async fn update_project_task<T: Serialize + ?Sized>( &self, project_id: &str, task_id: &str, body: &T, ) -> Result<Value, Error>

PATCH /api/v1/projects/{project_id}/tasks/{task_id}.

pub async fn claim_project_task( &self, project: &str, task: &str, ) -> Result<Value, Error>

POST /api/v1/projects/{project}/tasks/{task}/claim: takes an unassigned task atomically.

pub async fn delete_project_task( &self, project: &str, task: &str, ) -> Result<Value, Error>

DELETE /api/v1/projects/{project}/tasks/{task}: removes a task subtree and its linked todos.

pub async fn create_project_blocker<T: Serialize + ?Sized>( &self, project_id: &str, body: &T, ) -> Result<Value, Error>

POST /api/v1/projects/{project_id}/blockers.

pub async fn create_project_update<T: Serialize + ?Sized>( &self, project_id: &str, body: &T, ) -> Result<Value, Error>

POST /api/v1/projects/{project_id}/updates.

pub async fn complete_project<T: Serialize + ?Sized>( &self, project_id: &str, body: &T, ) -> Result<Value, Error>

POST /api/v1/projects/{project_id}/completion.

pub async fn project_versions( &self, project: &str, query: &[(&str, &str)], ) -> Result<Value, Error>

GET /api/v1/projects/{project}/versions (before, limit): newest first.

pub async fn project_version( &self, project: &str, version: i64, ) -> Result<Value, Error>

GET /api/v1/projects/{project}/versions/{version}: one retained snapshot.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.