gusto_embedded


Namegusto_embedded JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/Gusto/gusto-python-client.git
SummaryPython Client SDK Generated by Speakeasy.
upload_time2025-03-03 21:13:22
maintainerNone
docs_urlNone
authorSpeakeasy
requires_python>=3.9
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # gusto

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

<div align="left">
    <a href="https://www.speakeasy.com/?utm_source=gusto&utm_campaign=python"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
    <a href="https://opensource.org/licenses/MIT">
        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
    </a>
</div>


<!-- Start Summary [summary] -->
## Summary

Gusto API: Welcome to Gusto's Embedded Payroll API documentation!
<!-- End Summary [summary] -->

<!-- Start Table of Contents [toc] -->
## Table of Contents
<!-- $toc-max-depth=2 -->
* [gusto](https://github.com/Gusto/gusto-python-client/blob/master/#gusto)
  * [SDK Installation](https://github.com/Gusto/gusto-python-client/blob/master/#sdk-installation)
  * [IDE Support](https://github.com/Gusto/gusto-python-client/blob/master/#ide-support)
  * [Example Usage](https://github.com/Gusto/gusto-python-client/blob/master/#example-usage)
  * [Authentication](https://github.com/Gusto/gusto-python-client/blob/master/#authentication)
  * [Available Resources and Operations](https://github.com/Gusto/gusto-python-client/blob/master/#available-resources-and-operations)
  * [File uploads](https://github.com/Gusto/gusto-python-client/blob/master/#file-uploads)
  * [Retries](https://github.com/Gusto/gusto-python-client/blob/master/#retries)
  * [Error Handling](https://github.com/Gusto/gusto-python-client/blob/master/#error-handling)
  * [Server Selection](https://github.com/Gusto/gusto-python-client/blob/master/#server-selection)
  * [Custom HTTP Client](https://github.com/Gusto/gusto-python-client/blob/master/#custom-http-client)
  * [Resource Management](https://github.com/Gusto/gusto-python-client/blob/master/#resource-management)
  * [Debugging](https://github.com/Gusto/gusto-python-client/blob/master/#debugging)
* [Development](https://github.com/Gusto/gusto-python-client/blob/master/#development)
  * [Maturity](https://github.com/Gusto/gusto-python-client/blob/master/#maturity)
  * [Contributions](https://github.com/Gusto/gusto-python-client/blob/master/#contributions)

<!-- End Table of Contents [toc] -->

<!-- Start SDK Installation [installation] -->
## SDK Installation

> [!NOTE]
> **Python version upgrade policy**
>
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), 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.

```bash
pip install gusto_embedded
```

### 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.

```bash
poetry add gusto_embedded
```

### Shell and script usage with `uv`

You can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:

```shell
uvx --from gusto_embedded python
```

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

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

from gusto_embedded import Gusto

sdk = Gusto(
  # 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.
<!-- End SDK Installation [installation] -->

<!-- Start IDE Support [idesupport] -->
## 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](https://docs.pydantic.dev/latest/integrations/pycharm/)
<!-- End IDE Support [idesupport] -->

## Example Usage

### Example

```python
# Synchronous Example
from gusto_embedded import Gusto
import os

auth_token = os.getenv("GUSTO_COMPANY_ACCESS_AUTH", None)
if auth_token is None:
	raise ValueError("GUSTO_COMPANY_ACCESS_AUTH is not set")

with Gusto(company_access_auth=auth_token) as gusto:
    res = gusto.introspection.get_info()

    # Handle response
    print(res)
```

</br>

The same SDK client can also be used to make asychronous requests by importing asyncio.
```python
# Asynchronous Example
import asyncio
from gusto_embedded import Gusto
import os

async def main():
  auth_token = os.getenv("GUSTO_COMPANY_ACCESS_AUTH", None)
  if auth_token is None:
    raise ValueError("GUSTO_COMPANY_ACCESS_AUTH is not set")

  async with Gusto(company_access_auth=auth_token) as gusto:
      res = gusto.introspection.get_info_async()

      # Handle response
      print(res)

asyncio.run(main())
```

### Common workflows
A common workflow, as documented [in our docs](https://docs.gusto.com/embedded-payroll/docs/onboard-a-company), is to create a
new partner managed company. In this section we will illustrate using a system access token to create a partner managed
company. Then we will use the returned company access token for subsequent requests. We'll do this in the following steps.
1. [Create a Partner Managed Company](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#create_partner_managed)
2. [View](https://flows.gusto.com/terms) and [Accept](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#accept_terms_of_service) Terms of Service
3. [Create a Company Location](https://docs.gusto.com/embedded-payroll/docs/onboard-a-company#3-create-a-company-location)

```python
# Synchronous Example
from gusto_embedded import Gusto, PostV1PartnerManagedCompaniesSecurity
import os

system_auth_token = os.getenv("GUSTO_SYSTEM_ACCESS_AUTH", None)
if system_auth_token is None:
	raise ValueError("GUSTO_SYSTEM_ACCESS_AUTH is not set")

security = PostV1PartnerManagedCompaniesSecurity(system_access_auth=system_auth_token)
system_gusto = Gusto()
partner_managed_company_res = system_gusto.companies.create_partner_managed(
  security=security,
  user={
    "first_name": "Frank",
    "last_name": "Ocean",
    "email": "frank@example.com",
    "phone": "2345558899",
  },
  company={
      "name": "Frank's Ocean, LLC",
      "trade_name": "Frank’s Ocean",
      "ein": "123432989",
      "contractor_only": False,
  }
)

company_access_token = partner_managed_company_res.access_token
company_refresh_token = partner_managed_company_res.refresh_token
company_uuid = partner_managed_company_res.company_uuid

with Gusto(company_access_auth=company_access_token) as gusto:
    # Get company admin
    company_res = gusto.companies.get(company_id=company_uuid)
    primary_admin = company_res.primary_payroll_admin

    # Accept terms of service
    terms_of_service_res = gusto.companies.accept_terms_of_service(
      company_uuid=company_uuid,
      email=primary_admin.email,
      ip_address="...",
      external_user_id="..."
    )

    # Create a company location
    location_res = gusto.locations.create(
      company_id=company_uuid,
      phone_number="8009360383",
      street_1="425 2nd Street",
      city="San Francisco",
      state="CA",
      zip_code="94107",
      street_2="Suite 602"
    )
```
<!-- No SDK Example Usage [usage] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name                  | Type | Scheme      | Environment Variable        |
| --------------------- | ---- | ----------- | --------------------------- |
| `company_access_auth` | http | HTTP Bearer | `GUSTO_COMPANY_ACCESS_AUTH` |

To authenticate with the API the `company_access_auth` parameter must be set when initializing the SDK client instance. For example:
```python
from gusto_embedded import Gusto
import os


with Gusto(
    company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""),
) as gusto:

    res = gusto.introspection.get_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:
```python
import gusto_embedded
from gusto_embedded import Gusto
import os


with Gusto() as gusto:

    res = gusto.companies.create_partner_managed(security=gusto_embedded.PostV1PartnerManagedCompaniesSecurity(
        system_access_auth=os.getenv("GUSTO_SYSTEM_ACCESS_AUTH", ""),
    ), user={
        "first_name": "Frank",
        "last_name": "Ocean",
        "email": "frank@example.com",
        "phone": "2345558899",
    }, company={
        "name": "Frank's Ocean, LLC",
        "trade_name": "Frank’s Ocean",
        "ein": "123456789",
        "contractor_only": False,
    })

    # Handle response
    print(res)

```
<!-- End Authentication [security] -->

<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations

<details open>
<summary>Available methods</summary>

### [ach_transactions](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/achtransactions/README.md)

* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/achtransactions/README.md#get_all) - Get all ACH transactions for a company

### [bank_accounts](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md#create) - Create a company bank account
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md#get) - Get all company bank accounts
* [verify](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md#verify) - Verify a company bank account
* [create_from_plaid_token](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md#create_from_plaid_token) - Create a bank account from a plaid processor token

### [companies](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md)

* [create_partner_managed](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#create_partner_managed) - Create a partner managed company
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#get) - Get a company
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#update) - Update a company
* [migrate](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#migrate) - Migrate company to embedded payroll
* [accept_terms_of_service](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#accept_terms_of_service) - Accept terms of service for a company user
* [retrieve_terms_of_service](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#retrieve_terms_of_service) - Retrieve terms of service status for a company user
* [create_admin](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#create_admin) - Create an admin for the company
* [list_admins](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#list_admins) - Get all the admins at a company
* [get_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#get_onboarding_status) - Get the company's onboarding status
* [finish_onboarding](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#finish_onboarding) - Finish company onboarding
* [get_custom_fields](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#get_custom_fields) - Get the custom fields of a company

### [company_attachment](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachmentsdk/README.md)

* [get_download_url](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachmentsdk/README.md#get_download_url) - Get a temporary url to download the Company Attachment file

### [company_attachments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachments/README.md)

* [get_details](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachments/README.md#get_details) - Get Company Attachment Details
* [get_list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachments/README.md#get_list) - Get List of Company Attachments
* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachments/README.md#create) - Create Company Attachment and Upload File

### [company_benefits](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#create) - Create a company benefit
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#list) - Get benefits for a company
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get) - Get a company benefit
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#update) - Update a company benefit
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#delete) - Delete a company benefit
* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_all) - Get all benefits supported by Gusto
* [get_supported](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_supported) - Get a supported benefit by ID
* [get_summary](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_summary) - Get company benefit summary by company benefit id.
* [get_employee_benefits](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_employee_benefits) - Get all employee benefits for a company benefit
* [update_employee_benefits](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#update_employee_benefits) - Bulk update employee benefits for a company benefit
* [get_requirements](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_requirements) - Get benefit fields requirements by ID

### [company_forms](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md)

* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md#get_all) - Get all company forms
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md#get) - Get a company form
* [get_pdf](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md#get_pdf) - Get a company form pdf
* [sign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md#sign) - Sign a company form

### [contractor_documents](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md)

* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md#get_all) - Get all contractor documents
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md#get) - Get a contractor document
* [get_pdf](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md#get_pdf) - Get the contractor document pdf
* [sign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md#sign) - Sign a contractor document

### [contractor_forms](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md)

* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md#list) - Get all contractor forms
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md#get) - Get a contractor form
* [get_pdf](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md#get_pdf) - Get the contractor form pdf
* [generate1099](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md#generate1099) - Generate a 1099 form [DEMO]

### [contractor_payment_groups](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#create) - Create a contractor payment group
* [get_list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#get_list) - Get contractor payment groups for a company
* [preview](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#preview) - Preview a contractor payment group
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#get) - Fetch a contractor payment group
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#delete) - Cancel a contractor payment group
* [fund](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#fund) - Fund a contractor payment group [DEMO]

### [contractor_payment_method](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethodsdk/README.md)

* [get_bank_accounts](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethodsdk/README.md#get_bank_accounts) - Get all contractor bank accounts
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethodsdk/README.md#get) - Get a contractor's payment method
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethodsdk/README.md#update) - Update a contractor's payment method

### [contractor_payment_methods](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethods/README.md)

* [create_bank_account](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethods/README.md#create_bank_account) - Create a contractor bank account

### [contractor_payments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md)

* [get_receipt](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#get_receipt) - Get a single contractor payment receipt
* [fund](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#fund) - Fund a contractor payment [DEMO]
* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#create) - Create a contractor payment
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#list) - Get contractor payments for a company
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#get) - Get a single contractor payment
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#delete) - Cancel a contractor payment
* [preview](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#preview) - Preview contractor payment debit date

### [contractors](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#create) - Create a contractor
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#list) - Get contractors of a company
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#get) - Get a contractor
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#update) - Update a contractor
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#delete) - Delete a contractor
* [get_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#get_onboarding_status) - Get the contractor's onboarding status
* [update_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#update_onboarding_status) - Change the contractor's onboarding status
* [get_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#get_address) - Get a contractor address
* [update_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#update_address) - Update a contractor's address

### [departments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#create) - Create a department
* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#get_all) - Get all departments of a company
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#get) - Get a department
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#update) - Update a department
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#delete) - Delete a department
* [add_people](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#add_people) - Add people to a department
* [remove_people](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#remove_people) - Remove people from a department

### [earning_types](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md#create) - Create a custom earning type
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md#list) - Get all earning types for a company
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md#update) - Update an earning type
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md#delete) - Deactivate an earning type

### [employee_addresses](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#get) - Get an employee's home addresses
* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#create) - Create an employee's home address
* [retrieve_home_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#retrieve_home_address) - Get an employee's home address
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#update) - Update an employee's home address
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#delete) - Delete an employee's home address
* [get_work_addresses](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#get_work_addresses) - Get an employee's work addresses
* [create_work_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#create_work_address) - Create an employee work address
* [retrieve_work_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#retrieve_work_address) - Get an employee work address
* [update_work_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#update_work_address) - Update an employee work address
* [delete_work_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#delete_work_address) - Delete an employee's work address

### [employee_benefits](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#create) - Create an employee benefit
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#get) - Get all benefits for an employee
* [retrieve](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#retrieve) - Get an employee benefit
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#update) - Update an employee benefit
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#delete) - Delete an employee benefit
* [get_ytd_benefit_amounts_from_different_company](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#get_ytd_benefit_amounts_from_different_company) - Get year-to-date benefit amounts from a different company
* [create_ytd_benefit_amounts_from_different_company](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#create_ytd_benefit_amounts_from_different_company) - Create year-to-date benefit amounts from a different company

### [employee_employments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md)

* [create_termination](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#create_termination) - Create an employee termination
* [get_terminations](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#get_terminations) - Get terminations for an employee
* [delete_termination](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#delete_termination) - Delete an employee termination
* [update_termination](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#update_termination) - Update an employee termination
* [create_rehire](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#create_rehire) - Create an employee rehire
* [rehire](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#rehire) - Update an employee rehire
* [get_rehire](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#get_rehire) - Get an employee rehire
* [delete_rehire](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#delete_rehire) - Delete an employee rehire
* [get_history](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#get_history) - Get employment history for an employee

### [employee_forms](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md)

* [generate_w2](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#generate_w2) - Generate a W2 form [DEMO]
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#list) - Get all employee forms
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#get) - Get an employee form
* [get_pdf](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#get_pdf) - Get the employee form pdf
* [sign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#sign) - Sign an employee form

### [employee_payment_method](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#create) - Create an employee bank account
* [delete_bank_account](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#delete_bank_account) - Delete an employee bank account
* [update_bank_account](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#update_bank_account) - Update an employee bank account
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#get) - Get an employee's payment method
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#update) - Update an employee's payment method

### [employee_payment_methods](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethods/README.md)

* [get_bank_accounts](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethods/README.md#get_bank_accounts) - Get all employee bank accounts

### [employee_tax_setup](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md)

* [get_federal_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md#get_federal_taxes) - Get an employee's federal taxes
* [update_federal_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md#update_federal_taxes) - Update an employee's federal taxes
* [get_state_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md#get_state_taxes) - Get an employee's state taxes
* [update_state_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md#update_state_taxes) - Update an employee's state taxes

### [employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#create) - Create an employee
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#list) - Get employees of a company
* [create_historical](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#create_historical) - Create a historical employee
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#get) - Get an employee
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#update) - Update an employee
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#delete) - Delete an onboarding employee
* [get_custom_fields](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#get_custom_fields) - Get an employee's custom fields
* [update_onboarding_documents_config](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#update_onboarding_documents_config) - Update an employee's onboarding documents config
* [get_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#get_onboarding_status) - Get the employee's onboarding status
* [update_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#update_onboarding_status) - Update the employee's onboarding status
* [get_time_off_activities](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#get_time_off_activities) - Get employee time off activities

### [events](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/events/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/events/README.md#get) - Get all events

### [external_payrolls](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#create) - Create a new external payroll for a company
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#get) - Get external payrolls for a company
* [retrieve](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#retrieve) - Get an external payroll
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#delete) - Delete an external payroll
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#update) - Update an external payroll
* [calculate_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#calculate_taxes) - Get tax suggestions for an external payroll
* [list_tax_liabilities](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#list_tax_liabilities) - Get tax liabilities
* [update_tax_liabilities](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#update_tax_liabilities) - Update tax liabilities
* [finalize_tax_liabilities](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#finalize_tax_liabilities) - Finalize tax liabilities options and convert into processed payrolls

### [federal_tax_details](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/federaltaxdetailssdk/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/federaltaxdetailssdk/README.md#get) - Get Federal Tax Details
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/federaltaxdetailssdk/README.md#update) - Update Federal Tax Details

### [flows](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/flows/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/flows/README.md#create) - Create a flow

### [garnishments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#create) - Create a garnishment
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#list) - Get garnishments for an employee
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#get) - Get a garnishment
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#update) - Update a garnishment
* [get_child_support_data](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#get_child_support_data) - Get child support garnishment data

### [generated_documents](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/generateddocuments/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/generateddocuments/README.md#get) - Get a generated document


### [historical_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/historicalemployees/README.md)

* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/historicalemployees/README.md#update) - Update a historical employee

### [holiday_pay_policies](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#get) - Get a company's holiday pay policy
* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#create) - Create a holiday pay policy for a company
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#update) - Update a company's holiday pay policy
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#delete) - Delete a company's holiday pay policy
* [add_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#add_employees) - Add employees to a company's holiday pay policy
* [remove_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#remove_employees) - Remove employees from a company's holiday pay policy
* [preview_paid_holidays](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#preview_paid_holidays) - Preview a company's paid holidays

### [i9_verification](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md)

* [get_authorization](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#get_authorization) - Get an employee's I-9 authorization
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#update) - Create or update an employee's I-9 authorization
* [get_document_options](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#get_document_options) - Get an employee's I-9 verification document options
* [get_documents](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#get_documents) - Get an employee's I-9 verification documents
* [create_documents](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#create_documents) - Create an employee's I-9 authorization verification documents
* [delete_document](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#delete_document) - Delete an employee's I-9 verification document
* [employer_sign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#employer_sign) - Employer sign an employee's Form I-9

### [industry_selection](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/industryselection/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/industryselection/README.md#get) - Get a company industry selection
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/industryselection/README.md#update) - Update a company industry selection

### [introspection](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/introspection/README.md)

* [get_info](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/introspection/README.md#get_info) - Get info about the current access token
* [refresh_token](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/introspection/README.md#refresh_token) - Refresh access token

### [invoices](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/invoices/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/invoices/README.md#get) - Retrieve invoicing data for companies

### [jobs_and_compensations](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md)

* [create_job](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#create_job) - Create a job
* [get_jobs](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#get_jobs) - Get jobs for an employee
* [get_job](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#get_job) - Get a job
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#update) - Update a job
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#delete) - Delete an individual job
* [get_compensations](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#get_compensations) - Get compensations for a job
* [create_compensation](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#create_compensation) - Create a compensation
* [get_compensation](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#get_compensation) - Get a compensation
* [update_compensation](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#update_compensation) - Update a compensation
* [delete_compensation](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#delete_compensation) - Delete a compensation

### [locations](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#create) - Create a company location
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#get) - Get company locations
* [retrieve](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#retrieve) - Get a location
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#update) - Update a location
* [get_minimum_wages](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#get_minimum_wages) - Get minimum wages for a location

### [notifications](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/notifications/README.md)

* [get_details](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/notifications/README.md#get_details) - Get a notification's details

### [pay_schedules](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#create) - Create a new pay schedule
* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_all) - Get the pay schedules for a company
* [get_preview](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_preview) - Preview pay schedule dates
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get) - Get a pay schedule
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#update) - Update a pay schedule
* [get_pay_periods](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_pay_periods) - Get pay periods for a company
* [get_unprocessed_termination_periods](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_unprocessed_termination_periods) - Get termination pay periods for a company
* [get_assignments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_assignments) - Get pay schedule assignments for a company
* [preview_assignment](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#preview_assignment) - Preview pay schedule assignments for a company
* [assign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#assign) - Assign pay schedules for a company

### [payment_configs](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/paymentconfigssdk/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/paymentconfigssdk/README.md#get) - Get a company's payment configs
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/paymentconfigssdk/README.md#update) - Update a company's payment configs

### [payrolls](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md)

* [create_off_cycle](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#create_off_cycle) - Create an off-cycle payroll
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#list) - Get all payrolls for a company
* [get_approved_reversals](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_approved_reversals) - Get approved payroll reversals
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get) - Get a single payroll
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#update) - Update a payroll by ID
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#delete) - Delete a payroll
* [prepare](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#prepare) - Prepare a payroll for update
* [get_receipt](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_receipt) - Get a single payroll receipt
* [get_blockers](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_blockers) - Get all payroll blockers for a company
* [skip](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#skip) - Skip a payroll
* [calculate_gross_up](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#calculate_gross_up) - Calculate gross up
* [calculate](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#calculate) - Calculate a payroll
* [submit](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#submit) - Submit payroll
* [cancel](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#cancel) - Cancel a payroll
* [get_pay_stub](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_pay_stub) - Get an employee pay stub (pdf)
* [get_pay_stubs](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_pay_stubs) - Get an employee's pay stubs
* [generate_printable_checks](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#generate_printable_checks) - Generate printable payroll checks (pdf)

### [recovery_cases](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/recoverycases/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/recoverycases/README.md#get) - Get all recovery cases for a company
* [redebit](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/recoverycases/README.md#redebit) - Initiate a redebit for a recovery case

### [reports](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/reports/README.md)

* [create_custom](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/reports/README.md#create_custom) - Create a custom report
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/reports/README.md#get) - Get a report
* [get_template](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/reports/README.md#get_template) - Get a report template

### [signatories](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md)

* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#create) - Create a signatory
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#list) - Get all company signatories
* [invite](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#invite) - Invite a signatory
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#update) - Update a signatory
* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#delete) - Delete a signatory

### [tax_requirements](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/taxrequirements/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/taxrequirements/README.md#get) - Get State Tax Requirements
* [update_state](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/taxrequirements/README.md#update_state) - Update State Tax Requirements
* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/taxrequirements/README.md#get_all) - Get All Tax Requirement States

### [time_off_policies](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md)

* [calculate_accruing_time_off_hours](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#calculate_accruing_time_off_hours) - Calculate accruing time off hours
* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#get) - Get a time off policy
* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#update) - Update a time off policy
* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#get_all) - Get all time off policies
* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#create) - Create a time off policy
* [add_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#add_employees) - Add employees to a time off policy
* [remove_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#remove_employees) - Remove employees from a time off policy
* [update_balance](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#update_balance) - Update employee time off hour balances
* [deactivate](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#deactivate) - Deactivate a time off policy

### [webhooks](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md)

* [create_subscription](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#create_subscription) - Create a webhook subscription
* [list_subscriptions](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#list_subscriptions) - List webhook subscriptions
* [update_subscription](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#update_subscription) - Update a webhook subscription
* [get_subscription](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#get_subscription) - Get a webhook subscription
* [delete_subscription](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#delete_subscription) - Delete a webhook subscription
* [verify](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#verify) - Verify the webhook subscription
* [request_verification_token](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#request_verification_token) - Request the webhook subscription verification_token

### [wire_in_requests](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/wireinrequests/README.md)

* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/wireinrequests/README.md#get) - Get a single Wire In Request
* [submit](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/wireinrequests/README.md#submit) - Submit a wire in request
* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/wireinrequests/README.md#list) - Get all Wire In Requests for a company

</details>
<!-- End Available Resources and Operations [operations] -->

<!-- Start File uploads [file-upload] -->
## File uploads

Certain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP]
>
> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.
>

```python
import gusto_embedded
from gusto_embedded import Gusto
import os


with Gusto(
    company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""),
) as gusto:

    res = gusto.company_attachments.create(company_id="<id>", document={
        "file_name": "example.file",
        "content": open("example.file", "rb"),
    }, category=gusto_embedded.PostV1CompaniesAttachmentCategory.GEP_NOTICE)

    # Handle response
    print(res)

```
<!-- End File uploads [file-upload] -->

<!-- Start Retries [retries] -->
## 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:
```python
from gusto_embedded import Gusto
from gusto_embedded.utils import BackoffStrategy, RetryConfig
import os


with Gusto(
    company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""),
) as gusto:

    res = gusto.introspection.get_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:
```python
from gusto_embedded import Gusto
from gusto_embedded.utils import BackoffStrategy, RetryConfig
import os


with Gusto(
    retry_config=RetryConfig("backoff", BackoffStrategy(1, 50, 1.1, 100), False),
    company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""),
) as gusto:

    res = gusto.introspection.get_info()

    # Handle response
    print(res)

```
<!-- End Retries [retries] -->

<!-- Start Error Handling [errors] -->
## 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 `create_partner_managed_async` method may raise the following exceptions:

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

### Example

```python
import gusto_embedded
from gusto_embedded import Gusto, models
import os


with Gusto() as gusto:
    res = None
    try:

        res = gusto.companies.create_partner_managed(security=gusto_embedded.PostV1PartnerManagedCompaniesSecurity(
            system_access_auth=os.getenv("GUSTO_SYSTEM_ACCESS_AUTH", ""),
        ), user={
            "first_name": "Frank",
            "last_name": "Ocean",
            "email": "frank@example.com",
            "phone": "2345558899",
        }, company={
            "name": "Frank's Ocean, LLC",
            "trade_name": "Frank’s Ocean",
            "ein": "123456789",
            "contractor_only": False,
        })

        # 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)
```
<!-- End Error Handling [errors] -->

<!-- Start Server Selection [server] -->
## 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

```python
from gusto_embedded import Gusto
import os


with Gusto(
    server="prod",
    company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""),
) as gusto:

    res = gusto.introspection.get_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:
```python
from gusto_embedded import Gusto
import os


with Gusto(
    server_url="https://api.gusto-demo.com",
    company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""),
) as gusto:

    res = gusto.introspection.get_info()

    # Handle response
    print(res)

```
<!-- End Server Selection [server] -->

<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client

The Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) 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:
```python
from gusto_embedded import Gusto
import httpx

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

or you could wrap the client with your own custom logic:
```python
from gusto_embedded import Gusto
from gusto_embedded.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 = Gusto(async_client=CustomClient(httpx.AsyncClient()))
```
<!-- End Custom HTTP Client [http-client] -->

<!-- Start Resource Management [resource-management] -->
## Resource Management

The `Gusto` 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][context-manager] and reuse it across the application.

[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers

```python
from gusto_embedded import Gusto
import os
def main():

    with Gusto(
        company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""),
    ) as gusto:
        # Rest of application here...


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

    async with Gusto(
        company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""),
    ) as gusto:
        # Rest of application here...
```
<!-- End Resource Management [resource-management] -->

<!-- Start Debugging [debug] -->
## 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.
```python
from gusto_embedded import Gusto
import logging

logging.basicConfig(level=logging.DEBUG)
s = Gusto(debug_logger=logging.getLogger("gusto_embedded"))
```

You can also enable a default debug logger by setting an environment variable `GUSTO_DEBUG` to true.
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

# 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](https://www.speakeasy.com/?utm_source=gusto&utm_campaign=python)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Gusto/gusto-python-client.git",
    "name": "gusto_embedded",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Speakeasy",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/82/7d/1d0402dc54638159183879a03914ce53c49ac5d855279ae576be704603ee/gusto_embedded-0.1.1.tar.gz",
    "platform": null,
    "description": "# gusto\n\nDeveloper-friendly & type-safe Python SDK specifically catered to leverage *gusto* API.\n\n<div align=\"left\">\n    <a href=\"https://www.speakeasy.com/?utm_source=gusto&utm_campaign=python\"><img src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454\" /></a>\n    <a href=\"https://opensource.org/licenses/MIT\">\n        <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n    </a>\n</div>\n\n\n<!-- Start Summary [summary] -->\n## Summary\n\nGusto API: Welcome to Gusto's Embedded Payroll API documentation!\n<!-- End Summary [summary] -->\n\n<!-- Start Table of Contents [toc] -->\n## Table of Contents\n<!-- $toc-max-depth=2 -->\n* [gusto](https://github.com/Gusto/gusto-python-client/blob/master/#gusto)\n  * [SDK Installation](https://github.com/Gusto/gusto-python-client/blob/master/#sdk-installation)\n  * [IDE Support](https://github.com/Gusto/gusto-python-client/blob/master/#ide-support)\n  * [Example Usage](https://github.com/Gusto/gusto-python-client/blob/master/#example-usage)\n  * [Authentication](https://github.com/Gusto/gusto-python-client/blob/master/#authentication)\n  * [Available Resources and Operations](https://github.com/Gusto/gusto-python-client/blob/master/#available-resources-and-operations)\n  * [File uploads](https://github.com/Gusto/gusto-python-client/blob/master/#file-uploads)\n  * [Retries](https://github.com/Gusto/gusto-python-client/blob/master/#retries)\n  * [Error Handling](https://github.com/Gusto/gusto-python-client/blob/master/#error-handling)\n  * [Server Selection](https://github.com/Gusto/gusto-python-client/blob/master/#server-selection)\n  * [Custom HTTP Client](https://github.com/Gusto/gusto-python-client/blob/master/#custom-http-client)\n  * [Resource Management](https://github.com/Gusto/gusto-python-client/blob/master/#resource-management)\n  * [Debugging](https://github.com/Gusto/gusto-python-client/blob/master/#debugging)\n* [Development](https://github.com/Gusto/gusto-python-client/blob/master/#development)\n  * [Maturity](https://github.com/Gusto/gusto-python-client/blob/master/#maturity)\n  * [Contributions](https://github.com/Gusto/gusto-python-client/blob/master/#contributions)\n\n<!-- End Table of Contents [toc] -->\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n> [!NOTE]\n> **Python version upgrade policy**\n>\n> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), 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.\n\nThe SDK can be installed with either *pip* or *poetry* package managers.\n\n### PIP\n\n*PIP* is the default package installer for Python, enabling easy installation and management of packages from PyPI via the command line.\n\n```bash\npip install gusto_embedded\n```\n\n### Poetry\n\n*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.\n\n```bash\npoetry add gusto_embedded\n```\n\n### Shell and script usage with `uv`\n\nYou can use this SDK in a Python shell with [uv](https://docs.astral.sh/uv/) and the `uvx` command that comes with it like so:\n\n```shell\nuvx --from gusto_embedded python\n```\n\nIt's also possible to write a standalone Python script without needing to set up a whole project like so:\n\n```python\n#!/usr/bin/env -S uv run --script\n# /// script\n# requires-python = \">=3.9\"\n# dependencies = [\n#     \"gusto_embedded\",\n# ]\n# ///\n\nfrom gusto_embedded import Gusto\n\nsdk = Gusto(\n  # SDK arguments\n)\n\n# Rest of script here...\n```\n\nOnce that is saved to a file, you can run it with `uv run script.py` where\n`script.py` can be replaced with the actual file name.\n<!-- End SDK Installation [installation] -->\n\n<!-- Start IDE Support [idesupport] -->\n## IDE Support\n\n### PyCharm\n\nGenerally, 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.\n\n- [PyCharm Pydantic Plugin](https://docs.pydantic.dev/latest/integrations/pycharm/)\n<!-- End IDE Support [idesupport] -->\n\n## Example Usage\n\n### Example\n\n```python\n# Synchronous Example\nfrom gusto_embedded import Gusto\nimport os\n\nauth_token = os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", None)\nif auth_token is None:\n\traise ValueError(\"GUSTO_COMPANY_ACCESS_AUTH is not set\")\n\nwith Gusto(company_access_auth=auth_token) as gusto:\n    res = gusto.introspection.get_info()\n\n    # Handle response\n    print(res)\n```\n\n</br>\n\nThe same SDK client can also be used to make asychronous requests by importing asyncio.\n```python\n# Asynchronous Example\nimport asyncio\nfrom gusto_embedded import Gusto\nimport os\n\nasync def main():\n  auth_token = os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", None)\n  if auth_token is None:\n    raise ValueError(\"GUSTO_COMPANY_ACCESS_AUTH is not set\")\n\n  async with Gusto(company_access_auth=auth_token) as gusto:\n      res = gusto.introspection.get_info_async()\n\n      # Handle response\n      print(res)\n\nasyncio.run(main())\n```\n\n### Common workflows\nA common workflow, as documented [in our docs](https://docs.gusto.com/embedded-payroll/docs/onboard-a-company), is to create a\nnew partner managed company. In this section we will illustrate using a system access token to create a partner managed\ncompany. Then we will use the returned company access token for subsequent requests. We'll do this in the following steps.\n1. [Create a Partner Managed Company](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#create_partner_managed)\n2. [View](https://flows.gusto.com/terms) and [Accept](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#accept_terms_of_service) Terms of Service\n3. [Create a Company Location](https://docs.gusto.com/embedded-payroll/docs/onboard-a-company#3-create-a-company-location)\n\n```python\n# Synchronous Example\nfrom gusto_embedded import Gusto, PostV1PartnerManagedCompaniesSecurity\nimport os\n\nsystem_auth_token = os.getenv(\"GUSTO_SYSTEM_ACCESS_AUTH\", None)\nif system_auth_token is None:\n\traise ValueError(\"GUSTO_SYSTEM_ACCESS_AUTH is not set\")\n\nsecurity = PostV1PartnerManagedCompaniesSecurity(system_access_auth=system_auth_token)\nsystem_gusto = Gusto()\npartner_managed_company_res = system_gusto.companies.create_partner_managed(\n  security=security,\n  user={\n    \"first_name\": \"Frank\",\n    \"last_name\": \"Ocean\",\n    \"email\": \"frank@example.com\",\n    \"phone\": \"2345558899\",\n  },\n  company={\n      \"name\": \"Frank's Ocean, LLC\",\n      \"trade_name\": \"Frank\u2019s Ocean\",\n      \"ein\": \"123432989\",\n      \"contractor_only\": False,\n  }\n)\n\ncompany_access_token = partner_managed_company_res.access_token\ncompany_refresh_token = partner_managed_company_res.refresh_token\ncompany_uuid = partner_managed_company_res.company_uuid\n\nwith Gusto(company_access_auth=company_access_token) as gusto:\n    # Get company admin\n    company_res = gusto.companies.get(company_id=company_uuid)\n    primary_admin = company_res.primary_payroll_admin\n\n    # Accept terms of service\n    terms_of_service_res = gusto.companies.accept_terms_of_service(\n      company_uuid=company_uuid,\n      email=primary_admin.email,\n      ip_address=\"...\",\n      external_user_id=\"...\"\n    )\n\n    # Create a company location\n    location_res = gusto.locations.create(\n      company_id=company_uuid,\n      phone_number=\"8009360383\",\n      street_1=\"425 2nd Street\",\n      city=\"San Francisco\",\n      state=\"CA\",\n      zip_code=\"94107\",\n      street_2=\"Suite 602\"\n    )\n```\n<!-- No SDK Example Usage [usage] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name                  | Type | Scheme      | Environment Variable        |\n| --------------------- | ---- | ----------- | --------------------------- |\n| `company_access_auth` | http | HTTP Bearer | `GUSTO_COMPANY_ACCESS_AUTH` |\n\nTo authenticate with the API the `company_access_auth` parameter must be set when initializing the SDK client instance. For example:\n```python\nfrom gusto_embedded import Gusto\nimport os\n\n\nwith Gusto(\n    company_access_auth=os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", \"\"),\n) as gusto:\n\n    res = gusto.introspection.get_info()\n\n    # Handle response\n    print(res)\n\n```\n\n### Per-Operation Security Schemes\n\nSome operations in this SDK require the security scheme to be specified at the request level. For example:\n```python\nimport gusto_embedded\nfrom gusto_embedded import Gusto\nimport os\n\n\nwith Gusto() as gusto:\n\n    res = gusto.companies.create_partner_managed(security=gusto_embedded.PostV1PartnerManagedCompaniesSecurity(\n        system_access_auth=os.getenv(\"GUSTO_SYSTEM_ACCESS_AUTH\", \"\"),\n    ), user={\n        \"first_name\": \"Frank\",\n        \"last_name\": \"Ocean\",\n        \"email\": \"frank@example.com\",\n        \"phone\": \"2345558899\",\n    }, company={\n        \"name\": \"Frank's Ocean, LLC\",\n        \"trade_name\": \"Frank\u2019s Ocean\",\n        \"ein\": \"123456789\",\n        \"contractor_only\": False,\n    })\n\n    # Handle response\n    print(res)\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n<details open>\n<summary>Available methods</summary>\n\n### [ach_transactions](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/achtransactions/README.md)\n\n* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/achtransactions/README.md#get_all) - Get all ACH transactions for a company\n\n### [bank_accounts](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md#create) - Create a company bank account\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md#get) - Get all company bank accounts\n* [verify](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md#verify) - Verify a company bank account\n* [create_from_plaid_token](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/bankaccounts/README.md#create_from_plaid_token) - Create a bank account from a plaid processor token\n\n### [companies](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md)\n\n* [create_partner_managed](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#create_partner_managed) - Create a partner managed company\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#get) - Get a company\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#update) - Update a company\n* [migrate](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#migrate) - Migrate company to embedded payroll\n* [accept_terms_of_service](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#accept_terms_of_service) - Accept terms of service for a company user\n* [retrieve_terms_of_service](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#retrieve_terms_of_service) - Retrieve terms of service status for a company user\n* [create_admin](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#create_admin) - Create an admin for the company\n* [list_admins](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#list_admins) - Get all the admins at a company\n* [get_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#get_onboarding_status) - Get the company's onboarding status\n* [finish_onboarding](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#finish_onboarding) - Finish company onboarding\n* [get_custom_fields](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companies/README.md#get_custom_fields) - Get the custom fields of a company\n\n### [company_attachment](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachmentsdk/README.md)\n\n* [get_download_url](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachmentsdk/README.md#get_download_url) - Get a temporary url to download the Company Attachment file\n\n### [company_attachments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachments/README.md)\n\n* [get_details](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachments/README.md#get_details) - Get Company Attachment Details\n* [get_list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachments/README.md#get_list) - Get List of Company Attachments\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyattachments/README.md#create) - Create Company Attachment and Upload File\n\n### [company_benefits](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#create) - Create a company benefit\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#list) - Get benefits for a company\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get) - Get a company benefit\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#update) - Update a company benefit\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#delete) - Delete a company benefit\n* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_all) - Get all benefits supported by Gusto\n* [get_supported](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_supported) - Get a supported benefit by ID\n* [get_summary](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_summary) - Get company benefit summary by company benefit id.\n* [get_employee_benefits](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_employee_benefits) - Get all employee benefits for a company benefit\n* [update_employee_benefits](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#update_employee_benefits) - Bulk update employee benefits for a company benefit\n* [get_requirements](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companybenefits/README.md#get_requirements) - Get benefit fields requirements by ID\n\n### [company_forms](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md)\n\n* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md#get_all) - Get all company forms\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md#get) - Get a company form\n* [get_pdf](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md#get_pdf) - Get a company form pdf\n* [sign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/companyforms/README.md#sign) - Sign a company form\n\n### [contractor_documents](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md)\n\n* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md#get_all) - Get all contractor documents\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md#get) - Get a contractor document\n* [get_pdf](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md#get_pdf) - Get the contractor document pdf\n* [sign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractordocuments/README.md#sign) - Sign a contractor document\n\n### [contractor_forms](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md)\n\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md#list) - Get all contractor forms\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md#get) - Get a contractor form\n* [get_pdf](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md#get_pdf) - Get the contractor form pdf\n* [generate1099](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorforms/README.md#generate1099) - Generate a 1099 form [DEMO]\n\n### [contractor_payment_groups](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#create) - Create a contractor payment group\n* [get_list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#get_list) - Get contractor payment groups for a company\n* [preview](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#preview) - Preview a contractor payment group\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#get) - Fetch a contractor payment group\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#delete) - Cancel a contractor payment group\n* [fund](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentgroups/README.md#fund) - Fund a contractor payment group [DEMO]\n\n### [contractor_payment_method](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethodsdk/README.md)\n\n* [get_bank_accounts](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethodsdk/README.md#get_bank_accounts) - Get all contractor bank accounts\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethodsdk/README.md#get) - Get a contractor's payment method\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethodsdk/README.md#update) - Update a contractor's payment method\n\n### [contractor_payment_methods](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethods/README.md)\n\n* [create_bank_account](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpaymentmethods/README.md#create_bank_account) - Create a contractor bank account\n\n### [contractor_payments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md)\n\n* [get_receipt](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#get_receipt) - Get a single contractor payment receipt\n* [fund](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#fund) - Fund a contractor payment [DEMO]\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#create) - Create a contractor payment\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#list) - Get contractor payments for a company\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#get) - Get a single contractor payment\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#delete) - Cancel a contractor payment\n* [preview](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractorpayments/README.md#preview) - Preview contractor payment debit date\n\n### [contractors](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#create) - Create a contractor\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#list) - Get contractors of a company\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#get) - Get a contractor\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#update) - Update a contractor\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#delete) - Delete a contractor\n* [get_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#get_onboarding_status) - Get the contractor's onboarding status\n* [update_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#update_onboarding_status) - Change the contractor's onboarding status\n* [get_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#get_address) - Get a contractor address\n* [update_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/contractors/README.md#update_address) - Update a contractor's address\n\n### [departments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#create) - Create a department\n* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#get_all) - Get all departments of a company\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#get) - Get a department\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#update) - Update a department\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#delete) - Delete a department\n* [add_people](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#add_people) - Add people to a department\n* [remove_people](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/departments/README.md#remove_people) - Remove people from a department\n\n### [earning_types](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md#create) - Create a custom earning type\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md#list) - Get all earning types for a company\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md#update) - Update an earning type\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/earningtypes/README.md#delete) - Deactivate an earning type\n\n### [employee_addresses](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#get) - Get an employee's home addresses\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#create) - Create an employee's home address\n* [retrieve_home_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#retrieve_home_address) - Get an employee's home address\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#update) - Update an employee's home address\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#delete) - Delete an employee's home address\n* [get_work_addresses](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#get_work_addresses) - Get an employee's work addresses\n* [create_work_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#create_work_address) - Create an employee work address\n* [retrieve_work_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#retrieve_work_address) - Get an employee work address\n* [update_work_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#update_work_address) - Update an employee work address\n* [delete_work_address](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeaddresses/README.md#delete_work_address) - Delete an employee's work address\n\n### [employee_benefits](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#create) - Create an employee benefit\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#get) - Get all benefits for an employee\n* [retrieve](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#retrieve) - Get an employee benefit\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#update) - Update an employee benefit\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#delete) - Delete an employee benefit\n* [get_ytd_benefit_amounts_from_different_company](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#get_ytd_benefit_amounts_from_different_company) - Get year-to-date benefit amounts from a different company\n* [create_ytd_benefit_amounts_from_different_company](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeebenefits/README.md#create_ytd_benefit_amounts_from_different_company) - Create year-to-date benefit amounts from a different company\n\n### [employee_employments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md)\n\n* [create_termination](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#create_termination) - Create an employee termination\n* [get_terminations](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#get_terminations) - Get terminations for an employee\n* [delete_termination](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#delete_termination) - Delete an employee termination\n* [update_termination](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#update_termination) - Update an employee termination\n* [create_rehire](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#create_rehire) - Create an employee rehire\n* [rehire](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#rehire) - Update an employee rehire\n* [get_rehire](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#get_rehire) - Get an employee rehire\n* [delete_rehire](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#delete_rehire) - Delete an employee rehire\n* [get_history](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeemployments/README.md#get_history) - Get employment history for an employee\n\n### [employee_forms](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md)\n\n* [generate_w2](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#generate_w2) - Generate a W2 form [DEMO]\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#list) - Get all employee forms\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#get) - Get an employee form\n* [get_pdf](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#get_pdf) - Get the employee form pdf\n* [sign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeeforms/README.md#sign) - Sign an employee form\n\n### [employee_payment_method](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#create) - Create an employee bank account\n* [delete_bank_account](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#delete_bank_account) - Delete an employee bank account\n* [update_bank_account](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#update_bank_account) - Update an employee bank account\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#get) - Get an employee's payment method\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethodsdk/README.md#update) - Update an employee's payment method\n\n### [employee_payment_methods](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethods/README.md)\n\n* [get_bank_accounts](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeepaymentmethods/README.md#get_bank_accounts) - Get all employee bank accounts\n\n### [employee_tax_setup](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md)\n\n* [get_federal_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md#get_federal_taxes) - Get an employee's federal taxes\n* [update_federal_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md#update_federal_taxes) - Update an employee's federal taxes\n* [get_state_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md#get_state_taxes) - Get an employee's state taxes\n* [update_state_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employeetaxsetup/README.md#update_state_taxes) - Update an employee's state taxes\n\n### [employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#create) - Create an employee\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#list) - Get employees of a company\n* [create_historical](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#create_historical) - Create a historical employee\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#get) - Get an employee\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#update) - Update an employee\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#delete) - Delete an onboarding employee\n* [get_custom_fields](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#get_custom_fields) - Get an employee's custom fields\n* [update_onboarding_documents_config](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#update_onboarding_documents_config) - Update an employee's onboarding documents config\n* [get_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#get_onboarding_status) - Get the employee's onboarding status\n* [update_onboarding_status](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#update_onboarding_status) - Update the employee's onboarding status\n* [get_time_off_activities](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/employees/README.md#get_time_off_activities) - Get employee time off activities\n\n### [events](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/events/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/events/README.md#get) - Get all events\n\n### [external_payrolls](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#create) - Create a new external payroll for a company\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#get) - Get external payrolls for a company\n* [retrieve](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#retrieve) - Get an external payroll\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#delete) - Delete an external payroll\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#update) - Update an external payroll\n* [calculate_taxes](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#calculate_taxes) - Get tax suggestions for an external payroll\n* [list_tax_liabilities](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#list_tax_liabilities) - Get tax liabilities\n* [update_tax_liabilities](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#update_tax_liabilities) - Update tax liabilities\n* [finalize_tax_liabilities](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/externalpayrolls/README.md#finalize_tax_liabilities) - Finalize tax liabilities options and convert into processed payrolls\n\n### [federal_tax_details](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/federaltaxdetailssdk/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/federaltaxdetailssdk/README.md#get) - Get Federal Tax Details\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/federaltaxdetailssdk/README.md#update) - Update Federal Tax Details\n\n### [flows](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/flows/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/flows/README.md#create) - Create a flow\n\n### [garnishments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#create) - Create a garnishment\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#list) - Get garnishments for an employee\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#get) - Get a garnishment\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#update) - Update a garnishment\n* [get_child_support_data](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/garnishments/README.md#get_child_support_data) - Get child support garnishment data\n\n### [generated_documents](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/generateddocuments/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/generateddocuments/README.md#get) - Get a generated document\n\n\n### [historical_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/historicalemployees/README.md)\n\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/historicalemployees/README.md#update) - Update a historical employee\n\n### [holiday_pay_policies](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#get) - Get a company's holiday pay policy\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#create) - Create a holiday pay policy for a company\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#update) - Update a company's holiday pay policy\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#delete) - Delete a company's holiday pay policy\n* [add_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#add_employees) - Add employees to a company's holiday pay policy\n* [remove_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#remove_employees) - Remove employees from a company's holiday pay policy\n* [preview_paid_holidays](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/holidaypaypolicies/README.md#preview_paid_holidays) - Preview a company's paid holidays\n\n### [i9_verification](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md)\n\n* [get_authorization](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#get_authorization) - Get an employee's I-9 authorization\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#update) - Create or update an employee's I-9 authorization\n* [get_document_options](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#get_document_options) - Get an employee's I-9 verification document options\n* [get_documents](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#get_documents) - Get an employee's I-9 verification documents\n* [create_documents](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#create_documents) - Create an employee's I-9 authorization verification documents\n* [delete_document](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#delete_document) - Delete an employee's I-9 verification document\n* [employer_sign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/i9verification/README.md#employer_sign) - Employer sign an employee's Form I-9\n\n### [industry_selection](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/industryselection/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/industryselection/README.md#get) - Get a company industry selection\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/industryselection/README.md#update) - Update a company industry selection\n\n### [introspection](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/introspection/README.md)\n\n* [get_info](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/introspection/README.md#get_info) - Get info about the current access token\n* [refresh_token](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/introspection/README.md#refresh_token) - Refresh access token\n\n### [invoices](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/invoices/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/invoices/README.md#get) - Retrieve invoicing data for companies\n\n### [jobs_and_compensations](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md)\n\n* [create_job](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#create_job) - Create a job\n* [get_jobs](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#get_jobs) - Get jobs for an employee\n* [get_job](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#get_job) - Get a job\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#update) - Update a job\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#delete) - Delete an individual job\n* [get_compensations](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#get_compensations) - Get compensations for a job\n* [create_compensation](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#create_compensation) - Create a compensation\n* [get_compensation](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#get_compensation) - Get a compensation\n* [update_compensation](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#update_compensation) - Update a compensation\n* [delete_compensation](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/jobsandcompensations/README.md#delete_compensation) - Delete a compensation\n\n### [locations](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#create) - Create a company location\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#get) - Get company locations\n* [retrieve](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#retrieve) - Get a location\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#update) - Update a location\n* [get_minimum_wages](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/locations/README.md#get_minimum_wages) - Get minimum wages for a location\n\n### [notifications](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/notifications/README.md)\n\n* [get_details](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/notifications/README.md#get_details) - Get a notification's details\n\n### [pay_schedules](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#create) - Create a new pay schedule\n* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_all) - Get the pay schedules for a company\n* [get_preview](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_preview) - Preview pay schedule dates\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get) - Get a pay schedule\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#update) - Update a pay schedule\n* [get_pay_periods](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_pay_periods) - Get pay periods for a company\n* [get_unprocessed_termination_periods](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_unprocessed_termination_periods) - Get termination pay periods for a company\n* [get_assignments](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#get_assignments) - Get pay schedule assignments for a company\n* [preview_assignment](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#preview_assignment) - Preview pay schedule assignments for a company\n* [assign](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payschedules/README.md#assign) - Assign pay schedules for a company\n\n### [payment_configs](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/paymentconfigssdk/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/paymentconfigssdk/README.md#get) - Get a company's payment configs\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/paymentconfigssdk/README.md#update) - Update a company's payment configs\n\n### [payrolls](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md)\n\n* [create_off_cycle](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#create_off_cycle) - Create an off-cycle payroll\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#list) - Get all payrolls for a company\n* [get_approved_reversals](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_approved_reversals) - Get approved payroll reversals\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get) - Get a single payroll\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#update) - Update a payroll by ID\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#delete) - Delete a payroll\n* [prepare](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#prepare) - Prepare a payroll for update\n* [get_receipt](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_receipt) - Get a single payroll receipt\n* [get_blockers](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_blockers) - Get all payroll blockers for a company\n* [skip](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#skip) - Skip a payroll\n* [calculate_gross_up](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#calculate_gross_up) - Calculate gross up\n* [calculate](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#calculate) - Calculate a payroll\n* [submit](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#submit) - Submit payroll\n* [cancel](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#cancel) - Cancel a payroll\n* [get_pay_stub](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_pay_stub) - Get an employee pay stub (pdf)\n* [get_pay_stubs](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#get_pay_stubs) - Get an employee's pay stubs\n* [generate_printable_checks](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/payrolls/README.md#generate_printable_checks) - Generate printable payroll checks (pdf)\n\n### [recovery_cases](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/recoverycases/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/recoverycases/README.md#get) - Get all recovery cases for a company\n* [redebit](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/recoverycases/README.md#redebit) - Initiate a redebit for a recovery case\n\n### [reports](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/reports/README.md)\n\n* [create_custom](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/reports/README.md#create_custom) - Create a custom report\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/reports/README.md#get) - Get a report\n* [get_template](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/reports/README.md#get_template) - Get a report template\n\n### [signatories](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md)\n\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#create) - Create a signatory\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#list) - Get all company signatories\n* [invite](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#invite) - Invite a signatory\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#update) - Update a signatory\n* [delete](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/signatories/README.md#delete) - Delete a signatory\n\n### [tax_requirements](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/taxrequirements/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/taxrequirements/README.md#get) - Get State Tax Requirements\n* [update_state](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/taxrequirements/README.md#update_state) - Update State Tax Requirements\n* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/taxrequirements/README.md#get_all) - Get All Tax Requirement States\n\n### [time_off_policies](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md)\n\n* [calculate_accruing_time_off_hours](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#calculate_accruing_time_off_hours) - Calculate accruing time off hours\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#get) - Get a time off policy\n* [update](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#update) - Update a time off policy\n* [get_all](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#get_all) - Get all time off policies\n* [create](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#create) - Create a time off policy\n* [add_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#add_employees) - Add employees to a time off policy\n* [remove_employees](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#remove_employees) - Remove employees from a time off policy\n* [update_balance](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#update_balance) - Update employee time off hour balances\n* [deactivate](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/timeoffpolicies/README.md#deactivate) - Deactivate a time off policy\n\n### [webhooks](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md)\n\n* [create_subscription](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#create_subscription) - Create a webhook subscription\n* [list_subscriptions](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#list_subscriptions) - List webhook subscriptions\n* [update_subscription](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#update_subscription) - Update a webhook subscription\n* [get_subscription](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#get_subscription) - Get a webhook subscription\n* [delete_subscription](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#delete_subscription) - Delete a webhook subscription\n* [verify](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#verify) - Verify the webhook subscription\n* [request_verification_token](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/webhooks/README.md#request_verification_token) - Request the webhook subscription verification_token\n\n### [wire_in_requests](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/wireinrequests/README.md)\n\n* [get](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/wireinrequests/README.md#get) - Get a single Wire In Request\n* [submit](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/wireinrequests/README.md#submit) - Submit a wire in request\n* [list](https://github.com/Gusto/gusto-python-client/blob/master/docs/sdks/wireinrequests/README.md#list) - Get all Wire In Requests for a company\n\n</details>\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start File uploads [file-upload] -->\n## File uploads\n\nCertain SDK methods accept file objects as part of a request body or multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.\n\n> [!TIP]\n>\n> For endpoints that handle file uploads bytes arrays can also be used. However, using streams is recommended for large files.\n>\n\n```python\nimport gusto_embedded\nfrom gusto_embedded import Gusto\nimport os\n\n\nwith Gusto(\n    company_access_auth=os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", \"\"),\n) as gusto:\n\n    res = gusto.company_attachments.create(company_id=\"<id>\", document={\n        \"file_name\": \"example.file\",\n        \"content\": open(\"example.file\", \"rb\"),\n    }, category=gusto_embedded.PostV1CompaniesAttachmentCategory.GEP_NOTICE)\n\n    # Handle response\n    print(res)\n\n```\n<!-- End File uploads [file-upload] -->\n\n<!-- Start Retries [retries] -->\n## Retries\n\nSome 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.\n\nTo change the default retry strategy for a single API call, simply provide a `RetryConfig` object to the call:\n```python\nfrom gusto_embedded import Gusto\nfrom gusto_embedded.utils import BackoffStrategy, RetryConfig\nimport os\n\n\nwith Gusto(\n    company_access_auth=os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", \"\"),\n) as gusto:\n\n    res = gusto.introspection.get_info(,\n        RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False))\n\n    # Handle response\n    print(res)\n\n```\n\nIf 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:\n```python\nfrom gusto_embedded import Gusto\nfrom gusto_embedded.utils import BackoffStrategy, RetryConfig\nimport os\n\n\nwith Gusto(\n    retry_config=RetryConfig(\"backoff\", BackoffStrategy(1, 50, 1.1, 100), False),\n    company_access_auth=os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", \"\"),\n) as gusto:\n\n    res = gusto.introspection.get_info()\n\n    # Handle response\n    print(res)\n\n```\n<!-- End Retries [retries] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.\n\nBy default, an API error will raise a models.APIError exception, which has the following properties:\n\n| Property        | Type             | Description           |\n|-----------------|------------------|-----------------------|\n| `.status_code`  | *int*            | The HTTP status code  |\n| `.message`      | *str*            | The error message     |\n| `.raw_response` | *httpx.Response* | The raw HTTP response |\n| `.body`         | *str*            | The response content  |\n\nWhen 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 `create_partner_managed_async` method may raise the following exceptions:\n\n| Error Type                            | Status Code | Content Type     |\n| ------------------------------------- | ----------- | ---------------- |\n| models.UnprocessableEntityErrorObject | 422         | application/json |\n| models.APIError                       | 4XX, 5XX    | \\*/\\*            |\n\n### Example\n\n```python\nimport gusto_embedded\nfrom gusto_embedded import Gusto, models\nimport os\n\n\nwith Gusto() as gusto:\n    res = None\n    try:\n\n        res = gusto.companies.create_partner_managed(security=gusto_embedded.PostV1PartnerManagedCompaniesSecurity(\n            system_access_auth=os.getenv(\"GUSTO_SYSTEM_ACCESS_AUTH\", \"\"),\n        ), user={\n            \"first_name\": \"Frank\",\n            \"last_name\": \"Ocean\",\n            \"email\": \"frank@example.com\",\n            \"phone\": \"2345558899\",\n        }, company={\n            \"name\": \"Frank's Ocean, LLC\",\n            \"trade_name\": \"Frank\u2019s Ocean\",\n            \"ein\": \"123456789\",\n            \"contractor_only\": False,\n        })\n\n        # Handle response\n        print(res)\n\n    except models.UnprocessableEntityErrorObject as e:\n        # handle e.data: models.UnprocessableEntityErrorObjectData\n        raise(e)\n    except models.APIError as e:\n        # handle exception\n        raise(e)\n```\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Select Server by Name\n\nYou 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:\n\n| Name   | Server                       | Description |\n| ------ | ---------------------------- | ----------- |\n| `demo` | `https://api.gusto-demo.com` | Demo        |\n| `prod` | `https://api.gusto.com`      | Prod        |\n\n#### Example\n\n```python\nfrom gusto_embedded import Gusto\nimport os\n\n\nwith Gusto(\n    server=\"prod\",\n    company_access_auth=os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", \"\"),\n) as gusto:\n\n    res = gusto.introspection.get_info()\n\n    # Handle response\n    print(res)\n\n```\n\n### Override Server URL Per-Client\n\nThe 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:\n```python\nfrom gusto_embedded import Gusto\nimport os\n\n\nwith Gusto(\n    server_url=\"https://api.gusto-demo.com\",\n    company_access_auth=os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", \"\"),\n) as gusto:\n\n    res = gusto.introspection.get_info()\n\n    # Handle response\n    print(res)\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [httpx](https://www.python-httpx.org/) 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.\nDepending 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.\nThis 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.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nfrom gusto_embedded import Gusto\nimport httpx\n\nhttp_client = httpx.Client(headers={\"x-custom-header\": \"someValue\"})\ns = Gusto(client=http_client)\n```\n\nor you could wrap the client with your own custom logic:\n```python\nfrom gusto_embedded import Gusto\nfrom gusto_embedded.httpclient import AsyncHttpClient\nimport httpx\n\nclass CustomClient(AsyncHttpClient):\n    client: AsyncHttpClient\n\n    def __init__(self, client: AsyncHttpClient):\n        self.client = client\n\n    async def send(\n        self,\n        request: httpx.Request,\n        *,\n        stream: bool = False,\n        auth: Union[\n            httpx._types.AuthTypes, httpx._client.UseClientDefault, None\n        ] = httpx.USE_CLIENT_DEFAULT,\n        follow_redirects: Union[\n            bool, httpx._client.UseClientDefault\n        ] = httpx.USE_CLIENT_DEFAULT,\n    ) -> httpx.Response:\n        request.headers[\"Client-Level-Header\"] = \"added by client\"\n\n        return await self.client.send(\n            request, stream=stream, auth=auth, follow_redirects=follow_redirects\n        )\n\n    def build_request(\n        self,\n        method: str,\n        url: httpx._types.URLTypes,\n        *,\n        content: Optional[httpx._types.RequestContent] = None,\n        data: Optional[httpx._types.RequestData] = None,\n        files: Optional[httpx._types.RequestFiles] = None,\n        json: Optional[Any] = None,\n        params: Optional[httpx._types.QueryParamTypes] = None,\n        headers: Optional[httpx._types.HeaderTypes] = None,\n        cookies: Optional[httpx._types.CookieTypes] = None,\n        timeout: Union[\n            httpx._types.TimeoutTypes, httpx._client.UseClientDefault\n        ] = httpx.USE_CLIENT_DEFAULT,\n        extensions: Optional[httpx._types.RequestExtensions] = None,\n    ) -> httpx.Request:\n        return self.client.build_request(\n            method,\n            url,\n            content=content,\n            data=data,\n            files=files,\n            json=json,\n            params=params,\n            headers=headers,\n            cookies=cookies,\n            timeout=timeout,\n            extensions=extensions,\n        )\n\ns = Gusto(async_client=CustomClient(httpx.AsyncClient()))\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Resource Management [resource-management] -->\n## Resource Management\n\nThe `Gusto` 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][context-manager] and reuse it across the application.\n\n[context-manager]: https://docs.python.org/3/reference/datamodel.html#context-managers\n\n```python\nfrom gusto_embedded import Gusto\nimport os\ndef main():\n\n    with Gusto(\n        company_access_auth=os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", \"\"),\n    ) as gusto:\n        # Rest of application here...\n\n\n# Or when using async:\nasync def amain():\n\n    async with Gusto(\n        company_access_auth=os.getenv(\"GUSTO_COMPANY_ACCESS_AUTH\", \"\"),\n    ) as gusto:\n        # Rest of application here...\n```\n<!-- End Resource Management [resource-management] -->\n\n<!-- Start Debugging [debug] -->\n## Debugging\n\nYou can setup your SDK to emit debug logs for SDK requests and responses.\n\nYou can pass your own logger class directly into your SDK.\n```python\nfrom gusto_embedded import Gusto\nimport logging\n\nlogging.basicConfig(level=logging.DEBUG)\ns = Gusto(debug_logger=logging.getLogger(\"gusto_embedded\"))\n```\n\nYou can also enable a default debug logger by setting an environment variable `GUSTO_DEBUG` to true.\n<!-- End Debugging [debug] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile 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.\nWe 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.\n\n### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=gusto&utm_campaign=python)\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python Client SDK Generated by Speakeasy.",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/Gusto/gusto-python-client.git",
        "Repository": "https://github.com/Gusto/gusto-python-client.git"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "66cc4d36d5363dc007a885f609160d77c3ab5752392cb215163b06ad6268c6c4",
                "md5": "b06637d6c1ea0bf158a23077b6c38f58",
                "sha256": "ce2e40e570cf035ef7574269a9268bea01940012a3c6d05eb33704235b16d84a"
            },
            "downloads": -1,
            "filename": "gusto_embedded-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b06637d6c1ea0bf158a23077b6c38f58",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 645384,
            "upload_time": "2025-03-03T21:13:21",
            "upload_time_iso_8601": "2025-03-03T21:13:21.012310Z",
            "url": "https://files.pythonhosted.org/packages/66/cc/4d36d5363dc007a885f609160d77c3ab5752392cb215163b06ad6268c6c4/gusto_embedded-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "827d1d0402dc54638159183879a03914ce53c49ac5d855279ae576be704603ee",
                "md5": "8d9517f527fd647e076d4012755caa3c",
                "sha256": "83a46a78c8e5db1363a77a2bc28cd78edb51426ecc62daa0b1751b6da36d9c90"
            },
            "downloads": -1,
            "filename": "gusto_embedded-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8d9517f527fd647e076d4012755caa3c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 278045,
            "upload_time": "2025-03-03T21:13:22",
            "upload_time_iso_8601": "2025-03-03T21:13:22.624784Z",
            "url": "https://files.pythonhosted.org/packages/82/7d/1d0402dc54638159183879a03914ce53c49ac5d855279ae576be704603ee/gusto_embedded-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-03-03 21:13:22",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Gusto",
    "github_project": "gusto-python-client",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "gusto_embedded"
}
Speakeasy
Elapsed time: 0.52901s