Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
speakeasyVersion: 1.582.0
speakeasyVersion: 1.606.0
sources:
GustoEmbedded-OAS:
sourceNamespace: gusto-embedded-oas
sourceRevisionDigest: sha256:21604c1ff7b9c06fdb546e4c82de7f0638061d995a3daab264e9121e961a751a
sourceBlobDigest: sha256:a845c25e9fe3043a24e3cf22b6de69e05d374c47e8d8230cb6e07d4aa742c5a4
sourceRevisionDigest: sha256:4f17a92304262999beb52d09140d42dbda1ea1d96d00a4e18514b5153b5a8aa6
sourceBlobDigest: sha256:2411284264456b120394f00fbb5f0ae3ec0bcf8eb032d0b2645e144b8dc9b07a
tags:
- latest
- speakeasy-sdk-regen-1752706761
- speakeasy-sdk-regen-1753402543
- "2024-04-01"
targets:
gusto-embedded:
source: GustoEmbedded-OAS
sourceNamespace: gusto-embedded-oas
sourceRevisionDigest: sha256:21604c1ff7b9c06fdb546e4c82de7f0638061d995a3daab264e9121e961a751a
sourceBlobDigest: sha256:a845c25e9fe3043a24e3cf22b6de69e05d374c47e8d8230cb6e07d4aa742c5a4
sourceRevisionDigest: sha256:4f17a92304262999beb52d09140d42dbda1ea1d96d00a4e18514b5153b5a8aa6
sourceBlobDigest: sha256:2411284264456b120394f00fbb5f0ae3ec0bcf8eb032d0b2645e144b8dc9b07a
codeSamplesNamespace: gusto-embedded-oas-typescript-code-samples
codeSamplesRevisionDigest: sha256:0af51d1902f659776541c00e8292e04f5ecb4b9f0f88c17067de8d1156a43873
codeSamplesRevisionDigest: sha256:96dd9da12104cd493ed303ffd434921b0e20d8b152bb8b80cd04fb1071e3328c
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
168 changes: 153 additions & 15 deletions gusto_embedded/.speakeasy/gen.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion gusto_embedded/.speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ generation:
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 0.6.6
version: 0.6.7
additionalDependencies:
dependencies: {}
devDependencies: {}
Expand Down Expand Up @@ -60,4 +60,5 @@ typescript:
packageName: '@gusto/embedded-api'
responseFormat: envelope-http
templateVersion: v2
usageSDKInitImports: []
useIndexModules: false
22 changes: 16 additions & 6 deletions gusto_embedded/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,10 +194,11 @@ run();

### [bankAccounts](docs/sdks/bankaccounts/README.md)

