Skip to content

SyncStatusApi.md

Latest commit

 

History

History
85 lines (58 loc) · 2.42 KB

SyncStatusApi.md

File metadata and controls

85 lines (58 loc) · 2.42 KB

MergeCRMClient::SyncStatusApi

All URIs are relative to https://api.merge.dev/api/crm/v1

Method HTTP request Description
sync_status_list GET /sync-status

sync_status_list

sync_status_list(x_account_token, opts)

Get syncing status. Possible values: DISABLED, DONE, FAILED, PARTIALLY_SYNCED, PAUSED, SYNCING

Examples

require 'time'
require 'merge_crm_client'
# setup authorization
MergeCRMClient.configure do |config|
  # Configure API key authorization: tokenAuth
  config.api_key['tokenAuth'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['tokenAuth'] = 'Bearer'
end

api_instance = MergeCRMClient::SyncStatusApi.new
x_account_token = 'x_account_token_example' # String | Token identifying the end user.
opts = {
  cursor: 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw', # String | The pagination cursor value.
  page_size: 56 # Integer | Number of results to return per page.
}

begin
  
  result = api_instance.sync_status_list(x_account_token, opts)
  p result
rescue MergeCRMClient::ApiError => e
  puts "Error when calling SyncStatusApi->sync_status_list: #{e}"
end

Using the sync_status_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> sync_status_list_with_http_info(x_account_token, opts)

begin
  
  data, status_code, headers = api_instance.sync_status_list_with_http_info(x_account_token, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaginatedSyncStatusList>
rescue MergeCRMClient::ApiError => e
  puts "Error when calling SyncStatusApi->sync_status_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
x_account_token String Token identifying the end user.
cursor String The pagination cursor value. [optional]
page_size Integer Number of results to return per page. [optional]

Return type

PaginatedSyncStatusList

Authorization

tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json