relentless_identity 1.0.0

data/docs/JobsApi.md

@@ -0,0 +1,529 @@
+# RelentlessIdentity::JobsApi
+
+All URIs are relative to *https://api.relentlessidentity.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_job**](JobsApi.md#get_job) | **GET** /client/jobs/{job_id} | Get background job |
+| [**get_job_inputs_text**](JobsApi.md#get_job_inputs_text) | **GET** /client/jobs/{job_id}/inputs.txt | Download job inputs |
+| [**get_job_results_json**](JobsApi.md#get_job_results_json) | **GET** /client/jobs/{job_id}/results.json | Download job results as JSON |
+| [**get_job_results_text**](JobsApi.md#get_job_results_text) | **GET** /client/jobs/{job_id}/results.txt | Download job results as text |
+| [**list_jobs**](JobsApi.md#list_jobs) | **GET** /client/jobs | List background jobs |
+| [**schedule_finder_batch**](JobsApi.md#schedule_finder_batch) | **POST** /client/jobs/finder | Schedule a finder batch |
+| [**schedule_probe_batch**](JobsApi.md#schedule_probe_batch) | **POST** /client/jobs/probe-batch | Schedule a probe batch |
+
+
+## get_job
+
+> <ClientBackgroundJobDetailResponse> get_job(job_id, opts)
+
+Get background job
+
+Return the current status and paginated results for one background job.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::JobsApi.new
+job_id = 'job_id_example' # String | 
+opts = {
+  page: 56, # Integer | 
+  page_size: 56 # Integer | 
+}
+
+begin
+  # Get background job
+  result = api_instance.get_job(job_id, opts)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->get_job: #{e}"
+end
+```
+
+#### Using the get_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientBackgroundJobDetailResponse>, Integer, Hash)> get_job_with_http_info(job_id, opts)
+
+```ruby
+begin
+  # Get background job
+  data, status_code, headers = api_instance.get_job_with_http_info(job_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientBackgroundJobDetailResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->get_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **page_size** | **Integer** |  | [optional][default to 50] |
+
+### Return type
+
+[**ClientBackgroundJobDetailResponse**](ClientBackgroundJobDetailResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_job_inputs_text
+
+> String get_job_inputs_text(job_id, opts)
+
+Download job inputs
+
+Return the original background job inputs as plain text when the payload is still retained.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::JobsApi.new
+job_id = 'job_id_example' # String | 
+opts = {
+  if_none_match: 'if_none_match_example', # String | 
+  if_modified_since: 'if_modified_since_example' # String | 
+}
+
+begin
+  # Download job inputs
+  result = api_instance.get_job_inputs_text(job_id, opts)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->get_job_inputs_text: #{e}"
+end
+```
+
+#### Using the get_job_inputs_text_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_job_inputs_text_with_http_info(job_id, opts)
+
+```ruby
+begin
+  # Download job inputs
+  data, status_code, headers = api_instance.get_job_inputs_text_with_http_info(job_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->get_job_inputs_text_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+| **if_none_match** | **String** |  | [optional] |
+| **if_modified_since** | **String** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## get_job_results_json
+
+> Object get_job_results_json(job_id, opts)
+
+Download job results as JSON
+
+Return the canonical immutable background job results artifact as JSON.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::JobsApi.new
+job_id = 'job_id_example' # String | 
+opts = {
+  if_none_match: 'if_none_match_example', # String | 
+  if_modified_since: 'if_modified_since_example' # String | 
+}
+
+begin
+  # Download job results as JSON
+  result = api_instance.get_job_results_json(job_id, opts)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->get_job_results_json: #{e}"
+end
+```
+
+#### Using the get_job_results_json_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_job_results_json_with_http_info(job_id, opts)
+
+```ruby
+begin
+  # Download job results as JSON
+  data, status_code, headers = api_instance.get_job_results_json_with_http_info(job_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->get_job_results_json_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+| **if_none_match** | **String** |  | [optional] |
+| **if_modified_since** | **String** |  | [optional] |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_job_results_text
+
+> String get_job_results_text(job_id, opts)
+
+Download job results as text
+
+Return the canonical background job results in a readable plain-text format.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::JobsApi.new
+job_id = 'job_id_example' # String | 
+opts = {
+  if_none_match: 'if_none_match_example', # String | 
+  if_modified_since: 'if_modified_since_example' # String | 
+}
+
+begin
+  # Download job results as text
+  result = api_instance.get_job_results_text(job_id, opts)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->get_job_results_text: #{e}"
+end
+```
+
+#### Using the get_job_results_text_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_job_results_text_with_http_info(job_id, opts)
+
+```ruby
+begin
+  # Download job results as text
+  data, status_code, headers = api_instance.get_job_results_text_with_http_info(job_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->get_job_results_text_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job_id** | **String** |  |  |
+| **if_none_match** | **String** |  | [optional] |
+| **if_modified_since** | **String** |  | [optional] |
+
+### Return type
+
+**String**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json
+
+
+## list_jobs
+
+> <ClientBackgroundJobPageResponse> list_jobs(opts)
+
+List background jobs
+
+Return the authenticated user's paginated background job history.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::JobsApi.new
+opts = {
+  page: 56, # Integer | 
+  page_size: 56, # Integer | 
+  job_type: 'finder_batch', # String | 
+  status: 'queued' # String | 
+}
+
+begin
+  # List background jobs
+  result = api_instance.list_jobs(opts)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->list_jobs: #{e}"
+end
+```
+
+#### Using the list_jobs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientBackgroundJobPageResponse>, Integer, Hash)> list_jobs_with_http_info(opts)
+
+```ruby
+begin
+  # List background jobs
+  data, status_code, headers = api_instance.list_jobs_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientBackgroundJobPageResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->list_jobs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** |  | [optional][default to 1] |
+| **page_size** | **Integer** |  | [optional][default to 25] |
+| **job_type** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+
+### Return type
+
+[**ClientBackgroundJobPageResponse**](ClientBackgroundJobPageResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## schedule_finder_batch
+
+> <ClientBackgroundJobResponse> schedule_finder_batch(finder_batch_job_request)
+
+Schedule a finder batch
+
+Queue a background finder batch job with an optional deadline and callback URL.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::JobsApi.new
+finder_batch_job_request = RelentlessIdentity::FinderBatchJobRequest.new({inputs: [RelentlessIdentity::FinderBatchJobRequestInputsInner.new({full_name: 'Jane Doe', email_domain: 'acme.com'})]}) # FinderBatchJobRequest | 
+
+begin
+  # Schedule a finder batch
+  result = api_instance.schedule_finder_batch(finder_batch_job_request)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->schedule_finder_batch: #{e}"
+end
+```
+
+#### Using the schedule_finder_batch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientBackgroundJobResponse>, Integer, Hash)> schedule_finder_batch_with_http_info(finder_batch_job_request)
+
+```ruby
+begin
+  # Schedule a finder batch
+  data, status_code, headers = api_instance.schedule_finder_batch_with_http_info(finder_batch_job_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientBackgroundJobResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->schedule_finder_batch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **finder_batch_job_request** | [**FinderBatchJobRequest**](FinderBatchJobRequest.md) |  |  |
+
+### Return type
+
+[**ClientBackgroundJobResponse**](ClientBackgroundJobResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## schedule_probe_batch
+
+> <ClientBackgroundJobResponse> schedule_probe_batch(probe_batch_job_background_request)
+
+Schedule a probe batch
+
+Queue a background probe batch job with an optional deadline and callback URL.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::JobsApi.new
+probe_batch_job_background_request = RelentlessIdentity::ProbeBatchJobBackgroundRequest.new({emails: ["jane.doe@acme.com", "john.smith@acme.com"]}) # ProbeBatchJobBackgroundRequest | 
+
+begin
+  # Schedule a probe batch
+  result = api_instance.schedule_probe_batch(probe_batch_job_background_request)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->schedule_probe_batch: #{e}"
+end
+```
+
+#### Using the schedule_probe_batch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientBackgroundJobResponse>, Integer, Hash)> schedule_probe_batch_with_http_info(probe_batch_job_background_request)
+
+```ruby
+begin
+  # Schedule a probe batch
+  data, status_code, headers = api_instance.schedule_probe_batch_with_http_info(probe_batch_job_background_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientBackgroundJobResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling JobsApi->schedule_probe_batch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **probe_batch_job_background_request** | [**ProbeBatchJobBackgroundRequest**](ProbeBatchJobBackgroundRequest.md) |  |  |
+
+### Return type
+
+[**ClientBackgroundJobResponse**](ClientBackgroundJobResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/LocationInner.md

@@ -0,0 +1,15 @@
+# RelentlessIdentity::LocationInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::LocationInner.new()
+```
+

data/docs/ProbeApi.md

@@ -0,0 +1,147 @@
+# RelentlessIdentity::ProbeApi
+
+All URIs are relative to *https://api.relentlessidentity.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**probe_batch**](ProbeApi.md#probe_batch) | **POST** /client/probe/batch | Verify many email addresses |
+| [**probe_email**](ProbeApi.md#probe_email) | **POST** /client/probe | Verify an email address |
+
+
+## probe_batch
+
+> <ClientBatchIdentityResponse> probe_batch(probe_batch_request)
+
+Verify many email addresses
+
+Send many known email addresses and receive compact per-item identity results plus a batch summary.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::ProbeApi.new
+probe_batch_request = RelentlessIdentity::ProbeBatchRequest.new({emails: ["jane.doe@acme.com", "john.smith@acme.com"]}) # ProbeBatchRequest | 
+
+begin
+  # Verify many email addresses
+  result = api_instance.probe_batch(probe_batch_request)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling ProbeApi->probe_batch: #{e}"
+end
+```
+
+#### Using the probe_batch_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientBatchIdentityResponse>, Integer, Hash)> probe_batch_with_http_info(probe_batch_request)
+
+```ruby
+begin
+  # Verify many email addresses
+  data, status_code, headers = api_instance.probe_batch_with_http_info(probe_batch_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientBatchIdentityResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling ProbeApi->probe_batch_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **probe_batch_request** | [**ProbeBatchRequest**](ProbeBatchRequest.md) |  |  |
+
+### Return type
+
+[**ClientBatchIdentityResponse**](ClientBatchIdentityResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## probe_email
+
+> <ClientIdentityResponse> probe_email(probe_request)
+
+Verify an email address
+
+Send a single email address to verify it directly.
+
+### Examples
+
+```ruby
+require 'time'
+require 'relentless_identity'
+# setup authorization
+RelentlessIdentity.configure do |config|
+  # Configure Bearer authorization (PAT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RelentlessIdentity::ProbeApi.new
+probe_request = RelentlessIdentity::ProbeRequest.new({email: 'jane.doe@acme.com'}) # ProbeRequest | 
+
+begin
+  # Verify an email address
+  result = api_instance.probe_email(probe_request)
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling ProbeApi->probe_email: #{e}"
+end
+```
+
+#### Using the probe_email_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientIdentityResponse>, Integer, Hash)> probe_email_with_http_info(probe_request)
+
+```ruby
+begin
+  # Verify an email address
+  data, status_code, headers = api_instance.probe_email_with_http_info(probe_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientIdentityResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling ProbeApi->probe_email_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **probe_request** | [**ProbeRequest**](ProbeRequest.md) |  |  |
+
+### Return type
+
+[**ClientIdentityResponse**](ClientIdentityResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ProbeBatchJobBackgroundRequest.md

@@ -0,0 +1,22 @@
+# RelentlessIdentity::ProbeBatchJobBackgroundRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **deadline** | **Time** | Optional hard deadline for the job. Omit it to start as soon as capacity allows. If provided, the API returns 422 when the deadline is too tight even with immediate execution. | [optional] |
+| **callback_url** | **String** |  | [optional] |
+| **emails** | **Array<String>** | One or more exact mailbox addresses to verify asynchronously. |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ProbeBatchJobBackgroundRequest.new(
+  deadline: 2027-01-02T00:00Z,
+  callback_url: null,
+  emails: ["jane.doe@acme.com","john.smith@acme.com"]
+)
+```
+