pub struct Employees {
pub client: Client,
}Fields§
§client: ClientImplementations§
source§impl Employees
impl Employees
sourcepub async fn get(
&self,
employee_id_or_uuid: &str,
include: &[String]
) -> Result<Response<Employee>, ClientError>
pub async fn get( &self, employee_id_or_uuid: &str, include: &[String] ) -> Result<Response<Employee>, ClientError>
Get an employee.
This function performs a GET to the /v1/employees/{employee_id_or_uuid} endpoint.
Get an employee.
Parameters:
include: &[String]– Include the requested attribute(s) in each employee response.
sourcepub async fn put(
&self,
employee_id_or_uuid: &str,
body: &PutEmployeesRequest
) -> Result<Response<Employee>, ClientError>
pub async fn put( &self, employee_id_or_uuid: &str, body: &PutEmployeesRequest ) -> Result<Response<Employee>, ClientError>
Update an employee.
This function performs a PUT to the /v1/employees/{employee_id_or_uuid} endpoint.
Update an employee.
sourcepub async fn get_company(
&self,
company_id_or_uuid: &str,
terminated: bool,
page: f64,
per: f64,
include: &[String]
) -> Result<Response<Vec<Employee>>, ClientError>
pub async fn get_company( &self, company_id_or_uuid: &str, terminated: bool, page: f64, per: f64, include: &[String] ) -> Result<Response<Vec<Employee>>, ClientError>
Get employees of a company.
This function performs a GET to the /v1/companies/{company_id_or_uuid}/employees endpoint.
Get all of the employees, onboarding, active and terminated, for a given company.
Parameters:
terminated: bool– Filters employees by the provided boolean.page: f64– The page that is requested. When unspecified, will load all employees.per: f64– Number of employees per page. When unspecified, will default to 25.include: &[String]– Include the requested attribute(s) in each employee response.
sourcepub async fn get_all_company(
&self,
company_id_or_uuid: &str,
terminated: bool,
include: &[String]
) -> Result<Response<Vec<Employee>>, ClientError>
pub async fn get_all_company( &self, company_id_or_uuid: &str, terminated: bool, include: &[String] ) -> Result<Response<Vec<Employee>>, ClientError>
Get employees of a company.
This function performs a GET to the /v1/companies/{company_id_or_uuid}/employees endpoint.
As opposed to get_company, this function returns all the pages of the request at once.
Get all of the employees, onboarding, active and terminated, for a given company.
sourcepub async fn post(
&self,
company_id_or_uuid: &str,
body: &PostEmployeesRequest
) -> Result<Response<Employee>, ClientError>
pub async fn post( &self, company_id_or_uuid: &str, body: &PostEmployeesRequest ) -> Result<Response<Employee>, ClientError>
Create an employee.
This function performs a POST to the /v1/companies/{company_id_or_uuid}/employees endpoint.
Create an employee.
sourcepub async fn get_home_address(
&self,
employee_id: &str
) -> Result<Response<Location>, ClientError>
pub async fn get_home_address( &self, employee_id: &str ) -> Result<Response<Location>, ClientError>
Get an employee’s home address.
This function performs a GET to the /v1/employees/{employee_id}/home_address endpoint.
The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.
sourcepub async fn put_home_address(
&self,
employee_id: &str,
body: &PutEmployeeHomeAddressRequest
) -> Result<Response<Location>, ClientError>
pub async fn put_home_address( &self, employee_id: &str, body: &PutEmployeeHomeAddressRequest ) -> Result<Response<Location>, ClientError>
Update an employee’s home address.
This function performs a PUT to the /v1/employees/{employee_id}/home_address endpoint.
The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.