MergeHRISClient.Api.Employees (MergeHRISClient v1.0.3) View Source

API calls for all endpoints tagged Employees.

Link to this section Summary

Functions

employees_create(connection, authorization, x_account_token, employee_endpoint_request, opts \\ [])

Creates an Employee object with the given values.

employees_ignore_create(connection, authorization, x_account_token, model_id, ignore_common_model_request, opts \\ [])

Ignores a specific row based on the model_id in the url. These records will have their properties set to null, and will not be updated in future syncs. The "reason" and "message" fields in the request body will be stored for audit purposes.

employees_list(connection, authorization, x_account_token, opts \\ [])

Returns a list of Employee objects.

employees_meta_post_retrieve(connection, authorization, x_account_token, opts \\ [])

Returns metadata for Employee POSTs.

employees_retrieve(connection, authorization, x_account_token, id, opts \\ [])

Returns an Employee object with the given id.

Link to this section Functions

employees_create(connection, authorization, x_account_token, employee_endpoint_request, opts \\ [])

Specs

employees_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  MergeHRISClient.Model.EmployeeEndpointRequest.t(),
  keyword()
) :: {:ok, MergeHRISClient.Model.EmployeeResponse.t()} | {:error, Tesla.Env.t()}

Creates an Employee object with the given values.

Parameters

connection (MergeHRISClient.Connection): Connection to server
authorization (String.t): Should include 'Bearer ' followed by your test/production API Key.
x_account_token (String.t): Token identifying the end user.
employee_endpoint_request (EmployeeEndpointRequest):
opts (KeywordList): [optional] Optional parameters
- :is_debug_mode (boolean()): Whether to include debug fields (such as log file links) in the response.
- :run_async (boolean()): Whether or not third-party updates should be run asynchronously.
  Returns

on success {:error, Tesla.Env.t} on failure

employees_ignore_create(connection, authorization, x_account_token, model_id, ignore_common_model_request, opts \\ [])

Specs

employees_ignore_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  MergeHRISClient.Model.IgnoreCommonModelRequest.t(),
  keyword()
) ::
  {:ok, MergeHRISClient.Model.IgnoreCommonModel.t()} | {:error, Tesla.Env.t()}

Parameters

connection (MergeHRISClient.Connection): Connection to server
authorization (String.t): Should include 'Bearer ' followed by your test/production API Key.
x_account_token (String.t): Token identifying the end user.
model_id (String.t):
ignore_common_model_request (IgnoreCommonModelRequest):
opts (KeywordList): [optional] Optional parameters
Returns

on success {:error, Tesla.Env.t} on failure

employees_list(connection, authorization, x_account_token, opts \\ [])

Specs

employees_list(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, MergeHRISClient.Model.PaginatedEmployeeList.t()}
  | {:error, Tesla.Env.t()}

Returns a list of Employee objects.

Parameters

connection (MergeHRISClient.Connection): Connection to server
authorization (String.t): Should include 'Bearer ' followed by your test/production API Key.
x_account_token (String.t): Token identifying the end user.
opts (KeywordList): [optional] Optional parameters
- :company_id (String.t): If provided, will only return employees for this company.
- :created_after (DateTime.t): If provided, will only return objects created after this datetime.
- :created_before (DateTime.t): If provided, will only return objects created before this datetime.
- :cursor (String.t): The pagination cursor value.
- :display_full_name (String.t): If provided, will only return employees with this display name.
- :employment_status (String.t): If provided, will only return employees with this employment status.
- :first_name (String.t): If provided, will only return employees with this first name.
- :include_deleted_data (boolean()): Whether to include data that was marked as deleted by third party webhooks.
- :include_remote_data (boolean()): Whether to include the original data Merge fetched from the third-party to produce these models.
- :include_sensitive_fields (boolean()): Whether to include sensitive fields (such as social security numbers) in the response.
- :last_name (String.t): If provided, will only return employees with this last name.
- :manager_id (String.t): If provided, will only return employees for this manager.
- :modified_after (DateTime.t): If provided, will only return objects modified after this datetime.
- :modified_before (DateTime.t): If provided, will only return objects modified before this datetime.
- :page_size (integer()): Number of results to return per page.
- :pay_group_id (String.t): If provided, will only return employees for this pay group
- :personal_email (String.t): If provided, will only return Employees with this personal email
- :remote_fields (String.t): Which fields should be returned in non-normalized form.
- :remote_id (String.t): The API provider's ID for the given object.
- :team_id (String.t): If provided, will only return employees for this team.
- :work_email (String.t): If provided, will only return Employees with this work email
- :work_location_id (String.t): If provided, will only return employees for this location.
  Returns

on success {:error, Tesla.Env.t} on failure

employees_meta_post_retrieve(connection, authorization, x_account_token, opts \\ [])

Specs

employees_meta_post_retrieve(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, MergeHRISClient.Model.MetaResponse.t()} | {:error, Tesla.Env.t()}

Returns metadata for Employee POSTs.

Parameters

connection (MergeHRISClient.Connection): Connection to server
authorization (String.t): Should include 'Bearer ' followed by your test/production API Key.
x_account_token (String.t): Token identifying the end user.
opts (KeywordList): [optional] Optional parameters
Returns

on success {:error, Tesla.Env.t} on failure

employees_retrieve(connection, authorization, x_account_token, id, opts \\ [])

Specs

employees_retrieve(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, MergeHRISClient.Model.Employee.t()} | {:error, Tesla.Env.t()}

Returns an Employee object with the given id.

Parameters

connection (MergeHRISClient.Connection): Connection to server
authorization (String.t): Should include 'Bearer ' followed by your test/production API Key.
x_account_token (String.t): Token identifying the end user.
id (String.t):
opts (KeywordList): [optional] Optional parameters
- :include_remote_data (boolean()): Whether to include the original data Merge fetched from the third-party to produce these models.
- :include_sensitive_fields (boolean()): Whether to include sensitive fields (such as social security numbers) in the response.
- :remote_fields (String.t): Which fields should be returned in non-normalized form.
  Returns

on success {:error, Tesla.Env.t} on failure