relentless_identity

RelentlessIdentity - the Ruby gem for the Relentless Identity API

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 SDK 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.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build relentless_identity.gemspec

Then either install the gem locally:

gem install ./relentless_identity-1.0.0.gem

(for development, run gem install --dev ./relentless_identity-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'relentless_identity', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'relentless_identity', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'relentless_identity'

# Setup authorization
RelentlessIdentity.configure do |config|
  # Configure Bearer authorization (PAT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = RelentlessIdentity::AccountApi.new
opts = {
  page: 56, # Integer | Page number starting at 1.
  page_size: 56, # Integer | Number of history rows per page. Maximum 25.
  request_type: 'finder', # String | Optional request-type filter.
  state: 'deliverable' # String | Optional deliverability-state filter.
}

begin
  #Get paginated request history
  result = api_instance.get_request_history(opts)
  p result
rescue RelentlessIdentity::ApiError => e
  puts "Exception when calling AccountApi->get_request_history: #{e}"
end

Documentation for API Endpoints

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

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