Struct Client

pub struct Client { /* private fields */ }

Entrypoint for interacting with the API client.

Implementations

impl Client

pub fn new<I, K, R, T, Q>( client_id: I, client_secret: K, redirect_uri: R, token: T, refresh_token: Q, server: impl Into<RootDefaultServers>, ) -> Self

where I: ToString, K: ToString, R: ToString, T: ToString, Q: ToString,

Create a new Client struct. Requires OAuth2 configuration values as well as an access and refresh token.

Panics

This function will panic if the internal http client fails to create

pub fn set_auto_access_token_refresh(&mut self, enabled: bool) -> &mut Self

Enables or disables the automatic refreshing of access tokens upon expiration

pub async fn set_expires_at(&self, expires_at: Option<Instant>) -> &Self

Sets a specific Instant at which the access token should be considered expired. The expiration value will only be used when automatic access token refreshing is also enabled. None may be passed in if the expiration is unknown. In this case automatic refreshes will be attempted when encountering an UNAUTHENTICATED status code on a response.

pub async fn expires_at(&self) -> Option<Instant>

Gets the Instant at which the access token used by this client is set to expire if one is known

pub async fn set_expires_in(&self, expires_in: i64) -> &Self

Sets the number of seconds in which the current access token should be considered expired

pub async fn expires_in(&self) -> Option<Duration>

Gets the number of seconds from now in which the current access token will be considered expired if one is known

pub async fn is_expired(&self) -> Option<bool>

Determines if the access token currently stored in the client is expired. If the expiration can not be determined, None is returned

pub fn with_host_override<H>(&mut self, host: H) -> &mut Self

where H: ToString,

Override the host for all endpoins in the client.

pub fn remove_host_override(&mut self) -> &mut Self

Disables the global host override for the client.

pub fn get_host_override(&self) -> Option<&str>

pub fn new_from_env<T, R>( token: T, refresh_token: R, server: impl Into<RootDefaultServers>, ) -> Self

where T: ToString, R: ToString,

Create a new Client struct from environment variables. Requires an existing access and refresh token.

The following environment variables are expected to be set:

• GUSTO_CLIENT_ID
• GUSTO_CLIENT_SECRET
• GUSTO_REDIRECT_URI

Panics

This function will panic if the expected environment variables can not be found

pub fn user_consent_url(&self, scopes: &[String]) -> String

Return a user consent url with an optional set of scopes. If no scopes are provided, they will not be passed in the url.

pub async fn refresh_access_token(&self) -> Result<AccessToken, ClientError>

Refresh an access token from a refresh token. Client must have a refresh token for this to work.

pub async fn get_access_token( &mut self, code: &str, state: &str, ) -> Result<AccessToken, ClientError>

Get an access token from the code returned by the URL paramter sent to the redirect URL.

pub fn current_user(&self) -> CurrentUser

Return a reference to an interface that provides access to Current User operations.

pub fn companies(&self) -> Companies

Return a reference to an interface that provides access to Companies operations.

pub fn employees(&self) -> Employees

Return a reference to an interface that provides access to Employees operations.

pub fn contractors(&self) -> Contractors

Return a reference to an interface that provides access to Contractors operations.

pub fn payroll(&self) -> Payroll

Return a reference to an interface that provides access to Payroll operations.

pub fn contractor_payments(&self) -> ContractorPayments

Return a reference to an interface that provides access to Contractor Payments operations.

pub fn company_bank_accounts_beta(&self) -> CompanyBankAccountsBeta

Return a reference to an interface that provides access to Company Bank Accounts (Beta) operations.

pub fn benefits(&self) -> Benefits

Return a reference to an interface that provides access to Benefits operations.

pub fn locations(&self) -> Locations

Return a reference to an interface that provides access to Locations operations.

pub fn jobs(&self) -> Jobs

Return a reference to an interface that provides access to Jobs operations.

pub fn job_applicants_beta(&self) -> JobApplicantsBeta

Return a reference to an interface that provides access to Job Applicants (Beta) operations.

pub fn compensations(&self) -> Compensations

Return a reference to an interface that provides access to Compensations operations.

pub fn pay_schedules(&self) -> PaySchedules

Return a reference to an interface that provides access to Pay Schedules operations.

pub fn garnishments(&self) -> Garnishments

Return a reference to an interface that provides access to Garnishments operations.

pub fn time_off_requests(&self) -> TimeOffRequests

Return a reference to an interface that provides access to Time Off Requests operations.

pub fn earning_type(&self) -> EarningType

Return a reference to an interface that provides access to Earning Type operations.

pub fn terminations(&self) -> Terminations

Return a reference to an interface that provides access to Terminations operations.

pub fn custom_fields(&self) -> CustomFields

Return a reference to an interface that provides access to Custom Fields operations.

pub fn admins_beta(&self) -> AdminsBeta

Return a reference to an interface that provides access to Admins (Beta) operations.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.