gusto_app_integration 0.2.4

Python Client SDK Generated by Speakeasy.

gusto_app_integration

Developer-friendly & type-safe Python SDK specifically catered to leverage gusto_app_integration API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Gusto API: Welcome to Gusto's Embedded Payroll API documentation!

Table of Contents

• gusto_app_integration
  • SDK Installation
  • IDE Support
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Resource Management
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

[!NOTE] Python version upgrade policy

Once a Python version reaches its official end of life date, a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.

The SDK can be installed with either pip or poetry package managers.

PIP

PIP is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.

pip install gusto_app_integration

Poetry

Poetry is a modern tool that simplifies dependency management and package publishing by using a single pyproject.toml file to handle project metadata and dependencies.

poetry add gusto_app_integration

Shell and script usage with uv

You can use this SDK in a Python shell with uv and the uvx command that comes with it like so:

uvx --from gusto_app_integration python

It's also possible to write a standalone Python script without needing to set up a whole project like so:

#!/usr/bin/env -S uv run --script
# /// script
# requires-python = ">=3.9"
# dependencies = [
#     "gusto_app_integration",
# ]
# ///

from gusto_app_integration import GustoAppIntegration

sdk = GustoAppIntegration(
  # SDK arguments
)

# Rest of script here...

Once that is saved to a file, you can run it with uv run script.py where script.py can be replaced with the actual file name.

IDE Support

PyCharm

Generally, the SDK will work well with most IDEs out of the box. However, when using PyCharm, you can enjoy much better integration with Pydantic by installing an additional plugin.

• PyCharm Pydantic Plugin

SDK Example Usage

Example

# Synchronous Example
from gusto_app_integration import GustoAppIntegration


with GustoAppIntegration(
    company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
) as gai_client:

    res = gai_client.introspection.get_token_info()

    # Handle response
    print(res)

The same SDK client can also be used to make asychronous requests by importing asyncio.

# Asynchronous Example
import asyncio
from gusto_app_integration import GustoAppIntegration

async def main():

    async with GustoAppIntegration(
        company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
    ) as gai_client:

        res = await gai_client.introspection.get_token_info_async()

        # Handle response
        print(res)

asyncio.run(main())

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
company_access_auth	http	HTTP Bearer

To authenticate with the API the company_access_auth parameter must be set when initializing the SDK client instance. For example:

from gusto_app_integration import GustoAppIntegration


with GustoAppIntegration(
    company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
) as gai_client:

    res = gai_client.introspection.get_token_info()

    # Handle response
    print(res)

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import gusto_app_integration
from gusto_app_integration import GustoAppIntegration


with GustoAppIntegration() as gai_client:

    gai_client.introspection.disconnect_app_integration(security=gusto_app_integration.PostV1DisconnectAppIntegrationSecurity(
        system_access_auth="<YOUR_BEARER_TOKEN_HERE>",
    ), company_id="<id>")

    # Use the SDK ...

Available Resources and Operations

Available methods

companies

• provision - Create a company
• get - Get a company
• update - Update a company
• get_admins - Get all the admins at a company
• get_custom_fields - Get the custom fields of a company

company_benefits

• create - Create a company benefit
• list - Get benefits for a company
• get_by_id - Get a company benefit
• update - Update a company benefit
• delete - Delete a company benefit
• list_supported - Get all benefits supported by Gusto
• get - Get a supported benefit by ID
• get_summary - Get company benefit summary by company benefit id.
• get_employee_benefits - Get all employee benefits for a company benefit
• bulk_update_employee_benefits - Bulk update employee benefits for a company benefit
• get_requirements - Get benefit fields requirements by ID

company_locations

• list - Get company locations

contractor_payment_groups

• get - Get contractor payment groups for a company
• preview - Preview a contractor payment group
• fetch - Fetch a contractor payment group

contractor_payments

• get - Get contractor payments for a company
• get_by_id - Get a single contractor payment

contractors

• create - Create a contractor
• get - Get contractors of a company
• get_by_id - Get a contractor
• update - Update a contractor

departments

• create - Create a department
• get_all - Get all departments of a company
• get - Get a department
• update - Update a department
• delete - Delete a department
• add_people - Add people to a department
• remove_people - Remove people from a department

earning_types

• create - Create a custom earning type
• get - Get all earning types for a company
• update - Update an earning type
• deactivate - Deactivate an earning type

employee_addresses

• list_home_addresses - Get an employee's home addresses
• create - Create an employee's home address
• get - Get an employee's home address
• update - Update an employee's home address
• delete_home_address - Delete an employee's home address
• get_work_addresses - Get an employee's work addresses
• create_work_address - Create an employee work address
• get_work_address - Get an employee work address
• update_work_address - Update an employee work address
• delete_work_address - Delete an employee's work address

