Class: Merge::Hris::AsyncSyncStatusClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/hris/sync_status/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Hris::AsyncSyncStatusClient

Parameters:



71
72
73
 
# File 'lib/merge_ruby_client/hris/sync_status/client.rb', line 71

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



67
68
69
 
# File 'lib/merge_ruby_client/hris/sync_status/client.rb', line 67

def request_client
  @request_client
end

Instance Method Details

#list(cursor: nil, page_size: nil, request_options: nil) ⇒ Merge::Hris::PaginatedSyncStatusList

Get sync status for the current sync and the most recently finished sync.

`last_sync_start` represents the most recent time any sync began.
`last_sync_finished` represents the most recent time any sync completed. These
timestamps may correspond to different sync instances which may result in a sync
start time being later than a separate sync completed time. To ensure you are
retrieving the latest available data reference the `last_sync_finished`
timestamp where `last_sync_result` is `DONE`. Possible values for `status` and
`last_sync_result` are `DISABLED`, `DONE`, `FAILED`, `PARTIALLY_SYNCED`,
`PAUSED`, `SYNCING`. Learn more about sync status in our [Help
Center](https://help.merge.dev/en/articles/8184193-merge-sync-statuses).

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.hris.sync_status.list(cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw")

Parameters:

  • cursor (String) (defaults to: nil) —

    The pagination cursor value.

  • page_size (Integer) (defaults to: nil) —

    Number of results to return per page.

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/merge_ruby_client/hris/sync_status/client.rb', line 97

def list(cursor: nil, page_size: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "cursor": cursor,
        "page_size": page_size
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/hris/v1/sync-status"
    end
    Merge::Hris::PaginatedSyncStatusList.from_json(json_object: response.body)
  end
end