relentless-identity 1.0.0

Relentless Identity API

relentless-identity

Public client API for Finder and Probe workflows. This spec is generated from the FastAPI app, then narrowed to the supported bearer-authenticated routes used by SDKs and the API reference.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.21.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import relentless_identity

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import relentless_identity

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import relentless_identity
from relentless_identity.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.relentlessidentity.com
# See configuration.py for a list of all supported configuration parameters.
configuration = relentless_identity.Configuration(
    host = "https://api.relentlessidentity.com"
)

# 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 Bearer authorization (PAT): bearerAuth
configuration = relentless_identity.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with relentless_identity.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = relentless_identity.AccountApi(api_client)
    page = 1 # int | Page number starting at 1. (optional) (default to 1)
    page_size = 25 # int | Number of history rows per page. Maximum 25. (optional) (default to 25)
    request_type = 'request_type_example' # str | Optional request-type filter. (optional)
    state = 'state_example' # str | Optional deliverability-state filter. (optional)

    try:
        # Get paginated request history
        api_response = api_instance.get_request_history(page=page, page_size=page_size, request_type=request_type, state=state)
        print("The response of AccountApi->get_request_history:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->get_request_history: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.relentlessidentity.com

Class	Method	HTTP request	Description
AccountApi	get_request_history	GET /client/history	Get paginated request history
AccountApi	get_token_status	GET /client/token	Inspect the current bearer token
AccountApi	get_usage	GET /client/usage	Get current usage and limits
FinderApi	finder_attempt	POST /client/attempt	Find a work email
JobsApi	get_job	GET /client/jobs/{job_id}	Get background job
JobsApi	get_job_inputs_text	GET /client/jobs/{job_id}/inputs.txt	Download job inputs
JobsApi	get_job_results_json	GET /client/jobs/{job_id}/results.json	Download job results as JSON
JobsApi	get_job_results_text	GET /client/jobs/{job_id}/results.txt	Download job results as text
JobsApi	list_jobs	GET /client/jobs	List background jobs
JobsApi	schedule_finder_batch	POST /client/jobs/finder	Schedule a finder batch
JobsApi	schedule_probe_batch	POST /client/jobs/probe-batch	Schedule a probe batch
ProbeApi	probe_batch	POST /client/probe/batch	Verify many email addresses
ProbeApi	probe_email	POST /client/probe	Verify an email address

Documentation For Models

• AliasInfo
• BatchSummary
• ClientBackgroundJobDetailResponse
• ClientBackgroundJobItemResponse
• ClientBackgroundJobPageResponse
• ClientBackgroundJobResponse
• ClientBatchIdentityResponse
• ClientFinderResponse
• ClientFinderResponseAlias
• ClientIdentityResponse
• ClientRequestHistoryItem
• ClientRequestHistoryPageResponse
• ClientTokenStatusResponse
• ClientUsageResponse
• ErrorResponse
• FinderBatchJobRequest
• FinderBatchJobRequestInputsInner
• FinderRequest
• HTTPValidationError
• IdentityProvider
• LocationInner
• ProbeBatchJobBackgroundRequest
• ProbeBatchRequest
• ProbeRequest
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (PAT)

Author