Struct Client 

pub struct Client { /* private fields */ }

This is the client that is used for interacting with the Xero API. It handles OAuth 2 authentication and context (the current tenant).

Implementations

impl Client

pub fn authorize_url( key_pair: KeyPair, redirect_url: Url, scopes: impl Into<Scope>, ) -> (Url, CsrfToken)

Generates an authorization URL to use for the code flow authorization method.

pub async fn from_client_credentials( key_pair: KeyPair, scopes: impl Into<Option<Scope>>, ) -> Result<Self, RequestTokenError<HttpClientError<Error>, OAuth2ErrorResponse>>

Errors

Returns an error if the connection can’t be made.

pub async fn from_authorization_code( key_pair: KeyPair, redirect_url: Url, code: String, ) -> Result<Self, RequestTokenError<HttpClientError<Error>, OAuth2ErrorResponse>>

Creates an authorized client from a code generated in the code flow authorization method.

Errors

Returns an error if the connection can’t be made.

pub async fn refresh_access_token(&mut self, key_pair: KeyPair) -> Result<()>

Refreshes the access token using the refresh token.

pub fn set_tenant(&mut self, tenant_id: Option<Uuid>)

Sets the tenant ID for this client.

pub fn rate_limit_info(&self) -> &RateLimitInfo

Get the current rate limit information

pub async fn get<'a, R: DeserializeOwned, U: AsRef<str> + Debug + Clone, T: Serialize + Sized + Debug>( &self, url: U, query: &T, ) -> Result<R>

Perform an authenticated GET request against the API with automatic retry.

pub async fn get_endpoint<'a, R: DeserializeOwned, T: Serialize + Sized + Debug>( &self, endpoint: XeroEndpoint, query: &T, ) -> Result<R>

Perform a GET request against the API using a typed XeroEndpoint with automatic retry.

pub async fn put<'a, R: DeserializeOwned, U: AsRef<str> + Debug + Clone, T: Serialize + Sized>( &self, url: U, data: &T, ) -> Result<R>

Perform an authenticated PUT request against the API with automatic retry.

pub async fn post<'a, R: DeserializeOwned, U: AsRef<str> + Debug + Clone, T: Serialize + Sized + Debug>( &self, url: U, data: &T, ) -> Result<R>

Perform an authenticated POST request against the API with automatic retry.

pub async fn post_endpoint<'a, R: DeserializeOwned, T: Serialize + Sized + Debug>( &self, endpoint: XeroEndpoint, data: &T, ) -> Result<R>

Perform a POST request against the API using a typed XeroEndpoint with automatic retry.

pub async fn put_endpoint<'a, R: DeserializeOwned, T: Serialize + Sized>( &self, endpoint: XeroEndpoint, data: &T, ) -> Result<R>

Perform a PUT request against the API using a typed XeroEndpoint with automatic retry.

pub async fn delete<U: AsRef<str> + Debug + Clone>(&self, url: U) -> Result<()>

Perform an authenticated DELETE request against the API with automatic retry.

pub async fn delete_endpoint(&self, endpoint: XeroEndpoint) -> Result<()>

Perform a DELETE request against the API using a typed XeroEndpoint with automatic retry.

pub fn contacts(&self) -> ContactsApi<'_>

Access the contacts API

pub fn invoices(&self) -> InvoicesApi<'_>

Access the invoices API

pub fn purchase_orders(&self) -> PurchaseOrdersApi<'_>

Access the purchase orders API

pub fn quotes(&self) -> QuotesApi<'_>

Access the quotes API

pub fn timesheets(&self) -> TimesheetsApi<'_>

Access the timesheets API

pub fn employees(&self) -> EmployeesApi<'_>

Access the employees API

pub fn earnings_rates(&self) -> EarningsRatesApi<'_>

Access the earnings rates API

pub fn pay_calendars(&self) -> PayCalendarsApi<'_>

Access the pay calendars API

pub fn items(&self) -> ItemsApi<'_>

Access the items API

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.