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

API calls for all endpoints tagged Employees.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source

Specs

employees_create(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, MergeHRISClient.Model.Employee.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 production API Key.
  • x_account_token (String.t): Token identifying the end user.
  • opts (KeywordList): [optional] Optional parameters
    • :run_async (boolean()): Whether or not third-party updates should be run asynchronously.
    • :body (EmployeeRequest):

      Returns

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

Link to this function

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

View Source

Specs

Returns a list of Employee objects.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • authorization (String.t): Should include 'Bearer ' followed by your 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.
    • :expand (String.t): Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
    • :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 sensetive fields (such as social security numbers) in the response.
    • :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.
    • :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_location_id (String.t): If provided, will only return employees for this location.

      Returns

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

Link to this function

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

View Source

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 production API Key.
  • x_account_token (String.t): Token identifying the end user.
  • id (String.t):
  • opts (KeywordList): [optional] Optional parameters
    • :expand (String.t): Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
    • :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 sensetive fields (such as social security numbers) in the response.

      Returns

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