relentless_identity 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 834d934cf1f94e2fccf87ea4abd77b262ff1413c77c65729b49aea6d4377a6ec
+  data.tar.gz: 842641417f0642347312378cda1811bb0e097804cedb717ec35960d28f12844f
+SHA512:
+  metadata.gz: bfaab2de37843312daecb43bbe71b9394cc30388dc5a44d387bc481ac6db029f1a8fb0b38b24d701e24edafe82ceb18280b3a39dd27274b7a830784df588c917
+  data.tar.gz: 550fa7044f4871a347506010b2bb8587c12610e07594373790c6fcbaa8c9e05c8a6e19048a2249ea812d785956d09b60513e1f36542af4cef457bfe12faabd15

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,143 @@
+# 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](https://openapi-generator.tech) 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:
+
+```shell
+gem build relentless_identity.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```ruby
+# 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**](docs/AccountApi.md#get_request_history) | **GET** /client/history | Get paginated request history
+*RelentlessIdentity::AccountApi* | [**get_token_status**](docs/AccountApi.md#get_token_status) | **GET** /client/token | Inspect the current bearer token
+*RelentlessIdentity::AccountApi* | [**get_usage**](docs/AccountApi.md#get_usage) | **GET** /client/usage | Get current usage and limits
+*RelentlessIdentity::FinderApi* | [**finder_attempt**](docs/FinderApi.md#finder_attempt) | **POST** /client/attempt | Find a work email
+*RelentlessIdentity::JobsApi* | [**get_job**](docs/JobsApi.md#get_job) | **GET** /client/jobs/{job_id} | Get background job
+*RelentlessIdentity::JobsApi* | [**get_job_inputs_text**](docs/JobsApi.md#get_job_inputs_text) | **GET** /client/jobs/{job_id}/inputs.txt | Download job inputs
+*RelentlessIdentity::JobsApi* | [**get_job_results_json**](docs/JobsApi.md#get_job_results_json) | **GET** /client/jobs/{job_id}/results.json | Download job results as JSON
+*RelentlessIdentity::JobsApi* | [**get_job_results_text**](docs/JobsApi.md#get_job_results_text) | **GET** /client/jobs/{job_id}/results.txt | Download job results as text
+*RelentlessIdentity::JobsApi* | [**list_jobs**](docs/JobsApi.md#list_jobs) | **GET** /client/jobs | List background jobs
+*RelentlessIdentity::JobsApi* | [**schedule_finder_batch**](docs/JobsApi.md#schedule_finder_batch) | **POST** /client/jobs/finder | Schedule a finder batch
+*RelentlessIdentity::JobsApi* | [**schedule_probe_batch**](docs/JobsApi.md#schedule_probe_batch) | **POST** /client/jobs/probe-batch | Schedule a probe batch
+*RelentlessIdentity::ProbeApi* | [**probe_batch**](docs/ProbeApi.md#probe_batch) | **POST** /client/probe/batch | Verify many email addresses
+*RelentlessIdentity::ProbeApi* | [**probe_email**](docs/ProbeApi.md#probe_email) | **POST** /client/probe | Verify an email address
+
+
+## Documentation for Models
+
+ - [RelentlessIdentity::AliasInfo](docs/AliasInfo.md)
+ - [RelentlessIdentity::BatchSummary](docs/BatchSummary.md)
+ - [RelentlessIdentity::ClientBackgroundJobDetailResponse](docs/ClientBackgroundJobDetailResponse.md)
+ - [RelentlessIdentity::ClientBackgroundJobItemResponse](docs/ClientBackgroundJobItemResponse.md)
+ - [RelentlessIdentity::ClientBackgroundJobPageResponse](docs/ClientBackgroundJobPageResponse.md)
+ - [RelentlessIdentity::ClientBackgroundJobResponse](docs/ClientBackgroundJobResponse.md)
+ - [RelentlessIdentity::ClientBatchIdentityResponse](docs/ClientBatchIdentityResponse.md)
+ - [RelentlessIdentity::ClientFinderResponse](docs/ClientFinderResponse.md)
+ - [RelentlessIdentity::ClientFinderResponseAlias](docs/ClientFinderResponseAlias.md)
+ - [RelentlessIdentity::ClientIdentityResponse](docs/ClientIdentityResponse.md)
+ - [RelentlessIdentity::ClientRequestHistoryItem](docs/ClientRequestHistoryItem.md)
+ - [RelentlessIdentity::ClientRequestHistoryPageResponse](docs/ClientRequestHistoryPageResponse.md)
+ - [RelentlessIdentity::ClientTokenStatusResponse](docs/ClientTokenStatusResponse.md)
+ - [RelentlessIdentity::ClientUsageResponse](docs/ClientUsageResponse.md)
+ - [RelentlessIdentity::ErrorResponse](docs/ErrorResponse.md)
+ - [RelentlessIdentity::FinderBatchJobRequest](docs/FinderBatchJobRequest.md)
+ - [RelentlessIdentity::FinderBatchJobRequestInputsInner](docs/FinderBatchJobRequestInputsInner.md)
+ - [RelentlessIdentity::FinderRequest](docs/FinderRequest.md)
+ - [RelentlessIdentity::HTTPValidationError](docs/HTTPValidationError.md)
+ - [RelentlessIdentity::IdentityProvider](docs/IdentityProvider.md)
+ - [RelentlessIdentity::LocationInner](docs/LocationInner.md)
+ - [RelentlessIdentity::ProbeBatchJobBackgroundRequest](docs/ProbeBatchJobBackgroundRequest.md)
+ - [RelentlessIdentity::ProbeBatchRequest](docs/ProbeBatchRequest.md)
+ - [RelentlessIdentity::ProbeRequest](docs/ProbeRequest.md)
+ - [RelentlessIdentity::ValidationError](docs/ValidationError.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### bearerAuth
+
+- **Type**: Bearer authentication (PAT)
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AccountApi.md

@@ -0,0 +1,219 @@
+# RelentlessIdentity::AccountApi
+
+All URIs are relative to *https://api.relentlessidentity.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_request_history**](AccountApi.md#get_request_history) | **GET** /client/history | Get paginated request history |
+| [**get_token_status**](AccountApi.md#get_token_status) | **GET** /client/token | Inspect the current bearer token |
+| [**get_usage**](AccountApi.md#get_usage) | **GET** /client/usage | Get current usage and limits |
+
+
+## get_request_history
+
+> <ClientRequestHistoryPageResponse> get_request_history(opts)
+
+Get paginated request history
+
+Return the authenticated user's latest request history with pagination and optional filters.
+
+### 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::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 "Error when calling AccountApi->get_request_history: #{e}"
+end
+```
+
+#### Using the get_request_history_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientRequestHistoryPageResponse>, Integer, Hash)> get_request_history_with_http_info(opts)
+
+```ruby
+begin
+  # Get paginated request history
+  data, status_code, headers = api_instance.get_request_history_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientRequestHistoryPageResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling AccountApi->get_request_history_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number starting at 1. | [optional][default to 1] |
+| **page_size** | **Integer** | Number of history rows per page. Maximum 25. | [optional][default to 25] |
+| **request_type** | **String** | Optional request-type filter. | [optional] |
+| **state** | **String** | Optional deliverability-state filter. | [optional] |
+
+### Return type
+
+[**ClientRequestHistoryPageResponse**](ClientRequestHistoryPageResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_token_status
+
+> <ClientTokenStatusResponse> get_token_status
+
+Inspect the current bearer token
+
+Validate the current bearer token and return its active claims.
+
+### 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::AccountApi.new
+
+begin
+  # Inspect the current bearer token
+  result = api_instance.get_token_status
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling AccountApi->get_token_status: #{e}"
+end
+```
+
+#### Using the get_token_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientTokenStatusResponse>, Integer, Hash)> get_token_status_with_http_info
+
+```ruby
+begin
+  # Inspect the current bearer token
+  data, status_code, headers = api_instance.get_token_status_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientTokenStatusResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling AccountApi->get_token_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ClientTokenStatusResponse**](ClientTokenStatusResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_usage
+
+> <ClientUsageResponse> get_usage
+
+Get current usage and limits
+
+Return the current account usage, free-tier limits, and paid capacity details for the authenticated user.
+
+### 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::AccountApi.new
+
+begin
+  # Get current usage and limits
+  result = api_instance.get_usage
+  p result
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling AccountApi->get_usage: #{e}"
+end
+```
+
+#### Using the get_usage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ClientUsageResponse>, Integer, Hash)> get_usage_with_http_info
+
+```ruby
+begin
+  # Get current usage and limits
+  data, status_code, headers = api_instance.get_usage_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ClientUsageResponse>
+rescue RelentlessIdentity::ApiError => e
+  puts "Error when calling AccountApi->get_usage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ClientUsageResponse**](ClientUsageResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AliasInfo.md

@@ -0,0 +1,20 @@
+# RelentlessIdentity::AliasInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **original** | **String** |  | [optional] |
+| **resolved** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::AliasInfo.new(
+  original: null,
+  resolved: null
+)
+```
+

data/docs/BatchSummary.md

@@ -0,0 +1,26 @@
+# RelentlessIdentity::BatchSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Total number of requested items. |  |
+| **found** | **Integer** | Items that resolved to a positive deliverable result. |  |
+| **not_found** | **Integer** | Items that completed cleanly with a negative result. |  |
+| **errors** | **Integer** | Items that ended with an operational verification error rather than a mailbox verdict. |  |
+| **unique_domains** | **Integer** | Distinct mailbox domains represented in the batch. |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::BatchSummary.new(
+  total: null,
+  found: null,
+  not_found: null,
+  errors: null,
+  unique_domains: null
+)
+```
+

data/docs/ClientBackgroundJobDetailResponse.md

@@ -0,0 +1,30 @@
+# RelentlessIdentity::ClientBackgroundJobDetailResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **job** | [**ClientBackgroundJobResponse**](ClientBackgroundJobResponse.md) |  |  |
+| **items** | [**Array<ClientBackgroundJobItemResponse>**](ClientBackgroundJobItemResponse.md) |  |  |
+| **total_items** | **Integer** |  |  |
+| **page** | **Integer** |  |  |
+| **page_size** | **Integer** |  |  |
+| **total_pages** | **Integer** |  |  |
+| **results_expired** | **Boolean** | Whether the stored item payload rows have already expired and been pruned. | [optional] |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientBackgroundJobDetailResponse.new(
+  job: null,
+  items: null,
+  total_items: null,
+  page: null,
+  page_size: null,
+  total_pages: null,
+  results_expired: null
+)
+```
+

data/docs/ClientBackgroundJobItemResponse.md

@@ -0,0 +1,48 @@
+# RelentlessIdentity::ClientBackgroundJobItemResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **item_index** | **Integer** |  |  |
+| **status** | **String** |  |  |
+| **request_type** | **String** |  |  |
+| **input** | **Hash<String, Object>** | Original submitted input for this item. |  |
+| **result** | **Hash<String, Object>** |  | [optional] |
+| **result_state** | **String** |  | [optional] |
+| **result_outcome** | **String** |  | [optional] |
+| **resolved_address** | **String** |  | [optional] |
+| **provider** | **String** |  | [optional] |
+| **charge_micros** | **Integer** |  | [optional][default to 0] |
+| **error_message** | **String** |  | [optional] |
+| **started_at** | **Time** |  | [optional] |
+| **completed_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientBackgroundJobItemResponse.new(
+  id: null,
+  item_index: null,
+  status: null,
+  request_type: null,
+  input: null,
+  result: null,
+  result_state: null,
+  result_outcome: null,
+  resolved_address: null,
+  provider: null,
+  charge_micros: null,
+  error_message: null,
+  started_at: null,
+  completed_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/ClientBackgroundJobPageResponse.md

@@ -0,0 +1,26 @@
+# RelentlessIdentity::ClientBackgroundJobPageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<ClientBackgroundJobResponse>**](ClientBackgroundJobResponse.md) |  |  |
+| **total** | **Integer** |  |  |
+| **page** | **Integer** |  |  |
+| **page_size** | **Integer** |  |  |
+| **total_pages** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientBackgroundJobPageResponse.new(
+  items: null,
+  total: null,
+  page: null,
+  page_size: null,
+  total_pages: null
+)
+```
+

data/docs/ClientBackgroundJobResponse.md

@@ -0,0 +1,76 @@
+# RelentlessIdentity::ClientBackgroundJobResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **job_type** | **String** |  |  |
+| **status** | **String** | Current high-level job lifecycle state. |  |
+| **deadline_at** | **Time** |  |  |
+| **estimated_runtime_seconds** | **Integer** |  |  |
+| **scheduled_start_at** | **Time** |  |  |
+| **callback_url** | **String** |  | [optional] |
+| **callback_status** | **String** |  |  |
+| **callback_attempts** | **Integer** |  |  |
+| **callback_last_error** | **String** |  | [optional] |
+| **requested_count** | **Integer** | Total number of submitted items for the job. |  |
+| **completed_count** | **Integer** |  |  |
+| **success_count** | **Integer** |  |  |
+| **not_found_count** | **Integer** |  |  |
+| **error_count** | **Integer** |  |  |
+| **reserved_amount_micros** | **Integer** |  |  |
+| **actual_amount_micros** | **Integer** |  |  |
+| **progress_percent** | **Float** | Approximate percent complete based on completed item count. | [optional] |
+| **summary** | **Hash<String, Object>** | Aggregated counts and provider stats for the job. | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **started_at** | **Time** |  | [optional] |
+| **completed_at** | **Time** |  | [optional] |
+| **history_expires_at** | **Time** |  | [optional] |
+| **results_pruned_at** | **Time** |  | [optional] |
+| **artifact_available** | **Boolean** |  | [optional][default to false] |
+| **artifact_json_url** | **String** |  | [optional] |
+| **artifact_size_bytes** | **Integer** |  | [optional] |
+| **artifact_uploaded_at** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientBackgroundJobResponse.new(
+  id: null,
+  job_type: null,
+  status: null,
+  deadline_at: null,
+  estimated_runtime_seconds: null,
+  scheduled_start_at: null,
+  callback_url: null,
+  callback_status: null,
+  callback_attempts: null,
+  callback_last_error: null,
+  requested_count: null,
+  completed_count: null,
+  success_count: null,
+  not_found_count: null,
+  error_count: null,
+  reserved_amount_micros: null,
+  actual_amount_micros: null,
+  progress_percent: null,
+  summary: null,
+  metadata: null,
+  started_at: null,
+  completed_at: null,
+  history_expires_at: null,
+  results_pruned_at: null,
+  artifact_available: null,
+  artifact_json_url: null,
+  artifact_size_bytes: null,
+  artifact_uploaded_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/ClientBatchIdentityResponse.md

@@ -0,0 +1,20 @@
+# RelentlessIdentity::ClientBatchIdentityResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **results** | [**Array<ClientIdentityResponse>**](ClientIdentityResponse.md) | Per-email compact probe results in request order. |  |
+| **summary** | [**BatchSummary**](BatchSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientBatchIdentityResponse.new(
+  results: null,
+  summary: null
+)
+```
+

data/docs/ClientFinderResponse.md

@@ -0,0 +1,34 @@
+# RelentlessIdentity::ClientFinderResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | **String** | Final public deliverability verdict. |  |
+| **outcome** | **String** | Operational outcome. `error` means the verification could not complete cleanly and should not be treated as a negative mailbox verdict. | [optional] |
+| **address** | **String** |  | [optional] |
+| **is_alias** | **Boolean** | Whether the resolved address is an alias rather than a primary mailbox. | [optional] |
+| **_alias** | [**ClientFinderResponseAlias**](ClientFinderResponseAlias.md) |  | [optional] |
+| **is_catchall** | **Boolean** | Whether the mailbox domain behaved like a catch-all during verification. | [optional] |
+| **identity_providers** | [**Array<IdentityProvider>**](IdentityProvider.md) | Identity providers associated with the mailbox domain when available. | [optional] |
+| **mx_hosts** | **Array<String>** | Observed MX hosts for the mailbox domain. | [optional] |
+| **request_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'relentless_identity'
+
+instance = RelentlessIdentity::ClientFinderResponse.new(
+  state: null,
+  outcome: null,
+  address: null,
+  is_alias: null,
+  _alias: null,
+  is_catchall: null,
+  identity_providers: null,
+  mx_hosts: null,
+  request_id: null
+)
+```
+