Skip to content

Latest commit

 

History

History
265 lines (191 loc) · 10 KB

SelectiveSyncApi.md

File metadata and controls

265 lines (191 loc) · 10 KB
Raw

MergeHRISClient.SelectiveSyncApi

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

Method HTTP request Description
selective_sync_configurations_list GET /selective-sync/configurations
selective_sync_configurations_update PUT /selective-sync/configurations
selective_sync_meta_list GET /selective-sync/meta

selective_sync_configurations_list

[LinkedAccountSelectiveSyncConfiguration] selective_sync_configurations_list(x_account_token)

Get a linked account's selective syncs.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeHRISClient
from MergeHRISClient.api import selective_sync_api
from MergeHRISClient.model.linked_account_selective_sync_configuration import LinkedAccountSelectiveSyncConfiguration
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/hris/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeHRISClient.Configuration(
    host = "https://api.merge.dev/api/hris/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with MergeHRISClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = selective_sync_api.SelectiveSyncApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.selective_sync_configurations_list(x_account_token)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling SelectiveSyncApi->selective_sync_configurations_list: %s\n" % e)

Parameters

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

Return type

[LinkedAccountSelectiveSyncConfiguration]

Authorization

tokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

selective_sync_configurations_update

[LinkedAccountSelectiveSyncConfiguration] selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)

Replace a linked account's selective syncs.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeHRISClient
from MergeHRISClient.api import selective_sync_api
from MergeHRISClient.model.linked_account_selective_sync_configuration import LinkedAccountSelectiveSyncConfiguration
from MergeHRISClient.model.linked_account_selective_sync_configuration_list_request import LinkedAccountSelectiveSyncConfigurationListRequest
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/hris/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeHRISClient.Configuration(
    host = "https://api.merge.dev/api/hris/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with MergeHRISClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = selective_sync_api.SelectiveSyncApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.
    linked_account_selective_sync_configuration_list_request = LinkedAccountSelectiveSyncConfigurationListRequest(
        sync_configurations=[
            LinkedAccountSelectiveSyncConfigurationRequest(
                linked_account_conditions=[
                    LinkedAccountConditionRequest(
                        condition_schema_id="condition_schema_id_example",
                        operator="operator_example",
                        value=None,
                    ),
                ],
            ),
        ],
    ) # LinkedAccountSelectiveSyncConfigurationListRequest | 

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.selective_sync_configurations_update(x_account_token, linked_account_selective_sync_configuration_list_request)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling SelectiveSyncApi->selective_sync_configurations_update: %s\n" % e)

Parameters

Name Type Description Notes
x_account_token str Token identifying the end user.
linked_account_selective_sync_configuration_list_request LinkedAccountSelectiveSyncConfigurationListRequest

Return type

[LinkedAccountSelectiveSyncConfiguration]

Authorization

tokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

selective_sync_meta_list

PaginatedConditionSchemaList selective_sync_meta_list(x_account_token)

Get metadata for the conditions available to a linked account.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeHRISClient
from MergeHRISClient.api import selective_sync_api
from MergeHRISClient.model.paginated_condition_schema_list import PaginatedConditionSchemaList
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/hris/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeHRISClient.Configuration(
    host = "https://api.merge.dev/api/hris/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: tokenAuth
configuration.api_key['tokenAuth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['tokenAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with MergeHRISClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = selective_sync_api.SelectiveSyncApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.
    common_model = "common_model_example" # str |  (optional)
    cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" # str | The pagination cursor value. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)

    # example passing only required values which don't have defaults set
    try:
        api_response = api_instance.selective_sync_meta_list(x_account_token)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling SelectiveSyncApi->selective_sync_meta_list: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.selective_sync_meta_list(x_account_token, common_model=common_model, cursor=cursor, page_size=page_size)
        pprint(api_response)
    except MergeHRISClient.ApiException as e:
        print("Exception when calling SelectiveSyncApi->selective_sync_meta_list: %s\n" % e)

Parameters

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

Return type

PaginatedConditionSchemaList

Authorization

tokenAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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