# Employees (*hris.employees*) ## Overview ### Available Operations * [list](#list) - List Employees * [create](#create) - Create Employee * [get](#get) - Get Employee * [update](#update) - Update Employee * [delete](#delete) - Delete Employee ## list Apideck operates as a stateless Unified API, which means that the list endpoint only provides a portion of the employee model. This is due to the fact that most HRIS systems do not readily provide all data in every call. However, you can access the complete employee model through an employee detail call. ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.hris.employees.list({ serviceId: "salesforce", filter: { companyId: "1234", email: "elon@tesla.com", firstName: "Elon", title: "Manager", lastName: "Musk", managerId: "1234", employmentStatus: "active", employeeNumber: "123456-AB", departmentId: "1234", }, sort: { by: "created_at", direction: "desc", }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { hrisEmployeesList } from "@apideck/sdk/funcs/hrisEmployeesList.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await hrisEmployeesList(apideck, { serviceId: "salesforce", filter: { companyId: "1234", email: "elon@tesla.com", firstName: "Elon", title: "Manager", lastName: "Musk", managerId: "1234", employmentStatus: "active", employeeNumber: "123456-AB", departmentId: "1234", }, sort: { by: "created_at", direction: "desc", }, passThrough: { "search": "San Francisco", }, fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.HrisEmployeesAllRequest](../../models/operations/hrisemployeesallrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.HrisEmployeesAllResponse](../../models/operations/hrisemployeesallresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## create Create Employee ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; import { RFCDate } from "@apideck/sdk/types"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.hris.employees.create({ serviceId: "salesforce", employee: { id: "12345", firstName: "Elon", lastName: "Musk", middleName: "D.", displayName: "Technoking", preferredName: "Elon Musk", initials: "EM", salutation: "Mr", title: "CEO", maritalStatus: "married", partner: { firstName: "Elon", lastName: "Musk", middleName: "D.", gender: "male", initials: "EM", birthday: new RFCDate("2000-08-12"), deceasedOn: new RFCDate("2000-08-12"), }, division: "Europe", divisionId: "12345", departmentId: "12345", departmentName: "12345", team: { id: "1234", name: "Full Stack Engineers", }, companyId: "23456", companyName: "SpaceX", employmentStartDate: "2021-10-26", employmentEndDate: "2028-10-26", leavingReason: "resigned", employeeNumber: "123456-AB", employmentStatus: "active", ethnicity: "African American", manager: { id: "12345", name: "Elon Musk", firstName: "Elon", lastName: "Musk", email: "elon@musk.com", employmentStatus: "active", }, directReports: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], socialSecurityNumber: "123456789", birthday: new RFCDate("2000-08-12"), deceasedOn: new RFCDate("2000-08-12"), countryOfBirth: "US", description: "A description", gender: "male", pronouns: "she,her", preferredLanguage: "EN", languages: [ "EN", ], nationalities: [ "US", ], photoUrl: "https://unavatar.io/elon-musk", timezone: "Europe/London", source: "lever", sourceId: "12345", recordUrl: "https://app.intercom.io/contacts/12345", jobs: [ { title: "CEO", role: "Sales", startDate: new RFCDate("2020-08-12"), endDate: new RFCDate("2020-08-12"), compensationRate: 72000, currency: "USD", paymentUnit: "year", hiredAt: new RFCDate("2020-08-12"), isPrimary: true, isManager: true, status: "active", location: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, }, ], compensations: [ { rate: 50, paymentUnit: "hour", currency: "USD", flsaStatus: "nonexempt", effectiveDate: "2021-06-11", paymentFrequency: "monthly", }, ], worksRemote: true, addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], bankAccounts: [ { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, ], taxCode: "1111", taxId: "234-32-0000", dietaryPreference: "Veggie", foodAllergies: [ "No allergies", ], probationPeriod: { startDate: new RFCDate("2021-10-01"), endDate: new RFCDate("2021-11-28"), }, tags: [ "New", ], rowVersion: "1-12345", deleted: true, passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { hrisEmployeesCreate } from "@apideck/sdk/funcs/hrisEmployeesCreate.js"; import { RFCDate } from "@apideck/sdk/types"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await hrisEmployeesCreate(apideck, { serviceId: "salesforce", employee: { id: "12345", firstName: "Elon", lastName: "Musk", middleName: "D.", displayName: "Technoking", preferredName: "Elon Musk", initials: "EM", salutation: "Mr", title: "CEO", maritalStatus: "married", partner: { firstName: "Elon", lastName: "Musk", middleName: "D.", gender: "male", initials: "EM", birthday: new RFCDate("2000-08-12"), deceasedOn: new RFCDate("2000-08-12"), }, division: "Europe", divisionId: "12345", departmentId: "12345", departmentName: "12345", team: { id: "1234", name: "Full Stack Engineers", }, companyId: "23456", companyName: "SpaceX", employmentStartDate: "2021-10-26", employmentEndDate: "2028-10-26", leavingReason: "resigned", employeeNumber: "123456-AB", employmentStatus: "active", ethnicity: "African American", manager: { id: "12345", name: "Elon Musk", firstName: "Elon", lastName: "Musk", email: "elon@musk.com", employmentStatus: "active", }, directReports: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], socialSecurityNumber: "123456789", birthday: new RFCDate("2000-08-12"), deceasedOn: new RFCDate("2000-08-12"), countryOfBirth: "US", description: "A description", gender: "male", pronouns: "she,her", preferredLanguage: "EN", languages: [ "EN", ], nationalities: [ "US", ], photoUrl: "https://unavatar.io/elon-musk", timezone: "Europe/London", source: "lever", sourceId: "12345", recordUrl: "https://app.intercom.io/contacts/12345", jobs: [ { title: "CEO", role: "Sales", startDate: new RFCDate("2020-08-12"), endDate: new RFCDate("2020-08-12"), compensationRate: 72000, currency: "USD", paymentUnit: "year", hiredAt: new RFCDate("2020-08-12"), isPrimary: true, isManager: true, status: "active", location: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, }, ], compensations: [ { rate: 50, paymentUnit: "hour", currency: "USD", flsaStatus: "nonexempt", effectiveDate: "2021-06-11", paymentFrequency: "monthly", }, ], worksRemote: true, addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], bankAccounts: [ { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, ], taxCode: "1111", taxId: "234-32-0000", dietaryPreference: "Veggie", foodAllergies: [ "No allergies", ], probationPeriod: { startDate: new RFCDate("2021-10-01"), endDate: new RFCDate("2021-11-28"), }, tags: [ "New", ], rowVersion: "1-12345", deleted: true, passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.HrisEmployeesAddRequest](../../models/operations/hrisemployeesaddrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.HrisEmployeesAddResponse](../../models/operations/hrisemployeesaddresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## get Get Employee ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.hris.employees.get({ id: "", serviceId: "salesforce", fields: "id,updated_at", filter: { companyId: "1234", }, passThrough: { "search": "San Francisco", }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { hrisEmployeesGet } from "@apideck/sdk/funcs/hrisEmployeesGet.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await hrisEmployeesGet(apideck, { id: "", serviceId: "salesforce", fields: "id,updated_at", filter: { companyId: "1234", }, passThrough: { "search": "San Francisco", }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.HrisEmployeesOneRequest](../../models/operations/hrisemployeesonerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.HrisEmployeesOneResponse](../../models/operations/hrisemployeesoneresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## update Update Employee ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; import { RFCDate } from "@apideck/sdk/types"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.hris.employees.update({ id: "", serviceId: "salesforce", employee: { id: "12345", firstName: "Elon", lastName: "Musk", middleName: "D.", displayName: "Technoking", preferredName: "Elon Musk", initials: "EM", salutation: "Mr", title: "CEO", maritalStatus: "married", partner: { firstName: "Elon", lastName: "Musk", middleName: "D.", gender: "male", initials: "EM", birthday: new RFCDate("2000-08-12"), deceasedOn: new RFCDate("2000-08-12"), }, division: "Europe", divisionId: "12345", departmentId: "12345", departmentName: "12345", team: { id: "1234", name: "Full Stack Engineers", }, companyId: "23456", companyName: "SpaceX", employmentStartDate: "2021-10-26", employmentEndDate: "2028-10-26", leavingReason: "resigned", employeeNumber: "123456-AB", employmentStatus: "active", ethnicity: "African American", manager: { id: "12345", name: "Elon Musk", firstName: "Elon", lastName: "Musk", email: "elon@musk.com", employmentStatus: "active", }, directReports: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], socialSecurityNumber: "123456789", birthday: new RFCDate("2000-08-12"), deceasedOn: new RFCDate("2000-08-12"), countryOfBirth: "US", description: "A description", gender: "male", pronouns: "she,her", preferredLanguage: "EN", languages: [ "EN", ], nationalities: [ "US", ], photoUrl: "https://unavatar.io/elon-musk", timezone: "Europe/London", source: "lever", sourceId: "12345", recordUrl: "https://app.intercom.io/contacts/12345", jobs: [ { title: "CEO", role: "Sales", startDate: new RFCDate("2020-08-12"), endDate: new RFCDate("2020-08-12"), compensationRate: 72000, currency: "USD", paymentUnit: "year", hiredAt: new RFCDate("2020-08-12"), isPrimary: true, isManager: true, status: "active", location: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, }, ], compensations: [ { rate: 50, paymentUnit: "hour", currency: "USD", flsaStatus: "nonexempt", effectiveDate: "2021-06-11", paymentFrequency: "other", }, ], worksRemote: true, addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ {}, ], }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], bankAccounts: [ { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, ], taxCode: "1111", taxId: "234-32-0000", dietaryPreference: "Veggie", foodAllergies: [ "No allergies", ], probationPeriod: { startDate: new RFCDate("2021-10-01"), endDate: new RFCDate("2021-11-28"), }, tags: [ "New", ], rowVersion: "1-12345", deleted: true, passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { hrisEmployeesUpdate } from "@apideck/sdk/funcs/hrisEmployeesUpdate.js"; import { RFCDate } from "@apideck/sdk/types"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await hrisEmployeesUpdate(apideck, { id: "", serviceId: "salesforce", employee: { id: "12345", firstName: "Elon", lastName: "Musk", middleName: "D.", displayName: "Technoking", preferredName: "Elon Musk", initials: "EM", salutation: "Mr", title: "CEO", maritalStatus: "married", partner: { firstName: "Elon", lastName: "Musk", middleName: "D.", gender: "male", initials: "EM", birthday: new RFCDate("2000-08-12"), deceasedOn: new RFCDate("2000-08-12"), }, division: "Europe", divisionId: "12345", departmentId: "12345", departmentName: "12345", team: { id: "1234", name: "Full Stack Engineers", }, companyId: "23456", companyName: "SpaceX", employmentStartDate: "2021-10-26", employmentEndDate: "2028-10-26", leavingReason: "resigned", employeeNumber: "123456-AB", employmentStatus: "active", ethnicity: "African American", manager: { id: "12345", name: "Elon Musk", firstName: "Elon", lastName: "Musk", email: "elon@musk.com", employmentStatus: "active", }, directReports: [ "a0d636c6-43b3-4bde-8c70-85b707d992f4", "a98lfd96-43b3-4bde-8c70-85b707d992e6", ], socialSecurityNumber: "123456789", birthday: new RFCDate("2000-08-12"), deceasedOn: new RFCDate("2000-08-12"), countryOfBirth: "US", description: "A description", gender: "male", pronouns: "she,her", preferredLanguage: "EN", languages: [ "EN", ], nationalities: [ "US", ], photoUrl: "https://unavatar.io/elon-musk", timezone: "Europe/London", source: "lever", sourceId: "12345", recordUrl: "https://app.intercom.io/contacts/12345", jobs: [ { title: "CEO", role: "Sales", startDate: new RFCDate("2020-08-12"), endDate: new RFCDate("2020-08-12"), compensationRate: 72000, currency: "USD", paymentUnit: "year", hiredAt: new RFCDate("2020-08-12"), isPrimary: true, isManager: true, status: "active", location: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, }, ], compensations: [ { rate: 50, paymentUnit: "hour", currency: "USD", flsaStatus: "nonexempt", effectiveDate: "2021-06-11", paymentFrequency: "other", }, ], worksRemote: true, addresses: [ { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, ], phoneNumbers: [ { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, { id: "12345", countryCode: "1", areaCode: "323", number: "111-111-1111", extension: "105", type: "primary", }, ], emails: [ { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, { id: "123", email: "elon@musk.com", type: "primary", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], socialLinks: [ { id: "12345", url: "https://www.twitter.com/apideck", type: "twitter", }, ], bankAccounts: [ { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, ], taxCode: "1111", taxId: "234-32-0000", dietaryPreference: "Veggie", foodAllergies: [ "No allergies", ], probationPeriod: { startDate: new RFCDate("2021-10-01"), endDate: new RFCDate("2021-11-28"), }, tags: [ "New", ], rowVersion: "1-12345", deleted: true, passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.HrisEmployeesUpdateRequest](../../models/operations/hrisemployeesupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.HrisEmployeesUpdateResponse](../../models/operations/hrisemployeesupdateresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## delete Delete Employee ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.hris.employees.delete({ id: "", serviceId: "salesforce", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { hrisEmployeesDelete } from "@apideck/sdk/funcs/hrisEmployeesDelete.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await hrisEmployeesDelete(apideck, { id: "", serviceId: "salesforce", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.HrisEmployeesDeleteRequest](../../models/operations/hrisemployeesdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.HrisEmployeesDeleteResponse](../../models/operations/hrisemployeesdeleteresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* |