Skip to content

Latest commit

 

History

History
executable file
·
341 lines (260 loc) · 22.1 KB

README.md

File metadata and controls

executable file
·
341 lines (260 loc) · 22.1 KB
Raw

employeeBenefits

Available Operations

deleteV1EmployeeBenefitsEmployeeBenefitId

Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.

scope: employee_benefits:write

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  DeleteV1EmployeeBenefitsEmployeeBenefitIdRequest,
  DeleteV1EmployeeBenefitsEmployeeBenefitIdResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const employeeBenefitId: string = "consequatur";

sdk.employeeBenefits.deleteV1EmployeeBenefitsEmployeeBenefitId(employeeBenefitId).then((res: DeleteV1EmployeeBenefitsEmployeeBenefitIdResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
employeeBenefitId string ✔️ The UUID of the employee benefit.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.DeleteV1EmployeeBenefitsEmployeeBenefitIdResponse>

getV1EmployeeBenefitsEmployeeBenefitId

Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.

scope: employee_benefits:read

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  GetV1EmployeeBenefitsEmployeeBenefitIdRequest,
  GetV1EmployeeBenefitsEmployeeBenefitIdResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const employeeBenefitId: string = "est";

sdk.employeeBenefits.getV1EmployeeBenefitsEmployeeBenefitId(employeeBenefitId).then((res: GetV1EmployeeBenefitsEmployeeBenefitIdResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
employeeBenefitId string ✔️ The UUID of the employee benefit.
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetV1EmployeeBenefitsEmployeeBenefitIdResponse>

getV1EmployeesEmployeeIdEmployeeBenefits

Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.

Returns an array of all employee benefits for this employee

scope: employee_benefits:read

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  GetV1EmployeesEmployeeIdEmployeeBenefitsRequest,
  GetV1EmployeesEmployeeIdEmployeeBenefitsResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const employeeId: string = "repellendus";
const page: number = 7851.53;
const per: number = 9843.3;

sdk.employeeBenefits.getV1EmployeesEmployeeIdEmployeeBenefits(employeeId, page, per).then((res: GetV1EmployeesEmployeeIdEmployeeBenefitsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
employeeId string ✔️ The UUID of the employee
page number ➖ The page that is requested. When unspecified, will load all objects.
per number ➖ Number of objects per page. When unspecified, will default to 25
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.GetV1EmployeesEmployeeIdEmployeeBenefitsResponse>

postEmployeeYtdBenefitAmountsFromDifferentCompany

Year-to-date benefit amounts from a different company represents the amount of money added to an employees plan during a current year, made outside of the current contribution when they were employed at a different company.

scope: employee_benefits:write

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  PostEmployeeYtdBenefitAmountsFromDifferentCompanyRequest,
  PostEmployeeYtdBenefitAmountsFromDifferentCompanyRequestBody,
  PostEmployeeYtdBenefitAmountsFromDifferentCompanyResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const employeeId: string = "ut";
const requestBody: PostEmployeeYtdBenefitAmountsFromDifferentCompanyRequestBody = {
  benefitType: 7034.95,
  taxYear: 5864.1,
  ytdCompanyContributionAmount: "qui",
  ytdEmployeeDeductionAmount: "quae",
};

sdk.employeeBenefits.postEmployeeYtdBenefitAmountsFromDifferentCompany(employeeId, requestBody).then((res: PostEmployeeYtdBenefitAmountsFromDifferentCompanyResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
employeeId string ✔️ The UUID of the employee
requestBody operations.PostEmployeeYtdBenefitAmountsFromDifferentCompanyRequestBody ➖ N/A
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.PostEmployeeYtdBenefitAmountsFromDifferentCompanyResponse>

postV1EmployeesEmployeeIdEmployeeBenefits

Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.

scope: employee_benefits:write

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  PostV1EmployeesEmployeeIdEmployeeBenefitsRequest,
  PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBody,
  PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBodyContribution,
  PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBodyContributionType,
  PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBodyContributionValue2,
  PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBodyDeductionReducesTaxableIncome,
  PostV1EmployeesEmployeeIdEmployeeBenefitsResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const employeeId: string = "laudantium";
const requestBody: PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBody = {
  active: false,
  catchUp: false,
  companyBenefitUuid: "odio",
  companyContribution: "occaecati",
  companyContributionAnnualMaximum: "voluptatibus",
  contributeAsPercentage: false,
  contribution: {
    type: PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBodyContributionType.Amount,
    value: [
      {
        rate: "quis",
        threshold: "ipsum",
      },
      {
        rate: "delectus",
        threshold: "voluptate",
      },
      {
        rate: "consectetur",
        threshold: "vero",
      },
    ],
  },
  coverageAmount: "tenetur",
  coverageSalaryMultiplier: "dignissimos",
  deductAsPercentage: false,
  deductionReducesTaxableIncome: PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBodyDeductionReducesTaxableIncome.LessThanNilGreaterThan,
  elective: false,
  employeeDeduction: "distinctio",
  employeeDeductionAnnualMaximum: "quod",
  limitOption: "odio",
};

sdk.employeeBenefits.postV1EmployeesEmployeeIdEmployeeBenefits(employeeId, requestBody).then((res: PostV1EmployeesEmployeeIdEmployeeBenefitsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
employeeId string ✔️ The UUID of the employee
requestBody operations.PostV1EmployeesEmployeeIdEmployeeBenefitsRequestBody ➖ N/A
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.PostV1EmployeesEmployeeIdEmployeeBenefitsResponse>

putV1EmployeeBenefitsEmployeeBenefitId

Employee benefits represent an employee enrolled in a particular company benefit. It includes information specific to that employee’s enrollment.

scope: employee_benefits:write

Example Usage

import { Gusto } from "@speakeasy-sdks/gusto";
import {
  PutV1EmployeeBenefitsEmployeeBenefitIdRequest,
  PutV1EmployeeBenefitsEmployeeBenefitIdRequestBody,
  PutV1EmployeeBenefitsEmployeeBenefitIdRequestBodyContribution,
  PutV1EmployeeBenefitsEmployeeBenefitIdRequestBodyContributionType,
  PutV1EmployeeBenefitsEmployeeBenefitIdRequestBodyContributionValue2,
  PutV1EmployeeBenefitsEmployeeBenefitIdRequestBodyDeductionReducesTaxableIncome,
  PutV1EmployeeBenefitsEmployeeBenefitIdResponse,
} from "@speakeasy-sdks/gusto/dist/sdk/models/operations";

const sdk = new Gusto({
  security: {
    authorization: "",
  },
});
const employeeBenefitId: string = "similique";
const requestBody: PutV1EmployeeBenefitsEmployeeBenefitIdRequestBody = {
  active: false,
  catchUp: false,
  companyContribution: "facilis",
  companyContributionAnnualMaximum: "vero",
  contributeAsPercentage: false,
  contribution: {
    type: PutV1EmployeeBenefitsEmployeeBenefitIdRequestBodyContributionType.Percentage,
    value: "quibusdam",
  },
  coverageAmount: "illum",
  coverageSalaryMultiplier: "sequi",
  deductAsPercentage: false,
  deductionReducesTaxableIncome: PutV1EmployeeBenefitsEmployeeBenefitIdRequestBodyDeductionReducesTaxableIncome.DoesNotReduceTaxableIncome,
  elective: false,
  employeeDeduction: "impedit",
  employeeDeductionAnnualMaximum: "aut",
  limitOption: "voluptatibus",
  version: "exercitationem",
};

sdk.employeeBenefits.putV1EmployeeBenefitsEmployeeBenefitId(employeeBenefitId, requestBody).then((res: PutV1EmployeeBenefitsEmployeeBenefitIdResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Parameters

Parameter Type Required Description
employeeBenefitId string ✔️ The UUID of the employee benefit.
requestBody operations.PutV1EmployeeBenefitsEmployeeBenefitIdRequestBody ➖ N/A
config AxiosRequestConfig ➖ Available config options for making requests.

Response

Promise<operations.PutV1EmployeeBenefitsEmployeeBenefitIdResponse>