Struct Client 

pub struct Client { /* private fields */ }

Implementations

impl Client

pub fn new(base: &str, token: Option<String>) -> Result<Self>

pub fn authenticated(&self, token: Option<String>) -> Self

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

Apply diagnostic opt-out to every Apps API request, including uploads and downloads.

pub fn base_url(&self) -> &str

pub async fn request( &self, method: &str, path: &[&str], query: &[(&str, String)], body: Option<Value>, idempotency_key: Option<&str>, ) -> Result<Value>

Author/user endpoint escape hatch; CLI features all call this primary package interface.

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

pub async fn register_platform(&self, target: &str) -> Result<Value>

Record this signed-in account’s platform for the author-visible target population.

pub async fn search( &self, query: &str, private: bool, mine: bool, ) -> Result<Value>

pub async fn app(&self, id: &str) -> Result<Value>

pub async fn available(&self, id: &str) -> Result<Value>

pub async fn create( &self, id: &str, name: &str, description: &str, logo: Option<&str>, key: Option<&str>, ) -> Result<Value>

pub async fn edit( &self, id: &str, changes: Value, key: Option<&str>, ) -> Result<Value>

pub async fn action( &self, method: &str, app: &str, rest: &[&str], body: Option<Value>, key: Option<&str>, ) -> Result<Value>

pub async fn resolve( &self, spec: &InstallSpec, target: &str, ) -> Result<Resolution>

pub async fn upload( &self, app: &str, target: &str, bytes: Vec<u8>, key: Option<&str>, ) -> Result<Value>

pub async fn upload_signed( &self, app: &str, target: &str, bytes: Vec<u8>, author: Option<&AuthorKey>, key: Option<&str>, ) -> Result<Value>

Upload a package, signed with your author key when one is given.

pub async fn download(&self, resolution: &Resolution) -> Result<Vec<u8>>

pub async fn signing_keys(&self) -> Result<Value>

The public keys that sign this service’s releases.

pub async fn withdraw_release( &self, app: &str, release_id: &str, reason: &str, key: Option<&str>, ) -> Result<Value>

Withdraw a bad release. It stops being served; installs and the updater move to the latest good release on its channel.

pub async fn author_keys(&self) -> Result<Value>

Your registered author keys.

pub async fn add_author_key( &self, public_key: &str, name: Option<&str>, key: Option<&str>, ) -> Result<Value>

Register an author public key (base64 Ed25519).

pub async fn revoke_author_key( &self, key_id: &str, reason: Option<&str>, key: Option<&str>, ) -> Result<Value>

Revoke an author key so nothing new can be signed with it.

pub async fn capabilities(&self, require: &[&str]) -> Result<Value>

What this server supports, answering require queries such as streaming, subscriptions or target:linux-x86_64 in requirements.

pub async fn events( &self, feed: &Feed, after: Option<i64>, types: &[&str], limit: Option<u32>, ) -> Result<Value>

One page of a feed as JSON, after the event seq after.

pub async fn stream_events( &self, feed: &Feed, last_event_id: Option<&str>, types: &[&str], ) -> Result<EventStream>

Open a server-sent event stream. Without last_event_id it starts at the newest event, or where a subscription’s stream last stopped.

pub async fn subscriptions(&self, status: Option<&str>) -> Result<Value>

Your subscriptions. status is active, paused, cancelled or all; the default lists active and paused ones.

pub async fn subscription(&self, id: &str) -> Result<Value>

pub async fn create_subscription( &self, subscription: &NewSubscription, key: Option<&str>, ) -> Result<Value>

Subscribe. A webhook subscription’s secret is in the result once.

pub async fn update_subscription( &self, id: &str, changes: Value, key: Option<&str>, ) -> Result<Value>

Change types, channels, delivery, description or status.

pub async fn pause_subscription( &self, id: &str, key: Option<&str>, ) -> Result<Value>

pub async fn resume_subscription( &self, id: &str, key: Option<&str>, ) -> Result<Value>

pub async fn cancel_subscription( &self, id: &str, key: Option<&str>, ) -> Result<Value>

pub async fn subscription_deliveries( &self, id: &str, status: Option<&str>, ) -> Result<Value>

pub async fn rotate_subscription_secret( &self, id: &str, key: Option<&str>, ) -> Result<Value>

pub async fn ping_subscription( &self, id: &str, key: Option<&str>, ) -> Result<Value>

Queue a signed ping delivery to a webhook subscription.

pub async fn report( &self, message: &str, pr: Option<&str>, key: Option<&str>, ) -> Result<Value>

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.