* [create](docs/sdks/bankaccounts/README.md#create) - Create a company bank account
* [get](docs/sdks/bankaccounts/README.md#get) - Get all company bank accounts
* [create](docs/sdks/bankaccounts/README.md#create) - Create a company bank account
* [verify](docs/sdks/bankaccounts/README.md#verify) - Verify a company bank account
* [createFromPlaidToken](docs/sdks/bankaccounts/README.md#createfromplaidtoken) - Create a bank account from a plaid processor token
* [deleteV1CompaniesCompanyIdBankAccountsBankAccountId](docs/sdks/bankaccounts/README.md#deletev1companiescompanyidbankaccountsbankaccountid) - Delete a company bank account

### [companies](docs/sdks/companies/README.md)

Expand Down Expand Up @@ -241,6 +242,8 @@ run();
* [getEmployeeBenefits](docs/sdks/companybenefits/README.md#getemployeebenefits) - Get all employee benefits for a company benefit
* [updateEmployeeBenefits](docs/sdks/companybenefits/README.md#updateemployeebenefits) - Bulk update employee benefits for a company benefit
* [getRequirements](docs/sdks/companybenefits/README.md#getrequirements) - Get benefit fields requirements by ID
* [getV1CompanyBenefitsCompanyBenefitIdContributionExclusions](docs/sdks/companybenefits/README.md#getv1companybenefitscompanybenefitidcontributionexclusions) - Get contribution exclusions for a company benefit
* [putV1CompanyBenefitsCompanyBenefitIdContributionExclusions](docs/sdks/companybenefits/README.md#putv1companybenefitscompanybenefitidcontributionexclusions) - Update contribution exclusions for a company benefit

### [companyForms](docs/sdks/companyforms/README.md)

Expand Down Expand Up @@ -620,6 +623,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`achTransactionsGetAll`](docs/sdks/achtransactions/README.md#getall) - Get all ACH transactions for a company
- [`bankAccountsCreate`](docs/sdks/bankaccounts/README.md#create) - Create a company bank account
- [`bankAccountsCreateFromPlaidToken`](docs/sdks/bankaccounts/README.md#createfromplaidtoken) - Create a bank account from a plaid processor token
- [`bankAccountsDeleteV1CompaniesCompanyIdBankAccountsBankAccountId`](docs/sdks/bankaccounts/README.md#deletev1companiescompanyidbankaccountsbankaccountid) - Delete a company bank account
- [`bankAccountsGet`](docs/sdks/bankaccounts/README.md#get) - Get all company bank accounts
- [`bankAccountsVerify`](docs/sdks/bankaccounts/README.md#verify) - Verify a company bank account
- [`companiesAcceptTermsOfService`](docs/sdks/companies/README.md#accepttermsofservice) - Accept terms of service for a company user
Expand Down Expand Up @@ -647,7 +651,9 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
- [`companyBenefitsGetRequirements`](docs/sdks/companybenefits/README.md#getrequirements) - Get benefit fields requirements by ID
- [`companyBenefitsGetSummary`](docs/sdks/companybenefits/README.md#getsummary) - Get company benefit summary by company benefit id.
- [`companyBenefitsGetSupported`](docs/sdks/companybenefits/README.md#getsupported) - Get a supported benefit by ID
- [`companyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions`](docs/sdks/companybenefits/README.md#getv1companybenefitscompanybenefitidcontributionexclusions) - Get contribution exclusions for a company benefit
- [`companyBenefitsList`](docs/sdks/companybenefits/README.md#list) - Get benefits for a company
- [`companyBenefitsPutV1CompanyBenefitsCompanyBenefitIdContributionExclusions`](docs/sdks/companybenefits/README.md#putv1companybenefitscompanybenefitidcontributionexclusions) - Update contribution exclusions for a company benefit
- [`companyBenefitsUpdate`](docs/sdks/companybenefits/README.md#update) - Update a company benefit
- [`companyBenefitsUpdateEmployeeBenefits`](docs/sdks/companybenefits/README.md#updateemployeebenefits) - Bulk update employee benefits for a company benefit
- [`companyFormsGet`](docs/sdks/companyforms/README.md#get) - Get a company form
Expand Down Expand Up @@ -903,6 +909,7 @@ To learn about this feature and how to get started, check
- [`useAchTransactionsGetAll`](docs/sdks/achtransactions/README.md#getall) - Get all ACH transactions for a company
- [`useBankAccountsCreateFromPlaidTokenMutation`](docs/sdks/bankaccounts/README.md#createfromplaidtoken) - Create a bank account from a plaid processor token
- [`useBankAccountsCreateMutation`](docs/sdks/bankaccounts/README.md#create) - Create a company bank account
- [`useBankAccountsDeleteV1CompaniesCompanyIdBankAccountsBankAccountIdMutation`](docs/sdks/bankaccounts/README.md#deletev1companiescompanyidbankaccountsbankaccountid) - Delete a company bank account
- [`useBankAccountsGet`](docs/sdks/bankaccounts/README.md#get) - Get all company bank accounts
- [`useBankAccountsVerifyMutation`](docs/sdks/bankaccounts/README.md#verify) - Verify a company bank account
- [`useCompaniesAcceptTermsOfServiceMutation`](docs/sdks/companies/README.md#accepttermsofservice) - Accept terms of service for a company user
Expand Down Expand Up @@ -930,7 +937,9 @@ To learn about this feature and how to get started, check
- [`useCompanyBenefitsGetRequirements`](docs/sdks/companybenefits/README.md#getrequirements) - Get benefit fields requirements by ID
- [`useCompanyBenefitsGetSummary`](docs/sdks/companybenefits/README.md#getsummary) - Get company benefit summary by company benefit id.
- [`useCompanyBenefitsGetSupported`](docs/sdks/companybenefits/README.md#getsupported) - Get a supported benefit by ID
- [`useCompanyBenefitsGetV1CompanyBenefitsCompanyBenefitIdContributionExclusions`](docs/sdks/companybenefits/README.md#getv1companybenefitscompanybenefitidcontributionexclusions) - Get contribution exclusions for a company benefit
- [`useCompanyBenefitsList`](docs/sdks/companybenefits/README.md#list) - Get benefits for a company
- [`useCompanyBenefitsPutV1CompanyBenefitsCompanyBenefitIdContributionExclusionsMutation`](docs/sdks/companybenefits/README.md#putv1companybenefitscompanybenefitidcontributionexclusions) - Update contribution exclusions for a company benefit
- [`useCompanyBenefitsUpdateEmployeeBenefitsMutation`](docs/sdks/companybenefits/README.md#updateemployeebenefits) - Bulk update employee benefits for a company benefit
- [`useCompanyBenefitsUpdateMutation`](docs/sdks/companybenefits/README.md#update) - Update a company benefit
- [`useCompanyFormsGet`](docs/sdks/companyforms/README.md#get) - Get a company form
Expand Down Expand Up @@ -1329,7 +1338,7 @@ run();
**Primary error:**
* [`GustoEmbeddedError`](./src/models/errors/gustoembeddederror.ts): The base class for HTTP error responses.

<details><summary>Less common errors (10)</summary>
<details><summary>Less common errors (11)</summary>

<br />

Expand All @@ -1342,10 +1351,11 @@ run();


**Inherit from [`GustoEmbeddedError`](./src/models/errors/gustoembeddederror.ts)**:
* [`UnprocessableEntityErrorObject`](./src/models/errors/unprocessableentityerrorobject.ts): Unprocessable Entity This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details. Applicable to 135 of 257 methods.*
* [`UnprocessableEntityErrorObject1`](./src/models/errors/unprocessableentityerrorobject1.ts): Unprocessable Entity This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details. Status code `422`. Applicable to 4 of 257 methods.*
* [`PayrollBlockersError`](./src/models/errors/payrollblockerserror.ts): Payroll Blockers Error For detailed information, see the [Payroll Blockers guide](https://docs.gusto.com/embedded-payroll/docs/payroll-blockers). Status code `422`. Applicable to 4 of 257 methods.*
* [`DeleteV1CompanyBenefitsCompanyBenefitIdResponseBody`](./src/models/errors/deletev1companybenefitscompanybenefitidresponsebody.ts): Unprocessable Entity. Status code `422`. Applicable to 1 of 257 methods.*
* [`UnprocessableEntityErrorObject`](./src/models/errors/unprocessableentityerrorobject.ts): Unprocessable Entity This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details. Applicable to 138 of 260 methods.*
* [`UnprocessableEntityErrorObject1`](./src/models/errors/unprocessableentityerrorobject1.ts): Unprocessable Entity This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details. Status code `422`. Applicable to 4 of 260 methods.*
* [`PayrollBlockersError`](./src/models/errors/payrollblockerserror.ts): Payroll Blockers Error For detailed information, see the [Payroll Blockers guide](https://docs.gusto.com/embedded-payroll/docs/payroll-blockers). Status code `422`. Applicable to 4 of 260 methods.*
* [`DeleteV1CompanyBenefitsCompanyBenefitIdResponseBody`](./src/models/errors/deletev1companybenefitscompanybenefitidresponsebody.ts): Unprocessable Entity. Status code `422`. Applicable to 1 of 260 methods.*
* [`CompanySuspensionCreationErrors`](./src/models/errors/companysuspensioncreationerrors.ts): Unprocessable Entity This may happen when the body of your request contains errors such as `invalid_attribute_value`, or the request fails due to an `invalid_operation`. See the [Errors Categories](https://docs.gusto.com/embedded-payroll/docs/error-categories) guide for more details. Status code `422`. Applicable to 1 of 260 methods.*
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.

</details>
Expand Down
12 changes: 11 additions & 1 deletion gusto_embedded/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -308,4 +308,14 @@ Based on:
### Generated
- [typescript v0.6.6] gusto_embedded
### Releases
- [NPM v0.6.6] https://www.npmjs.com/package/@gusto/embedded-api/v/0.6.6 - gusto_embedded
- [NPM v0.6.6] https://www.npmjs.com/package/@gusto/embedded-api/v/0.6.6 - gusto_embedded

## 2025-08-20 16:53:32
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.606.0 (2.686.7) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.6.7] gusto_embedded
### Releases
- [NPM v0.6.7] https://www.npmjs.com/package/@gusto/embedded-api/v/0.6.7 - gusto_embedded
12 changes: 6 additions & 6 deletions gusto_embedded/docs/models/components/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ let value: Admin = {

## Fields

| Field | Type | Required | Description |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `uuid` | *string* | :heavy_check_mark: | The unique id of the admin. |
| `email` | *string* | :heavy_minus_sign: | The email of the admin for Gusto's system. If the email matches an existing user, this will create an admin account for them. |
| `firstName` | *string* | :heavy_minus_sign: | The first name of the admin. |
| `lastName` | *string* | :heavy_minus_sign: | The last name of the admin. |
| Field | Type | Required | Description |
| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
| `uuid` | *string* | :heavy_check_mark: | The unique id of the admin. |
| `email` | *string* | :heavy_minus_sign: | The email of the admin for Gusto's system. |
| `firstName` | *string* | :heavy_minus_sign: | The first name of the admin. |
| `lastName` | *string* | :heavy_minus_sign: | The last name of the admin. |
13 changes: 6 additions & 7 deletions gusto_embedded/docs/models/components/benefits.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,15 @@
## Example Usage

```typescript
import { Benefits } from "@gusto/embedded-api/models/components/payrollemployeecompensationstype.js";
import { Benefits } from "@gusto/embedded-api/models/components/externalpayroll.js";

let value: Benefits = {};
```

## Fields

| Field | Type | Required | Description |
| --------------------- | --------------------- | --------------------- | --------------------- |
| `name` | *string* | :heavy_minus_sign: | N/A |
| `employeeDeduction` | *number* | :heavy_minus_sign: | N/A |
| `companyContribution` | *number* | :heavy_minus_sign: | N/A |
| `imputed` | *boolean* | :heavy_minus_sign: | N/A |
| Field | Type | Required | Description |
| --------------------------- | --------------------------- | --------------------------- | --------------------------- |
| `benefitId` | *number* | :heavy_minus_sign: | N/A |
| `companyContributionAmount` | *string* | :heavy_minus_sign: | N/A |
| `employeeDeductionAmount` | *string* | :heavy_minus_sign: | N/A |
Loading