employee_benefits

• create - Create an employee benefit
• get_all - Get all benefits for an employee
• get - Get an employee benefit
• update - Update an employee benefit
• delete - Delete an employee benefit
• get_ytd_benefit_amounts_from_different_company - Get year-to-date benefit amounts from a different company
• create_ytd_benefit_amounts_from_different_company - Create year-to-date benefit amounts from a different company

employee_employments

• create_termination - Create an employee termination
• delete_termination - Delete an employee termination
• update_termination - Update an employee termination
• create_rehire - Create an employee rehire
• update_rehire - Update an employee rehire
• get_rehire - Get an employee rehire
• delete_rehire - Delete an employee rehire
• get_history - Get employment history for an employee

employees

• create - Create an employee
• get - Get employees of a company
• get_by_id - Get an employee
• update - Update an employee
• delete - Delete an onboarding employee
• get_custom_fields - Get an employee's custom fields
• get_time_off_activities - Get employee time off activities
• get_terminations - Get terminations for an employee

events

• get_all - Get all events

garnishments

• create - Create a garnishment
• get - Get garnishments for an employee
• get_by_id - Get a garnishment
• update - Update a garnishment
• get_child_support - Get child support garnishment data

introspection

• get_token_info - Get info about the current access token
• revoke - Revoke access token
• refresh_access_token - Refresh access token
• disconnect_app_integration - Disconnect an app integration

jobs

• create - Create a job
• create_compensation - Create a compensation

jobs_and_compensations

• get_jobs - Get jobs for an employee
• get - Get a job
• update_job - Update a job
• delete - Delete an individual job
• get_compensations_for_job - Get compensations for a job
• get_compensation - Get a compensation
• update_compensation - Update a compensation
• delete_compensation - Delete a compensation

locations

• create - Create a company location
• get - Get a location
• update - Update a location
• get_minimum_wages - Get minimum wages for a location

pay_schedules

• list - Get the pay schedules for a company
• get - Get a pay schedule
• get_pay_periods - Get pay periods for a company
• get_unprocessed_termination_pay_periods - Get termination pay periods for a company
• get_assignments - Get pay schedule assignments for a company

payrolls

• get_for_company - Get all payrolls for a company
• get - Get a single payroll
• update - Update a payroll by ID
• prepare - Prepare a payroll for update

time_off_policies

• calculate_accruing_time_off_hours - Calculate accruing time off hours

webhooks

• create - Create a webhook subscription
• list_subscriptions - List webhook subscriptions
• update_subscription - Update a webhook subscription
• get_subscription - Get a webhook subscription
• delete_subscription - Delete a webhook subscription
• verify - Verify the webhook subscription
• request_verification_token - Request the webhook subscription verification_token

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a RetryConfig object to the call:

from gusto_app_integration import GustoAppIntegration
from gusto_app_integration.utils import BackoffStrategy, RetryConfig


with GustoAppIntegration(
    company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
) as gai_client:

    res = gai_client.introspection.get_token_info(,
        RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False))

    # Handle response
    print(res)

If you'd like to override the default retry strategy for all operations that support retries, you can use the retry_config optional parameter when initializing the SDK:

from gusto_app_integration import GustoAppIntegration
from gusto_app_integration.utils import BackoffStrategy, RetryConfig


with GustoAppIntegration(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
) as gai_client:

    res = gai_client.introspection.get_token_info()

    # Handle response
    print(res)

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.

By default, an API error will raise a models.APIError exception, which has the following properties:

Property	Type	Description
.status_code	int	The HTTP status code
.message	str	The error message
.raw_response	httpx.Response	The raw HTTP response
.body	str	The response content

When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the provision_async method may raise the following exceptions:

