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

API calls for all endpoints tagged SyncStatus.

Link to this section Summary

Link to this section Functions

Link to this function

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

View Source

Specs

Get syncing status.

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
    • :cursor (integer()): The pagination cursor value.
    • :page_size (integer()): Number of results to return per page.

      Returns

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

Link to this function

sync_status_resync_create(connection, x_account_token, opts \\ [])

View Source

Specs

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

Force resync of all models.

Parameters

  • connection (MergeHRISClient.Connection): Connection to server
  • x_account_token (String.t): Token identifying the end user.
  • opts (KeywordList): [optional] Optional parameters

    Returns

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