Skip to content

UsersApi.md

Latest commit

 

History

History
204 lines (152 loc) · 9.33 KB

UsersApi.md

File metadata and controls

204 lines (152 loc) · 9.33 KB

MergeATSClient.UsersApi

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

Method HTTP request Description
users_list GET /users
users_retrieve GET /users/{id}

users_list

PaginatedRemoteUserList users_list(x_account_token)

Returns a list of RemoteUser objects.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeATSClient
from MergeATSClient.api import users_api
from MergeATSClient.model.paginated_remote_user_list import PaginatedRemoteUserList
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeATSClient.Configuration(
    host = "https://api.merge.dev/api/ats/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 MergeATSClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = users_api.UsersApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.
    created_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects created after this datetime. (optional)
    created_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects created before this datetime. (optional)
    cursor = "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw" # str | The pagination cursor value. (optional)
    email = "email_example" # str, none_type | If provided, will only return remote users with the given email address (optional)
    include_deleted_data = True # bool | Whether to include data that was marked as deleted by third party webhooks. (optional)
    include_remote_data = True # bool | Whether to include the original data Merge fetched from the third-party to produce these models. (optional)
    modified_after = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects modified after this datetime. (optional)
    modified_before = dateutil_parser('1970-01-01T00:00:00.00Z') # datetime | If provided, will only return objects modified before this datetime. (optional)
    page_size = 1 # int | Number of results to return per page. (optional)
    remote_fields = "access_role" # str | Which fields should be returned in non-normalized form. (optional) if omitted the server will use the default value of "access_role"
    remote_id = "remote_id_example" # str, none_type | The API provider's ID for the given object. (optional)

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.users_list(x_account_token, created_after=created_after, created_before=created_before, cursor=cursor, email=email, include_deleted_data=include_deleted_data, include_remote_data=include_remote_data, modified_after=modified_after, modified_before=modified_before, page_size=page_size, remote_fields=remote_fields, remote_id=remote_id)
        pprint(api_response)
    except MergeATSClient.ApiException as e:
        print("Exception when calling UsersApi->users_list: %s\n" % e)

Parameters

Name Type Description Notes
x_account_token str Token identifying the end user.
created_after datetime If provided, will only return objects created after this datetime. [optional]
created_before datetime If provided, will only return objects created before this datetime. [optional]
cursor str The pagination cursor value. [optional]
email str, none_type If provided, will only return remote users with the given email address [optional]
include_deleted_data bool Whether to include data that was marked as deleted by third party webhooks. [optional]
include_remote_data bool Whether to include the original data Merge fetched from the third-party to produce these models. [optional]
modified_after datetime If provided, will only return objects modified after this datetime. [optional]
modified_before datetime If provided, will only return objects modified before this datetime. [optional]
page_size int Number of results to return per page. [optional]
remote_fields str Which fields should be returned in non-normalized form. [optional] if omitted the server will use the default value of "access_role"
remote_id str, none_type The API provider's ID for the given object. [optional]

Return type

PaginatedRemoteUserList

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]

users_retrieve

RemoteUser users_retrieve(x_account_token, id)

Returns a RemoteUser object with the given id.

Example

  • Api Key Authentication (tokenAuth):
import time
import MergeATSClient
from MergeATSClient.api import users_api
from MergeATSClient.model.remote_user import RemoteUser
from pprint import pprint
# Defining the host is optional and defaults to https://api.merge.dev/api/ats/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = MergeATSClient.Configuration(
    host = "https://api.merge.dev/api/ats/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 MergeATSClient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = users_api.UsersApi(api_client)
    x_account_token = "X-Account-Token_example" # str | Token identifying the end user.
    id = "id_example" # str | 
    include_remote_data = True # bool | Whether to include the original data Merge fetched from the third-party to produce these models. (optional)
    remote_fields = "access_role" # str | Which fields should be returned in non-normalized form. (optional) if omitted the server will use the default value of "access_role"

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

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        api_response = api_instance.users_retrieve(x_account_token, id, include_remote_data=include_remote_data, remote_fields=remote_fields)
        pprint(api_response)
    except MergeATSClient.ApiException as e:
        print("Exception when calling UsersApi->users_retrieve: %s\n" % e)

Parameters

Name Type Description Notes
x_account_token str Token identifying the end user.
id str
include_remote_data bool Whether to include the original data Merge fetched from the third-party to produce these models. [optional]
remote_fields str Which fields should be returned in non-normalized form. [optional] if omitted the server will use the default value of "access_role"

Return type

RemoteUser

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]