Struct gusto_api::Client

pub struct Client { /* fields omitted */ }

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
) -> Self where
    I: ToString,
    K: ToString,
    R: ToString,
    T: ToString,
    Q: ToString, 

Create a new Client struct. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key your requests will work.

pub fn new_from_env<T, R>(token: T, refresh_token: R) -> Self where
    T: ToString,
    R: ToString, 

Create a new Client struct from environment variables. It takes a type that can convert into an &str (String or Vec<u8> for example). As long as the function is given a valid API key and your requests will work. We pass in the token and refresh token to the client so if you are storing it in a database, you can get it first.

pub fn user_consent_url(&self) -> String

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

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) -> Result<AccessToken>

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.