Struct ZoteroWebClient

pub struct ZoteroWebClient {
    client: Client,
    api_key: String,
    base_url: String,
}

Blocking client for the Zotero Web API v3.

Fields

client: Client

api_key: String

base_url: String

Implementations

impl ZoteroWebClient

pub fn new(api_key: &str, library_id: &str, library_type: &str) -> Self

Create a new client for a user library.

pub fn with_base_url(api_key: &str, base_url: &str) -> Self

Create a client with a custom base URL (for testing).

fn headers(&self) -> HeaderMap

Common headers for all API requests.

pub fn get_item(&self, key: &str) -> Result<Value>

GET a single item by key.

pub fn children(&self, key: &str) -> Result<Vec<Value>>

GET children of an item (attachments, notes).

pub fn item_template(&self, item_type: &str) -> Result<Value>

GET an item template for a given type.

Note: the template endpoint is global (/items/new), not scoped to a user library. We use the API root, not self.base_url.

pub fn create_items(&self, items: &[Value]) -> Result<Value>

POST new items to the library.

pub fn update_item(&self, key: &str, data: &Value, version: i32) -> Result<()>

PATCH (update) an existing item.

Requires the item’s current version for optimistic concurrency.

pub fn delete_item(&self, key: &str, version: i32) -> Result<()>

DELETE an item permanently.

pub fn get_collections(&self) -> Result<Vec<Value>>

GET all collections.

pub fn create_collections(&self, collections: &[Value]) -> Result<Value>

POST new collections.

pub fn download_file(&self, url: &str, dest: &Path) -> Result<()>

Download a file from a URL to a local path.

pub fn attach_file( &self, parent_key: &str, file_path: &Path, title: &str, ) -> Result<Value>

Upload a file attachment to an item.

Implements the full Zotero file upload protocol:

1. Create attachment item metadata
2. Get upload authorization (with file hash)
3. Upload file bytes to S3
4. Register the upload with Zotero

fn get_upload_authorization( &self, key: &str, md5: &str, filename: &str, filesize: usize, mtime: u128, ) -> Result<Value>

Step 2: Get upload authorization from Zotero.

fn upload_to_s3( &self, url: &str, content_type: &str, prefix: &str, file_bytes: &[u8], suffix: &str, ) -> Result<()>

Step 3: Upload file bytes to S3 pre-signed URL.

fn register_upload(&self, key: &str, upload_key: &str) -> Result<()>

Step 4: Register a completed upload with Zotero.

Trait Implementations

impl Debug for ZoteroWebClient

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

Formats the value using the given formatter.