Error Type	Status Code	Content Type
models.UnprocessableEntityErrorObject	422	application/json
models.APIError	4XX, 5XX	*/*

Example

import gusto_app_integration
from gusto_app_integration import GustoAppIntegration, models


with GustoAppIntegration() as gai_client:
    res = None
    try:

        res = gai_client.companies.provision(security=gusto_app_integration.PostV1ProvisionSecurity(
            system_access_auth="<YOUR_BEARER_TOKEN_HERE>",
        ), user={
            "first_name": "Frank",
            "last_name": "Ocean",
            "email": "[e-mail]",
            "phone": "2345558899",
        }, company={
            "name": "Frank's Ocean, LLC",
            "trade_name": "Frank’s Ocean",
            "ein": "123456789",
            "states": [
                "CO",
                "CA",
            ],
            "number_employees": 8,
            "addresses": [
                {
                    "street_1": "1201 16th Street Mall",
                    "street_2": "Suite 350",
                    "city": "Denver",
                    "zip_code": "80202",
                    "state": "CO",
                    "phone": "2345678900",
                    "is_primary": "true",
                },
                {
                    "street_1": "525 20th Street",
                    "city": "San Francisco",
                    "zip_code": "94107",
                    "state": "CA",
                    "phone": "2345678901",
                },
            ],
        })

        # Handle response
        print(res)

    except models.UnprocessableEntityErrorObject as e:
        # handle e.data: models.UnprocessableEntityErrorObjectData
        raise(e)
    except models.APIError as e:
        # handle exception
        raise(e)

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: str optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Name	Server	Description
demo	https://api.gusto-demo.com	Demo
prod	https://api.gusto.com	Prod

Example

from gusto_app_integration import GustoAppIntegration


with GustoAppIntegration(
    server="prod",
    company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
) as gai_client:

    res = gai_client.introspection.get_token_info()

    # Handle response
    print(res)

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

from gusto_app_integration import GustoAppIntegration


with GustoAppIntegration(
    server_url="https://api.gusto-demo.com",
    company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
) as gai_client:

    res = gai_client.introspection.get_token_info()

    # Handle response
    print(res)

Custom HTTP Client

The Python SDK makes API calls using the httpx HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with your own HTTP client instance. Depending on whether you are using the sync or async version of the SDK, you can pass an instance of HttpClient or AsyncHttpClient respectively, which are Protocol's ensuring that the client has the necessary methods to make API calls. This allows you to wrap the client with your own custom logic, such as adding custom headers, logging, or error handling, or you can just pass an instance of httpx.Client or httpx.AsyncClient directly.

For example, you could specify a header for every request that this sdk makes as follows:

from gusto_app_integration import GustoAppIntegration
import httpx

http_client = httpx.Client(headers={"x-custom-header": "someValue"})
s = GustoAppIntegration(client=http_client)

or you could wrap the client with your own custom logic:

from gusto_app_integration import GustoAppIntegration
from gusto_app_integration.httpclient import AsyncHttpClient
import httpx

class CustomClient(AsyncHttpClient):
    client: AsyncHttpClient

    def __init__(self, client: AsyncHttpClient):
        self.client = client

    async def send(
        self,
        request: httpx.Request,
        *,
        stream: bool = False,
        auth: Union[
            httpx._types.AuthTypes, httpx._client.UseClientDefault, None
        ] = httpx.USE_CLIENT_DEFAULT,
        follow_redirects: Union[
            bool, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
    ) -> httpx.Response:
        request.headers["Client-Level-Header"] = "added by client"

        return await self.client.send(
            request, stream=stream, auth=auth, follow_redirects=follow_redirects
        )

    def build_request(
        self,
        method: str,
        url: httpx._types.URLTypes,
        *,
        content: Optional[httpx._types.RequestContent] = None,
        data: Optional[httpx._types.RequestData] = None,
        files: Optional[httpx._types.RequestFiles] = None,
        json: Optional[Any] = None,
        params: Optional[httpx._types.QueryParamTypes] = None,
        headers: Optional[httpx._types.HeaderTypes] = None,
        cookies: Optional[httpx._types.CookieTypes] = None,
        timeout: Union[
            httpx._types.TimeoutTypes, httpx._client.UseClientDefault
        ] = httpx.USE_CLIENT_DEFAULT,
        extensions: Optional[httpx._types.RequestExtensions] = None,
    ) -> httpx.Request:
        return self.client.build_request(
            method,
            url,
            content=content,
            data=data,
            files=files,
            json=json,
            params=params,
            headers=headers,
            cookies=cookies,
            timeout=timeout,
            extensions=extensions,
        )

s = GustoAppIntegration(async_client=CustomClient(httpx.AsyncClient()))

Resource Management

The GustoAppIntegration class implements the context manager protocol and registers a finalizer function to close the underlying sync and async HTTPX clients it uses under the hood. This will close HTTP connections, release memory and free up other resources held by the SDK. In short-lived Python programs and notebooks that make a few SDK method calls, resource management may not be a concern. However, in longer-lived programs, it is beneficial to create a single SDK instance via a context manager and reuse it across the application.

from gusto_app_integration import GustoAppIntegration
def main():

    with GustoAppIntegration(
        company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
    ) as gai_client:
        # Rest of application here...


# Or when using async:
async def amain():

    async with GustoAppIntegration(
        company_access_auth="<YOUR_BEARER_TOKEN_HERE>",
    ) as gai_client:
        # Rest of application here...

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass your own logger class directly into your SDK.

from gusto_app_integration import GustoAppIntegration
import logging

logging.basicConfig(level=logging.DEBUG)
s = GustoAppIntegration(debug_logger=logging.getLogger("gusto_app_integration"))

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy