Expand description
§ironflow-sdk
Type-safe Rust SDK for the Ironflow workflow engine API. Generated from the OpenAPI specification via progenitor, with ergonomic wrappers for authentication and SSE event streaming.
§Quick start
use ironflow_sdk::IronflowClient;
let client = IronflowClient::new("https://ironflow.example.com", "my-api-key");
let runs = client.list_runs().await?;
for run in &runs.data {
}§Authentication
The SDK uses Bearer token authentication. Pass your API key when creating the client – it is attached to every request automatically.
§SSE Event Streaming
use ironflow_sdk::IronflowClient;
use futures_util::StreamExt;
let client = IronflowClient::new("https://ironflow.example.com", "my-api-key");
let mut stream = client.events(None, None).await?;
while let Some(event) = stream.next().await {
match event {
Ok(ev) => { /* handle event */ }
Err(e) => { /* handle error */ }
}
}Re-exports§
pub use builder::ClientBuilder;pub use client::IronflowClient;pub use error::Error;
Modules§
- builder
- Builder pattern for
IronflowClientwith retry and rate-limit configuration. - client
- Ergonomic HTTP client for the Ironflow API.
- error
- SDK error types.
- rate_
limit - Client-side rate limiter.
- retry
- Automatic retry with exponential backoff and jitter.
- sse
- SSE (Server-Sent Events) streaming helpers.
- types
- Types used as operation parameters and responses.