Provides API endpoints related to people
Summary
Functions
Bulk index employees
Bulk index teams
Delete employee
Delete team
Index employee
Bulk index employees
Index team
Schedules the processing of uploaded employees and teams
Functions
@spec bulkindexemployees( body :: Gleanex.Indexing.BulkIndexEmployeesRequest.t(), opts :: keyword() ) :: :ok | {:error, Gleanex.Error.t()}
Bulk index employees
Replaces all the currently indexed employees using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints.
Request Body
Content Types: application/json; charset=UTF-8
@spec bulkindexteams( body :: Gleanex.Indexing.BulkIndexTeamsRequest.t(), opts :: keyword() ) :: :ok | {:error, Gleanex.Error.t()}
Bulk index teams
Replaces all the currently indexed teams using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints.
Request Body
Content Types: application/json; charset=UTF-8
@spec deleteemployee( body :: Gleanex.Indexing.DeleteEmployeeRequest.t(), opts :: keyword() ) :: :ok | {:error, Gleanex.Error.t()}
Delete employee
Delete an employee. Silently succeeds if employee is not present.
Request Body
Content Types: application/json; charset=UTF-8
@spec deleteteam(body :: Gleanex.Indexing.DeleteTeamRequest.t(), opts :: keyword()) :: :ok | {:error, Gleanex.Error.t()}
Delete team
Delete a team based on provided id.
Request Body
Content Types: application/json; charset=UTF-8
@spec indexemployee( body :: Gleanex.Indexing.IndexEmployeeRequest.t(), opts :: keyword() ) :: :ok | {:error, Gleanex.Error.t()}
Index employee
Adds an employee or replaces the existing information about an employee.
Request Body
Content Types: application/json; charset=UTF-8
@spec indexemployeelist( body :: Gleanex.Indexing.IndexEmployeeListRequest.t(), opts :: keyword() ) :: :ok | {:error, Gleanex.Error.t()}
Bulk index employees
Bulk upload details of all the employees. This deletes all employees uploaded in the prior batch. SOON TO BE DEPRECATED in favor of /bulkindexemployees.
Request Body
Content Types: application/json; charset=UTF-8
@spec indexteam(body :: Gleanex.Indexing.IndexTeamRequest.t(), opts :: keyword()) :: :ok | {:error, Gleanex.Error.t()}
Index team
Adds a team or updates information about a team
Request Body
Content Types: application/json; charset=UTF-8
@spec processallemployeesandteams(opts :: keyword()) :: :ok | {:error, Gleanex.Error.t()}
Schedules the processing of uploaded employees and teams
Schedules the immediate processing of employees and teams uploaded through the indexing API. By default all uploaded people data will be processed asynchronously but this API can be used to schedule its processing on demand.