Struct RestClient 

pub(super) struct RestClient {
    http: Client,
    base_url: String,
    headers: HeaderMap,
    signer: Option<MacSigner>,
}

An HTTP client bound to a base URL, carrying the 1Password identity headers and an optional MAC signer. Requests are signed automatically once a signer is attached.

Fields

http: Client

base_url: String

headers: HeaderMap

signer: Option<MacSigner>

Implementations

impl RestClient

pub(super) fn new( http: Client, base_url: impl Into<String>, client_id: &str, user_agent: &str, op_user_agent: &str, ) -> Result<RestClient, OnePasswordError>

Builds the base client with the identity headers derived from ClientInfo.

pub(super) fn with_base_url(&self, base_url: impl Into<String>) -> RestClient

Derives a client for another API root. It keeps the transport and the headers, but does not sign its requests, as the signer belongs to the receiver.

pub(super) fn with_session_id( &self, session_id: &str, ) -> Result<RestClient, OnePasswordError>

Derives a client that adds the session id header.

pub(super) fn with_signer(&self, signer: MacSigner) -> RestClient

Derives a client that signs every request. The signer carries the session id already, so this keeps whatever headers the receiver has.

pub(super) async fn post_json<T: DeserializeOwned>( &self, endpoint: &str, body: Value, ) -> Result<T, OnePasswordError>

POSTs a JSON body and parses the JSON response.

pub(super) async fn post_json_or_empty<T: DeserializeOwned>( &self, endpoint: &str, body: Value, ) -> Result<Option<T>, OnePasswordError>

POSTs a JSON body and parses the JSON response, reporting an empty success body as None.

Some endpoints answer 200 with an empty body while the result is not ready yet, which must not be mistaken for a parse error.

pub(super) async fn post_json_unless_status<T: DeserializeOwned>( &self, endpoint: &str, body: Value, status: StatusCode, ) -> Result<Option<T>, OnePasswordError>

POSTs a JSON body and parses the JSON response, or returns None when the server answers with status, whatever the body.

pub(super) async fn put_json<T: DeserializeOwned>( &self, endpoint: &str, body: Value, ) -> Result<T, OnePasswordError>

PUTs a JSON body and parses the JSON response.

pub(super) async fn put<T: DeserializeOwned>( &self, endpoint: &str, ) -> Result<T, OnePasswordError>

PUTs with no body and parses the JSON response.

pub(super) async fn delete_json( &self, endpoint: &str, body: Value, ) -> Result<(), OnePasswordError>

DELETEs a JSON body. The response carries nothing to parse and errors surface for the caller to ignore.

pub(super) async fn get_encrypted_json<T: DeserializeOwned>( &self, endpoint: &str, session_key: &AesKey, ) -> Result<T, OnePasswordError>

GETs an opdata envelope, decrypts it, and parses the JSON plaintext.

pub(super) async fn post_encrypted_json<T: DeserializeOwned>( &self, endpoint: &str, params: Value, session_key: &AesKey, ) -> Result<T, OnePasswordError>

Encrypts params, POSTs the opdata envelope, then decrypts and parses the response.

async fn request_json<T: DeserializeOwned>( &self, method: Method, endpoint: &str, body: Option<&Value>, ) -> Result<T, OnePasswordError>

Sends a request and parses the JSON response.

async fn request( &self, method: Method, endpoint: &str, body: Option<&Value>, ) -> Result<String, OnePasswordError>

async fn send( &self, method: Method, endpoint: &str, body: Option<&Value>, ) -> Result<(StatusCode, String), OnePasswordError>

Sends a request and returns the status and the body, whatever the status.