Crate gusto_api

A fully generated, opinionated API client library for Gusto.

API Details

Welcome to Gusto’s API documentation.

API Terms of Service

Contact

name	email
Developer Relations	developer@gusto.com

Client Details

This client is generated from the Gusto OpenAPI specs based on API spec version 1.0. This way it will remain up to date as features are added. The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
gusto-api = "0.7.0"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of credentials.

use gusto_api::Client;

let gusto = Client::new(
    String::from("client-id"),
    String::from("client-secret"),
    String::from("redirect-uri"),
    String::from("token"),
    String::from("refresh-token"),
    gusto_api::RootProductionServer
);

Alternatively, the library can search for most of the variables required for the client in the environment:

• GUSTO_CLIENT_ID
• GUSTO_CLIENT_SECRET
• GUSTO_REDIRECT_URI

And then you can create a client from the environment.

use gusto_api::Client;

let gusto = Client::new_from_env(
    String::from("token"),
    String::from("refresh-token"),
    gusto_api::RootProductionServer
);

It is okay to pass empty values for token and refresh_token. In the initial state of the client, you will not know these values.

To start off a fresh client and get a token and refresh_token, use the following.

use gusto_api::Client;

async fn do_call() {
    let mut gusto = Client::new_from_env("", "", gusto_api::RootProductionServer);

    // Get the URL to request consent from the user.
    // You can optionally pass in scopes. If none are provided, then the
    // resulting URL will not have any scopes.
    let user_consent_url = gusto.user_consent_url(&["some-scope".to_string()]);

    // In your redirect URL capture the code sent and our state.
    // Send it along to the request for the token.
    let code = "thing-from-redirect-url";
    let state = "state-from-redirect-url";
    let mut access_token = gusto.get_access_token(code, state).await.unwrap();

    // You can additionally refresh the access token with the following.
    // You must have a refresh token to be able to call this function.
    access_token = gusto.refresh_access_token().await.unwrap();
}

Modules

admins_beta

benefits

companies

company_bank_accounts_beta

compensations

contractor_payments

contractors

current_user

custom_fields

earning_type

employees

garnishments

job_applicants_beta

jobs

locations

pay_schedules

payroll

terminations

time_off_requests

types

The data types sent to and returned from the API client.

Structs

AccessToken

Client

Entrypoint for interacting with the API client.

HeaderMap

A set of HTTP headers

Response

RootDemoServer

RootProductionServer

StatusCode

An HTTP status code (status-code in RFC 7230 et al.).

Enums

ClientError

Errors returned by the client

RootDefaultServers

Constants

FALLBACK_HOST