SelectiveSyncApi.md

MergeHRISClient\SelectiveSyncApi

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

Method	HTTP request	Description
selectiveSyncConfigurationsList()	GET /selective-sync/configurations
selectiveSyncConfigurationsUpdate()	PUT /selective-sync/configurations
selectiveSyncMetaList()	GET /selective-sync/meta

selectiveSyncConfigurationsList()

selectiveSyncConfigurationsList($x_account_token): \MergeHRISClient\Model\LinkedAccountSelectiveSyncConfiguration[]

Get a linked account's selective syncs.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: tokenAuth
$config = MergeHRISClient\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MergeHRISClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MergeHRISClient\Api\SelectiveSyncApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$x_account_token = 'x_account_token_example'; // string | Token identifying the end user.

try {
    $result = $apiInstance->selectiveSyncConfigurationsList($x_account_token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SelectiveSyncApi->selectiveSyncConfigurationsList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
x_account_token	string	Token identifying the end user.

Return type

\MergeHRISClient\Model\LinkedAccountSelectiveSyncConfiguration[]

Authorization

tokenAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

selectiveSyncConfigurationsUpdate()

selectiveSyncConfigurationsUpdate($x_account_token, $linked_account_selective_sync_configuration_list_request): \MergeHRISClient\Model\LinkedAccountSelectiveSyncConfiguration[]

Replace a linked account's selective syncs.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: tokenAuth
$config = MergeHRISClient\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MergeHRISClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MergeHRISClient\Api\SelectiveSyncApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$x_account_token = 'x_account_token_example'; // string | Token identifying the end user.
$linked_account_selective_sync_configuration_list_request = {"linked_account_conditons":[{"condition_schema_id":"123e4567-e89b-12d3-a456-426655440000","operator":"GREATER_THAN_OR_EQUAL","value":"2022-01-01T00:00:00Z"}]}; // \MergeHRISClient\Model\LinkedAccountSelectiveSyncConfigurationListRequest

try {
    $result = $apiInstance->selectiveSyncConfigurationsUpdate($x_account_token, $linked_account_selective_sync_configuration_list_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SelectiveSyncApi->selectiveSyncConfigurationsUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
x_account_token	string	Token identifying the end user.
linked_account_selective_sync_configuration_list_request	\MergeHRISClient\Model\LinkedAccountSelectiveSyncConfigurationListRequest

Return type

\MergeHRISClient\Model\LinkedAccountSelectiveSyncConfiguration[]

Authorization

tokenAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

selectiveSyncMetaList()

selectiveSyncMetaList($x_account_token, $common_model, $cursor, $page_size): \MergeHRISClient\Model\PaginatedConditionSchemaList

Get metadata for the conditions available to a linked account.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: tokenAuth
$config = MergeHRISClient\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = MergeHRISClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new MergeHRISClient\Api\SelectiveSyncApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$x_account_token = 'x_account_token_example'; // string | Token identifying the end user.
$common_model = 'common_model_example'; // string
$cursor = cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw; // string | The pagination cursor value.
$page_size = 56; // int | Number of results to return per page.

try {
    $result = $apiInstance->selectiveSyncMetaList($x_account_token, $common_model, $cursor, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SelectiveSyncApi->selectiveSyncMetaList: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

\MergeHRISClient\Model\PaginatedConditionSchemaList

Authorization

tokenAuth

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]