Struct ApiClient 

pub struct ApiClient { /* private fields */ }

Asynchronous Asana API client handling retries, rate limiting, and caching.

Implementations

impl ApiClient

pub fn builder(token: AuthToken) -> ApiClientBuilder

Create a builder for configuring the client.

pub fn new(token: AuthToken) -> Result<Self, ApiError>

Construct a client with default options.

Errors

Returns an error if the cache directory cannot be created or if the HTTP client fails to initialize.

pub fn with_options( token: AuthToken, options: ApiClientOptions, ) -> Result<Self, ApiError>

Construct a client with specific options.

Errors

Returns an error if the cache directory cannot be created or if the HTTP client fails to initialize.

pub fn set_offline(&self, offline: bool)

Update offline mode at runtime.

pub fn is_offline(&self) -> bool

Determine if offline mode is active.

pub async fn rate_limit_info(&self) -> Option<RateLimitInfo>

Retrieve the most recent rate-limit information captured from the API.

pub fn base_url(&self) -> &str

Return the base URL currently configured.

pub async fn get_json<T>( &self, path: &str, query: &[(&str, &str)], ) -> Result<T, ApiError>

where T: DeserializeOwned,

Retrieve JSON from an endpoint and deserialize into T.

Errors

Returns an error if the network request fails, the response is invalid, or deserialization fails.

pub async fn get_current_user(&self) -> Result<Value, ApiError>

Retrieve the current authenticated user (/users/me).

Errors

Returns an error if the network request fails, authentication is invalid, or the response cannot be parsed.

pub async fn post_json<T, R>(&self, path: &str, body: &T) -> Result<R, ApiError>

where T: Serialize + ?Sized + Sync, R: DeserializeOwned,

POST helper for JSON endpoints returning a structured payload.

Errors

Returns an error if serialization fails, the network request fails, or the response cannot be deserialized.

pub async fn post_json_with_query<T, R>( &self, path: &str, query_pairs: Vec<(String, String)>, body: &T, ) -> Result<R, ApiError>

where T: Serialize + ?Sized + Sync, R: DeserializeOwned,

POST helper accepting explicit query parameters.

Errors

Returns an error if serialization fails, the network request fails, or the response cannot be deserialized.

pub async fn post_void<T>(&self, path: &str, body: &T) -> Result<(), ApiError>

where T: Serialize + ?Sized + Sync,

POST helper for endpoints that do not return a payload.

Errors

Returns an error if serialization fails or the network request fails.

pub async fn put_json<T, R>(&self, path: &str, body: &T) -> Result<R, ApiError>

where T: Serialize + ?Sized + Sync, R: DeserializeOwned,

PUT helper for JSON endpoints returning a structured payload.

Errors

Returns an error if serialization fails, the network request fails, or the response cannot be deserialized.

pub async fn put_json_with_query<T, R>( &self, path: &str, query_pairs: Vec<(String, String)>, body: &T, ) -> Result<R, ApiError>

where T: Serialize + ?Sized + Sync, R: DeserializeOwned,

PUT helper accepting explicit query parameters.

Errors

Returns an error if serialization fails, the network request fails, or the response cannot be deserialized.

pub async fn delete( &self, path: &str, query_pairs: Vec<(String, String)>, ) -> Result<(), ApiError>

DELETE helper ignoring the response payload.

Errors

Returns an error if the network request fails.

pub async fn post_multipart<R>( &self, path: &str, form: Form, ) -> Result<R, ApiError>

where R: DeserializeOwned,

POST multipart form data.

Errors

Returns an error if the network request fails or the response cannot be deserialized.

pub async fn download_file(&self, url: &str) -> Result<Vec<u8>, ApiError>

Download file from URL.

Errors

Returns an error if the network request fails or the download fails.

pub fn paginate<T>( &self, path: impl Into<String>, query: Vec<(String, String)>, ) -> impl Stream<Item = Result<Vec<T>, ApiError>> + '_

where T: DeserializeOwned + Send + 'static,

Stream paginated endpoints as a series of pages (Vec<T>).

pub fn paginate_with_limit<T>( &self, path: impl Into<String>, query: Vec<(String, String)>, max_items: Option<usize>, ) -> impl Stream<Item = Result<Vec<T>, ApiError>> + '_

where T: DeserializeOwned + Send + 'static,

Stream paginated endpoints with an optional global item limit.

Trait Implementations

impl Clone for ApiClient

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.